Skip to content

Commit

Permalink
5.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@NatanLifshitz
NatanLifshitz committed Dec 3, 2023
1 parent 23f970d commit 73fa334
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 198 deletions.
2 changes: 2 additions & 0 deletions changelog.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
### 5.0.0
- Support for Fabric Loader 1.5.0. Note that this version will no longer debfuscate crash logs.

This comment has been minimized.

Sign in to view

Copy link
@C-Higgins

C-Higgins Jan 21, 2024

Should be 0.15.0
### 4.2.1
- Added missing Chinese translation.
### 4.2.0
Expand Down
197 changes: 1 addition & 196 deletions fabric/src/main/java/fudge/notenoughcrashes/fabric/StacktraceDeobfuscator.java
View file
Original file line number Diff line number Diff line change
@@ -1,213 +1,18 @@
package fudge.notenoughcrashes.fabric;

import com.google.common.collect.Lists;
import com.google.common.net.UrlEscapers;
import fudge.notenoughcrashes.NecConfig;
import fudge.notenoughcrashes.NotEnoughCrashes;
import fudge.notenoughcrashes.platform.NecPlatform;
import net.fabricmc.mapping.reader.v2.MappingGetter;
import net.fabricmc.mapping.reader.v2.TinyMetadata;
import net.fabricmc.mapping.reader.v2.TinyV2Factory;
import net.fabricmc.mapping.reader.v2.TinyVisitor;
import net.minecraft.MinecraftVersion;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;

import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.nio.file.*;
import java.util.*;

