Add rudimentary build info command (#717)

* Add rudimentary build info command

* Translate task to Kotlin

* Fix error

Author: xpple

build.gradle

@@ -1,4 +1,5 @@
 import net.earthcomputer.clientcommands.buildscript.CheckLanguageFilesTask
+import net.earthcomputer.clientcommands.buildscript.GenerateBuildInfoTask
 
 plugins {
 	id 'fabric-loom' version '1.9-SNAPSHOT'
@@ -101,6 +102,10 @@ jar {
 	from("LICENSE")
 }
 
+tasks.register('generateBuildInfo', GenerateBuildInfoTask) {
+	outputFile = new File(temporaryDir, "build_info.json")
+}
+
 processResources {
 	inputs.property "version", project.version
 	inputs.property "mcversion", project.minecraft_version_dependency
@@ -115,6 +120,8 @@ processResources {
 	from(sourceSets.main.resources.srcDirs) {
 		exclude "fabric.mod.json"
 	}
+
+	from generateBuildInfo
 }
 
 java {

buildSrc/src/main/kotlin/net/earthcomputer/clientcommands/buildscript/GenerateBuildInfoTask.kt

@@ -0,0 +1,58 @@
+package net.earthcomputer.clientcommands.buildscript
+
+import com.google.gson.Gson
+import com.google.gson.JsonObject
+import org.gradle.api.DefaultTask
+import org.gradle.api.file.RegularFileProperty
+import org.gradle.api.tasks.OutputFile
+import org.gradle.api.tasks.TaskAction
+import org.gradle.process.ExecOperations
+import java.io.ByteArrayOutputStream
+import java.nio.charset.StandardCharsets
+import javax.inject.Inject
+
+abstract class GenerateBuildInfoTask : DefaultTask() {
+
+    companion object {
+        private val GSON = Gson()
+    }
+
+    @get:OutputFile
+    abstract val outputFile: RegularFileProperty
+
+    @get:Inject
+    protected abstract val execOperations: ExecOperations
+
+    init {
+        // never reuse previous outputs
+        this.outputs.upToDateWhen { false }
+    }
+
+    @TaskAction
+    protected fun run() {
+        val version = this.project.version.toString()
+        val branch = this.executeCommand("git", "branch", "--show-current")
+        val shortCommitHash = this.executeCommand("git", "rev-parse", "--short", "HEAD")
+        val commitHash = this.executeCommand("git", "rev-parse", "HEAD")
+
+        val jsonObject = JsonObject().apply {
+            addProperty("version", version)
+            addProperty("branch", branch)
+            addProperty("shortCommitHash", shortCommitHash)
+            addProperty("commitHash", commitHash)
+        }
+
+        outputFile.asFile.get().writer().use {
+            GSON.toJson(jsonObject, it)
+        }
+    }
+
+    private fun executeCommand(vararg args: Any): String {
+        val outputBytes = ByteArrayOutputStream()
+        this.execOperations.exec {
+            standardOutput = outputBytes
+            commandLine(*args)
+        }.rethrowFailure()
+        return outputBytes.toString(StandardCharsets.UTF_8).trim()
+    }
+}

src/main/java/net/earthcomputer/clientcommands/ClientCommands.java

@@ -11,10 +11,10 @@
 import net.earthcomputer.clientcommands.event.ClientConnectionEvents;
 import net.earthcomputer.clientcommands.features.CommandExecutionCustomPayload;
 import net.earthcomputer.clientcommands.features.FishingCracker;
-import net.earthcomputer.clientcommands.features.ServerBrandManager;
-import net.earthcomputer.clientcommands.util.MappingsHelper;
 import net.earthcomputer.clientcommands.features.PlayerRandCracker;
 import net.earthcomputer.clientcommands.features.Relogger;
+import net.earthcomputer.clientcommands.features.ServerBrandManager;
+import net.earthcomputer.clientcommands.util.MappingsHelper;
 import net.fabricmc.api.ClientModInitializer;
 import net.fabricmc.fabric.api.client.command.v2.ClientCommandRegistrationCallback;
 import net.fabricmc.fabric.api.client.command.v2.FabricClientCommandSource;
@@ -123,6 +123,7 @@ public static void registerCommands(CommandDispatcher<FabricClientCommandSource>
         AreaStatsCommand.register(dispatcher, context);
         AuditMixinsCommand.register(dispatcher);
         BookCommand.register(dispatcher);
+        BuildInfoCommand.register(dispatcher);
         CalcCommand.register(dispatcher);
         CalcStackCommand.register(dispatcher, context);
         CDebugCommand.register(dispatcher);

src/main/java/net/earthcomputer/clientcommands/command/BuildInfoCommand.java

@@ -0,0 +1,21 @@
+package net.earthcomputer.clientcommands.command;
+
+import com.mojang.brigadier.Command;
+import com.mojang.brigadier.CommandDispatcher;
+import net.earthcomputer.clientcommands.util.BuildInfo;
+import net.fabricmc.fabric.api.client.command.v2.FabricClientCommandSource;
+import net.minecraft.network.chat.Component;
+
+import static net.fabricmc.fabric.api.client.command.v2.ClientCommandManager.*;
+
+public class BuildInfoCommand {
+    public static void register(CommandDispatcher<FabricClientCommandSource> dispatcher) {
+        dispatcher.register(literal("cbuildinfo")
+            .executes(ctx -> buildInfo(ctx.getSource())));
+    }
+
+    private static int buildInfo(FabricClientCommandSource source) {
+        source.sendFeedback(Component.translatable("commands.cbuildinfo.success", BuildInfo.VERSION, BuildInfo.BRANCH, BuildInfo.SHORT_COMMIT_HASH));
+        return Command.SINGLE_SUCCESS;
+    }
+}

src/main/java/net/earthcomputer/clientcommands/util/BuildInfo.java

@@ -0,0 +1,44 @@
+package net.earthcomputer.clientcommands.util;
+
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParser;
+import com.mojang.logging.LogUtils;
+import net.fabricmc.loader.api.FabricLoader;
+import org.slf4j.Logger;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.nio.file.Files;
+
+public final class BuildInfo {
+    private BuildInfo() {
+    }
+
+    private static final Logger LOGGER = LogUtils.getLogger();
+
+    public static final String VERSION;
+    public static final String BRANCH;
+    public static final String SHORT_COMMIT_HASH;
+    public static final String COMMIT_HASH;
+
+    static {
+        String version, branch, shortCommitHash, commitHash;
+        version = branch = shortCommitHash = commitHash = "unknown";
+        try (BufferedReader reader = Files.newBufferedReader(FabricLoader.getInstance()
+            .getModContainer("clientcommands").orElseThrow()
+            .findPath("build_info.json").orElseThrow())
+        ) {
+            JsonObject object = JsonParser.parseReader(reader).getAsJsonObject();
+            version = object.get("version").getAsString();
+            branch = object.get("branch").getAsString();
+            shortCommitHash = object.get("shortCommitHash").getAsString();
+            commitHash = object.get("commitHash").getAsString();
+        } catch (RuntimeException | IOException e) {
+            LOGGER.error("Error while reading build_info.json", e);
+        }
+        VERSION = version;
+        BRANCH = branch;
+        SHORT_COMMIT_HASH = shortCommitHash;
+        COMMIT_HASH = commitHash;
+    }
+}

src/main/resources/assets/clientcommands/lang/en_us.json

@@ -40,6 +40,8 @@
   "commands.cbook.commandException": "You are not holding a book",
   "commands.cbook.success": "Successfully edited book",
 
+  "commands.cbuildinfo.success": "Running clientcommands on version %s (%s@{%s})",
+
   "commands.ccalc.expected": "Expected %s",
   "commands.ccalc.invalidArgumentCount": "Function \"%s\" cannot take %s arguments",
   "commands.ccalc.parse": "Parsed expression: %s",