From 187be47e88188a56f1de0aaefead3c26bf34331e Mon Sep 17 00:00:00 2001 From: 33 Date: Tue, 19 Jul 2022 20:40:53 +0800 Subject: [PATCH] Add: Custom Gradle Plugin in `buildSrc` --- BuildScripts/cos.gradle | 154 ------------------ BuildScripts/curseforge.gradle | 5 +- BuildScripts/modrinth.gradle | 7 +- BuildScripts/version.gradle | 37 ----- build.gradle | 21 +-- buildSrc/build.gradle.kts | 23 +++ buildSrc/build.properties | 5 + .../customskinloader/gradle/BuildPlugin.java | 14 ++ .../gradle/task/UploadTask.java | 73 +++++++++ .../gradle/util/ConfigUtil.java | 33 ++++ .../customskinloader/gradle/util/CosUtil.java | 68 ++++++++ .../gradle/util/VersionUtil.java | 53 ++++++ .../customskinloader.properties | 1 + gradlew | 0 settings.gradle | 2 + 15 files changed, 285 insertions(+), 211 deletions(-) delete mode 100644 BuildScripts/cos.gradle delete mode 100644 BuildScripts/version.gradle create mode 100644 buildSrc/build.gradle.kts create mode 100644 buildSrc/build.properties create mode 100644 buildSrc/src/main/java/customskinloader/gradle/BuildPlugin.java create mode 100644 buildSrc/src/main/java/customskinloader/gradle/task/UploadTask.java create mode 100644 buildSrc/src/main/java/customskinloader/gradle/util/ConfigUtil.java create mode 100644 buildSrc/src/main/java/customskinloader/gradle/util/CosUtil.java create mode 100644 buildSrc/src/main/java/customskinloader/gradle/util/VersionUtil.java create mode 100644 buildSrc/src/main/resources/META-INF/gradle-plugins/customskinloader.properties mode change 100644 => 100755 gradlew diff --git a/BuildScripts/cos.gradle b/BuildScripts/cos.gradle deleted file mode 100644 index 024c5d6..0000000 --- a/BuildScripts/cos.gradle +++ /dev/null @@ -1,154 +0,0 @@ -/** - * Gradle Script for COS - * It can be used to upload or download file from Tencent Cloud COS. - * COS: https://cloud.tencent.com/document/product/436 - */ - -buildscript { - repositories { - mavenCentral() - } - dependencies { - classpath 'com.qcloud:cos_api:5.4.6' - } -} - -import com.qcloud.cos.COSClient -import com.qcloud.cos.ClientConfig -import com.qcloud.cos.auth.BasicCOSCredentials -import com.qcloud.cos.auth.COSCredentials -import com.qcloud.cos.model.PutObjectRequest -import com.qcloud.cos.model.GetObjectRequest -import com.qcloud.cos.region.Region - -String getMcVersion(String filename) { - if (filename.endsWith(".json")) - return filename.substring(0, filename.indexOf('-')) - return filename.substring(filename.indexOf('_') + 1, filename.indexOf('-')) -} - -String getKey(String filename) { - String name = filename.substring(0, filename.lastIndexOf('.')) - if (name.indexOf('-') == -1) return null - if (filename.endsWith(".json")) - return String.format( - "versions/%s/%s", - name, - filename - ) - if (filename.endsWith(".jar")) { - if (filename.contains("Fabric") || filename.contains("Forge")) { - return String.format( - "mods/%s", - filename - ) - } else { - return String.format( - "libraries/customskinloader/%s/%s/%s", - name.substring(0, name.indexOf('-')), - name.substring(name.indexOf('-') + 1), - filename - ) - } - } - return filename -} - -ext.bucketName = System.getenv("COS_BUCKET") -ext.cosUrl = "https://csl.littleservice.cn/" -ext.cosClient0 = null - -COSClient getCosClient() { - if (cosClient0 != null) return cosClient0 - - COSCredentials cred = new BasicCOSCredentials(System.getenv("COS_SECRET_ID"), System.getenv("COS_SECRET_KEY")) - ClientConfig clientConfig = new ClientConfig(new Region("ap-shanghai")) - cosClient0 = new COSClient(cred, clientConfig) -} - -void uploadFile(String key, File file) { - PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, key, file) - getCosClient().putObject(putObjectRequest) -} - -void downloadFile(String key, File file) { - GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, key) - getCosClient().getObject(getObjectRequest, file) -} - -String toJson(Map map, int d) { - StringBuilder sb = new StringBuilder("{\n") - Iterator> it = map.entrySet().iterator() - while (it.hasNext()) { - Map.Entry e = it.next() - String k = e.key - String v = null - if (e.value instanceof String) { - v = "\"" + e.value + "\"" - } else if (e.value instanceof Map) { - v = toJson((Map) e.value, d + 1) - } - for (int i = 0; i < d * 2; i++) { - sb.append(' ') - } - if (it.hasNext()) { - sb.append(String.format("\"%s\" : %s,\n", k, v)) - } else { - sb.append(String.format("\"%s\" : %s\n", k, v)) - } - } - for (int i = 0; i < (d - 1) * 2; i++) { - sb.append(' ') - } - sb.append("}") - return sb.toString() -} - -String toJson(Map map) { - return toJson(map, 1) -} - -void writeToFile(File f, String s) { - FileWriter fw = new FileWriter(f) - fw.write(s) - fw.flush() - fw.close() -} - -void uploadArtifacts(String shortVersion) { - File dir = rootProject.file("build/libs") - if (!dir.isDirectory()) return - - String cslversion = shortVersion.replace(".", "") - LinkedHashMap map = new LinkedHashMap() - LinkedHashMap map2 = new LinkedHashMap() - LinkedHashMap map3 = new LinkedHashMap() - map.put("version", shortVersion) - map.put("downloads", map2) - map.put("launchermeta", map3) - - File[] files = dir.listFiles() - for (file in files) { - String key = getKey(file.getName()) - if (key == null) continue - uploadFile(key, file) - String url = cosUrl + key - String mcversion = getMcVersion(file.getName()) - println(String.format("csl-%s-%s\t%s", mcversion.replace(".", "").toLowerCase(), cslversion, url)) - - if (key.startsWith("mods/") && key.endsWith(".jar") && !key.endsWith("-sources.jar")) { - map2.put(mcversion, url) - } else if (key.endsWith(".json")) { - map3.put(mcversion, url) - } - } - - File latest = new File("build/libs/latest.json") - map.get("downloads").put("Forge", map.get("downloads").remove("ForgeLegacy")) - writeToFile(latest, toJson(map)) - uploadFile("latest.json", latest) -} - -ext { - uploadArtifacts = this.&uploadArtifacts -} diff --git a/BuildScripts/curseforge.gradle b/BuildScripts/curseforge.gradle index 8b597e8..a1e4b7c 100644 --- a/BuildScripts/curseforge.gradle +++ b/BuildScripts/curseforge.gradle @@ -13,6 +13,7 @@ buildscript { import com.matthewprenger.cursegradle.CurseArtifact import com.matthewprenger.cursegradle.CurseGradlePlugin import com.matthewprenger.cursegradle.CurseUploadTask +import customskinloader.gradle.util.VersionUtil // https://www.curseforge.com/minecraft/mc-mods/customskinloader static void provideCurseForge0(Project proj) { @@ -35,8 +36,8 @@ static void provideCurseForge0(Project proj) { gameVersionStrings += proj.name.split("/")[0] // Loader Version changelogType = "text" changelog = System.getenv("GIT_COMMIT_DESC") ?: "" - displayName = "${proj.archivesBaseName}-${proj.ext.getShortVersion()}" - releaseType = proj.ext.isSnapshot() ? "beta" : "release" + displayName = "${proj.archivesBaseName}-${VersionUtil.getShortVersion(proj.rootProject)}" + releaseType = VersionUtil.isSnapshot(proj.rootProject) ? "beta" : "release" it } additionalArtifacts = [] diff --git a/BuildScripts/modrinth.gradle b/BuildScripts/modrinth.gradle index e97a7e9..b6f6ab8 100644 --- a/BuildScripts/modrinth.gradle +++ b/BuildScripts/modrinth.gradle @@ -12,6 +12,7 @@ buildscript { import com.modrinth.minotaur.TaskModrinthUpload import com.modrinth.minotaur.request.VersionType +import customskinloader.gradle.util.VersionUtil // https://modrinth.com/mod/customskinloader static void provideModrinth0(Project proj) { @@ -22,11 +23,11 @@ static void provideModrinth0(Project proj) { token = System.getenv("MODRINTH_TOKEN") projectId = "idMHQ4n2" - versionNumber = "${proj.ext.getCSLVersion()}-${proj.name.replace("/", ".")}" - versionName = "${proj.archivesBaseName}-${proj.ext.getShortVersion()}" + versionNumber = "${VersionUtil.getCSLVersion(proj.rootProject)}-${proj.name.replace("/", ".")}" + versionName = "${proj.archivesBaseName}-${VersionUtil.getShortVersion(proj.rootProject)}" changelog = System.getenv("GIT_COMMIT_DESC") ?: "" uploadFile = proj.tasks.jar - versionType = proj.ext.isSnapshot() ? VersionType.BETA : VersionType.RELEASE + versionType = VersionUtil.isSnapshot(proj.rootProject) ? VersionType.BETA : VersionType.RELEASE failSilently = true detectLoaders = false diff --git a/BuildScripts/version.gradle b/BuildScripts/version.gradle deleted file mode 100644 index 1a54a14..0000000 --- a/BuildScripts/version.gradle +++ /dev/null @@ -1,37 +0,0 @@ -/** - * Gradle Script for Version - * Format Version String - */ - -boolean isRelease() { - String s = rootProject.ext.config.snapshot - return s == null || s == "" || s == "0" -} - -boolean isSnapshot() { - return !isRelease() -} - -String getBuildNum() { - if (System.getenv("CIRCLE_BUILD_NUM") != null) - return System.getenv("CIRCLE_BUILD_NUM") - return "00" -} - -//Example: 14.10a-SNAPSHOT-33 -String getCSLVersion() { - return rootProject.ext.config.version + rootProject.ext.config.dev_version + - (isRelease() ? '' : ('-SNAPSHOT-' + getBuildNum())) -} - -//Example: 14.10a-s33 -String getShortVersion() { - return getCSLVersion().replace("SNAPSHOT-", "s") -} - -ext { - isSnapshot = this.&isSnapshot - getBuildNum = this.&getBuildNum - getCSLVersion = this.&getCSLVersion - getShortVersion = this.&getShortVersion -} diff --git a/build.gradle b/build.gradle index 33d35bf..48974c0 100644 --- a/build.gradle +++ b/build.gradle @@ -1,4 +1,5 @@ apply plugin: 'base' +apply plugin: 'customskinloader' ext.configFile = file "build.properties" configFile.withReader { @@ -29,6 +30,8 @@ wrapper { gradleVersion = "4.10.3" } +import customskinloader.gradle.util.VersionUtil + subprojects { apply plugin: 'net.minecraftforge.gradle.forge' @@ -39,11 +42,9 @@ subprojects { project.ext.config = new ConfigSlurper().parse prop } - apply from: rootProject.file("BuildScripts/version.gradle") - - version = getCSLVersion() + version = VersionUtil.getCSLVersion(rootProject) group = "customskinloader" - ext.shortVersion = getShortVersion() + ext.shortVersion = VersionUtil.getShortVersion(rootProject) sourceCompatibility = targetCompatibility = 1.8 compileJava { @@ -57,7 +58,7 @@ subprojects { replace '@MOD_VERSION@', rootProject.ext.config.version replace '@MOD_FULL_VERSION@', project.version - replace '@MOD_BUILD_NUMBER@', getBuildNum() + replace '@MOD_BUILD_NUMBER@', VersionUtil.getBuildNum() replaceIn 'CustomSkinLoader.java' } @@ -214,13 +215,3 @@ subprojects { } } } - -apply from: rootProject.file('BuildScripts/cos.gradle') -apply from: rootProject.file('BuildScripts/version.gradle') - -task upload { - onlyIf { System.getenv("COS_SECRET_KEY") != null } - doLast { - uploadArtifacts(getShortVersion()) - } -} diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts new file mode 100644 index 0000000..be913d2 --- /dev/null +++ b/buildSrc/build.gradle.kts @@ -0,0 +1,23 @@ +plugins { + id("java") +} + +group = "customskinloader" +version = "1.0.0" + +repositories { + mavenCentral() +} + +dependencies { + testImplementation("org.junit.jupiter:junit-jupiter-api:5.8.1") + testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.8.1") + implementation("com.qcloud:cos_api:5.6.98") + implementation(gradleApi()) + implementation("com.google.code.gson:gson:2.9.0") + implementation("commons-io:commons-io:2.11.0") +} + +tasks.getByName("test") { + useJUnitPlatform() +} \ No newline at end of file diff --git a/buildSrc/build.properties b/buildSrc/build.properties new file mode 100644 index 0000000..2c5a53a --- /dev/null +++ b/buildSrc/build.properties @@ -0,0 +1,5 @@ +forge_mc_version=1.12.2 +forge_version=14.23.5.2768 +mappings_version=stable_39 +# this subproject is only to provide dependency for other subprojects. +is_real_project=false diff --git a/buildSrc/src/main/java/customskinloader/gradle/BuildPlugin.java b/buildSrc/src/main/java/customskinloader/gradle/BuildPlugin.java new file mode 100644 index 0000000..250534e --- /dev/null +++ b/buildSrc/src/main/java/customskinloader/gradle/BuildPlugin.java @@ -0,0 +1,14 @@ +package customskinloader.gradle; + +import customskinloader.gradle.task.UploadTask; +import org.gradle.api.Plugin; +import org.gradle.api.Project; + +public class BuildPlugin implements Plugin { + @Override + public void apply(Project project) { + System.out.printf("Apply project '%s'", project.getName()); + project.getTasks().create("upload", UploadTask.class, + task -> task.rootProject = project.getRootProject()); + } +} \ No newline at end of file diff --git a/buildSrc/src/main/java/customskinloader/gradle/task/UploadTask.java b/buildSrc/src/main/java/customskinloader/gradle/task/UploadTask.java new file mode 100644 index 0000000..7f4e715 --- /dev/null +++ b/buildSrc/src/main/java/customskinloader/gradle/task/UploadTask.java @@ -0,0 +1,73 @@ +package customskinloader.gradle.task; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import customskinloader.gradle.util.CosUtil; +import customskinloader.gradle.util.VersionUtil; +import org.apache.commons.io.FileUtils; +import org.gradle.api.DefaultTask; +import org.gradle.api.Project; +import org.gradle.api.tasks.TaskAction; + +import java.io.File; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.LinkedHashMap; + +public class UploadTask extends DefaultTask { + public Project rootProject; + + private static final Gson gson = new GsonBuilder().setPrettyPrinting().create(); + + private void uploadArtifacts() throws IOException { + String shortVersion = VersionUtil.getShortVersion(rootProject); + File dir = rootProject.file("build/libs"); + if (!dir.isDirectory()) { + return; + } + + String cslversion = shortVersion.replace(".", ""); + LinkedHashMap map = new LinkedHashMap<>(); + LinkedHashMap map2 = new LinkedHashMap<>(); + LinkedHashMap map3 = new LinkedHashMap<>(); + map.put("version", shortVersion); + map.put("downloads", map2); + map.put("launchermeta", map3); + + File[] files = dir.listFiles(); + if (files == null) { + return; + } + for (File file : files) { + String key = CosUtil.getKey(file.getName()); + if (key == null) { + continue; + } + CosUtil.uploadFile(key, file); + String url = CosUtil.cosUrl + key; + String mcversion = VersionUtil.getMcVersion(file.getName()); + if (mcversion.equals("ForgeLegacy")) { + mcversion = "Forge"; + } + System.out.printf("csl-%s-%s\t%s%n", + mcversion.replace(".", "").toLowerCase(), cslversion, url); + + if (key.startsWith("mods/") && key.endsWith(".jar") && !key.endsWith("-sources.jar")) { + map2.put(mcversion, url); + } else if (key.endsWith(".json")) { + map3.put(mcversion, url); + } + } + + File latest = new File("build/libs/latest.json"); + FileUtils.write(latest, gson.toJson(map), StandardCharsets.UTF_8); + CosUtil.uploadFile("latest.json", latest); + } + + @TaskAction + public void upload() throws IOException { + if (System.getenv("COS_SECRET_KEY") != null) { + uploadArtifacts(); + } + } +} diff --git a/buildSrc/src/main/java/customskinloader/gradle/util/ConfigUtil.java b/buildSrc/src/main/java/customskinloader/gradle/util/ConfigUtil.java new file mode 100644 index 0000000..9a0fc35 --- /dev/null +++ b/buildSrc/src/main/java/customskinloader/gradle/util/ConfigUtil.java @@ -0,0 +1,33 @@ +package customskinloader.gradle.util; + +import groovy.util.ConfigObject; +import org.gradle.api.Project; + +public class ConfigUtil { + public static ConfigObject getConfig(Project project) { + if (!project.getExtensions().getExtraProperties().has("config")) { + System.out.printf("Config not found in '%s'", project.getName()); + return new ConfigObject(); + } + Object o = project.getExtensions().getExtraProperties().get("config"); + if (!(o instanceof ConfigObject)) { + System.out.printf("Config in '%s' is not ConfigObject", project.getName()); + return new ConfigObject(); + } + return (ConfigObject) o; + } + + public static String getConfigString(Project project, String key) { + ConfigObject config = getConfig(project); + Object o = config.get(key); + if (o == null) { + System.out.printf("Config '%s' not found in '%s'", key, project.getName()); + return null; + } + if (!(o instanceof String)) { + System.out.printf("Config '%s' in '%s' is not String", key, project.getName()); + return null; + } + return (String) config.getProperty(key); + } +} diff --git a/buildSrc/src/main/java/customskinloader/gradle/util/CosUtil.java b/buildSrc/src/main/java/customskinloader/gradle/util/CosUtil.java new file mode 100644 index 0000000..dd19e46 --- /dev/null +++ b/buildSrc/src/main/java/customskinloader/gradle/util/CosUtil.java @@ -0,0 +1,68 @@ +package customskinloader.gradle.util; + +import com.qcloud.cos.COSClient; +import com.qcloud.cos.ClientConfig; +import com.qcloud.cos.auth.BasicCOSCredentials; +import com.qcloud.cos.auth.COSCredentials; +import com.qcloud.cos.model.GetObjectRequest; +import com.qcloud.cos.model.PutObjectRequest; +import com.qcloud.cos.region.Region; + +import java.io.File; + +public class CosUtil { + public static String getKey(String filename) { + String name = filename.substring(0, filename.lastIndexOf('.')); + if (name.indexOf('-') == -1) { + return null; + } + if (filename.endsWith(".json")) + return String.format( + "versions/%s/%s", + name, + filename + ); + if (filename.endsWith(".jar")) { + if (filename.contains("Fabric") || filename.contains("Forge")) { + return String.format( + "mods/%s", + filename + ); + } else { + return String.format( + "libraries/customskinloader/%s/%s/%s", + name.substring(0, name.indexOf('-')), + name.substring(name.indexOf('-') + 1), + filename + ); + } + } + return filename; + } + private static final String bucketName = System.getenv("COS_BUCKET"); + public static final String cosUrl = "https://csl.littleservice.cn/"; + private static COSClient cosClient0 = null; + + private static COSClient getCosClient() { + if (cosClient0 != null) { + return cosClient0; + } + + COSCredentials cred = new BasicCOSCredentials(System.getenv("COS_SECRET_ID"), + System.getenv("COS_SECRET_KEY")); + ClientConfig clientConfig = new ClientConfig(new Region("ap-shanghai")); + cosClient0 = new COSClient(cred, clientConfig); + + return cosClient0; + } + + public static void uploadFile(String key, File file) { + PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, key, file); + getCosClient().putObject(putObjectRequest); + } + + public static void downloadFile(String key, File file) { + GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, key); + getCosClient().getObject(getObjectRequest, file); + } +} diff --git a/buildSrc/src/main/java/customskinloader/gradle/util/VersionUtil.java b/buildSrc/src/main/java/customskinloader/gradle/util/VersionUtil.java new file mode 100644 index 0000000..efa95ac --- /dev/null +++ b/buildSrc/src/main/java/customskinloader/gradle/util/VersionUtil.java @@ -0,0 +1,53 @@ +package customskinloader.gradle.util; + +import org.gradle.api.Project; +import org.gradle.util.VersionNumber; + +import java.util.Arrays; +import java.util.Collection; +import java.util.stream.Collectors; + +public class VersionUtil { + public static boolean isRelease(Project rootProject) { + String s = ConfigUtil.getConfigString(rootProject, "snapshot"); + return s == null || s.equals("") || s.equals("0"); + } + + public static boolean isSnapshot(Project rootProject) { + return !isRelease(rootProject); + } + + public static String getBuildNum() { + if (System.getenv("CIRCLE_BUILD_NUM") != null) { + return System.getenv("CIRCLE_BUILD_NUM"); + } + return "00"; + } + + //Example: 14.10a-SNAPSHOT-33 + public static String getCSLVersion(Project rootProject) { + + return ConfigUtil.getConfigString(rootProject, "version") + + ConfigUtil.getConfigString(rootProject, "dev_version") + + (isRelease(rootProject) ? "" : ("-SNAPSHOT-" + getBuildNum())); + } + + //Example: 14.10a-s33 + public static String getShortVersion(Project rootProject) { + return getCSLVersion(rootProject).replace("SNAPSHOT-", "s"); + } + + public static String getMcVersion(String filename) { + if (filename.endsWith(".json")) { + return filename.substring(0, filename.indexOf('-')); + } + return filename.substring(filename.indexOf('_') + 1, filename.indexOf('-')); + } + + public static Collection getMcMajorVersions(String version) { + return Arrays.stream(version.split(",")) + .map(VersionNumber::parse) + .map(it -> String.format("%s.%s", it.getMajor(), it.getMinor())) + .collect(Collectors.toSet()); + } +} diff --git a/buildSrc/src/main/resources/META-INF/gradle-plugins/customskinloader.properties b/buildSrc/src/main/resources/META-INF/gradle-plugins/customskinloader.properties new file mode 100644 index 0000000..cc737a0 --- /dev/null +++ b/buildSrc/src/main/resources/META-INF/gradle-plugins/customskinloader.properties @@ -0,0 +1 @@ +implementation-class=customskinloader.gradle.BuildPlugin \ No newline at end of file diff --git a/gradlew b/gradlew old mode 100644 new mode 100755 diff --git a/settings.gradle b/settings.gradle index 494138e..b85d86e 100644 --- a/settings.gradle +++ b/settings.gradle @@ -21,3 +21,5 @@ include "Forge/Active" //Fabric Edition for [1.14,) include "Fabric" +include 'buildSrc' +