LiteLoaderTweaker.java 15.5 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
package com.mumfrey.liteloader.launch;

import java.io.File;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;

import net.minecraft.launchwrapper.ITweaker;
import net.minecraft.launchwrapper.Launch;
import net.minecraft.launchwrapper.LaunchClassLoader;

import com.mumfrey.liteloader.util.SortableValue;
import com.mumfrey.liteloader.util.log.LiteLoaderLogger;

/**
 * LiteLoader tweak class
 * 
 * @author Adam Mummery-Smith
 */
public class LiteLoaderTweaker implements ITweaker
{
	public static final int ENV_TYPE_CLIENT = 0;
	public static final int ENV_TYPE_DEDICATEDSERVER = 1;
	
	// TODO Version - 1.7.10
	public static final String VERSION = "1.7.10";

	protected static final String bootstrapClassName = "com.mumfrey.liteloader.core.LiteLoaderBootstrap";

	/**
	 * Loader startup state
	 * 
	 * @author Adam Mummery-Smith
	 */
	enum StartupState
	{
		PREPARE,
		PREINIT,
		BEGINGAME,
		INIT,
		POSTINIT,
		DONE;
		
		/**
		 * Current state
		 */
		private static StartupState currentState = StartupState.PREPARE.gotoState();

		/**
		 * Whether this state is active
		 */
		private boolean inState;
		
		/**
		 * Whether this state is completed (can go to next state)
		 */
		private boolean completed;
		
		/**
		 * @return
		 */
		public boolean isCompleted()
		{
			return this.completed;
		}
		
		/**
		 * @return
		 */
		public boolean isInState()
		{
			return this.inState;
		}
		
		/**
		 * Go to the next state, checks whether can move to the next state (previous state is marked completed) first
		 */
		public StartupState gotoState()
		{
			for (StartupState otherState : StartupState.values())
			{
				if (otherState.isInState() && otherState != this)
				{
					if (otherState.canGotoState(this))
						otherState.leaveState();
					else
						throw new IllegalStateException(String.format("Cannot go to state <%s> as %s %s", this.name(), otherState, otherState.getNextState() == this ? "" : "and expects \""  + otherState.getNextState().name() + "\" instead"), LiteLoaderLogger.getLastThrowable());
				}
			}
			
			LiteLoaderLogger.clearLastThrowable();
			StartupState.currentState = this;
			
			this.inState = true;
			this.completed = false;
			
			return this;
		}
		
		/* (non-Javadoc)
		 * @see java.lang.Enum#toString()
		 */
		@Override
		public String toString()
		{
			return String.format("<%s> is %s %s", this.name(), this.inState ? "[ACTIVE]" : "[INACTIVE]", this.completed ? "and [COMPLETED]" : "but [INCOMPLETE]");
		}
		
		/**
		 * 
		 */
		public void leaveState()
		{
			this.inState = false;
		}
		
		/**
		 * 
		 */
		public void completed()
		{
			if (!this.inState || this.completed)
				throw new IllegalStateException("Attempted to complete state " + this.name() + " but the state is already completed or is not active", LiteLoaderLogger.getLastThrowable());
			
			this.completed = true;
		}
		
		/**
		 * @return
		 */
		private StartupState getNextState()
		{
			return this.ordinal() < StartupState.values().length - 1 ? StartupState.values()[this.ordinal() + 1] : StartupState.DONE;
		}
		
		/**
		 * @param next
		 * @return
		 */
		public boolean canGotoState(StartupState next)
		{
			if (this.inState && next == this.getNextState())
			{
				return this.completed;
			}
			
			return !this.inState;
		}
		
		/**
		 * @return
		 */
		public static StartupState getCurrent()
		{
			return StartupState.currentState;
		}
	}
	
	/**
	 * Singleton instance, mainly for delegating from injected callbacks which need a static method to call
	 */
	protected static LiteLoaderTweaker instance;
	
	/**
	 * Approximate location of the minecraft jar, used for "base" injection position in ClassPathUtilities
	 */
	protected static URL jarUrl;
	
	/**
	 * "Order" value for inserted tweakers, used as disambiguating sort criteria for injected tweakers which have the same priority 
	 */
	protected int tweakOrder = 0;
	
	/**
	 * All tweakers, used to avoid injecting duplicates
	 */
	protected Set<String> allCascadingTweaks = new HashSet<String>();
	
