Merge pull request #19159 from MauricioFauth/response-renderer-disabl…

…e-removal Remove the ResponseRenderer::disable() method
phpmyadmin · May 14, 2024 · 4c98f9b · 4c98f9b
2 parents 797fe78 + 578ed90
commit 4c98f9b
Show file tree

Hide file tree

Showing 15 changed files with 453 additions and 205 deletions.
diff --git a/app/services_controllers.php b/app/services_controllers.php
@@ -369,7 +369,7 @@
         ],
         Export\ExportController::class => [
             'class' => Export\ExportController::class,
-            'arguments' => ['$response' => '@response', '$export' => '@export'],
+            'arguments' => ['@response', '@export', '@' . ResponseFactory::class],
         ],
         Export\TablesController::class => [
             'class' => Export\TablesController::class,

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -7215,11 +7215,6 @@ parameters:
 			count: 1
 			path: src/Export/Export.php
 
-		-
-			message: "#^Method PhpMyAdmin\\\\Export\\\\Export\\:\\:getMemoryLimit\\(\\) should return int but returns \\(float\\|int\\)\\.$#"
-			count: 1
-			path: src/Export/Export.php
-
 		-
 			message: "#^Only booleans are allowed in a negated boolean, int\\|false given\\.$#"
 			count: 1

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1814,6 +1814,7 @@
       <code><![CDATA[$whatStrucOrData]]></code>
     </PossiblyInvalidArgument>
     <PossiblyInvalidCast>
+      <code><![CDATA[$this->export->dumpBuffer]]></code>
       <code><![CDATA[$this->export->dumpBuffer]]></code>
       <code><![CDATA[$whatStrucOrData]]></code>
       <code><![CDATA[$whatStrucOrData]]></code>
@@ -1844,13 +1845,6 @@
       <code><![CDATA[$GLOBALS['export_type']]]></code>
       <code><![CDATA[$GLOBALS['export_type']]]></code>
     </PossiblyNullArgument>
-    <PossiblyUnusedReturnValue>
-      <code><![CDATA[Response|null]]></code>
-    </PossiblyUnusedReturnValue>
-    <RedundantCondition>
-      <code><![CDATA[! $GLOBALS['save_on_server']]]></code>
-      <code><![CDATA[$outputFormat === 'sendit' && ! $GLOBALS['save_on_server']]]></code>
-    </RedundantCondition>
     <RiskyTruthyFalsyComparison>
       <code><![CDATA[$asSeparateFiles]]></code>
       <code><![CDATA[$onServerParam]]></code>
@@ -5737,12 +5731,6 @@
       <code><![CDATA[$GLOBALS['time_start']]]></code>
       <code><![CDATA[$GLOBALS['xkana']]]></code>
     </InvalidArrayOffset>
-    <InvalidReturnStatement>
-      <code><![CDATA[$memoryLimit]]></code>
-    </InvalidReturnStatement>
-    <InvalidReturnType>
-      <code><![CDATA[int]]></code>
-    </InvalidReturnType>
     <MixedArgument>
       <code><![CDATA[$GLOBALS['xkana'] ?? '']]></code>
       <code><![CDATA[$dbAlias]]></code>
@@ -13673,7 +13661,6 @@
       <code><![CDATA[Config::getInstance()]]></code>
       <code><![CDATA[Config::getInstance()]]></code>
       <code><![CDATA[Config::getInstance()]]></code>
-      <code><![CDATA[Config::getInstance()]]></code>
     </DeprecatedMethod>
     <InaccessibleProperty>
       <code><![CDATA[$config->config->debug->sql]]></code>

diff --git a/src/Controllers/Export/ExportController.php b/src/Controllers/Export/ExportController.php
@@ -13,6 +13,7 @@
 use PhpMyAdmin\Encoding;
 use PhpMyAdmin\Exceptions\ExportException;
 use PhpMyAdmin\Export\Export;
+use PhpMyAdmin\Http\Factory\ResponseFactory;
 use PhpMyAdmin\Http\Response;
 use PhpMyAdmin\Http\ServerRequest;
 use PhpMyAdmin\Identifiers\DatabaseName;
@@ -39,8 +40,11 @@
 
 final class ExportController implements InvocableController
 {
-    public function __construct(private readonly ResponseRenderer $response, private readonly Export $export)
-    {
+    public function __construct(
+        private readonly ResponseRenderer $response,
+        private readonly Export $export,
+        private readonly ResponseFactory $responseFactory,
+    ) {
     }
 
     public function __invoke(ServerRequest $request): Response|null
@@ -164,14 +168,6 @@ public function __invoke(ServerRequest $request): Response|null
             }
         }
 
-        /**
-         * If we are sending the export file (as opposed to just displaying it
-         * as text), we have to bypass the usual PhpMyAdmin\Response mechanism
-         */
-        if ($outputFormat === 'sendit' && ! $GLOBALS['save_on_server']) {
-            $this->response->disable();
-        }
-
         $tableNames = [];
         // Generate error url and check for needed variables
         if ($GLOBALS['export_type'] === 'server') {
@@ -546,9 +542,7 @@ public function __invoke(ServerRequest $request): Response|null
             return null;
         }
 
-        echo $this->export->dumpBuffer;
-
-        return null;
+        return $this->responseFactory->createResponse()->write($this->export->dumpBuffer);
     }
 
     /**

diff --git a/src/Export/Export.php b/src/Export/Export.php
@@ -276,7 +276,7 @@ public function getMemoryLimit(): int
         // Some memory is needed for compression, assume 1/3
         $memoryLimit /= 8;
 
-        return $memoryLimit;
+        return (int) $memoryLimit;
     }
 
     /**

diff --git a/src/Footer.php b/src/Footer.php
@@ -37,10 +37,6 @@ class Footer
      * or also include scripts, errors and links
      */
     private bool $isMinimal = false;
