ClassPathUtilities.java 14.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
package com.mumfrey.liteloader.launch;

import java.io.File;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLClassLoader;
import java.security.AccessController;
import java.security.PrivilegedActionException;
import java.security.PrivilegedExceptionAction;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Stack;
import java.util.jar.JarFile;

import com.mumfrey.liteloader.launch.InjectionStrategy.InjectionPosition;
import com.mumfrey.liteloader.util.log.LiteLoaderLogger;

import net.minecraft.launchwrapper.Launch;
import net.minecraft.launchwrapper.LaunchClassLoader;
import sun.misc.URLClassPath;

/**
 * Nasty horrible reflection hacks to do nasty things with the classpath
 * 
 * @author Adam Mummery-Smith
 */
public abstract class ClassPathUtilities
{
    /**
     * URLClassLoader::ucp -> instance of URLClassPath
     */
    private static Field ucp;

    /**
     * URLClassPath::urls -> instance of Stack<URL> 
     */
    private static Field classPathURLs;

    /**
     * URLClassPath::path -> instance of ArrayList<URL> 
     */
    private static Field classPathPath;

    /**
     * URLClassPath::lmap -> instance of HashMap<String, URLClassPath.Loader> 
     */
    private static Field classPathLoaderMap;

    /**
     * URLClassPath::loaders -> instance of ArrayList<URLClassPath.Loader> 
     */
    private static Field classPathLoaderList;

    private static boolean canInject;

    private static boolean canTerminate;

    static
    {
        try
        {
            ClassPathUtilities.ucp = URLClassLoader.class.getDeclaredField("ucp");
            ClassPathUtilities.ucp.setAccessible(true);

            ClassPathUtilities.classPathURLs = URLClassPath.class.getDeclaredField("urls");
            ClassPathUtilities.classPathURLs.setAccessible(true);
            ClassPathUtilities.classPathPath = URLClassPath.class.getDeclaredField("path");
            ClassPathUtilities.classPathPath.setAccessible(true);
            ClassPathUtilities.classPathLoaderMap = URLClassPath.class.getDeclaredField("lmap");
            ClassPathUtilities.classPathLoaderMap.setAccessible(true);
            ClassPathUtilities.classPathLoaderList = URLClassPath.class.getDeclaredField("loaders");
            ClassPathUtilities.classPathLoaderList.setAccessible(true);
            ClassPathUtilities.canInject = true;
        }
        catch (Throwable th)
        {
            LiteLoaderLogger.severe(th, "ClassPathUtilities: Error initialising ClassPathUtilities, special class path injection disabled");
            th.printStackTrace();
        }
    }

    /**
     * Injects a URL into the classpath based on the specified injection strategy
     * 
     * @param classLoader
     * @param url
     */
    public static void injectIntoClassPath(URLClassLoader classLoader, URL url, InjectionStrategy strategy)
    {
        if (strategy == null || strategy.getPosition() == null)
        {
            ClassPathUtilities.addURL(classLoader, url);
            return;
        }

        if (strategy.getPosition() == InjectionPosition.Top)
        {
            ClassPathUtilities.injectIntoClassPath(classLoader, url);
        }
        else if (strategy.getPosition() == InjectionPosition.Base)
        {
            ClassPathUtilities.injectIntoClassPath(classLoader, url, LiteLoaderTweaker.getJarUrl());
        }
        else if (strategy.getPosition() == InjectionPosition.Above)
        {
            String[] params = strategy.getParams();
            if (params.length > 0)
            {
                ClassPathUtilities.injectIntoClassPath(classLoader, url, params[0]);
            }
        }
        else
        {
            ClassPathUtilities.addURL(classLoader, url);
        }
    }

    /**
     * Injects a URL into the classpath at the TOP of the stack
     * 
     * @param classLoader
     * @param url
     */
    public static void injectIntoClassPath(URLClassLoader classLoader, URL url)
    {
        ClassPathUtilities.injectIntoClassPath(classLoader, url, (URL)null);
    }

