Request.php 34.1 KB
Newer Older
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
8
namespace yii\web;
Qiang Xue committed
9

Qiang Xue committed
10 11
use Yii;
use yii\base\InvalidConfigException;
12
use yii\helpers\Security;
Qiang Xue committed
13

Qiang Xue committed
14
/**
15 16 17 18 19
 * The web Request class represents an HTTP request
 *
 * It encapsulates the $_SERVER variable and resolves its inconsistency among different Web servers.
 * Also it provides an interface to retrieve request parameters from $_POST, $_GET, $_COOKIES and REST
 * parameters sent via other HTTP methods like PUT or DELETE.
20
 *
21 22
 * @property string $absoluteUrl The currently requested absolute URL. This property is read-only.
 * @property string $acceptTypes User browser accept types, null if not present. This property is read-only.
23 24 25 26 27
 * @property array $acceptedContentTypes The content types ordered by the preference level. The first element
 * represents the most preferred content type.
 * @property array $acceptedLanguages The languages ordered by the preference level. The first element
 * represents the most preferred language.
 * @property string $baseUrl The relative URL for the application.
28 29 30 31
 * @property string $cookieValidationKey The secret key used for cookie validation. If it was not set
 * previously, a random key will be generated and used.
 * @property CookieCollection $cookies The cookie collection. This property is read-only.
 * @property string $csrfToken The random token for CSRF validation. This property is read-only.
Qiang Xue committed
32 33
 * @property string $csrfTokenFromHeader The CSRF token sent via [[CSRF_HEADER]] by browser. Null is returned
 * if no such header is sent. This property is read-only.
34 35 36 37 38 39
 * @property string $hostInfo Schema and hostname part (with port number if needed) of the request URL (e.g.
 * `http://www.yiiframework.com`).
 * @property boolean $isAjax Whether this is an AJAX (XMLHttpRequest) request. This property is read-only.
 * @property boolean $isDelete Whether this is a DELETE request. This property is read-only.
 * @property boolean $isFlash Whether this is an Adobe Flash or Adobe Flex request. This property is
 * read-only.
40 41 42
 * @property boolean $isGet Whether this is a GET request. This property is read-only.
 * @property boolean $isHead Whether this is a HEAD request. This property is read-only.
 * @property boolean $isOptions Whether this is a OPTIONS request. This property is read-only.
43 44 45 46 47 48 49 50 51
 * @property boolean $isPatch Whether this is a PATCH request. This property is read-only.
 * @property boolean $isPost Whether this is a POST request. This property is read-only.
 * @property boolean $isPut Whether this is a PUT request. This property is read-only.
 * @property boolean $isSecureConnection If the request is sent via secure channel (https). This property is
 * read-only.
 * @property string $method Request method, such as GET, POST, HEAD, PUT, PATCH, DELETE. The value returned is
 * turned into upper case. This property is read-only.
 * @property string $pathInfo Part of the request URL that is after the entry script and before the question
 * mark. Note, the returned path info is already URL-decoded.
52
 * @property integer $port Port number for insecure requests.
53 54 55 56 57 58
 * @property string $preferredLanguage The language that the application should use. Null is returned if both
 * [[getAcceptedLanguages()]] and `$languages` are empty. This property is read-only.
 * @property string $queryString Part of the request URL that is after the question mark. This property is
 * read-only.
 * @property string $rawBody The request body. This property is read-only.
 * @property string $referrer URL referrer, null if not present. This property is read-only.
59 60 61 62
 * @property array $restParams The RESTful request parameters.
 * @property string $scriptFile The entry script file path.
 * @property string $scriptUrl The relative URL of the entry script.
 * @property integer $securePort Port number for secure requests.
63 64
 * @property string $serverName Server name. This property is read-only.
 * @property integer $serverPort Server port number. This property is read-only.
65
 * @property string $url The currently requested relative URL. Note that the URI returned is URL-encoded.
66 67 68
 * @property string $userAgent User agent, null if not present. This property is read-only.
 * @property string $userHost User host name, null if cannot be determined. This property is read-only.
 * @property string $userIP User IP address. This property is read-only.
69
 *
Qiang Xue committed
70
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
71
 * @since 2.0
Qiang Xue committed
72
 */
