EpicKnarvik97/Stargate
2
0
Fork 0
Code Issues 7 Pull Requests Projects 1 Releases 27 Wiki Activity

Cleans up message logging quite a bit

Browse Source 
Adds methods to Stargate for easier logging and less redundancy
Loads the language loader in two parts to make it available while loading
Adds a translated string to the reload-message
Uses String.format to make long messages more readable
Makes it possible to get strings directly from the backup language to make debugging easier
This commit is contained in:
Kristian Knarvik
2021-10-26 15:05:05 +02:00
parent eaf7596014
commit 1c906528f2
22 changed files with 154 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/main/java/net/knarcraft/stargate/config/EconomyConfig.java
View File

@ -242,12 +242,10 @@ public final class EconomyConfig {
this.vault = vault;
return true;
} else {
Stargate.getConsoleLogger().info(Stargate.getString("prefix") +
Stargate.getString("ecoLoadError"));
Stargate.logInfo(Stargate.getString("ecoLoadError"));
}
} else {
Stargate.getConsoleLogger().info(Stargate.getString("prefix") +
Stargate.getString("vaultLoadError"));
Stargate.logInfo(Stargate.getString("vaultLoadError"));
}
economyEnabled = false;
return false;

68
src/main/java/net/knarcraft/stargate/config/LanguageLoader.java
View File

