/* TShock, a server mod for Terraria Copyright (C) 2011-2016 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.Linq; using System.Collections.Generic; using System.Data; using MySql.Data.MySqlClient; namespace TShockAPI.DB { /// /// Class that manages bans. /// public class BanManager { private IDbConnection database; /// /// Initializes a new instance of the class. /// /// A valid connection to the TShock database public BanManager(IDbConnection db) { database = db; var table = new SqlTable("Bans", new SqlColumn("IP", MySqlDbType.String, 16) { Primary = true }, new SqlColumn("Name", MySqlDbType.Text), new SqlColumn("UUID", MySqlDbType.Text), new SqlColumn("Reason", MySqlDbType.Text), new SqlColumn("BanningUser", MySqlDbType.Text), new SqlColumn("Date", MySqlDbType.Text), new SqlColumn("Expiration", MySqlDbType.Text) ); var creator = new SqlTableCreator(db, db.GetSqlType() == SqlType.Sqlite ? (IQueryBuilder)new SqliteQueryCreator() : new MysqlQueryCreator()); try { creator.EnsureTableStructure(table); } catch (DllNotFoundException) { System.Console.WriteLine("Possible problem with your database - is Sqlite3.dll present?"); throw new Exception("Could not find a database library (probably Sqlite3.dll)"); } } /// /// Gets a ban by IP. /// /// The IP. /// The ban. public Ban GetBanByIp(string ip) { try { using (var reader = database.QueryReader("SELECT * FROM Bans WHERE IP=@0", ip)) { if (reader.Read()) return new Ban(reader.Get("IP"), reader.Get("Name"), reader.Get("UUID"), reader.Get("Reason"), reader.Get("BanningUser"), reader.Get("Date"), reader.Get("Expiration")); } } catch (Exception ex) { TShock.Log.Error(ex.ToString()); } return null; } /// /// Gets a list of bans sorted by their addition date from newest to oldest /// public List GetBans() => GetSortedBans(BanSortMethod.AddedNewestToOldest).ToList(); /// /// Retrieves an enumerable of objects, sorted using the provided sort method /// /// /// public IEnumerable GetSortedBans(BanSortMethod sortMethod) { List banlist = new List(); try { using (var reader = database.QueryReader("SELECT * FROM Bans")) { while (reader.Read()) { banlist.Add(new Ban(reader.Get("IP"), reader.Get("Name"), reader.Get("UUID"), reader.Get("Reason"), reader.Get("BanningUser"), reader.Get("Date"), reader.Get("Expiration"))); } Comparison comparer; switch (sortMethod) { case BanSortMethod.AddedOldestToNewest: comparer = (a, b) => b.DateTime.CompareTo(a.DateTime); break; case BanSortMethod.AddedNewestToOldest: comparer = (a, b) => a.DateTime.CompareTo(b.DateTime); break; case BanSortMethod.ExpirationLatestToSoonest: comparer = (a, b) => b.ExpirationDateTime.CompareTo(a.ExpirationDateTime); break; default: //Default encompasses BanSortMethod.ExpirationSoonestToLatest comparer = (a, b) => a.ExpirationDateTime.CompareTo(b.ExpirationDateTime); break; } banlist.Sort(comparer); return banlist; } } catch (Exception ex) { TShock.Log.Error(ex.ToString()); Console.WriteLine(ex.StackTrace); } return null; } /// /// Gets a ban by name. /// /// The name. /// Whether to check with case sensitivity. /// The ban. public Ban GetBanByName(string name, bool casesensitive = true) { try { var namecol = casesensitive ? "Name" : "UPPER(Name)"; if (!casesensitive) name = name.ToUpper(); using (var reader = database.QueryReader("SELECT * FROM Bans WHERE " + namecol + "=@0", name)) { if (reader.Read()) return new Ban(reader.Get("IP"), reader.Get("Name"), reader.Get("UUID"), reader.Get("Reason"), reader.Get("BanningUser"), reader.Get("Date"), reader.Get("Expiration")); } } catch (Exception ex) { TShock.Log.Error(ex.ToString()); } return null; } /// /// Gets a ban by UUID. /// /// The UUID. /// The ban. public Ban GetBanByUUID(string uuid) { try { using (var reader = database.QueryReader("SELECT * FROM Bans WHERE UUID=@0", uuid)) { if (reader.Read()) return new Ban(reader.Get("IP"), reader.Get("Name"), reader.Get("UUID"), reader.Get("Reason"), reader.Get("BanningUser"), reader.Get("Date"), reader.Get("Expiration")); } } catch (Exception ex) { TShock.Log.Error(ex.ToString()); } return null; } /// /// Adds a ban. /// /// true, if ban was added, false otherwise. /// Ip. /// Name. /// UUID. /// Reason. /// If set to true enable throwing exceptions. /// Banner. /// Expiration date. public bool AddBan(string ip, string name = "", string uuid = "", string reason = "", bool exceptions = false, string banner = "", string expiration = "") { try { /* * If the ban already exists, update its entry with the new date * and expiration details. */ if (GetBanByIp(ip) != null) { return database.Query("UPDATE Bans SET Date = @0, Expiration = @1 WHERE IP = @2", DateTime.UtcNow.ToString("s"), expiration, ip) == 1; } else { return database.Query("INSERT INTO Bans (IP, Name, UUID, Reason, BanningUser, Date, Expiration) VALUES (@0, @1, @2, @3, @4, @5, @6);", ip, name, uuid, reason, banner, DateTime.UtcNow.ToString("s"), expiration) != 0; } } catch (Exception ex) { if (exceptions) throw ex; TShock.Log.Error(ex.ToString()); } return false; } /// /// Removes a ban. /// /// true, if ban was removed, false otherwise. /// Match. /// If set to true by name. /// If set to true casesensitive. /// If set to true exceptions. public bool RemoveBan(string match, bool byName = false, bool casesensitive = true, bool exceptions = false) { try { if (!byName) return database.Query("DELETE FROM Bans WHERE IP=@0", match) != 0; var namecol = casesensitive ? "Name" : "UPPER(Name)"; return database.Query("DELETE FROM Bans WHERE " + namecol + "=@0", casesensitive ? match : match.ToUpper()) != 0; } catch (Exception ex) { if (exceptions) throw ex; TShock.Log.Error(ex.ToString()); } return false; } /// /// Clears bans. /// /// true, if bans were cleared, false otherwise. public bool ClearBans() { try { return database.Query("DELETE FROM Bans") != 0; } catch (Exception ex) { TShock.Log.Error(ex.ToString()); } return false; } } /// /// Enum containing sort options for ban retrieval /// public enum BanSortMethod { /// /// Bans will be sorted on expiration date, from soonest to latest /// ExpirationSoonestToLatest, /// /// Bans will be sorted on expiration date, from latest to soonest /// ExpirationLatestToSoonest, /// /// Bans will be sorted by the date they were added, from newest to oldest /// AddedNewestToOldest, /// /// Bans will be sorted by the date they were added, from oldest to newest /// AddedOldestToNewest } /// /// Model class that represents a ban entry in the TShock database. /// public class Ban { /// /// Gets or sets the IP address of the ban entry. /// /// The IP Address public string IP { get; set; } /// /// Gets or sets the name. /// /// The name. public string Name { get; set; } /// /// Gets or sets the Client UUID of the ban /// /// The UUID public string UUID { get; set; } /// /// Gets or sets the ban reason. /// /// The ban reason. public string Reason { get; set; } /// /// Gets or sets the name of the user who added this ban entry. /// /// The banning user. public string BanningUser { get; set; } /// /// Gets or sets the UTC date of when the ban is to take effect /// /// The date, which must be in UTC public string Date { get; set; } /// /// Gets the object representation of the string. /// public DateTime DateTime { get; } /// /// Gets or sets the expiration date, in which the ban shall be lifted /// /// The expiration. public string Expiration { get; set; } /// /// Gets the object representation of the string. /// public DateTime ExpirationDateTime { get; } /// /// Initializes a new instance of the class. /// /// Ip. /// Name. /// UUID. /// Reason. /// Banner. /// UTC ban date. /// Expiration time public Ban(string ip, string name, string uuid, string reason, string banner, string date, string exp) { IP = ip; Name = name; UUID = uuid; Reason = reason; BanningUser = banner; Date = date; Expiration = exp; } /// /// Initializes a new instance of the class. /// public Ban() { IP = string.Empty; Name = string.Empty; UUID = string.Empty; Reason = string.Empty; BanningUser = ""; Date = ""; Expiration = ""; } } }