Request.php 40.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;
13
use yii\helpers\StringHelper;
Qiang Xue committed
14

Qiang Xue committed
15
/**
16 17 18 19 20
 * 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.
21
 *
22
 * Request is configured as an application component in [[\yii\web\Application]] by default.
23 24
 * You can access that instance via `Yii::$app->request`.
 *
25
 * @property string $absoluteUrl The currently requested absolute URL. This property is read-only.
26 27
 * @property array $acceptableContentTypes The content types ordered by the preference level. The first
 * element represents the most preferred content type.
28
 * @property array $acceptableLanguages The languages ordered by the preference level. The first element
29 30
 * represents the most preferred language.
 * @property string $baseUrl The relative URL for the application.
31 32 33
 * @property array $bodyParams The request parameters given in the request body.
 * @property string $contentType Request content-type. Null is returned if this information is not available.
 * This property is read-only.
34 35 36
 * @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.
37
 * @property string $csrfToken The token used to perform CSRF validation. This property is read-only.
Qiang Xue committed
38 39
 * @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.
40
 * @property HeaderCollection $headers The header collection. This property is read-only.
41 42 43 44 45 46
 * @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.
47 48 49
 * @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.
50 51 52 53 54 55 56 57 58
 * @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.
59
 * @property integer $port Port number for insecure requests.
60 61
 * @property array $postParams The request POST parameter values.
 * @property array $queryParams The request GET parameter values.
62 63 64
 * @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.
65
 * @property string $rawCsrfToken The random token for CSRF validation. This property is read-only.
66
 * @property string $referrer URL referrer, null if not present. This property is read-only.
67 68 69
 * @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.
70 71
 * @property string $serverName Server name. This property is read-only.
 * @property integer $serverPort Server port number. This property is read-only.
72
 * @property string $url The currently requested relative URL. Note that the URI returned is URL-encoded.
73 74 75
 * @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.
76
 *
Qiang Xue committed
77
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
78
 * @since 2.0
Qiang Xue committed
79
 */
