GDCC/HDC 3B-Bi-directional LDN messaging, Template Instructions

pom.xml

@@ -112,7 +112,7 @@
         <dependency>
           <groupId>com.apicatalog</groupId>
           <artifactId>titanium-json-ld</artifactId>
-          <version>0.8.6</version>
+          <version>1.3.0-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.google.code.gson</groupId>

scripts/api/data/metadatablocks/citation.tsv

@@ -111,6 +111,7 @@
 	publicationIDType	upc		14											
 	publicationIDType	url		15											
 	publicationIDType	urn		16											
+	publicationIDType	DASH-NRS		17											
 	contributorType	Data Collector		0											
 	contributorType	Data Curator		1											
 	contributorType	Data Manager		2											

scripts/api/data/workflows/internal-ldnannounce-workflow.json

@@ -0,0 +1,16 @@
+{
+  "name": "LDN Announce workflow",
+  "steps": [
+    {
+      "provider":":internal",
+      "stepType":"ldnannounce",
+      "parameters": {
+        "stepName":"LDN Announce"
+      },
+      "requiredSettings": {
+        ":LDNAnnounceRequiredFields": "string",
+        ":LDNTarget": "string"
+      }
+    }
+  ]
+}

src/main/java/edu/harvard/iq/dataverse/Dataset.java

@@ -33,8 +33,8 @@
 import javax.persistence.Table;
 import javax.persistence.Temporal;
 import javax.persistence.TemporalType;
-import edu.harvard.iq.dataverse.util.BundleUtil;
 import edu.harvard.iq.dataverse.util.StringUtil;
+import edu.harvard.iq.dataverse.util.SystemConfig;
 
 /**
  *
@@ -152,6 +152,19 @@ public void setCitationDateDatasetFieldType(DatasetFieldType citationDateDataset
         this.citationDateDatasetFieldType = citationDateDatasetFieldType;
     }    
 
+
+    @ManyToOne
+    @JoinColumn(name="template_id",nullable = true)
+    private Template template;
+
+    public Template getTemplate() {
+        return template;
+    }
+
+    public void setTemplate(Template template) {
+        this.template = template;
+    }
+
     public Dataset() {
         DatasetVersion datasetVersion = new DatasetVersion();
         datasetVersion.setDataset(this);
@@ -743,6 +756,11 @@ public void setHarvestIdentifier(String harvestIdentifier) {
         this.harvestIdentifier = harvestIdentifier;
     }
 
+    public String getLocalURL() {
+        //Assumes GlobalId != null
+        return  SystemConfig.getDataverseSiteUrlStatic() + "/dataset.xhtml?persistentId=" + this.getGlobalId().asString();
+    }
+
     public String getRemoteArchiveURL() {
         if (isHarvested()) {
             if (HarvestingClient.HARVEST_STYLE_DATAVERSE.equals(this.getHarvestedFrom().getHarvestStyle())) {

src/main/java/edu/harvard/iq/dataverse/DatasetPage.java

@@ -1768,6 +1768,7 @@ public void handleChangeButton() {
             workingVersion.initDefaultValues(licenseServiceBean.getDefault());
             updateDatasetFieldInputLevels();
         }
+        dataset.setTemplate(selectedTemplate);
         /*
         Issue 8646: necessary for the access popup which is shared by the dataset page and the file page
         */
@@ -2055,6 +2056,8 @@ private String init(boolean initFull) {
                         selectedTemplate = testT;
                     }
                 }