-    /**
-     * Whether to display anything
-     */
-    private bool $isEnabled = true;
 
     public function __construct(private readonly Template $template, private readonly Config $config)
     {
@@ -155,14 +151,6 @@ public function getErrorMessages(): string
         return $retval;
     }
 
-    /**
-     * Disables the rendering of the footer
-     */
-    public function disable(): void
-    {
-        $this->isEnabled = false;
-    }
-
     /**
      * Set the ajax flag to indicate whether
      * we are servicing an ajax request
@@ -197,10 +185,6 @@ public function getScripts(): Scripts
      */
     public function getDisplay(): string
     {
-        if (! $this->isEnabled) {
-            return '';
-        }
-
         if (! $this->isAjax && ! $this->isMinimal) {
             if (Core::getEnv('SCRIPT_NAME') !== '') {
                 $url = $this->getSelfUrl();

diff --git a/src/Header.php b/src/Header.php
@@ -59,10 +59,6 @@ class Header
      * Whether we are servicing an ajax request.
      */
     private bool $isAjax = false;
-    /**
-     * Whether to display anything
-     */
-    private bool $isEnabled = true;
     /**
      * Whether the HTTP headers (and possibly some HTML)
      * have already been sent to the browser
@@ -163,14 +159,6 @@ public function getJsParamsCode(): string
         return 'window.Navigation.update(window.CommonParams.setAll(' . json_encode($params, JSON_HEX_TAG) . '));';
     }
 
-    /**
-     * Disables the rendering of the header
-     */
-    public function disable(): void
-    {
-        $this->isEnabled = false;
-    }
-
     /**
      * Set the ajax flag to indicate whether
      * we are servicing an ajax request
@@ -247,7 +235,7 @@ public function disableWarnings(): void
      */
     public function getDisplay(): string
     {
-        if ($this->headerIsSent || ! $this->isEnabled || $this->isAjax) {
+        if ($this->headerIsSent || $this->isAjax) {
             return '';
         }
 

diff --git a/src/Plugins/Auth/AuthenticationCookie.php b/src/Plugins/Auth/AuthenticationCookie.php
@@ -7,12 +7,14 @@
 
 namespace PhpMyAdmin\Plugins\Auth;
 
+use Fig\Http\Message\StatusCodeInterface;
 use PhpMyAdmin\Config;
 use PhpMyAdmin\Core;
 use PhpMyAdmin\Current;
 use PhpMyAdmin\Error\ErrorHandler;
 use PhpMyAdmin\Exceptions\AuthenticationFailure;
 use PhpMyAdmin\Exceptions\SessionHandlerException;
+use PhpMyAdmin\Http\Factory\ResponseFactory;
 use PhpMyAdmin\Http\Response;
 use PhpMyAdmin\LanguageManager;
 use PhpMyAdmin\Message;
@@ -478,10 +480,11 @@ public function rememberCredentials(): Response|null
         Util::clearUserCache();
 
         $responseRenderer = ResponseRenderer::getInstance();
-        $responseRenderer->disable();
-        $responseRenderer->redirect('./index.php?route=/' . Url::getCommonRaw($urlParams, '&'));
 
-        return $responseRenderer->response();
+        return ResponseFactory::create()->createResponse(StatusCodeInterface::STATUS_FOUND)->withHeader(
+            'Location',
+            $responseRenderer->fixRelativeUrlForRedirect('./index.php?route=/' . Url::getCommonRaw($urlParams, '&')),
+        );
     }
 
     /**

diff --git a/src/Plugins/Auth/AuthenticationSignon.php b/src/Plugins/Auth/AuthenticationSignon.php
@@ -7,8 +7,10 @@
 
 namespace PhpMyAdmin\Plugins\Auth;
 
+use Fig\Http\Message\StatusCodeInterface;
 use PhpMyAdmin\Config;
 use PhpMyAdmin\Exceptions\AuthenticationFailure;
+use PhpMyAdmin\Http\Factory\ResponseFactory;
 use PhpMyAdmin\Http\Response;
 use PhpMyAdmin\LanguageManager;
 use PhpMyAdmin\Plugins\AuthenticationPlugin;
@@ -40,7 +42,6 @@ class AuthenticationSignon extends AuthenticationPlugin
     public function showLoginForm(): Response
     {
         $responseRenderer = ResponseRenderer::getInstance();
-        $responseRenderer->disable();
         unset($_SESSION['LAST_SIGNON_URL']);
         $config = Config::getInstance();
         if (empty($config->selectedServer['SignonURL'])) {
@@ -53,9 +54,10 @@ public function showLoginForm(): Response
             return $responseRenderer->response();
         }
 
-        $responseRenderer->redirect($config->selectedServer['SignonURL']);
-
-        return $responseRenderer->response();
+        return ResponseFactory::create()->createResponse(StatusCodeInterface::STATUS_FOUND)->withHeader(
+            'Location',
+            $responseRenderer->fixRelativeUrlForRedirect($config->selectedServer['SignonURL']),
+        );
     }
 
     /**

diff --git a/src/ResponseRenderer.php b/src/ResponseRenderer.php
@@ -51,10 +51,6 @@ class ResponseRenderer
      * Whether we are servicing an ajax request.
      */
     protected bool $isAjax = false;
-    /**
-     * Whether response object is disabled
-     */
-    protected bool $isDisabled = false;
     /**
      * Whether there were any errors during the processing of the request
      * Only used for ajax responses
@@ -205,17 +201,6 @@ public function isAjax(): bool
         return $this->isAjax;
     }
 
-    /**
-     * Disables the rendering of the header
-     * and the footer in responses
-     */
-    public function disable(): void
-    {
-        $this->header->disable();
-        $this->footer->disable();
-        $this->isDisabled = true;
-    }
-
     /**
      * Returns a PhpMyAdmin\Header object
      */
@@ -273,11 +258,6 @@ private function getDisplay(): string
      */
     private function ajaxResponse(): string
     {
-        /* Avoid wrapping in case we're disabled */
-        if ($this->isDisabled) {
-            return $this->getDisplay();
-        }
-
         if (! isset($this->JSON['message'])) {
             $this->JSON['message'] = $this->getDisplay();
         } elseif ($this->JSON['message'] instanceof Message) {