Autoupdate (#191)

Co-authored-by: NopoTheGamer <40329022+NopoTheGamer@users.noreply.github.com>

4 files changed, 545 insertions, 0 deletions

diff --git a/src/main/java/io/github/moulberry/notenoughupdates/miscfeatures/updater/AutoUpdater.java b/src/main/java/io/github/moulberry/notenoughupdates/miscfeatures/updater/AutoUpdater.java
new file mode 100644
index 00000000..7869225d
--- /dev/null
+++ b/src/main/java/io/github/moulberry/notenoughupdates/miscfeatures/updater/AutoUpdater.java
@@ -0,0 +1,257 @@
+/*
+ * Copyright (C) 2022 NotEnoughUpdates contributors
+ *
+ * This file is part of NotEnoughUpdates.
+ *
+ * NotEnoughUpdates is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * NotEnoughUpdates is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with NotEnoughUpdates. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package io.github.moulberry.notenoughupdates.miscfeatures.updater;
+
+import com.google.common.collect.Iterables;
+import com.google.gson.JsonArray;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonPrimitive;
+import com.google.gson.JsonSyntaxException;
+import io.github.moulberry.notenoughupdates.NotEnoughUpdates;
+import io.github.moulberry.notenoughupdates.util.NotificationHandler;
+import io.github.moulberry.notenoughupdates.util.Utils;
+import net.minecraft.client.Minecraft;
+import net.minecraft.client.gui.FontRenderer;
+import net.minecraft.event.ClickEvent;
+import net.minecraft.event.HoverEvent;
+import net.minecraft.util.ChatComponentText;
+import net.minecraft.util.ChatStyle;
+import net.minecraft.util.EnumChatFormatting;
+import net.minecraft.util.IChatComponent;
+import net.minecraftforge.fml.common.Loader;
+import org.apache.commons.lang3.SystemUtils;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.Arrays;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipFile;
+
+public class AutoUpdater {
+
+	NotEnoughUpdates neu;
+
+	public AutoUpdater(NotEnoughUpdates neu) {
+		this.neu = neu;
+	}
+
+	public void logProgress(String str) {
+		logProgress(new ChatComponentText(str));
+	}
+
+	public void logProgress(IChatComponent chatComponent) {
+		Minecraft.getMinecraft().addScheduledTask(() -> {
+			IChatComponent chatComponent1 = new ChatComponentText("");
+			chatComponent1.setChatStyle(new ChatStyle().setColor(EnumChatFormatting.AQUA));
+			chatComponent1.appendSibling(chatComponent);
+			Minecraft.getMinecraft().thePlayer.addChatMessage(new ChatComponentText("§e[NEU-AutoUpdater] ").appendSibling(
+				chatComponent1));
+		});
+	}
+
+	public UpdateLoader getUpdateLoader(URL url) {
+		if (SystemUtils.IS_OS_UNIX) {
+			return new LinuxBasedUpdater(this, url);
+		}
+		if (Loader.isModLoaded("skyblockclientupdater") && SCUCompatUpdater.IS_ENABLED) {
+			return SCUCompatUpdater.tryCreate(this, url);
+		}
+		return null;
+	}
+
+	UpdateLoader updateLoader;
+
+	public void updateFromURL(URL url) {
+		if (updateLoader != null) {
+			logProgress(
+				"There is already an update in progress, so the auto updater cannot process this update (as it might already be installed or is currently being downloaded). Please restart your client to install another update");
+			return;
+		}
+		if (!"https".equals(url.getProtocol())) {
+			logProgress("§cInvalid protocol in url: " + url + ". Only https is a valid protocol.");
+			return;
+		}
+		updateLoader = getUpdateLoader(url);
+		if (updateLoader == null) {
+			logProgress(new ChatComponentText(
+				"Your system does not support auto updates. Please download this update manually. Click here to read more about auto update compatibility (or the link above for manual downloads)")
+				.setChatStyle(
+					new ChatStyle()
+						.setChatHoverEvent(new HoverEvent(
+							HoverEvent.Action.SHOW_TEXT,
+							new ChatComponentText("Click here to read about auto update modalities")
+						))
+						.setChatClickEvent(new ClickEvent(ClickEvent.Action.RUN_COMMAND, "/neuupdate updatemodes"))
+				));
+			return;
+		}
+		updateLoader.greet();
+		logProgress(new ChatComponentText("[Start download now]")
+			.setChatStyle(new ChatStyle()
+				.setColor(EnumChatFormatting.GREEN)
+				.setChatHoverEvent(new HoverEvent(
+					HoverEvent.Action.SHOW_TEXT,
+					new ChatComponentText("Click to start download.")
+				))
+				.setChatClickEvent(new ClickEvent(
+					ClickEvent.Action.RUN_COMMAND,
+					"/neuupdate scheduleDownload"
+				))));
+	}
+
+	public void scheduleDownload() {
+		if (updateLoader == null) {
+			logProgress("§cNo update found. Try running /neuupdate check first");
+			return;
+		}
+		if (updateLoader.getState() != UpdateLoader.State.NOTHING) {
+			logProgress("§cUpdate download already started. No need to start the download again.");
+			return;
+		}
+		logProgress("Download started.");
+		updateLoader.scheduleDownload();
+	}
+
+	private void displayUpdateMessage(
+		JsonObject updateJson,
+		String updateMessage,
+		String downloadLink,
+		String directDownload
+	) {
+		int firstWidth = -1;
+
+		for (String line : Iterables.concat(Arrays.asList(updateMessage.split("\n")), Arrays.asList("Download here"))) {
+			FontRenderer fr = Minecraft.getMinecraft().fontRendererObj;
+			boolean isDownloadLink = line.equals("Download here");
+			int width = fr.getStringWidth(line);
+			if (firstWidth == -1) {
+				firstWidth = width;
+			}
+			int missingLen = firstWidth - width;
+			if (missingLen > 0) {
+				StringBuilder sb = new StringBuilder(missingLen / 4 / 2 + line.length());
+				for (int i = 0; i < missingLen / 4 / 2; i++) { /* fr.getCharWidth(' ') == 4 */
+					sb.append(" ");
+				}
+				sb.append(line);
+				line = sb.toString();
+			}
+			ChatComponentText cp = new ChatComponentText(line);
+			if (isDownloadLink)
+				cp.setChatStyle(Utils.createClickStyle(ClickEvent.Action.OPEN_URL, downloadLink));
+			Minecraft.getMinecraft().thePlayer.addChatMessage(cp);
+		}
+		neu.displayLinks(updateJson, firstWidth);
+		NotificationHandler.displayNotification(Arrays.asList(
+			"",
+			"§eThere is a new version of NotEnoughUpdates available.",
+			"§eCheck the chat for more information"
+		), true);
+		try {
+			if (directDownload != null)
+				updateFromURL(new URL(directDownload));
+		} catch (MalformedURLException e) {
+			e.printStackTrace();
+		}
+	}
+
+	public void displayUpdateMessageIfOutOfDate() {
+		File repo = neu.manager.repoLocation;
+		if (repo.exists()) {
+			File updateJson = new File(repo, "update.json");
+			try {
+				JsonObject o = neu.manager.getJsonFromFile(updateJson);
+
+				int fullReleaseVersion =
+					o.has("version_id") && o.get("version_id").isJsonPrimitive() ? o.get("version_id").getAsInt() : -1;
+				int preReleaseVersion =
+					o.has("version_id") && o.get("version_id").isJsonPrimitive() ? o.get("version_id").getAsInt() : -1;
+				int hotfixVersion =
+					o.has("hotfix_id") && o.get("hotfix_id").isJsonPrimitive() ? o.get("hotfix_id").getAsInt() : -1;
+
+				boolean hasFullReleaseAvailableForUpgrade = fullReleaseVersion > NotEnoughUpdates.VERSION_ID;
+				boolean hasHotfixAvailableForUpgrade =
+					fullReleaseVersion == NotEnoughUpdates.VERSION_ID && hotfixVersion > NotEnoughUpdates.HOTFIX_VERSION_ID;
+				boolean hasPreReleaseAvailableForUpdate =
+					fullReleaseVersion == NotEnoughUpdates.VERSION_ID && preReleaseVersion > NotEnoughUpdates.PRE_VERSION_ID;
+
+				int updateChannel = NotEnoughUpdates.INSTANCE.config.notifications.updateChannel; /* 1 = Full, 2 = Pre */
+				if (hasFullReleaseAvailableForUpgrade || (hasHotfixAvailableForUpgrade && updateChannel == 1)) {
+					displayUpdateMessage(
+						o,
+						o.get("update_msg").getAsString(),
+						o.get("update_link").getAsString(),
+						o.has("update_direct") ? o.get("update_direct").getAsString() : null
+					);
+				} else if (hasPreReleaseAvailableForUpdate && updateChannel == 2) {
+					displayUpdateMessage(
+						o,
+						o.get("pre_update_msg").getAsString(),
+						o.get("pre_update_link").getAsString(),
+						o.has("pre_update_direct") ? o.get("pre_update_direct").getAsString() : null
+					);
+				}
+			} catch (Exception e) {
+				e.printStackTrace();
+				Minecraft.getMinecraft().thePlayer.addChatMessage(new ChatComponentText(
+					"§e[NEU] §cThere has been an error checking for updates. Check the log or join the discord for more information.").setChatStyle(
+					Utils.createClickStyle(
+						ClickEvent.Action.OPEN_URL, "https://discord.gg/moulberry")));
+			}
+		}
+	}
+
+	private boolean validateMcModInfo(JsonArray array) {
+		if (array.size() != 1) return false;
+		JsonElement jsonElement = array.get(0);
+		if (!jsonElement.isJsonObject()) return false;
+		JsonObject jsonObject = jsonElement.getAsJsonObject();
+		if (!jsonObject.has("modid")) return false;
+		JsonElement modid = jsonObject.get("modid");
+		if (!modid.isJsonPrimitive()) return false;
+		JsonPrimitive primitive = modid.getAsJsonPrimitive();
+		if (!primitive.isString()) return false;
+		return "notenoughupdates".equals(primitive.getAsString());
+	}
+
+	public boolean isNeuJar(File sus) {
+		try (ZipFile zipFile = new ZipFile(sus)) {
+			ZipEntry entry = zipFile.getEntry("mcmod.info");
+			if (entry == null) {
+				return false;
+			}
+			try (InputStream inputStream = zipFile.getInputStream(entry)) {
+				JsonArray jsonArray = neu.manager.gson.fromJson(
+					new InputStreamReader(inputStream),
+					JsonArray.class
+				);
+				return validateMcModInfo(jsonArray);
+			}
+		} catch (IOException | JsonSyntaxException e) {
+			e.printStackTrace();
+		}
+		return false;
+	}
+}
diff --git a/src/main/java/io/github/moulberry/notenoughupdates/miscfeatures/updater/LinuxBasedUpdater.java b/src/main/java/io/github/moulberry/notenoughupdates/miscfeatures/updater/LinuxBasedUpdater.java
new file mode 100644
index 00000000..3118b135
--- /dev/null
+++ b/src/main/java/io/github/moulberry/notenoughupdates/miscfeatures/updater/LinuxBasedUpdater.java
@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2022 NotEnoughUpdates contributors
+ *
+ * This file is part of NotEnoughUpdates.
+ *
+ * NotEnoughUpdates is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * NotEnoughUpdates is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with NotEnoughUpdates. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package io.github.moulberry.notenoughupdates.miscfeatures.updater;
+
+import java.io.File;
+import java.net.URL;
+import java.util.List;
+
+class LinuxBasedUpdater /* Based on what? */ extends UpdateLoader {
+
+	LinuxBasedUpdater(AutoUpdater updater, URL url) {
+		super(updater, url);
+	}
+
+	@Override
+	public void greet() {
+		updater.logProgress(
+			"Welcome Aristocrat! Your superior linux system configuration is supported for NEU auto updates.");
+	}
+
+	@Override
+	public void deleteFiles(List<File> toDelete) {
+		for (File toDel : toDelete) {
+			if (!toDel.delete()) {
+				updater.logProgress("§cCould not delete old version of NEU: " + toDel + ". Please manually delete file.");
+				state = State.FAILED;
+			}
+		}
+	}
+}
diff --git a/src/main/java/io/github/moulberry/notenoughupdates/miscfeatures/updater/SCUCompatUpdater.java b/src/main/java/io/github/moulberry/notenoughupdates/miscfeatures/updater/SCUCompatUpdater.java
new file mode 100644
index 00000000..3cb600cb
--- /dev/null
+++ b/src/main/java/io/github/moulberry/notenoughupdates/miscfeatures/updater/SCUCompatUpdater.java
@@ -0,0 +1,100 @@
+/*
+ * Copyright (C) 2022 NotEnoughUpdates contributors
+ *
+ * This file is part of NotEnoughUpdates.
+ *
+ * NotEnoughUpdates is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * NotEnoughUpdates is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with NotEnoughUpdates. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package io.github.moulberry.notenoughupdates.miscfeatures.updater;
+
+import java.io.File;
+import java.lang.invoke.MethodHandle;
+import java.lang.invoke.MethodHandles;
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import java.net.URL;
+import java.util.List;
+
+/*
+ * Legal considerations: Skyblock Client Updater is licensed under the GNU AGPL v3.0 or later (with modifications).
+ * https://github.com/My-Name-Is-Jeff/SkyblockClient-Updater/blob/main/LICENSE
+ *
+ * However, even tho the AGPL License does not allow conveying covered work in combination with LGPL licensed code
+ * (such as our own), we do not perceive ourselves as conveying neither an unmodified version of Skyblock Client Updater
+ * nor a work based on Skyblock Client Updater (modified work) since our work is usable and functional in its entirety
+ * without presence of Skyblock Client Updater and is not to be distributed along a copy of Skyblock Client Updater
+ * unless that combined work is licensed with respect of both the LGPL and the AGPL, therefore is not adapting any part
+ * of Skyblock Client Updater unless already part of a whole distribution.
+ *
+ * In case the Copyright owner (Lily aka My-Name-Is-Jeff on Github) disagrees, we are willing to take down this module
+ * (or only convey this component of our work under a pure GPL license) with or without them providing legal grounds
+ * for this request. However, due to them not being able to be reached for comment, we will include this
+ * component for the time being.
+ * */
+public class SCUCompatUpdater extends UpdateLoader {
+
+	public static final boolean IS_ENABLED = false;
+
+	private SCUCompatUpdater(AutoUpdater updater, URL url) {
+		super(updater, url);
+	}
+
+	@Override
+	public void greet() {
+		updater.logProgress("Skyblock Client Updater compatibility layer loaded.");
+	}
+
+	@Override
+	public void deleteFiles(List<File> toDelete) {
+		try {
+			for (File f : toDelete)
+				ReflectionHolder.deleteFileOnShutdownHandle.invoke(ReflectionHolder.updateCheckerInstance, f, "");
+		} catch (Throwable e) {
+			e.printStackTrace();
+			updater.logProgress("Invoking SCU failed. Check the log for more info.");
+			state = State.FAILED;
+		}
+	}
+
+	static class ReflectionHolder {
+		static boolean isSCUFullyPresent = false;
+		static Class<?> updateChecker;
+		static Object updateCheckerInstance;
+		static Method deleteFileOnShutdown;
+		static MethodHandle deleteFileOnShutdownHandle;
+
+		static {
+			try {
+				updateChecker = Class.forName("mynameisjeff.skyblockclientupdater.utils.UpdateChecker");
+				Field instanceField = updateChecker.getDeclaredField("INSTANCE");
+				instanceField.setAccessible(true);
+				updateCheckerInstance = instanceField.get(null);
+				deleteFileOnShutdown = updateChecker.getDeclaredMethod("deleteFileOnShutdown", File.class, String.class);
+				deleteFileOnShutdownHandle = MethodHandles.publicLookup().unreflect(deleteFileOnShutdown);
+				isSCUFullyPresent = true;
+			} catch (NoSuchFieldException | ClassNotFoundException | IllegalAccessException | NoSuchMethodException e) {
+				e.printStackTrace();
+			}
+		}
+	}
+
+	public static UpdateLoader tryCreate(AutoUpdater updater, URL url) {
+		if (!ReflectionHolder.isSCUFullyPresent) {
+			updater.logProgress("§cFound Skyclient Updater Mod, however our hooks did not function properly.");
+			return null;
+		}
+		return new SCUCompatUpdater(updater, url);
+	}
+}
diff --git a/src/main/java/io/github/moulberry/notenoughupdates/miscfeatures/updater/UpdateLoader.java b/src/main/java/io/github/moulberry/notenoughupdates/miscfeatures/updater/UpdateLoader.java
new file mode 100644
index 00000000..1a1a8504
--- /dev/null
+++ b/src/main/java/io/github/moulberry/notenoughupdates/miscfeatures/updater/UpdateLoader.java
@@ -0,0 +1,141 @@
+/*
+ * Copyright (C) 2022 NotEnoughUpdates contributors
+ *
+ * This file is part of NotEnoughUpdates.
+ *
+ * NotEnoughUpdates is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * NotEnoughUpdates is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with NotEnoughUpdates. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package io.github.moulberry.notenoughupdates.miscfeatures.updater;
+
+import io.github.moulberry.notenoughupdates.util.NetUtils;
+import net.minecraft.client.Minecraft;
+import org.apache.commons.io.IOUtils;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.net.URL;
+import java.nio.file.Files;
+import java.util.ArrayList;
+import java.util.List;
+
+abstract class UpdateLoader {
+
+	enum State {
+		NOTHING, DOWNLOAD_STARTED, DOWNLOAD_FINISHED, INSTALLED, FAILED
+	}
+
+	URL url;
+	AutoUpdater updater;
+
+	State state = State.NOTHING;
+
+	UpdateLoader(AutoUpdater updater, URL url) {
+		this.url = url;
+		this.updater = updater;
+	}
+
+	public State getState() {
+		return state;
+	}
+
+	public void setState(State state) {
+		this.state = state;
+	}
+
+	public URL getUrl() {
+		return url;
+	}
+
+	public void scheduleDownload() {
+		state = State.DOWNLOAD_STARTED;
+		try {
+			NetUtils.downloadAsync(url, File.createTempFile("NotEnoughUpdates-update", ".jar"))
+							.handle(
+								(f, exc) -> {
+									if (exc != null) {
+										state = State.FAILED;
+										updater.logProgress("§cError while downloading. Check your logs for more info.");
+										exc.printStackTrace();
+										return null;
+									}
+									state = State.DOWNLOAD_FINISHED;
+
+									updater.logProgress("Download completed. Trying to install");
+									launchUpdate(f);
+									return null;
+								});
+		} catch (IOException e) {
+			state = State.FAILED;
+			updater.logProgress("§cError while creating download. Check your logs for more info.");
+			e.printStackTrace();
+		}
+	}
+
+	public abstract void greet();
+
+	public void launchUpdate(File file) {
+
+		if (state != State.DOWNLOAD_FINISHED) {
+			updater.logProgress("§cUpdate is invalid state " + state + " to start update.");
+			state = State.FAILED;
+			return;
+		}
+		File mcDataDir = new File(Minecraft.getMinecraft().mcDataDir, "mods");
+		if (!mcDataDir.exists() || !mcDataDir.isDirectory() || !mcDataDir.canRead()) {
+			updater.logProgress("§cCould not find mods folder. Searched: " + mcDataDir);
+			state = State.FAILED;
+			return;
+		}
+		ArrayList<File> toDelete = new ArrayList<>();
+		File[] modFiles = mcDataDir.listFiles();
+		if (modFiles == null) {
+			updater.logProgress("§cCould not list minecraft mod folder (" + mcDataDir + ")");
+			state = State.FAILED;
+			return;
+		}
+		for (File sus : modFiles) {
+			if (sus.getName().endsWith(".jar")) {
+				if (updater.isNeuJar(sus)) {
+					updater.logProgress("Found old NEU file: " + sus + ". Deleting later.");
+					toDelete.add(sus);
+				}
+			}
+		}
+		File dest = new File(mcDataDir, file.getName());
+		try (
+			InputStream i = Files.newInputStream(file.toPath());
+			OutputStream o = Files.newOutputStream(dest.toPath());
+		) {
+			IOUtils.copyLarge(i, o);
+		} catch (IOException e) {
+			e.printStackTrace();
+			updater.logProgress(
+				"§cFailed to copy release JAR. Not making any changes to your mod folder. Consult your logs for more info.");
+			state = State.FAILED;
+		}
+		deleteFiles(toDelete);
+		if (state != State.FAILED) {
+			state = State.INSTALLED;
+			updater.logProgress("Update successful. Thank you for your time.");
+			return;
+		}
+		updater.logProgress("§cFailure to delete some files. Please delte the old NEU version manually from your mods folder.");
+	}
+
+	public abstract void deleteFiles(List<File> toDelete);
+
+}