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

namespace UnicaenAuth\Authentication\Storage;

5
use UnicaenApp\Entity\Ldap\People;
6
use UnicaenApp\Mapper\Ldap\People as LdapPeopleMapper;
7
use UnicaenAuth\Options\ModuleOptions;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
use Zend\Authentication\Exception\InvalidArgumentException;
use Zend\Authentication\Storage;
use Zend\Authentication\Storage\StorageInterface;
use Zend\ServiceManager\ServiceManager;
use Zend\ServiceManager\ServiceManagerAwareInterface;

/**
 * Ldap authentication storage.
 *
 * @author Bertrand GAUTHIER <bertrand.gauthier at unicaen.fr>
 */
class Ldap implements Storage\StorageInterface, ServiceManagerAwareInterface
{
    /**
     * @var StorageInterface
     */
    protected $storage;

    /**
27
     * @var LdapPeopleMapper
Bertrand Gauthier's avatar
Bertrand Gauthier committed
28
29
     */
    protected $mapper;
30
31
32
33
34
    
    /**
     * @var ModuleOptions
     */
    protected $options;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
35
36

    /**
37
     * @var People
Bertrand Gauthier's avatar
Bertrand Gauthier committed
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
     */
    protected $resolvedIdentity;

    /**
     * @var ServiceManager
     */
    protected $serviceManager;

    /**
     * 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()
    {
        return $this->getStorage()->isEmpty();
    }

    /**
     * Returns the contents of storage
     *
     * Behavior is undefined when storage is empty.
     *
     * @throws InvalidArgumentException If reading contents from storage is impossible
63
     * @return People
Bertrand Gauthier's avatar
Bertrand Gauthier committed
64
65
66
67
68
69
70
71
72
73
     */
    public function read()
    {
        if (null !== $this->resolvedIdentity) {
            return $this->resolvedIdentity;
        }

        $identity = $this->getStorage()->read();

        if (is_scalar($identity)) {
74
            $identity = $this->getMapper()->findOneByUsername($identity);
Bertrand Gauthier's avatar
Bertrand Gauthier committed
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
        }

        if ($identity) {
            $this->resolvedIdentity = $identity;
        } else {
            $this->resolvedIdentity = null;
        }

        return $this->resolvedIdentity;
    }

    /**
     * Writes $contents to storage
     *
     * @param  mixed $contents
     * @throws InvalidArgumentException If writing $contents to storage is impossible
     * @return void
     */
    public function write($contents)
    {
        $this->resolvedIdentity = null;
        $this->getStorage()->write($contents);
97
        return $this;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
98
99
100
101
102
103
104
105
106
107
108
109
    }

    /**
     * Clears contents from storage
     *
     * @throws InvalidArgumentException If clearing contents from storage is impossible
     * @return void
     */
    public function clear()
    {
        $this->resolvedIdentity = null;
        $this->getStorage()->clear();
110
        return $this;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
    }

    /**
     * getStorage
     *
     * @return Storage\StorageInterface
     */
    public function getStorage()
    {
        if (null === $this->storage) {
            $this->setStorage(new Storage\Session);
        }
        return $this->storage;
    }

    /**
     * setStorage
     *
     * @param Storage\StorageInterface $storage
     * @access public
     * @return Ldap
     */
    public function setStorage(Storage\StorageInterface $storage)
    {
        $this->storage = $storage;
        return $this;
    }

    /**
     * getMapper
     *
142
     * @return LdapPeopleMapper
Bertrand Gauthier's avatar
Bertrand Gauthier committed
143
144
145
146
     */
    public function getMapper()
    {
        if (null === $this->mapper) {
147
            $this->mapper = $this->getServiceManager()->get('ldap_people_mapper');
Bertrand Gauthier's avatar
Bertrand Gauthier committed
148
149
150
151
152
153
154
        }
        return $this->mapper;
    }

    /**
     * setMapper
     *
155
     * @param LdapPeopleMapper $mapper
Bertrand Gauthier's avatar
Bertrand Gauthier committed
156
157
     * @return Ldap
     */
158
    public function setMapper(LdapPeopleMapper $mapper)
Bertrand Gauthier's avatar
Bertrand Gauthier committed
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
    {
        $this->mapper = $mapper;
        return $this;
    }

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

    /**
     * Set service manager instance
     *
     * @param ServiceManager $locator
     * @return void
     */
    public function setServiceManager(ServiceManager $serviceManager)
    {
        $this->serviceManager = $serviceManager;
183
        return $this;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
184
185
186
    }

    /**
187
     * @param ModuleOptions $options
Bertrand Gauthier's avatar
Bertrand Gauthier committed
188
     */
189
    public function setOptions(ModuleOptions $options)
Bertrand Gauthier's avatar
Bertrand Gauthier committed
190
191
    {
        $this->options = $options;
192
        return $this;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
193
194
195
    }

    /**
196
     * @return ModuleOptions
Bertrand Gauthier's avatar
Bertrand Gauthier committed
197
198
199
     */
    public function getOptions()
    {
200
        if (!$this->options instanceof ModuleOptions) {
201
            $this->setOptions($this->getServiceManager()->get('unicaen-auth_module_options'));
Bertrand Gauthier's avatar
Bertrand Gauthier committed
202
203
204
205
        }
        return $this->options;
    }
}