Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 1564 lines (1354 sloc) 35.293 kb
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 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563
<?php defined('SYSPATH') or die('No direct script access.');
/**
* Request and response wrapper. Uses the [Route] class to determine what
* [Controller] to send the request to.
*
* @package Kohana
* @category Base
* @author Kohana Team
* @copyright (c) 2008-2012 Kohana Team
* @license http://kohanaframework.org/license
*/
class Kohana_Request implements HTTP_Request {

/**
* @var string client user agent
*/
public static $user_agent = '';

/**
* @var string client IP address
*/
public static $client_ip = '0.0.0.0';

/**
* @var string trusted proxy server IPs
*/
public static $trusted_proxies = array('127.0.0.1', 'localhost', 'localhost.localdomain');

/**
* @var Request main request instance
*/
public static $initial;

/**
* @var Request currently executing request instance
*/
public static $current;

/**
* Creates a new request object for the given URI. New requests should be
* created using the [Request::instance] or [Request::factory] methods.
*
* $request = Request::factory($uri);
*
* If $cache parameter is set, the response for the request will attempt to
* be retrieved from the cache.
*
* @param string $uri URI of the request
* @param Cache $cache
* @param array $injected_routes an array of routes to use, for testing
* @return void|Request
* @throws Request_Exception
* @uses Route::all
* @uses Route::matches
*/
public static function factory($uri = TRUE, HTTP_Cache $cache = NULL, $injected_routes = array())
{
// If this is the initial request
if ( ! Request::$initial)
{
if (Kohana::$is_cli)
{
// Default protocol for command line is cli://
$protocol = 'cli';

// Get the command line options
$options = CLI::options('uri', 'method', 'get', 'post', 'referrer');

if (isset($options['uri']))
{
// Use the specified URI
$uri = $options['uri'];
}
elseif ($uri === TRUE)
{
$uri = '';
}

if (isset($options['method']))
{
// Use the specified method
$method = strtoupper($options['method']);
}
else
{
// Default to GET requests
$method = HTTP_Request::GET;
}

if (isset($options['get']))
{
// Overload the global GET data
parse_str($options['get'], $_GET);
}

if (isset($options['post']))
{
// Overload the global POST data
parse_str($options['post'], $_POST);
}

if (isset($options['referrer']))
{
$referrer = $options['referrer'];
}
}
else
{
if (isset($_SERVER['SERVER_PROTOCOL']))
{
$protocol = $_SERVER['SERVER_PROTOCOL'];
}
else
{
$protocol = HTTP::$protocol;
}

if (isset($_SERVER['REQUEST_METHOD']))
{
// Use the server request method
$method = $_SERVER['REQUEST_METHOD'];
}
else
{
// Default to GET requests
$method = HTTP_Request::GET;
}

if ( ! empty($_SERVER['HTTPS']) AND filter_var($_SERVER['HTTPS'], FILTER_VALIDATE_BOOLEAN))
{
// This request is secure
$secure = TRUE;
}

if (isset($_SERVER['HTTP_REFERER']))
{
// There is a referrer for this request
$referrer = $_SERVER['HTTP_REFERER'];
}

if (isset($_SERVER['HTTP_USER_AGENT']))
{
// Browser type
Request::$user_agent = $_SERVER['HTTP_USER_AGENT'];
}

if (isset($_SERVER['HTTP_X_REQUESTED_WITH']))
{
// Typically used to denote AJAX requests
$requested_with = $_SERVER['HTTP_X_REQUESTED_WITH'];
}

if (isset($_SERVER['HTTP_X_FORWARDED_FOR'])
AND isset($_SERVER['REMOTE_ADDR'])
AND in_array($_SERVER['REMOTE_ADDR'], Request::$trusted_proxies))
{
// Use the forwarded IP address, typically set when the
// client is using a proxy server.
// Format: "X-Forwarded-For: client1, proxy1, proxy2"
$client_ips = explode(',', $_SERVER['HTTP_X_FORWARDED_FOR']);

Request::$client_ip = array_shift($client_ips);

unset($client_ips);
}
elseif (isset($_SERVER['HTTP_CLIENT_IP'])
AND isset($_SERVER['REMOTE_ADDR'])
AND in_array($_SERVER['REMOTE_ADDR'], Request::$trusted_proxies))
{
// Use the forwarded IP address, typically set when the
// client is using a proxy server.
$client_ips = explode(',', $_SERVER['HTTP_CLIENT_IP']);

Request::$client_ip = array_shift($client_ips);

unset($client_ips);
}
elseif (isset($_SERVER['REMOTE_ADDR']))
{
// The remote IP address
Request::$client_ip = $_SERVER['REMOTE_ADDR'];
}

if ($method !== HTTP_Request::GET)
{
// Ensure the raw body is saved for future use
$body = file_get_contents('php://input');
}

if ($uri === TRUE)
{
// Attempt to guess the proper URI
$uri = Request::detect_uri();
}

$cookies = array();

if (($cookie_keys = array_keys($_COOKIE)))
{
foreach ($cookie_keys as $key)
{
$cookies[$key] = Cookie::get($key);
}
}
}

// Create the instance singleton
Request::$initial = $request = new Request($uri, $cache, $injected_routes);

// Store global GET and POST data in the initial request only
$request->protocol($protocol)
->query($_GET)
->post($_POST);

if (isset($secure))
{
// Set the request security
$request->secure($secure);
}

if (isset($method))
{
// Set the request method
$request->method($method);
}

if (isset($referrer))
{
// Set the referrer
$request->referrer($referrer);
}

if (isset($requested_with))
{
// Apply the requested with variable
$request->requested_with($requested_with);
}

if (isset($body))
{
// Set the request body (probably a PUT type)
$request->body($body);
}

if (isset($cookies))
{
$request->cookie($cookies);
}
}
else
{
$request = new Request($uri, $cache, $injected_routes);
}

return $request;
}

/**
* Automatically detects the URI of the main request using PATH_INFO,
* REQUEST_URI, PHP_SELF or REDIRECT_URL.
*
* $uri = Request::detect_uri();
*
* @return string URI of the main request
* @throws Kohana_Exception
* @since 3.0.8
*/
public static function detect_uri()
{
if ( ! empty($_SERVER['PATH_INFO']))
{
// PATH_INFO does not contain the docroot or index
$uri = $_SERVER['PATH_INFO'];
}
else
{
// REQUEST_URI and PHP_SELF include the docroot and index

if (isset($_SERVER['REQUEST_URI']))
{
/**
* We use REQUEST_URI as the fallback value. The reason
* for this is we might have a malformed URL such as:
*
* http://localhost/http://example.com/judge.php
*
* which parse_url can't handle. So rather than leave empty
* handed, we'll use this.
*/
$uri = $_SERVER['REQUEST_URI'];

if ($request_uri = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH))
{
// Valid URL path found, set it.
$uri = $request_uri;
}

// Decode the request URI
$uri = rawurldecode($uri);
}
elseif (isset($_SERVER['PHP_SELF']))
{
$uri = $_SERVER['PHP_SELF'];
}
elseif (isset($_SERVER['REDIRECT_URL']))
{
$uri = $_SERVER['REDIRECT_URL'];
}
else
{
// If you ever see this error, please report an issue at http://dev.kohanaphp.com/projects/kohana3/issues
// along with any relevant information about your web server setup. Thanks!
throw new Kohana_Exception('Unable to detect the URI using PATH_INFO, REQUEST_URI, PHP_SELF or REDIRECT_URL');
}

// Get the path from the base URL, including the index file
$base_url = parse_url(Kohana::$base_url, PHP_URL_PATH);

if (strpos($uri, $base_url) === 0)
{
// Remove the base URL from the URI
$uri = (string) substr($uri, strlen($base_url));
}

if (Kohana::$index_file AND strpos($uri, Kohana::$index_file) === 0)
{
// Remove the index file from the URI
$uri = (string) substr($uri, strlen(Kohana::$index_file));
}
}

return $uri;
}

