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

namespace UnicaenAuth\Service;

5
use UnicaenApp\Exception\RuntimeException;
6
use UnicaenApp\Traits\SessionContainerTrait;
7
use Zend\Session\Container as SessionContainer;
8
use Zend\Permissions\Acl\Role\RoleInterface;
9
10
use ZfcUser\Entity\UserInterface;
use UnicaenAuth\Entity\Ldap\People;
11
use UnicaenAuth\Acl\NamedRole;
12
13

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

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

27
    /**
28
     * @var array
29
     */
30
    protected $identityRoles;
31

32

33
34
35
36
37
38
39
40
41
42
43
44
45

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

47
48
49
        return null;
    }

50
51


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

65
66
67
        return null;
    }

68
69


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

84
85
        return $this->identity;
    }
86

87
88


89
    /**
90
     * Retourne tous les rôles de l'utilisateur courant, pas seulement le rôle courant sélectionné.
91
     *
92
93
94
95
96
     * @return array
     */
    public function getIdentityRoles()
    {
        if (null === $this->identityRoles) {
97
            $identityProvider    = $this->getIdentityProvider();
98
            $this->identityRoles = $identityProvider->getAllIdentityRoles();
99
        }
100

101
102
        return $this->identityRoles;
    }
103

104
105


106
    /**
107
     * Retourne parmi tous les rôles de l'utilisateur courant ceux qui peuvent être sélectionnés.
108
     *
109
110
111
112
     * @return array
     */
    public function getSelectableIdentityRoles()
    {
113
114
115
        $filter = function ($r) {
            return !($r instanceof NamedRole && !$r->getSelectable());
        };
Bertrand Gauthier's avatar
Bertrand Gauthier committed
116
        $roles  = array_filter($this->getIdentityRoles(), $filter);
117

Bertrand Gauthier's avatar
Bertrand Gauthier committed
118
        return $roles;
119
    }
120

121
122


123
    /**
124
     * Si un utilisateur est authentifié, retourne le rôle utilisateur sélectionné,
125
     * ou alors le premier sélectionnable si aucun n'a été sélectionné.
126
127
128
129
     *
     * 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.
     *
130
131
132
133
     * @return mixed
     */
    public function getSelectedIdentityRole()
    {
134
135
136
137
138
139
140
        if ($this->getNextSelectedIdentityRole()) {
            $this->getSessionContainer()->selectedIdentityRole = $this->getNextSelectedIdentityRole();
        }

        if (null === $this->getSessionContainer()->selectedIdentityRole && $this->getIdentity()) {
            $roles = $this->getSelectableIdentityRoles();
            $this->setSelectedIdentityRole(reset($roles));
141
        }
142
143
144

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

145
146
147
148
149
        if ($roleId){
            $role = $this->normalizedIdentityRole($roleId);
            if ($this->isRoleValid($role)) {
                return $role;
            }
150
        }
151

152
        return null;
153
    }
154

155
156


157
    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
158
     * Mémorise en session le rôle spécifié comme étant le rôle courant de l'utilisateur.
159
     *
Bertrand Gauthier's avatar
Bertrand Gauthier committed
160
     * NB: seul l'id du rôle est mémorisé en session.
161
     *
Bertrand Gauthier's avatar
Bertrand Gauthier committed
162
     * @param RoleInterface|string $role
163
     *
164
     * @return \UnicaenAuth\Service\UserContext
165
     * @throws RuntimeException
166
167
168
169
170
     */
    public function setSelectedIdentityRole($role)
    {
        if ($role) {
            if (!$this->isRoleValid($role)) {
171
                throw new RuntimeException("Rôle spécifié invalide.");
172
            }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
173
174
175
176
            if ($role instanceof RoleInterface) {
                $role = $role->getRoleId();
            }
            $this->getSessionContainer()->selectedIdentityRole = $role;
177
        } else {
178
179
            unset($this->getSessionContainer()->selectedIdentityRole);
        }
180
181
182
183

        return $this;
    }

184
185


186
187
188
189
190
    /**
     * Retourne l'éventuel rôle spécifié en session devant être le prochain rôle sélectionné.
     *
     * @return string|null
     */
191
    public function getNextSelectedIdentityRole()
192
193
194
195
    {
        return $this->getSessionContainer()->nextSelectedIdentityRole;
    }

196
197


198
199
200
201
202
203
    /**
     * 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
204
     *
205
206
207
208
209
210
211
212
213
214
215
     * @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');
216
        } else {
217
218
219
            unset($this->getSessionContainer()->nextSelectedIdentityRole);
        }

220
221
        return $this;
    }
222

223
224


225
226
    /**
     * Recherche le role spécifié parmi les rôles connus au format objets.
227
228
     *
     * @param RoleInterface|string $role
229
     *
230
     * @return RoleInterface Role trouvé au format objet dans la mesure du possible
231
232
233
     */
    protected function normalizedIdentityRole($role)
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
234
        if (!$role || is_object($role)) {
235
236
            return $role;
        }
237

238
239
240
241
242
243
244
245
        foreach ($this->getIdentityRoles() as $r) {
            if ($r instanceof RoleInterface && $role === $r->getRoleId()) {
                return $r;
            }
            if ($role === $r) {
                return $r;
            }
        }
246

247
248
        return $role;
    }
249

250
251


252
    /**
253
     * Teste si le rôle spécifié fait partie des rôles disponibles.
254
255
     *
     * @param RoleInterface|string $role
256
     *
257
     * @return boolean
258
     */
259
    protected function isRoleValid($role)
260
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
261
262
263
        if ($role instanceof RoleInterface) {
            $role = $role->getRoleId();
        }
264

265
        foreach ($this->getIdentityRoles() as $r) {
266
            if ($r instanceof RoleInterface) {
267
268
269
270
271
272
                $r = $r->getRoleId();
            }
            if ($role === $r) {
                return true;
            }
        }
273

274
275
        return false;
    }
276

277
278


279
    /**
280
     *
281
282
283
284
     * @return \UnicaenAuth\Provider\Identity\Chain
     */
    private function getIdentityProvider()
    {
285
286
        return $this->getServiceAuthorize()->getIdentityProvider();
        /* @var $identityProvider \UnicaenAuth\Provider\Identity\Chain */
287
    }
288

289
}