Request.php 37.9 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\base\InvalidParamException;
13
use yii\helpers\Json;
14
use yii\helpers\Security;
15
use yii\helpers\StringHelper;
Qiang Xue committed
16

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

Qiang Xue committed
93

Qiang Xue committed
94
	/**
95
	 * @var boolean whether to enable CSRF (Cross-Site Request Forgery) validation. Defaults to true.
96
	 * When CSRF validation is enabled, forms submitted to an Yii Web application must be originated
Qiang Xue committed
97 98 99
	 * 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,
100
	 * forms submitted via POST method must contain a hidden input whose name is specified by [[csrfVar]].
Qiang Xue committed
101
	 * You may use [[\yii\web\Html::beginForm()]] to generate his hidden input.
102 103 104 105
	 *
	 * 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.
	 *
106
	 * @see Controller::enableCsrfValidation
Qiang Xue committed
107 108
	 * @see http://en.wikipedia.org/wiki/Cross-site_request_forgery
	 */
109
	public $enableCsrfValidation = true;
Qiang Xue committed
110
	/**
111
	 * @var string the name of the token used to prevent CSRF. Defaults to '_csrf'.
112
	 * This property is used only when [[enableCsrfValidation]] is true.
Qiang Xue committed
113
	 */
114
	public $csrfVar = '_csrf';
Qiang Xue committed
115 116 117 118
	/**
	 * @var array the configuration of the CSRF cookie. This property is used only when [[enableCsrfValidation]] is true.
	 * @see Cookie
	 */
Alexander Makarov committed
119
	public $csrfCookie = ['httpOnly' => true];
Qiang Xue committed
120
	/**
Qiang Xue committed
121
	 * @var boolean whether cookies should be validated to ensure they are not tampered. Defaults to true.
Qiang Xue committed
122
	 */
Qiang Xue committed
123
	public $enableCookieValidation = true;
Qiang Xue committed
124
	/**
125
	 * @var string|boolean the name of the POST parameter that is used to indicate if a request is a PUT, PATCH or DELETE
126
	 * request tunneled through POST. Default to '_method'.
Taras Gudz committed
127 128
	 * @see getMethod()
	 * @see getRestParams()
Qiang Xue committed
129 130
	 */
	public $restVar = '_method';
Qiang Xue committed
131 132 133

	private $_cookies;

Qiang Xue committed
134

Qiang Xue committed
135 136 137 138 139 140 141 142 143 144
	/**
	 * 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;
145
			$_GET = array_merge($_GET, $params);
Alexander Makarov committed
146
			return [$route, $_GET];
Qiang Xue committed
147
		} else {
148
			throw new NotFoundHttpException(Yii::t('yii', 'Page not found.'));
Qiang Xue committed
149 150 151
		}
	}

Qiang Xue committed
152
	/**
153 154
	 * 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
155 156
	 * The value returned is turned into upper case.
	 */
157
	public function getMethod()
Qiang Xue committed
158
	{
159
		if (isset($_POST[$this->restVar])) {
Qiang Xue committed
160
			return strtoupper($_POST[$this->restVar]);
Qiang Xue committed
161 162 163 164 165
		} else {
			return isset($_SERVER['REQUEST_METHOD']) ? strtoupper($_SERVER['REQUEST_METHOD']) : 'GET';
		}
	}

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
	/**
	 * 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';
	}
183

184 185 186 187 188 189 190 191
	/**
	 * Returns whether this is a HEAD request.
	 * @return boolean whether this is a HEAD request.
	 */
	public function getIsHead()
	{
		return $this->getMethod() === 'HEAD';
	}
192

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

	/**
	 * Returns whether this is a DELETE request.
	 * @return boolean whether this is a DELETE request.
	 */
Qiang Xue committed
206
	public function getIsDelete()
Qiang Xue committed
207
	{
208
		return $this->getMethod() === 'DELETE';
Qiang Xue committed
209 210 211 212 213 214
	}

	/**
	 * Returns whether this is a PUT request.
	 * @return boolean whether this is a PUT request.
	 */
Qiang Xue committed
215
	public function getIsPut()
Qiang Xue committed
216
	{
217
		return $this->getMethod() === 'PUT';
Qiang Xue committed
218 219
	}

