UserContext.php 10.4 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\EventManager\EventManagerAwareInterface;
15
use Zend\EventManager\EventManagerAwareTrait;
16
use Zend\Permissions\Acl\Role\RoleInterface;
17
18
19
use ZfcUser\Entity\UserInterface;

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

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

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

39
40
41
42
43
44
45
46
47
48
49
50
    /**
     * 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'];
            }
        }
51

52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
        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'];
            }
        }
67

68
69
70
        return null;
    }

71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
    /**
     * 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;
    }

87
    /**
88
     * Retourne les données d'identité correspondant à l'utilisateur courant.
89
     *
90
     * @return mixed
91
     */
92
    public function getIdentity()
93
    {
94
95
96
97
98
99
        if (null === $this->identity) {
            $authenticationService = $this->getServiceLocator()->get('Zend\Authentication\AuthenticationService');
            if ($authenticationService->hasIdentity()) {
                $this->identity = $authenticationService->getIdentity();
            }
        }
100

101
102
        return $this->identity;
    }
103

104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
    /**
     * 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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
    /**
     * @param string $roleId
     *
     * @return Role
     */
    public function getIdentityRole($roleId)
    {
        $roles = $this->getServiceAuthorize()->getRoles();
        if (isset($roles[$roleId])) {
            return $roles[$roleId];
        }

        return null;
    }

139
    /**
140
     * Retourne tous les rôles de l'utilisateur courant, pas seulement le rôle courant sélectionné.
141
     *
142
143
144
     * Les clés du tableau sont les ID de rôles, les valeurs sont les objets Role
     *
     * @return Role[]
145
146
147
148
     */
    public function getIdentityRoles()
    {
        if (null === $this->identityRoles) {
149
150
151
            $this->identityRoles = [];

            $roles            = $this->getServiceAuthorize()->getRoles();
152
153
            $identityProvider = $this->getIdentityProvider();
            if ($identityProvider instanceof Chain) {
154
                $identityRoles = $identityProvider->getAllIdentityRoles();
155
            } else {
156
                $identityRoles = $identityProvider->getIdentityRoles();
157
            }
158
159
            foreach ($identityRoles as $role) {
                if ($role instanceof RoleInterface) {
160
                    $this->identityRoles[$role->getRoleId()] = $role;
161
162
163
                } elseif (is_string($role) && isset($roles[$role])) {
                    $role = $roles[$role];
                    /** @var RoleInterface $role */
164
165
                    $this->identityRoles[$role->getRoleId()] = $role;
                }
166
            }
167
        }
168

169
170
        return $this->identityRoles;
    }
171

172
173
174
175
176
177
178
179
180
181
    /**
     * Retourne tous les rôles de l'utilisateur courant au format littéral.
     *
     * @return array
     * @see getIdentityRoles()
     */
    public function getIdentityRolesToString()
    {
        $f = new RoleFormatter();
        $rolesToStrings = [];
182

183
184
185
186
187
188
        foreach ($this->getIdentityRoles() as $identityRole) {
            $rolesToStrings[$identityRole->getRoleId()] = $f->format($identityRole);
        }

        return $rolesToStrings;
    }
189

190
    /**
191
     * Retourne parmi tous les rôles de l'utilisateur courant ceux qui peuvent être sélectionnés.
192
     *
193
194
195
196
     * @return array
     */
    public function getSelectableIdentityRoles()
    {
197
198
199
        $filter = function ($r) {
            return !($r instanceof NamedRole && !$r->getSelectable());
        };
Bertrand Gauthier's avatar
Bertrand Gauthier committed
200
        $roles  = array_filter($this->getIdentityRoles(), $filter);
201

Bertrand Gauthier's avatar
Bertrand Gauthier committed
202
        return $roles;
203
    }
204

