ProtocolLib.java

/**
 * ProtocolLib - Bukkit server library that allows access to the Minecraft protocol. Copyright (C) 2012 Kristian S.
 * Stangeland
 * <p>
 * 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 2 of the License, or (at your option) any later
 * version.
 * <p>
 * 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.
 * <p>
 * You should have received a copy of the GNU General Public License along with this program; if not, write to the Free
 * Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */
package com.comphenix.protocol;

import com.comphenix.protocol.async.AsyncFilterManager;
import com.comphenix.protocol.error.*;
import com.comphenix.protocol.injector.InternalManager;
import com.comphenix.protocol.injector.PacketFilterManager;
import com.comphenix.protocol.metrics.Statistics;
import com.comphenix.protocol.scheduler.DefaultScheduler;
import com.comphenix.protocol.scheduler.FoliaScheduler;
import com.comphenix.protocol.scheduler.ProtocolScheduler;
import com.comphenix.protocol.scheduler.Task;
import com.comphenix.protocol.updater.Updater;
import com.comphenix.protocol.updater.Updater.UpdateType;
import com.comphenix.protocol.utility.ByteBuddyFactory;
import com.comphenix.protocol.utility.ChatExtensions;
import com.comphenix.protocol.utility.MinecraftVersion;
import com.comphenix.protocol.utility.Util;
import com.google.common.base.Splitter;
import com.google.common.collect.Iterables;
import org.bukkit.Server;
import org.bukkit.command.CommandExecutor;
import org.bukkit.command.PluginCommand;
import org.bukkit.plugin.Plugin;
import org.bukkit.plugin.PluginManager;
import org.bukkit.plugin.java.JavaPlugin;

import java.io.File;
import java.io.IOException;
import java.util.HashSet;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * The main entry point for ProtocolLib.
 *
 * @author Kristian
 */
public class ProtocolLib extends JavaPlugin {
    // Every possible error or warning report type
    public static final ReportType REPORT_CANNOT_DELETE_CONFIG = new ReportType(
            "Cannot delete old ProtocolLib configuration.");

    public static final ReportType REPORT_PLUGIN_LOAD_ERROR = new ReportType("Cannot load ProtocolLib.");
    public static final ReportType REPORT_CANNOT_LOAD_CONFIG = new ReportType("Cannot load configuration");
    public static final ReportType REPORT_PLUGIN_ENABLE_ERROR = new ReportType("Cannot enable ProtocolLib.");

    public static final ReportType REPORT_METRICS_IO_ERROR = new ReportType(
            "Unable to enable metrics due to network problems.");
    public static final ReportType REPORT_METRICS_GENERIC_ERROR = new ReportType(
            "Unable to enable metrics due to network problems.");

    public static final ReportType REPORT_CANNOT_PARSE_MINECRAFT_VERSION = new ReportType(
            "Unable to retrieve current Minecraft version. Assuming %s");
    public static final ReportType REPORT_CANNOT_DETECT_CONFLICTING_PLUGINS = new ReportType(
            "Unable to detect conflicting plugin versions.");
    public static final ReportType REPORT_CANNOT_REGISTER_COMMAND = new ReportType("Cannot register command %s: %s");

    public static final ReportType REPORT_CANNOT_CREATE_TIMEOUT_TASK = new ReportType(
            "Unable to create packet timeout task.");
    public static final ReportType REPORT_CANNOT_UPDATE_PLUGIN = new ReportType("Cannot perform automatic updates.");

    /**
     * The number of milliseconds per second.
     */
    static final long MILLI_PER_SECOND = TimeUnit.SECONDS.toMillis(1);

    private static final int ASYNC_MANAGER_DELAY = 1;
    private static final String PERMISSION_INFO = "protocol.info";

    // these fields are only existing once, we can make them static
    private static Logger logger;
    private static ProtocolConfig config;
    private static InternalManager protocolManager;
    private static ErrorReporter reporter = new BasicErrorReporter();

    private Statistics statistics;

    private Task packetTask = null;
    private int tickCounter = 0;
    private int configExpectedMod = -1;

    // updater
    private Updater updater;
    private Handler redirectHandler;

    private ProtocolScheduler scheduler;

    // commands
    private CommandProtocol commandProtocol;
    private CommandPacket commandPacket;
    private CommandFilter commandFilter;
    private PacketLogging packetLogging;

    // Whether disabling field resetting is needed
    private boolean skipDisable;
    private boolean loadingFailed = false;