220 221 222 223 224 225 226 227 228
	/**
	 * 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
229 230 231 232
	/**
	 * Returns whether this is an AJAX (XMLHttpRequest) request.
	 * @return boolean whether this is an AJAX (XMLHttpRequest) request.
	 */
Qiang Xue committed
233
	public function getIsAjax()
Qiang Xue committed
234 235 236 237 238
	{
		return isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] === 'XMLHttpRequest';
	}

	/**
Qiang Xue committed
239
	 * Returns whether this is an Adobe Flash or Flex request.
Qiang Xue committed
240 241
	 * @return boolean whether this is an Adobe Flash or Adobe Flex request.
	 */
Qiang Xue committed
242
	public function getIsFlash()
Qiang Xue committed
243 244 245 246 247 248 249 250 251 252
	{
		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
Taras Gudz committed
253
	 * @see getMethod()
Qiang Xue committed
254 255 256 257
	 */
	public function getRestParams()
	{
		if ($this->_restParams === null) {
258
			if (isset($_POST[$this->restVar])) {
Qiang Xue committed
259
				$this->_restParams = $_POST;
260 261
			} elseif(strncmp($this->getContentType(), 'application/json', 16) === 0) {
				$this->_restParams = Json::decode($this->getRawBody(), true);
Qiang Xue committed
262
			} else {
Alexander Makarov committed
263
				$this->_restParams = [];
264
				mb_parse_str($this->getRawBody(), $this->_restParams);
Qiang Xue committed
265 266 267 268 269
			}
		}
		return $this->_restParams;
	}

Qiang Xue committed
270 271 272 273 274 275 276 277 278 279 280 281 282 283
	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
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
	/**
	 * 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
305 306 307
	/**
	 * Returns the named GET parameter value.
	 * If the GET parameter does not exist, the second parameter to this method will be returned.
308
	 * @param string $name the GET parameter name. If not specified, whole $_GET is returned.
Qiang Xue committed
309 310
	 * @param mixed $defaultValue the default parameter value if the GET parameter does not exist.
	 * @return mixed the GET parameter value
Taras Gudz committed
311
	 * @see getPost()
Qiang Xue committed
312
	 */
313
	public function get($name = null, $defaultValue = null)
Qiang Xue committed
314
	{
315 316 317
		if ($name === null) {
			return $_GET;
		}
Qiang Xue committed
318 319 320 321 322 323
		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.
324
	 * @param string $name the POST parameter name. If not specified, whole $_POST is returned.
Qiang Xue committed
325
	 * @param mixed $defaultValue the default parameter value if the POST parameter does not exist.
326
	 * @property array the POST request parameter values
Qiang Xue committed
327
	 * @return mixed the POST parameter value
Taras Gudz committed
328
	 * @see get()
Qiang Xue committed
329
	 */
330
	public function getPost($name = null, $defaultValue = null)
Qiang Xue committed
331
	{
332 333 334
		if ($name === null) {
			return $_POST;
		}
Qiang Xue committed
335 336 337 338 339
		return isset($_POST[$name]) ? $_POST[$name] : $defaultValue;
	}

	/**
	 * Returns the named DELETE parameter value.
340
	 * @param string $name the DELETE parameter name. If not specified, an array of DELETE parameters is returned.
Qiang Xue committed
341
	 * @param mixed $defaultValue the default parameter value if the DELETE parameter does not exist.
342
	 * @property array the DELETE request parameter values
Qiang Xue committed
343 344
	 * @return mixed the DELETE parameter value
	 */
345
	public function getDelete($name = null, $defaultValue = null)
Qiang Xue committed
346
	{
347 348 349
		if ($name === null) {
			return $this->getRestParams();
		}
Qiang Xue committed
350
		return $this->getIsDelete() ? $this->getRestParam($name, $defaultValue) : null;
Qiang Xue committed
351 352 353 354
	}

	/**
	 * Returns the named PUT parameter value.
355
	 * @param string $name the PUT parameter name. If not specified, an array of PUT parameters is returned.
Qiang Xue committed
356
	 * @param mixed $defaultValue the default parameter value if the PUT parameter does not exist.
357
	 * @property array the PUT request parameter values
Qiang Xue committed
358 359
	 * @return mixed the PUT parameter value
	 */
360
	public function getPut($name = null, $defaultValue = null)
Qiang Xue committed
361
	{
362 363 364
		if ($name === null) {
			return $this->getRestParams();
		}
Qiang Xue committed
365
		return $this->getIsPut() ? $this->getRestParam($name, $defaultValue) : null;
Qiang Xue committed
366 367
	}

368 369
	/**
	 * Returns the named PATCH parameter value.
370
	 * @param string $name the PATCH parameter name. If not specified, an array of PATCH parameters is returned.
371
	 * @param mixed $defaultValue the default parameter value if the PATCH parameter does not exist.
372
	 * @property array the PATCH request parameter values
373 374
	 * @return mixed the PATCH parameter value
	 */
375
	public function getPatch($name = null, $defaultValue = null)
376
	{
377 378 379
		if ($name === null) {
			return $this->getRestParams();
		}
380 381 382
		return $this->getIsPatch() ? $this->getRestParam($name, $defaultValue) : null;
	}

Qiang Xue committed
383 384
	private $_hostInfo;

Qiang Xue committed
385
	/**
Qiang Xue committed
386
	 * Returns the schema and host part of the current request URL.
Qiang Xue committed
387 388
	 * The returned URL does not have an ending slash.
	 * By default this is determined based on the user request information.
Qiang Xue committed
389 390
	 * 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
391
	 * @see setHostInfo()
Qiang Xue committed
392
	 */
Qiang Xue committed
393
	public function getHostInfo()
Qiang Xue committed
394
	{
Qiang Xue committed
395
		if ($this->_hostInfo === null) {
Qiang Xue committed
396 397
			$secure = $this->getIsSecureConnection();
			$http = $secure ? 'https' : 'http';
Qiang Xue committed
398 399 400 401 402 403 404 405
			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
406 407 408
			}
		}

Qiang Xue committed
409
		return $this->_hostInfo;
Qiang Xue committed
410 411 412 413 414 415
	}

	/**
	 * 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
416
	 * @param string $value the schema and host part of the application URL. The trailing slashes will be removed.
Qiang Xue committed
417 418 419
	 */
	public function setHostInfo($value)
	{
Qiang Xue committed
420
		$this->_hostInfo = rtrim($value, '/');
Qiang Xue committed
421 422
	}

Qiang Xue committed
423 424
	private $_baseUrl;

Qiang Xue committed
425 426
	/**
	 * Returns the relative URL for the application.
Qiang Xue committed
427 428
	 * This is similar to [[scriptUrl]] except that it does not include the script file name,
	 * and the ending slashes are removed.
Qiang Xue committed
429
	 * @return string the relative URL for the application
Taras Gudz committed
430
	 * @see setScriptUrl()
Qiang Xue committed
431
	 */
Qiang Xue committed
432
	public function getBaseUrl()
Qiang Xue committed
433
	{
Qiang Xue committed
434 435 436
		if ($this->_baseUrl === null) {
			$this->_baseUrl = rtrim(dirname($this->getScriptUrl()), '\\/');
		}
Qiang Xue committed
437
		return $this->_baseUrl;
Qiang Xue committed
438 439 440 441 442 443 444 445 446 447
	}

	/**
	 * 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
448
		$this->_baseUrl = $value;
Qiang Xue committed
449 450
	}

Qiang Xue committed
451 452
	private $_scriptUrl;

Qiang Xue committed
453 454 455 456
	/**
	 * 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
457
	 * @throws InvalidConfigException if unable to determine the entry script URL
Qiang Xue committed
458 459 460
	 */
	public function getScriptUrl()
	{
Qiang Xue committed
461
		if ($this->_scriptUrl === null) {
Qiang Xue committed
462 463
			$scriptFile = $this->getScriptFile();
			$scriptName = basename($scriptFile);
Qiang Xue committed
464 465
			if (basename($_SERVER['SCRIPT_NAME']) === $scriptName) {
				$this->_scriptUrl = $_SERVER['SCRIPT_NAME'];
Qiang Xue committed
466 467 468 469 470 471
			} 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
472 473
			} elseif (isset($_SERVER['DOCUMENT_ROOT']) && strpos($scriptFile, $_SERVER['DOCUMENT_ROOT']) === 0) {
				$this->_scriptUrl = str_replace('\\', '/', str_replace($_SERVER['DOCUMENT_ROOT'], '', $scriptFile));
Qiang Xue committed
474
			} else {
Qiang Xue committed
475
				throw new InvalidConfigException('Unable to determine the entry script URL.');
Qiang Xue committed
476
			}
Qiang Xue committed
477 478 479 480 481 482 483 484 485 486 487 488
		}
		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
489
		$this->_scriptUrl = '/' . trim($value, '/');
Qiang Xue committed
490 491
	}