/**
* Return the currently executing request. This is changed to the current
* request when [Request::execute] is called and restored when the request
* is completed.
*
* $request = Request::current();
*
* @return Request
* @since 3.0.5
*/
public static function current()
{
return Request::$current;
}

/**
* Returns the first request encountered by this framework. This will should
* only be set once during the first [Request::factory] invocation.
*
* // Get the first request
* $request = Request::initial();
*
* // Test whether the current request is the first request
* if (Request::initial() === Request::current())
* // Do something useful
*
* @return Request
* @since 3.1.0
*/
public static function initial()
{
return Request::$initial;
}

/**
* Returns information about the client user agent.
*
* // Returns "Chrome" when using Google Chrome
* $browser = Request::user_agent('browser');
*
* Multiple values can be returned at once by using an array:
*
* // Get the browser and platform with a single call
* $info = Request::user_agent(array('browser', 'platform'));
*
* When using an array for the value, an associative array will be returned.
*
* @param mixed $value String to return: browser, version, robot, mobile, platform; or array of values
* @return mixed requested information, FALSE if nothing is found
* @uses Kohana::$config
* @uses Request::$user_agent
*/
public static function user_agent($value)
{
if (is_array($value))
{
$agent = array();
foreach ($value as $v)
{
// Add each key to the set
$agent[$v] = Request::user_agent($v);
}

return $agent;
}

static $info;

if (isset($info[$value]))
{
// This value has already been found
return $info[$value];
}

if ($value === 'browser' OR $value == 'version')
{
// Load browsers
$browsers = Kohana::$config->load('user_agents')->browser;

foreach ($browsers as $search => $name)
{
if (stripos(Request::$user_agent, $search) !== FALSE)
{
// Set the browser name
$info['browser'] = $name;

if (preg_match('#'.preg_quote($search).'[^0-9.]*+([0-9.][0-9.a-z]*)#i', Request::$user_agent, $matches))
{
// Set the version number
$info['version'] = $matches[1];
}
else
{
// No version number found
$info['version'] = FALSE;
}

return $info[$value];
}
}
}
else
{
// Load the search group for this type
$group = Kohana::$config->load('user_agents')->$value;

foreach ($group as $search => $name)
{
if (stripos(Request::$user_agent, $search) !== FALSE)
{
// Set the value name
return $info[$value] = $name;
}
}
}

// The value requested could not be found
return $info[$value] = FALSE;
}

