BirthdayBot/ApplicationCommands/ConfigModule.cs

308 lines
16 KiB
C#
Raw Normal View History

2022-03-10 22:09:15 +00:00
using BirthdayBot.Data;
using Discord.Interactions;
using System.Text;
namespace BirthdayBot.ApplicationCommands;
[RequireBotModerator]
2022-03-10 23:37:34 +00:00
[Group("config", HelpCmdConfig)]
2022-03-10 22:09:15 +00:00
public class ConfigModule : BotModuleBase {
2022-03-10 23:37:34 +00:00
public const string HelpCmdConfig = "Configure basic settings for the bot.";
public const string HelpCmdAnnounce = "Settings regarding birthday announcements.";
2022-03-11 01:11:43 +00:00
public const string HelpCmdBlocking = "Settings for limiting user access.";
2022-03-10 23:37:34 +00:00
public const string HelpCmdRole = "Settings for roles used by this bot.";
public const string HelpCmdCheck = "Test the bot's current configuration and show the results.";
2022-03-10 22:09:15 +00:00
const string HelpPofxBlankUnset = " Leave blank to unset.";
const string HelpOptChannel = "The corresponding channel to use.";
const string HelpOptRole = "The corresponding role to use.";
2022-03-10 23:37:34 +00:00
[Group("announce", HelpPfxModOnly + HelpCmdAnnounce)]
2022-03-10 22:09:15 +00:00
public class SubCmdsConfigAnnounce : BotModuleBase {
2022-03-11 01:11:43 +00:00
private const string HelpSubCmdChannel = "Set which channel will receive announcement messages.";
private const string HelpSubCmdMessage = "Modify the announcement message.";
private const string HelpSubCmdPing = "Set whether to ping users mentioned in the announcement.";
internal const string ModalCidAnnounce = "edit-announce";
private const string ModalComCidSingle = "msg-single";
private const string ModalComCidMulti = "msg-multi";
2022-03-10 22:09:15 +00:00
[SlashCommand("help", "Show information regarding announcement messages.")]
public async Task CmdAnnounceHelp() {
2022-03-11 01:11:43 +00:00
const string subcommands =
$"`/config announce` - {HelpCmdAnnounce}\n" +
$" ⤷`set-channel` - {HelpSubCmdChannel}\n" +
$" ⤷`set-message` - {HelpSubCmdMessage}\n" +
$" ⤷`set-ping` - {HelpSubCmdPing}";
const string whatIs =
"As the name implies, an announcement message is the messages displayed when somebody's birthday be" +
"arrives. If enabled, an announcment message is shown at midnight respective to the appropriate time zone, " +
"first using the user's local time (if it is known), or else using the server's default time zone, or else " +
"referring back to midnight in Universal Time (UTC).\n\n" +
"To enable announcement messages, use the `set-channel` subcommand.";
const string editMsg =
"The `set-message` subcommand allow moderators to edit the message sent into the announcement channel.\n" +
"Two messages may be provided: `single` sets the message that is displayed when one user has a birthday, and " +
"`multi` sets the message used when two or more users have birthdays. If only one of the two messages " +
"have been set, this bot will use the same message in both cases.\n\n" +
"You may use the token `%n` in your message to specify where the name(s) should appear, otherwise the names " +
"will appear at the very end of your custom message.";
await RespondAsync(embed: new EmbedBuilder()
.WithAuthor("Announcement configuration")
.WithDescription(subcommands)
.AddField("What is an announcement message?", whatIs)
.AddField("Customization", editMsg)
.Build()).ConfigureAwait(false);
2022-03-10 22:09:15 +00:00
}
2022-03-11 01:11:43 +00:00
[SlashCommand("set-channel", HelpPfxModOnly + HelpSubCmdChannel + HelpPofxBlankUnset)]
public async Task CmdSetChannel([Summary(description: HelpOptChannel)] SocketTextChannel? channel = null) {
await DoDatabaseUpdate(Context, s => s.AnnouncementChannel = (long?)channel?.Id);
2022-03-10 22:09:15 +00:00
await RespondAsync(":white_check_mark: The announcement channel has been " +
(channel == null ? "unset." : $"set to **{channel.Name}**."));
}
2022-03-11 01:11:43 +00:00
[SlashCommand("set-message", HelpPfxModOnly + HelpSubCmdMessage)]
2022-03-10 22:09:15 +00:00
public async Task CmdSetMessage() {
2022-03-20 21:10:43 +00:00
using var db = new BotDatabaseContext();
var settings = Context.Guild.GetConfigOrNew(db);
var txtSingle = new TextInputBuilder() {
Label = "Single - Message for one birthday",
CustomId = ModalComCidSingle,
Style = TextInputStyle.Paragraph,
MaxLength = 1500,
Required = false,
Placeholder = BackgroundServices.BirthdayRoleUpdate.DefaultAnnounce,
2022-03-20 21:10:43 +00:00
Value = settings.AnnounceMessage ?? ""
};
var txtMulti = new TextInputBuilder() {
Label = "Multi - Message for multiple birthdays",
CustomId = ModalComCidMulti,
Style = TextInputStyle.Paragraph,
MaxLength = 1500,
Required = false,
Placeholder = BackgroundServices.BirthdayRoleUpdate.DefaultAnnouncePl,
2022-03-20 21:10:43 +00:00
Value = settings.AnnounceMessagePl ?? ""
};
var form = new ModalBuilder()
.WithTitle("Edit announcement message")
.WithCustomId(ModalCidAnnounce)
.AddTextInput(txtSingle)
.AddTextInput(txtMulti)
.Build();
await RespondWithModalAsync(form).ConfigureAwait(false);
}
internal static async Task CmdSetMessageResponse(SocketModal modal, SocketGuildChannel channel,
Dictionary<string, SocketMessageComponentData> data) {
string? newSingle = data[ModalComCidSingle].Value;
string? newMulti = data[ModalComCidMulti].Value;
if (string.IsNullOrWhiteSpace(newSingle)) newSingle = null;
if (string.IsNullOrWhiteSpace(newMulti)) newMulti = null;
2022-03-20 21:10:43 +00:00
using var db = new BotDatabaseContext();
var settings = channel.Guild.GetConfigOrNew(db);
if (settings.IsNew) db.GuildConfigurations.Add(settings);
settings.AnnounceMessage = newSingle;
settings.AnnounceMessagePl = newMulti;
await db.SaveChangesAsync();
await modal.RespondAsync(":white_check_mark: Announcement messages have been updated.");
2022-03-10 22:09:15 +00:00
}
2022-03-11 01:11:43 +00:00
[SlashCommand("set-ping", HelpPfxModOnly + HelpSubCmdPing)]
2022-03-10 22:09:15 +00:00
public async Task CmdSetPing([Summary(description: "Set True to ping users, False to display them normally.")]bool option) {
2022-03-20 08:07:17 +00:00
await DoDatabaseUpdate(Context, s => s.AnnouncePing = option);
2022-03-11 01:11:43 +00:00
await RespondAsync($":white_check_mark: Announcement pings are now **{(option ? "on" : "off")}**.").ConfigureAwait(false);
2022-03-10 22:09:15 +00:00
}
}
2022-03-10 23:37:34 +00:00
[Group("role", HelpPfxModOnly + HelpCmdRole)]
2022-03-10 22:09:15 +00:00
public class SubCmdsConfigRole : BotModuleBase {
[SlashCommand("set-birthday-role", HelpPfxModOnly + "Set the role given to users having a birthday.")]
public async Task CmdSetBRole([Summary(description: HelpOptRole)]SocketRole role) {
if (role.IsEveryone || role.IsManaged) {
await RespondAsync(":x: This role cannot be used for this setting.", ephemeral: true);
return;
}
await DoDatabaseUpdate(Context, s => s.BirthdayRole = (long)role.Id);
2022-03-10 22:09:15 +00:00
await RespondAsync($":white_check_mark: The birthday role has been set to **{role.Name}**.").ConfigureAwait(false);
}
[SlashCommand("set-moderator-role", HelpPfxModOnly + "Designate a role whose members can configure the bot." + HelpPofxBlankUnset)]
public async Task CmdSetModRole([Summary(description: HelpOptRole)]SocketRole? role = null) {
if (role != null && (role.IsEveryone || role.IsManaged)) {
await RespondAsync(":x: This role cannot be used for this setting.", ephemeral: true);
return;
}
2022-03-20 08:07:17 +00:00
await DoDatabaseUpdate(Context, s => s.ModeratorRole = (long?)role?.Id);
2022-03-10 22:09:15 +00:00
await RespondAsync(":white_check_mark: The moderator role has been " +
(role == null ? "unset." : $"set to **{role.Name}**."));
}
}
2022-03-11 01:11:43 +00:00
[Group("block", HelpCmdBlocking)]
public class SubCmdsConfigBlocking : BotModuleBase {
[SlashCommand("add-block", HelpPfxModOnly + "Add a user to the block list.")]
2022-03-11 03:41:45 +00:00
public Task CmdAddBlock([Summary(description: "The user to block.")] SocketGuildUser user) => UpdateBlockAsync(user, true);
2022-03-11 01:11:43 +00:00
[SlashCommand("remove-block", HelpPfxModOnly + "Remove a user from the block list.")]
2022-03-11 03:41:45 +00:00
public Task CmdDelBlock([Summary(description: "The user to unblock.")] SocketGuildUser user) => UpdateBlockAsync(user, false);
2022-03-11 01:11:43 +00:00
2022-03-11 03:41:45 +00:00
private async Task UpdateBlockAsync(SocketGuildUser user, bool setting) {
2022-03-20 08:07:17 +00:00
// setting: true to add (set), false to remove (unset)
using var db = new BotDatabaseContext();
var existing = db.BlocklistEntries
.Where(bl => bl.GuildId == (long)user.Guild.Id && bl.UserId == (long)user.Id).FirstOrDefault();
bool already = (existing != null) == setting;
2022-03-11 01:11:43 +00:00
if (already) {
2022-03-11 03:41:45 +00:00
await RespondAsync($":white_check_mark: User is already {(setting ? "" : "not ")}blocked.").ConfigureAwait(false);
2022-03-20 08:07:17 +00:00
return;
2022-03-11 01:11:43 +00:00
}
2022-03-20 08:07:17 +00:00
if (setting) db.BlocklistEntries.Add(new BlocklistEntry() { GuildId = (long)user.Guild.Id, UserId = (long)user.Id });
else db.Remove(existing!);
await db.SaveChangesAsync();
await RespondAsync($":white_check_mark: {Common.FormatName(user, false)} has been {(setting ? "" : "un")}blocked.");
2022-03-11 01:11:43 +00:00
}
[SlashCommand("set-moderated", HelpPfxModOnly + "Set moderated mode on the server.")]
2022-03-20 08:07:17 +00:00
public async Task CmdSetModerated([Summary(name: "enable", description: "The moderated mode setting.")] bool setting) {
bool current = false;
await DoDatabaseUpdate(Context, s => {
current = s.Moderated;
s.Moderated = setting;
});
bool already = setting == current;
2022-03-11 01:11:43 +00:00
if (already) {
2022-03-20 08:07:17 +00:00
await RespondAsync($":white_check_mark: Moderated mode is already **{(setting ? "en" : "dis")}abled**.");
2022-03-11 01:11:43 +00:00
} else {
await RespondAsync($":white_check_mark: Moderated mode is now **{(setting ? "en" : "dis")}abled**.").ConfigureAwait(false);
}
}
}
2022-03-10 23:37:34 +00:00
[SlashCommand("check", HelpPfxModOnly + HelpCmdCheck)]
2022-03-10 22:09:15 +00:00
public async Task CmdCheck() {
static string DoTestFor(string label, Func<bool> test) => $"{label}: { (test() ? ":white_check_mark: Yes" : ":x: No") }";
2022-03-20 08:07:17 +00:00
2022-03-10 22:09:15 +00:00
SocketTextChannel channel = (SocketTextChannel)Context.Channel;
var guild = Context.Guild;
2022-03-20 08:07:17 +00:00
using var db = new BotDatabaseContext();
var guildconf = guild.GetConfigOrNew(db);
if (!guildconf.IsNew) await db.Entry(guildconf).Collection(t => t.UserEntries).LoadAsync();
2022-03-20 08:07:17 +00:00
var result = new StringBuilder();
2022-03-10 22:09:15 +00:00
result.AppendLine($"Server ID: `{guild.Id}` | Bot shard ID: `{Shard.ShardId:00}`");
2022-03-23 18:09:05 +00:00
result.AppendLine($"Number of registered birthdays: `{ guildconf.UserEntries.Count }`");
result.AppendLine($"Server time zone: `{ (guildconf.GuildTimeZone ?? "Not set - using UTC") }`");
2022-03-10 22:09:15 +00:00
result.AppendLine();
bool hasMembers = Common.HasMostMembersDownloaded(guild);
result.Append(DoTestFor("Bot has obtained the user list", () => hasMembers));
result.AppendLine($" - Has `{guild.DownloadedMemberCount}` of `{guild.MemberCount}` members.");
int bdayCount = default;
2022-03-10 22:09:15 +00:00
result.Append(DoTestFor("Birthday processing", delegate {
if (!hasMembers) return false;
if (guildconf.IsNew) return false;
bdayCount = BackgroundServices.BirthdayRoleUpdate.GetGuildCurrentBirthdays(guildconf.UserEntries, guildconf.GuildTimeZone).Count;
2022-03-10 22:09:15 +00:00
return true;
}));
if (!hasMembers) result.AppendLine(" - Previous step failed.");
else if (guildconf.IsNew) result.AppendLine(" - No data.");
else result.AppendLine($" - `{bdayCount}` user(s) currently having a birthday.");
2022-03-10 22:09:15 +00:00
result.AppendLine();
2022-05-25 16:09:54 +00:00
result.AppendLine(DoTestFor("Birthday role set with `/config role set-birthday-role`", delegate {
2022-03-20 08:07:17 +00:00
if (guildconf.IsNew) return false;
SocketRole? role = guild.GetRole((ulong)(guildconf.BirthdayRole ?? 0));
2022-03-10 22:09:15 +00:00
return role != null;
}));
result.AppendLine(DoTestFor("Birthday role can be managed by bot", delegate {
2022-03-20 08:07:17 +00:00
if (guildconf.IsNew) return false;
SocketRole? role = guild.GetRole((ulong)(guildconf.BirthdayRole ?? 0));
2022-03-10 22:09:15 +00:00
if (role == null) return false;
return guild.CurrentUser.GuildPermissions.ManageRoles && role.Position < guild.CurrentUser.Hierarchy;
}));
result.AppendLine();
SocketTextChannel? announcech = null;
result.AppendLine(DoTestFor("(Optional) Announcement channel set with `bb.config channel`", delegate {
2022-03-20 08:07:17 +00:00
if (guildconf.IsNew) return false;
announcech = guild.GetTextChannel((ulong)(guildconf.AnnouncementChannel ?? 0));
2022-03-10 22:09:15 +00:00
return announcech != null;
}));
string disp = announcech == null ? "announcement channel" : $"<#{announcech.Id}>";
result.AppendLine(DoTestFor($"(Optional) Bot can send messages into { disp }", delegate {
if (announcech == null) return false;
return guild.CurrentUser.GetPermissions(announcech).SendMessages;
}));
await RespondAsync(embed: new EmbedBuilder() {
Author = new EmbedAuthorBuilder() { Name = "Status and config check" },
Description = result.ToString()
}.Build()).ConfigureAwait(false);
const int announceMsgPreviewLimit = 350;
static string prepareAnnouncePreview(string announce) {
string trunc = announce.Length > announceMsgPreviewLimit ? announce[..announceMsgPreviewLimit] + "`(...)`" : announce;
var result = new StringBuilder();
foreach (var line in trunc.Split('\n'))
result.AppendLine($"> {line}");
return result.ToString();
}
2022-03-20 08:07:17 +00:00
if (!guildconf.IsNew && (guildconf.AnnounceMessage != null || guildconf.AnnounceMessagePl != null)) {
2022-03-10 22:09:15 +00:00
var em = new EmbedBuilder().WithAuthor(new EmbedAuthorBuilder() { Name = "Custom announce messages:" });
var dispAnnounces = new StringBuilder("Custom announcement message(s):\n");
2022-03-20 08:07:17 +00:00
if (guildconf.AnnounceMessage != null) {
em = em.AddField("Single", prepareAnnouncePreview(guildconf.AnnounceMessage));
2022-03-10 22:09:15 +00:00
}
2022-03-20 08:07:17 +00:00
if (guildconf.AnnounceMessagePl != null) {
em = em.AddField("Multi", prepareAnnouncePreview(guildconf.AnnounceMessagePl));
2022-03-10 22:09:15 +00:00
}
2022-03-11 03:41:45 +00:00
await ReplyAsync(embed: em.Build()).ConfigureAwait(false);
2022-03-10 22:09:15 +00:00
}
}
[SlashCommand("set-timezone", HelpPfxModOnly + "Configure the time zone to use by default in the server." + HelpPofxBlankUnset)]
public async Task CmdSetTimezone([Summary(description: HelpOptZone)] string? zone = null) {
const string Response = ":white_check_mark: The server's time zone has been ";
if (zone == null) {
await DoDatabaseUpdate(Context, s => s.GuildTimeZone = null);
2022-03-10 22:09:15 +00:00
await RespondAsync(Response + "unset.").ConfigureAwait(false);
} else {
string parsedZone;
try {
parsedZone = ParseTimeZone(zone);
} catch (FormatException e) {
await RespondAsync(e.Message).ConfigureAwait(false);
return;
}
await DoDatabaseUpdate(Context, s => s.GuildTimeZone = parsedZone);
2022-03-20 08:07:17 +00:00
await RespondAsync(Response + $"set to **{parsedZone}**.").ConfigureAwait(false);
2022-03-10 22:09:15 +00:00
}
}
2022-03-20 08:07:17 +00:00
/// <summary>
/// Helper method for updating arbitrary <see cref="GuildConfig"/> values without all the boilerplate.
/// </summary>
/// <param name="valueUpdater">A delegate which modifies <see cref="GuildConfig"/> properties as needed.</param>
private static async Task DoDatabaseUpdate(SocketInteractionContext context, Action<GuildConfig> valueUpdater) {
using var db = new BotDatabaseContext();
var settings = context.Guild.GetConfigOrNew(db);
valueUpdater(settings);
if (settings.IsNew) db.GuildConfigurations.Add(settings);
await db.SaveChangesAsync();
}
2022-03-10 22:09:15 +00:00
}