Merge pull request #65 from salesforce/fix-validator

yoikawa · web-flow · commit 0b284dfdbd9a · 2025-03-05T22:29:14.000+09:00
fix LabelValidator to return more detail
diff --git a/src/main/java/com/force/i18n/LocaleUtils.java b/src/main/java/com/force/i18n/LocaleUtils.java
@@ -1,14 +1,15 @@
-/* 
+/*
  * Copyright (c) 2017, salesforce.com, inc.
  * All rights reserved.
- * Licensed under the BSD 3-Clause license. 
+ * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root  or https://opensource.org/licenses/BSD-3-Clause
  */
 
 package com.force.i18n;
 
 import java.util.List;
 import java.util.Locale;
+import java.util.Locale.LanguageRange;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 
@@ -60,29 +61,34 @@ public Locale getLocaleFromDbString(String value) {
         return getLocaleByIsoCode(value);
     }
 
-     /**
-      * HTTP and Java do not use the same locale stuff
-      * HTTP would say "de-de", but Java would want "de_DE".  This handles those kinds of
-      * weirdness things  (like "de-de;q=0.8")
-      * @param str the HTTP language input
-      * @return the java locale from the http language input.  
-      */
-     public Locale getLocaleFromHttpInput(String str) {
-         if ("*".equals(str)) return null;  // Invalid
-         int semiIndex = str.indexOf(';');
-         String locale = str;
-         if (semiIndex > 0) {
-             // We have a "quality" rating.  Ignore it.  It's useless
-             locale = str.substring(0,semiIndex);
-         }
-         // OK, we should have "de" or "de-de";
-         if (locale.length() == 2) {
-             return new Locale.Builder().setLanguage(locale.toLowerCase()).build();
-         } else if (locale.length() == 5) {
-             if (locale.charAt(2) != '-') return null;
-             return new Locale.Builder().setLanguage(locale.substring(0,2).toLowerCase()).setRegion(locale.substring(3,5).toUpperCase()).build();
-         } else {
-             return null;
-         }
-     }
+    /**
+     * Parses an "Accept-Language" header value as defined in
+     * <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-accept-language">RFC 9110</a> and returns the first
+     * value.
+     *
+     * <p>HTTP and Java handle locales differently. For example, HTTP might use {@code "de-de,de;q=0.8"}, while Java expects
+     * "de_DE". This method addresses such discrepancies.
+     *
+     * @param str
+     *            The HTTP language input, which should follow the "language-range" format of the "Accept-Language"
+     *            header as defined in <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-accept-language">RFC
+     *            9110</a>, except for the wildcard '*'. If the wildcard '*' is provided, this method will return
+     *            {@code null}.
+     * @return The Java locale derived from the HTTP language input. If {@code str} contains multiple languages, only
+     *         the first value is considered, and the rest are ignored. Returns {@code null} if an invalid {@code str}
+     *         is provided.
+     */
+    public Locale getLocaleFromHttpInput(String str) {
+        if (str == null || "*".equals(str)) return null; // Invalid
+
+        try {
+            final List<LanguageRange> ranges = Locale.LanguageRange.parse(str);
+            if (ranges != null && !ranges.isEmpty()) {
+                return Locale.forLanguageTag(ranges.get(0).getRange());
+            }
+        } catch (IllegalArgumentException ignore) {
+            // do nothing. let below to return null
+        }
+        return null;
+    }
 }
diff --git a/src/main/java/com/force/i18n/grammar/ArticledDeclension.java b/src/main/java/com/force/i18n/grammar/ArticledDeclension.java
@@ -132,6 +132,18 @@ protected void setString(ArticleForm form, String value) {
             this.value = intern(value);
         }
         @Override
