[TASK] Use ServerRequestInterface in File/ReplaceFileController 12/56212/4
authorMathias Brodala <mbrodala@pagemachine.de>
Fri, 16 Mar 2018 11:06:12 +0000 (12:06 +0100)
committerChristian Kuhn <lolli@schwarzbu.ch>
Fri, 16 Mar 2018 12:33:11 +0000 (13:33 +0100)
* deprecate public properties
* deprecate public (non-routed) methods

Change-Id: Ibc8d9f48b026da94fed65ee1fbad962dcb98af7c
Resolves: #84334
Releases: master
Reviewed-on: https://review.typo3.org/56212
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Reviewed-by: Łukasz Uznański <l.uznanski@macopedia.pl>
Tested-by: Łukasz Uznański <l.uznanski@macopedia.pl>
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
typo3/sysext/backend/Classes/Controller/File/ReplaceFileController.php
typo3/sysext/core/Documentation/Changelog/master/Deprecation-84334-ProtectedMethodsAndPropertiesInReplaceFileController.rst [new file with mode: 0644]
typo3/sysext/install/Configuration/ExtensionScanner/Php/PropertyProtectedMatcher.php

index 12ba4c2..99790b8 100644 (file)
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 namespace TYPO3\CMS\Backend\Controller\File;
 
 /*
@@ -16,7 +17,9 @@ namespace TYPO3\CMS\Backend\Controller\File;
 
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
+use TYPO3\CMS\Backend\Routing\UriBuilder;
 use TYPO3\CMS\Backend\Template\ModuleTemplate;
+use TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait;
 use TYPO3\CMS\Core\Http\HtmlResponse;
 use TYPO3\CMS\Core\Imaging\Icon;
 use TYPO3\CMS\Core\Localization\LanguageService;
@@ -31,26 +34,39 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
  */
 class ReplaceFileController
 {
+    use PublicPropertyDeprecationTrait;
+
+    /**
+     * @var array
+     */
+    protected $deprecatedPublicProperties = [
+        'doc' => 'Using $doc of class ReplaceFileController from outside is discouraged as this variable is only used for internal storage.',
+        'title' => 'Using $title of class ReplaceFileController from outside is discouraged as this variable is only used for internal storage.',
+        'uid' => 'Using $uid of class ReplaceFileController from outside is discouraged as this variable is only used for internal storage.',
+        'returnUrl' => 'Using $returnUrl of class ReplaceFileController from outside is discouraged as this variable is only used for internal storage.',
+        'content' => 'Using $content of class ReplaceFileController from outside is discouraged as this variable is only used for internal storage.',
+    ];
+
     /**
      * Document template object
      *
      * @var \TYPO3\CMS\Backend\Template\DocumentTemplate
      */
-    public $doc;
+    protected $doc;
 
     /**
      * Name of the filemount
      *
      * @var string
      */
-    public $title;
+    protected $title;
 
     /**
      * sys_file uid
      *
      * @var int
      */
-    public $uid;
+    protected $uid;
 
     /**
      * The file or folder object that should be renamed
@@ -64,14 +80,14 @@ class ReplaceFileController
      *
      * @var string
      */
-    public $returnUrl;
+    protected $returnUrl;
 
     /**
      * Accumulating content
      *
      * @var string
      */
-    public $content;
+    protected $content;
 
     /**
      * ModuleTemplate object
@@ -87,22 +103,49 @@ class ReplaceFileController
     {
         $this->moduleTemplate = GeneralUtility::makeInstance(ModuleTemplate::class);
         $GLOBALS['SOBE'] = $this;
-        $this->init();
+
+        // @deprecated since v9, will be moved out of __construct() in v10
+        $this->init($GLOBALS['TYPO3_REQUEST']);
+    }
+
+    /**
+     * Processes the request, currently everything is handled and put together via "main()"
+     *
+     * @param ServerRequestInterface $request the current request
+     * @return ResponseInterface the response with the content
+     */
+    public function mainAction(ServerRequestInterface $request): ResponseInterface
+    {
+        $this->renderContent();
+        return new HtmlResponse($this->moduleTemplate->renderContent());
+    }
+
+    /**
+     * Main function, rendering the content of the replace form
+     */
+    public function main()
+    {
+        trigger_error('Method main() will be replaced by protected method renderContent() in v10. Do not call from other extension', E_USER_DEPRECATED);
+        $this->renderContent();
     }
 
     /**
      * Init
      *
+     * @param ServerRequestInterface $request
      * @throws \RuntimeException
      * @throws InsufficientFileAccessPermissionsException
      */
-    protected function init()
+    protected function init(ServerRequestInterface $request): void
     {
-        // Initialize GPvars:
-        $this->uid = (int)GeneralUtility::_GP('uid');
+        $parsedBody = $request->getParsedBody();
+        $queryParams = $request->getQueryParams();
         $lang = $this->getLanguageService();
 
-        $this->returnUrl = GeneralUtility::sanitizeLocalUrl(GeneralUtility::_GP('returnUrl'));
+        // Initialize GPvars:
+        $this->uid = (int)($parsedBody['uid'] ?? $queryParams['uid'] ?? 0);
+        $this->returnUrl = GeneralUtility::sanitizeLocalUrl($parsedBody['returnUrl'] ?? $queryParams['returnUrl'] ?? '');
+
         // Cleaning and checking uid
         if ($this->uid > 0) {
             $this->fileOrFolderObject = ResourceFactory::getInstance()
@@ -148,14 +191,14 @@ class ReplaceFileController
     }
 
     /**
-     * Main function, rendering the content of the rename form
+     * Render module content
      */
-    public function main()
+    protected function renderContent(): void
     {
         // Assign variables used by the fluid template
         $assigns = [];
         /** @var \TYPO3\CMS\Backend\Routing\UriBuilder $uriBuilder */
-        $uriBuilder = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Routing\UriBuilder::class);
+        $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
         $assigns['moduleUrlTceFile'] = (string)$uriBuilder->buildUriFromRoute('tce_file');
         $assigns['uid'] = $this->uid;
         $assigns['returnUrl'] = $this->returnUrl;
@@ -190,21 +233,9 @@ class ReplaceFileController
     }
 
     /**
-     * Processes the request, currently everything is handled and put together via "main()"
-     *
-     * @param ServerRequestInterface $request the current request
-     * @return ResponseInterface the response with the content
-     */
-    public function mainAction(ServerRequestInterface $request): ResponseInterface
-    {
-        $this->main();
-        return new HtmlResponse($this->moduleTemplate->renderContent());
-    }
-
-    /**
      * @return LanguageService
      */
-    protected function getLanguageService()
+    protected function getLanguageService(): LanguageService
     {
         return $GLOBALS['LANG'];
     }
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-84334-ProtectedMethodsAndPropertiesInReplaceFileController.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-84334-ProtectedMethodsAndPropertiesInReplaceFileController.rst
new file mode 100644 (file)
index 0000000..ff93666
--- /dev/null
@@ -0,0 +1,52 @@
+.. include:: ../../Includes.txt
+
+===============================================================================
+Deprecation: #84334 - Protected methods and properties in ReplaceFileController
+===============================================================================
+
+See :issue:`84334`
+
+Description
+===========
+
+This file is about third party usage of :php:`TYPO3\CMS\Backend\Controller\File\RenameFileController`.
+
+A series of class properties has been set to protected.
+They will throw deprecation warnings if called public from outside:
+
+* :php:`doc`
+* :php:`title`
+* :php:`uid`
+* :php:`returnUrl`
+* [not scanned] :php:`content`
+
+All methods not used as entry points by :php:`TYPO3\CMS\Backend\Http\RouteDispatcher` will be
+removed or set to protected in v10 and throw deprecation warnings if used from a third party:
+
+* [not scanned] :php:`main()`
+
+
+Impact
+======
+
+Calling one of the above methods or accessing one of the above properties on an instance of
+:php:`ReplaceFileController` will throw a deprecation warning in v9 and a PHP fatal in v10.
+
+
+Affected Installations
+======================
+
+The extension scanner will find most usages, but may also find some false positives. The most
+common property and method names like :php:`$content` are not registered and will not be found
+if an extension uses that on an instance of :php:`ReplaceFileController`.
+
+In general all extensions that set properties or call methods except :php:`mainAction()` are affected.
+
+
+Migration
+=========
+
+In general, extensions should not instantiate and re-use controllers of the core. Existing
+usages should be rewritten to be free of calls like these.
+
+.. index:: Backend, PHP-API, PartiallyScanned
\ No newline at end of file
index 5e21c09..94d7955 100644 (file)
@@ -362,4 +362,24 @@ return [
             'Deprecation-84326-ProtectedMethodsAndPropertiesInFileUploadController.rst',
         ],
     ],
+    'TYPO3\CMS\Backend\Controller\File\ReplaceFileController->doc' => [
+        'restFiles' => [
+            'Deprecation-84334-ProtectedMethodsAndPropertiesInReplaceFileController.rst',
+        ],
+    ],
+    'TYPO3\CMS\Backend\Controller\File\ReplaceFileController->title' => [
+        'restFiles' => [
+            'Deprecation-84334-ProtectedMethodsAndPropertiesInReplaceFileController.rst',
+        ],
+    ],
+    'TYPO3\CMS\Backend\Controller\File\ReplaceFileController->uid' => [
+        'restFiles' => [
+            'Deprecation-84334-ProtectedMethodsAndPropertiesInReplaceFileController.rst',
+        ],
+    ],
+    'TYPO3\CMS\Backend\Controller\File\ReplaceFileController->returnUrl' => [
+        'restFiles' => [
+            'Deprecation-84334-ProtectedMethodsAndPropertiesInReplaceFileController.rst',
+        ],
+    ],
 ];