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

Ban rewrite and various other adjustments

Browse source
This commit is contained in:
Chris 2020-11-26 17:20:19 +10:30
parent ce523e1436
commit cde4cc5f04
11 changed files with 742 additions and 276 deletions
Download patch file Download diff file Expand all files Collapse all files

468
TShockAPI/DB/BanManager.cs
View file

@ -31,14 +31,36 @@ namespace TShockAPI.DB
{
private IDbConnection database;
private Dictionary<int, Ban> _bans;
/// <summary>
/// Event invoked when a ban check occurs
/// Dictionary of Bans, keyed on unique ban ID
/// </summary>
public static event EventHandler<BanEventArgs> OnBanCheck;
public Dictionary<int, Ban> Bans
{
get
{
if (_bans == null)
{
_bans = RetrieveAllBans().ToDictionary(b => b.UniqueId);
}
return _bans;
}
}
/// <summary>
/// Event invoked when a ban is added
/// Event invoked when a ban is checked for validity
/// </summary>
public static event EventHandler<BanEventArgs> OnBanAdded;
public static event EventHandler<BanEventArgs> OnBanValidate;
/// <summary>
/// Event invoked before a ban is added
/// </summary>
public static event EventHandler<BanPreAddEventArgs> OnBanPreAdd;
/// <summary>
/// Event invoked after a ban is added
/// </summary>
public static event EventHandler<BanEventArgs> OnBanPostAdd;
/// <summary>
/// Initializes a new instance of the <see cref="TShockAPI.DB.BanManager"/> class.
@ -49,11 +71,12 @@ namespace TShockAPI.DB
database = db;
var table = new SqlTable("PlayerBans",
new SqlColumn("Identifier", MySqlDbType.Text) { Primary = true, Unique = true },
new SqlColumn("Id", MySqlDbType.Int32) { Primary = true, AutoIncrement = true },
new SqlColumn("Identifier", MySqlDbType.Text),
new SqlColumn("Reason", MySqlDbType.Text),
new SqlColumn("BanningUser", MySqlDbType.Text),
new SqlColumn("Date", MySqlDbType.Text),
new SqlColumn("Expiration", MySqlDbType.Text)
new SqlColumn("Date", MySqlDbType.Int64),
new SqlColumn("Expiration", MySqlDbType.Int64)
);
var creator = new SqlTableCreator(db,
db.GetSqlType() == SqlType.Sqlite
@ -69,7 +92,8 @@ namespace TShockAPI.DB
throw new Exception("Could not find a database library (probably Sqlite3.dll)");
}
OnBanCheck += CheckBanValid;
OnBanValidate += BanValidateCheck;
OnBanPreAdd += BanAddedCheck;
}
/// <summary>
@ -89,19 +113,29 @@ namespace TShockAPI.DB
var date = reader.Get<string>("Date");
var expiration = reader.Get<string>("Expiration");
if (!DateTime.TryParse(date, out DateTime start))
{
start = DateTime.UtcNow;
}
if (!DateTime.TryParse(expiration, out DateTime end))
{
end = DateTime.MaxValue;
}
if (!string.IsNullOrWhiteSpace(ip))
{
InsertBan($"{Ban.Identifiers.IP}{ip}", reason, banningUser, date, expiration);
InsertBan($"{Identifiers.IP}{ip}", reason, banningUser, start, end);
}
if (!string.IsNullOrWhiteSpace(account))
{
InsertBan($"{Ban.Identifiers.Account}{account}", reason, banningUser, date, expiration);
InsertBan($"{Identifiers.Account}{account}", reason, banningUser, start, end);
}
if (!string.IsNullOrWhiteSpace(uuid))
{
InsertBan($"{Ban.Identifiers.UUID}{uuid}", reason, banningUser, date, expiration);
InsertBan($"{Identifiers.UUID}{uuid}", reason, banningUser, start, end);
}
}
}
@ -111,99 +145,145 @@ namespace TShockAPI.DB
/// Determines whether or not a ban is valid
/// </summary>
/// <param name="ban"></param>
/// <param name="player"></param>
/// <returns></returns>
public bool IsValidBan(Ban ban)
public bool IsValidBan(Ban ban, TSPlayer player)
{
BanEventArgs args = new BanEventArgs { Ban = ban };
OnBanCheck?.Invoke(this, args);
BanEventArgs args = new BanEventArgs
{
Ban = ban,
Player = player
};
OnBanValidate?.Invoke(this, args);
return args.Valid;
}
internal void CheckBanValid(object sender, BanEventArgs args)
internal void BanValidateCheck(object sender, BanEventArgs args)
{
//We consider a ban to be valid if the start time is before now and the end time is after now
args.Valid = args.Ban.BanDateTime < DateTime.UtcNow && args.Ban.ExpirationDateTime > DateTime.UtcNow;
//Only perform validation if the event has not been cancelled before we got here
if (args.Valid)
{
//We consider a ban to be valid if the start time is before now and the end time is after now, and the player is not immune to bans
args.Valid = (DateTime.UtcNow > args.Ban.BanDateTime && DateTime.UtcNow < args.Ban.ExpirationDateTime) && !args.Player.HasPermission(Permissions.immunetoban);
}
}
/// <summary>
/// Adds a new ban for the given identifier. If the addition succeeds, returns a ban object with the ban details. Else returns null
/// </summary>
/// <param name="identifier"></param>
/// <param name="reason"></param>
/// <param name="banningUser"></param>
/// <param name="fromDate"></param>
/// <param name="toDate"></param>
/// <returns></returns>
public Ban InsertBan(string identifier, string reason, string banningUser, DateTime fromDate, DateTime toDate)
=> InsertBan(identifier, reason, banningUser, fromDate.ToString("s"), toDate.ToString("s"));
/// <summary>
/// Adds a new ban for the given identifier. If the addition succeeds, returns a ban object with the ban details. Else returns null
/// </summary>
/// <param name="identifier"></param>
/// <param name="reason"></param>
/// <param name="banningUser"></param>
/// <param name="fromDate"></param>
/// <param name="toDate"></param>
/// <returns></returns>
public Ban InsertBan(string identifier, string reason, string banningUser, string fromDate, string toDate)
internal void BanAddedCheck(object sender, BanPreAddEventArgs args)
{
Ban b = new Ban(identifier, reason, banningUser, fromDate, toDate);
//Only perform validation if the event has not been cancelled before we got here
if (args.Valid)
{
//We consider a ban valid to add if no other *current* bans exist for the identifier provided.
//E.g., if a previous ban has expired, a new ban is valid.
//However, if a previous ban on the provided identifier is still in effect, a new ban is not valid
args.Valid = !Bans.Any(b => b.Value.Identifier == args.Identifier && b.Value.ExpirationDateTime > DateTime.UtcNow);
args.Message = args.Valid ? null : "a current ban for this identifier already exists.";
}
}
/// <summary>
/// Adds a new ban for the given identifier. Returns a Ban object if the ban was added, else null
/// </summary>
/// <param name="identifier"></param>
/// <param name="reason"></param>
/// <param name="banningUser"></param>
/// <param name="fromDate"></param>
/// <param name="toDate"></param>
/// <returns></returns>
public AddBanResult InsertBan(string identifier, string reason, string banningUser, DateTime fromDate, DateTime toDate)
{
BanPreAddEventArgs args = new BanPreAddEventArgs
{
Identifier = identifier,
Reason = reason,
BanningUser = banningUser,
BanDateTime = fromDate,
ExpirationDateTime = toDate
};
BanEventArgs args = new BanEventArgs { Ban = b };
OnBanAdded?.Invoke(this, args);
OnBanPreAdd?.Invoke(this, args);
if (!args.Valid)
{
return null;
string message = $"Ban was invalidated: {(args.Message ?? "no further information provided.")}";
return new AddBanResult { Message = message };
}
int rowsModified = database.Query("INSERT OR IGNORE INTO PlayerBans (Identifier, Reason, BanningUser, Date, Expiration) VALUES (@0, @1, @2, @3, @4);", identifier, reason, banningUser, fromDate, toDate);
//Return the ban if the query actually inserted the row. If the given identifier already exists, the INSERT is ignored and 0 rows are modified.
return rowsModified != 0 ? b : null;
string query = "INSERT INTO PlayerBans (Identifier, Reason, BanningUser, Date, Expiration) VALUES (@0, @1, @2, @3, @4);";
if (database.GetSqlType() == SqlType.Mysql)
{
query += "SELECT CAST(LAST_INSERT_ID() as INT);";
}
else
{
query += "SELECT CAST(last_insert_rowid() as INT);";
}
int uniqueId = database.QueryScalar<int>(query, identifier, reason, banningUser, fromDate.Ticks, toDate.Ticks);
if (uniqueId == 0)
{
return new AddBanResult { Message = "Database insert failed." };
}
Ban b = new Ban(uniqueId, identifier, reason, banningUser, fromDate, toDate);
_bans.Add(uniqueId, b);
OnBanPostAdd?.Invoke(this, new BanEventArgs { Ban = b });
return new AddBanResult { Ban = b };
}
/// <summary>
/// Attempts to remove a ban. Returns true if the ban was removed or expired. False if the ban could not be removed or expired
/// </summary>
/// <param name="identifier"></param>
/// <param name="uniqueId">The unique ID of the ban to change</param>
/// <param name="fullDelete">If true, deletes the ban from the database. If false, marks the expiration time as now, rendering the ban expired. Defaults to false</param>
/// <returns></returns>
public bool RemoveBan(string identifier, bool fullDelete = false)
public bool RemoveBan(int uniqueId, bool fullDelete = false)
{
int rowsModified;
if (fullDelete)
{
rowsModified = database.Query("DELETE FROM PlayerBans WHERE Identifier=@0", identifier);
rowsModified = database.Query("DELETE FROM PlayerBans WHERE Id=@0", uniqueId);
_bans.Remove(uniqueId);
}
else
{
rowsModified = database.Query("UPDATE PlayerBans SET Expiration=@0 WHERE Identifier=@1", DateTime.UtcNow.ToString("s"), identifier);
rowsModified = database.Query("UPDATE PlayerBans SET Expiration=@0 WHERE Id=@1", DateTime.UtcNow.Ticks, uniqueId);
_bans[uniqueId].ExpirationDateTime = DateTime.UtcNow;
}
return rowsModified > 0;
}
/// <summary>
/// Retrieves a ban for a given identifier, or null if no matches are found
/// Retrieves a single ban from a unique ban ID
/// </summary>
/// <param name="identifier"></param>
/// <param name="id"></param>
/// <returns></returns>
public Ban GetBanByIdentifier(string identifier)
public Ban GetBanById(int id)
{
using (var reader = database.QueryReader("SELECT * FROM PlayerBans WHERE Identifier=@0", identifier))
if (Bans.ContainsKey(id))
{
return Bans[id];
}
using (var reader = database.QueryReader("SELECT * FROM PlayerBans WHERE Id=@0", id))
{
if (reader.Read())
{
var id = reader.Get<string>("Identifier");
var uniqueId = reader.Get<int>("Id");
var identifier = reader.Get<string>("Identifier");
var reason = reader.Get<string>("Reason");
var banningUser = reader.Get<string>("BanningUser");
var date = reader.Get<string>("Date");
var expiration = reader.Get<string>("Expiration");
var date = reader.Get<long>("Date");
var expiration = reader.Get<long>("Expiration");
return new Ban(id, reason, banningUser, date, expiration);
return new Ban(uniqueId, identifier, reason, banningUser, date, expiration);
}
}
@ -211,41 +291,80 @@ namespace TShockAPI.DB
}
/// <summary>
/// Retrieves an enumerable of bans for a given set of identifiers
/// Retrieves an enumerable of all bans for a given identifier
/// </summary>
/// <param name="identifiers"></param>
/// <param name="identifier">Identifier to search with</param>
/// <param name="currentOnly">Whether or not to exclude expired bans</param>
/// <returns></returns>
public IEnumerable<Ban> GetBansByIdentifiers(params string[] identifiers)
public IEnumerable<Ban> RetrieveBansByIdentifier(string identifier, bool currentOnly = true)
{
//Generate a sequence of '@0, @1, @2, ... etc'
var parameters = string.Join(", ", Enumerable.Range(0, identifiers.Count()).Select(p => $"@{p}"));
string query = "SELECT * FROM PlayerBans WHERE Identifier=@0";
if (currentOnly)
{
query += $" AND Expiration > {DateTime.UtcNow.Ticks}";
}
using (var reader = database.QueryReader($"SELECT * FROM PlayerBans WHERE Identifier IN ({parameters})", identifiers))
using (var reader = database.QueryReader(query, identifier))
{
while (reader.Read())
{
var uniqueId = reader.Get<int>("Id");
var ident = reader.Get<string>("Identifier");
var id = reader.Get<string>("Identifier");
var reason = reader.Get<string>("Reason");
var banningUser = reader.Get<string>("BanningUser");
var date = reader.Get<string>("Date");
var expiration = reader.Get<string>("Expiration");
var date = reader.Get<long>("Date");
var expiration = reader.Get<long>("Expiration");
yield return new Ban(id, reason, banningUser, date, expiration);
yield return new Ban(uniqueId, ident, reason, banningUser, date, expiration);
}
}
}
/// <summary>
/// Gets a list of bans sorted by their addition date from newest to oldest
/// Retrieves an enumerable of bans for a given set of identifiers
/// </summary>
public List<Ban> GetAllBans() => GetAllBansSorted(BanSortMethod.AddedNewestToOldest).ToList();
/// <param name="currentOnly">Whether or not to exclude expired bans</param>
/// <param name="identifiers"></param>
/// <returns></returns>
public IEnumerable<Ban> GetBansByIdentifiers(bool currentOnly = true, params string[] identifiers)
{
//Generate a sequence of '@0, @1, @2, ... etc'
var parameters = string.Join(", ", Enumerable.Range(0, identifiers.Count()).Select(p => $"@{p}"));
string query = $"SELECT * FROM PlayerBans WHERE Identifier IN ({parameters})";
if (currentOnly)
{
query += $" AND Expiration > {DateTime.UtcNow.Ticks}";
}
using (var reader = database.QueryReader(query, identifiers))
{
while (reader.Read())
{
var uniqueId = reader.Get<int>("Id");
var identifier = reader.Get<string>("Identifier");
var reason = reader.Get<string>("Reason");
var banningUser = reader.Get<string>("BanningUser");
var date = reader.Get<long>("Date");
var expiration = reader.Get<long>("Expiration");
yield return new Ban(uniqueId, identifier, reason, banningUser, date, expiration);
}
}
}
/// <summary>
/// Retrieves an enumerable of <see cref="Ban"/> objects, sorted using the provided sort method
/// Retrieves a list of bans from the database, sorted by their addition date from newest to oldest
/// </summary>
public IEnumerable<Ban> RetrieveAllBans() => RetrieveAllBansSorted(BanSortMethod.AddedNewestToOldest);
/// <summary>
/// Retrieves an enumerable of <see cref="Ban"/>s from the database, sorted using the provided sort method
/// </summary>
/// <param name="sortMethod"></param>
/// <returns></returns>
public IEnumerable<Ban> GetAllBansSorted(BanSortMethod sortMethod)
public IEnumerable<Ban> RetrieveAllBansSorted(BanSortMethod sortMethod)
{
List<Ban> banlist = new List<Ban>();
try
@ -255,24 +374,25 @@ namespace TShockAPI.DB
{
while (reader.Read())
{
var uniqueId = reader.Get<int>("Id");
var identifier = reader.Get<string>("Identifier");
var reason = reader.Get<string>("Reason");
var banningUser = reader.Get<string>("BanningUser");
var date = reader.Get<string>("Date");
var expiration = reader.Get<string>("Expiration");
var date = reader.Get<long>("Date");
var expiration = reader.Get<long>("Expiration");
var ban = new Ban(identifier, reason, banningUser, date, expiration);
var ban = new Ban(uniqueId, identifier, reason, banningUser, date, expiration);
banlist.Add(ban);
}
}
return banlist;
}
catch (Exception ex)
{
TShock.Log.Error(ex.ToString());
Console.WriteLine(ex.StackTrace);
}
return null;
return banlist;
}
/// <summary>
@ -321,51 +441,124 @@ namespace TShockAPI.DB
/// <summary>
/// Bans will be sorted by the date they were added, from oldest to newest
/// </summary>
AddedOldestToNewest
AddedOldestToNewest,
/// <summary>
/// Bans will be sorted by their unique ID
/// </summary>
UniqueId
}
/// <summary>
/// Event args used when a ban check is invoked, or a new ban is added
/// Result of an attempt to add a ban
/// </summary>
public class AddBanResult
{
/// <summary>
/// Message generated from the attempt
/// </summary>
public string Message { get; set; }
/// <summary>
/// Ban object generated from the attempt, or null if the attempt failed
/// </summary>
public Ban Ban { get; set; }
}
/// <summary>
/// Event args used for formalized bans
/// </summary>
public class BanEventArgs : EventArgs
{
/// <summary>
/// The ban being checked or added
/// Complete ban object
/// </summary>
public Ban Ban { get; set; }
/// <summary>
/// Whether or not the operation is valid
/// Player ban is being applied to
/// </summary>
public TSPlayer Player { get; set; }
/// <summary>
/// Whether or not the operation should be considered to be valid
/// </summary>
public bool Valid { get; set; } = true;
}
/// <summary>
/// Event args used for ban data prior to a ban being formalized
/// </summary>
public class BanPreAddEventArgs : EventArgs
{
/// <summary>
/// An identifiable piece of information to ban
/// </summary>
public string Identifier { get; set; }
/// <summary>
/// Gets or sets the ban reason.
/// </summary>
/// <value>The ban reason.</value>
public string Reason { get; set; }
/// <summary>
/// Gets or sets the name of the user who added this ban entry.
/// </summary>
/// <value>The banning user.</value>
public string BanningUser { get; set; }
/// <summary>
/// DateTime from which the ban will take effect
/// </summary>
public DateTime BanDateTime { get; set; }
/// <summary>
/// DateTime at which the ban will end
/// </summary>
public DateTime ExpirationDateTime { get; set; }
/// <summary>
/// Whether or not the operation should be considered to be valid
/// </summary>
public bool Valid { get; set; } = true;
/// <summary>
/// Optional message to explain why the event was invalidated, if it was
/// </summary>
public string Message { get; set; }
}
/// <summary>
/// Contains constants for different identifier types known to TShock
/// </summary>
public static class Identifiers
{
/// <summary>
/// IP identifier prefix constant
/// </summary>
public const string IP = "ip:";
/// <summary>
/// UUID identifier prefix constant
/// </summary>
public const string UUID = "uuid:";
/// <summary>
/// Player name identifier prefix constant
/// </summary>
public const string Name = "name:";
/// <summary>
/// User account identifier prefix constant
/// </summary>
public const string Account = "acc:";
}
/// <summary>
/// Model class that represents a ban entry in the TShock database.
/// </summary>
public class Ban
{
/// <summary>
/// Contains constants for different identifier types known to TShock
/// A unique ID assigned to this ban
/// </summary>
public class Identifiers
{
/// <summary>
/// IP identifier prefix constant
/// </summary>
public const string IP = "ip:";
/// <summary>
/// UUID identifier prefix constant
/// </summary>
public const string UUID = "uuid:";
/// <summary>
/// Player name identifier prefix constant
/// </summary>
public const string Name = "name:";
/// <summary>
/// User account identifier prefix constant
/// </summary>
public const string Account = "acc:";
}
public int UniqueId { get; set; }
/// <summary>
/// An identifiable piece of information to ban
@ -387,44 +580,71 @@ namespace TShockAPI.DB
/// <summary>
/// DateTime from which the ban will take effect
/// </summary>
public DateTime BanDateTime { get; }
public DateTime BanDateTime { get; set; }
/// <summary>
/// DateTime at which the ban will end
/// </summary>
public DateTime ExpirationDateTime { get; }
public DateTime ExpirationDateTime { get; set; }
/// <summary>
/// Returns a string in the format dd:mm:hh:ss indicating the time until the ban expires.
/// If the ban is not set to expire (ExpirationDateTime == DateTime.MaxValue), returns the string 'Never'
/// </summary>
/// <returns></returns>
public string GetPrettyExpirationString()
{
if (ExpirationDateTime == DateTime.MaxValue)
{
return "Never";
}
TimeSpan ts = (ExpirationDateTime - DateTime.UtcNow).Duration(); // Use duration to avoid pesky negatives for expired bans
return $"{ts.Days:00}:{ts.Hours:00}:{ts.Minutes:00}:{ts.Seconds:00}";
}
/// <summary>
/// Returns a string in the format dd:mm:hh:ss indicating the time elapsed since the ban was added.
/// </summary>
/// <returns></returns>
public string GetPrettyTimeSinceBanString()
{
TimeSpan ts = (DateTime.UtcNow - BanDateTime).Duration();
return $"{ts.Days:00}:{ts.Hours:00}:{ts.Minutes:00}:{ts.Seconds:00}";
}
/// <summary>
/// Initializes a new instance of the <see cref="TShockAPI.DB.Ban"/> class.
/// </summary>
/// <param name="uniqueId">Unique ID assigned to the ban</param>
/// <param name="identifier">Identifier to apply the ban to</param>
/// <param name="reason">Reason for the ban</param>
/// <param name="banningUser">Account name that executed the ban</param>
/// <param name="start">Ban start datetime</param>
/// <param name="end">Ban end datetime</param>
public Ban(string identifier, string reason, string banningUser, string start, string end)
/// <param name="start">System ticks at which the ban began</param>
/// <param name="end">System ticks at which the ban will end</param>
public Ban(int uniqueId, string identifier, string reason, string banningUser, long start, long end)
: this(uniqueId, identifier, reason, banningUser, new DateTime(start), new DateTime(end))
{
}
/// <summary>
/// Initializes a new instance of the <see cref="TShockAPI.DB.Ban"/> class.
/// </summary>
/// <param name="uniqueId">Unique ID assigned to the ban</param>
/// <param name="identifier">Identifier to apply the ban to</param>
/// <param name="reason">Reason for the ban</param>
/// <param name="banningUser">Account name that executed the ban</param>
/// <param name="start">DateTime at which the ban will start</param>
/// <param name="end">DateTime at which the ban will end</param>
public Ban(int uniqueId, string identifier, string reason, string banningUser, DateTime start, DateTime end)
{
UniqueId = uniqueId;
Identifier = identifier;
Reason = reason;
BanningUser = banningUser;
if (DateTime.TryParse(start, out DateTime d))
{
BanDateTime = d;
}
else
{
BanDateTime = DateTime.UtcNow;
}
if (DateTime.TryParse(end, out DateTime e))
{
ExpirationDateTime = e;
}
else
{
ExpirationDateTime = DateTime.MaxValue;
}
BanDateTime = start;
ExpirationDateTime = end;
}
}
}