DRIVERPlugin.inc.php

<?php
 
define('DRIVER_ACCESS_OPEN', 0);
define('DRIVER_ACCESS_CLOSED', 1);
define('DRIVER_ACCESS_EMBARGOED', 2);
define('DRIVER_ACCESS_DELAYED', 3);
define('DRIVER_ACCESS_RESTRICTED', 4);
 
import('lib.pkp.classes.plugins.GenericPlugin');
 
class DRIVERPlugin extends GenericPlugin {
 
   function register($category, $path, $mainContextId = null) {
      $success = parent::register($category, $path, $mainContextId);
      if ($success && $this->getEnabled($mainContextId)) {
         $this->import('DRIVERDAO');
         $driverDao = new DRIVERDAO();
         DAORegistry::registerDAO('DRIVERDAO', $driverDao);
 
         // Add DRIVER set to OAI results
         HookRegistry::register('OAIDAO::getJournalSets', array($this, 'sets'));
         HookRegistry::register('JournalOAI::records', array($this, 'recordsOrIdentifiers'));
         HookRegistry::register('JournalOAI::identifiers', array($this, 'recordsOrIdentifiers'));
         HookRegistry::register('OAIDAO::_returnRecordFromRow', array($this, 'addSet'));
         HookRegistry::register('OAIDAO::_returnIdentifierFromRow', array($this, 'addSet'));
 
         // consider DRIVER article in article tombstones
         HookRegistry::register('ArticleTombstoneManager::insertArticleTombstone', array($this, 'insertDRIVERArticleTombstone'));
      }
      return $success;
   }
 
   function getDisplayName() {
      return __('plugins.generic.driver.displayName');
   }
 
   function getDescription() {
      return __('plugins.generic.driver.description');
   }
 
   /*
    * OAI interface
    */
 
   function sets($hookName, $params) {
      $sets =& $params[5];
      array_push($sets, new OAISet('driver', 'Open Access DRIVERset', ''));
      return false;
   }
 
   function recordsOrIdentifiers($hookName, $params) {
      $journalOAI =& $params[0];
      $from = $params[1];
      $until = $params[2];
      $set = $params[3];
      $offset = $params[4];
      $limit = $params[5];
      $total =& $params[6];
      $records =& $params[7];
 
      $records = array();
      if (isset($set) && $set == 'driver') {
         $driverDao = DAORegistry::getDAO('DRIVERDAO'); /* @var $driverDao DRIVERDAO */
         $driverDao->setOAI($journalOAI);
         if ($hookName == 'JournalOAI::records') {
            $funcName = '_returnRecordFromRow';
         } else if ($hookName == 'JournalOAI::identifiers') {
            $funcName = '_returnIdentifierFromRow';
         }
         $journalId = $journalOAI->journalId;
         $records = $driverDao->getDRIVERRecordsOrIdentifiers(array($journalId, null), $from, $until, $offset, $limit, $total, $funcName);
         return true;
      }
      return false;
   }
 
   function addSet($hookName, $params) {
      $record =& $params[0];
      $row = $params[1];
 
      if ($this->isDRIVERRecord($row)) {
         $record->sets[] = 'driver';
      }
      return false;
   }
 
   function insertDRIVERArticleTombstone($hookName, $params) {
      $articleTombstone =& $params[0];
 
      if ($this->isDRIVERArticle($articleTombstone->getOAISetObjectId(ASSOC_TYPE_JOURNAL), $articleTombstone->getDataObjectId())) {
         $dataObjectTombstoneSettingsDao = DAORegistry::getDAO('DataObjectTombstoneSettingsDAO'); /* @var $dataObjectTombstoneSettingsDao DataObjectTombstoneSettingsDAO */
         $dataObjectTombstoneSettingsDao->updateSetting($articleTombstone->getId(), 'driver', true, 'bool');
      }
      return false;
   }
 