@ -25,30 +25,27 @@ public final class LanguageLoader {
/**
* Instantiates a new language loader
*
* <p>This will only load the backup language. Set the chosen language and reload afterwards.</p>
*
* @param languageFolder <p>The folder containing the language files</p>
* @param chosenLanguage <p>The chosen plugin language</p>
*/
public LanguageLoader(String languageFolder, String chosenLanguage) {
this.chosenLanguage = chosenLanguage;
public LanguageLoader(String languageFolder) {
this.languageFolder = languageFolder;
File tmp = new File(languageFolder, chosenLanguage + ".txt");
if (!tmp.exists()) {
if (tmp.getParentFile().mkdirs() && Stargate.getStargateConfig().isDebuggingEnabled()) {
Stargate.getConsoleLogger().info("[stargate] Created language folder");
File testFile = new File(languageFolder, "en.txt");
if (!testFile.exists()) {
if (testFile.getParentFile().mkdirs()) {
Stargate.debug("LanguageLoader", "Created language folder");
}
}
updateLanguage(chosenLanguage);
loadedStringTranslations = load(chosenLanguage);
//Load english as backup language in case the chosen language is missing newly added text strings
InputStream inputStream = FileHelper.getInputStreamForInternalFile("/lang/en.txt");
if (inputStream != null) {
loadedBackupStrings = load("en", inputStream);
} else {
loadedBackupStrings = null;
Stargate.getConsoleLogger().severe("[stargate] Error loading backup language. There may be missing " +
"text in-game");
Stargate.getConsoleLogger().severe("[stargate] Error loading backup language. " +
"There may be missing text in-game");
}
}
@ -56,7 +53,7 @@ public final class LanguageLoader {
* Reloads languages from the files on disk
*/
public void reload() {
// This extracts/updates the language as needed
//Extracts/Updates the language as needed
updateLanguage(chosenLanguage);
loadedStringTranslations = load(chosenLanguage);
}
@ -72,7 +69,21 @@ public final class LanguageLoader {
if (loadedStringTranslations != null) {
value = loadedStringTranslations.get(name);
}
if (value == null && loadedBackupStrings != null) {
if (value == null) {
value = getBackupString(name);
}
return value;
}
/**
* Gets the string to display given its name/key
*
* @param name <p>The name/key of the string to display</p>
* @return <p>The string in the backup language (English)</p>
*/
public String getBackupString(String name) {
String value = null;
if (loadedBackupStrings != null) {
value = loadedBackupStrings.get(name);
}
if (value == null) {
@ -96,17 +107,13 @@ public final class LanguageLoader {
* @param language <p>The language to update</p>
*/
private void updateLanguage(String language) {
// Load the current language file
Map<String, String> currentLanguageValues = load(language);
InputStream inputStream = getClass().getResourceAsStream("/lang/" + language + ".txt");
if (inputStream == null) {
Stargate.getConsoleLogger().info("[stargate] The language " + language + " is not available. Falling " +
"back to english, You can add a custom language by creating a new text file in the lang directory.");
if (Stargate.getStargateConfig().isDebuggingEnabled()) {
Stargate.getConsoleLogger().info("[stargate] Unable to load /lang/" + language + ".txt");
}
Stargate.logInfo(String.format("The language %s is not available. Falling back to english, You can add a " +
"custom language by creating a new text file in the lang directory.", language));
Stargate.debug("LanguageLoader::updateLanguage", String.format("Unable to load /lang/%s.txt", language));
return;
}
@ -134,7 +141,7 @@ public final class LanguageLoader {
//If currentLanguageValues is null; the chosen language has not been used before
if (currentLanguageValues == null) {
updateLanguageFile(language, internalLanguageValues, null);
Stargate.getConsoleLogger().info("[stargate] Language (" + language + ") has been loaded");
Stargate.logInfo(String.format("Language (%s) has been loaded", language));
return;
}
@ -155,8 +162,7 @@ public final class LanguageLoader {
//Update the file itself
if (updateNecessary) {
updateLanguageFile(language, newLanguageValues, currentLanguageValues);
Stargate.getConsoleLogger().info("[stargate] Your language file (" + language +
".txt) has been updated");
Stargate.logInfo(String.format("Your language file (%s.txt) has been updated", language));
}
}
}
@ -218,7 +224,7 @@ public final class LanguageLoader {
strings = FileHelper.readKeyValuePairs(bufferedReader);
} catch (Exception e) {
if (Stargate.getStargateConfig().isDebuggingEnabled()) {
Stargate.getConsoleLogger().info("[stargate] Unable to load language " + lang);
Stargate.getConsoleLogger().info("[Stargate] Unable to load language " + lang);
}
return null;
}
@ -229,15 +235,17 @@ public final class LanguageLoader {
* Prints debug output to the console for checking loaded language strings/translations
*/
public void debug() {
Set<String> keys = loadedStringTranslations.keySet();
for (String key : keys) {
Stargate.debug("LanguageLoader::Debug::loadedStringTranslations", key + " => " +
loadedStringTranslations.get(key));
if (loadedStringTranslations != null) {
Set<String> keys = loadedStringTranslations.keySet();
for (String key : keys) {
Stargate.debug("LanguageLoader::Debug::loadedStringTranslations", key + " => " +
loadedStringTranslations.get(key));
}
}
if (loadedBackupStrings == null) {
return;
}
keys = loadedBackupStrings.keySet();
Set<String> keys = loadedBackupStrings.keySet();
for (String key : keys) {
Stargate.debug("LanguageLoader::Debug::loadedBackupStrings", key + " => " +
loadedBackupStrings.get(key));

18
src/main/java/net/knarcraft/stargate/config/StargateConfig.java
View File

@ -32,11 +32,10 @@ public final class StargateConfig {
private StargateGateConfig stargateGateConfig;
private MessageSender messageSender;
public LanguageLoader languageLoader;
public final LanguageLoader languageLoader;
private EconomyConfig economyConfig;
private final Logger logger;
private final String languageFolder;
private final String dataFolderPath;
private String gateFolder;
private String portalFolder;
@ -56,7 +55,7 @@ public final class StargateConfig {
dataFolderPath = Stargate.stargate.getDataFolder().getPath().replaceAll("\\\\", "/");
portalFolder = dataFolderPath + "/portals/";
gateFolder = dataFolderPath + "/gates/";
languageFolder = dataFolderPath + "/lang/";
languageLoader = new LanguageLoader(dataFolderPath + "/lang/");
this.loadConfig();
@ -70,8 +69,10 @@ public final class StargateConfig {
* Finish the config setup by loading languages, gates and portals, and loading economy if vault is loaded
*/
public void finishSetup() {
//Load the translated strings before they're used by loadGates
languageLoader = new LanguageLoader(languageFolder, languageName);
//Set the chosen language and reload the language loader
languageLoader.setChosenLanguage(languageName);
languageLoader.reload();
messageSender = new MessageSender(languageLoader);
if (debuggingEnabled) {
languageLoader.debug();
@ -132,7 +133,7 @@ public final class StargateConfig {
startStopBungeeListener(stargateGateConfig.enableBungee());
}
messageSender.sendErrorMessage(sender, "stargate reloaded");
messageSender.sendErrorMessage(sender, languageLoader.getString("reloaded"));
}
/**
@ -309,7 +310,7 @@ public final class StargateConfig {
*/
public void loadGates() {
GateHandler.loadGates(gateFolder);
logger.info(Stargate.getString("prefix") + "Loaded " + GateHandler.getGateCount() + " gate layouts");
Stargate.logInfo(String.format("Loaded %s gate layouts", GateHandler.getGateCount()));
}
/**
@ -358,8 +359,7 @@ public final class StargateConfig {
EconomyConfig economyConfig = getEconomyConfig();
if (economyConfig.setupEconomy(Stargate.getPluginManager()) && economyConfig.getEconomy() != null) {
String vaultVersion = economyConfig.getVault().getDescription().getVersion();
logger.info(Stargate.getString("prefix") + Stargate.replaceVars(
Stargate.getString("vaultLoaded"), "%version%", vaultVersion));
Stargate.logInfo(Stargate.replaceVars(Stargate.getString("vaultLoaded"), "%version%", vaultVersion));
}
}

5
src/main/java/net/knarcraft/stargate/config/StargateGateConfig.java
View File

@ -4,8 +4,6 @@ import net.knarcraft.stargate.Stargate;
import org.bukkit.ChatColor;
import org.bukkit.configuration.file.FileConfiguration;
import static net.knarcraft.stargate.Stargate.getString;
/**
* The Stargate gate config keeps track of all global config values related to gates
*/
@ -181,8 +179,7 @@ public final class StargateGateConfig {
} catch (IllegalArgumentException | NullPointerException ignored) {
}
}
Stargate.getConsoleLogger().warning(getString("prefix") +
"You have specified an invalid color in your config.yml. Defaulting to BLACK");
Stargate.logWarning("You have specified an invalid color in your config.yml. Defaulting to BLACK");
this.signColor = ChatColor.BLACK;
}