Request.php 20.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
use Yii;
Qiang Xue committed
11
use yii\base\HttpException;
Qiang Xue committed
12
use yii\base\InvalidConfigException;
Qiang Xue committed
13

Qiang Xue committed
14 15
/**
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
16
 * @since 2.0
Qiang Xue committed
17
 */
Qiang Xue committed
18
class Request extends \yii\base\Request
Qiang Xue committed
19 20
{
	/**
Qiang Xue committed
21
	 * @var boolean whether cookies should be validated to ensure they are not tampered. Defaults to true.
Qiang Xue committed
22
	 */
Qiang Xue committed
23 24 25 26 27
	public $enableCookieValidation = true;
	/**
	 * @var string the secret key used for cookie validation. If not set, a random key will be generated and used.
	 */
	public $cookieValidationKey;
Qiang Xue committed
28 29 30 31 32 33 34 35
	/**
	 * @var string|boolean the name of the POST parameter that is used to indicate if a request is a PUT or DELETE
	 * request tunneled through POST. If false, it means disabling REST request tunneled through POST.
	 * Default to '_method'.
	 * @see getRequestMethod
	 * @see getRestParams
	 */
	public $restVar = '_method';
Qiang Xue committed
36 37 38

	private $_cookies;

Qiang Xue committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
	/**
	 * 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()
	{
		Yii::setAlias('@www', $this->getBaseUrl());

		$result = Yii::$app->getUrlManager()->parseRequest($this);
		if ($result !== false) {
			list ($route, $params) = $result;
			$params = array_merge($_GET, $params);
			return array($route, $params);
		} else {
			throw new HttpException(404, Yii::t('yii|Page not found.'));
		}
	}

Qiang Xue committed
58 59 60 61 62 63 64
	/**
	 * Returns the method of the current request (e.g. GET, POST, HEAD, PUT, DELETE).
	 * @return string request method, such as GET, POST, HEAD, PUT, DELETE.
	 * The value returned is turned into upper case.
	 */
	public function getRequestMethod()
	{
Qiang Xue committed
65 66
		if ($this->restVar !== false && isset($_POST[$this->restVar])) {
			return strtoupper($_POST[$this->restVar]);
Qiang Xue committed
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
		} else {
			return isset($_SERVER['REQUEST_METHOD']) ? strtoupper($_SERVER['REQUEST_METHOD']) : 'GET';
		}
	}

	/**
	 * Returns whether this is a POST request.
	 * @return boolean whether this is a POST request.
	 */
	public function getIsPostRequest()
	{
		return isset($_SERVER['REQUEST_METHOD']) && !strcasecmp($_SERVER['REQUEST_METHOD'], 'POST');
	}

	/**
	 * Returns whether this is a DELETE request.
	 * @return boolean whether this is a DELETE request.
	 */
	public function getIsDeleteRequest()
	{
		return $this->getRequestMethod() === 'DELETE';
	}

	/**
	 * Returns whether this is a PUT request.
	 * @return boolean whether this is a PUT request.
	 */
	public function getIsPutRequest()
	{
		return $this->getRequestMethod() === 'PUT';
	}

	/**
	 * Returns whether this is an AJAX (XMLHttpRequest) request.
	 * @return boolean whether this is an AJAX (XMLHttpRequest) request.
	 */
	public function getIsAjaxRequest()
	{
		return isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] === 'XMLHttpRequest';
	}

	/**
Qiang Xue committed
109
	 * Returns whether this is an Adobe Flash or Flex request.
Qiang Xue committed
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
	 * @return boolean whether this is an Adobe Flash or Adobe Flex request.
	 */
	public function getIsFlashRequest()
	{
		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
	 * @see getRequestMethod
	 */
	public function getRestParams()
	{
		if ($this->_restParams === null) {
Qiang Xue committed
128
			if ($this->restVar !== false && isset($_POST[$this->restVar])) {
Qiang Xue committed
129 130 131 132
				$this->_restParams = $_POST;
			} else {
				$this->_restParams = array();
				if (function_exists('mb_parse_str')) {
Qiang Xue committed
133
					mb_parse_str($this->getRawBody(), $this->_restParams);
Qiang Xue committed
134
				} else {
Qiang Xue committed
135
					parse_str($this->getRawBody(), $this->_restParams);
Qiang Xue committed
136 137 138 139 140 141
				}
			}
		}
		return $this->_restParams;
	}

Qiang Xue committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155
	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
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
	/**
	 * 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
177 178 179 180 181 182 183 184
	/**
	 * Returns the named GET parameter value.
	 * If the GET parameter does not exist, the second parameter to this method will be returned.
	 * @param string $name the GET parameter name
	 * @param mixed $defaultValue the default parameter value if the GET parameter does not exist.
	 * @return mixed the GET parameter value
	 * @see getPost
	 */
Qiang Xue committed
185
	public function getParam($name, $defaultValue = null)
Qiang Xue committed
186 187 188 189 190 191 192 193 194 195 196 197
	{
		return isset($_GET[$name]) ? $_GET[$name] : $defaultValue;
	}

	/**
	 * Returns the named POST parameter value.
	 * If the POST parameter does not exist, the second parameter to this method will be returned.
	 * @param string $name the POST parameter name
	 * @param mixed $defaultValue the default parameter value if the POST parameter does not exist.
	 * @return mixed the POST parameter value
	 * @see getParam
	 */
Qiang Xue committed
198
	public function getPost($name, $defaultValue = null)
Qiang Xue committed
199 200 201 202 203 204 205 206 207 208
	{
		return isset($_POST[$name]) ? $_POST[$name] : $defaultValue;
	}

	/**
	 * Returns the named DELETE parameter value.
	 * @param string $name the DELETE parameter name
	 * @param mixed $defaultValue the default parameter value if the DELETE parameter does not exist.
	 * @return mixed the DELETE parameter value
	 */
Qiang Xue committed
209
	public function getDelete($name, $defaultValue = null)
Qiang Xue committed
210
	{
Qiang Xue committed
211
		return $this->getIsDeleteRequest() ? $this->getRestParam($name, $defaultValue) : null;
Qiang Xue committed
212 213 214 215 216 217 218 219
	}

	/**
	 * Returns the named PUT parameter value.
	 * @param string $name the PUT parameter name
	 * @param mixed $defaultValue the default parameter value if the PUT parameter does not exist.
	 * @return mixed the PUT parameter value
	 */
Qiang Xue committed
220
	public function getPut($name, $defaultValue = null)
Qiang Xue committed
221
	{
Qiang Xue committed
222
		return $this->getIsPutRequest() ? $this->getRestParam($name, $defaultValue) : null;
Qiang Xue committed
223 224
	}

Qiang Xue committed
225 226
	private $_hostInfo;

Qiang Xue committed
227
	/**
Qiang Xue committed
228
	 * Returns the schema and host part of the current request URL.
Qiang Xue committed
229 230
	 * The returned URL does not have an ending slash.
	 * By default this is determined based on the user request information.
Qiang Xue committed
231 232
	 * You may explicitly specify it by setting the [[setHostInfo()|hostInfo]] property.
	 * @return string schema and hostname part (with port number if needed) of the request URL (e.g. `http://www.yiiframework.com`)
Qiang Xue committed
233 234
	 * @see setHostInfo
	 */
Qiang Xue committed
235
	public function getHostInfo()
Qiang Xue committed
236
	{
Qiang Xue committed
237
		if ($this->_hostInfo === null) {
Qiang Xue committed
238 239
			$secure = $this->getIsSecureConnection();
			$http = $secure ? 'https' : 'http';
Qiang Xue committed
240 241 242 243 244 245 246 247
			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
248 249 250
			}
		}

Qiang Xue committed
251
		return $this->_hostInfo;
Qiang Xue committed
252 253 254 255 256 257
	}

	/**
	 * 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
258
	 * @param string $value the schema and host part of the application URL. The trailing slashes will be removed.
Qiang Xue committed
259 260 261
	 */
	public function setHostInfo($value)
	{
Qiang Xue committed
262
		$this->_hostInfo = rtrim($value, '/');
Qiang Xue committed
263 264
	}