    @Override
    public void onLoad() {
        // Logging
        logger = this.getLogger();
        ProtocolLogger.init(this);

        // Initialize enhancer factory
        ByteBuddyFactory.getInstance().setClassLoader(this.getClassLoader());

        // Add global parameters
        DetailedErrorReporter detailedReporter = new DetailedErrorReporter(this);
        reporter = this.getFilteredReporter(detailedReporter);

        // Configuration
        this.saveDefaultConfig();
        this.reloadConfig();

        try {
            config = new ProtocolConfig(this);
        } catch (Exception exception) {
            reporter.reportWarning(this, Report.newBuilder(REPORT_CANNOT_LOAD_CONFIG).error(exception));

            // Load it again
            if (this.deleteConfig()) {
                config = new ProtocolConfig(this);
            } else {
                reporter.reportWarning(this, Report.newBuilder(REPORT_CANNOT_DELETE_CONFIG));
            }
        }

        // Print the state of the debug mode
        if (config.isDebug()) {
            logger.warning("Debug mode is enabled!");
        }

        // And the state of the error reporter
        if (config.isDetailedErrorReporting()) {
            detailedReporter.setDetailedReporting(true);
            logger.warning("Detailed error reporting enabled!");
        }

        try {
            this.scheduler = Util.isUsingFolia()
                    ? new FoliaScheduler(this)
                    : new DefaultScheduler(this);

            // Check for other versions
            this.checkConflictingVersions();

            // Handle unexpected Minecraft versions
            MinecraftVersion version = this.verifyMinecraftVersion(); // returns the current version or null if a version mismatch was detected
            if(version == null) {
                loadingFailed = true;
                return;
            }

            // Set updater - this will not perform any update automatically
            this.updater = Updater.create(this, 0, this.getFile(), UpdateType.NO_DOWNLOAD, true);

            // api init
            protocolManager = PacketFilterManager.newBuilder()
                    .server(this.getServer())
                    .library(this)
                    .minecraftVersion(version)
                    .reporter(reporter)
                    .build();
            ProtocolLibrary.init(this, config, protocolManager, scheduler, reporter);

            // Setup error reporter
            detailedReporter.addGlobalParameter("manager", protocolManager);

            // Send logging information to player listeners too
            this.initializeCommands();
            this.setupBroadcastUsers(PERMISSION_INFO);

        } catch (Exception e) {
            reporter.reportDetailed(this, Report.newBuilder(REPORT_PLUGIN_LOAD_ERROR).error(e).callerParam(protocolManager));
            loadingFailed = true;
        }
    }

    /**
     * Initialize all command handlers.
     */
    private void initializeCommands() {
        // Initialize command handlers
        for (ProtocolCommand command : ProtocolCommand.values()) {
            try {
                switch (command) {
                    case PROTOCOL:
                        this.commandProtocol = new CommandProtocol(reporter, this, this.updater, config);
                        break;
                    case FILTER:
                        this.commandFilter = new CommandFilter(reporter, this, config);
                        break;
                    case PACKET:
                        this.commandPacket = new CommandPacket(reporter, this, logger, this.commandFilter, protocolManager);
                        break;
                    case LOGGING:
                        this.packetLogging = new PacketLogging(this, protocolManager);
                        break;
                }
            } catch (OutOfMemoryError e) {
                throw e;
            } catch (LinkageError e) {
                logger.warning("Failed to register command " + command.name() + ": " + e);
            } catch (Throwable e) {
                reporter.reportWarning(this, Report.newBuilder(REPORT_CANNOT_REGISTER_COMMAND)
                        .messageParam(command.name(), e.getMessage()).error(e));
            }
        }
    }

    /**
     * Retrieve a error reporter that may be filtered by the configuration.
     *
     * @return The new default error reporter.
     */
    private ErrorReporter getFilteredReporter(ErrorReporter reporter) {
        return new DelegatedErrorReporter(reporter) {
            private int lastModCount = -1;
            private Set<String> reports = new HashSet<>();

            @Override
            protected Report filterReport(Object sender, Report report, boolean detailed) {
                try {
                    String canonicalName = ReportType.getReportName(sender, report.getType());
                    String reportName = Iterables.getLast(Splitter.on("#").split(canonicalName)).toUpperCase();

                    if (config != null && config.getModificationCount() != this.lastModCount) {
                        // Update our cached set again
                        this.reports = new HashSet<>(config.getSuppressedReports());
                        this.lastModCount = config.getModificationCount();
                    }

                    // Cancel reports either on the full canonical name, or just the report name
                    if (this.reports.contains(canonicalName) || this.reports.contains(reportName)) {
                        return null;
                    }

                } catch (Exception e) {
                    // Only report this with a minor message
                    logger.warning("Error filtering reports: " + e);
                }
                // Don't filter anything
                return report;
            }
        };
    }