/**
* Returns the accepted content types. If a specific type is defined,
* the quality of that type will be returned.
*
* $types = Request::accept_type();
*
* @param string $type Content MIME type
* @return mixed An array of all types or a specific type as a string
* @uses Request::_parse_accept
*/
public static function accept_type($type = NULL)
{
static $accepts;

if ($accepts === NULL)
{
// Parse the HTTP_ACCEPT header
$accepts = Request::_parse_accept($_SERVER['HTTP_ACCEPT'], array('*/*' => 1.0));
}

if (isset($type))
{
// Return the quality setting for this type
return isset($accepts[$type]) ? $accepts[$type] : $accepts['*/*'];
}

return $accepts;
}

/**
* Returns the accepted languages. If a specific language is defined,
* the quality of that language will be returned. If the language is not
* accepted, FALSE will be returned.
*
* $langs = Request::accept_lang();
*
* @param string $lang Language code
* @return mixed An array of all types or a specific type as a string
* @uses Request::_parse_accept
*/
public static function accept_lang($lang = NULL)
{
static $accepts;

if ($accepts === NULL)
{
// Parse the HTTP_ACCEPT_LANGUAGE header
$accepts = Request::_parse_accept($_SERVER['HTTP_ACCEPT_LANGUAGE']);
}

if (isset($lang))
{
// Return the quality setting for this lang
return isset($accepts[$lang]) ? $accepts[$lang] : FALSE;
}

return $accepts;
}

/**
* Returns the accepted encodings. If a specific encoding is defined,
* the quality of that encoding will be returned. If the encoding is not
* accepted, FALSE will be returned.
*
* $encodings = Request::accept_encoding();
*
* @param string $type Encoding type
* @return mixed An array of all types or a specific type as a string
* @uses Request::_parse_accept
*/
public static function accept_encoding($type = NULL)
{
static $accepts;

if ($accepts === NULL)
{
// Parse the HTTP_ACCEPT_LANGUAGE header
$accepts = Request::_parse_accept($_SERVER['HTTP_ACCEPT_ENCODING']);
}

if (isset($type))
{
// Return the quality setting for this type
return isset($accepts[$type]) ? $accepts[$type] : FALSE;
}

return $accepts;
}

/**
* Determines if a file larger than the post_max_size has been uploaded. PHP
* does not handle this situation gracefully on its own, so this method
* helps to solve that problem.
*
* @return boolean
* @uses Num::bytes
* @uses Arr::get
*/
public static function post_max_size_exceeded()
{
// Make sure the request method is POST
if (Request::$initial->method() !== HTTP_Request::POST)
return FALSE;

// Get the post_max_size in bytes
$max_bytes = Num::bytes(ini_get('post_max_size'));

// Error occurred if method is POST, and content length is too long
return (Arr::get($_SERVER, 'CONTENT_LENGTH') > $max_bytes);
}

/**
* Process URI
*
* @param string $uri URI
* @param array $routes Route
* @return array
*/
public static function process_uri($uri, $routes = NULL)
{
// Load routes
$routes = (empty($routes)) ? Route::all() : $routes;
$params = NULL;

foreach ($routes as $name => $route)
{
// We found something suitable
if ($params = $route->matches($uri))
{
return array(
'params' => $params,
'route' => $route,
);
}
}

return NULL;
}

/**
* Parses an accept header and returns an array (type => quality) of the
* accepted types, ordered by quality.
*
* $accept = Request::_parse_accept($header, $defaults);
*
* @param string $header Header to parse
* @param array $accepts Default values
* @return array
*/
protected static function _parse_accept( & $header, array $accepts = NULL)
{
if ( ! empty($header))
{
// Get all of the types
$types = explode(',', $header);

foreach ($types as $type)
{
// Split the type into parts
$parts = explode(';', $type);

// Make the type only the MIME
$type = trim(array_shift($parts));

// Default quality is 1.0
$quality = 1.0;

foreach ($parts as $part)
{
// Prevent undefined $value notice below
if (strpos($part, '=') === FALSE)
continue;

// Separate the key and value
list ($key, $value) = explode('=', trim($part));

if ($key === 'q')
{
// There is a quality for this type
$quality = (float) trim($value);
}
}

// Add the accept type and quality
$accepts[$type] = $quality;
}
}

// Make sure that accepts is an array
$accepts = (array) $accepts;

// Order by quality
arsort($accepts);

return $accepts;
}

/**
* @var string the x-requested-with header which most likely
* will be xmlhttprequest
*/
protected $_requested_with;

/**
* @var string method: GET, POST, PUT, DELETE, HEAD, etc
*/
protected $_method = 'GET';

/**
* @var string protocol: HTTP/1.1, FTP, CLI, etc
*/
protected $_protocol;

/**
* @var boolean
*/
protected $_secure = FALSE;

/**
* @var string referring URL
*/
protected $_referrer;

/**
* @var Route route matched for this request
*/
protected $_route;

/**
* @var Route array of routes to manually look at instead of the global namespace
*/
protected $_routes;

/**
* @var Kohana_Response response
*/
protected $_response;

/**
* @var Kohana_HTTP_Header headers to sent as part of the request
*/
protected $_header;

/**
* @var string the body
*/
protected $_body;

/**
* @var string controller directory
*/
protected $_directory = '';

/**
* @var string controller to be executed
*/
protected $_controller;

/**
* @var string action to be executed in the controller
*/
protected $_action;

/**
* @var string the URI of the request
*/
protected $_uri;

/**
* @var boolean external request
*/
protected $_external = FALSE;

/**
* @var array parameters from the route
*/
protected $_params = array();

/**
* @var array query parameters
*/
protected $_get = array();

/**
* @var array post parameters
*/
protected $_post = array();

/**
* @var array cookies to send with the request
*/
protected $_cookies = array();

/**
* @var Kohana_Request_Client
*/
protected $_client;

/**
* Creates a new request object for the given URI. New requests should be
* created using the [Request::instance] or [Request::factory] methods.
*
* $request = new Request($uri);
*
* If $cache parameter is set, the response for the request will attempt to
* be retrieved from the cache.
*
* @param string $uri URI of the request
* @param HTTP_Cache $cache
* @param array $injected_routes an array of routes to use, for testing
* @return void
* @throws Request_Exception
* @uses Route::all
* @uses Route::matches
*/
public function __construct($uri, HTTP_Cache $cache = NULL, $injected_routes = array())
{
// Initialise the header
$this->_header = new HTTP_Header(array());

// Assign injected routes
$this->_routes = $injected_routes;

// Cleanse query parameters from URI (faster that parse_url())
$split_uri = explode('?', $uri);
$uri = array_shift($split_uri);

// Initial request has global $_GET already applied
if (Request::$initial !== NULL)
{
if ($split_uri)
{
parse_str($split_uri[0], $this->_get);
}
}

// Detect protocol (if present)
// Always default to an internal request if we don't have an initial.
// This prevents the default index.php from being able to proxy
// external pages.
if (Request::$initial === NULL OR strpos($uri, '://') === FALSE)
{
// Remove trailing slashes from the URI
$uri = trim($uri, '/');

$processed_uri = Request::process_uri($uri, $this->_routes);

// Return here rather than throw exception. This will allow
// use of Request object even with unmatched route
if ($processed_uri === NULL)
{
$this->_uri = $uri;
return;
}

// Store the URI
$this->_uri = $uri;

// Store the matching route
$this->_route = $processed_uri['route'];
$params = $processed_uri['params'];

// Is this route external?
$this->_external = $this->_route->is_external();

if (isset($params['directory']))
{
// Controllers are in a sub-directory
$this->_directory = $params['directory'];
}

// Store the controller
$this->_controller = $params['controller'];

if (isset($params['action']))
{
// Store the action
$this->_action = $params['action'];
}
else
{
// Use the default action
$this->_action = Route::$default_action;
}

// These are accessible as public vars and can be overloaded
unset($params['controller'], $params['action'], $params['directory']);

// Params cannot be changed once matched
$this->_params = $params;

// Apply the client
$this->_client = new Request_Client_Internal(array('cache' => $cache));
}
else
{
// Create a route
$this->_route = new Route($uri);

// Store the URI
$this->_uri = $uri;

// Set the security setting if required
if (strpos($uri, 'https://') === 0)
{
$this->secure(TRUE);
}

// Set external state
$this->_external = TRUE;

// Setup the client
$this->_client = Request_Client_External::factory(array('cache' => $cache));
}
}

/**
* Returns the response as the string representation of a request.
*
* echo $request;
*
* @return string
*/
public function __toString()
{
return $this->render();
}

/**
* Returns the URI for the current route.
*
* $request->uri();
*
* @param array $params Additional route parameters
* @return string
* @uses Route::uri
*/
public function uri()
{
return empty($this->_uri) ? '/' : $this->_uri;
}

/**
* Create a URL string from the current request. This is a shortcut for:
*
* echo URL::site($this->request->uri(), $protocol);
*
* @param array $params URI parameters
* @param mixed $protocol protocol string or Request object
* @return string
* @since 3.0.7
* @uses URL::site
*/
public function url($protocol = NULL)
{
// Create a URI with the current route and convert it to a URL
return URL::site($this->uri(), $protocol);
}

/**
* Retrieves a value from the route parameters.
*
* $id = $request->param('id');
*
* @param string $key Key of the value
* @param mixed $default Default value if the key is not set
* @return mixed
*/
public function param($key = NULL, $default = NULL)
{
if ($key === NULL)
{
// Return the full array
return $this->_params;
}

return isset($this->_params[$key]) ? $this->_params[$key] : $default;
}