Qiang Xue committed
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
	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
516 517
	private $_pathInfo;

Qiang Xue committed
518 519
	/**
	 * Returns the path info of the currently requested URL.
Qiang Xue committed
520 521
	 * 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
522
	 * @return string part of the request URL that is after the entry script and before the question mark.
Qiang Xue committed
523
	 * Note, the returned path info is already URL-decoded.
Qiang Xue committed
524
	 * @throws InvalidConfigException if the path info cannot be determined due to unexpected server configuration
Qiang Xue committed
525 526 527
	 */
	public function getPathInfo()
	{
Qiang Xue committed
528
		if ($this->_pathInfo === null) {
Qiang Xue committed
529 530 531 532
			$this->_pathInfo = $this->resolvePathInfo();
		}
		return $this->_pathInfo;
	}
Qiang Xue committed
533

Qiang Xue committed
534 535 536 537 538
	/**
	 * 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
539 540
	public function setPathInfo($value)
	{
Qiang Xue committed
541
		$this->_pathInfo = ltrim($value, '/');
Qiang Xue committed
542 543
	}

Qiang Xue committed
544 545 546
	/**
	 * 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
547
	 * The starting slashes are both removed (ending slashes will be kept).
Qiang Xue committed
548 549
	 * @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
550
	 * @throws InvalidConfigException if the path info cannot be determined due to unexpected server configuration
Qiang Xue committed
551 552 553
	 */
	protected function resolvePathInfo()
	{
Qiang Xue committed
554
		$pathInfo = $this->getUrl();
Qiang Xue committed
555

Qiang Xue committed
556 557 558
		if (($pos = strpos($pathInfo, '?')) !== false) {
			$pathInfo = substr($pathInfo, 0, $pos);
		}
Qiang Xue committed
559

Qiang Xue committed
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
		$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
576

Qiang Xue committed
577 578 579 580 581 582
		$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
583
		} elseif (isset($_SERVER['PHP_SELF']) && strpos($_SERVER['PHP_SELF'], $scriptUrl) === 0) {
Qiang Xue committed
584 585
			$pathInfo = substr($_SERVER['PHP_SELF'], strlen($scriptUrl));
		} else {
Qiang Xue committed
586
			throw new InvalidConfigException('Unable to determine the path info of the current request.');
Qiang Xue committed
587
		}