Qiang Xue committed
73
class Request extends \yii\base\Request
Qiang Xue committed
74
{
75 76 77
	/**
	 * The name of the HTTP header for sending CSRF token.
	 */
Qiang Xue committed
78
	const CSRF_HEADER = 'X-CSRF-Token';
79

Qiang Xue committed
80

Qiang Xue committed
81
	/**
82
	 * @var boolean whether to enable CSRF (Cross-Site Request Forgery) validation. Defaults to true.
83
	 * When CSRF validation is enabled, forms submitted to an Yii Web application must be originated
Qiang Xue committed
84 85 86
	 * from the same application. If not, a 400 HTTP exception will be raised.
	 *
	 * Note, this feature requires that the user client accepts cookie. Also, to use this feature,
87
	 * forms submitted via POST method must contain a hidden input whose name is specified by [[csrfVar]].
Qiang Xue committed
88
	 * You may use [[\yii\web\Html::beginForm()]] to generate his hidden input.
89 90 91 92
	 *
	 * In JavaScript, you may get the values of [[csrfVar]] and [[csrfToken]] via `yii.getCsrfVar()` and
	 * `yii.getCsrfToken()`, respectively. The [[\yii\web\YiiAsset]] asset must be registered.
	 *
93
	 * @see Controller::enableCsrfValidation
Qiang Xue committed
94 95
	 * @see http://en.wikipedia.org/wiki/Cross-site_request_forgery
	 */
96
	public $enableCsrfValidation = true;
Qiang Xue committed
97
	/**
98
	 * @var string the name of the token used to prevent CSRF. Defaults to '_csrf'.
99
	 * This property is used only when [[enableCsrfValidation]] is true.
Qiang Xue committed
100
	 */
101
	public $csrfVar = '_csrf';
Qiang Xue committed
102 103 104 105
	/**
	 * @var array the configuration of the CSRF cookie. This property is used only when [[enableCsrfValidation]] is true.
	 * @see Cookie
	 */
Qiang Xue committed
106
	public $csrfCookie = array('httpOnly' => true);
Qiang Xue committed
107
	/**
Qiang Xue committed
108
	 * @var boolean whether cookies should be validated to ensure they are not tampered. Defaults to true.
Qiang Xue committed
109
	 */
Qiang Xue committed
110
	public $enableCookieValidation = true;
Qiang Xue committed
111
	/**
112
	 * @var string|boolean the name of the POST parameter that is used to indicate if a request is a PUT, PATCH or DELETE
113
	 * request tunneled through POST. Default to '_method'.
114
	 * @see getMethod
Qiang Xue committed
115 116 117
	 * @see getRestParams
	 */
	public $restVar = '_method';
Qiang Xue committed
118 119 120

	private $_cookies;

Qiang Xue committed
121

Qiang Xue committed
122 123 124 125 126 127 128 129 130 131
	/**
	 * Resolves the current request into a route and the associated parameters.
	 * @return array the first element is the route, and the second is the associated parameters.
	 * @throws HttpException if the request cannot be resolved.
	 */
	public function resolve()
	{
		$result = Yii::$app->getUrlManager()->parseRequest($this);
		if ($result !== false) {
			list ($route, $params) = $result;
132 133
			$_GET = array_merge($_GET, $params);
			return array($route, $_GET);
Qiang Xue committed
134
		} else {
135
			throw new HttpException(404, Yii::t('yii', 'Page not found.'));
Qiang Xue committed
136 137 138
		}
	}

Qiang Xue committed
139
	/**
140 141
	 * Returns the method of the current request (e.g. GET, POST, HEAD, PUT, PATCH, DELETE).
	 * @return string request method, such as GET, POST, HEAD, PUT, PATCH, DELETE.
Qiang Xue committed
142 143
	 * The value returned is turned into upper case.
	 */
144
	public function getMethod()
Qiang Xue committed
145
	{
146
		if (isset($_POST[$this->restVar])) {
Qiang Xue committed
147
			return strtoupper($_POST[$this->restVar]);
Qiang Xue committed
148 149 150 151 152
		} else {
			return isset($_SERVER['REQUEST_METHOD']) ? strtoupper($_SERVER['REQUEST_METHOD']) : 'GET';
		}
	}

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
	/**
	 * Returns whether this is a GET request.
	 * @return boolean whether this is a GET request.
	 */
	public function getIsGet()
	{
		return $this->getMethod() === 'GET';
	}

	/**
	 * Returns whether this is an OPTIONS request.
	 * @return boolean whether this is a OPTIONS request.
	 */
	public function getIsOptions()
	{
		return $this->getMethod() === 'OPTIONS';
	}
  
171 172 173 174 175 176 177 178 179
	/**
	 * Returns whether this is a HEAD request.
	 * @return boolean whether this is a HEAD request.
	 */
	public function getIsHead()
	{
		return $this->getMethod() === 'HEAD';
	}
  
Qiang Xue committed
180 181 182 183
	/**
	 * Returns whether this is a POST request.
	 * @return boolean whether this is a POST request.
	 */
Qiang Xue committed
184
	public function getIsPost()
Qiang Xue committed
185
	{
186
		return $this->getMethod() === 'POST';
Qiang Xue committed
187 188 189 190 191 192
	}

	/**
	 * Returns whether this is a DELETE request.
	 * @return boolean whether this is a DELETE request.
	 */
Qiang Xue committed
193
	public function getIsDelete()
Qiang Xue committed
194
	{
195
		return $this->getMethod() === 'DELETE';
Qiang Xue committed
196 197 198 199 200 201
	}

	/**
	 * Returns whether this is a PUT request.
	 * @return boolean whether this is a PUT request.
	 */
Qiang Xue committed
202
	public function getIsPut()
Qiang Xue committed
203
	{
204
		return $this->getMethod() === 'PUT';
Qiang Xue committed
205 206
	}

207 208 209 210 211 212 213 214 215
	/**
	 * Returns whether this is a PATCH request.
	 * @return boolean whether this is a PATCH request.
	 */
	public function getIsPatch()
	{
		return $this->getMethod() === 'PATCH';
	}

Qiang Xue committed
216 217 218 219
	/**
	 * Returns whether this is an AJAX (XMLHttpRequest) request.
	 * @return boolean whether this is an AJAX (XMLHttpRequest) request.
	 */
Qiang Xue committed
220
	public function getIsAjax()
Qiang Xue committed
221 222 223 224 225
	{
		return isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] === 'XMLHttpRequest';
	}

	/**
Qiang Xue committed
226
	 * Returns whether this is an Adobe Flash or Flex request.
Qiang Xue committed
227 228
	 * @return boolean whether this is an Adobe Flash or Adobe Flex request.
	 */
Qiang Xue committed
229
	public function getIsFlash()
Qiang Xue committed
230 231 232 233 234 235 236 237 238 239
	{
		return isset($_SERVER['HTTP_USER_AGENT']) &&
			(stripos($_SERVER['HTTP_USER_AGENT'], 'Shockwave') !== false || stripos($_SERVER['HTTP_USER_AGENT'], 'Flash') !== false);
	}

	private $_restParams;

	/**
	 * Returns the request parameters for the RESTful request.
	 * @return array the RESTful request parameters
240
	 * @see getMethod
Qiang Xue committed
241 242 243 244
	 */
	public function getRestParams()
	{
		if ($this->_restParams === null) {
245
			if (isset($_POST[$this->restVar])) {
Qiang Xue committed
246 247 248 249
				$this->_restParams = $_POST;
			} else {
				$this->_restParams = array();
				if (function_exists('mb_parse_str')) {
Qiang Xue committed
250
					mb_parse_str($this->getRawBody(), $this->_restParams);
Qiang Xue committed
251
				} else {
Qiang Xue committed
252
					parse_str($this->getRawBody(), $this->_restParams);
Qiang Xue committed
253 254 255 256 257 258
				}
			}
		}
		return $this->_restParams;
	}

