UsageEventPlugin.inc.php

<?php
 
import('lib.pkp.plugins.generic.usageEvent.PKPUsageEventPlugin');
 
class UsageEventPlugin extends PKPUsageEventPlugin {
 
 
   //
   // Implement methods from PKPUsageEventPlugin.
   //
   function getEventHooks() {
      return array_merge(parent::getEventHooks(), array(
         'ArticleHandler::download',
         'IssueHandler::download',
         'HtmlArticleGalleyPlugin::articleDownload',
         'HtmlArticleGalleyPlugin::articleDownloadFinished'
      ));
   }
 
   protected function getDownloadFinishedEventHooks() {
      return array_merge(parent::getDownloadFinishedEventHooks(), array(
         'HtmlArticleGalleyPlugin::articleDownloadFinished'
      ));
   }
 
   protected function getUsageEventData($hookName, $hookArgs, $request, $router, $templateMgr, $context) {
      list($pubObject, $downloadSuccess, $assocType, $idParams, $canonicalUrlPage, $canonicalUrlOp, $canonicalUrlParams) =
         parent::getUsageEventData($hookName, $hookArgs, $request, $router, $templateMgr, $context);
 
      if (!$pubObject) {
         switch ($hookName) {
            // Press index page, issue content page and article abstract.
            case 'TemplateManager::display':
               $page = $router->getRequestedPage($request);
               $op = $router->getRequestedOp($request);
               $args = $router->getRequestedArgs($request);
 
               $wantedPages = array('issue', 'article');
               $wantedOps = array('index', 'view');
 
               if (!in_array($page, $wantedPages) || !in_array($op, $wantedOps)) break;
 
               // View requests with 1 argument might relate to journal
               // or article. With more than 1 is related with other objects
               // that we are not interested in or that are counted using a
               // different hook.
               if ($op == 'view' && count($args) > 1) break;
 
               $journal = $templateMgr->getTemplateVars('currentContext');
               $issue = $templateMgr->getTemplateVars('issue');
               $submission = $templateMgr->getTemplateVars('article');
 
               // No published objects, no usage event.
               if (!$journal && !$issue && !$submission) break;
 
               if ($journal) {
                  $pubObject = $journal;
                  $assocType = ASSOC_TYPE_JOURNAL;
                  $canonicalUrlOp = '';
               }
 
               if ($issue) {
                  $pubObject = $issue;
                  $assocType = ASSOC_TYPE_ISSUE;
                  $canonicalUrlParams = array($issue->getId());
                  $idParams = array('s' . $issue->getId());
               }
 
               if ($submission) {
                  $pubObject = $submission;
                  $assocType = ASSOC_TYPE_SUBMISSION;
                  $canonicalUrlParams = array($pubObject->getId());
                  $idParams = array('m' . $pubObject->getId());
               }
 
               $downloadSuccess = true;
               $canonicalUrlOp = $op;
               break;
 
               // Issue galley.
            case 'IssueHandler::download':
               $assocType = ASSOC_TYPE_ISSUE_GALLEY;
               $issue = $hookArgs[0];
               $galley = $hookArgs[1];
               $canonicalUrlOp = 'download';
               $canonicalUrlParams = array($issue->getId(), $galley->getId());
               $idParams = array('i' . $issue->getId(), 'f' . $galley->getId());
               $downloadSuccess = false;
               $pubObject = $galley;
               break;
 
               // Article file.
            case 'ArticleHandler::download':
            case 'HtmlArticleGalleyPlugin::articleDownload':
               $assocType = ASSOC_TYPE_SUBMISSION_FILE;
               $article = $hookArgs[0];
               $galley = $hookArgs[1];
               $fileId = $hookArgs[2];
               // if file is not a gallay file (e.g. CSS or images), there is no usage event.
               if ($galley->getFileId() != $fileId) return false;
               $canonicalUrlOp = 'download';
               $canonicalUrlParams = array($article->getId(), $galley->getId(), $fileId);
               $idParams = array('a' . $article->getId(), 'g' . $galley->getId(), 'f' . $fileId);
               $downloadSuccess = false;
               $submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO'); /* @var $submissionFileDao SubmissionFileDAO */
               $pubObject = $submissionFileDao->getLatestRevision($fileId);
               break;
            default:
               // Why are we called from an unknown hook?
               assert(false);
         }
      }
 
      return array($pubObject, $downloadSuccess, $assocType, $idParams, $canonicalUrlPage, $canonicalUrlOp, $canonicalUrlParams);
   }
 
   protected function getHtmlPageAssocTypes() {
      return array(
         ASSOC_TYPE_JOURNAL,
         ASSOC_TYPE_ISSUE,
         ASSOC_TYPE_SUBMISSION,
      );
   }
 
   protected function isPubIdObjectType($pubObject) {
      return is_a($pubObject, 'Submission');
   }
 
}