ReportGeneratorHandler.inc.php

<?php
 
import('classes.handler.Handler');
import('lib.pkp.classes.core.JSONMessage');
import('classes.statistics.StatisticsHelper');
 
class ReportGeneratorHandler extends Handler {
   function __construct() {
      parent::__construct();
      $this->addRoleAssignment(
         ROLE_ID_MANAGER,
         array('fetchReportGenerator', 'saveReportGenerator', 'fetchArticlesInfo', 'fetchRegions'));
   }
 
   function authorize($request, &$args, $roleAssignments) {
      import('lib.pkp.classes.security.authorization.ContextAccessPolicy');
      $this->addPolicy(new ContextAccessPolicy($request, $roleAssignments));
      return parent::authorize($request, $args, $roleAssignments);
   }
 
   function fetchReportGenerator($args, $request) {
      $this->setupTemplate($request);
      $reportGeneratorForm = $this->_getReportGeneratorForm($request);
      $reportGeneratorForm->initData();
 
      $formContent = $reportGeneratorForm->fetch($request);
 
      $json = new JSONMessage(true);
      if ($request->getUserVar('refreshForm')) {
         $json->setEvent('refreshForm', $formContent);
      } else {
         $json->setContent($formContent);
      }
 
      return $json;
   }
 
   function saveReportGenerator($args, $request) {
      $this->setupTemplate($request);
 
      $reportGeneratorForm = $this->_getReportGeneratorForm($request);
      $reportGeneratorForm->readInputData();
      $json = new JSONMessage(true);
      if ($reportGeneratorForm->validate()) {
         $reportUrl = $reportGeneratorForm->execute();
         $json->setAdditionalAttributes(array('reportUrl' => $reportUrl));
      } else {
         $json->setStatus(false);
      }
 
      return $json;
   }
 
   function fetchArticlesInfo($args, $request) {
      $this->validate();
 
      $issueId = (int) $request->getUserVar('issueId');
      import('lib.pkp.classes.core.JSONMessage');
 
      if (!$issueId) {
         return new JSONMessage(false);
      } else {
         $submissionsIterator = Services::get('submission')->getMany([
            'contextId' => $request->getContext()->getId(),
            'issueIds' => $issueId,
         ]);
         $articlesInfo = array();
         foreach ($submissionsIterator as $submission) {
            $articlesInfo[] = array('id' => $submission->getId(), 'title' => $submission->getLocalizedTitle());
         }
 
         return new JSONMessage(true, $articlesInfo);
      }
   }
 
   function fetchRegions($args, $request) {
      $this->validate();
 
      $countryId = (string) $request->getUserVar('countryId');
      import('lib.pkp.classes.core.JSONMessage');
 
      if ($countryId) {
         $statsHelper = new StatisticsHelper();
         $geoLocationTool = $statsHelper->getGeoLocationTool();
         if ($geoLocationTool) {
            $regions = $geoLocationTool->getRegions($countryId);
            if (!empty($regions)) {
               $regionsData = array();
               foreach ($regions as $id => $name) {
                  $regionsData[] = array('id' => $id, 'name' => $name);
               }
               return new JSONMessage(true, $regionsData);
            }
         }
      }
 
      return new JSONMessage(false);
   }
 
   function setupTemplate($request) {
      parent::setupTemplate($request);
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_MANAGER, LOCALE_COMPONENT_PKP_SUBMISSION,
         LOCALE_COMPONENT_APP_MANAGER, LOCALE_COMPONENT_APP_SUBMISSION);
   }
 
 
   //
   // Private helper methods.
   //
   function &_getReportGeneratorForm($request) {
      $router = $request->getRouter();
      $context = $router->getContext($request);
 
      $metricType = $request->getUserVar('metricType');
      if (!$metricType) {
         $metricType = $context->getDefaultMetricType();
      }
 
      $statsHelper = new StatisticsHelper();
      $reportPlugin = $statsHelper->getReportPluginByMetricType($metricType);
      if (!is_scalar($metricType) || !$reportPlugin) {
         fatalError('Invalid metric type.');
      }
 
      $columns = $reportPlugin->getColumns($metricType);
      $columns = array_flip(array_intersect(array_flip($statsHelper->getColumnNames()), $columns));
 
      $optionalColumns = $reportPlugin->getOptionalColumns($metricType);
      $optionalColumns = array_flip(array_intersect(array_flip($statsHelper->getColumnNames()), $optionalColumns));
 
      $objects = $reportPlugin->getObjectTypes($metricType);
      $objects = array_flip(array_intersect(array_flip($statsHelper->getObjectTypeString()), $objects));
 
      $defaultReportTemplates = $reportPlugin->getDefaultReportTemplates($metricType);
 
      // If the report plugin doesn't works with the file type column,
      // don't load file types.
      if (isset($columns[STATISTICS_DIMENSION_FILE_TYPE])) {
         $fileTypes = $statsHelper->getFileTypeString();
      } else {
         $fileTypes = null;
      }
 
      // Metric type will be presented in header, remove if any.
      if (isset($columns[STATISTICS_DIMENSION_METRIC_TYPE])) unset($columns[STATISTICS_DIMENSION_METRIC_TYPE]);
 
      $reportTemplate = $request->getUserVar('reportTemplate');
 
      import('controllers.statistics.form.ReportGeneratorForm');
      $reportGeneratorForm = new ReportGeneratorForm($columns, $optionalColumns,
         $objects, $fileTypes, $metricType, $defaultReportTemplates, $reportTemplate);
 
      return $reportGeneratorForm;
   }
}