Plex-FAWE/src/com/sk89q/worldedit/bukkit/WorldEditPlugin.java

// $Id$
/*
 * WorldEdit
 * Copyright (C) 2010 sk89q <http://www.sk89q.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

package com.sk89q.worldedit.bukkit;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.logging.Logger;
import org.bukkit.command.Command;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.bukkit.event.Event.Priority;
import org.bukkit.event.Event;
import org.bukkit.event.Listener;
import org.bukkit.event.block.BlockListener;
import org.bukkit.event.player.PlayerListener;
import org.bukkit.plugin.java.JavaPlugin;
import com.sk89q.bukkit.migration.PermissionsResolverManager;
import com.sk89q.bukkit.migration.PermissionsResolverServerListener;
import com.sk89q.worldedit.*;
import com.sk89q.worldedit.bags.BlockBag;
import com.sk89q.worldedit.regions.Region;

/**
 * Plugin for Bukkit.
 * 
 * @author sk89q
 */
public class WorldEditPlugin extends JavaPlugin {
    /**
     * WorldEdit messages get sent here.
     */
    private static final Logger logger = Logger.getLogger("Minecraft.WorldEdit");
    
    /**
     * The server interface that all server-related API goes through.
     */
    protected ServerInterface server;
    /**
     * Main WorldEdit instance.
     */
    protected WorldEdit controller;
    /**
     * Deprecated API.
     */
    protected WorldEditAPI api;
    
    /**
     * Holds the configuration for WorldEdit.
     */
    private BukkitConfiguration config;
    /**
     * The permissions resolver in use.
     */
    private PermissionsResolverManager perms;

    /**
     * Called on plugin enable.
     */
    public void onEnable() {
        logger.info("WorldEdit " + getDescription().getVersion() + " enabled.");
        
        // Make the data folders that WorldEdit uses
        getDataFolder().mkdirs();

        // Create the default configuration file
        createDefaultConfiguration("config.yml");
        
        // Set up configuration and such, including the permissions
        // resolver
        config = new BukkitConfiguration(getConfiguration(), logger);
        perms = new PermissionsResolverManager(
                getConfiguration(), getServer(), "WorldEdit", logger);
        
        // Load the configuration
        loadConfiguration();
        
        // Setup interfaces
        server = new BukkitServerInterface(this, getServer());
        controller = new WorldEdit(server, config);
        api = new WorldEditAPI(this);

        // Now we can register events!
        registerEvents();
    }

    /**
     * Called on plugin disable.
     */
    public void onDisable() {
        controller.clearSessions();
    }
    
    /**
     * Loads and reloads all configuration.
     */
    protected void loadConfiguration() {
        getConfiguration().load();
        config.load();
        perms.load();
    }

    /**
     * Register the events used by WorldEdit.
     */
    protected void registerEvents() {        
        PlayerListener playerListener = new WorldEditPlayerListener(this);
        BlockListener blockListener = new WorldEditBlockListener(this);
        
        registerEvent(Event.Type.PLAYER_QUIT, playerListener);
        registerEvent(Event.Type.PLAYER_ANIMATION, playerListener);
        registerEvent(Event.Type.PLAYER_ITEM, playerListener);
        registerEvent(Event.Type.PLAYER_COMMAND_PREPROCESS, playerListener);
        registerEvent(Event.Type.BLOCK_DAMAGED, blockListener);
        registerEvent(Event.Type.BLOCK_RIGHTCLICKED, blockListener);
        
        // The permissions resolver has some hooks of its own
        (new PermissionsResolverServerListener(perms)).register(this);
    }
    
    /**
     * Register an event.
     * 
     * @param type
     * @param listener
     * @param priority
     */
    protected void registerEvent(Event.Type type, Listener listener, Priority priority) {
        getServer().getPluginManager()
                .registerEvent(type, listener, priority, this);
    }
    
    /**
     * Register an event at normal priority.
     * 
     * @param type
     * @param listener
     */
    protected void registerEvent(Event.Type type, Listener listener) {
        getServer().getPluginManager()
                .registerEvent(type, listener, Priority.Normal, this);
    }
    
