-
Notifications
You must be signed in to change notification settings - Fork 348
/
Auth.php
238 lines (218 loc) · 6.19 KB
/
Auth.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<?php
/**
* Authentication view helper
*
* PHP version 8
*
* Copyright (C) Villanova University 2010.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* @category VuFind
* @package View_Helpers
* @author Demian Katz <demian.katz@villanova.edu>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link https://vufind.org/wiki/development Wiki
*/
namespace VuFind\View\Helper\Root;
use LmcRbacMvc\Identity\IdentityInterface;
use VuFind\Db\Entity\UserEntityInterface;
use VuFind\Db\Table\DbTableAwareInterface;
use VuFind\Db\Table\DbTableAwareTrait;
use VuFind\Exception\ILS as ILSException;
/**
* Authentication view helper
*
* @category VuFind
* @package View_Helpers
* @author Demian Katz <demian.katz@villanova.edu>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link https://vufind.org/wiki/development Wiki
*/
class Auth extends \Laminas\View\Helper\AbstractHelper implements DbTableAwareInterface
{
use ClassBasedTemplateRendererTrait;
use DbTableAwareTrait;
/**
* Authentication manager
*
* @var \VuFind\Auth\Manager
*/
protected $manager;
/**
* ILS Authenticator
*
* @var \VuFind\Auth\ILSAuthenticator
*/
protected $ilsAuthenticator;
/**
* Constructor
*
* @param \VuFind\Auth\Manager $manager Authentication manager
* @param \VuFind\Auth\ILSAuthenticator $ilsAuthenticator ILS Authenticator
*/
public function __construct(
\VuFind\Auth\Manager $manager,
\VuFind\Auth\ILSAuthenticator $ilsAuthenticator
) {
$this->manager = $manager;
$this->ilsAuthenticator = $ilsAuthenticator;
}
/**
* Render a template within an auth module folder.
*
* @param string $name Template name to render
* @param array $context Context for rendering template
*
* @return string
*/
protected function renderTemplate($name, $context = [])
{
// Get the current auth module's class name
$className = $this->getManager()->getAuthClassForTemplateRendering();
$template = 'Auth/%s/' . $name;
$context['topClass'] = $this->getBriefClass($className);
return $this->renderClassTemplate($template, $className, $context);
}
/**
* Get manager
*
* @return \VuFind\Auth\Manager
*/
public function getManager()
{
return $this->manager;
}
/**
* Checks whether the user is logged in.
*
* @return \VuFind\Db\Row\User|bool Object if user is logged in, false
* otherwise.
*
* @deprecated Use getIdentity() or getUserObject() instead.
*/
public function isLoggedIn()
{
return $this->getManager()->isLoggedIn();
}
/**
* Checks whether the user is logged in.
*
* @return ?UserEntityInterface Object if user is logged in, null otherwise.
*/
public function getUserObject(): ?UserEntityInterface
{
return $this->getManager()->getUserObject();
}
/**
* Get the logged-in user's identity (null if not logged in)
*
* @return ?IdentityInterface
*/
public function getIdentity(): ?IdentityInterface
{
return $this->getManager()->getIdentity();
}
/**
* Render the create account form fields.
*
* @param array $context Context for rendering template
*
* @return string
*/
public function getCreateFields($context = [])
{
return $this->renderTemplate('create.phtml', $context);
}
/**
* Get ILS patron record for the currently logged-in user.
*
* @return array|bool Patron array if available, false otherwise.
*/
public function getILSPatron()
{
try {
return $this->ilsAuthenticator->storedCatalogLogin();
} catch (ILSException $e) {
return false;
}
}
/**
* Render the login form fields.
*
* @param array $context Context for rendering template
*
* @return string
*/
public function getLoginFields($context = [])
{
return $this->renderTemplate('loginfields.phtml', $context);
}
/**
* Render the login template.
*
* @param array $context Context for rendering template
*
* @return string
*/
public function getLogin($context = [])
{
return $this->renderTemplate('login.phtml', $context);
}
/**
* Render the login description template.
*
* @param array $context Context for rendering template
*
* @return string
*/
public function getLoginDesc($context = [])
{
return $this->renderTemplate('logindesc.phtml', $context);
}
/**
* Get login token data
*
* @param string $userId user identifier
*
* @return array
*/
public function getLoginTokens(string $userId): array
{
$tokenTable = $this->getDbTable('LoginToken');
return $tokenTable->getByUserId($userId);
}
/**
* Render the new password form template.
*
* @param array $context Context for rendering template
*
* @return string
*/
public function getNewPasswordForm($context = [])
{
return $this->renderTemplate('newpassword.phtml', $context);
}
/**
* Render the password recovery form template.
*
* @param array $context Context for rendering template
*
* @return string
*/
public function getPasswordRecoveryForm($context = [])
{
return $this->renderTemplate('recovery.phtml', $context);
}
}