revanced-discord-bot/src/commands/moderation.rs

use bson::{doc, Document};
use chrono::{Duration, Utc};
use mongodb::options::{UpdateModifications, UpdateOptions};
use poise::serenity_prelude::{
    self as serenity, Mentionable, PermissionOverwrite, Permissions, UserId,
};
use tracing::{debug, error, trace};

use crate::db::model::{LockedChannel, Muted};
use crate::utils::macros::to_user;
use crate::utils::moderation::{
    ban_moderation, queue_unmute_member, respond_moderation, BanKind, ModerationKind,
};
use crate::{Context, Error};

/// Lock a channel.
#[poise::command(slash_command)]
pub async fn lock(ctx: Context<'_>) -> Result<(), Error> {
    let data = &ctx.data().read().await;
    let configuration = &data.configuration;
    let database = &data.database;
    let discord = &ctx.discord();
    let cache = &discord.cache;
    let http = &discord.http;

    let channel_id = ctx.channel_id().0;
    let channel = &cache.guild_channel(channel_id).unwrap();

    let author = ctx.author();

    let query: Document = LockedChannel {
        channel_id: Some(channel_id.to_string()),
        ..Default::default()
    }
    .into();

    // Check if channel is already muted, if so succeed.
    if let Ok(mut cursor) = database
        .find::<LockedChannel>("locked", query.clone(), None)
        .await
    {
        if cursor.advance().await.unwrap() {
            respond_moderation(
                &ctx,
                &ModerationKind::Lock(
                    channel.clone(),
                    author.clone(),
                    Some(Error::from("Channel already locked")),
                ),
                configuration,
            )
            .await?;
            return Ok(());
        }
    }

    // accumulate all roles with write permissions
    let permission_overwrites: Vec<_> = channel
        .permission_overwrites
        .iter()
        .filter_map(|r| {
            if r.allow.send_messages() || !r.deny.send_messages() {
                Some(r.clone())
            } else {
                None
            }
        })
        .collect();

    // save the original overwrites
    let updated: Document = LockedChannel {
        overwrites: Some(permission_overwrites.clone()),
        ..Default::default()
    }
    .into();

    database
        .update::<LockedChannel>(
            "locked",
            query,
            UpdateModifications::Document(doc! { "$set": updated}),
            Some(UpdateOptions::builder().upsert(true).build()),
        )
        .await?;

    // lock the channel by and creating the new permission overwrite
    for permission_overwrite in &permission_overwrites {
        let permission = Permissions::SEND_MESSAGES & Permissions::ADD_REACTIONS;

        if let Err(err) = channel
            .create_permission(
                http,
                &PermissionOverwrite {
                    allow: permission_overwrite.allow & !permission,
                    deny: permission_overwrite.deny | permission,
                    kind: permission_overwrite.kind,
                },
            )
            .await
        {
            error!("Failed to create the new permission: {:?}", err);
        }
    }

    respond_moderation(
        &ctx,
        &ModerationKind::Lock(channel.clone(), author.clone(), None),
        configuration,
    )
    .await
}

/// Unlock a channel.
#[poise::command(slash_command)]
pub async fn unlock(ctx: Context<'_>) -> Result<(), Error> {
    let data = &ctx.data().read().await;
    let configuration = &data.configuration;
    let database = &data.database;
    let discord = &ctx.discord();
    let cache = &discord.cache;
    let http = &discord.http;

    let channel_id = ctx.channel_id().0;

    let delete_result = database
        .find_and_delete::<LockedChannel>(
            "locked",
            LockedChannel {
                channel_id: Some(channel_id.to_string()),
                ..Default::default()
            }
            .into(),
            None,
        )
        .await;

    let channel = cache.guild_channel(channel_id).unwrap();

    let author = ctx.author();

    let mut error = None;
    if let Ok(Some(locked_channel)) = delete_result {
        for overwrite in &locked_channel.overwrites.unwrap() {
            channel.create_permission(http, overwrite).await?;
        }
    } else {
        error = Some(Error::from("Channel already unlocked"))
    }

    respond_moderation(
        &ctx,
        &ModerationKind::Unlock(channel.clone(), author.clone(), error), // TODO: handle error
        configuration,
    )
    .await
}

/// Unmute a member.
#[poise::command(slash_command)]
pub async fn unmute(
    ctx: Context<'_>,
    #[description = "The member to unmute"] member: UserId,
) -> Result<(), Error> {
    let user = to_user!(member, ctx);
    let id = user.id;
    ctx.defer().await.expect("Failed to defer");

    let data = &ctx.data().read().await;
    let configuration = &data.configuration;

    if let Some(pending_unmute) = data.pending_unmutes.get(&id.0) {
        trace!("Cancelling pending unmute for {}", id.0);
        pending_unmute.abort();
    }

    let author = ctx.author();

    let queue = queue_unmute_member(
        ctx.discord().clone(),
        data.database.clone(),
        ctx.guild_id().unwrap(),
        id,
        configuration.general.mute.role,
        0,
    )
    .await
    .unwrap()
    .err();

    respond_moderation(
        &ctx,
        &ModerationKind::Unmute(user, author.clone(), queue),
        configuration,
    )
    .await
}