	/**
	 * Sorted list of tweakers, used to sort tweakers before injecting
	 */
	protected Set<SortableValue<String>> sortedCascadingTweaks = new TreeSet<SortableValue<String>>();

	/**
	 * True if this is the primary tweak, not known until at least PREJOINGAME
	 */
	protected boolean isPrimary;
	
	/**
	 * Startup environment information, used to store info about the current startup in one place, also handles parsing command line arguments
	 */
	protected StartupEnvironment env;
	
	/**
	 * Loader bootstrap object
	 */
	protected LoaderBootstrap bootstrap;
	
	/**
	 * Transformer manager
	 */
	protected ClassTransformerManager transformerManager;
	
	/* (non-Javadoc)
	 * @see net.minecraft.launchwrapper.ITweaker#acceptOptions(java.util.List, java.io.File, java.io.File, java.lang.String)
	 */
	@Override
	public void acceptOptions(List<String> args, File gameDirectory, File assetsDirectory, String profile)
	{
		Launch.classLoader.addClassLoaderExclusion("com.google.common.");
		LiteLoaderTweaker.instance = this;
		
		this.onPrepare(args, gameDirectory, assetsDirectory, profile);
		
		this.onPreInit();
	}

	/* (non-Javadoc)
	 * @see net.minecraft.launchwrapper.ITweaker#injectIntoClassLoader(net.minecraft.launchwrapper.LaunchClassLoader)
	 */
	@Override
	public void injectIntoClassLoader(LaunchClassLoader classLoader)
	{
		classLoader.addClassLoaderExclusion("com.mumfrey.liteloader.core.runtime.Obf");
		classLoader.addClassLoaderExclusion("com.mumfrey.liteloader.core.runtime.Packets");

		this.transformerManager.injectUpstreamTransformers(classLoader);

		for (String transformerClassName : this.bootstrap.getRequiredDownstreamTransformers())
		{
			LiteLoaderLogger.info("Queuing required class transformer '%s'", transformerClassName);
			this.transformerManager.injectTransformer(transformerClassName);
		}
	}
	
	/* (non-Javadoc)
	 * @see net.minecraft.launchwrapper.ITweaker#getLaunchTarget()
	 */
	@Override
	public String getLaunchTarget()
	{
		this.isPrimary = true;
		this.onPreBeginGame();
		
		return "net.minecraft.client.main.Main";
	}

	/* (non-Javadoc)
	 * @see net.minecraft.launchwrapper.ITweaker#getLaunchArguments()
	 */
	@Override
	public String[] getLaunchArguments()
	{
		return this.env.getLaunchArguments();
	}

	/**
	 * Return true if this is the primary tweaker
	 */
	public boolean isPrimary()
	{
		return this.isPrimary;
	}
	
	/**
	 * Get the class transformer manager
	 */
	public ClassTransformerManager getTransformerManager()
	{
		return this.transformerManager;
	}

	/**
	 * @param gameDirectory
	 * @param assetsDirectory
	 * @param profile
	 * @param apisToLoad
	 */
	private void onPrepare(List<String> args, File gameDirectory, File assetsDirectory, String profile)
	{
		LiteLoaderLogger.info("Bootstrapping LiteLoader " + LiteLoaderTweaker.VERSION);
		
		try
		{
			this.initEnvironment(args, gameDirectory, assetsDirectory, profile);

			this.bootstrap = this.spawnBootstrap(LiteLoaderTweaker.bootstrapClassName, Launch.classLoader);
			
			this.transformerManager = new ClassTransformerManager(this.bootstrap.getRequiredTransformers());
			this.transformerManager.injectTransformers(this.bootstrap.getPacketTransformers());
			
			StartupState.PREPARE.completed();
		}
		catch (Throwable th)
		{
			LiteLoaderLogger.severe(th, "Error during LiteLoader PREPARE: %s %s", th.getClass().getName(), th.getMessage());
		}
	}

	/**
	 * Do the first stage of loader startup, which enumerates mod sources and finds tweakers
	 */
	private void onPreInit()
	{
		StartupState.PREINIT.gotoState();

		try
		{
			this.bootstrap.preInit(Launch.classLoader, true, this.env.getModFilterList());
			
			this.injectDiscoveredTweakClasses();
			StartupState.PREINIT.completed();
		}
		catch (Throwable th)
		{
			LiteLoaderLogger.severe(th, "Error during LiteLoader PREINIT: %s %s", th.getClass().getName(), th.getMessage());
		}
	}
	
