Erikmitk / kitodo-presentation

Classes/Plugin/OaiPmh.php

Spacing +27 added lines, -27 removed lines

@@ -82,7 +82,7 @@ 
         // Delete expired resumption tokens.
         $GLOBALS['TYPO3_DB']->exec_DELETEquery(
             'tx_dlf_tokens',
-            'tx_dlf_tokens.ident="oai" AND tx_dlf_tokens.tstamp<' . intval($GLOBALS['EXEC_TIME'] - $this->conf['expired'])
+            'tx_dlf_tokens.ident="oai" AND tx_dlf_tokens.tstamp<'.intval($GLOBALS['EXEC_TIME'] - $this->conf['expired'])
         );
         if ($GLOBALS['TYPO3_DB']->sql_affected_rows() === -1) {
             // Deletion failed.
@@ -150,13 +150,13 @@ 
         $oai_dc = $this->oai->createElementNS($this->formats['oai_dc']['namespace'], 'oai_dc:dc');
         $oai_dc->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:dc', 'http://purl.org/dc/elements/1.1/');
         $oai_dc->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
-        $oai_dc->setAttributeNS('http://www.w3.org/2001/XMLSchema-instance', 'xsi:schemaLocation', $this->formats['oai_dc']['namespace'] . ' ' . $this->formats['oai_dc']['schema']);
+        $oai_dc->setAttributeNS('http://www.w3.org/2001/XMLSchema-instance', 'xsi:schemaLocation', $this->formats['oai_dc']['namespace'].' '.$this->formats['oai_dc']['schema']);
         $oai_dc->appendChild($this->oai->createElementNS('http://purl.org/dc/elements/1.1/', 'dc:identifier', htmlspecialchars($metadata['record_id'], ENT_NOQUOTES, 'UTF-8')));
         if (!empty($metadata['purl'])) {
             $oai_dc->appendChild($this->oai->createElementNS('http://purl.org/dc/elements/1.1/', 'dc:identifier', htmlspecialchars($metadata['purl'], ENT_NOQUOTES, 'UTF-8')));
         }
         if (!empty($metadata['prod_id'])) {
-            $oai_dc->appendChild($this->oai->createElementNS('http://purl.org/dc/elements/1.1/', 'dc:identifier', 'kitodo:production:' . htmlspecialchars($metadata['prod_id'], ENT_NOQUOTES, 'UTF-8')));
+            $oai_dc->appendChild($this->oai->createElementNS('http://purl.org/dc/elements/1.1/', 'dc:identifier', 'kitodo:production:'.htmlspecialchars($metadata['prod_id'], ENT_NOQUOTES, 'UTF-8')));
         }
         if (!empty($metadata['urn'])) {
             $oai_dc->appendChild($this->oai->createElementNS('http://purl.org/dc/elements/1.1/', 'dc:identifier', htmlspecialchars($metadata['urn'], ENT_NOQUOTES, 'UTF-8')));
@@ -253,7 +253,7 @@ 
         }
         // Add attributes and build XML tree.
         $epicur->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
-        $epicur->setAttributeNS('http://www.w3.org/2001/XMLSchema-instance', 'xsi:schemaLocation', $this->formats['epicur']['namespace'] . ' ' . $this->formats['epicur']['schema']);
+        $epicur->setAttributeNS('http://www.w3.org/2001/XMLSchema-instance', 'xsi:schemaLocation', $this->formats['epicur']['namespace'].' '.$this->formats['epicur']['schema']);
         // Do we update an URN or register a new one?
         if ($metadata['tstamp'] == $metadata['crdate']) {
             $update->setAttribute('type', 'urn_new');
@@ -300,10 +300,10 @@ 
                 // Import node into \DOMDocument.
                 $mets = $this->oai->importNode($root->item(0), true);
             } else {
-                Helper::devLog('No METS part found in document with location "' . $metadata['location'] . '"', DEVLOG_SEVERITY_ERROR);
+                Helper::devLog('No METS part found in document with location "'.$metadata['location'].'"', DEVLOG_SEVERITY_ERROR);
             }
         } else {
-            Helper::devLog('Could not load XML file from "' . $metadata['location'] . '"', DEVLOG_SEVERITY_ERROR);
+            Helper::devLog('Could not load XML file from "'.$metadata['location'].'"', DEVLOG_SEVERITY_ERROR);
         }
         if ($mets === null) {
             $mets = $this->oai->createElementNS('http://kitodo.org/', 'kitodo:error', htmlspecialchars($this->pi_getLL('error', 'Error!', false), ENT_NOQUOTES, 'UTF-8'));
@@ -339,15 +339,15 @@ 
             if (substr($this->conf['stylesheet'], 0, 4) == 'EXT:') {
                 list($extKey, $filePath) = explode('/', substr($this->conf['stylesheet'], 4), 2);
                 if (\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLoaded($extKey)) {
-                    $this->conf['stylesheet'] = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::siteRelPath($extKey) . $filePath;
+                    $this->conf['stylesheet'] = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::siteRelPath($extKey).$filePath;
                 }
             }
             $stylesheet = \TYPO3\CMS\Core\Utility\GeneralUtility::locationHeaderUrl($this->conf['stylesheet']);
         } else {
             // Use default stylesheet if no custom stylesheet is given.
-            $stylesheet = \TYPO3\CMS\Core\Utility\GeneralUtility::locationHeaderUrl(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::siteRelPath($this->extKey) . 'Resources/Public/Stylesheets/OaiPmh.xsl');
+            $stylesheet = \TYPO3\CMS\Core\Utility\GeneralUtility::locationHeaderUrl(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::siteRelPath($this->extKey).'Resources/Public/Stylesheets/OaiPmh.xsl');
         }
