/* * This file is part of fabric-loom, licensed under the MIT License (MIT). * * Copyright (c) 2016-2021 FabricMC * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ package net.fabricmc.loom.task; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.File; import java.io.FileNotFoundException; import java.io.IOException; import java.io.UncheckedIOException; import java.nio.file.Files; import java.nio.file.Path; import java.util.ArrayList; import java.util.Collections; import java.util.LinkedHashSet; import java.util.List; import java.util.Map; import java.util.Set; import java.util.jar.Manifest; import com.google.common.base.Preconditions; import org.gradle.api.Action; import org.gradle.api.Project; import org.gradle.api.artifacts.Configuration; import org.gradle.api.file.FileCollection; import org.gradle.api.file.RegularFileProperty; import org.gradle.api.plugins.JavaPlugin; import org.gradle.api.provider.Property; import org.gradle.api.tasks.Input; import org.gradle.api.tasks.InputFile; import org.gradle.api.tasks.TaskAction; import org.gradle.jvm.tasks.Jar; import org.jetbrains.annotations.ApiStatus; import net.fabricmc.loom.LoomGradleExtension; import net.fabricmc.loom.api.mappings.layered.MappingsNamespace; import net.fabricmc.loom.build.JarRemapper; import net.fabricmc.loom.build.MixinRefmapHelper; import net.fabricmc.loom.build.nesting.JarNester; import net.fabricmc.loom.build.nesting.MergedNestedJarProvider; import net.fabricmc.loom.build.nesting.NestedDependencyProvider; import net.fabricmc.loom.build.nesting.NestedJarPathProvider; import net.fabricmc.loom.build.nesting.NestedJarProvider; import net.fabricmc.loom.configuration.JarManifestConfiguration; import net.fabricmc.loom.configuration.accesswidener.AccessWidenerFile; import net.fabricmc.loom.configuration.accesswidener.AccessWidenerJarProcessor; import net.fabricmc.loom.configuration.providers.mappings.MappingsProviderImpl; import net.fabricmc.loom.util.Constants; import net.fabricmc.loom.util.TinyRemapperHelper; import net.fabricmc.loom.util.ZipReprocessorUtil; import net.fabricmc.loom.util.ZipUtils; import net.fabricmc.stitch.util.Pair; import net.fabricmc.tinyremapper.TinyRemapper; import net.fabricmc.tinyremapper.TinyUtils; import net.fabricmc.tinyremapper.extension.mixin.MixinExtension; public class RemapJarTask extends Jar { private static final String MANIFEST_PATH = "META-INF/MANIFEST.MF"; private final RegularFileProperty input; private final Property addNestedDependencies; private final Property addDefaultNestedDependencies; private final Property remapAccessWidener; private final List> remapOptions = new ArrayList<>(); public JarRemapper jarRemapper; private FileCollection classpath; private final Set nestedPaths = new LinkedHashSet<>(); public RemapJarTask() { super(); LoomGradleExtension extension = LoomGradleExtension.get(getProject()); input = getProject().getObjects().fileProperty(); addNestedDependencies = getProject().getObjects().property(Boolean.class) .convention(false); addDefaultNestedDependencies = getProject().getObjects().property(Boolean.class) .convention(true); remapAccessWidener = getProject().getObjects().property(Boolean.class) .convention(false); if (!extension.getMixin().getUseLegacyMixinAp().get()) { remapOptions.add(b -> b.extension(new MixinExtension())); } } @TaskAction public void doTask() throws Throwable { boolean singleRemap = false; if (jarRemapper == null) { singleRemap = true; jarRemapper = new JarRemapper(); } scheduleRemap(singleRemap || LoomGradleExtension.get(getProject()).isRootProject()); if (singleRemap) { jarRemapper.remap(); } } public void scheduleRemap(boolean isMainRemapTask) throws Throwable { Project project = getProject(); LoomGradleExtension extension = LoomGradleExtension.get(getProject()); Path input = this.getInput().getAsFile().get().toPath(); Path output = this.getArchiveFile().get().getAsFile().toPath(); if (!Files.exists(input)) { throw new FileNotFoundException(input.toString()); } MappingsProviderImpl mappingsProvider = extension.getMappingsProvider(); String fromM = MappingsNamespace.NAMED.toString(); String toM = MappingsNamespace.INTERMEDIARY.toString(); if (isMainRemapTask) { jarRemapper.addToClasspath(getRemapClasspath()); jarRemapper.addMappings(TinyRemapperHelper.create(mappingsProvider.getMappings(), fromM, toM, false)); } for (File mixinMapFile : extension.getAllMixinMappings()) { if (mixinMapFile.exists()) { jarRemapper.addMappings(TinyUtils.createTinyMappingProvider(mixinMapFile.toPath(), fromM, toM)); } } // Add remap options to the jar remapper jarRemapper.addOptions(this.remapOptions); NestedJarProvider nestedJarProvider = getNestedJarProvider(); nestedJarProvider.prepare(getProject()); jarRemapper.scheduleRemap(input, output) .supplyAccessWidener((remapData, remapper) -> { if (getRemapAccessWidener().getOrElse(false) && extension.getAccessWidenerPath().isPresent()) { AccessWidenerJarProcessor accessWidenerJarProcessor = extension.getJarProcessorManager().getByType(AccessWidenerJarProcessor.class); byte[] data; try { data = accessWidenerJarProcessor.getRemappedAccessWidener(remapper, toM); } catch (IOException e) { throw new RuntimeException("Failed to remap access widener", e); } AccessWidenerFile awFile = AccessWidenerFile.fromModJar(remapData.input); Preconditions.checkNotNull(awFile, "Failed to find accessWidener in fabric.mod.json: " + remapData.input); return Pair.of(awFile.name(), data); } return null; }) .complete((data, accessWidener) -> { if (!Files.exists(output)) { throw new RuntimeException("Failed to remap " + input + " to " + output + " - file missing!"); } if (extension.getMixin().getUseLegacyMixinAp().get()) { if (MixinRefmapHelper.addRefmapName(project, output)) { project.getLogger().debug("Transformed mixin reference maps in output JAR!"); } } if (getAddNestedDependencies().getOrElse(false)) { JarNester.nestJars(nestedJarProvider.provide(), output.toFile(), project.getLogger()); } if (accessWidener != null) { try { ZipUtils.replace(data.output, accessWidener.getLeft(), accessWidener.getRight()); } catch (IOException e) { throw new UncheckedIOException("Failed to replace access widener in output jar", e); } } // Add data to the manifest try { int count = ZipUtils.transform(data.output, Map.of(MANIFEST_PATH, bytes -> { var manifest = new Manifest(new ByteArrayInputStream(bytes)); var manifestConfiguration = new JarManifestConfiguration(project); manifestConfiguration.configure(manifest); manifest.getMainAttributes().putValue("Fabric-Mapping-Namespace", toM); ByteArrayOutputStream out = new ByteArrayOutputStream(); manifest.write(out); return out.toByteArray(); })); Preconditions.checkState(count > 0, "Did not transform any jar manifest"); } catch (IOException e) { throw new UncheckedIOException("Failed to transform jar manifest", e); } if (isReproducibleFileOrder() || !isPreserveFileTimestamps()) { try { ZipReprocessorUtil.reprocessZip(output.toFile(), isReproducibleFileOrder(), isPreserveFileTimestamps()); } catch (IOException e) { throw new RuntimeException("Failed to re-process jar", e); } } }); } private NestedJarProvider getNestedJarProvider() { Configuration includeConfiguration = getProject().getConfigurations().getByName(Constants.Configurations.INCLUDE); if (!addDefaultNestedDependencies.getOrElse(true)) { return new NestedJarPathProvider(nestedPaths); } NestedJarProvider baseProvider = NestedDependencyProvider.createNestedDependencyProviderFromConfiguration(getProject(), includeConfiguration); if (nestedPaths.isEmpty()) { return baseProvider; } return new MergedNestedJarProvider( baseProvider, new NestedJarPathProvider(nestedPaths) ); } private Path[] getRemapClasspath() { FileCollection files = this.classpath; if (files == null) { files = getProject().getConfigurations().getByName(JavaPlugin.COMPILE_CLASSPATH_CONFIGURATION_NAME); } return files.getFiles().stream() .map(File::toPath) .filter(Files::exists) .toArray(Path[]::new); } @InputFile public RegularFileProperty getInput() { return input; } @Input public Property getAddNestedDependencies() { return addNestedDependencies; } @Input public Property getAddDefaultNestedDependencies() { return addDefaultNestedDependencies; } @Input public Property getRemapAccessWidener() { return remapAccessWidener; } public void remapOptions(Action action) { this.remapOptions.add(action); } public RemapJarTask classpath(FileCollection collection) { if (this.classpath == null) { this.classpath = collection; } else { this.classpath = this.classpath.plus(collection); } return this; } @ApiStatus.Experimental // This only allows mod jars, proceed with care when trying to pass in configurations with projects, or something that depends on a task. public RemapJarTask include(Object... paths) { Collections.addAll(nestedPaths, paths); this.addNestedDependencies.set(true); return this; } }