Isolate SimplyJPK's Tip Service from his feat/misc-improvements branch

DiscordBot/Modules/TipModule.cs

@@ -0,0 +1,195 @@
+using System.IO;
+using Discord.Commands;
+using DiscordBot.Attributes;
+using DiscordBot.Services;
+using DiscordBot.Services.Tips;
+using DiscordBot.Services.Tips.Components;
+using DiscordBot.Settings;
+
+// ReSharper disable all UnusedMember.Local
+namespace DiscordBot.Modules;
+
+public class TipModule : ModuleBase
+{
+	#region Dependency Injection
+
+	public CommandHandlingService CommandHandlingService { get; set; }
+	public BotSettings Settings { get; set; }
+	public TipService TipService { get; set; }
+
+	#endregion
+
+	[Command("Tip")]
+	[Summary("Find and provide pre-authored tips (images or text) by their keywords.")]
+ 	/* for now */ [RequireModerator] /* maybe Helper too */
+	public async Task Tip(string keywords)
+	{
+		var tips = TipService.GetTips(keywords);
+		if (tips.Count == 0)
+		{
+			await ReplyAsync("No tips for the keywords provided were found.");
+			return;
+		}
+
+		var isAnyTextTips = tips.Any(tip => !string.IsNullOrEmpty(tip.Content));
+		var builder = new EmbedBuilder();
+		if (isAnyTextTips)
+		{
+			// Loop through tips in order, have dot point list of the .Content property in an embed
+			builder
+				.WithTitle("Tip List")
+				.WithDescription("Here are the tips for your keywords:");
+			foreach (var tip in tips)
+			{
+				builder.AddField(tip.Keywords.Count == 1 ? tip.Keywords[0] : "Multiple Keywords", tip.Content);
+			}
+		}
+
+		var attachments = tips
+			.Where(tip => tip.ImagePaths != null && tip.ImagePaths.Any())
+			.SelectMany(tip => tip.ImagePaths)
+			.Select(imagePath => new FileAttachment(TipService.GetTipPath(imagePath)))
+			.ToList();
+
+		if (attachments.Count > 0)
+		{
+			if (isAnyTextTips)
+			{
+				await Context.Channel.SendFilesAsync(attachments, embed: builder.Build());
+			}
+			else
+			{
+				await Context.Channel.SendFilesAsync(attachments);
+			}
+		}
+		else
+		{
+			await ReplyAsync(embed: builder.Build());
+		}
+
+		var ids = string.Join(" ", tips.Select(t => t.Id.ToString()).ToArray());
+		await ReplyAsync($"-# Tip ID {ids}");
+		await Context.Message.DeleteAsync();
+	}
+
+	[Command("AddTip")]
+	[Summary("Add a tip to the database.")]
+	[RequireModerator]
+	public async Task AddTip(string keywords, string content = "")
+	{
+		await TipService.AddTip(Context.Message, keywords, content);
+	}
+
+	[Command("RemoveTip")]
+	[Summary("Remove a tip from the database.")]
+	[RequireModerator]
+	public async Task RemoveTip(ulong tipId)
+	{
+ 		Tip tip = TipService.GetTip(tipId);
+   		if (tip == null)
+	 	{
+			await Context.Channel.SendMessageAsync("No such tip found to be removed.");
+			return;
+   		}
+
+		await TipService.RemoveTip(Context.Message, tip);
+	}
+
+	[Command("ReplaceTip")]
+	[Summary("Replace image content of an existing tip in the database.")]
+	[RequireModerator]
+	public async Task ReplaceTip(ulong tipId, string content = "")
+	{
+ 		Tip tip = TipService.GetTip(tipId);
+   		if (tip == null)
+	 	{
+			await Context.Channel.SendMessageAsync("No such tip found to be replaced.");
+			return;
+   		}
+
+		await TipService.ReplaceTip(Context.Message, tip, content);
+	}
+
+	[Command("DumpTips")]
+	[Summary("For debugging, view the tip index.")]
+	[RequireModerator]
+	public async Task DumpTipDatabase()
+	{
+ 		string json = TipService.DumpTipDatabase();
+   		string prefix = "Tip database index as JSON:\n";
+   		int chunkSize = 1800;
+	 	int chunkTime = 2000;
+   		while (!string.IsNullOrEmpty(json))
+	 	{
+   			string chunk = json;
+			if (json.Length > chunkSize)
+   			{
+				chunk =	json.Substring(0, chunkSize);
+				json = json.Substring(chunkSize);
+			}
+   			else
+	  		{
+	 			json = string.Empty;
+ 			}
+			await Context.Channel.SendMessageAsync(
+				$"{prefix}```\n{chunk}\n```");
+			prefix = string.Empty;
+			if (!string.IsNullOrEmpty(json))
+				await Task.Delay(chunkTime);
+		}
+	}
+
+	[Command("ListTips")]
+	[Summary("List available tips by their keywords.")]
+	[RequireModerator]
+	public async Task ListTips()
+	{
+ 		List<Tip> tips = TipService.GetAllTips().OrderBy(t => t.Id).ToList();
+   		int chunkCount = 10;
+	 	int chunkTime = 2000;
+   		bool first = true;
+
+		while (tips.Count > 0)
+  		{
+			var builder = new EmbedBuilder();
+			if (first)
+			{
+				builder
+					.WithTitle("List of Tips")
+					.WithDescription("Tips available for the following keywords:");
+				first = false;
+			}
+
+			int chunk = 0;
+			while (tips.Count > 0 && chunk < chunkCount)
+   			{
+				string keywords = string.Join("`, `", tips[0].Keywords.OrderBy(k => k));
+				string images = String.Concat(
+    					Enumerable.Repeat(" :frame_photo:",
+	 				tips[0].ImagePaths.Count).ToArray());
+				builder.AddField($"ID: {tips[0].Id} {images}", $"`{keywords}`");
+				tips.RemoveAt(0);
+				chunk++;
+			}
+
+			await ReplyAsync(embed: builder.Build());
+			if (tips.Count > 0)
+   				await Task.Delay(chunkTime);
+	   	}
+	}
+
+	#region CommandList
+	[Command("TipHelp")]
+	[Alias("TipsHelp")]
+	[Summary("Shows available tip database commands.")]
+	public async Task TipHelp()
+	{
+ 		// NOTE: skips the RequireModerator commands, so nearly an empty list
+		foreach (var message in CommandHandlingService.GetCommandListMessages("TipModule", true, true, false))
+		{
+			await ReplyAsync(message);
+		}
+	}
+	#endregion
+
+}