Qiang Xue committed
80
class Request extends \yii\base\Request
Qiang Xue committed
81
{
82 83 84
	/**
	 * The name of the HTTP header for sending CSRF token.
	 */
Qiang Xue committed
85
	const CSRF_HEADER = 'X-CSRF-Token';
86 87 88 89
	/**
	 * The length of the CSRF token mask.
	 */
	const CSRF_MASK_LENGTH = 8;
90

91

Qiang Xue committed
92
	/**
93
	 * @var boolean whether to enable CSRF (Cross-Site Request Forgery) validation. Defaults to true.
94
	 * When CSRF validation is enabled, forms submitted to an Yii Web application must be originated
Qiang Xue committed
95 96 97
	 * 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,
98
	 * forms submitted via POST method must contain a hidden input whose name is specified by [[csrfVar]].
Qiang Xue committed
99
	 * You may use [[\yii\web\Html::beginForm()]] to generate his hidden input.
100 101 102 103
	 *
	 * 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.
	 *
104
	 * @see Controller::enableCsrfValidation
Qiang Xue committed
105 106
	 * @see http://en.wikipedia.org/wiki/Cross-site_request_forgery
	 */
107
	public $enableCsrfValidation = true;
Qiang Xue committed
108
	/**
109
	 * @var string the name of the token used to prevent CSRF. Defaults to '_csrf'.
110
	 * This property is used only when [[enableCsrfValidation]] is true.
Qiang Xue committed
111
	 */
112
	public $csrfVar = '_csrf';
Qiang Xue committed
113 114 115 116
	/**
	 * @var array the configuration of the CSRF cookie. This property is used only when [[enableCsrfValidation]] is true.
	 * @see Cookie
	 */
Alexander Makarov committed
117
	public $csrfCookie = ['httpOnly' => true];
Qiang Xue committed
118
	/**
Qiang Xue committed
119
	 * @var boolean whether cookies should be validated to ensure they are not tampered. Defaults to true.
Qiang Xue committed
120
	 */
Qiang Xue committed
121
	public $enableCookieValidation = true;
Qiang Xue committed
122
	/**
123
	 * @var string|boolean the name of the POST parameter that is used to indicate if a request is a PUT, PATCH or DELETE
124
	 * request tunneled through POST. Default to '_method'.
Taras Gudz committed
125
	 * @see getMethod()
126
	 * @see getBodyParams()
Qiang Xue committed
127
	 */
128
	public $methodVar = '_method';
Daniel Schmidt committed
129
	/**
130
	 * @var array the parsers for converting the raw HTTP request body into [[bodyParams]].
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
	 * The array keys are the request `Content-Types`, and the array values are the
	 * corresponding configurations for [[Yii::createObject|creating the parser objects]].
	 * A parser must implement the [[RequestParserInterface]].
	 *
	 * To enable parsing for JSON requests you can use the [[JsonParser]] class like in the following example:
	 *
	 * ```
	 * [
	 *     'application/json' => 'yii\web\JsonParser',
	 * ]
	 * ```
	 *
	 * To register a parser for parsing all request types you can use `'*'` as the array key.
	 * This one will be used as a fallback in case no other types match.
	 *
146
	 * @see getBodyParams()
Daniel Schmidt committed
147 148
	 */
	public $parsers = [];
149

Qiang Xue committed
150
	private $_cookies;
151

152 153 154 155
	/**
	 * @var array the headers in this collection (indexed by the header names)
	 */
	private $_headers;
Qiang Xue committed
156

Qiang Xue committed
157 158 159 160 161 162 163 164 165 166
	/**
	 * 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;
167
			$_GET = array_merge($_GET, $params);
Alexander Makarov committed
168
			return [$route, $_GET];
Qiang Xue committed
169
		} else {
170
			throw new NotFoundHttpException(Yii::t('yii', 'Page not found.'));
Qiang Xue committed
171 172 173
		}
	}

174 175 176 177 178 179 180 181 182 183 184
	/**
	 * Returns the header collection.
	 * The header collection contains incoming HTTP headers.
	 * @return HeaderCollection the header collection
	 */
	public function getHeaders()
	{
		if ($this->_headers === null) {
			$this->_headers = new HeaderCollection;
			if (function_exists('getallheaders')) {
				$headers = getallheaders();
185 186
			} elseif (function_exists('http_get_request_headers')) {
				$headers = http_get_request_headers();
187 188
			} else {
				foreach ($_SERVER as $name => $value) {
189
					if (strncmp($name, 'HTTP_', 5) === 0) {
190 191 192 193
						$name = str_replace(' ', '-', ucwords(strtolower(str_replace('_', ' ', substr($name, 5)))));
						$this->_headers->add($name, $value);
					}
				}
194 195 196 197
				return $this->_headers;
			}
			foreach ($headers as $name => $value) {
				$this->_headers->add($name, $value);
198 199
			}
		}
200

201 202 203
		return $this->_headers;
	}

Qiang Xue committed
204
	/**
205 206
	 * 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
207 208
	 * The value returned is turned into upper case.
	 */
209
	public function getMethod()
Qiang Xue committed
210
	{
211 212
		if (isset($_POST[$this->methodVar])) {
			return strtoupper($_POST[$this->methodVar]);
213 214
		} elseif (isset($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'])) {
			return strtoupper($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']);
Qiang Xue committed
215 216 217 218 219
		} else {
			return isset($_SERVER['REQUEST_METHOD']) ? strtoupper($_SERVER['REQUEST_METHOD']) : 'GET';
		}
	}

220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
	/**
	 * 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';
	}
237

238 239 240 241 242 243 244 245
	/**
	 * Returns whether this is a HEAD request.
	 * @return boolean whether this is a HEAD request.
	 */
	public function getIsHead()
	{
		return $this->getMethod() === 'HEAD';
	}
246

Qiang Xue committed
247 248 249 250
	/**
	 * Returns whether this is a POST request.
	 * @return boolean whether this is a POST request.
	 */
Qiang Xue committed
251
	public function getIsPost()
Qiang Xue committed
252
	{
253
		return $this->getMethod() === 'POST';
Qiang Xue committed
254 255 256 257 258 259
	}

	/**
	 * Returns whether this is a DELETE request.
	 * @return boolean whether this is a DELETE request.
	 */
Qiang Xue committed
260
	public function getIsDelete()
Qiang Xue committed
261
	{
262
		return $this->getMethod() === 'DELETE';
Qiang Xue committed
263 264 265 266 267 268
	}

	/**
	 * Returns whether this is a PUT request.
	 * @return boolean whether this is a PUT request.
	 */
Qiang Xue committed
269
	public function getIsPut()
Qiang Xue committed
270
	{
271
		return $this->getMethod() === 'PUT';
Qiang Xue committed
272 273
	}

274 275 276 277 278 279 280 281 282
	/**
	 * 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
283 284 285 286
	/**
	 * Returns whether this is an AJAX (XMLHttpRequest) request.
	 * @return boolean whether this is an AJAX (XMLHttpRequest) request.
	 */
Qiang Xue committed
287
	public function getIsAjax()
Qiang Xue committed
288 289 290 291 292
	{
		return isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] === 'XMLHttpRequest';
	}

	/**
Qiang Xue committed
293
	 * Returns whether this is an Adobe Flash or Flex request.
Qiang Xue committed
294 295
	 * @return boolean whether this is an Adobe Flash or Adobe Flex request.
	 */
Qiang Xue committed
296
	public function getIsFlash()
Qiang Xue committed
297 298 299 300 301
	{
		return isset($_SERVER['HTTP_USER_AGENT']) &&
			(stripos($_SERVER['HTTP_USER_AGENT'], 'Shockwave') !== false || stripos($_SERVER['HTTP_USER_AGENT'], 'Flash') !== false);
	}

302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
	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;
	}

	private $_bodyParams;
Qiang Xue committed
317 318

	/**
319
	 * Returns the request parameters given in the request body.
320 321 322 323
	 *
	 * Request parameters are determined using the parsers configured in [[parsers]] property.
	 * If no parsers are configured for the current [[contentType]] it uses the PHP function [[mb_parse_str()]]
	 * to parse the [[rawBody|request body]].
324
	 * @return array the request parameters given in the request body.
325
	 * @throws \yii\base\InvalidConfigException if a registered parser does not implement the [[RequestParserInterface]].
Taras Gudz committed
326
	 * @see getMethod()
327 328
	 * @see getBodyParam()
	 * @see setBodyParams()
Qiang Xue committed
329
	 */
330
	public function getBodyParams()
Qiang Xue committed
331
	{
332
		if ($this->_bodyParams === null) {
333
			$contentType = $this->getContentType();
334 335 336
			if (isset($_POST[$this->methodVar])) {
				$this->_bodyParams = $_POST;
				unset($this->_bodyParams[$this->methodVar]);
337 338 339 340 341
			} elseif (isset($this->parsers[$contentType])) {
				$parser = Yii::createObject($this->parsers[$contentType]);
				if (!($parser instanceof RequestParserInterface)) {
					throw new InvalidConfigException("The '$contentType' request parser is invalid. It must implement the yii\\web\\RequestParserInterface.");
				}
342
				$this->_bodyParams = $parser->parse($this->getRawBody(), $contentType);
343 344 345 346
			} elseif (isset($this->parsers['*'])) {
				$parser = Yii::createObject($this->parsers['*']);
				if (!($parser instanceof RequestParserInterface)) {
					throw new InvalidConfigException("The fallback request parser is invalid. It must implement the yii\\web\\RequestParserInterface.");
Daniel Schmidt committed
347
				}
348
				$this->_bodyParams = $parser->parse($this->getRawBody(), $contentType);
349 350 351
			} elseif ($this->getMethod() === 'POST') {
				// PHP has already parsed the body so we have all params in $_POST
				$this->_bodyParams = $_POST;
Qiang Xue committed
352
			} else {
353 354
				$this->_bodyParams = [];
				mb_parse_str($this->getRawBody(), $this->_bodyParams);
Qiang Xue committed
355 356
			}
		}
357
		return $this->_bodyParams;
Qiang Xue committed
358 359
	}

360 361 362 363 364 365 366 367 368 369
	/**
	 * Sets the request body parameters.
	 * @param array $values the request body parameters (name-value pairs)
	 * @see getBodyParam()
	 * @see getBodyParams()
	 */
	public function setBodyParams($values)
	{
		$this->_bodyParams = $values;
	}
Qiang Xue committed
370 371

	/**
372 373 374 375 376 377
	 * Returns the named request body 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
	 * @see getBodyParams()
	 * @see setBodyParams()
Qiang Xue committed
378
	 */
379
	public function getBodyParam($name, $defaultValue = null)
Qiang Xue committed
380
	{
381 382
		$params = $this->getBodyParams();
		return isset($params[$name]) ? $params[$name] : $defaultValue;
Qiang Xue committed
383 384
	}

385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
	/**
	 * Returns POST parameter with a given name. If name isn't specified, returns an array of all POST parameters.
	 *
	 * @param string $name the parameter name
	 * @param mixed $defaultValue the default parameter value if the parameter does not exist.
	 * @return array|mixed
	 */
	public function post($name = null, $defaultValue = null)
	{
		if ($name === null) {
			return $this->getBodyParams();
		} else {
			return $this->getBodyParam($name, $defaultValue);
		}
	}

401 402
	private $_queryParams;

Qiang Xue committed
403
	/**
404 405 406 407 408
	 * Returns the request parameters given in the [[queryString]].
	 *
	 * This method will return the contents of `$_GET` if params where not explicitly set.
	 * @return array the request GET parameter values.
	 * @see setQueryParams()
Qiang Xue committed
409
	 */
410
	public function getQueryParams()
Qiang Xue committed
411
	{
412 413 414 415
		if ($this->_queryParams === null) {
			return $_GET;
		}
		return $this->_queryParams;
Qiang Xue committed
416 417 418
	}

	/**
419 420 421 422
	 * Sets the request [[queryString]] parameters.
	 * @param array $values the request query parameters (name-value pairs)
	 * @see getQueryParam()
	 * @see getQueryParams()
Qiang Xue committed
423
	 */
424
	public function setQueryParams($values)
Qiang Xue committed
425
	{
426
		$this->_queryParams = $values;
Qiang Xue committed
427 428
	}

429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
	/**
	 * Returns GET parameter with a given name. If name isn't specified, returns an array of all GET parameters.
	 *
	 * @param string $name the parameter name
	 * @param mixed $defaultValue the default parameter value if the parameter does not exist.
	 * @return array|mixed
	 */
	public function get($name = null, $defaultValue = null)
	{
		if ($name === null) {
			return $this->getQueryParams();
		} else {
			return $this->getQueryParam($name, $defaultValue);
		}
	}

Qiang Xue committed
445 446 447
	/**
	 * Returns the named GET parameter value.
	 * If the GET parameter does not exist, the second parameter to this method will be returned.
448
	 * @param string $name the GET parameter name. If not specified, whole $_GET is returned.
Qiang Xue committed
449 450
	 * @param mixed $defaultValue the default parameter value if the GET parameter does not exist.
	 * @return mixed the GET parameter value
451
	 * @see getBodyParam()
Qiang Xue committed
452
	 */
453
	public function getQueryParam($name, $defaultValue = null)
Qiang Xue committed
454
	{
455 456
		$params = $this->getQueryParams();
		return isset($params[$name]) ? $params[$name] : $defaultValue;
Qiang Xue committed
457 458
	}

Qiang Xue committed
459 460
	private $_hostInfo;

Qiang Xue committed
461
	/**
Qiang Xue committed
462
	 * Returns the schema and host part of the current request URL.
Qiang Xue committed
463 464
	 * The returned URL does not have an ending slash.
	 * By default this is determined based on the user request information.
Qiang Xue committed
465 466
	 * 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`)
Taras Gudz committed
467
	 * @see setHostInfo()
Qiang Xue committed
468
	 */
Qiang Xue committed
469
	public function getHostInfo()
Qiang Xue committed
470
	{
Qiang Xue committed
471
		if ($this->_hostInfo === null) {
Qiang Xue committed
472 473
			$secure = $this->getIsSecureConnection();
			$http = $secure ? 'https' : 'http';
Qiang Xue committed
474 475 476 477 478 479 480 481
			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
482 483 484
			}
		}

Qiang Xue committed
485
		return $this->_hostInfo;
Qiang Xue committed
486 487 488 489 490 491
	}

	/**
	 * 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
492
	 * @param string $value the schema and host part of the application URL. The trailing slashes will be removed.
Qiang Xue committed
493 494 495
	 */
	public function setHostInfo($value)
	{
Qiang Xue committed
496
		$this->_hostInfo = rtrim($value, '/');
Qiang Xue committed
497 498
	}

