Signposting

doc/release-notes/5962-signposting.md

@@ -0,0 +1,43 @@
+# Signposting for DV 5.5
+
+This branch adds [Signposting](https://signposting.org/) support to DV 5.5.
+
+There are 2 Signposting profile levels, level 1 and level 2. In this implementation, 
+ * level 1 links are shown in 
+HTTP header, which can be fetched by `curl -I https://domain/link-to-article`. 
+ * The level 2 linkset can be fetched by visiting the dedicated linkset page for 
+   that artifact. The link can be seen in level 1 links with key name `rel="linkset"`.
+
+The configuration is stored as JSON string in the `Bundle.properties` file, key name is
+`signposting.configuration.SignpostingConf`. Please see a sample configuration below with explaination for each of the
+config items.
+
+```json
+{
+  "license": {
+    "CC0": "https://creativecommons.org/licenses/cc0/"
+  },
+  "describedby": {
+    "doi": "https://doi.org/",
+    "type": "application/vnd.citationstyles.csl+json"
+  },
+  "useDefaultFileType": true,
+  "defaultFileTypeValue": "https://schema.org/Dataset",
+  "maxItems": 5,
+  "maxAuthors": 5
+}
+```
+
+ * The `license` is a `dict` contains the URI for `CC0`. Please be noted that this is a 
+temporary solution as all the licenses should be given by `multi-license` support once it's merged.
+ * `describedby` is required by [Signposting](https://signposting.org/). It shows the link to the metadata 
+which describes the resources that is the origin of the link.
+ * `useDefaultFileType` and `defaultFileTypeValue` are used in combination to provide extra `Dataset` type to DV 
+   datasets. `AboutPage` is required by `Signposting`, hence always present in the datasets. Whilst a second type 
+   could be configured to better reflect the actual scholarly type of the dataset. 
+ * `maxItems` sets the max number of items/files which will be shown in `level 1` profile. Datasets with 
+   too many files will not show any file link in `level 1` profile. They will be shown in `level 2` linkset only. 
+ * `maxAuthors` Same with `maxItems`, `maxAuthors` sets the max number of authors to be shown in `level 1` profile. 
+If amount of authors exceeds this value, no link of authors will be shown in `level 1` profile. 
+
+Note: Authors without author link will not be counted nor shown in any profile/linkset. 

pom.xml

@@ -675,12 +675,12 @@
         </dependency>
     </dependencies>
     <build>
-        <!--        <testResources>
+        <!--       <testResources>
             <testResource>
                 <directory>${project.basedir}/src/main/resources</directory>
             </testResource>
         </testResources>-->
-        <!--        <testResources>
+        <!--       <testResources>
             <testResource>
               <directory>${project.basedir}/src/test/java</directory>
               <excludes>

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

@@ -45,11 +45,8 @@
 import edu.harvard.iq.dataverse.search.SearchFilesServiceBean;
 import edu.harvard.iq.dataverse.search.SortBy;
 import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
-import edu.harvard.iq.dataverse.util.ArchiverUtil;
-import edu.harvard.iq.dataverse.util.BundleUtil;
-import edu.harvard.iq.dataverse.util.FileSortFieldAndOrder;
-import edu.harvard.iq.dataverse.util.FileUtil;
-import edu.harvard.iq.dataverse.util.JsfHelper;
+import edu.harvard.iq.dataverse.util.*;
+
 import static edu.harvard.iq.dataverse.util.JsfHelper.JH;
 import static edu.harvard.iq.dataverse.util.StringUtil.isEmpty;
 
@@ -85,6 +82,8 @@
 
 import org.primefaces.event.FileUploadEvent;
 import org.primefaces.model.file.UploadedFile;
+
+import javax.json.*;
 import javax.validation.ConstraintViolation;
 import org.apache.commons.httpclient.HttpClient;
 //import org.primefaces.context.RequestContext;
@@ -130,6 +129,7 @@
 import edu.harvard.iq.dataverse.search.SearchServiceBean;
 import edu.harvard.iq.dataverse.search.SearchUtil;
 import edu.harvard.iq.dataverse.search.SolrClientService;
+import edu.harvard.iq.dataverse.util.SignpostingResources;
 import java.util.Comparator;
 import org.apache.solr.client.solrj.SolrQuery;
 import org.apache.solr.client.solrj.impl.HttpSolrClient;
@@ -1917,7 +1917,7 @@ private String init(boolean initFull) {
                         logger.warning("Problem getting rsync script (Command Exception): " + cex.getLocalizedMessage());
                     }
                 }
-               
+
                 tooLargeToDownload = getSizeOfDatasetNumeric() > settingsWrapper.getZipDownloadLimit();
                 tooLargeToDownloadOriginal = getSizeOfDatasetOrigNumeric() > settingsWrapper.getZipDownloadLimit();
                 tooLargeToDownloadArchival = getSizeOfDatasetArchivalNumeric() > settingsWrapper.getZipDownloadLimit();
@@ -2940,15 +2940,15 @@ public void startDownloadAllOriginal(){
         this.setSelectedFiles(workingVersion.getFileMetadatas());
         startDownload(true);
     }
-    
+
     public void startDownloadSelectedArchival() {
         startDownload(false);
     }
 
     public void startDownloadSelectedOriginal() {
         startDownload(true);
     }
-    
+
     private void startDownload(boolean downloadOriginal){
         boolean guestbookRequired = isDownloadPopupRequired();
         boolean validate = validateFilesForDownload(guestbookRequired, downloadOriginal);
@@ -3019,15 +3019,15 @@ public boolean validateFilesForDownload(boolean guestbookRequired, boolean downl
             setValidateFilesOutcome("Mixed");
             return true;
         }
-        
+
         if (guestbookRequired) {
             setValidateFilesOutcome("GuestbookRequired");
         }
 
         return true;
 
     }
-    
+
     private void updateGuestbookResponse (boolean guestbookRequired, boolean downloadOriginal) {
         // Note that the GuestbookResponse object may still have information from
         // the last download action performed by the user. For example, it may
@@ -5477,4 +5477,15 @@ public boolean isFileDeleted (DataFile dataFile) {
 
         return dataFile.getDeleted();
     }
+
+    /**
+     * Add Signposting
+     * @return String
+     */
+    public String getSignpostingLinkHeader() {
+        if (!workingVersion.isReleased())
+            return "DRAFT";
+        SignpostingResources sr = new SignpostingResources(systemConfig, workingVersion, settingsService.getValueForKey(SettingsServiceBean.Key.SignpostingConf));
+        return sr.getLinks();
+    }
 }

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

@@ -836,6 +836,19 @@ protected static Response error( Status sts, String msg ) {
                         .add( "message", msg ).build()
                 ).type(MediaType.APPLICATION_JSON_TYPE).build();
     }
