Tweaks TextManager storage structure

Author: Ghost-chu

pom.xml

@@ -309,7 +309,6 @@
                 <excludes>
                     <exclude>src/main/resources/bin</exclude>
                     <exclude>src/main/resources/lang</exclude>
-                    <exclude>src/main/resources/lang-original</exclude>
                 </excludes>
             </resource>
             <resource>
@@ -322,11 +321,6 @@
                 <filtering>false</filtering>
                 <directory>src/main/resources/lang</directory>
             </resource>
-            <resource>
-                <targetPath>lang-original</targetPath>
-                <filtering>false</filtering>
-                <directory>src/main/resources/lang-original</directory>
-            </resource>
         </resources>
     </build>
 

src/main/java/org/maxgamer/quickshop/util/language/text/TextManager.java

@@ -1,6 +1,7 @@
 package org.maxgamer.quickshop.util.language.text;
 
 import com.dumptruckman.bukkit.configuration.json.JsonConfiguration;
+import lombok.SneakyThrows;
 import org.apache.commons.io.IOUtils;
 import org.bukkit.Bukkit;
 import org.bukkit.command.CommandSender;
@@ -49,15 +50,19 @@ public TextManager(QuickShop plugin) {
     /**
      * Generate the override files storage path
      *
-     * @param crowdinPath The crowdin file path
+     * @param path The distribution file path
      * @return Override files storage path
      */
+    @SneakyThrows
     @NotNull
-    private File getOverrideFilesFolder(@NotNull String crowdinPath) {
-        File file = new File(crowdinPath);
-        File folder = new File(new File(plugin.getDataFolder(), "overrides"), file.getName() + ".overrides");
-        folder.mkdirs();
-        return folder;
+    private File getOverrideFilesFolder(@NotNull String path) {
+        File file = new File(path);
+        String module = file.getParentFile().getName();
+        File moduleFolder = new File(new File(plugin.getDataFolder(), "overrides"), module);
+        moduleFolder.mkdirs();
+        File fileFolder = new File(moduleFolder,file.getName());
+        fileFolder.mkdirs();
+        return file;
     }
 
     /**
@@ -78,7 +83,7 @@ private JsonConfiguration loadBundled(String file) {
         JsonConfiguration bundledLang = new JsonConfiguration();
         try {
             File fileObject = new File(file);
-            bundledLang.loadFromString(new String(IOUtils.toByteArray(new InputStreamReader(plugin.getResource("lang-original/" + fileObject.getName())), StandardCharsets.UTF_8)));
+            bundledLang.loadFromString(new String(IOUtils.toByteArray(new InputStreamReader(plugin.getResource("lang/" + fileObject.getName())), StandardCharsets.UTF_8)));
         } catch (IOException | InvalidConfigurationException ex) {
             bundledLang = new JsonConfiguration();
             plugin.getLogger().log(Level.SEVERE, "Cannot load bundled language file from Jar, some strings may missing!", ex);
@@ -127,7 +132,13 @@ public void load() {
         postProcessors.add(new ColorProcessor());
     }
 
-    private boolean localeEnabled(String locale, List<String> regex){
+    /**
+     * Gets specific locale status
+     * @param locale The locale
+     * @param regex The regexes
+     * @return The locale enabled status
+     */
+    private boolean localeEnabled(@NotNull String locale, @NotNull List<String> regex){
         for (String languagesRegex : regex) {
             try {
                 if (locale.matches(languagesRegex)) {
@@ -140,7 +151,12 @@ private boolean localeEnabled(String locale, List<String> regex){
         return false;
     }
 
-    private void applyOverrideConfiguration(JsonConfiguration distributionConfiguration, JsonConfiguration overrideConfiguration) {
+    /**
+     * Merge override data into distribution configuration to override texts
+     * @param distributionConfiguration The configuration that from distribution (will override it)
+     * @param overrideConfiguration The configuration that from local
+     */
+    private void applyOverrideConfiguration(@NotNull JsonConfiguration distributionConfiguration, @NotNull JsonConfiguration overrideConfiguration) {
         for (String key : overrideConfiguration.getKeys(true)) {
             if ("language-version".equals(key) || "config-version".equals(key) || "version".equals(key)) {
                 continue;
@@ -149,7 +165,14 @@ private void applyOverrideConfiguration(JsonConfiguration distributionConfigurat
         }
     }
 
-    private JsonConfiguration getDistributionConfiguration(String distributionFile, String distributionCode) throws Exception {
+    /**
+     * Getting configuration from distribution platform
+     * @param distributionFile Distribution path
+     * @param distributionCode Locale code on distribution platform
+     * @return The configuration
+     * @throws Exception Any errors when getting it
+     */
+    private JsonConfiguration getDistributionConfiguration(@NotNull String distributionFile, @NotNull String distributionCode) throws Exception {
         JsonConfiguration configuration = new JsonConfiguration();
         try {
             // Load the locale file from local cache if available
@@ -162,7 +185,15 @@ private JsonConfiguration getDistributionConfiguration(String distributionFile,
         return configuration;
     }
 
-    private JsonConfiguration getOverrideConfiguration(String overrideFile, String locale) throws IOException, InvalidConfigurationException {
+    /**
+     * Getting user's override configuration for specific distribution path
+     * @param overrideFile The distribution
+     * @param locale the locale
+     * @return The override configuration
+     * @throws IOException IOException
+     * @throws InvalidConfigurationException File invalid
+     */
+    private JsonConfiguration getOverrideConfiguration(@NotNull String overrideFile, @NotNull String locale) throws IOException, InvalidConfigurationException {
         File localOverrideFile = new File(getOverrideFilesFolder(overrideFile), locale + ".json");
         if (!localOverrideFile.exists()) {
             localOverrideFile.getParentFile().mkdirs();

src/main/java/org/maxgamer/quickshop/util/language/text/TextMapper.java

@@ -12,41 +12,76 @@ public class TextMapper {
     private final Map<String, Map<String, JsonConfiguration>> locale2ContentMapping = new HashMap<>();
     private final Map<String, JsonConfiguration> bundledFile2ContentMapping = new HashMap<>();
 
+    /**
+     * Reset TextMapper
+     */
     public void reset(){
         this.locale2ContentMapping.clear();
         this.bundledFile2ContentMapping.clear();
     }
 
+    /**
+     * Deploy new locale to TextMapper with cloud values and bundle values
+     * @param distributionPath Distribution Path
+     * @param locale The locale code
+     * @param distribution The values from Distribution platform
+     * @param bundled The values from bundled file
+     */
     public void deploy(@NotNull String distributionPath, @NotNull String locale, @NotNull JsonConfiguration distribution, @NotNull JsonConfiguration bundled){
         this.bundledFile2ContentMapping.put(distributionPath,bundled);
         this.locale2ContentMapping.computeIfAbsent(distributionPath,e->new HashMap<>());
         this.locale2ContentMapping.get(distributionPath).put(locale,distribution);
     }
 
+    /**
+     * Remove all locales data under specific distribution path
+     * @param distributionPath The distribution path
+     */
     public void remove(@NotNull String distributionPath){
         this.bundledFile2ContentMapping.remove(distributionPath);
         this.locale2ContentMapping.remove(distributionPath);
     }
-
+    /**
+     * Remove specific locales data under specific distribution path
+     * @param distributionPath The distribution path
+     * @param locale The locale
+     */
     public void remove(@NotNull String distributionPath, @NotNull String locale){
         if(this.locale2ContentMapping.containsKey(distributionPath)){
             this.locale2ContentMapping.get(distributionPath).remove(locale);
         }
     }
 
+    /**
+     * Remove specific bundled data
+     * @param distributionPath The distribution path
+     */
     public void removeBundled(@NotNull String distributionPath){
         this.bundledFile2ContentMapping.remove(distributionPath);
     }
 
-
+    /**
+     * Getting specific bundled data
+     * @param distributionPath The distribution path
+     * @return The bundled data, null if never deployed
+     */
     public @Nullable JsonConfiguration getBundled(@NotNull String distributionPath){
         return this.bundledFile2ContentMapping.get(distributionPath);
     }
-
+    /**
+     * Getting locales data under specific distribution data
+     * @param distributionPath The distribution path
+     * @return The locales data, empty if never deployed
+     */
     public @NotNull Map<String,JsonConfiguration> getDistribution(@NotNull String distributionPath){
         return this.locale2ContentMapping.getOrDefault(distributionPath, Collections.emptyMap());
     }
-
+    /**
+     * Getting specific locale data under specific distribution data
+     * @param distributionPath The distribution path
+     * @param locale The specific locale
+     * @return The locale data, null if never deployed
+     */
     public @Nullable JsonConfiguration getDistribution(@NotNull String distributionPath, @NotNull String locale){
         return this.getDistribution(distributionPath).get(locale);
     }