/* TShock, a server mod for Terraria Copyright (C) 2011-2015 Nyx Studios (fka. The TShock Team) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ using System; using System.Collections; using System.Collections.Generic; using System.Data; using System.Diagnostics; using System.Linq; using MySql.Data.MySqlClient; namespace TShockAPI.DB { public class GroupManager : IEnumerable { private IDbConnection database; public readonly List groups = new List(); public GroupManager(IDbConnection db) { database = db; var table = new SqlTable("GroupList", new SqlColumn("GroupName", MySqlDbType.VarChar, 32) {Primary = true}, new SqlColumn("Parent", MySqlDbType.VarChar, 32), new SqlColumn("Commands", MySqlDbType.Text), new SqlColumn("ChatColor", MySqlDbType.Text), new SqlColumn("Prefix", MySqlDbType.Text), new SqlColumn("Suffix", MySqlDbType.Text) ); var creator = new SqlTableCreator(db, db.GetSqlType() == SqlType.Sqlite ? (IQueryBuilder) new SqliteQueryCreator() : new MysqlQueryCreator()); if (creator.EnsureTableStructure(table)) { // Add default groups if they don't exist AddDefaultGroup("guest", "", string.Join(",", Permissions.canbuild, Permissions.canregister, Permissions.canlogin, Permissions.canpartychat, Permissions.cantalkinthird, Permissions.canchat)); AddDefaultGroup("default", "guest", string.Join(",", Permissions.warp, Permissions.canchangepassword)); AddDefaultGroup("newadmin", "default", string.Join(",", Permissions.kick, Permissions.editspawn, Permissions.reservedslot)); AddDefaultGroup("admin", "newadmin", string.Join(",", Permissions.ban, Permissions.whitelist, "tshock.world.time.*", Permissions.spawnboss, Permissions.spawnmob, Permissions.managewarp, Permissions.time, Permissions.tp, Permissions.slap, Permissions.kill, Permissions.logs, Permissions.immunetokick, Permissions.tpothers)); AddDefaultGroup("trustedadmin", "admin", string.Join(",", Permissions.maintenance, "tshock.cfg.*", "tshock.world.*", Permissions.butcher, Permissions.item, Permissions.heal, Permissions.immunetoban, Permissions.usebanneditem)); AddDefaultGroup("vip", "default", string.Join(",", Permissions.reservedslot)); } // Load Permissions from the DB LoadPermisions(); Group.DefaultGroup = GetGroupByName(TShock.Config.DefaultGuestGroupName); } private void AddDefaultGroup(string name, string parent, string permissions) { if (!GroupExists(name)) AddGroup(name, parent, permissions); } public bool GroupExists(string group) { if (group == "superadmin") return true; return groups.Any(g => g.Name.Equals(group)); } IEnumerator IEnumerable.GetEnumerator() { return GetEnumerator(); } public IEnumerator GetEnumerator() { return groups.GetEnumerator(); } public Group GetGroupByName(string name) { var ret = groups.Where(g => g.Name == name); return 1 == ret.Count() ? ret.ElementAt(0) : null; } /// /// Adds group with name and permissions if it does not exist. /// /// name of group /// parent of group /// permissions /// chatcolor /// exceptions true indicates use exceptions for errors false otherwise public String AddGroup(String name, string parentname, String permissions, String chatcolor = Group.defaultChatColor, bool exceptions = false) { if (GroupExists(name)) { if (exceptions) throw new GroupExistsException(name); return "Error: Group already exists. Use /modgroup to change permissions."; } var group = new Group(name, null, chatcolor); group.Permissions = permissions; if (!string.IsNullOrWhiteSpace(parentname)) { var parent = groups.FirstOrDefault(gp => gp.Name == parentname); if (parent == null || name == parentname) { var error = "Invalid parent {0} for group {1}".SFormat(parentname, group.Name); if (exceptions) throw new GroupManagerException(error); TShock.Log.ConsoleError(error); return error; } group.Parent = parent; } string query = (TShock.Config.StorageType.ToLower() == "sqlite") ? "INSERT OR IGNORE INTO GroupList (GroupName, Parent, Commands, ChatColor) VALUES (@0, @1, @2, @3);" : "INSERT IGNORE INTO GroupList SET GroupName=@0, Parent=@1, Commands=@2, ChatColor=@3"; if (database.Query(query, name, parentname, permissions, chatcolor) == 1) { groups.Add(group); return "Group " + name + " has been created successfully."; } else if (exceptions) throw new GroupManagerException("Failed to add group '" + name + ".'"); return ""; } public String AddGroup(String name, String permissions) { return AddGroup(name, null, permissions, Group.defaultChatColor, false); } /// /// Updates a group including permissions /// /// name of the group to update /// parent of group /// permissions /// chatcolor public void UpdateGroup(string name, string parentname, string permissions, string chatcolor, string suffix, string prefix) { Group group = GetGroupByName(name); if (group == null) throw new GroupNotExistException(name); Group parent = null; if (!string.IsNullOrWhiteSpace(parentname)) { parent = GetGroupByName(parentname); if (parent == null || parent == group) throw new GroupManagerException("Invalid parent \"{0}\" for group \"{1}\".".SFormat(parentname, name)); // Check if the new parent would cause loops. List groupChain = new List { group, parent }; Group checkingGroup = parent.Parent; while (checkingGroup != null) { if (groupChain.Contains(checkingGroup)) throw new GroupManagerException( string.Format("Invalid parent \"{0}\" for group \"{1}\" would cause loops in the parent chain.", parentname, name)); groupChain.Add(checkingGroup); checkingGroup = checkingGroup.Parent; } } // Ensure any group validation is also persisted to the DB. var newGroup = new Group(name, parent, chatcolor, permissions); newGroup.Prefix = prefix; newGroup.Suffix = suffix; string query = "UPDATE GroupList SET Parent=@0, Commands=@1, ChatColor=@2, Suffix=@3, Prefix=@4 WHERE GroupName=@5"; if (database.Query(query, parentname, newGroup.Permissions, newGroup.ChatColor, suffix, prefix, name) != 1) throw new GroupManagerException(string.Format("Failed to update group \"{0}\".", name)); group.ChatColor = chatcolor; group.Permissions = permissions; group.Parent = parent; group.Prefix = prefix; group.Suffix = suffix; } public String DeleteGroup(String name, bool exceptions = false) { if (!GroupExists(name)) { if (exceptions) throw new GroupNotExistException(name); return "Error: Group doesn't exist."; } if (database.Query("DELETE FROM GroupList WHERE GroupName=@0", name) == 1) { groups.Remove(TShock.Utils.GetGroup(name)); return "Group " + name + " has been deleted successfully."; } else if (exceptions) throw new GroupManagerException("Failed to delete group '" + name + ".'"); return ""; } public String AddPermissions(String name, List permissions) { if (!GroupExists(name)) return "Error: Group doesn't exist."; var group = TShock.Utils.GetGroup(name); var oldperms = group.Permissions; // Store old permissions in case of error permissions.ForEach(p => group.AddPermission(p)); if (database.Query("UPDATE GroupList SET Commands=@0 WHERE GroupName=@1", group.Permissions, name) == 1) return "Group " + name + " has been modified successfully."; // Restore old permissions so DB and internal object are in a consistent state group.Permissions = oldperms; return ""; } public String DeletePermissions(String name, List permissions) { if (!GroupExists(name)) return "Error: Group doesn't exist."; var group = TShock.Utils.GetGroup(name); var oldperms = group.Permissions; // Store old permissions in case of error permissions.ForEach(p => group.RemovePermission(p)); if (database.Query("UPDATE GroupList SET Commands=@0 WHERE GroupName=@1", group.Permissions, name) == 1) return "Group " + name + " has been modified successfully."; // Restore old permissions so DB and internal object are in a consistent state group.Permissions = oldperms; return ""; } public void LoadPermisions() { try { List newGroups = new List(groups.Count); Dictionary newGroupParents = new Dictionary(groups.Count); using (var reader = database.QueryReader("SELECT * FROM GroupList")) { while (reader.Read()) { string groupName = reader.Get("GroupName"); if (groupName == "superadmin") { TShock.Log.ConsoleInfo("WARNING: Group \"superadmin\" is defined in the database even though it's a reserved group name."); continue; } newGroups.Add(new Group(groupName, null, reader.Get("ChatColor"), reader.Get("Commands")) { Prefix = reader.Get("Prefix"), Suffix = reader.Get("Suffix"), }); try { newGroupParents.Add(groupName, reader.Get("Parent")); } catch (ArgumentException) { // Just in case somebody messed with the unique primary key. TShock.Log.ConsoleError("ERROR: Group name \"{0}\" occurs more than once. Keeping current group settings."); return; } } } try { // Get rid of deleted groups. for (int i = 0; i < groups.Count; i++) if (newGroups.All(g => g.Name != groups[i].Name)) groups.RemoveAt(i--); // Apply changed group settings while keeping the current instances and add new groups. foreach (Group newGroup in newGroups) { Group currentGroup = groups.FirstOrDefault(g => g.Name == newGroup.Name); if (currentGroup != null) newGroup.AssignTo(currentGroup); else groups.Add(newGroup); } // Resolve parent groups. Debug.Assert(newGroups.Count == newGroupParents.Count); for (int i = 0; i < groups.Count; i++) { Group group = groups[i]; string parentGroupName; if (!newGroupParents.TryGetValue(group.Name, out parentGroupName) || string.IsNullOrEmpty(parentGroupName)) continue; group.Parent = groups.FirstOrDefault(g => g.Name == parentGroupName); if (group.Parent == null) { TShock.Log.ConsoleError( "ERROR: Group \"{0}\" is referencing non existent parent group \"{1}\", parent reference was removed.", group.Name, parentGroupName); } else { if (group.Parent == group) TShock.Log.ConsoleInfo( "WARNING: Group \"{0}\" is referencing itself as parent group, parent reference was removed.", group.Name); List groupChain = new List { group }; Group checkingGroup = group; while (checkingGroup.Parent != null) { if (groupChain.Contains(checkingGroup.Parent)) { TShock.Log.ConsoleError( "ERROR: Group \"{0}\" is referencing parent group \"{1}\" which is already part of the parent chain. Parent reference removed.", checkingGroup.Name, checkingGroup.Parent.Name); checkingGroup.Parent = null; break; } groupChain.Add(checkingGroup); checkingGroup = checkingGroup.Parent; } } } } finally { if (!groups.Any(g => g is SuperAdminGroup)) groups.Add(new SuperAdminGroup()); } } catch (Exception ex) { TShock.Log.ConsoleError("Error on reloading groups: " + ex); } } } [Serializable] public class GroupManagerException : Exception { public GroupManagerException(string message) : base(message) { } public GroupManagerException(string message, Exception inner) : base(message, inner) { } } [Serializable] public class GroupExistsException : GroupManagerException { public GroupExistsException(string name) : base("Group '" + name + "' already exists") { } } [Serializable] public class GroupNotExistException : GroupManagerException { public GroupNotExistException(string name) : base("Group '" + name + "' does not exist") { } } }