205
    /**
206
     * Si un utilisateur est authentifié, retourne le rôle utilisateur sélectionné,
207
     * ou alors le premier sélectionnable si aucun n'a été sélectionné.
208
209
210
211
     *
     * 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.
     *
212
     * @return RoleInterface
213
214
215
     */
    public function getSelectedIdentityRole()
    {
216
217
218
219
220
221
222
        if ($this->getNextSelectedIdentityRole()) {
            $this->getSessionContainer()->selectedIdentityRole = $this->getNextSelectedIdentityRole();
        }

        if (null === $this->getSessionContainer()->selectedIdentityRole && $this->getIdentity()) {
            $roles = $this->getSelectableIdentityRoles();
            $this->setSelectedIdentityRole(reset($roles));
223
        }
224
225

        $roleId = $this->getSessionContainer()->selectedIdentityRole;
226
        if ($roleId) {
227
228
//            $roles = $this->getServiceAuthorize()->getRoles(); // Récupération de tous les rôles du provider
            $roles = $this->getIdentityRoles();
229
230
            if (isset($roles[$roleId])) {
                $role = $roles[$roleId];
231
            } else {
232
233
234
                $role = null;
            }

235
236
237
            if ($this->isRoleValid($role)) {
                return $role;
            }
238
        }
239

240
        return null;
241
    }
242

243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
    /**
     * 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();
258

259
260
        return $f->format($role);
    }
261

262
    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
263
     * Mémorise en session le rôle spécifié comme étant le rôle courant de l'utilisateur.
264
     *
Bertrand Gauthier's avatar
Bertrand Gauthier committed
265
     * NB: seul l'id du rôle est mémorisé en session.
266
     *
Bertrand Gauthier's avatar
Bertrand Gauthier committed
267
     * @param RoleInterface|string $role
268
     *
269
     * @return \UnicaenAuth\Service\UserContext
270
     * @throws RuntimeException
271
272
273
274
275
     */
    public function setSelectedIdentityRole($role)
    {
        if ($role) {
            if (!$this->isRoleValid($role)) {
276
                throw new RuntimeException("Rôle spécifié invalide.");
277
            }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
278
279
280
281
            if ($role instanceof RoleInterface) {
                $role = $role->getRoleId();
            }
            $this->getSessionContainer()->selectedIdentityRole = $role;
282
        } else {
283
284
            unset($this->getSessionContainer()->selectedIdentityRole);
        }
285

286
287
        $this->triggerUserRoleSelectedEvent(UserRoleSelectedEvent::POST_SELECTION, $role);

288
289
290
291
292
293
294
295
        return $this;
    }

    /**
     * Retourne l'éventuel rôle spécifié en session devant être le prochain rôle sélectionné.
     *
     * @return string|null
     */
296
    public function getNextSelectedIdentityRole()
297
298
299
300
301
302
303
304
305
306
    {
        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
307
     *
308
309
310
311
312
313
314
315
316
317
318
     * @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');
319
        } else {
320
321
322
            unset($this->getSessionContainer()->nextSelectedIdentityRole);
        }

323
324
        $this->triggerUserRoleSelectedEvent(UserRoleSelectedEvent::POST_SELECTION, $role);

325
326
        return $this;
    }
327

328
329
330
331
332
333
334
335
336
337
338
339
340
341
    /**
     * 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);
    }
342

343
    /**
344
     * Teste si le rôle spécifié fait partie des rôles disponibles.
345
346
     *
     * @param RoleInterface|string $role
347
     *
348
     * @return boolean
349
     */
350
    public function isRoleValid($role)
351
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
352
353
354
        if ($role instanceof RoleInterface) {
            $role = $role->getRoleId();
        }
355

356
        foreach ($this->getIdentityRoles() as $r) {
357
            if ($r instanceof RoleInterface) {
358
359
360
361
362
363
                $r = $r->getRoleId();
            }
            if ($role === $r) {
                return true;
            }
        }
364

365
366
        return false;
    }
367

368
    /**
369
     *
370
     * @return Chain
371
372
373
     */
    private function getIdentityProvider()
    {
374
375
        /* @var $identityProvider Chain */
        $identityProvider = $this->getServiceAuthorize()->getIdentityProvider();
376

377
378
        return $identityProvider;
    }
379
}