/// Mute a member.
#[allow(clippy::too_many_arguments)]
#[poise::command(slash_command)]
pub async fn mute(
    ctx: Context<'_>,
    #[description = "The member to mute"] member: UserId,
    #[description = "Seconds"] seconds: Option<i64>,
    #[description = "Minutes"] minutes: Option<i64>,
    #[description = "Hours"] hours: Option<i64>,
    #[description = "Days"] days: Option<i64>,
    #[description = "Months"] months: Option<i64>,
    #[description = "The reason of the mute"] reason: String,
) -> Result<(), Error> {
    let user = to_user!(member, ctx);
    let id = user.id;
    let now = Utc::now();
    let mut mute_duration = Duration::zero();

    if let Some(seconds) = seconds {
        mute_duration = mute_duration
            .checked_add(&Duration::seconds(seconds))
            .unwrap();
    }
    if let Some(minutes) = minutes {
        mute_duration = mute_duration
            .checked_add(&Duration::minutes(minutes))
            .unwrap();
    }
    if let Some(hours) = hours {
        mute_duration = mute_duration.checked_add(&Duration::hours(hours)).unwrap();
    }
    if let Some(days) = days {
        mute_duration = mute_duration.checked_add(&Duration::days(days)).unwrap();
    }
    if let Some(months) = months {
        const DAYS_IN_MONTH: i64 = 30;
        mute_duration = mute_duration
            .checked_add(&Duration::days(months * DAYS_IN_MONTH))
            .unwrap();
    }

    let data = &mut *ctx.data().write().await;
    let configuration = &data.configuration;
    let author = ctx.author();

    let mute = &configuration.general.mute;
    let guild_id = ctx.guild_id().unwrap();

    let discord = ctx.discord();
    let cache = &discord.cache;

    let unmute_time = if !mute_duration.is_zero() {
        Some((now + mute_duration).timestamp() as u64)
    } else {
        None
    };

    let mut updated = Muted {
        guild_id: Some(guild_id.0.to_string()),
        expires: unmute_time,
        reason: Some(reason.clone()),
        ..Default::default()
    };

    let result = async {
        if let Some(mut member) = cache.member(guild_id, id) {
            let (is_currently_muted, removed_roles) =
                crate::utils::moderation::mute_moderation(&ctx, &mut member, mute).await?;
            // Prevent the bot from overriding the "take" field.
            // This would happen otherwise, because the bot would accumulate the users roles and then override the value in the database
            // resulting in the user being muted to have no roles to add back later.
            if !is_currently_muted {
                updated.taken_roles = Some(removed_roles.iter().map(ToString::to_string).collect());
            }
        }

        let query: Document = Muted {
            user_id: Some(id.to_string()),
            ..Default::default()
        }
        .into();

        let updated: Document = updated.into();
        data.database
            .update::<Muted>(
                "muted",
                query.clone(),
                UpdateModifications::Document(doc! { "$set": updated }),
                Some(UpdateOptions::builder().upsert(true).build()),
            )
            .await?;

        if let Some(pending_unmute) = data.pending_unmutes.get(&id.0) {
            trace!("Cancelling pending unmute for {}", id.0);
            pending_unmute.abort();
        }

        if unmute_time.is_none() {
            data.database
                .update::<Muted>(
                    "muted",
                    query,
                    UpdateModifications::Document(doc! { "$unset": { "expires": "" } }),
                    None,
                )
                .await?;
        } else {
            data.pending_unmutes.insert(
                id.0,
                queue_unmute_member(
                    discord.clone(),
                    data.database.clone(),
                    guild_id,
                    id,
                    mute.role,
                    mute_duration.num_seconds() as u64,
                ),
            );
        }
        Ok(())
    }
    .await;

    let duration = unmute_time.map(|time| format!("<t:{}:F>", time));

    respond_moderation(
        &ctx,
        &ModerationKind::Mute(user, author.clone(), reason, duration, result.err()),
        configuration,
    )
    .await
}

