classes/oai/omp/PressOAI.inc.php

<?php

import('lib.pkp.classes.oai.OAI');
import('classes.oai.omp.OAIDAO');

class PressOAI extends OAI {
   var $site;

   var $press;

   var $pressId;

   var $dao;


   function PressOAI($config) {
      parent::OAI($config);

      $this->site =& Request::getSite();
      $this->press =& Request::getPress();
      $this->pressId = isset($this->press) ? $this->press->getId() : null;
      $this->dao =& DAORegistry::getDAO('OAIDAO');
      $this->dao->setOAI($this);
   }

   function getNonPathInfoParams() {
      return array('press', 'page');
   }

   function publicationFormatIdToIdentifier($publicationFormatId) {
      $prefix = $this->_getIdentifierPrefix();
      return $prefix . $publicationFormatId;
   }

   function identifierToPublicationFormatId($identifier) {
      $prefix = $this->_getIdentifierPrefix();
      if (strstr($identifier, $prefix)) {
         return (int) str_replace($prefix, '', $identifier);
      } else {
         return false;
      }
   }

   function setSpecToSeriesId($setSpec, $pressId = null) {
      $tmpArray = split(':', $setSpec);
      if (count($tmpArray) == 1) {
         list($pressSpec) = $tmpArray;
         $pressSpec = urldecode($pressSpec);
         $seriesSpec = null;
      } else if (count($tmpArray) == 2) {
         list($pressSpec, $seriesSpec) = $tmpArray;
         $pressSpec = urldecode($pressSpec);
         $seriesSpec = urldecode($seriesSpec);
      } else {
         return array(0, 0);
      }
      return $this->dao->getSetPressSeriesId($pressSpec, $seriesSpec, $this->pressId);
   }


   //
   // OAI interface functions
   //

   function &repositoryInfo() {
      $info = new OAIRepository();

      if (isset($this->press)) {
         $info->repositoryName = $this->press->getLocalizedName();
         $info->adminEmail = $this->press->getSetting('contactEmail');

      } else {
         $info->repositoryName = $this->site->getLocalizedTitle();
         $info->adminEmail = $this->site->getLocalizedContactEmail();
      }

      $info->sampleIdentifier = $this->publicationFormatIdToIdentifier(1);
      $info->earliestDatestamp = $this->dao->getEarliestDatestamp(array($this->pressId));

      $info->toolkitTitle = 'Open Monograph Press';
      $versionDao =& DAORegistry::getDAO('VersionDAO');
      $currentVersion =& $versionDao->getCurrentVersion();
      $info->toolkitVersion = $currentVersion->getVersionString(false);
      $info->toolkitURL = 'http://pkp.sfu.ca/omp/';

      return $info;
   }

   function validIdentifier($identifier) {
      return $this->identifierToPublicationFormatId($identifier) !== false;
   }

   function identifierExists($identifier) {
      $recordExists = false;
      $publicationFormatId = $this->identifierToPublicationFormatId($identifier);
      if ($publicationFormatId) {
         $recordExists = $this->dao->recordExists($publicationFormatId, array($this->pressId));
      }
      return $recordExists;
   }

   function &record($identifier) {
      $publicationFormatId = $this->identifierToPublicationFormatId($identifier);
      if ($publicationFormatId) {
         $record =& $this->dao->getRecord($publicationFormatId, array($this->pressId));
      }
      if (!isset($record)) {
         $record = false;
      }
      return $record;
   }

   function &records($metadataPrefix, $from, $until, $set, $offset, $limit, &$total) {
      $records = null;
      if (!HookRegistry::call('PressOAI::records', array(&$this, $from, $until, $set, $offset, $limit, $total, &$records))) {
         $seriesId = null;
         if (isset($set)) {
            list($pressId, $seriesId) = $this->setSpecToSeriesId($set);
         } else {
            $pressId = $this->pressId;
         }
         $records =& $this->dao->getRecords(array($pressId, $seriesId), $from, $until, $set, $offset, $limit, $total);
      }
      return $records;
   }

   function &identifiers($metadataPrefix, $from, $until, $set, $offset, $limit, &$total) {
      $records = null;
      if (!HookRegistry::call('PressOAI::identifiers', array(&$this, $from, $until, $set, $offset, $limit, $total, &$records))) {
         $seriesId = null;
         if (isset($set)) {
            list($pressId, $seriesId) = $this->setSpecToSeriesId($set);
         } else {
            $pressId = $this->pressId;
         }
         $records =& $this->dao->getIdentifiers(array($pressId, $sectionId), $from, $until, $set, $offset, $limit, $total);
      }
      return $records;
   }

   function &sets($offset, $limit, &$total) {
      $sets = null;
      if (!HookRegistry::call('PressOAI::sets', array(&$this, $offset, $limit, $total, &$sets))) {
         $sets =& $this->dao->getSets($this->pressId, $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;
   }


   //
   // Private helper methods
   //
   function _getIdentifierPrefix() {
      return 'oai:' . $this->config->repositoryId . ':' . 'publicationFormat/';
   }
}

?>