forked from TeamInklings/Octobot
Add filtering by message author to /clear (#169)
Closes #164 This PR adds an optional argument to `/clear` - `author` of type User. If the user is specified, only messages sent by that user will be cleared. Simple as that.
This commit is contained in:
parent
687883bbf8
commit
b30d690113
5 changed files with 56 additions and 5 deletions
|
@ -564,4 +564,10 @@
|
||||||
<data name="GuildInfoBoostCount" xml:space="preserve">
|
<data name="GuildInfoBoostCount" xml:space="preserve">
|
||||||
<value>Boost count</value>
|
<value>Boost count</value>
|
||||||
</data>
|
</data>
|
||||||
|
<data name="NoMessagesToClear" xml:space="preserve">
|
||||||
|
<value>There are no messages matching your filter!</value>
|
||||||
|
</data>
|
||||||
|
<data name="MessagesClearedFiltered" xml:space="preserve">
|
||||||
|
<value>Cleared {0} messages from {1}</value>
|
||||||
|
</data>
|
||||||
</root>
|
</root>
|
||||||
|
|
|
@ -564,4 +564,10 @@
|
||||||
<data name="GuildInfoBoostCount" xml:space="preserve">
|
<data name="GuildInfoBoostCount" xml:space="preserve">
|
||||||
<value>Количество бустов</value>
|
<value>Количество бустов</value>
|
||||||
</data>
|
</data>
|
||||||
|
<data name="NoMessagesToClear" xml:space="preserve">
|
||||||
|
<value>Нет сообщений, которые подходят под твой фильтр!</value>
|
||||||
|
</data>
|
||||||
|
<data name="MessagesClearedFiltered" xml:space="preserve">
|
||||||
|
<value>Очищено {0} сообщений от {1}</value>
|
||||||
|
</data>
|
||||||
</root>
|
</root>
|
||||||
|
|
|
@ -564,4 +564,10 @@
|
||||||
<data name="GuildInfoBoostCount" xml:space="preserve">
|
<data name="GuildInfoBoostCount" xml:space="preserve">
|
||||||
<value>кол-во бустов</value>
|
<value>кол-во бустов</value>
|
||||||
</data>
|
</data>
|
||||||
|
<data name="NoMessagesToClear" xml:space="preserve">
|
||||||
|
<value>алло а чё мне удалять-то</value>
|
||||||
|
</data>
|
||||||
|
<data name="MessagesClearedFiltered" xml:space="preserve">
|
||||||
|
<value>вырезано {0} забавных сообщений от {1}</value>
|
||||||
|
</data>
|
||||||
</root>
|
</root>
|
||||||
|
|
|
@ -45,9 +45,10 @@ public class ClearCommandGroup : CommandGroup
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// A slash command that clears messages in the channel it was executed.
|
/// A slash command that clears messages in the channel it was executed, optionally filtering by message author.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="amount">The amount of messages to clear.</param>
|
/// <param name="amount">The amount of messages to clear.</param>
|
||||||
|
/// <param name="author">The user whose messages will be cleared.</param>
|
||||||
/// <returns>
|
/// <returns>
|
||||||
/// A feedback sending result which may or may not have succeeded. A successful result does not mean that any messages
|
/// A feedback sending result which may or may not have succeeded. A successful result does not mean that any messages
|
||||||
/// were cleared and vice-versa.
|
/// were cleared and vice-versa.
|
||||||
|
@ -62,7 +63,8 @@ public class ClearCommandGroup : CommandGroup
|
||||||
[UsedImplicitly]
|
[UsedImplicitly]
|
||||||
public async Task<Result> ExecuteClear(
|
public async Task<Result> ExecuteClear(
|
||||||
[Description("Number of messages to remove (2-100)")] [MinValue(2)] [MaxValue(100)]
|
[Description("Number of messages to remove (2-100)")] [MinValue(2)] [MaxValue(100)]
|
||||||
int amount)
|
int amount,
|
||||||
|
IUser? author = null)
|
||||||
{
|
{
|
||||||
if (!_context.TryGetContextIDs(out var guildId, out var channelId, out var executorId))
|
if (!_context.TryGetContextIDs(out var guildId, out var channelId, out var executorId))
|
||||||
{
|
{
|
||||||
|
@ -92,11 +94,11 @@ public class ClearCommandGroup : CommandGroup
|
||||||
var data = await _guildData.GetData(guildId, CancellationToken);
|
var data = await _guildData.GetData(guildId, CancellationToken);
|
||||||
Messages.Culture = GuildSettings.Language.Get(data.Settings);
|
Messages.Culture = GuildSettings.Language.Get(data.Settings);
|
||||||
|
|
||||||
return await ClearMessagesAsync(executor, amount, data, channelId, messages, bot, CancellationToken);
|
return await ClearMessagesAsync(executor, author, data, channelId, messages, bot, CancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
private async Task<Result> ClearMessagesAsync(
|
private async Task<Result> ClearMessagesAsync(
|
||||||
IUser executor, int amount, GuildData data, Snowflake channelId, IReadOnlyList<IMessage> messages, IUser bot,
|
IUser executor, IUser? author, GuildData data, Snowflake channelId, IReadOnlyList<IMessage> messages, IUser bot,
|
||||||
CancellationToken ct = default)
|
CancellationToken ct = default)
|
||||||
{
|
{
|
||||||
var idList = new List<Snowflake>(messages.Count);
|
var idList = new List<Snowflake>(messages.Count);
|
||||||
|
@ -104,12 +106,27 @@ public class ClearCommandGroup : CommandGroup
|
||||||
for (var i = messages.Count - 1; i >= 1; i--) // '>= 1' to skip last message ('Octobot is thinking...')
|
for (var i = messages.Count - 1; i >= 1; i--) // '>= 1' to skip last message ('Octobot is thinking...')
|
||||||
{
|
{
|
||||||
var message = messages[i];
|
var message = messages[i];
|
||||||
|
if (author is not null && message.Author.ID != author.ID)
|
||||||
|
{
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
idList.Add(message.ID);
|
idList.Add(message.ID);
|
||||||
builder.AppendLine(string.Format(Messages.MessageFrom, Mention.User(message.Author)));
|
builder.AppendLine(string.Format(Messages.MessageFrom, Mention.User(message.Author)));
|
||||||
builder.Append(message.Content.InBlockCode());
|
builder.Append(message.Content.InBlockCode());
|
||||||
}
|
}
|
||||||
|
|
||||||
var title = string.Format(Messages.MessagesCleared, amount.ToString());
|
if (idList.Count == 0)
|
||||||
|
{
|
||||||
|
var failedEmbed = new EmbedBuilder().WithSmallTitle(Messages.NoMessagesToClear, bot)
|
||||||
|
.WithColour(ColorsList.Red).Build();
|
||||||
|
|
||||||
|
return await _feedback.SendContextualEmbedResultAsync(failedEmbed, ct);
|
||||||
|
}
|
||||||
|
|
||||||
|
var title = author is not null
|
||||||
|
? string.Format(Messages.MessagesClearedFiltered, idList.Count.ToString(), author.GetTag())
|
||||||
|
: string.Format(Messages.MessagesCleared, idList.Count.ToString());
|
||||||
var description = builder.ToString();
|
var description = builder.ToString();
|
||||||
|
|
||||||
var deleteResult = await _channelApi.BulkDeleteMessagesAsync(
|
var deleteResult = await _channelApi.BulkDeleteMessagesAsync(
|
||||||
|
|
16
src/Messages.Designer.cs
generated
16
src/Messages.Designer.cs
generated
|
@ -980,5 +980,21 @@ namespace Octobot {
|
||||||
return ResourceManager.GetString("GuildInfoBoostCount", resourceCulture);
|
return ResourceManager.GetString("GuildInfoBoostCount", resourceCulture);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
internal static string NoMessagesToClear
|
||||||
|
{
|
||||||
|
get
|
||||||
|
{
|
||||||
|
return ResourceManager.GetString("NoMessagesToClear", resourceCulture);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
internal static string MessagesClearedFiltered
|
||||||
|
{
|
||||||
|
get
|
||||||
|
{
|
||||||
|
return ResourceManager.GetString("MessagesClearedFiltered", resourceCulture);
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Reference in a new issue