Qiang Xue committed
499 500
	private $_baseUrl;

Qiang Xue committed
501 502
	/**
	 * Returns the relative URL for the application.
Qiang Xue committed
503 504
	 * This is similar to [[scriptUrl]] except that it does not include the script file name,
	 * and the ending slashes are removed.
Qiang Xue committed
505
	 * @return string the relative URL for the application
Taras Gudz committed
506
	 * @see setScriptUrl()
Qiang Xue committed
507
	 */
Qiang Xue committed
508
	public function getBaseUrl()
Qiang Xue committed
509
	{
Qiang Xue committed
510 511 512
		if ($this->_baseUrl === null) {
			$this->_baseUrl = rtrim(dirname($this->getScriptUrl()), '\\/');
		}
Qiang Xue committed
513
		return $this->_baseUrl;
Qiang Xue committed
514 515 516 517 518 519 520 521 522 523
	}

	/**
	 * 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
524
		$this->_baseUrl = $value;
Qiang Xue committed
525 526
	}

Qiang Xue committed
527 528
	private $_scriptUrl;

Qiang Xue committed
529 530 531 532
	/**
	 * 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
533
	 * @throws InvalidConfigException if unable to determine the entry script URL
Qiang Xue committed
534 535 536
	 */
	public function getScriptUrl()
	{
Qiang Xue committed
537
		if ($this->_scriptUrl === null) {
Qiang Xue committed
538 539
			$scriptFile = $this->getScriptFile();
			$scriptName = basename($scriptFile);
Qiang Xue committed
540 541
			if (basename($_SERVER['SCRIPT_NAME']) === $scriptName) {
				$this->_scriptUrl = $_SERVER['SCRIPT_NAME'];
Qiang Xue committed
542 543 544 545 546 547
			} 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
548 549
			} elseif (isset($_SERVER['DOCUMENT_ROOT']) && strpos($scriptFile, $_SERVER['DOCUMENT_ROOT']) === 0) {
				$this->_scriptUrl = str_replace('\\', '/', str_replace($_SERVER['DOCUMENT_ROOT'], '', $scriptFile));
Qiang Xue committed
550
			} else {
Qiang Xue committed
551
				throw new InvalidConfigException('Unable to determine the entry script URL.');
Qiang Xue committed
552
			}
Qiang Xue committed
553 554 555 556 557 558 559 560 561 562 563 564
		}
		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
565
		$this->_scriptUrl = '/' . trim($value, '/');
Qiang Xue committed
566 567
	}

Qiang Xue committed
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
	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
592 593
	private $_pathInfo;

Qiang Xue committed
594 595
	/**
	 * Returns the path info of the currently requested URL.
Qiang Xue committed
596 597
	 * 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
598
	 * @return string part of the request URL that is after the entry script and before the question mark.
Qiang Xue committed
599
	 * Note, the returned path info is already URL-decoded.
Qiang Xue committed
600
	 * @throws InvalidConfigException if the path info cannot be determined due to unexpected server configuration
Qiang Xue committed
601 602 603
	 */
	public function getPathInfo()
	{
Qiang Xue committed
604
		if ($this->_pathInfo === null) {
Qiang Xue committed
605 606 607 608
			$this->_pathInfo = $this->resolvePathInfo();
		}
		return $this->_pathInfo;
	}
Qiang Xue committed
609

Qiang Xue committed
610 611 612 613 614
	/**
	 * 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
615 616
	public function setPathInfo($value)
	{
Qiang Xue committed
617
		$this->_pathInfo = ltrim($value, '/');
Qiang Xue committed
618 619
	}

Qiang Xue committed
620 621 622
	/**
	 * 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
623
	 * The starting slashes are both removed (ending slashes will be kept).
Qiang Xue committed
624 625
	 * @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
626
	 * @throws InvalidConfigException if the path info cannot be determined due to unexpected server configuration
Qiang Xue committed
627 628 629
	 */
	protected function resolvePathInfo()
	{
Qiang Xue committed
630
		$pathInfo = $this->getUrl();
Qiang Xue committed
631

Qiang Xue committed
632 633 634
		if (($pos = strpos($pathInfo, '?')) !== false) {
			$pathInfo = substr($pathInfo, 0, $pos);
		}
Qiang Xue committed
635

Qiang Xue committed
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
		$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
652

Qiang Xue committed
653 654 655 656 657 658
		$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));