Qiang Xue committed
265 266
	private $_baseUrl;

Qiang Xue committed
267 268
	/**
	 * Returns the relative URL for the application.
Qiang Xue committed
269 270
	 * This is similar to [[scriptUrl]] except that it does not include the script file name,
	 * and the ending slashes are removed.
Qiang Xue committed
271 272 273
	 * @return string the relative URL for the application
	 * @see setScriptUrl
	 */
Qiang Xue committed
274
	public function getBaseUrl()
Qiang Xue committed
275
	{
Qiang Xue committed
276 277 278
		if ($this->_baseUrl === null) {
			$this->_baseUrl = rtrim(dirname($this->getScriptUrl()), '\\/');
		}
Qiang Xue committed
279
		return $this->_baseUrl;
Qiang Xue committed
280 281 282 283 284 285 286 287 288 289
	}

	/**
	 * 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
290
		$this->_baseUrl = $value;
Qiang Xue committed
291 292
	}

Qiang Xue committed
293 294
	private $_scriptUrl;

Qiang Xue committed
295 296 297 298
	/**
	 * 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
299
	 * @throws InvalidConfigException if unable to determine the entry script URL
Qiang Xue committed
300 301 302
	 */
	public function getScriptUrl()
	{
Qiang Xue committed
303 304 305 306
		if ($this->_scriptUrl === null) {
			$scriptName = basename($_SERVER['SCRIPT_FILENAME']);
			if (basename($_SERVER['SCRIPT_NAME']) === $scriptName) {
				$this->_scriptUrl = $_SERVER['SCRIPT_NAME'];
Qiang Xue committed
307 308 309 310 311 312 313 314
			} 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;
			} elseif (isset($_SERVER['DOCUMENT_ROOT']) && strpos($_SERVER['SCRIPT_FILENAME'], $_SERVER['DOCUMENT_ROOT']) === 0) {
				$this->_scriptUrl = str_replace('\\', '/', str_replace($_SERVER['DOCUMENT_ROOT'], '', $_SERVER['SCRIPT_FILENAME']));
Qiang Xue committed
315
			} else {
Qiang Xue committed
316
				throw new InvalidConfigException('Unable to determine the entry script URL.');
Qiang Xue committed
317
			}
Qiang Xue committed
318 319 320 321 322 323 324 325 326 327 328 329
		}
		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
