AbstractAssertion.php 6.97 KB
Newer Older
1 2 3 4
<?php

namespace UnicaenAuth\Assertion;

Laurent Lécluse's avatar
Laurent Lécluse committed
5
use BjyAuthorize\Service\Authorize;
6 7
use UnicaenAuth\Service\AuthorizeService;
use UnicaenAuth\Service\Traits\AuthorizeServiceAwareTrait;
Laurent Lécluse's avatar
Laurent Lécluse committed
8
use UnicaenAuth\Service\Traits\UserContextServiceAwareTrait;
9
use UnicaenAuth\Service\UserContext;
10 11 12 13 14 15 16 17 18 19 20
use Zend\Mvc\MvcEvent;
use Zend\Permissions\Acl\Acl;
use Zend\Permissions\Acl\Assertion\AssertionInterface;
use Zend\Permissions\Acl\Resource\ResourceInterface;
use Zend\Permissions\Acl\Role\RoleInterface;

/**
 * Description of AbstractAssertion
 *
 * @author Laurent LÉCLUSE <laurent.lecluse at unicaen.fr>
 */
21
abstract class AbstractAssertion implements AssertionInterface
22
{
Laurent Lécluse's avatar
Laurent Lécluse committed
23
    use UserContextServiceAwareTrait;
24
    use AuthorizeServiceAwareTrait;
25

26 27 28 29 30 31 32 33
    /**
     * @var Acl
     */
    private $acl;

    /**
     * @var RoleInterface
     */
Laurent Lécluse's avatar
Laurent Lécluse committed
34
    private $role = false;
35

36
    /**
37
     * @var MvcEvent
38
     */
39
    private $mvcEvent;
40

41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70


    /**
     * !!!! Pour éviter l'erreur "Serialization of 'Closure' is not allowed"... !!!!
     *
     * @return array
     */
    public function __sleep()
    {
        return [];
    }



    /**
     * Returns true if and only if the assertion conditions are met
     *
     * This method is passed the ACL, Role, Resource, and privilege to which the authorization query applies. If the
     * $role, $this->resource, or $privilege parameters are null, it means that the query applies to all Roles, Resources, or
     * privileges, respectively.
     *
     * @param  Acl               $acl
     * @param  RoleInterface     $role
     * @param  ResourceInterface $resource
     * @param  string            $privilege
     *
     * @return bool
     */
    public final function assert(Acl $acl, RoleInterface $role = null, ResourceInterface $resource = null, $privilege = null)
    {
71 72
        $this->setAcl($acl);
        $this->setRole($role);
73
        $this->init();
74 75
        switch (true) {
            case $this->detectPrivilege($resource):
76
//                var_dump('assertPrivilege '.get_class($this).' '.$resource->getResourceId().' '.$privilege);
77
                return $this->assertPrivilege(ltrim(strstr($resource, '/'), '/'), $privilege);
78 79 80 81 82 83 84 85 86

            case $this->detectController($resource):

                $resource   = (string)$resource;
                $spos       = strpos($resource, '/') + 1;
                $dpos       = strrpos($resource, ':') + 1;
                $controller = substr($resource, $spos, $dpos - $spos - 1);
                $action     = substr($resource, $dpos);

87
//                var_dump('assertController '.get_class($this).' '.$controller.'.'.$action.' '.$privilege);
88
                return $this->assertController($controller, $action, $privilege);
89 90

            case $this->detectEntity($resource):
91
//                var_dump('assertEntity '.get_class($this).' '.$resource->getResourceId().' '.$privilege);
92
                return $this->assertEntity($resource, $privilege);
93 94

            default:
95
//                var_dump('assertOther '.get_class($this).' '.$resource->getResourceId().' '.$privilege);
96
                return $this->assertOther($resource, $privilege);
97 98 99 100 101
        }
    }



102 103 104 105 106 107 108 109 110 111 112 113 114
    /**
     * @param string|ResourceInterface $resource
     * @param string                   $privilege
     *
     * @return bool
     */
    public function isAllowed($resource, $privilege = null)
    {
        return $this->getServiceAuthorize()->isAllowed($resource, $privilege);
    }



115
    /**
116 117 118 119
     * @return Acl
     */
    public function getAcl()
    {
120
        if (!$this->acl) {
Laurent Lécluse's avatar
Laurent Lécluse committed
121 122
            $this->acl = $this->getServiceAuthorize()->getAcl();
        }
123

124 125 126 127 128 129 130
        return $this->acl;
    }



    /**
     * @param Acl $acl
131
     *
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
     * @return AbstractAssertion
     */
    public function setAcl(Acl $acl = null)
    {
        $this->acl = $acl;

        return $this;
    }



    /**
     * @return RoleInterface
     */
    public function getRole()
    {
148 149
        if (false === $this->role) {
            $sUserContext = $this->serviceUserContext;
Laurent Lécluse's avatar
Laurent Lécluse committed
150 151 152 153
            if ($sUserContext->getIdentity()) {
                $this->role = $sUserContext->getSelectedIdentityRole();
            }
        }
154

155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
        return $this->role;
    }



    /**
     * @param RoleInterface $role
     *
     * @return AbstractAssertion
     */
    public function setRole(RoleInterface $role = null)
    {
        $this->role = $role;

        return $this;
    }



    /**
175 176 177 178 179 180 181 182 183 184 185 186 187 188
     * @param string $resource
     *
     * @return boolean
     */
    private function detectPrivilege($resource = null)
    {
        if ($resource instanceof ResourceInterface) $resource = $resource->getResourceId();

        return is_string($resource) && 0 === strpos($resource, 'privilege/');
    }



    /**
189 190
     * @param string $privilege
     * @param string $subPrivilege
191 192 193
     *
     * @return boolean
     */
194
    protected function assertPrivilege($privilege, $subPrivilege = null)
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
    {
        return true;
    }



    /**
     * @param string $resource
     *
     * @return boolean
     */
    private function detectController($resource = null)
    {
        if ($resource instanceof ResourceInterface) $resource = $resource->getResourceId();

        return 0 === strpos($resource, 'controller/');
    }



215 216 217 218 219 220 221 222 223 224
    /**
     * Ititialisation des paramètres de l'assertion (si nécessaire)
     */
    public function init()
    {

    }



225
    /**
226 227 228
     * @param string $controller
     * @param string $action
     * @param string $privilege
229 230 231
     *
     * @return boolean
     */
232
    protected function assertController($controller, $action = null, $privilege = null)
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
    {
        return true;
    }



    /**
     * @param string $resource
     *
     * @return boolean
     */
    private function detectEntity($resource = null)
    {
        return
            is_object($resource)
            && method_exists($resource, 'getId');
    }



    /**
     * @param ResourceInterface $entity
     * @param string            $privilege
     *
     * @return boolean
     */
259
    protected function assertEntity(ResourceInterface $entity, $privilege = null)
260 261 262 263 264 265 266
    {
        return true;
    }



    /**
267
     * @param ResourceInterface $resource
268 269 270 271
     * @param string            $privilege
     *
     * @return boolean
     */
272
    protected function assertOther(ResourceInterface $resource = null, $privilege = null)
273 274 275 276 277 278
    {
        return true;
    }



279 280 281 282 283 284 285 286 287 288
    /**
     * Parcours la liste des résultats des assertions transmises (liste de booleans)
     * Si l'une d'entres elles est fausse alors false est retourné. true sinon.
     *
     * @param array $assertions
     *
     * @return bool
     */
    protected function asserts($assertions)
    {
289
        if (!is_array($assertions)) {
290 291 292
            $assertions = [$assertions];
        }

293
        foreach ($assertions as $assertion) {
294 295 296 297 298 299 300
            if (!$assertion) return false;
        }

        return true;
    }


301

302 303 304 305
    public function setMvcEvent(MvcEvent $mvcEvent)
    {
        $this->mvcEvent = $mvcEvent;
    }
306

307 308


309 310 311 312 313
    /**
     * @return MvcEvent
     */
    protected function getMvcEvent()
    {
314
        return $this->mvcEvent;
315 316 317
    }

}