/**
* Redirects as the request response. If the URL does not include a
* protocol, it will be converted into a complete URL.
*
* $request->redirect($url);
*
* [!!] No further processing can be done after this method is called!
*
* @param string $url Redirect location
* @param integer $code Status code: 301, 302, etc
* @return void
* @uses URL::site
* @uses Request::send_headers
*/
public function redirect($url = '', $code = 302)
{
$referrer = $this->uri();
$protocol = ($this->secure()) ? 'https' : TRUE;

if (strpos($referrer, '://') === FALSE)
{
$referrer = URL::site($referrer, $protocol, ! empty(Kohana::$index_file));
}

if (strpos($url, '://') === FALSE)
{
// Make the URI into a URL
$url = URL::site($url, TRUE, ! empty(Kohana::$index_file));
}

if (($response = $this->response()) === NULL)
{
$response = $this->create_response();
}

echo $response->status($code)
->headers('Location', $url)
->headers('Referer', $referrer)
->send_headers()
->body();

// Stop execution
exit;
}

/**
* Sets and gets the referrer from the request.
*
* @param string $referrer
* @return mixed
*/
public function referrer($referrer = NULL)
{
if ($referrer === NULL)
{
// Act as a getter
return $this->_referrer;
}

// Act as a setter
$this->_referrer = (string) $referrer;

return $this;
}

/**
* Sets and gets the route from the request.
*
* @param string $route
* @return mixed
*/
public function route(Route $route = NULL)
{
if ($route === NULL)
{
// Act as a getter
return $this->_route;
}

// Act as a setter
$this->_route = $route;

return $this;
}

/**
* Sets and gets the directory for the controller.
*
* @param string $directory Directory to execute the controller from
* @return mixed
*/
public function directory($directory = NULL)
{
if ($directory === NULL)
{
// Act as a getter
return $this->_directory;
}

// Act as a setter
$this->_directory = (string) $directory;

return $this;
}

/**
* Sets and gets the controller for the matched route.
*
* @param string $controller Controller to execute the action
* @return mixed
*/
public function controller($controller = NULL)
{
if ($controller === NULL)
{
// Act as a getter
return $this->_controller;
}

// Act as a setter
$this->_controller = (string) $controller;

return $this;
}

/**
* Sets and gets the action for the controller.
*
* @param string $action Action to execute the controller from
* @return mixed
*/
public function action($action = NULL)
{
if ($action === NULL)
{
// Act as a getter
return $this->_action;
}

// Act as a setter
$this->_action = (string) $action;

return $this;
}

/**
* Provides access to the [Request_Client].
*
* @return Request_Client
* @return self
*/
public function client(Request_Client $client = NULL)
{
if ($client === NULL)
return $this->_client;
else
{
$this->_client = $client;
return $this;
}
}

/**
* Gets and sets the requested with property, which should
* be relative to the x-requested-with pseudo header.
*
* @param string $requested_with Requested with value
* @return mixed
*/
public function requested_with($requested_with = NULL)
{
if ($requested_with === NULL)
{
// Act as a getter
return $this->_requested_with;
}

// Act as a setter
$this->_requested_with = strtolower($requested_with);

return $this;
}

/**
* Processes the request, executing the controller action that handles this
* request, determined by the [Route].
*
* 1. Before the controller action is called, the [Controller::before] method
* will be called.
* 2. Next the controller action will be called.
* 3. After the controller action is called, the [Controller::after] method
* will be called.
*
* By default, the output from the controller is captured and returned, and
* no headers are sent.
*
* $request->execute();
*
* @return Response
* @throws Request_Exception
* @throws HTTP_Exception_404
* @uses [Kohana::$profiling]
* @uses [Profiler]
*/
public function execute()
{
if ( ! $this->_route instanceof Route)
{
throw new HTTP_Exception_404('Unable to find a route to match the URI: :uri', array(
':uri' => $this->_uri,
));
}

if ( ! $this->_client instanceof Request_Client)
{
throw new Request_Exception('Unable to execute :uri without a Kohana_Request_Client', array(
':uri' => $this->_uri,
));
}

return $this->_client->execute($this);
}