    private boolean deleteConfig() {
        return config.getFile().delete();
    }

    @Override
    public void reloadConfig() {
        super.reloadConfig();

        // Reload configuration
        if (config != null) {
            config.reloadConfig();
        }
    }

    private void setupBroadcastUsers(final String permission) {
        // Guard against multiple calls
        if (this.redirectHandler != null) {
            return;
        }

        // Broadcast information to every user too
        this.redirectHandler = new Handler() {
            @Override
            public void publish(LogRecord record) {
                // Only display warnings and above
                if (record.getLevel().intValue() >= Level.WARNING.intValue()) {
                    ProtocolLib.this.commandPacket.broadcastMessageSilently(record.getMessage(), permission);
                }
            }

            @Override
            public void flush() {
                // Not needed.
            }

            @Override
            public void close() throws SecurityException {
                // Do nothing.
            }
        };

        logger.addHandler(this.redirectHandler);
    }

    @Override
    public void onEnable() {
        if(loadingFailed) {
            this.getLogger().log(Level.SEVERE, "Loading of ProtocolLib failed (see log above). ProtocolLib will be disabled.");
            this.disablePlugin();
            return;
        }
        try {
            Server server = this.getServer();
            PluginManager manager = server.getPluginManager();

            // Silly plugin reloaders!
            if (protocolManager == null) {
                Logger directLogging = Logger.getLogger("Minecraft");
                String[] message = new String[]{
                        " ProtocolLib does not support plugin reloaders! ", " Please use the built-in reload command! "
                };

                // Print as severe
                for (String line : ChatExtensions.toFlowerBox(message, "*", 3, 1)) {
                    directLogging.severe(line);
                }

                this.disablePlugin();
                return;
            }

            // Check for incompatible plugins
            this.checkForIncompatibility(manager);

            // Set up command handlers
            this.registerCommand(CommandProtocol.NAME, this.commandProtocol);
            this.registerCommand(CommandPacket.NAME, this.commandPacket);
            this.registerCommand(CommandFilter.NAME, this.commandFilter);
            this.registerCommand(PacketLogging.NAME, this.packetLogging);

            // Player login and logout events
            protocolManager.registerEvents(manager, this);

            // Worker that ensures that async packets are eventually sent
            // It also performs the update check.
            this.createPacketTask(server);
        } catch (OutOfMemoryError e) {
            throw e;
        } catch (Throwable e) {
            reporter.reportDetailed(this, Report.newBuilder(REPORT_PLUGIN_ENABLE_ERROR).error(e));
            this.disablePlugin();
            return;
        }

        // Try to enable statistics
        try {
            if (config.isMetricsEnabled()) {
                this.statistics = new Statistics(this);
            }
        } catch (OutOfMemoryError e) {
            throw e;
        } catch (IOException e) {
            reporter.reportDetailed(this, Report.newBuilder(REPORT_METRICS_IO_ERROR).error(e).callerParam(this.statistics));
        } catch (Throwable e) {
            reporter.reportDetailed(this, Report.newBuilder(REPORT_METRICS_GENERIC_ERROR).error(e).callerParam(
                    this.statistics));
        }
    }

    private void checkForIncompatibility(PluginManager manager) {
        for (String plugin : ProtocolLibrary.INCOMPATIBLE) {
            if (manager.getPlugin(plugin) != null) {
                // Special case for TagAPI and iTag
                if (plugin.equals("TagAPI")) {
                    Plugin iTag = manager.getPlugin("iTag");
                    if (iTag == null || iTag.getDescription().getVersion().startsWith("1.0")) {
                        logger.severe("Detected incompatible plugin: TagAPI");
                    }
                } else {
                    logger.severe("Detected incompatible plugin: " + plugin);
                }
            }
        }
    }

