Skip to content

Commit

Permalink
auto-cf: add option to exclude files from overrides (#332)
Browse files Browse the repository at this point in the history
  • Loading branch information
@itzg
itzg authored Oct 27, 2023
1 parent 27c47b0 commit eaa5f32
Show file tree
Hide file tree
Showing 6 changed files with 275 additions and 109 deletions.
126 changes: 21 additions & 105 deletions src/main/java/me/itzg/helpers/curseforge/CurseForgeInstaller.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardCopyOption;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
Expand All @@ -32,6 +30,7 @@
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;
import me.itzg.helpers.curseforge.ExcludeIncludesContent.ExcludeIncludes;
import me.itzg.helpers.curseforge.OverridesApplier.Result;
import me.itzg.helpers.curseforge.model.Category;
import me.itzg.helpers.curseforge.model.CurseForgeFile;
import me.itzg.helpers.curseforge.model.CurseForgeMod;
Expand Down Expand Up @@ -64,8 +63,6 @@ public class CurseForgeInstaller {

public static final String ETERNAL_DEVELOPER_CONSOLE_URL = "https://console.curseforge.com/";
public static final String CURSEFORGE_ID = "curseforge";
public static final String LEVEL_DAT_SUFFIX = "/level.dat";
public static final int LEVEL_DAT_SUFFIX_LEN = LEVEL_DAT_SUFFIX.length();
public static final String REPO_SUBDIR_MODPACKS = "modpacks";
public static final String REPO_SUBDIR_MODS = "mods";
public static final String REPO_SUBDIR_WORLDS = "worlds";
Expand Down Expand Up @@ -108,6 +105,9 @@ public class CurseForgeInstaller {
CurseForgeApiClient.CATEGORY_WORLDS
));

@Getter @Setter
private List<String> overridesExclusions;

/**
* @throws MissingModsException if any mods need to be manually downloaded
*/
Expand All @@ -118,8 +118,12 @@ public void installFromModpackZip(Path modpackZip, String slug) throws IOExcepti
final MinecraftModpackManifest modpackManifest = extractModpackManifest(modpackZip);

processModpackManifest(context, modpackManifest,
() -> applyOverrides(modpackZip, modpackManifest.getOverrides())
);
new OverridesFromZipApplier(
outputDir, modpackZip, overridesSkipExisting,
modpackManifest.getOverrides(),
levelFrom, overridesExclusions
)
);
});
}

Expand All @@ -146,7 +150,7 @@ public void installFromModpackManifest(String modpackManifestLoc, String slug) t
}

processModpackManifest(context, modpackManifest,
() -> new OverridesResult(Collections.emptyList(), null)
() -> new Result(Collections.emptyList(), null)
);
});
}
Expand Down Expand Up @@ -359,8 +363,13 @@ else if (Manifests.allFilesPresent(outputDir, context.prevInstallManifest)) {
try {

final MinecraftModpackManifest modpackManifest = extractModpackManifest(modpackZip);
results = processModpack(context, modpackManifest, () -> applyOverrides(modpackZip,
modpackManifest.getOverrides()));
results = processModpack(context, modpackManifest,
new OverridesFromZipApplier(
outputDir, modpackZip, overridesSkipExisting,
modpackManifest.getOverrides(),
levelFrom, overridesExclusions
)
);
} finally {
Files.delete(modpackZip);
}
Expand Down Expand Up @@ -479,9 +488,6 @@ private void trimLevelsContent(CurseForgeManifest manifest) {
});
}

