Merge branch 'v3' of https://gitlab.com/kwoth/nadekobot into v3

docs/guides/windows-guide.md

@@ -21,7 +21,7 @@
 #### Prerequisites
 
 - Windows 8 or later (64-bit)
-- [Create a Discord Bot application and invite the bot to your server](../../creds-guide.md)
+- [Create a Discord Bot application and invite the bot to your server](../creds-guide.md)
 
 **Optional**
 

src/NadekoBot/Modules/Administration/Services/RoleCommandsService.cs

@@ -12,6 +12,8 @@ using LinqToDB;
 using LinqToDB.EntityFrameworkCore;
 using NadekoBot.Db;
 using Serilog;
+using System.Threading;
+using System;
 
 namespace NadekoBot.Modules.Administration.Services
 {
@@ -21,6 +23,11 @@ namespace NadekoBot.Modules.Administration.Services
         private readonly DiscordSocketClient _client;
         private readonly ConcurrentDictionary<ulong, IndexedCollection<ReactionRoleMessage>> _models;
 
+        /// <summary>
+        /// Contains the (Message ID, User ID) of reaction roles that are currently being processed.
+        /// </summary>
+        private readonly ConcurrentHashSet<(ulong, ulong)> _reacting = new();
+
         public RoleCommandsService(DiscordSocketClient client, DbService db,
             Bot bot)
         {
@@ -38,75 +45,58 @@ namespace NadekoBot.Modules.Administration.Services
 
         private Task _client_ReactionAdded(Cacheable<IUserMessage, ulong> msg, ISocketMessageChannel chan, SocketReaction reaction)
         {
-            var _ = Task.Run(async () =>
+            _ = Task.Run(async () =>
             {
-                try
+                if (!reaction.User.IsSpecified ||
+                    reaction.User.Value.IsBot ||
+                    reaction.User.Value is not SocketGuildUser gusr ||
+                    chan is not SocketGuildChannel gch ||
+                    !_models.TryGetValue(gch.Guild.Id, out var confs))
+                    return;
+
+                var conf = confs.FirstOrDefault(x => x.MessageId == msg.Id);
+
+                if (conf is null)
+                    return;
+
+                // compare emote names for backwards compatibility :facepalm:
+                var reactionRole = conf.ReactionRoles.FirstOrDefault(x => x.EmoteName == reaction.Emote.Name || x.EmoteName == reaction.Emote.ToString());
+
+                if (reactionRole != null)
                 {
-                    if (!reaction.User.IsSpecified ||
+                    if (!conf.Exclusive)
-                        reaction.User.Value.IsBot ||
-                        !(reaction.User.Value is SocketGuildUser gusr))
-                        return;
-
-                    if (!(chan is SocketGuildChannel gch))
-                        return;
-
-                    if (!_models.TryGetValue(gch.Guild.Id, out var confs))
-                        return;
-
-                    var conf = confs.FirstOrDefault(x => x.MessageId == msg.Id);
-
-                    if (conf is null)
-                        return;
-
-                    // compare emote names for backwards compatibility :facepalm:
-                    var reactionRole = conf.ReactionRoles.FirstOrDefault(x => x.EmoteName == reaction.Emote.Name || x.EmoteName == reaction.Emote.ToString());
-                    if (reactionRole != null)
                     {
-                        if (conf.Exclusive)
+                        await AddReactionRoleAsync(gusr, reactionRole);
-                        {
+                        return;
-                            var roleIds = conf.ReactionRoles.Select(x => x.RoleId)
-                                .Where(x => x != reactionRole.RoleId)
-                                .Select(x => gusr.Guild.GetRole(x))
-                                .Where(x => x != null);
-
-                            var __ = Task.Run(async () =>
-                            {
-                                try
-                                {
-                                    //if the role is exclusive,
-                                    // remove all other reactions user added to the message
-                                    var dl = await msg.GetOrDownloadAsync().ConfigureAwait(false);
-                                    foreach (var r in dl.Reactions)
-                                    {
-                                        if (r.Key.Name == reaction.Emote.Name)
-                                            continue;
-                                        try { await dl.RemoveReactionAsync(r.Key, gusr).ConfigureAwait(false); } catch { }
-                                        await Task.Delay(100).ConfigureAwait(false);
-                                    }
-                                }
-                                catch { }
-                            });
-                            await gusr.RemoveRolesAsync(roleIds).ConfigureAwait(false);
-                        }
-
-                        var toAdd = gusr.Guild.GetRole(reactionRole.RoleId);
-                        if (toAdd != null && !gusr.Roles.Contains(toAdd))
-                        {
-                            await gusr.AddRolesAsync(new[] { toAdd }).ConfigureAwait(false);
-                        }
                     }
-                    else
+
+                    // If same (message, user) are being processed in an exclusive rero, quit
+                    if (!_reacting.Add((msg.Id, reaction.UserId)))
+                        return;
+
+                    try
                     {
-                        var dl = await msg.GetOrDownloadAsync().ConfigureAwait(false);
+                        var removeExclusiveTask = RemoveExclusiveReactionRoleAsync(msg, gusr, reaction, conf, reactionRole, CancellationToken.None);
-                        await dl.RemoveReactionAsync(reaction.Emote, dl.Author,
+                        var addRoleTask = AddReactionRoleAsync(gusr, reactionRole);
-                            new RequestOptions()
+
-                            {
+                        await Task.WhenAll(removeExclusiveTask, addRoleTask).ConfigureAwait(false);
-                                RetryMode = RetryMode.RetryRatelimit | RetryMode.Retry502
+                    }
-                            }).ConfigureAwait(false);
+                    finally
-                        Log.Warning("User {0} is adding unrelated reactions to the reaction roles message.", dl.Author);
+                    {
+                        // Free (message/user) for another exclusive rero
+                        _reacting.TryRemove((msg.Id, reaction.UserId));
                     }
                 }
-                catch { }
+                else
+                {
+                    var dl = await msg.GetOrDownloadAsync().ConfigureAwait(false);
+                    await dl.RemoveReactionAsync(reaction.Emote, dl.Author,
+                        new RequestOptions()
+                        {
+                            RetryMode = RetryMode.RetryRatelimit | RetryMode.Retry502
+                        }).ConfigureAwait(false);
+                    Log.Warning("User {0} is adding unrelated reactions to the reaction roles message.", dl.Author);
+                }
             });
 
             return Task.CompletedTask;
@@ -114,16 +104,16 @@ namespace NadekoBot.Modules.Administration.Services
 
         private Task _client_ReactionRemoved(Cacheable<IUserMessage, ulong> msg, ISocketMessageChannel chan, SocketReaction reaction)
         {
-            var _ = Task.Run(async () =>
+            _ = Task.Run(async () =>
             {
                 try
                 {
                     if (!reaction.User.IsSpecified ||
                         reaction.User.Value.IsBot ||
-                        !(reaction.User.Value is SocketGuildUser gusr))
+                        reaction.User.Value is not SocketGuildUser gusr)
                         return;
 
-                    if (!(chan is SocketGuildChannel gch))
+                    if (chan is not SocketGuildChannel gch)
                         return;
 
                     if (!_models.TryGetValue(gch.Guild.Id, out var confs))
@@ -193,5 +183,71 @@ namespace NadekoBot.Modules.Administration.Services
                 uow.SaveChanges();
             }
         }
+
+        /// <summary>
+        /// Adds a reaction role to the specified user.
+        /// </summary>
+        /// <param name="user">A Discord guild user.</param>
+        /// <param name="dbRero">The database settings of this reaction role.</param>
+        private Task AddReactionRoleAsync(SocketGuildUser user, ReactionRole dbRero)
+        {
+            var toAdd = user.Guild.GetRole(dbRero.RoleId);
+
+            return (toAdd != null && !user.Roles.Contains(toAdd))
+                ? user.AddRoleAsync(toAdd)
+                : Task.CompletedTask;
+        }
+
+        /// <summary>
+        /// Removes the exclusive reaction roles and reactions from the specified user.
+        /// </summary>
+        /// <param name="reactionMessage">The Discord message that contains the reaction roles.</param>
+        /// <param name="user">A Discord guild user.</param>
+        /// <param name="reaction">The Discord reaction of the user.</param>
+        /// <param name="dbReroMsg">The database entry of the reaction role message.</param>
+        /// <param name="dbRero">The database settings of this reaction role.</param>
+        /// <param name="cToken">A cancellation token to cancel the operation.</param>
+        /// <exception cref="OperationCanceledException">Occurs when the operation is cancelled before it began.</exception>
+        /// <exception cref="TaskCanceledException">Occurs when the operation is cancelled while it's still executing.</exception>
+        private Task RemoveExclusiveReactionRoleAsync(Cacheable<IUserMessage, ulong> reactionMessage, SocketGuildUser user, SocketReaction reaction, ReactionRoleMessage dbReroMsg, ReactionRole dbRero, CancellationToken cToken = default)
+        {
+            cToken.ThrowIfCancellationRequested();
+
+            var roleIds = dbReroMsg.ReactionRoles.Select(x => x.RoleId)
+                .Where(x => x != dbRero.RoleId)
+                .Select(x => user.Guild.GetRole(x))
+                .Where(x => x != null);
+
+            var removeReactionsTask = RemoveOldReactionsAsync(reactionMessage, user, reaction, cToken);
+
+            var removeRolesTask = user.RemoveRolesAsync(roleIds);
+
+            return Task.WhenAll(removeReactionsTask, removeRolesTask);
+        }
+
+        /// <summary>
+        /// Removes old reactions from an exclusive reaction role.
+        /// </summary>
+        /// <param name="reactionMessage">The Discord message that contains the reaction roles.</param>
+        /// <param name="user">A Discord guild user.</param>
+        /// <param name="reaction">The Discord reaction of the user.</param>
+        /// <param name="cToken">A cancellation token to cancel the operation.</param>
+        /// <exception cref="OperationCanceledException">Occurs when the operation is cancelled before it began.</exception>
+        /// <exception cref="TaskCanceledException">Occurs when the operation is cancelled while it's still executing.</exception>
+        private async Task RemoveOldReactionsAsync(Cacheable<IUserMessage, ulong> reactionMessage, SocketGuildUser user, SocketReaction reaction, CancellationToken cToken = default)
+        {
+            cToken.ThrowIfCancellationRequested();
+
+            //if the role is exclusive,
+            // remove all other reactions user added to the message
+            var dl = await reactionMessage.GetOrDownloadAsync().ConfigureAwait(false);
+            foreach (var r in dl.Reactions)
+            {
+                if (r.Key.Name == reaction.Emote.Name)
+                    continue;
+                try { await dl.RemoveReactionAsync(r.Key, user).ConfigureAwait(false); } catch { }
+                await Task.Delay(100, cToken).ConfigureAwait(false);
+            }
+        }
     }
 }