show a list of invalid containers if no valid containers are found

Mumfrey
1 parent 12a6cba5
Showing 12 changed files with 245 additions and 22 deletions
java/client/com/mumfrey/liteloader/client/gui/modlist/GuiModListPanel.java
java/client/com/mumfrey/liteloader/client/gui/modlist/GuiModListPanelInvalid.java
java/client/com/mumfrey/liteloader/client/gui/modlist/ModList.java
java/client/com/mumfrey/liteloader/client/gui/modlist/ModListEntry.java
java/common/com/mumfrey/liteloader/core/BadContainerInfo.java
java/common/com/mumfrey/liteloader/core/LiteLoaderEnumerator.java
java/common/com/mumfrey/liteloader/core/LiteLoaderMods.java
java/common/com/mumfrey/liteloader/core/ModInfo.java
java/common/com/mumfrey/liteloader/core/api/EnumeratorModuleFolder.java
java/common/com/mumfrey/liteloader/core/api/LoadableModFile.java
java/common/com/mumfrey/liteloader/interfaces/LoaderEnumerator.java
java/common/com/mumfrey/liteloader/interfaces/ModularEnumerator.java
@@ -41,18 +41,18 @@ public class GuiModListPanel extends Gui
 	static final int PANEL_HEIGHT              = 32;
 	static final int PANEL_SPACING             = 3;
-	private ModListEntry owner;
+	protected ModListEntry owner;
 	/**
 	 * For text display
 	 */
-	private final FontRenderer fontRenderer;
+	protected final FontRenderer fontRenderer;
-	private final int brandColour;
+	protected final int brandColour;
-	private final List<ModInfoDecorator> decorators;
+	protected final List<ModInfoDecorator> decorators;
-	private final ModInfo<?> modInfo;
+	protected final ModInfo<?> modInfo;
 	/**
 	 * True if the mouse was over this mod on the last render
@@ -65,11 +65,11 @@ public class GuiModListPanel extends Gui
 	public GuiModListPanel(ModListEntry owner, FontRenderer fontRenderer, int brandColour, ModInfo<?> modInfo, List<ModInfoDecorator> decorators)
 	{
-		this.owner = owner;
+		this.owner        = owner;
 		this.fontRenderer = fontRenderer;
-		this.brandColour = brandColour;
-		this.modInfo = modInfo;
-		this.decorators = decorators;
+		this.brandColour  = brandColour;
+		this.modInfo      = modInfo;
+		this.decorators   = decorators;
 		for (ModInfoDecorator decorator : this.decorators)
 		{
@@ -122,7 +122,7 @@ public class GuiModListPanel extends Gui
 		this.fontRenderer.drawString(versionText, xPosition + 5, yPosition + 12, GuiModListPanel.VERSION_TEXT_COLOUR);
 		this.fontRenderer.drawString(statusText,  xPosition + 5, yPosition + 22, statusColour);
-		this.mouseOver = this.isMouseOver(mouseX, mouseY, xPosition, yPosition, width, PANEL_HEIGHT); 
+		this.updateMouseOver(mouseX, mouseY, xPosition, yPosition, width); 
 		int hangerColour = this.mouseOver ? GuiModListPanel.HANGER_COLOUR_MOUSEOVER : GuiModListPanel.HANGER_COLOUR;
 		drawRect(xPosition, yPosition, xPosition + 1, yPosition + PANEL_HEIGHT, hangerColour);
@@ -131,6 +131,18 @@ public class GuiModListPanel extends Gui
 			decorator.onDrawListEntry(mouseX, mouseY, partialTicks, xPosition, yPosition, width, GuiModListPanel.PANEL_HEIGHT, selected, this.modInfo, gradientColour, titleColour, statusColour);
 		}
 	}
+
+	/**
+	 * @param mouseX
+	 * @param mouseY
+	 * @param xPosition
+	 * @param yPosition
+	 * @param width
+	 */
+	protected void updateMouseOver(int mouseX, int mouseY, int xPosition, int yPosition, int width)
+	{
+		this.mouseOver = this.isMouseOver(mouseX, mouseY, xPosition, yPosition, width, PANEL_HEIGHT);
+	}
 	protected void postRender(int mouseX, int mouseY, float partialTicks, int xPosition, int yPosition, int width, boolean selected)
 	{
@@ -218,7 +230,7 @@ public class GuiModListPanel extends Gui
 		return GuiModListPanel.PANEL_HEIGHT + GuiModListPanel.PANEL_SPACING;
 	}