Qiang Xue committed
259 260 261 262 263 264 265 266 267 268 269 270 271 272
	private $_rawBody;

	/**
	 * Returns the raw HTTP request body.
	 * @return string the request body
	 */
	public function getRawBody()
	{
		if ($this->_rawBody === null) {
			$this->_rawBody = file_get_contents('php://input');
		}
		return $this->_rawBody;
	}

Qiang Xue committed
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
	/**
	 * Sets the RESTful parameters.
	 * @param array $values the RESTful parameters (name-value pairs)
	 */
	public function setRestParams($values)
	{
		$this->_restParams = $values;
	}

	/**
	 * Returns the named RESTful parameter value.
	 * @param string $name the parameter name
	 * @param mixed $defaultValue the default parameter value if the parameter does not exist.
	 * @return mixed the parameter value
	 */
	public function getRestParam($name, $defaultValue = null)
	{
		$params = $this->getRestParams();
		return isset($params[$name]) ? $params[$name] : $defaultValue;
	}

Qiang Xue committed
294 295 296 297 298 299 300 301
	/**
	 * Returns the named GET parameter value.
	 * If the GET parameter does not exist, the second parameter to this method will be returned.
	 * @param string $name the GET parameter name
	 * @param mixed $defaultValue the default parameter value if the GET parameter does not exist.
	 * @return mixed the GET parameter value
	 * @see getPost
	 */
Qiang Xue committed
302
	public function get($name, $defaultValue = null)
Qiang Xue committed
303 304 305 306 307 308 309 310 311 312 313 314
	{
		return isset($_GET[$name]) ? $_GET[$name] : $defaultValue;
	}

	/**
	 * Returns the named POST parameter value.
	 * If the POST parameter does not exist, the second parameter to this method will be returned.
	 * @param string $name the POST parameter name
	 * @param mixed $defaultValue the default parameter value if the POST parameter does not exist.
	 * @return mixed the POST parameter value
	 * @see getParam
	 */
Qiang Xue committed
315
	public function getPost($name, $defaultValue = null)
Qiang Xue committed
316 317 318 319 320 321 322 323 324 325
	{
		return isset($_POST[$name]) ? $_POST[$name] : $defaultValue;
	}

	/**
	 * Returns the named DELETE parameter value.
	 * @param string $name the DELETE parameter name
	 * @param mixed $defaultValue the default parameter value if the DELETE parameter does not exist.
	 * @return mixed the DELETE parameter value
	 */
Qiang Xue committed
326
	public function getDelete($name, $defaultValue = null)
Qiang Xue committed
327
	{
Qiang Xue committed
328
		return $this->getIsDelete() ? $this->getRestParam($name, $defaultValue) : null;
Qiang Xue committed
329 330 331 332 333 334 335 336
	}

	/**
	 * Returns the named PUT parameter value.
	 * @param string $name the PUT parameter name
	 * @param mixed $defaultValue the default parameter value if the PUT parameter does not exist.
	 * @return mixed the PUT parameter value
	 */
Qiang Xue committed
337
	public function getPut($name, $defaultValue = null)
Qiang Xue committed
338
	{
Qiang Xue committed
339
		return $this->getIsPut() ? $this->getRestParam($name, $defaultValue) : null;
Qiang Xue committed
340 341
	}

342 343 344 345 346 347 348 349 350 351 352
	/**
	 * Returns the named PATCH parameter value.
	 * @param string $name the PATCH parameter name
	 * @param mixed $defaultValue the default parameter value if the PATCH parameter does not exist.
	 * @return mixed the PATCH parameter value
	 */
	public function getPatch($name, $defaultValue = null)
	{
		return $this->getIsPatch() ? $this->getRestParam($name, $defaultValue) : null;
	}

Qiang Xue committed
353 354
	private $_hostInfo;

Qiang Xue committed
355
	/**
Qiang Xue committed
356
	 * Returns the schema and host part of the current request URL.
Qiang Xue committed
357 358
	 * The returned URL does not have an ending slash.
	 * By default this is determined based on the user request information.
Qiang Xue committed
359 360
	 * You may explicitly specify it by setting the [[setHostInfo()|hostInfo]] property.
	 * @return string schema and hostname part (with port number if needed) of the request URL (e.g. `http://www.yiiframework.com`)
Qiang Xue committed
361 362
	 * @see setHostInfo
	 */
Qiang Xue committed
363
	public function getHostInfo()
Qiang Xue committed
364
	{
Qiang Xue committed
365
		if ($this->_hostInfo === null) {
Qiang Xue committed
366 367
			$secure = $this->getIsSecureConnection();
			$http = $secure ? 'https' : 'http';
Qiang Xue committed
368 369 370 371 372 373 374 375
			if (isset($_SERVER['HTTP_HOST'])) {
				$this->_hostInfo = $http . '://' . $_SERVER['HTTP_HOST'];
			} else {
				$this->_hostInfo = $http . '://' . $_SERVER['SERVER_NAME'];
				$port = $secure ? $this->getSecurePort() : $this->getPort();
				if (($port !== 80 && !$secure) || ($port !== 443 && $secure)) {
					$this->_hostInfo .= ':' . $port;
				}
Qiang Xue committed
376 377 378
			}
		}

Qiang Xue committed
379
		return $this->_hostInfo;
Qiang Xue committed
380 381 382 383 384 385
	}

	/**
	 * Sets the schema and host part of the application URL.
	 * This setter is provided in case the schema and hostname cannot be determined
	 * on certain Web servers.
Qiang Xue committed
386
	 * @param string $value the schema and host part of the application URL. The trailing slashes will be removed.
Qiang Xue committed
387 388 389
	 */
	public function setHostInfo($value)
	{
Qiang Xue committed
390
		$this->_hostInfo = rtrim($value, '/');
Qiang Xue committed
391 392
	}

