BXC-4786 - Custom alt text

auth-api/src/main/java/edu/unc/lib/boxc/auth/api/services/DatastreamPermissionUtil.java

@@ -25,6 +25,8 @@ public class DatastreamPermissionUtil {
         DS_PERMISSION_MAP.put(DatastreamType.JP2_ACCESS_COPY, Permission.viewAccessCopies);
         DS_PERMISSION_MAP.put(DatastreamType.AUDIO_ACCESS_COPY, Permission.viewAccessCopies);
         DS_PERMISSION_MAP.put(DatastreamType.ACCESS_SURROGATE, Permission.viewAccessCopies);
+        DS_PERMISSION_MAP.put(DatastreamType.ALT_TEXT, Permission.viewMetadata);
+        DS_PERMISSION_MAP.put(DatastreamType.ALT_TEXT_HISTORY, Permission.viewHidden);
         DS_PERMISSION_MAP.put(DatastreamType.MD_DESCRIPTIVE, Permission.viewMetadata);
         DS_PERMISSION_MAP.put(DatastreamType.MD_DESCRIPTIVE_HISTORY, Permission.viewHidden);
         DS_PERMISSION_MAP.put(DatastreamType.MD_EVENTS, Permission.viewHidden);

deposit-app/src/main/java/edu/unc/lib/boxc/deposit/fcrepo4/IngestContentObjectsJob.java

@@ -14,6 +14,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URI;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -25,6 +26,8 @@
 import java.util.Set;
 
 import edu.unc.lib.boxc.model.api.exceptions.NotFoundException;
+import edu.unc.lib.boxc.operations.impl.altText.AltTextUpdateService;
+import edu.unc.lib.boxc.operations.jms.altText.AltTextUpdateRequest;
 import org.apache.http.HttpStatus;
 import org.apache.jena.datatypes.xsd.XSDDatatype;
 import org.apache.jena.rdf.model.Bag;
@@ -137,6 +140,9 @@ public class IngestContentObjectsJob extends AbstractDepositJob {
     @Autowired
     private UpdateDescriptionService updateDescService;
 
+    @Autowired
+    private AltTextUpdateService altTextUpdateService;
+
     private AccessGroupSet groupSet;
     private AgentPrincipals agent;
 
@@ -342,6 +348,8 @@ private void ingestFileObject(ContentObject parent, Resource parentResc, Resourc
             addPremisEvents(obj);
             // add MODS
             addDescription(obj, childResc);
+            // Add alt text if present
+            addAltText(obj);
 
             overrideModifiedTimestamp(obj, childResc);
             log.debug("Finished all updates for file {} in work {}", pid, work.getPid());
@@ -824,6 +832,21 @@ private void addAclProperties(Resource dResc, Resource aResc) {
         }
     }
 
+    private void addAltText(ContentObject obj) throws IOException {
+        Path altTextPath = getAltTextPath(obj.getPid(), false);
+        if (!Files.exists(altTextPath)) {
+            return;
+        }
+
+        var altText = Files.readString(altTextPath, StandardCharsets.UTF_8);
+        var request = new AltTextUpdateRequest();
+        request.setAgent(agent);
+        request.setPidString(obj.getPid().getId());
+        request.setAltText(altText);
+        request.setTransferSession(logTransferSession);
+        altTextUpdateService.updateAltText(request);
+    }
+
     private void addDescription(ContentObject obj, Resource dResc) throws IOException {
         addDescriptionHistory(obj, dResc);
 

deposit-app/src/main/java/edu/unc/lib/boxc/deposit/work/AbstractDepositJob.java

@@ -1,5 +1,6 @@
 package edu.unc.lib.boxc.deposit.work;
 
+import static edu.unc.lib.boxc.deposit.api.DepositConstants.ALT_TEXT_DIR;
 import static edu.unc.lib.boxc.deposit.api.DepositConstants.DESCRIPTION_DIR;
 import static edu.unc.lib.boxc.deposit.api.DepositConstants.HISTORY_DIR;
 import static edu.unc.lib.boxc.deposit.api.DepositConstants.TECHMD_DIR;
@@ -239,6 +240,10 @@ public String getDepositField(DepositField field) {
         return getDepositStatus().get(field.name());
     }
 
+    public File getAltTextDir() {
+        return new File(getDepositDirectory(), ALT_TEXT_DIR);
+    }
+
     public File getDescriptionDir() {
         return new File(getDepositDirectory(), DESCRIPTION_DIR);
     }
@@ -268,6 +273,16 @@ public Path getModsPath(PID pid, boolean createDirs) {
         return getMetadataPath(getDescriptionDir(), pid, ".xml", createDirs);
     }
 
+    /**
+     * Get the path where alt text should be stored for the given pid
+     * @param pid pid of the object
+     * @param createDirs if true, then parent directories for path will be created
+     * @return Path for the alt text
+     */
+    public Path getAltTextPath(PID pid, boolean createDirs) {
+        return getMetadataPath(getAltTextDir(), pid, ".txt", createDirs);
+    }
+
     /**
      * Get path to where MODS history should be stored
      *

deposit-app/src/main/webapp/WEB-INF/deposit-jobs-context.xml

@@ -106,6 +106,14 @@
         <property name="versionedDatastreamService" ref="versionedDatastreamService" />
     </bean>
 
+    <bean id="altTextUpdateService" class="edu.unc.lib.boxc.operations.impl.altText.AltTextUpdateService">
+        <property name="aclService" ref="aclService" />
+        <property name="repositoryObjectLoader" ref="repositoryObjectLoader" />
+        <property name="repositoryObjectFactory" ref="repositoryObjectFactory" />
+        <property name="versionedDatastreamService" ref="versionedDatastreamService" />
+        <property name="sendsMessages" value="false" />
+    </bean>
+
     <bean id="metsSipSchema" class="edu.unc.lib.boxc.common.xml.SecureXMLFactory"
           factory-method="createSchema">
         <constructor-arg ref="schemaFactory" />

deposit-app/src/test/java/edu/unc/lib/boxc/deposit/fcrepo4/IngestContentObjectsJobTest.java

@@ -8,6 +8,7 @@
 import static edu.unc.lib.boxc.model.api.StreamingConstants.STREAMREAPER_PREFIX_URL;
 import static edu.unc.lib.boxc.persist.impl.storage.StorageLocationTestHelper.LOC1_ID;
 import static java.nio.charset.StandardCharsets.UTF_8;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assertions.fail;
 import static org.mockito.ArgumentMatchers.any;
@@ -33,6 +34,8 @@
 import java.util.Map;
 
 import edu.unc.lib.boxc.model.api.exceptions.NotFoundException;
+import edu.unc.lib.boxc.operations.impl.altText.AltTextUpdateService;
+import edu.unc.lib.boxc.operations.jms.altText.AltTextUpdateRequest;
 import org.apache.commons.io.FileUtils;
 import org.apache.http.HttpStatus;
 import org.apache.jena.rdf.model.Bag;
@@ -159,8 +162,12 @@ public class IngestContentObjectsJobTest extends AbstractDepositJobTest {
     private BinaryTransferSession mockTransferSession;
     @Mock
     private UpdateDescriptionService updateDescService;
+    @Mock
+    private AltTextUpdateService altTextUpdateService;
     @Captor
     private ArgumentCaptor<Model> modelCaptor;
+    @Captor
+    private ArgumentCaptor<AltTextUpdateRequest> altTextRequestCaptor;
 
     private Path storageLocPath;
 
@@ -192,6 +199,7 @@ public void init() throws Exception {
         setField(job, "locationManager", storageLocationManager);
         setField(job, "updateDescService", updateDescService);
         setField(job, "depositModelManager", depositModelManager);
+        setField(job, "altTextUpdateService", altTextUpdateService);
 
         job.init();
 
@@ -379,7 +387,6 @@ public void ingestWorkWithFileWithStreamingPropertiesAndOriginalFile() throws Ex
         fileResc.addProperty(CdrDeposit.mimetype, "text/plain");
         fileResc.addProperty(Cdr.streamingUrl, STREAMREAPER_PREFIX_URL);
         fileResc.addProperty(Cdr.streamingType, STREAMING_TYPE);
-        workBag.add(fileResc);
 
         job.closeModel();
 
@@ -394,7 +401,45 @@ public void ingestWorkWithFileWithStreamingPropertiesAndOriginalFile() throws Ex
         verify(repoObjFactory).createWorkObject(eq(workPid), any(Model.class));
         verify(destinationObj).addMember(eq(work));
 
-        verify(jobStatusFactory, times(3)).incrCompletion(eq(jobUUID), eq(1));
+        verify(jobStatusFactory, times(2)).incrCompletion(eq(jobUUID), eq(1));
+    }
+
+    @Test
+    public void ingestWorkWithFileWithAltText() throws Exception {
+        PID workPid = makePid(RepositoryPathConstants.CONTENT_BASE);
+        WorkObject work = mock(WorkObject.class);
+        Bag workBag = setupWork(workPid, work);
+
+        String loc = "image.jpg";
+        String mime = "image/jpeg";
+        PID filePid = addFileObject(workBag, loc, mime);
+
+        var fileResc = model.getResource(filePid.getRepositoryPath());
+        fileResc.addProperty(RDF.type, Cdr.FileObject);
+        fileResc.addProperty(CdrDeposit.mimetype, mime);
+
+        Path altTextPath = job.getAltTextPath(filePid, true);
+        FileUtils.writeStringToFile(altTextPath.toFile(), "Alternative text", UTF_8);
+
+        job.closeModel();
+
+        when(work.addDataFile(any(PID.class), any(URI.class),
+                anyString(), anyString(), isNull(), isNull(), any(Model.class)))
+                .thenReturn(mockFileObj);
+        when(mockFileObj.getPid()).thenReturn(filePid);
+        when(repoObjLoader.getWorkObject(eq(workPid))).thenReturn(work);
+
+        job.run();
+
+        verify(repoObjFactory).createWorkObject(eq(workPid), any(Model.class));
+        verify(destinationObj).addMember(eq(work));
+
+        verify(jobStatusFactory, times(2)).incrCompletion(eq(jobUUID), eq(1));
+
+        verify(altTextUpdateService).updateAltText(altTextRequestCaptor.capture());
+        AltTextUpdateRequest request = altTextRequestCaptor.getValue();
+        assertEquals("Alternative text", request.getAltText());
+        assertEquals(filePid.getId(), request.getPidString());
     }
 
     /**

deposit-app/src/test/resources/spring-test/cdr-client-container.xml

@@ -149,6 +149,14 @@
         <property name="checksAccess" value="false" />
         <property name="versionedDatastreamService" ref="versionedDatastreamService" />
     </bean>
+
+    <bean id="altTextUpdateService" class="edu.unc.lib.boxc.operations.impl.altText.AltTextUpdateService">
+        <property name="aclService" ref="aclService" />
+        <property name="repositoryObjectLoader" ref="repositoryObjectLoader" />
+        <property name="repositoryObjectFactory" ref="repositoryObjectFactory" />
+        <property name="versionedDatastreamService" ref="versionedDatastreamService" />
+        <property name="sendsMessages" value="false" />
+    </bean>
 
     <bean id="transactionManager" class="edu.unc.lib.boxc.fcrepo.utils.TransactionManager">
         <property name="client" ref="fcrepoClient" />

deposit-utils/src/main/java/edu/unc/lib/boxc/deposit/api/DepositConstants.java

@@ -7,6 +7,7 @@
  */
 public class DepositConstants {
     public static final String DESCRIPTION_DIR = "description";
+    public static final String ALT_TEXT_DIR = "altText";
     public static final String HISTORY_DIR = "history";
     public static final String JENA_TDB_DIR = "jena-tdb-model";
     public static final String EVENTS_FILE = "events.xml";

etc/solr-config/access/conf/schema.xml

@@ -117,6 +117,7 @@
     <field name="abstract" type="string" indexed="false" stored="true"/>
     <!-- Groups which have administrative viewing rights to this object -->
     <field name="adminGroup" type="string" indexed="true" stored="true" required="true" multiValued="true" default="" docValues="true"/>
+    <field name="altText" type="string" indexed="false" stored="true"/>
     <!-- Sortable string representation of the path to this object.  This object is included if it is a container -->
     <field name="ancestorIds" type="string" indexed="true" stored="true" docValues="true"/>
     <!--
@@ -291,6 +292,7 @@
   <copyField source="rightsOaiPmh" dest="keywordIndex"/>
   <copyField source="rightsUri" dest="keywordIndex"/>
   <copyField source="genre" dest="keywordIndex"/>
+  <copyField source="altText" dest="keywordIndex"/>
 
   <!-- Same as the keyword index plus full text. Too bad recursive copy fields don't work -->
   <copyField source="title" dest="text"/>
@@ -310,4 +312,5 @@
   <copyField source="rightsUri" dest="text"/>
   <copyField source="fullText" dest="text"/>
   <copyField source="genre" dest="text"/>
+  <copyField source="altText" dest="text"/>
 </schema>

indexing-solr/src/main/java/edu/unc/lib/boxc/indexing/solr/filter/SetAltTextFilter.java

@@ -0,0 +1,50 @@
+package edu.unc.lib.boxc.indexing.solr.filter;
+
+import edu.unc.lib.boxc.indexing.solr.exception.IndexingException;
+import edu.unc.lib.boxc.indexing.solr.indexing.DocumentIndexingPackage;
+import edu.unc.lib.boxc.model.api.exceptions.NotFoundException;
+import edu.unc.lib.boxc.model.api.objects.ContentObject;
+import edu.unc.lib.boxc.model.api.objects.FileObject;
+import edu.unc.lib.boxc.model.api.objects.RepositoryObjectLoader;
+import edu.unc.lib.boxc.model.fcrepo.ids.DatastreamPids;
+import org.apache.commons.io.IOUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+
+import static java.nio.charset.StandardCharsets.UTF_8;
+
+/**
+ * Filter which populates alt text for the object being indexed
+ *
+ * @author bbpennel
+ */
+public class SetAltTextFilter implements IndexDocumentFilter {
+    private static final Logger log = LoggerFactory.getLogger(SetAltTextFilter.class);
+    private RepositoryObjectLoader repositoryObjectLoader;
+
+    @Override
+    public void filter(DocumentIndexingPackage dip) throws IndexingException {
+        ContentObject contentObj = dip.getContentObject();
+        // object being indexed must be a file object
+        if (!(contentObj instanceof FileObject)) {
+            return;
+        }
+
+        try {
+            var altTextPid = DatastreamPids.getAltTextPid(contentObj.getPid());
+            var altTextBinary = repositoryObjectLoader.getBinaryObject(altTextPid);
+            var altText = IOUtils.toString(altTextBinary.getBinaryStream(), UTF_8);
+            dip.getDocument().setAltText(altText);
+        } catch (NotFoundException e) {
+            log.debug("No alt text datastream found for {}", dip.getPid());
+        } catch (IOException e) {
+            throw new IndexingException("Failed to retrieve alt text datastream for {}" + dip.getPid(), e);
+        }
+    }
+
+    public void setRepositoryObjectLoader(RepositoryObjectLoader repositoryObjectLoader) {
+        this.repositoryObjectLoader = repositoryObjectLoader;
+    }
+}

indexing-solr/src/main/java/edu/unc/lib/boxc/indexing/solr/filter/SetContentStatusFilter.java

@@ -56,28 +56,37 @@ private List<String> determineContentStatus(DocumentIndexingPackage dip)
         }
 
         if (obj instanceof FileObject) {
-            Resource parentResc = obj.getParent().getResource();
-            if (parentResc.hasProperty(Cdr.primaryObject, resc)) {
-                status.add(FacetConstants.IS_PRIMARY_OBJECT);
-            }
-            if (parentResc.hasProperty(Cdr.useAsThumbnail, resc)) {
-                status.add(FacetConstants.ASSIGNED_AS_THUMBNAIL);
-            }
-            if (hasAccessSurrogate(obj.getPid())) {
-                status.add(FacetConstants.HAS_ACCESS_SURROGATE);
-            } else {
-                status.add(FacetConstants.NO_ACCESS_SURROGATE);
-            }
-            if (resc.hasProperty(Cdr.streamingUrl)) {
-                status.add(FacetConstants.HAS_STREAMING);
-            } else {
-                status.add(FacetConstants.NO_STREAMING);
-            }
+            addFileObjectStatuses(obj, resc, status);
         }
 
         return status;
     }
 
+    private void addFileObjectStatuses(ContentObject obj, Resource resc, List<String> status) {
+        Resource parentResc = obj.getParent().getResource();
+        if (parentResc.hasProperty(Cdr.primaryObject, resc)) {
+            status.add(FacetConstants.IS_PRIMARY_OBJECT);
+        }
+        if (parentResc.hasProperty(Cdr.useAsThumbnail, resc)) {
+            status.add(FacetConstants.ASSIGNED_AS_THUMBNAIL);
+        }
+        if (hasAccessSurrogate(obj.getPid())) {
+            status.add(FacetConstants.HAS_ACCESS_SURROGATE);
+        } else {
+            status.add(FacetConstants.NO_ACCESS_SURROGATE);
+        }
+        if (resc.hasProperty(Cdr.streamingUrl)) {
+            status.add(FacetConstants.HAS_STREAMING);
+        } else {
+            status.add(FacetConstants.NO_STREAMING);
+        }
+        if (resc.hasProperty(Cdr.hasAltText)) {
+            status.add(FacetConstants.HAS_ALT_TEXT);
+        } else {
+            status.add(FacetConstants.NO_ALT_TEXT);
+        }
+    }
+
     private void addWorkObjectStatuses(List<String> status, Resource resource) {
         if (resource.hasProperty(Cdr.primaryObject)) {
             status.add(FacetConstants.HAS_PRIMARY_OBJECT);