Merge pull request #189 from AtlasOfLivingAustralia/biocollect-342

AtlasOfLivingAustralia/biocollect#342 adds …

Author: m-r-c

grails-app/conf/UrlMappings.groovy

@@ -28,6 +28,7 @@ class UrlMappings {
         "/ws/audit/getAuditMessagesForProjectPerPage/$id"(controller: "audit", action: "getAuditMessagesForProjectPerPage")
 
         "/ws/document/listImages"(controller: "document", action: "listImages")
+        "/ws/document/$id/file"(controller: "document", action: "getFile")
 
         "/ws/activitiesForProject/$id" {
             controller = 'activity'

grails-app/controllers/au/org/ala/ecodata/DocumentController.groovy

@@ -46,6 +46,40 @@ class DocumentController {
         }
     }
 
+    def getFile() {
+        if (params.id) {
+            Map document = documentService.get(params.id)
+
+            if (!document) {
+                response.status = 404
+                render status:404, text: 'No such id'
+            } else {
+                String path = "${grailsApplication.config.app.file.upload.path}${File.separator}${document.filepath}${File.separator}${document.filename}"
+
+                File file = new File(path)
+
+                if (!file.exists()) {
+                    response.status = 404
+                    return null
+                }
+
+                if (params.forceDownload?.toBoolean()) {
+                    // set the content type to octet-stream to stop the browser from auto playing known types
+                    response.setContentType('application/octet-stream')
+                } else {
+                    response.setContentType(document.contentType ?: 'application/octet-stream')
+                }
+                response.outputStream << new FileInputStream(file)
+                response.outputStream.flush()
+
+                return null
+            }
+        } else {
+            response.status = 400
+            render status:400, text: 'id is a required parameter'
+        }
+    }
+
     def find(String entity, String id) {
         if (params.links as boolean) {
             def result = documentService.findAllLinksByOwner(entity+'Id', id)

grails-app/services/au/org/ala/ecodata/OutputService.groovy

@@ -130,6 +130,7 @@ class OutputService {
 
                 // save images to ecodata
                 props.data = saveImages(props.data, props.name, output.outputId, props.activityId);
+                props.data = saveAudio(props.data, props.name, output.outputId, props.activityId);
 
                 getCommonService().updateProperties(output, props)
 
@@ -182,6 +183,7 @@ class OutputService {
             try {
                 // save image properties to db
                 props.data = saveImages(props.data, props.name, output.outputId, activity.activityId)
+                props.data = saveAudio(props.data, props.name, output.outputId, activity.activityId)
 
                 getCommonService().updateProperties(output, props)
 
@@ -235,7 +237,21 @@ class OutputService {
      * @return the output data, with any image objects updated to include the new document id
      */
     Map saveImages(Map output, String metadataName, String outputId, String activityId, Map context = null) {
-         URL biocollect
+        saveMultimedia(output, metadataName, outputId, activityId, "image", "surveyImage", "image", context)
+    }
+
+    /**
+     * find images and save or delete it.
+     * @param activityId
+     * @param outputs
+     * @return the output data, with any image objects updated to include the new document id
+     */
+    Map saveAudio(Map output, String metadataName, String outputId, String activityId, Map context = null) {
+        saveMultimedia(output, metadataName, outputId, activityId, "audio", "surveyAudio", "audio", context)
+    }
+
+    Map saveMultimedia(Map output, String metadataName, String outputId, String activityId, String dataTypeName, String role, String type, Map context = null) {
+        URL biocollect
         InputStream stream
         Map outputMetadata, names
         OutputMetadata dataModel
@@ -244,7 +260,7 @@ class OutputService {
         if(!context){
             outputMetadata = metadataService.getOutputDataModelByName(metadataName) as Map
             dataModel = new OutputMetadata(outputMetadata);
-            names = dataModel.getNamesForDataType('image', null);
+            names = dataModel.getNamesForDataType(dataTypeName, null);
         } else {
             names = context
         }
@@ -259,8 +275,8 @@ class OutputService {
                             it.activityId = activityId
                             it.outputId = outputId
                             it.remove('staged')
-                            it.role = 'surveyImage'
-                            it.type = 'image'
+                            it.role = role
+                            it.type = type
                             // record creation requires images to have an 'identifier' attribute containing the url for the image
                             it.identifier = it.url
 
@@ -283,12 +299,12 @@ class OutputService {
                 // recursive check for image data
                 if(node instanceof Map){
                     if(output[name] instanceof Map){
-                        output[name] = saveImages(output[name], metadataName, outputId, activityId, node)
+                        output[name] = saveMultimedia(output[name], metadataName, outputId, activityId, dataTypeName, role, type, node)
                     }
 
                     if(output[name] instanceof  List){
                         output[name].eachWithIndex{ column, index ->
-                            output[name][index] = saveImages(column, metadataName, outputId, activityId, node)
+                            output[name][index] = saveMultimedia(column, metadataName, outputId, activityId, dataTypeName, role, type,  node)
                         }
                     }
                 }

grails-app/services/au/org/ala/ecodata/ProjectService.groovy

@@ -374,7 +374,7 @@ class ProjectService {
      */
     List<Map> findByName(String name) {
         List<Map> matches = []
-        
+
         if (name) {
             name = name.replaceAll(" +", " ").trim()
             matches = Project.withCriteria {

src/groovy/au/org/ala/ecodata/converter/AudioConverter.groovy

@@ -0,0 +1,27 @@
+package au.org.ala.ecodata.converter
+
+class AudioConverter implements RecordFieldConverter {
+
+    private static final String DEFAULT_RIGHTS_STATEMENT = "The rights to all uploaded audio are held equally, under a Creative Commons Attribution (CC-BY v3.0) license, by the contributor of the audio and the primary organisation responsible for the project to which they are contributed."
+    private static final String DEFAULT_LICENCE = "Creative Commons Attribution"
+
+    List<Map> convert(Map data, Map metadata = [:]) {
+        Map record = [:]
+
+        record.multimedia = data[metadata.name]
+        record.multimedia?.each {
+            if (it instanceof Map) {
+                it.identifier = it.identifier ?: it.url
+                it.creator = it.creator ?: it.attribution
+                it.title = it.title ?: it.filename
+                it.type = it.type ?: it.contentType
+                it.rightsHolder = it.creator ?: it.attribution
+                it.rights = DEFAULT_RIGHTS_STATEMENT
+                // note: the US spelling of licenSe is expected for the dublin core standard, so don't fix it
+                it.license = DEFAULT_LICENCE
+            }
+        }
+
+        [record]
+    }
+}

src/groovy/au/org/ala/ecodata/converter/RecordConverter.groovy

@@ -131,7 +131,7 @@ class RecordConverter {
         try {
             converter = Class.forName("${packageName}.${className}")?.newInstance()
         } catch (ClassNotFoundException e) {
-            log.warn "No specific converter found for output data type ${outputDataType} with class name ${packageName}.${className}, using generic converter"
+            log.debug "No specific converter found for output data type ${outputDataType} with class name ${packageName}.${className}, using generic converter"
             converter = new GenericFieldConverter()
         }