    /**
     * Injects a URL into the classpath at the TOP of the stack
     * 
     * @param classLoader
     * @param url
     * @param above
     */
    @SuppressWarnings({ "unchecked" })
    public static void injectIntoClassPath(URLClassLoader classLoader, URL url, URL above)
    {
        if (ClassPathUtilities.canInject)
        {
            LiteLoaderLogger.info("ClassPathUtilities: attempting to inject %s into %s", url, classLoader.getClass().getSimpleName());

            try
            {
                URLClassPath classPath = (URLClassPath)ClassPathUtilities.ucp.get(classLoader);

                Stack<URL> urls = (Stack<URL>)ClassPathUtilities.classPathURLs.get(classPath);
                ArrayList<URL> path = (ArrayList<URL>)ClassPathUtilities.classPathPath.get(classPath);

                synchronized (urls)
                {
                    if (!path.contains(url))
                    {
                        urls.add(url);

                        if (above == null)
                        {
                            path.add(0, url);
                        }
                        else
                        {
                            for (int pos = path.size() - 1; pos > 0; pos--)
                            {
                                if (above.equals(path.get(pos)))
                                    path.add(pos, url);
                            }
                        }
                    }
                }
            }
            catch (Exception ex)
            {
                LiteLoaderLogger.warning("ClassPathUtilities: failed to inject %s", url);
            }
        }

        ClassPathUtilities.addURL(classLoader, url);
    }

    /**
     * @param classLoader
     * @param url
     * @param above
     */
    public static void injectIntoClassPath(URLClassLoader classLoader, URL url, String above)
    {
        above = above.trim().toLowerCase();
        if (above.length() < 1) return;

        for (URL classPathUrl : classLoader.getURLs())
        {
            if (classPathUrl.toString().toLowerCase().contains(above))
            {
                ClassPathUtilities.injectIntoClassPath(classLoader, url, classPathUrl);
                return;
            }
        }
    }

    /**
     * @param classLoader
     * @param url
     */
    public static void addURL(URLClassLoader classLoader, URL url)
    {
        if (classLoader instanceof LaunchClassLoader)
        {
            ((LaunchClassLoader)classLoader).addURL(url);
        }
        else
        {
            try
            {
                Method mAddUrl = URLClassLoader.class.getDeclaredMethod("addURL", URL.class);
                mAddUrl.setAccessible(true);
                mAddUrl.invoke(classLoader, url);
            }
            catch (Exception ex) {}
        }
    }

    /**
     * Is the specified jar on the game launch classpath
     * 
     * @param jarFile
     */
    public static boolean isJarOnClassPath(File jarFile)
    {
        URLClassLoader classLoader = (URLClassLoader)Launch.class.getClassLoader();
        return ClassPathUtilities.isJarOnClassPath(jarFile, classLoader);
    }

    /**
     * @param jarFile
     * @param classLoader
     */
    public static boolean isJarOnClassPath(File jarFile, URLClassLoader classLoader)
    {
        try
        {
            String jarURL = jarFile.toURI().toURL().toString();

            URL[] classPath = classLoader.getURLs();
            for (URL classPathEntry : classPath)
            {
                if (classPathEntry.toString().equals(jarURL))
                    return true;
            }
        }
        catch (Exception ex)
        {
            ex.printStackTrace();
        }

        return false;
    }

    /**
     * Gets the file containing the specified resource
     * 
     * @param contextClass
     * @param resource
     */
    public static File getPathToResource(Class<?> contextClass, String resource)
    {
        URL res = contextClass.getResource(resource);
        if (res == null) return null;

        boolean returnParent = true;
        String jarPath = res.toString();
        if (jarPath.startsWith("jar:") && jarPath.indexOf('!') > -1)
        {
            jarPath = jarPath.substring(4, jarPath.indexOf('!'));
            returnParent = false;
        }

        if (jarPath.startsWith("file:"))
        {
            try
            {
                File targetFile = new File(new URI(jarPath));
                return returnParent ? targetFile.getParentFile() : targetFile;
            }
            catch (URISyntaxException ex)
            {
                // derp
            }
        }

        return null;
    }

    /**
     * @param contextClass
     * @param resource
     */
    public static boolean deleteClassPathJarContaining(Class<?> contextClass, String resource)
    {
        File jarFile = ClassPathUtilities.getPathToResource(contextClass, resource);
        if (jarFile != null && jarFile.exists() && jarFile.isFile() && jarFile.getName().endsWith(".jar"))
        {
            return ClassPathUtilities.deleteClassPathJar(jarFile.getName());
        }

        return false;
    }

