opencultureconsulting
/
simple-oai-pmh
mirror of https://github.com/opencultureconsulting/simple-oai-pmh.git
2
0
Fork 0
Code Issues Releases Activity

Removed OAI client and Moodle integration

This commit is contained in:
Sebastian Meyer 2017-05-04 16:29:45 +02:00
parent fad4f72a2b
commit fc28928f56
3 changed files with 0 additions and 244 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
client.php
View File

@ -1,12 +0,0 @@
<?php
require_once('oai2client.php');
$client = new OAI2Client('http://localhost/~daniel/2moodle/local/oai_pmh/moodle.php');
var_dump($client->Identify());
var_dump($client->ListMetadataFormats());
var_dump($client->ListSets());
var_dump($client->ListIdentifiers(array('metadataPrefix' => 'oai_dc')));
var_dump($client->ListRecords(array('metadataPrefix' => 'oai_dc')));
var_dump($client->GetRecord('aaaaa', 'oai_dc'));

147
moodle.php
View File

@ -1,147 +0,0 @@
<?php
require_once('oai2server.php');
/**
* Identifier settings. It needs to have proper values to reflect the settings of the data provider.
* Is MUST be declared in this order
*
* - $identifyResponse['repositoryName'] : compulsory. A human readable name for the repository;
* - $identifyResponse['baseURL'] : compulsory. The base URL of the repository;
* - $identifyResponse['protocolVersion'] : compulsory. The version of the OAI-PMH supported by the repository;
* - $identifyResponse['earliestDatestamp'] : compulsory. A UTCdatetime that is the guaranteed lower limit of all datestamps recording changes, modifications, or deletions in the repository. A repository must not use datestamps lower than the one specified by the content of the earliestDatestamp element. earliestDatestamp must be expressed at the finest granularity supported by the repository.
* - $identifyResponse['deletedRecord'] : the manner in which the repository supports the notion of deleted records. Legitimate values are no ; transient ; persistent with meanings defined in the section on deletion.
* - $identifyResponse['granularity'] : the finest harvesting granularity supported by the repository. The legitimate values are YYYY-MM-DD and YYYY-MM-DDThh:mm:ssZ with meanings as defined in ISO8601.
*
*/
// script must be at moodle/local/oai_pmh
require_once('../../config.php');
$adminEmail = generate_email_supportuser();
$identifyResponse = array();
$identifyResponse["repositoryName"] = $SITE->fullname;;
$identifyResponse["baseURL"] = $CFG->wwwroot.'/local/oai_pmh/moodle.php';
$identifyResponse["protocolVersion"] = '2.0';
$identifyResponse['adminEmail'] = $adminEmail->email;
$identifyResponse["earliestDatestamp"] = '2013-01-01T12:00:00Z';
$identifyResponse["deletedRecord"] = 'no'; // How your repository handles deletions
// no: The repository does not maintain status about deletions.
// It MUST NOT reveal a deleted status.
// persistent: The repository persistently keeps track about deletions
// with no time limit. It MUST consistently reveal the status
// of a deleted record over time.
// transient: The repository does not guarantee that a list of deletions is
// maintained. It MAY reveal a deleted status for records.
$identifyResponse["granularity"] = 'YYYY-MM-DDThh:mm:ssZ';
if (!isset($uri)) {
$uri = 'test.oai_pmh';
}
$uri = parse_url($CFG->wwwroot);
$oai2 = new OAI2Server($uri['host'], $_GET, $identifyResponse,
array(
'ListMetadataFormats' =>
function($identifier = '') {
return array('oai_dc' => array('metadataPrefix'=>'oai_dc',
'schema'=>'http://www.openarchives.org/OAI/2.0/oai_dc.xsd',
'metadataNamespace'=>'http://www.openarchives.org/OAI/2.0/oai_dc/',
'record_prefix'=>'dc',
'record_namespace' => 'http://purl.org/dc/elements/1.1/'));
},
'ListSets' =>
function($resumptionToken = '') {
return array (array('setSpec' => 'all', 'setName' => 'All files'));
},
'ListRecords' =>
function($metadataPrefix, $from = '', $until = '', $set = '', $count = false, $deliveredRecords = 0, $maxItems = 0) {
global $DB;
if ($metadataPrefix != 'oai_dc') {
throw new OAI2Exception('noRecordsMatch');
}
$files = array();
$fs = get_file_storage();
$hashes = $DB->get_records_sql("SELECT DISTINCT pathnamehash as hash FROM files");
foreach ($hashes as $h) {
if ($file = $fs->get_file_by_hash($h->hash)) {
$files[] = $file;
}
}
if ($count) {
return sizeof($files);
}
if (empty($files)) {
throw new OAI2Exception('noRecordsMatch');
}
$records = array();
$now = date('Y-m-d-H:s');
foreach ($files as $f) {
$filename = $f->get_filename();
if (!empty($filename) && ($filename != ' ') && $filename != '.') {
$records[] = array('identifier' => $f->get_contenthash(),
'datestamp' => $now,
'set' => 'all',
'metadata' => array(
'container_name' => 'oai_dc:dc',
'container_attributes' => array(
'xmlns:oai_dc' => "http://www.openarchives.org/OAI/2.0/oai_dc/",
'xmlns:dc' => "http://purl.org/dc/elements/1.1/",
'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
'xsi:schemaLocation' =>
'http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd'
),
'fields' => array(
'dc:title' => $f->get_filename(),
'dc:author' => $f->get_author(),
)
));
}
}
return $records;
},
'GetRecord' =>
function($identifier, $metadataPrefix) {
global $DB;
if ($metadataPrefix != 'oai_dc') {
throw new OAI2Exception('noRecordsMatch');
}
$fs = get_file_storage();
$record = $DB->get_record_sql("SELECT id, pathnamehash FROM files WHERE contenthash = '{$identifier}' ORDER BY id LIMIT 1");
if (!$file = $fs->get_file_by_hash($record->pathnamehash)) {
throw new OAI2Exception('idDoesNotExist');
}
$now = date('Y-m-d-H:s');
return array('identifier' => $file->get_contenthash(),
'datestamp' => $now,
'set' => 'all',
'metadata' => array(
'container_name' => 'oai_dc:dc',
'container_attributes' => array(
'xmlns:oai_dc' => "http://www.openarchives.org/OAI/2.0/oai_dc/",
'xmlns:dc' => "http://purl.org/dc/elements/1.1/",
'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
'xsi:schemaLocation' =>
'http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd'
),
'fields' => array(
'dc:title' => $file->get_filename(),
'dc:author' => $file->get_author(),
)
));
},
)
);
$response = $oai2->response();
$response->formatOutput = true;
$response->preserveWhiteSpace = false;
header('Content-Type: text/xml');
echo $response->saveXML();