DiscordBot/Program.cs

@@ -4,6 +4,7 @@
 using Discord.WebSocket;
 using DiscordBot.Service;
 using DiscordBot.Services;
+using DiscordBot.Services.Tips;
 using DiscordBot.Settings;
 using DiscordBot.Utils;
 using Microsoft.Extensions.DependencyInjection;
@@ -104,6 +105,7 @@ private IServiceProvider ConfigureServices() =>
             .AddSingleton<ReminderService>()
             .AddSingleton<WeatherService>()
             .AddSingleton<AirportService>()
+            .AddSingleton<TipService>()
             .AddSingleton<CannedResponseService>()
             .AddSingleton<UserExtendedService>()
             .BuildServiceProvider();
@@ -114,4 +116,4 @@ private static void DeserializeSettings()
         _rules = SerializeUtil.DeserializeFile<Rules>(@"Settings/Rules.json");
         _userSettings = SerializeUtil.DeserializeFile<UserSettings>(@"Settings/UserSettings.json");
     }
-}
+}

DiscordBot/Services/Tips/Components/Tip.cs

@@ -0,0 +1,11 @@
+using Discord;
+
+namespace DiscordBot.Services.Tips.Components;
+
+public class Tip: IEntity<ulong>
+{
+	public ulong Id { get; set; }
+	public string Content { get; set; }
+	public List<string> Keywords { get; set; }
+	public List<string> ImagePaths { get; set; }
+}