Qiang Xue committed
393 394
	private $_baseUrl;

Qiang Xue committed
395 396
	/**
	 * Returns the relative URL for the application.
Qiang Xue committed
397 398
	 * This is similar to [[scriptUrl]] except that it does not include the script file name,
	 * and the ending slashes are removed.
Qiang Xue committed
399 400 401
	 * @return string the relative URL for the application
	 * @see setScriptUrl
	 */
Qiang Xue committed
402
	public function getBaseUrl()
Qiang Xue committed
403
	{
Qiang Xue committed
404 405 406
		if ($this->_baseUrl === null) {
			$this->_baseUrl = rtrim(dirname($this->getScriptUrl()), '\\/');
		}
Qiang Xue committed
407
		return $this->_baseUrl;
Qiang Xue committed
408 409 410 411 412 413 414 415 416 417
	}

	/**
	 * Sets the relative URL for the application.
	 * By default the URL is determined based on the entry script URL.
	 * This setter is provided in case you want to change this behavior.
	 * @param string $value the relative URL for the application
	 */
	public function setBaseUrl($value)
	{
Qiang Xue committed
418
		$this->_baseUrl = $value;
Qiang Xue committed
419 420
	}

Qiang Xue committed
421 422
	private $_scriptUrl;

Qiang Xue committed
423 424 425 426
	/**
	 * Returns the relative URL of the entry script.
	 * The implementation of this method referenced Zend_Controller_Request_Http in Zend Framework.
	 * @return string the relative URL of the entry script.
Qiang Xue committed
427
	 * @throws InvalidConfigException if unable to determine the entry script URL
Qiang Xue committed
428 429 430
	 */
	public function getScriptUrl()
	{
Qiang Xue committed
431
		if ($this->_scriptUrl === null) {
Qiang Xue committed
432 433
			$scriptFile = $this->getScriptFile();
			$scriptName = basename($scriptFile);
Qiang Xue committed
434 435
			if (basename($_SERVER['SCRIPT_NAME']) === $scriptName) {
				$this->_scriptUrl = $_SERVER['SCRIPT_NAME'];
Qiang Xue committed
436 437 438 439 440 441
			} elseif (basename($_SERVER['PHP_SELF']) === $scriptName) {
				$this->_scriptUrl = $_SERVER['PHP_SELF'];
			} elseif (isset($_SERVER['ORIG_SCRIPT_NAME']) && basename($_SERVER['ORIG_SCRIPT_NAME']) === $scriptName) {
				$this->_scriptUrl = $_SERVER['ORIG_SCRIPT_NAME'];
			} elseif (($pos = strpos($_SERVER['PHP_SELF'], '/' . $scriptName)) !== false) {
				$this->_scriptUrl = substr($_SERVER['SCRIPT_NAME'], 0, $pos) . '/' . $scriptName;
Qiang Xue committed
442 443
			} elseif (isset($_SERVER['DOCUMENT_ROOT']) && strpos($scriptFile, $_SERVER['DOCUMENT_ROOT']) === 0) {
				$this->_scriptUrl = str_replace('\\', '/', str_replace($_SERVER['DOCUMENT_ROOT'], '', $scriptFile));
Qiang Xue committed
444
			} else {
Qiang Xue committed
445
				throw new InvalidConfigException('Unable to determine the entry script URL.');
Qiang Xue committed
446
			}
Qiang Xue committed
447 448 449 450 451 452 453 454 455 456 457 458
		}
		return $this->_scriptUrl;
	}

	/**
	 * Sets the relative URL for the application entry script.
	 * This setter is provided in case the entry script URL cannot be determined
	 * on certain Web servers.
	 * @param string $value the relative URL for the application entry script.
	 */
	public function setScriptUrl($value)
	{
Qiang Xue committed
459
		$this->_scriptUrl = '/' . trim($value, '/');
Qiang Xue committed
460 461
	}

Qiang Xue committed
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
	private $_scriptFile;

	/**
	 * Returns the entry script file path.
	 * The default implementation will simply return `$_SERVER['SCRIPT_FILENAME']`.
	 * @return string the entry script file path
	 */
	public function getScriptFile()
	{
		return isset($this->_scriptFile) ? $this->_scriptFile : $_SERVER['SCRIPT_FILENAME'];
	}

	/**
	 * Sets the entry script file path.
	 * The entry script file path normally can be obtained from `$_SERVER['SCRIPT_FILENAME']`.
	 * If your server configuration does not return the correct value, you may configure
	 * this property to make it right.
	 * @param string $value the entry script file path.
	 */
	public function setScriptFile($value)
	{
		$this->_scriptFile = $value;
	}

Qiang Xue committed
486 487
	private $_pathInfo;

Qiang Xue committed
488 489
	/**
	 * Returns the path info of the currently requested URL.
Qiang Xue committed
490 491
	 * A path info refers to the part that is after the entry script and before the question mark (query string).
	 * The starting and ending slashes are both removed.
Qiang Xue committed
492
	 * @return string part of the request URL that is after the entry script and before the question mark.
Qiang Xue committed
493
	 * Note, the returned path info is already URL-decoded.
Qiang Xue committed
494
	 * @throws InvalidConfigException if the path info cannot be determined due to unexpected server configuration
Qiang Xue committed
495 496 497
	 */
	public function getPathInfo()
	{
Qiang Xue committed
498
		if ($this->_pathInfo === null) {
Qiang Xue committed
499 500 501 502
			$this->_pathInfo = $this->resolvePathInfo();
		}
		return $this->_pathInfo;
	}