   function isDRIVERRecord($row) {
      // if the article is alive
      if (!isset($row['tombstone_id'])) {
         $journalDao = DAORegistry::getDAO('JournalDAO'); /* @var $journalDao JournalDAO */
         $issueDao = DAORegistry::getDAO('IssueDAO'); /* @var $issueDao IssueDAO */
 
         $journal = $journalDao->getById($row['journal_id']);
         $submission = Services::get('submission')->get($row['submission_id']);
         $publication = $submission->getCurrentPublication();
         $issue = $issueDao->getById($publication->getData('issueId'));
 
         // is open access
         $status = '';
         if ($journal->getData('publishingMode') == PUBLISHING_MODE_OPEN) {
            $status = DRIVER_ACCESS_OPEN;
         } else if ($journal->getData('publishingMode') == PUBLISHING_MODE_SUBSCRIPTION) {
            if ($issue->getAccessStatus() == 0 || $issue->getAccessStatus() == ISSUE_ACCESS_OPEN) {
               $status = DRIVER_ACCESS_OPEN;
            } else if ($issue->getAccessStatus() == ISSUE_ACCESS_SUBSCRIPTION) {
               if ($publication->getData('accessStatus') == ARTICLE_ACCESS_OPEN) {
                  $status = DRIVER_ACCESS_OPEN;
               } else if ($issue->getAccessStatus() == ISSUE_ACCESS_SUBSCRIPTION && $issue->getOpenAccessDate() != NULL) {
                  $status = DRIVER_ACCESS_EMBARGOED;
               } else if ($issue->getAccessStatus() == ISSUE_ACCESS_SUBSCRIPTION && $issue->getOpenAccessDate() == NULL) {
                  $status = DRIVER_ACCESS_CLOSED;
               }
            }
         }
         if ($journal->getData('restrictSiteAccess') == 1 || $journal->getData('restrictArticleAccess') == 1) {
            $status = DRIVER_ACCESS_RESTRICTED;
         }
 
         if ($status == DRIVER_ACCESS_EMBARGOED && date('Y-m-d') >= date('Y-m-d', strtotime($issue->getOpenAccessDate()))) {
            $status = DRIVER_ACCESS_DELAYED;
         }
 
         // is there a full text
         $galleys = $submission->getGalleys();
         if (!empty($galleys)) {
            return $status == DRIVER_ACCESS_OPEN;
         }
         return false;
      } else {
         $dataObjectTombstoneSettingsDao = DAORegistry::getDAO('DataObjectTombstoneSettingsDAO'); /* @var $dataObjectTombstoneSettingsDao DataObjectTombstoneSettingsDAO */
         return $dataObjectTombstoneSettingsDao->getSetting($row['tombstone_id'], 'driver');
      }
   }
 
 
   function isDRIVERArticle($journalId, $articleId) {
         $journalDao = DAORegistry::getDAO('JournalDAO'); /* @var $journalDao JournalDAO */
         $issueDao = DAORegistry::getDAO('IssueDAO'); /* @var $issueDao IssueDAO */
 
         $journal = $journalDao->getById($journalId);
         $submission = Services::get('submission')->get($articleId);
         $publication = $submission->getCurrentPublication();
         $issue = $issueDao->getById($publication->getData('issueId'));
 
         // is open access
         $status = '';
         if ($journal->getData('publishingMode') == PUBLISHING_MODE_OPEN) {
            $status = DRIVER_ACCESS_OPEN;
         } else if ($journal->getData('publishingMode') == PUBLISHING_MODE_SUBSCRIPTION) {
            if ($issue->getAccessStatus() == 0 || $issue->getAccessStatus() == ISSUE_ACCESS_OPEN) {
               $status = DRIVER_ACCESS_OPEN;
            } else if ($issue->getAccessStatus() == ISSUE_ACCESS_SUBSCRIPTION) {
               if ($publication->getData('accessStatus') == ARTICLE_ACCESS_OPEN) {
                  $status = DRIVER_ACCESS_OPEN;
               } else if ($issue->getAccessStatus() == ISSUE_ACCESS_SUBSCRIPTION && $issue->getOpenAccessDate() != NULL) {
                  $status = DRIVER_ACCESS_EMBARGOED;
               } else if ($issue->getAccessStatus() == ISSUE_ACCESS_SUBSCRIPTION && $issue->getOpenAccessDate() == NULL) {
                  $status = DRIVER_ACCESS_CLOSED;
               }
            }
         }
         if ($journal->getData('restrictSiteAccess') == 1 || $journal->getData('restrictArticleAccess') == 1) {
            $status = DRIVER_ACCESS_RESTRICTED;
         }
 
         if ($status == DRIVER_ACCESS_EMBARGOED && date('Y-m-d') >= date('Y-m-d', strtotime($issue->getOpenAccessDate()))) {
            $status = DRIVER_ACCESS_DELAYED;
         }
 
         // is there a full text
         $galleys = $submission->getGalleys();
         if (!empty($galleys)) {
            return $status == DRIVER_ACCESS_OPEN;
         }
         return false;
   }
 
}