	/**
	 * 
	 */
	private void onPreBeginGame()
	{
		StartupState.BEGINGAME.gotoState();
		try
		{
			this.transformerManager.injectDownstreamTransformers(Launch.classLoader);
			this.bootstrap.preBeginGame();
			StartupState.BEGINGAME.completed();
		}
		catch (Throwable th)
		{
			LiteLoaderLogger.severe(th, "Error during LiteLoader BEGINGAME: %s %s", th.getClass().getName(), th.getMessage());
		}
	}

	/**
	 * Do the second stage of loader startup
	 */
	private void onInit()
	{
		StartupState.INIT.gotoState();
		
		try
		{
			this.bootstrap.init();
			StartupState.INIT.completed();
		}
		catch (Throwable th)
		{
			LiteLoaderLogger.severe(th, "Error during LiteLoader INIT: %s %s", th.getClass().getName(), th.getMessage());
		}
	}
	
	/**
	 * Do the second stage of loader startup
	 */
	private void onPostInit()
	{
		StartupState.POSTINIT.gotoState();

		try
		{
			this.bootstrap.postInit();
			StartupState.POSTINIT.completed();

			StartupState.DONE.gotoState();
		}
		catch (Throwable th)
		{
			LiteLoaderLogger.severe(th, "Error during LiteLoader POSTINIT: %s %s", th.getClass().getName(), th.getMessage());
		}
	}

	/**
	 * Set up the startup environment
	 * 
	 * @param args
	 * @param gameDirectory
	 * @param assetsDirectory
	 * @param profile
	 */
	private void initEnvironment(List<String> args, File gameDirectory, File assetsDirectory, String profile)
	{
		this.env = this.spawnStartupEnvironment(args, gameDirectory, assetsDirectory, profile);

		URL[] urls = Launch.classLoader.getURLs();
		LiteLoaderTweaker.jarUrl = urls[urls.length - 1]; // probably?
	}

	/**
	 * Injects discovered tweak classes
	 */
	private void injectDiscoveredTweakClasses()
	{
		if (this.sortedCascadingTweaks.size() > 0)
		{
			if (StartupState.getCurrent() != StartupState.PREINIT || !StartupState.PREINIT.isInState())
			{
				LiteLoaderLogger.warning("Failed to inject cascaded tweak classes because preInit is already complete");
				return;
			}
			
			LiteLoaderLogger.info("Injecting cascaded tweakers...");

			@SuppressWarnings("unchecked")
			List<String> tweakClasses = (List<String>)Launch.blackboard.get("TweakClasses");
			@SuppressWarnings("unchecked")
			List<ITweaker> tweakers = (List<ITweaker>)Launch.blackboard.get("Tweaks");
			if (tweakClasses != null && tweakers != null)
			{
				for (SortableValue<String> tweak : this.sortedCascadingTweaks)
				{
					String tweakClass = tweak.getValue();
					LiteLoaderLogger.info("Injecting tweak class %s with priority %d", tweakClass, tweak.getPriority());
					this.injectTweakClass(tweakClass, tweakClasses, tweakers);
				}
			}
			
			// Clear sortedTweaks but not allTweaks
			this.sortedCascadingTweaks.clear();
		}
	}

	/**
	 * @param tweakClass
	 * @param tweakClasses
	 * @param tweakers
	 */
	private void injectTweakClass(String tweakClass, List<String> tweakClasses, List<ITweaker> tweakers)
	{
		if (!tweakClasses.contains(tweakClass))
		{
			for (ITweaker existingTweaker : tweakers)
			{
				if (tweakClass.equals(existingTweaker.getClass().getName()))
					return;
			}
			
			tweakClasses.add(tweakClass);
		}
	}
	
	/**
	 * @param tweakClass
	 * @param priority
	 * @return
	 */
	public boolean addCascadedTweaker(String tweakClass, int priority)
	{
		if (tweakClass != null && !this.allCascadingTweaks.contains(tweakClass))
		{
			if (this.getClass().getName().equals(tweakClass))
				return false;
			
			if (LiteLoaderTweaker.isTweakAlreadyEnqueued(tweakClass))
				return false;
			
			this.allCascadingTweaks.add(tweakClass);
			this.sortedCascadingTweaks.add(new SortableValue<String>(priority, this.tweakOrder++, tweakClass));
			return true;
		}
		
		return false;
	}