Qiang Xue committed
503

Qiang Xue committed
504 505 506 507 508
	/**
	 * Sets the path info of the current request.
	 * This method is mainly provided for testing purpose.
	 * @param string $value the path info of the current request
	 */
Qiang Xue committed
509 510
	public function setPathInfo($value)
	{
Qiang Xue committed
511
		$this->_pathInfo = ltrim($value, '/');
Qiang Xue committed
512 513
	}

Qiang Xue committed
514 515 516
	/**
	 * Resolves the path info part of the currently requested URL.
	 * A path info refers to the part that is after the entry script and before the question mark (query string).
Qiang Xue committed
517
	 * The starting slashes are both removed (ending slashes will be kept).
Qiang Xue committed
518 519
	 * @return string part of the request URL that is after the entry script and before the question mark.
	 * Note, the returned path info is decoded.
Qiang Xue committed
520
	 * @throws InvalidConfigException if the path info cannot be determined due to unexpected server configuration
Qiang Xue committed
521 522 523
	 */
	protected function resolvePathInfo()
	{
Qiang Xue committed
524
		$pathInfo = $this->getUrl();
Qiang Xue committed
525

Qiang Xue committed
526 527 528
		if (($pos = strpos($pathInfo, '?')) !== false) {
			$pathInfo = substr($pathInfo, 0, $pos);
		}
Qiang Xue committed
529

Qiang Xue committed
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
		$pathInfo = urldecode($pathInfo);

		// try to encode in UTF8 if not so
		// http://w3.org/International/questions/qa-forms-utf-8.html
		if (!preg_match('%^(?:
				[\x09\x0A\x0D\x20-\x7E]              # ASCII
				| [\xC2-\xDF][\x80-\xBF]             # non-overlong 2-byte
				| \xE0[\xA0-\xBF][\x80-\xBF]         # excluding overlongs
				| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
				| \xED[\x80-\x9F][\x80-\xBF]         # excluding surrogates
				| \xF0[\x90-\xBF][\x80-\xBF]{2}      # planes 1-3
				| [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
				| \xF4[\x80-\x8F][\x80-\xBF]{2}      # plane 16
				)*$%xs', $pathInfo)) {
			$pathInfo = utf8_encode($pathInfo);
		}
Qiang Xue committed
546

Qiang Xue committed
547 548 549 550 551 552 553 554 555
		$scriptUrl = $this->getScriptUrl();
		$baseUrl = $this->getBaseUrl();
		if (strpos($pathInfo, $scriptUrl) === 0) {
			$pathInfo = substr($pathInfo, strlen($scriptUrl));
		} elseif ($baseUrl === '' || strpos($pathInfo, $baseUrl) === 0) {
			$pathInfo = substr($pathInfo, strlen($baseUrl));
		} elseif (strpos($_SERVER['PHP_SELF'], $scriptUrl) === 0) {
			$pathInfo = substr($_SERVER['PHP_SELF'], strlen($scriptUrl));
		} else {
Qiang Xue committed
556
			throw new InvalidConfigException('Unable to determine the path info of the current request.');
Qiang Xue committed
557
		}
Qiang Xue committed
558

Qiang Xue committed
559
		return ltrim($pathInfo, '/');
Qiang Xue committed
560 561
	}

Qiang Xue committed
562
	/**
Qiang Xue committed
563 564 565
	 * Returns the currently requested absolute URL.
	 * This is a shortcut to the concatenation of [[hostInfo]] and [[url]].
	 * @return string the currently requested absolute URL.
Qiang Xue committed
566
	 */
Qiang Xue committed
567
	public function getAbsoluteUrl()
Qiang Xue committed
568
	{
Qiang Xue committed
569
		return $this->getHostInfo() . $this->getUrl();
Qiang Xue committed
570 571
	}

Qiang Xue committed
572
	private $_url;
Qiang Xue committed
573

Qiang Xue committed
574
	/**
Qiang Xue committed
575 576 577 578 579
	 * Returns the currently requested relative URL.
	 * This refers to the portion of the URL that is after the [[hostInfo]] part.
	 * It includes the [[queryString]] part if any.
	 * @return string the currently requested relative URL. Note that the URI returned is URL-encoded.
	 * @throws InvalidConfigException if the URL cannot be determined due to unusual server configuration
Qiang Xue committed
580
	 */
Qiang Xue committed
581
	public function getUrl()
Qiang Xue committed
582
	{
Qiang Xue committed
583 584
		if ($this->_url === null) {
			$this->_url = $this->resolveRequestUri();
Qiang Xue committed
585
		}
Qiang Xue committed
586
		return $this->_url;
Qiang Xue committed
587 588
	}

Qiang Xue committed
589
	/**
Qiang Xue committed
590
	 * Sets the currently requested relative URL.
Qiang Xue committed
591 592 593 594
	 * The URI must refer to the portion that is after [[hostInfo]].
	 * Note that the URI should be URL-encoded.
	 * @param string $value the request URI to be set
	 */
Qiang Xue committed
595
	public function setUrl($value)
Qiang Xue committed
596
	{
Qiang Xue committed
597
		$this->_url = $value;
Qiang Xue committed
598 599
	}

Qiang Xue committed
600 601 602 603 604 605
	/**
	 * Resolves the request URI portion for the currently requested URL.
	 * This refers to the portion that is after the [[hostInfo]] part. It includes the [[queryString]] part if any.
	 * The implementation of this method referenced Zend_Controller_Request_Http in Zend Framework.
	 * @return string|boolean the request URI portion for the currently requested URL.
	 * Note that the URI returned is URL-encoded.
Qiang Xue committed
606
	 * @throws InvalidConfigException if the request URI cannot be determined due to unusual server configuration
Qiang Xue committed
607 608 609 610 611 612 613
	 */
	protected function resolveRequestUri()
	{
		if (isset($_SERVER['HTTP_X_REWRITE_URL'])) { // IIS
			$requestUri = $_SERVER['HTTP_X_REWRITE_URL'];
		} elseif (isset($_SERVER['REQUEST_URI'])) {
			$requestUri = $_SERVER['REQUEST_URI'];
Qiang Xue committed
614
			if ($requestUri !== '' && $requestUri[0] !== '/') {
Qiang Xue committed
615 616 617 618 619 620 621 622
				$requestUri = preg_replace('/^(http|https):\/\/[^\/]+/i', '', $requestUri);
			}
		} elseif (isset($_SERVER['ORIG_PATH_INFO'])) { // IIS 5.0 CGI
			$requestUri = $_SERVER['ORIG_PATH_INFO'];
			if (!empty($_SERVER['QUERY_STRING'])) {
				$requestUri .= '?' . $_SERVER['QUERY_STRING'];
			}
		} else {
Qiang Xue committed
623
			throw new InvalidConfigException('Unable to determine the request URI.');
Qiang Xue committed
624 625 626 627
		}
		return $requestUri;
	}

Qiang Xue committed
628 629 630 631 632 633
	/**
	 * Returns part of the request URL that is after the question mark.
	 * @return string part of the request URL that is after the question mark
	 */
	public function getQueryString()
	{
Qiang Xue committed
634
		return isset($_SERVER['QUERY_STRING']) ? $_SERVER['QUERY_STRING'] : '';
Qiang Xue committed
635 636 637 638 639 640 641 642
	}

	/**
	 * Return if the request is sent via secure channel (https).
	 * @return boolean if the request is sent via secure channel (https)
	 */
	public function getIsSecureConnection()
	{
643 644
		return isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] === 'on' || $_SERVER['HTTPS'] == 1)
			|| isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https';
