Fix Starboard's incorrectly showing messages.

GreemDev · GreemDev · commit 4edb9b9ef3ac · 2021-08-16T19:41:22.000-05:00
diff --git a/global.json b/global.json
@@ -0,0 +1,7 @@
+{
+  "sdk": {
+    "version": "5.0",
+    "rollForward": "latestMajor",
+    "allowPrerelease": false
+  }
+}
diff --git a/src/Commands/Modules/StarboardModule.cs b/src/Commands/Modules/StarboardModule.cs
@@ -1,6 +1,8 @@
+using System.Collections.Generic;
 using System.Threading.Tasks;
 using Discord;
 using Discord.WebSocket;
+using Gommon;
 using Qmmands;
 using Volte.Core.Entities;
 using Volte.Services;
@@ -18,39 +20,57 @@ public sealed class StarboardModule : VolteModule
         
         [Command("Channel", "Ch")]
         [Description("Sets the channel to be used by starboard when a message is starred.")]
-        public Task<ActionResult> ChannelAsync(SocketTextChannel channel)
+        public Task<ActionResult> ChannelAsync(
+            [Description("The channel to be used by Starboard.")] SocketTextChannel channel)
         {
-            Context.Modify(data =>
-            {
-                data.Configuration.Starboard.StarboardChannel = channel.Id;
-            });
+            Context.Modify(data => data.Configuration.Starboard.StarboardChannel = channel.Id);
             return Ok($"Successfully set the starboard channel to {MentionUtils.MentionChannel(channel.Id)}.");
         }
 
         [Command("Amount", "Count")]
         [Description("Sets the amount of stars required on a message for it to be posted to the Starboard.")]
-        public Task<ActionResult> AmountAsync(int amount)
+        public Task<ActionResult> AmountAsync(
+            [Description("The desired star count threshold before posting it in the starboard channel.")] int amount)
         {
             if (amount < 1)
-            {
                 return BadRequest("Amount must be larger than zero.");
-            }
+            
+
+            Context.Modify(data => data.Configuration.Starboard.StarsRequiredToPost = amount);
+            
+            return Ok($"Set the amount of stars required to be posted as a starboard message to **{amount}**.");
+        }
 
+        [Command("Setup")]
+        [Description("A one-off command that creates a channel for Starboard, with read-only permissions for everyone, and enables the starboard.")]
+        public async Task<ActionResult> SetupAsync(
+            [Description("The name for the Starboard channel that will be created."), Remainder] string channelName = "starboard")
+        {
+            var channel = await Context.Guild.CreateTextChannelAsync(channelName.Replace(" ", "-"), props =>
+            {
+                props.CategoryId = Context.Channel.CategoryId;
+                props.PermissionOverwrites = new List<Overwrite>
+                {
+                    new Overwrite(Context.Guild.EveryoneRole.Id, PermissionTarget.Role, 
+                        new OverwritePermissions(viewChannel: PermValue.Allow, sendMessages: PermValue.Deny))
+                };
+            });
+            
             Context.Modify(data =>
             {
-                data.Configuration.Starboard.StarsRequiredToPost = amount;
+                data.Configuration.Starboard.Enabled = true;
+                data.Configuration.Starboard.StarboardChannel = channel.Id;
             });
-            return Ok($"Set the amount of stars required to be posted as a starboard message to **{amount}**.");
+            
+            return Ok($"Successfully configured the Starboard functionality, and any starred messages will go to {channel.Mention}.");
         }
 
         [Command("Enable")]
         [Description("Enable or disable the Starboard in this guild.")]
-        public Task<ActionResult> EnableAsync(bool enabled)
+        public Task<ActionResult> EnableAsync(
+            [Description("Whether or not to enable or disable the Starboard.")] bool enabled)
         {
-            Context.Modify(data =>
-            {
-                data.Configuration.Starboard.Enabled = enabled;
-            });
+            Context.Modify(data => data.Configuration.Starboard.Enabled = enabled);
             return Ok(
                 enabled ? "Enabled the Starboard in this Guild." : "Disabled the Starboard in this Guild.");
         }
