[kbss-cvut/termit-ui#581] Modify REST API to support term translation…

…s import.

src/main/java/cz/cvut/kbss/termit/rest/VocabularyController.java

@@ -235,12 +235,22 @@ public ResponseEntity<Void> createVocabulary(
                        example = ApiDoc.ID_NAMESPACE_EXAMPLE)
             @RequestParam(name = QueryParams.NAMESPACE,
                           required = false) Optional<String> namespace,
-            @Parameter(description = "File containing a SKOS glossary in RDF.")
-            @RequestParam(name = "file") MultipartFile file) {
+            @Parameter(
+                    description = "File containing a SKOS glossary in RDF or an Excel file with supported structure.")
+            @RequestParam(name = "file") MultipartFile file,
+            @Parameter(description = "Whether to import only translations of existing terms from the vocabulary.")
+            @RequestParam(name = "translationsOnly", required = false,
+                          defaultValue = "false") boolean translationsOnly) {
         final URI vocabularyIri = resolveVocabularyUri(localName, namespace);
-        final Vocabulary vocabulary = vocabularyService.importVocabulary(vocabularyIri, file);
-        LOG.debug("Vocabulary {} re-imported.", vocabulary);
-        return ResponseEntity.created(locationWithout(generateLocation(vocabulary.getUri()), "/import/" + localName))
+        final Vocabulary result;
+        if (translationsOnly) {
+            result = vocabularyService.importTermTranslations(vocabularyIri, file);
+            LOG.debug("Translations of terms in vocabulary {} imported.", result);
+        } else {
+            result = vocabularyService.importVocabulary(vocabularyIri, file);
+            LOG.debug("Vocabulary {} re-imported.", result);
+        }
+        return ResponseEntity.created(locationWithout(generateLocation(result.getUri()), "/import/" + localName))
                              .build();
     }
 
@@ -310,13 +320,14 @@ public List<AbstractChangeRecord> getDetailedHistoryOfContent(
                        example = ApiDoc.ID_NAMESPACE_EXAMPLE) @RequestParam(name = QueryParams.NAMESPACE,
                                                                             required = false) Optional<String> namespace,
             @Parameter(description = ChangeRecordFilterDto.ApiDoc.TERM_NAME_DESCRIPTION) @RequestParam(name = "term",
-                                                                                         required = false,
-                                                                                         defaultValue = "") String termName,
+                                                                                                       required = false,
+                                                                                                       defaultValue = "") String termName,
             @Parameter(description = ChangeRecordFilterDto.ApiDoc.CHANGE_TYPE_DESCRIPTION) @RequestParam(name = "type",
-                                                                                           required = false) URI changeType,
-            @Parameter(description = ChangeRecordFilterDto.ApiDoc.AUTHOR_NAME_DESCRIPTION) @RequestParam(name = "author",
-                                                                                           required = false,
-                                                                                           defaultValue = "") String authorName,
+                                                                                                         required = false) URI changeType,
+            @Parameter(description = ChangeRecordFilterDto.ApiDoc.AUTHOR_NAME_DESCRIPTION) @RequestParam(
+                    name = "author",
+                    required = false,
+                    defaultValue = "") String authorName,
             @Parameter(description = ChangeRecordFilterDto.ApiDoc.CHANGED_ATTRIBUTE_DESCRIPTION) @RequestParam(
                     name = "attribute", required = false, defaultValue = "") String changedAttributeName,
 
@@ -327,7 +338,8 @@ public List<AbstractChangeRecord> getDetailedHistoryOfContent(
                     name = Constants.QueryParams.PAGE, required = false, defaultValue = DEFAULT_PAGE) Integer pageNo) {
         final Pageable pageReq = createPageRequest(pageSize, pageNo);
         final Vocabulary vocabulary = vocabularyService.getReference(resolveVocabularyUri(localName, namespace));
-        final ChangeRecordFilterDto filter = new ChangeRecordFilterDto(termName, changedAttributeName, authorName, changeType);
+        final ChangeRecordFilterDto filter = new ChangeRecordFilterDto(termName, changedAttributeName, authorName,
+                                                                       changeType);
         return vocabularyService.getDetailedHistoryOfContent(vocabulary, filter, pageReq);
     }
 

src/main/java/cz/cvut/kbss/termit/service/business/VocabularyService.java

@@ -281,6 +281,19 @@ public Vocabulary importVocabulary(URI vocabularyIri, MultipartFile file) {
         return repositoryService.importVocabulary(vocabularyIri, file);
     }
 