Qiang Xue committed
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
	}

	/**
	 * Returns the server name.
	 * @return string server name
	 */
	public function getServerName()
	{
		return $_SERVER['SERVER_NAME'];
	}

	/**
	 * Returns the server port number.
	 * @return integer server port number
	 */
	public function getServerPort()
	{
Qiang Xue committed
662
		return (int)$_SERVER['SERVER_PORT'];
Qiang Xue committed
663 664 665 666 667 668
	}

	/**
	 * Returns the URL referrer, null if not present
	 * @return string URL referrer, null if not present
	 */
Qiang Xue committed
669
	public function getReferrer()
Qiang Xue committed
670
	{
Qiang Xue committed
671
		return isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : null;
Qiang Xue committed
672 673 674 675 676 677 678 679
	}

	/**
	 * Returns the user agent, null if not present.
	 * @return string user agent, null if not present
	 */
	public function getUserAgent()
	{
Qiang Xue committed
680
		return isset($_SERVER['HTTP_USER_AGENT']) ? $_SERVER['HTTP_USER_AGENT'] : null;
Qiang Xue committed
681 682 683 684 685 686
	}

	/**
	 * Returns the user IP address.
	 * @return string user IP address
	 */
687
	public function getUserIP()
Qiang Xue committed
688
	{
Qiang Xue committed
689
		return isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : '127.0.0.1';
Qiang Xue committed
690 691 692 693 694 695 696 697
	}

	/**
	 * Returns the user host name, null if it cannot be determined.
	 * @return string user host name, null if cannot be determined
	 */
	public function getUserHost()
	{
Qiang Xue committed
698
		return isset($_SERVER['REMOTE_HOST']) ? $_SERVER['REMOTE_HOST'] : null;
Qiang Xue committed
699 700 701 702 703 704 705 706
	}

	/**
	 * Returns user browser accept types, null if not present.
	 * @return string user browser accept types, null if not present
	 */
	public function getAcceptTypes()
	{
Qiang Xue committed
707
		return isset($_SERVER['HTTP_ACCEPT']) ? $_SERVER['HTTP_ACCEPT'] : null;
Qiang Xue committed
708 709 710 711
	}

	private $_port;

Qiang Xue committed
712
	/**
Qiang Xue committed
713 714 715 716 717 718 719 720
	 * Returns the port to use for insecure requests.
	 * Defaults to 80, or the port specified by the server if the current
	 * request is insecure.
	 * @return integer port number for insecure requests.
	 * @see setPort
	 */
	public function getPort()
	{
Qiang Xue committed
721 722 723
		if ($this->_port === null) {
			$this->_port = !$this->getIsSecureConnection() && isset($_SERVER['SERVER_PORT']) ? (int)$_SERVER['SERVER_PORT'] : 80;
		}
Qiang Xue committed
724 725 726 727 728 729 730 731 732 733 734
		return $this->_port;
	}

	/**
	 * Sets the port to use for insecure requests.
	 * This setter is provided in case a custom port is necessary for certain
	 * server configurations.
	 * @param integer $value port number.
	 */
	public function setPort($value)
	{
Qiang Xue committed
735 736 737 738
		if ($value != $this->_port) {
			$this->_port = (int)$value;
			$this->_hostInfo = null;
		}
Qiang Xue committed
739 740 741 742 743 744 745 746 747 748 749 750 751
	}

	private $_securePort;

	/**
	 * Returns the port to use for secure requests.
	 * Defaults to 443, or the port specified by the server if the current
	 * request is secure.
	 * @return integer port number for secure requests.
	 * @see setSecurePort
	 */
	public function getSecurePort()
	{
Qiang Xue committed
752 753 754
		if ($this->_securePort === null) {
			$this->_securePort = $this->getIsSecureConnection() && isset($_SERVER['SERVER_PORT']) ? (int)$_SERVER['SERVER_PORT'] : 443;
		}
Qiang Xue committed
755 756 757 758 759 760 761 762 763 764 765
		return $this->_securePort;
	}

	/**
	 * Sets the port to use for secure requests.
	 * This setter is provided in case a custom port is necessary for certain
	 * server configurations.
	 * @param integer $value port number.
	 */
	public function setSecurePort($value)
	{
Qiang Xue committed
766 767 768
		if ($value != $this->_securePort) {
			$this->_securePort = (int)$value;
			$this->_hostInfo = null;
Qiang Xue committed
769
		}
Qiang Xue committed
770 771
	}