/**
* Returns whether this request is the initial request Kohana received.
* Can be used to test for sub requests.
*
* if ( ! $request->is_initial())
* // This is a sub request
*
* @return boolean
*/
public function is_initial()
{
return ($this === Request::$initial);
}

/**
* Readonly access to the [Request::$_external] property.
*
* if ( ! $request->is_external())
* // This is an internal request
*
* @return boolean
*/
public function is_external()
{
return $this->_external;
}

/**
* Returns whether this is an ajax request (as used by JS frameworks)
*
* @return boolean
*/
public function is_ajax()
{
return ($this->requested_with() === 'xmlhttprequest');
}

/**
* Generates an [ETag](http://en.wikipedia.org/wiki/HTTP_ETag) from the
* request response.
*
* $etag = $request->generate_etag();
*
* [!!] If the request response is empty when this method is called, an
* exception will be thrown!
*
* @return string
* @throws Request_Exception
*/
public function generate_etag()
{
if ($this->_response === NULL)
{
throw new Request_Exception('No response yet associated with request - cannot auto generate resource ETag');
}

// Generate a unique hash for the response
return '"'.sha1($this->_response).'"';
}

/**
* Set or get the response for this request
*
* @param Response $response Response to apply to this request
* @return Response
* @return void
*/
public function response(Response $response = NULL)
{
if ($response === NULL)
{
// Act as a getter
return $this->_response;
}

// Act as a setter
$this->_response = $response;

return $this;
}

/**
* Creates a response based on the type of request, i.e. an
* Request_HTTP will produce a Response_HTTP, and the same applies
* to CLI.
*
* // Create a response to the request
* $response = $request->create_response();
*
* @param boolean $bind Bind to this request
* @return Response
* @since 3.1.0
*/
public function create_response($bind = TRUE)
{
$response = new Response(array('_protocol' => $this->protocol()));

if ($bind)
{
// Bind a new response to the request
$this->_response = $response;
}

return $response;
}

/**
* Gets or sets the HTTP method. Usually GET, POST, PUT or DELETE in
* traditional CRUD applications.
*
* @param string $method Method to use for this request
* @return mixed
*/
public function method($method = NULL)
{
if ($method === NULL)
{
// Act as a getter
return $this->_method;
}

// Act as a setter
$this->_method = strtoupper($method);

return $this;
}

/**
* Gets or sets the HTTP protocol. If there is no current protocol set,
* it will use the default set in HTTP::$protocol
*
* @param string $protocol Protocol to set to the request/response
* @return mixed
*/
public function protocol($protocol = NULL)
{
if ($protocol === NULL)
{
if ($this->_protocol)
return $this->_protocol;
else
return $this->_protocol = HTTP::$protocol;
}

// Act as a setter
$this->_protocol = strtoupper($protocol);
return $this;
}

/**
* Getter/Setter to the security settings for this request. This
* method should be treated as immutable.
*
* @param boolean $secure is this request secure?
* @return mixed
*/
public function secure($secure = NULL)
{
if ($secure === NULL)
return $this->_secure;

// Act as a setter
$this->_secure = (bool) $secure;
return $this;
}

/**
* Gets or sets HTTP headers to the request or response. All headers
* are included immediately after the HTTP protocol definition during
* transmission. This method provides a simple array or key/value
* interface to the headers.
*
* @param mixed $key Key or array of key/value pairs to set
* @param string $value Value to set to the supplied key
* @return mixed
*/
public function headers($key = NULL, $value = NULL)
{
if ($key instanceof HTTP_Header)
{
// Act a setter, replace all headers
$this->_header = $key;

return $this;
}

if (is_array($key))
{
// Act as a setter, replace all headers
$this->_header->exchangeArray($key);

return $this;
}

if ($this->_header->count() === 0 AND $this->is_initial())
{
// Lazy load the request headers
$this->_header = HTTP::request_headers();
}

if ($key === NULL)
{
// Act as a getter, return all headers
return $this->_header;
}
elseif ($value === NULL)
{
// Act as a getter, single header
return ($this->_header->offsetExists($key)) ? $this->_header->offsetGet($key) : NULL;
}

// Act as a setter for a single header
$this->_header[$key] = $value;

return $this;
}

