Bxc 4605 csv export parent info (#1761)

sharonluong · web-flow · commit aa5e63e14d2d · 2024-07-09T10:06:15.000-04:00
* BXC-4605 update export csv

* BXC-4605 update tests and add correct info for parent work

* BXC-4605 update imports

* BXC-4605 fix up tests and add headers

* BXC-4605 fixing last test

* BXC-4605 standardie URLs
diff --git a/web-services-app/src/main/java/edu/unc/lib/boxc/web/services/processing/ExportCsvService.java b/web-services-app/src/main/java/edu/unc/lib/boxc/web/services/processing/ExportCsvService.java
@@ -1,44 +1,14 @@
 package edu.unc.lib.boxc.web.services.processing;
 
-import static edu.unc.lib.boxc.auth.api.AccessPrincipalConstants.AUTHENTICATED_PRINC;
-import static edu.unc.lib.boxc.auth.api.AccessPrincipalConstants.PUBLIC_PRINC;
-import static edu.unc.lib.boxc.auth.api.Permission.viewHidden;
-import static edu.unc.lib.boxc.auth.api.UserRole.canViewOriginals;
-import static edu.unc.lib.boxc.auth.api.UserRole.none;
-import static edu.unc.lib.boxc.model.api.DatastreamType.ACCESS_SURROGATE;
-import static edu.unc.lib.boxc.model.api.DatastreamType.ORIGINAL_FILE;
-import static edu.unc.lib.boxc.model.api.ids.RepositoryPathConstants.CONTENT_ROOT_ID;
-import static edu.unc.lib.boxc.model.api.rdf.CdrAcl.embargoUntil;
-import static edu.unc.lib.boxc.search.api.FacetConstants.MARKED_FOR_DELETION;
-
-import java.io.BufferedWriter;
-import java.io.IOException;
-import java.io.OutputStream;
-import java.io.OutputStreamWriter;
-import java.io.Writer;
-import java.nio.charset.StandardCharsets;
-import java.text.SimpleDateFormat;
-import java.util.Arrays;
-import java.util.Date;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Objects;
-
-import edu.unc.lib.boxc.model.api.ResourceType;
-import edu.unc.lib.boxc.model.api.objects.RepositoryObjectLoader;
-import org.apache.commons.csv.CSVFormat;
-import org.apache.commons.csv.CSVPrinter;
-import org.apache.commons.lang3.StringUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import edu.unc.lib.boxc.auth.api.models.AccessGroupSet;
 import edu.unc.lib.boxc.auth.api.models.AgentPrincipals;
 import edu.unc.lib.boxc.auth.api.services.AccessControlService;
+import edu.unc.lib.boxc.common.util.URIUtil;
+import edu.unc.lib.boxc.model.api.ResourceType;
 import edu.unc.lib.boxc.model.api.exceptions.NotFoundException;
 import edu.unc.lib.boxc.model.api.exceptions.RepositoryException;
 import edu.unc.lib.boxc.model.api.ids.PID;
+import edu.unc.lib.boxc.model.api.objects.RepositoryObjectLoader;
 import edu.unc.lib.boxc.search.api.FacetConstants;
 import edu.unc.lib.boxc.search.api.SearchFieldKey;
 import edu.unc.lib.boxc.search.api.models.ContentObjectRecord;
@@ -48,6 +18,35 @@
 import edu.unc.lib.boxc.search.solr.responses.SearchResultResponse;
 import edu.unc.lib.boxc.search.solr.services.ChildrenCountService;
 import edu.unc.lib.boxc.web.common.services.SolrQueryLayerService;
+import org.apache.commons.csv.CSVFormat;
+import org.apache.commons.csv.CSVPrinter;
+import org.apache.commons.lang3.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.BufferedWriter;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.io.OutputStreamWriter;
+import java.io.Writer;
+import java.nio.charset.StandardCharsets;
+import java.text.SimpleDateFormat;
+import java.util.Arrays;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+
+import static edu.unc.lib.boxc.auth.api.AccessPrincipalConstants.AUTHENTICATED_PRINC;
+import static edu.unc.lib.boxc.auth.api.AccessPrincipalConstants.PUBLIC_PRINC;
+import static edu.unc.lib.boxc.auth.api.Permission.viewHidden;
+import static edu.unc.lib.boxc.auth.api.UserRole.canViewOriginals;
+import static edu.unc.lib.boxc.auth.api.UserRole.none;
+import static edu.unc.lib.boxc.model.api.DatastreamType.ORIGINAL_FILE;
+import static edu.unc.lib.boxc.model.api.ids.RepositoryPathConstants.CONTENT_ROOT_ID;
+import static edu.unc.lib.boxc.model.api.rdf.CdrAcl.embargoUntil;
+import static edu.unc.lib.boxc.search.api.FacetConstants.MARKED_FOR_DELETION;
 
 /**
  * Service which outputs a CSV listing of a repository object and all of its children,
@@ -77,12 +76,15 @@ public class ExportCsvService {
     public static final String PATRON_PERMISSIONS_HEADER = "Patron Permissions";
     public static final String EMBARGO_HEADER = "Embargo Date";
     public static final String VIEW_BEHAVIOR_HEADER = "View";
+    public static final String PARENT_WORK_URL = "Parent Work URL";
+    public static final String PARENT_WORK_TITLE = "Parent Work Title";
 
     private static final String[] CSV_HEADERS = new String[] {
             OBJ_TYPE_HEADER, PID_HEADER, TITLE_HEADER, PATH_HEADER,
             DEPTH_HEADER, DELETED_HEADER, DATE_ADDED_HEADER, DATE_UPDATED_HEADER,
             MIME_TYPE_HEADER, CHECKSUM_HEADER, FILE_SIZE_HEADER, ACCESS_SURROGATE_HEADER, NUM_CHILDREN_HEADER,
-            DESCRIBED_HEADER, PATRON_PERMISSIONS_HEADER, EMBARGO_HEADER, VIEW_BEHAVIOR_HEADER
+            DESCRIBED_HEADER, PATRON_PERMISSIONS_HEADER, EMBARGO_HEADER, VIEW_BEHAVIOR_HEADER,
+            PARENT_WORK_URL, PARENT_WORK_TITLE
     };
 
     private static final List<String> SEARCH_FIELDS = Arrays.asList(SearchFieldKey.ID.name(),
@@ -99,6 +101,7 @@ public class ExportCsvService {
     private AccessControlService aclService;
     private SolrQueryLayerService queryLayer;
     private RepositoryObjectLoader repositoryObjectLoader;
+    private String baseUrl;
     private int pageSize = DEFAULT_PAGE_SIZE;
 
     private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd kk:mm:ss");
@@ -224,7 +227,7 @@ private CSVPrinter getPrinter(Writer writer) throws IOException {
     }
 
     private void printObject(CSVPrinter printer, ContentObjectRecord object) throws IOException {
-        // Vitals: object type, pid, title, path, label, depth
+        // Vitals: object type, pid, title, path, depth
         printer.print(object.getResourceType());
         printer.print(object.getId());
         printer.print(object.getTitle());
@@ -310,6 +313,18 @@ private void printObject(CSVPrinter printer, ContentObjectRecord object) throws
         var behavior = object.getViewBehavior();
         printer.print(Objects.requireNonNullElse(behavior, ""));
 
+        // Parent info for FileObjects
+        if (ResourceType.File.name().equals(object.getResourceType())) {
+            // parentWorkUrl, parentWorkTitle
+            var parentWorkId = object.getAncestorPathFacet().getHighestTierNode().getSearchKey();
+            printer.print(getUrl(parentWorkId));
+            var parentWorkTitle = getTitle(object.getAncestorNames());
+            printer.print(parentWorkTitle);
+        } else {
+            printer.print("");
+            printer.print("");
+        }
+
         printer.println();
     }
 
@@ -335,6 +350,27 @@ private String getEmbargoDate(ContentObjectRecord object) {
         return StringUtils.substringBefore(embargoProperty.getString(), "T");
     }
 
+    /**
+     * Creating a record URL with just the ID
+     * @param id
+     * @return
+     */
+    private String getUrl(String id) {
+        return URIUtil.join(baseUrl, id);
+    }
+
+    /**
+     * Transforming ancestor path names to get the second to last one (for the work), but keep escaped slashes if necessary
+     * @param input
+     * @return
+     */
+    private String getTitle(String input) {
+        String regex = "(?<!\\\\)/";
+        String[] result = input.split(regex);
+        // for the last one escape any backslashes in the title
+        return result[result.length - 2].replace("\\/", "/");
+    }
+
     public void setChildrenCountService(ChildrenCountService childrenCountService) {
         this.childrenCountService = childrenCountService;
     }
@@ -354,4 +390,8 @@ public void setPageSize(int pageSize) {
     public void setRepositoryObjectLoader(RepositoryObjectLoader repositoryObjectLoader) {
         this.repositoryObjectLoader = repositoryObjectLoader;
     }
+
+    public void setBaseUrl(String baseUrl) {
+        this.baseUrl = baseUrl;
+    }
 }
diff --git a/web-services-app/src/main/webapp/WEB-INF/service-context.xml b/web-services-app/src/main/webapp/WEB-INF/service-context.xml
@@ -409,6 +409,7 @@
         <property name="aclService" ref="aclService"/>
         <property name="queryLayer" ref="queryLayer"/>
         <property name="repositoryObjectLoader" ref="repositoryObjectLoader"/>
+        <property name="baseUrl" value="${base.record.url}"/>
     </bean>
 
     <bean id="facetValuesService" class="edu.unc.lib.boxc.search.solr.services.FacetValuesService"
diff --git a/web-services-app/src/test/java/edu/unc/lib/boxc/web/services/rest/modify/ExportCsvIT.java b/web-services-app/src/test/java/edu/unc/lib/boxc/web/services/rest/modify/ExportCsvIT.java
@@ -197,7 +197,7 @@ public void exportWorkWithFile() throws Exception {
         List<CSVRecord> csvList = parseCsvResponse(response);
         assertEquals(3, csvList.size(), "Unexpected number of results");
 
-        assertCsvContentIsCorrect(csvList, folderObj.getPid(), workPid, filePid);
+        assertCsvContentIsCorrect(csvList, folderPid, workPid, filePid);
     }
 
     @Test
@@ -221,15 +221,17 @@ public void exportWorkWithAccessSurrogate() throws Exception {
 
         List<CSVRecord> csvList = parseCsvResponse(response);
 
-        String pathToWork = FOLDER_PATH + "/" + workPid.getId();
-        assertCsvRecord(csvList, ResourceType.Work, workPid, "TestWork",
+        var workId = workPid.getId();
+        String pathToWork = FOLDER_PATH + "/" + workId;
+        assertCsvRecord(csvList, ResourceType.Work, workPid, workId,
                 pathToWork, 4, false, null, null, null, null,
-                1, false, "Authenticated", "", "");
+                1, false, "Authenticated", "", "", null, null);
 
-        String pathToFile = pathToWork + "/file.txt";
-        assertCsvRecord(csvList, ResourceType.File, pidList.get("filePid"), "TestWork",
+        var fileTitle = "file.txt";
+        String pathToFile = pathToWork + "/" + fileTitle;
+        assertCsvRecord(csvList, ResourceType.File, filePid, fileTitle,
                 pathToFile, 5, false, "text/plain", null, (long) 7, "Y",
-                null, false, "Authenticated", "", "");
+                null, false, "Authenticated", "", "", getUrl(workPid.getId()), workId);
     }
 
     @Test
@@ -268,12 +270,13 @@ public void exportDescribedResource() throws Exception {
         String pathToWork = pathToFolder + "/Work Test";
         assertCsvRecord(csvList, ResourceType.Work, workPid, "Work Test",
                 pathToWork, 4, false, null, null, null, null,
-                1, true, "Authenticated", "", "");
+                1, true, "Authenticated", "", "", null, null);
 
-        String pathToFile = pathToWork + "/file.txt";
-        assertCsvRecord(csvList, ResourceType.File, filePid, "TestWork2",
+        var fileTitle = "file.txt";
+        String pathToFile = pathToWork + "/" + fileTitle;
+        assertCsvRecord(csvList, ResourceType.File, filePid, fileTitle,
                 pathToFile, 5, false, "text/plain", null, (long) 7, null,
-                null, false, "Authenticated", "", "");
+                null, false, "Authenticated", "", "", getUrl(workPid.getId()), "Work Test");
     }
 
     @Test