-	private boolean isMouseOver(int mouseX, int mouseY, int x, int y, int width, int height)
+	protected boolean isMouseOver(int mouseX, int mouseY, int x, int y, int width, int height)
 	{
 		return mouseX > x && mouseX < x + width && mouseY > y && mouseY < y + height;
 	}
+package com.mumfrey.liteloader.client.gui.modlist;
+
+import java.util.List;
+
+import net.minecraft.client.gui.FontRenderer;
+
+import com.mumfrey.liteloader.api.ModInfoDecorator;
+import com.mumfrey.liteloader.core.ModInfo;
+
+public class GuiModListPanelInvalid extends GuiModListPanel
+{
+	private static final int BAD_PANEL_HEIGHT = 22;
+
+	public GuiModListPanelInvalid(ModListEntry owner, FontRenderer fontRenderer, int brandColour, ModInfo<?> modInfo, List<ModInfoDecorator> decorators)
+	{
+		super(owner, fontRenderer, brandColour, modInfo, decorators);
+	}
+
+	@Override
+	protected void render(int mouseX, int mouseY, float partialTicks, int xPosition, int yPosition, int width, boolean selected)
+	{
+		int gradientColour = selected ? ERROR_GRADIENT_COLOUR : ERROR_GRADIENT_COLOUR2;
+		
+		this.drawGradientRect(xPosition, yPosition, xPosition + width, yPosition + 22, gradientColour, GuiModListPanel.GRADIENT_COLOUR2);
+		
+		String titleText = this.owner.getTitleText();
+		String reasonText = this.modInfo.getDescription();
+
+		this.fontRenderer.drawString(titleText,   xPosition + 5, yPosition + 2,  0xFF8888);
+		this.fontRenderer.drawString(reasonText, xPosition + 5, yPosition + 12, GuiModListPanel.ERROR_GRADIENT_COLOUR);
+		
+		this.updateMouseOver(mouseX, mouseY, xPosition, yPosition, width); 
+		drawRect(xPosition, yPosition, xPosition + 1, yPosition + 22, ERROR_COLOUR);
+	}
+	
+	@Override
+	protected void postRender(int mouseX, int mouseY, float partialTicks, int xPosition, int yPosition, int width, boolean selected)
+	{
+	}
+	
+	@Override
+	public int getHeight()
+	{
+		return GuiModListPanelInvalid.BAD_PANEL_HEIGHT;
+	}
+	
+	@Override
+	public int getTotalHeight()
+	{
+		return GuiModListPanelInvalid.BAD_PANEL_HEIGHT + GuiModListPanel.PANEL_SPACING;
+	}
+}
@@ -71,6 +71,16 @@ public class ModList
 			ModListEntry modListEntry = new ModListEntry(this, mods, environment, minecraft.fontRendererObj, brandColour, decorators, disabledMod);
 			sortedMods.put(modListEntry.getKey(), modListEntry);
 		}
+		
+		// Show bad containers if no other containers are found, should help users realise they have the wrong mod version!
+		if (sortedMods.size() == 0)
+		{
+			for (ModInfo<?> badMod : mods.getBadContainers())
+			{
+				ModListEntry modListEntry = new ModListEntry(this, mods, environment, minecraft.fontRendererObj, brandColour, decorators, badMod);
+				sortedMods.put(modListEntry.getKey(), modListEntry);
+			}
+		}
 		// Injected tweaks
 		for (ModInfo<Loadable<?>> injectedTweak : mods.getInjectedTweaks())