85
oai2client.php
View File

@ -1,85 +0,0 @@
<?php
/**
* http://www.openarchives.org/OAI/2.0/guidelines-harvester.htm
* 8. Harvesting all the Metadata from a Repository
*
* Proxies, aggregators and other such agents may wish to harvest a complete copy of a repository
* including set structure and all metadata formats. One strategy for doing this would be:
*
* # Issue an Identify request to find the finest datestamp granularity supported.
* # Issue a ListMetadataFormats request to obtain a list of all metadataPrefixes supported.
* # Harvest using ListRecords requests for each metadataPrefix supported. Knowledge of the
* datestamp granularity allows for less overlap if granularities finer than a day are supported.
* # Set structure can be inferred from the setSpec elements in the header blocks of each record
* returned (consistency checks are possible).
* # Items may be reconstructed from the constituent records. Local datestamps must be assigned to
* harvested items.
* # Provenance and other information in <about> blocks may be re-assembled at the item level if it
* is the same for all metadata formats harvested. However, this information may be supplied
* differently for different metadata formats and may thus need to be store separately for each
* metadata format.
*/
class OAI2Client {
public function __construct($server_base_url) {
$this->server_base_url = $server_base_url;
require_once('./curl.php');
$this->curl = new Curl();
}
public function Identify() {
return $this->curl->get($this->server_base_url.'?verb=Identify');
}
public function ListMetadataFormats($identifier = '') {
$url = $this->server_base_url.'?verb=ListMetadataFormats';
if (!empty($identifier)) {
$url .= "&identifier={$identifier}";
}
return $this->curl->get($url);
}
public function ListSets($resumptionToken = '') {
$url = $this->server_base_url.'?verb=ListSets';
return $this->curl->get($url);
}
public function ListIdentifiers($options = array()) {
$options_default = array('from' => null,
'until' => null,
'set' => null,
'resumptionToken' => null,
'metadataPrefix' => null); // required
$url = $this->server_base_url.'?verb=ListIdentifiers';
if (!empty($options['metadataPrefix'])) {
$url .= "&metadataPrefix={$options['metadataPrefix']}";
}
return $this->curl->get($url);
}
public function ListRecords($options = array()) {
$options_default = array('from' => null,
'until' => null,
'set' => null,
'resumptionToken' => null,
'metadataPrefix' => null); // required
$url = $this->server_base_url.'?verb=ListRecords';
if (!empty($options['metadataPrefix'])) {
$url .= "&metadataPrefix={$options['metadataPrefix']}";
}
return $this->curl->get($url);
}
public function GetRecord($identifier, $metadataPrefix) {
$url = $this->server_base_url.'?verb=ListRecords';
$url .= "&identifier={$identifier}&metadataPrefix={$metadataPrefix}";
return $this->curl->get($url);
}
}