Merge pull request #3534 from magento-tsg/2.2-develop-pr63

[TSG] Backporting for 2.2 (pr63) (2.2.8)

Author: Alexander Akimov

app/code/Magento/Catalog/Block/Product/ProductList/Toolbar.php

@@ -7,6 +7,10 @@
 
 use Magento\Catalog\Helper\Product\ProductList;
 use Magento\Catalog\Model\Product\ProductList\Toolbar as ToolbarModel;
+use Magento\Catalog\Model\Product\ProductList\ToolbarMemorizer;
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\App\Http\Context;
+use Magento\Framework\Data\Form\FormKey;
 
 /**
  * Product list toolbar
@@ -77,6 +81,7 @@ class Toolbar extends \Magento\Framework\View\Element\Template
 
     /**
      * @var bool $_paramsMemorizeAllowed
+     * @deprecated
      */
     protected $_paramsMemorizeAllowed = true;
 
@@ -96,6 +101,7 @@ class Toolbar extends \Magento\Framework\View\Element\Template
      * Catalog session
      *
      * @var \Magento\Catalog\Model\Session
+     * @deprecated
      */
     protected $_catalogSession;
 
@@ -104,6 +110,11 @@ class Toolbar extends \Magento\Framework\View\Element\Template
      */
     protected $_toolbarModel;
 
+    /**
+     * @var ToolbarMemorizer
+     */
+    private $toolbarMemorizer;
+
     /**
      * @var ProductList
      */
@@ -119,6 +130,16 @@ class Toolbar extends \Magento\Framework\View\Element\Template
      */
     protected $_postDataHelper;
 
+    /**
+     * @var Context
+     */
+    private $httpContext;
+
+    /**
+     * @var FormKey
+     */
+    private $formKey;
+
     /**
      * @param \Magento\Framework\View\Element\Template\Context $context
      * @param \Magento\Catalog\Model\Session $catalogSession
@@ -128,6 +149,11 @@ class Toolbar extends \Magento\Framework\View\Element\Template
      * @param ProductList $productListHelper
      * @param \Magento\Framework\Data\Helper\PostHelper $postDataHelper
      * @param array $data
+     * @param ToolbarMemorizer|null $toolbarMemorizer
+     * @param Context|null $httpContext
+     * @param FormKey|null $formKey
+     *
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
         \Magento\Framework\View\Element\Template\Context $context,
@@ -137,21 +163,34 @@ public function __construct(
         \Magento\Framework\Url\EncoderInterface $urlEncoder,
         ProductList $productListHelper,
         \Magento\Framework\Data\Helper\PostHelper $postDataHelper,
-        array $data = []
+        array $data = [],
+        ToolbarMemorizer $toolbarMemorizer = null,
+        Context $httpContext = null,
+        FormKey $formKey = null
     ) {
         $this->_catalogSession = $catalogSession;
         $this->_catalogConfig = $catalogConfig;
         $this->_toolbarModel = $toolbarModel;
         $this->urlEncoder = $urlEncoder;
         $this->_productListHelper = $productListHelper;
         $this->_postDataHelper = $postDataHelper;
+        $this->toolbarMemorizer = $toolbarMemorizer ?: ObjectManager::getInstance()->get(
+            ToolbarMemorizer::class
+        );
+        $this->httpContext = $httpContext ?: ObjectManager::getInstance()->get(
+            Context::class
+        );
+        $this->formKey = $formKey ?: ObjectManager::getInstance()->get(
+            FormKey::class
+        );
         parent::__construct($context, $data);
     }
 
     /**
      * Disable list state params memorizing
      *
      * @return $this
+     * @deprecated
      */
     public function disableParamsMemorizing()
     {
@@ -165,6 +204,7 @@ public function disableParamsMemorizing()
      * @param string $param parameter name
      * @param mixed $value parameter value
      * @return $this
+     * @deprecated
      */
     protected function _memorizeParam($param, $value)
     {
@@ -244,13 +284,13 @@ public function getCurrentOrder()
             $defaultOrder = $keys[0];
         }
 
-        $order = $this->_toolbarModel->getOrder();
+        $order = $this->toolbarMemorizer->getOrder();
         if (!$order || !isset($orders[$order])) {
             $order = $defaultOrder;
         }
 
-        if ($order != $defaultOrder) {
-            $this->_memorizeParam('sort_order', $order);
+        if ($this->toolbarMemorizer->isMemorizingAllowed()) {
+            $this->httpContext->setValue(ToolbarModel::ORDER_PARAM_NAME, $order, $defaultOrder);
         }
 
         $this->setData('_current_grid_order', $order);
@@ -270,13 +310,13 @@ public function getCurrentDirection()
         }
 
         $directions = ['asc', 'desc'];
-        $dir = strtolower($this->_toolbarModel->getDirection());
+        $dir = strtolower($this->toolbarMemorizer->getDirection());
         if (!$dir || !in_array($dir, $directions)) {
             $dir = $this->_direction;
         }
 
-        if ($dir != $this->_direction) {
-            $this->_memorizeParam('sort_direction', $dir);
+        if ($this->toolbarMemorizer->isMemorizingAllowed()) {
+            $this->httpContext->setValue(ToolbarModel::DIRECTION_PARAM_NAME, $dir, $this->_direction);
         }
 
         $this->setData('_current_grid_direction', $dir);
@@ -392,6 +432,8 @@ public function getPagerUrl($params = [])
     }
 
     /**
+     * Get pager encoded url.
+     *
      * @param array $params
      * @return string
      */
@@ -412,11 +454,15 @@ public function getCurrentMode()
             return $mode;
         }
         $defaultMode = $this->_productListHelper->getDefaultViewMode($this->getModes());