Qiang Xue committed
659
		} elseif (isset($_SERVER['PHP_SELF']) && strpos($_SERVER['PHP_SELF'], $scriptUrl) === 0) {
Qiang Xue committed
660 661
			$pathInfo = substr($_SERVER['PHP_SELF'], strlen($scriptUrl));
		} else {
Qiang Xue committed
662
			throw new InvalidConfigException('Unable to determine the path info of the current request.');
Qiang Xue committed
663
		}
Qiang Xue committed
664

665
		if ($pathInfo[0] === '/') {
666 667 668
			$pathInfo = substr($pathInfo, 1);
		}

669
		return (string)$pathInfo;
Qiang Xue committed
670 671
	}

Qiang Xue committed
672
	/**
Qiang Xue committed
673 674 675
	 * 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
676
	 */
Qiang Xue committed
677
	public function getAbsoluteUrl()
Qiang Xue committed
678
	{
Qiang Xue committed
679
		return $this->getHostInfo() . $this->getUrl();
Qiang Xue committed
680 681
	}

Qiang Xue committed
682
	private $_url;
Qiang Xue committed
683

Qiang Xue committed
684
	/**
Qiang Xue committed
685 686 687 688 689
	 * 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
690
	 */
Qiang Xue committed
691
	public function getUrl()
Qiang Xue committed
692
	{
Qiang Xue committed
693 694
		if ($this->_url === null) {
			$this->_url = $this->resolveRequestUri();
Qiang Xue committed
695
		}
Qiang Xue committed
696
		return $this->_url;
Qiang Xue committed
697 698
	}

Qiang Xue committed
699
	/**
Qiang Xue committed
700
	 * Sets the currently requested relative URL.
Qiang Xue committed
701 702 703 704
	 * 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
705
	public function setUrl($value)
Qiang Xue committed
706
	{
Qiang Xue committed
707
		$this->_url = $value;
Qiang Xue committed
708 709
	}

Qiang Xue committed
710 711 712 713 714 715
	/**
	 * 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
716
	 * @throws InvalidConfigException if the request URI cannot be determined due to unusual server configuration
Qiang Xue committed
717 718 719 720 721 722 723
	 */
	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
724
			if ($requestUri !== '' && $requestUri[0] !== '/') {
Qiang Xue committed
725 726 727 728 729 730 731 732
				$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
733
			throw new InvalidConfigException('Unable to determine the request URI.');
Qiang Xue committed
734 735 736 737
		}
		return $requestUri;
	}

Qiang Xue committed
738 739 740 741 742 743
	/**
	 * 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
744
		return isset($_SERVER['QUERY_STRING']) ? $_SERVER['QUERY_STRING'] : '';
Qiang Xue committed
745 746 747 748 749 750 751 752
	}

	/**
	 * Return if the request is sent via secure channel (https).
	 * @return boolean if the request is sent via secure channel (https)
	 */
	public function getIsSecureConnection()
	{
753 754
		return isset($_SERVER['HTTPS']) && (strcasecmp($_SERVER['HTTPS'], 'on') === 0 || $_SERVER['HTTPS'] == 1)
			|| isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && strcasecmp($_SERVER['HTTP_X_FORWARDED_PROTO'], 'https') === 0;
Qiang Xue committed
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
	}

	/**
	 * 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
772
		return (int)$_SERVER['SERVER_PORT'];
Qiang Xue committed
773 774 775 776 777 778
	}

	/**
	 * Returns the URL referrer, null if not present
	 * @return string URL referrer, null if not present
	 */