/**
* @param overridesApplier typically calls {@link #applyOverrides(Path, String)}
*/
private ModPackResults processModpack(InstallContext context,
MinecraftModpackManifest modpackManifest, OverridesApplier overridesApplier
) throws IOException {
Expand Down Expand Up @@ -540,14 +546,14 @@ private ModPackResults processModpack(InstallContext context,
.collectList()
.block();

final OverridesResult overridesResult = overridesApplier.apply();
final Result overridesResult = overridesApplier.apply();

prepareModLoader(modLoader.getId(), modpackManifest.getMinecraft().getVersion());

return buildResults(modpackManifest, modLoader, modFiles, overridesResult);
}

private ModPackResults buildResults(MinecraftModpackManifest modpackManifest, ModLoader modLoader, List<PathWithInfo> modFiles, OverridesResult overridesResult) {
private ModPackResults buildResults(MinecraftModpackManifest modpackManifest, ModLoader modLoader, List<PathWithInfo> modFiles, Result overridesResult) {
return new ModPackResults()
.setName(modpackManifest.getName())
.setVersion(modpackManifest.getVersion())
Expand All @@ -572,7 +578,7 @@ private ModPackResults buildResults(MinecraftModpackManifest modpackManifest, Mo
.setModLoaderId(modLoader.getId());
}

private String resolveLevelName(List<PathWithInfo> modFiles, OverridesResult overridesResult) {
private String resolveLevelName(List<PathWithInfo> modFiles, Result overridesResult) {
if (levelFrom == LevelFrom.OVERRIDES && overridesResult.levelName != null) {
return overridesResult.levelName;
}
Expand Down Expand Up @@ -638,96 +644,6 @@ private Mono<Set<Integer>> resolveFromSlugOrIds(
.collect(Collectors.toSet());
}

@AllArgsConstructor
static class OverridesResult {
List<Path> paths;
String levelName;
}

interface OverridesApplier {
OverridesResult apply() throws IOException;
}

private OverridesResult applyOverrides(Path modpackZip, String overridesDir) throws IOException {
log.debug("Applying overrides from '{}' in zip file", overridesDir);

final String levelEntryName = findLevelEntryInOverrides(modpackZip, overridesDir);
final String levelEntryNamePrefix = levelEntryName != null ? levelEntryName+"/" : null;

final boolean worldOutputDirExists = levelEntryName != null &&
Files.exists(outputDir.resolve(levelEntryName));

log.debug("While applying overrides, found level entry='{}' in modpack overrides and worldOutputDirExists={}",
levelEntryName, worldOutputDirExists);

final String overridesDirPrefix = overridesDir + "/";
final int overridesPrefixLen = overridesDirPrefix.length();

final List<Path> overrides = new ArrayList<>();
try (ZipInputStream zip = new ZipInputStream(Files.newInputStream(modpackZip))) {
ZipEntry entry;
while ((entry = zip.getNextEntry()) != null) {
if (entry.getName().startsWith(overridesDirPrefix)) {
if (!entry.isDirectory()) {
if (log.isTraceEnabled()) {
log.trace("Processing override entry={}:{}", entry.isDirectory() ? "D":"F", entry.getName());
}
final String subpath = entry.getName().substring(overridesPrefixLen);
final Path outPath = outputDir.resolve(subpath);

// Rules
// - don't ever overwrite world data
// - user has option to not overwrite any existing file from overrides
// - otherwise user will want latest modpack's overrides content

final boolean isInWorldDirectory = levelEntryNamePrefix != null &&
subpath.startsWith(levelEntryNamePrefix);

if (worldOutputDirExists && isInWorldDirectory) {
continue;
}

if ( !(overridesSkipExisting && Files.exists(outPath)) ) {
log.trace("Applying override {}", subpath);
// zip files don't always list the directories before the files, so just create-as-needed
Files.createDirectories(outPath.getParent());
Files.copy(zip, outPath, StandardCopyOption.REPLACE_EXISTING);
}
else {
log.trace("Skipping override={} since the file already existed", subpath);
}

// Track this path for later cleanup
// UNLESS it is within a world/level directory
if (levelEntryName == null || !isInWorldDirectory) {
overrides.add(outPath);
}
}
}
}
}

return new OverridesResult(overrides,
levelFrom == LevelFrom.OVERRIDES ? levelEntryName : null
);
}

/**
* @return if present, the subpath to a world/level directory with the overrides prefix removed otherwise null
*/
private String findLevelEntryInOverrides(Path modpackZip, String overridesDir) throws IOException {
try (ZipInputStream zip = new ZipInputStream(Files.newInputStream(modpackZip))) {
ZipEntry entry;
while ((entry = zip.getNextEntry()) != null) {
final String name = entry.getName();
if (!entry.isDirectory() && name.startsWith(overridesDir + "/") && name.endsWith(LEVEL_DAT_SUFFIX)) {
return name.substring(overridesDir.length()+1, name.length() - LEVEL_DAT_SUFFIX_LEN);
}
}
}
return null;
}

/**
* Downloads the referenced project-file into the appropriate subdirectory from outputPaths
*/
Expand Down
19 changes: 15 additions & 4 deletions src/main/java/me/itzg/helpers/curseforge/InstallCurseForgeCommand.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import java.io.PrintWriter;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.Set;
import java.util.concurrent.Callable;
import java.util.regex.Matcher;
Expand All @@ -25,9 +26,10 @@
import picocli.CommandLine.ExitCode;
import picocli.CommandLine.Option;

@Command(name = "install-curseforge", subcommands = {
SchemasCommand.class
})
@Command(name = "install-curseforge",
description = "Downloads, installs, and upgrades CurseForge modpacks",
subcommands = {SchemasCommand.class}
)
public class InstallCurseForgeCommand implements Callable<Integer> {

@Option(names = {"--help","-h"}, usageHelp = true)
Expand Down Expand Up @@ -114,7 +116,6 @@ static class Listed {
}
}


@Option(names = "--filename-matcher", paramLabel = "STR",
description = "Substring to select specific modpack filename")
String filenameMatcher;
Expand All @@ -135,6 +136,15 @@ static class Listed {
)
boolean overridesSkipExisting;

@Option(names = "--overrides-exclusions",
split = "\n|,", splitSynopsisLabel = "NL or ,",
description = "Excludes files from the overrides that match these ant-style patterns\n"
+ "* : matches any non-slash characters\n"
+ "** : matches any characters\n"
+ "? : matches one character"
)
List<String> overridesExclusions;

@ArgGroup(exclusive = false)
SharedFetchArgs sharedFetchArgs = new SharedFetchArgs();

Expand Down Expand Up @@ -182,6 +192,7 @@ public Integer call() throws Exception {
.setForceSynchronize(forceSynchronize)
.setLevelFrom(levelFrom)
.setOverridesSkipExisting(overridesSkipExisting)
.setOverridesExclusions(overridesExclusions)
.setSharedFetchOptions(sharedFetchArgs.options())
.setApiKey(apiKey)
.setDownloadsRepo(downloadsRepo);
Expand Down
18 changes: 18 additions & 0 deletions src/main/java/me/itzg/helpers/curseforge/OverridesApplier.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package me.itzg.helpers.curseforge;

import java.io.IOException;
import java.nio.file.Path;
import java.util.List;
import lombok.AllArgsConstructor;

interface OverridesApplier {

Result apply() throws IOException;

@AllArgsConstructor
class Result {

List<Path> paths;
String levelName;
}
}
Loading

0 comments on commit eaa5f32

Please sign in to comment.