Qiang Xue committed
588

589
		if ($pathInfo[0] === '/') {
590 591 592
			$pathInfo = substr($pathInfo, 1);
		}

593
		return (string)$pathInfo;
Qiang Xue committed
594 595
	}

Qiang Xue committed
596
	/**
Qiang Xue committed
597 598 599
	 * 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
600
	 */
Qiang Xue committed
601
	public function getAbsoluteUrl()
Qiang Xue committed
602
	{
Qiang Xue committed
603
		return $this->getHostInfo() . $this->getUrl();
Qiang Xue committed
604 605
	}

Qiang Xue committed
606
	private $_url;
Qiang Xue committed
607

Qiang Xue committed
608
	/**
Qiang Xue committed
609 610 611 612 613
	 * 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
614
	 */
Qiang Xue committed
615
	public function getUrl()
Qiang Xue committed
616
	{
Qiang Xue committed
617 618
		if ($this->_url === null) {
			$this->_url = $this->resolveRequestUri();
Qiang Xue committed
619
		}
Qiang Xue committed
620
		return $this->_url;
Qiang Xue committed
621 622
	}

Qiang Xue committed
623
	/**
Qiang Xue committed
624
	 * Sets the currently requested relative URL.
Qiang Xue committed
625 626 627 628
	 * 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
629
	public function setUrl($value)
Qiang Xue committed
630
	{
Qiang Xue committed
631
		$this->_url = $value;
Qiang Xue committed
632 633
	}

Qiang Xue committed
634 635 636 637 638 639
	/**
	 * 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
640
	 * @throws InvalidConfigException if the request URI cannot be determined due to unusual server configuration
Qiang Xue committed
641 642 643 644 645 646 647
	 */
	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