@@ -303,15 +306,17 @@ public void exportDeletedResource() throws Exception {
         assertContainerRecord(csvList, ResourceType.Folder, folderPid, "Folder",
                 FOLDER_PATH, 3, true, 1, false, "Staff-only", "");
 
-        String pathToWork = FOLDER_PATH + "/" + workPid.getId();
-        assertCsvRecord(csvList, ResourceType.Work, workPid, "TestWorkDeleted",
+        var workId = workPid.getId();
+        String pathToWork = FOLDER_PATH + "/" + workId;
+        assertCsvRecord(csvList, ResourceType.Work, workPid, workId,
                 pathToWork, 4, true, null, null, null, null,
-                1, false, "Staff-only", "", "");
+                1, false, "Staff-only", "", "", null, null);
 
-        String pathToFile = pathToWork + "/file.txt";
-        assertCsvRecord(csvList, ResourceType.File, filePid, "TestWork2",
+        var fileTitle = "file.txt";
+        String pathToFile = pathToWork + "/" + fileTitle;
+        assertCsvRecord(csvList, ResourceType.File, filePid, fileTitle,
                 pathToFile, 5, true, "text/plain", null, (long) 7, null,
-                null, false, "Staff-only", "", "");
+                null, false, "Staff-only", "", "", getUrl(workPid.getId()), workId);
     }
 
     @Test
