mirror of
https://github.com/MCCTeam/Minecraft-Console-Client
synced 2025-11-07 17:36:07 +00:00
[skip ci] Normalize all line endings
This commit is contained in:
ReinforceZwei
parent
bdad4f302d
commit
37bcad37e0
11 changed files with 10827 additions and 10827 deletions
|
|
@ -1,470 +1,470 @@
|
|||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Data;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using Brigadier.NET;
|
||||
using Brigadier.NET.Builder;
|
||||
using MinecraftClient.CommandHandler;
|
||||
using MinecraftClient.CommandHandler.Patch;
|
||||
using MinecraftClient.Scripting;
|
||||
using Tomlet.Attributes;
|
||||
|
||||
namespace MinecraftClient.ChatBots
|
||||
{
|
||||
/// <summary>
|
||||
/// ChatBot for storing and delivering Mails
|
||||
/// </summary>
|
||||
public class Mailer : ChatBot
|
||||
{
|
||||
public const string CommandName = "mailer";
|
||||
|
||||
public static Configs Config = new();
|
||||
|
||||
[TomlDoNotInlineObject]
|
||||
public class Configs
|
||||
{
|
||||
[NonSerialized]
|
||||
private const string BotName = "Mailer";
|
||||
|
||||
public bool Enabled = false;
|
||||
|
||||
public string DatabaseFile = "MailerDatabase.ini";
|
||||
|
||||
public string IgnoreListFile = "MailerIgnoreList.ini";
|
||||
|
||||
public bool PublicInteractions = false;
|
||||
|
||||
public int MaxMailsPerPlayer = 10;
|
||||
|
||||
public int MaxDatabaseSize = 10000;
|
||||
|
||||
public int MailRetentionDays = 30;
|
||||
|
||||
public void OnSettingUpdate()
|
||||
{
|
||||
DatabaseFile ??= string.Empty;
|
||||
IgnoreListFile ??= string.Empty;
|
||||
|
||||
if (!Enabled) return;
|
||||
|
||||
bool checkSuccessed = true;
|
||||
|
||||
if (Config.MaxDatabaseSize <= 0)
|
||||
{
|
||||
LogToConsole(BotName, Translations.bot_mailer_init_fail_db_size);
|
||||
checkSuccessed = false;
|
||||
}
|
||||
|
||||
if (Config.MaxMailsPerPlayer <= 0)
|
||||
{
|
||||
LogToConsole(BotName, Translations.bot_mailer_init_fail_max_mails);
|
||||
checkSuccessed = false;
|
||||
}
|
||||
|
||||
if (Config.MailRetentionDays <= 0)
|
||||
{
|
||||
LogToConsole(BotName, Translations.bot_mailer_init_fail_mail_retention);
|
||||
checkSuccessed = false;
|
||||
}
|
||||
|
||||
if (!checkSuccessed)
|
||||
{
|
||||
LogToConsole(BotName, Translations.general_bot_unload);
|
||||
Enabled = false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Holds the list of ignored players
|
||||
/// </summary>
|
||||
private class IgnoreList : HashSet<string>
|
||||
{
|
||||
/// <summary>
|
||||
/// Read ignore list from file
|
||||
/// </summary>
|
||||
/// <param name="filePath">Path to the ignore list</param>
|
||||
/// <returns>Ignore list</returns>
|
||||
public static IgnoreList FromFile(string filePath)
|
||||
{
|
||||
IgnoreList ignoreList = new();
|
||||
foreach (string line in FileMonitor.ReadAllLinesWithRetries(filePath))
|
||||
{
|
||||
if (!line.StartsWith("#"))
|
||||
{
|
||||
string entry = line.ToLower();
|
||||
if (!ignoreList.Contains(entry))
|
||||
ignoreList.Add(entry);
|
||||
}
|
||||
}
|
||||
return ignoreList;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Save ignore list to file
|
||||
/// </summary>
|
||||
/// <param name="filePath">Path to destination file</param>
|
||||
public void SaveToFile(string filePath)
|
||||
{
|
||||
List<string> lines = new();
|
||||
lines.Add("#Ignored Players");
|
||||
foreach (string player in this)
|
||||
lines.Add(player);
|
||||
FileMonitor.WriteAllLinesWithRetries(filePath, lines);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Holds the Mail database: a collection of Mails sent from a player to another player
|
||||
/// </summary>
|
||||
private class MailDatabase : List<Mail>
|
||||
{
|
||||
/// <summary>
|
||||
/// Read mail database from file
|
||||
/// </summary>
|
||||
/// <param name="filePath">Path to the database</param>
|
||||
/// <returns>Mail database</returns>
|
||||
public static MailDatabase FromFile(string filePath)
|
||||
{
|
||||
MailDatabase database = new();
|
||||
Dictionary<string, Dictionary<string, string>> iniFileDict = INIFile.ParseFile(FileMonitor.ReadAllLinesWithRetries(filePath));
|
||||
foreach (KeyValuePair<string, Dictionary<string, string>> iniSection in iniFileDict)
|
||||
{
|
||||
//iniSection.Key is "mailXX" but we don't need it here
|
||||
string sender = iniSection.Value["sender"];
|
||||
string recipient = iniSection.Value["recipient"];
|
||||
string content = iniSection.Value["content"];
|
||||
DateTime timestamp = DateTime.Parse(iniSection.Value["timestamp"]);
|
||||
bool anonymous = INIFile.Str2Bool(iniSection.Value["anonymous"]);
|
||||
database.Add(new Mail(sender, recipient, content, anonymous, timestamp));
|
||||
}
|
||||
return database;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Save mail database to file
|
||||
/// </summary>
|
||||
/// <param name="filePath">Path to destination file</param>
|
||||
public void SaveToFile(string filePath)
|
||||
{
|
||||
Dictionary<string, Dictionary<string, string>> iniFileDict = new();
|
||||
int mailCount = 0;
|
||||
foreach (Mail mail in this)
|
||||
{
|
||||
mailCount++;
|
||||
Dictionary<string, string> iniSection = new()
|
||||
{
|
||||
#pragma warning disable format // @formatter:off
|
||||
["sender"] = mail.Sender,
|
||||
["recipient"] = mail.Recipient,
|
||||
["content"] = mail.Content,
|
||||
["timestamp"] = mail.DateSent.ToString(),
|
||||
["anonymous"] = mail.Anonymous.ToString()
|
||||
#pragma warning restore format // @formatter:on
|
||||
};
|
||||
iniFileDict["mail" + mailCount] = iniSection;
|
||||
}
|
||||
FileMonitor.WriteAllLinesWithRetries(filePath, INIFile.Generate(iniFileDict, "Mail Database"));
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Represents a Mail sent from a player to another player
|
||||
/// </summary>
|
||||
private class Mail
|
||||
{
|
||||
private readonly string sender;
|
||||
private readonly string senderLower;
|
||||
private readonly string recipient;
|
||||
private readonly string recipientLower;
|
||||
private readonly string message;
|
||||
private readonly DateTime datesent;
|
||||
private bool delivered;
|
||||
private readonly bool anonymous;
|
||||
|
||||
public Mail(string sender, string recipient, string message, bool anonymous, DateTime datesent)
|
||||
{
|
||||
this.sender = sender;
|
||||
senderLower = sender.ToLower();
|
||||
this.recipient = recipient;
|
||||
recipientLower = recipient.ToLower();
|
||||
this.message = message;
|
||||
this.datesent = datesent;
|
||||
delivered = false;
|
||||
this.anonymous = anonymous;
|
||||
}
|
||||
|
||||
public string Sender { get { return sender; } }
|
||||
public string SenderLowercase { get { return senderLower; } }
|
||||
public string Recipient { get { return recipient; } }
|
||||
public string RecipientLowercase { get { return recipientLower; } }
|
||||
public string Content { get { return message; } }
|
||||
public DateTime DateSent { get { return datesent; } }
|
||||
public bool Delivered => delivered;
|
||||
public bool Anonymous { get { return anonymous; } }
|
||||
public void SetDelivered() { delivered = true; }
|
||||
|
||||
public override string ToString()
|
||||
{
|
||||
return String.Format("{0} {1} {2} {3}", Sender, Recipient, Content, DateSent);
|
||||
}
|
||||
}
|
||||
|
||||
// Internal variables
|
||||
private int maxMessageLength = 0;
|
||||
private DateTime nextMailSend = DateTime.Now;
|
||||
private MailDatabase mailDatabase = new();
|
||||
private IgnoreList ignoreList = new();
|
||||
private FileMonitor? mailDbFileMonitor;
|
||||
private FileMonitor? ignoreListFileMonitor;
|
||||
private readonly object readWriteLock = new();
|
||||
|
||||
/// <summary>
|
||||
/// Initialization of the Mailer bot
|
||||
/// </summary>
|
||||
public override void Initialize()
|
||||
{
|
||||
LogDebugToConsole(Translations.bot_mailer_init);
|
||||
LogDebugToConsole(Translations.bot_mailer_init_db + Config.DatabaseFile);
|
||||
LogDebugToConsole(Translations.bot_mailer_init_ignore + Config.IgnoreListFile);
|
||||
LogDebugToConsole(Translations.bot_mailer_init_public + Config.PublicInteractions);
|
||||
LogDebugToConsole(Translations.bot_mailer_init_max_mails + Config.MaxMailsPerPlayer);
|
||||
LogDebugToConsole(Translations.bot_mailer_init_db_size + Config.MaxDatabaseSize);
|
||||
LogDebugToConsole(Translations.bot_mailer_init_mail_retention + Config.MailRetentionDays + " days");
|
||||
|
||||
if (!File.Exists(Config.DatabaseFile))
|
||||
{
|
||||
LogToConsole(string.Format(Translations.bot_mailer_create_db, Path.GetFullPath(Config.DatabaseFile)));
|
||||
new MailDatabase().SaveToFile(Config.DatabaseFile);
|
||||
}
|
||||
|
||||
if (!File.Exists(Config.IgnoreListFile))
|
||||
{
|
||||
LogToConsole(string.Format(Translations.bot_mailer_create_ignore, Path.GetFullPath(Config.IgnoreListFile)));
|
||||
new IgnoreList().SaveToFile(Config.IgnoreListFile);
|
||||
}
|
||||
|
||||
lock (readWriteLock)
|
||||
{
|
||||
LogDebugToConsole(string.Format(Translations.bot_mailer_load_db, Path.GetFullPath(Config.DatabaseFile)));
|
||||
mailDatabase = MailDatabase.FromFile(Config.DatabaseFile);
|
||||
|
||||
LogDebugToConsole(string.Format(Translations.bot_mailer_load_ignore, Path.GetFullPath(Config.IgnoreListFile)));
|
||||
ignoreList = IgnoreList.FromFile(Config.IgnoreListFile);
|
||||
}
|
||||
|
||||
//Initialize file monitors. In case the bot needs to unload for some reason in the future, do not forget to .Dispose() them
|
||||
mailDbFileMonitor = new FileMonitor(Path.GetDirectoryName(Config.DatabaseFile)!, Path.GetFileName(Config.DatabaseFile), FileMonitorCallback);
|
||||
ignoreListFileMonitor = new FileMonitor(Path.GetDirectoryName(Config.IgnoreListFile)!, Path.GetFileName(Config.IgnoreListFile), FileMonitorCallback);
|
||||
|
||||
McClient.dispatcher.Register(l => l.Literal("help")
|
||||
.Then(l => l.Literal(CommandName)
|
||||
.Executes(r => OnCommandHelp(r.Source, string.Empty)))
|
||||
);
|
||||
|
||||
McClient.dispatcher.Register(l => l.Literal(CommandName)
|
||||
.Then(l => l.Literal("getmails")
|
||||
.Executes(r => OnCommandGetMails()))
|
||||
.Then(l => l.Literal("getignored")
|
||||
.Executes(r => OnCommandGetIgnored()))
|
||||
.Then(l => l.Literal("addignored")
|
||||
.Then(l => l.Argument("username", Arguments.String())
|
||||
.Executes(r => OnCommandAddIgnored(Arguments.GetString(r, "username")))))
|
||||
.Then(l => l.Literal("removeignored")
|
||||
.Then(l => l.Argument("username", Arguments.String())
|
||||
.Executes(r => OnCommandRemoveIgnored(Arguments.GetString(r, "username")))))
|
||||
.Then(l => l.Literal("_help")
|
||||
.Executes(r => OnCommandHelp(r.Source, string.Empty))
|
||||
.Redirect(McClient.dispatcher.GetRoot().GetChild("help").GetChild(CommandName)))
|
||||
);
|
||||
}
|
||||
|
||||
public override void OnUnload()
|
||||
{
|
||||
McClient.dispatcher.Unregister(CommandName);
|
||||
McClient.dispatcher.GetRoot().GetChild("help").RemoveChild(CommandName);
|
||||
}
|
||||
|
||||
private int OnCommandHelp(CmdResult r, string? cmd)
|
||||
{
|
||||
return r.SetAndReturn(cmd switch
|
||||
{
|
||||
#pragma warning disable format // @formatter:off
|
||||
_ => Translations.bot_mailer_cmd_help + ": /mailer <getmails|addignored|getignored|removeignored>"
|
||||
+ '\n' + McClient.dispatcher.GetAllUsageString(CommandName, false),
|
||||
#pragma warning restore format // @formatter:on
|
||||
});
|
||||
}
|
||||
|
||||
private int OnCommandGetMails()
|
||||
{
|
||||
LogToConsole(string.Format(Translations.bot_mailer_cmd_getmails, string.Join("\n", mailDatabase)));
|
||||
return 1;
|
||||
}
|
||||
|
||||
private int OnCommandGetIgnored()
|
||||
{
|
||||
LogToConsole(string.Format(Translations.bot_mailer_cmd_getignored, string.Join("\n", ignoreList)));
|
||||
return 1;
|
||||
}
|
||||
|
||||
private int OnCommandAddIgnored(string username)
|
||||
{
|
||||
if (IsValidName(username))
|
||||
{
|
||||
username = username.ToLower();
|
||||
lock (readWriteLock)
|
||||
{
|
||||
if (!ignoreList.Contains(username))
|
||||
{
|
||||
ignoreList.Add(username);
|
||||
ignoreList.SaveToFile(Config.IgnoreListFile);
|
||||
}
|
||||
}
|
||||
LogToConsole(string.Format(Translations.bot_mailer_cmd_ignore_added, username));
|
||||
return 1;
|
||||
}
|
||||
else
|
||||
{
|
||||
LogToConsole(string.Format(Translations.bot_mailer_cmd_ignore_invalid, "addignored"));
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
private int OnCommandRemoveIgnored(string username)
|
||||
{
|
||||
if (IsValidName(username))
|
||||
{
|
||||
username = username.ToLower();
|
||||
lock (readWriteLock)
|
||||
{
|
||||
if (ignoreList.Contains(username))
|
||||
{
|
||||
ignoreList.Remove(username);
|
||||
ignoreList.SaveToFile(Config.IgnoreListFile);
|
||||
}
|
||||
}
|
||||
LogToConsole(string.Format(Translations.bot_mailer_cmd_ignore_removed, username));
|
||||
return 1;
|
||||
}
|
||||
else
|
||||
{
|
||||
LogToConsole(string.Format(Translations.bot_mailer_cmd_ignore_invalid, "removeignored"));
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Standard settings for the bot.
|
||||
/// </summary>
|
||||
public override void AfterGameJoined()
|
||||
{
|
||||
maxMessageLength = GetMaxChatMessageLength()
|
||||
- 44 // Deduct length of "/ 16CharPlayerName 16CharPlayerName mailed: "
|
||||
- Settings.Config.Main.Advanced.PrivateMsgsCmdName.Length; // Deduct length of "tell" command
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Process chat messages from the server
|
||||
/// </summary>
|
||||
public override void GetText(string text)
|
||||
{
|
||||
string message = "";
|
||||
string username = "";
|
||||
text = GetVerbatim(text);
|
||||
|
||||
if (IsPrivateMessage(text, ref message, ref username) || (Config.PublicInteractions && IsChatMessage(text, ref message, ref username)))
|
||||
{
|
||||
string usernameLower = username.ToLower();
|
||||
if (!ignoreList.Contains(usernameLower))
|
||||
{
|
||||
string command = message.Split(' ')[0].ToLower();
|
||||
switch (command)
|
||||
{
|
||||
case "mail":
|
||||
case "tellonym":
|
||||
if (usernameLower != GetUsername().ToLower()
|
||||
&& mailDatabase.Count < Config.MaxDatabaseSize
|
||||
&& mailDatabase.Where(mail => mail.SenderLowercase == usernameLower).Count() < Config.MaxMailsPerPlayer)
|
||||
{
|
||||
Queue<string> args = new(Command.GetArgs(message));
|
||||
if (args.Count >= 2)
|
||||
{
|
||||
bool anonymous = (command == "tellonym");
|
||||
string recipient = args.Dequeue();
|
||||
message = string.Join(" ", args);
|
||||
|
||||
if (IsValidName(recipient))
|
||||
{
|
||||
if (message.Length <= maxMessageLength)
|
||||
{
|
||||
Mail mail = new(username, recipient, message, anonymous, DateTime.Now);
|
||||
LogToConsole(string.Format(Translations.bot_mailer_saving, mail.ToString()));
|
||||
lock (readWriteLock)
|
||||
{
|
||||
mailDatabase.Add(mail);
|
||||
mailDatabase.SaveToFile(Config.DatabaseFile);
|
||||
}
|
||||
SendPrivateMessage(username, "Message saved!");
|
||||
}
|
||||
else SendPrivateMessage(username, "Your message cannot be longer than " + maxMessageLength + " characters.");
|
||||
}
|
||||
else SendPrivateMessage(username, "Recipient '" + recipient + "' is not a valid player name.");
|
||||
}
|
||||
else SendPrivateMessage(username, "Usage: " + command + " <recipient> <message>");
|
||||
}
|
||||
else SendPrivateMessage(username, "Couldn't save Message. Limit reached!");
|
||||
break;
|
||||
}
|
||||
}
|
||||
else LogDebugToConsole(string.Format(Translations.bot_mailer_user_ignored, username));
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Called on each MCC tick, around 10 times per second
|
||||
/// </summary>
|
||||
public override void Update()
|
||||
{
|
||||
DateTime dateNow = DateTime.Now;
|
||||
if (nextMailSend < dateNow)
|
||||
{
|
||||
LogDebugToConsole(string.Format(Translations.bot_mailer_process_mails, DateTime.Now));
|
||||
|
||||
// Process at most 3 mails at a time to avoid spamming. Other mails will be processed on next mail send
|
||||
HashSet<string> onlinePlayersLowercase = new(GetOnlinePlayers().Select(name => name.ToLower()));
|
||||
foreach (Mail mail in mailDatabase.Where(mail => !mail.Delivered && onlinePlayersLowercase.Contains(mail.RecipientLowercase)).Take(3))
|
||||
{
|
||||
string sender = mail.Anonymous ? "Anonymous" : mail.Sender;
|
||||
SendPrivateMessage(mail.Recipient, sender + " mailed: " + mail.Content);
|
||||
mail.SetDelivered();
|
||||
LogDebugToConsole(string.Format(Translations.bot_mailer_delivered, mail.ToString()));
|
||||
}
|
||||
|
||||
lock (readWriteLock)
|
||||
{
|
||||
mailDatabase.RemoveAll(mail => mail.Delivered);
|
||||
mailDatabase.RemoveAll(mail => mail.DateSent.AddDays(Config.MailRetentionDays) < DateTime.Now);
|
||||
mailDatabase.SaveToFile(Config.DatabaseFile);
|
||||
}
|
||||
|
||||
nextMailSend = dateNow.AddSeconds(10);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Called when the Mail Database or Ignore list has changed on disk
|
||||
/// </summary>
|
||||
/// <param name="sender"></param>
|
||||
/// <param name="e"></param>
|
||||
private void FileMonitorCallback(object sender, FileSystemEventArgs e)
|
||||
{
|
||||
lock (readWriteLock)
|
||||
{
|
||||
mailDatabase = MailDatabase.FromFile(Config.DatabaseFile);
|
||||
ignoreList = IgnoreList.FromFile(Config.IgnoreListFile);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Data;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using Brigadier.NET;
|
||||
using Brigadier.NET.Builder;
|
||||
using MinecraftClient.CommandHandler;
|
||||
using MinecraftClient.CommandHandler.Patch;
|
||||
using MinecraftClient.Scripting;
|
||||
using Tomlet.Attributes;
|
||||
|
||||
namespace MinecraftClient.ChatBots
|
||||
{
|
||||
/// <summary>
|
||||
/// ChatBot for storing and delivering Mails
|
||||
/// </summary>
|
||||
public class Mailer : ChatBot
|
||||
{
|
||||
public const string CommandName = "mailer";
|
||||
|
||||
public static Configs Config = new();
|
||||
|
||||
[TomlDoNotInlineObject]
|
||||
public class Configs
|
||||
{
|
||||
[NonSerialized]
|
||||
private const string BotName = "Mailer";
|
||||
|
||||
public bool Enabled = false;
|
||||
|
||||
public string DatabaseFile = "MailerDatabase.ini";
|
||||
|
||||
public string IgnoreListFile = "MailerIgnoreList.ini";
|
||||
|
||||
public bool PublicInteractions = false;
|
||||
|
||||
public int MaxMailsPerPlayer = 10;
|
||||
|
||||
public int MaxDatabaseSize = 10000;
|
||||
|
||||
public int MailRetentionDays = 30;
|
||||
|
||||
public void OnSettingUpdate()
|
||||
{
|
||||
DatabaseFile ??= string.Empty;
|
||||
IgnoreListFile ??= string.Empty;
|
||||
|
||||
if (!Enabled) return;
|
||||
|
||||
bool checkSuccessed = true;
|
||||
|
||||
if (Config.MaxDatabaseSize <= 0)
|
||||
{
|
||||
LogToConsole(BotName, Translations.bot_mailer_init_fail_db_size);
|
||||
checkSuccessed = false;
|
||||
}
|
||||
|
||||
if (Config.MaxMailsPerPlayer <= 0)
|
||||
{
|
||||
LogToConsole(BotName, Translations.bot_mailer_init_fail_max_mails);
|
||||
checkSuccessed = false;
|
||||
}
|
||||
|
||||
if (Config.MailRetentionDays <= 0)
|
||||
{
|
||||
LogToConsole(BotName, Translations.bot_mailer_init_fail_mail_retention);
|
||||
checkSuccessed = false;
|
||||
}
|
||||
|
||||
if (!checkSuccessed)
|
||||
{
|
||||
LogToConsole(BotName, Translations.general_bot_unload);
|
||||
Enabled = false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Holds the list of ignored players
|
||||
/// </summary>
|
||||
private class IgnoreList : HashSet<string>
|
||||
{
|
||||
/// <summary>
|
||||
/// Read ignore list from file
|
||||
/// </summary>
|
||||
/// <param name="filePath">Path to the ignore list</param>
|
||||
/// <returns>Ignore list</returns>
|
||||
public static IgnoreList FromFile(string filePath)
|
||||
{
|
||||
IgnoreList ignoreList = new();
|
||||
foreach (string line in FileMonitor.ReadAllLinesWithRetries(filePath))
|
||||
{
|
||||
if (!line.StartsWith("#"))
|
||||
{
|
||||
string entry = line.ToLower();
|
||||
if (!ignoreList.Contains(entry))
|
||||
ignoreList.Add(entry);
|
||||
}
|
||||
}
|
||||
return ignoreList;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Save ignore list to file
|
||||
/// </summary>
|
||||
/// <param name="filePath">Path to destination file</param>
|
||||
public void SaveToFile(string filePath)
|
||||
{
|
||||
List<string> lines = new();
|
||||
lines.Add("#Ignored Players");
|
||||
foreach (string player in this)
|
||||
lines.Add(player);
|
||||
FileMonitor.WriteAllLinesWithRetries(filePath, lines);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Holds the Mail database: a collection of Mails sent from a player to another player
|
||||
/// </summary>
|
||||
private class MailDatabase : List<Mail>
|
||||
{
|
||||
/// <summary>
|
||||
/// Read mail database from file
|
||||
/// </summary>
|
||||
/// <param name="filePath">Path to the database</param>
|
||||
/// <returns>Mail database</returns>
|
||||
public static MailDatabase FromFile(string filePath)
|
||||
{
|
||||
MailDatabase database = new();
|
||||
Dictionary<string, Dictionary<string, string>> iniFileDict = INIFile.ParseFile(FileMonitor.ReadAllLinesWithRetries(filePath));
|
||||
foreach (KeyValuePair<string, Dictionary<string, string>> iniSection in iniFileDict)
|
||||
{
|
||||
//iniSection.Key is "mailXX" but we don't need it here
|
||||
string sender = iniSection.Value["sender"];
|
||||
string recipient = iniSection.Value["recipient"];
|
||||
string content = iniSection.Value["content"];
|
||||
DateTime timestamp = DateTime.Parse(iniSection.Value["timestamp"]);
|
||||
bool anonymous = INIFile.Str2Bool(iniSection.Value["anonymous"]);
|
||||
database.Add(new Mail(sender, recipient, content, anonymous, timestamp));
|
||||
}
|
||||
return database;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Save mail database to file
|
||||
/// </summary>
|
||||
/// <param name="filePath">Path to destination file</param>
|
||||
public void SaveToFile(string filePath)
|
||||
{
|
||||
Dictionary<string, Dictionary<string, string>> iniFileDict = new();
|
||||
int mailCount = 0;
|
||||
foreach (Mail mail in this)
|
||||
{
|
||||
mailCount++;
|
||||
Dictionary<string, string> iniSection = new()
|
||||
{
|
||||
#pragma warning disable format // @formatter:off
|
||||
["sender"] = mail.Sender,
|
||||
["recipient"] = mail.Recipient,
|
||||
["content"] = mail.Content,
|
||||
["timestamp"] = mail.DateSent.ToString(),
|
||||
["anonymous"] = mail.Anonymous.ToString()
|
||||
#pragma warning restore format // @formatter:on
|
||||
};
|
||||
iniFileDict["mail" + mailCount] = iniSection;
|
||||
}
|
||||
FileMonitor.WriteAllLinesWithRetries(filePath, INIFile.Generate(iniFileDict, "Mail Database"));
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Represents a Mail sent from a player to another player
|
||||
/// </summary>
|
||||
private class Mail
|
||||
{
|
||||
private readonly string sender;
|
||||
private readonly string senderLower;
|
||||
private readonly string recipient;
|
||||
private readonly string recipientLower;
|
||||
private readonly string message;
|
||||
private readonly DateTime datesent;
|
||||
private bool delivered;
|
||||
private readonly bool anonymous;
|
||||
|
||||
public Mail(string sender, string recipient, string message, bool anonymous, DateTime datesent)
|
||||
{
|
||||
this.sender = sender;
|
||||
senderLower = sender.ToLower();
|
||||
this.recipient = recipient;
|
||||
recipientLower = recipient.ToLower();
|
||||
this.message = message;
|
||||
this.datesent = datesent;
|
||||
delivered = false;
|
||||
this.anonymous = anonymous;
|
||||
}
|
||||
|
||||
public string Sender { get { return sender; } }
|
||||
public string SenderLowercase { get { return senderLower; } }
|
||||
public string Recipient { get { return recipient; } }
|
||||
public string RecipientLowercase { get { return recipientLower; } }
|
||||
public string Content { get { return message; } }
|
||||
public DateTime DateSent { get { return datesent; } }
|
||||
public bool Delivered => delivered;
|
||||
public bool Anonymous { get { return anonymous; } }
|
||||
public void SetDelivered() { delivered = true; }
|
||||
|
||||
public override string ToString()
|
||||
{
|
||||
return String.Format("{0} {1} {2} {3}", Sender, Recipient, Content, DateSent);
|
||||
}
|
||||
}
|
||||
|
||||
// Internal variables
|
||||
private int maxMessageLength = 0;
|
||||
private DateTime nextMailSend = DateTime.Now;
|
||||
private MailDatabase mailDatabase = new();
|
||||
private IgnoreList ignoreList = new();
|
||||
private FileMonitor? mailDbFileMonitor;
|
||||
private FileMonitor? ignoreListFileMonitor;
|
||||
private readonly object readWriteLock = new();
|
||||
|
||||
/// <summary>
|
||||
/// Initialization of the Mailer bot
|
||||
/// </summary>
|
||||
public override void Initialize()
|
||||
{
|
||||
LogDebugToConsole(Translations.bot_mailer_init);
|
||||
LogDebugToConsole(Translations.bot_mailer_init_db + Config.DatabaseFile);
|
||||
LogDebugToConsole(Translations.bot_mailer_init_ignore + Config.IgnoreListFile);
|
||||
LogDebugToConsole(Translations.bot_mailer_init_public + Config.PublicInteractions);
|
||||
LogDebugToConsole(Translations.bot_mailer_init_max_mails + Config.MaxMailsPerPlayer);
|
||||
LogDebugToConsole(Translations.bot_mailer_init_db_size + Config.MaxDatabaseSize);
|
||||
LogDebugToConsole(Translations.bot_mailer_init_mail_retention + Config.MailRetentionDays + " days");
|
||||
|
||||
if (!File.Exists(Config.DatabaseFile))
|
||||
{
|
||||
LogToConsole(string.Format(Translations.bot_mailer_create_db, Path.GetFullPath(Config.DatabaseFile)));
|
||||
new MailDatabase().SaveToFile(Config.DatabaseFile);
|
||||
}
|
||||
|
||||
if (!File.Exists(Config.IgnoreListFile))
|
||||
{
|
||||
LogToConsole(string.Format(Translations.bot_mailer_create_ignore, Path.GetFullPath(Config.IgnoreListFile)));
|
||||
new IgnoreList().SaveToFile(Config.IgnoreListFile);
|
||||
}
|
||||
|
||||
lock (readWriteLock)
|
||||
{
|
||||
LogDebugToConsole(string.Format(Translations.bot_mailer_load_db, Path.GetFullPath(Config.DatabaseFile)));
|
||||
mailDatabase = MailDatabase.FromFile(Config.DatabaseFile);
|
||||
|
||||
LogDebugToConsole(string.Format(Translations.bot_mailer_load_ignore, Path.GetFullPath(Config.IgnoreListFile)));
|
||||
ignoreList = IgnoreList.FromFile(Config.IgnoreListFile);
|
||||
}
|
||||
|
||||
//Initialize file monitors. In case the bot needs to unload for some reason in the future, do not forget to .Dispose() them
|
||||
mailDbFileMonitor = new FileMonitor(Path.GetDirectoryName(Config.DatabaseFile)!, Path.GetFileName(Config.DatabaseFile), FileMonitorCallback);
|
||||
ignoreListFileMonitor = new FileMonitor(Path.GetDirectoryName(Config.IgnoreListFile)!, Path.GetFileName(Config.IgnoreListFile), FileMonitorCallback);
|
||||
|
||||
McClient.dispatcher.Register(l => l.Literal("help")
|
||||
.Then(l => l.Literal(CommandName)
|
||||
.Executes(r => OnCommandHelp(r.Source, string.Empty)))
|
||||
);
|
||||
|
||||
McClient.dispatcher.Register(l => l.Literal(CommandName)
|
||||
.Then(l => l.Literal("getmails")
|
||||
.Executes(r => OnCommandGetMails()))
|
||||
.Then(l => l.Literal("getignored")
|
||||
.Executes(r => OnCommandGetIgnored()))
|
||||
.Then(l => l.Literal("addignored")
|
||||
.Then(l => l.Argument("username", Arguments.String())
|
||||
.Executes(r => OnCommandAddIgnored(Arguments.GetString(r, "username")))))
|
||||
.Then(l => l.Literal("removeignored")
|
||||
.Then(l => l.Argument("username", Arguments.String())
|
||||
.Executes(r => OnCommandRemoveIgnored(Arguments.GetString(r, "username")))))
|
||||
.Then(l => l.Literal("_help")
|
||||
.Executes(r => OnCommandHelp(r.Source, string.Empty))
|
||||
.Redirect(McClient.dispatcher.GetRoot().GetChild("help").GetChild(CommandName)))
|
||||
);
|
||||
}
|
||||
|
||||
public override void OnUnload()
|
||||
{
|
||||
McClient.dispatcher.Unregister(CommandName);
|
||||
McClient.dispatcher.GetRoot().GetChild("help").RemoveChild(CommandName);
|
||||
}
|
||||
|
||||
private int OnCommandHelp(CmdResult r, string? cmd)
|
||||
{
|
||||
return r.SetAndReturn(cmd switch
|
||||
{
|
||||
#pragma warning disable format // @formatter:off
|
||||
_ => Translations.bot_mailer_cmd_help + ": /mailer <getmails|addignored|getignored|removeignored>"
|
||||
+ '\n' + McClient.dispatcher.GetAllUsageString(CommandName, false),
|
||||
#pragma warning restore format // @formatter:on
|
||||
});
|
||||
}
|
||||
|
||||
private int OnCommandGetMails()
|
||||
{
|
||||
LogToConsole(string.Format(Translations.bot_mailer_cmd_getmails, string.Join("\n", mailDatabase)));
|
||||
return 1;
|
||||
}
|
||||
|
||||
private int OnCommandGetIgnored()
|
||||
{
|
||||
LogToConsole(string.Format(Translations.bot_mailer_cmd_getignored, string.Join("\n", ignoreList)));
|
||||
return 1;
|
||||
}
|
||||
|
||||
private int OnCommandAddIgnored(string username)
|
||||
{
|
||||
if (IsValidName(username))
|
||||
{
|
||||
username = username.ToLower();
|
||||
lock (readWriteLock)
|
||||
{
|
||||
if (!ignoreList.Contains(username))
|
||||
{
|
||||
ignoreList.Add(username);
|
||||
ignoreList.SaveToFile(Config.IgnoreListFile);
|
||||
}
|
||||
}
|
||||
LogToConsole(string.Format(Translations.bot_mailer_cmd_ignore_added, username));
|
||||
return 1;
|
||||
}
|
||||
else
|
||||
{
|
||||
LogToConsole(string.Format(Translations.bot_mailer_cmd_ignore_invalid, "addignored"));
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
private int OnCommandRemoveIgnored(string username)
|
||||
{
|
||||
if (IsValidName(username))
|
||||
{
|
||||
username = username.ToLower();
|
||||
lock (readWriteLock)
|
||||
{
|
||||
if (ignoreList.Contains(username))
|
||||
{
|
||||
ignoreList.Remove(username);
|
||||
ignoreList.SaveToFile(Config.IgnoreListFile);
|
||||
}
|
||||
}
|
||||
LogToConsole(string.Format(Translations.bot_mailer_cmd_ignore_removed, username));
|
||||
return 1;
|
||||
}
|
||||
else
|
||||
{
|
||||
LogToConsole(string.Format(Translations.bot_mailer_cmd_ignore_invalid, "removeignored"));
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Standard settings for the bot.
|
||||
/// </summary>
|
||||
public override void AfterGameJoined()
|
||||
{
|
||||
maxMessageLength = GetMaxChatMessageLength()
|
||||
- 44 // Deduct length of "/ 16CharPlayerName 16CharPlayerName mailed: "
|
||||
- Settings.Config.Main.Advanced.PrivateMsgsCmdName.Length; // Deduct length of "tell" command
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Process chat messages from the server
|
||||
/// </summary>
|
||||
public override void GetText(string text)
|
||||
{
|
||||
string message = "";
|
||||
string username = "";
|
||||
text = GetVerbatim(text);
|
||||
|
||||
if (IsPrivateMessage(text, ref message, ref username) || (Config.PublicInteractions && IsChatMessage(text, ref message, ref username)))
|
||||
{
|
||||
string usernameLower = username.ToLower();
|
||||
if (!ignoreList.Contains(usernameLower))
|
||||
{
|
||||
string command = message.Split(' ')[0].ToLower();
|
||||
switch (command)
|
||||
{
|
||||
case "mail":
|
||||
case "tellonym":
|
||||
if (usernameLower != GetUsername().ToLower()
|
||||
&& mailDatabase.Count < Config.MaxDatabaseSize
|
||||
&& mailDatabase.Where(mail => mail.SenderLowercase == usernameLower).Count() < Config.MaxMailsPerPlayer)
|
||||
{
|
||||
Queue<string> args = new(Command.GetArgs(message));
|
||||
if (args.Count >= 2)
|
||||
{
|
||||
bool anonymous = (command == "tellonym");
|
||||
string recipient = args.Dequeue();
|
||||
message = string.Join(" ", args);
|
||||
|
||||
if (IsValidName(recipient))
|
||||
{
|
||||
if (message.Length <= maxMessageLength)
|
||||
{
|
||||
Mail mail = new(username, recipient, message, anonymous, DateTime.Now);
|
||||
LogToConsole(string.Format(Translations.bot_mailer_saving, mail.ToString()));
|
||||
lock (readWriteLock)
|
||||
{
|
||||
mailDatabase.Add(mail);
|
||||
mailDatabase.SaveToFile(Config.DatabaseFile);
|
||||
}
|
||||
SendPrivateMessage(username, "Message saved!");
|
||||
}
|
||||
else SendPrivateMessage(username, "Your message cannot be longer than " + maxMessageLength + " characters.");
|
||||
}
|
||||
else SendPrivateMessage(username, "Recipient '" + recipient + "' is not a valid player name.");
|
||||
}
|
||||
else SendPrivateMessage(username, "Usage: " + command + " <recipient> <message>");
|
||||
}
|
||||
else SendPrivateMessage(username, "Couldn't save Message. Limit reached!");
|
||||
break;
|
||||
}
|
||||
}
|
||||
else LogDebugToConsole(string.Format(Translations.bot_mailer_user_ignored, username));
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Called on each MCC tick, around 10 times per second
|
||||
/// </summary>
|
||||
public override void Update()
|
||||
{
|
||||
DateTime dateNow = DateTime.Now;
|
||||
if (nextMailSend < dateNow)
|
||||
{
|
||||
LogDebugToConsole(string.Format(Translations.bot_mailer_process_mails, DateTime.Now));
|
||||
|
||||
// Process at most 3 mails at a time to avoid spamming. Other mails will be processed on next mail send
|
||||
HashSet<string> onlinePlayersLowercase = new(GetOnlinePlayers().Select(name => name.ToLower()));
|
||||
foreach (Mail mail in mailDatabase.Where(mail => !mail.Delivered && onlinePlayersLowercase.Contains(mail.RecipientLowercase)).Take(3))
|
||||
{
|
||||
string sender = mail.Anonymous ? "Anonymous" : mail.Sender;
|
||||
SendPrivateMessage(mail.Recipient, sender + " mailed: " + mail.Content);
|
||||
mail.SetDelivered();
|
||||
LogDebugToConsole(string.Format(Translations.bot_mailer_delivered, mail.ToString()));
|
||||
}
|
||||
|
||||
lock (readWriteLock)
|
||||
{
|
||||
mailDatabase.RemoveAll(mail => mail.Delivered);
|
||||
mailDatabase.RemoveAll(mail => mail.DateSent.AddDays(Config.MailRetentionDays) < DateTime.Now);
|
||||
mailDatabase.SaveToFile(Config.DatabaseFile);
|
||||
}
|
||||
|
||||
nextMailSend = dateNow.AddSeconds(10);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Called when the Mail Database or Ignore list has changed on disk
|
||||
/// </summary>
|
||||
/// <param name="sender"></param>
|
||||
/// <param name="e"></param>
|
||||
private void FileMonitorCallback(object sender, FileSystemEventArgs e)
|
||||
{
|
||||
lock (readWriteLock)
|
||||
{
|
||||
mailDatabase = MailDatabase.FromFile(Config.DatabaseFile);
|
||||
ignoreList = IgnoreList.FromFile(Config.IgnoreListFile);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue