UserContext.php 8.65 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
use UnicaenAuth\Event\UserRoleSelectedEvent;
9
use UnicaenAuth\Provider\Identity\Chain;
10
use Zend\EventManager\EventManagerAwareInterface;
11
use Zend\Session\Container as SessionContainer;
12
use Zend\Permissions\Acl\Role\RoleInterface;
13
14
use ZfcUser\Entity\UserInterface;
use UnicaenAuth\Entity\Ldap\People;
15
use UnicaenAuth\Acl\NamedRole;
16
use Zend\EventManager\EventManagerAwareTrait;
17
18

/**
19
 * Service centralisant des méthodes utiles concernant l'utilisateur authentifié.
20
21
22
 *
 * @author Laurent LÉCLUSE <laurent.lecluse at unicaen.fr>
 */
23
class UserContext extends AbstractService implements EventManagerAwareInterface
24
{
25
    use EventManagerAwareTrait;
26
    use SessionContainerTrait;
27
28
29
30
31

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

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

38

39
40
41
42
43
44
45
46
47
48
49
50
51

    /**
     * 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'];
            }
        }
52

53
54
55
        return null;
    }

56
57


58
59
60
61
62
63
64
65
66
67
68
69
    /**
     * 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'];
            }
        }
70

71
72
73
        return null;
    }

74
75


76
    /**
77
     * Retourne les données d'identité correspondant à l'utilisateur courant.
78
     *
79
     * @return mixed
80
     */
81
    public function getIdentity()
82
    {
83
84
85
86
87
88
        if (null === $this->identity) {
            $authenticationService = $this->getServiceLocator()->get('Zend\Authentication\AuthenticationService');
            if ($authenticationService->hasIdentity()) {
                $this->identity = $authenticationService->getIdentity();
            }
        }
89

90
91
        return $this->identity;
    }
92

93
94


Laurent Lécluse's avatar
Laurent Lécluse committed
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
    /**
     * @param string $roleId
     *
     * @return Role
     */
    public function getIdentityRole($roleId)
    {
        $roles = $this->getServiceAuthorize()->getRoles();
        if (isset($roles[$roleId])) {
            return $roles[$roleId];
        }

        return null;
    }



112
    /**
113
     * Retourne tous les rôles de l'utilisateur courant, pas seulement le rôle courant sélectionné.
114
     *
115
116
117
     * Les clés du tableau sont les ID de rôles, les valeurs sont les objets Role
     *
     * @return Role[]
118
119
120
121
     */
    public function getIdentityRoles()
    {
        if (null === $this->identityRoles) {
122
123
124
            $this->identityRoles = [];

            $roles            = $this->getServiceAuthorize()->getRoles();
125
126
            $identityProvider = $this->getIdentityProvider();
            if ($identityProvider instanceof Chain) {
127
                $iRoles = $identityProvider->getAllIdentityRoles();
128
            } else {
129
130
131
132
133
134
135
136
137
                $iRoles = $identityProvider->getIdentityRoles();
            }
            foreach ($iRoles as $role) {
                if ($role instanceof Role) {
                    $this->identityRoles[$role->getRoleId()] = $role;
                } elseif (isset($roles[$role])) {
                    $role                                    = $roles[$role];
                    $this->identityRoles[$role->getRoleId()] = $role;
                }
138
            }
139
        }
140

141
142
        return $this->identityRoles;
    }
143

144
145


146
    /**
147
     * Retourne parmi tous les rôles de l'utilisateur courant ceux qui peuvent être sélectionnés.
148
     *
149
150
151
152
     * @return array
     */
    public function getSelectableIdentityRoles()
    {
153
154
155
        $filter = function ($r) {
            return !($r instanceof NamedRole && !$r->getSelectable());
        };
Bertrand Gauthier's avatar
Bertrand Gauthier committed
156
        $roles  = array_filter($this->getIdentityRoles(), $filter);
157

Bertrand Gauthier's avatar
Bertrand Gauthier committed
158
        return $roles;
159
    }
160

161
162


163
    /**
164
     * Si un utilisateur est authentifié, retourne le rôle utilisateur sélectionné,
165
     * ou alors le premier sélectionnable si aucun n'a été sélectionné.
166
167
168
169
     *
     * 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.
     *
170
171
172
173
     * @return mixed
     */
    public function getSelectedIdentityRole()
    {
174

175
176
177
178
179
180
181
        if ($this->getNextSelectedIdentityRole()) {
            $this->getSessionContainer()->selectedIdentityRole = $this->getNextSelectedIdentityRole();
        }

        if (null === $this->getSessionContainer()->selectedIdentityRole && $this->getIdentity()) {
            $roles = $this->getSelectableIdentityRoles();
            $this->setSelectedIdentityRole(reset($roles));
182
        }
183
184
185

        $roleId = $this->getSessionContainer()->selectedIdentityRole;

186
187
188
189
190
        if ($roleId) {

            $roles = $this->getServiceAuthorize()->getRoles(); // Récupération de tous les rôles du provider
            if (isset($roles[$roleId])) {
                $role = $roles[$roleId];
191
            } else {
192
193
194
                $role = null;
            }

195
196
197
            if ($this->isRoleValid($role)) {
                return $role;
            }
198
        }
199

200
        return null;
201
    }
202

203
204


205
    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
206
     * Mémorise en session le rôle spécifié comme étant le rôle courant de l'utilisateur.
207
     *
Bertrand Gauthier's avatar
Bertrand Gauthier committed
208
     * NB: seul l'id du rôle est mémorisé en session.
209
     *
Bertrand Gauthier's avatar
Bertrand Gauthier committed
210
     * @param RoleInterface|string $role
211
     *
212
     * @return \UnicaenAuth\Service\UserContext
213
     * @throws RuntimeException
214
215
216
217
218
     */
    public function setSelectedIdentityRole($role)
    {
        if ($role) {
            if (!$this->isRoleValid($role)) {
219
                throw new RuntimeException("Rôle spécifié invalide.");
220
            }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
221
222
223
224
            if ($role instanceof RoleInterface) {
                $role = $role->getRoleId();
            }
            $this->getSessionContainer()->selectedIdentityRole = $role;
225
        } else {
226
227
            unset($this->getSessionContainer()->selectedIdentityRole);
        }
228

229
230
        $this->triggerUserRoleSelectedEvent(UserRoleSelectedEvent::POST_SELECTION, $role);

231
232
233
        return $this;
    }

234
235


236
237
238
239
240
    /**
     * Retourne l'éventuel rôle spécifié en session devant être le prochain rôle sélectionné.
     *
     * @return string|null
     */
241
    public function getNextSelectedIdentityRole()
242
243
244
245
    {
        return $this->getSessionContainer()->nextSelectedIdentityRole;
    }

246
247


248
249
250
251
252
253
    /**
     * 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
254
     *
255
256
257
258
259
260
261
262
263
264
265
     * @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');
266
        } else {
267
268
269
            unset($this->getSessionContainer()->nextSelectedIdentityRole);
        }

270
271
        $this->triggerUserRoleSelectedEvent(UserRoleSelectedEvent::POST_SELECTION, $role);

272
273
        return $this;
    }
274

275
276
277
278
279
280
281
282
283
284
285
286
287
288
    /**
     * 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);
    }
289

290
    /**
291
     * Teste si le rôle spécifié fait partie des rôles disponibles.
292
293
     *
     * @param RoleInterface|string $role
294
     *
295
     * @return boolean
296
     */
297
    public function isRoleValid($role)
298
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
299
300
301
        if ($role instanceof RoleInterface) {
            $role = $role->getRoleId();
        }
302

303
        foreach ($this->getIdentityRoles() as $r) {
304
            if ($r instanceof RoleInterface) {
305
306
307
308
309
310
                $r = $r->getRoleId();
            }
            if ($role === $r) {
                return true;
            }
        }
311

312
313
        return false;
    }
314

315
316


317
    /**
318
     *
319
320
321
322
     * @return \UnicaenAuth\Provider\Identity\Chain
     */
    private function getIdentityProvider()
    {
323
324
        return $this->getServiceAuthorize()->getIdentityProvider();
        /* @var $identityProvider \UnicaenAuth\Provider\Identity\Chain */
325
    }
326

327
}