LdapDb.php 4.4 KB
Newer Older
Bertrand Gauthier's avatar
Bertrand Gauthier committed
1
2
3
4
<?php

namespace UnicaenAuth\Authentication\Storage;

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

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

    /**
38
     * @var ModuleOptions
Bertrand Gauthier's avatar
Bertrand Gauthier committed
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
     */
    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()
    {
        if (!$this->getLdapStorage()->isEmpty()) {
            return false;
        }
        if (!$this->getDbStorage()->isEmpty()) {
            return false;
        }
        return true;
    }

    /**
     * Returns the contents of storage
     *
     * Behavior is undefined when storage is empty.
     *
     * @throws InvalidArgumentException If reading contents from storage is impossible
65
     * @return UserInterface
Bertrand Gauthier's avatar
Bertrand Gauthier committed
66
67
68
69
70
71
72
73
74
75
76
77
     */
    public function read()
    {
        $identity = null;
        $userId = null;
        if (($dbIdentity = $this->getDbStorage()->read())) {
            $userId = $dbIdentity->getId();
            $identity = $dbIdentity;
        }
        // moyen de savoir si l'utilisateur a été créé à partir de l'annuaire LDAP: mdp = 'ldap' dans la table
        if (!$dbIdentity || $dbIdentity->getPassword() == 'ldap') {
            $ldapIdentity = $this->getLdapStorage()->read();
78
79
80
            if ($ldapIdentity) {
                $identity = new PeopleAdapter($ldapIdentity->getData(), $userId);
            }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
81
82
83
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
        }
        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
124
     * @return LdapDb
Bertrand Gauthier's avatar
Bertrand Gauthier committed
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
     */
    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
147
     * @return LdapDb
Bertrand Gauthier's avatar
Bertrand Gauthier committed
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
     */
    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
170
     * @return LdapDb
Bertrand Gauthier's avatar
Bertrand Gauthier committed
171
172
173
174
175
176
177
178
     */
    public function setLdapStorage(Ldap $storage)
    {
        $this->ldapStorage = $storage;
        return $this;
    }

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

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