make several usage statistics parameters configurable

Author: nwoodward

dspace-server-webapp/src/main/java/org/dspace/app/rest/utils/UsageReportUtils.java

@@ -27,6 +27,7 @@
 import org.dspace.core.Constants;
 import org.dspace.core.Context;
 import org.dspace.handle.service.HandleService;
+import org.dspace.services.ConfigurationService;
 import org.dspace.statistics.Dataset;
 import org.dspace.statistics.content.DatasetDSpaceObjectGenerator;
 import org.dspace.statistics.content.DatasetTimeGenerator;
@@ -46,6 +47,9 @@
 @Component
 public class UsageReportUtils {
 
+    @Autowired
+    private ConfigurationService configurationService;
+
     @Autowired
     private HandleService handleService;
 
@@ -135,13 +139,14 @@ public UsageReportRest createUsageReport(Context context, DSpaceObject dso, Stri
      */
     private UsageReportRest resolveGlobalUsageReport(Context context)
         throws SQLException, IOException, ParseException, SolrServerException {
+        int topItemsLimit = configurationService.getIntProperty("usage-statistics.topItemsLimit", 10);
+
         StatisticsListing statListing = new StatisticsListing(
             new StatisticsDataVisits());
 
-        // Adding a new generator for our top 10 items without a name length delimiter
+        // Adding a new generator for our top n items without a name length delimiter
         DatasetDSpaceObjectGenerator dsoAxis = new DatasetDSpaceObjectGenerator();
-        // TODO make max nr of top items (views wise)? Must be set
-        dsoAxis.addDsoChild(Constants.ITEM, 10, false, -1);
+        dsoAxis.addDsoChild(Constants.ITEM, topItemsLimit, false, -1);
         statListing.addDatasetGenerator(dsoAxis);
 
         Dataset dataset = statListing.getDataset(context, 1);
@@ -182,7 +187,7 @@ private UsageReportRest resolveTotalVisits(Context context, DSpaceObject dso)
         UsageReportPointDsoTotalVisitsRest totalVisitPoint = new UsageReportPointDsoTotalVisitsRest();
         totalVisitPoint.setType(StringUtils.substringAfterLast(dso.getClass().getName().toLowerCase(), "."));
         totalVisitPoint.setId(dso.getID().toString());
-        if (dataset.getColLabels().size() > 0) {
+        if (!dataset.getColLabels().isEmpty()) {
             totalVisitPoint.setLabel(dso.getName());
             totalVisitPoint.addValue("views", Integer.valueOf(dataset.getMatrix()[0][0]));
         } else {
@@ -205,10 +210,14 @@ private UsageReportRest resolveTotalVisits(Context context, DSpaceObject dso)
      */
     private UsageReportRest resolveTotalVisitsPerMonth(Context context, DSpaceObject dso)
         throws SQLException, IOException, ParseException, SolrServerException {
+        String startDateInterval =
+            configurationService.getProperty("usage-statistics.startDateInterval", "-6");
+        String endDateInterval =
+            configurationService.getProperty("usage-statistics.endDateInterval", "+1");
+
         StatisticsTable statisticsTable = new StatisticsTable(new StatisticsDataVisits(dso));
         DatasetTimeGenerator timeAxis = new DatasetTimeGenerator();
-        // TODO month start and end as request para?
-        timeAxis.setDateInterval("month", "-6", "+1");
+        timeAxis.setDateInterval("month", startDateInterval, endDateInterval);
         statisticsTable.addDatasetGenerator(timeAxis);
         DatasetDSpaceObjectGenerator dsoAxis = new DatasetDSpaceObjectGenerator();
         dsoAxis.addDsoChild(dso.getType(), 10, false, -1);
@@ -275,7 +284,10 @@ private UsageReportRest resolveTotalDownloads(Context context, DSpaceObject dso)
      */
     private UsageReportRest resolveTopCountries(Context context, DSpaceObject dso)
         throws SQLException, IOException, ParseException, SolrServerException {
-        Dataset dataset = this.getTypeStatsDataset(context, dso, "countryCode", 1);
+        int topCountriesLimit =
+            configurationService.getIntProperty("usage-statistics.topCountriesLimit", 100);
+
+        Dataset dataset = this.getTypeStatsDataset(context, dso, "countryCode", topCountriesLimit, 1);
 
         UsageReportRest usageReportRest = new UsageReportRest();
         for (int i = 0; i < dataset.getColLabels().size(); i++) {
@@ -299,7 +311,10 @@ private UsageReportRest resolveTopCountries(Context context, DSpaceObject dso)
      */
     private UsageReportRest resolveTopCities(Context context, DSpaceObject dso)
         throws SQLException, IOException, ParseException, SolrServerException {
-        Dataset dataset = this.getTypeStatsDataset(context, dso, "city", 1);
+        int topCitiesLimit =
+            configurationService.getIntProperty("usage-statistics.topCitiesLimit", 100);
+
+        Dataset dataset = this.getTypeStatsDataset(context, dso, "city", topCitiesLimit, 1);
 
         UsageReportRest usageReportRest = new UsageReportRest();
         for (int i = 0; i < dataset.getColLabels().size(); i++) {
@@ -339,16 +354,17 @@ private Dataset getDSOStatsDataset(Context context, DSpaceObject dso, int facetM
      * @param dso            DSO we want the stats dataset of
      * @param typeAxisString String of the type we want on the axis of the dataset (corresponds to solr field),
      *                       examples: countryCode, city
+     * @param typeAxisMax    Maximum amount of results to return in the dataset
      * @param facetMinCount  Minimum amount of results on a facet data point for it to be added to dataset
      * @return Stats dataset with the given type on the axis, of the given DSO and with given facetMinCount
      */
-    private Dataset getTypeStatsDataset(Context context, DSpaceObject dso, String typeAxisString, int facetMinCount)
+    private Dataset getTypeStatsDataset(Context context, DSpaceObject dso, String typeAxisString, int typeAxisMax,
+                                        int facetMinCount)
         throws SQLException, IOException, ParseException, SolrServerException {
         StatisticsListing statListing = new StatisticsListing(new StatisticsDataVisits(dso));
         DatasetTypeGenerator typeAxis = new DatasetTypeGenerator();
         typeAxis.setType(typeAxisString);
-        // TODO make max nr of top countries/cities a request para? Must be set
-        typeAxis.setMax(100);
+        typeAxis.setMax(typeAxisMax);
         statListing.addDatasetGenerator(typeAxis);
         return statListing.getDataset(context, facetMinCount);
     }

dspace/config/modules/usage-statistics.cfg

@@ -60,4 +60,21 @@ usage-statistics.shardedByYear = false
 #anonymize_statistics.dns_mask = anonymized
 
 # Only anonymize statistics records older than this threshold (expressed in days)
-#anonymize_statistics.time_threshold = 90
+#anonymize_statistics.time_threshold = 90
+
+# Maximum number of items to display in the usage statistics report for an entire repository
+usage-statistics.topItemsLimit = 10
+
+# Number of months to begin retrieving usage statistics for total visits per month of a DSpace object
+# For example, -6 means include the previous six months
+usage-statistics.startDateInterval = -6
+
+# Number of months to end retrieving usage statistics for total visits per month of a DSpace object
+# For example, +1 means include the current month
+usage-statistics.endDateInterval = +1
+
+# Maximum number of countries to display in the usage statistics reports
+usage-statistics.topCountriesLimit = 100
+
+# Maximum number of cities to display in the usage statistics reports
+usage-statistics.topCitiesLimit = 100