LdapDb.php 4.59 KB
Newer Older
Bertrand Gauthier's avatar
Bertrand Gauthier committed
1
2
3
<?php
namespace UnicaenAuth\Authentication\Storage;

4
5
use UnicaenAuth\Entity\Ldap\PeopleAdapter;
use UnicaenAuth\Options\ModuleOptions;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
6
7
8
9
use Zend\Authentication\Exception\InvalidArgumentException;
use Zend\Authentication\Storage;
use Zend\ServiceManager\ServiceManager;
use Zend\ServiceManager\ServiceManagerAwareInterface;
10
use ZfcUser\Entity\UserInterface;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
11
12
13
14
15
16
17
18

/**
 * Ldap/Db mixin authentification storage.
 *
 * @see Ldap
 * @see Db
 * @author Bertrand GAUTHIER <bertrand.gauthier at unicaen.fr>
 */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
19
class LdapDb implements Storage\StorageInterface, ServiceManagerAwareInterface
Bertrand Gauthier's avatar
Bertrand Gauthier committed
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
    /**
     * @var ServiceManager
     */
    protected $serviceManager;
    
    /**
     * @var Ldap
     */
    protected $ldapStorage;
    
    /**
     * @var Db
     */
    protected $dbStorage;

    /**
37
     * @var ModuleOptions
Bertrand Gauthier's avatar
Bertrand Gauthier committed
38
39
40
41
42
43
44
45
46
47
48
     */
    protected $options;

    /**
     * Returns true if and only if storage is empty
     *
     * @throws InvalidArgumentException If it is impossible to determine whether storage is empty
     * @return boolean
     */
    public function isEmpty()
    {
49
50
        if ($this->getLdapStorage()->isEmpty() && $this->getDbStorage()->isEmpty()) {
            return true;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
51
        }
52
        return false;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
53
54
55
56
57
58
59
60
    }

    /**
     * Returns the contents of storage
     *
     * Behavior is undefined when storage is empty.
     *
     * @throws InvalidArgumentException If reading contents from storage is impossible
61
     * @return UserInterface
Bertrand Gauthier's avatar
Bertrand Gauthier committed
62
63
64
65
66
67
68
69
70
     */
    public function read()
    {
        $identity = null;
        $userId = null;
        if (($dbIdentity = $this->getDbStorage()->read())) {
            $userId = $dbIdentity->getId();
            $identity = $dbIdentity;
        }
71
72
73
74
75
76
77
        
        $userExistsInDb   = (bool) $dbIdentity;
        $userExistsInLdap = $dbIdentity && $dbIdentity->getPassword() === 'ldap';
        // NB: si le mot de passe est 'ldap', alors l'utilisateur a été créé à partir de l'annuaire LDAP

        if (!$userExistsInDb || $userExistsInLdap) {
            // on s'attend à ce que les données en session soient l'entité LDAP correspondant à l'utilisateur connecté
Bertrand Gauthier's avatar
Bertrand Gauthier committed
78
            $ldapIdentity = $this->getLdapStorage()->read();
79
80
81
            if ($ldapIdentity) {
                $identity = new PeopleAdapter($ldapIdentity->getData(), $userId);
            }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
82
        }
83
        
Bertrand Gauthier's avatar
Bertrand Gauthier committed
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
        return $identity;
    }

    /**
     * Writes $contents to storage
     *
     * @param  mixed $contents
     * @throws InvalidArgumentException If writing $contents to storage is impossible
     * @return void
     */
    public function write($contents)
    {
        $this->getLdapStorage()->write($contents);
        $this->getDbStorage()->write($contents);
    }

    /**
     * Clears contents from storage
     *
     * @throws InvalidArgumentException If clearing contents from storage is impossible
     * @return void
     */
    public function clear()
    {
        $this->getLdapStorage()->clear();
        $this->getDbStorage()->clear();
    }

    /**
     * Retrieve service manager instance
     *
     * @return ServiceManager
     */
    public function getServiceManager()
    {
        return $this->serviceManager;
    }

    /**
     * Set service manager
     *
     * @param ServiceManager $serviceManager
Bertrand Gauthier's avatar
Bertrand Gauthier committed
126
     * @return LdapDb
Bertrand Gauthier's avatar
Bertrand Gauthier committed
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
     */
    public function setServiceManager(ServiceManager $serviceManager)
    {
        $this->serviceManager = $serviceManager;
        return $this;
    }

    /**
     * get db Storage
     *
     * @return Db
     */
    public function getDbStorage()
    {
        return $this->dbStorage;
    }

    /**
     * set db Storage
     *
     * @param Db $storage
     * @access public
Bertrand Gauthier's avatar
Bertrand Gauthier committed
149
     * @return LdapDb
Bertrand Gauthier's avatar
Bertrand Gauthier committed
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
     */
    public function setDbStorage(Db $storage)
    {
        $this->dbStorage = $storage;
        return $this;
    }

    /**
     * get ldap Storage
     *
     * @return Ldap
     */
    public function getLdapStorage()
    {
        return $this->ldapStorage;
    }

    /**
     * set ldap Storage
     *
     * @param Ldap $storage
     * @access public
Bertrand Gauthier's avatar
Bertrand Gauthier committed
172
     * @return LdapDb
Bertrand Gauthier's avatar
Bertrand Gauthier committed
173
174
175
176
177
178
179
180
     */
    public function setLdapStorage(Ldap $storage)
    {
        $this->ldapStorage = $storage;
        return $this;
    }

    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
181
182
     * @param ModuleOptions $options
     * @return LdapDb
Bertrand Gauthier's avatar
Bertrand Gauthier committed
183
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
184
    public function setOptions(ModuleOptions $options)
Bertrand Gauthier's avatar
Bertrand Gauthier committed
185
186
    {
        $this->options = $options;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
187
        return $this;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
188
189
190
    }

    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
191
     * @return ModuleOptions
Bertrand Gauthier's avatar
Bertrand Gauthier committed
192
193
194
     */
    public function getOptions()
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
195
        if (null === $this->options) {
196
            $this->setOptions($this->getServiceManager()->get('unicaen-auth_module_options'));
Bertrand Gauthier's avatar
Bertrand Gauthier committed
197
198
199
        }
        return $this->options;
    }
200
}