    // Used to check Minecraft version
    private MinecraftVersion verifyMinecraftVersion() {
        MinecraftVersion minimum = new MinecraftVersion(ProtocolLibrary.MINIMUM_MINECRAFT_VERSION);
        MinecraftVersion maximum = new MinecraftVersion(ProtocolLibrary.MAXIMUM_MINECRAFT_VERSION);

        try {
            MinecraftVersion current = new MinecraftVersion(this.getServer());


            String line = "============================================================";
            // We'll just warn the user for now
            if (current.compareTo(minimum) < 0) {
                logger.warning(line + "\nThis version of ProtocolLib has only been tested with Minecraft " + minimum.getVersion() + " or newer.\n" + line);
            }
            if (current.compareTo(maximum) > 0) {
                boolean ignore = config.getIgnoreVersionCheck().equals(current.getVersion());
                Level level = ignore ? Level.WARNING : Level.SEVERE;
                logger.log(level, line);
                logger.log(level, "");
                logger.log(level, "This version of ProtocolLib (" + getDescription().getVersion() + ") has not been tested with Minecraft " + current.getVersion() + " and is likely not work as expected.");
                if(ignore) {
                    logger.log(level, "As you configured ProtocolLib to ignore this, ProtocolLib will attempt to continue initialization. Proceed with caution!");
                } else {
                    logger.log(level, "ProtocolLib will be **DISABLED** now. If you want to ignore this error, set \"ignore version check: '" + current.getVersion() +  "'\" in 'plugins/ProtocolLib/config.yml' and restart the server. Proceed with caution and expect errors!");
                }
                logger.log(level, "Check https://github.com/dmulloy2/ProtocolLib/releases for new releases of ProtocolLib and https://ci.dmulloy2.net/job/ProtocolLib/ for the latest development builds, which might support minecraft " + current.getVersion());
                logger.log(level, "");
                logger.log(level, line);

                if(!ignore) {
                    return null;
                }
            }

            return current;
        } catch (Exception e) {
            reporter.reportWarning(this,
                    Report.newBuilder(REPORT_CANNOT_PARSE_MINECRAFT_VERSION).error(e).messageParam(maximum));

            // Unknown version - just assume it is the latest
            return maximum;
        }
    }

    private void checkConflictingVersions() {
        Pattern ourPlugin = Pattern.compile("ProtocolLib-(.*)\\.jar");
        MinecraftVersion currentVersion = new MinecraftVersion(this.getDescription().getVersion());
        MinecraftVersion newestVersion = null;

        // Skip the file that contains this current instance however
        File loadedFile = this.getFile();

        try {
            // Scan the plugin folder for newer versions of ProtocolLib
            // The plugin folder isn't always plugins/
            File pluginFolder = this.getDataFolder().getParentFile();

            File[] candidates = pluginFolder.listFiles();
            if (candidates != null) {
                for (File candidate : candidates) {
                    if (candidate.isFile() && !candidate.equals(loadedFile)) {
                        Matcher match = ourPlugin.matcher(candidate.getName());
                        if (match.matches()) {
                            MinecraftVersion version = new MinecraftVersion(match.group(1));

                            if (candidate.length() == 0) {
                                // Delete and inform the user
                                logger.info((candidate.delete() ? "Deleted " : "Could not delete ") + candidate);
                            } else if (newestVersion == null || newestVersion.compareTo(version) < 0) {
                                newestVersion = version;
                            }
                        }
                    }
                }
            }
        } catch (Exception e) {
            // TODO This shows [ProtocolLib] and [ProtocolLibrary] in the message
            reporter.reportWarning(this, Report.newBuilder(REPORT_CANNOT_DETECT_CONFLICTING_PLUGINS).error(e));
        }

        // See if the newest version is actually higher
        if (newestVersion != null && currentVersion.compareTo(newestVersion) < 0) {
            // We don't need to set internal classes or instances to NULL - that would break the other loaded plugin
            this.skipDisable = true;

            throw new IllegalStateException(String.format(
                    "Detected a newer version of ProtocolLib (%s) in plugin folder than the current (%s). Disabling.",
                    newestVersion.getVersion(), currentVersion.getVersion()));
        }
    }

    private void registerCommand(String name, CommandExecutor executor) {
        try {
            // Ignore these - they must have printed an error already
            if (executor == null) {
                return;
            }

            PluginCommand command = this.getCommand(name);

            // Try to load the command
            if (command != null) {
                command.setExecutor(executor);
            } else {
                throw new RuntimeException("plugin.yml might be corrupt.");
            }
        } catch (RuntimeException e) {
            reporter.reportWarning(this,
                    Report.newBuilder(REPORT_CANNOT_REGISTER_COMMAND).messageParam(name, e.getMessage()).error(e));
        }
    }