648
			if ($requestUri !== '' && $requestUri[0] !== '/') {
Qiang Xue committed
649 650 651 652 653 654 655 656
				$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
657
			throw new InvalidConfigException('Unable to determine the request URI.');
Qiang Xue committed
658 659 660 661
		}
		return $requestUri;
	}

Qiang Xue committed
662 663 664 665 666 667
	/**
	 * 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
668
		return isset($_SERVER['QUERY_STRING']) ? $_SERVER['QUERY_STRING'] : '';
Qiang Xue committed
669 670 671 672 673 674 675 676
	}

	/**
	 * Return if the request is sent via secure channel (https).
	 * @return boolean if the request is sent via secure channel (https)
	 */
	public function getIsSecureConnection()
	{
677
		return isset($_SERVER['HTTPS']) && (strcasecmp($_SERVER['HTTPS'], 'on') === 0 || $_SERVER['HTTPS'] == 1)
678
			|| isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && strcasecmp($_SERVER['HTTP_X_FORWARDED_PROTO'], 'https') === 0;
Qiang Xue committed
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
	}

	/**
	 * 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
696
		return (int)$_SERVER['SERVER_PORT'];
Qiang Xue committed
697 698 699 700 701 702
	}

	/**
	 * Returns the URL referrer, null if not present
	 * @return string URL referrer, null if not present
	 */
Qiang Xue committed
703
	public function getReferrer()
Qiang Xue committed
704
	{
Qiang Xue committed
705
		return isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : null;
Qiang Xue committed
706 707 708 709 710 711 712 713
	}

	/**
	 * Returns the user agent, null if not present.
	 * @return string user agent, null if not present
	 */
	public function getUserAgent()
	{
Qiang Xue committed
714
		return isset($_SERVER['HTTP_USER_AGENT']) ? $_SERVER['HTTP_USER_AGENT'] : null;
Qiang Xue committed
715 716 717 718 719 720
	}

	/**
	 * Returns the user IP address.
	 * @return string user IP address
	 */
721
	public function getUserIP()
Qiang Xue committed
722
	{
Qiang Xue committed
723
		return isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : '127.0.0.1';
Qiang Xue committed
724 725 726 727 728 729 730 731
	}

	/**
	 * 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
732
		return isset($_SERVER['REMOTE_HOST']) ? $_SERVER['REMOTE_HOST'] : null;
Qiang Xue committed
733 734 735 736
	}

	private $_port;

Qiang Xue committed
737
	/**
Qiang Xue committed
738 739 740 741
	 * 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
742
	 * @see setPort()
Qiang Xue committed
743 744 745
	 */
	public function getPort()
	{
Qiang Xue committed
746 747 748
		if ($this->_port === null) {
			$this->_port = !$this->getIsSecureConnection() && isset($_SERVER['SERVER_PORT']) ? (int)$_SERVER['SERVER_PORT'] : 80;
		}
Qiang Xue committed
749 750 751 752 753 754 755 756 757 758 759
		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
760 761 762 763
		if ($value != $this->_port) {
			$this->_port = (int)$value;
			$this->_hostInfo = null;
		}
Qiang Xue committed
764 765 766 767 768 769 770 771 772
	}

	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
773
	 * @see setSecurePort()
Qiang Xue committed
774 775 776
	 */
	public function getSecurePort()
	{
Qiang Xue committed
777 778 779
		if ($this->_securePort === null) {
			$this->_securePort = $this->getIsSecureConnection() && isset($_SERVER['SERVER_PORT']) ? (int)$_SERVER['SERVER_PORT'] : 443;
		}
Qiang Xue committed
780 781 782 783 784 785 786 787 788 789 790
		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
791 792 793
		if ($value != $this->_securePort) {
			$this->_securePort = (int)$value;
			$this->_hostInfo = null;
Qiang Xue committed
794
		}
Qiang Xue committed
795 796
	}

797
	private $_contentTypes;
Qiang Xue committed
798 799

	/**
800
	 * Returns the content types acceptable by the end user.
801 802 803
	 * 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
804
	 */
805
	public function getAcceptableContentTypes()
Qiang Xue committed
806
	{
807 808 809 810
		if ($this->_contentTypes === null) {
			if (isset($_SERVER['HTTP_ACCEPT'])) {
				$this->_contentTypes = $this->parseAcceptHeader($_SERVER['HTTP_ACCEPT']);
			} else {
Alexander Makarov committed
811
				$this->_contentTypes = [];
812 813 814 815 816 817
			}
		}
		return $this->_contentTypes;
	}

	/**
818
	 * @param array $value the content types that are acceptable by the end user. They should
819 820
	 * be ordered by the preference level.
	 */