+                //Initalize with the default if there is one 
+                dataset.setTemplate(selectedTemplate);
                 workingVersion = dataset.getEditVersion(selectedTemplate, null);
                 updateDatasetFieldInputLevels();
             } else {
@@ -3565,6 +3568,7 @@ public String save() {
             if (editMode == EditMode.CREATE) {
                 //Lock the metadataLanguage once created
                 dataset.setMetadataLanguage(getEffectiveMetadataLanguage());
+                //ToDo - could drop use of selectedTemplate and just use the persistent dataset.getTemplate() 
                 if ( selectedTemplate != null ) {
                     if ( isSessionUserAuthenticated() ) {
                         cmd = new CreateNewDatasetCommand(dataset, dvRequestService.getDataverseRequest(), false, selectedTemplate);

src/main/java/edu/harvard/iq/dataverse/MailServiceBean.java

@@ -16,6 +16,8 @@
 import edu.harvard.iq.dataverse.util.BundleUtil;
 import edu.harvard.iq.dataverse.util.MailUtil;
 import edu.harvard.iq.dataverse.util.SystemConfig;
+import edu.harvard.iq.dataverse.util.json.JsonUtil;
+
 import java.io.UnsupportedEncodingException;
 import java.text.MessageFormat;
 import java.util.ArrayList;
@@ -169,7 +171,7 @@ public boolean sendSystemEmail(String to, String subject, String messageText, bo
         return sent;
     }
 
-    private InternetAddress getSystemAddress() {
+    public InternetAddress getSystemAddress() {
        String systemEmail = settingsService.getValueForKey(Key.SystemEmail);
        return MailUtil.parseSystemAddress(systemEmail);
     }
@@ -608,6 +610,26 @@ public String getMessageTextBasedOnNotification(UserNotification userNotificatio
                 ));
 
                 return ingestedCompletedWithErrorsMessage;
+            case DATASETMENTIONED:
+                String additionalInfo = userNotification.getAdditionalInfo();
+                dataset = (Dataset) targetObject;
+                javax.json.JsonObject citingResource = null;
+                citingResource = JsonUtil.getJsonObject(additionalInfo);
+
+
+                pattern = BundleUtil.getStringFromBundle("notification.email.datasetWasMentioned");
+                Object[] paramArrayDatasetMentioned = {
+                        userNotification.getUser().getName(),
+                        BrandingUtil.getInstallationBrandName(), 
+                        citingResource.getString("@type"),
+                        citingResource.getString("@id"),
+                        citingResource.getString("name"),
+                        citingResource.getString("relationship"), 
+                        systemConfig.getDataverseSiteUrl(),
+                        dataset.getGlobalId().toString(), 
+                        dataset.getDisplayName()};
+                messageText = MessageFormat.format(pattern, paramArrayDatasetMentioned);
+                return messageText;
         }
 
         return "";
@@ -632,6 +654,7 @@ public Object getObjectOfNotification (UserNotification userNotification){
             case GRANTFILEACCESS:
             case REJECTFILEACCESS:
             case DATASETCREATED:
+            case DATASETMENTIONED:
                 return datasetService.find(userNotification.getObjectId());
             case CREATEDS:
             case SUBMITTEDDS:

src/main/java/edu/harvard/iq/dataverse/SettingsWrapper.java

@@ -13,6 +13,7 @@
 import edu.harvard.iq.dataverse.util.MailUtil;
 import edu.harvard.iq.dataverse.util.StringUtil;
 import edu.harvard.iq.dataverse.util.SystemConfig;
+import edu.harvard.iq.dataverse.util.json.JsonUtil;
 import edu.harvard.iq.dataverse.UserNotification.Type;
 
 import java.time.LocalDate;
@@ -646,5 +647,4 @@ public boolean isCustomLicenseAllowed() {
         }
         return customLicenseAllowed;
     }
-}
-
+}

src/main/java/edu/harvard/iq/dataverse/Template.java

@@ -1,7 +1,6 @@
 package edu.harvard.iq.dataverse;
 
 import java.io.Serializable;
-import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Comparator;
@@ -10,6 +9,11 @@
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
+
+import javax.json.Json;
+import javax.json.JsonObjectBuilder;
+import javax.json.JsonString;
 import javax.persistence.CascadeType;
 import javax.persistence.Column;
 import javax.persistence.Entity;
@@ -28,6 +32,8 @@
 import javax.validation.constraints.Size;
 
 import edu.harvard.iq.dataverse.util.DateUtil;
+import edu.harvard.iq.dataverse.util.json.JsonUtil;
+
 import javax.persistence.NamedQueries;
 import javax.persistence.NamedQuery;
 import org.hibernate.validator.constraints.NotBlank;
@@ -125,7 +131,13 @@ public void setTermsOfUseAndAccess(TermsOfUseAndAccess termsOfUseAndAccess) {
     public List<DatasetField> getDatasetFields() {
         return datasetFields;
     }
+
+    @Column(columnDefinition="TEXT", nullable = true )
+    private String instructions;
 
+    @Transient
+    private Map<String, String> instructionsMap = null;
+
     @Transient
     private Map<MetadataBlock, List<DatasetField>> metadataBlocksForView = new HashMap<>();
     @Transient
@@ -256,26 +268,31 @@ public void setMetadataValueBlocks() {
         metadataBlocksForView.clear();
         metadataBlocksForEdit.clear();
         List<DatasetField> filledInFields = this.getDatasetFields(); 
+
+        Map<String, String> instructionsMap = getInstructionsMap();
 
         List <MetadataBlock> viewMDB = new ArrayList<>();
         List <MetadataBlock> editMDB=this.getDataverse().getMetadataBlocks(true);
 
+        //The metadatablocks in this template include any from the Dataverse it is associated with 
+        //plus any others where the template has a displayable field (i.e. from before a block was dropped in the dataverse/collection)
         viewMDB.addAll(this.getDataverse().getMetadataBlocks(true));
-        for (DatasetField dsfv : filledInFields) {
-            if (!dsfv.isEmptyForDisplay()) {
-                MetadataBlock mdbTest = dsfv.getDatasetFieldType().getMetadataBlock();
+        for (DatasetField dsf : filledInFields) {
+            if (!dsf.isEmptyForDisplay()) {
+                MetadataBlock mdbTest = dsf.getDatasetFieldType().getMetadataBlock();
                 if (!viewMDB.contains(mdbTest)) {
                     viewMDB.add(mdbTest);
                 }
             }
-        }       
-        
+        }
+
         for (MetadataBlock mdb : viewMDB) {
 
             List<DatasetField> datasetFieldsForView = new ArrayList<>();
             for (DatasetField dsf : this.getDatasetFields()) {
                 if (dsf.getDatasetFieldType().getMetadataBlock().equals(mdb)) {
-                    if (!dsf.isEmpty()) {
+                    //For viewing, show the field if it has a value or custom instructions
+                    if (!dsf.isEmpty() || instructionsMap.containsKey(dsf.getDatasetFieldType().getName())) {
                         datasetFieldsForView.add(dsf);
                     }
                 }
@@ -344,6 +361,9 @@ public Template cloneNewTemplate(Template source) {
         }
         terms.setTemplate(newTemplate);
         newTemplate.setTermsOfUseAndAccess(terms);
+
+        newTemplate.getInstructionsMap().putAll(source.getInstructionsMap());
+        newTemplate.updateInstructions();
         return newTemplate;
     }
 
@@ -383,6 +403,45 @@ private List<DatasetField> getFlatDatasetFields(List<DatasetField> dsfList) {
         return retList;
     }
 
+    //Cache values in map for reading
+    public Map<String, String> getInstructionsMap() {
+        if(instructionsMap==null)
+            if(instructions != null) {
+            instructionsMap = JsonUtil.getJsonObject(instructions).entrySet().stream().collect(Collectors.toMap(entry -> entry.getKey(),entry -> ((JsonString)entry.getValue()).getString()));
+            } else {
+                instructionsMap = new HashMap<String,String>();
+        }
+        return instructionsMap;
+    }
+
+    //Get the cutstom instructions defined for a give fieldType
+    public String getInstructionsFor(String fieldType) {
+        return getInstructionsMap().get(fieldType);
+    }
+
+    /*
+    //Add/change or remove (null instructionString) instructions for a given fieldType
+    public void setInstructionsFor(String fieldType, String instructionString) {
+        if(instructionString==null) {
+            getInstructionsMap().remove(fieldType);
+        } else {
+        getInstructionsMap().put(fieldType, instructionString);
+        }
+        updateInstructions();
+    }
+    */
+
+    //Keep instructions up-to-date on any change
+    public void updateInstructions() {
+        JsonObjectBuilder builder = Json.createObjectBuilder();
+        getInstructionsMap().forEach((key, value) -> {
+            if (value != null)
+                builder.add(key, value);
+        });
+        instructions = JsonUtil.prettyPrint(builder.build());
+    }
+
+
     @Override
      public int hashCode() {
         int hash = 0;

src/main/java/edu/harvard/iq/dataverse/TemplatePage.java

@@ -185,6 +185,8 @@ public String save(String redirectPage) {
 
             DatasetFieldUtil.tidyUpFields( template.getDatasetFields(), false );
 
+            template.updateInstructions();
+
             if (editMode == EditMode.CREATE) {
                 template.setCreateTime(new Timestamp(new Date().getTime()));
                 template.setUsageCount(new Long(0));
@@ -247,5 +249,11 @@ public String deleteTemplate(Long templateId) {
         }
         return "/manage-templates.xhtml?dataverseId=" + dataverse.getId() + "&faces-redirect=true"; 
     }
+
+    //Get the cutstom instructions defined for a give fieldType
+    public String getInstructionsLabelFor(String fieldType) {
+        String fieldInstructions = template.getInstructionsMap().get(fieldType);
+        return (fieldInstructions!=null && !fieldInstructions.isBlank()) ? fieldInstructions : BundleUtil.getStringFromBundle("template.instructions.empty.label");
+    }
 
 }

src/main/java/edu/harvard/iq/dataverse/UserNotification.java

@@ -37,7 +37,7 @@ public enum Type {
         ASSIGNROLE, REVOKEROLE, CREATEDV, CREATEDS, CREATEACC, SUBMITTEDDS, RETURNEDDS, 
         PUBLISHEDDS, REQUESTFILEACCESS, GRANTFILEACCESS, REJECTFILEACCESS, FILESYSTEMIMPORT, 
         CHECKSUMIMPORT, CHECKSUMFAIL, CONFIRMEMAIL, APIGENERATED, INGESTCOMPLETED, INGESTCOMPLETEDWITHERRORS, 
-        PUBLISHFAILED_PIDREG, WORKFLOW_SUCCESS, WORKFLOW_FAILURE, STATUSUPDATED, DATASETCREATED;
+        PUBLISHFAILED_PIDREG, WORKFLOW_SUCCESS, WORKFLOW_FAILURE, STATUSUPDATED, DATASETCREATED, DATASETMENTIONED;
 
         public String getDescription() {
             return BundleUtil.getStringFromBundle("notification.typeDescription." + this.name());
@@ -88,6 +88,8 @@ public static String toStringValue(Set<Type> typesSet) {
     @Column( nullable = false )
     private Type type;
     private Long objectId;
+
+    private String additionalInfo;
 
     @Transient
     private boolean displayAsRead;
@@ -196,4 +198,12 @@ public void setRoleString(String roleString) {
     public String getLocaleSendDate() {
         return DateUtil.formatDate(sendDate);
     }
+
+    public String getAdditionalInfo() {
+        return additionalInfo;
+    }
+
+    public void setAdditionalInfo(String additionalInfo) {
+        this.additionalInfo = additionalInfo;
+    }
 }

src/main/java/edu/harvard/iq/dataverse/UserNotificationServiceBean.java

@@ -110,12 +110,16 @@ public void sendNotification(AuthenticatedUser dataverseUser, Timestamp sendDate
     }
 
     public void sendNotification(AuthenticatedUser dataverseUser, Timestamp sendDate, Type type, Long objectId, String comment, AuthenticatedUser requestor, boolean isHtmlContent) {
+        sendNotification(dataverseUser, sendDate, type, objectId, comment, requestor, isHtmlContent, null);
+    }
+    public void sendNotification(AuthenticatedUser dataverseUser, Timestamp sendDate, Type type, Long objectId, String comment, AuthenticatedUser requestor, boolean isHtmlContent, String additionalInfo) {
         UserNotification userNotification = new UserNotification();
         userNotification.setUser(dataverseUser);
         userNotification.setSendDate(sendDate);
         userNotification.setType(type);
         userNotification.setObjectId(objectId);
         userNotification.setRequestor(requestor);
+        userNotification.setAdditionalInfo(additionalInfo);
 
         if (!isEmailMuted(userNotification) && mailService.sendNotificationEmail(userNotification, comment, requestor, isHtmlContent)) {
             logger.fine("email was sent");

src/main/java/edu/harvard/iq/dataverse/api/Datasets.java

@@ -1592,8 +1592,7 @@ public Response getCustomTermsTab(@PathParam("id") String id, @PathParam("versio
         User user = session.getUser();
         String persistentId;
         try {
-            if (getDatasetVersionOrDie(createDataverseRequest(user), versionId, findDatasetOrDie(id), uriInfo, headers)
-                    .getTermsOfUseAndAccess().getLicense() != null) {
+            if (DatasetUtil.getLicense(getDatasetVersionOrDie(createDataverseRequest(user), versionId, findDatasetOrDie(id), uriInfo, headers)) != null) {
                 return error(Status.NOT_FOUND, "This Dataset has no custom license");
             }
             persistentId = getRequestParameter(":persistentId".substring(1));