/// Delete recent messages of a member. Cannot delete messages older than 14 days.
#[poise::command(slash_command)]
pub async fn purge(
    ctx: Context<'_>,
    #[description = "Member"] user: Option<UserId>,
    #[description = "Until message"] until: Option<String>,
    #[min = 1]
    #[max = 1000]
    #[description = "Count"]
    count: Option<i64>,
) -> Result<(), Error> {
    let user = if let Some(id) = user {
        Some(to_user!(id, ctx))
    } else {
        None
    };
    // The maximum amount of times to page through messages. If paged over MAX_PAGES amount of times without deleting messages, break.
    const MAX_PAGES: i8 = 2;
    // The maximal amount of messages that we can fetch at all
    const MAX_BULK_DELETE: i64 = 100;
    // Discord does not let us bulk-delete messages older than 14 days
    const MAX_BULK_DELETE_AGO_SECS: i64 = 60 * 60 * 24 * 14;

    let data = ctx.data().read().await;
    let configuration = &data.configuration;
    let embed_color = configuration.general.embed_color;
    let channel = ctx.channel_id();
    let too_old_timestamp = Utc::now().timestamp() - MAX_BULK_DELETE_AGO_SECS;

    let current_user = ctx.discord().http.get_current_user().await?;
    let image = current_user.face();

    let author = ctx.author();

    let handle = ctx
        .send(|f| {
            f.embed(|f| {
                f.title("Purging messages")
                    .description("Accumulating...")
                    .color(embed_color)
                    .thumbnail(&image)
            })
        })
        .await?;
    let mut response = handle.message().await?;

    ctx.defer().await?;

    let count_to_delete = count.unwrap_or(MAX_BULK_DELETE) as usize;
    let mut deleted_amount = 0;
    let mut empty_pages: i8 = 0;

    loop {
        // Filter out messages that are too old
        let mut messages = channel
            .messages(&ctx.discord(), |m| {
                m.limit(count_to_delete as u64).before(response.id)
            })
            .await?
            .into_iter()
            .take_while(|m| m.timestamp.timestamp() > too_old_timestamp)
            .collect::<Vec<_>>();

        // Filter for messages from the user
        if let Some(ref user) = user {
            messages = messages
                .into_iter()
                .filter(|msg| msg.author.id == user.id)
                .collect::<Vec<_>>();

            debug!("Filtered messages by {}. Left: {}", user, messages.len());
        }

        // Filter for messages until the g/mutiven id
        if let Some(ref message_id) = until {
            if let Ok(message_id) = message_id.parse::<u64>() {
                messages = messages
                    .into_iter()
                    .take_while(|m| m.id.0 > message_id)
                    .collect::<Vec<_>>();
                debug!(
                    "Filtered messages until {}. Left: {}",
                    message_id,
                    messages.len()
                );
            }
        }

        let purge_count = messages.len();
        if purge_count > 0 {
            deleted_amount += purge_count;
            channel.delete_messages(&ctx.discord(), &messages).await?;
        } else {
            empty_pages += 1;
        }

        if empty_pages >= MAX_PAGES || deleted_amount >= count_to_delete {
            break;
        }
    }

    response
        .to_mut()
        .edit(&ctx.discord(), |e| {
            e.set_embed(
                serenity::CreateEmbed::default()
                    .title("Purge successful")
                    .field("Deleted messages", deleted_amount.to_string(), false)
                    .field("Action by", author.mention(), false)
                    .color(embed_color)
                    .thumbnail(&image)
                    .footer(|f| {
                        f.text("ReVanced");
                        f.icon_url(image)
                    })
                    .clone(),
            )
        })
        .await?;
    Ok(())
}

/// Ban a member.
#[poise::command(slash_command)]
pub async fn ban(
    ctx: Context<'_>,
    #[description = "Member"] user: UserId,
    #[description = "Amount of days to delete messages"] dmd: Option<u8>,
    #[description = "Reason for the ban"] reason: Option<String>,
) -> Result<(), Error> {
    // We cannot use `User` as a parameter for the moderation commands because of a bug in serenity. See: https://github.com/revanced/revanced-discord-bot/issues/38
    let user = to_user!(user, ctx);
    handle_ban(&ctx, &BanKind::Ban(user, dmd, reason)).await
}

/// Unban a user.
#[poise::command(slash_command)]
pub async fn unban(ctx: Context<'_>, #[description = "User"] user: UserId) -> Result<(), Error> {
    let user = to_user!(user, ctx);
    handle_ban(&ctx, &BanKind::Unban(user)).await
}

async fn handle_ban(ctx: &Context<'_>, kind: &BanKind) -> Result<(), Error> {
    let data = ctx.data().read().await;

    let ban_result = ban_moderation(ctx, kind).await;

    let author = ctx.author();

    respond_moderation(
        ctx,
        &match kind {
            BanKind::Ban(user, _, reason) => {
                ModerationKind::Ban(user.clone(), author.clone(), reason.clone(), ban_result)
            },
            BanKind::Unban(user) => ModerationKind::Unban(user.clone(), author.clone(), ban_result),
        },
        &data.configuration,
    )
    .await
}