821
	public function setAcceptableContentTypes($value)
822 823 824 825
	{
		$this->_contentTypes = $value;
	}

826
	/**
Qiang Xue committed
827 828 829 830 831 832 833 834
	 *  Returns request content-type
	 * 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
835 836 837 838 839 840
	 */
	public function getContentType()
	{
		return isset($_SERVER["CONTENT_TYPE"]) ? $_SERVER["CONTENT_TYPE"] : null;
	}

841 842 843
	private $_languages;

	/**
844
	 * Returns the languages acceptable by the end user.
845 846 847 848
	 * 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.
	 */
849
	public function getAcceptableLanguages()
850 851 852 853 854
	{
		if ($this->_languages === null) {
			if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
				$this->_languages = $this->parseAcceptHeader($_SERVER['HTTP_ACCEPT_LANGUAGE']);
			} else {
Alexander Makarov committed
855
				$this->_languages = [];
856 857 858 859 860 861
			}
		}
		return $this->_languages;
	}

	/**
862
	 * @param array $value the languages that are acceptable by the end user. They should
863 864
	 * be ordered by the preference level.
	 */
865
	public function setAcceptableLanguages($value)
866 867 868 869 870 871
	{
		$this->_languages = $value;
	}

	/**
	 * Parses the given `Accept` (or `Accept-Language`) header.
872
	 * This method will return the acceptable values ordered by their preference level.
873 874 875 876 877
	 * @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
878
		$accepts = [];
879 880 881
		$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])) {
Alexander Makarov committed
882
				$accepts[] = [$matches[$i][1], isset($matches[$i][2]) ? (float)$matches[$i][2] : 1, $i];
883 884 885 886 887 888 889 890 891 892 893 894 895
			}
		}
		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
896
			} else {
897 898 899 900 901 902 903
				$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
904
			}
905
		});
Alexander Makarov committed
906
		$result = [];
907 908
		foreach ($accepts as $accept) {
			$result[] = $accept[0];
Qiang Xue committed
909
		}
910
		return array_unique($result);
Qiang Xue committed
911 912 913
	}

	/**
914 915 916
	 * 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.
917 918 919
	 * @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
920
	 */
921
	public function getPreferredLanguage(array $languages = [])
Qiang Xue committed
922
	{
923
		if (empty($languages)) {
924
			return Yii::$app->language;
925
		}
926 927
		foreach ($this->getAcceptableLanguages() as $acceptableLanguage) {
			$acceptableLanguage = str_replace('_', '-', strtolower($acceptableLanguage));
928
			foreach ($languages as $language) {
929 930
				$language = str_replace('_', '-', strtolower($language));
				// en-us==en-us, en==en-us, en-us==en
931
				if ($language === $acceptableLanguage || strpos($acceptableLanguage, $language . '-') === 0 || strpos($language, $acceptableLanguage . '-') === 0) {
932 933 934 935 936
					return $language;
				}
			}
		}
		return reset($languages);
Qiang Xue committed
937 938 939
	}

	/**
Qiang Xue committed
940
	 * Returns the cookie collection.
941 942 943 944 945 946 947 948 949 950 951 952 953
	 * 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
954
	 */
Qiang Xue committed
955
	public function getCookies()
Qiang Xue committed
956
	{
957
		if ($this->_cookies === null) {
Alexander Makarov committed
958
			$this->_cookies = new CookieCollection($this->loadCookies(), [
Qiang Xue committed
959
				'readOnly' => true,
Alexander Makarov committed
960
			]);
961 962 963
		}
		return $this->_cookies;
	}
Qiang Xue committed
964

