Merge branch 'develop' into PR-31-10-2024

Author: magento-devops-queue-mgr-svc

app/code/Magento/PageBuilder/Controller/Adminhtml/Template/Save.php

@@ -1,30 +1,40 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2019 Adobe
+ * All Rights Reserved.
  */
 
 declare(strict_types=1);
 
 namespace Magento\PageBuilder\Controller\Adminhtml\Template;
 
+use function preg_replace;
+use function str_replace;
+use function strpos;
+use function strtolower;
+use function substr;
+use function uniqid;
+use Exception;
 use Magento\Backend\App\Action;
 use Magento\Backend\App\Action\Context;
 use Magento\Framework\Api\ImageContent;
 use Magento\Framework\Api\ImageContentFactory;
 use Magento\Framework\Api\ImageContentValidator;
 use Magento\Framework\Api\SearchCriteriaBuilder;
 use Magento\Framework\App\Action\HttpPostActionInterface;
+use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\App\RequestInterface;
 use Magento\Framework\Controller\ResultFactory;
+use Magento\Framework\Exception\FileSystemException;
+use Magento\Framework\Exception\InputException;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Filesystem;
+use Magento\Framework\Image\AdapterFactory;
 use Magento\MediaStorage\Helper\File\Storage\Database;
 use Magento\PageBuilder\Api\Data\TemplateInterface;
 use Magento\PageBuilder\Api\TemplateRepositoryInterface;
 use Magento\PageBuilder\Model\TemplateFactory;
 use Psr\Log\LoggerInterface;
-use Magento\Framework\Image\AdapterFactory;
 
 /**
  * Save a template within template manager
@@ -33,7 +43,7 @@
  */
 class Save extends Action implements HttpPostActionInterface
 {
-    const ADMIN_RESOURCE = 'Magento_PageBuilder::template_save';
+    public const ADMIN_RESOURCE = 'Magento_PageBuilder::template_save';
 
     /**
      * @var LoggerInterface
@@ -151,7 +161,7 @@ public function execute()
                 $filePath = $this->storePreviewImage($request);
                 // Store the preview image within the new entity
                 $template->setPreviewImage($filePath);
-            } catch (\Exception $e) {
+            } catch (Exception $e) {
                 $this->logger->critical($e);
 
                 return $this->resultFactory->create(ResultFactory::TYPE_JSON)->setData(
@@ -176,7 +186,7 @@ public function execute()
                 'status' => 'error',
                 'message' => $e->getMessage()
             ];
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             $this->logger->critical($e);
 
             $result = [
@@ -215,26 +225,28 @@ private function validate(RequestInterface $request)
      * Handle storing the preview image
      *
      * @param RequestInterface $request
-     * @return string
+     * @return null|string
+     * @throws Exception
+     * @throws FileSystemException
+     * @throws InputException
      * @throws LocalizedException
-     * @throws \Magento\Framework\Exception\FileSystemException
-     * @throws \Magento\Framework\Exception\InputException
      */
-    private function storePreviewImage(RequestInterface $request) : ?string
+    private function storePreviewImage(RequestInterface $request): ?string
     {
         $fileName = preg_replace("/[^A-Za-z0-9]/", '', str_replace(
-                ' ',
-                '-',
-                strtolower($request->getParam(TemplateInterface::KEY_NAME))
-            )) . uniqid() . '.jpg';
+            ' ',
+            '-',
+            strtolower($request->getParam(TemplateInterface::KEY_NAME))
+        )) . uniqid() . '.jpg';
 
         // Prepare the image data
         $imgData = str_replace(' ', '+', $request->getParam('previewImage'));
-        $imgData = substr($imgData, strpos($imgData, ",") + 1);
-        // phpcs:ignore
+        $imgData = substr($imgData, strpos($imgData, ',') + 1);
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
         $decodedImage = base64_decode($imgData);
 
         $imageProperties = getimagesizefromstring($decodedImage);
+
         if (!$imageProperties) {
             throw new LocalizedException(__('Unable to get properties from image.'));
         }
