@@ -14,68 +14,68 @@ |
||
14 | 14 | |
15 | 15 | abstract class JsonApiPageBase extends ApiPageBase implements IJsonApiAction |
16 | 16 | { |
17 | - /** |
|
18 | - * Main function for this page, when no specific actions are called. |
|
19 | - * |
|
20 | - * @return void |
|
21 | - * @throws ApiException |
|
22 | - */ |
|
23 | - final protected function main() |
|
24 | - { |
|
25 | - if (headers_sent()) { |
|
26 | - throw new ApiException('Headers have already been sent - this indicates a bug in the application!'); |
|
27 | - } |
|
17 | + /** |
|
18 | + * Main function for this page, when no specific actions are called. |
|
19 | + * |
|
20 | + * @return void |
|
21 | + * @throws ApiException |
|
22 | + */ |
|
23 | + final protected function main() |
|
24 | + { |
|
25 | + if (headers_sent()) { |
|
26 | + throw new ApiException('Headers have already been sent - this indicates a bug in the application!'); |
|
27 | + } |
|
28 | 28 | |
29 | - // javascript access control |
|
30 | - $httpOrigin = WebRequest::origin(); |
|
29 | + // javascript access control |
|
30 | + $httpOrigin = WebRequest::origin(); |
|
31 | 31 | |
32 | - if ($httpOrigin !== null) { |
|
33 | - $CORSallowed = $this->getSiteConfiguration()->getCrossOriginResourceSharingHosts(); |
|
32 | + if ($httpOrigin !== null) { |
|
33 | + $CORSallowed = $this->getSiteConfiguration()->getCrossOriginResourceSharingHosts(); |
|
34 | 34 | |
35 | - if (in_array($httpOrigin, $CORSallowed)) { |
|
36 | - header("Access-Control-Allow-Origin: " . $httpOrigin); |
|
37 | - } |
|
38 | - } |
|
35 | + if (in_array($httpOrigin, $CORSallowed)) { |
|
36 | + header("Access-Control-Allow-Origin: " . $httpOrigin); |
|
37 | + } |
|
38 | + } |
|
39 | 39 | |
40 | - $responseData = $this->runApiPage(); |
|
40 | + $responseData = $this->runApiPage(); |
|
41 | 41 | |
42 | - ob_end_clean(); |
|
43 | - print($responseData); |
|
44 | - ob_start(); |
|
45 | - } |
|
42 | + ob_end_clean(); |
|
43 | + print($responseData); |
|
44 | + ob_start(); |
|
45 | + } |
|
46 | 46 | |
47 | - /** |
|
48 | - * Method that runs API action |
|
49 | - * |
|
50 | - * @return object|array The modified API document |
|
51 | - */ |
|
52 | - public abstract function executeApiAction(); |
|
47 | + /** |
|
48 | + * Method that runs API action |
|
49 | + * |
|
50 | + * @return object|array The modified API document |
|
51 | + */ |
|
52 | + public abstract function executeApiAction(); |
|
53 | 53 | |
54 | - /** |
|
55 | - * @return string |
|
56 | - */ |
|
57 | - final public function runApiPage() |
|
58 | - { |
|
54 | + /** |
|
55 | + * @return string |
|
56 | + */ |
|
57 | + final public function runApiPage() |
|
58 | + { |
|
59 | 59 | |
60 | - try { |
|
61 | - $apiDocument = $this->executeApiAction(); |
|
62 | - } |
|
63 | - catch (ApiException $ex) { |
|
64 | - $apiDocument = [ |
|
65 | - 'error' => $ex->getMessage(), |
|
66 | - ]; |
|
67 | - } |
|
60 | + try { |
|
61 | + $apiDocument = $this->executeApiAction(); |
|
62 | + } |
|
63 | + catch (ApiException $ex) { |
|
64 | + $apiDocument = [ |
|
65 | + 'error' => $ex->getMessage(), |
|
66 | + ]; |
|
67 | + } |
|
68 | 68 | |
69 | - $data = json_encode($apiDocument, JSON_UNESCAPED_UNICODE); |
|
69 | + $data = json_encode($apiDocument, JSON_UNESCAPED_UNICODE); |
|
70 | 70 | |
71 | - $targetVar = WebRequest::getString('targetVariable'); |
|
72 | - if ($targetVar !== null && preg_match('/^[a-z]+$/', $targetVar)) { |
|
73 | - $data = $targetVar . ' = ' . $data . ';'; |
|
74 | - header("Content-Type: text/javascript"); |
|
75 | - } else { |
|
76 | - header("Content-Type: application/json"); |
|
77 | - } |
|
71 | + $targetVar = WebRequest::getString('targetVariable'); |
|
72 | + if ($targetVar !== null && preg_match('/^[a-z]+$/', $targetVar)) { |
|
73 | + $data = $targetVar . ' = ' . $data . ';'; |
|
74 | + header("Content-Type: text/javascript"); |
|
75 | + } else { |
|
76 | + header("Content-Type: application/json"); |
|
77 | + } |
|
78 | 78 | |
79 | - return $data; |
|
80 | - } |
|
79 | + return $data; |
|
80 | + } |
|
81 | 81 | } |
@@ -33,7 +33,7 @@ discard block |
||
33 | 33 | $CORSallowed = $this->getSiteConfiguration()->getCrossOriginResourceSharingHosts(); |
34 | 34 | |
35 | 35 | if (in_array($httpOrigin, $CORSallowed)) { |
36 | - header("Access-Control-Allow-Origin: " . $httpOrigin); |
|
36 | + header("Access-Control-Allow-Origin: ".$httpOrigin); |
|
37 | 37 | } |
38 | 38 | } |
39 | 39 | |
@@ -70,7 +70,7 @@ discard block |
||
70 | 70 | |
71 | 71 | $targetVar = WebRequest::getString('targetVariable'); |
72 | 72 | if ($targetVar !== null && preg_match('/^[a-z]+$/', $targetVar)) { |
73 | - $data = $targetVar . ' = ' . $data . ';'; |
|
73 | + $data = $targetVar.' = '.$data.';'; |
|
74 | 74 | header("Content-Type: text/javascript"); |
75 | 75 | } else { |
76 | 76 | header("Content-Type: application/json"); |
@@ -72,7 +72,8 @@ |
||
72 | 72 | if ($targetVar !== null && preg_match('/^[a-z]+$/', $targetVar)) { |
73 | 73 | $data = $targetVar . ' = ' . $data . ';'; |
74 | 74 | header("Content-Type: text/javascript"); |
75 | - } else { |
|
75 | + } |
|
76 | + else { |
|
76 | 77 | header("Content-Type: application/json"); |
77 | 78 | } |
78 | 79 |
@@ -14,20 +14,20 @@ discard block |
||
14 | 14 | |
15 | 15 | class PageU2FLogin extends LoginCredentialPageBase |
16 | 16 | { |
17 | - protected function providerSpecificSetup() |
|
18 | - { |
|
19 | - $this->assign('showSignIn', false); |
|
20 | - $this->setTemplate('login/u2f.tpl'); |
|
17 | + protected function providerSpecificSetup() |
|
18 | + { |
|
19 | + $this->assign('showSignIn', false); |
|
20 | + $this->setTemplate('login/u2f.tpl'); |
|
21 | 21 | |
22 | - if ($this->partialUser === null) { |
|
23 | - throw new ApplicationLogicException("U2F cannot be first-stage authentication"); |
|
24 | - } |
|
22 | + if ($this->partialUser === null) { |
|
23 | + throw new ApplicationLogicException("U2F cannot be first-stage authentication"); |
|
24 | + } |
|
25 | 25 | |
26 | - $u2f = new U2FCredentialProvider($this->getDatabase(), $this->getSiteConfiguration()); |
|
27 | - $authData = json_encode($u2f->getAuthenticationData($this->partialUser)); |
|
26 | + $u2f = new U2FCredentialProvider($this->getDatabase(), $this->getSiteConfiguration()); |
|
27 | + $authData = json_encode($u2f->getAuthenticationData($this->partialUser)); |
|
28 | 28 | |
29 | - $this->addJs('/vendor/yubico/u2flib-server/examples/assets/u2f-api.js'); |
|
30 | - $this->setTailScript($this->getCspManager()->getNonce(), <<<JS |
|
29 | + $this->addJs('/vendor/yubico/u2flib-server/examples/assets/u2f-api.js'); |
|
30 | + $this->setTailScript($this->getCspManager()->getNonce(), <<<JS |
|
31 | 31 | var request = {$authData}; |
32 | 32 | u2f.sign(request, function(data) { |
33 | 33 | document.getElementById('authenticate').value=JSON.stringify(data); |
@@ -35,19 +35,19 @@ discard block |
||
35 | 35 | document.getElementById('loginForm').submit(); |
36 | 36 | }); |
37 | 37 | JS |
38 | - ); |
|
38 | + ); |
|
39 | 39 | |
40 | - } |
|
40 | + } |
|
41 | 41 | |
42 | - protected function getProviderCredentials() |
|
43 | - { |
|
44 | - $authenticate = WebRequest::postString("authenticate"); |
|
45 | - $request = WebRequest::postString("request"); |
|
42 | + protected function getProviderCredentials() |
|
43 | + { |
|
44 | + $authenticate = WebRequest::postString("authenticate"); |
|
45 | + $request = WebRequest::postString("request"); |
|
46 | 46 | |
47 | - if ($authenticate === null || $authenticate === "" || $request === null || $request === "") { |
|
48 | - throw new ApplicationLogicException("No authentication specified"); |
|
49 | - } |
|
47 | + if ($authenticate === null || $authenticate === "" || $request === null || $request === "") { |
|
48 | + throw new ApplicationLogicException("No authentication specified"); |
|
49 | + } |
|
50 | 50 | |
51 | - return array(json_decode($authenticate), json_decode($request), 'u2f'); |
|
52 | - } |
|
51 | + return array(json_decode($authenticate), json_decode($request), 'u2f'); |
|
52 | + } |
|
53 | 53 | } |
@@ -249,7 +249,7 @@ discard block |
||
249 | 249 | $targetScriptName = $currentScriptName; |
250 | 250 | } |
251 | 251 | else { |
252 | - $targetScriptName = $this->getSiteConfiguration()->getBaseUrl() . '/' . $script; |
|
252 | + $targetScriptName = $this->getSiteConfiguration()->getBaseUrl().'/'.$script; |
|
253 | 253 | } |
254 | 254 | |
255 | 255 | $pathInfo = array($targetScriptName); |
@@ -263,7 +263,7 @@ discard block |
||
263 | 263 | $url = implode('/', $pathInfo); |
264 | 264 | |
265 | 265 | if (is_array($parameters) && count($parameters) > 0) { |
266 | - $url .= '?' . http_build_query($parameters); |
|
266 | + $url .= '?'.http_build_query($parameters); |
|
267 | 267 | } |
268 | 268 | |
269 | 269 | $this->redirectUrl($url); |
@@ -307,8 +307,8 @@ discard block |
||
307 | 307 | * |
308 | 308 | * @param string $path The path (relative to the application root) of the file |
309 | 309 | */ |
310 | - final protected function addJs($path){ |
|
311 | - if(in_array($path, $this->extraJs)){ |
|
310 | + final protected function addJs($path) { |
|
311 | + if (in_array($path, $this->extraJs)) { |
|
312 | 312 | // nothing to do |
313 | 313 | return; |
314 | 314 | } |
@@ -331,7 +331,7 @@ discard block |
||
331 | 331 | */ |
332 | 332 | final protected function setHtmlTitle($title) |
333 | 333 | { |
334 | - $this->htmlTitle = $this->smarty->fetch('string:' . $title); |
|
334 | + $this->htmlTitle = $this->smarty->fetch('string:'.$title); |
|
335 | 335 | } |
336 | 336 | |
337 | 337 | public function execute() |
@@ -307,8 +307,9 @@ |
||
307 | 307 | * |
308 | 308 | * @param string $path The path (relative to the application root) of the file |
309 | 309 | */ |
310 | - final protected function addJs($path){ |
|
311 | - if(in_array($path, $this->extraJs)){ |
|
310 | + final protected function addJs($path) |
|
311 | + { |
|
312 | + if(in_array($path, $this->extraJs)) { |
|
312 | 313 | // nothing to do |
313 | 314 | return; |
314 | 315 | } |
@@ -23,357 +23,357 @@ |
||
23 | 23 | |
24 | 24 | abstract class PageBase extends TaskBase implements IRoutedTask |
25 | 25 | { |
26 | - use TemplateOutput; |
|
27 | - /** @var string Smarty template to display */ |
|
28 | - protected $template = "base.tpl"; |
|
29 | - /** @var string HTML title. Currently unused. */ |
|
30 | - protected $htmlTitle; |
|
31 | - /** @var bool Determines if the page is a redirect or not */ |
|
32 | - protected $isRedirecting = false; |
|
33 | - /** @var array Queue of headers to be sent on successful completion */ |
|
34 | - protected $headerQueue = array(); |
|
35 | - /** @var string The name of the route to use, as determined by the request router. */ |
|
36 | - private $routeName = null; |
|
37 | - /** @var TokenManager */ |
|
38 | - protected $tokenManager; |
|
39 | - /** @var ContentSecurityPolicyManager */ |
|
40 | - private $cspManager; |
|
41 | - /** @var string[] Extra JS files to include */ |
|
42 | - private $extraJs = array(); |
|
43 | - |
|
44 | - /** |
|
45 | - * Sets the route the request will take. Only should be called from the request router or barrier test. |
|
46 | - * |
|
47 | - * @param string $routeName The name of the route |
|
48 | - * @param bool $skipCallableTest Don't use this unless you know what you're doing, and what the implications are. |
|
49 | - * |
|
50 | - * @throws Exception |
|
51 | - * @category Security-Critical |
|
52 | - */ |
|
53 | - final public function setRoute($routeName, $skipCallableTest = false) |
|
54 | - { |
|
55 | - // Test the new route is callable before adopting it. |
|
56 | - if (!$skipCallableTest && !is_callable(array($this, $routeName))) { |
|
57 | - throw new Exception("Proposed route '$routeName' is not callable."); |
|
58 | - } |
|
59 | - |
|
60 | - // Adopt the new route |
|
61 | - $this->routeName = $routeName; |
|
62 | - } |
|
63 | - |
|
64 | - /** |
|
65 | - * Gets the name of the route that has been passed from the request router. |
|
66 | - * @return string |
|
67 | - */ |
|
68 | - final public function getRouteName() |
|
69 | - { |
|
70 | - return $this->routeName; |
|
71 | - } |
|
72 | - |
|
73 | - /** |
|
74 | - * Performs generic page setup actions |
|
75 | - */ |
|
76 | - final protected function setupPage() |
|
77 | - { |
|
78 | - $this->setUpSmarty(); |
|
79 | - |
|
80 | - $currentUser = User::getCurrent($this->getDatabase()); |
|
81 | - $this->assign('currentUser', $currentUser); |
|
82 | - $this->assign('loggedIn', (!$currentUser->isCommunityUser())); |
|
83 | - } |
|
84 | - |
|
85 | - /** |
|
86 | - * Runs the page logic as routed by the RequestRouter |
|
87 | - * |
|
88 | - * Only should be called after a security barrier! That means only from execute(). |
|
89 | - */ |
|
90 | - final protected function runPage() |
|
91 | - { |
|
92 | - $database = $this->getDatabase(); |
|
93 | - |
|
94 | - // initialise a database transaction |
|
95 | - if (!$database->beginTransaction()) { |
|
96 | - throw new Exception('Failed to start transaction on primary database.'); |
|
97 | - } |
|
98 | - |
|
99 | - try { |
|
100 | - // run the page code |
|
101 | - $this->{$this->getRouteName()}(); |
|
102 | - |
|
103 | - $database->commit(); |
|
104 | - } |
|
105 | - catch (ApplicationLogicException $ex) { |
|
106 | - // it's an application logic exception, so nothing went seriously wrong with the site. We can use the |
|
107 | - // standard templating system for this. |
|
108 | - |
|
109 | - // Firstly, let's undo anything that happened to the database. |
|
110 | - $database->rollBack(); |
|
111 | - |
|
112 | - // Reset smarty |
|
113 | - $this->setupPage(); |
|
114 | - |
|
115 | - // Set the template |
|
116 | - $this->setTemplate('exception/application-logic.tpl'); |
|
117 | - $this->assign('message', $ex->getMessage()); |
|
118 | - |
|
119 | - // Force this back to false |
|
120 | - $this->isRedirecting = false; |
|
121 | - $this->headerQueue = array(); |
|
122 | - } |
|
123 | - catch (OptimisticLockFailedException $ex) { |
|
124 | - // it's an optimistic lock failure exception, so nothing went seriously wrong with the site. We can use the |
|
125 | - // standard templating system for this. |
|
126 | - |
|
127 | - // Firstly, let's undo anything that happened to the database. |
|
128 | - $database->rollBack(); |
|
129 | - |
|
130 | - // Reset smarty |
|
131 | - $this->setupPage(); |
|
132 | - |
|
133 | - // Set the template |
|
134 | - $this->setTemplate('exception/optimistic-lock-failure.tpl'); |
|
135 | - $this->assign('message', $ex->getMessage()); |
|
136 | - |
|
137 | - $this->assign('debugTrace', false); |
|
138 | - |
|
139 | - if ($this->getSiteConfiguration()->getDebuggingTraceEnabled()) { |
|
140 | - ob_start(); |
|
141 | - var_dump(ExceptionHandler::getExceptionData($ex)); |
|
142 | - $textErrorData = ob_get_contents(); |
|
143 | - ob_end_clean(); |
|
144 | - |
|
145 | - $this->assign('exceptionData', $textErrorData); |
|
146 | - $this->assign('debugTrace', true); |
|
147 | - } |
|
148 | - |
|
149 | - // Force this back to false |
|
150 | - $this->isRedirecting = false; |
|
151 | - $this->headerQueue = array(); |
|
152 | - } |
|
153 | - finally { |
|
154 | - // Catch any hanging on transactions |
|
155 | - if ($database->hasActiveTransaction()) { |
|
156 | - $database->rollBack(); |
|
157 | - } |
|
158 | - } |
|
159 | - |
|
160 | - // run any finalisation code needed before we send the output to the browser. |
|
161 | - $this->finalisePage(); |
|
162 | - |
|
163 | - // Send the headers |
|
164 | - $this->sendResponseHeaders(); |
|
165 | - |
|
166 | - // Check we have a template to use! |
|
167 | - if ($this->template !== null) { |
|
168 | - $content = $this->fetchTemplate($this->template); |
|
169 | - ob_clean(); |
|
170 | - print($content); |
|
171 | - ob_flush(); |
|
172 | - |
|
173 | - return; |
|
174 | - } |
|
175 | - } |
|
176 | - |
|
177 | - /** |
|
178 | - * Performs final tasks needed before rendering the page. |
|
179 | - */ |
|
180 | - protected function finalisePage() |
|
181 | - { |
|
182 | - if ($this->isRedirecting) { |
|
183 | - $this->template = null; |
|
184 | - |
|
185 | - return; |
|
186 | - } |
|
187 | - |
|
188 | - $this->assign('extraJs', $this->extraJs); |
|
189 | - |
|
190 | - // If we're actually displaying content, we want to add the session alerts here! |
|
191 | - $this->assign('alerts', SessionAlert::getAlerts()); |
|
192 | - SessionAlert::clearAlerts(); |
|
193 | - |
|
194 | - $this->assign('htmlTitle', $this->htmlTitle); |
|
195 | - } |
|
196 | - |
|
197 | - /** |
|
198 | - * @return TokenManager |
|
199 | - */ |
|
200 | - public function getTokenManager() |
|
201 | - { |
|
202 | - return $this->tokenManager; |
|
203 | - } |
|
204 | - |
|
205 | - /** |
|
206 | - * @param TokenManager $tokenManager |
|
207 | - */ |
|
208 | - public function setTokenManager($tokenManager) |
|
209 | - { |
|
210 | - $this->tokenManager = $tokenManager; |
|
211 | - } |
|
212 | - |
|
213 | - /** |
|
214 | - * @return ContentSecurityPolicyManager |
|
215 | - */ |
|
216 | - public function getCspManager(): ContentSecurityPolicyManager |
|
217 | - { |
|
218 | - return $this->cspManager; |
|
219 | - } |
|
220 | - |
|
221 | - /** |
|
222 | - * @param ContentSecurityPolicyManager $cspManager |
|
223 | - */ |
|
224 | - public function setCspManager(ContentSecurityPolicyManager $cspManager): void |
|
225 | - { |
|
226 | - $this->cspManager = $cspManager; |
|
227 | - } |
|
228 | - |
|
229 | - /** |
|
230 | - * Sends the redirect headers to perform a GET at the destination page. |
|
231 | - * |
|
232 | - * Also nullifies the set template so Smarty does not render it. |
|
233 | - * |
|
234 | - * @param string $page The page to redirect requests to (as used in the UR) |
|
235 | - * @param null|string $action The action to use on the page. |
|
236 | - * @param null|array $parameters |
|
237 | - * @param null|string $script The script (relative to index.php) to redirect to |
|
238 | - */ |
|
239 | - final protected function redirect($page = '', $action = null, $parameters = null, $script = null) |
|
240 | - { |
|
241 | - $currentScriptName = WebRequest::scriptName(); |
|
242 | - |
|
243 | - // Are we changing script? |
|
244 | - if ($script === null || substr($currentScriptName, -1 * count($script)) === $script) { |
|
245 | - $targetScriptName = $currentScriptName; |
|
246 | - } |
|
247 | - else { |
|
248 | - $targetScriptName = $this->getSiteConfiguration()->getBaseUrl() . '/' . $script; |
|
249 | - } |
|
250 | - |
|
251 | - $pathInfo = array($targetScriptName); |
|
252 | - |
|
253 | - $pathInfo[1] = $page; |
|
254 | - |
|
255 | - if ($action !== null) { |
|
256 | - $pathInfo[2] = $action; |
|
257 | - } |
|
258 | - |
|
259 | - $url = implode('/', $pathInfo); |
|
260 | - |
|
261 | - if (is_array($parameters) && count($parameters) > 0) { |
|
262 | - $url .= '?' . http_build_query($parameters); |
|
263 | - } |
|
264 | - |
|
265 | - $this->redirectUrl($url); |
|
266 | - } |
|
267 | - |
|
268 | - /** |
|
269 | - * Sends the redirect headers to perform a GET at the new address. |
|
270 | - * |
|
271 | - * Also nullifies the set template so Smarty does not render it. |
|
272 | - * |
|
273 | - * @param string $path URL to redirect to |
|
274 | - */ |
|
275 | - final protected function redirectUrl($path) |
|
276 | - { |
|
277 | - // 303 See Other = re-request at new address with a GET. |
|
278 | - $this->headerQueue[] = 'HTTP/1.1 303 See Other'; |
|
279 | - $this->headerQueue[] = "Location: $path"; |
|
280 | - |
|
281 | - $this->setTemplate(null); |
|
282 | - $this->isRedirecting = true; |
|
283 | - } |
|
284 | - |
|
285 | - /** |
|
286 | - * Sets the name of the template this page should display. |
|
287 | - * |
|
288 | - * @param string $name |
|
289 | - * |
|
290 | - * @throws Exception |
|
291 | - */ |
|
292 | - final protected function setTemplate($name) |
|
293 | - { |
|
294 | - if ($this->isRedirecting) { |
|
295 | - throw new Exception('This page has been set as a redirect, no template can be displayed!'); |
|
296 | - } |
|
297 | - |
|
298 | - $this->template = $name; |
|
299 | - } |
|
300 | - |
|
301 | - /** |
|
302 | - * Adds an extra JS file to to the page |
|
303 | - * |
|
304 | - * @param string $path The path (relative to the application root) of the file |
|
305 | - */ |
|
306 | - final protected function addJs($path){ |
|
307 | - if(in_array($path, $this->extraJs)){ |
|
308 | - // nothing to do |
|
309 | - return; |
|
310 | - } |
|
311 | - |
|
312 | - $this->extraJs[] = $path; |
|
313 | - } |
|
314 | - |
|
315 | - /** |
|
316 | - * Main function for this page, when no specific actions are called. |
|
317 | - * @return void |
|
318 | - */ |
|
319 | - abstract protected function main(); |
|
320 | - |
|
321 | - /** |
|
322 | - * Takes a smarty template string and sets the HTML title to that value |
|
323 | - * |
|
324 | - * @param string $title |
|
325 | - * |
|
326 | - * @throws SmartyException |
|
327 | - */ |
|
328 | - final protected function setHtmlTitle($title) |
|
329 | - { |
|
330 | - $this->htmlTitle = $this->smarty->fetch('string:' . $title); |
|
331 | - } |
|
332 | - |
|
333 | - public function execute() |
|
334 | - { |
|
335 | - if ($this->getRouteName() === null) { |
|
336 | - throw new Exception('Request is unrouted.'); |
|
337 | - } |
|
338 | - |
|
339 | - if ($this->getSiteConfiguration() === null) { |
|
340 | - throw new Exception('Page has no configuration!'); |
|
341 | - } |
|
342 | - |
|
343 | - $this->setupPage(); |
|
344 | - |
|
345 | - $this->runPage(); |
|
346 | - } |
|
347 | - |
|
348 | - public function assignCSRFToken() |
|
349 | - { |
|
350 | - $token = $this->tokenManager->getNewToken(); |
|
351 | - $this->assign('csrfTokenData', $token->getTokenData()); |
|
352 | - } |
|
353 | - |
|
354 | - public function validateCSRFToken() |
|
355 | - { |
|
356 | - if (!$this->tokenManager->validateToken(WebRequest::postString('csrfTokenData'))) { |
|
357 | - throw new ApplicationLogicException('Form token is not valid, please reload and try again'); |
|
358 | - } |
|
359 | - } |
|
360 | - |
|
361 | - protected function sendResponseHeaders() |
|
362 | - { |
|
363 | - if (headers_sent()) { |
|
364 | - throw new ApplicationLogicException('Headers have already been sent! This is likely a bug in the application.'); |
|
365 | - } |
|
366 | - |
|
367 | - // send the CSP headers now |
|
368 | - header($this->getCspManager()->getHeader()); |
|
369 | - |
|
370 | - foreach ($this->headerQueue as $item) { |
|
371 | - if (mb_strpos($item, "\r") !== false || mb_strpos($item, "\n") !== false) { |
|
372 | - // Oops. We're not allowed to do this. |
|
373 | - throw new Exception('Unable to split header'); |
|
374 | - } |
|
375 | - |
|
376 | - header($item); |
|
377 | - } |
|
378 | - } |
|
26 | + use TemplateOutput; |
|
27 | + /** @var string Smarty template to display */ |
|
28 | + protected $template = "base.tpl"; |
|
29 | + /** @var string HTML title. Currently unused. */ |
|
30 | + protected $htmlTitle; |
|
31 | + /** @var bool Determines if the page is a redirect or not */ |
|
32 | + protected $isRedirecting = false; |
|
33 | + /** @var array Queue of headers to be sent on successful completion */ |
|
34 | + protected $headerQueue = array(); |
|
35 | + /** @var string The name of the route to use, as determined by the request router. */ |
|
36 | + private $routeName = null; |
|
37 | + /** @var TokenManager */ |
|
38 | + protected $tokenManager; |
|
39 | + /** @var ContentSecurityPolicyManager */ |
|
40 | + private $cspManager; |
|
41 | + /** @var string[] Extra JS files to include */ |
|
42 | + private $extraJs = array(); |
|
43 | + |
|
44 | + /** |
|
45 | + * Sets the route the request will take. Only should be called from the request router or barrier test. |
|
46 | + * |
|
47 | + * @param string $routeName The name of the route |
|
48 | + * @param bool $skipCallableTest Don't use this unless you know what you're doing, and what the implications are. |
|
49 | + * |
|
50 | + * @throws Exception |
|
51 | + * @category Security-Critical |
|
52 | + */ |
|
53 | + final public function setRoute($routeName, $skipCallableTest = false) |
|
54 | + { |
|
55 | + // Test the new route is callable before adopting it. |
|
56 | + if (!$skipCallableTest && !is_callable(array($this, $routeName))) { |
|
57 | + throw new Exception("Proposed route '$routeName' is not callable."); |
|
58 | + } |
|
59 | + |
|
60 | + // Adopt the new route |
|
61 | + $this->routeName = $routeName; |
|
62 | + } |
|
63 | + |
|
64 | + /** |
|
65 | + * Gets the name of the route that has been passed from the request router. |
|
66 | + * @return string |
|
67 | + */ |
|
68 | + final public function getRouteName() |
|
69 | + { |
|
70 | + return $this->routeName; |
|
71 | + } |
|
72 | + |
|
73 | + /** |
|
74 | + * Performs generic page setup actions |
|
75 | + */ |
|
76 | + final protected function setupPage() |
|
77 | + { |
|
78 | + $this->setUpSmarty(); |
|
79 | + |
|
80 | + $currentUser = User::getCurrent($this->getDatabase()); |
|
81 | + $this->assign('currentUser', $currentUser); |
|
82 | + $this->assign('loggedIn', (!$currentUser->isCommunityUser())); |
|
83 | + } |
|
84 | + |
|
85 | + /** |
|
86 | + * Runs the page logic as routed by the RequestRouter |
|
87 | + * |
|
88 | + * Only should be called after a security barrier! That means only from execute(). |
|
89 | + */ |
|
90 | + final protected function runPage() |
|
91 | + { |
|
92 | + $database = $this->getDatabase(); |
|
93 | + |
|
94 | + // initialise a database transaction |
|
95 | + if (!$database->beginTransaction()) { |
|
96 | + throw new Exception('Failed to start transaction on primary database.'); |
|
97 | + } |
|
98 | + |
|
99 | + try { |
|
100 | + // run the page code |
|
101 | + $this->{$this->getRouteName()}(); |
|
102 | + |
|
103 | + $database->commit(); |
|
104 | + } |
|
105 | + catch (ApplicationLogicException $ex) { |
|
106 | + // it's an application logic exception, so nothing went seriously wrong with the site. We can use the |
|
107 | + // standard templating system for this. |
|
108 | + |
|
109 | + // Firstly, let's undo anything that happened to the database. |
|
110 | + $database->rollBack(); |
|
111 | + |
|
112 | + // Reset smarty |
|
113 | + $this->setupPage(); |
|
114 | + |
|
115 | + // Set the template |
|
116 | + $this->setTemplate('exception/application-logic.tpl'); |
|
117 | + $this->assign('message', $ex->getMessage()); |
|
118 | + |
|
119 | + // Force this back to false |
|
120 | + $this->isRedirecting = false; |
|
121 | + $this->headerQueue = array(); |
|
122 | + } |
|
123 | + catch (OptimisticLockFailedException $ex) { |
|
124 | + // it's an optimistic lock failure exception, so nothing went seriously wrong with the site. We can use the |
|
125 | + // standard templating system for this. |
|
126 | + |
|
127 | + // Firstly, let's undo anything that happened to the database. |
|
128 | + $database->rollBack(); |
|
129 | + |
|
130 | + // Reset smarty |
|
131 | + $this->setupPage(); |
|
132 | + |
|
133 | + // Set the template |
|
134 | + $this->setTemplate('exception/optimistic-lock-failure.tpl'); |
|
135 | + $this->assign('message', $ex->getMessage()); |
|
136 | + |
|
137 | + $this->assign('debugTrace', false); |
|
138 | + |
|
139 | + if ($this->getSiteConfiguration()->getDebuggingTraceEnabled()) { |
|
140 | + ob_start(); |
|
141 | + var_dump(ExceptionHandler::getExceptionData($ex)); |
|
142 | + $textErrorData = ob_get_contents(); |
|
143 | + ob_end_clean(); |
|
144 | + |
|
145 | + $this->assign('exceptionData', $textErrorData); |
|
146 | + $this->assign('debugTrace', true); |
|
147 | + } |
|
148 | + |
|
149 | + // Force this back to false |
|
150 | + $this->isRedirecting = false; |
|
151 | + $this->headerQueue = array(); |
|
152 | + } |
|
153 | + finally { |
|
154 | + // Catch any hanging on transactions |
|
155 | + if ($database->hasActiveTransaction()) { |
|
156 | + $database->rollBack(); |
|
157 | + } |
|
158 | + } |
|
159 | + |
|
160 | + // run any finalisation code needed before we send the output to the browser. |
|
161 | + $this->finalisePage(); |
|
162 | + |
|
163 | + // Send the headers |
|
164 | + $this->sendResponseHeaders(); |
|
165 | + |
|
166 | + // Check we have a template to use! |
|
167 | + if ($this->template !== null) { |
|
168 | + $content = $this->fetchTemplate($this->template); |
|
169 | + ob_clean(); |
|
170 | + print($content); |
|
171 | + ob_flush(); |
|
172 | + |
|
173 | + return; |
|
174 | + } |
|
175 | + } |
|
176 | + |
|
177 | + /** |
|
178 | + * Performs final tasks needed before rendering the page. |
|
179 | + */ |
|
180 | + protected function finalisePage() |
|
181 | + { |
|
182 | + if ($this->isRedirecting) { |
|
183 | + $this->template = null; |
|
184 | + |
|
185 | + return; |
|
186 | + } |
|
187 | + |
|
188 | + $this->assign('extraJs', $this->extraJs); |
|
189 | + |
|
190 | + // If we're actually displaying content, we want to add the session alerts here! |
|
191 | + $this->assign('alerts', SessionAlert::getAlerts()); |
|
192 | + SessionAlert::clearAlerts(); |
|
193 | + |
|
194 | + $this->assign('htmlTitle', $this->htmlTitle); |
|
195 | + } |
|
196 | + |
|
197 | + /** |
|
198 | + * @return TokenManager |
|
199 | + */ |
|
200 | + public function getTokenManager() |
|
201 | + { |
|
202 | + return $this->tokenManager; |
|
203 | + } |
|
204 | + |
|
205 | + /** |
|
206 | + * @param TokenManager $tokenManager |
|
207 | + */ |
|
208 | + public function setTokenManager($tokenManager) |
|
209 | + { |
|
210 | + $this->tokenManager = $tokenManager; |
|
211 | + } |
|
212 | + |
|
213 | + /** |
|
214 | + * @return ContentSecurityPolicyManager |
|
215 | + */ |
|
216 | + public function getCspManager(): ContentSecurityPolicyManager |
|
217 | + { |
|
218 | + return $this->cspManager; |
|
219 | + } |
|
220 | + |
|
221 | + /** |
|
222 | + * @param ContentSecurityPolicyManager $cspManager |
|
223 | + */ |
|
224 | + public function setCspManager(ContentSecurityPolicyManager $cspManager): void |
|
225 | + { |
|
226 | + $this->cspManager = $cspManager; |
|
227 | + } |
|
228 | + |
|
229 | + /** |
|
230 | + * Sends the redirect headers to perform a GET at the destination page. |
|
231 | + * |
|
232 | + * Also nullifies the set template so Smarty does not render it. |
|
233 | + * |
|
234 | + * @param string $page The page to redirect requests to (as used in the UR) |
|
235 | + * @param null|string $action The action to use on the page. |
|
236 | + * @param null|array $parameters |
|
237 | + * @param null|string $script The script (relative to index.php) to redirect to |
|
238 | + */ |
|
239 | + final protected function redirect($page = '', $action = null, $parameters = null, $script = null) |
|
240 | + { |
|
241 | + $currentScriptName = WebRequest::scriptName(); |
|
242 | + |
|
243 | + // Are we changing script? |
|
244 | + if ($script === null || substr($currentScriptName, -1 * count($script)) === $script) { |
|
245 | + $targetScriptName = $currentScriptName; |
|
246 | + } |
|
247 | + else { |
|
248 | + $targetScriptName = $this->getSiteConfiguration()->getBaseUrl() . '/' . $script; |
|
249 | + } |
|
250 | + |
|
251 | + $pathInfo = array($targetScriptName); |
|
252 | + |
|
253 | + $pathInfo[1] = $page; |
|
254 | + |
|
255 | + if ($action !== null) { |
|
256 | + $pathInfo[2] = $action; |
|
257 | + } |
|
258 | + |
|
259 | + $url = implode('/', $pathInfo); |
|
260 | + |
|
261 | + if (is_array($parameters) && count($parameters) > 0) { |
|
262 | + $url .= '?' . http_build_query($parameters); |
|
263 | + } |
|
264 | + |
|
265 | + $this->redirectUrl($url); |
|
266 | + } |
|
267 | + |
|
268 | + /** |
|
269 | + * Sends the redirect headers to perform a GET at the new address. |
|
270 | + * |
|
271 | + * Also nullifies the set template so Smarty does not render it. |
|
272 | + * |
|
273 | + * @param string $path URL to redirect to |
|
274 | + */ |
|
275 | + final protected function redirectUrl($path) |
|
276 | + { |
|
277 | + // 303 See Other = re-request at new address with a GET. |
|
278 | + $this->headerQueue[] = 'HTTP/1.1 303 See Other'; |
|
279 | + $this->headerQueue[] = "Location: $path"; |
|
280 | + |
|
281 | + $this->setTemplate(null); |
|
282 | + $this->isRedirecting = true; |
|
283 | + } |
|
284 | + |
|
285 | + /** |
|
286 | + * Sets the name of the template this page should display. |
|
287 | + * |
|
288 | + * @param string $name |
|
289 | + * |
|
290 | + * @throws Exception |
|
291 | + */ |
|
292 | + final protected function setTemplate($name) |
|
293 | + { |
|
294 | + if ($this->isRedirecting) { |
|
295 | + throw new Exception('This page has been set as a redirect, no template can be displayed!'); |
|
296 | + } |
|
297 | + |
|
298 | + $this->template = $name; |
|
299 | + } |
|
300 | + |
|
301 | + /** |
|
302 | + * Adds an extra JS file to to the page |
|
303 | + * |
|
304 | + * @param string $path The path (relative to the application root) of the file |
|
305 | + */ |
|
306 | + final protected function addJs($path){ |
|
307 | + if(in_array($path, $this->extraJs)){ |
|
308 | + // nothing to do |
|
309 | + return; |
|
310 | + } |
|
311 | + |
|
312 | + $this->extraJs[] = $path; |
|
313 | + } |
|
314 | + |
|
315 | + /** |
|
316 | + * Main function for this page, when no specific actions are called. |
|
317 | + * @return void |
|
318 | + */ |
|
319 | + abstract protected function main(); |
|
320 | + |
|
321 | + /** |
|
322 | + * Takes a smarty template string and sets the HTML title to that value |
|
323 | + * |
|
324 | + * @param string $title |
|
325 | + * |
|
326 | + * @throws SmartyException |
|
327 | + */ |
|
328 | + final protected function setHtmlTitle($title) |
|
329 | + { |
|
330 | + $this->htmlTitle = $this->smarty->fetch('string:' . $title); |
|
331 | + } |
|
332 | + |
|
333 | + public function execute() |
|
334 | + { |
|
335 | + if ($this->getRouteName() === null) { |
|
336 | + throw new Exception('Request is unrouted.'); |
|
337 | + } |
|
338 | + |
|
339 | + if ($this->getSiteConfiguration() === null) { |
|
340 | + throw new Exception('Page has no configuration!'); |
|
341 | + } |
|
342 | + |
|
343 | + $this->setupPage(); |
|
344 | + |
|
345 | + $this->runPage(); |
|
346 | + } |
|
347 | + |
|
348 | + public function assignCSRFToken() |
|
349 | + { |
|
350 | + $token = $this->tokenManager->getNewToken(); |
|
351 | + $this->assign('csrfTokenData', $token->getTokenData()); |
|
352 | + } |
|
353 | + |
|
354 | + public function validateCSRFToken() |
|
355 | + { |
|
356 | + if (!$this->tokenManager->validateToken(WebRequest::postString('csrfTokenData'))) { |
|
357 | + throw new ApplicationLogicException('Form token is not valid, please reload and try again'); |
|
358 | + } |
|
359 | + } |
|
360 | + |
|
361 | + protected function sendResponseHeaders() |
|
362 | + { |
|
363 | + if (headers_sent()) { |
|
364 | + throw new ApplicationLogicException('Headers have already been sent! This is likely a bug in the application.'); |
|
365 | + } |
|
366 | + |
|
367 | + // send the CSP headers now |
|
368 | + header($this->getCspManager()->getHeader()); |
|
369 | + |
|
370 | + foreach ($this->headerQueue as $item) { |
|
371 | + if (mb_strpos($item, "\r") !== false || mb_strpos($item, "\n") !== false) { |
|
372 | + // Oops. We're not allowed to do this. |
|
373 | + throw new Exception('Unable to split header'); |
|
374 | + } |
|
375 | + |
|
376 | + header($item); |
|
377 | + } |
|
378 | + } |
|
379 | 379 | } |
@@ -16,73 +16,73 @@ |
||
16 | 16 | */ |
17 | 17 | function smarty_modifier_relativedate($input) |
18 | 18 | { |
19 | - $now = new DateTime(); |
|
19 | + $now = new DateTime(); |
|
20 | 20 | |
21 | - if (gettype($input) === 'object' |
|
22 | - && (get_class($input) === DateTime::class || get_class($input) === DateTimeImmutable::class) |
|
23 | - ) { |
|
24 | - $then = $input; |
|
25 | - } |
|
26 | - else { |
|
27 | - try { |
|
28 | - $then = new DateTime($input); |
|
29 | - } |
|
30 | - catch(Exception $ex) { |
|
31 | - return $input; |
|
32 | - } |
|
33 | - } |
|
21 | + if (gettype($input) === 'object' |
|
22 | + && (get_class($input) === DateTime::class || get_class($input) === DateTimeImmutable::class) |
|
23 | + ) { |
|
24 | + $then = $input; |
|
25 | + } |
|
26 | + else { |
|
27 | + try { |
|
28 | + $then = new DateTime($input); |
|
29 | + } |
|
30 | + catch(Exception $ex) { |
|
31 | + return $input; |
|
32 | + } |
|
33 | + } |
|
34 | 34 | |
35 | - $secs = $now->getTimestamp() - $then->getTimestamp(); |
|
35 | + $secs = $now->getTimestamp() - $then->getTimestamp(); |
|
36 | 36 | |
37 | - $second = 1; |
|
38 | - $minute = 60 * $second; |
|
39 | - $minuteCut = 60 * $second; |
|
40 | - $hour = 60 * $minute; |
|
41 | - $hourCut = 90 * $minute; |
|
42 | - $day = 24 * $hour; |
|
43 | - $dayCut = 48 * $hour; |
|
44 | - $week = 7 * $day; |
|
45 | - $weekCut = 14 * $day; |
|
46 | - $month = 30 * $day; |
|
47 | - $monthCut = 60 * $day; |
|
48 | - $year = 365 * $day; |
|
49 | - $yearCut = $year * 2; |
|
37 | + $second = 1; |
|
38 | + $minute = 60 * $second; |
|
39 | + $minuteCut = 60 * $second; |
|
40 | + $hour = 60 * $minute; |
|
41 | + $hourCut = 90 * $minute; |
|
42 | + $day = 24 * $hour; |
|
43 | + $dayCut = 48 * $hour; |
|
44 | + $week = 7 * $day; |
|
45 | + $weekCut = 14 * $day; |
|
46 | + $month = 30 * $day; |
|
47 | + $monthCut = 60 * $day; |
|
48 | + $year = 365 * $day; |
|
49 | + $yearCut = $year * 2; |
|
50 | 50 | |
51 | - $pluralise = true; |
|
51 | + $pluralise = true; |
|
52 | 52 | |
53 | - if ($secs <= 10) { |
|
54 | - $output = "just now"; |
|
55 | - $pluralise = false; |
|
56 | - } |
|
57 | - elseif ($secs > 10 && $secs < $minuteCut) { |
|
58 | - $output = round($secs / $second) . " second"; |
|
59 | - } |
|
60 | - elseif ($secs >= $minuteCut && $secs < $hourCut) { |
|
61 | - $output = round($secs / $minute) . " minute"; |
|
62 | - } |
|
63 | - elseif ($secs >= $hourCut && $secs < $dayCut) { |
|
64 | - $output = round($secs / $hour) . " hour"; |
|
65 | - } |
|
66 | - elseif ($secs >= $dayCut && $secs < $weekCut) { |
|
67 | - $output = round($secs / $day) . " day"; |
|
68 | - } |
|
69 | - elseif ($secs >= $weekCut && $secs < $monthCut) { |
|
70 | - $output = round($secs / $week) . " week"; |
|
71 | - } |
|
72 | - elseif ($secs >= $monthCut && $secs < $yearCut) { |
|
73 | - $output = round($secs / $month) . " month"; |
|
74 | - } |
|
75 | - elseif ($secs >= $yearCut && $secs < $year * 10) { |
|
76 | - $output = round($secs / $year) . " year"; |
|
77 | - } |
|
78 | - else { |
|
79 | - $output = "a long time ago"; |
|
80 | - $pluralise = false; |
|
81 | - } |
|
53 | + if ($secs <= 10) { |
|
54 | + $output = "just now"; |
|
55 | + $pluralise = false; |
|
56 | + } |
|
57 | + elseif ($secs > 10 && $secs < $minuteCut) { |
|
58 | + $output = round($secs / $second) . " second"; |
|
59 | + } |
|
60 | + elseif ($secs >= $minuteCut && $secs < $hourCut) { |
|
61 | + $output = round($secs / $minute) . " minute"; |
|
62 | + } |
|
63 | + elseif ($secs >= $hourCut && $secs < $dayCut) { |
|
64 | + $output = round($secs / $hour) . " hour"; |
|
65 | + } |
|
66 | + elseif ($secs >= $dayCut && $secs < $weekCut) { |
|
67 | + $output = round($secs / $day) . " day"; |
|
68 | + } |
|
69 | + elseif ($secs >= $weekCut && $secs < $monthCut) { |
|
70 | + $output = round($secs / $week) . " week"; |
|
71 | + } |
|
72 | + elseif ($secs >= $monthCut && $secs < $yearCut) { |
|
73 | + $output = round($secs / $month) . " month"; |
|
74 | + } |
|
75 | + elseif ($secs >= $yearCut && $secs < $year * 10) { |
|
76 | + $output = round($secs / $year) . " year"; |
|
77 | + } |
|
78 | + else { |
|
79 | + $output = "a long time ago"; |
|
80 | + $pluralise = false; |
|
81 | + } |
|
82 | 82 | |
83 | - if ($pluralise) { |
|
84 | - $output = (substr($output, 0, 2) <> "1 ") ? $output . "s ago" : $output . " ago"; |
|
85 | - } |
|
83 | + if ($pluralise) { |
|
84 | + $output = (substr($output, 0, 2) <> "1 ") ? $output . "s ago" : $output . " ago"; |
|
85 | + } |
|
86 | 86 | |
87 | - return $output; |
|
87 | + return $output; |
|
88 | 88 | } |
@@ -27,7 +27,7 @@ discard block |
||
27 | 27 | try { |
28 | 28 | $then = new DateTime($input); |
29 | 29 | } |
30 | - catch(Exception $ex) { |
|
30 | + catch (Exception $ex) { |
|
31 | 31 | return $input; |
32 | 32 | } |
33 | 33 | } |
@@ -55,25 +55,25 @@ discard block |
||
55 | 55 | $pluralise = false; |
56 | 56 | } |
57 | 57 | elseif ($secs > 10 && $secs < $minuteCut) { |
58 | - $output = round($secs / $second) . " second"; |
|
58 | + $output = round($secs / $second)." second"; |
|
59 | 59 | } |
60 | 60 | elseif ($secs >= $minuteCut && $secs < $hourCut) { |
61 | - $output = round($secs / $minute) . " minute"; |
|
61 | + $output = round($secs / $minute)." minute"; |
|
62 | 62 | } |
63 | 63 | elseif ($secs >= $hourCut && $secs < $dayCut) { |
64 | - $output = round($secs / $hour) . " hour"; |
|
64 | + $output = round($secs / $hour)." hour"; |
|
65 | 65 | } |
66 | 66 | elseif ($secs >= $dayCut && $secs < $weekCut) { |
67 | - $output = round($secs / $day) . " day"; |
|
67 | + $output = round($secs / $day)." day"; |
|
68 | 68 | } |
69 | 69 | elseif ($secs >= $weekCut && $secs < $monthCut) { |
70 | - $output = round($secs / $week) . " week"; |
|
70 | + $output = round($secs / $week)." week"; |
|
71 | 71 | } |
72 | 72 | elseif ($secs >= $monthCut && $secs < $yearCut) { |
73 | - $output = round($secs / $month) . " month"; |
|
73 | + $output = round($secs / $month)." month"; |
|
74 | 74 | } |
75 | 75 | elseif ($secs >= $yearCut && $secs < $year * 10) { |
76 | - $output = round($secs / $year) . " year"; |
|
76 | + $output = round($secs / $year)." year"; |
|
77 | 77 | } |
78 | 78 | else { |
79 | 79 | $output = "a long time ago"; |
@@ -81,7 +81,7 @@ discard block |
||
81 | 81 | } |
82 | 82 | |
83 | 83 | if ($pluralise) { |
84 | - $output = (substr($output, 0, 2) <> "1 ") ? $output . "s ago" : $output . " ago"; |
|
84 | + $output = (substr($output, 0, 2) <> "1 ") ? $output."s ago" : $output." ago"; |
|
85 | 85 | } |
86 | 86 | |
87 | 87 | return $output; |
@@ -21,160 +21,160 @@ discard block |
||
21 | 21 | */ |
22 | 22 | class User extends DataObject |
23 | 23 | { |
24 | - const STATUS_ACTIVE = 'Active'; |
|
25 | - const STATUS_SUSPENDED = 'Suspended'; |
|
26 | - const STATUS_DECLINED = 'Declined'; |
|
27 | - const STATUS_NEW = 'New'; |
|
28 | - const CREATION_MANUAL = 0; |
|
29 | - const CREATION_OAUTH = 1; |
|
30 | - const CREATION_BOT = 2; |
|
31 | - private $username; |
|
32 | - private $email; |
|
33 | - private $status = self::STATUS_NEW; |
|
34 | - private $onwikiname; |
|
35 | - private $welcome_sig = ""; |
|
36 | - private $lastactive = "0000-00-00 00:00:00"; |
|
37 | - private $forcelogout = 0; |
|
38 | - private $forceidentified = null; |
|
39 | - private $welcome_template = 0; |
|
40 | - private $abortpref = 0; |
|
41 | - private $confirmationdiff = 0; |
|
42 | - private $emailsig = ""; |
|
43 | - private $creationmode = 0; |
|
44 | - private $skin = "main"; |
|
45 | - /** @var User Cache variable of the current user - it's never going to change in the middle of a request. */ |
|
46 | - private static $currentUser; |
|
47 | - #region Object load methods |
|
48 | - |
|
49 | - /** |
|
50 | - * Gets the currently logged in user |
|
51 | - * |
|
52 | - * @param PdoDatabase $database |
|
53 | - * |
|
54 | - * @return User|CommunityUser |
|
55 | - */ |
|
56 | - public static function getCurrent(PdoDatabase $database) |
|
57 | - { |
|
58 | - if (self::$currentUser === null) { |
|
59 | - $sessionId = WebRequest::getSessionUserId(); |
|
60 | - |
|
61 | - if ($sessionId !== null) { |
|
62 | - /** @var User $user */ |
|
63 | - $user = self::getById($sessionId, $database); |
|
64 | - |
|
65 | - if ($user === false) { |
|
66 | - self::$currentUser = new CommunityUser(); |
|
67 | - } |
|
68 | - else { |
|
69 | - self::$currentUser = $user; |
|
70 | - } |
|
71 | - } |
|
72 | - else { |
|
73 | - $anonymousCoward = new CommunityUser(); |
|
74 | - |
|
75 | - self::$currentUser = $anonymousCoward; |
|
76 | - } |
|
77 | - } |
|
78 | - |
|
79 | - return self::$currentUser; |
|
80 | - } |
|
81 | - |
|
82 | - /** |
|
83 | - * Gets a user by their user ID |
|
84 | - * |
|
85 | - * Pass -1 to get the community user. |
|
86 | - * |
|
87 | - * @param int|null $id |
|
88 | - * @param PdoDatabase $database |
|
89 | - * |
|
90 | - * @return User|false |
|
91 | - */ |
|
92 | - public static function getById($id, PdoDatabase $database) |
|
93 | - { |
|
94 | - if ($id === null || $id == -1) { |
|
95 | - return new CommunityUser(); |
|
96 | - } |
|
97 | - |
|
98 | - /** @var User|false $user */ |
|
99 | - $user = parent::getById($id, $database); |
|
100 | - |
|
101 | - return $user; |
|
102 | - } |
|
103 | - |
|
104 | - /** |
|
105 | - * @return CommunityUser |
|
106 | - */ |
|
107 | - public static function getCommunity() |
|
108 | - { |
|
109 | - return new CommunityUser(); |
|
110 | - } |
|
111 | - |
|
112 | - /** |
|
113 | - * Gets a user by their username |
|
114 | - * |
|
115 | - * @param string $username |
|
116 | - * @param PdoDatabase $database |
|
117 | - * |
|
118 | - * @return CommunityUser|User|false |
|
119 | - */ |
|
120 | - public static function getByUsername($username, PdoDatabase $database) |
|
121 | - { |
|
122 | - global $communityUsername; |
|
123 | - if ($username == $communityUsername) { |
|
124 | - return new CommunityUser(); |
|
125 | - } |
|
126 | - |
|
127 | - $statement = $database->prepare("SELECT * FROM user WHERE username = :id LIMIT 1;"); |
|
128 | - $statement->bindValue(":id", $username); |
|
129 | - |
|
130 | - $statement->execute(); |
|
131 | - |
|
132 | - $resultObject = $statement->fetchObject(get_called_class()); |
|
133 | - |
|
134 | - if ($resultObject != false) { |
|
135 | - $resultObject->setDatabase($database); |
|
136 | - } |
|
137 | - |
|
138 | - return $resultObject; |
|
139 | - } |
|
140 | - |
|
141 | - /** |
|
142 | - * Gets a user by their on-wiki username. |
|
143 | - * |
|
144 | - * @param string $username |
|
145 | - * @param PdoDatabase $database |
|
146 | - * |
|
147 | - * @return User|false |
|
148 | - */ |
|
149 | - public static function getByOnWikiUsername($username, PdoDatabase $database) |
|
150 | - { |
|
151 | - $statement = $database->prepare("SELECT * FROM user WHERE onwikiname = :id LIMIT 1;"); |
|
152 | - $statement->bindValue(":id", $username); |
|
153 | - $statement->execute(); |
|
154 | - |
|
155 | - $resultObject = $statement->fetchObject(get_called_class()); |
|
156 | - |
|
157 | - if ($resultObject != false) { |
|
158 | - $resultObject->setDatabase($database); |
|
159 | - |
|
160 | - return $resultObject; |
|
161 | - } |
|
162 | - |
|
163 | - return false; |
|
164 | - } |
|
165 | - |
|
166 | - #endregion |
|
167 | - |
|
168 | - /** |
|
169 | - * Saves the current object |
|
170 | - * |
|
171 | - * @throws Exception |
|
172 | - */ |
|
173 | - public function save() |
|
174 | - { |
|
175 | - if ($this->isNew()) { |
|
176 | - // insert |
|
177 | - $statement = $this->dbObject->prepare(<<<SQL |
|
24 | + const STATUS_ACTIVE = 'Active'; |
|
25 | + const STATUS_SUSPENDED = 'Suspended'; |
|
26 | + const STATUS_DECLINED = 'Declined'; |
|
27 | + const STATUS_NEW = 'New'; |
|
28 | + const CREATION_MANUAL = 0; |
|
29 | + const CREATION_OAUTH = 1; |
|
30 | + const CREATION_BOT = 2; |
|
31 | + private $username; |
|
32 | + private $email; |
|
33 | + private $status = self::STATUS_NEW; |
|
34 | + private $onwikiname; |
|
35 | + private $welcome_sig = ""; |
|
36 | + private $lastactive = "0000-00-00 00:00:00"; |
|
37 | + private $forcelogout = 0; |
|
38 | + private $forceidentified = null; |
|
39 | + private $welcome_template = 0; |
|
40 | + private $abortpref = 0; |
|
41 | + private $confirmationdiff = 0; |
|
42 | + private $emailsig = ""; |
|
43 | + private $creationmode = 0; |
|
44 | + private $skin = "main"; |
|
45 | + /** @var User Cache variable of the current user - it's never going to change in the middle of a request. */ |
|
46 | + private static $currentUser; |
|
47 | + #region Object load methods |
|
48 | + |
|
49 | + /** |
|
50 | + * Gets the currently logged in user |
|
51 | + * |
|
52 | + * @param PdoDatabase $database |
|
53 | + * |
|
54 | + * @return User|CommunityUser |
|
55 | + */ |
|
56 | + public static function getCurrent(PdoDatabase $database) |
|
57 | + { |
|
58 | + if (self::$currentUser === null) { |
|
59 | + $sessionId = WebRequest::getSessionUserId(); |
|
60 | + |
|
61 | + if ($sessionId !== null) { |
|
62 | + /** @var User $user */ |
|
63 | + $user = self::getById($sessionId, $database); |
|
64 | + |
|
65 | + if ($user === false) { |
|
66 | + self::$currentUser = new CommunityUser(); |
|
67 | + } |
|
68 | + else { |
|
69 | + self::$currentUser = $user; |
|
70 | + } |
|
71 | + } |
|
72 | + else { |
|
73 | + $anonymousCoward = new CommunityUser(); |
|
74 | + |
|
75 | + self::$currentUser = $anonymousCoward; |
|
76 | + } |
|
77 | + } |
|
78 | + |
|
79 | + return self::$currentUser; |
|
80 | + } |
|
81 | + |
|
82 | + /** |
|
83 | + * Gets a user by their user ID |
|
84 | + * |
|
85 | + * Pass -1 to get the community user. |
|
86 | + * |
|
87 | + * @param int|null $id |
|
88 | + * @param PdoDatabase $database |
|
89 | + * |
|
90 | + * @return User|false |
|
91 | + */ |
|
92 | + public static function getById($id, PdoDatabase $database) |
|
93 | + { |
|
94 | + if ($id === null || $id == -1) { |
|
95 | + return new CommunityUser(); |
|
96 | + } |
|
97 | + |
|
98 | + /** @var User|false $user */ |
|
99 | + $user = parent::getById($id, $database); |
|
100 | + |
|
101 | + return $user; |
|
102 | + } |
|
103 | + |
|
104 | + /** |
|
105 | + * @return CommunityUser |
|
106 | + */ |
|
107 | + public static function getCommunity() |
|
108 | + { |
|
109 | + return new CommunityUser(); |
|
110 | + } |
|
111 | + |
|
112 | + /** |
|
113 | + * Gets a user by their username |
|
114 | + * |
|
115 | + * @param string $username |
|
116 | + * @param PdoDatabase $database |
|
117 | + * |
|
118 | + * @return CommunityUser|User|false |
|
119 | + */ |
|
120 | + public static function getByUsername($username, PdoDatabase $database) |
|
121 | + { |
|
122 | + global $communityUsername; |
|
123 | + if ($username == $communityUsername) { |
|
124 | + return new CommunityUser(); |
|
125 | + } |
|
126 | + |
|
127 | + $statement = $database->prepare("SELECT * FROM user WHERE username = :id LIMIT 1;"); |
|
128 | + $statement->bindValue(":id", $username); |
|
129 | + |
|
130 | + $statement->execute(); |
|
131 | + |
|
132 | + $resultObject = $statement->fetchObject(get_called_class()); |
|
133 | + |
|
134 | + if ($resultObject != false) { |
|
135 | + $resultObject->setDatabase($database); |
|
136 | + } |
|
137 | + |
|
138 | + return $resultObject; |
|
139 | + } |
|
140 | + |
|
141 | + /** |
|
142 | + * Gets a user by their on-wiki username. |
|
143 | + * |
|
144 | + * @param string $username |
|
145 | + * @param PdoDatabase $database |
|
146 | + * |
|
147 | + * @return User|false |
|
148 | + */ |
|
149 | + public static function getByOnWikiUsername($username, PdoDatabase $database) |
|
150 | + { |
|
151 | + $statement = $database->prepare("SELECT * FROM user WHERE onwikiname = :id LIMIT 1;"); |
|
152 | + $statement->bindValue(":id", $username); |
|
153 | + $statement->execute(); |
|
154 | + |
|
155 | + $resultObject = $statement->fetchObject(get_called_class()); |
|
156 | + |
|
157 | + if ($resultObject != false) { |
|
158 | + $resultObject->setDatabase($database); |
|
159 | + |
|
160 | + return $resultObject; |
|
161 | + } |
|
162 | + |
|
163 | + return false; |
|
164 | + } |
|
165 | + |
|
166 | + #endregion |
|
167 | + |
|
168 | + /** |
|
169 | + * Saves the current object |
|
170 | + * |
|
171 | + * @throws Exception |
|
172 | + */ |
|
173 | + public function save() |
|
174 | + { |
|
175 | + if ($this->isNew()) { |
|
176 | + // insert |
|
177 | + $statement = $this->dbObject->prepare(<<<SQL |
|
178 | 178 | INSERT INTO `user` ( |
179 | 179 | username, email, status, onwikiname, welcome_sig, |
180 | 180 | lastactive, forcelogout, forceidentified, |
@@ -185,32 +185,32 @@ discard block |
||
185 | 185 | :welcome_template, :abortpref, :confirmationdiff, :emailsig, :creationmode, :skin |
186 | 186 | ); |
187 | 187 | SQL |
188 | - ); |
|
189 | - $statement->bindValue(":username", $this->username); |
|
190 | - $statement->bindValue(":email", $this->email); |
|
191 | - $statement->bindValue(":status", $this->status); |
|
192 | - $statement->bindValue(":onwikiname", $this->onwikiname); |
|
193 | - $statement->bindValue(":welcome_sig", $this->welcome_sig); |
|
194 | - $statement->bindValue(":lastactive", $this->lastactive); |
|
195 | - $statement->bindValue(":forcelogout", $this->forcelogout); |
|
196 | - $statement->bindValue(":forceidentified", $this->forceidentified); |
|
197 | - $statement->bindValue(":welcome_template", $this->welcome_template); |
|
198 | - $statement->bindValue(":abortpref", $this->abortpref); |
|
199 | - $statement->bindValue(":confirmationdiff", $this->confirmationdiff); |
|
200 | - $statement->bindValue(":emailsig", $this->emailsig); |
|
201 | - $statement->bindValue(":creationmode", $this->creationmode); |
|
202 | - $statement->bindValue(":skin", $this->skin); |
|
203 | - |
|
204 | - if ($statement->execute()) { |
|
205 | - $this->id = (int)$this->dbObject->lastInsertId(); |
|
206 | - } |
|
207 | - else { |
|
208 | - throw new Exception($statement->errorInfo()); |
|
209 | - } |
|
210 | - } |
|
211 | - else { |
|
212 | - // update |
|
213 | - $statement = $this->dbObject->prepare(<<<SQL |
|
188 | + ); |
|
189 | + $statement->bindValue(":username", $this->username); |
|
190 | + $statement->bindValue(":email", $this->email); |
|
191 | + $statement->bindValue(":status", $this->status); |
|
192 | + $statement->bindValue(":onwikiname", $this->onwikiname); |
|
193 | + $statement->bindValue(":welcome_sig", $this->welcome_sig); |
|
194 | + $statement->bindValue(":lastactive", $this->lastactive); |
|
195 | + $statement->bindValue(":forcelogout", $this->forcelogout); |
|
196 | + $statement->bindValue(":forceidentified", $this->forceidentified); |
|
197 | + $statement->bindValue(":welcome_template", $this->welcome_template); |
|
198 | + $statement->bindValue(":abortpref", $this->abortpref); |
|
199 | + $statement->bindValue(":confirmationdiff", $this->confirmationdiff); |
|
200 | + $statement->bindValue(":emailsig", $this->emailsig); |
|
201 | + $statement->bindValue(":creationmode", $this->creationmode); |
|
202 | + $statement->bindValue(":skin", $this->skin); |
|
203 | + |
|
204 | + if ($statement->execute()) { |
|
205 | + $this->id = (int)$this->dbObject->lastInsertId(); |
|
206 | + } |
|
207 | + else { |
|
208 | + throw new Exception($statement->errorInfo()); |
|
209 | + } |
|
210 | + } |
|
211 | + else { |
|
212 | + // update |
|
213 | + $statement = $this->dbObject->prepare(<<<SQL |
|
214 | 214 | UPDATE `user` SET |
215 | 215 | username = :username, email = :email, |
216 | 216 | status = :status, |
@@ -223,387 +223,387 @@ discard block |
||
223 | 223 | updateversion = updateversion + 1 |
224 | 224 | WHERE id = :id AND updateversion = :updateversion; |
225 | 225 | SQL |
226 | - ); |
|
227 | - $statement->bindValue(":forceidentified", $this->forceidentified); |
|
228 | - |
|
229 | - $statement->bindValue(':id', $this->id); |
|
230 | - $statement->bindValue(':updateversion', $this->updateversion); |
|
231 | - |
|
232 | - $statement->bindValue(':username', $this->username); |
|
233 | - $statement->bindValue(':email', $this->email); |
|
234 | - $statement->bindValue(':status', $this->status); |
|
235 | - $statement->bindValue(':onwikiname', $this->onwikiname); |
|
236 | - $statement->bindValue(':welcome_sig', $this->welcome_sig); |
|
237 | - $statement->bindValue(':lastactive', $this->lastactive); |
|
238 | - $statement->bindValue(':forcelogout', $this->forcelogout); |
|
239 | - $statement->bindValue(':forceidentified', $this->forceidentified); |
|
240 | - $statement->bindValue(':welcome_template', $this->welcome_template); |
|
241 | - $statement->bindValue(':abortpref', $this->abortpref); |
|
242 | - $statement->bindValue(':confirmationdiff', $this->confirmationdiff); |
|
243 | - $statement->bindValue(':emailsig', $this->emailsig); |
|
244 | - $statement->bindValue(':creationmode', $this->creationmode); |
|
245 | - $statement->bindValue(':skin', $this->skin); |
|
246 | - |
|
247 | - if (!$statement->execute()) { |
|
248 | - throw new Exception($statement->errorInfo()); |
|
249 | - } |
|
250 | - |
|
251 | - if ($statement->rowCount() !== 1) { |
|
252 | - throw new OptimisticLockFailedException(); |
|
253 | - } |
|
254 | - |
|
255 | - $this->updateversion++; |
|
256 | - } |
|
257 | - } |
|
258 | - |
|
259 | - #region properties |
|
260 | - |
|
261 | - /** |
|
262 | - * Gets the tool username |
|
263 | - * @return string |
|
264 | - */ |
|
265 | - public function getUsername() |
|
266 | - { |
|
267 | - return $this->username; |
|
268 | - } |
|
269 | - |
|
270 | - /** |
|
271 | - * Sets the tool username |
|
272 | - * |
|
273 | - * @param string $username |
|
274 | - */ |
|
275 | - public function setUsername($username) |
|
276 | - { |
|
277 | - $this->username = $username; |
|
278 | - |
|
279 | - // If this isn't a brand new user, then it's a rename, force the logout |
|
280 | - if (!$this->isNew()) { |
|
281 | - $this->forcelogout = 1; |
|
282 | - } |
|
283 | - } |
|
284 | - |
|
285 | - /** |
|
286 | - * Gets the user's email address |
|
287 | - * @return string |
|
288 | - */ |
|
289 | - public function getEmail() |
|
290 | - { |
|
291 | - return $this->email; |
|
292 | - } |
|
293 | - |
|
294 | - /** |
|
295 | - * Sets the user's email address |
|
296 | - * |
|
297 | - * @param string $email |
|
298 | - */ |
|
299 | - public function setEmail($email) |
|
300 | - { |
|
301 | - $this->email = $email; |
|
302 | - } |
|
303 | - |
|
304 | - /** |
|
305 | - * Gets the status (User, Admin, Suspended, etc - excludes checkuser) of the user. |
|
306 | - * @return string |
|
307 | - */ |
|
308 | - public function getStatus() |
|
309 | - { |
|
310 | - return $this->status; |
|
311 | - } |
|
312 | - |
|
313 | - /** |
|
314 | - * @param string $status |
|
315 | - */ |
|
316 | - public function setStatus($status) |
|
317 | - { |
|
318 | - $this->status = $status; |
|
319 | - } |
|
320 | - |
|
321 | - /** |
|
322 | - * Gets the user's on-wiki name |
|
323 | - * @return string |
|
324 | - */ |
|
325 | - public function getOnWikiName() |
|
326 | - { |
|
327 | - return $this->onwikiname; |
|
328 | - } |
|
329 | - |
|
330 | - /** |
|
331 | - * Sets the user's on-wiki name |
|
332 | - * |
|
333 | - * This can have interesting side-effects with OAuth. |
|
334 | - * |
|
335 | - * @param string $onWikiName |
|
336 | - */ |
|
337 | - public function setOnWikiName($onWikiName) |
|
338 | - { |
|
339 | - $this->onwikiname = $onWikiName; |
|
340 | - } |
|
341 | - |
|
342 | - /** |
|
343 | - * Gets the welcome signature |
|
344 | - * @return string |
|
345 | - */ |
|
346 | - public function getWelcomeSig() |
|
347 | - { |
|
348 | - return $this->welcome_sig; |
|
349 | - } |
|
350 | - |
|
351 | - /** |
|
352 | - * Sets the welcome signature |
|
353 | - * |
|
354 | - * @param string $welcomeSig |
|
355 | - */ |
|
356 | - public function setWelcomeSig($welcomeSig) |
|
357 | - { |
|
358 | - $this->welcome_sig = $welcomeSig; |
|
359 | - } |
|
360 | - |
|
361 | - /** |
|
362 | - * Gets the last activity date for the user |
|
363 | - * |
|
364 | - * @return string |
|
365 | - * @todo This should probably return an instance of DateTime |
|
366 | - */ |
|
367 | - public function getLastActive() |
|
368 | - { |
|
369 | - return $this->lastactive; |
|
370 | - } |
|
371 | - |
|
372 | - /** |
|
373 | - * Gets the user's forced logout status |
|
374 | - * |
|
375 | - * @return bool |
|
376 | - */ |
|
377 | - public function getForceLogout() |
|
378 | - { |
|
379 | - return $this->forcelogout == 1; |
|
380 | - } |
|
381 | - |
|
382 | - /** |
|
383 | - * Sets the user's forced logout status |
|
384 | - * |
|
385 | - * @param bool $forceLogout |
|
386 | - */ |
|
387 | - public function setForceLogout($forceLogout) |
|
388 | - { |
|
389 | - $this->forcelogout = $forceLogout ? 1 : 0; |
|
390 | - } |
|
391 | - |
|
392 | - /** |
|
393 | - * Returns the ID of the welcome template used. |
|
394 | - * @return int |
|
395 | - */ |
|
396 | - public function getWelcomeTemplate() |
|
397 | - { |
|
398 | - return $this->welcome_template; |
|
399 | - } |
|
400 | - |
|
401 | - /** |
|
402 | - * Sets the ID of the welcome template used. |
|
403 | - * |
|
404 | - * @param int $welcomeTemplate |
|
405 | - */ |
|
406 | - public function setWelcomeTemplate($welcomeTemplate) |
|
407 | - { |
|
408 | - $this->welcome_template = $welcomeTemplate; |
|
409 | - } |
|
410 | - |
|
411 | - /** |
|
412 | - * Gets the user's abort preference |
|
413 | - * @todo this is badly named too! Also a bool that's actually an int. |
|
414 | - * @return int |
|
415 | - */ |
|
416 | - public function getAbortPref() |
|
417 | - { |
|
418 | - return $this->abortpref; |
|
419 | - } |
|
420 | - |
|
421 | - /** |
|
422 | - * Sets the user's abort preference |
|
423 | - * @todo rename, retype, and re-comment. |
|
424 | - * |
|
425 | - * @param int $abortPreference |
|
426 | - */ |
|
427 | - public function setAbortPref($abortPreference) |
|
428 | - { |
|
429 | - $this->abortpref = $abortPreference; |
|
430 | - } |
|
431 | - |
|
432 | - /** |
|
433 | - * Gets the user's confirmation diff. Unused if OAuth is in use. |
|
434 | - * @return int the diff ID |
|
435 | - */ |
|
436 | - public function getConfirmationDiff() |
|
437 | - { |
|
438 | - return $this->confirmationdiff; |
|
439 | - } |
|
440 | - |
|
441 | - /** |
|
442 | - * Sets the user's confirmation diff. |
|
443 | - * |
|
444 | - * @param int $confirmationDiff |
|
445 | - */ |
|
446 | - public function setConfirmationDiff($confirmationDiff) |
|
447 | - { |
|
448 | - $this->confirmationdiff = $confirmationDiff; |
|
449 | - } |
|
450 | - |
|
451 | - /** |
|
452 | - * Gets the users' email signature used on outbound mail. |
|
453 | - * @todo rename me! |
|
454 | - * @return string |
|
455 | - */ |
|
456 | - public function getEmailSig() |
|
457 | - { |
|
458 | - return $this->emailsig; |
|
459 | - } |
|
460 | - |
|
461 | - /** |
|
462 | - * Sets the user's email signature for outbound mail. |
|
463 | - * |
|
464 | - * @param string $emailSignature |
|
465 | - */ |
|
466 | - public function setEmailSig($emailSignature) |
|
467 | - { |
|
468 | - $this->emailsig = $emailSignature; |
|
469 | - } |
|
470 | - |
|
471 | - /** |
|
472 | - * @return int |
|
473 | - */ |
|
474 | - public function getCreationMode() |
|
475 | - { |
|
476 | - return $this->creationmode; |
|
477 | - } |
|
478 | - |
|
479 | - /** |
|
480 | - * @param $creationMode int |
|
481 | - */ |
|
482 | - public function setCreationMode($creationMode) |
|
483 | - { |
|
484 | - $this->creationmode = $creationMode; |
|
485 | - } |
|
486 | - |
|
487 | - /** |
|
488 | - * @return boolean |
|
489 | - */ |
|
490 | - public function getUseAlternateSkin() |
|
491 | - { |
|
492 | - return $this->skin === 'alt'; |
|
493 | - } |
|
494 | - |
|
495 | - /** |
|
496 | - * @return string |
|
497 | - */ |
|
498 | - public function getSkin() |
|
499 | - { |
|
500 | - return $this->skin; |
|
501 | - } |
|
502 | - |
|
503 | - /** |
|
504 | - * @param $skin string |
|
505 | - */ |
|
506 | - public function setSkin($skin) |
|
507 | - { |
|
508 | - $this->skin = $skin; |
|
509 | - } |
|
510 | - |
|
511 | - #endregion |
|
512 | - |
|
513 | - #region user access checks |
|
514 | - |
|
515 | - public function isActive() |
|
516 | - { |
|
517 | - return $this->status == self::STATUS_ACTIVE; |
|
518 | - } |
|
519 | - |
|
520 | - /** |
|
521 | - * Tests if the user is identified |
|
522 | - * |
|
523 | - * @param IdentificationVerifier $iv |
|
524 | - * |
|
525 | - * @return bool |
|
526 | - * @todo Figure out what on earth is going on with PDO's typecasting here. Apparently, it returns string("0") for |
|
527 | - * the force-unidentified case, and int(1) for the identified case?! This is quite ugly, but probably needed |
|
528 | - * to play it safe for now. |
|
529 | - * @category Security-Critical |
|
530 | - */ |
|
531 | - public function isIdentified(IdentificationVerifier $iv) |
|
532 | - { |
|
533 | - if ($this->forceidentified === 0 || $this->forceidentified === "0") { |
|
534 | - // User forced to unidentified in the database. |
|
535 | - return false; |
|
536 | - } |
|
537 | - elseif ($this->forceidentified === 1 || $this->forceidentified === "1") { |
|
538 | - // User forced to identified in the database. |
|
539 | - return true; |
|
540 | - } |
|
541 | - else { |
|
542 | - // User not forced to any particular identified status; consult IdentificationVerifier |
|
543 | - return $iv->isUserIdentified($this->getOnWikiName()); |
|
544 | - } |
|
545 | - } |
|
546 | - |
|
547 | - /** |
|
548 | - * DO NOT USE FOR TESTING IDENTIFICATION STATUS. |
|
549 | - * |
|
550 | - * @return bool|null |
|
551 | - */ |
|
552 | - public function getForceIdentified() { |
|
553 | - return $this->forceidentified; |
|
554 | - } |
|
555 | - |
|
556 | - /** |
|
557 | - * Tests if the user is suspended |
|
558 | - * @return bool |
|
559 | - * @category Security-Critical |
|
560 | - */ |
|
561 | - public function isSuspended() |
|
562 | - { |
|
563 | - return $this->status == self::STATUS_SUSPENDED; |
|
564 | - } |
|
565 | - |
|
566 | - /** |
|
567 | - * Tests if the user is new |
|
568 | - * @return bool |
|
569 | - * @category Security-Critical |
|
570 | - */ |
|
571 | - public function isNewUser() |
|
572 | - { |
|
573 | - return $this->status == self::STATUS_NEW; |
|
574 | - } |
|
575 | - |
|
576 | - /** |
|
577 | - * Tests if the user has been declined access to the tool |
|
578 | - * @return bool |
|
579 | - * @category Security-Critical |
|
580 | - */ |
|
581 | - public function isDeclined() |
|
582 | - { |
|
583 | - return $this->status == self::STATUS_DECLINED; |
|
584 | - } |
|
585 | - |
|
586 | - /** |
|
587 | - * Tests if the user is the community user |
|
588 | - * |
|
589 | - * @todo decide if this means logged out. I think it usually does. |
|
590 | - * @return bool |
|
591 | - * @category Security-Critical |
|
592 | - */ |
|
593 | - public function isCommunityUser() |
|
594 | - { |
|
595 | - return false; |
|
596 | - } |
|
597 | - |
|
598 | - #endregion |
|
599 | - |
|
600 | - /** |
|
601 | - * Gets the approval date of the user |
|
602 | - * @return DateTime|false |
|
603 | - */ |
|
604 | - public function getApprovalDate() |
|
605 | - { |
|
606 | - $query = $this->dbObject->prepare(<<<SQL |
|
226 | + ); |
|
227 | + $statement->bindValue(":forceidentified", $this->forceidentified); |
|
228 | + |
|
229 | + $statement->bindValue(':id', $this->id); |
|
230 | + $statement->bindValue(':updateversion', $this->updateversion); |
|
231 | + |
|
232 | + $statement->bindValue(':username', $this->username); |
|
233 | + $statement->bindValue(':email', $this->email); |
|
234 | + $statement->bindValue(':status', $this->status); |
|
235 | + $statement->bindValue(':onwikiname', $this->onwikiname); |
|
236 | + $statement->bindValue(':welcome_sig', $this->welcome_sig); |
|
237 | + $statement->bindValue(':lastactive', $this->lastactive); |
|
238 | + $statement->bindValue(':forcelogout', $this->forcelogout); |
|
239 | + $statement->bindValue(':forceidentified', $this->forceidentified); |
|
240 | + $statement->bindValue(':welcome_template', $this->welcome_template); |
|
241 | + $statement->bindValue(':abortpref', $this->abortpref); |
|
242 | + $statement->bindValue(':confirmationdiff', $this->confirmationdiff); |
|
243 | + $statement->bindValue(':emailsig', $this->emailsig); |
|
244 | + $statement->bindValue(':creationmode', $this->creationmode); |
|
245 | + $statement->bindValue(':skin', $this->skin); |
|
246 | + |
|
247 | + if (!$statement->execute()) { |
|
248 | + throw new Exception($statement->errorInfo()); |
|
249 | + } |
|
250 | + |
|
251 | + if ($statement->rowCount() !== 1) { |
|
252 | + throw new OptimisticLockFailedException(); |
|
253 | + } |
|
254 | + |
|
255 | + $this->updateversion++; |
|
256 | + } |
|
257 | + } |
|
258 | + |
|
259 | + #region properties |
|
260 | + |
|
261 | + /** |
|
262 | + * Gets the tool username |
|
263 | + * @return string |
|
264 | + */ |
|
265 | + public function getUsername() |
|
266 | + { |
|
267 | + return $this->username; |
|
268 | + } |
|
269 | + |
|
270 | + /** |
|
271 | + * Sets the tool username |
|
272 | + * |
|
273 | + * @param string $username |
|
274 | + */ |
|
275 | + public function setUsername($username) |
|
276 | + { |
|
277 | + $this->username = $username; |
|
278 | + |
|
279 | + // If this isn't a brand new user, then it's a rename, force the logout |
|
280 | + if (!$this->isNew()) { |
|
281 | + $this->forcelogout = 1; |
|
282 | + } |
|
283 | + } |
|
284 | + |
|
285 | + /** |
|
286 | + * Gets the user's email address |
|
287 | + * @return string |
|
288 | + */ |
|
289 | + public function getEmail() |
|
290 | + { |
|
291 | + return $this->email; |
|
292 | + } |
|
293 | + |
|
294 | + /** |
|
295 | + * Sets the user's email address |
|
296 | + * |
|
297 | + * @param string $email |
|
298 | + */ |
|
299 | + public function setEmail($email) |
|
300 | + { |
|
301 | + $this->email = $email; |
|
302 | + } |
|
303 | + |
|
304 | + /** |
|
305 | + * Gets the status (User, Admin, Suspended, etc - excludes checkuser) of the user. |
|
306 | + * @return string |
|
307 | + */ |
|
308 | + public function getStatus() |
|
309 | + { |
|
310 | + return $this->status; |
|
311 | + } |
|
312 | + |
|
313 | + /** |
|
314 | + * @param string $status |
|
315 | + */ |
|
316 | + public function setStatus($status) |
|
317 | + { |
|
318 | + $this->status = $status; |
|
319 | + } |
|
320 | + |
|
321 | + /** |
|
322 | + * Gets the user's on-wiki name |
|
323 | + * @return string |
|
324 | + */ |
|
325 | + public function getOnWikiName() |
|
326 | + { |
|
327 | + return $this->onwikiname; |
|
328 | + } |
|
329 | + |
|
330 | + /** |
|
331 | + * Sets the user's on-wiki name |
|
332 | + * |
|
333 | + * This can have interesting side-effects with OAuth. |
|
334 | + * |
|
335 | + * @param string $onWikiName |
|
336 | + */ |
|
337 | + public function setOnWikiName($onWikiName) |
|
338 | + { |
|
339 | + $this->onwikiname = $onWikiName; |
|
340 | + } |
|
341 | + |
|
342 | + /** |
|
343 | + * Gets the welcome signature |
|
344 | + * @return string |
|
345 | + */ |
|
346 | + public function getWelcomeSig() |
|
347 | + { |
|
348 | + return $this->welcome_sig; |
|
349 | + } |
|
350 | + |
|
351 | + /** |
|
352 | + * Sets the welcome signature |
|
353 | + * |
|
354 | + * @param string $welcomeSig |
|
355 | + */ |
|
356 | + public function setWelcomeSig($welcomeSig) |
|
357 | + { |
|
358 | + $this->welcome_sig = $welcomeSig; |
|
359 | + } |
|
360 | + |
|
361 | + /** |
|
362 | + * Gets the last activity date for the user |
|
363 | + * |
|
364 | + * @return string |
|
365 | + * @todo This should probably return an instance of DateTime |
|
366 | + */ |
|
367 | + public function getLastActive() |
|
368 | + { |
|
369 | + return $this->lastactive; |
|
370 | + } |
|
371 | + |
|
372 | + /** |
|
373 | + * Gets the user's forced logout status |
|
374 | + * |
|
375 | + * @return bool |
|
376 | + */ |
|
377 | + public function getForceLogout() |
|
378 | + { |
|
379 | + return $this->forcelogout == 1; |
|
380 | + } |
|
381 | + |
|
382 | + /** |
|
383 | + * Sets the user's forced logout status |
|
384 | + * |
|
385 | + * @param bool $forceLogout |
|
386 | + */ |
|
387 | + public function setForceLogout($forceLogout) |
|
388 | + { |
|
389 | + $this->forcelogout = $forceLogout ? 1 : 0; |
|
390 | + } |
|
391 | + |
|
392 | + /** |
|
393 | + * Returns the ID of the welcome template used. |
|
394 | + * @return int |
|
395 | + */ |
|
396 | + public function getWelcomeTemplate() |
|
397 | + { |
|
398 | + return $this->welcome_template; |
|
399 | + } |
|
400 | + |
|
401 | + /** |
|
402 | + * Sets the ID of the welcome template used. |
|
403 | + * |
|
404 | + * @param int $welcomeTemplate |
|
405 | + */ |
|
406 | + public function setWelcomeTemplate($welcomeTemplate) |
|
407 | + { |
|
408 | + $this->welcome_template = $welcomeTemplate; |
|
409 | + } |
|
410 | + |
|
411 | + /** |
|
412 | + * Gets the user's abort preference |
|
413 | + * @todo this is badly named too! Also a bool that's actually an int. |
|
414 | + * @return int |
|
415 | + */ |
|
416 | + public function getAbortPref() |
|
417 | + { |
|
418 | + return $this->abortpref; |
|
419 | + } |
|
420 | + |
|
421 | + /** |
|
422 | + * Sets the user's abort preference |
|
423 | + * @todo rename, retype, and re-comment. |
|
424 | + * |
|
425 | + * @param int $abortPreference |
|
426 | + */ |
|
427 | + public function setAbortPref($abortPreference) |
|
428 | + { |
|
429 | + $this->abortpref = $abortPreference; |
|
430 | + } |
|
431 | + |
|
432 | + /** |
|
433 | + * Gets the user's confirmation diff. Unused if OAuth is in use. |
|
434 | + * @return int the diff ID |
|
435 | + */ |
|
436 | + public function getConfirmationDiff() |
|
437 | + { |
|
438 | + return $this->confirmationdiff; |
|
439 | + } |
|
440 | + |
|
441 | + /** |
|
442 | + * Sets the user's confirmation diff. |
|
443 | + * |
|
444 | + * @param int $confirmationDiff |
|
445 | + */ |
|
446 | + public function setConfirmationDiff($confirmationDiff) |
|
447 | + { |
|
448 | + $this->confirmationdiff = $confirmationDiff; |
|
449 | + } |
|
450 | + |
|
451 | + /** |
|
452 | + * Gets the users' email signature used on outbound mail. |
|
453 | + * @todo rename me! |
|
454 | + * @return string |
|
455 | + */ |
|
456 | + public function getEmailSig() |
|
457 | + { |
|
458 | + return $this->emailsig; |
|
459 | + } |
|
460 | + |
|
461 | + /** |
|
462 | + * Sets the user's email signature for outbound mail. |
|
463 | + * |
|
464 | + * @param string $emailSignature |
|
465 | + */ |
|
466 | + public function setEmailSig($emailSignature) |
|
467 | + { |
|
468 | + $this->emailsig = $emailSignature; |
|
469 | + } |
|
470 | + |
|
471 | + /** |
|
472 | + * @return int |
|
473 | + */ |
|
474 | + public function getCreationMode() |
|
475 | + { |
|
476 | + return $this->creationmode; |
|
477 | + } |
|
478 | + |
|
479 | + /** |
|
480 | + * @param $creationMode int |
|
481 | + */ |
|
482 | + public function setCreationMode($creationMode) |
|
483 | + { |
|
484 | + $this->creationmode = $creationMode; |
|
485 | + } |
|
486 | + |
|
487 | + /** |
|
488 | + * @return boolean |
|
489 | + */ |
|
490 | + public function getUseAlternateSkin() |
|
491 | + { |
|
492 | + return $this->skin === 'alt'; |
|
493 | + } |
|
494 | + |
|
495 | + /** |
|
496 | + * @return string |
|
497 | + */ |
|
498 | + public function getSkin() |
|
499 | + { |
|
500 | + return $this->skin; |
|
501 | + } |
|
502 | + |
|
503 | + /** |
|
504 | + * @param $skin string |
|
505 | + */ |
|
506 | + public function setSkin($skin) |
|
507 | + { |
|
508 | + $this->skin = $skin; |
|
509 | + } |
|
510 | + |
|
511 | + #endregion |
|
512 | + |
|
513 | + #region user access checks |
|
514 | + |
|
515 | + public function isActive() |
|
516 | + { |
|
517 | + return $this->status == self::STATUS_ACTIVE; |
|
518 | + } |
|
519 | + |
|
520 | + /** |
|
521 | + * Tests if the user is identified |
|
522 | + * |
|
523 | + * @param IdentificationVerifier $iv |
|
524 | + * |
|
525 | + * @return bool |
|
526 | + * @todo Figure out what on earth is going on with PDO's typecasting here. Apparently, it returns string("0") for |
|
527 | + * the force-unidentified case, and int(1) for the identified case?! This is quite ugly, but probably needed |
|
528 | + * to play it safe for now. |
|
529 | + * @category Security-Critical |
|
530 | + */ |
|
531 | + public function isIdentified(IdentificationVerifier $iv) |
|
532 | + { |
|
533 | + if ($this->forceidentified === 0 || $this->forceidentified === "0") { |
|
534 | + // User forced to unidentified in the database. |
|
535 | + return false; |
|
536 | + } |
|
537 | + elseif ($this->forceidentified === 1 || $this->forceidentified === "1") { |
|
538 | + // User forced to identified in the database. |
|
539 | + return true; |
|
540 | + } |
|
541 | + else { |
|
542 | + // User not forced to any particular identified status; consult IdentificationVerifier |
|
543 | + return $iv->isUserIdentified($this->getOnWikiName()); |
|
544 | + } |
|
545 | + } |
|
546 | + |
|
547 | + /** |
|
548 | + * DO NOT USE FOR TESTING IDENTIFICATION STATUS. |
|
549 | + * |
|
550 | + * @return bool|null |
|
551 | + */ |
|
552 | + public function getForceIdentified() { |
|
553 | + return $this->forceidentified; |
|
554 | + } |
|
555 | + |
|
556 | + /** |
|
557 | + * Tests if the user is suspended |
|
558 | + * @return bool |
|
559 | + * @category Security-Critical |
|
560 | + */ |
|
561 | + public function isSuspended() |
|
562 | + { |
|
563 | + return $this->status == self::STATUS_SUSPENDED; |
|
564 | + } |
|
565 | + |
|
566 | + /** |
|
567 | + * Tests if the user is new |
|
568 | + * @return bool |
|
569 | + * @category Security-Critical |
|
570 | + */ |
|
571 | + public function isNewUser() |
|
572 | + { |
|
573 | + return $this->status == self::STATUS_NEW; |
|
574 | + } |
|
575 | + |
|
576 | + /** |
|
577 | + * Tests if the user has been declined access to the tool |
|
578 | + * @return bool |
|
579 | + * @category Security-Critical |
|
580 | + */ |
|
581 | + public function isDeclined() |
|
582 | + { |
|
583 | + return $this->status == self::STATUS_DECLINED; |
|
584 | + } |
|
585 | + |
|
586 | + /** |
|
587 | + * Tests if the user is the community user |
|
588 | + * |
|
589 | + * @todo decide if this means logged out. I think it usually does. |
|
590 | + * @return bool |
|
591 | + * @category Security-Critical |
|
592 | + */ |
|
593 | + public function isCommunityUser() |
|
594 | + { |
|
595 | + return false; |
|
596 | + } |
|
597 | + |
|
598 | + #endregion |
|
599 | + |
|
600 | + /** |
|
601 | + * Gets the approval date of the user |
|
602 | + * @return DateTime|false |
|
603 | + */ |
|
604 | + public function getApprovalDate() |
|
605 | + { |
|
606 | + $query = $this->dbObject->prepare(<<<SQL |
|
607 | 607 | SELECT timestamp |
608 | 608 | FROM log |
609 | 609 | WHERE objectid = :userid |
@@ -612,12 +612,12 @@ discard block |
||
612 | 612 | ORDER BY id DESC |
613 | 613 | LIMIT 1; |
614 | 614 | SQL |
615 | - ); |
|
616 | - $query->execute(array(":userid" => $this->id)); |
|
615 | + ); |
|
616 | + $query->execute(array(":userid" => $this->id)); |
|
617 | 617 | |
618 | - $data = DateTime::createFromFormat("Y-m-d H:i:s", $query->fetchColumn()); |
|
619 | - $query->closeCursor(); |
|
618 | + $data = DateTime::createFromFormat("Y-m-d H:i:s", $query->fetchColumn()); |
|
619 | + $query->closeCursor(); |
|
620 | 620 | |
621 | - return $data; |
|
622 | - } |
|
621 | + return $data; |
|
622 | + } |
|
623 | 623 | } |
@@ -549,7 +549,8 @@ |
||
549 | 549 | * |
550 | 550 | * @return bool|null |
551 | 551 | */ |
552 | - public function getForceIdentified() { |
|
552 | + public function getForceIdentified() |
|
553 | + { |
|
553 | 554 | return $this->forceidentified; |
554 | 555 | } |
555 | 556 |
@@ -23,13 +23,13 @@ discard block |
||
23 | 23 | |
24 | 24 | class StatsUsers extends InternalPageBase |
25 | 25 | { |
26 | - public function main() |
|
27 | - { |
|
28 | - $this->setHtmlTitle('Users :: Statistics'); |
|
26 | + public function main() |
|
27 | + { |
|
28 | + $this->setHtmlTitle('Users :: Statistics'); |
|
29 | 29 | |
30 | - $database = $this->getDatabase(); |
|
30 | + $database = $this->getDatabase(); |
|
31 | 31 | |
32 | - $query = <<<SQL |
|
32 | + $query = <<<SQL |
|
33 | 33 | SELECT |
34 | 34 | u.id |
35 | 35 | , u.username |
@@ -45,34 +45,34 @@ discard block |
||
45 | 45 | WHERE u.status = 'Active' |
46 | 46 | SQL; |
47 | 47 | |
48 | - $users = $database->query($query)->fetchAll(PDO::FETCH_ASSOC); |
|
49 | - $this->assign('users', $users); |
|
48 | + $users = $database->query($query)->fetchAll(PDO::FETCH_ASSOC); |
|
49 | + $this->assign('users', $users); |
|
50 | 50 | |
51 | - $this->assign('statsPageTitle', 'Account Creation Tool users'); |
|
52 | - $this->setTemplate("statistics/users.tpl"); |
|
53 | - } |
|
51 | + $this->assign('statsPageTitle', 'Account Creation Tool users'); |
|
52 | + $this->setTemplate("statistics/users.tpl"); |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * Entry point for the detail action. |
|
57 | - * |
|
58 | - * @throws ApplicationLogicException |
|
59 | - */ |
|
60 | - protected function detail() |
|
61 | - { |
|
62 | - $userId = WebRequest::getInt('user'); |
|
63 | - if ($userId === null) { |
|
64 | - throw new ApplicationLogicException("User not found"); |
|
65 | - } |
|
55 | + /** |
|
56 | + * Entry point for the detail action. |
|
57 | + * |
|
58 | + * @throws ApplicationLogicException |
|
59 | + */ |
|
60 | + protected function detail() |
|
61 | + { |
|
62 | + $userId = WebRequest::getInt('user'); |
|
63 | + if ($userId === null) { |
|
64 | + throw new ApplicationLogicException("User not found"); |
|
65 | + } |
|
66 | 66 | |
67 | - $database = $this->getDatabase(); |
|
67 | + $database = $this->getDatabase(); |
|
68 | 68 | |
69 | - $user = User::getById($userId, $database); |
|
70 | - if ($user == false) { |
|
71 | - throw new ApplicationLogicException('User not found'); |
|
72 | - } |
|
69 | + $user = User::getById($userId, $database); |
|
70 | + if ($user == false) { |
|
71 | + throw new ApplicationLogicException('User not found'); |
|
72 | + } |
|
73 | 73 | |
74 | 74 | |
75 | - $activitySummary = $database->prepare(<<<SQL |
|
75 | + $activitySummary = $database->prepare(<<<SQL |
|
76 | 76 | SELECT COALESCE(closes.mail_desc, log.action) AS action, COUNT(*) AS count |
77 | 77 | FROM log |
78 | 78 | INNER JOIN user ON log.user = user.id |
@@ -80,14 +80,14 @@ discard block |
||
80 | 80 | WHERE user.username = :username |
81 | 81 | GROUP BY action; |
82 | 82 | SQL |
83 | - ); |
|
84 | - $activitySummary->execute(array(":username" => $user->getUsername())); |
|
85 | - $activitySummaryData = $activitySummary->fetchAll(PDO::FETCH_ASSOC); |
|
83 | + ); |
|
84 | + $activitySummary->execute(array(":username" => $user->getUsername())); |
|
85 | + $activitySummaryData = $activitySummary->fetchAll(PDO::FETCH_ASSOC); |
|
86 | 86 | |
87 | - $this->assign("user", $user); |
|
88 | - $this->assign("activity", $activitySummaryData); |
|
87 | + $this->assign("user", $user); |
|
88 | + $this->assign("activity", $activitySummaryData); |
|
89 | 89 | |
90 | - $usersCreatedQuery = $database->prepare(<<<SQL |
|
90 | + $usersCreatedQuery = $database->prepare(<<<SQL |
|
91 | 91 | SELECT log.timestamp time, request.name name, request.id id |
92 | 92 | FROM log |
93 | 93 | INNER JOIN request ON (request.id = log.objectid AND log.objecttype = 'Request') |
@@ -98,12 +98,12 @@ discard block |
||
98 | 98 | AND (emailtemplate.oncreated = '1' OR log.action = 'Closed custom-y') |
99 | 99 | ORDER BY log.timestamp; |
100 | 100 | SQL |
101 | - ); |
|
102 | - $usersCreatedQuery->execute(array(":username" => $user->getUsername())); |
|
103 | - $usersCreated = $usersCreatedQuery->fetchAll(PDO::FETCH_ASSOC); |
|
104 | - $this->assign("created", $usersCreated); |
|
101 | + ); |
|
102 | + $usersCreatedQuery->execute(array(":username" => $user->getUsername())); |
|
103 | + $usersCreated = $usersCreatedQuery->fetchAll(PDO::FETCH_ASSOC); |
|
104 | + $this->assign("created", $usersCreated); |
|
105 | 105 | |
106 | - $usersNotCreatedQuery = $database->prepare(<<<SQL |
|
106 | + $usersNotCreatedQuery = $database->prepare(<<<SQL |
|
107 | 107 | SELECT log.timestamp time, request.name name, request.id id |
108 | 108 | FROM log |
109 | 109 | JOIN request ON request.id = log.objectid AND log.objecttype = 'Request' |
@@ -114,54 +114,54 @@ discard block |
||
114 | 114 | AND (emailtemplate.oncreated = '0' OR log.action = 'Closed custom-n' OR log.action = 'Closed 0') |
115 | 115 | ORDER BY log.timestamp; |
116 | 116 | SQL |
117 | - ); |
|
118 | - $usersNotCreatedQuery->execute(array(":username" => $user->getUsername())); |
|
119 | - $usersNotCreated = $usersNotCreatedQuery->fetchAll(PDO::FETCH_ASSOC); |
|
120 | - $this->assign("notcreated", $usersNotCreated); |
|
121 | - |
|
122 | - /** @var Log[] $logs */ |
|
123 | - $logs = LogSearchHelper::get($database) |
|
124 | - ->byObjectType('User') |
|
125 | - ->byObjectId($user->getId()) |
|
126 | - ->getRecordCount($logCount) |
|
127 | - ->fetch(); |
|
128 | - |
|
129 | - if ($logCount === 0) { |
|
130 | - $this->assign('accountlog', array()); |
|
131 | - } |
|
132 | - else { |
|
133 | - list($users, $logData) = LogHelper::prepareLogsForTemplate($logs, $database, $this->getSiteConfiguration()); |
|
134 | - |
|
135 | - $this->assign("accountlog", $logData); |
|
136 | - $this->assign("users", $users); |
|
137 | - } |
|
138 | - |
|
139 | - $currentUser = User::getCurrent($database); |
|
140 | - $this->assign('canApprove', $this->barrierTest('approve', $currentUser, PageUserManagement::class)); |
|
141 | - $this->assign('canDecline', $this->barrierTest('decline', $currentUser, PageUserManagement::class)); |
|
142 | - $this->assign('canRename', $this->barrierTest('rename', $currentUser, PageUserManagement::class)); |
|
143 | - $this->assign('canEditUser', $this->barrierTest('editUser', $currentUser, PageUserManagement::class)); |
|
144 | - $this->assign('canSuspend', $this->barrierTest('suspend', $currentUser, PageUserManagement::class)); |
|
145 | - $this->assign('canEditRoles', $this->barrierTest('editRoles', $currentUser, PageUserManagement::class)); |
|
146 | - |
|
147 | - $oauth = new OAuthUserHelper($user, $database, $this->getOAuthProtocolHelper(), $this->getSiteConfiguration()); |
|
148 | - $this->assign('oauth', $oauth); |
|
149 | - |
|
150 | - if($user->getForceIdentified() === null) { |
|
151 | - $idVerifier = new IdentificationVerifier($this->getHttpHelper(), $this->getSiteConfiguration(), $this->getDatabase()); |
|
152 | - $this->assign('identificationStatus', $idVerifier->isUserIdentified($user->getOnWikiName()) ? 'detected' : 'missing'); |
|
153 | - } else { |
|
154 | - $this->assign('identificationStatus', $user->getForceIdentified() == 1 ? 'forced-on' : 'forced-off'); |
|
155 | - } |
|
156 | - |
|
157 | - if ($oauth->isFullyLinked()) { |
|
158 | - $this->assign('identity', $oauth->getIdentity(true)); |
|
159 | - $this->assign('identityExpired', $oauth->identityExpired()); |
|
160 | - } |
|
161 | - |
|
162 | - $this->assign('statsPageTitle', 'Account Creation Tool users'); |
|
163 | - |
|
164 | - $this->setHtmlTitle('{$user->getUsername()|escape} :: Users :: Statistics'); |
|
165 | - $this->setTemplate("statistics/userdetail.tpl"); |
|
166 | - } |
|
117 | + ); |
|
118 | + $usersNotCreatedQuery->execute(array(":username" => $user->getUsername())); |
|
119 | + $usersNotCreated = $usersNotCreatedQuery->fetchAll(PDO::FETCH_ASSOC); |
|
120 | + $this->assign("notcreated", $usersNotCreated); |
|
121 | + |
|
122 | + /** @var Log[] $logs */ |
|
123 | + $logs = LogSearchHelper::get($database) |
|
124 | + ->byObjectType('User') |
|
125 | + ->byObjectId($user->getId()) |
|
126 | + ->getRecordCount($logCount) |
|
127 | + ->fetch(); |
|
128 | + |
|
129 | + if ($logCount === 0) { |
|
130 | + $this->assign('accountlog', array()); |
|
131 | + } |
|
132 | + else { |
|
133 | + list($users, $logData) = LogHelper::prepareLogsForTemplate($logs, $database, $this->getSiteConfiguration()); |
|
134 | + |
|
135 | + $this->assign("accountlog", $logData); |
|
136 | + $this->assign("users", $users); |
|
137 | + } |
|
138 | + |
|
139 | + $currentUser = User::getCurrent($database); |
|
140 | + $this->assign('canApprove', $this->barrierTest('approve', $currentUser, PageUserManagement::class)); |
|
141 | + $this->assign('canDecline', $this->barrierTest('decline', $currentUser, PageUserManagement::class)); |
|
142 | + $this->assign('canRename', $this->barrierTest('rename', $currentUser, PageUserManagement::class)); |
|
143 | + $this->assign('canEditUser', $this->barrierTest('editUser', $currentUser, PageUserManagement::class)); |
|
144 | + $this->assign('canSuspend', $this->barrierTest('suspend', $currentUser, PageUserManagement::class)); |
|
145 | + $this->assign('canEditRoles', $this->barrierTest('editRoles', $currentUser, PageUserManagement::class)); |
|
146 | + |
|
147 | + $oauth = new OAuthUserHelper($user, $database, $this->getOAuthProtocolHelper(), $this->getSiteConfiguration()); |
|
148 | + $this->assign('oauth', $oauth); |
|
149 | + |
|
150 | + if($user->getForceIdentified() === null) { |
|
151 | + $idVerifier = new IdentificationVerifier($this->getHttpHelper(), $this->getSiteConfiguration(), $this->getDatabase()); |
|
152 | + $this->assign('identificationStatus', $idVerifier->isUserIdentified($user->getOnWikiName()) ? 'detected' : 'missing'); |
|
153 | + } else { |
|
154 | + $this->assign('identificationStatus', $user->getForceIdentified() == 1 ? 'forced-on' : 'forced-off'); |
|
155 | + } |
|
156 | + |
|
157 | + if ($oauth->isFullyLinked()) { |
|
158 | + $this->assign('identity', $oauth->getIdentity(true)); |
|
159 | + $this->assign('identityExpired', $oauth->identityExpired()); |
|
160 | + } |
|
161 | + |
|
162 | + $this->assign('statsPageTitle', 'Account Creation Tool users'); |
|
163 | + |
|
164 | + $this->setHtmlTitle('{$user->getUsername()|escape} :: Users :: Statistics'); |
|
165 | + $this->setTemplate("statistics/userdetail.tpl"); |
|
166 | + } |
|
167 | 167 | } |
@@ -147,7 +147,7 @@ |
||
147 | 147 | $oauth = new OAuthUserHelper($user, $database, $this->getOAuthProtocolHelper(), $this->getSiteConfiguration()); |
148 | 148 | $this->assign('oauth', $oauth); |
149 | 149 | |
150 | - if($user->getForceIdentified() === null) { |
|
150 | + if ($user->getForceIdentified() === null) { |
|
151 | 151 | $idVerifier = new IdentificationVerifier($this->getHttpHelper(), $this->getSiteConfiguration(), $this->getDatabase()); |
152 | 152 | $this->assign('identificationStatus', $idVerifier->isUserIdentified($user->getOnWikiName()) ? 'detected' : 'missing'); |
153 | 153 | } else { |
@@ -150,7 +150,8 @@ |
||
150 | 150 | if($user->getForceIdentified() === null) { |
151 | 151 | $idVerifier = new IdentificationVerifier($this->getHttpHelper(), $this->getSiteConfiguration(), $this->getDatabase()); |
152 | 152 | $this->assign('identificationStatus', $idVerifier->isUserIdentified($user->getOnWikiName()) ? 'detected' : 'missing'); |
153 | - } else { |
|
153 | + } |
|
154 | + else { |
|
154 | 155 | $this->assign('identificationStatus', $user->getForceIdentified() == 1 ? 'forced-on' : 'forced-off'); |
155 | 156 | } |
156 | 157 |
@@ -33,151 +33,151 @@ |
||
33 | 33 | */ |
34 | 34 | class PageCreateRequest extends RequestActionBase |
35 | 35 | { |
36 | - /** |
|
37 | - * Main function for this page, when no specific actions are called. |
|
38 | - * @return void |
|
39 | - * @throws AccessDeniedException |
|
40 | - * @throws ApplicationLogicException |
|
41 | - */ |
|
42 | - protected function main() |
|
43 | - { |
|
44 | - $this->checkPosted(); |
|
45 | - |
|
46 | - $database = $this->getDatabase(); |
|
47 | - |
|
48 | - $request = $this->getRequest($database); |
|
49 | - $template = $this->getTemplate($database); |
|
50 | - $creationMode = $this->getCreationMode(); |
|
51 | - $user = User::getCurrent($database); |
|
52 | - |
|
53 | - $secMgr = $this->getSecurityManager(); |
|
54 | - if ($secMgr->allows('RequestCreation', User::CREATION_BOT, $user) !== SecurityManager::ALLOWED |
|
55 | - && $creationMode === 'bot' |
|
56 | - ) { |
|
57 | - throw new AccessDeniedException($secMgr); |
|
58 | - } |
|
59 | - elseif ($secMgr->allows('RequestCreation', User::CREATION_OAUTH, $user) !== SecurityManager::ALLOWED |
|
60 | - && $creationMode === 'oauth' |
|
61 | - ) { |
|
62 | - throw new AccessDeniedException($secMgr); |
|
63 | - } |
|
64 | - |
|
65 | - if ($request->getEmailSent()) { |
|
66 | - throw new ApplicationLogicException('This requester has already had an email sent to them. Please fall back to manual creation'); |
|
67 | - } |
|
68 | - |
|
69 | - $request->setStatus(RequestStatus::JOBQUEUE); |
|
70 | - $request->setReserved(null); |
|
71 | - $request->save(); |
|
72 | - |
|
73 | - Logger::enqueuedJobQueue($database, $request); |
|
74 | - |
|
75 | - $creationTaskId = $this->enqueueCreationTask($creationMode, $request, $template, $user, $database); |
|
76 | - |
|
77 | - if ($user->getWelcomeTemplate() !== null && !WebRequest::postBoolean('skipAutoWelcome')) { |
|
78 | - $this->enqueueWelcomeTask($request, $creationTaskId, $user, $database); |
|
79 | - } |
|
80 | - |
|
81 | - SessionAlert::success("Request {$request->getId()} has been queued for autocreation"); |
|
82 | - |
|
83 | - $this->redirect(); |
|
84 | - } |
|
85 | - |
|
86 | - protected function getCreationMode() |
|
87 | - { |
|
88 | - $creationMode = WebRequest::postString('mode'); |
|
89 | - if ($creationMode !== 'oauth' && $creationMode !== 'bot') { |
|
90 | - throw new ApplicationLogicException('Unknown creation mode'); |
|
91 | - } |
|
92 | - |
|
93 | - return $creationMode; |
|
94 | - } |
|
95 | - |
|
96 | - /** |
|
97 | - * @param PdoDatabase $database |
|
98 | - * |
|
99 | - * @return EmailTemplate |
|
100 | - * @throws ApplicationLogicException |
|
101 | - */ |
|
102 | - protected function getTemplate(PdoDatabase $database) |
|
103 | - { |
|
104 | - $templateId = WebRequest::postInt('template'); |
|
105 | - if ($templateId === null) { |
|
106 | - throw new ApplicationLogicException('No template specified'); |
|
107 | - } |
|
108 | - |
|
109 | - /** @var EmailTemplate $template */ |
|
110 | - $template = EmailTemplate::getById($templateId, $database); |
|
111 | - if ($template === false || !$template->getActive()) { |
|
112 | - throw new ApplicationLogicException('Invalid or inactive template specified'); |
|
113 | - } |
|
114 | - |
|
115 | - if ($template->getDefaultAction() !== EmailTemplate::CREATED) { |
|
116 | - throw new ApplicationLogicException('Specified template is not a creation template!'); |
|
117 | - } |
|
118 | - |
|
119 | - return $template; |
|
120 | - } |
|
121 | - |
|
122 | - /** |
|
123 | - * @param PdoDatabase $database |
|
124 | - * |
|
125 | - * @return Request |
|
126 | - * @throws ApplicationLogicException |
|
127 | - */ |
|
128 | - protected function getRequest(PdoDatabase $database) |
|
129 | - { |
|
130 | - $request = parent::getRequest($database); |
|
131 | - |
|
132 | - if ($request->getStatus() == RequestStatus::CLOSED) { |
|
133 | - throw new ApplicationLogicException('Request is already closed'); |
|
134 | - } |
|
135 | - |
|
136 | - return $request; |
|
137 | - } |
|
138 | - |
|
139 | - /** |
|
140 | - * @param $creationMode |
|
141 | - * @param Request $request |
|
142 | - * @param EmailTemplate $template |
|
143 | - * @param User $user |
|
144 | - * |
|
145 | - * @param PdoDatabase $database |
|
146 | - * |
|
147 | - * @return int |
|
148 | - * @throws ApplicationLogicException |
|
149 | - */ |
|
150 | - protected function enqueueCreationTask( |
|
151 | - $creationMode, |
|
152 | - Request $request, |
|
153 | - EmailTemplate $template, |
|
154 | - User $user, |
|
155 | - PdoDatabase $database |
|
156 | - ) { |
|
157 | - $creationTaskClass = null; |
|
158 | - |
|
159 | - if ($creationMode == "oauth") { |
|
160 | - $creationTaskClass = UserCreationTask::class; |
|
161 | - } |
|
162 | - |
|
163 | - if ($creationMode == "bot") { |
|
164 | - $creationTaskClass = BotCreationTask::class; |
|
165 | - } |
|
166 | - |
|
167 | - if ($creationTaskClass === null) { |
|
168 | - throw new ApplicationLogicException('Cannot determine creation mode'); |
|
169 | - } |
|
170 | - |
|
171 | - $creationTask = new JobQueue(); |
|
172 | - $creationTask->setTask($creationTaskClass); |
|
173 | - $creationTask->setRequest($request->getId()); |
|
174 | - $creationTask->setEmailTemplate($template->getId()); |
|
175 | - $creationTask->setTriggerUserId($user->getId()); |
|
176 | - $creationTask->setDatabase($database); |
|
177 | - $creationTask->save(); |
|
178 | - |
|
179 | - $creationTaskId = $creationTask->getId(); |
|
180 | - |
|
181 | - return $creationTaskId; |
|
182 | - } |
|
36 | + /** |
|
37 | + * Main function for this page, when no specific actions are called. |
|
38 | + * @return void |
|
39 | + * @throws AccessDeniedException |
|
40 | + * @throws ApplicationLogicException |
|
41 | + */ |
|
42 | + protected function main() |
|
43 | + { |
|
44 | + $this->checkPosted(); |
|
45 | + |
|
46 | + $database = $this->getDatabase(); |
|
47 | + |
|
48 | + $request = $this->getRequest($database); |
|
49 | + $template = $this->getTemplate($database); |
|
50 | + $creationMode = $this->getCreationMode(); |
|
51 | + $user = User::getCurrent($database); |
|
52 | + |
|
53 | + $secMgr = $this->getSecurityManager(); |
|
54 | + if ($secMgr->allows('RequestCreation', User::CREATION_BOT, $user) !== SecurityManager::ALLOWED |
|
55 | + && $creationMode === 'bot' |
|
56 | + ) { |
|
57 | + throw new AccessDeniedException($secMgr); |
|
58 | + } |
|
59 | + elseif ($secMgr->allows('RequestCreation', User::CREATION_OAUTH, $user) !== SecurityManager::ALLOWED |
|
60 | + && $creationMode === 'oauth' |
|
61 | + ) { |
|
62 | + throw new AccessDeniedException($secMgr); |
|
63 | + } |
|
64 | + |
|
65 | + if ($request->getEmailSent()) { |
|
66 | + throw new ApplicationLogicException('This requester has already had an email sent to them. Please fall back to manual creation'); |
|
67 | + } |
|
68 | + |
|
69 | + $request->setStatus(RequestStatus::JOBQUEUE); |
|
70 | + $request->setReserved(null); |
|
71 | + $request->save(); |
|
72 | + |
|
73 | + Logger::enqueuedJobQueue($database, $request); |
|
74 | + |
|
75 | + $creationTaskId = $this->enqueueCreationTask($creationMode, $request, $template, $user, $database); |
|
76 | + |
|
77 | + if ($user->getWelcomeTemplate() !== null && !WebRequest::postBoolean('skipAutoWelcome')) { |
|
78 | + $this->enqueueWelcomeTask($request, $creationTaskId, $user, $database); |
|
79 | + } |
|
80 | + |
|
81 | + SessionAlert::success("Request {$request->getId()} has been queued for autocreation"); |
|
82 | + |
|
83 | + $this->redirect(); |
|
84 | + } |
|
85 | + |
|
86 | + protected function getCreationMode() |
|
87 | + { |
|
88 | + $creationMode = WebRequest::postString('mode'); |
|
89 | + if ($creationMode !== 'oauth' && $creationMode !== 'bot') { |
|
90 | + throw new ApplicationLogicException('Unknown creation mode'); |
|
91 | + } |
|
92 | + |
|
93 | + return $creationMode; |
|
94 | + } |
|
95 | + |
|
96 | + /** |
|
97 | + * @param PdoDatabase $database |
|
98 | + * |
|
99 | + * @return EmailTemplate |
|
100 | + * @throws ApplicationLogicException |
|
101 | + */ |
|
102 | + protected function getTemplate(PdoDatabase $database) |
|
103 | + { |
|
104 | + $templateId = WebRequest::postInt('template'); |
|
105 | + if ($templateId === null) { |
|
106 | + throw new ApplicationLogicException('No template specified'); |
|
107 | + } |
|
108 | + |
|
109 | + /** @var EmailTemplate $template */ |
|
110 | + $template = EmailTemplate::getById($templateId, $database); |
|
111 | + if ($template === false || !$template->getActive()) { |
|
112 | + throw new ApplicationLogicException('Invalid or inactive template specified'); |
|
113 | + } |
|
114 | + |
|
115 | + if ($template->getDefaultAction() !== EmailTemplate::CREATED) { |
|
116 | + throw new ApplicationLogicException('Specified template is not a creation template!'); |
|
117 | + } |
|
118 | + |
|
119 | + return $template; |
|
120 | + } |
|
121 | + |
|
122 | + /** |
|
123 | + * @param PdoDatabase $database |
|
124 | + * |
|
125 | + * @return Request |
|
126 | + * @throws ApplicationLogicException |
|
127 | + */ |
|
128 | + protected function getRequest(PdoDatabase $database) |
|
129 | + { |
|
130 | + $request = parent::getRequest($database); |
|
131 | + |
|
132 | + if ($request->getStatus() == RequestStatus::CLOSED) { |
|
133 | + throw new ApplicationLogicException('Request is already closed'); |
|
134 | + } |
|
135 | + |
|
136 | + return $request; |
|
137 | + } |
|
138 | + |
|
139 | + /** |
|
140 | + * @param $creationMode |
|
141 | + * @param Request $request |
|
142 | + * @param EmailTemplate $template |
|
143 | + * @param User $user |
|
144 | + * |
|
145 | + * @param PdoDatabase $database |
|
146 | + * |
|
147 | + * @return int |
|
148 | + * @throws ApplicationLogicException |
|
149 | + */ |
|
150 | + protected function enqueueCreationTask( |
|
151 | + $creationMode, |
|
152 | + Request $request, |
|
153 | + EmailTemplate $template, |
|
154 | + User $user, |
|
155 | + PdoDatabase $database |
|
156 | + ) { |
|
157 | + $creationTaskClass = null; |
|
158 | + |
|
159 | + if ($creationMode == "oauth") { |
|
160 | + $creationTaskClass = UserCreationTask::class; |
|
161 | + } |
|
162 | + |
|
163 | + if ($creationMode == "bot") { |
|
164 | + $creationTaskClass = BotCreationTask::class; |
|
165 | + } |
|
166 | + |
|
167 | + if ($creationTaskClass === null) { |
|
168 | + throw new ApplicationLogicException('Cannot determine creation mode'); |
|
169 | + } |
|
170 | + |
|
171 | + $creationTask = new JobQueue(); |
|
172 | + $creationTask->setTask($creationTaskClass); |
|
173 | + $creationTask->setRequest($request->getId()); |
|
174 | + $creationTask->setEmailTemplate($template->getId()); |
|
175 | + $creationTask->setTriggerUserId($user->getId()); |
|
176 | + $creationTask->setDatabase($database); |
|
177 | + $creationTask->save(); |
|
178 | + |
|
179 | + $creationTaskId = $creationTask->getId(); |
|
180 | + |
|
181 | + return $creationTaskId; |
|
182 | + } |
|
183 | 183 | } |
@@ -14,22 +14,22 @@ |
||
14 | 14 | |
15 | 15 | class PageLogout extends InternalPageBase |
16 | 16 | { |
17 | - /** |
|
18 | - * Main function for this page, when no specific actions are called. |
|
19 | - */ |
|
20 | - protected function main() |
|
21 | - { |
|
22 | - if(WebRequest::wasPosted()) { |
|
23 | - Session::destroy(); |
|
24 | - $this->redirect("login"); |
|
25 | - return; |
|
26 | - } |
|
17 | + /** |
|
18 | + * Main function for this page, when no specific actions are called. |
|
19 | + */ |
|
20 | + protected function main() |
|
21 | + { |
|
22 | + if(WebRequest::wasPosted()) { |
|
23 | + Session::destroy(); |
|
24 | + $this->redirect("login"); |
|
25 | + return; |
|
26 | + } |
|
27 | 27 | |
28 | - $this->redirect(); |
|
29 | - } |
|
28 | + $this->redirect(); |
|
29 | + } |
|
30 | 30 | |
31 | - protected function isProtectedPage() |
|
32 | - { |
|
33 | - return false; |
|
34 | - } |
|
31 | + protected function isProtectedPage() |
|
32 | + { |
|
33 | + return false; |
|
34 | + } |
|
35 | 35 | } |
@@ -19,7 +19,7 @@ |
||
19 | 19 | */ |
20 | 20 | protected function main() |
21 | 21 | { |
22 | - if(WebRequest::wasPosted()) { |
|
22 | + if (WebRequest::wasPosted()) { |
|
23 | 23 | Session::destroy(); |
24 | 24 | $this->redirect("login"); |
25 | 25 | return; |
@@ -32,225 +32,225 @@ |
||
32 | 32 | */ |
33 | 33 | class WebStart extends ApplicationBase |
34 | 34 | { |
35 | - /** |
|
36 | - * @var IRequestRouter $requestRouter The request router to use. Note that different entry points have different |
|
37 | - * routers and hence different URL mappings |
|
38 | - */ |
|
39 | - private $requestRouter; |
|
40 | - /** |
|
41 | - * @var bool $isPublic Determines whether to use public interface objects or internal interface objects |
|
42 | - */ |
|
43 | - private $isPublic = false; |
|
44 | - |
|
45 | - /** |
|
46 | - * WebStart constructor. |
|
47 | - * |
|
48 | - * @param SiteConfiguration $configuration The site configuration |
|
49 | - * @param IRequestRouter $router The request router to use |
|
50 | - */ |
|
51 | - public function __construct(SiteConfiguration $configuration, IRequestRouter $router) |
|
52 | - { |
|
53 | - parent::__construct($configuration); |
|
54 | - |
|
55 | - $this->requestRouter = $router; |
|
56 | - } |
|
57 | - |
|
58 | - /** |
|
59 | - * @param ITask $page |
|
60 | - * @param SiteConfiguration $siteConfiguration |
|
61 | - * @param PdoDatabase $database |
|
62 | - * @param PdoDatabase $notificationsDatabase |
|
63 | - * |
|
64 | - * @return void |
|
65 | - */ |
|
66 | - protected function setupHelpers( |
|
67 | - ITask $page, |
|
68 | - SiteConfiguration $siteConfiguration, |
|
69 | - PdoDatabase $database, |
|
70 | - PdoDatabase $notificationsDatabase = null |
|
71 | - ) { |
|
72 | - parent::setupHelpers($page, $siteConfiguration, $database, $notificationsDatabase); |
|
73 | - |
|
74 | - if ($page instanceof PageBase) { |
|
75 | - $page->setTokenManager(new TokenManager()); |
|
76 | - $page->setCspManager(new ContentSecurityPolicyManager($siteConfiguration)); |
|
77 | - |
|
78 | - if ($page instanceof InternalPageBase) { |
|
79 | - $page->setTypeAheadHelper(new TypeAheadHelper()); |
|
80 | - |
|
81 | - $identificationVerifier = new IdentificationVerifier($page->getHttpHelper(), $siteConfiguration, |
|
82 | - $database); |
|
83 | - $page->setIdentificationVerifier($identificationVerifier); |
|
84 | - |
|
85 | - $page->setSecurityManager(new SecurityManager($identificationVerifier, new RoleConfiguration())); |
|
86 | - |
|
87 | - if ($siteConfiguration->getTitleBlacklistEnabled()) { |
|
88 | - $page->setBlacklistHelper(new FakeBlacklistHelper()); |
|
89 | - } |
|
90 | - else { |
|
91 | - $page->setBlacklistHelper(new BlacklistHelper($page->getHttpHelper(), |
|
92 | - $siteConfiguration->getMediawikiWebServiceEndpoint())); |
|
93 | - } |
|
94 | - } |
|
95 | - } |
|
96 | - } |
|
97 | - |
|
98 | - /** |
|
99 | - * Application entry point. |
|
100 | - * |
|
101 | - * Sets up the environment and runs the application, performing any global cleanup operations when done. |
|
102 | - */ |
|
103 | - public function run() |
|
104 | - { |
|
105 | - try { |
|
106 | - if ($this->setupEnvironment()) { |
|
107 | - $this->main(); |
|
108 | - } |
|
109 | - } |
|
110 | - catch (EnvironmentException $ex) { |
|
111 | - ob_end_clean(); |
|
112 | - print Offline::getOfflineMessage($this->isPublic(), $ex->getMessage()); |
|
113 | - } |
|
114 | - catch (ReadableException $ex) { |
|
115 | - ob_end_clean(); |
|
116 | - print $ex->getReadableError(); |
|
117 | - } |
|
118 | - finally { |
|
119 | - $this->cleanupEnvironment(); |
|
120 | - } |
|
121 | - } |
|
122 | - |
|
123 | - /** |
|
124 | - * Environment setup |
|
125 | - * |
|
126 | - * This method initialises the tool environment. If the tool cannot be initialised correctly, it will return false |
|
127 | - * and shut down prematurely. |
|
128 | - * |
|
129 | - * @return bool |
|
130 | - * @throws EnvironmentException |
|
131 | - */ |
|
132 | - protected function setupEnvironment() |
|
133 | - { |
|
134 | - // initialise global exception handler |
|
135 | - set_exception_handler(array(ExceptionHandler::class, 'exceptionHandler')); |
|
136 | - set_error_handler(array(ExceptionHandler::class, 'errorHandler'), E_RECOVERABLE_ERROR); |
|
137 | - |
|
138 | - // start output buffering if necessary |
|
139 | - if (ob_get_level() === 0) { |
|
140 | - ob_start(); |
|
141 | - } |
|
142 | - |
|
143 | - // initialise super-global providers |
|
144 | - WebRequest::setGlobalStateProvider(new GlobalStateProvider()); |
|
145 | - |
|
146 | - if (Offline::isOffline()) { |
|
147 | - print Offline::getOfflineMessage($this->isPublic()); |
|
148 | - ob_end_flush(); |
|
149 | - |
|
150 | - return false; |
|
151 | - } |
|
152 | - |
|
153 | - // Call parent setup |
|
154 | - if (!parent::setupEnvironment()) { |
|
155 | - return false; |
|
156 | - } |
|
157 | - |
|
158 | - // Start up sessions |
|
159 | - Session::start(); |
|
160 | - |
|
161 | - // Check the user is allowed to be logged in still. This must be before we call any user-loading functions and |
|
162 | - // get the current user cached. |
|
163 | - // I'm not sure if this function call being here is particularly a good thing, but it's part of starting up a |
|
164 | - // session I suppose. |
|
165 | - $this->checkForceLogout(); |
|
166 | - |
|
167 | - // environment initialised! |
|
168 | - return true; |
|
169 | - } |
|
170 | - |
|
171 | - /** |
|
172 | - * Main application logic |
|
173 | - */ |
|
174 | - protected function main() |
|
175 | - { |
|
176 | - // Get the right route for the request |
|
177 | - $page = $this->requestRouter->route(); |
|
178 | - |
|
179 | - $siteConfiguration = $this->getConfiguration(); |
|
180 | - $database = PdoDatabase::getDatabaseConnection('acc'); |
|
181 | - |
|
182 | - if ($siteConfiguration->getIrcNotificationsEnabled()) { |
|
183 | - $notificationsDatabase = PdoDatabase::getDatabaseConnection('notifications'); |
|
184 | - } |
|
185 | - else { |
|
186 | - // @todo federated table here? |
|
187 | - $notificationsDatabase = $database; |
|
188 | - } |
|
189 | - |
|
190 | - $this->setupHelpers($page, $siteConfiguration, $database, $notificationsDatabase); |
|
191 | - |
|
192 | - /* @todo Remove this global statement! It's here for User.php, which does far more than it should. */ |
|
193 | - global $oauthProtocolHelper; |
|
194 | - $oauthProtocolHelper = $page->getOAuthProtocolHelper(); |
|
195 | - |
|
196 | - /* @todo Remove this global statement! It's here for Request.php, which does far more than it should. */ |
|
197 | - global $globalXffTrustProvider; |
|
198 | - $globalXffTrustProvider = $page->getXffTrustProvider(); |
|
199 | - |
|
200 | - // run the route code for the request. |
|
201 | - $page->execute(); |
|
202 | - } |
|
203 | - |
|
204 | - /** |
|
205 | - * Any cleanup tasks should go here |
|
206 | - * |
|
207 | - * Note that we need to be very careful here, as exceptions may have been thrown and handled. |
|
208 | - * This should *only* be for cleaning up, no logic should go here. |
|
209 | - */ |
|
210 | - protected function cleanupEnvironment() |
|
211 | - { |
|
212 | - // Clean up anything we splurged after sending the page. |
|
213 | - if (ob_get_level() > 0) { |
|
214 | - for ($i = ob_get_level(); $i > 0; $i--) { |
|
215 | - ob_end_clean(); |
|
216 | - } |
|
217 | - } |
|
218 | - } |
|
219 | - |
|
220 | - private function checkForceLogout() |
|
221 | - { |
|
222 | - $database = PdoDatabase::getDatabaseConnection('acc'); |
|
223 | - |
|
224 | - $sessionUserId = WebRequest::getSessionUserId(); |
|
225 | - iF ($sessionUserId === null) { |
|
226 | - return; |
|
227 | - } |
|
228 | - |
|
229 | - // Note, User::getCurrent() caches it's result, which we *really* don't want to trigger. |
|
230 | - $currentUser = User::getById($sessionUserId, $database); |
|
231 | - |
|
232 | - if ($currentUser === false) { |
|
233 | - // Umm... this user has a session cookie with a userId set, but no user exists... |
|
234 | - Session::restart(); |
|
235 | - |
|
236 | - $currentUser = User::getCurrent($database); |
|
237 | - } |
|
238 | - |
|
239 | - if ($currentUser->getForceLogout()) { |
|
240 | - Session::restart(); |
|
241 | - |
|
242 | - $currentUser->setForceLogout(false); |
|
243 | - $currentUser->save(); |
|
244 | - } |
|
245 | - } |
|
246 | - |
|
247 | - public function isPublic() |
|
248 | - { |
|
249 | - return $this->isPublic; |
|
250 | - } |
|
251 | - |
|
252 | - public function setPublic($isPublic) |
|
253 | - { |
|
254 | - $this->isPublic = $isPublic; |
|
255 | - } |
|
35 | + /** |
|
36 | + * @var IRequestRouter $requestRouter The request router to use. Note that different entry points have different |
|
37 | + * routers and hence different URL mappings |
|
38 | + */ |
|
39 | + private $requestRouter; |
|
40 | + /** |
|
41 | + * @var bool $isPublic Determines whether to use public interface objects or internal interface objects |
|
42 | + */ |
|
43 | + private $isPublic = false; |
|
44 | + |
|
45 | + /** |
|
46 | + * WebStart constructor. |
|
47 | + * |
|
48 | + * @param SiteConfiguration $configuration The site configuration |
|
49 | + * @param IRequestRouter $router The request router to use |
|
50 | + */ |
|
51 | + public function __construct(SiteConfiguration $configuration, IRequestRouter $router) |
|
52 | + { |
|
53 | + parent::__construct($configuration); |
|
54 | + |
|
55 | + $this->requestRouter = $router; |
|
56 | + } |
|
57 | + |
|
58 | + /** |
|
59 | + * @param ITask $page |
|
60 | + * @param SiteConfiguration $siteConfiguration |
|
61 | + * @param PdoDatabase $database |
|
62 | + * @param PdoDatabase $notificationsDatabase |
|
63 | + * |
|
64 | + * @return void |
|
65 | + */ |
|
66 | + protected function setupHelpers( |
|
67 | + ITask $page, |
|
68 | + SiteConfiguration $siteConfiguration, |
|
69 | + PdoDatabase $database, |
|
70 | + PdoDatabase $notificationsDatabase = null |
|
71 | + ) { |
|
72 | + parent::setupHelpers($page, $siteConfiguration, $database, $notificationsDatabase); |
|
73 | + |
|
74 | + if ($page instanceof PageBase) { |
|
75 | + $page->setTokenManager(new TokenManager()); |
|
76 | + $page->setCspManager(new ContentSecurityPolicyManager($siteConfiguration)); |
|
77 | + |
|
78 | + if ($page instanceof InternalPageBase) { |
|
79 | + $page->setTypeAheadHelper(new TypeAheadHelper()); |
|
80 | + |
|
81 | + $identificationVerifier = new IdentificationVerifier($page->getHttpHelper(), $siteConfiguration, |
|
82 | + $database); |
|
83 | + $page->setIdentificationVerifier($identificationVerifier); |
|
84 | + |
|
85 | + $page->setSecurityManager(new SecurityManager($identificationVerifier, new RoleConfiguration())); |
|
86 | + |
|
87 | + if ($siteConfiguration->getTitleBlacklistEnabled()) { |
|
88 | + $page->setBlacklistHelper(new FakeBlacklistHelper()); |
|
89 | + } |
|
90 | + else { |
|
91 | + $page->setBlacklistHelper(new BlacklistHelper($page->getHttpHelper(), |
|
92 | + $siteConfiguration->getMediawikiWebServiceEndpoint())); |
|
93 | + } |
|
94 | + } |
|
95 | + } |
|
96 | + } |
|
97 | + |
|
98 | + /** |
|
99 | + * Application entry point. |
|
100 | + * |
|
101 | + * Sets up the environment and runs the application, performing any global cleanup operations when done. |
|
102 | + */ |
|
103 | + public function run() |
|
104 | + { |
|
105 | + try { |
|
106 | + if ($this->setupEnvironment()) { |
|
107 | + $this->main(); |
|
108 | + } |
|
109 | + } |
|
110 | + catch (EnvironmentException $ex) { |
|
111 | + ob_end_clean(); |
|
112 | + print Offline::getOfflineMessage($this->isPublic(), $ex->getMessage()); |
|
113 | + } |
|
114 | + catch (ReadableException $ex) { |
|
115 | + ob_end_clean(); |
|
116 | + print $ex->getReadableError(); |
|
117 | + } |
|
118 | + finally { |
|
119 | + $this->cleanupEnvironment(); |
|
120 | + } |
|
121 | + } |
|
122 | + |
|
123 | + /** |
|
124 | + * Environment setup |
|
125 | + * |
|
126 | + * This method initialises the tool environment. If the tool cannot be initialised correctly, it will return false |
|
127 | + * and shut down prematurely. |
|
128 | + * |
|
129 | + * @return bool |
|
130 | + * @throws EnvironmentException |
|
131 | + */ |
|
132 | + protected function setupEnvironment() |
|
133 | + { |
|
134 | + // initialise global exception handler |
|
135 | + set_exception_handler(array(ExceptionHandler::class, 'exceptionHandler')); |
|
136 | + set_error_handler(array(ExceptionHandler::class, 'errorHandler'), E_RECOVERABLE_ERROR); |
|
137 | + |
|
138 | + // start output buffering if necessary |
|
139 | + if (ob_get_level() === 0) { |
|
140 | + ob_start(); |
|
141 | + } |
|
142 | + |
|
143 | + // initialise super-global providers |
|
144 | + WebRequest::setGlobalStateProvider(new GlobalStateProvider()); |
|
145 | + |
|
146 | + if (Offline::isOffline()) { |
|
147 | + print Offline::getOfflineMessage($this->isPublic()); |
|
148 | + ob_end_flush(); |
|
149 | + |
|
150 | + return false; |
|
151 | + } |
|
152 | + |
|
153 | + // Call parent setup |
|
154 | + if (!parent::setupEnvironment()) { |
|
155 | + return false; |
|
156 | + } |
|
157 | + |
|
158 | + // Start up sessions |
|
159 | + Session::start(); |
|
160 | + |
|
161 | + // Check the user is allowed to be logged in still. This must be before we call any user-loading functions and |
|
162 | + // get the current user cached. |
|
163 | + // I'm not sure if this function call being here is particularly a good thing, but it's part of starting up a |
|
164 | + // session I suppose. |
|
165 | + $this->checkForceLogout(); |
|
166 | + |
|
167 | + // environment initialised! |
|
168 | + return true; |
|
169 | + } |
|
170 | + |
|
171 | + /** |
|
172 | + * Main application logic |
|
173 | + */ |
|
174 | + protected function main() |
|
175 | + { |
|
176 | + // Get the right route for the request |
|
177 | + $page = $this->requestRouter->route(); |
|
178 | + |
|
179 | + $siteConfiguration = $this->getConfiguration(); |
|
180 | + $database = PdoDatabase::getDatabaseConnection('acc'); |
|
181 | + |
|
182 | + if ($siteConfiguration->getIrcNotificationsEnabled()) { |
|
183 | + $notificationsDatabase = PdoDatabase::getDatabaseConnection('notifications'); |
|
184 | + } |
|
185 | + else { |
|
186 | + // @todo federated table here? |
|
187 | + $notificationsDatabase = $database; |
|
188 | + } |
|
189 | + |
|
190 | + $this->setupHelpers($page, $siteConfiguration, $database, $notificationsDatabase); |
|
191 | + |
|
192 | + /* @todo Remove this global statement! It's here for User.php, which does far more than it should. */ |
|
193 | + global $oauthProtocolHelper; |
|
194 | + $oauthProtocolHelper = $page->getOAuthProtocolHelper(); |
|
195 | + |
|
196 | + /* @todo Remove this global statement! It's here for Request.php, which does far more than it should. */ |
|
197 | + global $globalXffTrustProvider; |
|
198 | + $globalXffTrustProvider = $page->getXffTrustProvider(); |
|
199 | + |
|
200 | + // run the route code for the request. |
|
201 | + $page->execute(); |
|
202 | + } |
|
203 | + |
|
204 | + /** |
|
205 | + * Any cleanup tasks should go here |
|
206 | + * |
|
207 | + * Note that we need to be very careful here, as exceptions may have been thrown and handled. |
|
208 | + * This should *only* be for cleaning up, no logic should go here. |
|
209 | + */ |
|
210 | + protected function cleanupEnvironment() |
|
211 | + { |
|
212 | + // Clean up anything we splurged after sending the page. |
|
213 | + if (ob_get_level() > 0) { |
|
214 | + for ($i = ob_get_level(); $i > 0; $i--) { |
|
215 | + ob_end_clean(); |
|
216 | + } |
|
217 | + } |
|
218 | + } |
|
219 | + |
|
220 | + private function checkForceLogout() |
|
221 | + { |
|
222 | + $database = PdoDatabase::getDatabaseConnection('acc'); |
|
223 | + |
|
224 | + $sessionUserId = WebRequest::getSessionUserId(); |
|
225 | + iF ($sessionUserId === null) { |
|
226 | + return; |
|
227 | + } |
|
228 | + |
|
229 | + // Note, User::getCurrent() caches it's result, which we *really* don't want to trigger. |
|
230 | + $currentUser = User::getById($sessionUserId, $database); |
|
231 | + |
|
232 | + if ($currentUser === false) { |
|
233 | + // Umm... this user has a session cookie with a userId set, but no user exists... |
|
234 | + Session::restart(); |
|
235 | + |
|
236 | + $currentUser = User::getCurrent($database); |
|
237 | + } |
|
238 | + |
|
239 | + if ($currentUser->getForceLogout()) { |
|
240 | + Session::restart(); |
|
241 | + |
|
242 | + $currentUser->setForceLogout(false); |
|
243 | + $currentUser->save(); |
|
244 | + } |
|
245 | + } |
|
246 | + |
|
247 | + public function isPublic() |
|
248 | + { |
|
249 | + return $this->isPublic; |
|
250 | + } |
|
251 | + |
|
252 | + public function setPublic($isPublic) |
|
253 | + { |
|
254 | + $this->isPublic = $isPublic; |
|
255 | + } |
|
256 | 256 | } |