    /**
     * @param jarFileName
     */
    public static boolean deleteClassPathJar(String jarFileName)
    {
        try
        {
            // First try to find the jar reference in the class loaders
            JarFile jar = ClassPathUtilities.getJarFromClassLoader(Launch.classLoader, jarFileName, false);
            JarFile parentJar = ClassPathUtilities.getJarFromClassLoader((URLClassLoader)Launch.class.getClassLoader(), jarFileName, false);

            if (jar != null && parentJar != null && jar.getName().equals(parentJar.getName()))
            {
                final JarDeletionHandler jarDeletionHandler = new JarDeletionHandler();

                JarFile jarInClassLoader = ClassPathUtilities.getJarFromClassLoader(Launch.classLoader, jarFileName, true);
                JarFile jarInParentClassLoader = ClassPathUtilities.getJarFromClassLoader((URLClassLoader)Launch.class.getClassLoader(), jarFileName, true);

                File jarFileInClassLoader = new File(jarInClassLoader.getName());
                File jarFileInParentClassLoader = new File(jarInParentClassLoader.getName());

                jarDeletionHandler.setPaths(jarInClassLoader, jarInParentClassLoader, jarFileInClassLoader, jarFileInParentClassLoader);

                try
                {
                    Boolean deleted = AccessController.doPrivileged(jarDeletionHandler);
                    ClassPathUtilities.canTerminate |= deleted;
                    return deleted;
                }
                catch (PrivilegedActionException ex)
                {
                    ex.printStackTrace();
                }
            }
        }
        catch (Exception ex)
        {
            ex.printStackTrace();
        }

        return false;
    }

    public static void terminateRuntime(int status)
    {
        if (ClassPathUtilities.canTerminate)
        {
            System.exit(status);
        }
        else
        {
            throw new IllegalStateException();
        }
    }

    /**
     * @param classLoader
     * @param fileName
     * @param removeFromClassPath
     * @throws MalformedURLException
     */
    @SuppressWarnings("unchecked")
    private static JarFile getJarFromClassLoader(URLClassLoader classLoader, String fileName, boolean removeFromClassPath) throws MalformedURLException
    {
        JarFile jar = null;

        try
        {
            URLClassPath classPath = (URLClassPath)ClassPathUtilities.ucp.get(classLoader);
            Map<String, ?> loaderMap = (Map<String, ?>)ClassPathUtilities.classPathLoaderMap.get(classPath);

            Iterator<?> iter = loaderMap.entrySet().iterator();
            while (iter.hasNext())
            {
                Entry<String, ?> loaderEntry = (Entry<String, ?>)iter.next();

                String url = loaderEntry.getKey();

                if (url.endsWith(fileName))
                {
                    Object loader = loaderEntry.getValue();
                    Field jarField = loader.getClass().getDeclaredField("jar");
                    jarField.setAccessible(true);

                    jar = (JarFile)jarField.get(loader);

                    if (removeFromClassPath)
                    {
                        jarField.set(loader, null);

                        Stack<URL> urls = (Stack<URL>)ClassPathUtilities.classPathURLs.get(classPath);
                        ArrayList<URL> path = (ArrayList<URL>)ClassPathUtilities.classPathPath.get(classPath);
                        ArrayList<?> loaders = (ArrayList<?>)ClassPathUtilities.classPathLoaderList.get(classPath);

                        loaders.remove(loader);
                        iter.remove();

                        URL jarURL = new URL(url);
                        urls.remove(jarURL);
                        path.remove(jarURL);
                    }
                }
            }
        }
        catch (IllegalArgumentException ex) {}
        catch (SecurityException ex) {}
        catch (IllegalAccessException ex) {}
        catch (NoSuchFieldException ex)
        {
            ex.printStackTrace();
        }

        return jar;
    }
}

class JarDeletionHandler implements PrivilegedExceptionAction<Boolean>
{
    JarFile jarInClassLoader, jarInParentClassLoader;
    File jarFileInClassLoader, jarFileInParentClassLoader;

    void setPaths(JarFile jarInClassLoader, JarFile jarInParentClassLoader, File jarFileInClassLoader, File jarFileInParentClassLoader)
    {
        this.jarInClassLoader = jarInClassLoader;
        this.jarInParentClassLoader = jarInParentClassLoader;
        this.jarFileInClassLoader = jarFileInClassLoader;
        this.jarFileInParentClassLoader = jarFileInParentClassLoader;
    }

    @Override
    public Boolean run() throws Exception
    {
        this.jarInClassLoader.close();
        this.jarInParentClassLoader.close();

        try
        {
            Thread.sleep(5000);
        }
        catch (Exception ex)
        {
            ex.printStackTrace();
        }

        boolean deletedJarFile = this.jarFileInClassLoader.delete();
        boolean deletedParentJarFile = this.jarFileInParentClassLoader.delete();

        System.err.println("deletedJarFile=" + deletedJarFile + "   deletedParentJarFile=" + deletedParentJarFile);

        return Boolean.valueOf(deletedJarFile || deletedParentJarFile);
    }
}