Add lang file updates on version change (#5072)

Author: APickledWalrus

src/main/java/ch/njol/skript/Skript.java

@@ -1218,12 +1218,11 @@ public static Collection<SkriptAddon> getAddons() {
 	 * @return A {@link SkriptAddon} representing Skript.
 	 */
 	public static SkriptAddon getAddonInstance() {
-		final SkriptAddon a = addon;
-		if (a == null)
-			return addon = new SkriptAddon(Skript.getInstance())
-					.setLanguageFileDirectory("lang");
-		else
-			return a;
+		if (addon == null) {
+			addon = new SkriptAddon(Skript.getInstance());
+			addon.setLanguageFileDirectory("lang");
+		}
+		return addon;
 	}
 
 	// ================ CONDITIONS & EFFECTS & SECTIONS ================

src/main/java/ch/njol/skript/config/Config.java

@@ -186,6 +186,17 @@ public boolean setValues(final Config other) {
 	public boolean setValues(final Config other, final String... excluded) {
 		return getMainNode().setValues(other.getMainNode(), excluded);
 	}
+
+	/**
+	 * Compares the keys and values of this Config and another.
+	 * @param other The other Config.
+	 * @param excluded Keys to exclude from this comparison.
+	 * @return True if there are differences in the keys and their values
+	 *  of this Config and the other Config.
+	 */
+	public boolean compareValues(Config other, String... excluded) {
+		return getMainNode().compareValues(other.getMainNode(), excluded);
+	}
 
 	@Nullable
 	public File getFile() {

src/main/java/ch/njol/skript/config/SectionNode.java

@@ -446,45 +446,80 @@ HashMap<String, String> toMap(final String prefix, final String separator) {
 		}
 		return r;
 	}
-	
+
 	/**
-	 * @param other
-	 * @param excluded keys and sections to exclude
-	 * @return <tt>false</tt> if this and the other SectionNode contain the exact same set of keys
+	 * Updates the values of this SectionNode based on the values of another SectionNode.
+	 * @param other The other SectionNode.
+	 * @param excluded Keys to exclude from this update.
+	 * @return True if there are differences in the keys of this SectionNode and the other SectionNode.
 	 */
-	public boolean setValues(final SectionNode other, final String... excluded) {
-		boolean r = false;
-		for (final Node n : this) {
-			if (CollectionUtils.containsIgnoreCase(excluded, n.key))
+	public boolean setValues(SectionNode other, String... excluded) {
+		return modify(other, false, excluded);
+	}
+
+	/**
+	 * Compares the keys and values of this SectionNode and another.
+	 * @param other The other SectionNode.
+	 * @param excluded Keys to exclude from this comparison.
+	 * @return True if there are no differences in the keys and their values
+	 *  of this SectionNode and the other SectionNode.
+	 */
+	public boolean compareValues(SectionNode other, String... excluded) {
+		return !modify(other, true, excluded); // invert as "modify" returns true if different
+	}
+
+	private boolean modify(SectionNode other, boolean compareValues, String... excluded) {
+		boolean different = false;
+
+		for (Node node : this) {
+			if (CollectionUtils.containsIgnoreCase(excluded, node.key))
 				continue;
-			final Node o = other.get(n.key);
-			if (o == null) {
-				r = true;
-			} else {
-				if (n instanceof SectionNode) {
-					if (o instanceof SectionNode) {
-						r |= ((SectionNode) n).setValues((SectionNode) o);
-					} else {
-						r = true;
+
+			Node otherNode = other.get(node.key);
+			if (otherNode != null) { // other has this key
+				if (node instanceof SectionNode) {
+					if (otherNode instanceof SectionNode) {
+						different |= ((SectionNode) node).modify((SectionNode) otherNode, compareValues);
+					} else { // Our node type is different from the old one
+						different = true;
+						if (compareValues) // Counting values means we don't need to copy over values
+							break;
 					}
-				} else if (n instanceof EntryNode) {
-					if (o instanceof EntryNode) {
-						((EntryNode) n).setValue(((EntryNode) o).getValue());
-					} else {
-						r = true;
+				} else if (node instanceof EntryNode) {
+					if (otherNode instanceof EntryNode) {
+						String ourValue = ((EntryNode) node).getValue();
+						String theirValue = ((EntryNode) otherNode).getValue();
+						if (compareValues) {
+							if (!ourValue.equals(theirValue)) {
+								different = true;
+								break; // Counting values means we don't need to copy over values
+							}
+						} else { // If we don't care about values, just copy over the old one
+							((EntryNode) node).setValue(theirValue);
+						}
+					} else { // Our node type is different from the old one
+						different = true;
+						if (compareValues) // Counting values means we don't need to copy over values
+							break;
 					}
 				}
+			} else { // other is missing this key (which means we have a new key)
+				different = true;
+				if (compareValues) // Counting values means we don't need to copy over values
+					break;
 			}
 		}
-		if (!r) {
-			for (final Node o : other) {
-				if (this.get(o.key) == null) {
-					r = true;
+
+		if (!different) {
+			for (Node otherNode : other) {
+				if (this.get(otherNode.key) == null) {
+					different = true;
 					break;
 				}
 			}
 		}
-		return r;
+
+		return different;
 	}
 
 }

src/main/java/ch/njol/skript/localization/Language.java

@@ -22,6 +22,7 @@
 import ch.njol.skript.SkriptAddon;
 import ch.njol.skript.config.Config;
 import ch.njol.skript.util.ExceptionUtils;
+import ch.njol.skript.util.FileUtils;
 import ch.njol.skript.util.Version;
 import org.bukkit.plugin.Plugin;
 import org.eclipse.jdt.annotation.Nullable;
@@ -197,8 +198,8 @@ public static void loadDefault(SkriptAddon addon) {
 				englishIs = null;
 			}
 		}
-		HashMap<String, String> def = load(defaultIs, "default");
-		HashMap<String, String> en = load(englishIs, "english");
+		HashMap<String, String> def = load(defaultIs, "default", false);
+		HashMap<String, String> en = load(englishIs, "english", addon == Skript.getAddonInstance());
 
 		String v = def.get("version");
 		if (v == null)
@@ -220,9 +221,9 @@ public static boolean load(String name) {
 		name = "" + name.toLowerCase(Locale.ENGLISH);
 
 		localizedLanguage = new HashMap<>();
-		boolean exists = load(Skript.getAddonInstance(), name);
+		boolean exists = load(Skript.getAddonInstance(), name, true);
 		for (SkriptAddon addon : Skript.getAddons()) {
-			exists |= load(addon, name);
+			exists |= load(addon, name, false);
 		}
 		if (!exists) {
 			if (name.equals("english")) {
@@ -241,18 +242,18 @@ public static boolean load(String name) {
 		return true;
 	}
 
-	private static boolean load(SkriptAddon addon, String name) {
+	private static boolean load(SkriptAddon addon, String name, boolean tryUpdate) {
 		if (addon.getLanguageFileDirectory() == null)
 			return false;
 		// Backwards addon compatibility
 		if (name.equals("english") && addon.plugin.getResource(addon.getLanguageFileDirectory() + "/default.lang") == null)
 			return true;
 
-		HashMap<String, String> l = load(addon.plugin.getResource(addon.getLanguageFileDirectory() + "/" + name + ".lang"), name);
+		HashMap<String, String> l = load(addon.plugin.getResource(addon.getLanguageFileDirectory() + "/" + name + ".lang"), name, tryUpdate);
 		File file = new File(addon.plugin.getDataFolder(), addon.getLanguageFileDirectory() + File.separator + name + ".lang");
 		try {
 			if (file.exists())
-				l.putAll(load(new FileInputStream(file), name));
+				l.putAll(load(new FileInputStream(file), name, tryUpdate));
 		} catch (FileNotFoundException e) {
 			assert false;
 		}
@@ -289,11 +290,38 @@ private static boolean load(SkriptAddon addon, String name) {
 		return true;
 	}
 
-	private static HashMap<String, String> load(@Nullable InputStream in, String name) {
+	private static HashMap<String, String> load(@Nullable InputStream in, String name, boolean tryUpdate) {
 		if (in == null)
 			return new HashMap<>();
+
 		try {
-			return new Config(in, name + ".lang", false, false, ":").toMap(".");
+			Config langConfig = new Config(in, name + ".lang", false, false, ":");
+
+			if (tryUpdate && !Skript.getVersion().toString().equals(langConfig.get("version"))) {
+				String langFileName = "lang/" + name + ".lang";
+
+				InputStream newConfigIn = Skript.getInstance().getResource(langFileName);
+				if (newConfigIn == null) {
+					Skript.error("The lang file '" + name + ".lang' is outdated, but Skript couldn't find the newest version of it in its jar.");
+					return new HashMap<>();
+				}
+				Config newLangConfig = new Config(newConfigIn, "Skript.jar/" + langFileName, false, false, ":");
+				newConfigIn.close();
+
+				File langFile = new File(Skript.getInstance().getDataFolder(), langFileName);
+				if (!newLangConfig.compareValues(langConfig, "version")) {
+					File langFileBackup = FileUtils.backup(langFile);
+					newLangConfig.getMainNode().set("version", Skript.getVersion().toString());
+					langConfig = newLangConfig;
+					langConfig.save(langFile);
+					Skript.info("The lang file '" + name + ".lang' has been updated to the latest version. A backup of your old lang file has been created as " + langFileBackup.getName());
+				} else { // Only the version changed, don't bother creating a backup
+					langConfig.getMainNode().set("version", Skript.getVersion().toString());
+					langConfig.save(langFile);
+				}
+			}
+
+			return langConfig.toMap(".");
 		} catch (IOException e) {
 			//noinspection ThrowableNotThrown
 			Skript.exception(e, "Could not load the language file '" + name + ".lang': " + ExceptionUtils.toString(e));