@@ -37,6 +37,8 @@ public class ModListEntry
 	 */
 	private boolean isActive;
+	private boolean isValid;
+	
 	private boolean isMissingDependencies;
 	private boolean isMissingAPIs;
@@ -90,12 +92,13 @@ public class ModListEntry
 		this.modInfo       = modInfo;
 		this.isActive      = modInfo.isActive();
+		this.isValid       = modInfo.isValid();
 		this.canBeToggled  = modInfo.isToggleable() && mods.getEnabledModsList().saveAllowed();
 		this.willBeEnabled = mods.isModEnabled(this.modInfo.getIdentifier());;
 		this.isExternal    = modInfo.getContainer().isExternalJar();
 		this.isErrored     = modInfo.getStartupErrors() != null && modInfo.getStartupErrors().size() > 0;
-		if (!modInfo.isActive())
+		if (!modInfo.isActive() && this.isValid)
 		{
 			this.isActive = modInfo.getContainer().isEnabled(environment);
@@ -123,7 +126,15 @@ public class ModListEntry
 	protected void initPanels(FontRenderer fontRenderer, int brandColour, List<ModInfoDecorator> decorators, ModInfo<?> modInfo)
 	{
 		this.infoPanel = new GuiModInfoPanel(this, fontRenderer, brandColour, modInfo);
-		this.listPanel = new GuiModListPanel(this, fontRenderer, brandColour, modInfo, decorators);
+		
+		if (this.isValid)
+		{
+			this.listPanel = new GuiModListPanel(this, fontRenderer, brandColour, modInfo, decorators);
+		}
+		else
+		{
+			this.listPanel = new GuiModListPanelInvalid(this, fontRenderer, brandColour, modInfo, decorators);
+		}
 	}
 	public void onTick()
+package com.mumfrey.liteloader.core;
+
+import com.mumfrey.liteloader.core.api.LoadableModFile;
+import com.mumfrey.liteloader.interfaces.Loadable;
+
+/**
+ * ModInfo for invalid containers
+ * 
+ * @author Adam Mummery-Smith
+ */
+public class BadContainerInfo extends NonMod
+{
+	/**
+	 * Reason the container could not be loaded 
+	 */
+	private final String reason;
+	
+	public BadContainerInfo(Loadable<?> container, String reason)
+	{
+		super(container, false);
+		this.reason = reason;
+	}
+	
+	/* (non-Javadoc)
+	 * @see com.mumfrey.liteloader.core.ModInfo#isToggleable()
+	 */
+	@Override
+	public boolean isToggleable()
+	{
+		return false;
+	}
+	
+	/* (non-Javadoc)
+	 * @see com.mumfrey.liteloader.core.ModInfo#isValid()
+	 */
+	@Override
+	public boolean isValid()
+	{
+		return false;
+	}
+	
+	/* (non-Javadoc)
+	 * @see com.mumfrey.liteloader.core.ModInfo#getDescription()
+	 */
+	@Override
+	public String getDescription()
+	{
+		return "\247c" + this.reason;
+	}
+	
+	/* (non-Javadoc)
+	 * @see com.mumfrey.liteloader.core.ModInfo#getVersion()
+	 */
+	@Override
+	public String getVersion()
+	{
+		if (this.container instanceof LoadableModFile)
+		{
+			return "supported: \247c" + ((LoadableModFile)this.container).getTargetVersion() + "\247r"; 
+		}
+		
+		return "supported: \247cUnknown";
+	}
+}
@@ -94,6 +94,11 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
 	 * Mapping of identifiers to mod containers 
 	 */
 	private final Map<String, LoadableMod<?>> enabledContainers = new HashMap<String, LoadableMod<?>>();
+
+	/**
+	 * Map of containers which cannot be loaded to reasons
+	 */
+	private final Set<ModInfo<Loadable<?>>> badContainers = new HashSet<ModInfo<Loadable<?>>>();
 	/**
 	 * Containers which have already been checked for potential mod candidates 
@@ -259,6 +264,14 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
 		return this.disabledContainers.values();
 	}
+	@Override
+	public Collection<? extends ModInfo<Loadable<?>>> getBadContainers()
+	{
+		this.checkState(EnumeratorState.FINALISED, "getBadContainers");
+		
+		return this.badContainers;
+	}
+	
 	/**
 	 * Get the list of injected tweak containers
 	 */
@@ -446,7 +459,7 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
 	}
 	/* (non-Javadoc)
-	 * @see com.mumfrey.liteloader.interfaces.PluggableEnumerator#registerModContainer(com.mumfrey.liteloader.interfaces.LoadableMod)
+	 * @see com.mumfrey.liteloader.interfaces.ModularEnumerator#registerModContainer(com.mumfrey.liteloader.interfaces.LoadableMod)
 	 */
 	@Override
 	public final boolean registerModContainer(LoadableMod<?> container)
