Merge branch 'dev'

Author: cgendreau

docs/export_objects.adoc

@@ -25,6 +25,10 @@ To include files in folder(s) it is possible to add the following attributes:
 "exportLayout": { "subfolder/" : ["fileUUID"] }
 ```
 
+It is also possible to use an alternative name (alias) for files:
+```
+"filenameAliases": { "fileUUID" : "myFileAlias" }
+```
 
 == Export processing
 

pom.xml

@@ -5,7 +5,7 @@
 
   <groupId>ca.gc.aafc</groupId>
   <artifactId>object-store.api</artifactId>
-  <version>1.23</version>
+  <version>1.24</version>
   <packaging>jar</packaging>
 
   <name>Object-Store API</name>

src/main/java/ca/gc/aafc/objectstore/api/dto/ObjectExportDto.java

@@ -25,6 +25,7 @@ public class ObjectExportDto {
   private UUID uuid;
 
   private List<UUID> fileIdentifiers;
+  private Map<UUID, String> filenameAliases;
   private Map<String, List<UUID>> exportLayout;
   private String name;
 

src/main/java/ca/gc/aafc/objectstore/api/file/FileController.java

@@ -206,7 +206,7 @@ public ResponseEntity<InputStreamResource> downloadObject(
 
     // For the download of an object use the originalFilename provided (if possible)
     return download(bucket, metadata.getFilename(),
-      ObjectFilenameUtils.generateMainObjectFilename(metadata),
+      ObjectFilenameUtils.generateMainObjectFilename(metadata, null),
         false, metadata.getDcFormat(), metadata);
   }
 
@@ -246,7 +246,7 @@ public ResponseEntity<InputStreamResource> downloadDerivative(
       .orElseThrow(() -> buildNotFoundException(bucket, Objects.toString(fileId)));
 
     return download(bucket, derivative.getFilename(), 
-      ObjectFilenameUtils.generateDerivativeFilename(derivative), true, derivative.getDcFormat(), derivative);
+      ObjectFilenameUtils.generateDerivativeFilename(derivative, null), true, derivative.getDcFormat(), derivative);
   }
 
   @GetMapping("/file/{bucket}/{fileId}/thumbnail")

src/main/java/ca/gc/aafc/objectstore/api/file/ObjectExportGenerator.java

@@ -16,6 +16,7 @@
 import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
 import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;
 import org.apache.commons.io.IOUtils;
+import org.apache.commons.lang3.StringUtils;
 import org.springframework.scheduling.annotation.Async;
 import org.springframework.stereotype.Service;
 
@@ -40,9 +41,11 @@ public ObjectExportGenerator(FileStorage fileStorage) {
 
   @Async(MainConfiguration.DINA_THREAD_POOL_BEAN_NAME)
   public CompletableFuture<UUID> export(UUID exportUUID, List<AbstractObjectStoreMetadata> objectsToExport,
+                                        Map<UUID, String> aliases,
                                         Map<String, List<UUID>> exportLayout, Path zipFile) {
 
     Map<UUID, String> layoutByFileIdentifier = invertExportLayout(exportLayout);
+    Map<UUID, String> filenameAliases = aliases == null ? Map.of() : aliases;
     Map<String, AtomicInteger> filenamesIncluded = new HashMap<>();
 
     try (ArchiveOutputStream<ZipArchiveEntry> o = new ZipArchiveOutputStream(zipFile)) {
@@ -53,7 +56,8 @@ public CompletableFuture<UUID> export(UUID exportUUID, List<AbstractObjectStoreM
 
         // Set zipEntry with information from fileStorage
         ZipArchiveEntry entry =
-          new ZipArchiveEntry(generateExportItemFilename(currObj, layoutByFileIdentifier, filenamesIncluded));
+          new ZipArchiveEntry(generateExportItemFilename(currObj, filenameAliases.get(currObj.getFileIdentifier()),
+            layoutByFileIdentifier.get(currObj.getFileIdentifier()), filenamesIncluded));
         entry.setSize(
           fileInfo.orElseThrow(() -> new IllegalStateException("No FileInfo found")).getLength());
         o.putArchiveEntry(entry);
@@ -79,25 +83,26 @@ public CompletableFuture<UUID> export(UUID exportUUID, List<AbstractObjectStoreM
    * Get a unique (withing the export) filename.
    *
    * @param obj           the data about the file to add
+   * @param filenameAlias use an alternative name for the filename
+   * @param folder        folder to which the file should be stored under
    * @param usedFilenames filenames that are already used with a counter. Will be modified by this function.
    * @return
    */
   private static String generateExportItemFilename(AbstractObjectStoreMetadata obj,
-                                                   Map<UUID, String> layoutByFileIdentifier,
+                                                   String filenameAlias, String folder,
                                                    Map<String, AtomicInteger> usedFilenames) {
     String filename;
-
     if (obj instanceof ObjectStoreMetadata metadata) {
-      filename = ObjectFilenameUtils.generateMainObjectFilename(metadata);
+      filename = ObjectFilenameUtils.generateMainObjectFilename(metadata, filenameAlias);
     } else if (obj instanceof Derivative derivative) {
-      filename = ObjectFilenameUtils.generateDerivativeFilename(derivative);
+      filename = ObjectFilenameUtils.generateDerivativeFilename(derivative, filenameAlias);
     } else {
       filename = obj.getFilename();
     }
 
     // Do we have an export layout to consider ?
-    if (layoutByFileIdentifier.containsKey(obj.getFileIdentifier())) {
-      String folderName = ObjectFilenameUtils.standardizeFolderName(layoutByFileIdentifier.get(obj.getFileIdentifier()));
+    if (StringUtils.isNotBlank(folder)) {
+      String folderName = ObjectFilenameUtils.standardizeFolderName(folder);
       filename = folderName + filename;
     }
 

src/main/java/ca/gc/aafc/objectstore/api/repository/ObjectExportRepository.java

@@ -33,6 +33,7 @@ public <S extends ObjectExportDto> S create(S s) {
       objectExportService.export(ObjectExportService.ExportArgs.builder()
         .username(authenticatedUser.getUsername())
         .fileIdentifiers(s.getFileIdentifiers())
+        .filenameAliases(s.getFilenameAliases())
         .exportLayout(s.getExportLayout())
         .name(s.getName())
         .build());

src/main/java/ca/gc/aafc/objectstore/api/service/ObjectExportService.java

@@ -127,7 +127,8 @@ public UUID export(ExportArgs exportArgs) {
 
     // then complete the export
     CompletableFuture<ExportResult> completableFuture =
-      objectExportGenerator.export(exportUUID, toExport, exportArgs.exportLayout(), zipFile)
+      objectExportGenerator.export(exportUUID, toExport, exportArgs.filenameAliases(),
+          exportArgs.exportLayout(), zipFile)
         .thenApply(uuid -> {
           String toaKey = toaCtrl.registerObject(filename);
           log.info("Generated toaKey {}", () -> toaKey);
@@ -166,11 +167,13 @@ private static void throwIllegalStateFileNotFound(UUID fileIdentifier) throws Il
   /**
    * @param username        the username of the user requesting the export
    * @param fileIdentifiers list of files identifier to export
+   * @param filenameAliases map of fileIdentifier to optional filename alias
    * @param exportLayout    folder structure of the export (optional)
    * @param name            optional name of the export (optional)
    */
   @Builder
   public record ExportArgs(String username, List<UUID> fileIdentifiers,
+                           Map<UUID, String> filenameAliases,
                            Map<String, List<UUID>> exportLayout, String name) {
 
   }

src/main/java/ca/gc/aafc/objectstore/api/util/ObjectFilenameUtils.java

@@ -69,9 +69,10 @@ public static String standardizeFolderName(String userSubmittedFolderName) {
    * Generate a filename (with file extension) for a derivative. Since Derivatives don't have a name we are trying to use the name
    * of the derivedFrom and add the derivative type as suffix. We will use a fallback on derivative's uuid.
    * @param derivative non null
+   * @param filenameAlias optional, an alias to use instead of the originalFilename of the derivedFrom
    * @return a filename like myUploadedImage_thumbnail.jpg
    */
-  public static String generateDerivativeFilename(Derivative derivative) {
+  public static String generateDerivativeFilename(Derivative derivative, String filenameAlias) {
     Objects.requireNonNull(derivative);
 
     ObjectStoreMetadata derivedFrom = derivative.getAcDerivedFrom();
@@ -80,8 +81,12 @@ public static String generateDerivativeFilename(Derivative derivative) {
       String derivativeSuffix =
         derivative.getDerivativeType() != null ? derivative.getDerivativeType().getSuffix() :
           "derivative";
+
+      String filename = StringUtils.isBlank(filenameAlias) ? derivedFrom.getOriginalFilename() :
+        standardizeFilename(filenameAlias);
+
       // generate a name from the originalFilename + the generated suffix + the derivative file extension (since it might be different from the original)
-      return FilenameUtils.getBaseName(derivedFrom.getOriginalFilename()) + "_" + derivativeSuffix + derivative.getFileExtension();
+      return FilenameUtils.getBaseName(filename) + "_" + derivativeSuffix + derivative.getFileExtension();
     }
     //fallback, use the internal name
     return derivative.getFilename();
@@ -91,19 +96,21 @@ public static String generateDerivativeFilename(Derivative derivative) {
    * Make sure a valid filename is generated for the download.
    *
    * @param mainObject
-   * @return
+   * @param filenameAlias optional, an alias to use instead of the originalFilename
+   * @return generated filename including file extension
    */
-  public static String generateMainObjectFilename(ObjectStoreMetadata mainObject) {
+  public static String generateMainObjectFilename(ObjectStoreMetadata mainObject, String filenameAlias) {
     Objects.requireNonNull(mainObject);
 
-    String originalFilename = mainObject.getOriginalFilename();
+    String filename = StringUtils.isBlank(filenameAlias) ? mainObject.getOriginalFilename() :
+      standardizeFilename(filenameAlias);
 
     // if there is no original file name of the filename is just an extension
-    if (StringUtils.isEmpty(originalFilename) || StringUtils.isEmpty(FilenameUtils.getBaseName(originalFilename))) {
+    if (StringUtils.isEmpty(filename) || StringUtils.isEmpty(FilenameUtils.getBaseName(filename))) {
       return mainObject.getFilename();
     }
     // use the internal extension since we are also returning the internal media type
-    return FilenameUtils.getBaseName(originalFilename) + mainObject.getFileExtension();
+    return FilenameUtils.getBaseName(filename) + mainObject.getFileExtension();
   }
 
   /**

src/test/java/ca/gc/aafc/objectstore/api/service/ObjectExportServiceIT.java

@@ -95,6 +95,7 @@ public void exportObjects_onExport_ZipContentValid()
       .username("testuser")
       .fileIdentifiers(List.of(osm.getFileIdentifier(), thumbnail.get().getFileIdentifier()))
       .exportLayout(Map.of("thumb/", List.of(thumbnail.get().getFileIdentifier())))
+      .filenameAliases(Map.of(osm.getFileIdentifier(), "testFileAlias"))
       .username("testname").build());
 
     // 5 - Wait for completion
@@ -121,7 +122,7 @@ public void exportObjects_onExport_ZipContentValid()
     }
 
     assertEquals(2, filenamesInZip.size());
-    assertTrue(filenamesInZip.contains("testfile.png"));
+    assertTrue(filenamesInZip.contains("testFileAlias.png"));
     assertTrue(filenamesInZip.contains("thumb/testfile_thumbnail.jpg"));
   }