/* * Minecraft Forge * Copyright (c) 2016-2019. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation version 2.1 * of the License. * * This library 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 * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ package net.minecraftforge.fml; import com.google.common.collect.ImmutableList; import cpw.mods.modlauncher.TransformingClassLoader; import net.minecraft.data.DataGenerator; import net.minecraft.util.registry.Bootstrap; import net.minecraftforge.api.distmarker.Dist; import net.minecraftforge.client.event.ModelRegistryEvent; import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.common.capabilities.CapabilityManager; import net.minecraftforge.fml.config.ConfigTracker; import net.minecraftforge.fml.config.ModConfig; import net.minecraftforge.fml.event.lifecycle.GatherDataEvent; import net.minecraftforge.fml.event.lifecycle.ModLifecycleEvent; import net.minecraftforge.fml.loading.FMLLoader; import net.minecraftforge.fml.loading.FMLPaths; import net.minecraftforge.fml.loading.LoadingModList; import net.minecraftforge.fml.loading.moddiscovery.ModFile; import net.minecraftforge.fml.loading.moddiscovery.ModFileInfo; import net.minecraftforge.fml.network.FMLNetworkConstants; import net.minecraftforge.fml.network.NetworkRegistry; import net.minecraftforge.forgespi.language.IModInfo; import net.minecraftforge.forgespi.language.IModLanguageProvider; import net.minecraftforge.registries.GameData; import net.minecraftforge.registries.ObjectHolderRegistry; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import java.io.IOException; import java.nio.file.Path; import java.util.*; import java.util.function.Function; import java.util.stream.Collectors; import static net.minecraftforge.fml.Logging.CORE; import static net.minecraftforge.fml.Logging.LOADING; /** * Loads mods. * * Dispatch cycle is seen in {@link #loadMods()} and {@link #finishMods()} * * Overall sequence for loadMods is: *
*
CONSTRUCT
*
Constructs the mod instance. Mods can typically setup basic environment such as Event listeners * and Configuration specifications here.
*
Automated dispatches
*
Dispatches automated elements : {@link net.minecraftforge.fml.common.Mod.EventBusSubscriber}, * {@link net.minecraftforge.event.RegistryEvent}, {@link net.minecraftforge.common.capabilities.CapabilityInject} * and others
*
CONFIG_LOAD
*
Dispatches ConfigLoadEvent to mods
*
COMMON_SETUP
*
Dispatches {@link net.minecraftforge.fml.event.lifecycle.FMLCommonSetupEvent} to mods
*
SIDED_SETUP
*
Dispatches {@link net.minecraftforge.fml.event.lifecycle.FMLClientSetupEvent} or * {@link net.minecraftforge.fml.event.lifecycle.FMLDedicatedServerSetupEvent} to mods
*
* * Overall sequence for finishMods is: *
*
ENQUEUE_IMC
*
Dispatches {@link net.minecraftforge.fml.event.lifecycle.InterModEnqueueEvent} to mods, * for enqueuing {@link InterModComms} messages for other mods to receive subsequently
*
PROCESS_IMC
*
Dispatches {@link net.minecraftforge.fml.event.lifecycle.InterModProcessEvent} to mods, * for processing {@link InterModComms} messages received from other mods prior to this event
*
COMPLETE
*
Dispatches {@link net.minecraftforge.fml.event.lifecycle.FMLLoadCompleteEvent} to mods, * and completes the mod loading sequence.
*
*/ public class ModLoader { private static final Logger LOGGER = LogManager.getLogger(); private static ModLoader INSTANCE; private final TransformingClassLoader launchClassLoader; private final LoadingModList loadingModList; private final List loadingExceptions; private final List loadingWarnings; private GatherDataEvent.DataGeneratorConfig dataGeneratorConfig; private ModLoader() { INSTANCE = this; this.launchClassLoader = FMLLoader.getLaunchClassLoader(); this.loadingModList = FMLLoader.getLoadingModList(); this.loadingExceptions = FMLLoader.getLoadingModList(). getErrors().stream().flatMap(ModLoadingException::fromEarlyException).collect(Collectors.toList()); this.loadingWarnings = FMLLoader.getLoadingModList(). getBrokenFiles().stream().map(file -> new ModLoadingWarning(null, ModLoadingStage.VALIDATE, "fml.modloading.brokenfile", file.getFileName())).collect(Collectors.toList()); LOGGER.info(CORE, "Loading Network data for FML net version: {}", FMLNetworkConstants.NETVERSION); } public static ModLoader get() { return INSTANCE == null ? INSTANCE = new ModLoader() : INSTANCE; } private static Runnable fireClientEvents() { return ()->MinecraftForge.EVENT_BUS.post(new ModelRegistryEvent()); } public void loadMods() { gatherAndInitializeMods(); DistExecutor.runWhenOn(Dist.CLIENT, ()->()-> ConfigTracker.INSTANCE.loadConfigs(ModConfig.Type.CLIENT, FMLPaths.CONFIGDIR.get())); ConfigTracker.INSTANCE.loadConfigs(ModConfig.Type.COMMON, FMLPaths.CONFIGDIR.get()); dispatchAndHandleError(LifecycleEventProvider.SETUP); DistExecutor.runWhenOn(Dist.CLIENT, ModLoader::fireClientEvents); dispatchAndHandleError(LifecycleEventProvider.SIDED_SETUP); } private void gatherAndInitializeMods() { final ModList modList = ModList.of(loadingModList.getModFiles().stream().map(ModFileInfo::getFile).collect(Collectors.toList()), loadingModList.getMods()); if (!this.loadingExceptions.isEmpty()) { throw new LoadingFailedException(loadingExceptions); } final List modContainers = loadingModList.getModFiles().stream(). map(ModFileInfo::getFile). map(mf -> buildMods(mf, launchClassLoader)). flatMap(Collection::stream). collect(Collectors.toList()); if (!loadingExceptions.isEmpty()) { LOGGER.fatal(CORE, "Failed to initialize mod containers"); throw new LoadingFailedException(loadingExceptions); } modList.setLoadedMods(modContainers); dispatchAndHandleError(LifecycleEventProvider.CONSTRUCT); GameData.fireCreateRegistryEvents(LifecycleEventProvider.CREATE_REGISTRIES, this::dispatchAndHandleError); ObjectHolderRegistry.findObjectHolders(); CapabilityManager.INSTANCE.injectCapabilities(modList.getAllScanData()); GameData.fireRegistryEvents(rl->true, LifecycleEventProvider.LOAD_REGISTRIES, this::dispatchAndHandleError); } private void dispatchAndHandleError(LifecycleEventProvider event) { if (!loadingExceptions.isEmpty()) { LOGGER.error(LOADING,"Skipping lifecycle event {}, {} errors found.", event, loadingExceptions.size()); } else { event.dispatch(this::accumulateErrors); } if (!loadingExceptions.isEmpty()) { LOGGER.fatal(LOADING,"Failed to complete lifecycle event {}, {} errors found", event, loadingExceptions.size()); throw new LoadingFailedException(loadingExceptions); } } private void accumulateErrors(List errors) { loadingExceptions.addAll(errors); } private List buildMods(final ModFile modFile, final TransformingClassLoader modClassLoader) { final Map modInfoMap = modFile.getModFileInfo().getMods().stream().collect(Collectors.toMap(IModInfo::getModId, Function.identity())); LOGGER.debug(LOADING, "ModContainer is {}", ModContainer.class.getClassLoader()); final List containers = modFile.getScanResult().getTargets().entrySet().stream(). map(e -> buildModContainerFromTOML(modFile, modClassLoader, modInfoMap, e)).collect(Collectors.toList()); if (containers.size() != modInfoMap.size()) { LOGGER.fatal(LOADING,"File {} constructed {} mods: {}, but had {} mods specified: {}", modFile.getFilePath(), containers.size(), containers.stream().map(ModContainer::getModId).collect(Collectors.toList()), modInfoMap.size(), modInfoMap.values().stream().map(IModInfo::getModId).collect(Collectors.toList())); loadingExceptions.add(new ModLoadingException(null, ModLoadingStage.CONSTRUCT, "fml.modloading.missingclasses", null, modFile.getFilePath())); } return containers; } private ModContainer buildModContainerFromTOML(final ModFile modFile, final TransformingClassLoader modClassLoader, final Map modInfoMap, final Map.Entry idToProviderEntry) { try { final String modId = idToProviderEntry.getKey(); final IModLanguageProvider.IModLanguageLoader languageLoader = idToProviderEntry.getValue(); IModInfo info = Optional.ofNullable(modInfoMap.get(modId)). // throw a missing metadata error if there is no matching modid in the modInfoMap from the mods.toml file orElseThrow(()->new ModLoadingException(null, ModLoadingStage.CONSTRUCT, "fml.modloading.missingmetadata", null, modId)); return languageLoader.loadMod(info, modClassLoader, modFile.getScanResult()); } catch (ModLoadingException mle) { // exceptions are caught and added to the error list for later handling. Null is returned here. loadingExceptions.add(mle); return null; } } public void finishMods() { dispatchAndHandleError(LifecycleEventProvider.ENQUEUE_IMC); dispatchAndHandleError(LifecycleEventProvider.PROCESS_IMC); dispatchAndHandleError(LifecycleEventProvider.COMPLETE); GameData.freezeData(); NetworkRegistry.lock(); } public List getWarnings() { return ImmutableList.copyOf(this.loadingWarnings); } public void addWarning(ModLoadingWarning warning) { this.loadingWarnings.add(warning); } public void runDataGenerator(final Set mods, final Path path, final Collection inputs, final boolean serverGenerators, final boolean clientGenerators, final boolean devToolGenerators, final boolean reportsGenerator, final boolean structureValidator) { if (mods.contains("minecraft") && mods.size() == 1) return; LOGGER.info("Initializing Data Gatherer for mods {}", mods); Bootstrap.register(); dataGeneratorConfig = new GatherDataEvent.DataGeneratorConfig(mods, path, inputs, serverGenerators, clientGenerators, devToolGenerators, reportsGenerator, structureValidator); gatherAndInitializeMods(); dispatchAndHandleError(LifecycleEventProvider.GATHERDATA); dataGeneratorConfig.runAll(); } public Function getDataGeneratorEvent() { return mc -> new GatherDataEvent(mc, dataGeneratorConfig.makeGenerator(p->dataGeneratorConfig.getMods().size() == 1 ? p : p.resolve(mc.getModId()), dataGeneratorConfig.getMods().contains(mc.getModId())), dataGeneratorConfig); } }