@@ -478,6 +491,15 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
 		return true;
 	}
+	
+	@Override
+	public void registerBadContainer(Loadable<?> container, String reason)
+	{
+		this.checkState(EnumeratorState.DISCOVER, "registerBadContainer");
+		
+		BadContainerInfo badMod = new BadContainerInfo(container, reason);
+		this.badContainers.add(badMod);
+	}
 	/**
 	 * @param container
@@ -2,6 +2,7 @@ package com.mumfrey.liteloader.core;
 import java.io.File;
 import java.util.Collections;
+import java.util.Deque;
 import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
@@ -79,22 +80,32 @@ public class LiteLoaderMods
 	/**
 	 * Global list of mods which we can load
 	 */
-	protected final LinkedList<Mod> allMods = new LinkedList<Mod>();
+	protected final List<Mod> allMods = new LinkedList<Mod>();
 	/**
 	 * Global list of mods which are still waiting for initialisiation
 	 */
-	protected final LinkedList<Mod> initMods = new LinkedList<Mod>();
+	protected final Deque<Mod> initMods = new LinkedList<Mod>();
 	/**
 	 * Global list of mods which we have loaded
 	 */
-	protected final LinkedList<Mod> loadedMods = new LinkedList<Mod>();
+	protected final List<Mod> loadedMods = new LinkedList<Mod>();
+	
+	/**
+	 * Global list of mods which we found but ignored (eg. outdated, invalid)
+	 */
+	protected final List<Mod> badMods = new LinkedList<Mod>();
 	/**
 	 * Mods which are loaded but disabled
 	 */
-	protected final LinkedList<ModInfo<?>> disabledMods = new LinkedList<ModInfo<?>>();
+	protected final List<ModInfo<?>> disabledMods = new LinkedList<ModInfo<?>>();
+	
+	/**
+	 * Bad containers
+	 */
+	protected final List<ModInfo<?>> badContainers = new LinkedList<ModInfo<?>>();
 	private int startupErrorCount, criticalErrorCount;
@@ -112,6 +123,7 @@ public class LiteLoaderMods
 	{
 		this.observers.addAll(observers);
 		this.disabledMods.addAll(this.enumerator.getDisabledContainers());
+		this.badContainers.addAll(this.enumerator.getBadContainers());
 	}
 	void onPostInit()
@@ -156,6 +168,14 @@ public class LiteLoaderMods
 	{
 		return this.disabledMods;
 	}
+
+	/**
+	 * Get a list of all bad containers
+	 */
+	public List<? extends ModInfo<?>> getBadContainers()
+	{
+		return this.badContainers;
+	}
 	/**
 	 * Get the list of injected tweak containers
@@ -60,6 +60,14 @@ public abstract class ModInfo&lt;TContainer extends Loadable&lt;?&gt;&gt;
 	}
 	/**
+	 * Get whether this mod is valid
+	 */
+	public boolean isValid()
+	{
+		return true;
+	}
+	
+	/**
 	 * Get whether this mod can be toggled
 	 */
 	public boolean isToggleable()