-        $this->oai->appendChild($this->oai->createProcessingInstruction('xml-stylesheet', 'type="text/xsl" href="' . htmlspecialchars($stylesheet, ENT_NOQUOTES, 'UTF-8') . '"'));
+        $this->oai->appendChild($this->oai->createProcessingInstruction('xml-stylesheet', 'type="text/xsl" href="'.htmlspecialchars($stylesheet, ENT_NOQUOTES, 'UTF-8').'"'));
         // Create root element.
         $root = $this->oai->createElementNS('http://www.openarchives.org/OAI/2.0/', 'OAI-PMH');
         $root->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
@@ -397,10 +397,10 @@ 
         // Send headers.
         header('HTTP/1.1 200 OK');
         header('Cache-Control: no-cache');
-        header('Content-Length: ' . strlen($content));
+        header('Content-Length: '.strlen($content));
         header('Content-Type: text/xml; charset=utf-8');
-        header('Date: ' . date('r', $GLOBALS['EXEC_TIME']));
-        header('Expires: ' . date('r', $GLOBALS['EXEC_TIME'] + $this->conf['expired']));
+        header('Date: '.date('r', $GLOBALS['EXEC_TIME']));
+        header('Expires: '.date('r', $GLOBALS['EXEC_TIME'] + $this->conf['expired']));
         echo $content;
         exit;
     }
@@ -464,10 +464,10 @@ 
             'tx_dlf_documents',
             'tx_dlf_relations',
             'tx_dlf_collections',
-            'AND tx_dlf_documents.record_id=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->piVars['identifier'], 'tx_dlf_documents')
-                . ' AND tx_dlf_documents.pid=' . intval($this->conf['pages'])
-                . ' AND tx_dlf_collections.pid=' . intval($this->conf['pages'])
-                . ' AND tx_dlf_relations.ident=' . $GLOBALS['TYPO3_DB']->fullQuoteStr('docs_colls', 'tx_dlf_relations')
+            'AND tx_dlf_documents.record_id='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->piVars['identifier'], 'tx_dlf_documents')
+                . ' AND tx_dlf_documents.pid='.intval($this->conf['pages'])
+                . ' AND tx_dlf_collections.pid='.intval($this->conf['pages'])
+                . ' AND tx_dlf_relations.ident='.$GLOBALS['TYPO3_DB']->fullQuoteStr('docs_colls', 'tx_dlf_relations')
                 . $where
                 . Helper::whereClause('tx_dlf_collections'),
             '',
