toastie-stuff/SupportChild
2
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages Wiki Activity Actions

Split interview template commands from admin and added delete command

Browse source
This commit is contained in:
Toastie 2024-12-27 02:24:48 +13:00
parent 78994a6263
commit 87e5957ae9
Signed by: toastie_t0ast
GPG key ID: 27F3B6855AFD40A4
4 changed files with 313 additions and 215 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

215
Commands/AdminCommands.cs
View file

@ -1,19 +1,10 @@
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.IO;
using System.Linq;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using DSharpPlus.Commands;
using DSharpPlus.Commands.ContextChecks;
using DSharpPlus.Commands.Processors.SlashCommands;
using DSharpPlus.Entities;
using DSharpPlus.Exceptions;
using DSharpPlus.Interactivity;
using DSharpPlus.Interactivity.Extensions;
using Newtonsoft.Json;
namespace SupportChild.Commands;
@ -168,210 +159,4 @@ public class AdminCommands
Logger.Log("Reloading bot...");
await SupportChild.Reload();
}
[RequireGuild]
[Command("getinterviewtemplate")]
[Description("Provides a copy of the interview template for a category which you can edit and then reupload.")]
public async Task GetInterviewTemplate(SlashCommandContext command,
[Parameter("category")][Description("The category to get the template for.")] DiscordChannel category)
{
if (!category?.IsCategory ?? true)
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "That channel is not a category."
}, true);
return;
}
if (!Database.TryGetCategory(category.Id, out Database.Category categoryData))
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "That category is not registered with the bot."
}, true);
return;
}
string interviewTemplateJSON = Database.GetInterviewTemplateJSON(category.Id);
if (interviewTemplateJSON == null)
{
string defaultTemplate =
"{\n" +
" \"category-id\": \"" + category.Id + "\",\n" +
" \"interview\":\n" +
" {\n" +
" \"message\": \"\",\n" +
" \"type\": \"\",\n" +
" \"color\": \"\",\n" +
" \"paths\":\n" +
" {\n" +
" \n" +
" }\n" +
" }\n" +
"}";
MemoryStream stream = new(Encoding.UTF8.GetBytes(defaultTemplate));
DiscordInteractionResponseBuilder response = new DiscordInteractionResponseBuilder().AddEmbed(new DiscordEmbedBuilder
{
Color = DiscordColor.Green,
Description = "No interview template found for this category. A default template has been generated."
}).AddFile("interview-template-" + category.Id + ".json", stream).AsEphemeral();
await command.RespondAsync(response);
}
else
{
MemoryStream stream = new(Encoding.UTF8.GetBytes(interviewTemplateJSON));
await command.RespondAsync(new DiscordInteractionResponseBuilder().AddFile("interview-template-" + category.Id + ".json", stream).AsEphemeral());
}
}
[RequireGuild]
[Command("setinterviewtemplate")]
[Description("Uploads an interview template file.")]
public async Task SetInterviewTemplate(SlashCommandContext command,
[Parameter("file")][Description("The file containing the template.")] DiscordAttachment file)
{
await command.DeferResponseAsync(true);
if (!file.MediaType?.Contains("application/json") ?? false)
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "The uploaded file is not a JSON file according to Discord."
}, true);
return;
}
Stream stream = await new HttpClient().GetStreamAsync(file.Url);
string json = await new StreamReader(stream).ReadToEndAsync();
try
{
List<string> errors = [];
// Convert it to an interview object to validate the template
Interviews.ValidatedTemplate template = JsonConvert.DeserializeObject<Interviews.ValidatedTemplate>(json, new JsonSerializerSettings()
{
//NullValueHandling = NullValueHandling.Include,
MissingMemberHandling = MissingMemberHandling.Error,
Error = delegate (object sender, Newtonsoft.Json.Serialization.ErrorEventArgs args)
{
// I noticed the main exception mainly has information for developers, not administrators,
// so I switched to using the inner message if available.
if (string.IsNullOrEmpty(args.ErrorContext.Error.InnerException?.Message))
{
errors.Add(args.ErrorContext.Error.Message);
}
else
{
errors.Add(args.ErrorContext.Error.InnerException.Message);
}
Logger.Debug("Exception occured when trying to upload interview template:\n" + args.ErrorContext.Error);
args.ErrorContext.Handled = false;
}
});
DiscordChannel category = await SupportChild.client.GetChannelAsync(template.categoryID);
if (!category.IsCategory)
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "The category ID in the uploaded JSON structure is not a valid category."
}, true);
return;
}
if (!Database.TryGetCategory(category.Id, out Database.Category _))
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "The category ID in the uploaded JSON structure is not a category registered with the bot, use /addcategory first."
}, true);
return;
}
template.interview.Validate(ref errors, out int summaryCount, out int summaryMaxLength);
if (summaryCount > 25)
{
errors.Add("A summary cannot contain more than 25 fields, but you have " + summaryCount + " fields in at least one of your interview branches.");
}
if (summaryMaxLength >= 6000)
{
errors.Add("A summary cannot contain more than 6000 characters, but at least one of your branches has the possibility of its summary reaching " + summaryMaxLength + " characters.");
}
if (errors.Count != 0)
{
string errorString = string.Join("\n\n", errors);
if (errorString.Length > 1500)
{
errorString = errorString.Substring(0, 1500);
}
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "The uploaded JSON structure could not be converted to an interview template.\n\nErrors:\n```\n" + errorString + "\n```",
Footer = new DiscordEmbedBuilder.EmbedFooter()
{
Text = "More detailed information may be available as debug messages in the bot logs."
}
}, true);
return;
}
if (!Database.SetInterviewTemplate(template))
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "An error occured trying to write the new template to database."
}, true);
return;
}
try
{
MemoryStream memStream = new(Encoding.UTF8.GetBytes(Database.GetInterviewTemplateJSON(template.categoryID)));
// Log it if the log channel exists
DiscordChannel logChannel = await SupportChild.client.GetChannelAsync(Config.logChannel);
await logChannel.SendMessageAsync(new DiscordMessageBuilder().AddEmbed(new DiscordEmbedBuilder
{
Color = DiscordColor.Green,
Description = command.User.Mention + " uploaded a new interview template for the `" + category.Name + "` category."
}).AddFile("interview-template-" + template.categoryID + ".json", memStream));
}
catch (NotFoundException)
{
Logger.Error("Could not find the log channel.");
}
}
catch (Exception e)
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "The uploaded JSON structure could not be converted to an interview template.\n\nError message:\n```\n" + e.Message + "\n```"
}, true);
return;
}
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Green,
Description = "Uploaded interview template."
}, true);
}
}

