Source: services/ReportService.js

/**
 * Copyright (C) 2005-2016 Alfresco Software Limited.
 *
 * This file is part of Alfresco
 *
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Alfresco is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * @module alfresco/services/SiteService
 * @extends module:alfresco/services/BaseService
 * @mixes module:alfresco/core/CoreXhr
 * @author Erik Winlöf
 */
define(["dojo/_base/declare",
        "alfresco/services/BaseService",
        "alfresco/core/CoreXhr",
        "alfresco/core/NotificationUtils",
        "alfresco/core/ObjectTypeUtils",
        "dojo/request/xhr",
        "dojo/json",
        "dojo/_base/lang",
        "service/constants/Default"],
        function(declare, BaseService, AlfXhr, NotificationUtils, ObjectTypeUtils, xhr, JSON, lang, AlfConstants) {

   return declare([BaseService, AlfXhr, NotificationUtils], {

      TOP_SITE_CONTRIBUTOR_REPORT: "TOP_SITE_CONTRIBUTOR_REPORT",
      SITE_CONTENT_REPORT: "SITE_CONTENT_REPORT",

      /**
       * An array of the i18n files to use with this widget.
       *
       * @instance
       * @type {Array}
       */
      i18nRequirements: [{i18nFile: "./i18n/ReportService.properties"}],

      /**
       * Sets up the subscriptions for the ReportService
       *
       * @instance
       * @since 1.0.32
       */
      registerSubscriptions: function alfresco_services_ReportService__registerSubscriptions() {
         this.alfSubscribe("ALF_RETRIEVE_SITE_CONTENT_REPORT", lang.hitch(this, this.getSiteContentReport));
         this.alfSubscribe("ALF_RETRIEVE_TOP_SITE_CONTRIBUTOR_REPORT", lang.hitch(this, this.getTopSiteContributorReport));
      },

      /**
       *
       * @instance
       * @param {object} payload The details of the request
       */
      getSiteContentReport: function alfresco_services_ReportService__getSiteContentReport(payload) {
         /*jshint eqnull:true*/
         var alfTopic = (payload.alfResponseTopic != null) ? payload.alfResponseTopic : "ALF_RETRIEVE_SITE_CONTENT_REPORT";
         var url = AlfConstants.PROXY_URI + "api/solrstats";
         if (payload.site) {
            url += "/site/" + encodeURIComponent(payload.site);
         }
         url += "?facet=content.mimetype";
         var config = {
            alfTopic: alfTopic,
            url: url,
            method: "GET",
            successCallback: this.publishSiteContentReport,
            callbackScope: this
         };
         this.serviceXhr(config);
      },

      publishSiteContentReport: function alfresco_services_ReportService__publishSiteContentReport(response, requestConfig) {
         this.alfPublish(requestConfig.alfTopic + "_SUCCESS", {
            requestConfig: requestConfig,
            response: {
               data: response,
               dataDescriptor: {
                  crosstabMode: false,
                  seriesInRows: false
               }
            }
         });
      },

      /**
       * Requests data that gives an overview of the amount of created content for each user in the site.
       *
       * @instance
       * @param {object} payload The details of the request
       */
      getTopSiteContributorReport: function alfresco_services_ReportService__getTopSiteContributorReport(payload) {
         /*jshint eqnull:true*/
         var alfTopic = (payload.alfResponseTopic != null) ? payload.alfResponseTopic : "ALF_RETRIEVE_TOP_SITE_CONTRIBUTOR_REPORT";
         var url = AlfConstants.PROXY_URI + "api/solrstats";
         if (payload.site)
         {
            url += "/site/" + encodeURIComponent(payload.site);
         }
         url += "?facet=content.creator";
         if (payload.startDate)
         {
            url += "&startDate=" + encodeURIComponent(payload.startDate);
         }
         if (payload.endDate)
         {
            url += "&endDate=" + encodeURIComponent(payload.endDate);
         }
         var config = {
            alfTopic: alfTopic,
            url: url,
            method: "GET",
            successCallback: this.publishTopSiteContributorReport,
            callbackScope: this
         };
         this.serviceXhr(config);
      },

      publishTopSiteContributorReport: function alfresco_services_ReportService__publishTopSiteContributorReport(response, requestConfig){
         this.alfPublish(requestConfig.alfTopic + "_SUCCESS", {
            requestConfig: requestConfig,
            response: {
               data: response,
               dataDescriptor: {
                  crosstabMode: false,
                  seriesInRows: false
               }
            }
         });
      }

   });
});