Merge pull request #7783 from magento-atwix-pyrrans/AC-5893-replace-zend-acl

[Pyrrans] AC-5893: Replace `Zend_Acl` with `laminas/laminas-permissions-acl`

Author: andrewbess

app/code/Magento/Authorization/Model/Acl/AclRetriever.php

@@ -21,8 +21,8 @@
  */
 class AclRetriever
 {
-    const PERMISSION_ANONYMOUS = 'anonymous';
-    const PERMISSION_SELF = 'self';
+    public const PERMISSION_ANONYMOUS = 'anonymous';
+    public const PERMISSION_SELF = 'self';
 
     /**
      * @var \Psr\Log\LoggerInterface
@@ -117,7 +117,7 @@ public function getAllowedResourcesByRole($roleId)
         /** @var \Magento\Authorization\Model\Rules $ruleItem */
         foreach ($rulesCollection->getItems() as $ruleItem) {
             $resourceId = $ruleItem->getResourceId();
-            if ($acl->has($resourceId) && $acl->isAllowed($roleId, $resourceId)) {
+            if ($acl->hasResource($resourceId) && $acl->isAllowed($roleId, $resourceId)) {
                 $allowedResources[] = $resourceId;
             }
         }

app/code/Magento/Authorization/Model/Acl/Loader/Rule.php

@@ -104,7 +104,7 @@ private function applyPermissionsAccordingToRules(Acl $acl): array
             $resource = $rule['resource_id'];
             $privileges = !empty($rule['privileges']) ? explode(',', $rule['privileges']) : null;
 
-            if ($acl->has($resource)) {
+            if ($acl->hasResource($resource)) {
                 $foundResources[$resource] = $resource;
                 if ($rule['permission'] == 'allow') {
                     if ($resource === $this->_rootResource->getId()) {

app/code/Magento/Authorization/Model/Acl/Role/Generic.php

@@ -5,9 +5,11 @@
  */
 namespace Magento\Authorization\Model\Acl\Role;
 
+use Laminas\Permissions\Acl\Role\GenericRole;
+
 /**
  * Generic acl role
  */
-class Generic extends \Zend_Acl_Role
+class Generic extends GenericRole
 {
 }

app/code/Magento/Authorization/Test/Unit/Model/Acl/AclRetrieverTest.php

@@ -165,9 +165,9 @@ protected function createAclRetriever()
         /**
          * @var Acl|MockObject $aclMock
          */
-        $aclMock = $this->createPartialMock(Acl::class, ['has', 'isAllowed']);
-        $aclMock->expects($this->any())->method('has')->willReturn(true);
-        $aclMock->expects($this->any())->method('isAllowed')->willReturn(true);
+        $aclMock = $this->createPartialMock(Acl::class, ['hasResource', 'isAllowed']);
+        $aclMock->method('hasResource')->willReturn(true);
+        $aclMock->method('isAllowed')->willReturn(true);
 
         /**
          * @var Builder|MockObject $aclBuilderMock

app/code/Magento/Authorization/Test/Unit/Model/Acl/Loader/RuleTest.php

@@ -114,7 +114,7 @@ public function testPopulateAclFromCache(): void
             );
 
         $aclMock = $this->createMock(Acl::class);
-        $aclMock->method('has')->willReturn(true);
+        $aclMock->method('hasResource')->willReturn(true);
         $aclMock
             ->method('allow')
             ->withConsecutive(

app/code/Magento/Backend/Model/Auth/Session.php

@@ -18,8 +18,6 @@
  * @api
  * @method \Magento\User\Model\User|null getUser()
  * @method \Magento\Backend\Model\Auth\Session setUser(\Magento\User\Model\User $value)
- * @method \Magento\Framework\Acl|null getAcl()
- * @method \Magento\Backend\Model\Auth\Session setAcl(\Magento\Framework\Acl $value)
  * @method int getUpdatedAt()
  * @method \Magento\Backend\Model\Auth\Session setUpdatedAt(int $value)
  *
@@ -62,6 +60,11 @@ class Session extends \Magento\Framework\Session\SessionManager implements \Mage
      */
     private $messageManager;
 
+    /**
+     * @var \Magento\Framework\Acl|null
+     */
+    private $acl = null;
+
     /**
      * @param \Magento\Framework\App\Request\Http $request
      * @param \Magento\Framework\Session\SidResolverInterface $sidResolver
@@ -152,7 +155,7 @@ public function isAllowed($resource, $privilege = null)
                 return $acl->isAllowed($user->getAclRole(), $resource, $privilege);
             } catch (\Exception $e) {
                 try {
-                    if (!$acl->has($resource)) {
+                    if (!$acl->hasResource($resource)) {
                         return $acl->isAllowed($user->getAclRole(), null, $privilege);
                     }
                 } catch (\Exception $e) {
@@ -284,4 +287,33 @@ public function isValidForPath($path)
     {
         return true;
     }
+
+    /**
+     * Set Acl model
+     *
+     * @return \Magento\Framework\Acl
+     */
+    public function getAcl()
+    {
+        return $this->acl;
+    }
+
+    /**
+     * Retrieve Acl
+     *
+     * @param \Magento\Framework\Acl $acl
+     * @return void
+     */
+    public function setAcl(\Magento\Framework\Acl $acl)
+    {
+        $this->acl = $acl;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getData($key = '', $clear = false)
+    {
+        return $key === 'acl' ? $this->getAcl() : parent::getData($key, $clear);
+    }
 }

app/code/Magento/Backend/Test/Unit/Model/Auth/SessionTest.php

@@ -79,7 +79,7 @@ protected function setUp(): void
             ['getCookie', 'setPublicCookie']
         );
         $this->storage = $this->getMockBuilder(Storage::class)
-            ->addMethods(['getUser', 'getAcl', 'setAcl'])
+            ->addMethods(['getUser'])
             ->disableOriginalConstructor()
             ->getMock();
         $this->sessionConfig = $this->createPartialMock(
@@ -133,8 +133,6 @@ public function testRefreshAcl($isUserPassedViaParams)
         $userMock->expects($this->any())->method('getReloadAclFlag')->willReturn(true);
         $userMock->expects($this->once())->method('setReloadAclFlag')->with('0')->willReturnSelf();
         $userMock->expects($this->once())->method('save');
-        $this->storage->expects($this->once())->method('setAcl')->with($aclMock);
-        $this->storage->expects($this->any())->method('getAcl')->willReturn($aclMock);
         if ($isUserPassedViaParams) {
             $this->session->refreshAcl($userMock);
         } else {
@@ -250,7 +248,7 @@ public function testIsAllowed($isUserDefined, $isAclDefined, $isAllowed, $expect
             $aclMock = $this->getMockBuilder(Acl::class)
                 ->disableOriginalConstructor()
                 ->getMock();
-            $this->storage->expects($this->any())->method('getAcl')->willReturn($aclMock);
+            $this->session->setAcl($aclMock);
         }
         if ($isUserDefined) {
             $userMock = $this->getMockBuilder(User::class)

app/code/Magento/Config/Controller/Adminhtml/System/ConfigSectionChecker.php

@@ -6,6 +6,7 @@
 
 namespace Magento\Config\Controller\Adminhtml\System;
 
+use Laminas\Permissions\Acl\Exception\InvalidArgumentException;
 use Magento\Framework\Exception\NotFoundException;
 
 /**
@@ -41,11 +42,14 @@ public function isSectionAllowed($sectionId)
     {
         try {
             if (false == $this->_configStructure->getElement($sectionId)->isAllowed()) {
+                // phpcs:ignore Magento2.Exceptions.DirectThrow
                 throw new \Exception('');
             }
             return true;
-        } catch (\Zend_Acl_Exception $e) {
+        } catch (InvalidArgumentException $e) {
+            // phpcs:ignore Magento2.Exceptions.ThrowCatch
             throw new NotFoundException(__('Page not found.'));
+            // phpcs:ignore Magento2.Exceptions.ThrowCatch
         } catch (\Exception $e) {
             return false;
         }

composer.json

@@ -59,6 +59,7 @@
         "laminas/laminas-modulemanager": "^2.11.0",
         "laminas/laminas-mvc": "^3.3.3",
         "laminas/laminas-oauth": "^2.4",
+        "laminas/laminas-permissions-acl": "^2.10.0",
         "laminas/laminas-servicemanager": "^3.16.0",
         "laminas/laminas-soap": "^2.10.0",
         "laminas/laminas-stdlib": "^3.11.0",