@@ -335,10 +340,12 @@ public void exportFileResourceDirectly() throws Exception {
         List<CSVRecord> csvList = parseCsvResponse(response);
         assertEquals(1, csvList.size(), "Unexpected number of results");
 
-        String pathToFile = FOLDER_PATH + "/" + workPid.getId() + "/file.txt";
-        assertCsvRecord(csvList, ResourceType.File, filePid, "TestWork3",
+        var fileTitle = "file.txt";
+        var workId = workPid.getId();
+        String pathToFile = FOLDER_PATH + "/" +  workId + "/file.txt";
+        assertCsvRecord(csvList, ResourceType.File, filePid, fileTitle,
                 pathToFile, 5, false, "text/plain", null, (long) 7, null,
-                null, false, "Authenticated", "", "");
+                null, false, "Authenticated", "", "", getUrl(workPid.getId()), workId);
     }
 
     @Test
@@ -622,15 +629,17 @@ public void multiPageExport() throws Exception {
         assertContainerRecord(csvList, ResourceType.Folder, folderObj.getPid(), "Folder",
                 FOLDER_PATH, 3, false, 1, false, "Authenticated", "");
 
-        String pathToWork = FOLDER_PATH + "/" + workPid.getId();
-        assertCsvRecord(csvList, ResourceType.Work, workPid, "TestWork",
+        var workId = workPid.getId();
+        String pathToWork = FOLDER_PATH + "/" + workId;
+        assertCsvRecord(csvList, ResourceType.Work, workPid, workId,
                 pathToWork, 4, false, null, null, null, null,
-                1, false, "Authenticated", "", "");
+                1, false, "Authenticated", "", "", null, null);
 
-        String pathToFile = pathToWork + "/file.txt";
-        assertCsvRecord(csvList, ResourceType.File, pidList.get("filePid"), "TestWork",
+        var fileTitle = "file.txt";
+        String pathToFile = pathToWork + "/" + fileTitle;
+        assertCsvRecord(csvList, ResourceType.File, pidList.get("filePid"), fileTitle,
                 pathToFile, 5, false, "text/plain", null, (long) 7, null,
-                null, false, "Authenticated", "", "");
+                null, false, "Authenticated", "", "", getUrl(workPid.getId()), workId);
     }
 
     @Test