772
	private $_contentTypes;
Qiang Xue committed
773 774

	/**
775 776 777 778
	 * Returns the content types accepted by the end user.
	 * This is determined by the `Accept` HTTP header.
	 * @return array the content types ordered by the preference level. The first element
	 * represents the most preferred content type.
Qiang Xue committed
779
	 */
780
	public function getAcceptedContentTypes()
Qiang Xue committed
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
		if ($this->_contentTypes === null) {
			if (isset($_SERVER['HTTP_ACCEPT'])) {
				$this->_contentTypes = $this->parseAcceptHeader($_SERVER['HTTP_ACCEPT']);
			} else {
				$this->_contentTypes = array();
			}
		}
		return $this->_contentTypes;
	}

	/**
	 * @param array $value the content types that are accepted by the end user. They should
	 * be ordered by the preference level.
	 */
	public function setAcceptedContentTypes($value)
	{
		$this->_contentTypes = $value;
	}

	private $_languages;

	/**
	 * Returns the languages accepted by the end user.
	 * This is determined by the `Accept-Language` HTTP header.
	 * @return array the languages ordered by the preference level. The first element
	 * represents the most preferred language.
	 */
	public function getAcceptedLanguages()
	{
		if ($this->_languages === null) {
			if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
				$this->_languages = $this->parseAcceptHeader($_SERVER['HTTP_ACCEPT_LANGUAGE']);
			} else {
				$this->_languages = array();
			}
		}
		return $this->_languages;
	}

	/**
	 * @param array $value the languages that are accepted by the end user. They should
	 * be ordered by the preference level.
	 */
	public function setAcceptedLanguages($value)
	{
		$this->_languages = $value;
	}

	/**
	 * Parses the given `Accept` (or `Accept-Language`) header.
	 * This method will return the accepted values ordered by their preference level.
	 * @param string $header the header to be parsed
	 * @return array the accept values ordered by their preference level.
	 */
	protected function parseAcceptHeader($header)
	{
		$accepts = array();
		$n = preg_match_all('/\s*([\w\/\-\*]+)\s*(?:;\s*q\s*=\s*([\d\.]+))?[^,]*/', $header, $matches, PREG_SET_ORDER);
		for ($i = 0; $i < $n; ++$i) {
			if (!empty($matches[$i][1])) {
				$accepts[] = array($matches[$i][1], isset($matches[$i][2]) ? (float)$matches[$i][2] : 1, $i);
			}
		}
		usort($accepts, function ($a, $b) {
			if ($a[1] > $b[1]) {
				return -1;
			} elseif ($a[1] < $b[1]) {
				return 1;
			} elseif ($a[0] === $b[0]) {
				return $a[2] > $b[2] ? 1 : -1;
			} elseif ($a[0] === '*/*') {
				return 1;
			} elseif ($b[0] === '*/*') {
				return -1;
Qiang Xue committed
856
			} else {
857 858 859 860 861 862 863
				$wa = $a[0][strlen($a[0]) - 1] === '*';
				$wb = $b[0][strlen($b[0]) - 1] === '*';
				if ($wa xor $wb) {
					return $wa ? 1 : -1;
				} else {
					return $a[2] > $b[2] ? 1 : -1;
				}
Qiang Xue committed
864
			}
865 866 867 868
		});
		$result = array();
		foreach ($accepts as $accept) {
			$result[] = $accept[0];
Qiang Xue committed
869
		}
870
		return array_unique($result);
Qiang Xue committed
871 872 873
	}

	/**
874 875 876 877 878 879 880
	 * Returns the user-preferred language that should be used by this application.
	 * The language resolution is based on the user preferred languages and the languages
	 * supported by the application. The method will try to find the best match.
	 * @param array $languages a list of the languages supported by the application.
	 * If empty, this method will return the first language returned by [[getAcceptedLanguages()]].
	 * @return string the language that the application should use. Null is returned if both [[getAcceptedLanguages()]]
	 * and `$languages` are empty.
Qiang Xue committed
881
	 */
882
	public function getPreferredLanguage($languages = array())
Qiang Xue committed
883
	{
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
		$acceptedLanguages = $this->getAcceptedLanguages();
		if (empty($languages)) {
			return isset($acceptedLanguages[0]) ? $acceptedLanguages[0] : null;
		}
		foreach ($acceptedLanguages as $acceptedLanguage) {
			$acceptedLanguage = str_replace('-', '_', strtolower($acceptedLanguage));
			foreach ($languages as $language) {
				$language = str_replace('-', '_', strtolower($language));
				// en_us==en_us, en==en_us, en_us==en
				if ($language === $acceptedLanguage || strpos($acceptedLanguage, $language . '_') === 0 || strpos($language, $acceptedLanguage . '_') === 0) {
					return $language;
				}
			}
		}
		return reset($languages);
Qiang Xue committed
899 900 901
	}

	/**
Qiang Xue committed
902
	 * Returns the cookie collection.
903 904 905 906 907 908 909 910 911 912 913 914 915
	 * Through the returned cookie collection, you may access a cookie using the following syntax:
	 *
	 * ~~~
	 * $cookie = $request->cookies['name']
	 * if ($cookie !== null) {
	 *     $value = $cookie->value;
	 * }
	 *
	 * // alternatively
	 * $value = $request->cookies->getValue('name');
	 * ~~~
	 *
	 * @return CookieCollection the cookie collection.
Qiang Xue committed
916
	 */