Qiang Xue committed
779
	public function getReferrer()
Qiang Xue committed
780
	{
Qiang Xue committed
781
		return isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : null;
Qiang Xue committed
782 783 784 785 786 787 788 789
	}

	/**
	 * Returns the user agent, null if not present.
	 * @return string user agent, null if not present
	 */
	public function getUserAgent()
	{
Qiang Xue committed
790
		return isset($_SERVER['HTTP_USER_AGENT']) ? $_SERVER['HTTP_USER_AGENT'] : null;
Qiang Xue committed
791 792 793 794 795 796
	}

	/**
	 * Returns the user IP address.
	 * @return string user IP address
	 */
797
	public function getUserIP()
Qiang Xue committed
798
	{
Qiang Xue committed
799
		return isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : '127.0.0.1';
Qiang Xue committed
800 801 802 803 804 805 806 807
	}

	/**
	 * 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
808
		return isset($_SERVER['REMOTE_HOST']) ? $_SERVER['REMOTE_HOST'] : null;
Qiang Xue committed
809 810 811 812
	}

	private $_port;

Qiang Xue committed
813
	/**
Qiang Xue committed
814 815 816 817
	 * 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.
Taras Gudz committed
818
	 * @see setPort()
Qiang Xue committed
819 820 821
	 */
	public function getPort()
	{
Qiang Xue committed
822 823 824
		if ($this->_port === null) {
			$this->_port = !$this->getIsSecureConnection() && isset($_SERVER['SERVER_PORT']) ? (int)$_SERVER['SERVER_PORT'] : 80;
		}
Qiang Xue committed
825 826 827 828 829 830 831 832 833 834 835
		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
836 837 838 839
		if ($value != $this->_port) {
			$this->_port = (int)$value;
			$this->_hostInfo = null;
		}
Qiang Xue committed
840 841 842 843 844 845 846 847 848
	}

	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.
Taras Gudz committed
849
	 * @see setSecurePort()
Qiang Xue committed
850 851 852
	 */
	public function getSecurePort()
	{
Qiang Xue committed
853 854 855
		if ($this->_securePort === null) {
			$this->_securePort = $this->getIsSecureConnection() && isset($_SERVER['SERVER_PORT']) ? (int)$_SERVER['SERVER_PORT'] : 443;
		}
Qiang Xue committed
856 857 858 859 860 861 862 863 864 865 866
		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
867 868 869
		if ($value != $this->_securePort) {
			$this->_securePort = (int)$value;
			$this->_hostInfo = null;
Qiang Xue committed
870
		}
Qiang Xue committed
871 872
	}

873
	private $_contentTypes;
Qiang Xue committed
874 875

	/**
876
	 * Returns the content types acceptable by the end user.
877 878 879
	 * 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
880
	 */
881
	public function getAcceptableContentTypes()
Qiang Xue committed
882
	{
883 884 885 886
		if ($this->_contentTypes === null) {
			if (isset($_SERVER['HTTP_ACCEPT'])) {
				$this->_contentTypes = $this->parseAcceptHeader($_SERVER['HTTP_ACCEPT']);
			} else {
Alexander Makarov committed
887
				$this->_contentTypes = [];
888 889 890 891 892 893
			}
		}
		return $this->_contentTypes;
	}

	/**
894
	 * @param array $value the content types that are acceptable by the end user. They should
895 896
	 * be ordered by the preference level.
	 */
897
	public function setAcceptableContentTypes($value)
898 899 900 901
	{
		$this->_contentTypes = $value;
	}

902
	/**
903
	 * Returns request content-type
Qiang Xue committed
904 905 906 907 908 909 910
	 * The Content-Type header field indicates the MIME type of the data
	 * contained in [[getRawBody()]] or, in the case of the HEAD method, the
	 * media type that would have been sent had the request been a GET.
	 * For the MIME-types the user expects in response, see [[acceptableContentTypes]].
	 * @return string request content-type. Null is returned if this information is not available.
	 * @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
	 * HTTP 1.1 header field definitions
911 912 913 914 915 916
	 */
	public function getContentType()
	{
		return isset($_SERVER["CONTENT_TYPE"]) ? $_SERVER["CONTENT_TYPE"] : null;
	}

917 918 919
	private $_languages;

	/**
920
	 * Returns the languages acceptable by the end user.
921 922 923 924
	 * 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.
	 */
925
	public function getAcceptableLanguages()
926 927 928 929 930
	{
		if ($this->_languages === null) {
			if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
				$this->_languages = $this->parseAcceptHeader($_SERVER['HTTP_ACCEPT_LANGUAGE']);
			} else {
Alexander Makarov committed
931
				$this->_languages = [];
932 933 934 935 936 937
			}
		}
		return $this->_languages;
	}

	/**
938
	 * @param array $value the languages that are acceptable by the end user. They should
939 940
	 * be ordered by the preference level.
	 */
