Merge pull request #27 from alopezlago/alopezlago/v3

v3 update: remove explicit text/voice channel pairing in config file, and several improvements

APACHE_LICENSE.txt

@@ -0,0 +1,204 @@
+This applies to the EntityFramework and Sqlite DLLs (Microsoft.EntityFramework.*.dll, SQLite*.dll)
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

QuizBowlDiscordScoreTracker/Bot.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.Linq;
@@ -17,6 +18,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Options;
+using QuizBowlDiscordScoreTracker.Database;
 using QuizBowlDiscordScoreTracker.Web;
 using Serilog;
 
@@ -25,7 +27,7 @@ namespace QuizBowlDiscordScoreTracker
     // TODO: Refactor this so that most of the methods are in a separate class that is easily testable.
     public sealed class Bot : BackgroundService
     {
-        private static readonly Regex BuzzRegex = new Regex("^bu?z+$", RegexOptions.IgnoreCase);
+        private static readonly Regex BuzzRegex = new Regex("^\\s*bu?z+\\s*$", RegexOptions.IgnoreCase);
 
         // TODO: We may need a lock for this, and this lock would need to be accessible form BotCommands. We could wrap
         // this in an object which would do the locking for us.
@@ -37,6 +39,7 @@ public sealed class Bot : BackgroundService
         private readonly ILogger logger;
         private readonly DiscordNetEventLogger discordNetEventLogger;
         private readonly IDisposable configurationChangeCallback;
+        private readonly IDatabaseActionFactory dbActionFactory;
 
         [SuppressMessage("Code Quality", "CA2213:Disposable fields should be disposed", Justification = "Dispose method is inaccessible")]
         private readonly CommandService commandService;
@@ -58,6 +61,7 @@ public Bot(IOptionsMonitor<BotConfiguration> options, IHubContext<MonitorHub> hu
             this.hubContext = hubContext;
             this.gameStateManager = new GameStateManager();
             this.options = options;
+            this.dbActionFactory = new SqliteDatabaseActionFactory(this.options.CurrentValue.DatabaseDataSource);
 
             // TODO: Rewrite this so that
             // #1: buzz emojis are server-dependent, since emojis are
@@ -75,6 +79,7 @@ public Bot(IOptionsMonitor<BotConfiguration> options, IHubContext<MonitorHub> hu
             serviceCollection.AddSingleton(this.client);
             serviceCollection.AddSingleton(this.gameStateManager);
             serviceCollection.AddSingleton(this.options);
+            serviceCollection.AddSingleton(this.dbActionFactory);
             this.serviceProvider = serviceCollection.BuildServiceProvider();
 
             this.commandService = new CommandService(new CommandServiceConfig()
@@ -109,6 +114,7 @@ public override void Dispose()
             this.discordNetEventLogger.Dispose();
             this.configurationChangeCallback.Dispose();
             this.client.Dispose();
+            base.Dispose();
         }
 
         private static IEnumerable<Regex> BuildBuzzEmojiRegexes(BotConfiguration options)
@@ -135,10 +141,19 @@ private static IEnumerable<Regex> BuildBuzzEmojiRegexes(BotConfiguration options
 
         protected override async Task ExecuteAsync(CancellationToken stoppingToken)
         {
+            // Make sure the database exists
+            using (DatabaseAction action = this.dbActionFactory.Create())
+            {
+                await action.MigrateAsync();
+            }
+
+            stoppingToken.ThrowIfCancellationRequested();
+
             // TODO: If we go to a more proper service architecture, move more of the initialization logic from the
             // constructor to here, since we could start/stop the client multiple times.
             string token = this.options.CurrentValue.BotToken;
             await this.client.LoginAsync(TokenType.Bot, token);
+            stoppingToken.ThrowIfCancellationRequested();
             await this.client.StartAsync();
         }
 
@@ -148,19 +163,31 @@ public override Task StopAsync(CancellationToken cancellationToken)
             return base.StopAsync(cancellationToken);
         }
 
-        private async Task<Tuple<IVoiceChannel, IGuildUser>> MuteReader(
-            ITextChannel textChannel, string voiceChannelName, ulong? readerId)
+        private async Task<Tuple<IVoiceChannel, IGuildUser>> MuteReader(ITextChannel textChannel, ulong? readerId)
         {
-            IGuildUser reader = null;
+            Stopwatch stopwatch = new Stopwatch();
+            stopwatch.Start();
+            ulong? voiceChannelId = null;
+            using (DatabaseAction action = this.dbActionFactory.Create())
+            {
+                voiceChannelId = await action.GetPairedVoiceChannelIdOrNullAsync(textChannel.Id);
+            }
+
+            stopwatch.Stop();
+            this.logger.Verbose($"Time to get paired channel: {stopwatch.ElapsedMilliseconds} ms");
 
-            IReadOnlyCollection<IVoiceChannel> voiceChannels = await textChannel.Guild.GetVoiceChannelsAsync();
-            IVoiceChannel voiceChannel = voiceChannels.FirstOrDefault(channel => channel.Name == voiceChannelName);
+            if (voiceChannelId == null)
+            {
+                return null;
+            }
+
+            IVoiceChannel voiceChannel = await textChannel.Guild.GetVoiceChannelAsync(voiceChannelId.Value);
             if (voiceChannel == null)
             {
                 return null;
             }
 
-            reader = await textChannel.Guild.GetUserAsync(readerId.Value);
+            IGuildUser reader = await textChannel.Guild.GetUserAsync(readerId.Value);
             try
             {
                 // Make sure the reader didn't mute themselves or leave the voice channel
@@ -187,18 +214,15 @@ private async Task PromptNextPlayer(GameState state, ITextChannel textChannel)
         {
             if (state.TryGetNextPlayer(out ulong userId))
             {
-                Tuple<IVoiceChannel, IGuildUser> voiceChannelReaderPair = null;
-                if (this.options.CurrentValue.TryGetVoiceChannelName(
-                    textChannel.Guild.Name, textChannel.Name, out string voiceChannelName))
-                {
-                    voiceChannelReaderPair = await this.MuteReader(textChannel, voiceChannelName, state.ReaderId);
-                }
-
                 IGuildUser user = await textChannel.Guild.GetUserAsync(userId);
-                await textChannel.SendMessageAsync(user.Mention);
-                await this.hubContext.Clients.Group(GroupFromChannel(textChannel))
+                Task<Tuple<IVoiceChannel, IGuildUser>> getVoiceChannelReaderPair = this.MuteReader(
+                    textChannel, state.ReaderId);
+                Task sendMessage = textChannel.SendMessageAsync(user.Mention);
+                Task alertWebSocket = this.hubContext.Clients.Group(GroupFromChannel(textChannel))
                     .SendAsync("PlayerBuzz", user.Nickname ?? user.Username);
+                await Task.WhenAll(getVoiceChannelReaderPair, sendMessage, alertWebSocket);
 
+                Tuple<IVoiceChannel, IGuildUser> voiceChannelReaderPair = getVoiceChannelReaderPair.Result;
                 if (voiceChannelReaderPair != null)
                 {
                     // We want to run this on a separate thread and not block the event handler
@@ -232,7 +256,6 @@ private async Task OnMessageCreated(SocketMessage message)
             // Some commands may need to be taken in DM channels. Everything for handling buzzes and scoring should be
             // on the main channel 
             if (!(userMessage.Channel is ITextChannel channel &&
-                this.options.CurrentValue.IsTextSupportedChannel(channel.Guild.Name, channel.Name) &&
                 this.gameStateManager.TryGet(channel.Id, out GameState state)))
             {
                 return;