/******************************************************************************* * Copyright (c) 2011-2014 SirSengir. * All rights reserved. This program and the accompanying materials * are made available under the terms of the GNU Lesser Public License v3 * which accompanies this distribution, and is available at * http://www.gnu.org/licenses/lgpl-3.0.txt * * Various Contributors including, but not limited to: * SirSengir (original work), CovertJaguar, Player, Binnie, MysteriousAges ******************************************************************************/ package forestry.plugins; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableSet; import com.google.common.collect.Lists; import javax.annotation.Nonnull; import java.io.File; import java.util.ArrayList; import java.util.HashSet; import java.util.Iterator; import java.util.LinkedHashSet; import java.util.List; import java.util.Locale; import java.util.Random; import java.util.Set; import net.minecraft.command.CommandHandler; import net.minecraft.command.ICommand; import net.minecraft.item.ItemStack; import net.minecraft.server.MinecraftServer; import net.minecraft.util.StatCollector; import net.minecraft.world.World; import net.minecraft.world.chunk.IChunkProvider; import net.minecraftforge.common.config.Configuration; import net.minecraftforge.common.config.Property; import net.minecraftforge.fml.common.IFuelHandler; import net.minecraftforge.fml.common.discovery.ASMDataTable; import net.minecraftforge.fml.common.event.FMLInterModComms; import net.minecraftforge.fml.common.event.FMLPreInitializationEvent; import net.minecraftforge.fml.common.registry.GameRegistry; import forestry.Forestry; import forestry.api.core.ForestryAPI; import forestry.core.IPickupHandler; import forestry.core.IResupplyHandler; import forestry.core.ISaveEventHandler; import forestry.core.PluginCore; import forestry.core.network.IPacketRegistry; import forestry.core.utils.Log; public class PluginManager { private static final String PLUGIN_CONFIG_FILE_NAME = "plugins.cfg"; private static final String CATEGORY_PLUGINS = "plugins"; public static final ArrayList pickupHandlers = Lists.newArrayList(); public static final ArrayList saveEventHandlers = Lists.newArrayList(); public static final ArrayList resupplyHandlers = Lists.newArrayList(); private static final Set loadedPlugins = new LinkedHashSet<>(); private static final Set unloadedPlugins = new LinkedHashSet<>(); private static Stage stage = Stage.SETUP; public enum Stage { SETUP, // setup API to make it functional, register basic blocks and items. GameMode Configs are not yet accessible SETUP_DISABLED, // setup fallback API to avoid crashes PRE_INIT, // register handlers, triggers, definitions, backpacks, crates, and anything that depends on basic items INIT, // anything that depends on PreInit stages, recipe registration POST_INIT, // stubborn mod integration, dungeon loot, and finalization of things that take input from mods FINISHED } public static final Set configDisabledPlugins = new HashSet<>(); public static Stage getStage() { return stage; } public static Set getLoadedPlugins() { return ImmutableSet.copyOf(loadedPlugins); } private static void registerHandlers(IForestryPlugin plugin) { Log.debug("Registering Handlers for Plugin: {}", plugin); IPacketRegistry packetRegistry = plugin.getPacketRegistry(); if (packetRegistry != null) { packetRegistry.registerPackets(); } IPickupHandler pickupHandler = plugin.getPickupHandler(); if (pickupHandler != null) { pickupHandlers.add(pickupHandler); } ISaveEventHandler saveHandler = plugin.getSaveEventHandler(); if (saveHandler != null) { saveEventHandlers.add(saveHandler); } IResupplyHandler resupplyHandler = plugin.getResupplyHandler(); if (resupplyHandler != null) { resupplyHandlers.add(resupplyHandler); } IFuelHandler fuelHandler = plugin.getFuelHandler(); if (fuelHandler != null) { GameRegistry.registerFuelHandler((fuelHandler)); } } private static IForestryPlugin getPluginCore(@Nonnull List forestryPlugins) { for (IForestryPlugin plugin : forestryPlugins) { if (plugin instanceof PluginCore) { return plugin; } } return null; } private static void configurePlugins(@Nonnull List forestryPlugins) { Locale locale = Locale.getDefault(); Locale.setDefault(Locale.ENGLISH); Configuration config = new Configuration(new File(Forestry.instance.getConfigFolder(), PLUGIN_CONFIG_FILE_NAME)); config.load(); config.addCustomCategoryComment(CATEGORY_PLUGINS, "Disabling these plugins can greatly change how the mod functions.\n" + "Your mileage may vary, please report any issues."); IForestryPlugin corePlugin = getPluginCore(forestryPlugins); forestryPlugins.remove(corePlugin); forestryPlugins.add(0, corePlugin); Set toLoad = new HashSet<>(); ImmutableList allForestryPlugins = ImmutableList.copyOf(forestryPlugins); Iterator iterator = forestryPlugins.iterator(); while (iterator.hasNext()) { IForestryPlugin plugin = iterator.next(); if (plugin.canBeDisabled()) { if (!isEnabled(config, plugin)) { iterator.remove(); Log.info("Plugin disabled: {0}", plugin); continue; } if (!plugin.isAvailable()) { iterator.remove(); Log.info("Plugin {0} failed to load: {1}", plugin, plugin.getFailMessage()); continue; } } ForestryPlugin info = plugin.getClass().getAnnotation(ForestryPlugin.class); toLoad.add(info.pluginID()); } boolean changed; do { changed = false; iterator = forestryPlugins.iterator(); while (iterator.hasNext()) { IForestryPlugin plugin = iterator.next(); Set dependencies = plugin.getDependencyUids(); if (!toLoad.containsAll(dependencies)) { iterator.remove(); changed = true; ForestryPlugin info = plugin.getClass().getAnnotation(ForestryPlugin.class); String pluginId = info.pluginID(); toLoad.remove(pluginId); Log.warning("Plugin {0} is missing dependencies: {1}", pluginId, dependencies); } } } while (changed); loadedPlugins.addAll(forestryPlugins); unloadedPlugins.addAll(allForestryPlugins); unloadedPlugins.removeAll(loadedPlugins); ForestryAPI.enabledPlugins = new HashSet<>(); for (IForestryPlugin plugin : loadedPlugins) { ForestryPlugin info = plugin.getClass().getAnnotation(ForestryPlugin.class); ForestryAPI.enabledPlugins.add(info.pluginID()); } if (config.hasChanged()) { config.save(); } Locale.setDefault(locale); } public static void runSetup(FMLPreInitializationEvent event) { ASMDataTable asmDataTable = event.getAsmData(); List forestryPlugins = ForestryPluginUtil.getForestryPlugins(asmDataTable); stage = Stage.SETUP; configurePlugins(forestryPlugins); for (IForestryPlugin plugin : loadedPlugins) { Log.debug("Setup Start: {0}", plugin); plugin.setupAPI(); plugin.registerItemsAndBlocks(); Log.debug("Setup Complete: {0}", plugin); } stage = Stage.SETUP_DISABLED; for (IForestryPlugin plugin : unloadedPlugins) { Log.debug("Disabled-Setup Start: {0}", plugin); plugin.disabledSetupAPI(); Log.debug("Disabled-Setup Complete: {0}", plugin); } } public static void runPreInit() { stage = Stage.PRE_INIT; for (IForestryPlugin plugin : loadedPlugins) { Log.debug("Pre-Init Start: {0}", plugin); registerHandlers(plugin); plugin.preInit(); if (ForestryAPI.enabledPlugins.contains(ForestryPluginUids.BUILDCRAFT_STATEMENTS)) { plugin.registerTriggers(); } if (ForestryAPI.enabledPlugins.contains(ForestryPluginUids.STORAGE)) { plugin.registerBackpackItems(); plugin.registerCrates(); } Log.debug("Pre-Init Complete: {0}", plugin); } } public static void runInit() { stage = Stage.INIT; for (IForestryPlugin plugin : loadedPlugins) { Log.debug("Init Start: {0}", plugin); plugin.doInit(); plugin.registerRecipes(); Log.debug("Init Complete: {0}", plugin); } } public static void runPostInit() { stage = Stage.POST_INIT; for (IForestryPlugin plugin : loadedPlugins) { Log.debug("Post-Init Start: {0}", plugin); plugin.postInit(); Log.debug("Post-Init Complete: {0}", plugin); } stage = Stage.FINISHED; } public static void serverStarting(MinecraftServer server) { CommandHandler commandManager = (CommandHandler) server.getCommandManager(); for (IForestryPlugin plugin : loadedPlugins) { ICommand[] commands = plugin.getConsoleCommands(); if (commands == null) { continue; } for (ICommand command : commands) { commandManager.registerCommand(command); } } } public static void processIMCMessages(ImmutableList messages) { for (FMLInterModComms.IMCMessage message : messages) { for (IForestryPlugin plugin : loadedPlugins) { if (plugin.processIMCMessage(message)) { break; } } } } public static void populateChunk(IChunkProvider chunkProvider, World world, Random rand, int chunkX, int chunkZ, boolean hasVillageGenerated) { for (IForestryPlugin plugin : loadedPlugins) { plugin.populateChunk(chunkProvider, world, rand, chunkX, chunkZ, hasVillageGenerated); } } public static void populateChunkRetroGen(World world, Random rand, int chunkX, int chunkZ) { for (IForestryPlugin plugin : loadedPlugins) { plugin.populateChunkRetroGen(world, rand, chunkX, chunkZ); } } @Nonnull public static List getHiddenItems() { List hiddenItems = new ArrayList<>(); for (IForestryPlugin plugin : loadedPlugins) { plugin.getHiddenItems(hiddenItems); } return hiddenItems; } private static boolean isEnabled(Configuration config, IForestryPlugin plugin) { ForestryPlugin info = plugin.getClass().getAnnotation(ForestryPlugin.class); String comment = StatCollector.translateToLocal(info.unlocalizedDescription()); Property prop = config.get(CATEGORY_PLUGINS, info.pluginID(), true, comment); boolean enabled = prop.getBoolean(); if (!enabled) { configDisabledPlugins.add(plugin); } return enabled; } }