Validate language parameter in API services (geonetwork#6673)

* Validate formatters language parameter

* Add LanguageUtils tests

* Update Pages API to validate the language

* Formatters API - accept value 'all' for language parameter

Author: josegar74

services/src/main/java/org/fao/geonet/api/pages/PagesAPI.java

@@ -36,6 +36,7 @@
 import org.fao.geonet.api.exception.ResourceAlreadyExistException;
 import org.fao.geonet.api.exception.ResourceNotFoundException;
 import org.fao.geonet.api.exception.WebApplicationException;
+import org.fao.geonet.api.tools.i18n.LanguageUtils;
 import org.fao.geonet.domain.Profile;
 import org.fao.geonet.domain.page.Page;
 import org.fao.geonet.domain.page.PageIdentity;
@@ -56,6 +57,7 @@
 import java.io.UnsupportedEncodingException;
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 
 @RequestMapping(value = {"/{portal}/api/pages"})
@@ -75,6 +77,9 @@ public class PagesAPI {
     @Autowired
     private PageRepository pageRepository;
 
+    @Autowired
+    private LanguageUtils languageUtils;
+
     @io.swagger.v3.oas.annotations.Operation(
         summary = "Add a new Page object in DRAFT section in status HIDDEN",
         description = "<p>Is not possible to load a link and a file at the same time.</p> <a href='http://geonetwork-opensource.org/manuals/4.0.x/eng/users/user-guide/define-static-pages/define-pages.html'>More info</a>")
@@ -98,6 +103,7 @@ public void addPage(
         @RequestParam(value = "format", required = true) final Page.PageFormat format,
         @Parameter(hidden = true) final HttpServletResponse response) throws ResourceAlreadyExistException {
 
+        checkValidLanguage(language);
 
         checkMandatoryContent(data, link);
 
@@ -141,6 +147,9 @@ public ResponseEntity editPage(
         @RequestParam(value = "link", required = false) final String link,
         @RequestParam(value = "format", required = true) final Page.PageFormat format
     ) throws ResourceNotFoundException {
+
+        checkValidLanguage(language);
+
         checkUniqueContent(data, link);
 
         checkCorrectFormat(data, link, format);
@@ -174,6 +183,10 @@ public void editPageName(
         @RequestParam(value = "newPageId", required = false) final String newPageId,
         @Parameter(hidden = true) final HttpServletResponse response) throws ResourceNotFoundException, ResourceAlreadyExistException {
 
+        checkValidLanguage(language);
+
+        checkValidLanguage(newLanguage);
+
         final Page page = pageRepository.findById(new PageIdentity(language, pageId)).get();
 
         if (page == null) {
@@ -501,6 +514,15 @@ private void checkFileType(final MultipartFile data) {
         }
     }
 
+    private void checkValidLanguage(String language) {
+        if (!languageUtils.getUiLanguages().contains(language)) {
+            throw new IllegalArgumentException(
+                String.format("Language value is not valid: %s. A valid application language is mandatory: %s.",
+                    language,
+                    String.join(",", languageUtils.getUiLanguages())));
+        }
+    }
+
     /**
      * Check permissions on single page and return.
      *

services/src/main/java/org/fao/geonet/api/records/formatters/FormatterApi.java

@@ -108,6 +108,8 @@
 public class FormatterApi extends AbstractFormatService implements ApplicationListener {
     private static final Set<String> ALLOWED_PARAMETERS = Sets.newHashSet("id", "uuid", "xsl", "skippopularity", "hide_withheld");
 
+    private static final String PARAM_LANGUAGE_ALL_VALUES = "all";
+
     @Autowired
     LanguageUtils languageUtils;
 
@@ -243,9 +245,17 @@ public void getRecordFormattedBy(
             formatType = FormatType.xml;
         }
 
-        String language = isoLanguagesMapper.iso639_2T_to_iso639_2B(locale.getISO3Language());
+        String language;
         if (StringUtils.isNotEmpty(iso3lang)) {
-            language = isoLanguagesMapper.iso639_2T_to_iso639_2B(iso3lang);
+            if (PARAM_LANGUAGE_ALL_VALUES.equalsIgnoreCase(iso3lang)) {
+                language = iso3lang;
+            } else if (languageUtils.getUiLanguages().contains(iso3lang)) {
+                language = isoLanguagesMapper.iso639_2T_to_iso639_2B(iso3lang);
+            } else {
+                language = languageUtils.getDefaultUiLanguage();
+            }
+        } else {
+            language = isoLanguagesMapper.iso639_2T_to_iso639_2B(locale.getISO3Language());
         }
 
         AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, servletRequest);

services/src/main/java/org/fao/geonet/api/tools/i18n/LanguageUtils.java

@@ -31,7 +31,9 @@
  * Created by francois on 05/02/16.
  */
 public class LanguageUtils {
+    /* The languages in the UI */
     private final Set<String> iso3code;
+    /* The default application language */
     private final String defaultLanguage;
     Collection<Locale> locales = new ArrayList<>();
 
@@ -70,9 +72,27 @@ public String getIso3langCode(Enumeration<Locale> locales) {
     }
 
     public Locale parseAcceptLanguage(final Locale locale) {
-        Vector<Locale> locales = new Vector<>();
-        locales.add(locale);
+        List<Locale> localesToParse = Collections.singletonList(locale);
 
-        return parseAcceptLanguage(locales.elements());
+        return parseAcceptLanguage(Collections.enumeration(localesToParse));
+    }
+
+
+    /**
+     * Get the default application iso3 code language.
+     *
+     * @return
+     */
+    public String getDefaultUiLanguage() {
+        return defaultLanguage;
+    }
+
+    /**
+     * Get the UI iso3 code languages.
+     *
+     * @return
+     */
+    public Set<String> getUiLanguages() {
+        return iso3code;
     }
 }

services/src/test/java/org/fao/geonet/api/tools/i18n/LanguageUtilsTest.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright (C) 2001-2022 Food and Agriculture Organization of the
+ * United Nations (FAO-UN), United Nations World Food Programme (WFP)
+ * and United Nations Environment Programme (UNEP)
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or (at
+ * your option) any later version.
+ *
+ * This program 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
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ *
+ * Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2,
+ * Rome - Italy. email: [email protected]
+ */
+package org.fao.geonet.api.tools.i18n;
+
+import org.fao.geonet.languages.IsoLanguagesMapper;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+
+import java.util.HashSet;
+import java.util.Locale;
+import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+public class LanguageUtilsTest  {
+    LanguageUtils languageUtils;
+
+    @Before
+    public void setUp() throws Exception {
+        Set<String> localesToLoad = Stream.of("dut", "ger", "eng", "fre")
+            .collect(Collectors.toCollection(HashSet::new));
+
+        languageUtils = new LanguageUtils(localesToLoad, "eng");
+    }
+
+    @Test
+    public void getDefaultLanguage() throws Exception {
+        Assert.assertEquals("eng", languageUtils.getDefaultUiLanguage());
+    }
+
+    @Test
+    public void getUiLanguages() throws Exception {
+        Assert.assertEquals(4, languageUtils.getUiLanguages().size());
+    }
+
+    @Test
+    public void parseAcceptLanguage() throws Exception {
+        Set<String> localesToLoad = Stream.of("dut", "ger", "eng", "fre")
+            .collect(Collectors.toCollection(HashSet::new));
+
+        LanguageUtils languageUtils = new LanguageUtils(localesToLoad, "eng");
+
+        Locale gerLocale = new Locale("de");
+        String iso3lang = languageUtils.parseAcceptLanguage(gerLocale).getISO3Language();
+        Assert.assertEquals("ger", IsoLanguagesMapper.iso639_2T_to_iso639_2B(iso3lang));
+
+        // Get default language as not in the list of supported locales
+        Locale spaLocale = new Locale("es");
+        iso3lang = languageUtils.parseAcceptLanguage(spaLocale).getISO3Language();
+        Assert.assertEquals("eng", IsoLanguagesMapper.iso639_2T_to_iso639_2B(iso3lang));
+    }
+}