UserContext.php 10.8 KB
Newer Older
1
2
3
4
<?php

namespace UnicaenAuth\Service;

5
use BjyAuthorize\Acl\Role;
6
use UnicaenApp\Exception\RuntimeException;
7
use UnicaenApp\Traits\SessionContainerTrait;
8
9
use UnicaenAuth\Acl\NamedRole;
use UnicaenAuth\Entity\Ldap\People;
10
use UnicaenAuth\Entity\Shibboleth\ShibUser;
11
use UnicaenAuth\Event\UserRoleSelectedEvent;
12
use UnicaenAuth\Formatter\RoleFormatter;
13
use UnicaenAuth\Provider\Identity\Chain;
14
use Zend\Authentication\AuthenticationService;
15
use Zend\EventManager\EventManagerAwareInterface;
16
use Zend\EventManager\EventManagerAwareTrait;
17
use Zend\Permissions\Acl\Role\RoleInterface;
18
19
20
use ZfcUser\Entity\UserInterface;

/**
21
 * Service centralisant des méthodes utiles concernant l'utilisateur authentifié.
22
 *
23
 * @author Unicaen
24
 */
25
class UserContext extends AbstractService implements EventManagerAwareInterface
26
{
27
    use EventManagerAwareTrait;
28
    use SessionContainerTrait;
29
30
31
32
33

    /**
     * @var mixed
     */
    protected $identity;
34

35
    /**
36
     * @var array
37
     */
38
    protected $identityRoles;
39

40
41
42
43
44
45
46
47
48
49
50
51
52
    /**
     * @var AuthenticationService
     */
    protected $authenticationService;

    /**
     * @param AuthenticationService $authenticationService
     */
    public function setAuthenticationService(AuthenticationService $authenticationService)
    {
        $this->authenticationService = $authenticationService;
    }

53
54
55
56
57
58
59
60
61
62
63
64
    /**
     * Retourne l'utilisateur BDD courant
     *
     * @return UserInterface
     */
    public function getDbUser()
    {
        if (($identity = $this->getIdentity())) {
            if (isset($identity['db']) && $identity['db'] instanceof UserInterface) {
                return $identity['db'];
            }
        }
65

66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
        return null;
    }

    /**
     * Retourne l'utilisateur LDAP courant
     *
     * @return People
     */
    public function getLdapUser()
    {
        if (($identity = $this->getIdentity())) {
            if (isset($identity['ldap']) && $identity['ldap'] instanceof People) {
                return $identity['ldap'];
            }
        }
81

82
83
84
        return null;
    }

85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
    /**
     * Retourne l'éventuel utilisateur Shibboleth courant.
     *
     * @return ShibUser|null
     */
    public function getShibUser()
    {
        if (($identity = $this->getIdentity())) {
            if (isset($identity['shib']) && $identity['shib'] instanceof ShibUser) {
                return $identity['shib'];
            }
        }

        return null;
    }

101
    /**
102
     * Retourne les données d'identité correspondant à l'utilisateur courant.
103
     *
104
     * @return mixed
105
     */
106
    public function getIdentity()
107
    {
108
        if (null === $this->identity) {
109
            $authenticationService = $this->authenticationService;
110
111
112
113
            if ($authenticationService->hasIdentity()) {
                $this->identity = $authenticationService->getIdentity();
            }
        }
114

115
116
        return $this->identity;
    }
117

118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
    /**
     * Retourne l'identifiant de connexion de l'utilisateur courant.
     *
     * @return string|null
     */
    public function getIdentityUsername()
    {
        if ($user = $this->getShibUser()) {
            return $user->getUsername();
        }
        if ($user = $this->getLdapUser()) {
            return $user->getUsername();
        }
        if ($user = $this->getDbUser()) {
            return $user->getUsername();
        }

        return null;
    }

Laurent Lécluse's avatar
Laurent Lécluse committed
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
    /**
     * @param string $roleId
     *
     * @return Role
     */
    public function getIdentityRole($roleId)
    {
        $roles = $this->getServiceAuthorize()->getRoles();
        if (isset($roles[$roleId])) {
            return $roles[$roleId];
        }

        return null;
    }

153
    /**
154
     * Retourne tous les rôles de l'utilisateur courant, pas seulement le rôle courant sélectionné.
155
     *
156
157
158
     * Les clés du tableau sont les ID de rôles, les valeurs sont les objets Role
     *
     * @return Role[]
159
160
161
162
     */
    public function getIdentityRoles()
    {
        if (null === $this->identityRoles) {
163
164
165
            $this->identityRoles = [];

            $roles            = $this->getServiceAuthorize()->getRoles();
166
167
            $identityProvider = $this->getIdentityProvider();
            if ($identityProvider instanceof Chain) {
168
                $identityRoles = $identityProvider->getAllIdentityRoles();
169
            } else {
170
                $identityRoles = $identityProvider->getIdentityRoles();
171
            }
172
173
            foreach ($identityRoles as $role) {
                if ($role instanceof RoleInterface) {
174
                    $this->identityRoles[$role->getRoleId()] = $role;
175
176
177
                } elseif (is_string($role) && isset($roles[$role])) {
                    $role = $roles[$role];
                    /** @var RoleInterface $role */
178
179
                    $this->identityRoles[$role->getRoleId()] = $role;
                }
180
            }
181
        }
182

183
184
        return $this->identityRoles;
    }
185

186
187
188
189
190
191
192
193
194
195
    /**
     * Retourne tous les rôles de l'utilisateur courant au format littéral.
     *
     * @return array
     * @see getIdentityRoles()
     */
    public function getIdentityRolesToString()
    {
        $f = new RoleFormatter();
        $rolesToStrings = [];
196

197
198
199
200
201
202
        foreach ($this->getIdentityRoles() as $identityRole) {
            $rolesToStrings[$identityRole->getRoleId()] = $f->format($identityRole);
        }

        return $rolesToStrings;
    }
203

204
    /**
205
     * Retourne parmi tous les rôles de l'utilisateur courant ceux qui peuvent être sélectionnés.
206
     *
207
208
209
210
     * @return array
     */
    public function getSelectableIdentityRoles()
    {
211
212
213
        $filter = function ($r) {
            return !($r instanceof NamedRole && !$r->getSelectable());
        };
Bertrand Gauthier's avatar
Bertrand Gauthier committed
214
        $roles  = array_filter($this->getIdentityRoles(), $filter);
215

Bertrand Gauthier's avatar
Bertrand Gauthier committed
216
        return $roles;
217
    }
218

219
    /**
220
     * Si un utilisateur est authentifié, retourne le rôle utilisateur sélectionné,
221
     * ou alors le premier sélectionnable si aucun n'a été sélectionné.
222
223
224
225
     *
     * NB: Si un rôle est spécifié en session comme devant être le prochain rôle sélectionné,
     * c'est lui qui est pris en compte.
     *
226
     * @return RoleInterface
227
228
229
     */
    public function getSelectedIdentityRole()
    {
230
231
232
233
234
235
236
        if ($this->getNextSelectedIdentityRole()) {
            $this->getSessionContainer()->selectedIdentityRole = $this->getNextSelectedIdentityRole();
        }

        if (null === $this->getSessionContainer()->selectedIdentityRole && $this->getIdentity()) {
            $roles = $this->getSelectableIdentityRoles();
            $this->setSelectedIdentityRole(reset($roles));
237
        }
238
239

        $roleId = $this->getSessionContainer()->selectedIdentityRole;
240
        if ($roleId) {
241
242
//            $roles = $this->getServiceAuthorize()->getRoles(); // Récupération de tous les rôles du provider
            $roles = $this->getIdentityRoles();
243
244
            if (isset($roles[$roleId])) {
                $role = $roles[$roleId];
245
            } else {
246
247
248
                $role = null;
            }

249
250
251
            if ($this->isRoleValid($role)) {
                return $role;
            }
252
        }
253

254
        return null;
255
    }
256

257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
    /**
     * Retourne le rôle utilisateur sélectionné éventuel au format littéral.
     *
     * @return string
     * @see getSelectedIdentityRole()
     */
    public function getSelectedIdentityRoleToString()
    {
        $role = $this->getSelectedIdentityRole();

        if (! $role) {
            return null;
        }

        $f = new RoleFormatter();
272

273
274
        return $f->format($role);
    }
275

276
    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
277
     * Mémorise en session le rôle spécifié comme étant le rôle courant de l'utilisateur.
278
     *
Bertrand Gauthier's avatar
Bertrand Gauthier committed
279
     * NB: seul l'id du rôle est mémorisé en session.
280
     *
Bertrand Gauthier's avatar
Bertrand Gauthier committed
281
     * @param RoleInterface|string $role
282
     *
283
     * @return \UnicaenAuth\Service\UserContext
284
     * @throws RuntimeException
285
286
287
288
289
     */
    public function setSelectedIdentityRole($role)
    {
        if ($role) {
            if (!$this->isRoleValid($role)) {
290
                throw new RuntimeException("Rôle spécifié invalide.");
291
            }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
292
293
294
295
            if ($role instanceof RoleInterface) {
                $role = $role->getRoleId();
            }
            $this->getSessionContainer()->selectedIdentityRole = $role;
296
        } else {
297
298
            unset($this->getSessionContainer()->selectedIdentityRole);
        }
299

300
301
        $this->triggerUserRoleSelectedEvent(UserRoleSelectedEvent::POST_SELECTION, $role);

302
303
304
305
306
307
308
309
        return $this;
    }

    /**
     * Retourne l'éventuel rôle spécifié en session devant être le prochain rôle sélectionné.
     *
     * @return string|null
     */
310
    public function getNextSelectedIdentityRole()
311
312
313
314
315
316
317
318
319
320
    {
        return $this->getSessionContainer()->nextSelectedIdentityRole;
    }

    /**
     * Mémorise en session le rôle devant être le prochain rôle sélectionné.
     *
     * NB: seul l'id du rôle est mémorisé en session ; la durée de vie du stockage est de 1 requête seulement.
     *
     * @param RoleInterface|string $role
321
     *
322
323
324
325
326
327
328
329
330
331
332
     * @return \UnicaenAuth\Service\UserContext
     */
    public function setNextSelectedIdentityRole($role)
    {
        if ($role instanceof RoleInterface) {
            $role = $role->getRoleId();
        }

        if ($role) {
            $this->getSessionContainer()->nextSelectedIdentityRole = $role;
            $this->getSessionContainer()->setExpirationHops(1, 'nextSelectedIdentityRole');
333
        } else {
334
335
336
            unset($this->getSessionContainer()->nextSelectedIdentityRole);
        }

337
338
        $this->triggerUserRoleSelectedEvent(UserRoleSelectedEvent::POST_SELECTION, $role);

339
340
        return $this;
    }
341

342
343
344
345
346
347
348
349
350
351
352
353
354
355
    /**
     * Déclenche l'événement donnant à l'application l'opportunité de réagir à la sélection d'un rôle.
     *
     * @param string $name Ex: UserRoleSelectedEvent::POST_SELECTION
     * @param RoleInterface|string|null $role Rôle sélectionné
     */
    private function triggerUserRoleSelectedEvent($name, $role)
    {
        $event = new UserRoleSelectedEvent($name);
        $event
            ->setRole($role)
            ->setTarget($this);
        $this->getEventManager()->trigger($event);
    }
356

357
    /**
358
     * Teste si le rôle spécifié fait partie des rôles disponibles.
359
360
     *
     * @param RoleInterface|string $role
361
     *
362
     * @return boolean
363
     */
364
    public function isRoleValid($role)
365
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
366
367
368
        if ($role instanceof RoleInterface) {
            $role = $role->getRoleId();
        }
369

370
        foreach ($this->getIdentityRoles() as $r) {
371
            if ($r instanceof RoleInterface) {
372
373
374
375
376
377
                $r = $r->getRoleId();
            }
            if ($role === $r) {
                return true;
            }
        }
378

379
380
        return false;
    }
381

382
    /**
383
     *
384
     * @return Chain
385
386
387
     */
    private function getIdentityProvider()
    {
388
389
        /* @var $identityProvider Chain */
        $identityProvider = $this->getServiceAuthorize()->getIdentityProvider();
390

391
392
        return $identityProvider;
    }
393
}