330
		$this->_scriptUrl = '/' . trim($value, '/');
Qiang Xue committed
331 332
	}

Qiang Xue committed
333 334
	private $_pathInfo;

Qiang Xue committed
335 336
	/**
	 * Returns the path info of the currently requested URL.
Qiang Xue committed
337 338
	 * 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
339
	 * @return string part of the request URL that is after the entry script and before the question mark.
Qiang Xue committed
340
	 * Note, the returned path info is already URL-decoded.
Qiang Xue committed
341
	 * @throws InvalidConfigException if the path info cannot be determined due to unexpected server configuration
Qiang Xue committed
342 343 344
	 */
	public function getPathInfo()
	{
Qiang Xue committed
345
		if ($this->_pathInfo === null) {
Qiang Xue committed
346 347 348 349
			$this->_pathInfo = $this->resolvePathInfo();
		}
		return $this->_pathInfo;
	}
Qiang Xue committed
350

Qiang Xue committed
351 352 353 354 355
	/**
	 * 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
356 357 358 359 360
	public function setPathInfo($value)
	{
		$this->_pathInfo = trim($value, '/');
	}

Qiang Xue committed
361 362 363 364 365 366
	/**
	 * 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).
	 * The starting and ending slashes are both removed.
	 * @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
367
	 * @throws InvalidConfigException if the path info cannot be determined due to unexpected server configuration
Qiang Xue committed
368 369 370 371
	 */
	protected function resolvePathInfo()
	{
		$pathInfo = $this->getRequestUri();
Qiang Xue committed
372

Qiang Xue committed
373 374 375
		if (($pos = strpos($pathInfo, '?')) !== false) {
			$pathInfo = substr($pathInfo, 0, $pos);
		}
Qiang Xue committed
376

Qiang Xue committed
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
		$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
393

Qiang Xue committed
394 395 396 397 398 399 400 401 402
		$scriptUrl = $this->getScriptUrl();
		$baseUrl = $this->getBaseUrl();
		if (strpos($pathInfo, $scriptUrl) === 0) {
			$pathInfo = substr($pathInfo, strlen($scriptUrl));
		} elseif ($baseUrl === '' || strpos($pathInfo, $baseUrl) === 0) {
			$pathInfo = substr($pathInfo, strlen($baseUrl));
		} elseif (strpos($_SERVER['PHP_SELF'], $scriptUrl) === 0) {
			$pathInfo = substr($_SERVER['PHP_SELF'], strlen($scriptUrl));
		} else {
Qiang Xue committed
403
			throw new InvalidConfigException('Unable to determine the path info of the current request.');
Qiang Xue committed
404
		}
Qiang Xue committed
405 406

		return trim($pathInfo, '/');
Qiang Xue committed
407 408
	}

