From fccaed8dc216241b5c84ef38f3b45b25cde995a1 Mon Sep 17 00:00:00 2001 From: HypherionMC Date: Sun, 5 Nov 2023 18:08:31 +0200 Subject: [PATCH] Initial Commit --- .gitignore | 168 ++++++++ LICENSE.txt | 201 +++++++++ README.md | 18 + build.gradle | 65 +++ gradle/wrapper/gradle-wrapper.properties | 6 + gradlew | 234 +++++++++++ gradlew.bat | 89 ++++ settings.gradle | 2 + .../jarrelocator/DirectoryRelocatorTask.java | 192 +++++++++ .../jarrelocator/JarRelocator.java | 103 +++++ .../jarrelocator/JarRelocatorTask.java | 194 +++++++++ .../jarrelocator/RelocatingClassVisitor.java | 48 +++ .../jarrelocator/RelocatingRemapper.java | 89 ++++ .../hypherionmc/jarrelocator/Relocation.java | 137 +++++++ .../jarrelocator/SelectorUtils.java | 381 ++++++++++++++++++ 15 files changed, 1927 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 build.gradle create mode 100644 gradle/wrapper/gradle-wrapper.properties create mode 100644 gradlew create mode 100644 gradlew.bat create mode 100644 settings.gradle create mode 100644 src/main/java/com/hypherionmc/jarrelocator/DirectoryRelocatorTask.java create mode 100644 src/main/java/com/hypherionmc/jarrelocator/JarRelocator.java create mode 100644 src/main/java/com/hypherionmc/jarrelocator/JarRelocatorTask.java create mode 100644 src/main/java/com/hypherionmc/jarrelocator/RelocatingClassVisitor.java create mode 100644 src/main/java/com/hypherionmc/jarrelocator/RelocatingRemapper.java create mode 100644 src/main/java/com/hypherionmc/jarrelocator/Relocation.java create mode 100644 src/main/java/com/hypherionmc/jarrelocator/SelectorUtils.java diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9f6c60f --- /dev/null +++ b/.gitignore @@ -0,0 +1,168 @@ +# Created by https://www.gitignore.io/ + +### Intellij ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff: +.idea/ +*.iws +/out/ +*.iml +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + + +### Maven ### +target/ +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +pom.xml.next +release.properties +dependency-reduced-pom.xml +buildNumber.properties +.mvn/timing.properties + + +### Eclipse ### + +.metadata +bin/ +tmp/ +*.tmp +*.bak +*.swp +*~.nib +local.properties +.settings/ +.loadpath +.recommenders + +# Eclipse Core +.project + +# External tool builders +.externalToolBuilders/ + +# Locally stored "Eclipse launch configurations" +*.launch + +# PyDev specific (Python IDE for Eclipse) +*.pydevproject + +# CDT-specific (C/C++ Development Tooling) +.cproject + +# JDT-specific (Eclipse Java Development Tools) +.classpath + +# Java annotation processor (APT) +.factorypath + +# PDT-specific (PHP Development Tools) +.buildpath + +# sbteclipse plugin +.target + +# Tern plugin +.tern-project + +# TeXlipse plugin +.texlipse + +# STS (Spring Tool Suite) +.springBeans + +# Code Recommenders +.recommenders/ + + +### Linux ### +*~ + +# temporary files which can be created if a process still has a handle open of a deleted file +.fuse_hidden* + +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + +# .nfs files are created when an open file is removed but is still being accessed +.nfs* + + +### macOS ### +*.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon +# Thumbnails +._* +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + + +### Windows ### +# Windows image file caches +Thumbs.db +ehthumbs.db + +# Folder config file +Desktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msm +*.msp + +# Windows shortcuts +*.lnk + + +### Java ### +*.class + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +*.jar +*.war +*.ear + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* + +.gradle +.idea +build/ \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..da697c0 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# jar-relocator + +This is a fork of [jar-relocator by lucko](https://github.com/lucko/jar-relocator/) with some changes required for our own use. + +#### Full list of changes + +* Packages renamed from `me.lucko` to `com.hypherionmc`. +* Added a DirectoryRelocator task that allows remapping files inside a directory, instead of a jar +* Added a runDirectory() method to JarRelocator. +* Converted from MAVEN to Gradle +* Not published to maven central +* Not signed + +This fork will probably not be of much use to anyone else, but it's kept here for source control, and to disclose the source of the library + +### License + +This library is licensed under Apache License Version 2.0, just like the original. \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..591b951 --- /dev/null +++ b/build.gradle @@ -0,0 +1,65 @@ +plugins { + id 'java' + id 'maven-publish' + id 'com.github.johnrengelman.shadow' version '7.0.0' +} + +group 'com.hypherionmc' +version '1.0.0' + +repositories { + mavenCentral() +} + +configurations { + shadeMe + implementation.extendsFrom shadeMe +} + +dependencies { + shadeMe 'org.ow2.asm:asm:9.2' + shadeMe 'org.ow2.asm:asm-commons:9.2' +} + +tasks.withType(JavaCompile) { + options.encoding = 'UTF-8' + sourceCompatibility = JavaVersion.VERSION_1_8 + targetCompatibility = JavaVersion.VERSION_1_8 +} + +tasks.register('sourcesJar', Jar) { + archiveClassifier.set('sources') + from sourceSets.main.allJava +} + +tasks.register('javadocJar', Jar) { + archiveClassifier.set('javadoc') + dependsOn 'javadoc' + from javadoc.destinationDir +} + +shadowJar { + duplicatesStrategy = DuplicatesStrategy.EXCLUDE + configurations = [project.configurations.getByName("shadeMe")] + archiveClassifier.set(null) +} + +publishing { + publications { + mavenJava(MavenPublication) { + artifact shadowJar + artifact sourcesJar + artifact javadocJar + } + } + + repositories { + maven { + url System.getenv('MAVEN_URL') + credentials { + username System.getenv('MAVEN_USER') + password System.getenv('MAVEN_PASS') + } + } + } +} \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..a4fad02 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Sun Oct 29 20:46:13 SAST 2023 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..1b6c787 --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..701e6bd --- /dev/null +++ b/settings.gradle @@ -0,0 +1,2 @@ +rootProject.name = 'jar-relocator' + diff --git a/src/main/java/com/hypherionmc/jarrelocator/DirectoryRelocatorTask.java b/src/main/java/com/hypherionmc/jarrelocator/DirectoryRelocatorTask.java new file mode 100644 index 0000000..fc7c189 --- /dev/null +++ b/src/main/java/com/hypherionmc/jarrelocator/DirectoryRelocatorTask.java @@ -0,0 +1,192 @@ +package com.hypherionmc.jarrelocator; + +import org.objectweb.asm.ClassReader; +import org.objectweb.asm.ClassWriter; + +import java.io.*; +import java.nio.file.Files; +import java.nio.file.StandardCopyOption; +import java.util.*; +import java.util.jar.Attributes; +import java.util.jar.Manifest; +import java.util.regex.Pattern; + +/** + * @author HypherionSA + * Same as {@link JarRelocatorTask}, but works on a directory instead of a jar + */ +final class DirectoryRelocatorTask { + + /** + * META-INF/*.SF + * META-INF/*.DSA + * META-INF/*.RSA + * META-INF/SIG-* + * + * Specification + */ + private static final Pattern SIGNATURE_FILE_PATTERN = Pattern.compile("META-INF/(?:[^/]+\\.(?:DSA|RSA|SF)|SIG-[^/]+)"); + + /** + * Specification + */ + private static final Pattern SIGNATURE_PROPERTY_PATTERN = Pattern.compile(".*-Digest"); + + private final RelocatingRemapper remapper; + private final Set resources = new HashSet<>(); + private final File inputDirectory; + + DirectoryRelocatorTask(RelocatingRemapper remapper, File inputDirectory) { + this.remapper = remapper; + this.inputDirectory = inputDirectory; + } + + void processEntries() throws IOException { + for (File entry : listAllFiles(inputDirectory)) { + String name = entry.getName(); + if (name.equals("META-INF/INDEX.LIST") || entry.isDirectory()) { + continue; + } + + // Signatures will become invalid after remapping, so we delete them to avoid making the output useless + if (SIGNATURE_FILE_PATTERN.matcher(name).matches()) { + continue; + } + + try (InputStream entryIn = Files.newInputStream(entry.toPath())) { + processEntry(entry, entryIn); + } + } + } + + List listAllFiles(File file) { + List returnList = new ArrayList<>(); + + File[] files = file.listFiles(); + if (files == null) + return new ArrayList<>(); + + for (File f : files) { + if (f.isDirectory()) { + returnList.addAll(listAllFiles(f)); + continue; + } + + returnList.add(f); + } + + return returnList; + } + + private void processEntry(File entry, InputStream inputStream) throws IOException { + String name = entry.getAbsolutePath(); + String mappedName = this.remapper.map(name); + + // ensure the parent directory structure exists for the entry. + processDirectory(mappedName, true); + + if (name.endsWith(".class")) { + processClass(name, inputStream); + } else if (name.equals("META-INF/MANIFEST.MF")) { + processManifest(name, inputStream); + } else if (!this.resources.contains(mappedName)) { + processResource(mappedName, inputStream); + } + } + + private void processDirectory(String name, boolean parentsOnly) throws IOException { + int index = name.lastIndexOf('/'); + if (index != -1) { + String parentDirectory = name.substring(0, index); + if (!this.resources.contains(parentDirectory)) { + processDirectory(parentDirectory, false); + } + } + + if (parentsOnly) { + return; + } + + // directory entries must end in "/" + File dir = new File(inputDirectory, name); + if (!dir.exists()) + dir.mkdirs(); + this.resources.add(name); + } + + private void processResource(String name, InputStream entryIn) throws IOException { + File file = new File(name); + File tmpFile = new File(name + ".tmp"); + FileOutputStream outputStream = new FileOutputStream(tmpFile); + + copy(entryIn, outputStream); + outputStream.close(); + Files.move(tmpFile.toPath(), file.toPath(), StandardCopyOption.REPLACE_EXISTING); + + this.resources.add(name); + } + + private void processClass(String name, InputStream entryIn) throws IOException { + ClassReader classReader = new ClassReader(entryIn); + ClassWriter classWriter = new ClassWriter(0); + RelocatingClassVisitor classVisitor = new RelocatingClassVisitor(classWriter, this.remapper, name); + + try { + classReader.accept(classVisitor, ClassReader.EXPAND_FRAMES); + } catch (Throwable e) { + throw new RuntimeException("Error processing class " + name, e); + } + + byte[] renamedClass = classWriter.toByteArray(); + + // Need to take the .class off for remapping evaluation + String mappedName = this.remapper.map(name.substring(0, name.indexOf('.'))); + File outName = new File(mappedName + ".class"); + File tmpFile = new File(mappedName + ".tmp"); + FileOutputStream outputStream = new FileOutputStream(tmpFile); + + // Now we put it back on so the class file is written out with the right extension. + outputStream.write(renamedClass); + outputStream.close(); + Files.move(tmpFile.toPath(), outName.toPath(), StandardCopyOption.REPLACE_EXISTING); + } + + private void processManifest(String name, InputStream entryIn) throws IOException { + Manifest in = new Manifest(entryIn); + Manifest out = new Manifest(); + + out.getMainAttributes().putAll(in.getMainAttributes()); + + for (Map.Entry entry : in.getEntries().entrySet()) { + Attributes outAttributes = new Attributes(); + for (Map.Entry property : entry.getValue().entrySet()) { + String key = property.getKey().toString(); + if (!SIGNATURE_PROPERTY_PATTERN.matcher(key).matches()) { + outAttributes.put(property.getKey(), property.getValue()); + } + } + out.getEntries().put(entry.getKey(), outAttributes); + } + + File outFile = new File(name); + File tempFile = new File(name + ".tmp"); + FileOutputStream outputStream = new FileOutputStream(tempFile); + out.write(outputStream); + outputStream.close(); + + Files.move(tempFile.toPath(), outFile.toPath(), StandardCopyOption.REPLACE_EXISTING); + + this.resources.add(name); + } + + private static void copy(InputStream from, OutputStream to) throws IOException { + byte[] buf = new byte[8192]; + while (true) { + int n = from.read(buf); + if (n == -1) { + break; + } + to.write(buf, 0, n); + } + } +} diff --git a/src/main/java/com/hypherionmc/jarrelocator/JarRelocator.java b/src/main/java/com/hypherionmc/jarrelocator/JarRelocator.java new file mode 100644 index 0000000..e784f96 --- /dev/null +++ b/src/main/java/com/hypherionmc/jarrelocator/JarRelocator.java @@ -0,0 +1,103 @@ +/* + * Copyright Apache Software Foundation + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.hypherionmc.jarrelocator; + +import java.io.BufferedOutputStream; +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Map; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.jar.JarFile; +import java.util.jar.JarOutputStream; + +/** + * Relocates classes and resources within a jar file. + */ +public final class JarRelocator { + + /** The input jar */ + private final File input; + /** The output jar */ + private final File output; + /** The relocating remapper */ + private final RelocatingRemapper remapper; + + /** If the {@link #run()} method has been called yet */ + private final AtomicBoolean used = new AtomicBoolean(false); + + /** + * Creates a new instance with the given settings. + * + * @param input the input jar file + * @param output the output jar file + * @param relocations the relocations + */ + public JarRelocator(File input, File output, Collection relocations) { + this.input = input; + this.output = output; + this.remapper = new RelocatingRemapper(relocations); + } + + /** + * Creates a new instance with the given settings. + * + * @param input the input jar file + * @param output the output jar file + * @param relocations the relocations + */ + public JarRelocator(File input, File output, Map relocations) { + this.input = input; + this.output = output; + Collection c = new ArrayList<>(relocations.size()); + for (Map.Entry entry : relocations.entrySet()) { + c.add(new Relocation(entry.getKey(), entry.getValue())); + } + this.remapper = new RelocatingRemapper(c); + } + + /** + * Executes the relocation task + * + * @throws IOException if an exception is encountered whilst performing i/o + * with the input or output file + */ + public void run() throws IOException { + if (this.used.getAndSet(true)) { + throw new IllegalStateException("#run has already been called on this instance"); + } + + try (JarOutputStream out = new JarOutputStream(new BufferedOutputStream(Files.newOutputStream(this.output.toPath())))) { + try (JarFile in = new JarFile(this.input)) { + JarRelocatorTask task = new JarRelocatorTask(this.remapper, out, in); + task.processEntries(); + } + } + } + + public void runDirectory() throws IOException { + if (this.used.getAndSet(true)) { + throw new IllegalStateException("#run has already been called on this instance"); + } + + DirectoryRelocatorTask task = new DirectoryRelocatorTask(remapper, input); + task.processEntries(); + } + +} diff --git a/src/main/java/com/hypherionmc/jarrelocator/JarRelocatorTask.java b/src/main/java/com/hypherionmc/jarrelocator/JarRelocatorTask.java new file mode 100644 index 0000000..ee74cbd --- /dev/null +++ b/src/main/java/com/hypherionmc/jarrelocator/JarRelocatorTask.java @@ -0,0 +1,194 @@ +/* + * Copyright Apache Software Foundation + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.hypherionmc.jarrelocator; + +import org.objectweb.asm.ClassReader; +import org.objectweb.asm.ClassWriter; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.util.Enumeration; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; +import java.util.jar.*; +import java.util.regex.Pattern; + +/** + * A task that copies {@link JarEntry jar entries} from a {@link JarFile jar input} to a + * {@link JarOutputStream jar output}, applying the relocations defined by a + * {@link RelocatingRemapper}. + */ +final class JarRelocatorTask { + + /** + * META-INF/*.SF + * META-INF/*.DSA + * META-INF/*.RSA + * META-INF/SIG-* + * + * Specification + */ + private static final Pattern SIGNATURE_FILE_PATTERN = Pattern.compile("META-INF/(?:[^/]+\\.(?:DSA|RSA|SF)|SIG-[^/]+)"); + + /** + * Specification + */ + private static final Pattern SIGNATURE_PROPERTY_PATTERN = Pattern.compile(".*-Digest"); + + private final RelocatingRemapper remapper; + private final JarOutputStream jarOut; + private final JarFile jarIn; + + private final Set resources = new HashSet<>(); + + JarRelocatorTask(RelocatingRemapper remapper, JarOutputStream jarOut, JarFile jarIn) { + this.remapper = remapper; + this.jarOut = jarOut; + this.jarIn = jarIn; + } + + void processEntries() throws IOException { + for (Enumeration entries = this.jarIn.entries(); entries.hasMoreElements(); ) { + JarEntry entry = entries.nextElement(); + + // The 'INDEX.LIST' file is an optional file, containing information about the packages + // defined in a jar. Instead of relocating the entries in it, we delete it, since it is + // optional anyway. + // + // We don't process directory entries, and instead opt to recreate them when adding + // classes/resources. + String name = entry.getName(); + if (name.equals("META-INF/INDEX.LIST") || entry.isDirectory()) { + continue; + } + + // Signatures will become invalid after remapping, so we delete them to avoid making the output useless + if (SIGNATURE_FILE_PATTERN.matcher(name).matches()) { + continue; + } + + try (InputStream entryIn = this.jarIn.getInputStream(entry)) { + processEntry(entry, entryIn); + } + } + } + + private void processEntry(JarEntry entry, InputStream entryIn) throws IOException { + String name = entry.getName(); + String mappedName = this.remapper.map(name); + + // ensure the parent directory structure exists for the entry. + processDirectory(mappedName, true); + + if (name.endsWith(".class")) { + processClass(name, entryIn); + } else if (name.equals("META-INF/MANIFEST.MF")) { + processManifest(name, entryIn, entry.getTime()); + } else if (!this.resources.contains(mappedName)) { + processResource(mappedName, entryIn, entry.getTime()); + } + } + + private void processDirectory(String name, boolean parentsOnly) throws IOException { + int index = name.lastIndexOf('/'); + if (index != -1) { + String parentDirectory = name.substring(0, index); + if (!this.resources.contains(parentDirectory)) { + processDirectory(parentDirectory, false); + } + } + + if (parentsOnly) { + return; + } + + // directory entries must end in "/" + JarEntry entry = new JarEntry(name + "/"); + this.jarOut.putNextEntry(entry); + this.resources.add(name); + } + + private void processManifest(String name, InputStream entryIn, long lastModified) throws IOException { + Manifest in = new Manifest(entryIn); + Manifest out = new Manifest(); + + out.getMainAttributes().putAll(in.getMainAttributes()); + + for (Map.Entry entry : in.getEntries().entrySet()) { + Attributes outAttributes = new Attributes(); + for (Map.Entry property : entry.getValue().entrySet()) { + String key = property.getKey().toString(); + if (!SIGNATURE_PROPERTY_PATTERN.matcher(key).matches()) { + outAttributes.put(property.getKey(), property.getValue()); + } + } + out.getEntries().put(entry.getKey(), outAttributes); + } + + JarEntry jarEntry = new JarEntry(name); + jarEntry.setTime(lastModified); + this.jarOut.putNextEntry(jarEntry); + + out.write(this.jarOut); + + this.resources.add(name); + } + + private void processResource(String name, InputStream entryIn, long lastModified) throws IOException { + JarEntry jarEntry = new JarEntry(name); + jarEntry.setTime(lastModified); + + this.jarOut.putNextEntry(jarEntry); + copy(entryIn, this.jarOut); + + this.resources.add(name); + } + + private void processClass(String name, InputStream entryIn) throws IOException { + ClassReader classReader = new ClassReader(entryIn); + ClassWriter classWriter = new ClassWriter(0); + RelocatingClassVisitor classVisitor = new RelocatingClassVisitor(classWriter, this.remapper, name); + + try { + classReader.accept(classVisitor, ClassReader.EXPAND_FRAMES); + } catch (Throwable e) { + throw new RuntimeException("Error processing class " + name, e); + } + + byte[] renamedClass = classWriter.toByteArray(); + + // Need to take the .class off for remapping evaluation + String mappedName = this.remapper.map(name.substring(0, name.indexOf('.'))); + + // Now we put it back on so the class file is written out with the right extension. + this.jarOut.putNextEntry(new JarEntry(mappedName + ".class")); + this.jarOut.write(renamedClass); + } + + private static void copy(InputStream from, OutputStream to) throws IOException { + byte[] buf = new byte[8192]; + while (true) { + int n = from.read(buf); + if (n == -1) { + break; + } + to.write(buf, 0, n); + } + } +} diff --git a/src/main/java/com/hypherionmc/jarrelocator/RelocatingClassVisitor.java b/src/main/java/com/hypherionmc/jarrelocator/RelocatingClassVisitor.java new file mode 100644 index 0000000..adcf92e --- /dev/null +++ b/src/main/java/com/hypherionmc/jarrelocator/RelocatingClassVisitor.java @@ -0,0 +1,48 @@ +/* + * Copyright Apache Software Foundation + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.hypherionmc.jarrelocator; + +import org.objectweb.asm.ClassVisitor; +import org.objectweb.asm.ClassWriter; +import org.objectweb.asm.Opcodes; +import org.objectweb.asm.commons.ClassRemapper; + +/** + * A {@link ClassVisitor} that relocates types and names with a {@link RelocatingRemapper}. + */ +final class RelocatingClassVisitor extends ClassRemapper { + private final String packageName; + + RelocatingClassVisitor(ClassWriter writer, RelocatingRemapper remapper, String name) { + super(Opcodes.ASM9, writer, remapper); + this.packageName = name.substring(0, name.lastIndexOf('/') + 1); + } + + @Override + public void visitSource(String source, String debug) { + if (source == null) { + super.visitSource(null, debug); + return; + } + + // visit source file name + String name = this.packageName + source; + String mappedName = super.remapper.map(name); + String mappedFileName = mappedName.substring(mappedName.lastIndexOf('/') + 1); + super.visitSource(mappedFileName, debug); + } +} diff --git a/src/main/java/com/hypherionmc/jarrelocator/RelocatingRemapper.java b/src/main/java/com/hypherionmc/jarrelocator/RelocatingRemapper.java new file mode 100644 index 0000000..5d2f40b --- /dev/null +++ b/src/main/java/com/hypherionmc/jarrelocator/RelocatingRemapper.java @@ -0,0 +1,89 @@ +/* + * Copyright Apache Software Foundation + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.hypherionmc.jarrelocator; + +import org.objectweb.asm.commons.Remapper; + +import java.util.Collection; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +/** + * Remaps class names and types using defined {@link Relocation} rules. + */ +final class RelocatingRemapper extends Remapper { + private static final Pattern CLASS_PATTERN = Pattern.compile("(\\[*)?L(.+);"); + + // https://docs.oracle.com/javase/10/docs/specs/jar/jar.html#multi-release-jar-files + private static final Pattern VERSION_PATTERN = Pattern.compile("^(META-INF/versions/\\d+/)(.*)$"); + + private final Collection rules; + + RelocatingRemapper(Collection rules) { + this.rules = rules; + } + + @Override + public String map(String name) { + String relocatedName = relocate(name, false); + if (relocatedName != null) { + return relocatedName; + } + return super.map(name); + } + + @Override + public Object mapValue(Object object) { + if (object instanceof String) { + String relocatedName = relocate((String) object, true); + if (relocatedName != null) { + return relocatedName; + } + } + return super.mapValue(object); + } + + private String relocate(String name, boolean isStringValue) { + String prefix = ""; + String suffix = ""; + + if (isStringValue) { + Matcher m = CLASS_PATTERN.matcher(name); + if (m.matches()) { + prefix = m.group(1) + "L"; + name = m.group(2); + suffix = ";"; + } + } + + Matcher m = VERSION_PATTERN.matcher(name); + if (m.matches()) { + prefix = m.group(1); + name = m.group(2); + } + + for (Relocation r : this.rules) { + if (isStringValue && r.canRelocateClass(name)) { + return prefix + r.relocateClass(name) + suffix; + } else if (r.canRelocatePath(name)) { + return prefix + r.relocatePath(name) + suffix; + } + } + + return null; + } +} diff --git a/src/main/java/com/hypherionmc/jarrelocator/Relocation.java b/src/main/java/com/hypherionmc/jarrelocator/Relocation.java new file mode 100644 index 0000000..c79db56 --- /dev/null +++ b/src/main/java/com/hypherionmc/jarrelocator/Relocation.java @@ -0,0 +1,137 @@ +/* + * Copyright Apache Software Foundation + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.hypherionmc.jarrelocator; + +import java.util.Collection; +import java.util.Collections; +import java.util.LinkedHashSet; +import java.util.Set; + +/** + * A relocation rule + */ +public final class Relocation { + private final String pattern; + private final String relocatedPattern; + private final String pathPattern; + private final String relocatedPathPattern; + + private final Set includes; + private final Set excludes; + + /** + * Creates a new relocation + * + * @param pattern the pattern to match + * @param relocatedPattern the pattern to relocate to + * @param includes a collection of patterns which this rule should specifically include + * @param excludes a collection of patterns which this rule should specifically exclude + */ + public Relocation(String pattern, String relocatedPattern, Collection includes, Collection excludes) { + this.pattern = pattern.replace('/', '.'); + this.pathPattern = pattern.replace('.', '/'); + this.relocatedPattern = relocatedPattern.replace('/', '.'); + this.relocatedPathPattern = relocatedPattern.replace('.', '/'); + + if (includes != null && !includes.isEmpty()) { + this.includes = normalizePatterns(includes); + this.includes.addAll(includes); + } else { + this.includes = null; + } + + if (excludes != null && !excludes.isEmpty()) { + this.excludes = normalizePatterns(excludes); + this.excludes.addAll(excludes); + } else { + this.excludes = null; + } + } + + /** + * Creates a new relocation with no specific includes or excludes + * + * @param pattern the pattern to match + * @param relocatedPattern the pattern to relocate to + */ + public Relocation(String pattern, String relocatedPattern) { + this(pattern, relocatedPattern, Collections.emptyList(), Collections.emptyList()); + } + + private boolean isIncluded(String path) { + if (this.includes == null) { + return true; + } + + for (String include : this.includes) { + if (SelectorUtils.matchPath(include, path, true)) { + return true; + } + } + return false; + } + + private boolean isExcluded(String path) { + if (this.excludes == null) { + return false; + } + + for (String exclude : this.excludes) { + if (SelectorUtils.matchPath(exclude, path, true)) { + return true; + } + } + return false; + } + + boolean canRelocatePath(String path) { + if (path.endsWith(".class")) { + path = path.substring(0, path.length() - 6); + } + + if (!isIncluded(path) || isExcluded(path)) { + return false; + } + + return path.startsWith(this.pathPattern) || path.startsWith("/" + this.pathPattern); + } + + boolean canRelocateClass(String clazz) { + return clazz.indexOf('/') == -1 && canRelocatePath(clazz.replace('.', '/')); + } + + String relocatePath(String path) { + return path.replaceFirst(this.pathPattern, this.relocatedPathPattern); + } + + String relocateClass(String clazz) { + return clazz.replaceFirst(this.pattern, this.relocatedPattern); + } + + private static Set normalizePatterns(Collection patterns) { + Set normalized = new LinkedHashSet<>(); + for (String pattern : patterns) { + String classPattern = pattern.replace('.', '/'); + normalized.add(classPattern); + if (classPattern.endsWith("/*")) { + String packagePattern = classPattern.substring(0, classPattern.lastIndexOf('/')); + normalized.add(packagePattern); + } + } + return normalized; + } +} diff --git a/src/main/java/com/hypherionmc/jarrelocator/SelectorUtils.java b/src/main/java/com/hypherionmc/jarrelocator/SelectorUtils.java new file mode 100644 index 0000000..efdb7d9 --- /dev/null +++ b/src/main/java/com/hypherionmc/jarrelocator/SelectorUtils.java @@ -0,0 +1,381 @@ +/* + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2002-2003 The Apache Software Foundation. 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. + * + * 3. The end-user documentation included with the redistribution, if + * any, must include the following acknowlegement: + * "This product includes software developed by the + * Apache Software Foundation (http://www.codehaus.org/)." + * Alternately, this acknowlegement may appear in the software itself, + * if and wherever such third-party acknowlegements normally appear. + * + * 4. The names "Ant" and "Apache Software + * Foundation" must not be used to endorse or promote products derived + * from this software without prior written permission. For written + * permission, please contact codehaus@codehaus.org. + * + * 5. Products derived from this software may not be called "Apache" + * nor may "Apache" appear in their names without prior written + * permission of the Apache Group. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR + * ITS 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. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + +package com.hypherionmc.jarrelocator; + +import java.io.File; +import java.util.ArrayList; +import java.util.List; +import java.util.StringTokenizer; + +/** + * This is a stripped down version of org.codehaus.plexus.util.SelectorUtils for + * use in {@link Relocation}. + * + * @author Arnout J. Kuiper ajkuiper@wxs.nl + * @author Magesh Umasankar + * @author Bruce Atherton + */ +final class SelectorUtils { + private static final String PATTERN_HANDLER_PREFIX = "["; + private static final String PATTERN_HANDLER_SUFFIX = "]"; + private static final String REGEX_HANDLER_PREFIX = "%regex" + PATTERN_HANDLER_PREFIX; + private static final String ANT_HANDLER_PREFIX = "%ant" + PATTERN_HANDLER_PREFIX; + + private static boolean isAntPrefixedPattern(String pattern) { + return pattern.length() > (ANT_HANDLER_PREFIX.length() + PATTERN_HANDLER_SUFFIX.length() + 1) + && pattern.startsWith(ANT_HANDLER_PREFIX) && pattern.endsWith(PATTERN_HANDLER_SUFFIX); + } + + // When str starts with a File.separator, pattern has to start with a File.separator. + // When pattern starts with a File.separator, str has to start with a File.separator. + private static boolean separatorPatternStartSlashMismatch(String pattern, String str, String separator) { + return str.startsWith(separator) != pattern.startsWith(separator); + } + + public static boolean matchPath(String pattern, String str, boolean isCaseSensitive) { + return matchPath(pattern, str, File.separator, isCaseSensitive); + } + + private static boolean matchPath(String pattern, String str, String separator, boolean isCaseSensitive) { + if (isRegexPrefixedPattern(pattern)) { + pattern = pattern.substring(REGEX_HANDLER_PREFIX.length(), pattern.length() - PATTERN_HANDLER_SUFFIX.length()); + return str.matches(pattern); + } else { + if (isAntPrefixedPattern(pattern)) { + pattern = pattern.substring(ANT_HANDLER_PREFIX.length(), pattern.length() - PATTERN_HANDLER_SUFFIX.length()); + } + return matchAntPathPattern(pattern, str, separator, isCaseSensitive); + } + } + + private static boolean isRegexPrefixedPattern(String pattern) { + return pattern.length() > (REGEX_HANDLER_PREFIX.length() + PATTERN_HANDLER_SUFFIX.length() + 1) + && pattern.startsWith(REGEX_HANDLER_PREFIX) && pattern.endsWith(PATTERN_HANDLER_SUFFIX); + } + + private static boolean matchAntPathPattern(String pattern, String str, String separator, boolean isCaseSensitive) { + if (separatorPatternStartSlashMismatch(pattern, str, separator)) { + return false; + } + String[] patDirs = tokenizePathToString(pattern, separator); + String[] strDirs = tokenizePathToString(str, separator); + return matchAntPathPattern(patDirs, strDirs, isCaseSensitive); + + } + + private static boolean matchAntPathPattern(String[] patDirs, String[] strDirs, boolean isCaseSensitive) { + int patIdxStart = 0; + int patIdxEnd = patDirs.length - 1; + int strIdxStart = 0; + int strIdxEnd = strDirs.length - 1; + + // up to first '**' + while (patIdxStart <= patIdxEnd && strIdxStart <= strIdxEnd) { + String patDir = patDirs[patIdxStart]; + if (patDir.equals("**")) { + break; + } + if (!match(patDir, strDirs[strIdxStart], isCaseSensitive)) { + return false; + } + patIdxStart++; + strIdxStart++; + } + if (strIdxStart > strIdxEnd) { + // String is exhausted + for (int i = patIdxStart; i <= patIdxEnd; i++) { + if (!patDirs[i].equals("**")) { + return false; + } + } + return true; + } else { + if (patIdxStart > patIdxEnd) { + // String not exhausted, but pattern is. Failure. + return false; + } + } + + // up to last '**' + while (patIdxStart <= patIdxEnd && strIdxStart <= strIdxEnd) { + String patDir = patDirs[patIdxEnd]; + if (patDir.equals("**")) { + break; + } + if (!match(patDir, strDirs[strIdxEnd], isCaseSensitive)) { + return false; + } + patIdxEnd--; + strIdxEnd--; + } + if (strIdxStart > strIdxEnd) { + // String is exhausted + for (int i = patIdxStart; i <= patIdxEnd; i++) { + if (!patDirs[i].equals("**")) { + return false; + } + } + return true; + } + + while (patIdxStart != patIdxEnd && strIdxStart <= strIdxEnd) { + int patIdxTmp = -1; + for (int i = patIdxStart + 1; i <= patIdxEnd; i++) { + if (patDirs[i].equals("**")) { + patIdxTmp = i; + break; + } + } + if (patIdxTmp == patIdxStart + 1) { + // '**/**' situation, so skip one + patIdxStart++; + continue; + } + // Find the pattern between padIdxStart & padIdxTmp in str between + // strIdxStart & strIdxEnd + int patLength = (patIdxTmp - patIdxStart - 1); + int strLength = (strIdxEnd - strIdxStart + 1); + int foundIdx = -1; + strLoop: + for (int i = 0; i <= strLength - patLength; i++) { + for (int j = 0; j < patLength; j++) { + String subPat = patDirs[patIdxStart + j + 1]; + String subStr = strDirs[strIdxStart + i + j]; + if (!match(subPat, subStr, isCaseSensitive)) { + continue strLoop; + } + } + + foundIdx = strIdxStart + i; + break; + } + + if (foundIdx == -1) { + return false; + } + + patIdxStart = patIdxTmp; + strIdxStart = foundIdx + patLength; + } + + for (int i = patIdxStart; i <= patIdxEnd; i++) { + if (!patDirs[i].equals("**")) { + return false; + } + } + + return true; + } + + private static boolean match(String pattern, String str, boolean isCaseSensitive) { + char[] patArr = pattern.toCharArray(); + char[] strArr = str.toCharArray(); + return match(patArr, strArr, isCaseSensitive); + } + + private static boolean match(char[] patArr, char[] strArr, boolean isCaseSensitive) { + int patIdxStart = 0; + int patIdxEnd = patArr.length - 1; + int strIdxStart = 0; + int strIdxEnd = strArr.length - 1; + char ch; + + boolean containsStar = false; + for (char aPatArr : patArr) { + if (aPatArr == '*') { + containsStar = true; + break; + } + } + + if (!containsStar) { + // No '*'s, so we make a shortcut + if (patIdxEnd != strIdxEnd) { + return false; // Pattern and string do not have the same size + } + for (int i = 0; i <= patIdxEnd; i++) { + ch = patArr[i]; + if (ch != '?' && !equals(ch, strArr[i], isCaseSensitive)) { + return false; // Character mismatch + } + } + return true; // String matches against pattern + } + + if (patIdxEnd == 0) { + return true; // Pattern contains only '*', which matches anything + } + + // Process characters before first star + while ((ch = patArr[patIdxStart]) != '*' && strIdxStart <= strIdxEnd) { + if (ch != '?' && !equals(ch, strArr[strIdxStart], isCaseSensitive)) { + return false; // Character mismatch + } + patIdxStart++; + strIdxStart++; + } + if (strIdxStart > strIdxEnd) { + // All characters in the string are used. Check if only '*'s are + // left in the pattern. If so, we succeeded. Otherwise failure. + for (int i = patIdxStart; i <= patIdxEnd; i++) { + if (patArr[i] != '*') { + return false; + } + } + return true; + } + + // Process characters after last star + while ((ch = patArr[patIdxEnd]) != '*' && strIdxStart <= strIdxEnd) { + if (ch != '?' && !equals(ch, strArr[strIdxEnd], isCaseSensitive)) { + return false; // Character mismatch + } + patIdxEnd--; + strIdxEnd--; + } + if (strIdxStart > strIdxEnd) { + // All characters in the string are used. Check if only '*'s are + // left in the pattern. If so, we succeeded. Otherwise failure. + for (int i = patIdxStart; i <= patIdxEnd; i++) { + if (patArr[i] != '*') { + return false; + } + } + return true; + } + + // process pattern between stars. padIdxStart and patIdxEnd point + // always to a '*'. + while (patIdxStart != patIdxEnd && strIdxStart <= strIdxEnd) { + int patIdxTmp = -1; + for (int i = patIdxStart + 1; i <= patIdxEnd; i++) { + if (patArr[i] == '*') { + patIdxTmp = i; + break; + } + } + if (patIdxTmp == patIdxStart + 1) { + // Two stars next to each other, skip the first one. + patIdxStart++; + continue; + } + // Find the pattern between padIdxStart & padIdxTmp in str between + // strIdxStart & strIdxEnd + int patLength = (patIdxTmp - patIdxStart - 1); + int strLength = (strIdxEnd - strIdxStart + 1); + int foundIdx = -1; + strLoop: + for (int i = 0; i <= strLength - patLength; i++) { + for (int j = 0; j < patLength; j++) { + ch = patArr[patIdxStart + j + 1]; + if (ch != '?' && !equals(ch, strArr[strIdxStart + i + j], isCaseSensitive)) { + continue strLoop; + } + } + + foundIdx = strIdxStart + i; + break; + } + + if (foundIdx == -1) { + return false; + } + + patIdxStart = patIdxTmp; + strIdxStart = foundIdx + patLength; + } + + // All characters in the string are used. Check if only '*'s are left + // in the pattern. If so, we succeeded. Otherwise failure. + for (int i = patIdxStart; i <= patIdxEnd; i++) { + if (patArr[i] != '*') { + return false; + } + } + return true; + } + + /** + * Tests whether two characters are equal. + */ + private static boolean equals(char c1, char c2, boolean isCaseSensitive) { + if (c1 == c2) { + return true; + } + if (!isCaseSensitive) { + // NOTE: Try both upper case and lower case as done by String.equalsIgnoreCase() + if (Character.toUpperCase(c1) == Character.toUpperCase(c2) + || Character.toLowerCase(c1) == Character.toLowerCase(c2)) { + return true; + } + } + return false; + } + + private static String[] tokenizePathToString(String path, String separator) { + List ret = new ArrayList(); + StringTokenizer st = new StringTokenizer(path, separator); + while (st.hasMoreTokens()) { + ret.add(st.nextToken()); + } + return ret.toArray(new String[ret.size()]); + } + + /** + * Private Constructor + */ + private SelectorUtils() { + } +}