Merged HEAD-BUG-FIX (5.0/Cloud) to HEAD (5.0/Cloud)

75005: Merged WAT2 (5.0/Cloud) to HEAD-BUG-FIX (5.0/Cloud)
      70182: WIP, allows date ranges for solr stats queries


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@75334 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

config/alfresco/templates/webscripts/org/alfresco/repository/solr/stats.get.json.ftl

@@ -13,13 +13,12 @@
       </#list>   
     ],
     "queryInfo": {
-       "numberFound": "${result.numberFound?c}",
+      "numberFound": "${result.numberFound?c}"
-       "totalRows": "${resultSize?c}"
+      ,"totalRows": "${resultSize?c}"
       <#if result.sum??>
-       ,
+         ,"sum": "${result.sum?c}"
-       "sum": "${result.sum?c}",
+         ,"max": "${result.max?c}"
-       "max": "${result.max?c}",
+         ,"mean": "${result.mean?c}"
-       "mean": "${result.mean?c}"
       </#if>    
     },
     "metadata": [

source/java/org/alfresco/repo/web/scripts/solr/StatsGet.java

@@ -5,7 +5,6 @@ import java.util.Map;
 
 import org.alfresco.model.ContentModel;
 import org.alfresco.repo.security.permissions.AccessDeniedException;
-import org.alfresco.service.cmr.search.SearchParameters.SortDefinition;
 import org.alfresco.service.cmr.search.SearchService;
 import org.alfresco.service.cmr.search.StatsParameters;
 import org.alfresco.service.cmr.search.StatsResultSet;
@@ -13,27 +12,39 @@ import org.alfresco.service.cmr.search.StatsService;
 import org.alfresco.service.cmr.site.SiteInfo;
 import org.alfresco.service.cmr.site.SiteService;
 import org.alfresco.service.namespace.QName;
+import org.alfresco.util.Pair;
+import org.joda.time.LocalDate;
 import org.springframework.extensions.webscripts.Cache;
 import org.springframework.extensions.webscripts.DeclarativeWebScript;
 import org.springframework.extensions.webscripts.Status;
 import org.springframework.extensions.webscripts.WebScriptRequest;
 
 /**
- * Gets stats on Solr content
+ * Retrieves statistics using solr.  For a list of potential facets call it with /api/solr/stats?listFacets=true
+ * You can pass one of these facets in eg. facet=content.creator .  The facet name can be used as a I18n resource bundle key,
+ * it also has a predefined structure: group.property[.type] eg. content.created.datetime. The [.type] is optional, the default is String.</description>
  *
+ * The facets are configured using Spring config.  For Dates it may be necessary to display a different value from the one you use to query,
+ * in this case add the value to the "displayedFacets" map.
  * @author Gethin James
  */
 public class StatsGet extends DeclarativeWebScript
 {
-
+    public static final String DATE_TIME_SUFFIX = "datetime";
     private StatsService stats;
     private SiteService siteService;
     private Map<String,String> facets;
+   // private Map<String,String> displayedFacets;  //alternative facets to use for display
     
     public void setFacets(Map<String, String> facets)
     {
         this.facets = facets;
     }
+//    
+//    public void setDisplayedFacets(Map<String, String> displayedFacets)
+//    {
+//        this.displayedFacets = displayedFacets;
+//    }
 
     public void setStats(StatsService stats)
     {
@@ -69,11 +80,17 @@ public class StatsGet extends DeclarativeWebScript
          }
        }
 
-       QName propFacet = findFacet(req.getParameter("facet"));
+       String facetKey = req.getParameter("facet");
-       String query = buildQuery(siteInfo);
+       if (facetKey == null) facetKey = facets.entrySet().iterator().next().getKey();  //default
+       //boolean usesDateTime = (facetKey != null && facetKey.endsWith(DATE_TIME_SUFFIX));
+       String query;
        
-       StatsParameters params = new StatsParameters(SearchService.LANGUAGE_SOLR_FTS_ALFRESCO, query);
+       QName propFacet = findFacet(facetKey);
-       params.addSort(new SortDefinition(SortDefinition.SortType.FIELD, "contentsize", false));
+       Pair<LocalDate, LocalDate> startAndEnd = getStartAndEndDates(req.getParameter("startDate"),req.getParameter("endDate"));
+       query = buildQuery(siteInfo, facetKey, startAndEnd);
+
+       StatsParameters params = new StatsParameters(SearchService.LANGUAGE_SOLR_FTS_ALFRESCO, query, false);
+       //params.addSort(new SortDefinition(SortDefinition.SortType.FIELD, "contentsize", false));
        params.addStatsParameter(StatsParameters.PARAM_FIELD, "contentsize");
        params.addStatsParameter(StatsParameters.PARAM_FACET, StatsParameters.FACET_PREFIX+propFacet.toString());
   
@@ -81,6 +98,7 @@ public class StatsGet extends DeclarativeWebScript
        
        model.put("result", result);
        model.put("resultSize", result.getStats().size());
+       //model.put("isDate", startAndEnd!=null);
        return model;
     }
 
@@ -91,22 +109,37 @@ public class StatsGet extends DeclarativeWebScript
      */
     private QName findFacet(String facetKey)
     {         
-       if (facetKey == null) facetKey = facets.entrySet().iterator().next().getKey();  //default
-           
        if (!facets.containsKey(facetKey))
        {
            throw new AccessDeniedException("Invalid facet key:"+facetKey);
        }
        
+       //If there is an alternative facet to use for display then use it.
+//       if (displayedFacets.containsKey(facetKey))
+//       {
+//           QName propFacet = QName.createQName(displayedFacets.get(facetKey));
+//           return propFacet;       
+//       }
+//       else 
+//       {
            QName propFacet = QName.createQName(facets.get(facetKey));
            return propFacet;
+   //    }
+
     }
 
-    protected String buildQuery(SiteInfo siteInfo)
+    protected String buildQuery(SiteInfo siteInfo, String facetKey, Pair<LocalDate, LocalDate> startEndDate)
     {
         StringBuilder luceneQuery = new StringBuilder();
         luceneQuery.append("TYPE:\"" + ContentModel.TYPE_CONTENT + "\"");
         
+        if (startEndDate != null)
+        {
+            //QName propFacet = QName.createQName(facets.get(facetKey));
+            String dateFacet = "{http://www.alfresco.org/model/content/1.0}created";//hard coded for now.
+            luceneQuery.append(" AND "+dateFacet.toString()+":(\""+startEndDate.getFirst()+"\"..\""+startEndDate.getSecond()+"\")");
+        }
+        
         if (siteInfo != null)
         {
             luceneQuery.append(" AND ANCESTOR:\""+siteInfo.getNodeRef().toString()+"\"");
@@ -114,6 +147,20 @@ public class StatsGet extends DeclarativeWebScript
         return luceneQuery.toString();
     }
     
+    /**
+     * Parses ISO8601 formatted Date Strings.
+     * @param start If start is null then defaults to 1 month
+     * @param end If end is null then it defaults to now();
+     * @return Pair <Start,End>
+     */
+    public static Pair<LocalDate, LocalDate> getStartAndEndDates(String start, String end)
+    {
+        if (start == null) return null;
+        LocalDate startDate = LocalDate.parse(start);
+        LocalDate endDate = end!=null?LocalDate.parse(end):LocalDate.now();
+        return new Pair<LocalDate, LocalDate>(startDate, endDate);
+    }
+
     /**
      * Allows you to add a facet to the list of available facets for Solr Statistics
      * @param facetKey e.g. content.mimetype