Qiang Xue committed
409 410 411 412 413 414 415 416 417 418
	/**
	 * Returns the currently requested URL.
	 * This is a shortcut to the concatenation of [[hostInfo]] and [[requestUri]].
	 * @return string the currently requested URL.
	 */
	public function getUrl()
	{
		return $this->getHostInfo() . $this->getRequestUri();
	}

Qiang Xue committed
419 420
	private $_requestUri;

Qiang Xue committed
421
	/**
Qiang Xue committed
422
	 * Returns the portion after [[hostInfo]] for the currently requested URL.
Qiang Xue committed
423
	 * This refers to the portion that is after the [[hostInfo]] part. It includes the [[queryString]] part if any.
Qiang Xue committed
424 425
	 * The implementation of this method referenced Zend_Controller_Request_Http in Zend Framework.
	 * @return string the request URI portion for the currently requested URL.
Qiang Xue committed
426
	 * Note that the URI returned is URL-encoded.
Qiang Xue committed
427
	 * @throws InvalidConfigException if the request URI cannot be determined due to unusual server configuration
Qiang Xue committed
428 429 430
	 */
	public function getRequestUri()
	{
Qiang Xue committed
431
		if ($this->_requestUri === null) {
Qiang Xue committed
432
			$this->_requestUri = $this->resolveRequestUri();
Qiang Xue committed
433 434 435 436
		}
		return $this->_requestUri;
	}

Qiang Xue committed
437 438 439 440 441 442 443 444 445 446 447
	/**
	 * Sets the currently requested URI.
	 * 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
	 */
	public function setRequestUri($value)
	{
		$this->_requestUri = $value;
	}

Qiang Xue committed
448 449 450 451 452 453
	/**
	 * 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
454
	 * @throws InvalidConfigException if the request URI cannot be determined due to unusual server configuration
Qiang Xue committed
455 456 457 458 459 460 461
	 */
	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
462
			if ($requestUri !== '' && $requestUri[0] !== '/') {
Qiang Xue committed
463 464 465 466 467 468 469 470
				$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
471
			throw new InvalidConfigException('Unable to determine the request URI.');
Qiang Xue committed
472 473 474 475
		}
		return $requestUri;
	}

Qiang Xue committed
476 477 478 479 480 481
	/**
	 * 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
482
		return isset($_SERVER['QUERY_STRING']) ? $_SERVER['QUERY_STRING'] : '';
Qiang Xue committed
483 484 485 486 487 488 489 490
	}

	/**
	 * Return if the request is sent via secure channel (https).
	 * @return boolean if the request is sent via secure channel (https)
	 */
	public function getIsSecureConnection()
	{
Qiang Xue committed
491
		return !empty($_SERVER['HTTPS']) && strcasecmp($_SERVER['HTTPS'], 'off');
Qiang Xue committed
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
	}

	/**
	 * 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
509
		return (int)$_SERVER['SERVER_PORT'];
Qiang Xue committed
510 511 512 513 514 515
	}

	/**
	 * Returns the URL referrer, null if not present
	 * @return string URL referrer, null if not present
	 */
Qiang Xue committed
516
	public function getReferrer()
Qiang Xue committed
517
	{
Qiang Xue committed
518
		return isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : null;
Qiang Xue committed
519 520 521 522 523 524 525 526
	}

	/**
	 * Returns the user agent, null if not present.
	 * @return string user agent, null if not present
	 */
	public function getUserAgent()
	{
Qiang Xue committed
527
		return isset($_SERVER['HTTP_USER_AGENT']) ? $_SERVER['HTTP_USER_AGENT'] : null;
Qiang Xue committed
528 529 530 531 532 533 534 535
	}

	/**
	 * Returns the user IP address.
	 * @return string user IP address
	 */
	public function getUserHostAddress()
	{
Qiang Xue committed
536
		return isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : '127.0.0.1';
Qiang Xue committed
537 538 539 540 541 542 543 544
	}

	/**
	 * 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
545
		return isset($_SERVER['REMOTE_HOST']) ? $_SERVER['REMOTE_HOST'] : null;
Qiang Xue committed
546 547 548 549 550 551 552 553
	}

	/**
	 * Returns user browser accept types, null if not present.
	 * @return string user browser accept types, null if not present
	 */
	public function getAcceptTypes()
	{
Qiang Xue committed
554
		return isset($_SERVER['HTTP_ACCEPT']) ? $_SERVER['HTTP_ACCEPT'] : null;
Qiang Xue committed
555 556 557 558
	}

	private $_port;

