PKPUsageStatsReportPlugin.inc.php

<?php
 
import('lib.pkp.classes.plugins.ReportPlugin');
 
abstract class PKPUsageStatsReportPlugin extends ReportPlugin {
 
   function register($category, $path, $mainContextId = null) {
      $success = parent::register($category, $path, $mainContextId);
      $this->addLocaleData();
      return $success;
   }
 
   function getName() {
      return 'usageStatsReportPlugin';
   }
 
   function getDisplayName() {
      return __('plugins.reports.usageStats.report.displayName');
   }
 
   function getDescription() {
      return __('plugins.reports.usageStats.report.description');
   }
 
   function display($args, $request) {
      $router = $request->getRouter();
      $context = $router->getContext($request);
 
      $metricType = $this->getMetricTypes();
 
      import('classes.statistics.StatisticsHelper');
      $statsHelper = new StatisticsHelper();
      $columnNames = $statsHelper->getColumnNames();
      // Make sure we aggregate by month instead of day.
      unset($columnNames[STATISTICS_DIMENSION_DAY]);
      $columns = array_keys($columnNames);
 
      $reportArgs = array(
         'metricType' => $metricType,
         'columns' => $columns,
         'filters' => json_encode(array(STATISTICS_DIMENSION_CONTEXT_ID => $context->getId())),
         'orderBy' => json_encode(array(STATISTICS_DIMENSION_MONTH => STATISTICS_ORDER_ASC))
      );
 
      $request->redirect(null, null, 'tools', 'generateReport', $reportArgs);
   }
 
   function getMetrics($metricType = null, $columns = null, $filters = null, $orderBy = null, $range = null) {
      // This plug-in uses the MetricsDAO to store metrics. So we simply
      // delegate there.
      $metricsDao = DAORegistry::getDAO('MetricsDAO'); /* @var $metricsDao MetricsDAO */
      return $metricsDao->getMetrics($metricType, $columns, $filters, $orderBy, $range);
   }
 
   function getMetricDisplayType($metricType) {
      return __('plugins.reports.usageStats.metricType');
   }
 
   function getMetricFullName($metricType) {
      return __('plugins.reports.usageStats.metricType.full');
   }
 
   function getDefaultReportTemplates($metricTypes = null) {
      $reports = array();
      $pluginMetricTypes = $this->getMetricTypes();
      if (is_null($metricTypes)) $metricTypes = $pluginMetricTypes;
 
      if (!$this->isMetricTypeValid($metricTypes)) return $reports;
 
      // Context index page views.
      $columns = array(STATISTICS_DIMENSION_ASSOC_TYPE,
         STATISTICS_DIMENSION_CONTEXT_ID,
         STATISTICS_DIMENSION_MONTH,
         STATISTICS_DIMENSION_COUNTRY);
 
      $filter = array(STATISTICS_DIMENSION_ASSOC_TYPE => Application::getContextAssocType());
 
      // We allow the subclasses to define the name locale key.
      $reports[] = array('nameLocaleKey' => '',
            'metricType' => $metricTypes, 'columns' => $columns, 'filter' => $filter,
            'aggregationColumns' => $this->getAggregationColumns());
 
      return $reports;
   }
 
 
   function getOptionalColumns($metricType) {
      if (!$this->isMetricTypeValid($metricType)) return array();
      return array(
         STATISTICS_DIMENSION_CITY,
         STATISTICS_DIMENSION_REGION
      );
   }
 
 
   //
   // Protected methods.
   //
   protected function getAggregationColumns() {
      return array(STATISTICS_DIMENSION_COUNTRY,
         STATISTICS_DIMENSION_REGION,
         STATISTICS_DIMENSION_CITY,
         STATISTICS_DIMENSION_MONTH,
         STATISTICS_DIMENSION_DAY);
   }
 
   protected function isMetricTypeValid($metricType) {
      $pluginMetricTypes = $this->getMetricTypes();
      if (!is_array($metricType)) $metricType = array($metricType);
 
      // Check if the plugin supports the passed metric types.
      $intersection = array_intersect($metricType, $pluginMetricTypes);
      return !empty($intersection);
   }
}