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

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

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

29
    /**
30
     * @var array
31
     */
32
    protected $identityRoles;
33

34

35
36
37
38
39
40
41
42
43
44
45
46
47

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

49
50
51
        return null;
    }

52
53


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

67
68
69
        return null;
    }

70
71


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

86
87
        return $this->identity;
    }
88

89
90


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

        return null;
    }



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

            $roles            = $this->getServiceAuthorize()->getRoles();
121
122
            $identityProvider = $this->getIdentityProvider();
            if ($identityProvider instanceof Chain) {
123
                $iRoles = $identityProvider->getAllIdentityRoles();
124
            } else {
125
126
127
128
129
130
131
132
133
                $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;
                }
134
            }
135
        }
136

137
138
        return $this->identityRoles;
    }
139

140
141


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

Bertrand Gauthier's avatar
Bertrand Gauthier committed
154
        return $roles;
155
    }
156

157
158


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

171
172
173
174
175
176
177
        if ($this->getNextSelectedIdentityRole()) {
            $this->getSessionContainer()->selectedIdentityRole = $this->getNextSelectedIdentityRole();
        }

        if (null === $this->getSessionContainer()->selectedIdentityRole && $this->getIdentity()) {
            $roles = $this->getSelectableIdentityRoles();
            $this->setSelectedIdentityRole(reset($roles));
178
        }
179
180
181

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

182
183
184
185
186
        if ($roleId) {

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

191
192
193
            if ($this->isRoleValid($role)) {
                return $role;
            }
194
        }
195

196
        return null;
197
    }
198

199
200


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

        return $this;
    }

228
229


230
231
232
233
234
    /**
     * Retourne l'éventuel rôle spécifié en session devant être le prochain rôle sélectionné.
     *
     * @return string|null
     */
235
    public function getNextSelectedIdentityRole()
236
237
238
239
    {
        return $this->getSessionContainer()->nextSelectedIdentityRole;
    }

240
241


242
243
244
245
246
247
    /**
     * 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
248
     *
249
250
251
252
253
254
255
256
257
258
259
     * @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');
260
        } else {
261
262
263
            unset($this->getSessionContainer()->nextSelectedIdentityRole);
        }

264
265
        return $this;
    }
266

267
268


269
    /**
270
     * Teste si le rôle spécifié fait partie des rôles disponibles.
271
272
     *
     * @param RoleInterface|string $role
273
     *
274
     * @return boolean
275
     */
276
    protected function isRoleValid($role)
277
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
278
279
280
        if ($role instanceof RoleInterface) {
            $role = $role->getRoleId();
        }
281

282
        foreach ($this->getIdentityRoles() as $r) {
283
            if ($r instanceof RoleInterface) {
284
285
286
287
288
289
                $r = $r->getRoleId();
            }
            if ($role === $r) {
                return true;
            }
        }
290

291
292
        return false;
    }
293

294
295


296
    /**
297
     *
298
299
300
301
     * @return \UnicaenAuth\Provider\Identity\Chain
     */
    private function getIdentityProvider()
    {
302
303
        return $this->getServiceAuthorize()->getIdentityProvider();
        /* @var $identityProvider \UnicaenAuth\Provider\Identity\Chain */
304
    }
305

306
}