From 9dcce18cda5317ea1150eed06d6589b6285577e6 Mon Sep 17 00:00:00 2001 From: TheArcaneBrony Date: Mon, 4 Sep 2023 06:29:00 +0200 Subject: Add start of Media Moderator PoC bot --- .../Bot/Commands/CmdCommand.cs | 46 ++++++++ .../Bot/Commands/HelpCommand.cs | 24 +++++ .../Bot/Commands/PingCommand.cs | 15 +++ .../Bot/FileStorageProvider.cs | 39 +++++++ .../Bot/Interfaces/CommandContext.cs | 12 +++ .../Bot/Interfaces/ICommand.cs | 12 +++ ExampleBots/LibMatrix.ExampleBot/Bot/MRUBot.cs | 117 +++++++++++++++++++++ .../Bot/MRUBotConfiguration.cs | 12 +++ .../Bot/StartupTasks/ServerRoomSizeCalulator.cs | 72 +++++++++++++ 9 files changed, 349 insertions(+) create mode 100644 ExampleBots/LibMatrix.ExampleBot/Bot/Commands/CmdCommand.cs create mode 100644 ExampleBots/LibMatrix.ExampleBot/Bot/Commands/HelpCommand.cs create mode 100644 ExampleBots/LibMatrix.ExampleBot/Bot/Commands/PingCommand.cs create mode 100644 ExampleBots/LibMatrix.ExampleBot/Bot/FileStorageProvider.cs create mode 100644 ExampleBots/LibMatrix.ExampleBot/Bot/Interfaces/CommandContext.cs create mode 100644 ExampleBots/LibMatrix.ExampleBot/Bot/Interfaces/ICommand.cs create mode 100644 ExampleBots/LibMatrix.ExampleBot/Bot/MRUBot.cs create mode 100644 ExampleBots/LibMatrix.ExampleBot/Bot/MRUBotConfiguration.cs create mode 100644 ExampleBots/LibMatrix.ExampleBot/Bot/StartupTasks/ServerRoomSizeCalulator.cs (limited to 'ExampleBots/LibMatrix.ExampleBot/Bot') diff --git a/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/CmdCommand.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/CmdCommand.cs new file mode 100644 index 0000000..ca10326 --- /dev/null +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/CmdCommand.cs @@ -0,0 +1,46 @@ +using LibMatrix.ExampleBot.Bot.Interfaces; +using LibMatrix.StateEventTypes.Spec; + +namespace LibMatrix.ExampleBot.Bot.Commands; + +public class CmdCommand : ICommand { + public string Name => "cmd"; + public string Description => "Runs a command on the host system"; + + public Task CanInvoke(CommandContext ctx) { + return Task.FromResult(ctx.MessageEvent.Sender.EndsWith(":rory.gay")); + } + + public async Task Invoke(CommandContext ctx) { + var cmd = ctx.Args.Aggregate("\"", (current, arg) => current + arg + " "); + + cmd = cmd.Trim(); + cmd += "\""; + + await ctx.Room.SendMessageEventAsync("m.room.message", new RoomMessageEventData { + Body = $"Command being executed: `{cmd}`" + }); + + var output = ArcaneLibs.Util.GetCommandOutputSync( + Environment.OSVersion.Platform == PlatformID.Unix ? "/bin/sh" : "cmd.exe", + (Environment.OSVersion.Platform == PlatformID.Unix ? "-c " : "/c ") + cmd) + .Replace("`", "\\`") + .Split("\n").ToList(); + foreach (var _out in output) Console.WriteLine($"{_out.Length:0000} {_out}"); + + var msg = ""; + while (output.Count > 0) { + Console.WriteLine("Adding: " + output[0]); + msg += output[0] + "\n"; + output.RemoveAt(0); + if ((output.Count > 0 && (msg + output[0]).Length > 64000) || output.Count == 0) { + await ctx.Room.SendMessageEventAsync("m.room.message", new RoomMessageEventData { + FormattedBody = $"```ansi\n{msg}\n```", + // Body = Markdig.Markdown.ToHtml(msg), + Format = "org.matrix.custom.html" + }); + msg = ""; + } + } + } +} diff --git a/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/HelpCommand.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/HelpCommand.cs new file mode 100644 index 0000000..69766d1 --- /dev/null +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/HelpCommand.cs @@ -0,0 +1,24 @@ +using System.Text; +using LibMatrix.ExampleBot.Bot.Interfaces; +using LibMatrix.StateEventTypes.Spec; +using Microsoft.Extensions.DependencyInjection; + +namespace LibMatrix.ExampleBot.Bot.Commands; + +public class HelpCommand(IServiceProvider services) : ICommand { + public string Name { get; } = "help"; + public string Description { get; } = "Displays this help message"; + + public async Task Invoke(CommandContext ctx) { + var sb = new StringBuilder(); + sb.AppendLine("Available commands:"); + var commands = services.GetServices().ToList(); + foreach (var command in commands) { + sb.AppendLine($"- {command.Name}: {command.Description}"); + } + + await ctx.Room.SendMessageEventAsync("m.room.message", new RoomMessageEventData { + Body = sb.ToString() + }); + } +} diff --git a/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/PingCommand.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/PingCommand.cs new file mode 100644 index 0000000..a7c65b5 --- /dev/null +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/PingCommand.cs @@ -0,0 +1,15 @@ +using LibMatrix.ExampleBot.Bot.Interfaces; +using LibMatrix.StateEventTypes.Spec; + +namespace LibMatrix.ExampleBot.Bot.Commands; + +public class PingCommand : ICommand { + public string Name { get; } = "ping"; + public string Description { get; } = "Pong!"; + + public async Task Invoke(CommandContext ctx) { + await ctx.Room.SendMessageEventAsync("m.room.message", new RoomMessageEventData { + Body = "pong!" + }); + } +} diff --git a/ExampleBots/LibMatrix.ExampleBot/Bot/FileStorageProvider.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/FileStorageProvider.cs new file mode 100644 index 0000000..2dfcee5 --- /dev/null +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/FileStorageProvider.cs @@ -0,0 +1,39 @@ +using System.Text.Json; +using ArcaneLibs.Extensions; +using LibMatrix.Extensions; +using LibMatrix.Interfaces.Services; +using Microsoft.Extensions.Logging; + +namespace LibMatrix.ExampleBot.Bot; + +public class FileStorageProvider : IStorageProvider { + private readonly ILogger _logger; + + public string TargetPath { get; } + + /// + /// Creates a new instance of . + /// + /// + public FileStorageProvider(string targetPath) { + new Logger(new LoggerFactory()).LogInformation("test"); + Console.WriteLine($"Initialised FileStorageProvider with path {targetPath}"); + TargetPath = targetPath; + if(!Directory.Exists(targetPath)) { + Directory.CreateDirectory(targetPath); + } + } + + public async Task SaveObjectAsync(string key, T value) => await File.WriteAllTextAsync(Path.Join(TargetPath, key), value?.ToJson()); + + public async Task LoadObjectAsync(string key) => JsonSerializer.Deserialize(await File.ReadAllTextAsync(Path.Join(TargetPath, key))); + + public Task ObjectExistsAsync(string key) => Task.FromResult(File.Exists(Path.Join(TargetPath, key))); + + public Task> GetAllKeysAsync() => Task.FromResult(Directory.GetFiles(TargetPath).Select(Path.GetFileName).ToList()); + + public Task DeleteObjectAsync(string key) { + File.Delete(Path.Join(TargetPath, key)); + return Task.CompletedTask; + } +} diff --git a/ExampleBots/LibMatrix.ExampleBot/Bot/Interfaces/CommandContext.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/Interfaces/CommandContext.cs new file mode 100644 index 0000000..ec61a1e --- /dev/null +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/Interfaces/CommandContext.cs @@ -0,0 +1,12 @@ +using LibMatrix.Responses; +using LibMatrix.RoomTypes; +using LibMatrix.StateEventTypes.Spec; + +namespace LibMatrix.ExampleBot.Bot.Interfaces; + +public class CommandContext { + public GenericRoom Room { get; set; } + public StateEventResponse MessageEvent { get; set; } + public string CommandName => (MessageEvent.TypedContent as RoomMessageEventData).Body.Split(' ')[0][1..]; + public string[] Args => (MessageEvent.TypedContent as RoomMessageEventData).Body.Split(' ')[1..]; +} diff --git a/ExampleBots/LibMatrix.ExampleBot/Bot/Interfaces/ICommand.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/Interfaces/ICommand.cs new file mode 100644 index 0000000..393ddbb --- /dev/null +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/Interfaces/ICommand.cs @@ -0,0 +1,12 @@ +namespace LibMatrix.ExampleBot.Bot.Interfaces; + +public interface ICommand { + public string Name { get; } + public string Description { get; } + + public Task CanInvoke(CommandContext ctx) { + return Task.FromResult(true); + } + + public Task Invoke(CommandContext ctx); +} \ No newline at end of file diff --git a/ExampleBots/LibMatrix.ExampleBot/Bot/MRUBot.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/MRUBot.cs new file mode 100644 index 0000000..4f9b173 --- /dev/null +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/MRUBot.cs @@ -0,0 +1,117 @@ +using System.Diagnostics.CodeAnalysis; +using ArcaneLibs.Extensions; +using LibMatrix.ExampleBot.Bot.Interfaces; +using LibMatrix.Extensions; +using LibMatrix.Homeservers; +using LibMatrix.Services; +using LibMatrix.StateEventTypes.Spec; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; +using Microsoft.Extensions.Logging; + +namespace LibMatrix.ExampleBot.Bot; + +public class MRUBot : IHostedService { + private readonly HomeserverProviderService _homeserverProviderService; + private readonly ILogger _logger; + private readonly MRUBotConfiguration _configuration; + private readonly IEnumerable _commands; + + public MRUBot(HomeserverProviderService homeserverProviderService, ILogger logger, + MRUBotConfiguration configuration, IServiceProvider services) { + logger.LogInformation("MRUBot hosted service instantiated!"); + _homeserverProviderService = homeserverProviderService; + _logger = logger; + _configuration = configuration; + _logger.LogInformation("Getting commands..."); + _commands = services.GetServices(); + _logger.LogInformation("Got {} commands!", _commands.Count()); + } + + /// Triggered when the application host is ready to start the service. + /// Indicates that the start process has been aborted. + [SuppressMessage("ReSharper", "FunctionNeverReturns")] + public async Task StartAsync(CancellationToken cancellationToken) { + Directory.GetFiles("bot_data/cache").ToList().ForEach(File.Delete); + AuthenticatedHomeserverGeneric hs; + try { + hs = await _homeserverProviderService.GetAuthenticatedWithToken(_configuration.Homeserver, + _configuration.AccessToken); + } + catch (Exception e) { + _logger.LogError("{}", e.Message); + throw; + } + + await (await hs.GetRoom("!DoHEdFablOLjddKWIp:rory.gay")).JoinAsync(); + + // foreach (var room in await hs.GetJoinedRooms()) { + // if(room.RoomId is "!OGEhHVWSdvArJzumhm:matrix.org") continue; + // foreach (var stateEvent in await room.GetStateAsync>("")) { + // var _ = stateEvent.GetType; + // } + // _logger.LogInformation($"Got room state for {room.RoomId}!"); + // } + + hs.SyncHelper.InviteReceivedHandlers.Add(async Task (args) => { + var inviteEvent = + args.Value.InviteState.Events.FirstOrDefault(x => + x.Type == "m.room.member" && x.StateKey == hs.WhoAmI.UserId); + _logger.LogInformation( + $"Got invite to {args.Key} by {inviteEvent.Sender} with reason: {(inviteEvent.TypedContent as RoomMemberEventData).Reason}"); + if (inviteEvent.Sender.EndsWith(":rory.gay") || inviteEvent.Sender == "@mxidupwitch:the-apothecary.club") { + try { + var senderProfile = await hs.GetProfile(inviteEvent.Sender); + await (await hs.GetRoom(args.Key)).JoinAsync(reason: $"I was invited by {senderProfile.DisplayName ?? inviteEvent.Sender}!"); + } + catch (Exception e) { + _logger.LogError("{}", e.ToString()); + await (await hs.GetRoom(args.Key)).LeaveAsync(reason: "I was unable to join the room: " + e); + } + } + }); + hs.SyncHelper.TimelineEventHandlers.Add(async @event => { + _logger.LogInformation( + "Got timeline event in {}: {}", @event.RoomId, @event.ToJson(indent: false, ignoreNull: true)); + + var room = await hs.GetRoom(@event.RoomId); + // _logger.LogInformation(eventResponse.ToJson(indent: false)); + if (@event is { Type: "m.room.message", TypedContent: RoomMessageEventData message }) { + if (message is { MessageType: "m.text" } && message.Body.StartsWith(_configuration.Prefix)) { + var command = _commands.FirstOrDefault(x => x.Name == message.Body.Split(' ')[0][_configuration.Prefix.Length..]); + if (command == null) { + await room.SendMessageEventAsync("m.room.message", + new RoomMessageEventData { + MessageType = "m.text", + Body = "Command not found!" + }); + return; + } + + var ctx = new CommandContext { + Room = room, + MessageEvent = @event + }; + if (await command.CanInvoke(ctx)) { + await command.Invoke(ctx); + } + else { + await room.SendMessageEventAsync("m.room.message", + new RoomMessageEventData { + MessageType = "m.text", + Body = "You do not have permission to run this command!" + }); + } + } + } + }); + await hs.SyncHelper.RunSyncLoop(cancellationToken: cancellationToken); + } + + /// Triggered when the application host is performing a graceful shutdown. + /// Indicates that the shutdown process should no longer be graceful. + public Task StopAsync(CancellationToken cancellationToken) { + _logger.LogInformation("Shutting down bot!"); + return Task.CompletedTask; + } +} diff --git a/ExampleBots/LibMatrix.ExampleBot/Bot/MRUBotConfiguration.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/MRUBotConfiguration.cs new file mode 100644 index 0000000..c7620df --- /dev/null +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/MRUBotConfiguration.cs @@ -0,0 +1,12 @@ +using Microsoft.Extensions.Configuration; + +namespace LibMatrix.ExampleBot.Bot; + +public class MRUBotConfiguration { + public MRUBotConfiguration(IConfiguration config) { + config.GetRequiredSection("Bot").Bind(this); + } + public string Homeserver { get; set; } = ""; + public string AccessToken { get; set; } = ""; + public string Prefix { get; set; } +} \ No newline at end of file diff --git a/ExampleBots/LibMatrix.ExampleBot/Bot/StartupTasks/ServerRoomSizeCalulator.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/StartupTasks/ServerRoomSizeCalulator.cs new file mode 100644 index 0000000..4785192 --- /dev/null +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/StartupTasks/ServerRoomSizeCalulator.cs @@ -0,0 +1,72 @@ +using System.Diagnostics.CodeAnalysis; +using ArcaneLibs.Extensions; +using LibMatrix.ExampleBot.Bot.Interfaces; +using LibMatrix.Homeservers; +using LibMatrix.Services; +using LibMatrix.StateEventTypes.Spec; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; +using Microsoft.Extensions.Logging; + +namespace LibMatrix.ExampleBot.Bot.StartupTasks; + +public class ServerRoomSizeCalulator : IHostedService { + private readonly HomeserverProviderService _homeserverProviderService; + private readonly ILogger _logger; + private readonly MRUBotConfiguration _configuration; + private readonly IEnumerable _commands; + + public ServerRoomSizeCalulator(HomeserverProviderService homeserverProviderService, ILogger logger, + MRUBotConfiguration configuration, IServiceProvider services) { + logger.LogInformation("Server room size calculator hosted service instantiated!"); + _homeserverProviderService = homeserverProviderService; + _logger = logger; + _configuration = configuration; + } + + /// Triggered when the application host is ready to start the service. + /// Indicates that the start process has been aborted. + [SuppressMessage("ReSharper", "FunctionNeverReturns")] + public async Task StartAsync(CancellationToken cancellationToken) { + Directory.GetFiles("bot_data/cache").ToList().ForEach(File.Delete); + AuthenticatedHomeserverGeneric hs; + try { + hs = await _homeserverProviderService.GetAuthenticatedWithToken(_configuration.Homeserver, + _configuration.AccessToken); + } + catch (Exception e) { + _logger.LogError("{}", e.Message); + throw; + } + + await (await hs.GetRoom("!DoHEdFablOLjddKWIp:rory.gay")).JoinAsync(); + + Dictionary totalRoomSize = new(); + foreach (var room in await hs.GetJoinedRooms()) { + var stateList = room.GetFullStateAsync().ToBlockingEnumerable().ToList(); + var roomSize = stateList.Count; + if (roomSize > 10000) { + await File.AppendAllLinesAsync("large_rooms.txt", new[] { $"{{ \"{room.RoomId}\", {roomSize} }}," }, cancellationToken); + } + + var roomHs = room.RoomId.Split(":")[1]; + if (totalRoomSize.ContainsKey(roomHs)) { + totalRoomSize[roomHs] += roomSize; + } + else { + totalRoomSize.Add(roomHs, roomSize); + } + + _logger.LogInformation($"Got room state for {room.RoomId}!"); + } + + await File.WriteAllTextAsync("server_size.txt", string.Join('\n', totalRoomSize.Select(x => $"{{ \"{x.Key}\", {x.Value} }},")), cancellationToken); + } + + /// Triggered when the application host is performing a graceful shutdown. + /// Indicates that the shutdown process should no longer be graceful. + public Task StopAsync(CancellationToken cancellationToken) { + _logger.LogInformation("Shutting down bot!"); + return Task.CompletedTask; + } +} -- cgit 1.4.1