	/**
	 * The bootstrap object has to be spawned using reflection for obvious reasons, 
	 * 
	 * @param bootstrapClassName
	 * @param classLoader
	 * @return
	 */
	protected LoaderBootstrap spawnBootstrap(String bootstrapClassName, ClassLoader classLoader)
	{
		if (!StartupState.PREPARE.isInState())
		{
			throw new IllegalStateException("spawnBootstrap is not valid outside PREPARE");
		}
		
		try
		{
			@SuppressWarnings("unchecked")
			Class<? extends LoaderBootstrap> bootstrapClass = (Class<? extends LoaderBootstrap>)Class.forName(bootstrapClassName, false, classLoader);
			Constructor<? extends LoaderBootstrap> bootstrapCtor = bootstrapClass.getDeclaredConstructor(StartupEnvironment.class, ITweaker.class);
			bootstrapCtor.setAccessible(true);
			
			return bootstrapCtor.newInstance(this.env, this);
		}
		catch (Throwable th)
		{
			throw new RuntimeException(th);
		}
	}

	/**
	 * @param args
	 * @param gameDirectory
	 * @param assetsDirectory
	 * @param profile
	 * @return
	 */
	protected StartupEnvironment spawnStartupEnvironment(List<String> args, File gameDirectory, File assetsDirectory, String profile)
	{
		return new StartupEnvironment(args, gameDirectory, assetsDirectory, profile)
		{
			@Override
			public void registerCoreAPIs(List<String> apisToLoad)
			{
				apisToLoad.add(0, "com.mumfrey.liteloader.client.api.LiteLoaderCoreAPIClient");
			}

			@Override
			public int getEnvironmentTypeId()
			{
				return LiteLoaderTweaker.ENV_TYPE_CLIENT;
			}
		};
	}

	/**
	 * @return
	 */
	public static URL getJarUrl()
	{
		return LiteLoaderTweaker.jarUrl;
	}

	/**
	 * @param url URL to add
	 */
	public static boolean addURLToParentClassLoader(URL url)
	{
		if (StartupState.getCurrent() == StartupState.PREINIT && StartupState.PREINIT.isInState())
		{
			try
			{
				URLClassLoader classLoader = (URLClassLoader)Launch.class.getClassLoader();
				Method mAddUrl = URLClassLoader.class.getDeclaredMethod("addURL", URL.class);
				mAddUrl.setAccessible(true);
				mAddUrl.invoke(classLoader, url);
				
				return true;
			}
			catch (Exception ex)
			{
				LiteLoaderLogger.warning(ex, "addURLToParentClassLoader failed: %s", ex.getMessage());
			}
		}
			
		return false;
	}

	/**
	 * @param clazz
	 * @return
	 */
	@SuppressWarnings("unchecked")
	private static boolean isTweakAlreadyEnqueued(String clazz)
	{
		List<String> tweakClasses = (List<String>)Launch.blackboard.get("TweakClasses");
		List<ITweaker> tweakers = (List<ITweaker>)Launch.blackboard.get("Tweaks");
		
		if (tweakClasses != null)
		{
			for (String tweakClass : tweakClasses)
			{
				if (tweakClass.equals(clazz)) return true;
			}
		}		
		
		if (tweakers != null)
		{
			for (ITweaker tweaker : tweakers)
			{
				if (tweaker.getClass().getName().equals(clazz)) return true;
			}
		}
		
		return false;
	}

	/**
	 * @return
	 */
	public static boolean loadingBarEnabled()
	{
		LoaderProperties properties = LiteLoaderTweaker.instance.bootstrap.getProperties();
		return properties != null && properties.getBooleanProperty("loadingbar"); 
	}

	/**
	 * Callback from the "Main" class, do the PREBEGINGAME steps (inject "downstream" transformers)
	 */
	public static void preBeginGame()
	{
		LiteLoaderTweaker.instance.onPreBeginGame();
	}

	/**
	 * Callback from Minecraft::startGame() do early mod initialisation
	 */
	public static void init()
	{
		LiteLoaderTweaker.instance.onInit();
	}

	/**
	 * Callback from Minecraft::startGame() do late mod initialisation
	 */
	public static void postInit()
	{
		LiteLoaderTweaker.instance.onPostInit();
	}
}