diff options
Diffstat (limited to '')
11 files changed, 459 insertions, 0 deletions
diff --git a/ExampleBots/MediaModeratorPoC/Bot/AccountData/BotData.cs b/ExampleBots/MediaModeratorPoC/Bot/AccountData/BotData.cs new file mode 100644 index 0000000..9b92948 --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/Bot/AccountData/BotData.cs @@ -0,0 +1,7 @@ +namespace MediaModeratorPoC.Bot.AccountData; + +public class BotData { + public string ControlRoom { get; set; } = ""; + public string? LogRoom { get; set; } = ""; + public string? PolicyRoom { get; set; } = ""; +} diff --git a/ExampleBots/MediaModeratorPoC/Bot/Commands/BanMediaCommand.cs b/ExampleBots/MediaModeratorPoC/Bot/Commands/BanMediaCommand.cs new file mode 100644 index 0000000..d0b5674 --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/Bot/Commands/BanMediaCommand.cs @@ -0,0 +1,66 @@ +using LibMatrix.Responses; +using LibMatrix.StateEventTypes.Spec; +using MediaModeratorPoC.Bot.AccountData; +using MediaModeratorPoC.Bot.Interfaces; +using MediaModeratorPoC.Bot.StateEventTypes; + +namespace MediaModeratorPoC.Bot.Commands; + +public class BanMediaCommand(IServiceProvider services) : ICommand { + public string Name { get; } = "banmedia"; + public string Description { get; } = "Create a policy banning a piece of media, must be used in reply to a message"; + + public async Task<bool> CanInvoke(CommandContext ctx) { + //check if user is admin in control room + var botData = await ctx.Homeserver.GetAccountData<BotData>("gay.rory.media_moderator_poc_data"); + var controlRoom = await ctx.Homeserver.GetRoom(botData.ControlRoom); + var powerLevels = await controlRoom.GetPowerLevelAsync(); + var isAdmin = powerLevels.UserHasPermission(ctx.MessageEvent.Sender, "m.room.ban"); + if (!isAdmin) { + // await ctx.Reply("You do not have permission to use this command!"); + var logRoom = await ctx.Homeserver.GetRoom(botData.LogRoom); + await logRoom.SendMessageEventAsync("m.room.message", new RoomMessageEventData { + Body = $"User {ctx.MessageEvent.Sender} tried to use command {Name} but does not have permission!", + MessageType = "m.text" + }); + } + return isAdmin; + } + + public async Task Invoke(CommandContext ctx) { + //check if reply + if ((ctx.MessageEvent.TypedContent as RoomMessageEventData).RelatesTo is { InReplyTo: not null } ) { + var messageContent = ctx.MessageEvent.TypedContent as RoomMessageEventData; + try { + var botData = await ctx.Homeserver.GetAccountData<BotData>("gay.rory.media_moderator_poc_data"); + var policyRoom = await ctx.Homeserver.GetRoom(botData.PolicyRoom); + var logRoom = await ctx.Homeserver.GetRoom(botData.LogRoom); + await logRoom.SendMessageEventAsync("m.room.message", new RoomMessageEventData { + Body = $"User {ctx.MessageEvent.Sender} is trying to ban media {messageContent.RelatesTo!.InReplyTo!.EventId}", + MessageType = "m.text" + }); + + //get replied message + var repliedMessage = await ctx.Room.GetEvent<StateEventResponse>(messageContent.RelatesTo!.InReplyTo!.EventId); + + await policyRoom.SendStateEventAsync("gay.rory.media_moderator_poc.rule.media", new MediaPolicyStateEventData() { + Entity = (repliedMessage.TypedContent as RoomMessageEventData).Url!, + Reason = string.Join(' ', ctx.Args), + Recommendation = PolicyRecommendationTypes.Ban + }); + } + catch (Exception e) { + await ctx.Room.SendMessageEventAsync("m.room.message", new RoomMessageEventData { + Body = $"Error: {e.Message}", + MessageType = "m.text" + }); + } + } + else { + await ctx.Room.SendMessageEventAsync("m.room.message", new RoomMessageEventData { + Body = "This command must be used in reply to a message!", + MessageType = "m.text", + }); + } + } +} diff --git a/ExampleBots/MediaModeratorPoC/Bot/Commands/CmdCommand.cs b/ExampleBots/MediaModeratorPoC/Bot/Commands/CmdCommand.cs new file mode 100644 index 0000000..14c4334 --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/Bot/Commands/CmdCommand.cs @@ -0,0 +1,46 @@ +using LibMatrix.StateEventTypes.Spec; +using MediaModeratorPoC.Bot.Interfaces; + +namespace MediaModeratorPoC.Bot.Commands; + +public class CmdCommand : ICommand { + public string Name => "cmd"; + public string Description => "Runs a command on the host system"; + + public Task<bool> 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/MediaModeratorPoC/Bot/Commands/HelpCommand.cs b/ExampleBots/MediaModeratorPoC/Bot/Commands/HelpCommand.cs new file mode 100644 index 0000000..8d63daa --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/Bot/Commands/HelpCommand.cs @@ -0,0 +1,25 @@ +using System.Text; +using LibMatrix.StateEventTypes.Spec; +using MediaModeratorPoC.Bot.Interfaces; +using Microsoft.Extensions.DependencyInjection; + +namespace MediaModeratorPoC.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<ICommand>().ToList(); + foreach (var command in commands) { + sb.AppendLine($"- {command.Name}: {command.Description}"); + } + + await ctx.Room.SendMessageEventAsync("m.room.message", new RoomMessageEventData { + MessageType = "m.notice", + Body = sb.ToString() + }); + } +} diff --git a/ExampleBots/MediaModeratorPoC/Bot/Commands/PingCommand.cs b/ExampleBots/MediaModeratorPoC/Bot/Commands/PingCommand.cs new file mode 100644 index 0000000..f9f46c2 --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/Bot/Commands/PingCommand.cs @@ -0,0 +1,15 @@ +using LibMatrix.StateEventTypes.Spec; +using MediaModeratorPoC.Bot.Interfaces; + +namespace MediaModeratorPoC.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/MediaModeratorPoC/Bot/FileStorageProvider.cs b/ExampleBots/MediaModeratorPoC/Bot/FileStorageProvider.cs new file mode 100644 index 0000000..d5b991a --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/Bot/FileStorageProvider.cs @@ -0,0 +1,38 @@ +using System.Text.Json; +using ArcaneLibs.Extensions; +using LibMatrix.Interfaces.Services; +using Microsoft.Extensions.Logging; + +namespace MediaModeratorPoC.Bot; + +public class FileStorageProvider : IStorageProvider { + private readonly ILogger<FileStorageProvider> _logger; + + public string TargetPath { get; } + + /// <summary> + /// Creates a new instance of <see cref="FileStorageProvider" />. + /// </summary> + /// <param name="targetPath"></param> + public FileStorageProvider(string targetPath) { + new Logger<FileStorageProvider>(new LoggerFactory()).LogInformation("test"); + Console.WriteLine($"Initialised FileStorageProvider with path {targetPath}"); + TargetPath = targetPath; + if(!Directory.Exists(targetPath)) { + Directory.CreateDirectory(targetPath); + } + } + + public async Task SaveObjectAsync<T>(string key, T value) => await File.WriteAllTextAsync(Path.Join(TargetPath, key), value?.ToJson()); + + public async Task<T?> LoadObjectAsync<T>(string key) => JsonSerializer.Deserialize<T>(await File.ReadAllTextAsync(Path.Join(TargetPath, key))); + + public Task<bool> ObjectExistsAsync(string key) => Task.FromResult(File.Exists(Path.Join(TargetPath, key))); + + public Task<List<string>> 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/MediaModeratorPoC/Bot/Interfaces/CommandContext.cs b/ExampleBots/MediaModeratorPoC/Bot/Interfaces/CommandContext.cs new file mode 100644 index 0000000..29a5a3f --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/Bot/Interfaces/CommandContext.cs @@ -0,0 +1,14 @@ +using LibMatrix.Homeservers; +using LibMatrix.Responses; +using LibMatrix.RoomTypes; +using LibMatrix.StateEventTypes.Spec; + +namespace MediaModeratorPoC.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..]; + public AuthenticatedHomeserverGeneric Homeserver { get; set; } +} diff --git a/ExampleBots/MediaModeratorPoC/Bot/Interfaces/ICommand.cs b/ExampleBots/MediaModeratorPoC/Bot/Interfaces/ICommand.cs new file mode 100644 index 0000000..a8fce94 --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/Bot/Interfaces/ICommand.cs @@ -0,0 +1,12 @@ +namespace MediaModeratorPoC.Bot.Interfaces; + +public interface ICommand { + public string Name { get; } + public string Description { get; } + + public Task<bool> CanInvoke(CommandContext ctx) { + return Task.FromResult(true); + } + + public Task Invoke(CommandContext ctx); +} \ No newline at end of file diff --git a/ExampleBots/MediaModeratorPoC/Bot/MediaModBot.cs b/ExampleBots/MediaModeratorPoC/Bot/MediaModBot.cs new file mode 100644 index 0000000..1b379c7 --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/Bot/MediaModBot.cs @@ -0,0 +1,179 @@ +using System.Diagnostics.CodeAnalysis; +using System.Text.RegularExpressions; +using ArcaneLibs.Extensions; +using LibMatrix; +using LibMatrix.Homeservers; +using LibMatrix.Responses; +using LibMatrix.RoomTypes; +using LibMatrix.Services; +using LibMatrix.StateEventTypes.Spec; +using MediaModeratorPoC.Bot.AccountData; +using MediaModeratorPoC.Bot.Interfaces; +using MediaModeratorPoC.Bot.StateEventTypes; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; +using Microsoft.Extensions.Logging; + +namespace MediaModeratorPoC.Bot; + +public class MediaModBot : IHostedService { + private readonly HomeserverProviderService _homeserverProviderService; + private readonly ILogger<MediaModBot> _logger; + private readonly MediaModBotConfiguration _configuration; + private readonly IEnumerable<ICommand> _commands; + + private GenericRoom PolicyRoom; + + public MediaModBot(HomeserverProviderService homeserverProviderService, ILogger<MediaModBot> logger, + MediaModBotConfiguration configuration, IServiceProvider services) { + logger.LogInformation("MRUBot hosted service instantiated!"); + _homeserverProviderService = homeserverProviderService; + _logger = logger; + _configuration = configuration; + _logger.LogInformation("Getting commands..."); + _commands = services.GetServices<ICommand>(); + _logger.LogInformation("Got {} commands!", _commands.Count()); + } + + /// <summary>Triggered when the application host is ready to start the service.</summary> + /// <param name="cancellationToken">Indicates that the start process has been aborted.</param> + [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; + } + + BotData botData; + + try { + botData = await hs.GetAccountData<BotData>("gay.rory.media_moderator_poc_data"); + } + catch (Exception e) { + if (e is not MatrixException { ErrorCode: "M_NOT_FOUND" }) { + _logger.LogError("{}", e.ToString()); + throw; + } + + botData = new BotData(); + var creationContent = CreateRoomRequest.CreatePrivate(hs, name: "Media Moderator PoC - Control room", roomAliasName: "media-moderator-poc-control-room"); + creationContent.Invite = _configuration.Admins; + creationContent.CreationContent["type"] = "gay.rory.media_moderator_poc.control_room"; + + botData.ControlRoom = (await hs.CreateRoom(creationContent)).RoomId; + + //set access rules to allow joining via control room + creationContent.InitialState.Add(new StateEvent { + Type = "m.room.join_rules", + StateKey = "", + TypedContent = new JoinRulesEventData() { + JoinRule = "knock_restricted", + Allow = new() { + new JoinRulesEventData.AllowEntry() { + Type = "m.room_membership", + RoomId = botData.ControlRoom + } + } + } + }); + + creationContent.Name = "Media Moderator PoC - Log room"; + creationContent.RoomAliasName = "media-moderator-poc-log-room"; + creationContent.CreationContent["type"] = "gay.rory.media_moderator_poc.log_room"; + botData.LogRoom = (await hs.CreateRoom(creationContent)).RoomId; + + creationContent.Name = "Media Moderator PoC - Policy room"; + creationContent.RoomAliasName = "media-moderator-poc-policy-room"; + creationContent.CreationContent["type"] = "gay.rory.media_moderator_poc.policy_room"; + botData.PolicyRoom = (await hs.CreateRoom(creationContent)).RoomId; + + await hs.SetAccountData("gay.rory.media_moderator_poc_data", botData); + } + + PolicyRoom = await hs.GetRoom(botData.PolicyRoom); + + 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.EndsWith(":conduit.rory.gay")) { + 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: true, 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.notice", + Body = "Command not found!" + }); + return; + } + + var ctx = new CommandContext { + Room = room, + MessageEvent = @event, + Homeserver = hs + }; + if (await command.CanInvoke(ctx)) { + await command.Invoke(ctx); + } + else { + await room.SendMessageEventAsync("m.room.message", + new RoomMessageEventData { + MessageType = "m.notice", + Body = "You do not have permission to run this command!" + }); + } + } + } + }); + await hs.SyncHelper.RunSyncLoop(cancellationToken: cancellationToken); + } + + /// <summary>Triggered when the application host is performing a graceful shutdown.</summary> + /// <param name="cancellationToken">Indicates that the shutdown process should no longer be graceful.</param> + public Task StopAsync(CancellationToken cancellationToken) { + _logger.LogInformation("Shutting down bot!"); + return Task.CompletedTask; + } + + + private async Task<bool> CheckMedia(StateEventResponse @event) { + var stateList = PolicyRoom.GetFullStateAsync(); + await foreach (var state in stateList) { + if(state.Type != "gay.rory.media_moderator_poc.rule.media") continue; + var rule = state.TypedContent as MediaPolicyStateEventData; + rule.Entity = rule.Entity.Replace("\\*", ".*").Replace("\\?", "."); + var regex = new Regex(rule.Entity); + if (regex.IsMatch(@event.RawContent["url"].GetValue<string>())) { + _logger.LogInformation("{url} matched rule {rule}", @event.RawContent["url"], rule.ToJson(ignoreNull: true)); + return true; + } + } + return false; + } +} diff --git a/ExampleBots/MediaModeratorPoC/Bot/MediaModBotConfiguration.cs b/ExampleBots/MediaModeratorPoC/Bot/MediaModBotConfiguration.cs new file mode 100644 index 0000000..c441e2a --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/Bot/MediaModBotConfiguration.cs @@ -0,0 +1,13 @@ +using Microsoft.Extensions.Configuration; + +namespace MediaModeratorPoC.Bot; + +public class MediaModBotConfiguration { + public MediaModBotConfiguration(IConfiguration config) { + config.GetRequiredSection("MediaMod").Bind(this); + } + public string Homeserver { get; set; } = ""; + public string AccessToken { get; set; } = ""; + public string Prefix { get; set; } + public List<string> Admins { get; set; } = new(); +} diff --git a/ExampleBots/MediaModeratorPoC/Bot/StateEventTypes/MediaPolicyStateEventData.cs b/ExampleBots/MediaModeratorPoC/Bot/StateEventTypes/MediaPolicyStateEventData.cs new file mode 100644 index 0000000..812ccf2 --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/Bot/StateEventTypes/MediaPolicyStateEventData.cs @@ -0,0 +1,44 @@ +using System.Text.Json.Serialization; +using LibMatrix.Helpers; +using LibMatrix.Interfaces; + +namespace MediaModeratorPoC.Bot.StateEventTypes; + + +[MatrixEvent(EventName = "gay.rory.media_moderator_poc.rule.media")] +public class MediaPolicyStateEventData : IStateEventType { + /// <summary> + /// Entity this ban applies to, can use * and ? as globs. + /// This is an MXC URI. + /// </summary> + [JsonPropertyName("entity")] + public string Entity { get; set; } + + /// <summary> + /// Reason this user is banned + /// </summary> + [JsonPropertyName("reason")] + public string? Reason { get; set; } + + /// <summary> + /// Suggested action to take + /// </summary> + [JsonPropertyName("recommendation")] + public string? Recommendation { get; set; } + + /// <summary> + /// Expiry time in milliseconds since the unix epoch, or null if the ban has no expiry. + /// </summary> + [JsonPropertyName("support.feline.policy.expiry.rev.2")] //stable prefix: expiry, msc pending + public long? Expiry { get; set; } + + //utils + /// <summary> + /// Readable expiry time, provided for easy interaction + /// </summary> + [JsonPropertyName("gay.rory.matrix_room_utils.readable_expiry_time_utc")] + public DateTime? ExpiryDateTime { + get => Expiry == null ? null : DateTimeOffset.FromUnixTimeMilliseconds(Expiry.Value).DateTime; + set => Expiry = ((DateTimeOffset)value).ToUnixTimeMilliseconds(); + } +} |