IQSS/7177 enhance metrics api

doc/release-notes/7178-new_metrics.md

@@ -0,0 +1,3 @@
+## Major Use Cases
+
+- Users can retrieve new types of metrics and per-collection metrics. The new capabilities are described in the guides. A new version of the [Dataverse Metrics web app](https://github.com/IQSS/dataverse-metrics) adds interactive graphs to display these metrics. Anyone running the existing Dataverse Metrics app will need to upgrade or apply [a small patch](https://github.com/IQSS/dataverse-metrics/pull/60) to continue retrieving metrics from Dataverse instances upgrading to this release. Issue #7177/PR #7178

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

@@ -15,6 +15,8 @@
 import javax.persistence.GenerationType;
 import javax.persistence.Id;
 import javax.persistence.Index;
+import javax.persistence.JoinColumn;
+import javax.persistence.ManyToOne;
 import javax.persistence.Table;
 import javax.persistence.Temporal;
 import javax.persistence.TemporalType;
@@ -46,6 +48,10 @@ public class Metric implements Serializable {
     @Column(columnDefinition = "TEXT", nullable = true)
     private String dayString;
 
+    @ManyToOne(optional=true)
+    @JoinColumn(name="dataverse_id", nullable=true)
+    private Dataverse dataverse;
+
     @Temporal(value = TemporalType.TIMESTAMP)
     @Column(nullable = false)
     private Date lastCalledDate;
@@ -55,16 +61,21 @@ public Metric() {
     }
 
     //For monthly and day metrics
-
-    public Metric(String name, String dayString, String dataLocation, String value) throws IOException {
-        if(null == name || null == value) {
-            throw new IOException("A created metric must have a metricName and metricValue");
-        }
+    /**
+     * 
+     * @param name - metric name
+     * @param dayString - how many days (day metric only)
+     * @param dataLocation - local, remote, all
+     * @param d - the parent dataverse
+     * @param value - the value to cache
+     */
+    public Metric(String name, String dayString, String dataLocation, Dataverse d, String value) {
         this.name = name;
         this.valueJson = value;
         this.dataLocation = dataLocation;
         this.dayString = dayString;
         this.lastCalledDate = new Timestamp(new Date().getTime());
+        this.dataverse = d;
     }
 
     /**
@@ -121,4 +132,12 @@ public void setLastCalledDate(Date calledDate) {
         this.lastCalledDate = calledDate;
     }
 
+    public Dataverse getDataverse() {
+        return dataverse;
+    }
+
+    public void setDataverse(Dataverse dataverse) {
+        this.dataverse = dataverse;
+    }
+
 }

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

@@ -63,6 +63,7 @@
 import javax.ejb.EJB;
 import javax.ejb.EJBException;
 import javax.json.Json;
+import javax.json.JsonArray;
 import javax.json.JsonArrayBuilder;
 import javax.json.JsonObject;
 import javax.json.JsonObjectBuilder;
@@ -76,6 +77,7 @@
 import javax.ws.rs.core.Context;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
+import javax.ws.rs.core.Response.ResponseBuilder;
 import javax.ws.rs.core.Response.Status;
 import static org.apache.commons.lang.StringUtils.isNumeric;
 
@@ -706,7 +708,15 @@ protected Response response( DataverseRequestHandler hdl ) {
     protected Response ok( JsonArrayBuilder bld ) {
         return Response.ok(Json.createObjectBuilder()
             .add("status", STATUS_OK)
-            .add("data", bld).build()).build();
+            .add("data", bld).build())
+            .type(MediaType.APPLICATION_JSON).build();
+    }
+
+    protected Response ok( JsonArray ja ) {
+        return Response.ok(Json.createObjectBuilder()
+            .add("status", STATUS_OK)
+            .add("data", ja).build())
+            .type(MediaType.APPLICATION_JSON).build();
     }
 
     protected Response ok( JsonObjectBuilder bld ) {
@@ -716,6 +726,14 @@ protected Response ok( JsonObjectBuilder bld ) {
             .type(MediaType.APPLICATION_JSON)
             .build();
     }
+
+    protected Response ok( JsonObject jo ) {
+        return Response.ok( Json.createObjectBuilder()
+                .add("status", STATUS_OK)
+                .add("data", jo).build() )
+                .type(MediaType.APPLICATION_JSON)
+                .build();    
+    }
 
     protected Response ok( String msg ) {
         return Response.ok().entity(Json.createObjectBuilder()
@@ -743,10 +761,15 @@ protected Response ok( boolean value ) {
     /**
      * @param data Payload to return.
      * @param mediaType Non-JSON media type.
+     * @param downloadFilename - add Content-Disposition header to suggest filename if not null
      * @return Non-JSON response, such as a shell script.
      */
-    protected Response ok(String data, MediaType mediaType) {
-        return Response.ok().entity(data).type(mediaType).build();
+    protected Response ok(String data, MediaType mediaType, String downloadFilename) {
+        ResponseBuilder res =Response.ok().entity(data).type(mediaType);
+        if(downloadFilename != null) {
+            res = res.header("Content-Disposition", "attachment; filename=" + downloadFilename);
+        }
+        return res.build();
     }
 
     protected Response created( String uri, JsonObjectBuilder bld ) {

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

@@ -163,7 +163,7 @@ public void doFilter(ServletRequest sr, ServletResponse sr1, FilterChain fc) thr
             if (settingsSvc.isTrueForKey(SettingsServiceBean.Key.AllowCors, true )) {
                 ((HttpServletResponse) sr1).addHeader("Access-Control-Allow-Origin", "*");
                 ((HttpServletResponse) sr1).addHeader("Access-Control-Allow-Methods", "PUT, GET, POST, DELETE, OPTIONS");
-                ((HttpServletResponse) sr1).addHeader("Access-Control-Allow-Headers", "Content-Type, X-Dataverse-Key");
+                ((HttpServletResponse) sr1).addHeader("Access-Control-Allow-Headers", "Accept, Content-Type, X-Dataverse-Key");
             }
             fc.doFilter(sr, sr1);
         } catch ( ServletException se ) {

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

@@ -95,6 +95,7 @@
 import edu.harvard.iq.dataverse.makedatacount.DatasetMetricsServiceBean;
 import edu.harvard.iq.dataverse.makedatacount.MakeDataCountLoggingServiceBean;
 import edu.harvard.iq.dataverse.makedatacount.MakeDataCountLoggingServiceBean.MakeDataCountEntry;
+import edu.harvard.iq.dataverse.metrics.MetricsUtil;
 import edu.harvard.iq.dataverse.makedatacount.MakeDataCountUtil;
 import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
 import edu.harvard.iq.dataverse.util.ArchiverUtil;
@@ -1380,7 +1381,7 @@ public Response getRsync(@PathParam("identifier") String id) {
                 logger.log(Level.WARNING, "Failed to lock the dataset (dataset id={0})", dataset.getId());
                 return error(Response.Status.FORBIDDEN, "Failed to lock the dataset (dataset id="+dataset.getId()+")");
             }
-            return ok(scriptRequestResponse.getScript(), MediaType.valueOf(MediaType.TEXT_PLAIN));
+            return ok(scriptRequestResponse.getScript(), MediaType.valueOf(MediaType.TEXT_PLAIN), null);
         } catch (WrappedResponse wr) {
             return wr.getResponse();
         } catch (EJBException ex) {
@@ -2192,7 +2193,13 @@ public Response getMakeDataCountMetric(@PathParam("id") String idSupplied, @Path
             if (yyyymm != null) {
                 // We add "-01" because we store "2018-05-01" rather than "2018-05" in the "monthyear" column.
                 // Dates come to us as "2018-05-01" in the SUSHI JSON ("begin-date") and we decided to store them as-is.
-                monthYear = yyyymm + "-01";
+                monthYear = MetricsUtil.sanitizeYearMonthUserInput(yyyymm) + "-01";
+            }
+            if (country != null) {
+                country = country.toLowerCase();
+                if (!MakeDataCountUtil.isValidCountryCode(country)) {
+                    return error(Response.Status.BAD_REQUEST, "Country must be one of the ISO 1366 Country Codes");
+                }
             }
             DatasetMetrics datasetMetrics = datasetMetricsSvc.getDatasetMetricsByDatasetForDisplay(dataset, monthYear, country);
             if (datasetMetrics == null) {
@@ -2273,6 +2280,9 @@ public Response getMakeDataCountMetric(@PathParam("id") String idSupplied, @Path
             return ok(jsonObjectBuilder);
         } catch (WrappedResponse wr) {
             return wr.getResponse();
+        } catch (Exception e) {
+            //bad date - caught in sanitize call
+            return error(BAD_REQUEST, e.getMessage());
         }
     }