public final class StacktraceDeobfuscator {

private static final String MAPPINGS_JAR_LOCATION = "mappings/mappings.tiny";
private static final String NAMESPACE_FROM = "intermediary";
private static final String NAMESPACE_TO = "named";
private static final Path CACHED_MAPPINGS = NotEnoughCrashes.DIRECTORY
.resolve("mappings-" + MinecraftVersion.create().getName() + ".tiny");

private static Map<String, String> mappings = null;

// No need to deobf in dev
private static final boolean DEBUG_DEOBF = false;
private static final boolean ENABLE_DEOBF = (!NecPlatform.instance().isDevelopmentEnvironment()
&& NecConfig.instance().deobfuscateStackTrace) || DEBUG_DEOBF;

public static void init() {
if (!ENABLE_DEOBF) return;
try {
if (!Files.exists(CACHED_MAPPINGS)) downloadAndCacheMappings();
} catch (Exception e) {
NotEnoughCrashes.getLogger().error("Failed to load mappings!", e);
}

// Install the log exception deobfuscation rewrite policy
DeobfuscatingRewritePolicy.install();
}


private static void downloadAndCacheMappings() {
String yarnVersion;
try {
yarnVersion = YarnVersion.getLatestBuildForCurrentVersion();
} catch (IOException e) {
NotEnoughCrashes.getLogger().error("Could not get latest yarn build for version", e);
return;
}

NotEnoughCrashes.getLogger().info("Downloading deobfuscation mappings: " + yarnVersion + " for the first launch");

String encodedYarnVersion = UrlEscapers.urlFragmentEscaper().escape(yarnVersion);
// Download V2 jar
String artifactUrl = "https://maven.fabricmc.net/net/fabricmc/yarn/" + encodedYarnVersion + "/yarn-" + encodedYarnVersion + "-v2.jar";

try {
Files.createDirectories(NotEnoughCrashes.DIRECTORY);
} catch (IOException e) {
NotEnoughCrashes.getLogger().error("Could not create " + NotEnoughCrashes.NAME + " directory!", e);
return;
}

File jarFile = NotEnoughCrashes.DIRECTORY.resolve("yarn-mappings.jar").toFile();
jarFile.deleteOnExit();
try {
FileUtils.copyURLToFile(new URL(artifactUrl), jarFile);
} catch (IOException e) {
NotEnoughCrashes.getLogger().error("Failed to downloads mappings!", e);
return;
}

try (FileSystem jar = FileSystems.newFileSystem(jarFile.toPath(), (ClassLoader) null)) {
NotEnoughCrashes.ensureDirectoryExists();
Files.copy(jar.getPath(MAPPINGS_JAR_LOCATION), CACHED_MAPPINGS, StandardCopyOption.REPLACE_EXISTING);
} catch (IOException e) {
NotEnoughCrashes.getLogger().error("Failed to extract mappings!", e);
}
}


private static void loadMappings() {
if (!Files.exists(CACHED_MAPPINGS)) {
NotEnoughCrashes.getLogger().warn("Could not download mappings, stack trace won't be deobfuscated");
return;
}

Map<String, String> mappings = new HashMap<>();

try (BufferedReader mappingReader = Files.newBufferedReader(CACHED_MAPPINGS)) {
TinyV2Factory.visit(mappingReader, new TinyVisitor() {
private final Map<String, Integer> namespaceStringToColumn = new HashMap<>();

private void addMappings(MappingGetter name) {
mappings.put(name.get(namespaceStringToColumn.get(NAMESPACE_FROM)).replace('/', '.'),
name.get(namespaceStringToColumn.get(NAMESPACE_TO)).replace('/', '.'));
}

@Override
public void start(TinyMetadata metadata) {
namespaceStringToColumn.put(NAMESPACE_FROM, metadata.index(NAMESPACE_FROM));
namespaceStringToColumn.put(NAMESPACE_TO, metadata.index(NAMESPACE_TO));
}

@Override
public void pushClass(MappingGetter name) {
addMappings(name);
}

@Override
public void pushMethod(MappingGetter name, String descriptor) {
addMappings(name);
}

@Override
public void pushField(MappingGetter name, String descriptor) {
addMappings(name);
}
});

} catch (IOException e) {
NotEnoughCrashes.getLogger().error("Could not load mappings", e);
}

StacktraceDeobfuscator.mappings = mappings;
}

public static void deobfuscateThrowable(Throwable t) {
Deque<Throwable> queue = new ArrayDeque<>();
queue.add(t);
boolean firstLoop = true;
while (!queue.isEmpty()) {
t = queue.remove();
t.setStackTrace(deobfuscateStacktrace(t.getStackTrace(), firstLoop));
if (t.getCause() != null) {
queue.add(t.getCause());
}
Collections.addAll(queue, t.getSuppressed());

firstLoop = false;
}
}


// No need to insert multiple watermarks in one exception
public static StackTraceElement[] deobfuscateStacktrace(StackTraceElement[] stackTrace, boolean insertWatermark) {
if (stackTrace.length == 0) return stackTrace;

List<StackTraceElement> stackTraceList = Lists.newArrayList(stackTrace);
if (ENABLE_DEOBF
// Check it wasn't deobfuscated already. This can happen when this is called both by DeobfuscatingRewritePolicy
// and then CrashReport mixin. They don't cover all cases alone though so we need both.
&& !StringUtils.startsWith(stackTrace[0].getClassName(), NotEnoughCrashes.NAME)) {
if (mappings == null) loadMappings();
if (mappings == null) return stackTrace;

if (insertWatermark) {
try {
stackTraceList.add(0, new StackTraceElement(NotEnoughCrashes.NAME + " deobfuscated stack trace",
"", YarnVersion.getLatestBuildForCurrentVersion(), -1));
} catch (IOException e) {
NotEnoughCrashes.getLogger().error("Could not get used yarn version", e);
return stackTrace;
}
}

int index = 0;

for (StackTraceElement el : stackTraceList) {
String remappedClass = mappings.get(el.getClassName());
String remappedMethod = mappings.get(el.getMethodName());
stackTraceList.set(index, new StackTraceElement(
remappedClass != null ? remappedClass : el.getClassName(),
remappedMethod != null ? remappedMethod : el.getMethodName(),
remappedClass != null ? getFileName(remappedClass) : el.getFileName(),
el.getLineNumber())
);
index++;
}
}


return stackTraceList.toArray(new StackTraceElement[] {});
}

private static String getFileName(String className) {
if (className.isEmpty()) return className;

int lastDot = className.lastIndexOf('.');
if (lastDot != -1) {
className = className.substring(lastDot + 1);
}

return className.split("\\$",2)[0];
}

// For testing
public static void main(String[] args) {
init();
for (Map.Entry<String, String> entry : mappings.entrySet()) {
System.out.println(entry.getKey() + " <=> " + entry.getValue());
}
return stackTrace;
}
}
4 changes: 2 additions & 2 deletions gradle/libs.versions.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ task_tree = { id = "com.dorongold.task-tree", version.ref = "task_tree" }
[versions]

# This Mod Version
mod_version = "4.2.1"
mod_version = "5.0.0"

# Gradle Plugins
architectury_plugin = "3.4-SNAPSHOT"
Expand All @@ -33,7 +33,7 @@ overrides_modrinth = "mc"

# Mods & Libraries
yarn_mappings = "1.19.2+build.28"
fabric_loader = "0.14.10"
fabric_loader = "0.15.0"
fabric_api = "0.66.0+1.19.2"
quilt_loader = "0.17.6"
forge = "43.1.52"
Expand Down

0 comments on commit 73fa334

Please sign in to comment.