    /**
     * Disable the current plugin.
     */
    private void disablePlugin() {
        this.getServer().getPluginManager().disablePlugin(this);
    }

    private void createPacketTask(Server server) {
        try {
            if (this.packetTask != null) {
                throw new IllegalStateException("Packet task has already been created");
            }

            // Attempt to create task
            this.packetTask = scheduler.scheduleSyncRepeatingTask(() -> {
                AsyncFilterManager manager = (AsyncFilterManager) protocolManager.getAsynchronousManager();
                // We KNOW we're on the main thread at the moment
                manager.sendProcessedPackets(ProtocolLib.this.tickCounter++, true);

                // House keeping
                ProtocolLib.this.updateConfiguration();

                // Check for updates too
                if (!ProtocolLibrary.updatesDisabled() && (ProtocolLib.this.tickCounter % 20) == 0) {
                    ProtocolLib.this.checkUpdates();
                }
            }, ASYNC_MANAGER_DELAY, ASYNC_MANAGER_DELAY);
        } catch (OutOfMemoryError e) {
            throw e;
        } catch (Throwable e) {
            if (this.packetTask == null) {
                reporter.reportDetailed(this, Report.newBuilder(REPORT_CANNOT_CREATE_TIMEOUT_TASK).error(e));
            }
        }
    }

    private void updateConfiguration() {
        if (config != null && config.getModificationCount() != this.configExpectedMod) {
            this.configExpectedMod = config.getModificationCount();

            // Update the debug flag
            protocolManager.setDebug(config.isDebug());
        }
    }

    private void checkUpdates() {
        // Ignore milliseconds - it's pointless
        long currentTime = System.currentTimeMillis() / MILLI_PER_SECOND;

        try {
            long updateTime = config.getAutoLastTime() + config.getAutoDelay();

            // Should we update?
            if (currentTime > updateTime && !this.updater.isChecking()) {
                // Initiate the update as if it came from the console
                if (config.isAutoDownload()) {
                    this.commandProtocol.updateVersion(this.getServer().getConsoleSender(), false);
                } else if (config.isAutoNotify()) {
                    this.commandProtocol.checkVersion(this.getServer().getConsoleSender(), false);
                } else {
                    this.commandProtocol.updateFinished();
                }
            }
        } catch (Exception e) {
            reporter.reportDetailed(this, Report.newBuilder(REPORT_CANNOT_UPDATE_PLUGIN).error(e));
            ProtocolLibrary.disableUpdates();
        }
    }

    @Override
    public void onDisable() {
        if (this.skipDisable) {
            return;
        }

        // that reloading the server might break ProtocolLib / plugins depending on it
        if (Util.isCurrentlyReloading()) {
            logger.severe("╔══════════════════════════════════════════════════════════════════╗");
            logger.severe("║                               WARNING                            ║");
            logger.severe("║     RELOADING THE SERVER WHILE PROTOCOL LIB IS ENABLED MIGHT     ║");
            logger.severe("║                    LEAD TO UNEXPECTED ERRORS!                    ║");
            logger.severe("║                                                                  ║");
            logger.severe("║     Consider to cleanly restart your server if you encounter     ║");
            logger.severe("║    any issues related to Protocol Lib before opening an issue    ║");
            logger.severe("║                            on GitHub!                            ║");
            logger.severe("╚══════════════════════════════════════════════════════════════════╝");
        }

        // Clean up
        if (this.packetTask != null) {
            packetTask.cancel();
            this.packetTask = null;
        }

        // And redirect handler too
        if (this.redirectHandler != null) {
            logger.removeHandler(this.redirectHandler);
        }
        if (protocolManager != null) {
            protocolManager.close();
        } else {
            return; // Plugin reloaders!
        }

        protocolManager = null;
        this.statistics = null;

        // To clean up global parameters
        reporter = new BasicErrorReporter();
    }

    /**
     * Retrieve the metrics instance used to measure users of this library.
     * <p>
     * Note that this method may return NULL when the server is reloading or shutting down. It is also NULL if metrics has
     * been disabled.
     *
     * @return Metrics instance container.
     */
    public Statistics getStatistics() {
        return this.statistics;
    }

    public ProtocolConfig getProtocolConfig() {
        return config;
    }

    public ProtocolScheduler getScheduler() {
        return scheduler;
    }

    // Different commands
    private enum ProtocolCommand {
        FILTER,
        PACKET,
        PROTOCOL,
        LOGGING
    }
}