Qiang Xue committed
965 966 967 968 969 970
	/**
	 * Converts `$_COOKIE` into an array of [[Cookie]].
	 * @return array the cookies obtained from request
	 */
	protected function loadCookies()
	{
Alexander Makarov committed
971
		$cookies = [];
Qiang Xue committed
972 973 974
		if ($this->enableCookieValidation) {
			$key = $this->getCookieValidationKey();
			foreach ($_COOKIE as $name => $value) {
975
				if (is_string($value) && ($value = Security::validateData($value, $key)) !== false) {
Alexander Makarov committed
976
					$cookies[$name] = new Cookie([
Qiang Xue committed
977 978
						'name' => $name,
						'value' => @unserialize($value),
Alexander Makarov committed
979
					]);
Qiang Xue committed
980 981 982 983
				}
			}
		} else {
			foreach ($_COOKIE as $name => $value) {
Alexander Makarov committed
984
				$cookies[$name] = new Cookie([
Qiang Xue committed
985 986
					'name' => $name,
					'value' => $value,
Alexander Makarov committed
987
				]);
Qiang Xue committed
988 989 990 991 992 993 994 995
			}
		}
		return $cookies;
	}

	private $_cookieValidationKey;

	/**
996
	 * @return string the secret key used for cookie validation. If it was not set previously,
Qiang Xue committed
997 998 999 1000 1001
	 * a random key will be generated and used.
	 */
	public function getCookieValidationKey()
	{
		if ($this->_cookieValidationKey === null) {
1002
			$this->_cookieValidationKey = Security::getSecretKey(__CLASS__ . '/' . Yii::$app->id);
Qiang Xue committed
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
		}
		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;
	}

1016 1017 1018 1019
	/**
	 * @var Cookie
	 */
	private $_csrfCookie;
Qiang Xue committed
1020 1021

	/**
1022 1023
	 * 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
1024 1025 1026
	 * @return string the random token for CSRF validation.
	 * @see enableCsrfValidation
	 */
1027
	public function getRawCsrfToken()
Qiang Xue committed
1028
	{
1029
		if ($this->_csrfCookie === null) {
1030
			$this->_csrfCookie = $this->getCookies()->get($this->csrfVar);
1031 1032
			if ($this->_csrfCookie === null) {
				$this->_csrfCookie = $this->createCsrfCookie();
1033
				Yii::$app->getResponse()->getCookies()->add($this->_csrfCookie);
Qiang Xue committed
1034 1035 1036
			}
		}

1037
		return $this->_csrfCookie->value;
Qiang Xue committed
1038 1039
	}

1040
	private $_csrfToken;
1041 1042

	/**
1043 1044 1045 1046 1047 1048 1049
	 * 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.
1050
	 */
1051
	public function getCsrfToken()
1052
	{
1053 1054 1055 1056 1057 1058
		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();
1059
			// The + sign may be decoded as blank space later, which will fail the validation
1060
			$this->_csrfToken = str_replace('+', '.', base64_encode($mask . $this->xorTokens($token, $mask)));
1061
		}
1062
		return $this->_csrfToken;
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
	}

	/**
	 * 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;
	}

1084 1085 1086 1087 1088
	/**
	 * @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
1089 1090
		$key = 'HTTP_' . str_replace('-', '_', strtoupper(self::CSRF_HEADER));
		return isset($_SERVER[$key]) ? $_SERVER[$key] : null;
1091 1092
	}

Qiang Xue committed
1093 1094 1095 1096 1097 1098 1099 1100 1101
	/**
	 * 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;
1102
		$options['name'] = $this->csrfVar;
1103
		$options['value'] = Security::generateRandomKey();
Qiang Xue committed
1104 1105 1106 1107 1108 1109 1110
		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.
1111
	 * This method is called in [[Controller::beforeAction()]].
Qiang Xue committed
1112
	 * @return boolean whether CSRF token is valid. If [[enableCsrfValidation]] is false, this method will return true.
Qiang Xue committed
1113 1114 1115
	 */
	public function validateCsrfToken()
	{
1116
		$method = $this->getMethod();
Alexander Makarov committed
1117
		if (!$this->enableCsrfValidation || !in_array($method, ['POST', 'PUT', 'PATCH', 'DELETE'], true)) {
Qiang Xue committed
1118
			return true;
Qiang Xue committed
1119
		}
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
		$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;
		}
1135 1136 1137 1138 1139 1140
		return $this->validateCsrfTokenInternal($token, $trueToken)
			|| $this->validateCsrfTokenInternal($this->getCsrfTokenFromHeader(), $trueToken);
	}

	private function validateCsrfTokenInternal($token, $trueToken)
	{
Qiang Xue committed
1141
		$token = base64_decode(str_replace('.', '+', $token));
1142 1143 1144 1145 1146 1147 1148 1149
		$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
1150
	}
Qiang Xue committed
1151
}