diff options
38 files changed, 688 insertions, 63 deletions
diff --git a/LibMatrix.ExampleBot/Bot/Commands/CmdCommand.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/CmdCommand.cs index ca10326..ca10326 100644 --- a/LibMatrix.ExampleBot/Bot/Commands/CmdCommand.cs +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/CmdCommand.cs diff --git a/LibMatrix.ExampleBot/Bot/Commands/HelpCommand.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/HelpCommand.cs index 69766d1..69766d1 100644 --- a/LibMatrix.ExampleBot/Bot/Commands/HelpCommand.cs +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/HelpCommand.cs diff --git a/LibMatrix.ExampleBot/Bot/Commands/PingCommand.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/PingCommand.cs index a7c65b5..a7c65b5 100644 --- a/LibMatrix.ExampleBot/Bot/Commands/PingCommand.cs +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/Commands/PingCommand.cs diff --git a/LibMatrix.ExampleBot/Bot/FileStorageProvider.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/FileStorageProvider.cs index 2dfcee5..2dfcee5 100644 --- a/LibMatrix.ExampleBot/Bot/FileStorageProvider.cs +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/FileStorageProvider.cs diff --git a/LibMatrix.ExampleBot/Bot/Interfaces/CommandContext.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/Interfaces/CommandContext.cs index ec61a1e..ec61a1e 100644 --- a/LibMatrix.ExampleBot/Bot/Interfaces/CommandContext.cs +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/Interfaces/CommandContext.cs diff --git a/LibMatrix.ExampleBot/Bot/Interfaces/ICommand.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/Interfaces/ICommand.cs index 393ddbb..393ddbb 100644 --- a/LibMatrix.ExampleBot/Bot/Interfaces/ICommand.cs +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/Interfaces/ICommand.cs diff --git a/LibMatrix.ExampleBot/Bot/MRUBot.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/MRUBot.cs index 4f9b173..4f9b173 100644 --- a/LibMatrix.ExampleBot/Bot/MRUBot.cs +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/MRUBot.cs diff --git a/LibMatrix.ExampleBot/Bot/MRUBotConfiguration.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/MRUBotConfiguration.cs index c7620df..c7620df 100644 --- a/LibMatrix.ExampleBot/Bot/MRUBotConfiguration.cs +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/MRUBotConfiguration.cs diff --git a/LibMatrix.ExampleBot/Bot/StartupTasks/ServerRoomSizeCalulator.cs b/ExampleBots/LibMatrix.ExampleBot/Bot/StartupTasks/ServerRoomSizeCalulator.cs index 4785192..4785192 100644 --- a/LibMatrix.ExampleBot/Bot/StartupTasks/ServerRoomSizeCalulator.cs +++ b/ExampleBots/LibMatrix.ExampleBot/Bot/StartupTasks/ServerRoomSizeCalulator.cs diff --git a/LibMatrix.ExampleBot/LibMatrix.ExampleBot.csproj b/ExampleBots/LibMatrix.ExampleBot/LibMatrix.ExampleBot.csproj index 3101842..1fc421a 100644 --- a/LibMatrix.ExampleBot/LibMatrix.ExampleBot.csproj +++ b/ExampleBots/LibMatrix.ExampleBot/LibMatrix.ExampleBot.csproj @@ -17,12 +17,11 @@ </PropertyGroup> <ItemGroup> - <ProjectReference Include="..\..\ArcaneLibs\ArcaneLibs\ArcaneLibs.csproj" /> - <ProjectReference Include="..\LibMatrix\LibMatrix.csproj" /> + <ProjectReference Include="..\..\..\ArcaneLibs\ArcaneLibs\ArcaneLibs.csproj" /> + <ProjectReference Include="..\..\LibMatrix\LibMatrix.csproj" /> </ItemGroup> <ItemGroup> - <PackageReference Include="ArcaneLibs" Version="1.0.0-preview3020494760.012ed3f" /> <PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0-preview.5.23280.8" /> </ItemGroup> <ItemGroup> diff --git a/LibMatrix.ExampleBot/Program.cs b/ExampleBots/LibMatrix.ExampleBot/Program.cs index 0378ec9..0378ec9 100644 --- a/LibMatrix.ExampleBot/Program.cs +++ b/ExampleBots/LibMatrix.ExampleBot/Program.cs diff --git a/LibMatrix.ExampleBot/Properties/launchSettings.json b/ExampleBots/LibMatrix.ExampleBot/Properties/launchSettings.json index 997e294..997e294 100644 --- a/LibMatrix.ExampleBot/Properties/launchSettings.json +++ b/ExampleBots/LibMatrix.ExampleBot/Properties/launchSettings.json diff --git a/LibMatrix.ExampleBot/appsettings.Development.json b/ExampleBots/LibMatrix.ExampleBot/appsettings.Development.json index 27bbd50..27bbd50 100644 --- a/LibMatrix.ExampleBot/appsettings.Development.json +++ b/ExampleBots/LibMatrix.ExampleBot/appsettings.Development.json diff --git a/LibMatrix.ExampleBot/appsettings.json b/ExampleBots/LibMatrix.ExampleBot/appsettings.json index 5668b53..5668b53 100644 --- a/LibMatrix.ExampleBot/appsettings.json +++ b/ExampleBots/LibMatrix.ExampleBot/appsettings.json 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(); + } +} diff --git a/ExampleBots/MediaModeratorPoC/MediaModeratorPoC.csproj b/ExampleBots/MediaModeratorPoC/MediaModeratorPoC.csproj new file mode 100644 index 0000000..1fc421a --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/MediaModeratorPoC.csproj @@ -0,0 +1,32 @@ +<Project Sdk="Microsoft.NET.Sdk"> + + <PropertyGroup> + <OutputType>Exe</OutputType> + <TargetFramework>net8.0</TargetFramework> + <LangVersion>preview</LangVersion> + <ImplicitUsings>enable</ImplicitUsings> + <Nullable>enable</Nullable> + <PublishAot>false</PublishAot> + <InvariantGlobalization>true</InvariantGlobalization> +<!-- <PublishTrimmed>true</PublishTrimmed>--> +<!-- <PublishReadyToRun>true</PublishReadyToRun>--> +<!-- <PublishSingleFile>true</PublishSingleFile>--> +<!-- <PublishReadyToRunShowWarnings>true</PublishReadyToRunShowWarnings>--> +<!-- <PublishTrimmedShowLinkerSizeComparison>true</PublishTrimmedShowLinkerSizeComparison>--> +<!-- <PublishTrimmedShowLinkerSizeComparisonWarnings>true</PublishTrimmedShowLinkerSizeComparisonWarnings>--> + </PropertyGroup> + + <ItemGroup> + <ProjectReference Include="..\..\..\ArcaneLibs\ArcaneLibs\ArcaneLibs.csproj" /> + <ProjectReference Include="..\..\LibMatrix\LibMatrix.csproj" /> + </ItemGroup> + + <ItemGroup> + <PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0-preview.5.23280.8" /> + </ItemGroup> + <ItemGroup> + <Content Include="appsettings*.json"> + <CopyToOutputDirectory>Always</CopyToOutputDirectory> + </Content> + </ItemGroup> +</Project> diff --git a/ExampleBots/MediaModeratorPoC/Program.cs b/ExampleBots/MediaModeratorPoC/Program.cs new file mode 100644 index 0000000..1bc0c62 --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/Program.cs @@ -0,0 +1,29 @@ +// See https://aka.ms/new-console-template for more information + +using ArcaneLibs; +using LibMatrix.Services; +using MediaModeratorPoC.Bot; +using MediaModeratorPoC.Bot.Interfaces; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; + +Console.WriteLine("Hello, World!"); + +var host = Host.CreateDefaultBuilder(args).ConfigureServices((_, services) => { + services.AddScoped<TieredStorageService>(x => + new TieredStorageService( + cacheStorageProvider: new FileStorageProvider("bot_data/cache/"), + dataStorageProvider: new FileStorageProvider("bot_data/data/") + ) + ); + services.AddSingleton<MediaModBotConfiguration>(); + services.AddRoryLibMatrixServices(); + foreach (var commandClass in new ClassCollector<ICommand>().ResolveFromAllAccessibleAssemblies()) { + Console.WriteLine($"Adding command {commandClass.Name}"); + services.AddScoped(typeof(ICommand), commandClass); + } + + services.AddHostedService<MediaModBot>(); +}).UseConsoleLifetime().Build(); + +await host.RunAsync(); diff --git a/ExampleBots/MediaModeratorPoC/Properties/launchSettings.json b/ExampleBots/MediaModeratorPoC/Properties/launchSettings.json new file mode 100644 index 0000000..997e294 --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/Properties/launchSettings.json @@ -0,0 +1,26 @@ +{ + "$schema": "http://json.schemastore.org/launchsettings.json", + "profiles": { + "Default": { + "commandName": "Project", + "dotnetRunMessages": true, + "environmentVariables": { + + } + }, + "Development": { + "commandName": "Project", + "dotnetRunMessages": true, + "environmentVariables": { + "DOTNET_ENVIRONMENT": "Development" + } + }, + "Local config": { + "commandName": "Project", + "dotnetRunMessages": true, + "environmentVariables": { + "DOTNET_ENVIRONMENT": "Local" + } + } + } +} diff --git a/ExampleBots/MediaModeratorPoC/appsettings.Development.json b/ExampleBots/MediaModeratorPoC/appsettings.Development.json new file mode 100644 index 0000000..a895170 --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/appsettings.Development.json @@ -0,0 +1,22 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Debug", + "System": "Information", + "Microsoft": "Information" + } + }, + "MediaMod": { + // The homeserver to connect to + "Homeserver": "rory.gay", + // The access token to use + "AccessToken": "syt_xxxxxxxxxxxxxxxxx", + // The command prefix + "Prefix": "?", + // List of people who should be invited to the control room + "Admins": [ + "@emma:conduit.rory.gay", + "@emma:rory.gay" + ] + } +} diff --git a/ExampleBots/MediaModeratorPoC/appsettings.json b/ExampleBots/MediaModeratorPoC/appsettings.json new file mode 100644 index 0000000..6ba02f3 --- /dev/null +++ b/ExampleBots/MediaModeratorPoC/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Debug", + "System": "Information", + "Microsoft": "Information" + } + } +} diff --git a/LibMatrix.ExampleBot/large_rooms.txt b/LibMatrix.ExampleBot/large_rooms.txt deleted file mode 100644 index 1d9341d..0000000 --- a/LibMatrix.ExampleBot/large_rooms.txt +++ /dev/null @@ -1,4 +0,0 @@ -{ "!ehXvUhWNASUkSLvAGP:matrix.org", 21957 } -{ "!fRRqjOaQcUbKOfCjvc:anontier.nl", 19117 } -{ "!OGEhHVWSdvArJzumhm:matrix.org", 101457 } -{ "!YTvKGNlinIzlkMTVRl:matrix.org", 30164 } diff --git a/LibMatrix.ExampleBot/server_size.txt b/LibMatrix.ExampleBot/server_size.txt deleted file mode 100644 index f275e42..0000000 --- a/LibMatrix.ExampleBot/server_size.txt +++ /dev/null @@ -1,45 +0,0 @@ -{ "thearcanebrony.net", 178 } -{ "feline.support", 2654 } -{ "waifuhunter.club", 3997 } -{ "rory.gay", 645 } -{ "the-apothecary.club", 7000 } -{ "fairydust.space", 176 } -{ "envs.net", 165 } -{ "anontier.nl", 44935 } -{ "nightshade.fun", 8 } -{ "matrix.org", 185873 } -{ "nerdsin.space", 2647 } -{ "no.lgbtqia.zone", 2084 } -{ "neko.dev", 2668 } -{ "jameskitt616.one", 390 } -{ "matrix.eclipse.org", 8 } -{ "catgirl.cloud", 16 } -{ "pikaviestin.fi", 368 } -{ "masfloss.net", 8 } -{ "pcg.life", 72 } -{ "grin.hu", 176 } -{ "possum.city", 16 } -{ "nixos.org", 8206 } -{ "tu-dresden.de", 9 } -{ "pixie.town", 817 } -{ "pixelthefox.net", 1478 } -{ "koneko.chat", 132 } -{ "arcticfoxes.net", 982 } -{ "hackint.org", 374 } -{ "tchncs.de", 19 } -{ "seirdy.one", 107 } -{ "fosscord.com", 9 } -{ "fachschaften.org", 1851 } -{ "nheko.im", 1884 } -{ "draupnir.midnightthoughts.space", 22 } -{ "privacyguides.org", 809 } -{ "vscape.tk", 124 } -{ "artemislena.eu", 599 } -{ "midov.pl", 2223 } -{ "e2e.zone", 8 } -{ "tastytea.de", 143 } -{ "matrix.nomagic.uk", 337 } -{ "gitter.im", 2586 } -{ "funklause.de", 113 } -{ "hyteck.de", 8 } -{ "alchemi.dev", 446 } \ No newline at end of file diff --git a/LibMatrix/Helpers/SyncHelper.cs b/LibMatrix/Helpers/SyncHelper.cs index de4f3d4..83b1685 100644 --- a/LibMatrix/Helpers/SyncHelper.cs +++ b/LibMatrix/Helpers/SyncHelper.cs @@ -113,6 +113,7 @@ public class SyncHelper { if (sync.Rooms is { Join.Count: > 0 }) { foreach (var updatedRoom in sync.Rooms.Join) { + if(updatedRoom.Value.Timeline is null) continue; foreach (var stateEventResponse in updatedRoom.Value.Timeline.Events) { stateEventResponse.RoomId = updatedRoom.Key; var tasks = TimelineEventHandlers.Select(x => x(stateEventResponse)).ToList(); @@ -178,7 +179,7 @@ public class SyncResult { public class JoinedRoomDataStructure { [JsonPropertyName("timeline")] - public TimelineDataStructure Timeline { get; set; } + public TimelineDataStructure? Timeline { get; set; } [JsonPropertyName("state")] public EventList State { get; set; } diff --git a/LibMatrix/Homeservers/AuthenticatedHomeserverGeneric.cs b/LibMatrix/Homeservers/AuthenticatedHomeserverGeneric.cs index ecac4e4..bb34112 100644 --- a/LibMatrix/Homeservers/AuthenticatedHomeserverGeneric.cs +++ b/LibMatrix/Homeservers/AuthenticatedHomeserverGeneric.cs @@ -6,6 +6,7 @@ using System.Net.Http; using System.Net.Http.Json; using System.Text.Json; using System.Text.Json.Nodes; +using System.Text.Json.Serialization; using System.Threading.Tasks; using LibMatrix.Extensions; using LibMatrix.Helpers; @@ -56,7 +57,10 @@ public class AuthenticatedHomeserverGeneric : RemoteHomeServer { } public async Task<GenericRoom> CreateRoom(CreateRoomRequest creationEvent) { - var res = await _httpClient.PostAsJsonAsync("/_matrix/client/v3/createRoom", creationEvent); + creationEvent.CreationContent["creator"] = UserId; + var res = await _httpClient.PostAsJsonAsync("/_matrix/client/v3/createRoom", creationEvent, new JsonSerializerOptions { + DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull + }); if (!res.IsSuccessStatusCode) { Console.WriteLine($"Failed to create room: {await res.Content.ReadAsStringAsync()}"); throw new InvalidDataException($"Failed to create room: {await res.Content.ReadAsStringAsync()}"); @@ -68,13 +72,14 @@ public class AuthenticatedHomeserverGeneric : RemoteHomeServer { #region Account Data public async Task<T> GetAccountData<T>(string key) { - var res = await _httpClient.GetAsync($"/_matrix/client/v3/user/{UserId}/account_data/{key}"); - if (!res.IsSuccessStatusCode) { - Console.WriteLine($"Failed to get account data: {await res.Content.ReadAsStringAsync()}"); - throw new InvalidDataException($"Failed to get account data: {await res.Content.ReadAsStringAsync()}"); - } - - return await res.Content.ReadFromJsonAsync<T>(); + // var res = await _httpClient.GetAsync($"/_matrix/client/v3/user/{UserId}/account_data/{key}"); + // if (!res.IsSuccessStatusCode) { + // Console.WriteLine($"Failed to get account data: {await res.Content.ReadAsStringAsync()}"); + // throw new InvalidDataException($"Failed to get account data: {await res.Content.ReadAsStringAsync()}"); + // } + // + // return await res.Content.ReadFromJsonAsync<T>(); + return await _httpClient.GetFromJsonAsync<T>($"/_matrix/client/v3/user/{UserId}/account_data/{key}"); } public async Task SetAccountData(string key, object data) { diff --git a/LibMatrix/Responses/CreateRoomRequest.cs b/LibMatrix/Responses/CreateRoomRequest.cs index c1c1697..2c05088 100644 --- a/LibMatrix/Responses/CreateRoomRequest.cs +++ b/LibMatrix/Responses/CreateRoomRequest.cs @@ -7,6 +7,7 @@ using System.Text.Json.Serialization; using System.Text.RegularExpressions; using LibMatrix.Extensions; using LibMatrix.Helpers; +using LibMatrix.Homeservers; using LibMatrix.StateEventTypes.Spec; namespace LibMatrix.Responses; @@ -29,6 +30,9 @@ public class CreateRoomRequest { [JsonPropertyName("initial_state")] public List<StateEvent> InitialState { get; set; } = null!; + /// <summary> + /// One of: ["public", "private"] + /// </summary> [JsonPropertyName("visibility")] public string Visibility { get; set; } = null!; @@ -38,6 +42,9 @@ public class CreateRoomRequest { [JsonPropertyName("creation_content")] public JsonObject CreationContent { get; set; } = new(); + [JsonPropertyName("invite")] + public List<string> Invite { get; set; } + /// <summary> /// For use only when you can't use the CreationContent property /// </summary> @@ -53,9 +60,10 @@ public class CreateRoomRequest { StateEvent.KnownStateEventTypes.FirstOrDefault(x => x.GetCustomAttributes<MatrixEventAttribute>()? .Any(y => y.EventName == event_type) ?? false) ?? typeof(object) - ) + ) }); } + return stateEvent; } set { @@ -75,4 +83,44 @@ public class CreateRoomRequest { return errors; } + + public static CreateRoomRequest CreatePrivate(AuthenticatedHomeserverGeneric hs, string? name = null, string? roomAliasName = null) { + var request = new CreateRoomRequest() { + Name = name ?? "Private Room", + Visibility = "private", + CreationContent = new(), + PowerLevelContentOverride = new() { + EventsDefault = 0, + UsersDefault = 0, + Kick = 50, + Ban = 50, + Invite = 25, + StateDefault = 10, + Redact = 50, + NotificationsPl = new() { + Room = 10 + }, + Events = new() { + { "m.room.avatar", 50 }, + { "m.room.canonical_alias", 50 }, + { "m.room.encryption", 100 }, + { "m.room.history_visibility", 100 }, + { "m.room.name", 50 }, + { "m.room.power_levels", 100 }, + { "m.room.server_acl", 100 }, + { "m.room.tombstone", 100 } + }, + Users = new() { + { + hs.UserId, + 101 + } + } + }, + RoomAliasName = roomAliasName, + InitialState = new() + }; + + return request; + } } diff --git a/LibMatrix/RoomTypes/GenericRoom.cs b/LibMatrix/RoomTypes/GenericRoom.cs index 3ba965b..8ba9a4b 100644 --- a/LibMatrix/RoomTypes/GenericRoom.cs +++ b/LibMatrix/RoomTypes/GenericRoom.cs @@ -4,6 +4,7 @@ using System.IO; using System.Net.Http; using System.Net.Http.Json; using System.Text.Json; +using System.Text.Json.Serialization; using System.Threading.Tasks; using System.Web; using LibMatrix.Extensions; @@ -83,6 +84,7 @@ public class GenericRoom { return res ?? new MessagesResponse(); } + // TODO: should we even error handle here? public async Task<string> GetNameAsync() { try { var res = await GetStateAsync<RoomNameEventData>("m.room.name"); @@ -103,6 +105,8 @@ public class GenericRoom { }); } + + // TODO: rewrite (members endpoint?) public async IAsyncEnumerable<StateEventResponse> GetMembersAsync(bool joinedOnly = true) { var res = GetFullStateAsync(); await foreach (var member in res) { @@ -112,6 +116,9 @@ public class GenericRoom { } } + +#region Utility shortcuts + public async Task<List<string>> GetAliasesAsync() { var res = await GetStateAsync<RoomAliasEventData>("m.room.aliases"); return res.Aliases; @@ -143,6 +150,13 @@ public class GenericRoom { return res.Type; } + public async Task<RoomPowerLevelEventData?> GetPowerLevelAsync() => + await GetStateAsync<RoomPowerLevelEventData>("m.room.power_levels"); + +#endregion + + + public async Task ForgetAsync() => await _httpClient.PostAsync($"/_matrix/client/v3/rooms/{RoomId}/forget", null); @@ -169,7 +183,9 @@ public class GenericRoom { public async Task<EventIdResponse> SendMessageEventAsync(string eventType, RoomMessageEventData content) { var res = await _httpClient.PutAsJsonAsync( - $"/_matrix/client/v3/rooms/{RoomId}/send/{eventType}/" + Guid.NewGuid(), content); + $"/_matrix/client/v3/rooms/{RoomId}/send/{eventType}/" + Guid.NewGuid(), content, new JsonSerializerOptions() { + DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull + }); var resu = await res.Content.ReadFromJsonAsync<EventIdResponse>(); return resu; } @@ -207,4 +223,8 @@ public class GenericRoom { } public readonly SpaceRoom AsSpace; + + public async Task<T> GetEvent<T>(string eventId) { + return await _httpClient.GetFromJsonAsync<T>($"/_matrix/client/v3/rooms/{RoomId}/event/{eventId}"); + } } diff --git a/LibMatrix/StateEventTypes/Spec/JoinRulesEventData.cs b/LibMatrix/StateEventTypes/Spec/JoinRulesEventData.cs index d3da559..08e8f22 100644 --- a/LibMatrix/StateEventTypes/Spec/JoinRulesEventData.cs +++ b/LibMatrix/StateEventTypes/Spec/JoinRulesEventData.cs @@ -12,6 +12,10 @@ public class JoinRulesEventData : IStateEventType { private static string Invite = "invite"; private static string Knock = "knock"; + /// <summary> + /// one of ["public", "invite", "knock", "restricted", "knock_restricted"] + /// "private" is reserved without implementation! + /// </summary> [JsonPropertyName("join_rule")] public string JoinRule { get; set; } diff --git a/LibMatrix/StateEventTypes/Spec/RoomMessageEventData.cs b/LibMatrix/StateEventTypes/Spec/RoomMessageEventData.cs index 5d65237..11a0e82 100644 --- a/LibMatrix/StateEventTypes/Spec/RoomMessageEventData.cs +++ b/LibMatrix/StateEventTypes/Spec/RoomMessageEventData.cs @@ -17,4 +17,24 @@ public class RoomMessageEventData : IStateEventType { [JsonPropertyName("format")] public string Format { get; set; } + + [JsonPropertyName("m.relates_to")] + public MessageRelatesTo? RelatesTo { get; set; } + + /// <summary> + /// Media URI for this message, if any + /// </summary> + [JsonPropertyName("url")] + public string? Url { get; set; } + + public class MessageRelatesTo { + + [JsonPropertyName("m.in_reply_to")] + public MessageInReplyTo? InReplyTo { get; set; } + + public class MessageInReplyTo { + [JsonPropertyName("event_id")] + public string EventId { get; set; } + } + } } |