@@ -22,521 +22,521 @@ |
||
| 22 | 22 | */ |
| 23 | 23 | class WebRequest |
| 24 | 24 | { |
| 25 | - /** |
|
| 26 | - * @var \Waca\Providers\GlobalState\IGlobalStateProvider Provides access to the global state. |
|
| 27 | - */ |
|
| 28 | - private static $globalStateProvider; |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * Returns a boolean value if the request was submitted with the HTTP POST method. |
|
| 32 | - * @return bool |
|
| 33 | - */ |
|
| 34 | - public static function wasPosted() |
|
| 35 | - { |
|
| 36 | - return self::method() === 'POST'; |
|
| 37 | - } |
|
| 38 | - |
|
| 39 | - /** |
|
| 40 | - * Gets the HTTP Method used |
|
| 41 | - * @return string|null |
|
| 42 | - */ |
|
| 43 | - public static function method() |
|
| 44 | - { |
|
| 45 | - $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 46 | - |
|
| 47 | - if (isset($server['REQUEST_METHOD'])) { |
|
| 48 | - return $server['REQUEST_METHOD']; |
|
| 49 | - } |
|
| 50 | - |
|
| 51 | - return null; |
|
| 52 | - } |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * Gets a boolean value stating whether the request was served over HTTPS or not. |
|
| 56 | - * @return bool |
|
| 57 | - */ |
|
| 58 | - public static function isHttps() |
|
| 59 | - { |
|
| 60 | - $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 61 | - |
|
| 62 | - if (isset($server['HTTP_X_FORWARDED_PROTO'])) { |
|
| 63 | - if ($server['HTTP_X_FORWARDED_PROTO'] === 'https') { |
|
| 64 | - // Client <=> Proxy is encrypted |
|
| 65 | - return true; |
|
| 66 | - } |
|
| 67 | - else { |
|
| 68 | - // Proxy <=> Server link unknown, Client <=> Proxy is not encrypted. |
|
| 69 | - return false; |
|
| 70 | - } |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - if (isset($server['HTTPS'])) { |
|
| 74 | - if ($server['HTTPS'] === 'off') { |
|
| 75 | - // ISAPI on IIS breaks the spec. :( |
|
| 76 | - return false; |
|
| 77 | - } |
|
| 78 | - |
|
| 79 | - if ($server['HTTPS'] !== '') { |
|
| 80 | - // Set to a non-empty value |
|
| 81 | - return true; |
|
| 82 | - } |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - return false; |
|
| 86 | - } |
|
| 87 | - |
|
| 88 | - /** |
|
| 89 | - * Gets the path info |
|
| 90 | - * |
|
| 91 | - * @return array Array of path info segments |
|
| 92 | - */ |
|
| 93 | - public static function pathInfo() |
|
| 94 | - { |
|
| 95 | - $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 96 | - if (!isset($server['PATH_INFO'])) { |
|
| 97 | - return array(); |
|
| 98 | - } |
|
| 99 | - |
|
| 100 | - $exploded = explode('/', $server['PATH_INFO']); |
|
| 101 | - |
|
| 102 | - // filter out empty values, and reindex from zero. Notably, the first element is always zero, since it starts |
|
| 103 | - // with a / |
|
| 104 | - return array_values(array_filter($exploded)); |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Gets the remote address of the web request |
|
| 109 | - * @return null|string |
|
| 110 | - */ |
|
| 111 | - public static function remoteAddress() |
|
| 112 | - { |
|
| 113 | - $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 114 | - |
|
| 115 | - if (isset($server['REMOTE_ADDR'])) { |
|
| 116 | - return $server['REMOTE_ADDR']; |
|
| 117 | - } |
|
| 118 | - |
|
| 119 | - return null; |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * Gets the XFF header contents for the web request |
|
| 124 | - * @return null|string |
|
| 125 | - */ |
|
| 126 | - public static function forwardedAddress() |
|
| 127 | - { |
|
| 128 | - $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 129 | - |
|
| 130 | - if (isset($server['HTTP_X_FORWARDED_FOR'])) { |
|
| 131 | - return $server['HTTP_X_FORWARDED_FOR']; |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - return null; |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - /** |
|
| 138 | - * Sets the global state provider. |
|
| 139 | - * |
|
| 140 | - * Almost guaranteed this is not the method you want in production code. |
|
| 141 | - * |
|
| 142 | - * @param \Waca\Providers\GlobalState\IGlobalStateProvider $globalState |
|
| 143 | - */ |
|
| 144 | - public static function setGlobalStateProvider($globalState) |
|
| 145 | - { |
|
| 146 | - self::$globalStateProvider = $globalState; |
|
| 147 | - } |
|
| 148 | - |
|
| 149 | - #region POST variables |
|
| 150 | - |
|
| 151 | - /** |
|
| 152 | - * @param string $key |
|
| 153 | - * |
|
| 154 | - * @return null|string |
|
| 155 | - */ |
|
| 156 | - public static function postString($key) |
|
| 157 | - { |
|
| 158 | - $post = &self::$globalStateProvider->getPostSuperGlobal(); |
|
| 159 | - if (!array_key_exists($key, $post)) { |
|
| 160 | - return null; |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - if ($post[$key] === "") { |
|
| 164 | - return null; |
|
| 165 | - } |
|
| 166 | - |
|
| 167 | - return (string)$post[$key]; |
|
| 168 | - } |
|
| 169 | - |
|
| 170 | - /** |
|
| 171 | - * @param string $key |
|
| 172 | - * |
|
| 173 | - * @return null|string |
|
| 174 | - */ |
|
| 175 | - public static function postEmail($key) |
|
| 176 | - { |
|
| 177 | - $post = &self::$globalStateProvider->getPostSuperGlobal(); |
|
| 178 | - if (!array_key_exists($key, $post)) { |
|
| 179 | - return null; |
|
| 180 | - } |
|
| 181 | - |
|
| 182 | - $filteredValue = filter_var($post[$key], FILTER_SANITIZE_EMAIL); |
|
| 183 | - |
|
| 184 | - if ($filteredValue === false) { |
|
| 185 | - return null; |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - return (string)$filteredValue; |
|
| 189 | - } |
|
| 190 | - |
|
| 191 | - /** |
|
| 192 | - * @param string $key |
|
| 193 | - * |
|
| 194 | - * @return int|null |
|
| 195 | - */ |
|
| 196 | - public static function postInt($key) |
|
| 197 | - { |
|
| 198 | - $post = &self::$globalStateProvider->getPostSuperGlobal(); |
|
| 199 | - if (!array_key_exists($key, $post)) { |
|
| 200 | - return null; |
|
| 201 | - } |
|
| 202 | - |
|
| 203 | - $filteredValue = filter_var($post[$key], FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE); |
|
| 204 | - |
|
| 205 | - if ($filteredValue === null) { |
|
| 206 | - return null; |
|
| 207 | - } |
|
| 208 | - |
|
| 209 | - return (int)$filteredValue; |
|
| 210 | - } |
|
| 211 | - |
|
| 212 | - /** |
|
| 213 | - * @param string $key |
|
| 214 | - * |
|
| 215 | - * @return bool |
|
| 216 | - */ |
|
| 217 | - public static function postBoolean($key) |
|
| 218 | - { |
|
| 219 | - $get = &self::$globalStateProvider->getPostSuperGlobal(); |
|
| 220 | - if (!array_key_exists($key, $get)) { |
|
| 221 | - return false; |
|
| 222 | - } |
|
| 223 | - |
|
| 224 | - // presence of parameter only |
|
| 225 | - if ($get[$key] === "") { |
|
| 226 | - return true; |
|
| 227 | - } |
|
| 228 | - |
|
| 229 | - if (in_array($get[$key], array(false, 'no', 'off', 0, 'false'), true)) { |
|
| 230 | - return false; |
|
| 231 | - } |
|
| 232 | - |
|
| 233 | - return true; |
|
| 234 | - } |
|
| 235 | - |
|
| 236 | - #endregion |
|
| 237 | - |
|
| 238 | - #region GET variables |
|
| 239 | - |
|
| 240 | - /** |
|
| 241 | - * @param string $key |
|
| 242 | - * |
|
| 243 | - * @return bool |
|
| 244 | - */ |
|
| 245 | - public static function getBoolean($key) |
|
| 246 | - { |
|
| 247 | - $get = &self::$globalStateProvider->getGetSuperGlobal(); |
|
| 248 | - if (!array_key_exists($key, $get)) { |
|
| 249 | - return false; |
|
| 250 | - } |
|
| 251 | - |
|
| 252 | - // presence of parameter only |
|
| 253 | - if ($get[$key] === "") { |
|
| 254 | - return true; |
|
| 255 | - } |
|
| 256 | - |
|
| 257 | - if (in_array($get[$key], array(false, 'no', 'off', 0, 'false'), true)) { |
|
| 258 | - return false; |
|
| 259 | - } |
|
| 260 | - |
|
| 261 | - return true; |
|
| 262 | - } |
|
| 263 | - |
|
| 264 | - /** |
|
| 265 | - * @param string $key |
|
| 266 | - * |
|
| 267 | - * @return int|null |
|
| 268 | - */ |
|
| 269 | - public static function getInt($key) |
|
| 270 | - { |
|
| 271 | - $get = &self::$globalStateProvider->getGetSuperGlobal(); |
|
| 272 | - if (!array_key_exists($key, $get)) { |
|
| 273 | - return null; |
|
| 274 | - } |
|
| 275 | - |
|
| 276 | - $filteredValue = filter_var($get[$key], FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE); |
|
| 277 | - |
|
| 278 | - if ($filteredValue === null) { |
|
| 279 | - return null; |
|
| 280 | - } |
|
| 281 | - |
|
| 282 | - return (int)$filteredValue; |
|
| 283 | - } |
|
| 284 | - |
|
| 285 | - /** |
|
| 286 | - * @param string $key |
|
| 287 | - * |
|
| 288 | - * @return null|string |
|
| 289 | - */ |
|
| 290 | - public static function getString($key) |
|
| 291 | - { |
|
| 292 | - $get = &self::$globalStateProvider->getGetSuperGlobal(); |
|
| 293 | - if (!array_key_exists($key, $get)) { |
|
| 294 | - return null; |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - if ($get[$key] === "") { |
|
| 298 | - return null; |
|
| 299 | - } |
|
| 300 | - |
|
| 301 | - return (string)$get[$key]; |
|
| 302 | - } |
|
| 303 | - |
|
| 304 | - #endregion |
|
| 305 | - |
|
| 306 | - /** |
|
| 307 | - * Sets the logged-in user to the specified user. |
|
| 308 | - * |
|
| 309 | - * @param User $user |
|
| 310 | - */ |
|
| 311 | - public static function setLoggedInUser(User $user) |
|
| 312 | - { |
|
| 313 | - $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 314 | - |
|
| 315 | - $session['userID'] = $user->getId(); |
|
| 316 | - unset($session['partialLogin']); |
|
| 317 | - } |
|
| 318 | - |
|
| 319 | - /** |
|
| 320 | - * Sets the post-login redirect |
|
| 321 | - */ |
|
| 322 | - public static function setPostLoginRedirect() |
|
| 323 | - { |
|
| 324 | - $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 325 | - $session['returnTo'] = self::requestUri(); |
|
| 326 | - } |
|
| 327 | - |
|
| 328 | - /** |
|
| 329 | - * @return string|null |
|
| 330 | - */ |
|
| 331 | - public static function requestUri() |
|
| 332 | - { |
|
| 333 | - $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 334 | - |
|
| 335 | - if (isset($server['REQUEST_URI'])) { |
|
| 336 | - return $server['REQUEST_URI']; |
|
| 337 | - } |
|
| 338 | - |
|
| 339 | - return null; |
|
| 340 | - } |
|
| 341 | - |
|
| 342 | - /** |
|
| 343 | - * Clears the post-login redirect |
|
| 344 | - * @return string |
|
| 345 | - */ |
|
| 346 | - public static function clearPostLoginRedirect() |
|
| 347 | - { |
|
| 348 | - $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 349 | - if (array_key_exists('returnTo', $session)) { |
|
| 350 | - $path = $session['returnTo']; |
|
| 351 | - unset($session['returnTo']); |
|
| 352 | - |
|
| 353 | - return $path; |
|
| 354 | - } |
|
| 355 | - |
|
| 356 | - return null; |
|
| 357 | - } |
|
| 358 | - |
|
| 359 | - /** |
|
| 360 | - * @return string|null |
|
| 361 | - */ |
|
| 362 | - public static function serverName() |
|
| 363 | - { |
|
| 364 | - $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 365 | - |
|
| 366 | - if (isset($server['SERVER_NAME'])) { |
|
| 367 | - return $server['SERVER_NAME']; |
|
| 368 | - } |
|
| 369 | - |
|
| 370 | - return null; |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - /** |
|
| 374 | - * You probably only want to deal with this through SessionAlert. |
|
| 375 | - * @return void |
|
| 376 | - */ |
|
| 377 | - public static function clearSessionAlertData() |
|
| 378 | - { |
|
| 379 | - $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 380 | - if (array_key_exists('alerts', $session)) { |
|
| 381 | - unset($session['alerts']); |
|
| 382 | - } |
|
| 383 | - } |
|
| 384 | - |
|
| 385 | - /** |
|
| 386 | - * You probably only want to deal with this through SessionAlert. |
|
| 387 | - * |
|
| 388 | - * @return string[] |
|
| 389 | - */ |
|
| 390 | - public static function getSessionAlertData() |
|
| 391 | - { |
|
| 392 | - $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 393 | - if (array_key_exists('alerts', $session)) { |
|
| 394 | - return $session['alerts']; |
|
| 395 | - } |
|
| 396 | - |
|
| 397 | - return array(); |
|
| 398 | - } |
|
| 399 | - |
|
| 400 | - /** |
|
| 401 | - * You probably only want to deal with this through SessionAlert. |
|
| 402 | - * |
|
| 403 | - * @param string[] $data |
|
| 404 | - */ |
|
| 405 | - public static function setSessionAlertData($data) |
|
| 406 | - { |
|
| 407 | - $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 408 | - $session['alerts'] = $data; |
|
| 409 | - } |
|
| 410 | - |
|
| 411 | - /** |
|
| 412 | - * You probably only want to deal with this through TokenManager. |
|
| 413 | - * |
|
| 414 | - * @return string[] |
|
| 415 | - */ |
|
| 416 | - public static function getSessionTokenData() |
|
| 417 | - { |
|
| 418 | - $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 419 | - if (array_key_exists('tokens', $session)) { |
|
| 420 | - return $session['tokens']; |
|
| 421 | - } |
|
| 422 | - |
|
| 423 | - return array(); |
|
| 424 | - } |
|
| 425 | - |
|
| 426 | - /** |
|
| 427 | - * You probably only want to deal with this through TokenManager. |
|
| 428 | - * |
|
| 429 | - * @param string[] $data |
|
| 430 | - */ |
|
| 431 | - public static function setSessionTokenData($data) |
|
| 432 | - { |
|
| 433 | - $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 434 | - $session['tokens'] = $data; |
|
| 435 | - } |
|
| 436 | - |
|
| 437 | - /** |
|
| 438 | - * @param string $key |
|
| 439 | - * |
|
| 440 | - * @return mixed |
|
| 441 | - */ |
|
| 442 | - public static function getSessionContext($key) |
|
| 443 | - { |
|
| 444 | - $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 445 | - |
|
| 446 | - if (!isset($session['context'])) { |
|
| 447 | - $session['context'] = array(); |
|
| 448 | - } |
|
| 449 | - |
|
| 450 | - if (!isset($session['context'][$key])) { |
|
| 451 | - return null; |
|
| 452 | - } |
|
| 453 | - |
|
| 454 | - return $session['context'][$key]; |
|
| 455 | - } |
|
| 456 | - |
|
| 457 | - /** |
|
| 458 | - * @param string $key |
|
| 459 | - * @param mixed $data |
|
| 460 | - */ |
|
| 461 | - public static function setSessionContext($key, $data) |
|
| 462 | - { |
|
| 463 | - $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 464 | - |
|
| 465 | - if (!isset($session['context'])) { |
|
| 466 | - $session['context'] = array(); |
|
| 467 | - } |
|
| 468 | - |
|
| 469 | - $session['context'][$key] = $data; |
|
| 470 | - } |
|
| 471 | - |
|
| 472 | - /** |
|
| 473 | - * @return int|null |
|
| 474 | - */ |
|
| 475 | - public static function getSessionUserId() |
|
| 476 | - { |
|
| 477 | - $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 478 | - |
|
| 479 | - return isset($session['userID']) ? (int)$session['userID'] : null; |
|
| 480 | - } |
|
| 481 | - |
|
| 482 | - /** |
|
| 483 | - * @param User $user |
|
| 484 | - */ |
|
| 485 | - public static function setPartialLogin(User $user) |
|
| 486 | - { |
|
| 487 | - $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 488 | - $session['partialLogin'] = $user->getId(); |
|
| 489 | - } |
|
| 490 | - |
|
| 491 | - /** |
|
| 492 | - * @return int|null |
|
| 493 | - */ |
|
| 494 | - public static function getPartialLogin() |
|
| 495 | - { |
|
| 496 | - $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 497 | - |
|
| 498 | - return isset($session['partialLogin']) ? (int)$session['partialLogin'] : null; |
|
| 499 | - } |
|
| 500 | - |
|
| 501 | - /** |
|
| 502 | - * @return null|string |
|
| 503 | - */ |
|
| 504 | - public static function userAgent() |
|
| 505 | - { |
|
| 506 | - $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 507 | - |
|
| 508 | - if (isset($server['HTTP_USER_AGENT'])) { |
|
| 509 | - return $server['HTTP_USER_AGENT']; |
|
| 510 | - } |
|
| 511 | - |
|
| 512 | - return null; |
|
| 513 | - } |
|
| 514 | - |
|
| 515 | - /** |
|
| 516 | - * @return null|string |
|
| 517 | - */ |
|
| 518 | - public static function scriptName() |
|
| 519 | - { |
|
| 520 | - $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 521 | - |
|
| 522 | - if (isset($server['SCRIPT_NAME'])) { |
|
| 523 | - return $server['SCRIPT_NAME']; |
|
| 524 | - } |
|
| 525 | - |
|
| 526 | - return null; |
|
| 527 | - } |
|
| 528 | - |
|
| 529 | - /** |
|
| 530 | - * @return null|string |
|
| 531 | - */ |
|
| 532 | - public static function origin() |
|
| 533 | - { |
|
| 534 | - $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 535 | - |
|
| 536 | - if (isset($server['HTTP_ORIGIN'])) { |
|
| 537 | - return $server['HTTP_ORIGIN']; |
|
| 538 | - } |
|
| 539 | - |
|
| 540 | - return null; |
|
| 541 | - } |
|
| 25 | + /** |
|
| 26 | + * @var \Waca\Providers\GlobalState\IGlobalStateProvider Provides access to the global state. |
|
| 27 | + */ |
|
| 28 | + private static $globalStateProvider; |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * Returns a boolean value if the request was submitted with the HTTP POST method. |
|
| 32 | + * @return bool |
|
| 33 | + */ |
|
| 34 | + public static function wasPosted() |
|
| 35 | + { |
|
| 36 | + return self::method() === 'POST'; |
|
| 37 | + } |
|
| 38 | + |
|
| 39 | + /** |
|
| 40 | + * Gets the HTTP Method used |
|
| 41 | + * @return string|null |
|
| 42 | + */ |
|
| 43 | + public static function method() |
|
| 44 | + { |
|
| 45 | + $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 46 | + |
|
| 47 | + if (isset($server['REQUEST_METHOD'])) { |
|
| 48 | + return $server['REQUEST_METHOD']; |
|
| 49 | + } |
|
| 50 | + |
|
| 51 | + return null; |
|
| 52 | + } |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * Gets a boolean value stating whether the request was served over HTTPS or not. |
|
| 56 | + * @return bool |
|
| 57 | + */ |
|
| 58 | + public static function isHttps() |
|
| 59 | + { |
|
| 60 | + $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 61 | + |
|
| 62 | + if (isset($server['HTTP_X_FORWARDED_PROTO'])) { |
|
| 63 | + if ($server['HTTP_X_FORWARDED_PROTO'] === 'https') { |
|
| 64 | + // Client <=> Proxy is encrypted |
|
| 65 | + return true; |
|
| 66 | + } |
|
| 67 | + else { |
|
| 68 | + // Proxy <=> Server link unknown, Client <=> Proxy is not encrypted. |
|
| 69 | + return false; |
|
| 70 | + } |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + if (isset($server['HTTPS'])) { |
|
| 74 | + if ($server['HTTPS'] === 'off') { |
|
| 75 | + // ISAPI on IIS breaks the spec. :( |
|
| 76 | + return false; |
|
| 77 | + } |
|
| 78 | + |
|
| 79 | + if ($server['HTTPS'] !== '') { |
|
| 80 | + // Set to a non-empty value |
|
| 81 | + return true; |
|
| 82 | + } |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + return false; |
|
| 86 | + } |
|
| 87 | + |
|
| 88 | + /** |
|
| 89 | + * Gets the path info |
|
| 90 | + * |
|
| 91 | + * @return array Array of path info segments |
|
| 92 | + */ |
|
| 93 | + public static function pathInfo() |
|
| 94 | + { |
|
| 95 | + $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 96 | + if (!isset($server['PATH_INFO'])) { |
|
| 97 | + return array(); |
|
| 98 | + } |
|
| 99 | + |
|
| 100 | + $exploded = explode('/', $server['PATH_INFO']); |
|
| 101 | + |
|
| 102 | + // filter out empty values, and reindex from zero. Notably, the first element is always zero, since it starts |
|
| 103 | + // with a / |
|
| 104 | + return array_values(array_filter($exploded)); |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Gets the remote address of the web request |
|
| 109 | + * @return null|string |
|
| 110 | + */ |
|
| 111 | + public static function remoteAddress() |
|
| 112 | + { |
|
| 113 | + $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 114 | + |
|
| 115 | + if (isset($server['REMOTE_ADDR'])) { |
|
| 116 | + return $server['REMOTE_ADDR']; |
|
| 117 | + } |
|
| 118 | + |
|
| 119 | + return null; |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * Gets the XFF header contents for the web request |
|
| 124 | + * @return null|string |
|
| 125 | + */ |
|
| 126 | + public static function forwardedAddress() |
|
| 127 | + { |
|
| 128 | + $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 129 | + |
|
| 130 | + if (isset($server['HTTP_X_FORWARDED_FOR'])) { |
|
| 131 | + return $server['HTTP_X_FORWARDED_FOR']; |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + return null; |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + /** |
|
| 138 | + * Sets the global state provider. |
|
| 139 | + * |
|
| 140 | + * Almost guaranteed this is not the method you want in production code. |
|
| 141 | + * |
|
| 142 | + * @param \Waca\Providers\GlobalState\IGlobalStateProvider $globalState |
|
| 143 | + */ |
|
| 144 | + public static function setGlobalStateProvider($globalState) |
|
| 145 | + { |
|
| 146 | + self::$globalStateProvider = $globalState; |
|
| 147 | + } |
|
| 148 | + |
|
| 149 | + #region POST variables |
|
| 150 | + |
|
| 151 | + /** |
|
| 152 | + * @param string $key |
|
| 153 | + * |
|
| 154 | + * @return null|string |
|
| 155 | + */ |
|
| 156 | + public static function postString($key) |
|
| 157 | + { |
|
| 158 | + $post = &self::$globalStateProvider->getPostSuperGlobal(); |
|
| 159 | + if (!array_key_exists($key, $post)) { |
|
| 160 | + return null; |
|
| 161 | + } |
|
| 162 | + |
|
| 163 | + if ($post[$key] === "") { |
|
| 164 | + return null; |
|
| 165 | + } |
|
| 166 | + |
|
| 167 | + return (string)$post[$key]; |
|
| 168 | + } |
|
| 169 | + |
|
| 170 | + /** |
|
| 171 | + * @param string $key |
|
| 172 | + * |
|
| 173 | + * @return null|string |
|
| 174 | + */ |
|
| 175 | + public static function postEmail($key) |
|
| 176 | + { |
|
| 177 | + $post = &self::$globalStateProvider->getPostSuperGlobal(); |
|
| 178 | + if (!array_key_exists($key, $post)) { |
|
| 179 | + return null; |
|
| 180 | + } |
|
| 181 | + |
|
| 182 | + $filteredValue = filter_var($post[$key], FILTER_SANITIZE_EMAIL); |
|
| 183 | + |
|
| 184 | + if ($filteredValue === false) { |
|
| 185 | + return null; |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + return (string)$filteredValue; |
|
| 189 | + } |
|
| 190 | + |
|
| 191 | + /** |
|
| 192 | + * @param string $key |
|
| 193 | + * |
|
| 194 | + * @return int|null |
|
| 195 | + */ |
|
| 196 | + public static function postInt($key) |
|
| 197 | + { |
|
| 198 | + $post = &self::$globalStateProvider->getPostSuperGlobal(); |
|
| 199 | + if (!array_key_exists($key, $post)) { |
|
| 200 | + return null; |
|
| 201 | + } |
|
| 202 | + |
|
| 203 | + $filteredValue = filter_var($post[$key], FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE); |
|
| 204 | + |
|
| 205 | + if ($filteredValue === null) { |
|
| 206 | + return null; |
|
| 207 | + } |
|
| 208 | + |
|
| 209 | + return (int)$filteredValue; |
|
| 210 | + } |
|
| 211 | + |
|
| 212 | + /** |
|
| 213 | + * @param string $key |
|
| 214 | + * |
|
| 215 | + * @return bool |
|
| 216 | + */ |
|
| 217 | + public static function postBoolean($key) |
|
| 218 | + { |
|
| 219 | + $get = &self::$globalStateProvider->getPostSuperGlobal(); |
|
| 220 | + if (!array_key_exists($key, $get)) { |
|
| 221 | + return false; |
|
| 222 | + } |
|
| 223 | + |
|
| 224 | + // presence of parameter only |
|
| 225 | + if ($get[$key] === "") { |
|
| 226 | + return true; |
|
| 227 | + } |
|
| 228 | + |
|
| 229 | + if (in_array($get[$key], array(false, 'no', 'off', 0, 'false'), true)) { |
|
| 230 | + return false; |
|
| 231 | + } |
|
| 232 | + |
|
| 233 | + return true; |
|
| 234 | + } |
|
| 235 | + |
|
| 236 | + #endregion |
|
| 237 | + |
|
| 238 | + #region GET variables |
|
| 239 | + |
|
| 240 | + /** |
|
| 241 | + * @param string $key |
|
| 242 | + * |
|
| 243 | + * @return bool |
|
| 244 | + */ |
|
| 245 | + public static function getBoolean($key) |
|
| 246 | + { |
|
| 247 | + $get = &self::$globalStateProvider->getGetSuperGlobal(); |
|
| 248 | + if (!array_key_exists($key, $get)) { |
|
| 249 | + return false; |
|
| 250 | + } |
|
| 251 | + |
|
| 252 | + // presence of parameter only |
|
| 253 | + if ($get[$key] === "") { |
|
| 254 | + return true; |
|
| 255 | + } |
|
| 256 | + |
|
| 257 | + if (in_array($get[$key], array(false, 'no', 'off', 0, 'false'), true)) { |
|
| 258 | + return false; |
|
| 259 | + } |
|
| 260 | + |
|
| 261 | + return true; |
|
| 262 | + } |
|
| 263 | + |
|
| 264 | + /** |
|
| 265 | + * @param string $key |
|
| 266 | + * |
|
| 267 | + * @return int|null |
|
| 268 | + */ |
|
| 269 | + public static function getInt($key) |
|
| 270 | + { |
|
| 271 | + $get = &self::$globalStateProvider->getGetSuperGlobal(); |
|
| 272 | + if (!array_key_exists($key, $get)) { |
|
| 273 | + return null; |
|
| 274 | + } |
|
| 275 | + |
|
| 276 | + $filteredValue = filter_var($get[$key], FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE); |
|
| 277 | + |
|
| 278 | + if ($filteredValue === null) { |
|
| 279 | + return null; |
|
| 280 | + } |
|
| 281 | + |
|
| 282 | + return (int)$filteredValue; |
|
| 283 | + } |
|
| 284 | + |
|
| 285 | + /** |
|
| 286 | + * @param string $key |
|
| 287 | + * |
|
| 288 | + * @return null|string |
|
| 289 | + */ |
|
| 290 | + public static function getString($key) |
|
| 291 | + { |
|
| 292 | + $get = &self::$globalStateProvider->getGetSuperGlobal(); |
|
| 293 | + if (!array_key_exists($key, $get)) { |
|
| 294 | + return null; |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + if ($get[$key] === "") { |
|
| 298 | + return null; |
|
| 299 | + } |
|
| 300 | + |
|
| 301 | + return (string)$get[$key]; |
|
| 302 | + } |
|
| 303 | + |
|
| 304 | + #endregion |
|
| 305 | + |
|
| 306 | + /** |
|
| 307 | + * Sets the logged-in user to the specified user. |
|
| 308 | + * |
|
| 309 | + * @param User $user |
|
| 310 | + */ |
|
| 311 | + public static function setLoggedInUser(User $user) |
|
| 312 | + { |
|
| 313 | + $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 314 | + |
|
| 315 | + $session['userID'] = $user->getId(); |
|
| 316 | + unset($session['partialLogin']); |
|
| 317 | + } |
|
| 318 | + |
|
| 319 | + /** |
|
| 320 | + * Sets the post-login redirect |
|
| 321 | + */ |
|
| 322 | + public static function setPostLoginRedirect() |
|
| 323 | + { |
|
| 324 | + $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 325 | + $session['returnTo'] = self::requestUri(); |
|
| 326 | + } |
|
| 327 | + |
|
| 328 | + /** |
|
| 329 | + * @return string|null |
|
| 330 | + */ |
|
| 331 | + public static function requestUri() |
|
| 332 | + { |
|
| 333 | + $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 334 | + |
|
| 335 | + if (isset($server['REQUEST_URI'])) { |
|
| 336 | + return $server['REQUEST_URI']; |
|
| 337 | + } |
|
| 338 | + |
|
| 339 | + return null; |
|
| 340 | + } |
|
| 341 | + |
|
| 342 | + /** |
|
| 343 | + * Clears the post-login redirect |
|
| 344 | + * @return string |
|
| 345 | + */ |
|
| 346 | + public static function clearPostLoginRedirect() |
|
| 347 | + { |
|
| 348 | + $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 349 | + if (array_key_exists('returnTo', $session)) { |
|
| 350 | + $path = $session['returnTo']; |
|
| 351 | + unset($session['returnTo']); |
|
| 352 | + |
|
| 353 | + return $path; |
|
| 354 | + } |
|
| 355 | + |
|
| 356 | + return null; |
|
| 357 | + } |
|
| 358 | + |
|
| 359 | + /** |
|
| 360 | + * @return string|null |
|
| 361 | + */ |
|
| 362 | + public static function serverName() |
|
| 363 | + { |
|
| 364 | + $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 365 | + |
|
| 366 | + if (isset($server['SERVER_NAME'])) { |
|
| 367 | + return $server['SERVER_NAME']; |
|
| 368 | + } |
|
| 369 | + |
|
| 370 | + return null; |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + /** |
|
| 374 | + * You probably only want to deal with this through SessionAlert. |
|
| 375 | + * @return void |
|
| 376 | + */ |
|
| 377 | + public static function clearSessionAlertData() |
|
| 378 | + { |
|
| 379 | + $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 380 | + if (array_key_exists('alerts', $session)) { |
|
| 381 | + unset($session['alerts']); |
|
| 382 | + } |
|
| 383 | + } |
|
| 384 | + |
|
| 385 | + /** |
|
| 386 | + * You probably only want to deal with this through SessionAlert. |
|
| 387 | + * |
|
| 388 | + * @return string[] |
|
| 389 | + */ |
|
| 390 | + public static function getSessionAlertData() |
|
| 391 | + { |
|
| 392 | + $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 393 | + if (array_key_exists('alerts', $session)) { |
|
| 394 | + return $session['alerts']; |
|
| 395 | + } |
|
| 396 | + |
|
| 397 | + return array(); |
|
| 398 | + } |
|
| 399 | + |
|
| 400 | + /** |
|
| 401 | + * You probably only want to deal with this through SessionAlert. |
|
| 402 | + * |
|
| 403 | + * @param string[] $data |
|
| 404 | + */ |
|
| 405 | + public static function setSessionAlertData($data) |
|
| 406 | + { |
|
| 407 | + $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 408 | + $session['alerts'] = $data; |
|
| 409 | + } |
|
| 410 | + |
|
| 411 | + /** |
|
| 412 | + * You probably only want to deal with this through TokenManager. |
|
| 413 | + * |
|
| 414 | + * @return string[] |
|
| 415 | + */ |
|
| 416 | + public static function getSessionTokenData() |
|
| 417 | + { |
|
| 418 | + $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 419 | + if (array_key_exists('tokens', $session)) { |
|
| 420 | + return $session['tokens']; |
|
| 421 | + } |
|
| 422 | + |
|
| 423 | + return array(); |
|
| 424 | + } |
|
| 425 | + |
|
| 426 | + /** |
|
| 427 | + * You probably only want to deal with this through TokenManager. |
|
| 428 | + * |
|
| 429 | + * @param string[] $data |
|
| 430 | + */ |
|
| 431 | + public static function setSessionTokenData($data) |
|
| 432 | + { |
|
| 433 | + $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 434 | + $session['tokens'] = $data; |
|
| 435 | + } |
|
| 436 | + |
|
| 437 | + /** |
|
| 438 | + * @param string $key |
|
| 439 | + * |
|
| 440 | + * @return mixed |
|
| 441 | + */ |
|
| 442 | + public static function getSessionContext($key) |
|
| 443 | + { |
|
| 444 | + $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 445 | + |
|
| 446 | + if (!isset($session['context'])) { |
|
| 447 | + $session['context'] = array(); |
|
| 448 | + } |
|
| 449 | + |
|
| 450 | + if (!isset($session['context'][$key])) { |
|
| 451 | + return null; |
|
| 452 | + } |
|
| 453 | + |
|
| 454 | + return $session['context'][$key]; |
|
| 455 | + } |
|
| 456 | + |
|
| 457 | + /** |
|
| 458 | + * @param string $key |
|
| 459 | + * @param mixed $data |
|
| 460 | + */ |
|
| 461 | + public static function setSessionContext($key, $data) |
|
| 462 | + { |
|
| 463 | + $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 464 | + |
|
| 465 | + if (!isset($session['context'])) { |
|
| 466 | + $session['context'] = array(); |
|
| 467 | + } |
|
| 468 | + |
|
| 469 | + $session['context'][$key] = $data; |
|
| 470 | + } |
|
| 471 | + |
|
| 472 | + /** |
|
| 473 | + * @return int|null |
|
| 474 | + */ |
|
| 475 | + public static function getSessionUserId() |
|
| 476 | + { |
|
| 477 | + $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 478 | + |
|
| 479 | + return isset($session['userID']) ? (int)$session['userID'] : null; |
|
| 480 | + } |
|
| 481 | + |
|
| 482 | + /** |
|
| 483 | + * @param User $user |
|
| 484 | + */ |
|
| 485 | + public static function setPartialLogin(User $user) |
|
| 486 | + { |
|
| 487 | + $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 488 | + $session['partialLogin'] = $user->getId(); |
|
| 489 | + } |
|
| 490 | + |
|
| 491 | + /** |
|
| 492 | + * @return int|null |
|
| 493 | + */ |
|
| 494 | + public static function getPartialLogin() |
|
| 495 | + { |
|
| 496 | + $session = &self::$globalStateProvider->getSessionSuperGlobal(); |
|
| 497 | + |
|
| 498 | + return isset($session['partialLogin']) ? (int)$session['partialLogin'] : null; |
|
| 499 | + } |
|
| 500 | + |
|
| 501 | + /** |
|
| 502 | + * @return null|string |
|
| 503 | + */ |
|
| 504 | + public static function userAgent() |
|
| 505 | + { |
|
| 506 | + $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 507 | + |
|
| 508 | + if (isset($server['HTTP_USER_AGENT'])) { |
|
| 509 | + return $server['HTTP_USER_AGENT']; |
|
| 510 | + } |
|
| 511 | + |
|
| 512 | + return null; |
|
| 513 | + } |
|
| 514 | + |
|
| 515 | + /** |
|
| 516 | + * @return null|string |
|
| 517 | + */ |
|
| 518 | + public static function scriptName() |
|
| 519 | + { |
|
| 520 | + $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 521 | + |
|
| 522 | + if (isset($server['SCRIPT_NAME'])) { |
|
| 523 | + return $server['SCRIPT_NAME']; |
|
| 524 | + } |
|
| 525 | + |
|
| 526 | + return null; |
|
| 527 | + } |
|
| 528 | + |
|
| 529 | + /** |
|
| 530 | + * @return null|string |
|
| 531 | + */ |
|
| 532 | + public static function origin() |
|
| 533 | + { |
|
| 534 | + $server = &self::$globalStateProvider->getServerSuperGlobal(); |
|
| 535 | + |
|
| 536 | + if (isset($server['HTTP_ORIGIN'])) { |
|
| 537 | + return $server['HTTP_ORIGIN']; |
|
| 538 | + } |
|
| 539 | + |
|
| 540 | + return null; |
|
| 541 | + } |
|
| 542 | 542 | } |
| 543 | 543 | \ No newline at end of file |
@@ -12,21 +12,21 @@ |
||
| 12 | 12 | |
| 13 | 13 | interface IRoutedTask extends ITask |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * Sets the route the request will take. Only should be called from the request router. |
|
| 17 | - * |
|
| 18 | - * @param $routeName string |
|
| 19 | - * |
|
| 20 | - * @return void |
|
| 21 | - * |
|
| 22 | - * @throws Exception |
|
| 23 | - * @category Security-Critical |
|
| 24 | - */ |
|
| 25 | - public function setRoute($routeName); |
|
| 15 | + /** |
|
| 16 | + * Sets the route the request will take. Only should be called from the request router. |
|
| 17 | + * |
|
| 18 | + * @param $routeName string |
|
| 19 | + * |
|
| 20 | + * @return void |
|
| 21 | + * |
|
| 22 | + * @throws Exception |
|
| 23 | + * @category Security-Critical |
|
| 24 | + */ |
|
| 25 | + public function setRoute($routeName); |
|
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * Gets the name of the route that has been passed from the request router. |
|
| 29 | - * @return string |
|
| 30 | - */ |
|
| 31 | - public function getRouteName(); |
|
| 27 | + /** |
|
| 28 | + * Gets the name of the route that has been passed from the request router. |
|
| 29 | + * @return string |
|
| 30 | + */ |
|
| 31 | + public function getRouteName(); |
|
| 32 | 32 | } |
| 33 | 33 | \ No newline at end of file |
@@ -16,97 +16,97 @@ |
||
| 16 | 16 | |
| 17 | 17 | abstract class ApiPageBase extends TaskBase implements IRoutedTask, IApiAction |
| 18 | 18 | { |
| 19 | - /** |
|
| 20 | - * API result document |
|
| 21 | - * @var DOMDocument |
|
| 22 | - */ |
|
| 23 | - protected $document; |
|
| 24 | - |
|
| 25 | - public function __construct() |
|
| 26 | - { |
|
| 27 | - $this->document = new DOMDocument('1.0'); |
|
| 28 | - } |
|
| 29 | - |
|
| 30 | - final public function execute() |
|
| 31 | - { |
|
| 32 | - $this->main(); |
|
| 33 | - } |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * @param string $routeName |
|
| 37 | - */ |
|
| 38 | - public function setRoute($routeName) |
|
| 39 | - { |
|
| 40 | - // no-op |
|
| 41 | - } |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * @return string |
|
| 45 | - */ |
|
| 46 | - public function getRouteName() |
|
| 47 | - { |
|
| 48 | - return 'main'; |
|
| 49 | - } |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * Main function for this page, when no specific actions are called. |
|
| 53 | - * |
|
| 54 | - * @throws ApiException |
|
| 55 | - * @return void |
|
| 56 | - */ |
|
| 57 | - final protected function main() |
|
| 58 | - { |
|
| 59 | - if (headers_sent()) { |
|
| 60 | - throw new ApiException('Headers have already been sent - this indicates a bug in the application!'); |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - header("Content-Type: text/xml"); |
|
| 64 | - |
|
| 65 | - // javascript access control |
|
| 66 | - $httpOrigin = WebRequest::origin(); |
|
| 67 | - |
|
| 68 | - if ($httpOrigin !== null) { |
|
| 69 | - $CORSallowed = $this->getSiteConfiguration()->getCrossOriginResourceSharingHosts(); |
|
| 70 | - |
|
| 71 | - if (in_array($httpOrigin, $CORSallowed)) { |
|
| 72 | - header("Access-Control-Allow-Origin: " . $httpOrigin); |
|
| 73 | - } |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - $responseData = $this->runApiPage(); |
|
| 77 | - |
|
| 78 | - ob_end_clean(); |
|
| 79 | - print($responseData); |
|
| 80 | - ob_start(); |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * Method that runs API action |
|
| 85 | - * |
|
| 86 | - * @param DOMElement $apiDocument |
|
| 87 | - * |
|
| 88 | - * @return DOMElement |
|
| 89 | - */ |
|
| 90 | - abstract public function executeApiAction(DOMElement $apiDocument); |
|
| 91 | - |
|
| 92 | - /** |
|
| 93 | - * @return string |
|
| 94 | - */ |
|
| 95 | - final public function runApiPage() |
|
| 96 | - { |
|
| 97 | - $apiDocument = $this->document->createElement("api"); |
|
| 98 | - |
|
| 99 | - try { |
|
| 100 | - $apiDocument = $this->executeApiAction($apiDocument); |
|
| 101 | - } |
|
| 102 | - catch (ApiException $ex) { |
|
| 103 | - $exception = $this->document->createElement("error"); |
|
| 104 | - $exception->setAttribute("message", $ex->getMessage()); |
|
| 105 | - $apiDocument->appendChild($exception); |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - $this->document->appendChild($apiDocument); |
|
| 109 | - |
|
| 110 | - return $this->document->saveXML(); |
|
| 111 | - } |
|
| 19 | + /** |
|
| 20 | + * API result document |
|
| 21 | + * @var DOMDocument |
|
| 22 | + */ |
|
| 23 | + protected $document; |
|
| 24 | + |
|
| 25 | + public function __construct() |
|
| 26 | + { |
|
| 27 | + $this->document = new DOMDocument('1.0'); |
|
| 28 | + } |
|
| 29 | + |
|
| 30 | + final public function execute() |
|
| 31 | + { |
|
| 32 | + $this->main(); |
|
| 33 | + } |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * @param string $routeName |
|
| 37 | + */ |
|
| 38 | + public function setRoute($routeName) |
|
| 39 | + { |
|
| 40 | + // no-op |
|
| 41 | + } |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * @return string |
|
| 45 | + */ |
|
| 46 | + public function getRouteName() |
|
| 47 | + { |
|
| 48 | + return 'main'; |
|
| 49 | + } |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * Main function for this page, when no specific actions are called. |
|
| 53 | + * |
|
| 54 | + * @throws ApiException |
|
| 55 | + * @return void |
|
| 56 | + */ |
|
| 57 | + final protected function main() |
|
| 58 | + { |
|
| 59 | + if (headers_sent()) { |
|
| 60 | + throw new ApiException('Headers have already been sent - this indicates a bug in the application!'); |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + header("Content-Type: text/xml"); |
|
| 64 | + |
|
| 65 | + // javascript access control |
|
| 66 | + $httpOrigin = WebRequest::origin(); |
|
| 67 | + |
|
| 68 | + if ($httpOrigin !== null) { |
|
| 69 | + $CORSallowed = $this->getSiteConfiguration()->getCrossOriginResourceSharingHosts(); |
|
| 70 | + |
|
| 71 | + if (in_array($httpOrigin, $CORSallowed)) { |
|
| 72 | + header("Access-Control-Allow-Origin: " . $httpOrigin); |
|
| 73 | + } |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + $responseData = $this->runApiPage(); |
|
| 77 | + |
|
| 78 | + ob_end_clean(); |
|
| 79 | + print($responseData); |
|
| 80 | + ob_start(); |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * Method that runs API action |
|
| 85 | + * |
|
| 86 | + * @param DOMElement $apiDocument |
|
| 87 | + * |
|
| 88 | + * @return DOMElement |
|
| 89 | + */ |
|
| 90 | + abstract public function executeApiAction(DOMElement $apiDocument); |
|
| 91 | + |
|
| 92 | + /** |
|
| 93 | + * @return string |
|
| 94 | + */ |
|
| 95 | + final public function runApiPage() |
|
| 96 | + { |
|
| 97 | + $apiDocument = $this->document->createElement("api"); |
|
| 98 | + |
|
| 99 | + try { |
|
| 100 | + $apiDocument = $this->executeApiAction($apiDocument); |
|
| 101 | + } |
|
| 102 | + catch (ApiException $ex) { |
|
| 103 | + $exception = $this->document->createElement("error"); |
|
| 104 | + $exception->setAttribute("message", $ex->getMessage()); |
|
| 105 | + $apiDocument->appendChild($exception); |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + $this->document->appendChild($apiDocument); |
|
| 109 | + |
|
| 110 | + return $this->document->saveXML(); |
|
| 111 | + } |
|
| 112 | 112 | } |
| 113 | 113 | \ No newline at end of file |
@@ -69,7 +69,7 @@ |
||
| 69 | 69 | $CORSallowed = $this->getSiteConfiguration()->getCrossOriginResourceSharingHosts(); |
| 70 | 70 | |
| 71 | 71 | if (in_array($httpOrigin, $CORSallowed)) { |
| 72 | - header("Access-Control-Allow-Origin: " . $httpOrigin); |
|
| 72 | + header("Access-Control-Allow-Origin: ".$httpOrigin); |
|
| 73 | 73 | } |
| 74 | 74 | } |
| 75 | 75 | |
@@ -10,21 +10,21 @@ |
||
| 10 | 10 | |
| 11 | 11 | abstract class PublicInterfacePageBase extends PageBase |
| 12 | 12 | { |
| 13 | - /** |
|
| 14 | - * PublicInterfaceInternalPageBase constructor. |
|
| 15 | - */ |
|
| 16 | - public function __construct() |
|
| 17 | - { |
|
| 18 | - $this->template = 'publicbase.tpl'; |
|
| 19 | - } |
|
| 13 | + /** |
|
| 14 | + * PublicInterfaceInternalPageBase constructor. |
|
| 15 | + */ |
|
| 16 | + public function __construct() |
|
| 17 | + { |
|
| 18 | + $this->template = 'publicbase.tpl'; |
|
| 19 | + } |
|
| 20 | 20 | |
| 21 | - final public function execute() |
|
| 22 | - { |
|
| 23 | - parent::execute(); |
|
| 24 | - } |
|
| 21 | + final public function execute() |
|
| 22 | + { |
|
| 23 | + parent::execute(); |
|
| 24 | + } |
|
| 25 | 25 | |
| 26 | - final public function finalisePage() |
|
| 27 | - { |
|
| 28 | - parent::finalisePage(); |
|
| 29 | - } |
|
| 26 | + final public function finalisePage() |
|
| 27 | + { |
|
| 28 | + parent::finalisePage(); |
|
| 29 | + } |
|
| 30 | 30 | } |
| 31 | 31 | \ No newline at end of file |
@@ -23,124 +23,124 @@ |
||
| 23 | 23 | */ |
| 24 | 24 | abstract class DataObject |
| 25 | 25 | { |
| 26 | - /** @var int ID of the object */ |
|
| 27 | - protected $id = null; |
|
| 28 | - /** @var int update version for optimistic locking */ |
|
| 29 | - protected $updateversion = 0; |
|
| 30 | - /** |
|
| 31 | - * @var PdoDatabase |
|
| 32 | - */ |
|
| 33 | - protected $dbObject; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * Retrieves a data object by it's row ID. |
|
| 37 | - * |
|
| 38 | - * @param int $id |
|
| 39 | - * @param PdoDatabase $database |
|
| 40 | - * |
|
| 41 | - * @return DataObject|false |
|
| 42 | - */ |
|
| 43 | - public static function getById($id, PdoDatabase $database) |
|
| 44 | - { |
|
| 45 | - $array = explode('\\', get_called_class()); |
|
| 46 | - $realClassName = strtolower(end($array)); |
|
| 47 | - |
|
| 48 | - $statement = $database->prepare("SELECT * FROM {$realClassName} WHERE id = :id LIMIT 1;"); |
|
| 49 | - $statement->bindValue(":id", $id); |
|
| 50 | - |
|
| 51 | - $statement->execute(); |
|
| 52 | - |
|
| 53 | - $resultObject = $statement->fetchObject(get_called_class()); |
|
| 54 | - |
|
| 55 | - if ($resultObject != false) { |
|
| 56 | - $resultObject->setDatabase($database); |
|
| 57 | - } |
|
| 58 | - |
|
| 59 | - return $resultObject; |
|
| 60 | - } |
|
| 61 | - |
|
| 62 | - public function setDatabase(PdoDatabase $db) |
|
| 63 | - { |
|
| 64 | - $this->dbObject = $db; |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - /** |
|
| 68 | - * Gets the database associated with this data object. |
|
| 69 | - * @return PdoDatabase |
|
| 70 | - */ |
|
| 71 | - public function getDatabase() |
|
| 72 | - { |
|
| 73 | - return $this->dbObject; |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * Saves a data object to the database, either updating or inserting a record. |
|
| 78 | - * |
|
| 79 | - * @return void |
|
| 80 | - */ |
|
| 81 | - abstract public function save(); |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * Retrieves the ID attribute |
|
| 85 | - */ |
|
| 86 | - public function getId() |
|
| 87 | - { |
|
| 88 | - return (int)$this->id; |
|
| 89 | - } |
|
| 90 | - |
|
| 91 | - /** |
|
| 92 | - * Deletes the object from the database |
|
| 93 | - */ |
|
| 94 | - public function delete() |
|
| 95 | - { |
|
| 96 | - if ($this->id === null) { |
|
| 97 | - // wtf? |
|
| 98 | - return; |
|
| 99 | - } |
|
| 100 | - |
|
| 101 | - $array = explode('\\', get_called_class()); |
|
| 102 | - $realClassName = strtolower(end($array)); |
|
| 103 | - |
|
| 104 | - $deleteQuery = "DELETE FROM {$realClassName} WHERE id = :id AND updateversion = :updateversion LIMIT 1;"; |
|
| 105 | - $statement = $this->dbObject->prepare($deleteQuery); |
|
| 106 | - |
|
| 107 | - $statement->bindValue(":id", $this->id); |
|
| 108 | - $statement->bindValue(":updateversion", $this->updateversion); |
|
| 109 | - $statement->execute(); |
|
| 110 | - |
|
| 111 | - if ($statement->rowCount() !== 1) { |
|
| 112 | - throw new OptimisticLockFailedException(); |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - $this->id = null; |
|
| 116 | - } |
|
| 117 | - |
|
| 118 | - /** |
|
| 119 | - * @return int |
|
| 120 | - */ |
|
| 121 | - public function getUpdateVersion() |
|
| 122 | - { |
|
| 123 | - return $this->updateversion; |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * Sets the update version. |
|
| 128 | - * |
|
| 129 | - * You should never call this to change the value of the update version. You should only call it when passing user |
|
| 130 | - * input through. |
|
| 131 | - * |
|
| 132 | - * @param int $updateVersion |
|
| 133 | - */ |
|
| 134 | - public function setUpdateVersion($updateVersion) |
|
| 135 | - { |
|
| 136 | - $this->updateversion = $updateVersion; |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - /** |
|
| 140 | - * @return bool |
|
| 141 | - */ |
|
| 142 | - public function isNew() |
|
| 143 | - { |
|
| 144 | - return $this->id === null; |
|
| 145 | - } |
|
| 26 | + /** @var int ID of the object */ |
|
| 27 | + protected $id = null; |
|
| 28 | + /** @var int update version for optimistic locking */ |
|
| 29 | + protected $updateversion = 0; |
|
| 30 | + /** |
|
| 31 | + * @var PdoDatabase |
|
| 32 | + */ |
|
| 33 | + protected $dbObject; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * Retrieves a data object by it's row ID. |
|
| 37 | + * |
|
| 38 | + * @param int $id |
|
| 39 | + * @param PdoDatabase $database |
|
| 40 | + * |
|
| 41 | + * @return DataObject|false |
|
| 42 | + */ |
|
| 43 | + public static function getById($id, PdoDatabase $database) |
|
| 44 | + { |
|
| 45 | + $array = explode('\\', get_called_class()); |
|
| 46 | + $realClassName = strtolower(end($array)); |
|
| 47 | + |
|
| 48 | + $statement = $database->prepare("SELECT * FROM {$realClassName} WHERE id = :id LIMIT 1;"); |
|
| 49 | + $statement->bindValue(":id", $id); |
|
| 50 | + |
|
| 51 | + $statement->execute(); |
|
| 52 | + |
|
| 53 | + $resultObject = $statement->fetchObject(get_called_class()); |
|
| 54 | + |
|
| 55 | + if ($resultObject != false) { |
|
| 56 | + $resultObject->setDatabase($database); |
|
| 57 | + } |
|
| 58 | + |
|
| 59 | + return $resultObject; |
|
| 60 | + } |
|
| 61 | + |
|
| 62 | + public function setDatabase(PdoDatabase $db) |
|
| 63 | + { |
|
| 64 | + $this->dbObject = $db; |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + /** |
|
| 68 | + * Gets the database associated with this data object. |
|
| 69 | + * @return PdoDatabase |
|
| 70 | + */ |
|
| 71 | + public function getDatabase() |
|
| 72 | + { |
|
| 73 | + return $this->dbObject; |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * Saves a data object to the database, either updating or inserting a record. |
|
| 78 | + * |
|
| 79 | + * @return void |
|
| 80 | + */ |
|
| 81 | + abstract public function save(); |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * Retrieves the ID attribute |
|
| 85 | + */ |
|
| 86 | + public function getId() |
|
| 87 | + { |
|
| 88 | + return (int)$this->id; |
|
| 89 | + } |
|
| 90 | + |
|
| 91 | + /** |
|
| 92 | + * Deletes the object from the database |
|
| 93 | + */ |
|
| 94 | + public function delete() |
|
| 95 | + { |
|
| 96 | + if ($this->id === null) { |
|
| 97 | + // wtf? |
|
| 98 | + return; |
|
| 99 | + } |
|
| 100 | + |
|
| 101 | + $array = explode('\\', get_called_class()); |
|
| 102 | + $realClassName = strtolower(end($array)); |
|
| 103 | + |
|
| 104 | + $deleteQuery = "DELETE FROM {$realClassName} WHERE id = :id AND updateversion = :updateversion LIMIT 1;"; |
|
| 105 | + $statement = $this->dbObject->prepare($deleteQuery); |
|
| 106 | + |
|
| 107 | + $statement->bindValue(":id", $this->id); |
|
| 108 | + $statement->bindValue(":updateversion", $this->updateversion); |
|
| 109 | + $statement->execute(); |
|
| 110 | + |
|
| 111 | + if ($statement->rowCount() !== 1) { |
|
| 112 | + throw new OptimisticLockFailedException(); |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + $this->id = null; |
|
| 116 | + } |
|
| 117 | + |
|
| 118 | + /** |
|
| 119 | + * @return int |
|
| 120 | + */ |
|
| 121 | + public function getUpdateVersion() |
|
| 122 | + { |
|
| 123 | + return $this->updateversion; |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * Sets the update version. |
|
| 128 | + * |
|
| 129 | + * You should never call this to change the value of the update version. You should only call it when passing user |
|
| 130 | + * input through. |
|
| 131 | + * |
|
| 132 | + * @param int $updateVersion |
|
| 133 | + */ |
|
| 134 | + public function setUpdateVersion($updateVersion) |
|
| 135 | + { |
|
| 136 | + $this->updateversion = $updateVersion; |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + /** |
|
| 140 | + * @return bool |
|
| 141 | + */ |
|
| 142 | + public function isNew() |
|
| 143 | + { |
|
| 144 | + return $this->id === null; |
|
| 145 | + } |
|
| 146 | 146 | } |
@@ -15,55 +15,55 @@ |
||
| 15 | 15 | */ |
| 16 | 16 | class Offline |
| 17 | 17 | { |
| 18 | - /** |
|
| 19 | - * Determines if the tool is offline |
|
| 20 | - * @return bool |
|
| 21 | - */ |
|
| 22 | - public static function isOffline() |
|
| 23 | - { |
|
| 24 | - global $dontUseDb; |
|
| 18 | + /** |
|
| 19 | + * Determines if the tool is offline |
|
| 20 | + * @return bool |
|
| 21 | + */ |
|
| 22 | + public static function isOffline() |
|
| 23 | + { |
|
| 24 | + global $dontUseDb; |
|
| 25 | 25 | |
| 26 | - return (bool)$dontUseDb; |
|
| 27 | - } |
|
| 26 | + return (bool)$dontUseDb; |
|
| 27 | + } |
|
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * Gets the offline message |
|
| 31 | - * |
|
| 32 | - * @param bool $external |
|
| 33 | - * @param null $message |
|
| 34 | - * |
|
| 35 | - * @return string |
|
| 36 | - */ |
|
| 37 | - public static function getOfflineMessage($external, $message = null) |
|
| 38 | - { |
|
| 39 | - global $dontUseDbCulprit, $dontUseDbReason, $baseurl; |
|
| 29 | + /** |
|
| 30 | + * Gets the offline message |
|
| 31 | + * |
|
| 32 | + * @param bool $external |
|
| 33 | + * @param null $message |
|
| 34 | + * |
|
| 35 | + * @return string |
|
| 36 | + */ |
|
| 37 | + public static function getOfflineMessage($external, $message = null) |
|
| 38 | + { |
|
| 39 | + global $dontUseDbCulprit, $dontUseDbReason, $baseurl; |
|
| 40 | 40 | |
| 41 | - $smarty = new Smarty(); |
|
| 42 | - $smarty->assign("baseurl", $baseurl); |
|
| 43 | - $smarty->assign("toolversion", Environment::getToolVersion()); |
|
| 41 | + $smarty = new Smarty(); |
|
| 42 | + $smarty->assign("baseurl", $baseurl); |
|
| 43 | + $smarty->assign("toolversion", Environment::getToolVersion()); |
|
| 44 | 44 | |
| 45 | - if (!headers_sent()) { |
|
| 46 | - header("HTTP/1.1 503 Service Unavailable"); |
|
| 47 | - } |
|
| 45 | + if (!headers_sent()) { |
|
| 46 | + header("HTTP/1.1 503 Service Unavailable"); |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | - if ($external) { |
|
| 50 | - return $smarty->fetch("offline/external.tpl"); |
|
| 51 | - } |
|
| 52 | - else { |
|
| 53 | - $hideCulprit = true; |
|
| 49 | + if ($external) { |
|
| 50 | + return $smarty->fetch("offline/external.tpl"); |
|
| 51 | + } |
|
| 52 | + else { |
|
| 53 | + $hideCulprit = true; |
|
| 54 | 54 | |
| 55 | - // Use the provided message if possible |
|
| 56 | - if ($message === null) { |
|
| 57 | - $hideCulprit = false; |
|
| 58 | - $message = $dontUseDbReason; |
|
| 59 | - } |
|
| 55 | + // Use the provided message if possible |
|
| 56 | + if ($message === null) { |
|
| 57 | + $hideCulprit = false; |
|
| 58 | + $message = $dontUseDbReason; |
|
| 59 | + } |
|
| 60 | 60 | |
| 61 | - $smarty->assign("hideCulprit", $hideCulprit); |
|
| 62 | - $smarty->assign("dontUseDbCulprit", $dontUseDbCulprit); |
|
| 63 | - $smarty->assign("dontUseDbReason", $message); |
|
| 64 | - $smarty->assign("alerts", array()); |
|
| 61 | + $smarty->assign("hideCulprit", $hideCulprit); |
|
| 62 | + $smarty->assign("dontUseDbCulprit", $dontUseDbCulprit); |
|
| 63 | + $smarty->assign("dontUseDbReason", $message); |
|
| 64 | + $smarty->assign("alerts", array()); |
|
| 65 | 65 | |
| 66 | - return $smarty->fetch("offline/internal.tpl"); |
|
| 67 | - } |
|
| 68 | - } |
|
| 66 | + return $smarty->fetch("offline/internal.tpl"); |
|
| 67 | + } |
|
| 68 | + } |
|
| 69 | 69 | } |
@@ -19,7 +19,7 @@ |
||
| 19 | 19 | */ |
| 20 | 20 | protected function main() |
| 21 | 21 | { |
| 22 | - $path = $this->getSiteConfiguration()->getFilePath() . '/team.json'; |
|
| 22 | + $path = $this->getSiteConfiguration()->getFilePath().'/team.json'; |
|
| 23 | 23 | $json = file_get_contents($path); |
| 24 | 24 | |
| 25 | 25 | $teamData = json_decode($json, true); |
@@ -12,31 +12,31 @@ |
||
| 12 | 12 | |
| 13 | 13 | class PageTeam extends InternalPageBase |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * Main function for this page, when no specific actions are called. |
|
| 17 | - * @return void |
|
| 18 | - */ |
|
| 19 | - protected function main() |
|
| 20 | - { |
|
| 21 | - $path = $this->getSiteConfiguration()->getFilePath() . '/team.json'; |
|
| 22 | - $json = file_get_contents($path); |
|
| 15 | + /** |
|
| 16 | + * Main function for this page, when no specific actions are called. |
|
| 17 | + * @return void |
|
| 18 | + */ |
|
| 19 | + protected function main() |
|
| 20 | + { |
|
| 21 | + $path = $this->getSiteConfiguration()->getFilePath() . '/team.json'; |
|
| 22 | + $json = file_get_contents($path); |
|
| 23 | 23 | |
| 24 | - $teamData = json_decode($json, true); |
|
| 24 | + $teamData = json_decode($json, true); |
|
| 25 | 25 | |
| 26 | - $active = array(); |
|
| 27 | - $inactive = array(); |
|
| 26 | + $active = array(); |
|
| 27 | + $inactive = array(); |
|
| 28 | 28 | |
| 29 | - foreach ($teamData as $name => $item) { |
|
| 30 | - if (count($item['Role']) == 0) { |
|
| 31 | - $inactive[$name] = $item; |
|
| 32 | - } |
|
| 33 | - else { |
|
| 34 | - $active[$name] = $item; |
|
| 35 | - } |
|
| 36 | - } |
|
| 29 | + foreach ($teamData as $name => $item) { |
|
| 30 | + if (count($item['Role']) == 0) { |
|
| 31 | + $inactive[$name] = $item; |
|
| 32 | + } |
|
| 33 | + else { |
|
| 34 | + $active[$name] = $item; |
|
| 35 | + } |
|
| 36 | + } |
|
| 37 | 37 | |
| 38 | - $this->assign('developer', $active); |
|
| 39 | - $this->assign('inactiveDeveloper', $inactive); |
|
| 40 | - $this->setTemplate('team/team.tpl'); |
|
| 41 | - } |
|
| 38 | + $this->assign('developer', $active); |
|
| 39 | + $this->assign('inactiveDeveloper', $inactive); |
|
| 40 | + $this->setTemplate('team/team.tpl'); |
|
| 41 | + } |
|
| 42 | 42 | } |
@@ -62,7 +62,7 @@ |
||
| 62 | 62 | } |
| 63 | 63 | |
| 64 | 64 | $safeUsername = htmlentities($user->getUsername(), ENT_COMPAT, 'UTF-8'); |
| 65 | - $this->setHtmlTitle($safeUsername . ' :: Users :: Statistics'); |
|
| 65 | + $this->setHtmlTitle($safeUsername.' :: Users :: Statistics'); |
|
| 66 | 66 | |
| 67 | 67 | $activitySummary = $database->prepare(<<<SQL |
| 68 | 68 | SELECT COALESCE(closes.mail_desc, log.action) AS action, COUNT(*) AS count |
@@ -22,13 +22,13 @@ discard block |
||
| 22 | 22 | |
| 23 | 23 | class StatsUsers extends InternalPageBase |
| 24 | 24 | { |
| 25 | - public function main() |
|
| 26 | - { |
|
| 27 | - $this->setHtmlTitle('Users :: Statistics'); |
|
| 25 | + public function main() |
|
| 26 | + { |
|
| 27 | + $this->setHtmlTitle('Users :: Statistics'); |
|
| 28 | 28 | |
| 29 | - $database = $this->getDatabase(); |
|
| 29 | + $database = $this->getDatabase(); |
|
| 30 | 30 | |
| 31 | - $query = <<<SQL |
|
| 31 | + $query = <<<SQL |
|
| 32 | 32 | SELECT |
| 33 | 33 | u.id |
| 34 | 34 | , u.username |
@@ -44,36 +44,36 @@ discard block |
||
| 44 | 44 | WHERE u.status = 'Active' |
| 45 | 45 | SQL; |
| 46 | 46 | |
| 47 | - $users = $database->query($query)->fetchAll(PDO::FETCH_ASSOC); |
|
| 48 | - $this->assign('users', $users); |
|
| 47 | + $users = $database->query($query)->fetchAll(PDO::FETCH_ASSOC); |
|
| 48 | + $this->assign('users', $users); |
|
| 49 | 49 | |
| 50 | - $this->assign('statsPageTitle', 'Account Creation Tool users'); |
|
| 51 | - $this->setTemplate("statistics/users.tpl"); |
|
| 52 | - } |
|
| 50 | + $this->assign('statsPageTitle', 'Account Creation Tool users'); |
|
| 51 | + $this->setTemplate("statistics/users.tpl"); |
|
| 52 | + } |
|
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Entry point for the detail action. |
|
| 56 | - * |
|
| 57 | - * @throws ApplicationLogicException |
|
| 58 | - */ |
|
| 59 | - protected function detail() |
|
| 60 | - { |
|
| 61 | - $userId = WebRequest::getInt('user'); |
|
| 62 | - if ($userId === null) { |
|
| 63 | - throw new ApplicationLogicException("User not found"); |
|
| 64 | - } |
|
| 54 | + /** |
|
| 55 | + * Entry point for the detail action. |
|
| 56 | + * |
|
| 57 | + * @throws ApplicationLogicException |
|
| 58 | + */ |
|
| 59 | + protected function detail() |
|
| 60 | + { |
|
| 61 | + $userId = WebRequest::getInt('user'); |
|
| 62 | + if ($userId === null) { |
|
| 63 | + throw new ApplicationLogicException("User not found"); |
|
| 64 | + } |
|
| 65 | 65 | |
| 66 | - $database = $this->getDatabase(); |
|
| 66 | + $database = $this->getDatabase(); |
|
| 67 | 67 | |
| 68 | - $user = User::getById($userId, $database); |
|
| 69 | - if ($user == false) { |
|
| 70 | - throw new ApplicationLogicException('User not found'); |
|
| 71 | - } |
|
| 68 | + $user = User::getById($userId, $database); |
|
| 69 | + if ($user == false) { |
|
| 70 | + throw new ApplicationLogicException('User not found'); |
|
| 71 | + } |
|
| 72 | 72 | |
| 73 | - $safeUsername = htmlentities($user->getUsername(), ENT_COMPAT, 'UTF-8'); |
|
| 74 | - $this->setHtmlTitle($safeUsername . ' :: Users :: Statistics'); |
|
| 73 | + $safeUsername = htmlentities($user->getUsername(), ENT_COMPAT, 'UTF-8'); |
|
| 74 | + $this->setHtmlTitle($safeUsername . ' :: Users :: Statistics'); |
|
| 75 | 75 | |
| 76 | - $activitySummary = $database->prepare(<<<SQL |
|
| 76 | + $activitySummary = $database->prepare(<<<SQL |
|
| 77 | 77 | SELECT COALESCE(closes.mail_desc, log.action) AS action, COUNT(*) AS count |
| 78 | 78 | FROM log |
| 79 | 79 | INNER JOIN user ON log.user = user.id |
@@ -81,14 +81,14 @@ discard block |
||
| 81 | 81 | WHERE user.username = :username |
| 82 | 82 | GROUP BY action; |
| 83 | 83 | SQL |
| 84 | - ); |
|
| 85 | - $activitySummary->execute(array(":username" => $user->getUsername())); |
|
| 86 | - $activitySummaryData = $activitySummary->fetchAll(PDO::FETCH_ASSOC); |
|
| 84 | + ); |
|
| 85 | + $activitySummary->execute(array(":username" => $user->getUsername())); |
|
| 86 | + $activitySummaryData = $activitySummary->fetchAll(PDO::FETCH_ASSOC); |
|
| 87 | 87 | |
| 88 | - $this->assign("user", $user); |
|
| 89 | - $this->assign("activity", $activitySummaryData); |
|
| 88 | + $this->assign("user", $user); |
|
| 89 | + $this->assign("activity", $activitySummaryData); |
|
| 90 | 90 | |
| 91 | - $usersCreatedQuery = $database->prepare(<<<SQL |
|
| 91 | + $usersCreatedQuery = $database->prepare(<<<SQL |
|
| 92 | 92 | SELECT log.timestamp time, request.name name, request.id id |
| 93 | 93 | FROM log |
| 94 | 94 | INNER JOIN request ON (request.id = log.objectid AND log.objecttype = 'Request') |
@@ -99,12 +99,12 @@ discard block |
||
| 99 | 99 | AND (emailtemplate.oncreated = '1' OR log.action = 'Closed custom-y') |
| 100 | 100 | ORDER BY log.timestamp; |
| 101 | 101 | SQL |
| 102 | - ); |
|
| 103 | - $usersCreatedQuery->execute(array(":username" => $user->getUsername())); |
|
| 104 | - $usersCreated = $usersCreatedQuery->fetchAll(PDO::FETCH_ASSOC); |
|
| 105 | - $this->assign("created", $usersCreated); |
|
| 102 | + ); |
|
| 103 | + $usersCreatedQuery->execute(array(":username" => $user->getUsername())); |
|
| 104 | + $usersCreated = $usersCreatedQuery->fetchAll(PDO::FETCH_ASSOC); |
|
| 105 | + $this->assign("created", $usersCreated); |
|
| 106 | 106 | |
| 107 | - $usersNotCreatedQuery = $database->prepare(<<<SQL |
|
| 107 | + $usersNotCreatedQuery = $database->prepare(<<<SQL |
|
| 108 | 108 | SELECT log.timestamp time, request.name name, request.id id |
| 109 | 109 | FROM log |
| 110 | 110 | JOIN request ON request.id = log.objectid AND log.objecttype = 'Request' |
@@ -115,45 +115,45 @@ discard block |
||
| 115 | 115 | AND (emailtemplate.oncreated = '0' OR log.action = 'Closed custom-n' OR log.action = 'Closed 0') |
| 116 | 116 | ORDER BY log.timestamp; |
| 117 | 117 | SQL |
| 118 | - ); |
|
| 119 | - $usersNotCreatedQuery->execute(array(":username" => $user->getUsername())); |
|
| 120 | - $usersNotCreated = $usersNotCreatedQuery->fetchAll(PDO::FETCH_ASSOC); |
|
| 121 | - $this->assign("notcreated", $usersNotCreated); |
|
| 122 | - |
|
| 123 | - /** @var Log[] $logs */ |
|
| 124 | - $logs = LogSearchHelper::get($database) |
|
| 125 | - ->byObjectType('User') |
|
| 126 | - ->byObjectId($user->getId()) |
|
| 127 | - ->getRecordCount($logCount) |
|
| 128 | - ->fetch(); |
|
| 129 | - |
|
| 130 | - if ($logCount === 0) { |
|
| 131 | - $this->assign('accountlog', array()); |
|
| 132 | - } |
|
| 133 | - else { |
|
| 134 | - list($users, $logData) = LogHelper::prepareLogsForTemplate($logs, $database, $this->getSiteConfiguration()); |
|
| 135 | - |
|
| 136 | - $this->assign("accountlog", $logData); |
|
| 137 | - $this->assign("users", $users); |
|
| 138 | - } |
|
| 139 | - |
|
| 140 | - $currentUser = User::getCurrent($database); |
|
| 141 | - $this->assign('canApprove', $this->barrierTest('approve', $currentUser, PageUserManagement::class)); |
|
| 142 | - $this->assign('canDecline', $this->barrierTest('decline', $currentUser, PageUserManagement::class)); |
|
| 143 | - $this->assign('canRename', $this->barrierTest('rename', $currentUser, PageUserManagement::class)); |
|
| 144 | - $this->assign('canEditUser', $this->barrierTest('editUser', $currentUser, PageUserManagement::class)); |
|
| 145 | - $this->assign('canSuspend', $this->barrierTest('suspend', $currentUser, PageUserManagement::class)); |
|
| 146 | - $this->assign('canEditRoles', $this->barrierTest('editRoles', $currentUser, PageUserManagement::class)); |
|
| 147 | - |
|
| 148 | - $oauth = new OAuthUserHelper($user, $database, $this->getOAuthProtocolHelper(), $this->getSiteConfiguration()); |
|
| 149 | - $this->assign('oauth', $oauth); |
|
| 150 | - |
|
| 151 | - if ($oauth->isFullyLinked()) { |
|
| 152 | - $this->assign('identity', $oauth->getIdentity(true)); |
|
| 153 | - $this->assign('identityExpired', $oauth->identityExpired()); |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - $this->assign('statsPageTitle', 'Account Creation Tool users'); |
|
| 157 | - $this->setTemplate("statistics/userdetail.tpl"); |
|
| 158 | - } |
|
| 118 | + ); |
|
| 119 | + $usersNotCreatedQuery->execute(array(":username" => $user->getUsername())); |
|
| 120 | + $usersNotCreated = $usersNotCreatedQuery->fetchAll(PDO::FETCH_ASSOC); |
|
| 121 | + $this->assign("notcreated", $usersNotCreated); |
|
| 122 | + |
|
| 123 | + /** @var Log[] $logs */ |
|
| 124 | + $logs = LogSearchHelper::get($database) |
|
| 125 | + ->byObjectType('User') |
|
| 126 | + ->byObjectId($user->getId()) |
|
| 127 | + ->getRecordCount($logCount) |
|
| 128 | + ->fetch(); |
|
| 129 | + |
|
| 130 | + if ($logCount === 0) { |
|
| 131 | + $this->assign('accountlog', array()); |
|
| 132 | + } |
|
| 133 | + else { |
|
| 134 | + list($users, $logData) = LogHelper::prepareLogsForTemplate($logs, $database, $this->getSiteConfiguration()); |
|
| 135 | + |
|
| 136 | + $this->assign("accountlog", $logData); |
|
| 137 | + $this->assign("users", $users); |
|
| 138 | + } |
|
| 139 | + |
|
| 140 | + $currentUser = User::getCurrent($database); |
|
| 141 | + $this->assign('canApprove', $this->barrierTest('approve', $currentUser, PageUserManagement::class)); |
|
| 142 | + $this->assign('canDecline', $this->barrierTest('decline', $currentUser, PageUserManagement::class)); |
|
| 143 | + $this->assign('canRename', $this->barrierTest('rename', $currentUser, PageUserManagement::class)); |
|
| 144 | + $this->assign('canEditUser', $this->barrierTest('editUser', $currentUser, PageUserManagement::class)); |
|
| 145 | + $this->assign('canSuspend', $this->barrierTest('suspend', $currentUser, PageUserManagement::class)); |
|
| 146 | + $this->assign('canEditRoles', $this->barrierTest('editRoles', $currentUser, PageUserManagement::class)); |
|
| 147 | + |
|
| 148 | + $oauth = new OAuthUserHelper($user, $database, $this->getOAuthProtocolHelper(), $this->getSiteConfiguration()); |
|
| 149 | + $this->assign('oauth', $oauth); |
|
| 150 | + |
|
| 151 | + if ($oauth->isFullyLinked()) { |
|
| 152 | + $this->assign('identity', $oauth->getIdentity(true)); |
|
| 153 | + $this->assign('identityExpired', $oauth->identityExpired()); |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + $this->assign('statsPageTitle', 'Account Creation Tool users'); |
|
| 157 | + $this->setTemplate("statistics/userdetail.tpl"); |
|
| 158 | + } |
|
| 159 | 159 | } |
@@ -12,12 +12,12 @@ |
||
| 12 | 12 | |
| 13 | 13 | class PageEmailConfirmationRequired extends PublicInterfacePageBase |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * Main function for this page, when no specific actions are called. |
|
| 17 | - * @return void |
|
| 18 | - */ |
|
| 19 | - protected function main() |
|
| 20 | - { |
|
| 21 | - $this->setTemplate('request/email-confirmation.tpl'); |
|
| 22 | - } |
|
| 15 | + /** |
|
| 16 | + * Main function for this page, when no specific actions are called. |
|
| 17 | + * @return void |
|
| 18 | + */ |
|
| 19 | + protected function main() |
|
| 20 | + { |
|
| 21 | + $this->setTemplate('request/email-confirmation.tpl'); |
|
| 22 | + } |
|
| 23 | 23 | } |
| 24 | 24 | \ No newline at end of file |