DiscordCreateChannelCommand.java

package com.denizenscript.ddiscordbot.commands;

import com.denizenscript.ddiscordbot.DiscordCommandUtils;
import com.denizenscript.ddiscordbot.objects.*;
import com.denizenscript.denizencore.objects.core.ElementTag;
import com.denizenscript.denizencore.scripts.ScriptEntry;
import com.denizenscript.denizencore.scripts.commands.AbstractCommand;
import com.denizenscript.denizencore.scripts.commands.Holdable;
import com.denizenscript.denizencore.scripts.commands.generator.*;
import com.denizenscript.denizencore.utilities.debugging.Debug;
import net.dv8tion.jda.api.Permission;
import net.dv8tion.jda.api.entities.channel.ChannelType;
import net.dv8tion.jda.api.entities.channel.concrete.Category;
import net.dv8tion.jda.api.entities.channel.middleman.GuildChannel;
import net.dv8tion.jda.api.requests.restaction.ChannelAction;

import java.util.Collections;
import java.util.List;
import java.util.Set;

public class DiscordCreateChannelCommand extends AbstractCommand implements Holdable {

    public DiscordCreateChannelCommand() {
        setName("discordcreatechannel");
        setSyntax("discordcreatechannel (id:<bot>) [group:<group>] [name:<name>] (description:<description>) (type:<type>) (category:<category_id>) (position:<#>) (roles:<list>) (users:<list>)");
        setRequiredArguments(2, 9);
        isProcedural = false;
        autoCompile();
    }
    // <--[command]
    // @Name discordcreatechannel
    // @Syntax discordcreatechannel (id:<bot>) [group:<group>] [name:<name>] (description:<description>) (type:<type>) (category:<category_id>) (position:<#>) (roles:<list>) (users:<list>)
    // @Required 2
    // @Maximum 9
    // @Short Creates text channels on Discord.
    // @Plugin dDiscordBot
    // @Group external
    //
    // @Description
    // Creates text channels on Discord.
    //
    // This functionality requires the Manage Channels permission.
    //
    // You can optionally specify the channel description (aka "topic") with the "description" argument.
    //
    // You can optionally specify the channel type. Valid types are TEXT, NEWS, CATEGORY, and VOICE.
    // Only text and news channels can have a description.
    // Categories cannot have a parent category.
    //
    // You can optionally specify the channel's parent category with the "category" argument.
    // By default, the channel will not be attached to any category.
    //
    // You can optionally specify the channel's position in the list as an integer with the "position" argument.
    //
    // You can optionally specify the roles or users that are able to view the channel.
    // The "roles" argument takes a list of DiscordRoleTags, and the "users" argument takes a list of DiscordUserTags.
    // Specifying either of these arguments will create a private channel (hidden for anyone not in the lists).
    //
    // The command can be ~waited for. See <@link language ~waitable>.
    //
    // @Tags
    // <entry[saveName].channel> returns the DiscordChannelTag of a channel upon creation when the command is ~waited for.
    //
    // @Usage
    // Use to create a channel in a category.
    // - discordcreatechannel id:mybot group:1234 name:my-channel category:5678
    //
    // @Usage
    // Use to create a voice channel and log its name upon creation.
    // - ~discordcreatechannel id:mybot group:1234 name:very-important-channel type:voice save:stuff
    // - debug log "Created channel '<entry[stuff].channel.name>'"
    //
    // -->

    public static void autoExecute(ScriptEntry scriptEntry,
                                   @ArgPrefixed @ArgName("id") @ArgDefaultNull DiscordBotTag bot,
                                   @ArgPrefixed @ArgName("group") DiscordGroupTag group,
                                   @ArgPrefixed @ArgName("name") String name,
                                   @ArgPrefixed @ArgDefaultNull @ArgName("description") String description,
                                   @ArgPrefixed @ArgDefaultText("text") @ArgName("type") ChannelType type,
                                   @ArgPrefixed @ArgDefaultNull @ArgName("category") String category,
                                   @ArgPrefixed @ArgDefaultNull @ArgName("position") ElementTag position,
                                   @ArgPrefixed @ArgDefaultNull @ArgName("roles") @ArgSubType(DiscordRoleTag.class) List<DiscordRoleTag> roles,
                                   @ArgPrefixed @ArgDefaultNull @ArgName("users") @ArgSubType(DiscordUserTag.class) List<DiscordUserTag> users) {
        bot = DiscordCommandUtils.inferBot(bot, group, users, roles);
        if (group.bot == null) {
            group = new DiscordGroupTag(bot.bot, group.guild_id);
        }
        ChannelAction<? extends GuildChannel> action;
        switch (type) {
            case NEWS: {
                action = group.getGuild().createNewsChannel(name);
                break;
            }
            case TEXT: {
                action = group.getGuild().createTextChannel(name);
                break;
            }
            case CATEGORY: {
                action = group.getGuild().createCategory(name);
                break;
            }
            case VOICE: {
                action = group.getGuild().createVoiceChannel(name);
                break;
            }
            default: {
                Debug.echoError(scriptEntry, "Invalid channel type!");
                return;
            }
        }
        if (description != null) {
            if (type != ChannelType.TEXT && type != ChannelType.NEWS) {
                Debug.echoError(scriptEntry, "Only text and news channels can have descriptions!");
                return;
            }
            action = action.setTopic(description);
        }
        if (category != null) {
            if (type == ChannelType.CATEGORY) {
                Debug.echoError(scriptEntry, "A category cannot have a parent category!");
                return;
            }
            Category resultCategory = group.getGuild().getCategoryById(category);
            if (resultCategory == null) {
                Debug.echoError(scriptEntry, "Invalid category!");
                return;
            }
            action = action.setParent(resultCategory);
        }
        if (position != null) {
            action = action.setPosition(position.asInt());
        }
        Set<Permission> permissions = Collections.singleton(Permission.VIEW_CHANNEL);
        if (roles != null || users != null) {
            action = action.addRolePermissionOverride(group.guild_id, null, permissions);
        }
        if (roles != null) {
            for (DiscordRoleTag role : roles) {
                action = action.addRolePermissionOverride(role.role_id, permissions, null);
            }
        }
        if (users != null) {
            for (DiscordUserTag user : users) {
                action = action.addMemberPermissionOverride(user.user_id, permissions, null);
            }
        }
        final DiscordBotTag finalBot = bot;
        DiscordCommandUtils.cleanWait(scriptEntry, action.onSuccess(resultChannel -> scriptEntry.addObject("channel", new DiscordChannelTag(finalBot.bot, resultChannel))));
    }
}