+    /**
+     * Imports translations of terms in the specified vocabulary from the specified file.
+     * @param vocabularyIri IRI of vocabulary for whose terms to import translations
+     * @param file File from which to import the translations
+     * @return The imported vocabulary metadata
+     * @throws cz.cvut.kbss.termit.exception.importing.VocabularyImportException If the import fails
+     */
+    @PreAuthorize("@vocabularyAuthorizationService.canModify(#vocabularyIri)")
+    public Vocabulary importTermTranslations(URI vocabularyIri, MultipartFile file) {
+        // TODO
+        return null;
+    }
+
     /**
      * Gets an Excel template file that can be used to import terms into TermIt.
      *

src/main/java/cz/cvut/kbss/termit/service/document/TermOccurrenceResolver.java

@@ -31,7 +31,6 @@
 import java.net.URI;
 import java.util.Collections;
 import java.util.List;
-import java.util.function.Consumer;
 
 /**
  * Base class for resolving term occurrences in an annotated document.
@@ -50,7 +49,7 @@ protected TermOccurrenceResolver(TermRepositoryService termService) {
      * Parses the specified input into some abstract representation from which new terms and term occurrences can be
      * extracted.
      * <p>
-     * Note that this method has to be called before calling {@link #findTermOccurrences(Consumer)}.
+     * Note that this method has to be called before calling {@link #findTermOccurrences(OccurrenceConsumer)}.
      *
      * @param input  The input to parse
      * @param source Original source of the input. Used for term occurrence generation

src/main/java/cz/cvut/kbss/termit/service/security/authorization/VocabularyAuthorizationService.java

@@ -165,6 +165,12 @@ public boolean canRead(VocabularyDto dto) {
         return canRead(new Vocabulary(dto.getUri()));
     }
 
+    public boolean canModify(URI vocabularyIri) {
+        Objects.requireNonNull(vocabularyIri);
+        final Vocabulary vocabulary = new Vocabulary(vocabularyIri);
+        return canModify(vocabulary);
+    }
+
     @Override
     public boolean canModify(Vocabulary asset) {
         Objects.requireNonNull(asset);

src/test/java/cz/cvut/kbss/termit/rest/VocabularyControllerTest.java

@@ -442,7 +442,7 @@ void getHistoryReturnsListOfChangeRecordsForSpecifiedVocabulary() throws Excepti
                 });
         assertNotNull(result);
         assertEquals(records, result);
-        verify(serviceMock).getChanges(vocabulary,emptyFilter);
+        verify(serviceMock).getChanges(vocabulary, emptyFilter);
     }
 
     @Test
@@ -653,15 +653,18 @@ void getDetailedHistoryOfContentReturnsListOfChangeRecordsWhenNoFilterIsSpecifie
         final int pageSize = Integer.parseInt(VocabularyController.DEFAULT_PAGE_SIZE);
         final Vocabulary vocabulary = generateVocabularyAndInitReferenceResolution();
         final Term term = Generator.generateTermWithId();
-        final List<AbstractChangeRecord> changeRecords = IntStream.range(0, 5).mapToObj(i -> Generator.generateChangeRecords(term, user)).flatMap(List::stream).toList();
+        final List<AbstractChangeRecord> changeRecords = IntStream.range(0, 5).mapToObj(
+                i -> Generator.generateChangeRecords(term, user)).flatMap(List::stream).toList();
         final ChangeRecordFilterDto filter = new ChangeRecordFilterDto();
         final Pageable pageable = Pageable.ofSize(pageSize);
 
         doReturn(changeRecords).when(serviceMock).getDetailedHistoryOfContent(vocabulary, filter, pageable);
 
-        final MvcResult mvcResult = mockMvc.perform(get(PATH + "/" + FRAGMENT + "/history-of-content/detail")).andExpect(status().isOk()).andReturn();
+        final MvcResult mvcResult = mockMvc.perform(get(PATH + "/" + FRAGMENT + "/history-of-content/detail"))
+                                           .andExpect(status().isOk()).andReturn();
         final List<AbstractChangeRecord> result =
-                readValue(mvcResult, new TypeReference<List<AbstractChangeRecord>>() {});
+                readValue(mvcResult, new TypeReference<>() {
+                });
         assertNotNull(result);
         assertEquals(changeRecords, result);
         verify(serviceMock).getDetailedHistoryOfContent(vocabulary, filter, pageable);
@@ -673,9 +676,33 @@ void getLanguagesRetrievesAndReturnsListOfLanguagesUsedInVocabulary() throws Exc
         final List<String> languages = List.of(Environment.LANGUAGE, "cs", "de");
         when(serviceMock.getLanguages(VOCABULARY_URI)).thenReturn(languages);
 
-        final MvcResult mvcResult = mockMvc.perform(get(PATH + "/" + FRAGMENT + "/languages").queryParam(QueryParams.NAMESPACE, NAMESPACE)).andReturn();
-        final List<String> result = readValue(mvcResult, new TypeReference<List<String>>() {});
+        final MvcResult mvcResult = mockMvc.perform(
+                get(PATH + "/" + FRAGMENT + "/languages").queryParam(QueryParams.NAMESPACE, NAMESPACE)).andReturn();
+        final List<String> result = readValue(mvcResult, new TypeReference<>() {
+        });
         assertEquals(languages, result);
         verify(serviceMock).getLanguages(VOCABULARY_URI);
     }
+
+    @Test
+    void reImportVocabularyRunsTermTranslationsImportForUploadedFileWhenTranslationsOnlyIsSpecified() throws Exception {
+        when(configMock.getNamespace().getVocabulary()).thenReturn(NAMESPACE);
+        final Vocabulary vocabulary = Generator.generateVocabulary();
+        vocabulary.setUri(URI.create(NAMESPACE + FRAGMENT));
+        when(idResolverMock.resolveIdentifier(NAMESPACE, FRAGMENT)).thenReturn(vocabulary.getUri());
+        when(serviceMock.importTermTranslations(any(URI.class), any())).thenReturn(vocabulary);
+        final MockMultipartFile upload = new MockMultipartFile("file", "vocabulary.xlsx",
+                                                               Constants.MediaType.EXCEL,
+                                                               Environment.loadFile("data/import-simple-en-cs.xlsx"));
+        final MvcResult mvcResult = mockMvc.perform(multipart(PATH + "/" + FRAGMENT + "/import").file(upload)
+                                                                                                .queryParam(
+                                                                                                        "translationsOnly",
+                                                                                                        "true"))
+                                           .andExpect(status().isCreated())
+                                           .andReturn();
+        verifyLocationEquals(PATH + "/" + FRAGMENT, mvcResult);
+        assertThat(mvcResult.getResponse().getHeader(HttpHeaders.LOCATION),
+                   containsString(QueryParams.NAMESPACE + "=" + NAMESPACE));
+        verify(serviceMock).importTermTranslations(vocabulary.getUri(), upload);
+    }
 }