PKPOAIDAO.inc.php

<?php
 
import('lib.pkp.classes.oai.OAI');
 
abstract class PKPOAIDAO extends DAO {
 
   var $oai;
 
 
   function setOAI($oai) {
      $this->oai = $oai;
   }
 
   //
   // Resumption tokens
   //
   function clearTokens() {
      $this->update(
         'DELETE FROM oai_resumption_tokens WHERE expire < ?', time()
      );
   }
 
   function getToken($tokenId) {
      $result = $this->retrieve(
         'SELECT * FROM oai_resumption_tokens WHERE token = ?',
         array($tokenId)
      );
 
      if ($result->RecordCount() == 0) {
         $token = null;
 
      } else {
         $row = $result->getRowAssoc(false);
         $token = new OAIResumptionToken($row['token'], $row['record_offset'], unserialize($row['params']), $row['expire']);
      }
 
      $result->Close();
      return $token;
   }
 
   function insertToken($token) {
      do {
         // Generate unique token ID
         $token->id = md5(uniqid(mt_rand(), true));
         $result = $this->retrieve(
            'SELECT COUNT(*) FROM oai_resumption_tokens WHERE token = ?',
            array($token->id)
         );
         $val = $result->fields[0];
 
         $result->Close();
      } while($val != 0);
 
      $this->update(
         'INSERT INTO oai_resumption_tokens (token, record_offset, params, expire)
         VALUES
         (?, ?, ?, ?)',
         array($token->id, $token->offset, serialize($token->params), $token->expire)
      );
 
      return $token;
   }
 
 
   function recordExists($dataObjectId, $setIds = array()) {
      return $this->getRecord($dataObjectId, $setIds)?true:false;
   }
 
   function getRecord($dataObjectId, $setIds = array()) {
      $result = $this->_getRecordsRecordSet($setIds, null, null, null, $dataObjectId);
      if ($result->RecordCount() != 0) {
         $row = $result->GetRowAssoc(false);
         $returner = $this->_returnRecordFromRow($row);
      } else $returner = null;
      $result->Close();
      return $returner;
   }
 
   function getRecords($setIds, $from, $until, $set, $offset, $limit, &$total) {
      $result = $this->_getRecordsRecordSet($setIds, $from, $until, $set);
      $total = $result->RecordCount();
 
      $records = array();
      $result->Move($offset);
      for ($count = 0; $count < $limit && !$result->EOF; $count++) {
         $row = $result->GetRowAssoc(false);
         $records[] = $this->_returnRecordFromRow($row);
         $result->MoveNext();
      }
      $result->Close();
      return $records;
   }
 
   function getIdentifiers($setIds, $from, $until, $set, $offset, $limit, &$total) {
      $result = $this->_getRecordsRecordSet($setIds, $from, $until, $set);
      $total = $result->RecordCount();
 
      $records = array();
      $result->Move($offset);
      for ($count = 0; $count < $limit && !$result->EOF; $count++) {
         $row = $result->GetRowAssoc(false);
         $records[] = $this->_returnIdentifierFromRow($row);
         $result->MoveNext();
      }
      $result->Close();
      return $records;
   }
 
   function getEarliestDatestamp($setIds = array()) {
      $result = $this->_getRecordsRecordSet($setIds, null, null, null, null, 'last_modified ASC');
      if ($result->RecordCount() != 0) {
         $row = $result->GetRowAssoc(false);
         $record = $this->_returnRecordFromRow($row);
         $datestamp = OAIUtils::UTCtoTimestamp($record->datestamp);
      } else {
         $datestamp = 0;
      }
      $result->Close();
      return $datestamp;
   }
 
 
   //
   // Private helper methods.
   //
   function _returnRecordFromRow($row) {
      $record = new OAIRecord();
      $record = $this->_doCommonOAIFromRowOperations($record, $row);
 
      HookRegistry::call('OAIDAO::_returnRecordFromRow', array(&$record, &$row));
 
      return $record;
   }
 
   function _returnIdentifierFromRow($row) {
      $record = new OAIIdentifier();
      $record = $this->_doCommonOAIFromRowOperations($record, $row);
 
      HookRegistry::call('OAIDAO::_returnIdentifierFromRow', array(&$record, &$row));
 
      return $record;
   }
 
   function _doCommonOAIFromRowOperations($record, $row) {
      $record->datestamp = OAIUtils::UTCDate(strtotime($this->datetimeFromDB($row['last_modified'])));
 
      if (isset($row['tombstone_id'])) {
         $record->identifier = $row['oai_identifier'];
         $record->sets = array($row['set_spec']);
         $record->status = OAIRECORD_STATUS_DELETED;
      } else {
         $record->status = OAIRECORD_STATUS_ALIVE;
         $record = $this->setOAIData($record, $row, is_a($record, 'OAIRecord'));
      }
 
      return $record;
   }
 
   abstract function _getRecordsRecordSet($setIds, $from, $until, $set, $submissionId = null, $orderBy = 'journal_id, submission_id');
}