Skip to content

[Bugfix] 修复 #6348 资源包管理处理非UTF-8编码的options.txt文件时出错 #6351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ToobLac wants to merge 5 commits into
base: main
Choose a base branch
from
+45 −17
Open

[Bugfix] 修复 #6348 资源包管理处理非UTF-8编码的options.txt文件时出错 #6351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
79de248
Fixes #6348
ToobLac Jul 9, 2026
9420f70
update
ToobLac Jul 9, 2026
34d122b
update
ToobLac Jul 9, 2026
c1c1672
update
ToobLac Jul 10, 2026
79dc5c9
update
ToobLac Jul 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 24 additions & 16 deletions HMCLCore/src/main/java/org/jackhuang/hmcl/addon/resourcepack/ResourcePackManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@
import org.jetbrains.annotations.Unmodifiable;

import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.io.UncheckedIOException;
import java.nio.charset.Charset;
import java.nio.file.*;
import java.util.*;
import java.util.stream.Stream;
Expand Down Expand Up @@ -224,33 +225,40 @@ public ResourcePackManager(GameRepository repository, String id) {
this.optionsFile = repository.getRunDirectory(id).resolve("options.txt");
}

@Nullable
private Charset optionsFileCharset;
Comment on lines +228 to +229

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 22, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Document the new options charset field

Add a /// Markdown-Javadoc comment describing this field’s lifecycle and fallback behavior. This newly introduced field is not documented, and the repository requires documentation for every field and mandates the /// format.

AGENTS.md reference: AGENTS.md:L16-L20

Useful? React with 👍 / 👎.


@NotNull
private Map<String, String> loadOptions() {
getMinecraftVersion();
Map<String, String> options = new LinkedHashMap<>();
if (!Files.isRegularFile(optionsFile)) return options;
try (var stream = Files.lines(optionsFile, StandardCharsets.UTF_8)) {
stream.forEach(s -> {
if (StringUtils.isNotBlank(s)) {
var entry = s.split(":", 2);
if (entry.length == 2) {
options.put(entry[0], entry[1]);
}
}
});
} catch (IOException e) {
byte[] bytes;
try {
bytes = Files.readAllBytes(optionsFile);
} catch (IOException | UncheckedIOException e) {
LOG.warning("Failed to read instance options file", e);
return options;
}
optionsFileCharset = StringUtils.detectMaybeNativeTextEncoding(bytes);
new String(bytes, optionsFileCharset).lines().forEach(s -> {
if (StringUtils.isNotBlank(s)) {
var entry = s.split(":", 2);
if (entry.length == 2) {
options.put(entry[0], entry[1]);
}
}
});
return options;
}

private void saveOptions(@NotNull Map<String, String> options) {
StringBuilder sb = new StringBuilder();
for (var entry : options.entrySet()) {
sb.append(entry.getKey()).append(":").append(entry.getValue()).append(System.lineSeparator());
}
try {
StringBuilder sb = new StringBuilder();
for (var entry : options.entrySet()) {
sb.append(entry.getKey()).append(":").append(entry.getValue()).append(System.lineSeparator());
}
FileUtils.saveSafely(optionsFile, sb.toString());
FileUtils.saveSafely(optionsFile, sb.toString(), optionsFileCharset);
} catch (IOException e) {
LOG.warning("Failed to save instance options file", e);
}
Expand Down
15 changes: 15 additions & 0 deletions HMCLCore/src/main/java/org/jackhuang/hmcl/util/StringUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,16 @@
*/
package org.jackhuang.hmcl.util;

import org.glavo.chardet.UniversalDetector;
import org.jackhuang.hmcl.util.gson.JsonUtils;
import org.jackhuang.hmcl.util.platform.OperatingSystem;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.Nullable;

import java.io.PrintWriter;
import java.io.StringWriter;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.*;
import java.util.function.Predicate;
import java.util.regex.Matcher;
Expand Down Expand Up @@ -630,6 +634,17 @@ public static List<String> deserializeStringList(String json) {
return JsonUtils.fromNonNullJson(json, JsonUtils.listTypeOf(String.class));
}

public static Charset detectMaybeNativeTextEncoding(byte[] data) {

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 22, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Annotate the modified utility class with @NotNullByDefault

Add @NotNullByDefault to this modified class (and the other modified Java classes). Without it, the new detectMaybeNativeTextEncoding API leaves its non-null parameter and return-value contract implicit, contrary to the repository’s required nullability convention.

AGENTS.md reference: AGENTS.md:L5-L9

Useful? React with 👍 / 👎.

var detector = new UniversalDetector();
detector.handleData(data);
detector.dataEnd();
var detected = detector.getDetectedCharset();
if (detected == null || !detected.isSupported()) return OperatingSystem.NATIVE_CHARSET;
var charset = detected.getCharset();
if (charset == StandardCharsets.UTF_8 || charset == StandardCharsets.US_ASCII) return StandardCharsets.UTF_8;
return OperatingSystem.NATIVE_CHARSET;

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 10, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Preserve the detected non-UTF-8 charset

When options.txt is encoded in a supported non-UTF-8 charset that differs from the current JVM native charset, such as an instance copied from a GBK Windows machine to a UTF-8 Linux/macOS install or a UTF-16 file with a BOM, this branch discards the charset UniversalDetector found and forces loadOptions() to decode with OperatingSystem.NATIVE_CHARSET. That still produces mojibake before the resource pack lists are parsed and later rewritten, so the non-UTF-8 fix only works when the file happens to match the local native charset; return the detected charset for supported non-ASCII encodings instead of falling back here.

Useful? React with 👍 / 👎.

@ToobLac ToobLac Jul 10, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

无需担心，这种情况MC也读取不了，就不管了（

Comment thread
ToobLac marked this conversation as resolved.
}

public static class LevCalculator {
private int[][] lev;

Expand Down
7 changes: 6 additions & 1 deletion HMCLCore/src/main/java/org/jackhuang/hmcl/util/io/FileUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import org.jetbrains.annotations.Nullable;

import java.io.*;
import java.nio.charset.Charset;
import java.nio.file.*;
import java.nio.file.attribute.BasicFileAttributes;
import java.nio.file.attribute.PosixFileAttributeView;
Expand Down Expand Up @@ -507,13 +508,17 @@ public static Path tmpSaveFile(Path file) {
}

public static void saveSafely(Path file, String content) throws IOException {
saveSafely(file, content, UTF_8);
}

public static void saveSafely(Path file, String content, @Nullable Charset charset) throws IOException {
Path parent = file.toAbsolutePath().getParent();
if (parent != null) {
Files.createDirectories(parent);
}

Path tmpFile = tmpSaveFile(file);
try (BufferedWriter writer = Files.newBufferedWriter(tmpFile, StandardOpenOption.TRUNCATE_EXISTING, StandardOpenOption.CREATE)) {
try (BufferedWriter writer = Files.newBufferedWriter(tmpFile, charset != null ? charset : UTF_8, StandardOpenOption.TRUNCATE_EXISTING, StandardOpenOption.CREATE)) {
writer.write(content);
}

Expand Down