Fix error: Direct use of $GLOBALS Superglobal detected

kitodo · May 28, 2024 · 34b3f99 · 34b3f99
1 parent 7a799a5
commit 34b3f99
Show file tree

Hide file tree

Showing 13 changed files with 54 additions and 35 deletions.
diff --git a/Classes/Command/BaseCommand.php b/Classes/Command/BaseCommand.php
@@ -299,7 +299,7 @@ protected function getParentDocumentUidForSaving(Document $document): int
 
  if ($doc !== null && !empty($doc->parentHref)) {
  // find document object by record_id of parent
- $parent = AbstractDocument::getInstance($doc->parentHref, ['storagePid' => $this->storagePid]);
+ $parent = AbstractDocument::getInstance($doc->parentHref, 0, ['storagePid' => $this->storagePid]);
 
  if ($parent->recordId) {
  $parentDocument = $this->documentRepository->findOneByRecordId($parent->recordId);

diff --git a/Classes/Command/HarvestCommand.php b/Classes/Command/HarvestCommand.php
@@ -226,7 +226,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
  $docLocation = $baseLocation . http_build_query($params);
  // ...index the document...
  $document = null;
- $doc = AbstractDocument::getInstance($docLocation, ['storagePid' => $this->storagePid], true);
+ $doc = AbstractDocument::getInstance($docLocation, 0, ['storagePid' => $this->storagePid], true);
 
  if ($doc === null) {
  $io->warning('WARNING: Document "' . $docLocation . '" could not be loaded. Skip to next document.');

diff --git a/Classes/Command/IndexCommand.php b/Classes/Command/IndexCommand.php
@@ -162,11 +162,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
  $io->error('ERROR: Document with UID "' . $input->getOption('doc') . '" could not be found on PID ' . $this->storagePid . ' .');
  exit(1);
  } else {
- $doc = AbstractDocument::getInstance($document->getLocation(), ['storagePid' => $this->storagePid], true);
+ $doc = AbstractDocument::getInstance($document->getLocation(), 0, ['storagePid' => $this->storagePid], true);
  }
 
  } else if (GeneralUtility::isValidUrl($input->getOption('doc'))) {
- $doc = AbstractDocument::getInstance($input->getOption('doc'), ['storagePid' => $this->storagePid], true);
+ $doc = AbstractDocument::getInstance($input->getOption('doc'), 0, ['storagePid' => $this->storagePid], true);
 
  $document = $this->getDocumentFromUrl($doc, $input->getOption('doc'));
  }

diff --git a/Classes/Command/ReindexCommand.php b/Classes/Command/ReindexCommand.php
@@ -186,7 +186,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
  }
 
  foreach ($documents as $id => $document) {
- $doc = AbstractDocument::getInstance($document->getLocation(), ['storagePid' => $this->storagePid], true);
+ $doc = AbstractDocument::getInstance($document->getLocation(), 0, ['storagePid' => $this->storagePid], true);
 
  if ($doc === null) {
  $io->warning('WARNING: Document "' . $document->getLocation() . '" could not be loaded. Skip to next document.');

diff --git a/Classes/Common/AbstractDocument.php b/Classes/Common/AbstractDocument.php
@@ -71,6 +71,12 @@ abstract class AbstractDocument
  */
  protected int $cPid = 0;
 
+ /**
+ * @access protected
+ * @var int This holds the page ID for the requests
+ */
+ protected int $pageId = 0;
+
  /**
  * @access public
  * @static
@@ -544,12 +550,13 @@ abstract public function getAllFiles(): array;
  * @static
  *
  * @param string $location The URL of XML file or the IRI of the IIIF resource
+ * @param int $pageId
  * @param array $settings
  * @param bool $forceReload Force reloading the document instead of returning the cached instance
  *
  * @return AbstractDocument|null Instance of this class, either MetsDocument or IiifManifest
  */
- public static function &getInstance(string $location, array $settings = [], bool $forceReload = false)
+ public static function &getInstance(string $location, int $pageId = 0, array $settings = [], bool $forceReload = false)
  {
  // Create new instance depending on format (METS or IIIF) ...
  $documentFormat = null;
@@ -600,11 +607,11 @@ public static function &getInstance(string $location, array $settings = [], bool
  // Sanitize input.
  $pid = max((int) $settings['storagePid'], 0);
  if ($documentFormat == 'METS') {
- $instance = new MetsDocument($pid, $location, $xml, $settings);
+ $instance = new MetsDocument($pid, $location, $pageId, $xml, $settings);
  } elseif ($documentFormat == 'IIIF') {
  // TODO: Parameter $preloadedDocument of class Kitodo\Dlf\Common\IiifManifest constructor expects SimpleXMLElement|Ubl\Iiif\Presentation\Common\Model\Resources\IiifResourceInterface, Ubl\Iiif\Presentation\Common\Model\AbstractIiifEntity|null given.
  // @phpstan-ignore-next-line
- $instance = new IiifManifest($pid, $location, $iiif);
+ $instance = new IiifManifest($pid, $location, $pageId, $iiif);
  }
 
  if ($instance) {
@@ -1164,7 +1171,7 @@ protected function magicGetRootId(): int
  if ($this->parentId) {
  // TODO: Parameter $location of static method AbstractDocument::getInstance() expects string, int<min, -1>|int<1, max> given.
  // @phpstan-ignore-next-line
- $parent = self::getInstance($this->parentId, ['storagePid' => $this->pid]);
+ $parent = self::getInstance($this->parentId, $this->pageId, ['storagePid' => $this->pid]);
  $this->rootId = $parent->rootId;
  }
  $this->rootIdLoaded = true;
@@ -1212,14 +1219,16 @@ protected function _setCPid(int $value): void
  *
  * @param int $pid If > 0, then only document with this PID gets loaded
  * @param string $location The location URL of the XML file to parse
+ * @param int $pageId
  * @param \SimpleXMLElement|IiifResourceInterface $preloadedDocument Either null or the \SimpleXMLElement
  * or IiifResourceInterface that has been loaded to determine the basic document format.
  *
  * @return void
  */
- protected function __construct(int $pid, string $location, $preloadedDocument, array $settings = [])
+ protected function __construct(int $pid, string $location, int $pageId, $preloadedDocument, array $settings = [])
  {
  $this->pid = $pid;
+ $this->pageId = $pageId;
  $this->setPreloadedDocument($preloadedDocument);
  $this->init($location, $settings);
  $this->establishRecordId($pid);
@@ -1415,7 +1424,7 @@ public function toArray($uriBuilder, array $config = [])
  // Configure @action URL for form.
  $file['url'] = $uriBuilder
  ->reset()
- ->setTargetPageUid($GLOBALS['TSFE']->id)
+ ->setTargetPageUid($this->pageId)
  ->setCreateAbsoluteUri($forceAbsoluteUrl)
  ->setArguments(
  [

diff --git a/Classes/Common/Indexer.php b/Classes/Common/Indexer.php
@@ -108,7 +108,7 @@ public static function add(Document $document, DocumentRepository $documentRepos
  $parent = $documentRepository->findByUid($parentId);
  if ($parent) {
  // get XML document of parent
- $doc = AbstractDocument::getInstance($parent->getLocation(), ['storagePid' => $parent->getPid()], true);
+ $doc = AbstractDocument::getInstance($parent->getLocation(), 0, ['storagePid' => $parent->getPid()], true);
  if ($doc !== null) {
  $parent->setCurrentDocument($doc);
  $success = self::add($parent, $documentRepository);

diff --git a/Classes/Controller/AbstractController.php b/Classes/Controller/AbstractController.php
@@ -15,6 +15,7 @@
 use Kitodo\Dlf\Common\Helper;
 use Kitodo\Dlf\Domain\Model\Document;
 use Kitodo\Dlf\Domain\Repository\DocumentRepository;
+use Psr\Http\Message\ServerRequestInterface;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 use TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
@@ -121,15 +122,17 @@ protected function loadDocument(int $documentId = 0): void
  $documentId = $this->requestData['id'];
  }
 
+ $pageId = $this->getRequest()->getAttribute('routing')->getPageId();
+
  // Try to get document format from database
  if (!empty($documentId)) {
 
  $doc = null;
 
  if (MathUtility::canBeInterpretedAsInteger($documentId)) {
- $doc = $this->getDocumentByUid($documentId);
+ $doc = $this->getDocumentByUid($documentId, $pageId);
  } elseif (GeneralUtility::isValidUrl($documentId)) {
- $doc = $this->getDocumentByUrl($documentId);
+ $doc = $this->getDocumentByUrl($documentId, $pageId);
  }
 
  if ($this->document !== null && $doc !== null) {
@@ -141,7 +144,7 @@ protected function loadDocument(int $documentId = 0): void
  $this->document = $this->documentRepository->findOneByRecordId($this->requestData['recordId']);
 
  if ($this->document !== null) {
- $doc = AbstractDocument::getInstance($this->document->getLocation(), $this->settings, true);
+ $doc = AbstractDocument::getInstance($this->document->getLocation(), $pageId, $this->settings, true);
  if ($doc !== null) {
  $this->document->setCurrentDocument($doc);
  } else {
@@ -165,7 +168,7 @@ protected function loadDocument(int $documentId = 0): void
  protected function configureProxyUrl(string &$url): void
  {
  $this->uriBuilder->reset()
- ->setTargetPageUid($GLOBALS['TSFE']->id)
+ ->setTargetPageUid($this->getRequest()->getAttribute('routing')->getPageId())
  ->setCreateAbsoluteUri(!empty($this->settings['forceAbsoluteUrl']))
  ->setArguments(
  [
@@ -434,22 +437,28 @@ protected function buildSimplePagination(PaginationInterface $pagination, Pagina
  ];
  }
 
+ protected function getRequest(): ServerRequestInterface
+ {
+ return $GLOBALS['TYPO3_REQUEST'];
+ }
+
  /**
  * Get document from repository by uid.
  *
  * @access private
  *
  * @param int $documentId The document's UID
+ * @param int $pageId
  *
  * @return AbstractDocument
  */
- private function getDocumentByUid(int $documentId)
+ private function getDocumentByUid(int $documentId, int $pageId)
  {
  $doc = null;
+ // find document from repository by uid
  $this->document = $this->documentRepository->findOneByIdAndSettings($documentId);
-
  if ($this->document) {
- $doc = AbstractDocument::getInstance($this->document->getLocation(), $this->settings, true);
+ $doc = AbstractDocument::getInstance($this->document->getLocation(), $pageId, $this->settings, true);
  } else {
  $this->logger->error('Invalid UID "' . $documentId . '" or PID "' . $this->settings['storagePid'] . '" for document loading');
  }
@@ -463,12 +472,13 @@ private function getDocumentByUid(int $documentId)
  * @access private
  *
  * @param string $documentId The document's URL
+ * @param int $pageId
  *
  * @return AbstractDocument
  */
- private function getDocumentByUrl(string $documentId)
+ private function getDocumentByUrl(string $documentId, int $pageId)
  {
- $doc = AbstractDocument::getInstance($documentId, $this->settings, true);
+ $doc = AbstractDocument::getInstance($documentId, $pageId, $this->settings, true);
 
  if ($doc !== null) {
  if ($doc->recordId) {
@@ -484,13 +494,13 @@ private function getDocumentByUrl(string $documentId)
 
  // Make sure configuration PID is set when applicable
  if ($doc->cPid == 0) {
- $doc->cPid = max((int) $this->settings['storagePid'], 0);
+ $doc->cPid = max(intval($this->settings['storagePid']), 0);
  }
 
  $this->document->setLocation($documentId);
- } else {
- $this->logger->error('Invalid location given "' . $documentId . '" for document loading');
- }
+  } else {
+  $this->logger->error('Invalid location given "' . $documentId . '" for document loading');
+  }
 
  return $doc;
  }

diff --git a/Classes/Controller/DocumentController.php b/Classes/Controller/DocumentController.php
@@ -119,7 +119,7 @@ protected function getUrlTemplate()
 
  $make = function ($page, $double, $pageGrid) {
  $result = $this->uriBuilder->reset()
- ->setTargetPageUid($this->configurationManager->getContentObject()->data['pid'])
+ ->setTargetPageUid($this->getRequest()->getAttribute('routing')->getPageId())
  ->setCreateAbsoluteUri(!empty($this->settings['forceAbsoluteUrl']) ? true : false)
  ->setArguments(
  [

diff --git a/Classes/Domain/Repository/DocumentRepository.php b/Classes/Domain/Repository/DocumentRepository.php
@@ -76,7 +76,7 @@ public function findOneByParameters($parameters)
 
  } else if (isset($parameters['location']) && GeneralUtility::isValidUrl($parameters['location'])) {
 
- $doc = AbstractDocument::getInstance($parameters['location'], [], true);
+ $doc = AbstractDocument::getInstance($parameters['location'], 0, [], true);
 
  if ($doc->recordId) {
  $document = $this->findOneByRecordId($doc->recordId);
@@ -91,7 +91,7 @@ public function findOneByParameters($parameters)
  }
 
  if ($document !== null && $doc === null) {
- $doc = AbstractDocument::getInstance($document->getLocation(), [], true);
+ $doc = AbstractDocument::getInstance($document->getLocation(), 0, [], true);
  }
 
  if ($doc !== null) {

diff --git a/Classes/ExpressionLanguage/DocumentTypeFunctionProvider.php b/Classes/ExpressionLanguage/DocumentTypeFunctionProvider.php
@@ -179,13 +179,13 @@ protected function loadDocument(array $requestData, int $pid): void
  // find document from repository by uid
  $this->document = $this->documentRepository->findOneByIdAndSettings((int) $requestData['id'], ['storagePid' => $pid]);
  if ($this->document) {
- $doc = AbstractDocument::getInstance($this->document->getLocation(), ['storagePid' => $pid], true);
+ $doc = AbstractDocument::getInstance($this->document->getLocation(), 0, ['storagePid' => $pid], true);
  } else {
  $this->logger->error('Invalid UID "' . $requestData['id'] . '" or PID "' . $pid . '" for document loading');
  }
  } else if (GeneralUtility::isValidUrl($requestData['id'])) {
 
- $doc = AbstractDocument::getInstance($requestData['id'], ['storagePid' => $pid], true);
+ $doc = AbstractDocument::getInstance($requestData['id'], 0, ['storagePid' => $pid], true);
 
  if ($doc !== null) {
  if ($doc->recordId) {
@@ -212,7 +212,7 @@ protected function loadDocument(array $requestData, int $pid): void
  $this->document = $this->documentRepository->findOneByRecordId($requestData['recordId']);
 
  if ($this->document !== null) {
- $doc = AbstractDocument::getInstance($this->document->getLocation(), ['storagePid' => $pid], true);
+ $doc = AbstractDocument::getInstance($this->document->getLocation(), 0, ['storagePid' => $pid], true);
  if ($doc !== null) {
  $this->document->setCurrentDocument($doc);
  } else {

diff --git a/Classes/Hooks/DataHandler.php b/Classes/Hooks/DataHandler.php
@@ -258,7 +258,7 @@ public function processDatamap_afterDatabaseOperations(string $status, string $t
  } else {
  // Reindex document.
  $document = $this->getDocumentRepository()->findByUid((int) $id);
- $doc = AbstractDocument::getInstance($document->getLocation(), ['storagePid' => $document->getPid()], true);
+ $doc = AbstractDocument::getInstance($document->getLocation(), 0, ['storagePid' => $document->getPid()], true);
  if ($document !== null && $doc !== null) {
  $document->setCurrentDocument($doc);
  Indexer::add($document, $this->getDocumentRepository());
@@ -340,7 +340,7 @@ public function processCmdmap_postProcess(string $command, string $table, $id):
  case 'undelete':
  // Reindex document.
  $document = $this->getDocumentRepository()->findByUid((int) $id);
- $doc = AbstractDocument::getInstance($document->getLocation(), ['storagePid' => $document->getPid()], true);
+ $doc = AbstractDocument::getInstance($document->getLocation(), 0, ['storagePid' => $document->getPid()], true);
  if ($document !== null && $doc !== null) {
  $document->setCurrentDocument($doc);
  Indexer::add($document, $this->getDocumentRepository());

diff --git a/Tests/Functional/Common/MetsDocumentTest.php b/Tests/Functional/Common/MetsDocumentTest.php
@@ -29,7 +29,7 @@ public function setUp(): void
  protected function doc(string $file)
  {
  $url = 'http://web:8001/Tests/Fixtures/MetsDocument/' . $file;
- $doc = AbstractDocument::getInstance($url, ['useExternalApisForMetadata' => 0]);
+ $doc = AbstractDocument::getInstance($url, 0, ['useExternalApisForMetadata' => 0]);
  self::assertNotNull($doc);
  return $doc;
  }

diff --git a/Tests/Functional/Common/SolrIndexingTest.php b/Tests/Functional/Common/SolrIndexingTest.php
@@ -77,7 +77,7 @@ public function canIndexAndSearchDocument()
  $document->setSolrcore($core->model->getUid());
  $this->persistenceManager->persistAll();
 
- $doc = AbstractDocument::getInstance($document->getLocation(), ['useExternalApisForMetadata' => 0]);
+ $doc = AbstractDocument::getInstance($document->getLocation(), 0, ['useExternalApisForMetadata' => 0]);
  $document->setCurrentDocument($doc);
 
  $indexingSuccessful = Indexer::add($document, $this->documentRepository);