    /**
     * Create a default configuration file from the .jar.
     * 
     * @param name
     */
    protected void createDefaultConfiguration(String name) {
        File actual = new File(getDataFolder(), name);
        if (!actual.exists()) {
            
            InputStream input =
                    this.getClass().getResourceAsStream("/defaults/" + name);
            if (input != null) {
                FileOutputStream output = null;

                try {
                    output = new FileOutputStream(actual);
                    byte[] buf = new byte[8192];
                    int length = 0;
                    while ((length = input.read(buf)) > 0) {
                        output.write(buf, 0, length);
                    }
                    
                    logger.info(getDescription().getName()
                            + ": Default configuration file written: " + name);
                } catch (IOException e) {
                    e.printStackTrace();
                } finally {
                    try {
                        if (input != null)
                            input.close();
                    } catch (IOException e) {}

                    try {
                        if (output != null)
                            output.close();
                    } catch (IOException e) {}
                }
            }
        }
    }

    /**
     * Called on WorldEdit command.
     */
    @Override
    public boolean onCommand(CommandSender sender, Command cmd,
            String commandLabel, String[] args) {
        // Since WorldEdit is primarily made for use in-game, we're going
        // to ignore the situation where the command sender is not aplayer.
        if (!(sender instanceof Player)) {
            return true;
        }
        
        Player player = (Player)sender;
        
        // Add the command to the array because the underlying command handling
        // code of WorldEdit expects it
        String[] split = new String[args.length + 1];
        System.arraycopy(args, 0, split, 1, args.length);
        split[0] = "/" + cmd.getName();
        
        controller.handleCommand(wrapPlayer(player), split);
        
        return true;
    }
    
    /**
     * Get a reference to the WorldEdit object.
     * 
     * @return
     */
    public WorldEdit getWorldEdit() {
        return controller;
    }
    
    /**
     * Gets the session for the player.
     * 
     * @param player
     * @return
     */
    public LocalSession getSession(Player player) {
        return controller.getSession(wrapPlayer(player));
    }
    
    /**
     * Gets the region selection for the player.
     * 
     * @param player
     * @return
     * @throws IncompleteRegionException 
     */
    public Region getPlayerSelection(Player player)
            throws IncompleteRegionException {
        return controller.getSession(wrapPlayer(player))
                .getSelection(new BukkitWorld(player.getWorld()));
    }
    
    /**
     * Gets the session for the player.
     * 
     * @param player
     * @return
     */
    public EditSession createEditSession(Player player) {
        LocalPlayer wePlayer = wrapPlayer(player);
        LocalSession session = controller.getSession(wePlayer);
        BlockBag blockBag = session.getBlockBag(wePlayer);
        
        EditSession editSession =
            new EditSession(wePlayer.getWorld(),
                    session.getBlockChangeLimit(), blockBag);
        editSession.enableQueue();
        
        return editSession;
    }
    
    /**
     * Remember an edit session.
     * 
     * @param player
     * @param editSession
     */
    public void remember(Player player, EditSession editSession) {
        LocalPlayer wePlayer = wrapPlayer(player);
        LocalSession session = controller.getSession(wePlayer);
        
        session.remember(editSession);
        editSession.flushQueue();
        
        controller.flushBlockBag(wePlayer, editSession);
    }
    
    /**
     * Wrap an operation into an EditSession.
     * 
     * @param player
     * @param op
     * @throws Throwable
     */
    public void perform(Player player, WorldEditOperation op)
            throws Throwable {
        LocalPlayer wePlayer = wrapPlayer(player);
        LocalSession session = controller.getSession(wePlayer);
        
        EditSession editSession = createEditSession(player);
        try {
            op.run(session, wePlayer, editSession);
        } finally {
            remember(player, editSession);
        }
    }
    
    /**
     * Get the API.
     * 
     * @return
     */
    @Deprecated
    public WorldEditAPI getAPI() {
        return api;
    }
    
    /**
     * Returns the configuration used by WorldEdit.
     * 
     * @return
     */
    public BukkitConfiguration getLocalConfiguration() {
        return config;
    }
    
    /**
     * Get the permissions resolver in use.
     * 
     * @return
     */
    public PermissionsResolverManager getPermissionsResolver() {
        return perms;
    }
    
    /**
     * Used to wrap a Bukkit Player as a LocalPlayer.
     * 
     * @param player
     * @return
     */
    public BukkitPlayer wrapPlayer(Player player) {
        return new BukkitPlayer(this, this.server, player);
    }
}