295
Commands/InterviewTemplateCommands.cs Normal file
View file

@ -0,0 +1,295 @@
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.IO;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using DSharpPlus.Commands;
using DSharpPlus.Commands.ContextChecks;
using DSharpPlus.Commands.Processors.SlashCommands;
using DSharpPlus.Entities;
using DSharpPlus.Exceptions;
using Newtonsoft.Json;
using SupportChild.Interviews;
namespace SupportChild.Commands;
[Command("interviewtemplate")]
[Description("Administrative commands.")]
public class InterviewTemplateCommands
{
[RequireGuild]
[Command("get")]
[Description("Provides a copy of the interview template for a category which you can edit and then reupload.")]
public async Task Get(SlashCommandContext command,
[Parameter("category")][Description("The category to get the template for.")] DiscordChannel category)
{
if (!category?.IsCategory ?? true)
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "That channel is not a category."
}, true);
return;
}
if (!Database.TryGetCategory(category.Id, out Database.Category categoryData))
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "That category is not registered with the bot."
}, true);
return;
}
string interviewTemplateJSON = Database.GetInterviewTemplateJSON(category.Id);
if (interviewTemplateJSON == null)
{
string defaultTemplate =
"{\n" +
" \"category-id\": \"" + category.Id + "\",\n" +
" \"interview\":\n" +
" {\n" +
" \"message\": \"\",\n" +
" \"type\": \"\",\n" +
" \"color\": \"\",\n" +
" \"paths\":\n" +
" {\n" +
" \n" +
" }\n" +
" }\n" +
"}";
MemoryStream stream = new(Encoding.UTF8.GetBytes(defaultTemplate));
DiscordInteractionResponseBuilder response = new DiscordInteractionResponseBuilder().AddEmbed(new DiscordEmbedBuilder
{
Color = DiscordColor.Green,
Description = "No interview template found for this category. A default template has been generated."
}).AddFile("interview-template-" + category.Id + ".json", stream).AsEphemeral();
await command.RespondAsync(response);
}
else
{
MemoryStream stream = new(Encoding.UTF8.GetBytes(interviewTemplateJSON));
await command.RespondAsync(new DiscordInteractionResponseBuilder().AddFile("interview-template-" + category.Id + ".json", stream).AsEphemeral());
}
}
[RequireGuild]
[Command("set")]
[Description("Uploads an interview template file.")]
public async Task Set(SlashCommandContext command,
[Parameter("file")][Description("The file containing the template.")] DiscordAttachment file)
{
await command.DeferResponseAsync(true);
if (!file.MediaType?.Contains("application/json") ?? false)
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "The uploaded file is not a JSON file according to Discord."
}, true);
return;
}
Stream stream = await new HttpClient().GetStreamAsync(file.Url);
string json = await new StreamReader(stream).ReadToEndAsync();
try
{
List<string> errors = [];
// Convert it to an interview object to validate the template
Interviews.ValidatedTemplate template = JsonConvert.DeserializeObject<Interviews.ValidatedTemplate>(json, new JsonSerializerSettings()
{
//NullValueHandling = NullValueHandling.Include,
MissingMemberHandling = MissingMemberHandling.Error,
Error = delegate (object sender, Newtonsoft.Json.Serialization.ErrorEventArgs args)
{
// I noticed the main exception mainly has information for developers, not administrators,
// so I switched to using the inner message if available.
if (string.IsNullOrEmpty(args.ErrorContext.Error.InnerException?.Message))
{
errors.Add(args.ErrorContext.Error.Message);
}
else
{
errors.Add(args.ErrorContext.Error.InnerException.Message);
}
Logger.Debug("Exception occured when trying to upload interview template:\n" + args.ErrorContext.Error);
args.ErrorContext.Handled = false;
}
});
DiscordChannel category = await SupportChild.client.GetChannelAsync(template.categoryID);
if (!category.IsCategory)
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "The category ID in the uploaded JSON structure is not a valid category."
}, true);
return;
}
if (!Database.TryGetCategory(category.Id, out Database.Category _))
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "The category ID in the uploaded JSON structure is not a category registered with the bot, use /addcategory first."
}, true);
return;
}
template.interview.Validate(ref errors, out int summaryCount, out int summaryMaxLength);
if (summaryCount > 25)
{
errors.Add("A summary cannot contain more than 25 fields, but you have " + summaryCount + " fields in at least one of your interview branches.");
}
if (summaryMaxLength >= 6000)
{
errors.Add("A summary cannot contain more than 6000 characters, but at least one of your branches has the possibility of its summary reaching " + summaryMaxLength + " characters.");
}
if (errors.Count != 0)
{
string errorString = string.Join("\n\n", errors);
if (errorString.Length > 1500)
{
errorString = errorString.Substring(0, 1500);
}
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "The uploaded JSON structure could not be converted to an interview template.\n\nErrors:\n```\n" + errorString + "\n```",
Footer = new DiscordEmbedBuilder.EmbedFooter()
{
Text = "More detailed information may be available as debug messages in the bot logs."
}
}, true);
return;
}
if (!Database.SetInterviewTemplate(template))
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "An error occured trying to write the new template to database."
}, true);
return;
}
try
{
MemoryStream memStream = new(Encoding.UTF8.GetBytes(Database.GetInterviewTemplateJSON(template.categoryID)));
// Log it if the log channel exists
DiscordChannel logChannel = await SupportChild.client.GetChannelAsync(Config.logChannel);
await logChannel.SendMessageAsync(new DiscordMessageBuilder().AddEmbed(new DiscordEmbedBuilder
{
Color = DiscordColor.Green,
Description = command.User.Mention + " uploaded a new interview template for the `" + category.Name + "` category."
}).AddFile("interview-template-" + template.categoryID + ".json", memStream));
}
catch (NotFoundException)
{
Logger.Error("Could not find the log channel.");
}
}
catch (Exception e)
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "The uploaded JSON structure could not be converted to an interview template.\n\nError message:\n```\n" + e.Message + "\n```"
}, true);
return;
}
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Green,
Description = "Uploaded interview template."
}, true);
}
[RequireGuild]
[Command("delete")]
[Description("Provides a copy of the interview template for a category which you can edit and then reupload.")]
public async Task Delete(SlashCommandContext command,
[Parameter("category")][Description("The category to delete the template for.")] DiscordChannel category)
{
if (!category?.IsCategory ?? true)
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "That channel is not a category."
}, true);
return;
}
if (!Database.TryGetCategory(category.Id, out Database.Category categoryData))
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "That category is not registered with the bot."
}, true);
return;
}
if (!Database.TryGetInterviewTemplate(category.Id, out InterviewQuestion _))
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "That category does not have an interview template."
}, true);
return;
}
MemoryStream memStream = new(Encoding.UTF8.GetBytes(Database.GetInterviewTemplateJSON(category.Id)));
if (!Database.TryDeleteInterviewTemplate(category.Id))
{
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Red,
Description = "A database error occured trying to delete the interview template."
}, true);
return;
}
await command.RespondAsync(new DiscordEmbedBuilder
{
Color = DiscordColor.Green,
Description = "Deleted interview template."
}, true);
try
{
// Log it if the log channel exists
DiscordChannel logChannel = await SupportChild.client.GetChannelAsync(Config.logChannel);
await logChannel.SendMessageAsync(new DiscordMessageBuilder().AddEmbed(new DiscordEmbedBuilder
{
Color = DiscordColor.Green,
Description = command.User.Mention + " deleted the interview template for the `" + category.Name + "` category."
}).AddFile("interview-template-" + category.Id + ".json", memStream));
}
catch (NotFoundException)
{
Logger.Error("Could not find the log channel.");
}
}
}

17
Database.cs
View file

@ -832,6 +832,23 @@ public static class Database
}
}
public static bool TryDeleteInterviewTemplate(ulong categoryID)
{
try
{
using MySqlConnection c = GetConnection();
c.Open();
using MySqlCommand deletion = new MySqlCommand(@"DELETE FROM interview_templates WHERE category_id=@category_id", c);
deletion.Parameters.AddWithValue("@category_id", categoryID);
deletion.Prepare();
return deletion.ExecuteNonQuery() > 0;
}
catch (MySqlException)
{
return false;
}
}
public static bool SaveInterview(ulong channelID, Interviews.InterviewQuestion interview)
{
try

1
SupportChild.cs
View file

@ -182,6 +182,7 @@ internal static class SupportChild
typeof(CloseCommand),
typeof(CreateButtonPanelCommand),
typeof(CreateSelectionBoxPanelCommand),
typeof(InterviewTemplateCommands),
typeof(ListAssignedCommand),
typeof(ListCommand),
typeof(ListInvalidCommand),