@@ -246,16 +258,16 @@ private function storePreviewImage(RequestInterface $request) : ?string
         $imageContent->setType($imageProperties['mime']);
 
         if ($this->imageContentValidator->isValid($imageContent)) {
-            $mediaDirWrite = $this->filesystem
-                ->getDirectoryWrite(\Magento\Framework\App\Filesystem\DirectoryList::MEDIA);
+            $mediaDirWrite = $this->filesystem->getDirectoryWrite(DirectoryList::MEDIA);
             $directory = $mediaDirWrite->getAbsolutePath('.template-manager');
             $mediaDirWrite->create($directory);
-            $fileAbsolutePath = $directory . $fileName;
+
+            $fileAbsolutePath = $directory . DIRECTORY_SEPARATOR . $fileName;
             // Write the file to the directory
             $mediaDirWrite->getDriver()->filePutContents($fileAbsolutePath, $decodedImage);
             // Generate a thumbnail, called -thumb next to the image for usage in the grid
             $thumbPath = str_replace('.jpg', '-thumb.jpg', $fileName);
-            $thumbAbsolutePath = $directory . $thumbPath;
+            $thumbAbsolutePath = $directory . DIRECTORY_SEPARATOR . $thumbPath;
             $imageFactory = $this->imageAdapterFactory->create();
             $imageFactory->open($fileAbsolutePath);
             $imageFactory->resize(350);

app/code/Magento/PageBuilder/Model/Wysiwyg/DefaultConfigProvider.php

@@ -1,31 +1,34 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2018 Adobe
+ * All Rights Reserved.
  */
 declare(strict_types=1);
 
 namespace Magento\PageBuilder\Model\Wysiwyg;
 
+use Magento\Framework\DataObject;
+use Magento\Framework\View\Asset\Repository;
+
 /**
  * This DefaultConfigProvider overrides existing configuration provided from the cms module
  */
 class DefaultConfigProvider implements \Magento\Framework\Data\Wysiwyg\ConfigProviderInterface
 {
     /**
-     * @var \Magento\Framework\View\Asset\Repository
+     * @var Repository
      */
-    private $assetRepo;
+    private Repository $assetRepo;
     /**
      * @var array
      */
     private $additionalSettings;
     /**
-     * @param \Magento\Framework\View\Asset\Repository $assetRepo
+     * @param Repository $assetRepo
      * @param array $additionalSettings
      */
     public function __construct(
-        \Magento\Framework\View\Asset\Repository $assetRepo,
+        Repository $assetRepo,
         array $additionalSettings
     ) {
         $this->assetRepo = $assetRepo;
@@ -34,15 +37,15 @@ public function __construct(
     /**
      * Returns configuration data
      *
-     * @param \Magento\Framework\DataObject $config
-     * @return \Magento\Framework\DataObject
+     * @param DataObject $config
+     * @return DataObject
      */
-    public function getConfig(\Magento\Framework\DataObject $config): \Magento\Framework\DataObject
+    public function getConfig(DataObject $config): DataObject
     {
         $config->addData(
             [
                 'tinymce' => [
-                    'toolbar' => 'undo redo | styles | fontsizeselect | lineheight | forecolor backcolor ' .
+                    'toolbar' => 'undo redo | styles | fontfamily fontsize | lineheight | forecolor backcolor ' .
                         '| bold italic underline | alignleft aligncenter alignright | numlist bullist ' .
                         '| link image table charmap',
 

app/code/Magento/PageBuilder/Test/Unit/Model/Wysiwyg/DefaultConfigProviderTest.php

@@ -0,0 +1,42 @@
+<?php
+/**
+ * Copyright 2018 Adobe
+ * All Rights Reserved.
+ */
+declare(strict_types=1);
+
+namespace Magento\PageBuilder\Test\Unit\Model\Wysiwyg;
+
+use Magento\PageBuilder\Model\Wysiwyg\DefaultConfigProvider;
+use Magento\Framework\DataObject;
+use Magento\Framework\View\Asset\Repository;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+class DefaultConfigProviderTest extends TestCase
+{
+    /**
+     * @var Repository|MockObject
+     */
+    private Repository $assetRepo;
+
+    /**
+     * @inheritDoc
+     */
+    protected function setUp(): void
+    {
+        $this->assetRepo = $this->createMock(Repository::class);
+        parent::setUp();
+    }
+
+    /**
+     * @return void
+     */
+    public function testGetConfig(): void
+    {
+        $config = new DataObject();
+        $configProvider = new DefaultConfigProvider($this->assetRepo, []);
+        $result = $configProvider->getConfig($config);
+        $this->assertStringContainsString('fontfamily fontsize', $result->getTinymce()['toolbar']);
+    }
+}