941
	public function setAcceptableLanguages($value)
942 943 944 945 946 947
	{
		$this->_languages = $value;
	}

	/**
	 * Parses the given `Accept` (or `Accept-Language`) header.
948
	 * This method will return the acceptable values ordered by their preference level.
949 950 951 952 953
	 * @param string $header the header to be parsed
	 * @return array the accept values ordered by their preference level.
	 */
	protected function parseAcceptHeader($header)
	{
Alexander Makarov committed
954
		$accepts = [];
955 956 957
		$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])) {
pzaremba committed
958
				$accepts[] = [$matches[$i][1], isset($matches[$i][2]) ? (float)$matches[$i][2] : 1, $i];
959 960 961 962 963 964 965 966 967 968 969 970 971
			}
		}
		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
972
			} else {
973 974 975 976 977 978 979
				$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
980
			}
981
		});
Alexander Makarov committed
982
		$result = [];
983 984
		foreach ($accepts as $accept) {
			$result[] = $accept[0];
Qiang Xue committed
985
		}
986
		return array_unique($result);
Qiang Xue committed
987 988 989
	}

	/**
990 991 992
	 * 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.
993 994 995
	 * @param array $languages a list of the languages supported by the application. If this is empty, the current
	 * application language will be returned without further processing.
	 * @return string the language that the application should use.
Qiang Xue committed
996
	 */
997
	public function getPreferredLanguage(array $languages = [])
Qiang Xue committed
998
	{
999
		if (empty($languages)) {
1000
			return Yii::$app->language;
1001
		}
1002 1003
		foreach ($this->getAcceptableLanguages() as $acceptableLanguage) {
			$acceptableLanguage = str_replace('_', '-', strtolower($acceptableLanguage));
1004
			foreach ($languages as $language) {
1005 1006
				$language = str_replace('_', '-', strtolower($language));
				// en-us==en-us, en==en-us, en-us==en
1007
				if ($language === $acceptableLanguage || strpos($acceptableLanguage, $language . '-') === 0 || strpos($language, $acceptableLanguage . '-') === 0) {
1008 1009 1010 1011 1012
					return $language;
				}
			}
		}
		return reset($languages);
Qiang Xue committed
1013 1014 1015
	}

	/**
Qiang Xue committed
1016
	 * Returns the cookie collection.
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
	 * 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
1030
	 */
Qiang Xue committed
1031
	public function getCookies()
Qiang Xue committed
1032
	{
1033
		if ($this->_cookies === null) {
Alexander Makarov committed
1034
			$this->_cookies = new CookieCollection($this->loadCookies(), [
Qiang Xue committed
1035
				'readOnly' => true,
Alexander Makarov committed
1036
			]);
1037 1038 1039
		}
		return $this->_cookies;
	}
Qiang Xue committed
1040

Qiang Xue committed
1041 1042 1043 1044 1045 1046
	/**
	 * Converts `$_COOKIE` into an array of [[Cookie]].
	 * @return array the cookies obtained from request
	 */
	protected function loadCookies()
	{
Alexander Makarov committed
1047
		$cookies = [];
Qiang Xue committed
1048 1049 1050
		if ($this->enableCookieValidation) {
			$key = $this->getCookieValidationKey();
			foreach ($_COOKIE as $name => $value) {
1051
				if (is_string($value) && ($value = Security::validateData($value, $key)) !== false) {
Alexander Makarov committed
1052
					$cookies[$name] = new Cookie([
Qiang Xue committed
1053 1054
						'name' => $name,
						'value' => @unserialize($value),
Alexander Makarov committed
1055
					]);
Qiang Xue committed
1056 1057 1058 1059
				}
			}
		} else {
			foreach ($_COOKIE as $name => $value) {
Alexander Makarov committed
1060
				$cookies[$name] = new Cookie([
Qiang Xue committed
1061 1062
					'name' => $name,
					'value' => $value,
Alexander Makarov committed
1063
				]);
Qiang Xue committed
1064 1065 1066 1067 1068 1069 1070 1071
			}
		}
		return $cookies;
	}

	private $_cookieValidationKey;

	/**
1072
	 * @return string the secret key used for cookie validation. If it was not set previously,
Qiang Xue committed
1073 1074 1075 1076 1077
	 * a random key will be generated and used.
	 */
	public function getCookieValidationKey()
	{
		if ($this->_cookieValidationKey === null) {
1078
			$this->_cookieValidationKey = Security::getSecretKey(__CLASS__ . '/' . Yii::$app->id);
Qiang Xue committed
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
		}
		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;
	}

1092 1093 1094 1095
	/**
	 * @var Cookie
	 */
	private $_csrfCookie;