Qiang Xue committed
559
	/**
Qiang Xue committed
560 561 562 563 564 565 566 567
	 * Returns the port to use for insecure requests.
	 * Defaults to 80, or the port specified by the server if the current
	 * request is insecure.
	 * @return integer port number for insecure requests.
	 * @see setPort
	 */
	public function getPort()
	{
Qiang Xue committed
568 569 570
		if ($this->_port === null) {
			$this->_port = !$this->getIsSecureConnection() && isset($_SERVER['SERVER_PORT']) ? (int)$_SERVER['SERVER_PORT'] : 80;
		}
Qiang Xue committed
571 572 573 574 575 576 577 578 579 580 581
		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
582 583 584 585
		if ($value != $this->_port) {
			$this->_port = (int)$value;
			$this->_hostInfo = null;
		}
Qiang Xue committed
586 587 588 589 590 591 592 593 594 595 596 597 598
	}

	private $_securePort;

	/**
	 * Returns the port to use for secure requests.
	 * Defaults to 443, or the port specified by the server if the current
	 * request is secure.
	 * @return integer port number for secure requests.
	 * @see setSecurePort
	 */
	public function getSecurePort()
	{
Qiang Xue committed
599 600 601
		if ($this->_securePort === null) {
			$this->_securePort = $this->getIsSecureConnection() && isset($_SERVER['SERVER_PORT']) ? (int)$_SERVER['SERVER_PORT'] : 443;
		}
Qiang Xue committed
602 603 604 605 606 607 608 609 610 611 612
		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
613 614 615
		if ($value != $this->_securePort) {
			$this->_securePort = (int)$value;
			$this->_hostInfo = null;
Qiang Xue committed
616
		}
Qiang Xue committed
617 618
	}

Qiang Xue committed
619
	private $_preferredLanguages;
Qiang Xue committed
620 621

	/**
Qiang Xue committed
622 623 624 625
	 * Returns the user preferred languages.
	 * The languages returned are ordered by user's preference, starting with the language that the user
	 * prefers the most.
	 * @return string the user preferred languages. An empty array may be returned if the user has no preference.
Qiang Xue committed
626
	 */
Qiang Xue committed
627
	public function getPreferredLanguages()
Qiang Xue committed
628
	{
Qiang Xue committed
629
		if ($this->_preferredLanguages === null) {
Qiang Xue committed
630 631 632 633 634
			if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) && ($n = preg_match_all('/([\w\-_]+)\s*(;\s*q\s*=\s*(\d*\.\d*))?/', $_SERVER['HTTP_ACCEPT_LANGUAGE'], $matches)) > 0) {
				$languages = array();
				for ($i = 0; $i < $n; ++$i) {
					$languages[$matches[1][$i]] = empty($matches[3][$i]) ? 1.0 : floatval($matches[3][$i]);
				}
Qiang Xue committed
635
				arsort($languages);
Qiang Xue committed
636 637 638
				$this->_preferredLanguages = array_keys($languages);
			} else {
				$this->_preferredLanguages = array();
Qiang Xue committed
639 640
			}
		}
Qiang Xue committed
641
		return $this->_preferredLanguages;
Qiang Xue committed
642 643 644
	}

	/**
Qiang Xue committed
645 646 647
	 * Returns the language most preferred by the user.
	 * @return string|boolean the language most preferred by the user. If the user has no preference, false
	 * will be returned.
Qiang Xue committed
648
	 */
Qiang Xue committed
649
	public function getPreferredLanguage()
Qiang Xue committed
650
	{
Qiang Xue committed
651 652
		$languages = $this->getPreferredLanguages();
		return isset($languages[0]) ? $languages[0] : false;
Qiang Xue committed
653 654 655
	}

	/**
Qiang Xue committed
656
	 * Returns the cookie collection.
657 658 659 660 661 662 663 664 665 666 667 668 669
	 * 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
670
	 */
Qiang Xue committed
671
	public function getCookies()
Qiang Xue committed
672
	{
673
		if ($this->_cookies === null) {
Qiang Xue committed
674 675
			$this->_cookies = new CookieCollection(array(
				'enableValidation' => $this->enableCookieValidation,
Qiang Xue committed
676
				'validationKey' => $this->cookieValidationKey,
Qiang Xue committed
677
			));
678 679 680
		}
		return $this->_cookies;
	}
Qiang Xue committed
681 682
}