JournalOAI.inc.php

<?php
 
import('lib.pkp.classes.oai.OAI');
import('classes.oai.ojs.OAIDAO');
 
class JournalOAI extends OAI {
   var $site;
 
   var $journal;
 
   var $journalId;
 
   var $dao;
 
 
   function __construct($config) {
      parent::__construct($config);
 
      $request = Application::get()->getRequest();
      $this->site = $request->getSite();
      $this->journal = $request->getJournal();
      $this->journalId = isset($this->journal) ? $this->journal->getId() : null;
      $this->dao = DAORegistry::getDAO('OAIDAO');
      $this->dao->setOAI($this);
   }
 
   function getNonPathInfoParams() {
      return array('journal', 'page');
   }
 
   function articleIdToIdentifier($articleId) {
      return 'oai:' . $this->config->repositoryId . ':' . 'article/' . $articleId;
   }
 
   function identifierToArticleId($identifier) {
      $prefix = 'oai:' . $this->config->repositoryId . ':' . 'article/';
      if (strstr($identifier, $prefix)) {
         return (int) str_replace($prefix, '', $identifier);
      } else {
         return false;
      }
   }
 
   function setSpecToSectionId($setSpec, $journalId = null) {
      $tmpArray = preg_split('/:/', $setSpec);
      if (count($tmpArray) == 1) {
         list($journalSpec) = $tmpArray;
         $journalSpec = urldecode($journalSpec);
         $sectionSpec = null;
      } else if (count($tmpArray) == 2) {
         list($journalSpec, $sectionSpec) = $tmpArray;
         $journalSpec = urldecode($journalSpec);
         $sectionSpec = urldecode($sectionSpec);
      } else {
         return array(0, 0);
      }
      return $this->dao->getSetJournalSectionId($journalSpec, $sectionSpec, $this->journalId);
   }
 
 
   //
   // OAI interface functions
   //
 
   function repositoryInfo() {
      $info = new OAIRepository();
 
      if (isset($this->journal)) {
         $info->repositoryName = $this->journal->getLocalizedName();
         $info->adminEmail = $this->journal->getData('contactEmail');
 
      } else {
         $info->repositoryName = $this->site->getLocalizedTitle();
         $info->adminEmail = $this->site->getLocalizedContactEmail();
      }
 
      $info->sampleIdentifier = $this->articleIdToIdentifier(1);
      $info->earliestDatestamp = $this->dao->getEarliestDatestamp(array($this->journalId));
 
      $info->toolkitTitle = 'Open Journal Systems';
      $versionDao = DAORegistry::getDAO('VersionDAO'); /* @var $versionDao VersionDAO */
      $currentVersion = $versionDao->getCurrentVersion();
      $info->toolkitVersion = $currentVersion->getVersionString();
      $info->toolkitURL = 'http://pkp.sfu.ca/ojs/';
 
      return $info;
   }
 
   function validIdentifier($identifier) {
      return $this->identifierToArticleId($identifier) !== false;
   }
 
   function identifierExists($identifier) {
      $recordExists = false;
      $articleId = $this->identifierToArticleId($identifier);
      if ($articleId) {
         $recordExists = $this->dao->recordExists($articleId, array($this->journalId));
      }
      return $recordExists;
   }
 
   function record($identifier) {
      $articleId = $this->identifierToArticleId($identifier);
      if ($articleId) {
         $record = $this->dao->getRecord($articleId, array($this->journalId));
      }
      if (!isset($record)) {
         $record = false;
      }
      return $record;
   }
 
   function records($metadataPrefix, $from, $until, $set, $offset, $limit, &$total) {
      $records = null;
      if (!HookRegistry::call('JournalOAI::records', array($this, $from, $until, $set, $offset, $limit, &$total, &$records))) {
         $sectionId = null;
         if (isset($set)) {
            list($journalId, $sectionId) = $this->setSpecToSectionId($set);
         } else {
            $journalId = $this->journalId;
         }
         $records = $this->dao->getRecords(array($journalId, $sectionId), $from, $until, $set, $offset, $limit, $total);
      }
      return $records;
   }
 
   function identifiers($metadataPrefix, $from, $until, $set, $offset, $limit, &$total) {
      $records = null;
      if (!HookRegistry::call('JournalOAI::identifiers', array($this, $from, $until, $set, $offset, $limit, &$total, &$records))) {
         $sectionId = null;
         if (isset($set)) {
            list($journalId, $sectionId) = $this->setSpecToSectionId($set);
         } else {
            $journalId = $this->journalId;
         }
         $records = $this->dao->getIdentifiers(array($journalId, $sectionId), $from, $until, $set, $offset, $limit, $total);
      }
      return $records;
   }
 
   function sets($offset, $limit, &$total) {
      $sets = null;
      if (!HookRegistry::call('JournalOAI::sets', array($this, $offset, $limit, &$total, &$sets))) {
         $sets = $this->dao->getJournalSets($this->journalId, $offset, $limit, $total);
      }
      return $sets;
   }
 
   function resumptionToken($tokenId) {
      $this->dao->clearTokens();
      $token = $this->dao->getToken($tokenId);
      if (!isset($token)) {
         $token = false;
      }
      return $token;
   }
 
   function saveResumptionToken($offset, $params) {
      $token = new OAIResumptionToken(null, $offset, $params, time() + $this->config->tokenLifetime);
      $this->dao->insertToken($token);
      return $token;
   }
}