Qiang Xue committed
1096 1097

	/**
1098 1099
	 * Returns the unmasked random token used to perform CSRF validation.
	 * This token is typically sent via a cookie. If such a cookie does not exist, a new token will be generated.
Qiang Xue committed
1100 1101 1102
	 * @return string the random token for CSRF validation.
	 * @see enableCsrfValidation
	 */
1103
	public function getRawCsrfToken()
Qiang Xue committed
1104
	{
1105
		if ($this->_csrfCookie === null) {
1106
			$this->_csrfCookie = $this->getCookies()->get($this->csrfVar);
1107 1108
			if ($this->_csrfCookie === null) {
				$this->_csrfCookie = $this->createCsrfCookie();
1109
				Yii::$app->getResponse()->getCookies()->add($this->_csrfCookie);
Qiang Xue committed
1110 1111 1112
			}
		}

1113
		return $this->_csrfCookie->value;
Qiang Xue committed
1114 1115
	}

1116
	private $_csrfToken;
1117 1118

	/**
1119 1120 1121 1122 1123 1124 1125
	 * Returns the token used to perform CSRF validation.
	 *
	 * This token is a masked version of [[rawCsrfToken]] to prevent [BREACH attacks](http://breachattack.com/).
	 * This token may be passed along via a hidden field of an HTML form or an HTTP header value
	 * to support CSRF validation.
	 *
	 * @return string the token used to perform CSRF validation.
1126
	 */
1127
	public function getCsrfToken()
1128
	{
1129 1130 1131 1132 1133 1134
		if ($this->_csrfToken === null) {
			// the mask doesn't need to be very random
			$chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_-.';
			$mask = substr(str_shuffle(str_repeat($chars, 5)), 0, self::CSRF_MASK_LENGTH);

			$token = $this->getRawCsrfToken();
1135
			// The + sign may be decoded as blank space later, which will fail the validation
1136
			$this->_csrfToken = str_replace('+', '.', base64_encode($mask . $this->xorTokens($token, $mask)));
1137
		}
1138
		return $this->_csrfToken;
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
	}

	/**
	 * Returns the XOR result of two strings.
	 * If the two strings are of different lengths, the shorter one will be padded to the length of the longer one.
	 * @param string $token1
	 * @param string $token2
	 * @return string the XOR result
	 */
	private function xorTokens($token1, $token2)
	{
		$n1 = StringHelper::byteLength($token1);
		$n2 = StringHelper::byteLength($token2);
		if ($n1 > $n2) {
			$token2 = str_pad($token2, $n1, $token2);
		} elseif ($n1 < $n2) {
			$token1 = str_pad($token1, $n2, $token1);
		}
		return $token1 ^ $token2;
	}

1160 1161 1162 1163 1164
	/**
	 * @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
1165 1166
		$key = 'HTTP_' . str_replace('-', '_', strtoupper(self::CSRF_HEADER));
		return isset($_SERVER[$key]) ? $_SERVER[$key] : null;
1167 1168
	}

Qiang Xue committed
1169 1170 1171 1172 1173 1174 1175 1176 1177
	/**
	 * 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;
1178
		$options['name'] = $this->csrfVar;
1179
		$options['value'] = Security::generateRandomKey();
Qiang Xue committed
1180 1181 1182 1183 1184 1185 1186
		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.
1187
	 * This method is called in [[Controller::beforeAction()]].
Qiang Xue committed
1188
	 * @return boolean whether CSRF token is valid. If [[enableCsrfValidation]] is false, this method will return true.
Qiang Xue committed
1189 1190 1191
	 */
	public function validateCsrfToken()
	{
1192
		$method = $this->getMethod();
Carsten Brandt committed
1193
		// only validate CSRF token on non-"safe" methods http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1.1
1194
		if (!$this->enableCsrfValidation || in_array($method, ['GET', 'HEAD', 'OPTIONS'], true)) {
Qiang Xue committed
1195
			return true;
Qiang Xue committed
1196
		}
1197
		$trueToken = $this->getCookies()->getValue($this->csrfVar);
1198
		$token = $this->getBodyParam($this->csrfVar);
1199 1200
		return $this->validateCsrfTokenInternal($token, $trueToken)
			|| $this->validateCsrfTokenInternal($this->getCsrfTokenFromHeader(), $trueToken);
1201 1202 1203 1204
	}

	private function validateCsrfTokenInternal($token, $trueToken)
	{
Qiang Xue committed
1205
		$token = base64_decode(str_replace('.', '+', $token));
1206 1207 1208 1209 1210 1211 1212 1213
		$n = StringHelper::byteLength($token);
		if ($n <= self::CSRF_MASK_LENGTH) {
			return false;
		}
		$mask = StringHelper::byteSubstr($token, 0, self::CSRF_MASK_LENGTH);
		$token = StringHelper::byteSubstr($token, self::CSRF_MASK_LENGTH, $n - self::CSRF_MASK_LENGTH);
		$token = $this->xorTokens($mask, $token);
		return $token === $trueToken;
Qiang Xue committed
1214
	}
Qiang Xue committed
1215
}