PKPStatsHandler.inc.php

<?php
 
import('classes.handler.Handler');
import('classes.statistics.StatisticsHelper');
 
class PKPStatsHandler extends Handler {
 
   var $_isBackendPage = true;
 
   public function __construct() {
      parent::__construct();
      $this->addRoleAssignment(
         [ROLE_ID_SITE_ADMIN, ROLE_ID_MANAGER, ROLE_ID_SUB_EDITOR],
         ['editorial', 'publications', 'users']
      );
   }
 
   public function authorize($request, &$args, $roleAssignments) {
      import('lib.pkp.classes.security.authorization.ContextAccessPolicy');
      $this->addPolicy(new ContextAccessPolicy($request, $roleAssignments));
      return parent::authorize($request, $args, $roleAssignments);
   }
 
 
   //
   // Public handler methods.
   //
   public function editorial($args, $request) {
      $dispatcher = $request->getDispatcher();
      $context = $request->getContext();
 
      if (!$context) {
         $dispatcher->handle404();
      }
 
      $templateMgr = TemplateManager::getManager($request);
      $this->setupTemplate($request);
 
      $dateStart = date('Y-m-d', strtotime('-91 days'));
      $dateEnd = date('Y-m-d', strtotime('yesterday'));
 
      $args = [
         'contextIds' => [$context->getId()],
      ];
 
      $totals = Services::get('editorialStats')->getOverview($args);
      $averages = Services::get('editorialStats')->getAverages($args);
      $dateRangeTotals = Services::get('editorialStats')->getOverview(
         array_merge(
            $args,
            [
               'dateStart' => $dateStart,
               'dateEnd' => $dateEnd,
            ]
         )
      );
 
      // Stats that should be converted to percentages
      $percentageStats = [
         'acceptanceRate',
         'declineRate',
         'declinedDeskRate',
         'declinedReviewRate',
      ];
 
      // Stats that should be indented in the table
      $indentStats = [
         'submissionsDeclinedDeskReject',
         'submissionsDeclinedPostReview',
         'daysToAccept',
         'daysToReject',
         'declinedDeskRate',
         'declinedReviewRate',
      ];
 
      // Compile table rows
      $tableRows = [];
      foreach ($totals as $i => $stat) {
         $row = [
            'key' => $stat['key'],
            'name' => __($stat['name']),
            'total' => $stat['value'],
            'dateRange' => $dateRangeTotals[$i]['value'],
         ];
         if (in_array($stat['key'], $indentStats)) {
            $row['name'] = ' ' . $row['name'];
         }
         if (in_array($stat['key'], $percentageStats)) {
            $row['total'] = ($stat['value'] * 100) . '%';
            $row['dateRange'] = ($dateRangeTotals[$i]['value'] * 100) . '%';
         }
         $description = $this->_getStatDescription($stat['key']);
         if ($description) {
            $row['description'] = $description;
         }
         if (array_key_exists($stat['key'], $averages)
               && $averages[$stat['key']] !== -1
               && $row['total'] > 0) {
            $row['total'] = __('stats.countWithYearlyAverage', [
               'count' => $stat['value'],
               'average' => $averages[$stat['key']],
            ]);
         }
         $tableRows[] = $row;
      }
 
      // Get the worflow stage counts
      $activeByStage = [];
      foreach (Application::get()->getApplicationStages() as $stageId) {
         $activeByStage[] = [
            'name' => __(Application::get()->getWorkflowStageName($stageId)),
            'count' => Services::get('editorialStats')->countActiveByStages($stageId, $args),
            'color' => Application::get()->getWorkflowStageColor($stageId),
         ];
      }
 
      $statsComponent = new \PKP\components\PKPStatsEditorialPage(
         $dispatcher->url($request, ROUTE_API, $context->getPath(), 'stats/editorial'),
         [
            'activeByStage' => $activeByStage,
            'averagesApiUrl' => $dispatcher->url($request, ROUTE_API, $context->getPath(), 'stats/editorial/averages'),
            'dateStart' => $dateStart,
            'dateEnd' => $dateEnd,
            'dateRangeOptions' => [
               [
                  'dateStart' => date('Y-m-d', strtotime('-91 days')),
                  'dateEnd' => $dateEnd,
                  'label' => __('stats.dateRange.last90Days'),
               ],
               [
                  'dateStart' => date('Y-m-d', strtotime(date('Y') . '-01-01')),
                  'dateEnd' => $dateEnd,
                  'label' => __('stats.dateRange.thisYear'),
               ],
               [
                  'dateStart' => date('Y-m-d', strtotime((date('Y') - 1) . '-01-01')),
                  'dateEnd' => date('Y-m-d', strtotime((date('Y') - 1) . '-12-31')),
                  'label' => __('stats.dateRange.lastYear'),
               ],
               [
                  'dateStart' => date('Y-m-d', strtotime((date('Y') - 2) . '-01-01')),
                  'dateEnd' => date('Y-m-d', strtotime((date('Y') - 1) . '-12-31')),
                  'label' => __('stats.dateRange.lastTwoYears'),
               ],
            ],
            'percentageStats' => $percentageStats,
            'tableColumns' => [
               [
                  'name' => 'name',
                  'label' => __('common.name'),
                  'value' => 'name',
               ],
               [
                  'name' => 'dateRange',
                  'label' => $dateStart . ' — ' . $dateEnd,
                  'value' => 'dateRange',
               ],
               [
                  'name' => 'total',
                  'label' => __('stats.total'),
                  'value' => 'total',
               ],
            ],
            'tableRows' => $tableRows,
         ]
      );
 
      $templateMgr->setLocaleKeys([
         'stats.descriptionForStat',
         'stats.countWithYearlyAverage',
      ]);
      $templateMgr->setState($statsComponent->getConfig());
      $templateMgr->assign([
         'pageComponent' => 'StatsEditorialPage',
         'pageTitle' => __('stats.editorialActivity'),
      ]);
 
      $templateMgr->display('stats/editorial.tpl');
   }
 