-        $mode = $this->_toolbarModel->getMode();
+        $mode = $this->toolbarMemorizer->getMode();
         if (!$mode || !isset($this->_availableMode[$mode])) {
             $mode = $defaultMode;
         }
 
+        if ($this->toolbarMemorizer->isMemorizingAllowed()) {
+            $this->httpContext->setValue(ToolbarModel::MODE_PARAM_NAME, $mode, $defaultMode);
+        }
+
         $this->setData('_current_grid_mode', $mode);
         return $mode;
     }
@@ -568,20 +614,22 @@ public function getLimit()
             $defaultLimit = $keys[0];
         }
 
-        $limit = $this->_toolbarModel->getLimit();
+        $limit = $this->toolbarMemorizer->getLimit();
         if (!$limit || !isset($limits[$limit])) {
             $limit = $defaultLimit;
         }
 
-        if ($limit != $defaultLimit) {
-            $this->_memorizeParam('limit_page', $limit);
+        if ($this->toolbarMemorizer->isMemorizingAllowed()) {
+            $this->httpContext->setValue(ToolbarModel::LIMIT_PARAM_NAME, $limit, $defaultLimit);
         }
 
         $this->setData('_current_limit', $limit);
         return $limit;
     }
 
     /**
+     * Check if limit is current used in toolbar.
+     *
      * @param int $limit
      * @return bool
      */
@@ -591,6 +639,8 @@ public function isLimitCurrent($limit)
     }
 
     /**
+     * Pager number of items from which products started on current page.
+     *
      * @return int
      */
     public function getFirstNum()
@@ -600,6 +650,8 @@ public function getFirstNum()
     }
 
     /**
+     * Pager number of items products finished on current page.
+     *
      * @return int
      */
     public function getLastNum()
@@ -609,6 +661,8 @@ public function getLastNum()
     }
 
     /**
+     * Total number of products in current category.
+     *
      * @return int
      */
     public function getTotalNum()
@@ -617,6 +671,8 @@ public function getTotalNum()
     }
 
     /**
+     * Check if current page is the first.
+     *
      * @return bool
      */
     public function isFirstPage()
@@ -625,6 +681,8 @@ public function isFirstPage()
     }
 
     /**
+     * Return last page number.
+     *
      * @return int
      */
     public function getLastPageNum()
@@ -692,6 +750,8 @@ public function getWidgetOptionsJson(array $customOptions = [])
             'orderDefault' => $this->getOrderField(),
             'limitDefault' => $this->_productListHelper->getDefaultLimitPerPageValue($defaultMode),
             'url' => $this->getPagerUrl(),
+            'formKey' => $this->formKey->getFormKey(),
+            'post' => $this->toolbarMemorizer->isMemorizingAllowed() ? true : false,
         ];
         $options = array_replace_recursive($options, $customOptions);
         return json_encode(['productListToolbarForm' => $options]);

app/code/Magento/Catalog/Controller/Category/View.php

@@ -8,13 +8,17 @@
 
 use Magento\Catalog\Api\CategoryRepositoryInterface;
 use Magento\Catalog\Model\Layer\Resolver;
+use Magento\Catalog\Model\Product\ProductList\ToolbarMemorizer;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\View\Result\PageFactory;
+use Magento\Framework\App\Action\Action;
 
 /**
+ * View a category on storefront. Needs to be accessible by POST because of the store switching.
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
-class View extends \Magento\Framework\App\Action\Action
+class View extends Action
 {
     /**
      * Core registry
@@ -69,6 +73,11 @@ class View extends \Magento\Framework\App\Action\Action
      */
     protected $categoryRepository;
 
+    /**
+     * @var ToolbarMemorizer
+     */
+    private $toolbarMemorizer;
+
     /**
      * Constructor
      *
@@ -82,6 +91,7 @@ class View extends \Magento\Framework\App\Action\Action
      * @param \Magento\Framework\Controller\Result\ForwardFactory $resultForwardFactory
      * @param Resolver $layerResolver
      * @param CategoryRepositoryInterface $categoryRepository
+     * @param ToolbarMemorizer|null $toolbarMemorizer
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -94,7 +104,8 @@ public function __construct(
         PageFactory $resultPageFactory,
         \Magento\Framework\Controller\Result\ForwardFactory $resultForwardFactory,
         Resolver $layerResolver,
-        CategoryRepositoryInterface $categoryRepository
+        CategoryRepositoryInterface $categoryRepository,
+        ToolbarMemorizer $toolbarMemorizer = null
     ) {
         parent::__construct($context);
         $this->_storeManager = $storeManager;
@@ -106,6 +117,7 @@ public function __construct(
         $this->resultForwardFactory = $resultForwardFactory;
         $this->layerResolver = $layerResolver;
         $this->categoryRepository = $categoryRepository;
+        $this->toolbarMemorizer = $toolbarMemorizer ?: $context->getObjectManager()->get(ToolbarMemorizer::class);
     }
 
     /**
@@ -130,6 +142,7 @@ protected function _initCategory()
         }
         $this->_catalogSession->setLastVisitedCategoryId($category->getId());
         $this->_coreRegistry->register('current_category', $category);
+        $this->toolbarMemorizer->memorizeParams();
         try {
             $this->_eventManager->dispatch(
                 'catalog_controller_category_init_after',
@@ -195,7 +208,7 @@ public function execute()
             if ($layoutUpdates && is_array($layoutUpdates)) {
                 foreach ($layoutUpdates as $layoutUpdate) {
                     $page->addUpdate($layoutUpdate);
-                    $page->addPageLayoutHandles(['layout_update' => md5($layoutUpdate)], null, false);
+                    $page->addPageLayoutHandles(['layout_update' => sha1($layoutUpdate)], null, false);
                 }
             }