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

namespace UnicaenAuth\Assertion;

Laurent Lécluse's avatar
Laurent Lécluse committed
5
6
use BjyAuthorize\Service\Authorize;
use UnicaenAuth\Service\Traits\UserContextServiceAwareTrait;
7
use Zend\Mvc\Application;
8
use Zend\Mvc\Controller\Plugin\FlashMessenger;
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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;
use Zend\ServiceManager\ServiceLocatorAwareInterface;
use Zend\ServiceManager\ServiceLocatorAwareTrait;

/**
 * Description of AbstractAssertion
 *
 * @author Laurent LÉCLUSE <laurent.lecluse at unicaen.fr>
 */
abstract class AbstractAssertion implements AssertionInterface, ServiceLocatorAwareInterface
{
    use ServiceLocatorAwareTrait;
Laurent Lécluse's avatar
Laurent Lécluse committed
25
    use UserContextServiceAwareTrait;
26

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

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

37
38
39
40
41
    /**
     * @var FlashMessenger
     */
    private $fm;

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
71


    /**
     * !!!! 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)
    {
72
73
        $this->setAcl($acl);
        $this->setRole($role);
74
        $this->init();
75
76
77
        switch (true) {
            case $this->detectPrivilege($resource):

78
                return $this->assertPrivilege(ltrim(strstr($resource, '/'), '/'), $privilege);
79
80
81
82
83
84
85
86
87

            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);

88
                return $this->assertController($controller, $action, $privilege);
89
90
91

            case $this->detectEntity($resource):

92
                return $this->assertEntity($resource, $privilege);
93
94
95

            default:

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()
    {
Laurent Lécluse's avatar
Laurent Lécluse committed
120
121
122
        if (!$this->acl){
            $this->acl = $this->getServiceAuthorize()->getAcl();
        }
123
124
125
126
127
128
129
        return $this->acl;
    }



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

        return $this;
    }



    /**
     * @return RoleInterface
     */
    public function getRole()
    {
Laurent Lécluse's avatar
Laurent Lécluse committed
147
148
149
150
151
152
        if (false === $this->role){
            $sUserContext = $this->getServiceUserContext();
            if ($sUserContext->getIdentity()) {
                $this->role = $sUserContext->getSelectedIdentityRole();
            }
        }
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
        return $this->role;
    }



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

        return $this;
    }



    /**
173
174
175
176
177
178
179
180
181
182
183
184
185
186
     * @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/');
    }



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



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

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



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

    }



223
    /**
224
225
226
     * @param string $controller
     * @param string $action
     * @param string $privilege
227
228
229
     *
     * @return boolean
     */
230
    protected function assertController($controller, $action = null, $privilege = null)
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
    {
        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
     */
257
    protected function assertEntity(ResourceInterface $entity, $privilege = null)
258
259
260
261
262
263
264
    {
        return true;
    }



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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
    /**
     * 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)
    {
        if (!is_array($assertions)){
            $assertions = [$assertions];
        }

        foreach( $assertions as $assertion ){
            if (!$assertion) return false;
        }

        return true;
    }



300
301
302
303
304
305
306
    /**
     * @return MvcEvent
     */
    protected function getMvcEvent()
    {
        $application = $this->getServiceLocator()->get('Application');

307
308
        /* @var $application Application */

309
310
311
        return $application->getMvcEvent();
    }

Laurent Lécluse's avatar
Laurent Lécluse committed
312
313
314
315
316
317
318
319
320
321
322
323
324


    /**
     * @return Authorize
     */
    private function getServiceAuthorize()
    {
        $serviceAuthorize = $this->getServiceLocator()->get('BjyAuthorize\Service\Authorize');
        /* @var $serviceAuthorize Authorize */

        return $serviceAuthorize;
    }

325
326
327
328
329
330
331
332
333
334
335
336
337


    /**
     * @return FlashMessenger
     */
    protected function flashMessenger()
    {
        if (!$this->fm){
            $this->fm = $this->getServiceLocator()->get('controllerpluginmanager')->get('flashmessenger');
        }

        return $this->fm;
    }
338
}