bentobox/src/main/java/world/bentobox/bentobox/api/flags/clicklisteners/CycleClick.java

package world.bentobox.bentobox.api.flags.clicklisteners;

import java.util.Objects;

import org.bukkit.Bukkit;
import org.bukkit.Sound;
import org.bukkit.World;
import org.bukkit.event.inventory.ClickType;

import world.bentobox.bentobox.BentoBox;
import world.bentobox.bentobox.api.addons.GameModeAddon;
import world.bentobox.bentobox.api.events.flags.FlagProtectionChangeEvent;
import world.bentobox.bentobox.api.flags.Flag;
import world.bentobox.bentobox.api.localization.TextVariables;
import world.bentobox.bentobox.api.panels.Panel;
import world.bentobox.bentobox.api.panels.PanelItem;
import world.bentobox.bentobox.api.panels.TabbedPanel;
import world.bentobox.bentobox.api.user.User;
import world.bentobox.bentobox.database.objects.Island;
import world.bentobox.bentobox.lists.Flags;
import world.bentobox.bentobox.managers.RanksManager;
import world.bentobox.bentobox.panels.settings.SettingsTab;
import world.bentobox.bentobox.util.Util;

/**
 * Left Clicks increase rank, right clicks lower rank
 * @author tastybento
 *
 */
public class CycleClick implements PanelItem.ClickHandler {

    protected final BentoBox plugin = BentoBox.getInstance();
    protected Island island;
    protected User user;
    protected boolean changeOccurred;
    private final String id;
    private int minRank = RanksManager.VISITOR_RANK;
    private int maxRank = RanksManager.OWNER_RANK;

    /**
     * Construct default cycle clicker with min rank of {@link RanksManager#VISITOR_RANK}
     * and max rank of {@link RanksManager#OWNER_RANK}
     * @param id - the flag id that will be adjusted by this click
     */
    public CycleClick(String id) {
        this.id = id;
    }

    /**
     * Construct a cycle clicker with a min and max rank
     * @param id flag id
     * @param minRank minimum rank value
     * @param maxRank maximum rank value
     */
    public CycleClick(String id, int minRank, int maxRank) {
        this.id = id;
        this.minRank = minRank;
        this.maxRank = maxRank;
    }

    @Override
    public boolean onClick(Panel panel, User user2, ClickType click, int slot) {
        if (panel.getWorld().isEmpty()) {
            plugin.logError("Panel " + panel.getName()
                    + " has no world associated with it. Please report this bug to the author.");
            return true;
        }
        // This click listener is used with TabbedPanel and SettingsTabs only
        TabbedPanel tp = (TabbedPanel)panel;
        SettingsTab st = (SettingsTab)tp.getActiveTab();
        // Get the island for this tab
        island = st.getIsland();
        this.user = user2;
        changeOccurred = false;
        // Permission prefix
        String prefix = plugin.getIWM().getPermissionPrefix(Util.getWorld(panel.getWorld().get()));
        String reqPerm = prefix + "settings." + id;
        String allPerms = prefix + "settings.*";
        if (!user.hasPermission(reqPerm) && !user.hasPermission(allPerms)
                && !user.isOp() && !user.hasPermission(prefix + "admin.settings")) {
            user.sendMessage("general.errors.no-permission", TextVariables.PERMISSION, reqPerm);
            user.getPlayer().playSound(user.getLocation(), Sound.BLOCK_METAL_HIT, 1F, 1F);
            return true;
        }
        // Left clicking increases the rank required
        // Right clicking decreases the rank required
        // Shift Left Click toggles player visibility
        if (island != null && (user.isOp() || island.isAllowed(user, Flags.CHANGE_SETTINGS) || user.hasPermission(prefix + "admin.settings"))) {
            changeOccurred = true;
            plugin.getFlagsManager().getFlag(id).ifPresent(flag -> {
                // Rank
                int currentRank = island.getFlag(flag);
                if (click.equals(ClickType.LEFT)) {
                    leftClick(flag, currentRank);

                } else if (click.equals(ClickType.RIGHT)) {
                    rightClick(flag, currentRank);

                } else if (click.equals(ClickType.SHIFT_LEFT) && user2.isOp()) {
                    leftShiftClick(flag, panel.getWorld().get());
                }
            });
        } else {
            reportError();
        }
        return true;
    }

    private void reportError() {
        if (island == null) {
            // Island is not targeted.
            user.sendMessage("general.errors.not-on-island");
        } else  {
            // Player is not the allowed to change settings.
            user.sendMessage("general.errors.insufficient-rank",
                    TextVariables.RANK,
                    user.getTranslation(RanksManager.getInstance().getRank(Objects.requireNonNull(island).getRank(user))));
        }
        user.getPlayer().playSound(user.getLocation(), Sound.BLOCK_METAL_HIT, 1F, 1F);
    }

    private void leftClick(Flag flag, int currentRank) {
        if (currentRank >= maxRank) {
            island.setFlag(flag, minRank);
        } else {
            island.setFlag(flag, RanksManager.getInstance().getRankUpValue(currentRank));
        }
        user.getPlayer().playSound(user.getLocation(), Sound.BLOCK_STONE_BUTTON_CLICK_OFF, 1F, 1F);
        // Fire event
        Bukkit.getPluginManager().callEvent(new FlagProtectionChangeEvent(island, user.getUniqueId(), flag, island.getFlag(flag)));

        // Subflag support
        if (flag.hasSubflags()) {
            // Fire events for all subflags as well
            flag.getSubflags().forEach(subflag -> Bukkit.getPluginManager().callEvent(new FlagProtectionChangeEvent(island, user.getUniqueId(), subflag, island.getFlag(subflag))));
        }

    }

    private void rightClick(Flag flag, int currentRank) {
        if (currentRank <= minRank) {
            island.setFlag(flag, maxRank);
        } else {
            island.setFlag(flag, RanksManager.getInstance().getRankDownValue(currentRank));
        }
        user.getPlayer().playSound(user.getLocation(), Sound.BLOCK_STONE_BUTTON_CLICK_ON, 1F, 1F);
        // Fire event
        Bukkit.getPluginManager().callEvent(new FlagProtectionChangeEvent(island, user.getUniqueId(), flag, island.getFlag(flag)));

        // Subflag support
        if (flag.hasSubflags()) {
            // Fire events for all subflags as well
            flag.getSubflags().forEach(subflag -> Bukkit.getPluginManager().callEvent(new FlagProtectionChangeEvent(island, user.getUniqueId(), subflag, island.getFlag(subflag))));
        }

    }

    private void leftShiftClick(Flag flag, World world) {
        if (!plugin.getIWM().getHiddenFlags(world).contains(flag.getID())) {
            plugin.getIWM().getHiddenFlags(world).add(flag.getID());
            user.getPlayer().playSound(user.getLocation(), Sound.BLOCK_GLASS_BREAK, 1F, 1F);
        } else {
            plugin.getIWM().getHiddenFlags(world).remove(flag.getID());
            user.getPlayer().playSound(user.getLocation(), Sound.BLOCK_NOTE_BLOCK_CHIME, 1F, 1F);
        }
        // Save changes
        plugin.getIWM().getAddon(world).ifPresent(GameModeAddon::saveWorldSettings);

    }

    /**
     * @param minRank the minRank to set
     */
    public void setMinRank(int minRank) {
        this.minRank = minRank;
    }

    /**
     * @param maxRank the maxRank to set
     */
    public void setMaxRank(int maxRank) {
        this.maxRank = maxRank;
    }

}