+        public int hashCode() {
+            return Objects.hash(super.hashCode(), this.value);
+        }
+        @Override
+        public boolean equals(Object other) {
+            if (this == other) return true;
+            if (other instanceof SimpleArticle) {
+                return super.equals(other) && Objects.equals(this.value, ((SimpleArticle)other).value);
+            }
+            return false;
+        }
+        @Override
         public boolean validate(String name) {
             if (this.value == null) {
                 HumanLanguage language = this.getDeclension().getLanguage();
diff --git a/src/main/java/com/force/i18n/grammar/parser/GrammaticalLabelFileParser.java b/src/main/java/com/force/i18n/grammar/parser/GrammaticalLabelFileParser.java
@@ -486,7 +486,7 @@ public enum ErrorType {
         public String getMessage(ErrorInfo ref) {
             String ret = (ref.getArguments() == null || ref.getArguments().length == 0) ? errorMessage
                     : MessageFormat.format(errorMessage, ref.getArguments());
-            return (ref == null) ? ret : ret + " at " + ref.toString();
+            return String.format("%s at %s (%s:%d)", ret, ref.toString(), ref.file, ref.lineNumber);
         }
     }
 
@@ -512,5 +512,23 @@ public class ErrorInfo extends LabelRef {
         public String getMessage() {
             return this.type.getMessage(this);
         }
+
+        @Override
+        public int hashCode() {
+            return Objects.hash(super.hashCode(), this.type, this.file, this.lineNumber);
+        }
+
+        @Override
+        public boolean equals(Object other) {
+            if (this == other) return true;
+            if (other instanceof ErrorInfo) {
+                ErrorInfo o = (ErrorInfo)other;
+                return super.equals(other)
+                    && this.type == o.type
+                    && Objects.equals(this.file, o.file)
+                    && this.lineNumber == o.lineNumber;
+            }
+            return false;
+        }
     }
 }
diff --git a/src/main/java/com/force/i18n/grammar/parser/LabelValidator.java b/src/main/java/com/force/i18n/grammar/parser/LabelValidator.java
@@ -1,7 +1,7 @@
-/* 
+/*
  * Copyright (c) 2017, salesforce.com, inc.
  * All rights reserved.
- * Licensed under the BSD 3-Clause license. 
+ * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root  or https://opensource.org/licenses/BSD-3-Clause
  */
 
@@ -17,6 +17,7 @@
 import com.force.i18n.grammar.GrammaticalTerm.TermType;
 import com.force.i18n.grammar.impl.LanguageDeclensionFactory;
 import com.force.i18n.grammar.parser.GrammaticalLabelFileParser.AliasParam;
+import com.force.i18n.grammar.parser.GrammaticalLabelFileParser.ErrorInfo;
 import com.force.i18n.settings.MapPropertyFileData;
 
 /**
@@ -72,11 +73,26 @@ public List<String> getDuplicates(HumanLanguage language) throws IOException {
     }
 
     public List<String> getInvalidLabels(HumanLanguage language) throws Exception {
+        return getInvalidLabels(language, true);
+    }
+
+    /**
+     * Validates labels for the speicified language.
+     *
+     * @param language
+     *            the language to validate labels
+     * @param onlyLabelKeys
+     *            {@code true} to return only the label key that has an error;
+     *            {@code false} to return detailed error information including file name and line number.
+     * @return a list of errors; returns an empty list if no errors are found.
+     * @throws IOException if there was a problem while parsing
+     */
+    public List<String> getInvalidLabels(HumanLanguage language, boolean onlyLabelKeys) throws IOException {
         List<String> result = new ArrayList<>();
         GrammaticalLabelFileParser parser = getParser(language, false);
         if (parser.getInvalidLabels() != null) {
-            for (LabelReference ref : parser.getInvalidLabels()) {
-                result.add(ref.toString());
+            for (ErrorInfo ref : parser.getInvalidLabels()) {
+                result.add(onlyLabelKeys ? ref.toString() : ref.getMessage());
             }
         }
         return result;
@@ -96,12 +112,6 @@ public List<String> validateReferencedCaseFormsExistTest(List<GrammaticalLabelSe
 
             Set<String> inheritedNouns = ls.getDictionary().getAllInheritedTermNames(TermType.Noun);
 
-            // Unwrap the layers of falling back: NOTE, this only works one level deep which is fine for now.
-            GrammaticalLabelSet main = ls;
-            if (main instanceof GrammaticalLabelSetFallbackImpl) {
-                main = ((GrammaticalLabelSetFallbackImpl)main).getOverlay();
-            }
-
             // Iterate through the label set
             for (String section : ls.sectionNames()) {
                 Map<String, Object> sectionMap = ls.getSection(section);
@@ -160,7 +170,7 @@ public String renderLabel(HumanLanguage language, String text) throws IOExceptio
      * @param text the text of the label to parser
      * @param grammarOverride the XML set of terms to add to the label set while testing
      * @return the rendered label
-     * @throws IOException if there is an issue reading from the label set descriptor passed into the constructor 
+     * @throws IOException if there is an issue reading from the label set descriptor passed into the constructor
      */
     public String renderLabel(HumanLanguage language, String text, String grammarOverride) throws IOException {
         return getTestLabelSet(language, text, grammarOverride).getString("Test", "Test");
@@ -193,7 +203,4 @@ LanguageDictionary loadDictionaryNoThrow(GrammaticalLabelSetDescriptor dictDesc)
             throw new RuntimeException(e);
         }
     }
-
-
-
 }
diff --git a/src/test/java/com/force/i18n/LocaleUtilsUnitTest.java b/src/test/java/com/force/i18n/LocaleUtilsUnitTest.java
@@ -1,7 +1,7 @@
-/* 
+/*
  * Copyright (c) 2017, salesforce.com, inc.
  * All rights reserved.
- * Licensed under the BSD 3-Clause license. 
+ * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root  or https://opensource.org/licenses/BSD-3-Clause
  */
 
@@ -41,7 +41,17 @@ public void testGetLocaleByIsoCodeWithLanguageCountry() throws Exception {
     public void testGetLocaleByIsoCodeWithLanguageCountryVariant() throws Exception {
         final String isoCode = "ca_ES_PREEURO";
         final Locale actualLocale = LocaleUtils.get().getLocaleByIsoCode(isoCode);
-        assertEquals("Expected getLocaleByIsoCode to return the Catalan Spain Locale with Euro variant", 
+        assertEquals("Expected getLocaleByIsoCode to return the Catalan Spain Locale with Euro variant",
         new Locale.Builder().setLanguage("ca").setRegion("ES").setVariant("PREEURO").build(), actualLocale);
     }
+
+    public void testGetLocaleFromHttpStrig() {
+        assertNull(LocaleUtils.get().getLocaleFromHttpInput("*"));
+        assertNull(LocaleUtils.get().getLocaleFromHttpInput(""));
+        assertNull(LocaleUtils.get().getLocaleFromHttpInput(null));
+
+        assertEquals(Locale.ENGLISH, LocaleUtils.get().getLocaleFromHttpInput("en"));
+        assertEquals(Locale.ENGLISH, LocaleUtils.get().getLocaleFromHttpInput("en;q=0.8"));
+        assertEquals(Locale.US, LocaleUtils.get().getLocaleFromHttpInput("en-US,en;q=0.8"));
+    }
 }