+
+    /**
+     * Adding Signposting
+     *
+     * @param bld
+     * @return HTTP OK response which contains the json structure of linkset
+     */
+    protected Response okLinkset( JsonArrayBuilder bld ) {
+        return Response.ok( Json.createObjectBuilder()
+                .add("linkset", bld).build() )
+                .type(MediaType.APPLICATION_JSON)
+                .build();
+    }
 }
 
 class LazyRef<T> {

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

@@ -925,7 +925,7 @@ public Response listBuiltinRoles() {
 			return error(Response.Status.INTERNAL_SERVER_ERROR, e.getMessage());
 		}
 	}
-        
+
     @DELETE
     @Path("roles/{id}")
     public Response deleteRole(@PathParam("id") String id) {

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

@@ -78,7 +78,6 @@
 import edu.harvard.iq.dataverse.ingest.IngestServiceBean;
 import edu.harvard.iq.dataverse.privateurl.PrivateUrl;
 import edu.harvard.iq.dataverse.S3PackageImporter;
-import static edu.harvard.iq.dataverse.api.AbstractApiBean.error;
 import edu.harvard.iq.dataverse.api.dto.RoleAssignmentDTO;
 import edu.harvard.iq.dataverse.batch.util.LoggingUtil;
 import edu.harvard.iq.dataverse.dataaccess.DataAccess;
@@ -104,9 +103,13 @@
 import edu.harvard.iq.dataverse.util.FileUtil;
 import edu.harvard.iq.dataverse.util.SystemConfig;
 import edu.harvard.iq.dataverse.util.json.JsonParseException;
+import edu.harvard.iq.dataverse.util.SignpostingResources;
 import edu.harvard.iq.dataverse.search.IndexServiceBean;
 import static edu.harvard.iq.dataverse.util.json.JsonPrinter.*;
+import static edu.harvard.iq.dataverse.util.json.JsonPrinter.jsonLinkset;
 import static edu.harvard.iq.dataverse.util.json.NullSafeJsonBuilder.jsonObjectBuilder;
+
+import edu.harvard.iq.dataverse.util.json.JsonPrinter;
 import edu.harvard.iq.dataverse.util.json.NullSafeJsonBuilder;
 import java.io.IOException;
 import java.io.InputStream;
@@ -535,7 +538,31 @@ public Response getVersionMetadataBlock( @PathParam("id") String datasetId,
             return notFound("metadata block named " + blockName + " not found");
         });
     }
-
+
+    /**
+     * Add Signposting
+     * @param datasetId
+     * @param versionId
+     * @param uriInfo
+     * @param headers
+     * @return
+     */
+    @GET
+    @Path("{id}/versions/{versionId}/linkset")
+    public Response getLinkset( @PathParam("id") String datasetId, @PathParam("versionId") String versionId, @Context UriInfo uriInfo, @Context HttpHeaders headers) {
+        if ( ":draft".equals(versionId) ) {
+            return badRequest("The :draft version can be viewed");
+        }
+        return response( req -> {
+            DatasetVersion dsv = getDatasetVersionOrDie(req, versionId, findDatasetOrDie(datasetId), uriInfo, headers);
+            String dataverseSiteUrl = systemConfig.getDataverseSiteUrl();
+            String anchor = dataverseSiteUrl + "/dataset.xhtml?persistentId=" + dsv.getDataset().getPersistentURL();
+            String signpostingConf = settingsService.getValueForKey(SettingsServiceBean.Key.SignpostingConf, BundleUtil.getStringFromBundle("signposting.configuration.SignpostingConf"));
+            if (signpostingConf.isEmpty()) return notFound("Configuration key for signposting is empty [SignpostingConf]");
+            if (dsv.getId() == null) return notFound("Dataset not found: Id is empty");
+            return okLinkset(JsonPrinter.jsonLinkset(new SignpostingResources(systemConfig, dsv, signpostingConf)));
+        });
+    }
     @GET
     @Path("{id}/modifyRegistration")
     public Response updateDatasetTargetURL(@PathParam("id") String id ) {

src/main/java/edu/harvard/iq/dataverse/settings/SettingsServiceBean.java

@@ -197,7 +197,12 @@ public enum Key {
          * some other metrics app.
          */
         MetricsUrl,
-
+
+        /**
+         * Key for Setting of Signposting
+         */
+        SignpostingConf,
+
         /**
          * Number of minutes before a metrics query can be rerun. Otherwise a cached value is returned.
          * Previous month dates always return cache. Only applies to new internal caching system (not miniverse).