[SSHOC-423] Proper encoding of URIs in concepts. Removed utilityclass…

… (experimental lombok feature) from MatcherUtils.
SSHOC · Aug 6, 2024 · 10eebef · 10eebef
1 parent efd5342
commit 10eebef
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 11 deletions.
diff --git a/src/main/java/eu/sshopencloud/marketplace/validators/vocabularies/ConceptFactory.java b/src/main/java/eu/sshopencloud/marketplace/validators/vocabularies/ConceptFactory.java
@@ -7,12 +7,18 @@
 import eu.sshopencloud.marketplace.repositories.vocabularies.ConceptRepository;
 import eu.sshopencloud.marketplace.validators.ValidationException;
 import lombok.RequiredArgsConstructor;
+import lombok.extern.log4j.Log4j;
+import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 import org.springframework.validation.BeanPropertyBindingResult;
 import org.springframework.validation.Errors;
+import org.springframework.web.util.UriUtils;
 
+import java.net.URLDecoder;
+import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Locale;
@@ -22,6 +28,7 @@
 @Service
 @Transactional
 @RequiredArgsConstructor
+@Slf4j
 public class ConceptFactory {
 
     private final ConceptRepository conceptRepository;
@@ -62,14 +69,13 @@ public Concept create(ConceptCore conceptCore, Vocabulary vocabulary, String cod
 
         concept.setDefinition(conceptCore.getDefinition());
 
-        if (StringUtils.isBlank(conceptCore.getUri())) {
-            concept.setUri(vocabulary.getNamespace() + concept.getCode());
+        if (StringUtils.isNotBlank(conceptCore.getUri()) &&
+                !StringUtils.equals(conceptCore.getUri(), vocabulary.getNamespace() + concept.getCode()) &&
+                !StringUtils.equals(conceptCore.getUri(), vocabulary.getNamespace() + URLEncoder.encode(concept.getCode(), StandardCharsets.UTF_8))) {
+            errors.rejectValue("uri", "field.invalid",
+                    "Uri is not consistent with vocabulary namespace and concept code.");
         } else {
-            if (conceptCore.getUri().equals(vocabulary.getNamespace() + concept.getCode())) {
-                concept.setUri(conceptCore.getUri());
-            } else {
-                errors.rejectValue("uri", "field.invalid", "Uri is not consistent with vocabulary namespace and concept code.");
-            }
+            concept.setUri(vocabulary.getNamespace() + (isURLEncoded(concept.getCode()) ? concept.getCode() : UriUtils.encode(concept.getCode(), StandardCharsets.UTF_8)));
         }
 
         if (errors.hasErrors())
@@ -78,6 +84,20 @@ public Concept create(ConceptCore conceptCore, Vocabulary vocabulary, String cod
         return concept;
     }
 
+    private boolean isURLEncoded(String code) {
+        try {
+            String decoded = UriUtils.decode(code, StandardCharsets.UTF_8);
+            String reEncoded = UriUtils.encode(decoded, StandardCharsets.UTF_8);
+            if (code.equals(reEncoded)) {
+                return true;
+            }
+        } catch (IllegalArgumentException e) {
+            log.debug(e.getMessage());
+            return false;
+        }
+        return false;
+    }
+
     public List<ConceptRelatedConcept> createConceptRelations(Concept concept, List<RelatedConceptCore> relatedConcepts) throws ValidationException {
 
         BeanPropertyBindingResult errors = new BeanPropertyBindingResult(relatedConcepts, "Concept");

diff --git a/...st/java/eu/sshopencloud/marketplace/controllers/vocabularies/ConceptControllerITCase.java b/...st/java/eu/sshopencloud/marketplace/controllers/vocabularies/ConceptControllerITCase.java
@@ -127,7 +127,7 @@ public void shouldCreateNewCandidateConcept() throws Exception {
                 .andExpect(jsonPath("$.code", is("New Candidate")))
                 .andExpect(jsonPath("$.label", is("New candidate concept")))
                 .andExpect(jsonPath("$.candidate", is(true)))
-                .andExpect(jsonPath("$.uri", is("http://purl.org/ontology/bibo/New Candidate")))
+                .andExpect(jsonPath("$.uri", is("http://purl.org/ontology/bibo/New%20Candidate")))
                 .andExpect(jsonPath("$.relatedConcepts[0].code", is("Journal")))
                 .andExpect(jsonPath("$.relatedConcepts[1].code", is("Book")))
                 .andExpect(jsonPath("$.relatedConcepts[2].code", is("Conference")));
@@ -447,7 +447,7 @@ public void shouldDeleteAndCreateConcept() throws Exception {
                 .andExpect(jsonPath("$.code", is("New Candidate")))
                 .andExpect(jsonPath("$.label", is("New candidate concept")))
                 .andExpect(jsonPath("$.candidate", is(true)))
-                .andExpect(jsonPath("$.uri", is("http://purl.org/ontology/bibo/New Candidate")))
+                .andExpect(jsonPath("$.uri", is("http://purl.org/ontology/bibo/New%20Candidate")))
                 .andExpect(jsonPath("$.relatedConcepts[0].code", is("Journal")))
                 .andExpect(jsonPath("$.relatedConcepts[1].code", is("Conference")));
 

diff --git a/src/test/java/eu/sshopencloud/marketplace/util/MatcherUtils.java b/src/test/java/eu/sshopencloud/marketplace/util/MatcherUtils.java
@@ -6,10 +6,9 @@
 import org.hamcrest.TypeSafeMatcher;
 
 
-@UtilityClass
 public class MatcherUtils {
 
-    public Matcher<Number> equalValue(long value) {
+    public static Matcher<Number> equalValue(long value) {
         return new TypeSafeMatcher<>() {
             @Override
             protected boolean matchesSafely(Number item) {