@@ -584,7 +584,7 @@ 
             $timestamp = $resArray['tstamp'];
             $earliestDatestamp = gmdate('Y-m-d\TH:i:s\Z', $timestamp);
         } else {
-            Helper::devLog('No records found with PID ' . $this->conf['pages'], DEVLOG_SEVERITY_NOTICE);
+            Helper::devLog('No records found with PID '.$this->conf['pages'], DEVLOG_SEVERITY_NOTICE);
         }
         $linkConf = [
             'parameter' => $GLOBALS['TSFE']->id,
@@ -844,9 +844,9 @@ 
             }
             $resArray = $allResults[0];
             if ($resArray['index_query'] != "") {
-                $solr_query .= '(' . $resArray['index_query'] . ')';
+                $solr_query .= '('.$resArray['index_query'].')';
             } else {
-                $solr_query .= 'collection:' . '"' . $resArray['index_name'] . '"';
+                $solr_query .= 'collection:'.'"'.$resArray['index_name'].'"';
             }
         } else {
             // If no set is specified we have to query for all collections
@@ -854,7 +854,7 @@ 
         }
         // Check for required fields.
         foreach ($this->formats[$this->piVars['metadataPrefix']]['requiredFields'] as $required) {
-            $solr_query .= ' NOT ' . $required . ':""';
+            $solr_query .= ' NOT '.$required.':""';
         }
         // toplevel="true" is always required
         $solr_query .= ' AND toplevel:true';
@@ -867,7 +867,7 @@ 
                 || is_array($date_array = strptime($this->piVars['from'], '%Y-%m-%d'))
             ) {
                 $timestamp = gmmktime($date_array['tm_hour'], $date_array['tm_min'], $date_array['tm_sec'], $date_array['tm_mon'] + 1, $date_array['tm_mday'], $date_array['tm_year'] + 1900);
-                $from = date("Y-m-d", $timestamp) . 'T' . date("H:i:s", $timestamp) . '.000Z';
+                $from = date("Y-m-d", $timestamp).'T'.date("H:i:s", $timestamp).'.000Z';
             } else {
                 throw new \Exception('badArgument');
             }
@@ -881,7 +881,7 @@ 
                 || is_array($date_array = strptime($this->piVars['until'], '%Y-%m-%d'))
             ) {
                 $timestamp = gmmktime($date_array['tm_hour'], $date_array['tm_min'], $date_array['tm_sec'], $date_array['tm_mon'] + 1, $date_array['tm_mday'], $date_array['tm_year'] + 1900);
-                $until = date("Y-m-d", $timestamp) . 'T' . date("H:i:s", $timestamp) . '.999Z';
+                $until = date("Y-m-d", $timestamp).'T'.date("H:i:s", $timestamp).'.999Z';
                 if ($from != "*" && $from > $until) {
                     throw new \Exception('badArgument');
                 }
@@ -898,7 +898,7 @@ 
                 throw new \Exception('badArgument');
             }
         }