Qiang Xue committed
917
	public function getCookies()
Qiang Xue committed
918
	{
919
		if ($this->_cookies === null) {
Qiang Xue committed
920 921
			$this->_cookies = new CookieCollection($this->loadCookies(), array(
				'readOnly' => true,
Qiang Xue committed
922
			));
923 924 925
		}
		return $this->_cookies;
	}
Qiang Xue committed
926

Qiang Xue committed
927 928 929 930 931 932 933 934 935 936
	/**
	 * Converts `$_COOKIE` into an array of [[Cookie]].
	 * @return array the cookies obtained from request
	 */
	protected function loadCookies()
	{
		$cookies = array();
		if ($this->enableCookieValidation) {
			$key = $this->getCookieValidationKey();
			foreach ($_COOKIE as $name => $value) {
937
				if (is_string($value) && ($value = Security::validateData($value, $key)) !== false) {
Qiang Xue committed
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
					$cookies[$name] = new Cookie(array(
						'name' => $name,
						'value' => @unserialize($value),
					));
				}
			}
		} else {
			foreach ($_COOKIE as $name => $value) {
				$cookies[$name] = new Cookie(array(
					'name' => $name,
					'value' => $value,
				));
			}
		}
		return $cookies;
	}

	private $_cookieValidationKey;

	/**
958
	 * @return string the secret key used for cookie validation. If it was not set previously,
Qiang Xue committed
959 960 961 962 963
	 * a random key will be generated and used.
	 */
	public function getCookieValidationKey()
	{
		if ($this->_cookieValidationKey === null) {
964
			$this->_cookieValidationKey = Security::getSecretKey(__CLASS__ . '/' . Yii::$app->id);
Qiang Xue committed
965 966 967 968 969 970 971 972 973 974 975 976 977
		}
		return $this->_cookieValidationKey;
	}

	/**
	 * Sets the secret key used for cookie validation.
	 * @param string $value the secret key used for cookie validation.
	 */
	public function setCookieValidationKey($value)
	{
		$this->_cookieValidationKey = $value;
	}

978 979 980 981
	/**
	 * @var Cookie
	 */
	private $_csrfCookie;
Qiang Xue committed
982 983 984 985 986 987 988 989 990

	/**
	 * Returns the random token used to perform CSRF validation.
	 * The token will be read from cookie first. If not found, a new token will be generated.
	 * @return string the random token for CSRF validation.
	 * @see enableCsrfValidation
	 */
	public function getCsrfToken()
	{
991
		if ($this->_csrfCookie === null) {
992
			$this->_csrfCookie = $this->getCookies()->get($this->csrfVar);
993 994
			if ($this->_csrfCookie === null) {
				$this->_csrfCookie = $this->createCsrfCookie();
995
				Yii::$app->getResponse()->getCookies()->add($this->_csrfCookie);
Qiang Xue committed
996 997 998
			}
		}

999
		return $this->_csrfCookie->value;
Qiang Xue committed
1000 1001
	}

1002 1003 1004 1005 1006
	/**
	 * @return string the CSRF token sent via [[CSRF_HEADER]] by browser. Null is returned if no such header is sent.
	 */
	public function getCsrfTokenFromHeader()
	{
Qiang Xue committed
1007 1008
		$key = 'HTTP_' . str_replace('-', '_', strtoupper(self::CSRF_HEADER));
		return isset($_SERVER[$key]) ? $_SERVER[$key] : null;
1009 1010
	}

Qiang Xue committed
1011 1012 1013 1014 1015 1016 1017 1018 1019
	/**
	 * Creates a cookie with a randomly generated CSRF token.
	 * Initial values specified in [[csrfCookie]] will be applied to the generated cookie.
	 * @return Cookie the generated cookie
	 * @see enableCsrfValidation
	 */
	protected function createCsrfCookie()
	{
		$options = $this->csrfCookie;
1020
		$options['name'] = $this->csrfVar;
Qiang Xue committed
1021 1022 1023 1024 1025 1026 1027 1028
		$options['value'] = sha1(uniqid(mt_rand(), true));
		return new Cookie($options);
	}

	/**
	 * Performs the CSRF validation.
	 * The method will compare the CSRF token obtained from a cookie and from a POST field.
	 * If they are different, a CSRF attack is detected and a 400 HTTP exception will be raised.
1029
	 * This method is called in [[Controller::beforeAction()]].
Qiang Xue committed
1030
	 * @return boolean whether CSRF token is valid. If [[enableCsrfValidation]] is false, this method will return true.
Qiang Xue committed
1031 1032 1033
	 */
	public function validateCsrfToken()
	{
1034
		$method = $this->getMethod();
1035
		if (!$this->enableCsrfValidation || !in_array($method, array('POST', 'PUT', 'PATCH', 'DELETE'), true)) {
Qiang Xue committed
1036
			return true;
Qiang Xue committed
1037
		}
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
		$trueToken = $this->getCookies()->getValue($this->csrfVar);
		switch ($method) {
			case 'PUT':
				$token = $this->getPut($this->csrfVar);
				break;
			case 'PATCH':
				$token = $this->getPatch($this->csrfVar);
				break;
			case 'DELETE':
				$token = $this->getDelete($this->csrfVar);
				break;
			default:
				$token = $this->getPost($this->csrfVar);
				break;
		}
		return $token === $trueToken || $this->getCsrfTokenFromHeader() === $trueToken;
Qiang Xue committed
1054
	}
Qiang Xue committed
1055
}