@@ -16,16 +16,16 @@ |
||
16 | 16 | */ |
17 | 17 | function smarty_modifier_date($input) |
18 | 18 | { |
19 | - if (gettype($input) === 'object' |
|
20 | - && (get_class($input) === DateTime::class || get_class($input) === DateTimeImmutable::class) |
|
21 | - ) { |
|
22 | - /** @var $date DateTime|DateTimeImmutable */ |
|
23 | - $date = $input; |
|
24 | - $dateString = $date->format('Y-m-d H:i:s'); |
|
19 | + if (gettype($input) === 'object' |
|
20 | + && (get_class($input) === DateTime::class || get_class($input) === DateTimeImmutable::class) |
|
21 | + ) { |
|
22 | + /** @var $date DateTime|DateTimeImmutable */ |
|
23 | + $date = $input; |
|
24 | + $dateString = $date->format('Y-m-d H:i:s'); |
|
25 | 25 | |
26 | - return $dateString; |
|
27 | - } |
|
28 | - else { |
|
29 | - return $input; |
|
30 | - } |
|
26 | + return $dateString; |
|
27 | + } |
|
28 | + else { |
|
29 | + return $input; |
|
30 | + } |
|
31 | 31 | } |
32 | 32 | \ No newline at end of file |
@@ -13,87 +13,87 @@ |
||
13 | 13 | |
14 | 14 | class LogSearchHelper extends SearchHelperBase |
15 | 15 | { |
16 | - /** |
|
17 | - * LogSearchHelper constructor. |
|
18 | - * |
|
19 | - * @param PdoDatabase $database |
|
20 | - */ |
|
21 | - protected function __construct(PdoDatabase $database) |
|
22 | - { |
|
23 | - parent::__construct($database, 'log', Log::class, 'timestamp DESC'); |
|
24 | - } |
|
16 | + /** |
|
17 | + * LogSearchHelper constructor. |
|
18 | + * |
|
19 | + * @param PdoDatabase $database |
|
20 | + */ |
|
21 | + protected function __construct(PdoDatabase $database) |
|
22 | + { |
|
23 | + parent::__construct($database, 'log', Log::class, 'timestamp DESC'); |
|
24 | + } |
|
25 | 25 | |
26 | - /** |
|
27 | - * Initiates a search for requests |
|
28 | - * |
|
29 | - * @param PdoDatabase $database |
|
30 | - * |
|
31 | - * @return LogSearchHelper |
|
32 | - */ |
|
33 | - public static function get(PdoDatabase $database) |
|
34 | - { |
|
35 | - $helper = new LogSearchHelper($database); |
|
26 | + /** |
|
27 | + * Initiates a search for requests |
|
28 | + * |
|
29 | + * @param PdoDatabase $database |
|
30 | + * |
|
31 | + * @return LogSearchHelper |
|
32 | + */ |
|
33 | + public static function get(PdoDatabase $database) |
|
34 | + { |
|
35 | + $helper = new LogSearchHelper($database); |
|
36 | 36 | |
37 | - return $helper; |
|
38 | - } |
|
37 | + return $helper; |
|
38 | + } |
|
39 | 39 | |
40 | - /** |
|
41 | - * Filters the results by user |
|
42 | - * |
|
43 | - * @param int $userId |
|
44 | - * |
|
45 | - * @return $this |
|
46 | - */ |
|
47 | - public function byUser($userId) |
|
48 | - { |
|
49 | - $this->whereClause .= ' AND user = ?'; |
|
50 | - $this->parameterList[] = $userId; |
|
40 | + /** |
|
41 | + * Filters the results by user |
|
42 | + * |
|
43 | + * @param int $userId |
|
44 | + * |
|
45 | + * @return $this |
|
46 | + */ |
|
47 | + public function byUser($userId) |
|
48 | + { |
|
49 | + $this->whereClause .= ' AND user = ?'; |
|
50 | + $this->parameterList[] = $userId; |
|
51 | 51 | |
52 | - return $this; |
|
53 | - } |
|
52 | + return $this; |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * Filters the results by log action |
|
57 | - * |
|
58 | - * @param string $action |
|
59 | - * |
|
60 | - * @return $this |
|
61 | - */ |
|
62 | - public function byAction($action) |
|
63 | - { |
|
64 | - $this->whereClause .= ' AND action = ?'; |
|
65 | - $this->parameterList[] = $action; |
|
55 | + /** |
|
56 | + * Filters the results by log action |
|
57 | + * |
|
58 | + * @param string $action |
|
59 | + * |
|
60 | + * @return $this |
|
61 | + */ |
|
62 | + public function byAction($action) |
|
63 | + { |
|
64 | + $this->whereClause .= ' AND action = ?'; |
|
65 | + $this->parameterList[] = $action; |
|
66 | 66 | |
67 | - return $this; |
|
68 | - } |
|
67 | + return $this; |
|
68 | + } |
|
69 | 69 | |
70 | - /** |
|
71 | - * Filters the results by object type |
|
72 | - * |
|
73 | - * @param string $objectType |
|
74 | - * |
|
75 | - * @return $this |
|
76 | - */ |
|
77 | - public function byObjectType($objectType) |
|
78 | - { |
|
79 | - $this->whereClause .= ' AND objecttype = ?'; |
|
80 | - $this->parameterList[] = $objectType; |
|
70 | + /** |
|
71 | + * Filters the results by object type |
|
72 | + * |
|
73 | + * @param string $objectType |
|
74 | + * |
|
75 | + * @return $this |
|
76 | + */ |
|
77 | + public function byObjectType($objectType) |
|
78 | + { |
|
79 | + $this->whereClause .= ' AND objecttype = ?'; |
|
80 | + $this->parameterList[] = $objectType; |
|
81 | 81 | |
82 | - return $this; |
|
83 | - } |
|
82 | + return $this; |
|
83 | + } |
|
84 | 84 | |
85 | - /** |
|
86 | - * Filters the results by object type |
|
87 | - * |
|
88 | - * @param integer $objectId |
|
89 | - * |
|
90 | - * @return $this |
|
91 | - */ |
|
92 | - public function byObjectId($objectId) |
|
93 | - { |
|
94 | - $this->whereClause .= ' AND objectid = ?'; |
|
95 | - $this->parameterList[] = $objectId; |
|
85 | + /** |
|
86 | + * Filters the results by object type |
|
87 | + * |
|
88 | + * @param integer $objectId |
|
89 | + * |
|
90 | + * @return $this |
|
91 | + */ |
|
92 | + public function byObjectId($objectId) |
|
93 | + { |
|
94 | + $this->whereClause .= ' AND objectid = ?'; |
|
95 | + $this->parameterList[] = $objectId; |
|
96 | 96 | |
97 | - return $this; |
|
98 | - } |
|
97 | + return $this; |
|
98 | + } |
|
99 | 99 | } |
100 | 100 | \ No newline at end of file |
@@ -219,7 +219,7 @@ discard block |
||
219 | 219 | $targetScriptName = $currentScriptName; |
220 | 220 | } |
221 | 221 | else { |
222 | - $targetScriptName = $this->getSiteConfiguration()->getBaseUrl() . '/' . $script; |
|
222 | + $targetScriptName = $this->getSiteConfiguration()->getBaseUrl().'/'.$script; |
|
223 | 223 | } |
224 | 224 | |
225 | 225 | $pathInfo = array($targetScriptName); |
@@ -233,7 +233,7 @@ discard block |
||
233 | 233 | $url = implode('/', $pathInfo); |
234 | 234 | |
235 | 235 | if (is_array($parameters) && count($parameters) > 0) { |
236 | - $url .= '?' . http_build_query($parameters); |
|
236 | + $url .= '?'.http_build_query($parameters); |
|
237 | 237 | } |
238 | 238 | |
239 | 239 | $this->redirectUrl($url); |
@@ -278,7 +278,7 @@ discard block |
||
278 | 278 | * @param string $path The path (relative to the application root) of the file |
279 | 279 | */ |
280 | 280 | final protected function addCss($path) { |
281 | - if(in_array($path, $this->extraCss)){ |
|
281 | + if (in_array($path, $this->extraCss)) { |
|
282 | 282 | // nothing to do |
283 | 283 | return; |
284 | 284 | } |
@@ -291,8 +291,8 @@ discard block |
||
291 | 291 | * |
292 | 292 | * @param string $path The path (relative to the application root) of the file |
293 | 293 | */ |
294 | - final protected function addJs($path){ |
|
295 | - if(in_array($path, $this->extraJs)){ |
|
294 | + final protected function addJs($path) { |
|
295 | + if (in_array($path, $this->extraJs)) { |
|
296 | 296 | // nothing to do |
297 | 297 | return; |
298 | 298 | } |
@@ -345,7 +345,7 @@ discard block |
||
345 | 345 | protected function sendResponseHeaders() |
346 | 346 | { |
347 | 347 | if (headers_sent()) { |
348 | - throw new ApplicationLogicException ('Headers have already been sent! This is likely a bug in the application.'); |
|
348 | + throw new ApplicationLogicException('Headers have already been sent! This is likely a bug in the application.'); |
|
349 | 349 | } |
350 | 350 | |
351 | 351 | foreach ($this->headerQueue as $item) { |
@@ -277,8 +277,9 @@ discard block |
||
277 | 277 | * |
278 | 278 | * @param string $path The path (relative to the application root) of the file |
279 | 279 | */ |
280 | - final protected function addCss($path) { |
|
281 | - if(in_array($path, $this->extraCss)){ |
|
280 | + final protected function addCss($path) |
|
281 | + { |
|
282 | + if(in_array($path, $this->extraCss)) { |
|
282 | 283 | // nothing to do |
283 | 284 | return; |
284 | 285 | } |
@@ -291,8 +292,9 @@ discard block |
||
291 | 292 | * |
292 | 293 | * @param string $path The path (relative to the application root) of the file |
293 | 294 | */ |
294 | - final protected function addJs($path){ |
|
295 | - if(in_array($path, $this->extraJs)){ |
|
295 | + final protected function addJs($path) |
|
296 | + { |
|
297 | + if(in_array($path, $this->extraJs)) { |
|
296 | 298 | // nothing to do |
297 | 299 | return; |
298 | 300 | } |
@@ -21,353 +21,353 @@ |
||
21 | 21 | |
22 | 22 | abstract class PageBase extends TaskBase implements IRoutedTask |
23 | 23 | { |
24 | - use TemplateOutput; |
|
25 | - /** @var string Smarty template to display */ |
|
26 | - protected $template = "base.tpl"; |
|
27 | - /** @var string HTML title. Currently unused. */ |
|
28 | - protected $htmlTitle; |
|
29 | - /** @var bool Determines if the page is a redirect or not */ |
|
30 | - protected $isRedirecting = false; |
|
31 | - /** @var array Queue of headers to be sent on successful completion */ |
|
32 | - protected $headerQueue = array(); |
|
33 | - /** @var string The name of the route to use, as determined by the request router. */ |
|
34 | - private $routeName = null; |
|
35 | - /** @var TokenManager */ |
|
36 | - protected $tokenManager; |
|
37 | - /** @var string[] Extra CSS files to include */ |
|
38 | - private $extraCss = array(); |
|
39 | - /** @var string[] Extra JS files to include */ |
|
40 | - private $extraJs = array(); |
|
41 | - |
|
42 | - /** |
|
43 | - * Sets the route the request will take. Only should be called from the request router or barrier test. |
|
44 | - * |
|
45 | - * @param string $routeName The name of the route |
|
46 | - * @param bool $skipCallableTest Don't use this unless you know what you're doing, and what the implications are. |
|
47 | - * |
|
48 | - * @throws Exception |
|
49 | - * @category Security-Critical |
|
50 | - */ |
|
51 | - final public function setRoute($routeName, $skipCallableTest = false) |
|
52 | - { |
|
53 | - // Test the new route is callable before adopting it. |
|
54 | - if (!$skipCallableTest && !is_callable(array($this, $routeName))) { |
|
55 | - throw new Exception("Proposed route '$routeName' is not callable."); |
|
56 | - } |
|
57 | - |
|
58 | - // Adopt the new route |
|
59 | - $this->routeName = $routeName; |
|
60 | - } |
|
61 | - |
|
62 | - /** |
|
63 | - * Gets the name of the route that has been passed from the request router. |
|
64 | - * @return string |
|
65 | - */ |
|
66 | - final public function getRouteName() |
|
67 | - { |
|
68 | - return $this->routeName; |
|
69 | - } |
|
70 | - |
|
71 | - /** |
|
72 | - * Performs generic page setup actions |
|
73 | - */ |
|
74 | - final protected function setupPage() |
|
75 | - { |
|
76 | - $this->setUpSmarty(); |
|
77 | - |
|
78 | - $siteNoticeText = SiteNotice::get($this->getDatabase()); |
|
79 | - |
|
80 | - $this->assign('siteNoticeText', $siteNoticeText); |
|
81 | - |
|
82 | - $currentUser = User::getCurrent($this->getDatabase()); |
|
83 | - $this->assign('currentUser', $currentUser); |
|
84 | - $this->assign('loggedIn', (!$currentUser->isCommunityUser())); |
|
85 | - } |
|
86 | - |
|
87 | - /** |
|
88 | - * Runs the page logic as routed by the RequestRouter |
|
89 | - * |
|
90 | - * Only should be called after a security barrier! That means only from execute(). |
|
91 | - */ |
|
92 | - final protected function runPage() |
|
93 | - { |
|
94 | - $database = $this->getDatabase(); |
|
95 | - |
|
96 | - // initialise a database transaction |
|
97 | - if (!$database->beginTransaction()) { |
|
98 | - throw new Exception('Failed to start transaction on primary database.'); |
|
99 | - } |
|
100 | - |
|
101 | - try { |
|
102 | - // run the page code |
|
103 | - $this->{$this->getRouteName()}(); |
|
104 | - |
|
105 | - $database->commit(); |
|
106 | - } |
|
107 | - catch (ApplicationLogicException $ex) { |
|
108 | - // it's an application logic exception, so nothing went seriously wrong with the site. We can use the |
|
109 | - // standard templating system for this. |
|
110 | - |
|
111 | - // Firstly, let's undo anything that happened to the database. |
|
112 | - $database->rollBack(); |
|
113 | - |
|
114 | - // Reset smarty |
|
115 | - $this->setUpSmarty(); |
|
116 | - |
|
117 | - // Set the template |
|
118 | - $this->setTemplate('exception/application-logic.tpl'); |
|
119 | - $this->assign('message', $ex->getMessage()); |
|
120 | - |
|
121 | - // Force this back to false |
|
122 | - $this->isRedirecting = false; |
|
123 | - $this->headerQueue = array(); |
|
124 | - } |
|
125 | - catch (OptimisticLockFailedException $ex) { |
|
126 | - // it's an optimistic lock failure exception, so nothing went seriously wrong with the site. We can use the |
|
127 | - // standard templating system for this. |
|
128 | - |
|
129 | - // Firstly, let's undo anything that happened to the database. |
|
130 | - $database->rollBack(); |
|
131 | - |
|
132 | - // Reset smarty |
|
133 | - $this->setUpSmarty(); |
|
134 | - |
|
135 | - // Set the template |
|
136 | - $this->setTemplate('exception/optimistic-lock-failure.tpl'); |
|
137 | - $this->assign('message', $ex->getMessage()); |
|
138 | - |
|
139 | - $this->assign('debugTrace', false); |
|
140 | - |
|
141 | - if ($this->getSiteConfiguration()->getDebuggingTraceEnabled()) { |
|
142 | - ob_start(); |
|
143 | - var_dump(ExceptionHandler::getExceptionData($ex)); |
|
144 | - $textErrorData = ob_get_contents(); |
|
145 | - ob_end_clean(); |
|
146 | - |
|
147 | - $this->assign('exceptionData', $textErrorData); |
|
148 | - $this->assign('debugTrace', true); |
|
149 | - } |
|
150 | - |
|
151 | - // Force this back to false |
|
152 | - $this->isRedirecting = false; |
|
153 | - $this->headerQueue = array(); |
|
154 | - } |
|
155 | - finally { |
|
156 | - // Catch any hanging on transactions |
|
157 | - if ($database->hasActiveTransaction()) { |
|
158 | - $database->rollBack(); |
|
159 | - } |
|
160 | - } |
|
161 | - |
|
162 | - // run any finalisation code needed before we send the output to the browser. |
|
163 | - $this->finalisePage(); |
|
164 | - |
|
165 | - // Send the headers |
|
166 | - $this->sendResponseHeaders(); |
|
167 | - |
|
168 | - // Check we have a template to use! |
|
169 | - if ($this->template !== null) { |
|
170 | - $content = $this->fetchTemplate($this->template); |
|
171 | - ob_clean(); |
|
172 | - print($content); |
|
173 | - ob_flush(); |
|
174 | - |
|
175 | - return; |
|
176 | - } |
|
177 | - } |
|
178 | - |
|
179 | - /** |
|
180 | - * Performs final tasks needed before rendering the page. |
|
181 | - */ |
|
182 | - protected function finalisePage() |
|
183 | - { |
|
184 | - if ($this->isRedirecting) { |
|
185 | - $this->template = null; |
|
186 | - |
|
187 | - return; |
|
188 | - } |
|
189 | - |
|
190 | - $this->assign('extraCss', $this->extraCss); |
|
191 | - $this->assign('extraJs', $this->extraJs); |
|
192 | - |
|
193 | - // If we're actually displaying content, we want to add the session alerts here! |
|
194 | - $this->assign('alerts', SessionAlert::getAlerts()); |
|
195 | - SessionAlert::clearAlerts(); |
|
196 | - |
|
197 | - $this->assign('htmlTitle', $this->htmlTitle); |
|
198 | - } |
|
199 | - |
|
200 | - /** |
|
201 | - * @return TokenManager |
|
202 | - */ |
|
203 | - public function getTokenManager() |
|
204 | - { |
|
205 | - return $this->tokenManager; |
|
206 | - } |
|
207 | - |
|
208 | - /** |
|
209 | - * @param TokenManager $tokenManager |
|
210 | - */ |
|
211 | - public function setTokenManager($tokenManager) |
|
212 | - { |
|
213 | - $this->tokenManager = $tokenManager; |
|
214 | - } |
|
215 | - |
|
216 | - /** |
|
217 | - * Sends the redirect headers to perform a GET at the destination page. |
|
218 | - * |
|
219 | - * Also nullifies the set template so Smarty does not render it. |
|
220 | - * |
|
221 | - * @param string $page The page to redirect requests to (as used in the UR) |
|
222 | - * @param null|string $action The action to use on the page. |
|
223 | - * @param null|array $parameters |
|
224 | - * @param null|string $script The script (relative to index.php) to redirect to |
|
225 | - */ |
|
226 | - final protected function redirect($page = '', $action = null, $parameters = null, $script = null) |
|
227 | - { |
|
228 | - $currentScriptName = WebRequest::scriptName(); |
|
229 | - |
|
230 | - // Are we changing script? |
|
231 | - if ($script === null || substr($currentScriptName, -1 * count($script)) === $script) { |
|
232 | - $targetScriptName = $currentScriptName; |
|
233 | - } |
|
234 | - else { |
|
235 | - $targetScriptName = $this->getSiteConfiguration()->getBaseUrl() . '/' . $script; |
|
236 | - } |
|
237 | - |
|
238 | - $pathInfo = array($targetScriptName); |
|
239 | - |
|
240 | - $pathInfo[1] = $page; |
|
241 | - |
|
242 | - if ($action !== null) { |
|
243 | - $pathInfo[2] = $action; |
|
244 | - } |
|
245 | - |
|
246 | - $url = implode('/', $pathInfo); |
|
247 | - |
|
248 | - if (is_array($parameters) && count($parameters) > 0) { |
|
249 | - $url .= '?' . http_build_query($parameters); |
|
250 | - } |
|
251 | - |
|
252 | - $this->redirectUrl($url); |
|
253 | - } |
|
254 | - |
|
255 | - /** |
|
256 | - * Sends the redirect headers to perform a GET at the new address. |
|
257 | - * |
|
258 | - * Also nullifies the set template so Smarty does not render it. |
|
259 | - * |
|
260 | - * @param string $path URL to redirect to |
|
261 | - */ |
|
262 | - final protected function redirectUrl($path) |
|
263 | - { |
|
264 | - // 303 See Other = re-request at new address with a GET. |
|
265 | - $this->headerQueue[] = 'HTTP/1.1 303 See Other'; |
|
266 | - $this->headerQueue[] = "Location: $path"; |
|
267 | - |
|
268 | - $this->setTemplate(null); |
|
269 | - $this->isRedirecting = true; |
|
270 | - } |
|
271 | - |
|
272 | - /** |
|
273 | - * Sets the name of the template this page should display. |
|
274 | - * |
|
275 | - * @param string $name |
|
276 | - * |
|
277 | - * @throws Exception |
|
278 | - */ |
|
279 | - final protected function setTemplate($name) |
|
280 | - { |
|
281 | - if ($this->isRedirecting) { |
|
282 | - throw new Exception('This page has been set as a redirect, no template can be displayed!'); |
|
283 | - } |
|
284 | - |
|
285 | - $this->template = $name; |
|
286 | - } |
|
287 | - |
|
288 | - /** |
|
289 | - * Adds an extra CSS file to to the page |
|
290 | - * |
|
291 | - * @param string $path The path (relative to the application root) of the file |
|
292 | - */ |
|
293 | - final protected function addCss($path) { |
|
294 | - if(in_array($path, $this->extraCss)){ |
|
295 | - // nothing to do |
|
296 | - return; |
|
297 | - } |
|
298 | - |
|
299 | - $this->extraCss[] = $path; |
|
300 | - } |
|
301 | - |
|
302 | - /** |
|
303 | - * Adds an extra JS file to to the page |
|
304 | - * |
|
305 | - * @param string $path The path (relative to the application root) of the file |
|
306 | - */ |
|
307 | - final protected function addJs($path){ |
|
308 | - if(in_array($path, $this->extraJs)){ |
|
309 | - // nothing to do |
|
310 | - return; |
|
311 | - } |
|
312 | - |
|
313 | - $this->extraJs[] = $path; |
|
314 | - } |
|
315 | - |
|
316 | - /** |
|
317 | - * Main function for this page, when no specific actions are called. |
|
318 | - * @return void |
|
319 | - */ |
|
320 | - abstract protected function main(); |
|
321 | - |
|
322 | - /** |
|
323 | - * @param string $title |
|
324 | - */ |
|
325 | - final protected function setHtmlTitle($title) |
|
326 | - { |
|
327 | - $this->htmlTitle = $title; |
|
328 | - } |
|
329 | - |
|
330 | - public function execute() |
|
331 | - { |
|
332 | - if ($this->getRouteName() === null) { |
|
333 | - throw new Exception('Request is unrouted.'); |
|
334 | - } |
|
335 | - |
|
336 | - if ($this->getSiteConfiguration() === null) { |
|
337 | - throw new Exception('Page has no configuration!'); |
|
338 | - } |
|
339 | - |
|
340 | - $this->setupPage(); |
|
341 | - |
|
342 | - $this->runPage(); |
|
343 | - } |
|
344 | - |
|
345 | - public function assignCSRFToken() |
|
346 | - { |
|
347 | - $token = $this->tokenManager->getNewToken(); |
|
348 | - $this->assign('csrfTokenData', $token->getTokenData()); |
|
349 | - } |
|
350 | - |
|
351 | - public function validateCSRFToken() |
|
352 | - { |
|
353 | - if (!$this->tokenManager->validateToken(WebRequest::postString('csrfTokenData'))) { |
|
354 | - throw new ApplicationLogicException('Form token is not valid, please reload and try again'); |
|
355 | - } |
|
356 | - } |
|
357 | - |
|
358 | - protected function sendResponseHeaders() |
|
359 | - { |
|
360 | - if (headers_sent()) { |
|
361 | - throw new ApplicationLogicException ('Headers have already been sent! This is likely a bug in the application.'); |
|
362 | - } |
|
363 | - |
|
364 | - foreach ($this->headerQueue as $item) { |
|
365 | - if (mb_strpos($item, "\r") !== false || mb_strpos($item, "\n") !== false) { |
|
366 | - // Oops. We're not allowed to do this. |
|
367 | - throw new Exception('Unable to split header'); |
|
368 | - } |
|
369 | - |
|
370 | - header($item); |
|
371 | - } |
|
372 | - } |
|
24 | + use TemplateOutput; |
|
25 | + /** @var string Smarty template to display */ |
|
26 | + protected $template = "base.tpl"; |
|
27 | + /** @var string HTML title. Currently unused. */ |
|
28 | + protected $htmlTitle; |
|
29 | + /** @var bool Determines if the page is a redirect or not */ |
|
30 | + protected $isRedirecting = false; |
|
31 | + /** @var array Queue of headers to be sent on successful completion */ |
|
32 | + protected $headerQueue = array(); |
|
33 | + /** @var string The name of the route to use, as determined by the request router. */ |
|
34 | + private $routeName = null; |
|
35 | + /** @var TokenManager */ |
|
36 | + protected $tokenManager; |
|
37 | + /** @var string[] Extra CSS files to include */ |
|
38 | + private $extraCss = array(); |
|
39 | + /** @var string[] Extra JS files to include */ |
|
40 | + private $extraJs = array(); |
|
41 | + |
|
42 | + /** |
|
43 | + * Sets the route the request will take. Only should be called from the request router or barrier test. |
|
44 | + * |
|
45 | + * @param string $routeName The name of the route |
|
46 | + * @param bool $skipCallableTest Don't use this unless you know what you're doing, and what the implications are. |
|
47 | + * |
|
48 | + * @throws Exception |
|
49 | + * @category Security-Critical |
|
50 | + */ |
|
51 | + final public function setRoute($routeName, $skipCallableTest = false) |
|
52 | + { |
|
53 | + // Test the new route is callable before adopting it. |
|
54 | + if (!$skipCallableTest && !is_callable(array($this, $routeName))) { |
|
55 | + throw new Exception("Proposed route '$routeName' is not callable."); |
|
56 | + } |
|
57 | + |
|
58 | + // Adopt the new route |
|
59 | + $this->routeName = $routeName; |
|
60 | + } |
|
61 | + |
|
62 | + /** |
|
63 | + * Gets the name of the route that has been passed from the request router. |
|
64 | + * @return string |
|
65 | + */ |
|
66 | + final public function getRouteName() |
|
67 | + { |
|
68 | + return $this->routeName; |
|
69 | + } |
|
70 | + |
|
71 | + /** |
|
72 | + * Performs generic page setup actions |
|
73 | + */ |
|
74 | + final protected function setupPage() |
|
75 | + { |
|
76 | + $this->setUpSmarty(); |
|
77 | + |
|
78 | + $siteNoticeText = SiteNotice::get($this->getDatabase()); |
|
79 | + |
|
80 | + $this->assign('siteNoticeText', $siteNoticeText); |
|
81 | + |
|
82 | + $currentUser = User::getCurrent($this->getDatabase()); |
|
83 | + $this->assign('currentUser', $currentUser); |
|
84 | + $this->assign('loggedIn', (!$currentUser->isCommunityUser())); |
|
85 | + } |
|
86 | + |
|
87 | + /** |
|
88 | + * Runs the page logic as routed by the RequestRouter |
|
89 | + * |
|
90 | + * Only should be called after a security barrier! That means only from execute(). |
|
91 | + */ |
|
92 | + final protected function runPage() |
|
93 | + { |
|
94 | + $database = $this->getDatabase(); |
|
95 | + |
|
96 | + // initialise a database transaction |
|
97 | + if (!$database->beginTransaction()) { |
|
98 | + throw new Exception('Failed to start transaction on primary database.'); |
|
99 | + } |
|
100 | + |
|
101 | + try { |
|
102 | + // run the page code |
|
103 | + $this->{$this->getRouteName()}(); |
|
104 | + |
|
105 | + $database->commit(); |
|
106 | + } |
|
107 | + catch (ApplicationLogicException $ex) { |
|
108 | + // it's an application logic exception, so nothing went seriously wrong with the site. We can use the |
|
109 | + // standard templating system for this. |
|
110 | + |
|
111 | + // Firstly, let's undo anything that happened to the database. |
|
112 | + $database->rollBack(); |
|
113 | + |
|
114 | + // Reset smarty |
|
115 | + $this->setUpSmarty(); |
|
116 | + |
|
117 | + // Set the template |
|
118 | + $this->setTemplate('exception/application-logic.tpl'); |
|
119 | + $this->assign('message', $ex->getMessage()); |
|
120 | + |
|
121 | + // Force this back to false |
|
122 | + $this->isRedirecting = false; |
|
123 | + $this->headerQueue = array(); |
|
124 | + } |
|
125 | + catch (OptimisticLockFailedException $ex) { |
|
126 | + // it's an optimistic lock failure exception, so nothing went seriously wrong with the site. We can use the |
|
127 | + // standard templating system for this. |
|
128 | + |
|
129 | + // Firstly, let's undo anything that happened to the database. |
|
130 | + $database->rollBack(); |
|
131 | + |
|
132 | + // Reset smarty |
|
133 | + $this->setUpSmarty(); |
|
134 | + |
|
135 | + // Set the template |
|
136 | + $this->setTemplate('exception/optimistic-lock-failure.tpl'); |
|
137 | + $this->assign('message', $ex->getMessage()); |
|
138 | + |
|
139 | + $this->assign('debugTrace', false); |
|
140 | + |
|
141 | + if ($this->getSiteConfiguration()->getDebuggingTraceEnabled()) { |
|
142 | + ob_start(); |
|
143 | + var_dump(ExceptionHandler::getExceptionData($ex)); |
|
144 | + $textErrorData = ob_get_contents(); |
|
145 | + ob_end_clean(); |
|
146 | + |
|
147 | + $this->assign('exceptionData', $textErrorData); |
|
148 | + $this->assign('debugTrace', true); |
|
149 | + } |
|
150 | + |
|
151 | + // Force this back to false |
|
152 | + $this->isRedirecting = false; |
|
153 | + $this->headerQueue = array(); |
|
154 | + } |
|
155 | + finally { |
|
156 | + // Catch any hanging on transactions |
|
157 | + if ($database->hasActiveTransaction()) { |
|
158 | + $database->rollBack(); |
|
159 | + } |
|
160 | + } |
|
161 | + |
|
162 | + // run any finalisation code needed before we send the output to the browser. |
|
163 | + $this->finalisePage(); |
|
164 | + |
|
165 | + // Send the headers |
|
166 | + $this->sendResponseHeaders(); |
|
167 | + |
|
168 | + // Check we have a template to use! |
|
169 | + if ($this->template !== null) { |
|
170 | + $content = $this->fetchTemplate($this->template); |
|
171 | + ob_clean(); |
|
172 | + print($content); |
|
173 | + ob_flush(); |
|
174 | + |
|
175 | + return; |
|
176 | + } |
|
177 | + } |
|
178 | + |
|
179 | + /** |
|
180 | + * Performs final tasks needed before rendering the page. |
|
181 | + */ |
|
182 | + protected function finalisePage() |
|
183 | + { |
|
184 | + if ($this->isRedirecting) { |
|
185 | + $this->template = null; |
|
186 | + |
|
187 | + return; |
|
188 | + } |
|
189 | + |
|
190 | + $this->assign('extraCss', $this->extraCss); |
|
191 | + $this->assign('extraJs', $this->extraJs); |
|
192 | + |
|
193 | + // If we're actually displaying content, we want to add the session alerts here! |
|
194 | + $this->assign('alerts', SessionAlert::getAlerts()); |
|
195 | + SessionAlert::clearAlerts(); |
|
196 | + |
|
197 | + $this->assign('htmlTitle', $this->htmlTitle); |
|
198 | + } |
|
199 | + |
|
200 | + /** |
|
201 | + * @return TokenManager |
|
202 | + */ |
|
203 | + public function getTokenManager() |
|
204 | + { |
|
205 | + return $this->tokenManager; |
|
206 | + } |
|
207 | + |
|
208 | + /** |
|
209 | + * @param TokenManager $tokenManager |
|
210 | + */ |
|
211 | + public function setTokenManager($tokenManager) |
|
212 | + { |
|
213 | + $this->tokenManager = $tokenManager; |
|
214 | + } |
|
215 | + |
|
216 | + /** |
|
217 | + * Sends the redirect headers to perform a GET at the destination page. |
|
218 | + * |
|
219 | + * Also nullifies the set template so Smarty does not render it. |
|
220 | + * |
|
221 | + * @param string $page The page to redirect requests to (as used in the UR) |
|
222 | + * @param null|string $action The action to use on the page. |
|
223 | + * @param null|array $parameters |
|
224 | + * @param null|string $script The script (relative to index.php) to redirect to |
|
225 | + */ |
|
226 | + final protected function redirect($page = '', $action = null, $parameters = null, $script = null) |
|
227 | + { |
|
228 | + $currentScriptName = WebRequest::scriptName(); |
|
229 | + |
|
230 | + // Are we changing script? |
|
231 | + if ($script === null || substr($currentScriptName, -1 * count($script)) === $script) { |
|
232 | + $targetScriptName = $currentScriptName; |
|
233 | + } |
|
234 | + else { |
|
235 | + $targetScriptName = $this->getSiteConfiguration()->getBaseUrl() . '/' . $script; |
|
236 | + } |
|
237 | + |
|
238 | + $pathInfo = array($targetScriptName); |
|
239 | + |
|
240 | + $pathInfo[1] = $page; |
|
241 | + |
|
242 | + if ($action !== null) { |
|
243 | + $pathInfo[2] = $action; |
|
244 | + } |
|
245 | + |
|
246 | + $url = implode('/', $pathInfo); |
|
247 | + |
|
248 | + if (is_array($parameters) && count($parameters) > 0) { |
|
249 | + $url .= '?' . http_build_query($parameters); |
|
250 | + } |
|
251 | + |
|
252 | + $this->redirectUrl($url); |
|
253 | + } |
|
254 | + |
|
255 | + /** |
|
256 | + * Sends the redirect headers to perform a GET at the new address. |
|
257 | + * |
|
258 | + * Also nullifies the set template so Smarty does not render it. |
|
259 | + * |
|
260 | + * @param string $path URL to redirect to |
|
261 | + */ |
|
262 | + final protected function redirectUrl($path) |
|
263 | + { |
|
264 | + // 303 See Other = re-request at new address with a GET. |
|
265 | + $this->headerQueue[] = 'HTTP/1.1 303 See Other'; |
|
266 | + $this->headerQueue[] = "Location: $path"; |
|
267 | + |
|
268 | + $this->setTemplate(null); |
|
269 | + $this->isRedirecting = true; |
|
270 | + } |
|
271 | + |
|
272 | + /** |
|
273 | + * Sets the name of the template this page should display. |
|
274 | + * |
|
275 | + * @param string $name |
|
276 | + * |
|
277 | + * @throws Exception |
|
278 | + */ |
|
279 | + final protected function setTemplate($name) |
|
280 | + { |
|
281 | + if ($this->isRedirecting) { |
|
282 | + throw new Exception('This page has been set as a redirect, no template can be displayed!'); |
|
283 | + } |
|
284 | + |
|
285 | + $this->template = $name; |
|
286 | + } |
|
287 | + |
|
288 | + /** |
|
289 | + * Adds an extra CSS file to to the page |
|
290 | + * |
|
291 | + * @param string $path The path (relative to the application root) of the file |
|
292 | + */ |
|
293 | + final protected function addCss($path) { |
|
294 | + if(in_array($path, $this->extraCss)){ |
|
295 | + // nothing to do |
|
296 | + return; |
|
297 | + } |
|
298 | + |
|
299 | + $this->extraCss[] = $path; |
|
300 | + } |
|
301 | + |
|
302 | + /** |
|
303 | + * Adds an extra JS file to to the page |
|
304 | + * |
|
305 | + * @param string $path The path (relative to the application root) of the file |
|
306 | + */ |
|
307 | + final protected function addJs($path){ |
|
308 | + if(in_array($path, $this->extraJs)){ |
|
309 | + // nothing to do |
|
310 | + return; |
|
311 | + } |
|
312 | + |
|
313 | + $this->extraJs[] = $path; |
|
314 | + } |
|
315 | + |
|
316 | + /** |
|
317 | + * Main function for this page, when no specific actions are called. |
|
318 | + * @return void |
|
319 | + */ |
|
320 | + abstract protected function main(); |
|
321 | + |
|
322 | + /** |
|
323 | + * @param string $title |
|
324 | + */ |
|
325 | + final protected function setHtmlTitle($title) |
|
326 | + { |
|
327 | + $this->htmlTitle = $title; |
|
328 | + } |
|
329 | + |
|
330 | + public function execute() |
|
331 | + { |
|
332 | + if ($this->getRouteName() === null) { |
|
333 | + throw new Exception('Request is unrouted.'); |
|
334 | + } |
|
335 | + |
|
336 | + if ($this->getSiteConfiguration() === null) { |
|
337 | + throw new Exception('Page has no configuration!'); |
|
338 | + } |
|
339 | + |
|
340 | + $this->setupPage(); |
|
341 | + |
|
342 | + $this->runPage(); |
|
343 | + } |
|
344 | + |
|
345 | + public function assignCSRFToken() |
|
346 | + { |
|
347 | + $token = $this->tokenManager->getNewToken(); |
|
348 | + $this->assign('csrfTokenData', $token->getTokenData()); |
|
349 | + } |
|
350 | + |
|
351 | + public function validateCSRFToken() |
|
352 | + { |
|
353 | + if (!$this->tokenManager->validateToken(WebRequest::postString('csrfTokenData'))) { |
|
354 | + throw new ApplicationLogicException('Form token is not valid, please reload and try again'); |
|
355 | + } |
|
356 | + } |
|
357 | + |
|
358 | + protected function sendResponseHeaders() |
|
359 | + { |
|
360 | + if (headers_sent()) { |
|
361 | + throw new ApplicationLogicException ('Headers have already been sent! This is likely a bug in the application.'); |
|
362 | + } |
|
363 | + |
|
364 | + foreach ($this->headerQueue as $item) { |
|
365 | + if (mb_strpos($item, "\r") !== false || mb_strpos($item, "\n") !== false) { |
|
366 | + // Oops. We're not allowed to do this. |
|
367 | + throw new Exception('Unable to split header'); |
|
368 | + } |
|
369 | + |
|
370 | + header($item); |
|
371 | + } |
|
372 | + } |
|
373 | 373 | } |
@@ -187,7 +187,8 @@ |
||
187 | 187 | $endpoint = $this->siteConfiguration->getMetaWikimediaWebServiceEndpoint(); |
188 | 188 | $response = $this->httpHelper->get($endpoint, $parameters); |
189 | 189 | $response = json_decode($response, true); |
190 | - } catch (CurlException $ex) { |
|
190 | + } |
|
191 | + catch (CurlException $ex) { |
|
191 | 192 | // failed getting identification status, so throw a nicer error. |
192 | 193 | $m = 'Could not contact metawiki API to determine user\' identification status. ' |
193 | 194 | . 'This is probably a transient error, so please try again.'; |
@@ -26,133 +26,133 @@ discard block |
||
26 | 26 | */ |
27 | 27 | class IdentificationVerifier |
28 | 28 | { |
29 | - /** |
|
30 | - * This field is an array of parameters, in key => value format, that should be appended to the Meta Wikimedia |
|
31 | - * Web Service Endpoint URL to query if a user is listed on the Identification Noticeboard. Note that URL encoding |
|
32 | - * of these values is *not* necessary; this is done automatically. |
|
33 | - * |
|
34 | - * @var string[] |
|
35 | - * @category Security-Critical |
|
36 | - */ |
|
37 | - private static $apiQueryParameters = array( |
|
38 | - 'action' => 'query', |
|
39 | - 'format' => 'json', |
|
40 | - 'prop' => 'links', |
|
41 | - // Populated from SiteConfiguration->getIdentificationNoticeboardPage |
|
42 | - 'titles' => '', |
|
43 | - // Username of the user to be checked, with User: prefix, goes here! Set in isIdentifiedOnWiki() |
|
44 | - 'pltitles' => '', |
|
45 | - ); |
|
46 | - /** @var HttpHelper */ |
|
47 | - private $httpHelper; |
|
48 | - /** @var SiteConfiguration */ |
|
49 | - private $siteConfiguration; |
|
50 | - /** @var PdoDatabase */ |
|
51 | - private $dbObject; |
|
52 | - |
|
53 | - /** |
|
54 | - * IdentificationVerifier constructor. |
|
55 | - * |
|
56 | - * @param HttpHelper $httpHelper |
|
57 | - * @param SiteConfiguration $siteConfiguration |
|
58 | - * @param PdoDatabase $dbObject |
|
59 | - */ |
|
60 | - public function __construct(HttpHelper $httpHelper, SiteConfiguration $siteConfiguration, PdoDatabase $dbObject) |
|
61 | - { |
|
62 | - $this->httpHelper = $httpHelper; |
|
63 | - $this->siteConfiguration = $siteConfiguration; |
|
64 | - $this->dbObject = $dbObject; |
|
65 | - } |
|
66 | - |
|
67 | - /** |
|
68 | - * Checks if the given user is identified to the Wikimedia Foundation. |
|
69 | - * |
|
70 | - * @param string $onWikiName The Wikipedia username of the user |
|
71 | - * |
|
72 | - * @return bool |
|
73 | - * @category Security-Critical |
|
74 | - * @throws EnvironmentException |
|
75 | - */ |
|
76 | - public function isUserIdentified($onWikiName) |
|
77 | - { |
|
78 | - if ($this->checkIdentificationCache($onWikiName)) { |
|
79 | - return true; |
|
80 | - } |
|
81 | - else { |
|
82 | - if ($this->isIdentifiedOnWiki($onWikiName)) { |
|
83 | - $this->cacheIdentificationStatus($onWikiName); |
|
84 | - |
|
85 | - return true; |
|
86 | - } |
|
87 | - else { |
|
88 | - return false; |
|
89 | - } |
|
90 | - } |
|
91 | - } |
|
92 | - |
|
93 | - /** |
|
94 | - * Checks if the given user has a valid entry in the idcache table. |
|
95 | - * |
|
96 | - * @param string $onWikiName The Wikipedia username of the user |
|
97 | - * |
|
98 | - * @return bool |
|
99 | - * @category Security-Critical |
|
100 | - */ |
|
101 | - private function checkIdentificationCache($onWikiName) |
|
102 | - { |
|
103 | - $interval = $this->siteConfiguration->getIdentificationCacheExpiry(); |
|
104 | - |
|
105 | - $query = <<<SQL |
|
29 | + /** |
|
30 | + * This field is an array of parameters, in key => value format, that should be appended to the Meta Wikimedia |
|
31 | + * Web Service Endpoint URL to query if a user is listed on the Identification Noticeboard. Note that URL encoding |
|
32 | + * of these values is *not* necessary; this is done automatically. |
|
33 | + * |
|
34 | + * @var string[] |
|
35 | + * @category Security-Critical |
|
36 | + */ |
|
37 | + private static $apiQueryParameters = array( |
|
38 | + 'action' => 'query', |
|
39 | + 'format' => 'json', |
|
40 | + 'prop' => 'links', |
|
41 | + // Populated from SiteConfiguration->getIdentificationNoticeboardPage |
|
42 | + 'titles' => '', |
|
43 | + // Username of the user to be checked, with User: prefix, goes here! Set in isIdentifiedOnWiki() |
|
44 | + 'pltitles' => '', |
|
45 | + ); |
|
46 | + /** @var HttpHelper */ |
|
47 | + private $httpHelper; |
|
48 | + /** @var SiteConfiguration */ |
|
49 | + private $siteConfiguration; |
|
50 | + /** @var PdoDatabase */ |
|
51 | + private $dbObject; |
|
52 | + |
|
53 | + /** |
|
54 | + * IdentificationVerifier constructor. |
|
55 | + * |
|
56 | + * @param HttpHelper $httpHelper |
|
57 | + * @param SiteConfiguration $siteConfiguration |
|
58 | + * @param PdoDatabase $dbObject |
|
59 | + */ |
|
60 | + public function __construct(HttpHelper $httpHelper, SiteConfiguration $siteConfiguration, PdoDatabase $dbObject) |
|
61 | + { |
|
62 | + $this->httpHelper = $httpHelper; |
|
63 | + $this->siteConfiguration = $siteConfiguration; |
|
64 | + $this->dbObject = $dbObject; |
|
65 | + } |
|
66 | + |
|
67 | + /** |
|
68 | + * Checks if the given user is identified to the Wikimedia Foundation. |
|
69 | + * |
|
70 | + * @param string $onWikiName The Wikipedia username of the user |
|
71 | + * |
|
72 | + * @return bool |
|
73 | + * @category Security-Critical |
|
74 | + * @throws EnvironmentException |
|
75 | + */ |
|
76 | + public function isUserIdentified($onWikiName) |
|
77 | + { |
|
78 | + if ($this->checkIdentificationCache($onWikiName)) { |
|
79 | + return true; |
|
80 | + } |
|
81 | + else { |
|
82 | + if ($this->isIdentifiedOnWiki($onWikiName)) { |
|
83 | + $this->cacheIdentificationStatus($onWikiName); |
|
84 | + |
|
85 | + return true; |
|
86 | + } |
|
87 | + else { |
|
88 | + return false; |
|
89 | + } |
|
90 | + } |
|
91 | + } |
|
92 | + |
|
93 | + /** |
|
94 | + * Checks if the given user has a valid entry in the idcache table. |
|
95 | + * |
|
96 | + * @param string $onWikiName The Wikipedia username of the user |
|
97 | + * |
|
98 | + * @return bool |
|
99 | + * @category Security-Critical |
|
100 | + */ |
|
101 | + private function checkIdentificationCache($onWikiName) |
|
102 | + { |
|
103 | + $interval = $this->siteConfiguration->getIdentificationCacheExpiry(); |
|
104 | + |
|
105 | + $query = <<<SQL |
|
106 | 106 | SELECT COUNT(`id`) |
107 | 107 | FROM `idcache` |
108 | 108 | WHERE `onwikiusername` = :onwikiname |
109 | 109 | AND DATE_ADD(`checktime`, INTERVAL {$interval}) >= NOW(); |
110 | 110 | SQL; |
111 | - $stmt = $this->dbObject->prepare($query); |
|
112 | - $stmt->bindValue(':onwikiname', $onWikiName, PDO::PARAM_STR); |
|
113 | - $stmt->execute(); |
|
114 | - |
|
115 | - // Guaranteed by the query to only return a single row with a single column |
|
116 | - $results = $stmt->fetch(PDO::FETCH_NUM); |
|
117 | - |
|
118 | - // I don't expect this to ever be a value other than 0 or 1 since the `onwikiusername` column is declared as a |
|
119 | - // unique key - but meh. |
|
120 | - return $results[0] != 0; |
|
121 | - } |
|
122 | - |
|
123 | - /** |
|
124 | - * Does pretty much exactly what it says on the label - this method will clear all expired idcache entries from the |
|
125 | - * idcache table. Meant to be called periodically by a maintenance script. |
|
126 | - * |
|
127 | - * @param SiteConfiguration $siteConfiguration |
|
128 | - * @param PdoDatabase $dbObject |
|
129 | - * |
|
130 | - * @return void |
|
131 | - */ |
|
132 | - public static function clearExpiredCacheEntries(SiteConfiguration $siteConfiguration, PdoDatabase $dbObject) |
|
133 | - { |
|
134 | - $interval = $siteConfiguration->getIdentificationCacheExpiry(); |
|
135 | - |
|
136 | - $query = <<<SQL |
|
111 | + $stmt = $this->dbObject->prepare($query); |
|
112 | + $stmt->bindValue(':onwikiname', $onWikiName, PDO::PARAM_STR); |
|
113 | + $stmt->execute(); |
|
114 | + |
|
115 | + // Guaranteed by the query to only return a single row with a single column |
|
116 | + $results = $stmt->fetch(PDO::FETCH_NUM); |
|
117 | + |
|
118 | + // I don't expect this to ever be a value other than 0 or 1 since the `onwikiusername` column is declared as a |
|
119 | + // unique key - but meh. |
|
120 | + return $results[0] != 0; |
|
121 | + } |
|
122 | + |
|
123 | + /** |
|
124 | + * Does pretty much exactly what it says on the label - this method will clear all expired idcache entries from the |
|
125 | + * idcache table. Meant to be called periodically by a maintenance script. |
|
126 | + * |
|
127 | + * @param SiteConfiguration $siteConfiguration |
|
128 | + * @param PdoDatabase $dbObject |
|
129 | + * |
|
130 | + * @return void |
|
131 | + */ |
|
132 | + public static function clearExpiredCacheEntries(SiteConfiguration $siteConfiguration, PdoDatabase $dbObject) |
|
133 | + { |
|
134 | + $interval = $siteConfiguration->getIdentificationCacheExpiry(); |
|
135 | + |
|
136 | + $query = <<<SQL |
|
137 | 137 | DELETE FROM `idcache` |
138 | 138 | WHERE DATE_ADD(`checktime`, INTERVAL {$interval}) < NOW(); |
139 | 139 | SQL; |
140 | - $dbObject->prepare($query)->execute(); |
|
141 | - } |
|
142 | - |
|
143 | - /** |
|
144 | - * This method will add an entry to the idcache that the given Wikipedia user has been verified as identified. This |
|
145 | - * is so we don't have to hit the API every single time we check. The cache entry is valid for as long as specified |
|
146 | - * in the ACC configuration (validity enforced by checkIdentificationCache() and clearExpiredCacheEntries()). |
|
147 | - * |
|
148 | - * @param string $onWikiName The Wikipedia username of the user |
|
149 | - * |
|
150 | - * @return void |
|
151 | - * @category Security-Critical |
|
152 | - */ |
|
153 | - private function cacheIdentificationStatus($onWikiName) |
|
154 | - { |
|
155 | - $query = <<<SQL |
|
140 | + $dbObject->prepare($query)->execute(); |
|
141 | + } |
|
142 | + |
|
143 | + /** |
|
144 | + * This method will add an entry to the idcache that the given Wikipedia user has been verified as identified. This |
|
145 | + * is so we don't have to hit the API every single time we check. The cache entry is valid for as long as specified |
|
146 | + * in the ACC configuration (validity enforced by checkIdentificationCache() and clearExpiredCacheEntries()). |
|
147 | + * |
|
148 | + * @param string $onWikiName The Wikipedia username of the user |
|
149 | + * |
|
150 | + * @return void |
|
151 | + * @category Security-Critical |
|
152 | + */ |
|
153 | + private function cacheIdentificationStatus($onWikiName) |
|
154 | + { |
|
155 | + $query = <<<SQL |
|
156 | 156 | INSERT INTO `idcache` |
157 | 157 | (`onwikiusername`) |
158 | 158 | VALUES |
@@ -161,45 +161,45 @@ discard block |
||
161 | 161 | `onwikiusername` = VALUES(`onwikiusername`), |
162 | 162 | `checktime` = CURRENT_TIMESTAMP; |
163 | 163 | SQL; |
164 | - $stmt = $this->dbObject->prepare($query); |
|
165 | - $stmt->bindValue(':onwikiname', $onWikiName, PDO::PARAM_STR); |
|
166 | - $stmt->execute(); |
|
167 | - } |
|
168 | - |
|
169 | - /** |
|
170 | - * Queries the Wikimedia API to determine if the specified user is listed on the identification noticeboard. |
|
171 | - * |
|
172 | - * @param string $onWikiName The Wikipedia username of the user |
|
173 | - * |
|
174 | - * @return bool |
|
175 | - * @throws EnvironmentException |
|
176 | - * @category Security-Critical |
|
177 | - */ |
|
178 | - private function isIdentifiedOnWiki($onWikiName) |
|
179 | - { |
|
180 | - $strings = new StringFunctions(); |
|
181 | - |
|
182 | - // First character of Wikipedia usernames is always capitalized. |
|
183 | - $onWikiName = $strings->ucfirst($onWikiName); |
|
184 | - |
|
185 | - $parameters = self::$apiQueryParameters; |
|
186 | - $parameters['pltitles'] = "User:" . $onWikiName; |
|
187 | - $parameters['titles'] = $this->siteConfiguration->getIdentificationNoticeboardPage(); |
|
188 | - |
|
189 | - try { |
|
190 | - $endpoint = $this->siteConfiguration->getMetaWikimediaWebServiceEndpoint(); |
|
191 | - $response = $this->httpHelper->get($endpoint, $parameters); |
|
192 | - $response = json_decode($response, true); |
|
193 | - } catch (CurlException $ex) { |
|
194 | - // failed getting identification status, so throw a nicer error. |
|
195 | - $m = 'Could not contact metawiki API to determine user\' identification status. ' |
|
196 | - . 'This is probably a transient error, so please try again.'; |
|
197 | - |
|
198 | - throw new EnvironmentException($m, 0, $ex); |
|
199 | - } |
|
200 | - |
|
201 | - $page = @array_pop($response['query']['pages']); |
|
202 | - |
|
203 | - return @$page['links'][0]['title'] === "User:" . $onWikiName; |
|
204 | - } |
|
164 | + $stmt = $this->dbObject->prepare($query); |
|
165 | + $stmt->bindValue(':onwikiname', $onWikiName, PDO::PARAM_STR); |
|
166 | + $stmt->execute(); |
|
167 | + } |
|
168 | + |
|
169 | + /** |
|
170 | + * Queries the Wikimedia API to determine if the specified user is listed on the identification noticeboard. |
|
171 | + * |
|
172 | + * @param string $onWikiName The Wikipedia username of the user |
|
173 | + * |
|
174 | + * @return bool |
|
175 | + * @throws EnvironmentException |
|
176 | + * @category Security-Critical |
|
177 | + */ |
|
178 | + private function isIdentifiedOnWiki($onWikiName) |
|
179 | + { |
|
180 | + $strings = new StringFunctions(); |
|
181 | + |
|
182 | + // First character of Wikipedia usernames is always capitalized. |
|
183 | + $onWikiName = $strings->ucfirst($onWikiName); |
|
184 | + |
|
185 | + $parameters = self::$apiQueryParameters; |
|
186 | + $parameters['pltitles'] = "User:" . $onWikiName; |
|
187 | + $parameters['titles'] = $this->siteConfiguration->getIdentificationNoticeboardPage(); |
|
188 | + |
|
189 | + try { |
|
190 | + $endpoint = $this->siteConfiguration->getMetaWikimediaWebServiceEndpoint(); |
|
191 | + $response = $this->httpHelper->get($endpoint, $parameters); |
|
192 | + $response = json_decode($response, true); |
|
193 | + } catch (CurlException $ex) { |
|
194 | + // failed getting identification status, so throw a nicer error. |
|
195 | + $m = 'Could not contact metawiki API to determine user\' identification status. ' |
|
196 | + . 'This is probably a transient error, so please try again.'; |
|
197 | + |
|
198 | + throw new EnvironmentException($m, 0, $ex); |
|
199 | + } |
|
200 | + |
|
201 | + $page = @array_pop($response['query']['pages']); |
|
202 | + |
|
203 | + return @$page['links'][0]['title'] === "User:" . $onWikiName; |
|
204 | + } |
|
205 | 205 | } |
@@ -183,7 +183,7 @@ discard block |
||
183 | 183 | $onWikiName = $strings->ucfirst($onWikiName); |
184 | 184 | |
185 | 185 | $parameters = self::$apiQueryParameters; |
186 | - $parameters['pltitles'] = "User:" . $onWikiName; |
|
186 | + $parameters['pltitles'] = "User:".$onWikiName; |
|
187 | 187 | $parameters['titles'] = $this->siteConfiguration->getIdentificationNoticeboardPage(); |
188 | 188 | |
189 | 189 | try { |
@@ -200,6 +200,6 @@ discard block |
||
200 | 200 | |
201 | 201 | $page = @array_pop($response['query']['pages']); |
202 | 202 | |
203 | - return @$page['links'][0]['title'] === "User:" . $onWikiName; |
|
203 | + return @$page['links'][0]['title'] === "User:".$onWikiName; |
|
204 | 204 | } |
205 | 205 | } |
@@ -14,200 +14,200 @@ |
||
14 | 14 | |
15 | 15 | final class SecurityManager |
16 | 16 | { |
17 | - const ALLOWED = 1; |
|
18 | - const ERROR_NOT_IDENTIFIED = 2; |
|
19 | - const ERROR_DENIED = 3; |
|
20 | - /** @var IdentificationVerifier */ |
|
21 | - private $identificationVerifier; |
|
22 | - /** |
|
23 | - * @var RoleConfiguration |
|
24 | - */ |
|
25 | - private $roleConfiguration; |
|
26 | - |
|
27 | - /** |
|
28 | - * SecurityManager constructor. |
|
29 | - * |
|
30 | - * @param IdentificationVerifier $identificationVerifier |
|
31 | - * @param RoleConfiguration $roleConfiguration |
|
32 | - */ |
|
33 | - public function __construct( |
|
34 | - IdentificationVerifier $identificationVerifier, |
|
35 | - RoleConfiguration $roleConfiguration |
|
36 | - ) { |
|
37 | - $this->identificationVerifier = $identificationVerifier; |
|
38 | - $this->roleConfiguration = $roleConfiguration; |
|
39 | - } |
|
40 | - |
|
41 | - /** |
|
42 | - * Tests if a user is allowed to perform an action. |
|
43 | - * |
|
44 | - * This method should form a hard, deterministic security barrier, and only return true if it is absolutely sure |
|
45 | - * that a user should have access to something. |
|
46 | - * |
|
47 | - * @param string $page |
|
48 | - * @param string $route |
|
49 | - * @param User $user |
|
50 | - * |
|
51 | - * @return int |
|
52 | - * |
|
53 | - * @category Security-Critical |
|
54 | - */ |
|
55 | - public function allows($page, $route, User $user) |
|
56 | - { |
|
57 | - $this->getActiveRoles($user, $activeRoles, $inactiveRoles); |
|
58 | - |
|
59 | - $availableRights = $this->flattenRoles($activeRoles); |
|
60 | - $testResult = $this->findResult($availableRights, $page, $route); |
|
61 | - |
|
62 | - if ($testResult !== null) { |
|
63 | - // We got a firm result here, so just return it. |
|
64 | - return $testResult; |
|
65 | - } |
|
66 | - |
|
67 | - // No firm result yet, so continue testing the inactive roles so we can give a better error. |
|
68 | - $inactiveRights = $this->flattenRoles($inactiveRoles); |
|
69 | - $testResult = $this->findResult($inactiveRights, $page, $route); |
|
70 | - |
|
71 | - if ($testResult === self::ALLOWED) { |
|
72 | - // The user is allowed to access this, but their role is inactive. |
|
73 | - return self::ERROR_NOT_IDENTIFIED; |
|
74 | - } |
|
75 | - |
|
76 | - // Other options from the secondary test are denied and inconclusive, which at this point defaults to denied. |
|
77 | - return self::ERROR_DENIED; |
|
78 | - } |
|
79 | - |
|
80 | - /** |
|
81 | - * @param array $pseudoRole The role (flattened) to check |
|
82 | - * @param string $page The page class to check |
|
83 | - * @param string $route The page route to check |
|
84 | - * |
|
85 | - * @return int|null |
|
86 | - */ |
|
87 | - private function findResult($pseudoRole, $page, $route) |
|
88 | - { |
|
89 | - if (isset($pseudoRole[$page])) { |
|
90 | - // check for deny on catch-all route |
|
91 | - if (isset($pseudoRole[$page][RoleConfiguration::ALL])) { |
|
92 | - if ($pseudoRole[$page][RoleConfiguration::ALL] === RoleConfiguration::ACCESS_DENY) { |
|
93 | - return self::ERROR_DENIED; |
|
94 | - } |
|
95 | - } |
|
96 | - |
|
97 | - // check normal route |
|
98 | - if (isset($pseudoRole[$page][$route])) { |
|
99 | - if ($pseudoRole[$page][$route] === RoleConfiguration::ACCESS_DENY) { |
|
100 | - return self::ERROR_DENIED; |
|
101 | - } |
|
102 | - |
|
103 | - if ($pseudoRole[$page][$route] === RoleConfiguration::ACCESS_ALLOW) { |
|
104 | - return self::ALLOWED; |
|
105 | - } |
|
106 | - } |
|
107 | - |
|
108 | - // check for allowed on catch-all route |
|
109 | - if (isset($pseudoRole[$page][RoleConfiguration::ALL])) { |
|
110 | - if ($pseudoRole[$page][RoleConfiguration::ALL] === RoleConfiguration::ACCESS_ALLOW) { |
|
111 | - return self::ALLOWED; |
|
112 | - } |
|
113 | - } |
|
114 | - } |
|
115 | - |
|
116 | - // return indeterminate result |
|
117 | - return null; |
|
118 | - } |
|
119 | - |
|
120 | - /** |
|
121 | - * Takes an array of roles and flattens the values to a single set. |
|
122 | - * |
|
123 | - * @param array $activeRoles |
|
124 | - * |
|
125 | - * @return array |
|
126 | - */ |
|
127 | - private function flattenRoles($activeRoles) |
|
128 | - { |
|
129 | - $result = array(); |
|
130 | - |
|
131 | - $roleConfig = $this->roleConfiguration->getApplicableRoles($activeRoles); |
|
132 | - |
|
133 | - // Iterate over every page in every role |
|
134 | - foreach ($roleConfig as $role) { |
|
135 | - foreach ($role as $page => $pageRights) { |
|
136 | - // Create holder in result for this page |
|
137 | - if (!isset($result[$page])) { |
|
138 | - $result[$page] = array(); |
|
139 | - } |
|
140 | - |
|
141 | - foreach ($pageRights as $action => $permission) { |
|
142 | - // Deny takes precedence, so if it's set, don't change it. |
|
143 | - if (isset($result[$page][$action])) { |
|
144 | - if ($result[$page][$action] === RoleConfiguration::ACCESS_DENY) { |
|
145 | - continue; |
|
146 | - } |
|
147 | - } |
|
148 | - |
|
149 | - if ($permission === RoleConfiguration::ACCESS_DEFAULT) { |
|
150 | - // Configured to do precisely nothing. |
|
151 | - continue; |
|
152 | - } |
|
153 | - |
|
154 | - $result[$page][$action] = $permission; |
|
155 | - } |
|
156 | - } |
|
157 | - } |
|
158 | - |
|
159 | - return $result; |
|
160 | - } |
|
161 | - |
|
162 | - /** |
|
163 | - * @param User $user |
|
164 | - * @param array $activeRoles |
|
165 | - * @param array $inactiveRoles |
|
166 | - */ |
|
167 | - public function getActiveRoles(User $user, &$activeRoles, &$inactiveRoles) |
|
168 | - { |
|
169 | - // Default to the community user here, because the main user is logged out |
|
170 | - $identified = false; |
|
171 | - $userRoles = array('public'); |
|
172 | - |
|
173 | - // if we're not the community user, get our real rights. |
|
174 | - if (!$user->isCommunityUser()) { |
|
175 | - // Check the user's status - only active users are allowed the effects of roles |
|
176 | - |
|
177 | - $userRoles[] = 'loggedIn'; |
|
178 | - |
|
179 | - if ($user->isActive()) { |
|
180 | - $ur = UserRole::getForUser($user->getId(), $user->getDatabase()); |
|
181 | - |
|
182 | - // NOTE: public is still in this array. |
|
183 | - foreach ($ur as $r) { |
|
184 | - $userRoles[] = $r->getRole(); |
|
185 | - } |
|
186 | - |
|
187 | - $identified = $user->isIdentified($this->identificationVerifier); |
|
188 | - } |
|
189 | - } |
|
190 | - |
|
191 | - $activeRoles = array(); |
|
192 | - $inactiveRoles = array(); |
|
193 | - |
|
194 | - /** @var string $v */ |
|
195 | - foreach ($userRoles as $v) { |
|
196 | - if ($this->roleConfiguration->roleNeedsIdentification($v)) { |
|
197 | - if ($identified) { |
|
198 | - $activeRoles[] = $v; |
|
199 | - } |
|
200 | - else { |
|
201 | - $inactiveRoles[] = $v; |
|
202 | - } |
|
203 | - } |
|
204 | - else { |
|
205 | - $activeRoles[] = $v; |
|
206 | - } |
|
207 | - } |
|
208 | - } |
|
209 | - |
|
210 | - public function getRoleConfiguration(){ |
|
211 | - return $this->roleConfiguration; |
|
212 | - } |
|
17 | + const ALLOWED = 1; |
|
18 | + const ERROR_NOT_IDENTIFIED = 2; |
|
19 | + const ERROR_DENIED = 3; |
|
20 | + /** @var IdentificationVerifier */ |
|
21 | + private $identificationVerifier; |
|
22 | + /** |
|
23 | + * @var RoleConfiguration |
|
24 | + */ |
|
25 | + private $roleConfiguration; |
|
26 | + |
|
27 | + /** |
|
28 | + * SecurityManager constructor. |
|
29 | + * |
|
30 | + * @param IdentificationVerifier $identificationVerifier |
|
31 | + * @param RoleConfiguration $roleConfiguration |
|
32 | + */ |
|
33 | + public function __construct( |
|
34 | + IdentificationVerifier $identificationVerifier, |
|
35 | + RoleConfiguration $roleConfiguration |
|
36 | + ) { |
|
37 | + $this->identificationVerifier = $identificationVerifier; |
|
38 | + $this->roleConfiguration = $roleConfiguration; |
|
39 | + } |
|
40 | + |
|
41 | + /** |
|
42 | + * Tests if a user is allowed to perform an action. |
|
43 | + * |
|
44 | + * This method should form a hard, deterministic security barrier, and only return true if it is absolutely sure |
|
45 | + * that a user should have access to something. |
|
46 | + * |
|
47 | + * @param string $page |
|
48 | + * @param string $route |
|
49 | + * @param User $user |
|
50 | + * |
|
51 | + * @return int |
|
52 | + * |
|
53 | + * @category Security-Critical |
|
54 | + */ |
|
55 | + public function allows($page, $route, User $user) |
|
56 | + { |
|
57 | + $this->getActiveRoles($user, $activeRoles, $inactiveRoles); |
|
58 | + |
|
59 | + $availableRights = $this->flattenRoles($activeRoles); |
|
60 | + $testResult = $this->findResult($availableRights, $page, $route); |
|
61 | + |
|
62 | + if ($testResult !== null) { |
|
63 | + // We got a firm result here, so just return it. |
|
64 | + return $testResult; |
|
65 | + } |
|
66 | + |
|
67 | + // No firm result yet, so continue testing the inactive roles so we can give a better error. |
|
68 | + $inactiveRights = $this->flattenRoles($inactiveRoles); |
|
69 | + $testResult = $this->findResult($inactiveRights, $page, $route); |
|
70 | + |
|
71 | + if ($testResult === self::ALLOWED) { |
|
72 | + // The user is allowed to access this, but their role is inactive. |
|
73 | + return self::ERROR_NOT_IDENTIFIED; |
|
74 | + } |
|
75 | + |
|
76 | + // Other options from the secondary test are denied and inconclusive, which at this point defaults to denied. |
|
77 | + return self::ERROR_DENIED; |
|
78 | + } |
|
79 | + |
|
80 | + /** |
|
81 | + * @param array $pseudoRole The role (flattened) to check |
|
82 | + * @param string $page The page class to check |
|
83 | + * @param string $route The page route to check |
|
84 | + * |
|
85 | + * @return int|null |
|
86 | + */ |
|
87 | + private function findResult($pseudoRole, $page, $route) |
|
88 | + { |
|
89 | + if (isset($pseudoRole[$page])) { |
|
90 | + // check for deny on catch-all route |
|
91 | + if (isset($pseudoRole[$page][RoleConfiguration::ALL])) { |
|
92 | + if ($pseudoRole[$page][RoleConfiguration::ALL] === RoleConfiguration::ACCESS_DENY) { |
|
93 | + return self::ERROR_DENIED; |
|
94 | + } |
|
95 | + } |
|
96 | + |
|
97 | + // check normal route |
|
98 | + if (isset($pseudoRole[$page][$route])) { |
|
99 | + if ($pseudoRole[$page][$route] === RoleConfiguration::ACCESS_DENY) { |
|
100 | + return self::ERROR_DENIED; |
|
101 | + } |
|
102 | + |
|
103 | + if ($pseudoRole[$page][$route] === RoleConfiguration::ACCESS_ALLOW) { |
|
104 | + return self::ALLOWED; |
|
105 | + } |
|
106 | + } |
|
107 | + |
|
108 | + // check for allowed on catch-all route |
|
109 | + if (isset($pseudoRole[$page][RoleConfiguration::ALL])) { |
|
110 | + if ($pseudoRole[$page][RoleConfiguration::ALL] === RoleConfiguration::ACCESS_ALLOW) { |
|
111 | + return self::ALLOWED; |
|
112 | + } |
|
113 | + } |
|
114 | + } |
|
115 | + |
|
116 | + // return indeterminate result |
|
117 | + return null; |
|
118 | + } |
|
119 | + |
|
120 | + /** |
|
121 | + * Takes an array of roles and flattens the values to a single set. |
|
122 | + * |
|
123 | + * @param array $activeRoles |
|
124 | + * |
|
125 | + * @return array |
|
126 | + */ |
|
127 | + private function flattenRoles($activeRoles) |
|
128 | + { |
|
129 | + $result = array(); |
|
130 | + |
|
131 | + $roleConfig = $this->roleConfiguration->getApplicableRoles($activeRoles); |
|
132 | + |
|
133 | + // Iterate over every page in every role |
|
134 | + foreach ($roleConfig as $role) { |
|
135 | + foreach ($role as $page => $pageRights) { |
|
136 | + // Create holder in result for this page |
|
137 | + if (!isset($result[$page])) { |
|
138 | + $result[$page] = array(); |
|
139 | + } |
|
140 | + |
|
141 | + foreach ($pageRights as $action => $permission) { |
|
142 | + // Deny takes precedence, so if it's set, don't change it. |
|
143 | + if (isset($result[$page][$action])) { |
|
144 | + if ($result[$page][$action] === RoleConfiguration::ACCESS_DENY) { |
|
145 | + continue; |
|
146 | + } |
|
147 | + } |
|
148 | + |
|
149 | + if ($permission === RoleConfiguration::ACCESS_DEFAULT) { |
|
150 | + // Configured to do precisely nothing. |
|
151 | + continue; |
|
152 | + } |
|
153 | + |
|
154 | + $result[$page][$action] = $permission; |
|
155 | + } |
|
156 | + } |
|
157 | + } |
|
158 | + |
|
159 | + return $result; |
|
160 | + } |
|
161 | + |
|
162 | + /** |
|
163 | + * @param User $user |
|
164 | + * @param array $activeRoles |
|
165 | + * @param array $inactiveRoles |
|
166 | + */ |
|
167 | + public function getActiveRoles(User $user, &$activeRoles, &$inactiveRoles) |
|
168 | + { |
|
169 | + // Default to the community user here, because the main user is logged out |
|
170 | + $identified = false; |
|
171 | + $userRoles = array('public'); |
|
172 | + |
|
173 | + // if we're not the community user, get our real rights. |
|
174 | + if (!$user->isCommunityUser()) { |
|
175 | + // Check the user's status - only active users are allowed the effects of roles |
|
176 | + |
|
177 | + $userRoles[] = 'loggedIn'; |
|
178 | + |
|
179 | + if ($user->isActive()) { |
|
180 | + $ur = UserRole::getForUser($user->getId(), $user->getDatabase()); |
|
181 | + |
|
182 | + // NOTE: public is still in this array. |
|
183 | + foreach ($ur as $r) { |
|
184 | + $userRoles[] = $r->getRole(); |
|
185 | + } |
|
186 | + |
|
187 | + $identified = $user->isIdentified($this->identificationVerifier); |
|
188 | + } |
|
189 | + } |
|
190 | + |
|
191 | + $activeRoles = array(); |
|
192 | + $inactiveRoles = array(); |
|
193 | + |
|
194 | + /** @var string $v */ |
|
195 | + foreach ($userRoles as $v) { |
|
196 | + if ($this->roleConfiguration->roleNeedsIdentification($v)) { |
|
197 | + if ($identified) { |
|
198 | + $activeRoles[] = $v; |
|
199 | + } |
|
200 | + else { |
|
201 | + $inactiveRoles[] = $v; |
|
202 | + } |
|
203 | + } |
|
204 | + else { |
|
205 | + $activeRoles[] = $v; |
|
206 | + } |
|
207 | + } |
|
208 | + } |
|
209 | + |
|
210 | + public function getRoleConfiguration(){ |
|
211 | + return $this->roleConfiguration; |
|
212 | + } |
|
213 | 213 | } |
@@ -207,7 +207,7 @@ |
||
207 | 207 | } |
208 | 208 | } |
209 | 209 | |
210 | - public function getRoleConfiguration(){ |
|
210 | + public function getRoleConfiguration() { |
|
211 | 211 | return $this->roleConfiguration; |
212 | 212 | } |
213 | 213 | } |
@@ -207,7 +207,8 @@ |
||
207 | 207 | } |
208 | 208 | } |
209 | 209 | |
210 | - public function getRoleConfiguration(){ |
|
210 | + public function getRoleConfiguration() |
|
211 | + { |
|
211 | 212 | return $this->roleConfiguration; |
212 | 213 | } |
213 | 214 | } |
@@ -22,225 +22,225 @@ |
||
22 | 22 | |
23 | 23 | abstract class InternalPageBase extends PageBase |
24 | 24 | { |
25 | - use NavigationMenuAccessControl; |
|
26 | - |
|
27 | - /** @var IdentificationVerifier */ |
|
28 | - private $identificationVerifier; |
|
29 | - /** @var ITypeAheadHelper */ |
|
30 | - private $typeAheadHelper; |
|
31 | - /** @var SecurityManager */ |
|
32 | - private $securityManager; |
|
33 | - /** @var IBlacklistHelper */ |
|
34 | - private $blacklistHelper; |
|
35 | - |
|
36 | - /** |
|
37 | - * @return ITypeAheadHelper |
|
38 | - */ |
|
39 | - public function getTypeAheadHelper() |
|
40 | - { |
|
41 | - return $this->typeAheadHelper; |
|
42 | - } |
|
43 | - |
|
44 | - /** |
|
45 | - * Sets up the internal IdentificationVerifier instance. Intended to be called from WebStart::setupHelpers(). |
|
46 | - * |
|
47 | - * @param IdentificationVerifier $identificationVerifier |
|
48 | - * |
|
49 | - * @return void |
|
50 | - */ |
|
51 | - public function setIdentificationVerifier(IdentificationVerifier $identificationVerifier) |
|
52 | - { |
|
53 | - $this->identificationVerifier = $identificationVerifier; |
|
54 | - } |
|
55 | - |
|
56 | - /** |
|
57 | - * @param ITypeAheadHelper $typeAheadHelper |
|
58 | - */ |
|
59 | - public function setTypeAheadHelper(ITypeAheadHelper $typeAheadHelper) |
|
60 | - { |
|
61 | - $this->typeAheadHelper = $typeAheadHelper; |
|
62 | - } |
|
63 | - |
|
64 | - /** |
|
65 | - * Runs the page code |
|
66 | - * |
|
67 | - * @throws Exception |
|
68 | - * @category Security-Critical |
|
69 | - */ |
|
70 | - final public function execute() |
|
71 | - { |
|
72 | - if ($this->getRouteName() === null) { |
|
73 | - throw new Exception("Request is unrouted."); |
|
74 | - } |
|
75 | - |
|
76 | - if ($this->getSiteConfiguration() === null) { |
|
77 | - throw new Exception("Page has no configuration!"); |
|
78 | - } |
|
79 | - |
|
80 | - $this->setupPage(); |
|
81 | - |
|
82 | - $this->touchUserLastActive(); |
|
83 | - |
|
84 | - $currentUser = User::getCurrent($this->getDatabase()); |
|
85 | - |
|
86 | - // Hey, this is also a security barrier, in addition to the below. Separated out for readability. |
|
87 | - if (!$this->isProtectedPage()) { |
|
88 | - // This page is /not/ a protected page, as such we can just run it. |
|
89 | - $this->runPage(); |
|
90 | - |
|
91 | - return; |
|
92 | - } |
|
93 | - |
|
94 | - // Security barrier. |
|
95 | - // |
|
96 | - // This code essentially doesn't care if the user is logged in or not, as the security manager hides all that |
|
97 | - // away for us |
|
98 | - $securityResult = $this->getSecurityManager()->allows(get_called_class(), $this->getRouteName(), $currentUser); |
|
99 | - if ($securityResult === SecurityManager::ALLOWED) { |
|
100 | - // We're allowed to run the page, so let's run it. |
|
101 | - $this->runPage(); |
|
102 | - } |
|
103 | - else { |
|
104 | - $this->handleAccessDenied($securityResult); |
|
105 | - |
|
106 | - // Send the headers |
|
107 | - $this->sendResponseHeaders(); |
|
108 | - } |
|
109 | - } |
|
110 | - |
|
111 | - /** |
|
112 | - * Performs final tasks needed before rendering the page. |
|
113 | - */ |
|
114 | - final public function finalisePage() |
|
115 | - { |
|
116 | - parent::finalisePage(); |
|
117 | - |
|
118 | - $this->assign('typeAheadBlock', $this->getTypeAheadHelper()->getTypeAheadScriptBlock()); |
|
119 | - |
|
120 | - $database = $this->getDatabase(); |
|
121 | - |
|
122 | - $currentUser = User::getCurrent($database); |
|
123 | - if (!$currentUser->isCommunityUser()) { |
|
124 | - $sql = 'SELECT * FROM user WHERE lastactive > DATE_SUB(CURRENT_TIMESTAMP(), INTERVAL 5 MINUTE);'; |
|
125 | - $statement = $database->query($sql); |
|
126 | - $activeUsers = $statement->fetchAll(PDO::FETCH_CLASS, User::class); |
|
127 | - $this->assign('onlineusers', $activeUsers); |
|
128 | - } |
|
129 | - |
|
130 | - $this->setupNavMenuAccess($currentUser); |
|
131 | - } |
|
132 | - |
|
133 | - /** |
|
134 | - * Configures whether the page respects roles or not. You probably want this to return true. |
|
135 | - * |
|
136 | - * Set to false for public pages. You probably want this to return true. |
|
137 | - * |
|
138 | - * This defaults to true unless you explicitly set it to false. Setting it to false means anybody can do anything |
|
139 | - * on this page, so you probably want this to return true. |
|
140 | - * |
|
141 | - * @return bool |
|
142 | - * @category Security-Critical |
|
143 | - */ |
|
144 | - protected function isProtectedPage() |
|
145 | - { |
|
146 | - return true; |
|
147 | - } |
|
148 | - |
|
149 | - protected function handleAccessDenied($denyReason) |
|
150 | - { |
|
151 | - $currentUser = User::getCurrent($this->getDatabase()); |
|
152 | - |
|
153 | - // Not allowed to access this resource. |
|
154 | - // Firstly, let's check if we're even logged in. |
|
155 | - if ($currentUser->isCommunityUser()) { |
|
156 | - // Not logged in, redirect to login page |
|
157 | - WebRequest::setPostLoginRedirect(); |
|
158 | - $this->redirect("login"); |
|
159 | - |
|
160 | - return; |
|
161 | - } |
|
162 | - else { |
|
163 | - // Decide whether this was a rights failure, or an identification failure. |
|
164 | - |
|
165 | - if ($denyReason === SecurityManager::ERROR_NOT_IDENTIFIED) { |
|
166 | - // Not identified |
|
167 | - throw new NotIdentifiedException($this->getSecurityManager()); |
|
168 | - } |
|
169 | - elseif ($denyReason === SecurityManager::ERROR_DENIED) { |
|
170 | - // Nope, plain old access denied |
|
171 | - throw new AccessDeniedException($this->getSecurityManager()); |
|
172 | - } |
|
173 | - else { |
|
174 | - throw new Exception('Unknown response from security manager.'); |
|
175 | - } |
|
176 | - } |
|
177 | - } |
|
178 | - |
|
179 | - /** |
|
180 | - * Tests the security barrier for a specified action. |
|
181 | - * |
|
182 | - * Don't use within templates |
|
183 | - * |
|
184 | - * @param string $action |
|
185 | - * |
|
186 | - * @param User $user |
|
187 | - * @param null|string $pageName |
|
188 | - * |
|
189 | - * @return bool |
|
190 | - * @category Security-Critical |
|
191 | - */ |
|
192 | - final public function barrierTest($action, User $user, $pageName = null) |
|
193 | - { |
|
194 | - $page = get_called_class(); |
|
195 | - if ($pageName !== null) { |
|
196 | - $page = $pageName; |
|
197 | - } |
|
198 | - |
|
199 | - $securityResult = $this->getSecurityManager()->allows($page, $action, $user); |
|
200 | - |
|
201 | - return $securityResult === SecurityManager::ALLOWED; |
|
202 | - } |
|
203 | - |
|
204 | - /** |
|
205 | - * Updates the lastactive timestamp |
|
206 | - */ |
|
207 | - private function touchUserLastActive() |
|
208 | - { |
|
209 | - if (WebRequest::getSessionUserId() !== null) { |
|
210 | - $query = 'UPDATE user SET lastactive = CURRENT_TIMESTAMP() WHERE id = :id;'; |
|
211 | - $this->getDatabase()->prepare($query)->execute(array(":id" => WebRequest::getSessionUserId())); |
|
212 | - } |
|
213 | - } |
|
214 | - |
|
215 | - /** |
|
216 | - * @return SecurityManager |
|
217 | - */ |
|
218 | - public function getSecurityManager() |
|
219 | - { |
|
220 | - return $this->securityManager; |
|
221 | - } |
|
222 | - |
|
223 | - /** |
|
224 | - * @param SecurityManager $securityManager |
|
225 | - */ |
|
226 | - public function setSecurityManager(SecurityManager $securityManager) |
|
227 | - { |
|
228 | - $this->securityManager = $securityManager; |
|
229 | - } |
|
230 | - |
|
231 | - /** |
|
232 | - * @return IBlacklistHelper |
|
233 | - */ |
|
234 | - public function getBlacklistHelper() |
|
235 | - { |
|
236 | - return $this->blacklistHelper; |
|
237 | - } |
|
238 | - |
|
239 | - /** |
|
240 | - * @param IBlacklistHelper $blacklistHelper |
|
241 | - */ |
|
242 | - public function setBlacklistHelper(IBlacklistHelper $blacklistHelper) |
|
243 | - { |
|
244 | - $this->blacklistHelper = $blacklistHelper; |
|
245 | - } |
|
25 | + use NavigationMenuAccessControl; |
|
26 | + |
|
27 | + /** @var IdentificationVerifier */ |
|
28 | + private $identificationVerifier; |
|
29 | + /** @var ITypeAheadHelper */ |
|
30 | + private $typeAheadHelper; |
|
31 | + /** @var SecurityManager */ |
|
32 | + private $securityManager; |
|
33 | + /** @var IBlacklistHelper */ |
|
34 | + private $blacklistHelper; |
|
35 | + |
|
36 | + /** |
|
37 | + * @return ITypeAheadHelper |
|
38 | + */ |
|
39 | + public function getTypeAheadHelper() |
|
40 | + { |
|
41 | + return $this->typeAheadHelper; |
|
42 | + } |
|
43 | + |
|
44 | + /** |
|
45 | + * Sets up the internal IdentificationVerifier instance. Intended to be called from WebStart::setupHelpers(). |
|
46 | + * |
|
47 | + * @param IdentificationVerifier $identificationVerifier |
|
48 | + * |
|
49 | + * @return void |
|
50 | + */ |
|
51 | + public function setIdentificationVerifier(IdentificationVerifier $identificationVerifier) |
|
52 | + { |
|
53 | + $this->identificationVerifier = $identificationVerifier; |
|
54 | + } |
|
55 | + |
|
56 | + /** |
|
57 | + * @param ITypeAheadHelper $typeAheadHelper |
|
58 | + */ |
|
59 | + public function setTypeAheadHelper(ITypeAheadHelper $typeAheadHelper) |
|
60 | + { |
|
61 | + $this->typeAheadHelper = $typeAheadHelper; |
|
62 | + } |
|
63 | + |
|
64 | + /** |
|
65 | + * Runs the page code |
|
66 | + * |
|
67 | + * @throws Exception |
|
68 | + * @category Security-Critical |
|
69 | + */ |
|
70 | + final public function execute() |
|
71 | + { |
|
72 | + if ($this->getRouteName() === null) { |
|
73 | + throw new Exception("Request is unrouted."); |
|
74 | + } |
|
75 | + |
|
76 | + if ($this->getSiteConfiguration() === null) { |
|
77 | + throw new Exception("Page has no configuration!"); |
|
78 | + } |
|
79 | + |
|
80 | + $this->setupPage(); |
|
81 | + |
|
82 | + $this->touchUserLastActive(); |
|
83 | + |
|
84 | + $currentUser = User::getCurrent($this->getDatabase()); |
|
85 | + |
|
86 | + // Hey, this is also a security barrier, in addition to the below. Separated out for readability. |
|
87 | + if (!$this->isProtectedPage()) { |
|
88 | + // This page is /not/ a protected page, as such we can just run it. |
|
89 | + $this->runPage(); |
|
90 | + |
|
91 | + return; |
|
92 | + } |
|
93 | + |
|
94 | + // Security barrier. |
|
95 | + // |
|
96 | + // This code essentially doesn't care if the user is logged in or not, as the security manager hides all that |
|
97 | + // away for us |
|
98 | + $securityResult = $this->getSecurityManager()->allows(get_called_class(), $this->getRouteName(), $currentUser); |
|
99 | + if ($securityResult === SecurityManager::ALLOWED) { |
|
100 | + // We're allowed to run the page, so let's run it. |
|
101 | + $this->runPage(); |
|
102 | + } |
|
103 | + else { |
|
104 | + $this->handleAccessDenied($securityResult); |
|
105 | + |
|
106 | + // Send the headers |
|
107 | + $this->sendResponseHeaders(); |
|
108 | + } |
|
109 | + } |
|
110 | + |
|
111 | + /** |
|
112 | + * Performs final tasks needed before rendering the page. |
|
113 | + */ |
|
114 | + final public function finalisePage() |
|
115 | + { |
|
116 | + parent::finalisePage(); |
|
117 | + |
|
118 | + $this->assign('typeAheadBlock', $this->getTypeAheadHelper()->getTypeAheadScriptBlock()); |
|
119 | + |
|
120 | + $database = $this->getDatabase(); |
|
121 | + |
|
122 | + $currentUser = User::getCurrent($database); |
|
123 | + if (!$currentUser->isCommunityUser()) { |
|
124 | + $sql = 'SELECT * FROM user WHERE lastactive > DATE_SUB(CURRENT_TIMESTAMP(), INTERVAL 5 MINUTE);'; |
|
125 | + $statement = $database->query($sql); |
|
126 | + $activeUsers = $statement->fetchAll(PDO::FETCH_CLASS, User::class); |
|
127 | + $this->assign('onlineusers', $activeUsers); |
|
128 | + } |
|
129 | + |
|
130 | + $this->setupNavMenuAccess($currentUser); |
|
131 | + } |
|
132 | + |
|
133 | + /** |
|
134 | + * Configures whether the page respects roles or not. You probably want this to return true. |
|
135 | + * |
|
136 | + * Set to false for public pages. You probably want this to return true. |
|
137 | + * |
|
138 | + * This defaults to true unless you explicitly set it to false. Setting it to false means anybody can do anything |
|
139 | + * on this page, so you probably want this to return true. |
|
140 | + * |
|
141 | + * @return bool |
|
142 | + * @category Security-Critical |
|
143 | + */ |
|
144 | + protected function isProtectedPage() |
|
145 | + { |
|
146 | + return true; |
|
147 | + } |
|
148 | + |
|
149 | + protected function handleAccessDenied($denyReason) |
|
150 | + { |
|
151 | + $currentUser = User::getCurrent($this->getDatabase()); |
|
152 | + |
|
153 | + // Not allowed to access this resource. |
|
154 | + // Firstly, let's check if we're even logged in. |
|
155 | + if ($currentUser->isCommunityUser()) { |
|
156 | + // Not logged in, redirect to login page |
|
157 | + WebRequest::setPostLoginRedirect(); |
|
158 | + $this->redirect("login"); |
|
159 | + |
|
160 | + return; |
|
161 | + } |
|
162 | + else { |
|
163 | + // Decide whether this was a rights failure, or an identification failure. |
|
164 | + |
|
165 | + if ($denyReason === SecurityManager::ERROR_NOT_IDENTIFIED) { |
|
166 | + // Not identified |
|
167 | + throw new NotIdentifiedException($this->getSecurityManager()); |
|
168 | + } |
|
169 | + elseif ($denyReason === SecurityManager::ERROR_DENIED) { |
|
170 | + // Nope, plain old access denied |
|
171 | + throw new AccessDeniedException($this->getSecurityManager()); |
|
172 | + } |
|
173 | + else { |
|
174 | + throw new Exception('Unknown response from security manager.'); |
|
175 | + } |
|
176 | + } |
|
177 | + } |
|
178 | + |
|
179 | + /** |
|
180 | + * Tests the security barrier for a specified action. |
|
181 | + * |
|
182 | + * Don't use within templates |
|
183 | + * |
|
184 | + * @param string $action |
|
185 | + * |
|
186 | + * @param User $user |
|
187 | + * @param null|string $pageName |
|
188 | + * |
|
189 | + * @return bool |
|
190 | + * @category Security-Critical |
|
191 | + */ |
|
192 | + final public function barrierTest($action, User $user, $pageName = null) |
|
193 | + { |
|
194 | + $page = get_called_class(); |
|
195 | + if ($pageName !== null) { |
|
196 | + $page = $pageName; |
|
197 | + } |
|
198 | + |
|
199 | + $securityResult = $this->getSecurityManager()->allows($page, $action, $user); |
|
200 | + |
|
201 | + return $securityResult === SecurityManager::ALLOWED; |
|
202 | + } |
|
203 | + |
|
204 | + /** |
|
205 | + * Updates the lastactive timestamp |
|
206 | + */ |
|
207 | + private function touchUserLastActive() |
|
208 | + { |
|
209 | + if (WebRequest::getSessionUserId() !== null) { |
|
210 | + $query = 'UPDATE user SET lastactive = CURRENT_TIMESTAMP() WHERE id = :id;'; |
|
211 | + $this->getDatabase()->prepare($query)->execute(array(":id" => WebRequest::getSessionUserId())); |
|
212 | + } |
|
213 | + } |
|
214 | + |
|
215 | + /** |
|
216 | + * @return SecurityManager |
|
217 | + */ |
|
218 | + public function getSecurityManager() |
|
219 | + { |
|
220 | + return $this->securityManager; |
|
221 | + } |
|
222 | + |
|
223 | + /** |
|
224 | + * @param SecurityManager $securityManager |
|
225 | + */ |
|
226 | + public function setSecurityManager(SecurityManager $securityManager) |
|
227 | + { |
|
228 | + $this->securityManager = $securityManager; |
|
229 | + } |
|
230 | + |
|
231 | + /** |
|
232 | + * @return IBlacklistHelper |
|
233 | + */ |
|
234 | + public function getBlacklistHelper() |
|
235 | + { |
|
236 | + return $this->blacklistHelper; |
|
237 | + } |
|
238 | + |
|
239 | + /** |
|
240 | + * @param IBlacklistHelper $blacklistHelper |
|
241 | + */ |
|
242 | + public function setBlacklistHelper(IBlacklistHelper $blacklistHelper) |
|
243 | + { |
|
244 | + $this->blacklistHelper = $blacklistHelper; |
|
245 | + } |
|
246 | 246 | } |
@@ -26,89 +26,89 @@ |
||
26 | 26 | */ |
27 | 27 | class AccessDeniedException extends ReadableException |
28 | 28 | { |
29 | - use NavigationMenuAccessControl; |
|
30 | - |
|
31 | - /** |
|
32 | - * @var SecurityManager |
|
33 | - */ |
|
34 | - private $securityManager; |
|
35 | - |
|
36 | - /** |
|
37 | - * AccessDeniedException constructor. |
|
38 | - * |
|
39 | - * @param SecurityManager $securityManager |
|
40 | - */ |
|
41 | - public function __construct(SecurityManager $securityManager = null) |
|
42 | - { |
|
43 | - $this->securityManager = $securityManager; |
|
44 | - } |
|
45 | - |
|
46 | - public function getReadableError() |
|
47 | - { |
|
48 | - if (!headers_sent()) { |
|
49 | - header("HTTP/1.1 403 Forbidden"); |
|
50 | - } |
|
51 | - |
|
52 | - $this->setUpSmarty(); |
|
53 | - |
|
54 | - // uck. We should still be able to access the database in this situation though. |
|
55 | - $database = PdoDatabase::getDatabaseConnection('acc'); |
|
56 | - $currentUser = User::getCurrent($database); |
|
57 | - $this->assign('currentUser', $currentUser); |
|
58 | - $this->assign("loggedIn", (!$currentUser->isCommunityUser())); |
|
59 | - |
|
60 | - if($this->securityManager !== null) { |
|
61 | - $this->setupNavMenuAccess($currentUser); |
|
62 | - } |
|
63 | - |
|
64 | - if ($currentUser->isDeclined()) { |
|
65 | - $this->assign('htmlTitle', 'Account Declined'); |
|
66 | - $this->assign('declineReason', $this->getLogEntry('Declined', $currentUser, $database)); |
|
67 | - |
|
68 | - return $this->fetchTemplate("exception/account-declined.tpl"); |
|
69 | - } |
|
70 | - |
|
71 | - if ($currentUser->isSuspended()) { |
|
72 | - $this->assign('htmlTitle', 'Account Suspended'); |
|
73 | - $this->assign('suspendReason', $this->getLogEntry('Suspended', $currentUser, $database)); |
|
74 | - |
|
75 | - return $this->fetchTemplate("exception/account-suspended.tpl"); |
|
76 | - } |
|
77 | - |
|
78 | - if ($currentUser->isNewUser()) { |
|
79 | - $this->assign('htmlTitle', 'Account Pending'); |
|
80 | - |
|
81 | - return $this->fetchTemplate("exception/account-new.tpl"); |
|
82 | - } |
|
83 | - |
|
84 | - return $this->fetchTemplate("exception/access-denied.tpl"); |
|
85 | - } |
|
86 | - |
|
87 | - /** |
|
88 | - * @param string $action |
|
89 | - * @param User $user |
|
90 | - * @param PdoDatabase $database |
|
91 | - * |
|
92 | - * @return null|string |
|
93 | - */ |
|
94 | - private function getLogEntry($action, User $user, PdoDatabase $database) |
|
95 | - { |
|
96 | - /** @var Log[] $logs */ |
|
97 | - $logs = LogSearchHelper::get($database) |
|
98 | - ->byAction($action) |
|
99 | - ->byObjectType('User') |
|
100 | - ->byObjectId($user->getId()) |
|
101 | - ->limit(1) |
|
102 | - ->fetch(); |
|
103 | - |
|
104 | - return $logs[0]->getComment(); |
|
105 | - } |
|
106 | - |
|
107 | - /** |
|
108 | - * @return SecurityManager |
|
109 | - */ |
|
110 | - protected function getSecurityManager() |
|
111 | - { |
|
112 | - return $this->securityManager; |
|
113 | - } |
|
29 | + use NavigationMenuAccessControl; |
|
30 | + |
|
31 | + /** |
|
32 | + * @var SecurityManager |
|
33 | + */ |
|
34 | + private $securityManager; |
|
35 | + |
|
36 | + /** |
|
37 | + * AccessDeniedException constructor. |
|
38 | + * |
|
39 | + * @param SecurityManager $securityManager |
|
40 | + */ |
|
41 | + public function __construct(SecurityManager $securityManager = null) |
|
42 | + { |
|
43 | + $this->securityManager = $securityManager; |
|
44 | + } |
|
45 | + |
|
46 | + public function getReadableError() |
|
47 | + { |
|
48 | + if (!headers_sent()) { |
|
49 | + header("HTTP/1.1 403 Forbidden"); |
|
50 | + } |
|
51 | + |
|
52 | + $this->setUpSmarty(); |
|
53 | + |
|
54 | + // uck. We should still be able to access the database in this situation though. |
|
55 | + $database = PdoDatabase::getDatabaseConnection('acc'); |
|
56 | + $currentUser = User::getCurrent($database); |
|
57 | + $this->assign('currentUser', $currentUser); |
|
58 | + $this->assign("loggedIn", (!$currentUser->isCommunityUser())); |
|
59 | + |
|
60 | + if($this->securityManager !== null) { |
|
61 | + $this->setupNavMenuAccess($currentUser); |
|
62 | + } |
|
63 | + |
|
64 | + if ($currentUser->isDeclined()) { |
|
65 | + $this->assign('htmlTitle', 'Account Declined'); |
|
66 | + $this->assign('declineReason', $this->getLogEntry('Declined', $currentUser, $database)); |
|
67 | + |
|
68 | + return $this->fetchTemplate("exception/account-declined.tpl"); |
|
69 | + } |
|
70 | + |
|
71 | + if ($currentUser->isSuspended()) { |
|
72 | + $this->assign('htmlTitle', 'Account Suspended'); |
|
73 | + $this->assign('suspendReason', $this->getLogEntry('Suspended', $currentUser, $database)); |
|
74 | + |
|
75 | + return $this->fetchTemplate("exception/account-suspended.tpl"); |
|
76 | + } |
|
77 | + |
|
78 | + if ($currentUser->isNewUser()) { |
|
79 | + $this->assign('htmlTitle', 'Account Pending'); |
|
80 | + |
|
81 | + return $this->fetchTemplate("exception/account-new.tpl"); |
|
82 | + } |
|
83 | + |
|
84 | + return $this->fetchTemplate("exception/access-denied.tpl"); |
|
85 | + } |
|
86 | + |
|
87 | + /** |
|
88 | + * @param string $action |
|
89 | + * @param User $user |
|
90 | + * @param PdoDatabase $database |
|
91 | + * |
|
92 | + * @return null|string |
|
93 | + */ |
|
94 | + private function getLogEntry($action, User $user, PdoDatabase $database) |
|
95 | + { |
|
96 | + /** @var Log[] $logs */ |
|
97 | + $logs = LogSearchHelper::get($database) |
|
98 | + ->byAction($action) |
|
99 | + ->byObjectType('User') |
|
100 | + ->byObjectId($user->getId()) |
|
101 | + ->limit(1) |
|
102 | + ->fetch(); |
|
103 | + |
|
104 | + return $logs[0]->getComment(); |
|
105 | + } |
|
106 | + |
|
107 | + /** |
|
108 | + * @return SecurityManager |
|
109 | + */ |
|
110 | + protected function getSecurityManager() |
|
111 | + { |
|
112 | + return $this->securityManager; |
|
113 | + } |
|
114 | 114 | } |
115 | 115 | \ No newline at end of file |
@@ -57,7 +57,7 @@ |
||
57 | 57 | $this->assign('currentUser', $currentUser); |
58 | 58 | $this->assign("loggedIn", (!$currentUser->isCommunityUser())); |
59 | 59 | |
60 | - if($this->securityManager !== null) { |
|
60 | + if ($this->securityManager !== null) { |
|
61 | 61 | $this->setupNavMenuAccess($currentUser); |
62 | 62 | } |
63 | 63 |
@@ -15,52 +15,52 @@ |
||
15 | 15 | |
16 | 16 | class NotIdentifiedException extends ReadableException |
17 | 17 | { |
18 | - use NavigationMenuAccessControl; |
|
19 | - /** |
|
20 | - * @var SecurityManager |
|
21 | - */ |
|
22 | - private $securityManager; |
|
18 | + use NavigationMenuAccessControl; |
|
19 | + /** |
|
20 | + * @var SecurityManager |
|
21 | + */ |
|
22 | + private $securityManager; |
|
23 | 23 | |
24 | - /** |
|
25 | - * NotIdentifiedException constructor. |
|
26 | - * |
|
27 | - * @param SecurityManager $securityManager |
|
28 | - */ |
|
29 | - public function __construct(SecurityManager $securityManager = null) |
|
30 | - { |
|
31 | - $this->securityManager = $securityManager; |
|
32 | - } |
|
24 | + /** |
|
25 | + * NotIdentifiedException constructor. |
|
26 | + * |
|
27 | + * @param SecurityManager $securityManager |
|
28 | + */ |
|
29 | + public function __construct(SecurityManager $securityManager = null) |
|
30 | + { |
|
31 | + $this->securityManager = $securityManager; |
|
32 | + } |
|
33 | 33 | |
34 | - /** |
|
35 | - * Returns a readable HTML error message that's displayable to the user using templates. |
|
36 | - * @return string |
|
37 | - */ |
|
38 | - public function getReadableError() |
|
39 | - { |
|
40 | - if (!headers_sent()) { |
|
41 | - header("HTTP/1.1 403 Forbidden"); |
|
42 | - } |
|
34 | + /** |
|
35 | + * Returns a readable HTML error message that's displayable to the user using templates. |
|
36 | + * @return string |
|
37 | + */ |
|
38 | + public function getReadableError() |
|
39 | + { |
|
40 | + if (!headers_sent()) { |
|
41 | + header("HTTP/1.1 403 Forbidden"); |
|
42 | + } |
|
43 | 43 | |
44 | - $this->setUpSmarty(); |
|
44 | + $this->setUpSmarty(); |
|
45 | 45 | |
46 | - // uck. We should still be able to access the database in this situation though. |
|
47 | - $database = PdoDatabase::getDatabaseConnection('acc'); |
|
48 | - $currentUser = User::getCurrent($database); |
|
49 | - $this->assign('currentUser', $currentUser); |
|
50 | - $this->assign("loggedIn", (!$currentUser->isCommunityUser())); |
|
46 | + // uck. We should still be able to access the database in this situation though. |
|
47 | + $database = PdoDatabase::getDatabaseConnection('acc'); |
|
48 | + $currentUser = User::getCurrent($database); |
|
49 | + $this->assign('currentUser', $currentUser); |
|
50 | + $this->assign("loggedIn", (!$currentUser->isCommunityUser())); |
|
51 | 51 | |
52 | - if($this->securityManager !== null) { |
|
53 | - $this->setupNavMenuAccess($currentUser); |
|
54 | - } |
|
52 | + if($this->securityManager !== null) { |
|
53 | + $this->setupNavMenuAccess($currentUser); |
|
54 | + } |
|
55 | 55 | |
56 | - return $this->fetchTemplate("exception/not-identified.tpl"); |
|
57 | - } |
|
56 | + return $this->fetchTemplate("exception/not-identified.tpl"); |
|
57 | + } |
|
58 | 58 | |
59 | - /** |
|
60 | - * @return SecurityManager |
|
61 | - */ |
|
62 | - protected function getSecurityManager() |
|
63 | - { |
|
64 | - return $this->securityManager; |
|
65 | - } |
|
59 | + /** |
|
60 | + * @return SecurityManager |
|
61 | + */ |
|
62 | + protected function getSecurityManager() |
|
63 | + { |
|
64 | + return $this->securityManager; |
|
65 | + } |
|
66 | 66 | } |
67 | 67 | \ No newline at end of file |
@@ -57,7 +57,7 @@ |
||
57 | 57 | $this->assign('currentUser', $currentUser); |
58 | 58 | $this->assign("loggedIn", (!$currentUser->isCommunityUser())); |
59 | 59 | |
60 | - if($this->securityManager !== null) { |
|
60 | + if ($this->securityManager !== null) { |
|
61 | 61 | $this->setupNavMenuAccess($currentUser); |
62 | 62 | } |
63 | 63 |
@@ -16,55 +16,55 @@ |
||
16 | 16 | |
17 | 17 | class MigrateToRoles extends ConsoleTaskBase |
18 | 18 | { |
19 | - public function execute() |
|
20 | - { |
|
21 | - $communityUser = User::getCommunity(); |
|
19 | + public function execute() |
|
20 | + { |
|
21 | + $communityUser = User::getCommunity(); |
|
22 | 22 | |
23 | - $database = $this->getDatabase(); |
|
24 | - $statement = $database->query('SELECT id, status, checkuser FROM user;'); |
|
25 | - $update = $database->prepare("UPDATE user SET status = 'Active' WHERE id = :id;"); |
|
23 | + $database = $this->getDatabase(); |
|
24 | + $statement = $database->query('SELECT id, status, checkuser FROM user;'); |
|
25 | + $update = $database->prepare("UPDATE user SET status = 'Active' WHERE id = :id;"); |
|
26 | 26 | |
27 | - $users = $statement->fetchAll(PDO::FETCH_ASSOC); |
|
27 | + $users = $statement->fetchAll(PDO::FETCH_ASSOC); |
|
28 | 28 | |
29 | - foreach ($users as $user) { |
|
30 | - $toAdd = array('user'); |
|
29 | + foreach ($users as $user) { |
|
30 | + $toAdd = array('user'); |
|
31 | 31 | |
32 | - if($user['status'] === 'Admin'){ |
|
33 | - $toAdd[] = 'admin'; |
|
34 | - } |
|
32 | + if($user['status'] === 'Admin'){ |
|
33 | + $toAdd[] = 'admin'; |
|
34 | + } |
|
35 | 35 | |
36 | - if($user['checkuser'] == 1){ |
|
37 | - $toAdd[] = 'checkuser'; |
|
38 | - } |
|
36 | + if($user['checkuser'] == 1){ |
|
37 | + $toAdd[] = 'checkuser'; |
|
38 | + } |
|
39 | 39 | |
40 | - foreach ($toAdd as $x) { |
|
41 | - $a = new UserRole(); |
|
42 | - $a->setUser($user['id']); |
|
43 | - $a->setRole($x); |
|
44 | - $a->setDatabase($database); |
|
45 | - $a->save(); |
|
46 | - } |
|
40 | + foreach ($toAdd as $x) { |
|
41 | + $a = new UserRole(); |
|
42 | + $a->setUser($user['id']); |
|
43 | + $a->setRole($x); |
|
44 | + $a->setDatabase($database); |
|
45 | + $a->save(); |
|
46 | + } |
|
47 | 47 | |
48 | - $logData = serialize(array( |
|
49 | - 'added' => $toAdd, |
|
50 | - 'removed' => array(), |
|
51 | - 'reason' => 'Initial migration' |
|
52 | - )); |
|
48 | + $logData = serialize(array( |
|
49 | + 'added' => $toAdd, |
|
50 | + 'removed' => array(), |
|
51 | + 'reason' => 'Initial migration' |
|
52 | + )); |
|
53 | 53 | |
54 | - $log = new Log(); |
|
55 | - $log->setDatabase($database); |
|
56 | - $log->setAction('RoleChange'); |
|
57 | - $log->setObjectId($user['id']); |
|
58 | - $log->setObjectType('User'); |
|
59 | - $log->setUser($communityUser); |
|
60 | - $log->setComment($logData); |
|
61 | - $log->save(); |
|
54 | + $log = new Log(); |
|
55 | + $log->setDatabase($database); |
|
56 | + $log->setAction('RoleChange'); |
|
57 | + $log->setObjectId($user['id']); |
|
58 | + $log->setObjectType('User'); |
|
59 | + $log->setUser($communityUser); |
|
60 | + $log->setComment($logData); |
|
61 | + $log->save(); |
|
62 | 62 | |
63 | - if($user['status'] === 'Admin' || $user['status'] === 'User'){ |
|
64 | - $update->execute(array('id' => $user['id'])); |
|
65 | - } |
|
66 | - } |
|
63 | + if($user['status'] === 'Admin' || $user['status'] === 'User'){ |
|
64 | + $update->execute(array('id' => $user['id'])); |
|
65 | + } |
|
66 | + } |
|
67 | 67 | |
68 | - $database->exec("UPDATE schemaversion SET version = 25;"); |
|
69 | - } |
|
68 | + $database->exec("UPDATE schemaversion SET version = 25;"); |
|
69 | + } |
|
70 | 70 | } |
@@ -29,11 +29,11 @@ discard block |
||
29 | 29 | foreach ($users as $user) { |
30 | 30 | $toAdd = array('user'); |
31 | 31 | |
32 | - if($user['status'] === 'Admin'){ |
|
32 | + if ($user['status'] === 'Admin') { |
|
33 | 33 | $toAdd[] = 'admin'; |
34 | 34 | } |
35 | 35 | |
36 | - if($user['checkuser'] == 1){ |
|
36 | + if ($user['checkuser'] == 1) { |
|
37 | 37 | $toAdd[] = 'checkuser'; |
38 | 38 | } |
39 | 39 | |
@@ -60,7 +60,7 @@ discard block |
||
60 | 60 | $log->setComment($logData); |
61 | 61 | $log->save(); |
62 | 62 | |
63 | - if($user['status'] === 'Admin' || $user['status'] === 'User'){ |
|
63 | + if ($user['status'] === 'Admin' || $user['status'] === 'User') { |
|
64 | 64 | $update->execute(array('id' => $user['id'])); |
65 | 65 | } |
66 | 66 | } |
@@ -29,11 +29,11 @@ discard block |
||
29 | 29 | foreach ($users as $user) { |
30 | 30 | $toAdd = array('user'); |
31 | 31 | |
32 | - if($user['status'] === 'Admin'){ |
|
32 | + if($user['status'] === 'Admin') { |
|
33 | 33 | $toAdd[] = 'admin'; |
34 | 34 | } |
35 | 35 | |
36 | - if($user['checkuser'] == 1){ |
|
36 | + if($user['checkuser'] == 1) { |
|
37 | 37 | $toAdd[] = 'checkuser'; |
38 | 38 | } |
39 | 39 | |
@@ -60,7 +60,7 @@ discard block |
||
60 | 60 | $log->setComment($logData); |
61 | 61 | $log->save(); |
62 | 62 | |
63 | - if($user['status'] === 'Admin' || $user['status'] === 'User'){ |
|
63 | + if($user['status'] === 'Admin' || $user['status'] === 'User') { |
|
64 | 64 | $update->execute(array('id' => $user['id'])); |
65 | 65 | } |
66 | 66 | } |