Update copyright information and readme
This commit is contained in:
parent
06aa69acde
commit
387bc4c161
40
README.md
40
README.md
|
|
@ -1,32 +1,28 @@
|
||||||
Simple OAI-PMH 2.0 Data Provider
|
Simple OAI-PMH 2.0 Data Provider
|
||||||
|
================================
|
||||||
|
|
||||||
Overview
|
This is a stand-alone and easy to install data provider for the [Open Archives Initiative's Protocol for Metadata Harvesting (OAI-PMH)](http://openarchives.org/pmh/) written in [PHP](http://php.net/). It serves records in any metadata format from a directory of XML files using the filename as identifier and the filemtime as datestamp. Resumption tokens are managed using files. Multiple metadata formats and sets are currently not supported.
|
||||||
|
|
||||||
This project is derived from the original work of Jianfeng Li
|
Just put the records as XML files in the data directory, adjust a few configuration settings and you are ready to go!
|
||||||
from "The Plant Accelerator" for the "University of Adelaide".
|
|
||||||
|
|
||||||
In the original docs (you can see them on git log),
|
Installation
|
||||||
Jianfeng Li he was inspired by PHP OAI Data Provider developed
|
------------
|
||||||
by Heinrich Stamerjohanns at University of Oldenburg.
|
|
||||||
His implementation is at http://physnet.uni-oldenburg.de/oai/.
|
|
||||||
|
|
||||||
Almost all the code was rewritten in my attempt to understand
|
1. Deploy all the files to a webserver.
|
||||||
both the OAI-PMH protocol and the original code itself.
|
|
||||||
|
|
||||||
The code changed so much that i removed the original documentation.
|
2. Put the records into the data/ directory (or create a symlink named "data" pointing to your records). Each record has to be a separate XML file with its identifier as filename (i.e. 12345678.xml).
|
||||||
|
|
||||||
There is some unit tests that were written based on the official
|
3. Edit oai2config.php and adjust the settings according to your preferences.
|
||||||
protocol documentation at http://www.openarchives.org/OAI/openarchivesprotocol.html#ErrorConditions
|
|
||||||
and also on the Open Archives Initiative - Repository Explorer at http://re.cs.uct.ac.za/
|
|
||||||
|
|
||||||
This version of the server relies on callbacks to get the needed data
|
4. Congratulations! Now you are running an OAI-PMH 2.0 compatible data provider.
|
||||||
to generate the XML responses. The file oai2.php is a sample server
|
|
||||||
instantiation to allow unit tests (OAI2ServerTest.php) to be run by
|
|
||||||
PHP Unit. It has "hard-coded" data to pass the tests and validates
|
|
||||||
that the server correctly reads correctly-formatted data.
|
|
||||||
It is your responsibility to provide callbacks that provides
|
|
||||||
correctly formatted data in all cases.
|
|
||||||
|
|
||||||
Tokens are managed using files.
|
History
|
||||||
|
-------
|
||||||
|
|
||||||
XML Responses are created using the DOMDocument PHP interfaces.
|
This project was originally initiated in 2002 by [Heinrich Stamerjohanns](stamer@uni-oldenburg.de) at [University of Oldenburg](https://www.uni-oldenburg.de/en/). His latest implementation can be still found via the [Internet Archive's Wayback Machine](https://web.archive.org/web/*/http://physnet.uni-oldenburg.de/oai/).
|
||||||
|
|
||||||
|
It was then modified in 2011 by [Jianfeng Li](jianfeng.li@adelaide.edu.au) of the [University of Adelaide](http://www.adelaide.edu.au/) for [The Plant Accelerator](http://www.plantaccelerator.org.au/). The modified version can be found in the [Google Code Archive](https://code.google.com/archive/p/oai-pmh-2/).
|
||||||
|
|
||||||
|
In 2013 [Daniel Neis Araujo](danielneis@gmail.com) of the [Federal University of Santa Catarina](http://en.ufsc.br/) modified the project again in order to integrate it with [Moodle](https://moodle.org/). His implementation can be found on [GitHub](https://github.com/danielneis/oai_pmh).
|
||||||
|
|
||||||
|
The current implementation was derived from the latter in 2017 by [Sebastian Meyer](sebastian.meyer@opencultureconsutling.com) of [Open Culture Consulting](https://www.opencultureconsulting.com/) for the [German Literature Archive](http://www.dla-marbach.de/en/).
|
||||||
|
|
|
||||||
33
index.html
33
index.html
|
|
@ -1,33 +0,0 @@
|
||||||
<!DOCTYPE html>
|
|
||||||
<html lang="en">
|
|
||||||
<!--
|
|
||||||
Simple OAI-PMH 2.0 Data Provider
|
|
||||||
Copyright (C) 2011 Jianfeng Li
|
|
||||||
Copyright (C) 2013 Daniel Neis Araujo <danielneis@gmail.com>
|
|
||||||
Copyright (C) 2017 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
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/>.
|
|
||||||
-->
|
|
||||||
<head>
|
|
||||||
<meta charset="UTF-8">
|
|
||||||
<title>Simple OAI-PMH 2.0 Data Provider</title>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<h1>Simple OAI-PMH 2.0 Data Provider</h1>
|
|
||||||
|
|
||||||
<p>This is a simple implementation of an <a href="http://www.openarchives.org/OAI/openarchivesprotocol.html" title="OpenArchives.org">OAI-PMH 2.0 Data Provider</a> written in <a href="http://www.php.net" title="PHP.net">PHP</a>.</p>
|
|
||||||
|
|
||||||
<p>For more information take a look at the source code repository on <a href="https://github.com/opencultureconsulting/oai_pmh" title="GitHub.com">GitHub</a>.</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
@ -1,7 +1,8 @@
|
||||||
<?php
|
<?php
|
||||||
/**
|
/**
|
||||||
* Simple OAI-PMH 2.0 Data Provider
|
* Simple OAI-PMH 2.0 Data Provider
|
||||||
* Copyright (C) 2011 Jianfeng Li
|
* Copyright (C) 2005 Heinrich Stamerjohanns <stamer@uni-oldenburg.de>
|
||||||
|
* Copyright (C) 2011 Jianfeng Li <jianfeng.li@adelaide.edu.au>
|
||||||
* Copyright (C) 2013 Daniel Neis Araujo <danielneis@gmail.com>
|
* Copyright (C) 2013 Daniel Neis Araujo <danielneis@gmail.com>
|
||||||
* Copyright (C) 2017 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
|
* Copyright (C) 2017 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
|
||||||
*
|
*
|
||||||
|
|
@ -92,7 +93,7 @@ $oai2 = new OAI2Server(
|
||||||
throw new OAI2Exception('idDoesNotExist');
|
throw new OAI2Exception('idDoesNotExist');
|
||||||
} else {
|
} else {
|
||||||
return array(
|
return array(
|
||||||
$config['metadataFormat'] => array (
|
$config['metadataFormat'] => array(
|
||||||
'metadataPrefix' => $config['metadataFormat'],
|
'metadataPrefix' => $config['metadataFormat'],
|
||||||
'schema'=> $config['metadataSchema'],
|
'schema'=> $config['metadataSchema'],
|
||||||
'metadataNamespace' => $config['metadataNamespace']
|
'metadataNamespace' => $config['metadataNamespace']
|
||||||
|
|
@ -1,7 +1,8 @@
|
||||||
<?php
|
<?php
|
||||||
/**
|
/**
|
||||||
* Simple OAI-PMH 2.0 Data Provider
|
* Simple OAI-PMH 2.0 Data Provider
|
||||||
* Copyright (C) 2011 Jianfeng Li
|
* Copyright (C) 2005 Heinrich Stamerjohanns <stamer@uni-oldenburg.de>
|
||||||
|
* Copyright (C) 2011 Jianfeng Li <jianfeng.li@adelaide.edu.au>
|
||||||
* Copyright (C) 2013 Daniel Neis Araujo <danielneis@gmail.com>
|
* Copyright (C) 2013 Daniel Neis Araujo <danielneis@gmail.com>
|
||||||
* Copyright (C) 2017 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
|
* Copyright (C) 2017 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
|
||||||
*
|
*
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,8 @@
|
||||||
<?php
|
<?php
|
||||||
/**
|
/**
|
||||||
* Simple OAI-PMH 2.0 Data Provider
|
* Simple OAI-PMH 2.0 Data Provider
|
||||||
* Copyright (C) 2011 Jianfeng Li
|
* Copyright (C) 2005 Heinrich Stamerjohanns <stamer@uni-oldenburg.de>
|
||||||
|
* Copyright (C) 2011 Jianfeng Li <jianfeng.li@adelaide.edu.au>
|
||||||
* Copyright (C) 2013 Daniel Neis Araujo <danielneis@gmail.com>
|
* Copyright (C) 2013 Daniel Neis Araujo <danielneis@gmail.com>
|
||||||
* Copyright (C) 2017 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
|
* Copyright (C) 2017 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
|
||||||
*
|
*
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,8 @@
|
||||||
<?php
|
<?php
|
||||||
/**
|
/**
|
||||||
* Simple OAI-PMH 2.0 Data Provider
|
* Simple OAI-PMH 2.0 Data Provider
|
||||||
* Copyright (C) 2011 Jianfeng Li
|
* Copyright (C) 2005 Heinrich Stamerjohanns <stamer@uni-oldenburg.de>
|
||||||
|
* Copyright (C) 2011 Jianfeng Li <jianfeng.li@adelaide.edu.au>
|
||||||
* Copyright (C) 2013 Daniel Neis Araujo <danielneis@gmail.com>
|
* Copyright (C) 2013 Daniel Neis Araujo <danielneis@gmail.com>
|
||||||
* Copyright (C) 2017 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
|
* Copyright (C) 2017 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
|
||||||
*
|
*
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,8 @@
|
||||||
<?php
|
<?php
|
||||||
/**
|
/**
|
||||||
* Simple OAI-PMH 2.0 Data Provider
|
* Simple OAI-PMH 2.0 Data Provider
|
||||||
* Copyright (C) 2011 Jianfeng Li
|
* Copyright (C) 2005 Heinrich Stamerjohanns <stamer@uni-oldenburg.de>
|
||||||
|
* Copyright (C) 2011 Jianfeng Li <jianfeng.li@adelaide.edu.au>
|
||||||
* Copyright (C) 2013 Daniel Neis Araujo <danielneis@gmail.com>
|
* Copyright (C) 2013 Daniel Neis Araujo <danielneis@gmail.com>
|
||||||
* Copyright (C) 2017 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
|
* Copyright (C) 2017 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
|
||||||
*
|
*
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue