themaster1970sf/TShock
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Add PlayerPermission hook, replace p.Group.HasPermission by p.HasPermission everywhere possible.

Browse source
This commit is contained in:
Enerdy 2016-01-11 14:33:44 +00:00
parent 21f16e5908
commit aa419283a9
13 changed files with 467 additions and 232 deletions
Download patch file Download diff file Expand all files Collapse all files

239
TShockAPI/Group.cs
View file

@ -22,56 +22,59 @@ using System.Collections.Generic;
namespace TShockAPI
{
/// <summary>
/// A class used to group multiple users' permissions and settings.
/// </summary>
public class Group
{
// NOTE: Using a const still suffers from needing to recompile to change the default
// ideally we would use a static but this means it can't be used for the default parameter :(
/// <summary>
/// Default chat color.
/// </summary>
/// <summary>
/// Default chat color.
/// </summary>
public const string defaultChatColor = "255,255,255";
/// <summary>
/// List of permissions available to the group.
/// </summary>
/// <summary>
/// List of permissions available to the group.
/// </summary>
public readonly List<string> permissions = new List<string>();
/// <summary>
/// List of permissions that the group is explicitly barred from.
/// </summary>
/// <summary>
/// List of permissions that the group is explicitly barred from.
/// </summary>
public readonly List<string> negatedpermissions = new List<string>();
/// <summary>
/// The group's name.
/// </summary>
/// <summary>
/// The group's name.
/// </summary>
public string Name { get; set; }
/// <summary>
/// The group that this group inherits permissions from.
/// </summary>
/// <summary>
/// The group that this group inherits permissions from.
/// </summary>
public Group Parent { get; set; }
/// <summary>
/// The chat prefix for this group.
/// </summary>
/// <summary>
/// The chat prefix for this group.
/// </summary>
public string Prefix { get; set; }
/// <summary>
/// The chat suffix for this group.
/// </summary>
/// <summary>
/// The chat suffix for this group.
/// </summary>
public string Suffix { get; set; }
/// <summary>
/// The name of the parent, not particularly sure why this is here.
/// We can use group.Parent.Name and not have this second reference.
/// This was added for rest, so a discussion with Shank is necessary.
/// </summary>
/// <summary>
/// The name of the parent, not particularly sure why this is here.
/// We can use group.Parent.Name and not have this second reference.
/// This was added for rest, so a discussion with Shank is necessary.
/// </summary>
public string ParentName { get { return (null == Parent) ? "" : Parent.Name; } }
/// <summary>
/// The chat color of the group.
/// Returns "255,255,255", sets "255,255,255"
/// </summary>
/// <summary>
/// The chat color of the group.
/// Returns "255,255,255", sets "255,255,255"
/// </summary>
public string ChatColor
{
get { return string.Format("{0},{1},{2}", R.ToString("D3"), G.ToString("D3"), B.ToString("D3")); }
@ -95,9 +98,9 @@ namespace TShockAPI
}
}
/// <summary>
/// The permissions of the user in string form.
/// </summary>
/// <summary>
/// The permissions of the user in string form.
/// </summary>
public string Permissions
{
get
@ -115,9 +118,9 @@ namespace TShockAPI
}
}
/// <summary>
/// The permissions of this group and all that it inherits from.
/// </summary>
/// <summary>
/// The permissions of this group and all that it inherits from.
/// </summary>
public virtual List<string> TotalPermissions
{
get
@ -148,12 +151,31 @@ namespace TShockAPI
}
}
/// <summary>
/// The group's chat color red byte.
/// </summary>
public byte R = 255;
/// <summary>
/// The group's chat color green byte.
/// </summary>
public byte G = 255;
/// <summary>
/// The group's chat color blue byte.
/// </summary>
public byte B = 255;
public static Group DefaultGroup = null;
/// <summary>
/// The default group attributed to unregistered users.
/// </summary>
public static Group DefaultGroup = null;
/// <summary>
/// Initializes a new instance of the group class.
/// </summary>
/// <param name="groupname">The name of the group.</param>
/// <param name="parentgroup">The parent group, if any.</param>
/// <param name="chatcolor">The chat color, in "RRR,GGG,BBB" format.</param>
/// <param name="permissions">The list of permissions associated with this group, separated by commas.</param>
public Group(string groupname, Group parentgroup = null, string chatcolor = "255,255,255", string permissions = null)
{
Name = groupname;
@ -162,21 +184,21 @@ namespace TShockAPI
Permissions = permissions;
}
/// <summary>
/// Checks to see if a group has a specified permission.
/// </summary>
/// <param name="permission">The permission to check.</param>
/// <returns>Returns true if the user has that permission.</returns>
/// <summary>
/// Checks to see if a group has a specified permission.
/// </summary>
/// <param name="permission">The permission to check.</param>
/// <returns>True if the group has that permission.</returns>
public virtual bool HasPermission(string permission)
{
bool negated = false;
{
bool negated = false;
if (String.IsNullOrEmpty(permission) || (RealHasPermission(permission, ref negated) && !negated))
{
return true;
}
if (negated)
return false;
if (negated)
return false;
string[] nodes = permission.Split('.');
for (int i = nodes.Length - 1; i >= 0; i--)
@ -189,37 +211,37 @@ namespace TShockAPI
}
return false;
}
private bool RealHasPermission(string permission, ref bool negated)
{
negated = false;
if (string.IsNullOrEmpty(permission))
return true;
private bool RealHasPermission(string permission, ref bool negated)
{
negated = false;
if (string.IsNullOrEmpty(permission))
return true;
var cur = this;
var traversed = new List<Group>();
while (cur != null)
{
if (cur.negatedpermissions.Contains(permission))
{
negated = true;
return false;
}
if (cur.permissions.Contains(permission))
return true;
if (traversed.Contains(cur))
{
throw new InvalidOperationException("Infinite group parenting ({0})".SFormat(cur.Name));
}
traversed.Add(cur);
cur = cur.Parent;
}
return false;
}
var cur = this;
var traversed = new List<Group>();
while (cur != null)
{
if (cur.negatedpermissions.Contains(permission))
{
negated = true;
return false;
}
if (cur.permissions.Contains(permission))
return true;
if (traversed.Contains(cur))
{
throw new InvalidOperationException("Infinite group parenting ({0})".SFormat(cur.Name));
}
traversed.Add(cur);
cur = cur.Parent;
}
return false;
}
/// <summary>
/// Adds a permission to the list of negated permissions.
/// </summary>
/// <param name="permission">The permission to negate.</param>
/// <summary>
/// Adds a permission to the list of negated permissions.
/// </summary>
/// <param name="permission">The permission to negate.</param>
public void NegatePermission(string permission)
{
// Avoid duplicates
@ -230,10 +252,10 @@ namespace TShockAPI
}
}
/// <summary>
/// Adds a permission to the list of permissions.
/// </summary>
/// <param name="permission">The permission to add.</param>
/// <summary>
/// Adds a permission to the list of permissions.
/// </summary>
/// <param name="permission">The permission to add.</param>
public void AddPermission(string permission)
{
if (permission.StartsWith("!"))
@ -249,11 +271,11 @@ namespace TShockAPI
}
}
/// <summary>
/// Clears the permission list and sets it to the list provided,
/// will parse "!permssion" and add it to the negated permissions.
/// </summary>
/// <param name="permission"></param>
/// <summary>
/// Clears the permission list and sets it to the list provided,
/// will parse "!permssion" and add it to the negated permissions.
/// </summary>
/// <param name="permission">The new list of permissions to associate with the group.</param>
public void SetPermission(List<string> permission)
{
permissions.Clear();
@ -261,11 +283,11 @@ namespace TShockAPI
permission.ForEach(p => AddPermission(p));
}
/// <summary>
/// Will remove a permission from the respective list,
/// where "!permission" will remove a negated permission.
/// </summary>
/// <param name="permission"></param>
/// <summary>
/// Will remove a permission from the respective list,
/// where "!permission" will remove a negated permission.
/// </summary>
/// <param name="permission"></param>
public void RemovePermission(string permission)
{
if (permission.StartsWith("!"))
@ -277,9 +299,9 @@ namespace TShockAPI
}
/// <summary>
/// Assigns all fields of this instance to another.
/// </summary>
/// <param name="otherGroup">The other instance.</param>
/// Assigns all fields of this instance to another.
/// </summary>
/// <param name="otherGroup">The other instance.</param>
public void AssignTo(Group otherGroup)
{
otherGroup.Name = Name;
@ -292,35 +314,44 @@ namespace TShockAPI
otherGroup.Permissions = Permissions;
}
public override string ToString() {
public override string ToString()
{
return this.Name;
}
}
/// <summary>
/// This class is the SuperAdminGroup, which has access to everything.
/// </summary>
/// <summary>
/// This class is the SuperAdminGroup, which has access to everything.
/// </summary>
public class SuperAdminGroup : Group
{
/// <summary>
/// The superadmin class has every permission, represented by '*'.
/// </summary>
public override List<string> TotalPermissions
{
get { return new List<string> { "*" }; }
}
/// <summary>
/// Initializes a new instance of the SuperAdminGroup class with the configured parameters.
/// Those can be changed in the config file.
/// </summary>
public SuperAdminGroup()
: base("superadmin")
{
R = (byte) TShock.Config.SuperAdminChatRGB[0];
G = (byte) TShock.Config.SuperAdminChatRGB[1];
B = (byte) TShock.Config.SuperAdminChatRGB[2];
R = (byte)TShock.Config.SuperAdminChatRGB[0];
G = (byte)TShock.Config.SuperAdminChatRGB[1];
B = (byte)TShock.Config.SuperAdminChatRGB[2];
Prefix = TShock.Config.SuperAdminChatPrefix;
Suffix = TShock.Config.SuperAdminChatSuffix;
}
/// <summary>
/// Override to allow access to everything.
/// </summary>
/// <param name="permission">The permission</param>
/// <returns>True</returns>
/// <summary>
/// Override to allow access to everything.
/// </summary>
/// <param name="permission">The permission</param>
/// <returns>True</returns>
public override bool HasPermission(string permission)
{
return true;