/**
* Set and get cookies values for this request.
*
* @param mixed $key Cookie name, or array of cookie values
* @param string $value Value to set to cookie
* @return string
* @return mixed
*/
public function cookie($key = NULL, $value = NULL)
{
if (is_array($key))
{
// Act as a setter, replace all cookies
$this->_cookies = $key;
return $this;
}
elseif ($key === NULL)
{
// Act as a getter, all cookies
return $this->_cookies;
}
elseif ($value === NULL)
{
// Act as a getting, single cookie
return isset($this->_cookies[$key]) ? $this->_cookies[$key] : NULL;
}

// Act as a setter for a single cookie
$this->_cookies[$key] = (string) $value;

return $this;
}

/**
* Gets or sets the HTTP body to the request or response. The body is
* included after the header, separated by a single empty new line.
*
* @param string $content Content to set to the object
* @return mixed
*/
public function body($content = NULL)
{
if ($content === NULL)
{
// Act as a getter
return $this->_body;
}

// Act as a setter
$this->_body = $content;

return $this;
}

/**
* Returns the length of the body for use with
* content header
*
* @return integer
*/
public function content_length()
{
return strlen($this->body());
}

/**
* Renders the HTTP_Interaction to a string, producing
*
* - Protocol
* - Headers
* - Body
*
* If there are variables set to the `Kohana_Request::$_post`
* they will override any values set to body.
*
* @param boolean $response Return the rendered response, else returns the rendered request
* @return string
*/
public function render()
{
if ( ! $post = $this->post())
{
$body = $this->body();
}
else
{
$this->headers('content-type', 'application/x-www-form-urlencoded');
$body = http_build_query($post, NULL, '&');
}

// Set the content length
$this->headers('content-length', (string) $this->content_length());

// If Kohana expose, set the user-agent
if (Kohana::$expose)
{
$this->headers('user-agent', 'Kohana Framework '.Kohana::VERSION.' ('.Kohana::CODENAME.')');
}

// Prepare cookies
if ($this->_cookies)
{
$cookie_string = array();

// Parse each
foreach ($this->_cookies as $key => $value)
{
$cookie_string[] = $key.'='.$value;
}

// Create the cookie string
$this->_header['cookie'] = implode('; ', $cookie_string);
}

$output = $this->method().' '.$this->uri().' '.$this->protocol()."\r\n";
$output .= (string) $this->_header;
$output .= $body;

return $output;
}

/**
* Gets or sets HTTP query string.
*
* @param mixed $key Key or key value pairs to set
* @param string $value Value to set to a key
* @return mixed
*/
public function query($key = NULL, $value = NULL)
{
if (is_array($key))
{
// Act as a setter, replace all query strings
$this->_get = $key;

return $this;
}

if ($key === NULL)
{
// Act as a getter, all query strings
return $this->_get;
}
elseif ($value === NULL)
{
// Act as a getter, single query string
return Arr::get($this->_get, $key);
}

// Act as a setter, single query string
$this->_get[$key] = $value;

return $this;
}

/**
* Gets or sets HTTP POST parameters to the request.
*
* @param mixed $key Key or key value pairs to set
* @param string $value Value to set to a key
* @return mixed
*/
public function post($key = NULL, $value = NULL)
{
if (is_array($key))
{
// Act as a setter, replace all fields
$this->_post = $key;

return $this;
}

if ($key === NULL)
{
// Act as a getter, all fields
return $this->_post;
}
elseif ($value === NULL)
{
// Act as a getter, single field
return Arr::get($this->_post, $key);
}

// Act as a setter, single field
$this->_post[$key] = $value;

return $this;
}

} // End Request
Something went wrong with that request. Please try again.