OAI Refactoring

application/configs/application.ini

@@ -102,6 +102,21 @@ oai.description.eprints.submissionPolicy.text =
 oai.description.eprints.comment.url =
 oai.description.eprints.comment.text =
 
+; Configuration of the oai formats
+; Optional custom oai server class name
+; oai.format.[lower cased format identifier].class = [oai server class name]
+; The xslt file
+; oai.format.[lower cased format identifier ].xsltFile = [xslt file name]
+; The format prefix
+; oai.format.[lower cased format identifier ].prefix = [prefix]
+oai.format.default.class = Oai_Model_BaseServer
+oai.format.copy_xml.xsltFile = copy_xml.xslt
+oai.format.epicur.xsltFile = epicur.xslt
+oai.format.marc21.xsltFile = marc21.xslt
+oai.format.oai_dc.xsltFile = oai_dc.xslt
+oai.format.oai_pp.xsltFile = oai_pp.xslt
+oai.format.xmetadissplus.xsltFile = XMetaDissPlus.xslt
+
 ; ERROR CONTROLLER SETTINGS
 errorController.showException = 0
 errorController.showRequest = 0

modules/oai/controllers/IndexController.php

@@ -77,7 +77,16 @@ public function indexAction()
             unset($parameters[$name]);
         }
 
-        $server = new Oai_Model_Server(); // TODO needs factory
+        $serverFactory = new Oai_Model_ServerFactory();
+
+        if (isset($parameters['metadataPrefix'])) {
+            $server = $serverFactory->create($parameters['metadataPrefix']);
+        } elseif (isset($parameters['resumptionToken'])) {
+            $server = $serverFactory->createByResumptionToken($parameters['resumptionToken']);
+        } else {
+            $server = $serverFactory->create();
+        }
+
         $server->setScriptPath($this->view->getScriptPath('index'));
         $server->setBaseUrl($this->view->fullUrl());
         $server->setBaseUri($request->getBaseUrl());

modules/oai/models/Server.php → modules/oai/models/BaseServer.php

@@ -37,8 +37,10 @@
 use Opus\Model\Xml;
 use Opus\Model\Xml\Version1;
 