diff --git a/src/Commands/VolteContext.cs b/src/Commands/VolteContext.cs
@@ -10,7 +10,6 @@
 using Volte.Core;
 using Volte.Core.Entities;
 using Volte.Core.Helpers;
-using Volte.Interactive;
 using Volte.Services;
 
 namespace Volte.Commands
@@ -23,15 +22,13 @@ public static VolteContext Create(SocketMessage msg, IServiceProvider provider)
         // ReSharper disable once SuggestBaseTypeForParameter
         private VolteContext(SocketMessage msg, IServiceProvider provider) : base(provider)
         {
-            if (provider.TryGet<DiscordShardedClient>(out var client))
-                Client = client;
+            Client = provider.Get<DiscordShardedClient>();
             Guild = msg.Channel.Cast<SocketTextChannel>()?.Guild;
             Interactive = provider.Get<InteractiveService>();
             Channel = msg.Channel.Cast<SocketTextChannel>();
             User = msg.Author.Cast<SocketGuildUser>();
             Message = msg.Cast<SocketUserMessage>();
-            if (provider.TryGet<DatabaseService>(out var db))
-                GuildData = db.GetData(Guild);
+            GuildData = provider.Get<DatabaseService>().GetData(Guild);
             Now = DateTime.Now;
         }
 
@@ -44,7 +41,12 @@ private VolteContext(SocketMessage msg, IServiceProvider provider) : base(provid
         public SocketUserMessage Message { get; }
         public GuildData GuildData { get; }
         public DateTime Now { get; }
+        
+        public Embed CreateEmbed(StringBuilder content) => CreateEmbed(content.ToString());
 
+        public Embed CreateEmbed(Action<EmbedBuilder> action) 
+            => CreateEmbedBuilder().Apply(action).Build();
+        
         public Embed CreateEmbed(string content) => CreateEmbedBuilder(content).Build();
 
         public EmbedBuilder CreateEmbedBuilder(string content = null) => new EmbedBuilder()
diff --git a/src/Core/Helpers/AsyncDuplicateLock.cs b/src/Core/Helpers/AsyncDuplicateLock.cs
@@ -3,7 +3,6 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Threading;
 using System.Threading.Tasks;
-using Gommon;
 
 namespace Volte.Core.Helpers
 {
diff --git a/src/Core/Helpers/DiscordHelper.cs b/src/Core/Helpers/DiscordHelper.cs
@@ -150,7 +150,12 @@ public static void RegisterVolteEventHandlers(this DiscordShardedClient client,
             var mod = provider.Get<ModerationService>();
             var starboard = provider.Get<StarboardService>();
 
-            client.Log += m => Task.Run(() => Logger.HandleLogEvent(new LogEventArgs(m)));
+            client.Log += async m =>
+            {
+                if (!(m.Message.ContainsIgnoreCase("unknown dispatch") &&
+                      m.Message.ContainsIgnoreCase("application_command")))
+                    await Task.Run(() => Logger.HandleLogEvent(new LogEventArgs(m)));
+            };
 
             if (provider.TryGet<GuildService>(out var guild))
             {
diff --git a/src/Services/PingChecksService.cs b/src/Services/PingChecksService.cs
@@ -13,8 +13,7 @@ public async Task CheckMessageAsync(MessageReceivedEventArgs args)
             {
                 Logger.Debug(LogSource.Service,
                     "Received a message to check for ping threshold violations.");
-                if (args.Message.MentionedEveryone ||
-                    args.Message.MentionedUsers.Count > 10)
+                if (args.Message.MentionedEveryone || args.Message.MentionedUsers.Count > 10)
                 {
                     await args.Message.DeleteAsync();
                     Logger.Debug(LogSource.Service,
diff --git a/src/Services/QuoteService.cs b/src/Services/QuoteService.cs
@@ -3,6 +3,7 @@
 using System.Threading.Tasks;
 using Discord.WebSocket;
 using Discord;
+using Discord.Rest;
 using Gommon;
 using Volte.Commands;
 using Volte.Core.Entities;
@@ -32,17 +33,9 @@ public async Task<bool> CheckMessageAsync(MessageReceivedEventArgs args)
             var match = JumpUrlPattern.Match(args.Message.Content);
             if (!match.Success) return false;
 
-            if (!ulong.TryParse(match.Groups["GuildId"].Value, out var guildId) ||
-                !ulong.TryParse(match.Groups["ChannelId"].Value, out var channelId) ||
-                !ulong.TryParse(match.Groups["MessageId"].Value, out var messageId)) return false;
-
-            var g = await _client.Rest.GetGuildAsync(guildId);
-            if (g is null) return false;
-            var c = await g.GetTextChannelAsync(channelId);
-            if (c is null) return false;
-
-            var m = await c.GetMessageAsync(messageId);
+            var m = await GetMatchMessageAsync(match);
             if (m is null) return false;
+            
             if (m.Content.IsNullOrWhitespace() && !m.Embeds.IsEmpty()) return false;
 
             await GenerateQuoteEmbed(m, args.Context).SendToAsync(args.Context.Channel)
@@ -54,6 +47,20 @@ await GenerateQuoteEmbed(m, args.Context).SendToAsync(args.Context.Channel)
             return true;
         }
 
+        private async Task<RestMessage> GetMatchMessageAsync(Match match)
+        {
+            if (!ulong.TryParse(match.Groups["GuildId"].Value, out var guildId) ||
+                !ulong.TryParse(match.Groups["ChannelId"].Value, out var channelId) ||
+                !ulong.TryParse(match.Groups["MessageId"].Value, out var messageId)) return null;
+
+            var g = await _client.Rest.GetGuildAsync(guildId);
+            if (g is null) return null;
+            var c = await g.GetTextChannelAsync(channelId);
+            if (c is null) return null;
+
+            return await c.GetMessageAsync(messageId);
+        }
+
         private Embed GenerateQuoteEmbed(IMessage message, VolteContext ctx)
         {
             var e = ctx.CreateEmbedBuilder()
diff --git a/src/Services/StarboardService.cs b/src/Services/StarboardService.cs
@@ -270,13 +270,16 @@ public EmbedBuilder GetStarboardEmbed(IMessage message)
                 .WithAuthor(message.Author)
                 .AddField("Posted", Format.Bold(Format.Url($"#{message.Channel.Name}", message.GetJumpUrl())));
 
-            if (Uri.IsWellFormedUriString(message.Content, UriKind.RelativeOrAbsolute))
-                e.WithImageUrl(message.Content);
-            else if (!message.Attachments.IsEmpty())
+            if (!message.Attachments.IsEmpty() && !message.Content.IsNullOrEmpty())
+                e.WithDescription(message.Content).WithImageUrl(message.Attachments.First().Url);
+            if (message.Attachments.IsEmpty() && !message.Content.IsNullOrEmpty())
+                e.WithDescription(message.Content);
+            if (!message.Attachments.IsEmpty() && message.Content.IsNullOrEmpty())
                 e.WithImageUrl(message.Attachments.First().Url);
 
-            if (message.Attachments.IsEmpty())
-                e.WithDescription(message.Content);
+            if (message.Attachments.Count > 1)
+                e.WithFooter($"This message has {message.Attachments.Count - 1} more attachments. See original message.");
+
             return e;
         }
 

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,6 @@`
`3`	`3`	`using System.Diagnostics.CodeAnalysis;`
`4`	`4`	`using System.Threading;`
`5`	`5`	`using System.Threading.Tasks;`
`6`		`-using Gommon;`
`7`	`6`
`8`	`7`	`namespace Volte.Core.Helpers`
`9`	`8`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,7 @@ public async Task CheckMessageAsync(MessageReceivedEventArgs args)`
`13`	`13`	`{`
`14`	`14`	`Logger.Debug(LogSource.Service,`
`15`	`15`	`"Received a message to check for ping threshold violations.");`
`16`		`- if (args.Message.MentionedEveryone \|\|`
`17`		`- args.Message.MentionedUsers.Count > 10)`
	`16`	`+ if (args.Message.MentionedEveryone \|\| args.Message.MentionedUsers.Count > 10)`
`18`	`17`	`{`
`19`	`18`	`await args.Message.DeleteAsync();`
`20`	`19`	`Logger.Debug(LogSource.Service,`