   public function publications($args, $request) {
      $dispatcher = $request->getDispatcher();
      $context = $request->getContext();
 
      if (!$context) {
         $dispatcher->handle404();
      }
 
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_SUBMISSION);
      AppLocale::requireComponents(LOCALE_COMPONENT_APP_SUBMISSION);
 
      $templateMgr = TemplateManager::getManager($request);
      $this->setupTemplate($request);
 
      $dateStart = date('Y-m-d', strtotime('-31 days'));
      $dateEnd = date('Y-m-d', strtotime('yesterday'));
      $count = 30;
 
      $timeline = Services::get('stats')->getTimeline(STATISTICS_DIMENSION_DAY, [
         'assocTypes' => ASSOC_TYPE_SUBMISSION,
         'contextIds' => $context->getId(),
         'count' => $count,
         'dateStart' => $dateStart,
         'dateEnd' => $dateEnd,
      ]);
 
      $statsComponent = new \PKP\components\PKPStatsPublicationPage(
         $dispatcher->url($request, ROUTE_API, $context->getPath(), 'stats/publications'),
         [
            'timeline' => $timeline,
            'timelineInterval' => STATISTICS_DIMENSION_DAY,
            'timelineType' => 'abstract',
            'tableColumns' => [
               [
                  'name' => 'title',
                  'label' => __('common.title'),
               ],
               [
                  'name' => 'abstractViews',
                  'label' => __('submission.abstractViews'),
                  'value' => 'abstractViews',
               ],
               [
                  'name' => 'galleyViews',
                  'label' => __('stats.fileViews'),
                  'value' => 'galleyViews',
               ],
               [
                  'name' => 'pdf',
                  'label' => __('stats.pdf'),
                  'value' => 'pdfViews',
               ],
               [
                  'name' => 'html',
                  'label' => __('stats.html'),
                  'value' => 'htmlViews',
               ],
               [
                  'name' => 'other',
                  'label' => __('common.other'),
                  'value' => 'otherViews',
               ],
               [
                  'name' => 'total',
                  'label' => __('stats.total'),
                  'value' => 'total',
                  'orderBy' => 'total',
                  'initialOrderDirection' => true,
               ],
            ],
            'count' => $count,
            'dateStart' => $dateStart,
            'dateEnd' => $dateEnd,
            'dateRangeOptions' => [
               [
                  'dateStart' => $dateStart,
                  'dateEnd' => $dateEnd,
                  'label' => __('stats.dateRange.last30Days'),
               ],
               [
                  'dateStart' => date('Y-m-d', strtotime('-91 days')),
                  'dateEnd' => $dateEnd,
                  'label' => __('stats.dateRange.last90Days'),
               ],
               [
                  'dateStart' => date('Y-m-d', strtotime('-12 months')),
                  'dateEnd' => $dateEnd,
                  'label' => __('stats.dateRange.last12Months'),
               ],
               [
                  'dateStart' => '',
                  'dateEnd' => '',
                  'label' => __('stats.dateRange.allDates'),
               ],
            ],
            'orderBy' => 'total',
            'orderDirection' => true,
         ]
      );
 
      $templateMgr->setState($statsComponent->getConfig());
      $templateMgr->assign([
         'pageComponent' => 'StatsPublicationsPage',
         'pageTitle' => __('stats.publicationStats'),
         'pageWidth' => PAGE_WIDTH_WIDE,
      ]);
 
      $templateMgr->display('stats/publications.tpl');
   }
 
   public function users($args, $request) {
      $dispatcher = $request->getDispatcher();
      $context = $request->getContext();
 
      if (!$context) {
         $dispatcher->handle404();
      }
 
      $templateMgr = TemplateManager::getManager($request);
      $this->setupTemplate($request);
      $templateMgr->assign([
         'pageTitle' => __('stats.userStatistics'),
         'userStats' => array_map(
            function ($item) {
               $item['name'] = __($item['name']);
               return $item;
            },
            Services::get('user')->getRolesOverview(['contextId' => $context->getId()])
         ),
      ]);
      $templateMgr->display('stats/users.tpl');
   }
 
   protected function _getStatDescription($key) {
      switch ($key) {
         case 'daysToDecision': return __('stats.description.daysToDecision');
         case 'acceptanceRate': return __('stats.description.acceptRejectRate');
         case 'declineRate': return __('stats.description.acceptRejectRate');
      }
      return '';
   }
}