1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
<?php
namespace Alpha\Util\Http;
use Alpha\Exception\IllegalArguementException;
use Alpha\Util\Config\ConfigProvider;
/**
* A class to encapsulate a HTTP request.
*
* @since 2.0
*
* @author John Collins <dev@alphaframework.org>
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2018, John Collins (founder of Alpha Framework).
* All rights reserved.
*
* <pre>
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the
* following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
* * Neither the name of the Alpha Framework nor the names
* of its contributors may be used to endorse or promote
* products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* </pre>
*/
class Request
{
/**
* Array of supported HTTP methods.
*
* @var array
*
* @since 2.0
*/
private $HTTPMethods = array('HEAD', 'GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS', 'TRACE');
/**
* The HTTP method of this request (must be in HTTPMethods array).
*
* @var string
*
* @since 2.0
*/
private $method;
/**
* An associative array of HTTP headers on this request.
*
* @var array
*
* @since 2.0
*/
private $headers;
/**
* An associative array of HTTP cookies on this request.
*
* @var array
*
* @since 2.0
*/
private $cookies;
/**
* The HTTP params (form data and query string) on this request.
*
* @var array
*
* @since 2.0
*/
private $params;
/**
* An associative 3D array of uploaded files.
*
* @var array
*
* @since 2.0
*/
private $files;
/**
* The request body if one was provided.
*
* @var string
*
* @since 2.0
*/
private $body;
/**
* The host header provided on the request.
*
* @var string
*
* @since 2.0
*/
private $host;
/**
* The IP of the client making the request.
*
* @var string
*
* @since 2.0
*/
private $IP;
/**
* The URI requested.
*
* @var string
*
* @since 2.0
*/
private $URI;
/**
* The query string provided on the request (if any).
*
* @var string
*
* @since 2.0
*/
private $queryString;
/**
* Builds up the request based on available PHP super globals, in addition to
* any overrides provided (useful for testing).
*
* @param array $overrides Hash array of PHP super globals to override
*
* @throws \Alpha\Exception\IllegalArguementException
*
* @since 2.0
*/
public function __construct($overrides = array())
{
// set HTTP headers
if (isset($overrides['headers']) && is_array($overrides['headers'])) {
$this->headers = $overrides['headers'];
} else {
$this->headers = $this->getGlobalHeaders();
}
// set HTTP method
if (isset($overrides['method']) && in_array($overrides['method'], $this->HTTPMethods)) {
$this->method = $overrides['method'];
} else {
$method = $this->getGlobalServerValue('REQUEST_METHOD');
if (in_array($method, $this->HTTPMethods)) {
$this->method = $method;
}
}
// allow the POST param _METHOD to override the HTTP method
if (isset($_POST['_METHOD']) && in_array($_POST['_METHOD'], $this->HTTPMethods)) {
$this->method = $_POST['_METHOD'];
}
// allow the POST param X-HTTP-Method-Override to override the HTTP method
if (isset($this->headers['X-HTTP-Method-Override']) && in_array($this->headers['X-HTTP-Method-Override'], $this->HTTPMethods)) {
$this->method = $this->headers['X-HTTP-Method-Override'];
}
if ($this->method == '') {
throw new IllegalArguementException('No valid HTTP method provided when creating new Request object');
}
// set HTTP cookies
if (isset($overrides['cookies']) && is_array($overrides['cookies'])) {
$this->cookies = $overrides['cookies'];
} elseif (isset($_COOKIE)) {
$this->cookies = $_COOKIE;
} else {
$this->cookies = array();
}
// set HTTP params
if (isset($overrides['params']) && is_array($overrides['params'])) {
$this->params = $overrides['params'];
} else {
$this->params = array();
if (isset($_GET)) {
$this->params = array_merge($this->params, $_GET);
}
if (isset($_POST)) {
$this->params = array_merge($this->params, $_POST);
}
}
// set HTTP body
if (isset($overrides['body'])) {
$this->body = $overrides['body'];
} else {
$this->body = $this->getGlobalBody();
}
// set HTTP host
if (isset($overrides['host'])) {
$this->host = $overrides['host'];
} else {
$this->host = $this->getGlobalServerValue('HTTP_HOST');
}
// set IP of the client
if (isset($overrides['IP'])) {
$this->IP = $overrides['IP'];
} else {
$this->IP = $this->getGlobalServerValue('REMOTE_ADDR');
}
// set requested URI
if (isset($overrides['URI'])) {
$this->URI = $overrides['URI'];
} else {
$this->URI = $this->getGlobalServerValue('REQUEST_URI');
}
// set uploaded files (if any)
if (isset($overrides['files'])) {
$this->files = $overrides['files'];
} elseif (isset($_FILES)) {
$this->files = $_FILES;
}
}
/**
* Tries to get the requested param from the $_SERVER super global, otherwise returns an
* empty string.
*
* @param string $param
* @return string
*
* @since 3.0
*/
private function getGlobalServerValue($param)
{
$server = $_SERVER;
if (isset($server[$param])) {
return $server[$param];
} else {
return '';
}
}
/**
* Get the HTTP method of this request.
*
* @return string
*
* @since 2.0
*/
public function getMethod()
{
return $this->method;
}
/**
* Set the HTTP method of this request.
*
* @param string $method
*
* @throws \Alpha\Exception\IllegalArguementException
*
* @since 2.0
*/
public function setMethod($method)
{
if (in_array($method, $this->HTTPMethods)) {
$this->method = $method;
} else {
throw new IllegalArguementException('The method provided ['.$method.'] is not valid!');
}
}
/**
* Return all headers on this request.
*
* @return array
*
* @since 2.0
*/
public function getHeaders()
{
return $this->headers;
}
/**
* Get the header matching the key provided.
*
* @param string $key The key to search for
* @param mixed $default If key is not found, return this instead
*
* @return string
*
* @since 2.0
*/
public function getHeader($key, $default = null)
{
if (array_key_exists($key, $this->headers)) {
return $this->headers[$key];
} else {
return $default;
}
}
/**
* Tries to get the current HTTP request headers from super globals.
*
* @return array
*
* @since 2.0
*/
private function getGlobalHeaders()
{
if (!function_exists('getallheaders')) {
$headers = array();
foreach ($_SERVER as $name => $value) {
if (substr($name, 0, 5) == 'HTTP_') {
$headers[str_replace(' ', '-', ucwords(strtolower(str_replace('_', ' ', substr($name, 5)))))] = $value;
}
if ($name == 'CONTENT_TYPE') {
$headers['Content-Type'] = $value;
}
if ($name == 'CONTENT_LENGTH') {
$headers['Content-Length'] = $value;
}
}
return $headers;
} else {
return getallheaders();
}
}
/**
* Return all cookies on this request.
*
* @return array
*
* @since 2.0
*/
public function getCookies()
{
return $this->cookies;
}
/**
* Get the cookie matching the key provided.
*
* @param string $key The key to search for
* @param mixed $default If key is not found, return this instead
*
* @return mixed
*
* @since 2.0
*/
public function getCookie($key, $default = null)
{
if (array_key_exists($key, $this->cookies)) {
return $this->cookies[$key];
} else {
return $default;
}
}
/**
* Return all params on this request.
*
* @return array
*
* @since 2.0
*/
public function getParams()
{
return $this->params;
}
/**
* Get the param matching the key provided.
*
* @param string $key The key to search for
* @param mixed $default If key is not found, return this instead
*
* @return string
*
* @since 2.0
*/
public function getParam($key, $default = null)
{
if (array_key_exists($key, $this->params)) {
return $this->params[$key];
} else {
return $default;
}
}
/**
* Append the hash array provided to the params for this request.
*
* @param array A hash array of values to add to the request params
*
* @since 2.0
*/
public function addParams($params)
{
if (is_array($params)) {
$this->params = array_merge($this->params, $params);
}
}
/**
* Set the params array.
*
* @param array A hash array of values to set as the request params
*
* @since 2.0
*/
public function setParams($params)
{
if (is_array($params)) {
$this->params = $params;
}
}
/**
* Return all files on this request.
*
* @return array
*
* @since 2.0
*/
public function getFiles()
{
return $this->files;
}
/**
* Get the file matching the key provided.
*
* @param string $key The key to search for
* @param mixed $default If key is not found, return this instead
*
* @return mixed
*
* @since 2.0
*/
public function getFile($key, $default = null)
{
if (array_key_exists($key, $this->files)) {
return $this->files[$key];
} else {
return $default;
}
}
/**
* Get the request body if one was provided.
*
* @return string
*
* @since 2.0
*/
public function getBody()
{
return $this->body;
}
/**
* Attempts to get the raw body of the current request from super globals.
*
* @return string
*
* @since 2.0
*/
private function getGlobalBody()
{
if (isset($GLOBALS['HTTP_RAW_POST_DATA'])) {
return $GLOBALS['HTTP_RAW_POST_DATA'];
} else {
return file_get_contents('php://input');
}
}
/**
* Get the Accept header of the request.
*
* @return string
*
* @since 2.0
*/
public function getAccept()
{
return $this->getHeader('Accept');
}
/**
* Get the Content-Type header of the request.
*
* @return string
*
* @since 2.0
*/
public function getContentType()
{
return $this->getHeader('Content-Type');
}
/**
* Get the Content-Length header of the request.
*
* @return string
*
* @since 2.0
*/
public function getContentLength()
{
return $this->getHeader('Content-Length');
}
/**
* Get the host name of the client that sent the request.
*
* @return string
*
* @since 2.0
*/
public function getHost()
{
return $this->host;
}
/**
* Get the URI that was requested.
*
* @return string
*
* @since 2.0
*/
public function getURI()
{
return $this->URI;
}
/**
* Get the URL that was requested.
*
* @return string
*
* @since 2.0
*/
public function getURL()
{
$config = ConfigProvider::getInstance();
return $config->get('app.url').$this->getURI();
}
/**
* Get the IP address of the client that sent the request.
*
* @return string
*
* @since 2.0
*/
public function getIP()
{
return $this->IP;
}
/**
* Get the Referrer header of the request.
*
* @return string
*
* @since 2.0
*/
public function getReferrer()
{
return $this->getHeader('Referrer');
}
/**
* Get the User-Agent header of the request.
*
* @return string
*
* @since 2.0
*/
public function getUserAgent()
{
return $this->getHeader('User-Agent');
}
/**
* Get the query string provided on the request.
*
* @return string
*
* @since 2.0
*/
public function getQueryString()
{
return $this->queryString;
}
/**
* Parses the route provided to extract matching params of the route from this request's URI.
*
* @param string $route The route with parameter names, e.g. /user/{username}
* @param array $defaultParams Optional hash array of default request param values to use if they are missing from URI
*
* @since 2.0
*/
public function parseParamsFromRoute($route, $defaultParams = array())
{
// if the URI has a query-string, we will ignore it for now
if (mb_strpos($this->URI, '?') !== false) {
$URI = mb_substr($this->URI, 0, mb_strpos($this->URI, '?'));
// let's take this opportunity to pass query string params to $this->params
$queryString = mb_substr($this->URI, (mb_strpos($this->URI, '?')+1));
$this->queryString = $queryString;
parse_str($queryString, $this->params);
} else {
$URI = $this->URI;
}
$paramNames = explode('/', $route);
$paramValues = explode('/', $URI);
for ($i = 0; $i < count($paramNames); ++$i) {
$name = $paramNames[$i];
if (!isset($this->params[trim($name, '{}')])) {
if (isset($paramValues[$i]) && substr($name, 0, 1) == '{' && substr($name, strlen($name)-1, 1) == '}') {
$this->params[trim($name, '{}')] = $paramValues[$i];
}
if (!isset($paramValues[$i]) && isset($defaultParams[trim($name, '{}')])) {
$this->params[trim($name, '{}')] = $defaultParams[trim($name, '{}')];
}
}
}
}
/**
* Checks to see if the request contains a secure/encrypted token.
*
* @return bool
*
* @since 2.0
*/
public function isSecureURI()
{
if (isset($this->params['act']) && mb_strpos($this->URI, '/tk/') !== false) {
return true;
} else {
return false;
}
}
}