simple-oai-pmh/index.php

203 lines
7.5 KiB
PHP
Raw Normal View History

<?php
2013-05-12 02:18:36 +02:00
/**
2017-05-12 18:13:53 +02:00
* Simple OAI-PMH 2.0 Data Provider
* Copyright (C) 2005 Heinrich Stamerjohanns <stamer@uni-oldenburg.de>
* Copyright (C) 2011 Jianfeng Li <jianfeng.li@adelaide.edu.au>
2017-05-12 18:13:53 +02:00
* Copyright (C) 2013 Daniel Neis Araujo <danielneis@gmail.com>
* Copyright (C) 2017 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
2013-05-12 02:18:36 +02:00
*
2017-05-12 18:13:53 +02:00
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
2013-05-12 02:18:36 +02:00
*
2017-05-12 18:13:53 +02:00
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
2013-05-12 02:18:36 +02:00
*/
2020-01-24 00:47:21 +01:00
use OCC\OAI2\Exception;
use OCC\OAI2\Server;
2020-01-24 00:13:17 +01:00
2020-01-24 00:47:21 +01:00
// Register PSR-4 autoloader
require __DIR__.'/vendor/autoload.php';
2020-01-24 00:13:17 +01:00
// Load configuration
2020-01-24 00:47:21 +01:00
require __DIR__.'/Configuration/Main.php';
2013-05-14 21:46:15 +02:00
// Get all available records and their respective status and timestamps
$records = [];
$setsrecords = [];
$deleted = [];
$timestamps = [];
$earliest = time();
2017-05-12 18:13:53 +02:00
2020-01-08 17:24:22 +01:00
foreach ($config['metadataPrefix'] as $prefix => $uris) {
$files = glob(rtrim($config['dataDirectory'], '/').'/'.$prefix.'/*.xml');
foreach ($files as $file) {
$records[$prefix][pathinfo($file, PATHINFO_FILENAME)] = $file;
$deleted[$prefix][pathinfo($file, PATHINFO_FILENAME)] = !filesize($file);
$timestamps[$prefix][filemtime($file)][] = pathinfo($file, PATHINFO_FILENAME);
if (filemtime($file) < $earliest) {
$earliest = filemtime($file);
}
2017-10-05 18:02:15 +02:00
}
if (isset($records[$prefix])) {
ksort($records[$prefix]);
reset($records[$prefix]);
ksort($timestamps[$prefix]);
reset($timestamps[$prefix]);
}
}
// get all set records.
foreach ($config['ListSets'] as $set => $setd) {
foreach ($config['metadataPrefix'] as $prefix => $uris) {
$path = rtrim($config['dataDirectory'], '/').'/sets/'.$set.'/'.$prefix.'/*.xml';
$files = glob(rtrim($config['dataDirectory'], '/').'/sets/'.$set.'/'.$prefix.'/*.xml');
foreach ($files as $file) {
$setsrecords[$set]['records'][$prefix][pathinfo($file, PATHINFO_FILENAME)] = $file;
$setsrecords[$set]['deleted'][$prefix][pathinfo($file, PATHINFO_FILENAME)] = !filesize($file);
$setsrecords[$set]['timestamps'][$prefix][filemtime($file)][] = pathinfo($file, PATHINFO_FILENAME);
if (filemtime($file) < $earliest) {
$earliest = filemtime($file);
}
}
if (isset($setsrecords[$set]['records'][$prefix])) {
ksort($setsrecords[$set]['records'][$prefix]);
reset($setsrecords[$set]['records'][$prefix]);
ksort($setsrecords[$set]['timestamps'][$prefix]);
reset($setsrecords[$set]['timestamps'][$prefix]);
}
}
2017-10-05 18:02:15 +02:00
}
2017-05-21 20:01:51 +02:00
// Get current base URL
2017-06-09 18:50:11 +02:00
$baseURL = $_SERVER['HTTP_HOST'].parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);
2017-05-21 20:01:51 +02:00
if (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] != 'off') {
2020-01-08 17:24:22 +01:00
$baseURL = 'https://'.$baseURL;
2017-05-21 20:01:51 +02:00
} else {
2020-01-08 17:24:22 +01:00
$baseURL = 'http://'.$baseURL;
2017-05-21 20:01:51 +02:00
}
2017-05-12 18:13:53 +02:00
// Build the Identify response
2020-01-08 17:24:22 +01:00
$identifyResponse = [
'repositoryName' => $config['repositoryName'],
'baseURL' => $baseURL,
'protocolVersion' => '2.0',
'adminEmail' => $config['adminEmail'],
'earliestDatestamp' => gmdate('Y-m-d\TH:i:s\Z', $earliest),
'deletedRecord' => $config['deletedRecord'],
'granularity' => 'YYYY-MM-DDThh:mm:ssZ'
];
2017-05-12 18:13:53 +02:00
2020-01-24 00:13:17 +01:00
$oai2 = new Server(
2020-01-08 17:24:22 +01:00
$baseURL,
2022-07-01 16:18:23 +02:00
array_merge($_POST, $_GET),
2020-01-08 17:24:22 +01:00
$identifyResponse,
[
'GetRecord' => function ($identifier, $metadataPrefix) {
global $records, $deleted;
if (empty($records[$metadataPrefix][$identifier])) {
return [];
} else {
return [
'identifier' => $identifier,
'timestamp' => filemtime($records[$metadataPrefix][$identifier]),
'deleted' => $deleted[$metadataPrefix][$identifier],
'metadata' => $records[$metadataPrefix][$identifier]
];
}
},
'ListRecords' => function ($metadataPrefix, $from = null, $until = null, $count = false, $deliveredRecords = 0, $maxItems = 100, $set = null) {
global $records, $deleted, $timestamps, $setsrecords;
2020-01-08 17:24:22 +01:00
$resultSet = [];
$currTimestamps = $timestamps;
$activeRecords = $records;
$deletedRecords = $deleted;
// override with SET records.
if (isset($set)) {
$activeRecords = $setsrecords[$set]['records'];
$currTimestamps = $setsrecords[$set]['timestamps'];
$deletedRecords = $setsrecords[$set]['deleted'];
}
foreach ($currTimestamps[$metadataPrefix] as $timestamp => $identifiers) {
2020-01-08 17:24:22 +01:00
if ((is_null($from) || $timestamp >= $from) && (is_null($until) || $timestamp <= $until)) {
foreach ($identifiers as $identifier) {
$resultSet[] = [
'identifier' => $identifier,
'timestamp' => filemtime($activeRecords[$metadataPrefix][$identifier]),
'deleted' => $deletedRecords[$metadataPrefix][$identifier],
'metadata' => $activeRecords[$metadataPrefix][$identifier]
2020-01-08 17:24:22 +01:00
];
}
}
}
if ($count) {
return count($resultSet);
} else {
return array_slice($resultSet, $deliveredRecords, $maxItems);
}
},
'ListMetadataFormats' => function ($identifier = '') {
global $config, $records;
if (!empty($identifier)) {
$formats = [];
foreach ($records as $format => $record) {
if (!empty($record[$identifier])) {
$formats[$format] = $config['metadataPrefix'][$format];
}
}
if (!empty($formats)) {
return $formats;
} else {
2020-01-24 00:13:17 +01:00
throw new Exception('idDoesNotExist');
2020-01-08 17:24:22 +01:00
}
} else {
return $config['metadataPrefix'];
}
},
'ListSets' => function ($identifier = '') {
global $config, $records, $setsrecords;
if (!empty($identifier)) {
$listsets = [];
foreach ($setsrecords as $set => $records) {
foreach ($records as $format => $record) {
if (!empty($record[$identifier])) {
$listsets[$set] = $config['ListSets'][$set];
}
}
}
if (!empty($listsets)) {
return $listsets;
} else {
throw new Exception('idDoesNotExist');
}
} else {
return $config['ListSets'];
}
2017-10-05 18:02:15 +02:00
}
2020-01-08 17:24:22 +01:00
],
$config
);
2013-05-15 02:56:52 +02:00
$response = $oai2->response();
2017-05-12 18:13:53 +02:00
2013-05-15 02:56:52 +02:00
if (isset($return)) {
2020-01-08 17:24:22 +01:00
return $response;
2013-05-15 02:56:52 +02:00
} else {
2020-01-08 17:24:22 +01:00
$response->formatOutput = true;
$response->preserveWhiteSpace = false;
header('Content-Type: text/xml');
echo $response->saveXML();
2013-05-15 02:56:52 +02:00
}