mirror of
https://github.com/TeamOctolings/Octobot.git
synced 2025-01-31 09:09:00 +03:00
Macintosh II
c6dd3727c3
mctaylors: - updated readme 7 times (and only adding new logo from /about) - [removed](aeeb3d4399
) bot footer from created event embed on the second try - [changed](4b9b91d9e4
) cdn from discord to upload.systems Octol1ttle: - Guild settings code has been overhauled. Instead of instances of a `GuildConfiguration` class being (de-)serialized when used with listing and setting options provided by reflection, there are now multiple `Option` classes responsible for the type of option they are storing. The classes support getting a value, validating and setting values with Results, and getting a user-friendly representation of these values. This makes use of polymorphism, providing clean and easier to use and refactor code. - Gateway event responders have been split into their own separate files, which should make it easier to find and modify responders when needed. - Warning suppressions regarding unused and never instantiated classes have been replaced by `[ImplicitUse]` annotations provided by `JetBrains.Annotations`. This avoids hiding real issues and provides a better way to suppress false warnings while being explicit. - It is no longer possible to execute some slash commands if they are run without the correct permissions - Dependencies are now more explicitly defined neroduckale: - Made easter eggs case-insensitive --------- Signed-off-by: Macintosh II <95250141+mctaylors@users.noreply.github.com> Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> Co-authored-by: Octol1ttle <l1ttleofficial@outlook.com> Co-authored-by: nrdk <neroduck@vk.com>
154 lines
6.3 KiB
C#
154 lines
6.3 KiB
C#
using System.ComponentModel;
|
|
using System.Text;
|
|
using Boyfriend.Data;
|
|
using Boyfriend.Data.Options;
|
|
using Boyfriend.Services;
|
|
using JetBrains.Annotations;
|
|
using Remora.Commands.Attributes;
|
|
using Remora.Commands.Groups;
|
|
using Remora.Discord.API.Abstractions.Objects;
|
|
using Remora.Discord.API.Abstractions.Rest;
|
|
using Remora.Discord.Commands.Attributes;
|
|
using Remora.Discord.Commands.Conditions;
|
|
using Remora.Discord.Commands.Contexts;
|
|
using Remora.Discord.Commands.Feedback.Services;
|
|
using Remora.Discord.Extensions.Embeds;
|
|
using Remora.Discord.Extensions.Formatting;
|
|
using Remora.Results;
|
|
|
|
namespace Boyfriend.Commands;
|
|
|
|
/// <summary>
|
|
/// Handles the commands to list and modify per-guild settings: /settings and /settings list.
|
|
/// </summary>
|
|
[UsedImplicitly]
|
|
public class SettingsCommandGroup : CommandGroup {
|
|
private static readonly IOption[] AllOptions = {
|
|
GuildSettings.Language,
|
|
GuildSettings.WelcomeMessage,
|
|
GuildSettings.ReceiveStartupMessages,
|
|
GuildSettings.RemoveRolesOnMute,
|
|
GuildSettings.ReturnRolesOnRejoin,
|
|
GuildSettings.AutoStartEvents,
|
|
GuildSettings.PublicFeedbackChannel,
|
|
GuildSettings.PrivateFeedbackChannel,
|
|
GuildSettings.EventNotificationChannel,
|
|
GuildSettings.DefaultRole,
|
|
GuildSettings.MuteRole,
|
|
GuildSettings.EventNotificationRole,
|
|
GuildSettings.EventEarlyNotificationOffset
|
|
};
|
|
|
|
private readonly ICommandContext _context;
|
|
private readonly GuildDataService _dataService;
|
|
private readonly FeedbackService _feedbackService;
|
|
private readonly IDiscordRestUserAPI _userApi;
|
|
|
|
public SettingsCommandGroup(
|
|
ICommandContext context, GuildDataService dataService,
|
|
FeedbackService feedbackService, IDiscordRestUserAPI userApi) {
|
|
_context = context;
|
|
_dataService = dataService;
|
|
_feedbackService = feedbackService;
|
|
_userApi = userApi;
|
|
}
|
|
|
|
/// <summary>
|
|
/// A slash command that lists current per-guild GuildSettings.
|
|
/// </summary>
|
|
/// <returns>
|
|
/// A feedback sending result which may or may not have succeeded.
|
|
/// </returns>
|
|
[Command("settingslist")]
|
|
[DiscordDefaultMemberPermissions(DiscordPermission.ManageGuild)]
|
|
[DiscordDefaultDMPermission(false)]
|
|
[RequireContext(ChannelContext.Guild)]
|
|
[RequireDiscordPermission(DiscordPermission.ManageGuild)]
|
|
[Description("Shows settings list for this server")]
|
|
[UsedImplicitly]
|
|
public async Task<Result> ListSettingsAsync() {
|
|
if (!_context.TryGetContextIDs(out var guildId, out _, out _))
|
|
return Result.FromError(
|
|
new ArgumentNullError(nameof(_context), "Unable to retrieve necessary IDs from command context"));
|
|
|
|
var currentUserResult = await _userApi.GetCurrentUserAsync(CancellationToken);
|
|
if (!currentUserResult.IsDefined(out var currentUser))
|
|
return Result.FromError(currentUserResult);
|
|
|
|
var cfg = await _dataService.GetSettings(guildId.Value, CancellationToken);
|
|
Messages.Culture = GuildSettings.Language.Get(cfg);
|
|
|
|
var builder = new StringBuilder();
|
|
|
|
foreach (var option in AllOptions) {
|
|
builder.Append(Markdown.InlineCode(option.Name))
|
|
.Append(": ");
|
|
builder.AppendLine(option.Display(cfg));
|
|
}
|
|
|
|
var embed = new EmbedBuilder().WithSmallTitle(Messages.SettingsListTitle, currentUser)
|
|
.WithDescription(builder.ToString())
|
|
.WithColour(ColorsList.Default)
|
|
.Build();
|
|
if (!embed.IsDefined(out var built)) return Result.FromError(embed);
|
|
|
|
return (Result)await _feedbackService.SendContextualEmbedAsync(built, ct: CancellationToken);
|
|
}
|
|
|
|
/// <summary>
|
|
/// A slash command that modifies per-guild GuildSettings.
|
|
/// </summary>
|
|
/// <param name="setting">The setting to modify.</param>
|
|
/// <param name="value">The new value of the setting.</param>
|
|
/// <returns>A feedback sending result which may or may not have succeeded.</returns>
|
|
[Command("settings")]
|
|
[DiscordDefaultMemberPermissions(DiscordPermission.ManageGuild)]
|
|
[DiscordDefaultDMPermission(false)]
|
|
[RequireContext(ChannelContext.Guild)]
|
|
[RequireDiscordPermission(DiscordPermission.ManageGuild)]
|
|
[Description("Change settings for this server")]
|
|
[UsedImplicitly]
|
|
public async Task<Result> EditSettingsAsync(
|
|
[Description("The setting whose value you want to change")]
|
|
string setting,
|
|
[Description("Setting value")] string value) {
|
|
if (!_context.TryGetContextIDs(out var guildId, out _, out _))
|
|
return Result.FromError(
|
|
new ArgumentNullError(nameof(_context), "Unable to retrieve necessary IDs from command context"));
|
|
|
|
var currentUserResult = await _userApi.GetCurrentUserAsync(CancellationToken);
|
|
if (!currentUserResult.IsDefined(out var currentUser))
|
|
return Result.FromError(currentUserResult);
|
|
|
|
var cfg = await _dataService.GetSettings(guildId.Value, CancellationToken);
|
|
Messages.Culture = GuildSettings.Language.Get(cfg);
|
|
|
|
var option = AllOptions.Single(
|
|
o => string.Equals(setting, o.Name, StringComparison.InvariantCultureIgnoreCase));
|
|
|
|
var setResult = option.Set(cfg, value);
|
|
if (!setResult.IsSuccess) {
|
|
var failedEmbed = new EmbedBuilder().WithSmallTitle(Messages.SettingNotChanged, currentUser)
|
|
.WithDescription(setResult.Error.Message)
|
|
.WithColour(ColorsList.Red)
|
|
.Build();
|
|
if (!failedEmbed.IsDefined(out var failedBuilt)) return Result.FromError(failedEmbed);
|
|
|
|
return (Result)await _feedbackService.SendContextualEmbedAsync(failedBuilt, ct: CancellationToken);
|
|
}
|
|
|
|
var builder = new StringBuilder();
|
|
|
|
builder.Append(Markdown.InlineCode(option.Name))
|
|
.Append($" {Messages.SettingIsNow} ")
|
|
.Append(option.Display(cfg));
|
|
|
|
var embed = new EmbedBuilder().WithSmallTitle(Messages.SettingSuccessfullyChanged, currentUser)
|
|
.WithDescription(builder.ToString())
|
|
.WithColour(ColorsList.Green)
|
|
.Build();
|
|
if (!embed.IsDefined(out var built)) return Result.FromError(embed);
|
|
|
|
return (Result)await _feedbackService.SendContextualEmbedAsync(built, ct: CancellationToken);
|
|
}
|
|
}
|