plugins/generic/counter/CounterPlugin.inc.php

<?php

// $Id: CounterPlugin.inc.php,v 1.18 2008/07/01 18:08:56 asmecher Exp $


define('COUNTER_UID_VAR', 'CounterPlugin_UID');
import('classes.plugins.GenericPlugin');

class CounterPlugin extends GenericPlugin {
   function register($category, $path) {
      $isEnabled = $this->getSetting(0, 'enabled');
      $success = parent::register($category, $path);
      if ($success && $isEnabled === true) {

         HookRegistry::register ('Templates::Admin::Index::AdminFunctions', array(&$this, 'displayMenuOption'));
         HookRegistry::register ('Templates::Manager::Index::ManagementPages', array(&$this, 'displayMenuOption'));
         HookRegistry::register ('LoadHandler', array(&$this, 'handleRequest'));
         HookRegistry::register ('TemplateManager::display', array(&$this, 'logRequest'));

         $this->import('LogEntryDAO');
         $logEntryDao =& new LogEntryDAO();
         DAORegistry::registerDAO('LogEntryDAO', $logEntryDao);
      }
      return $success;
   }

   function getName() {
      return 'CounterPlugin';
   }

   function getDisplayName() {
      $this->addLocaleData();
      return Locale::translate('plugins.generic.counter');
   }

   function getDescription() {
      $this->addLocaleData();
      return Locale::translate('plugins.generic.counter.description');
   }

   function displayMenuOption($hookName, $args) {
      if (!Validation::isSiteAdmin()) return false;

      $params =& $args[0];
      $smarty =& $args[1];
      $output =& $args[2];

      $this->addLocaleData();
      $output .= '<li>&#187; <a href="' . Request::url(null, 'counter') . '">' . Locale::translate('plugins.generic.counter') . '</a></li>';
      return false;
   }

   function logRequest($hookName, $args) {
      $templateManager =& $args[0];
      $template =& $args[1];

      $site =& Request::getSite();
      $journal =& Request::getJournal();
      $session =& Request::getSession();

      if (!$journal) return false;

      if (($logUser = $session->getSessionVar(COUNTER_UID_VAR))=='') {
         $logUser = Core::getCurrentDate() . '_' . $session->getId();
         $session->setSessionVar(COUNTER_UID_VAR, $logUser);
      }

      switch ($template) {
         case 'article/article.tpl':
         case 'article/interstitial.tpl':
         case 'article/pdfInterstitial.tpl':
            // Log the request as an article view.
            $article = $templateManager->get_template_vars('article');
            $galley = $templateManager->get_template_vars('galley');

            // If no galley exists, this is an abstract
            // view -- don't include it. (FIXME?)
            if (!$galley) return false;

            $logEntry =& new LogEntry();
            $logEntry->setSite($site->getTitle($site->getPrimaryLocale()));
            $logEntry->setJournal($journal->getTitle($journal->getPrimaryLocale()));
            $logEntry->setJournalUrl(Request::url(null, 'index'));
            $logEntry->setPrintIssn($journal->getSetting('printIssn'));
            $logEntry->setOnlineIssn($journal->getSetting('onlineIssn'));
            $logEntry->setPublisher($journal->getLocalizedSetting('publisherInstitution'));
            $logEntry->setUser($logUser);
            if ($galley->isHTMLGalley()) $logEntry->setType(LOG_ENTRY_TYPE_HTML_ARTICLE);
            elseif ($galley->isPdfGalley()) $logEntry->setType(LOG_ENTRY_TYPE_PDF_ARTICLE);
            else $logEntry->setType(LOG_ENTRY_TYPE_OTHER_ARTICLE);
            $logEntry->setValue($article->getArticleTitle());
            $logEntryDao =& DAORegistry::getDAO('LogEntryDAO');
            $logEntryDao->addEntry($logEntry);
            break;
         case 'search/searchResults.tpl':
            // Log the request as a search.
            $logEntry =& new LogEntry();
            $article = $templateManager->get_template_vars('article');
            $logEntry->setSite($site->getTitle($site->getPrimaryLocale()));
            $logEntry->setJournal($journal->getTitle($journal->getPrimaryLocale()));
            $logEntry->setJournalUrl(Request::url(null, 'index'));
            $logEntry->setUser($logUser);
            $logEntry->setType(LOG_ENTRY_TYPE_SEARCH);
            $logEntry->setValue(Request::getUserVar('query'));
            $logEntryDao =& DAORegistry::getDAO('LogEntryDAO');
            $logEntryDao->addEntry($logEntry);
            break;
      }

      return false;
   }

   function handleRequest($hookName, $args) {
      $page =& $args[0];
      $op =& $args[1];
      $sourceFile =& $args[2];

      // If the request is for the log analyzer itself, handle it.
      if ($page === 'counter') {
         $this->addLocaleData();
         $this->import('CounterHandler');
         Registry::set('plugin', $this);
         define('HANDLER_CLASS', 'CounterHandler');
         return true;
      }

      return false;
   }

   function isSitePlugin() {
      return true;
   }

   function getManagementVerbs() {
      $this->addLocaleData();
      $isEnabled = $this->getSetting(0, 'enabled');

      $verbs = array();

      // Non-site admin managers cannot manage Counter plugin.
      if (!Validation::isSiteAdmin()) return $verbs;

      if ($isEnabled) $verbs[] = array(
         'counter',
         Locale::translate('plugins.generic.counter')
      );
      $verbs[] = array(
         ($isEnabled?'disable':'enable'),
         Locale::translate($isEnabled?'manager.plugins.disable':'manager.plugins.enable')
      );
      return $verbs;
   }

   function manage($verb, $args) {

      // Non-site admin managers cannot manage Counter plugin.
      if (!Validation::isSiteAdmin()) return false;

      $isEnabled = $this->getSetting(0, 'enabled');
      $this->addLocaleData();
      switch ($verb) {
         case 'enable':
            $this->updateSetting(0, 'enabled', true);
            break;
         case 'disable':
            $this->updateSetting(0, 'enabled', false);
            break;
         case 'counter':
            if ($isEnabled) Request::redirect(null, 'counter');
      }
      return false;
   }
}

?>

---