@@ -658,10 +667,11 @@ public void exportWorkWithViewBehavior() throws Exception {
         List<CSVRecord> csvList = parseCsvResponse(response);
         assertEquals(3, csvList.size(), "Unexpected number of results");
 
-        String pathToWork = FOLDER_PATH + "/" + workPid.getId();
-        assertCsvRecord(csvList, ResourceType.Work, workPid, "TestWork",
+        var workId = workPid.getId();
+        String pathToWork = FOLDER_PATH + "/" + workId;
+        assertCsvRecord(csvList, ResourceType.Work, workPid, workId,
                 pathToWork, 4, false, null, null, null, null,
-                1, false, "Authenticated", "", paged);
+                1, false, "Authenticated", "", paged, null, null);
     }
 
     @Test
@@ -784,13 +794,14 @@ private void assertContainerRecord(List<CSVRecord> csvList, ResourceType objType
             String path, int depth, boolean deleted, Integer numChildren, boolean described, String permissions,
                                        String embargoDate) {
         assertCsvRecord(csvList, objType, expectedPid, title, path, depth, deleted,
-                null, null, null, null, numChildren, described, permissions, embargoDate, "");
+                null, null, null, null, numChildren, described, permissions,
+                embargoDate, "", "", "");
     }
 
     private void assertCsvRecord(List<CSVRecord> csvList, ResourceType objType, PID expectedPid, String title,
             String path, int depth, boolean deleted, String mimetype, String checksum, Long fileSize,
             String accessSurrogate, Integer numChildren, boolean described, String permissions,
-            String embargoDate, String behavior) {
+            String embargoDate, String behavior, String parentWorkUrl, String parentWorkTitle) {
         path = path == null ? "" : path;
         mimetype = mimetype == null ? "" : mimetype;
         checksum = checksum == null ? "" : checksum;
@@ -801,6 +812,7 @@ private void assertCsvRecord(List<CSVRecord> csvList, ResourceType objType, PID
                 continue;
             }
             assertEquals(objType.name(), rec.get(ExportCsvService.OBJ_TYPE_HEADER));
+            assertEquals(title, rec.get(ExportCsvService.TITLE_HEADER));
             assertEquals(path, rec.get(ExportCsvService.PATH_HEADER));
             assertEquals(depth, Integer.parseInt(rec.get(ExportCsvService.DEPTH_HEADER)));
             assertEquals(deleted, Boolean.parseBoolean(rec.get(ExportCsvService.DELETED_HEADER)));
@@ -828,6 +840,18 @@ private void assertCsvRecord(List<CSVRecord> csvList, ResourceType objType, PID
             assertEquals(permissions, rec.get(ExportCsvService.PATRON_PERMISSIONS_HEADER));
             assertEquals(embargoDate, rec.get(ExportCsvService.EMBARGO_HEADER));
             assertEquals(behavior, rec.get(ExportCsvService.VIEW_BEHAVIOR_HEADER));
+
+            if (parentWorkUrl == null) {
+                assertTrue(StringUtils.isBlank(rec.get(ExportCsvService.PARENT_WORK_URL)));
+            } else {
+                assertEquals(parentWorkUrl, rec.get(ExportCsvService.PARENT_WORK_URL));
+            }
+
+            if (parentWorkTitle == null) {
+                assertTrue(StringUtils.isBlank(rec.get(ExportCsvService.PARENT_WORK_TITLE)));
+            } else {
+                assertEquals(parentWorkTitle, rec.get(ExportCsvService.PARENT_WORK_TITLE));
+            }
             return;
         }
         fail("No CSV record with PID " + expectedPid.getId() + " present");
@@ -837,15 +861,17 @@ private void assertCsvContentIsCorrect(List<CSVRecord> csvList, PID folderPid, P
         assertContainerRecord(csvList, ResourceType.Folder, folderPid, "Folder",
                 FOLDER_PATH, 3, false, 1, false, "Authenticated", "");
 
-        String pathToWork = FOLDER_PATH + "/" + workPid.getId();
-        assertCsvRecord(csvList, ResourceType.Work, workPid, "TestWork",
+        var workId = workPid.getId();
+        String pathToWork = FOLDER_PATH + "/" + workId;
+        assertCsvRecord(csvList, ResourceType.Work, workPid, workId,
                 pathToWork, 4, false, null, null, null, null,
-                1, false, "Authenticated", "", "");
+                1, false, "Authenticated", "", "", "", "");
 
-        String pathToFile = pathToWork + "/file.txt";
-        assertCsvRecord(csvList, ResourceType.File, filePid, "TestWork",
+        var fileTitle = "file.txt";
+        String pathToFile = pathToWork + "/" + fileTitle;
+        assertCsvRecord(csvList, ResourceType.File, filePid, fileTitle,
                 pathToFile, 5, false, "text/plain", null, (long) 7, null,
-                null, false, "Authenticated", "", "");
+                null, false, "Authenticated", "", "", getUrl(workId), workId);
     }
 
     private List<CSVRecord> parseCsvResponse(MockHttpServletResponse response) throws Exception {
@@ -857,4 +883,8 @@ private List<CSVRecord> parseCsvResponse(MockHttpServletResponse response) throw
                 .forEach(csvList::add);
         return csvList;
     }
+
+    private String getUrl(String id) {
+        return "http://example.com/record/" + id;
+    }
 }
diff --git a/web-services-app/src/test/resources/export-csv-it-servlet.xml b/web-services-app/src/test/resources/export-csv-it-servlet.xml
@@ -35,6 +35,7 @@
         <property name="aclService" ref="aclService"/>
         <property name="queryLayer" ref="queryLayer"/>
         <property name="repositoryObjectLoader" ref="repositoryObjectLoader"/>
+        <property name="baseUrl" value="http://example.com/record/"/>
     </bean>
 
     <util:set id="accessGroups" set-class="edu.unc.lib.boxc.auth.fcrepo.models.AccessGroupSetImpl">