-class Oai_Model_Server extends Application_Model_Abstract
+class Oai_Model_BaseServer extends Application_Model_Abstract
 {
+    use Oai_Model_OptionsTrait;
+
     /**
      * Holds xml representation of document information to be processed.
      *
@@ -75,13 +77,6 @@ class Oai_Model_Server extends Application_Model_Abstract
      */
     private $xMetaDissRestriction = ['doctoralthesis', 'habilitation'];
 
-    /**
-     * Hold oai module configuration model.
-     *
-     * @var Oai_Model_Configuration
-     */
-    protected $configuration;
-
     /** @var Oai_Model_XmlFactory */
     private $xmlFactory;
 
@@ -104,10 +99,9 @@ public function init()
     {
         $config = $this->getConfig();
 
-        $this->xml           = new DOMDocument();
-        $this->proc          = new XSLTProcessor();
-        $this->configuration = new Oai_Model_Configuration($config);
-        $this->xmlFactory    = new Oai_Model_XmlFactory();
+        $this->xml        = new DOMDocument();
+        $this->proc       = new XSLTProcessor();
+        $this->xmlFactory = new Oai_Model_XmlFactory();
     }
 
     /**
@@ -120,7 +114,7 @@ public function init()
      */
     public function handleRequest($parameters, $requestUri)
     {
-        // TODO move error handling into Oai_Model_Server
+        // TODO move error handling into Oai_Model_BaseServer
         try {
             // handle request
             return $this->handleRequestIntern($parameters, $requestUri);
@@ -162,14 +156,11 @@ public function handleRequest($parameters, $requestUri)
     protected function handleRequestIntern($oaiRequest, $requestUri)
     {
         $this->init();
-
-        // Setup stylesheet
-        $this->loadStyleSheet($this->getScriptPath() . '/oai-pmh.xslt');
-
+        $this->loadStyleSheet();
         $this->setupProcessor();
 
         $metadataPrefixPath = $this->getScriptPath() . DIRECTORY_SEPARATOR . 'prefixes';
-        $resumptionPath     = $this->configuration->getResumptionTokenPath();
+        $resumptionPath     = $this->getResumptionTokenPath();
 
         $request = new Oai_Model_Request();
         $request->setPathToMetadataPrefixFiles($metadataPrefixPath);
@@ -350,10 +341,10 @@ protected function handleGetRecord(array &$oaiRequest)
      */
     protected function handleIdentify()
     {
-        $email            = $this->configuration->getEmailContact();
-        $repName          = $this->configuration->getRepositoryName();
-        $repIdentifier    = $this->configuration->getRepositoryIdentifier();
-        $sampleIdentifier = $this->configuration->getSampleIdentifier();
+        $email            = $this->getEmailContact();
+        $repName          = $this->getRepositoryName();
+        $repIdentifier    = $this->getRepositoryIdentifier();
+        $sampleIdentifier = $this->getSampleIdentifier();
 
         // Set backup date if database query does not return a date.
         $earliestDate = DateTime::createFromFormat("Y-m-d", '1970-01-01');
@@ -385,7 +376,7 @@ protected function handleIdentify()
      */
     protected function handleListIdentifiers(array &$oaiRequest)
     {
-        $maxIdentifier = $this->configuration->getMaxListIdentifiers();
+        $maxIdentifier = $this->getMaxListIdentifiers();
         $this->handlingOfLists($oaiRequest, $maxIdentifier);
     }
 
@@ -424,7 +415,7 @@ protected function handleListMetadataFormats($oaiRequest)
      */
     protected function handleListRecords(array &$oaiRequest)
     {
-        $maxRecords = $this->configuration->getMaxListRecords();
+        $maxRecords = $this->getMaxListRecords();
         $this->handlingOfLists($oaiRequest, $maxRecords);
     }
 
@@ -433,7 +424,7 @@ protected function handleListRecords(array &$oaiRequest)
      */
     protected function handleListSets()
     {
-        $repIdentifier = $this->configuration->getRepositoryIdentifier();
+        $repIdentifier = $this->getRepositoryIdentifier();
 
         $this->proc->setParameter('', 'repIdentifier', $repIdentifier);
         $this->xml->appendChild($this->xml->createElement('Documents'));
@@ -467,8 +458,8 @@ private function handlingOfLists(array &$oaiRequest, $maxRecords)
             $maxRecords = 100;
         }
 
-        $repIdentifier = $this->configuration->getRepositoryIdentifier();
-        $tempPath      = $this->configuration->getResumptionTokenPath();
+        $repIdentifier = $this->getRepositoryIdentifier();
+        $tempPath      = $this->getResumptionTokenPath();
 
         $this->proc->setParameter('', 'repIdentifier', $repIdentifier);
         $this->xml->appendChild($this->xml->createElement('Documents'));
@@ -782,29 +773,30 @@ private function getDocumentXmlDomNode($document)
     }
 
     /**
-     * @return string
+     * Load an xslt stylesheet.
      */
-    private function getOaiBaseUrl()
+    protected function loadStyleSheet()
     {
-        $oaiBaseUrl = $this->configuration->getOaiBaseUrl();
+        $this->xslt = new DOMDocument();
+        $this->xslt->load($this->getScriptPath() . '/oai-pmh.xslt');
 
-        // if no OAI base url is set, use local information as base url
-        if (true === empty($oaiBaseUrl)) {
-            $oaiBaseUrl = $this->getBaseUrl() . '/oai'; // TODO . $module;
-        }
+        // Replace import comment with prefix import
+        $prefixXsltFile = $this->getXsltFile();
 
-        return $oaiBaseUrl;
-    }
+        if ($prefixXsltFile) {
+            if (! file_exists($prefixXsltFile)) {
+                $prefixXsltFile = $this->getScriptPath() . '/prefixes/' . $prefixXsltFile;
+            }
+            $xsltXml = $this->xslt->saveXML();
+            $xsltXml = preg_replace(
+                '/<!-- add include here for each new metadata format    -->/u',
+                '<xsl:include href="' . $prefixXsltFile . '"/>',
+                $xsltXml
+            );
+
+            $this->xslt->loadXML($xsltXml);
+        }
 
-    /**
-     * Load an xslt stylesheet.
-     *
-     * @param string $stylesheet
-     */
-    protected function loadStyleSheet($stylesheet)
-    {
-        $this->xslt = new DOMDocument();
-        $this->xslt->load($stylesheet);
         $this->proc->importStyleSheet($this->xslt);
         if (isset($_SERVER['HTTP_HOST'])) {
             $this->proc->setParameter('', 'host', $_SERVER['HTTP_HOST']);
@@ -875,4 +867,191 @@ public function getResponse()
     {
         return $this->response;
     }
+
+    /**
+     * Return temporary path for resumption tokens.
+     *
+     * @return string Path.
+     */
+    public function getResumptionTokenPath()
+    {
+        return $this->options['resumptionTokenPath'] ?? '';
+    }
+
+    /**
+     * Sets the temporary path for resumption tokens.
+     *
+     * @param string $path
+     */
+    public function setResumptionTokenPath($path)
+    {
+        $this->options['resumptionTokenPath'] = $path;
+    }
+
+    /**
+     * Return contact email address.
+     *
+     * @return string Email address.
+     */
+    public function getEmailContact()
+    {
+        return $this->options['emailContact'] ?? '';
+    }
+
+    /**
+     * Sets the contact email address.
+     *
+     * @param string $email
+     */
+    public function setEmailContact($email)
+    {
+        $this->options['emailContact'] = $email;
+    }
+
+    /**
+     * Return OAI base url.
+     *
+     * @return string Oai base url.
+     */
+    private function getOaiBaseUrl()
+    {
+        $oaiBaseUrl = $this->options['oaiBaseUrl'] ?? '';
+
+        // if no OAI base url is set, use local information as base url
+        if (true === empty($oaiBaseUrl)) {
+            $oaiBaseUrl = $this->getBaseUrl() . '/oai'; // TODO . $module;
+        }
+
+        return $oaiBaseUrl;
+    }
+
+    /**
+     * Sets the OAI base url.
+     *
+     * @param string $url
+     */
+    public function setOaiBaseUrl($url)
+    {
+        $this->options['oaiBaseUrl'] = $url;
+    }
+
+    /**
+     * Return repository name.
+     *
+     * @return string Repository name.
+     */
+    private function getRepositoryName()
+    {
+        return $this->options['repositoryName'] ?? '';
+    }
+
+    /**
+     * Sets the repository name.
+     *
+     * @param string $repoName
+     */
+    public function setRepositoryName($repoName)
+    {
+        $this->options['repositoryName'] = $repoName;
+    }
+
+    /**
+     * Return repository identifier.
+     *
+     * @return string Repository identifier.
+     */
+    private function getRepositoryIdentifier()
+    {
+        return $this->options['repositoryIdentifier'] ?? '';
+    }
+
+    /**
+     * Sets the repository identifier.
+     *
+     * @param string $repoId
+     */
+    public function setRepositoryIdentifier($repoId)
+    {
+        $this->options['repositoryIdentifier'] = $repoId;
+    }
+
+    /**
+     * Return sample identifier.
+     *
+     * @return string Sample identifier.
+     */
+    private function getSampleIdentifier()
+    {
+        return $this->options['sampleIdentifier'] ?? '';
+    }
+
+    /**
+     * Sets the sample identifier.
+     *
+     * @param string $sampleId
+     */
+    public function setSampleIdentifier($sampleId)
+    {
+        $this->options['sampleIdentifier'] = $sampleId;
+    }
+
+    /**
+     * Return maximum number of listable identifiers per request.
+     *
+     * @return int Maximum number of listable identifiers per request.
+     */
+    private function getMaxListIdentifiers()
+    {
+        return $this->options['maxListIdentifiers'] ?? '';
+    }
+
+    /**
+     * Sets the maximum number of listable identifiers per request.
+     *
+     * @param int $maxListIds
+     */
+    public function setMaxListIdentifiers($maxListIds)
+    {
+        $this->options['maxListIdentifiers'] = $maxListIds;
+    }
+
+    /**
+     * Return maximum number of listable records per request.
+     *
+     * @return int Maximum number of listable records per request.
+     */
+    private function getMaxListRecords()
+    {
+        return $this->options['maxListRecords'] ?? '';
+    }
+
+    /**
+     * Sets the maximum number of listable records per request.
+     *
+     * @param int $maxListRecs
+     */
+    public function setMaxListRecords($maxListRecs)
+    {
+        $this->options['maxListRecords'] = $maxListRecs;
+    }
+
+    /**
+     * Return xlst file name / file path.
+     *
+     * @return string
+     */
+    protected function getXsltFile()
+    {
+        return $this->options['xsltFile'] ?? '';
+    }
+
+    /**
+     * Sets the xlst file name / file path.
+     *
+     * @param string $file
+     */
+    public function setXsltFile($file)
+    {
+        $this->options['xsltFile'] = $file;
+    }
 }