runelite/runelite-client/src/main/java/net/runelite/client/rs/ClientLoader.java

/*
 * Copyright (c) 2016-2017, Adam <Adam@sigterm.info>
 * Copyright (c) 2018, Tomas Slusny <slusnucky@gmail.com>
 * Copyright (c) 2018 Abex
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package net.runelite.client.rs;

import com.google.common.io.ByteStreams;
import java.applet.Applet;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.net.URLClassLoader;
import javax.inject.Inject;
import javax.inject.Named;
import javax.inject.Singleton;
import lombok.extern.slf4j.Slf4j;
import net.runelite.client.RuneLite;
import net.runelite.client.ui.RuneLiteSplashScreen;

@Slf4j
@Singleton
public class ClientLoader
{
	private final ClientUpdateCheckMode updateCheckMode;

	@Inject
	private ClientLoader(
		@Named("updateCheckMode") final ClientUpdateCheckMode updateCheckMode)
	{
		this.updateCheckMode = updateCheckMode;
	}

	public Applet load()
	{
		try
		{
			RuneLiteSplashScreen.stage(.2, "Fetching applet viewer config");
			final RSConfig config = ClientConfigLoader.fetch();

			switch (updateCheckMode)
			{
				case AUTO:
				default:
					return loadRLPlus(config);
				case VANILLA:
					return loadVanilla(config);
				case NONE:
					return null;
				case RSPS:
					RuneLite.allowPrivateServer = true;
					return loadRLPlus(config);
			}
		}
		catch (IOException | InstantiationException | IllegalAccessException e)
		{
			log.error("Error loading RS!", e);
			return null;
		}
		catch (ClassNotFoundException e)
		{
			RuneLiteSplashScreen.setError("Unable to load client", "Class not found. This means you"
				+ " are not running openosrs with Gradle as the injected client"
				+ " is not in your classpath.");

			log.error("Error loading RS!", e);
			return null;
		}
	}

	private static Applet loadRLPlus(final RSConfig config)
	throws ClassNotFoundException, InstantiationException, IllegalAccessException
	{
		RuneLiteSplashScreen.stage(.465, "Starting Old School RuneScape");

		ClassLoader rsClassLoader = new ClassLoader(ClientLoader.class.getClassLoader())
		{
			@Override
			protected Class<?> findClass(String name) throws ClassNotFoundException
			{
				String path = name.replace('.', '/').concat(".class");
				InputStream inputStream = ClientLoader.class.getResourceAsStream(path);
				if (inputStream == null)
				{
					throw new ClassNotFoundException(name + " " + path);
				}
				byte[] data;
				try
				{
					data = ByteStreams.toByteArray(inputStream);
				}
				catch (IOException e)
				{
					e.printStackTrace();
					RuneLiteSplashScreen.setError("Failed to load!", "Failed to load class: " + name + " " + path);
					throw new RuntimeException("Failed to load class: " + name + " " + path);
				}
				return defineClass(name, data, 0, data.length);
			}
		};
		Class<?> clientClass = rsClassLoader.loadClass("client");
		return loadFromClass(config, clientClass);
	}

	private static Applet loadVanilla(final RSConfig config)
	throws IOException, ClassNotFoundException, InstantiationException, IllegalAccessException
	{
		RuneLiteSplashScreen.stage(.465, "Starting Old School RuneScape");

		final String codebase = config.getCodeBase();
		final String initialJar = config.getInitialJar();
		final String initialClass = config.getInitialClass();
		final URL url = new URL(codebase + initialJar);

		// Must set parent classloader to null, or it will pull from
		// this class's classloader first
		final URLClassLoader classloader = new URLClassLoader(new URL[]{url}, null);
		final Class<?> clientClass = classloader.loadClass(initialClass);
		return loadFromClass(config, clientClass);
	}

	private static Applet loadFromClass(final RSConfig config, final Class<?> clientClass)
	throws IllegalAccessException, InstantiationException
	{
		final Applet rs = (Applet) clientClass.newInstance();
		rs.setStub(new RSAppletStub(config));
		return rs;
	}
}