-        $solr_query .= ' AND timestamp:[' . $from . ' TO ' . $until . ']';
+        $solr_query .= ' AND timestamp:['.$from.' TO '.$until.']';
         $documentSet = [];
         $solr = Solr::getInstance($this->conf['solrcore']);
         if (intval($this->conf['solr_limit']) > 0) {
@@ -938,10 +938,10 @@ 
             'tx_dlf_documents',
             'tx_dlf_relations',
             'tx_dlf_collections',
-            'AND tx_dlf_documents.uid IN (' . implode(',', $GLOBALS['TYPO3_DB']->cleanIntArray($documentsToProcess)) . ')'
-                . ' AND tx_dlf_documents.pid=' . intval($this->conf['pages'])
-                . ' AND tx_dlf_collections.pid=' . intval($this->conf['pages'])
-                . ' AND tx_dlf_relations.ident=' . $GLOBALS['TYPO3_DB']->fullQuoteStr('docs_colls', 'tx_dlf_relations')
+            'AND tx_dlf_documents.uid IN ('.implode(',', $GLOBALS['TYPO3_DB']->cleanIntArray($documentsToProcess)).')'
+                . ' AND tx_dlf_documents.pid='.intval($this->conf['pages'])
+                . ' AND tx_dlf_collections.pid='.intval($this->conf['pages'])
+                . ' AND tx_dlf_relations.ident='.$GLOBALS['TYPO3_DB']->fullQuoteStr('docs_colls', 'tx_dlf_relations')
                 . Helper::whereClause('tx_dlf_collections'),
             'tx_dlf_documents.uid',
             'tx_dlf_documents.tstamp',

Braces +18 added lines, -36 removed lines

@@ -26,8 +26,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class OaiPmh extends \Kitodo\Dlf\Common\AbstractPlugin
-{
+class OaiPmh extends \Kitodo\Dlf\Common\AbstractPlugin {
     public $scriptRelPath = 'Classes/Plugin/OaiPmh.php';
 
     /**
@@ -77,8 +76,7 @@ 
      *
      * @return void
      */
-    protected function deleteExpiredTokens()
-    {
+    protected function deleteExpiredTokens() {
         // Delete expired resumption tokens.
         $GLOBALS['TYPO3_DB']->exec_DELETEquery(
             'tx_dlf_tokens',
@@ -99,8 +97,7 @@ 
      *
      * @return \DOMElement XML node to add to the OAI response
      */
-    protected function error($type)
-    {
+    protected function error($type) {
         $this->error = true;
         $error = $this->oai->createElementNS('http://www.openarchives.org/OAI/2.0/', 'error', htmlspecialchars($this->pi_getLL($type, $type, false), ENT_NOQUOTES, 'UTF-8'));
         $error->setAttribute('code', $type);
@@ -114,8 +111,7 @@ 
      *
      * @return void
      */
-    protected function getUrlParams()
-    {
+    protected function getUrlParams() {
         $allowedParams = [
             'verb',
             'identifier',
@@ -145,8 +141,7 @@ 
      *
      * @return \DOMElement XML node to add to the OAI response
      */
-    protected function getDcData(array $metadata)
-    {
+    protected function getDcData(array $metadata) {
         $oai_dc = $this->oai->createElementNS($this->formats['oai_dc']['namespace'], 'oai_dc:dc');
         $oai_dc->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:dc', 'http://purl.org/dc/elements/1.1/');
         $oai_dc->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
@@ -224,8 +219,7 @@ 
      *
      * @return \DOMElement XML node to add to the OAI response
      */
-    protected function getEpicurData(array $metadata)
-    {
+    protected function getEpicurData(array $metadata) {
         // Define all XML elements with or without qualified namespace.
         if (empty($this->conf['unqualified_epicur'])) {
             $epicur = $this->oai->createElementNS($this->formats['epicur']['namespace'], 'epicur:epicur');
@@ -288,8 +282,7 @@ 
      *
      * @return \DOMElement XML node to add to the OAI response
      */
-    protected function getMetsData(array $metadata)
-    {
+    protected function getMetsData(array $metadata) {
         $mets = null;
         // Load METS file.
         $xml = new \DOMDocument();
@@ -321,8 +314,7 @@ 
      *
      * @return void
      */
-    public function main($content, $conf)
-    {
+    public function main($content, $conf) {
         // Initialize plugin.
         $this->init($conf);
         // Turn cache off.
@@ -412,8 +404,7 @@ 
      *
      * @return \DOMElement XML node to add to the OAI response
      */
-    protected function resume()
-    {
+    protected function resume() {
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable('tx_dlf_tokens');
 
@@ -447,8 +438,7 @@ 
      *
      * @return \DOMElement XML node to add to the OAI response
      */
-    protected function verbGetRecord()
-    {
+    protected function verbGetRecord() {
         if (count($this->piVars) != 3 || empty($this->piVars['metadataPrefix']) || empty($this->piVars['identifier'])) {
             return $this->error('badArgument');
         }
@@ -527,8 +517,7 @@ 
      *
      * @return \DOMElement XML node to add to the OAI response
      */
-    protected function verbIdentify()
-    {
+    protected function verbIdentify() {
         // Check for invalid arguments.
         if (count($this->piVars) > 1) {
             return $this->error('badArgument');
@@ -610,8 +599,7 @@ 
      *
      * @return \DOMElement XML node to add to the OAI response
      */
-    protected function verbListIdentifiers()
-    {
+    protected function verbListIdentifiers() {
         // If we have a resumption token we can continue our work
         if (!empty($this->piVars['resumptionToken'])) {
             // "resumptionToken" is an exclusive argument.
@@ -650,8 +638,7 @@ 
      *
      * @return \DOMElement XML node to add to the OAI response
      */
-    protected function verbListMetadataFormats()
-    {
+    protected function verbListMetadataFormats() {
         $resArray = [];
         // Check for invalid arguments.
         if (count($this->piVars) > 1) {
@@ -709,8 +696,7 @@ 
      *
      * @return \DOMElement XML node to add to the OAI response
      */
-    protected function verbListRecords()
-    {
+    protected function verbListRecords() {
         // Check for invalid arguments.
         if (!empty($this->piVars['resumptionToken'])) {
             // "resumptionToken" is an exclusive argument.
@@ -750,8 +736,7 @@ 
      *
      * @return \DOMElement XML node to add to the OAI response
      */
-    protected function verbListSets()
-    {
+    protected function verbListSets() {
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable('tx_dlf_collections');
 
@@ -807,8 +792,7 @@ 
      * @return array Array of matching records
      * @throws \Exception
      */
-    protected function fetchDocumentUIDs()
-    {
+    protected function fetchDocumentUIDs() {
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable('tx_dlf_collections');
 
@@ -929,8 +913,7 @@ 
      *
      * @return \DOMElement XML of enriched records
      */
-    protected function generateOutputForDocumentList(DocumentList $documentListSet)
-    {
+    protected function generateOutputForDocumentList(DocumentList $documentListSet) {
         $documentsToProcess = $documentListSet->removeRange(0, intval($this->conf['limit']));
         $verb = $this->piVars['verb'];
         $documents = $GLOBALS['TYPO3_DB']->exec_SELECT_mm_query(
@@ -1016,8 +999,7 @@ 
      *
      * @return \DOMElement XML for resumption token
      */
-    protected function generateResumptionTokenForDocumentListSet(DocumentList $documentListSet)
-    {
+    protected function generateResumptionTokenForDocumentListSet(DocumentList $documentListSet) {
         if ($documentListSet->count() != 0) {
             $token = uniqid();
             $GLOBALS['TYPO3_DB']->exec_INSERTquery(

Upper-Lower-Casing +8 added lines, -8 removed lines

@@ -36,7 +36,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $error = false;
+    protected $error = FALSE;
 
     /**
      * This holds the OAI DOM object
@@ -101,8 +101,8 @@ 
      */
     protected function error($type)
     {
-        $this->error = true;
-        $error = $this->oai->createElementNS('http://www.openarchives.org/OAI/2.0/', 'error', htmlspecialchars($this->pi_getLL($type, $type, false), ENT_NOQUOTES, 'UTF-8'));
+        $this->error = TRUE;
+        $error = $this->oai->createElementNS('http://www.openarchives.org/OAI/2.0/', 'error', htmlspecialchars($this->pi_getLL($type, $type, FALSE), ENT_NOQUOTES, 'UTF-8'));
         $error->setAttribute('code', $type);
         return $error;
     }
@@ -290,7 +290,7 @@ 
      */
     protected function getMetsData(array $metadata)
     {
-        $mets = null;
+        $mets = NULL;
         // Load METS file.
         $xml = new \DOMDocument();
         if ($xml->load($metadata['location'])) {
@@ -298,15 +298,15 @@ 
             $root = $xml->getElementsByTagNameNS($this->formats['mets']['namespace'], 'mets');
             if ($root->item(0) instanceof \DOMNode) {
                 // Import node into \DOMDocument.
-                $mets = $this->oai->importNode($root->item(0), true);
+                $mets = $this->oai->importNode($root->item(0), TRUE);
             } else {
                 Helper::devLog('No METS part found in document with location "' . $metadata['location'] . '"', DEVLOG_SEVERITY_ERROR);
             }
         } else {
             Helper::devLog('Could not load XML file from "' . $metadata['location'] . '"', DEVLOG_SEVERITY_ERROR);
         }
-        if ($mets === null) {
-            $mets = $this->oai->createElementNS('http://kitodo.org/', 'kitodo:error', htmlspecialchars($this->pi_getLL('error', 'Error!', false), ENT_NOQUOTES, 'UTF-8'));
+        if ($mets === NULL) {
+            $mets = $this->oai->createElementNS('http://kitodo.org/', 'kitodo:error', htmlspecialchars($this->pi_getLL('error', 'Error!', FALSE), ENT_NOQUOTES, 'UTF-8'));
         }
         return $mets;
     }
@@ -326,7 +326,7 @@ 
         // Initialize plugin.
         $this->init($conf);
         // Turn cache off.
-        $this->setCache(false);
+        $this->setCache(FALSE);
         // Get GET and POST variables.
         $this->getUrlParams();
         // Delete expired resumption tokens.