@@ -117,6 +117,7 @@ public class EnumeratorModuleFolder implements FilenameFilter, EnumeratorModule
 		if (fileName.endsWith(".litemod.zip"))
 		{
 			LiteLoaderLogger.warning("Found %s with unsupported extension .litemod.zip. Please change file extension to .litemod to allow this file to be loaded!", fileName);
+			return true;
 		}
 		return fileName.endsWith(".litemod") || fileName.endsWith(".jar");
@@ -164,7 +165,7 @@ public class EnumeratorModuleFolder implements FilenameFilter, EnumeratorModule
 	 */
 	protected void inspectFile(ModularEnumerator enumerator, LoadableFile candidateFile)
 	{
-		if (this.isValidFile(candidateFile))
+		if (this.isValidFile(enumerator, candidateFile))
 		{
 			String metaData = candidateFile.getFileContents(LoadableMod.METADATA_FILENAME, Charsets.UTF_8);
 			if (metaData != null)
@@ -182,19 +183,30 @@ public class EnumeratorModuleFolder implements FilenameFilter, EnumeratorModule
 			else
 			{
 				LiteLoaderLogger.info("Ignoring %s", candidateFile);
+//				enumerator.registerBadContainer(candidateFile, "No metadata");
 			}
 		}
+//		else
+//		{
+//			enumerator.registerBadContainer(candidateFile, "Not a valid file");
+//		}
 	}
 	/**
 	 * Check whether the specified file is a valid mod container
 	 * 
+	 * @param enumerator
 	 * @param candidateFile
 	 */
-	protected boolean isValidFile(LoadableFile candidateFile)
+	protected boolean isValidFile(ModularEnumerator enumerator, LoadableFile candidateFile)
 	{
 		String filename = candidateFile.getName().toLowerCase();
-		if (filename.endsWith(".litemod"))
+		if (filename.endsWith(".litemod.zip"))
+		{
+			enumerator.registerBadContainer(candidateFile, "Invalid file extension .litemod.zip");
+			return false;
+		}
+		else if (filename.endsWith(".litemod"))
 		{
 			return true;
 		}
@@ -281,6 +293,7 @@ public class EnumeratorModuleFolder implements FilenameFilter, EnumeratorModule
 			else
 			{
 				LiteLoaderLogger.info("Not adding invalid or version-mismatched mod file: %s", modFile);
+				enumerator.registerBadContainer(modFile, "Version not supported");
 			}
 		}
 	}
@@ -173,7 +173,7 @@ public class LoadableModFile extends LoadableFile implements LoadableMod&lt;File&gt;
 		try
 		{
 			this.modName     = this.getMetaValue("name", this.getDefaultName());
-			this.displayName = this.getMetaValue("displayName", null);
+			this.displayName = this.getMetaValue("displayName", this.modName);
 			this.version     = this.getMetaValue("version", "Unknown");
 			this.author      = this.getMetaValue("author", "Unknown");
@@ -85,6 +85,11 @@ public interface LoaderEnumerator extends ModularEnumerator
 	public abstract Collection<? extends ModInfo<Loadable<?>>> getDisabledContainers();
 	/**
+	 * Get all bad containers
+	 */
+	public abstract Collection<? extends ModInfo<Loadable<?>>> getBadContainers();
+	
+	/**
 	 * @param modClass
 	 * @param metaDataKey
 	 * @param defaultValue
@@ -23,6 +23,12 @@ public interface ModularEnumerator
 	 * @param container
 	 */
 	public abstract boolean registerModContainer(LoadableMod<?> container);
+	
+	/**
+	 * @param container
+	 * @param reason
+	 */
+	public abstract void registerBadContainer(Loadable<?> container, String reason);
 	/**
 	 * @param container