[MAINTENANCE] Use Middleware for PageViewProxy

Classes/Controller/AbstractController.php

@@ -169,7 +169,7 @@ protected function configureProxyUrl(string &$url): void
             ->setCreateAbsoluteUri(!empty($this->settings['forceAbsoluteUrl']))
             ->setArguments(
                 [
-                    'eID' => 'tx_dlf_pageview_proxy',
+                    'middleware' => 'page-view-proxy',
                     'url' => $url,
                     'uHash' => GeneralUtility::hmac($url, 'PageViewProxy')
                 ]

Classes/Eid/PageViewProxy.php → Classes/Middleware/PageViewProxy.php

@@ -10,20 +10,22 @@
  * LICENSE.txt file that was distributed with this source code.
  */
 
-namespace Kitodo\Dlf\Eid;
+namespace Kitodo\Dlf\Middleware;
 
 use Kitodo\Dlf\Common\Helper;
 use Kitodo\Dlf\Common\StdOutStream;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\MiddlewareInterface;
+use Psr\Http\Server\RequestHandlerInterface;
 use TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
 use TYPO3\CMS\Core\Http\JsonResponse;
 use TYPO3\CMS\Core\Http\RequestFactory;
 use TYPO3\CMS\Core\Http\Response;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
- * eID image proxy for plugin 'Page View' of the 'dlf' extension
+ * Image proxy Middleware for plugin 'Page View' of the 'dlf' extension
  *
  * Supported query parameters:
  * - `url` (mandatory): The URL to be proxied
@@ -34,7 +36,7 @@
  *
  * @access public
  */
-class PageViewProxy
+class PageViewProxy implements MiddlewareInterface
 {
     /**
      * @access protected
@@ -61,15 +63,51 @@ public function __construct()
         $this->extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get('dlf');
     }
 
+    /**
+     * The process method of the middleware.
+     *
+     * @access public
+     *
+     * @param ServerRequestInterface $request
+     * @param RequestHandlerInterface $handler
+     *
+     * @return ResponseInterface
+     */
+    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
+    {
+        $response = $handler->handle($request);
+        // Get input parameters and decrypt core name.
+        $parameters = $request->getQueryParams();
+        if (!isset($parameters['middleware']) || ($parameters['middleware'] != 'page-view-proxy')) {
+            return $response;
+        }
+
+        switch ($request->getMethod()) {
+            case 'OPTIONS':
+                return $this->handleOptions($request);
+
+            case 'GET':
+                return $this->handleGet($request);
+
+            case 'HEAD':
+                return $this->handleHead($request);
+
+            default:
+                // 405 Method Not Allowed
+                return GeneralUtility::makeInstance(Response::class)
+                    ->withStatus(405);
+        }
+    }
+
     /**
      * Return a response that is derived from $response and contains CORS
      * headers to be sent to the client.
-     * 
+     *
      * @access protected
      *
      * @param ResponseInterface $response
      * @param ServerRequestInterface $request The incoming request.
-     * 
+     *
      * @return ResponseInterface
      */
     protected function withCorsResponseHeaders(
@@ -223,32 +261,4 @@ protected function handleGet(ServerRequestInterface $request): ResponseInterface
 
         return $this->withCorsResponseHeaders($clientResponse, $request);
     }
-
-    /**
-     * The main method of the eID script
-     *
-     * @access public
-     *
-     * @param ServerRequestInterface $request
-     *
-     * @return ResponseInterface
-     */
-    public function main(ServerRequestInterface $request): ResponseInterface
-    {
-        switch ($request->getMethod()) {
-            case 'OPTIONS':
-                return $this->handleOptions($request);
-
-            case 'GET':
-                return $this->handleGet($request);
-
-            case 'HEAD':
-                return $this->handleHead($request);
-
-            default:
-                // 405 Method Not Allowed
-                return GeneralUtility::makeInstance(Response::class)
-                    ->withStatus(405);
-        }
-    }
 }

Configuration/RequestMiddlewares.php

@@ -11,6 +11,11 @@
  */
 
 return [
+    'backend' => [
+        'page-view-proxy' => [
+            'target' => \Kitodo\Dlf\Middleware\PageViewProxy::class,
+        ],
+    ],
     'frontend' => [
         'dlf/search-in-document' => [
             'target' => \Kitodo\Dlf\Middleware\SearchInDocument::class,

Tests/Functional/Api/PageViewProxyDisabledTest.php

@@ -11,7 +11,7 @@ class PageViewProxyDisabledTest extends FunctionalTestCase
 
     protected function queryProxy(array $query, string $method = 'GET')
     {
-        $query['eID'] = 'tx_dlf_pageview_proxy';
+        $query['middleware'] = 'page-view-proxy';
 
         return $this->httpClient->request($method, '', [
             'query' => $query,

Tests/Functional/Api/PageViewProxyTest.php

@@ -2,7 +2,6 @@
 
 namespace Kitodo\Dlf\Tests\Functional\Api;
 
-use GuzzleHttp\Client as HttpClient;
 use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
@@ -19,7 +18,7 @@ protected function getDlfConfiguration()
 
     protected function queryProxy(array $query, string $method = 'GET')
     {
-        $query['eID'] = 'tx_dlf_pageview_proxy';
+        $query['middleware'] = 'page-view-proxy';
 
         return $this->httpClient->request($method, '', [
             'query' => $query,

ext_localconf.php

@@ -77,10 +77,6 @@
 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processDatamapClass'][] = \Kitodo\Dlf\Hooks\DataHandler::class;
 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processCmdmapClass'][] = \Kitodo\Dlf\Hooks\DataHandler::class;
 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Common/MetsDocument.php']['hookClass'][] = \Kitodo\Dlf\Hooks\KitodoProductionHacks::class;
-// Register AJAX eID handlers.
-if ($GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['dlf']['enableInternalProxy'] ?? false) {
-    $GLOBALS['TYPO3_CONF_VARS']['FE']['eID_include']['tx_dlf_pageview_proxy'] = \Kitodo\Dlf\Eid\PageViewProxy::class . '::main';
-}
 // Use Caching Framework for Solr queries
 if (!is_array($GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations']['tx_dlf_solr'])) {
     $GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations']['tx_dlf_solr'] = [];