Added fixes for FileUploader to compatibility with PHP 8.1

Author: silinmykola

app/code/Magento/Catalog/Controller/Adminhtml/Product/Gallery/Upload.php

@@ -11,7 +11,7 @@
 use Magento\Framework\Exception\LocalizedException;
 
 /**
- * Class Upload
+ * The product gallery upload controller
  */
 class Upload extends \Magento\Backend\App\Action implements HttpPostActionInterface
 {
@@ -20,7 +20,7 @@ class Upload extends \Magento\Backend\App\Action implements HttpPostActionInterf
      *
      * @see _isAllowed()
      */
-    const ADMIN_RESOURCE = 'Magento_Catalog::products';
+    public const ADMIN_RESOURCE = 'Magento_Catalog::products';
 
     /**
      * @var \Magento\Framework\Controller\Result\RawFactory
@@ -98,6 +98,9 @@ public function execute()
                 $mediaDirectory->getAbsolutePath($this->productMediaConfig->getBaseTmpMediaPath())
             );
 
+            if ($result === false) {
+                throw new LocalizedException(__('Something went wrong while saving the file(s).'));
+            }
             $this->_eventManager->dispatch(
                 'catalog_product_gallery_upload_image_after',
                 ['result' => $result, 'action' => $this]

app/code/Magento/Catalog/Model/ImageUploader.php

@@ -247,11 +247,11 @@ public function saveFileToTmpDir($fileId)
             throw new LocalizedException(__('File validation failed.'));
         }
         $result = $uploader->save($this->mediaDirectory->getAbsolutePath($baseTmpPath));
-        unset($result['path']);
 
         if (!$result) {
             throw new LocalizedException(__('File can not be saved to the destination folder.'));
         }
+        unset($result['path']);
 
         /**
          * Workaround for prototype 1.7 methods "isJSON", "evalJSON" on Windows OS

app/code/Magento/CatalogImportExport/Model/Import/Uploader.php

@@ -7,6 +7,8 @@
 
 use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Exception\FileSystemException;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\ValidatorException;
 use Magento\Framework\Filesystem;
 use Magento\Framework\Filesystem\Directory\TargetDirectory;
@@ -56,18 +58,14 @@ class Uploader extends \Magento\MediaStorage\Model\File\Uploader
         'png' => 'image/png',
     ];
 
-    const DEFAULT_FILE_TYPE = 'application/octet-stream';
+    public const DEFAULT_FILE_TYPE = 'application/octet-stream';
 
     /**
-     * Image factory.
-     *
      * @var \Magento\Framework\Image\AdapterFactory
      */
     protected $_imageFactory;
 
     /**
-     * Validator.
-     *
      * @var \Magento\MediaStorage\Model\File\Validator\NotProtectedExtension
      */
     protected $_validator;
@@ -114,6 +112,8 @@ class Uploader extends \Magento\MediaStorage\Model\File\Uploader
 
     /**
      * Directory and filename must be no more than 255 characters in length
+     *
+     * @var int
      */
     private $maxFilenameLength = 255;
 
@@ -132,8 +132,8 @@ class Uploader extends \Magento\MediaStorage\Model\File\Uploader
      * @param string|null $filePath
      * @param \Magento\Framework\Math\Random|null $random
      * @param TargetDirectory|null $targetDirectory
-     * @throws \Magento\Framework\Exception\FileSystemException
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws FileSystemException
+     * @throws LocalizedException
      */
     public function __construct(
         \Magento\MediaStorage\Helper\File\Storage\Database $coreFileStorageDb,
@@ -182,7 +182,7 @@ public function init()
      * @param string $fileName
      * @param bool $renameFileOff
      * @return array
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function move($fileName, $renameFileOff = false)
     {
@@ -197,11 +197,14 @@ public function move($fileName, $renameFileOff = false)
         }
 
         $this->_setUploadFile($tmpFilePath);
-        $rootDirectory = $this->getTargetDirectory()->getDirectoryRead(DirectoryList::ROOT);
+        $rootDirectory = $this->targetDirectory->getDirectoryRead(DirectoryList::ROOT);
         $destDir = $rootDirectory->getAbsolutePath($this->getDestDir());
         $result = $this->save($destDir);
-        unset($result['path']);
-        $result['name'] = self::getCorrectFileName($result['name']);
+
+        if ($result) {
+            unset($result['path']);
+            $result['name'] = self::getCorrectFileName($result['name']);
+        }
 
         // Directory and filename must be no more than 255 characters in length
         if (strlen($result['file']) > $this->maxFilenameLength) {
@@ -219,29 +222,30 @@ public function move($fileName, $renameFileOff = false)
      * @param string $url
      * @param string $driver
      * @return string
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     private function downloadFileFromUrl($url, $driver)
     {
         $parsedUrlPath = parse_url($url, PHP_URL_PATH);
+
         if (!$parsedUrlPath) {
-            throw new \Magento\Framework\Exception\LocalizedException(__('Could not parse resource url.'));
+            throw new LocalizedException(__('Could not parse resource url.'));
         }
         $urlPathValues = explode('/', $parsedUrlPath);
         $fileName = preg_replace('/[^a-z0-9\._-]+/i', '', end($urlPathValues));
-
+        //phpcs:ignore Magento2.Functions.DiscouragedFunction
         $fileExtension = pathinfo($fileName, PATHINFO_EXTENSION);
+
         if ($fileExtension && !$this->checkAllowedExtension($fileExtension)) {
-            throw new \Magento\Framework\Exception\LocalizedException(__('Disallowed file type.'));
+            throw new LocalizedException(__('Disallowed file type.'));
         }
-
         $tmpFileName = str_replace(".$fileExtension", '', $fileName);
         $tmpFileName .= '_' . $this->random->getRandomString(16);
         $tmpFileName .= $fileExtension ? ".$fileExtension" : '';
         $tmpFilePath = $this->_directory->getRelativePath($this->getTempFilePath($tmpFileName));
 
         if (!$this->_directory->isWritable($this->getTmpDir())) {
-            throw new \Magento\Framework\Exception\LocalizedException(
+            throw new LocalizedException(
                 __('Import images directory must be writable in order to process remote images.')
             );
         }
@@ -253,26 +257,12 @@ private function downloadFileFromUrl($url, $driver)
         return $tmpFilePath;
     }
 
-    /**
-     * Retrieves target directory.
-     *
-     * @return TargetDirectory
-     */
-    private function getTargetDirectory(): TargetDirectory
-    {
-        if (!isset($this->targetDirectory)) {
-            $this->targetDirectory = ObjectManager::getInstance()->get(TargetDirectory::class);
-        }
-
-        return $this->targetDirectory;
-    }
-
     /**
      * Prepare information about the file for moving
      *
      * @param string $filePath
      * @return void
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     protected function _setUploadFile($filePath)
     {
@@ -290,7 +280,7 @@ protected function _setUploadFile($filePath)
             $readable = false;
         }
         if (!$readable) {
-            throw new \Magento\Framework\Exception\LocalizedException(
+            throw new LocalizedException(
                 __('File \'%1\' was not found or has read restriction.', $filePath)
             );
         }
@@ -322,7 +312,7 @@ protected function _readFileInfo($filePath)
      * Validate uploaded file by type and etc.
      *
      * @return void
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     protected function _validateFile()
     {
@@ -335,7 +325,7 @@ protected function _validateFile()
 
         $fileExtension = pathinfo($filePath, PATHINFO_EXTENSION);
         if (!$this->checkAllowedExtension($fileExtension)) {
-            throw new \Magento\Framework\Exception\LocalizedException(__('Disallowed file type.'));
+            throw new LocalizedException(__('Disallowed file type.'));
         }
         //run validate callbacks
         foreach ($this->_validateCallbacks as $params) {
@@ -405,7 +395,7 @@ public function getDestDir()
      */
     public function setDestDir($path)
     {
-        $directoryRoot = $this->getTargetDirectory()->getDirectoryWrite(DirectoryList::ROOT);
+        $directoryRoot = $this->targetDirectory->getDirectoryWrite(DirectoryList::ROOT);
         if (is_string($path) && $directoryRoot->isWritable($path)) {
             $this->_destDir = $path;
             return true;
@@ -429,7 +419,7 @@ protected function _moveFile($tmpPath, $destPath)
             $destinationRealPath = $this->_directory->getDriver()->getRealPath($destPath);
             $relativeDestPath = $this->_directory->getRelativePath($destPath);
             $isSameFile = $tmpRealPath === $destinationRealPath;
-            $rootDirectory = $this->getTargetDirectory()->getDirectoryWrite(DirectoryList::ROOT);
+            $rootDirectory = $this->targetDirectory->getDirectoryWrite(DirectoryList::ROOT);
             return $isSameFile ?: $this->_directory->copyFile($tmpPath, $relativeDestPath, $rootDirectory);
         } else {
             return false;

app/code/Magento/Config/Model/Config/Backend/File.php

@@ -5,8 +5,10 @@
  */
 namespace Magento\Config\Model\Config\Backend;
 
+use Exception;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Filesystem;
 use Magento\MediaStorage\Model\File\Uploader;
 
@@ -82,12 +84,14 @@ public function __construct(
      * Save uploaded file before saving config value
      *
      * @return $this
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     public function beforeSave()
     {
         $value = $this->getValue();
         $file = $this->getFileData();
+
         if (!empty($file)) {
             $uploadDir = $this->_getUploadDir();
             try {
@@ -97,11 +101,10 @@ public function beforeSave()
                 $uploader->setAllowRenameFiles(true);
                 $uploader->addValidateCallback('size', $this, 'validateMaxSize');
                 $result = $uploader->save($uploadDir);
-            } catch (\Exception $e) {
-                throw new \Magento\Framework\Exception\LocalizedException(__('%1', $e->getMessage()));
+            } catch (Exception $e) {
+                throw new LocalizedException(__('%1', $e->getMessage()));
             }
-
-            $filename = $result['file'];
+            $filename = ($result !== false) ? $result['file'] : '';
             if ($filename) {
                 if ($this->_addWhetherScopeInfo()) {
                     $filename = $this->_prependScopeInfo($filename);
@@ -148,7 +151,7 @@ protected function getFileData()
      *
      * @param  string $filePath Path to temporary uploaded file
      * @return void
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function validateMaxSize($filePath)
     {
@@ -157,7 +160,7 @@ public function validateMaxSize($filePath)
             $directory->getRelativePath($filePath)
         )['size'] > $this->_maxFileSize * 1024
         ) {
-            throw new \Magento\Framework\Exception\LocalizedException(
+            throw new LocalizedException(
                 __('The file you\'re uploading exceeds the server size limit of %1 kilobytes.', $this->_maxFileSize)
             );
         }
@@ -179,14 +182,14 @@ protected function _addWhetherScopeInfo()
      * Return path to directory for upload file
      *
      * @return string
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     protected function _getUploadDir()
     {
         $fieldConfig = $this->getFieldConfig();
 
         if (!array_key_exists('upload_dir', $fieldConfig)) {
-            throw new \Magento\Framework\Exception\LocalizedException(
+            throw new LocalizedException(
                 __('The base directory to upload file is not specified.')
             );
         }

app/code/Magento/Customer/Model/FileProcessor.php

@@ -27,7 +27,7 @@ class FileProcessor
     /**
      * Temporary directory name
      */
-    const TMP_DIR = 'tmp';
+    public const TMP_DIR = 'tmp';
 
     private const CUSTOMER_FILE_URL_PATH = 'customer/index/viewfile';
 
@@ -215,12 +215,13 @@ public function saveTemporaryFile($fileId)
         );
 
         $result = $uploader->save($path);
-        unset($result['path']);
+
         if (!$result) {
             throw new LocalizedException(
                 __('File can not be saved to the destination folder.')
             );
         }
+        unset($result['path']);
 
         return $result;
     }