-
-
Notifications
You must be signed in to change notification settings - Fork 0
GH-48 Introduce simple update checker, using Modrinth api. #48
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.
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
vLuckyyy
wants to merge
5
commits into
master
Choose a base branch
from
add-updater-by-modrinth-api
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+257
−0
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,7 @@ plugins { | |
} | ||
|
||
repositories { | ||
mavenCentral() | ||
gradlePluginPortal() | ||
} | ||
|
||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
plugins { | ||
`commons-java-17` | ||
`commons-repositories` | ||
} | ||
|
||
dependencies { | ||
implementation(project(":eternalcode-commons-updater")) | ||
} |
20 changes: 20 additions & 0 deletions
20
...updater-example/src/main/java/com/eternalcode/commons/updater/example/ExampleChecker.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
package com.eternalcode.commons.updater.example; | ||
|
||
import com.eternalcode.commons.updater.UpdateResult; | ||
|
||
public class ExampleChecker { | ||
|
||
private static final String OLD_ETERNALCOMBAT_VERSION = "1.3.3"; | ||
|
||
public static void main(String[] args) { | ||
ExampleUpdateService updateService = new ExampleUpdateService(); | ||
|
||
UpdateResult modrinthResult = updateService.checkModrinth("EternalCombat", OLD_ETERNALCOMBAT_VERSION); | ||
System.out.println("Modrinth update available: " + modrinthResult.isUpdateAvailable()); | ||
if (modrinthResult.isUpdateAvailable()) { | ||
System.out.println("Latest: " + modrinthResult.latestVersion()); | ||
System.out.println("Download: " + modrinthResult.downloadUrl()); | ||
System.out.println("Release page: " + modrinthResult.releaseUrl()); | ||
} | ||
} | ||
} |
13 changes: 13 additions & 0 deletions
13
...r-example/src/main/java/com/eternalcode/commons/updater/example/ExampleUpdateService.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
package com.eternalcode.commons.updater.example; | ||
|
||
import com.eternalcode.commons.updater.UpdateResult; | ||
import com.eternalcode.commons.updater.Version; | ||
import com.eternalcode.commons.updater.impl.ModrinthUpdateChecker; | ||
|
||
public final class ExampleUpdateService { | ||
private final ModrinthUpdateChecker modrinthChecker = new ModrinthUpdateChecker(); | ||
|
||
public UpdateResult checkModrinth(String projectId, String currentVersion) { | ||
return modrinthChecker.check(projectId, new Version(currentVersion)); | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
plugins { | ||
`commons-java-17` | ||
`commons-publish` | ||
`commons-repositories` | ||
`commons-java-unit-test` | ||
} | ||
|
||
tasks.test { | ||
useJUnitPlatform() | ||
} | ||
|
||
|
||
dependencies { | ||
api("org.json:json:20240303") | ||
api(project(":eternalcode-commons-shared")) | ||
|
||
api("org.jetbrains:annotations:24.1.0") | ||
} |
6 changes: 6 additions & 0 deletions
6
eternalcode-commons-updater/src/main/java/com/eternalcode/commons/updater/UpdateChecker.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
package com.eternalcode.commons.updater; | ||
|
||
public interface UpdateChecker { | ||
|
||
UpdateResult check(String projectId, Version currentVersion); | ||
} |
8 changes: 8 additions & 0 deletions
8
eternalcode-commons-updater/src/main/java/com/eternalcode/commons/updater/UpdateResult.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
package com.eternalcode.commons.updater; | ||
|
||
public record UpdateResult(Version currentVersion, Version latestVersion, String downloadUrl, String releaseUrl) { | ||
|
||
public boolean isUpdateAvailable() { | ||
return this.latestVersion.isNewerThan(this.currentVersion); | ||
} | ||
} |
89 changes: 89 additions & 0 deletions
89
eternalcode-commons-updater/src/main/java/com/eternalcode/commons/updater/Version.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
package com.eternalcode.commons.updater; | ||
|
||
import org.jetbrains.annotations.NotNull; | ||
|
||
public class Version implements Comparable<Version> { | ||
private final String value; | ||
private final int[] parts; | ||
|
||
public Version(String version) { | ||
if (version == null || version.trim().isEmpty()) { | ||
throw new IllegalArgumentException("Version cannot be null or empty"); | ||
} | ||
|
||
this.value = version.trim(); | ||
this.parts = parseVersion(this.value); | ||
} | ||
|
||
private int[] parseVersion(String version) { | ||
String cleaned = version.startsWith("v") ? version.substring(1) : version; | ||
|
||
int dashIndex = cleaned.indexOf('-'); | ||
if (dashIndex > 0) { | ||
cleaned = cleaned.substring(0, dashIndex); | ||
} | ||
|
||
String[] stringParts = cleaned.split("\\."); | ||
int[] intParts = new int[stringParts.length]; | ||
|
||
for (int i = 0; i < stringParts.length; i++) { | ||
try { | ||
intParts[i] = Integer.parseInt(stringParts[i]); | ||
} | ||
catch (NumberFormatException exception) { | ||
throw new IllegalArgumentException("Invalid version format: " + version); | ||
} | ||
} | ||
|
||
return intParts; | ||
} | ||
|
||
@Override | ||
public int compareTo(@NotNull Version other) { | ||
if (other == null) { | ||
return 1; | ||
} | ||
|
||
int maxLength = Math.max(this.parts.length, other.parts.length); | ||
|
||
for (int i = 0; i < maxLength; i++) { | ||
int thisPart = i < this.parts.length ? this.parts[i] : 0; | ||
int otherPart = i < other.parts.length ? other.parts[i] : 0; | ||
|
||
int result = Integer.compare(thisPart, otherPart); | ||
if (result != 0) { | ||
return result; | ||
} | ||
} | ||
|
||
return 0; | ||
} | ||
|
||
public boolean isNewerThan(Version other) { | ||
return this.compareTo(other) > 0; | ||
} | ||
|
||
@Override | ||
public boolean equals(Object obj) { | ||
if (this == obj) { | ||
return true; | ||
} | ||
|
||
if (obj == null || getClass() != obj.getClass()) { | ||
return false; | ||
} | ||
|
||
Version version = (Version) obj; | ||
return this.compareTo(version) == 0; | ||
} | ||
|
||
@Override | ||
public int hashCode() { | ||
return java.util.Arrays.hashCode(parts); | ||
} | ||
|
||
@Override | ||
public String toString() { | ||
return value; | ||
} | ||
} |
92 changes: 92 additions & 0 deletions
92
...ons-updater/src/main/java/com/eternalcode/commons/updater/impl/ModrinthUpdateChecker.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
package com.eternalcode.commons.updater.impl; | ||
|
||
import com.eternalcode.commons.Lazy; | ||
import com.eternalcode.commons.updater.UpdateChecker; | ||
import com.eternalcode.commons.updater.UpdateResult; | ||
import com.eternalcode.commons.updater.Version; | ||
import java.net.URI; | ||
import java.net.http.HttpClient; | ||
import java.net.http.HttpRequest; | ||
import java.net.http.HttpResponse; | ||
import java.time.Duration; | ||
import org.json.JSONArray; | ||
import org.json.JSONException; | ||
import org.json.JSONObject; | ||
|
||
public final class ModrinthUpdateChecker implements UpdateChecker { | ||
|
||
private static final String API_BASE_URL = "https://api.modrinth.com/v2"; | ||
private static final String MODRINTH_BASE_URL = "https://modrinth.com/plugin"; | ||
private static final String USER_AGENT = "UpdateChecker/1.0"; | ||
private static final Duration TIMEOUT = Duration.ofSeconds(10); | ||
|
||
private final Lazy<HttpClient> client = new Lazy<>(() -> HttpClient.newBuilder().connectTimeout(TIMEOUT).build()); | ||
|
||
@Override | ||
public UpdateResult check(String projectId, Version currentVersion) { | ||
if (projectId == null || projectId.trim().isEmpty()) { | ||
throw new IllegalArgumentException("Project ID cannot be null or empty"); | ||
} | ||
|
||
try { | ||
String url = API_BASE_URL + "/project/" + projectId + "/version"; | ||
|
||
HttpRequest request = | ||
HttpRequest.newBuilder().uri(URI.create(url)).header("User-Agent", USER_AGENT).timeout(TIMEOUT).build(); | ||
|
||
HttpResponse<String> response = this.client.get().send(request, HttpResponse.BodyHandlers.ofString()); | ||
|
||
if (response.statusCode() != 200) { | ||
return createEmptyResult(currentVersion); | ||
} | ||
|
||
String json = response.body(); | ||
if (json == null || json.trim().isEmpty()) { | ||
return createEmptyResult(currentVersion); | ||
} | ||
|
||
return parseVersionResponse(json, currentVersion, projectId); | ||
} | ||
catch (Exception exception) { | ||
throw new RuntimeException("Failed to check Modrinth updates for project: " + projectId, exception); | ||
} | ||
} | ||
|
||
private UpdateResult parseVersionResponse(String json, Version currentVersion, String projectId) { | ||
try { | ||
JSONArray versions = new JSONArray(json); | ||
|
||
if (versions.isEmpty()) { | ||
return createEmptyResult(currentVersion); | ||
} | ||
|
||
JSONObject latestVersionObj = versions.getJSONObject(0); | ||
|
||
String versionNumber = latestVersionObj.optString("version_number", null); | ||
if (versionNumber == null || versionNumber.trim().isEmpty()) { | ||
return createEmptyResult(currentVersion); | ||
} | ||
|
||
String downloadUrl = null; | ||
if (latestVersionObj.has("files")) { | ||
JSONArray files = latestVersionObj.getJSONArray("files"); | ||
if (!files.isEmpty()) { | ||
JSONObject firstFile = files.getJSONObject(0); | ||
downloadUrl = firstFile.optString("url", null); | ||
} | ||
} | ||
|
||
String releaseUrl = MODRINTH_BASE_URL + "/" + projectId + "/version/" + versionNumber; | ||
Version latestVersion = new Version(versionNumber); | ||
|
||
return new UpdateResult(currentVersion, latestVersion, downloadUrl, releaseUrl); | ||
} | ||
catch (JSONException exception) { | ||
return createEmptyResult(currentVersion); | ||
} | ||
} | ||
|
||
private UpdateResult createEmptyResult(Version currentVersion) { | ||
return new UpdateResult(currentVersion, currentVersion, null, null); | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.