芝麻web文件管理V1.00
编辑当前文件:/home2/sdektunc/xmintal-back/vendor/yiisoft/yii2/web/Request.php
request`. * * For more details and usage information on Request, see the [guide article on requests](guide:runtime-requests). * * @property-read string $absoluteUrl The currently requested absolute URL. * @property array $acceptableContentTypes The content types ordered by the quality score. Types with the * highest scores will be returned first. The array keys are the content types, while the array values are the * corresponding quality score and other parameters as given in the header. * @property array $acceptableLanguages The languages ordered by the preference level. The first element * represents the most preferred language. * @property-read array $authCredentials That contains exactly two elements: - 0: the username sent via HTTP * authentication, `null` if the username is not given - 1: the password sent via HTTP authentication, `null` if * the password is not given. * @property-read string|null $authPassword The password sent via HTTP authentication, `null` if the password * is not given. * @property-read string|null $authUser The username sent via HTTP authentication, `null` if the username is * not given. * @property string $baseUrl The relative URL for the application. * @property array|object $bodyParams The request parameters given in the request body. * @property-read string $contentType Request content-type. Empty string is returned if this information is * not available. * @property-read CookieCollection $cookies The cookie collection. * @property-read string $csrfToken The token used to perform CSRF validation. * @property-read string|null $csrfTokenFromHeader The CSRF token sent via [[CSRF_HEADER]] by browser. Null is * returned if no such header is sent. * @property-read array $eTags The entity tags. * @property-read HeaderCollection $headers The header collection. * @property string|null $hostInfo Schema and hostname part (with port number if needed) of the request URL * (e.g. `https://www.yiiframework.com`), null if can't be obtained from `$_SERVER` and wasn't set. See * [[getHostInfo()]] for security related notes on this property. * @property-read string|null $hostName Hostname part of the request URL (e.g. `www.yiiframework.com`). * @property-read bool $isAjax Whether this is an AJAX (XMLHttpRequest) request. * @property-read bool $isDelete Whether this is a DELETE request. * @property-read bool $isFlash Whether this is an Adobe Flash or Adobe Flex request. * @property-read bool $isGet Whether this is a GET request. * @property-read bool $isHead Whether this is a HEAD request. * @property-read bool $isOptions Whether this is a OPTIONS request. * @property-read bool $isPatch Whether this is a PATCH request. * @property-read bool $isPjax Whether this is a PJAX request. * @property-read bool $isPost Whether this is a POST request. * @property-read bool $isPut Whether this is a PUT request. * @property-read bool $isSecureConnection If the request is sent via secure channel (https). * @property-read string $method Request method, such as GET, POST, HEAD, PUT, PATCH, DELETE. The value * returned is turned into upper case. * @property-read string|null $origin URL origin of a CORS request, `null` if not available. * @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. * @property int $port Port number for insecure requests. * @property array $queryParams The request GET parameter values. * @property-read string $queryString Part of the request URL that is after the question mark. * @property string $rawBody The request body. * @property-read string|null $referrer URL referrer, null if not available. * @property-read string|null $remoteHost Remote host name, `null` if not available. * @property-read string|null $remoteIP Remote IP address, `null` if not available. * @property string $scriptFile The entry script file path. * @property string $scriptUrl The relative URL of the entry script. * @property int $securePort Port number for secure requests. * @property-read string|null $serverName Server name, null if not available. * @property-read int|null $serverPort Server port number, null if not available. * @property string $url The currently requested relative URL. Note that the URI returned may be URL-encoded * depending on the client. * @property-read string|null $userAgent User agent, null if not available. * @property-read string|null $userHost User host name, null if not available. * @property-read string|null $userIP User IP address, null if not available. * * @author Qiang Xue
* @since 2.0 * @SuppressWarnings(PHPMD.SuperGlobals) */ class Request extends \yii\base\Request { /** * The name of the HTTP header for sending CSRF token. */ const CSRF_HEADER = 'X-CSRF-Token'; /** * The length of the CSRF token mask. * @deprecated since 2.0.12. The mask length is now equal to the token length. */ const CSRF_MASK_LENGTH = 8; /** * @var bool whether to enable CSRF (Cross-Site Request Forgery) validation. Defaults to true. * When CSRF validation is enabled, forms submitted to an Yii Web application must be originated * 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, * forms submitted via POST method must contain a hidden input whose name is specified by [[csrfParam]]. * You may use [[\yii\helpers\Html::beginForm()]] to generate his hidden input. * * In JavaScript, you may get the values of [[csrfParam]] and [[csrfToken]] via `yii.getCsrfParam()` and * `yii.getCsrfToken()`, respectively. The [[\yii\web\YiiAsset]] asset must be registered. * You also need to include CSRF meta tags in your pages by using [[\yii\helpers\Html::csrfMetaTags()]]. * * @see Controller::enableCsrfValidation * @see https://en.wikipedia.org/wiki/Cross-site_request_forgery */ public $enableCsrfValidation = true; /** * @var string the name of the token used to prevent CSRF. Defaults to '_csrf'. * This property is used only when [[enableCsrfValidation]] is true. */ public $csrfParam = '_csrf'; /** * @var array the configuration for creating the CSRF [[Cookie|cookie]]. This property is used only when * both [[enableCsrfValidation]] and [[enableCsrfCookie]] are true. */ public $csrfCookie = ['httpOnly' => true]; /** * @var bool whether to use cookie to persist CSRF token. If false, CSRF token will be stored * in session under the name of [[csrfParam]]. Note that while storing CSRF tokens in session increases * security, it requires starting a session for every page, which will degrade your site performance. */ public $enableCsrfCookie = true; /** * @var bool whether cookies should be validated to ensure they are not tampered. Defaults to true. */ public $enableCookieValidation = true; /** * @var string a secret key used for cookie validation. This property must be set if [[enableCookieValidation]] is true. */ public $cookieValidationKey; /** * @var string the name of the POST parameter that is used to indicate if a request is a PUT, PATCH or DELETE * request tunneled through POST. Defaults to '_method'. * @see getMethod() * @see getBodyParams() */ public $methodParam = '_method'; /** * @var array the parsers for converting the raw HTTP request body into [[bodyParams]]. * 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. * * @see getBodyParams() */ public $parsers = []; /** * @var array the configuration for trusted security related headers. * * An array key is an IPv4 or IPv6 IP address in CIDR notation for matching a client. * * An array value is a list of headers to trust. These will be matched against * [[secureHeaders]] to determine which headers are allowed to be sent by a specified host. * The case of the header names must be the same as specified in [[secureHeaders]]. * * For example, to trust all headers listed in [[secureHeaders]] for IP addresses * in range `192.168.0.0-192.168.0.254` write the following: * * ```php * [ * '192.168.0.0/24', * ] * ``` * * To trust just the `X-Forwarded-For` header from `10.0.0.1`, use: * * ``` * [ * '10.0.0.1' => ['X-Forwarded-For'] * ] * ``` * * Default is to trust all headers except those listed in [[secureHeaders]] from all hosts. * Matches are tried in order and searching is stopped when IP matches. * * > Info: Matching is performed using [[IpValidator]]. * See [[IpValidator::::setRanges()|IpValidator::setRanges()]] * and [[IpValidator::networks]] for advanced matching. * * @see secureHeaders * @since 2.0.13 */ public $trustedHosts = []; /** * @var array lists of headers that are, by default, subject to the trusted host configuration. * These headers will be filtered unless explicitly allowed in [[trustedHosts]]. * If the list contains the `Forwarded` header, processing will be done according to RFC 7239. * The match of header names is case-insensitive. * @see https://en.wikipedia.org/wiki/List_of_HTTP_header_fields * @see https://datatracker.ietf.org/doc/html/rfc7239 * @see trustedHosts * @since 2.0.13 */ public $secureHeaders = [ // Common: 'X-Forwarded-For', 'X-Forwarded-Host', 'X-Forwarded-Proto', 'X-Forwarded-Port', // Microsoft: 'Front-End-Https', 'X-Rewrite-Url', // ngrok: 'X-Original-Host', ]; /** * @var string[] List of headers where proxies store the real client IP. * It's not advisable to put insecure headers here. * To use the `Forwarded` header according to RFC 7239, the header must be added to [[secureHeaders]] list. * The match of header names is case-insensitive. * @see trustedHosts * @see secureHeaders * @since 2.0.13 */ public $ipHeaders = [ 'X-Forwarded-For', // Common ]; /** * @var string[] List of headers where proxies store the real request port. * It's not advisable to put insecure headers here. * To use the `Forwarded Port`, the header must be added to [[secureHeaders]] list. * The match of header names is case-insensitive. * @see trustedHosts * @see secureHeaders * @since 2.0.46 */ public $portHeaders = [ 'X-Forwarded-Port', // Common ]; /** * @var array list of headers to check for determining whether the connection is made via HTTPS. * The array keys are header names and the array value is a list of header values that indicate a secure connection. * The match of header names and values is case-insensitive. * It's not advisable to put insecure headers here. * @see trustedHosts * @see secureHeaders * @since 2.0.13 */ public $secureProtocolHeaders = [ 'X-Forwarded-Proto' => ['https'], // Common 'Front-End-Https' => ['on'], // Microsoft ]; /** * @var CookieCollection Collection of request cookies. */ private $_cookies; /** * @var HeaderCollection Collection of request headers. */ private $_headers; /** * 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 NotFoundHttpException if the request cannot be resolved. */ public function resolve() { $result = Yii::$app->getUrlManager()->parseRequest($this); if ($result !== false) { list($route, $params) = $result; if ($this->_queryParams === null) { $_GET = $params + $_GET; // preserve numeric keys } else { $this->_queryParams = $params + $this->_queryParams; } return [$route, $this->getQueryParams()]; } throw new NotFoundHttpException(Yii::t('yii', 'Page not found.')); } /** * Filters headers according to the [[trustedHosts]]. * @param HeaderCollection $headerCollection * @since 2.0.13 */ protected function filterHeaders(HeaderCollection $headerCollection) { $trustedHeaders = $this->getTrustedHeaders(); // remove all secure headers unless they are trusted foreach ($this->secureHeaders as $secureHeader) { if (!in_array($secureHeader, $trustedHeaders)) { $headerCollection->remove($secureHeader); } } } /** * Trusted headers according to the [[trustedHosts]]. * @return array * @since 2.0.28 */ protected function getTrustedHeaders() { // do not trust any of the [[secureHeaders]] by default $trustedHeaders = []; // check if the client is a trusted host if (!empty($this->trustedHosts)) { $validator = $this->getIpValidator(); $ip = $this->getRemoteIP(); foreach ($this->trustedHosts as $cidr => $headers) { if (!is_array($headers)) { $cidr = $headers; $headers = $this->secureHeaders; } $validator->setRanges($cidr); if ($validator->validate($ip)) { $trustedHeaders = $headers; break; } } } return $trustedHeaders; } /** * Creates instance of [[IpValidator]]. * You can override this method to adjust validator or implement different matching strategy. * * @return IpValidator * @since 2.0.13 */ protected function getIpValidator() { return new IpValidator(); } /** * 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(); foreach ($headers as $name => $value) { $this->_headers->add($name, $value); } } elseif (function_exists('http_get_request_headers')) { $headers = http_get_request_headers(); foreach ($headers as $name => $value) { $this->_headers->add($name, $value); } } else { // ['prefix' => length] $headerPrefixes = ['HTTP_' => 5, 'REDIRECT_HTTP_' => 14]; foreach ($_SERVER as $name => $value) { foreach ($headerPrefixes as $prefix => $length) { if (strncmp($name, $prefix, $length) === 0) { $name = str_replace(' ', '-', ucwords(strtolower(str_replace('_', ' ', substr($name, $length))))); $this->_headers->add($name, $value); continue 2; } } } } $this->filterHeaders($this->_headers); } return $this->_headers; } /** * 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. * The value returned is turned into upper case. */ public function getMethod() { if ( isset($_POST[$this->methodParam]) // Never allow to downgrade request from WRITE methods (POST, PATCH, DELETE, etc) // to read methods (GET, HEAD, OPTIONS) for security reasons. && !in_array(strtoupper($_POST[$this->methodParam]), ['GET', 'HEAD', 'OPTIONS'], true) ) { return strtoupper($_POST[$this->methodParam]); } if ($this->headers->has('X-Http-Method-Override')) { return strtoupper($this->headers->get('X-Http-Method-Override')); } if (isset($_SERVER['REQUEST_METHOD'])) { return strtoupper($_SERVER['REQUEST_METHOD']); } return 'GET'; } /** * Returns whether this is a GET request. * @return bool whether this is a GET request. */ public function getIsGet() { return $this->getMethod() === 'GET'; } /** * Returns whether this is an OPTIONS request. * @return bool whether this is a OPTIONS request. */ public function getIsOptions() { return $this->getMethod() === 'OPTIONS'; } /** * Returns whether this is a HEAD request. * @return bool whether this is a HEAD request. */ public function getIsHead() { return $this->getMethod() === 'HEAD'; } /** * Returns whether this is a POST request. * @return bool whether this is a POST request. */ public function getIsPost() { return $this->getMethod() === 'POST'; } /** * Returns whether this is a DELETE request. * @return bool whether this is a DELETE request. */ public function getIsDelete() { return $this->getMethod() === 'DELETE'; } /** * Returns whether this is a PUT request. * @return bool whether this is a PUT request. */ public function getIsPut() { return $this->getMethod() === 'PUT'; } /** * Returns whether this is a PATCH request. * @return bool whether this is a PATCH request. */ public function getIsPatch() { return $this->getMethod() === 'PATCH'; } /** * Returns whether this is an AJAX (XMLHttpRequest) request. * * Note that in case of cross domain requests, browser doesn't set the X-Requested-With header by default: * https://stackoverflow.com/questions/8163703/cross-domain-ajax-doesnt-send-x-requested-with-header * * In case you are using `fetch()`, pass header manually: * * ``` * fetch(url, { * method: 'GET', * headers: {'X-Requested-With': 'XMLHttpRequest'} * }) * ``` * * @return bool whether this is an AJAX (XMLHttpRequest) request. */ public function getIsAjax() { return $this->headers->get('X-Requested-With') === 'XMLHttpRequest'; } /** * Returns whether this is a PJAX request. * @return bool whether this is a PJAX request */ public function getIsPjax() { return $this->getIsAjax() && $this->headers->has('X-Pjax'); } /** * Returns whether this is an Adobe Flash or Flex request. * @return bool whether this is an Adobe Flash or Adobe Flex request. */ public function getIsFlash() { $userAgent = $this->headers->get('User-Agent', ''); return stripos($userAgent, 'Shockwave') !== false || stripos($userAgent, 'Flash') !== false; } 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; } /** * Sets the raw HTTP request body, this method is mainly used by test scripts to simulate raw HTTP requests. * @param string $rawBody the request body */ public function setRawBody($rawBody) { $this->_rawBody = $rawBody; } private $_bodyParams; /** * Returns the request parameters given in the request body. * * 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]]. * @return array|object the request parameters given in the request body. * @throws \yii\base\InvalidConfigException if a registered parser does not implement the [[RequestParserInterface]]. * @see getMethod() * @see getBodyParam() * @see setBodyParams() */ public function getBodyParams() { if ($this->_bodyParams === null) { if (isset($_POST[$this->methodParam])) { $this->_bodyParams = $_POST; unset($this->_bodyParams[$this->methodParam]); return $this->_bodyParams; } $rawContentType = $this->getContentType(); if (($pos = strpos((string)$rawContentType, ';')) !== false) { // e.g. text/html; charset=UTF-8 $contentType = substr($rawContentType, 0, $pos); } else { $contentType = $rawContentType; } if (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."); } $this->_bodyParams = $parser->parse($this->getRawBody(), $rawContentType); } 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.'); } $this->_bodyParams = $parser->parse($this->getRawBody(), $rawContentType); } elseif ($this->getMethod() === 'POST') { // PHP has already parsed the body so we have all params in $_POST $this->_bodyParams = $_POST; } else { $this->_bodyParams = []; mb_parse_str($this->getRawBody(), $this->_bodyParams); } } return $this->_bodyParams; } /** * Sets the request body parameters. * * @param array|object $values the request body parameters (name-value pairs) * @see getBodyParams() */ public function setBodyParams($values) { $this->_bodyParams = $values; } /** * Returns the named request body parameter value. * * If the parameter does not exist, the second parameter passed to this method will be returned. * * @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() */ public function getBodyParam($name, $defaultValue = null) { $params = $this->getBodyParams(); if (is_object($params)) { // unable to use `ArrayHelper::getValue()` due to different dots in key logic and lack of exception handling try { return isset($params->{$name}) ? $params->{$name} : $defaultValue; } catch (\Exception $e) { return $defaultValue; } } return isset($params[$name]) ? $params[$name] : $defaultValue; } /** * 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(); } return $this->getBodyParam($name, $defaultValue); } private $_queryParams; /** * 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() */ public function getQueryParams() { if ($this->_queryParams === null) { return $_GET; } return $this->_queryParams; } /** * Sets the request [[queryString]] parameters. * @param array $values the request query parameters (name-value pairs) * @see getQueryParam() * @see getQueryParams() */ public function setQueryParams($values) { $this->_queryParams = $values; } /** * 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(); } return $this->getQueryParam($name, $defaultValue); } /** * Returns the named GET parameter value. * If the GET parameter does not exist, the second parameter passed 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 getBodyParam() */ public function getQueryParam($name, $defaultValue = null) { $params = $this->getQueryParams(); return isset($params[$name]) ? $params[$name] : $defaultValue; } private $_hostInfo; private $_hostName; /** * Returns the schema and host part of the current request URL. * * The returned URL does not have an ending slash. * * By default this value is based on the user request information. This method will * return the value of `$_SERVER['HTTP_HOST']` if it is available or `$_SERVER['SERVER_NAME']` if not. * You may want to check out the [PHP documentation](https://www.php.net/manual/en/reserved.variables.server.php) * for more information on these variables. * * You may explicitly specify it by setting the [[setHostInfo()|hostInfo]] property. * * > Warning: Dependent on the server configuration this information may not be * > reliable and [may be faked by the user sending the HTTP request](https://www.acunetix.com/vulnerabilities/web/host-header-attack). * > If the webserver is configured to serve the same site independent of the value of * > the `Host` header, this value is not reliable. In such situations you should either * > fix your webserver configuration or explicitly set the value by setting the [[setHostInfo()|hostInfo]] property. * > If you don't have access to the server configuration, you can setup [[\yii\filters\HostControl]] filter at * > application level in order to protect against such kind of attack. * * @property string|null schema and hostname part (with port number if needed) of the request URL * (e.g. `https://www.yiiframework.com`), null if can't be obtained from `$_SERVER` and wasn't set. * See [[getHostInfo()]] for security related notes on this property. * @return string|null schema and hostname part (with port number if needed) of the request URL * (e.g. `https://www.yiiframework.com`), null if can't be obtained from `$_SERVER` and wasn't set. * @see setHostInfo() */ public function getHostInfo() { if ($this->_hostInfo === null) { $secure = $this->getIsSecureConnection(); $http = $secure ? 'https' : 'http'; if ($this->getSecureForwardedHeaderTrustedPart('host') !== null) { $this->_hostInfo = $http . '://' . $this->getSecureForwardedHeaderTrustedPart('host'); } elseif ($this->headers->has('X-Forwarded-Host')) { $this->_hostInfo = $http . '://' . trim(explode(',', $this->headers->get('X-Forwarded-Host'))[0]); } elseif ($this->headers->has('X-Original-Host')) { $this->_hostInfo = $http . '://' . trim(explode(',', $this->headers->get('X-Original-Host'))[0]); } elseif ($this->headers->has('Host')) { $this->_hostInfo = $http . '://' . $this->headers->get('Host'); } elseif (isset($_SERVER['SERVER_NAME'])) { $this->_hostInfo = $http . '://' . $_SERVER['SERVER_NAME']; $port = $secure ? $this->getSecurePort() : $this->getPort(); if (($port !== 80 && !$secure) || ($port !== 443 && $secure)) { $this->_hostInfo .= ':' . $port; } } } return $this->_hostInfo; } /** * 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. * @param string|null $value the schema and host part of the application URL. The trailing slashes will be removed. * @see getHostInfo() for security related notes on this property. */ public function setHostInfo($value) { $this->_hostName = null; $this->_hostInfo = $value === null ? null : rtrim($value, '/'); } /** * Returns the host part of the current request URL. * Value is calculated from current [[getHostInfo()|hostInfo]] property. * * > Warning: The content of this value may not be reliable, dependent on the server * > configuration. Please refer to [[getHostInfo()]] for more information. * * @return string|null hostname part of the request URL (e.g. `www.yiiframework.com`) * @see getHostInfo() * @since 2.0.10 */ public function getHostName() { if ($this->_hostName === null) { $this->_hostName = parse_url((string)$this->getHostInfo(), PHP_URL_HOST); } return $this->_hostName; } private $_baseUrl; /** * Returns the relative URL for the application. * This is similar to [[scriptUrl]] except that it does not include the script file name, * and the ending slashes are removed. * @return string the relative URL for the application * @see setScriptUrl() */ public function getBaseUrl() { if ($this->_baseUrl === null) { $this->_baseUrl = rtrim(dirname($this->getScriptUrl()), '\\/'); } return $this->_baseUrl; } /** * 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) { $this->_baseUrl = $value; } private $_scriptUrl; /** * 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. * @throws InvalidConfigException if unable to determine the entry script URL */ public function getScriptUrl() { if ($this->_scriptUrl === null) { $scriptFile = $this->getScriptFile(); $scriptName = basename($scriptFile); if (isset($_SERVER['SCRIPT_NAME']) && basename($_SERVER['SCRIPT_NAME']) === $scriptName) { $this->_scriptUrl = $_SERVER['SCRIPT_NAME']; } elseif (isset($_SERVER['PHP_SELF']) && 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 (isset($_SERVER['PHP_SELF']) && ($pos = strpos($_SERVER['PHP_SELF'], '/' . $scriptName)) !== false) { $this->_scriptUrl = substr($_SERVER['SCRIPT_NAME'], 0, $pos) . '/' . $scriptName; } elseif (!empty($_SERVER['DOCUMENT_ROOT']) && strpos($scriptFile, $_SERVER['DOCUMENT_ROOT']) === 0) { $this->_scriptUrl = str_replace([$_SERVER['DOCUMENT_ROOT'], '\\'], ['', '/'], $scriptFile); } else { throw new InvalidConfigException('Unable to determine the entry script URL.'); } } 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) { $this->_scriptUrl = $value === null ? null : '/' . trim($value, '/'); } private $_scriptFile; /** * Returns the entry script file path. * The default implementation will simply return `$_SERVER['SCRIPT_FILENAME']`. * @return string the entry script file path * @throws InvalidConfigException */ public function getScriptFile() { if (isset($this->_scriptFile)) { return $this->_scriptFile; } if (isset($_SERVER['SCRIPT_FILENAME'])) { return $_SERVER['SCRIPT_FILENAME']; } throw new InvalidConfigException('Unable to determine the entry script file path.'); } /** * 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; } private $_pathInfo; /** * Returns the path info 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 already URL-decoded. * @throws InvalidConfigException if the path info cannot be determined due to unexpected server configuration */ public function getPathInfo() { if ($this->_pathInfo === null) { $this->_pathInfo = $this->resolvePathInfo(); } return $this->_pathInfo; } /** * 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 */ public function setPathInfo($value) { $this->_pathInfo = $value === null ? null : ltrim($value, '/'); } /** * 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 slashes are both removed (ending slashes will be kept). * @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. * @throws InvalidConfigException if the path info cannot be determined due to unexpected server configuration */ protected function resolvePathInfo() { $pathInfo = $this->getUrl(); if (($pos = strpos($pathInfo, '?')) !== false) { $pathInfo = substr($pathInfo, 0, $pos); } $pathInfo = urldecode($pathInfo); // try to encode in UTF8 if not so // https://www.w3.org/International/questions/qa-forms-utf-8.en.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 = $this->utf8Encode($pathInfo); } $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 (isset($_SERVER['PHP_SELF']) && strpos($_SERVER['PHP_SELF'], $scriptUrl) === 0) { $pathInfo = substr($_SERVER['PHP_SELF'], strlen($scriptUrl)); } else { throw new InvalidConfigException('Unable to determine the path info of the current request.'); } if (strncmp($pathInfo, '/', 1) === 0) { $pathInfo = substr($pathInfo, 1); } return (string) $pathInfo; } /** * Encodes an ISO-8859-1 string to UTF-8 * @param string $s * @return string the UTF-8 translation of `s`. * @see https://github.com/symfony/polyfill-php72/blob/master/Php72.php#L24 */ private function utf8Encode($s) { $s .= $s; $len = \strlen($s); for ($i = $len >> 1, $j = 0; $i < $len; ++$i, ++$j) { switch (true) { case $s[$i] < "\x80": $s[$j] = $s[$i]; break; case $s[$i] < "\xC0": $s[$j] = "\xC2"; $s[++$j] = $s[$i]; break; default: $s[$j] = "\xC3"; $s[++$j] = \chr(\ord($s[$i]) - 64); break; } } return substr($s, 0, $j); } /** * Returns the currently requested absolute URL. * This is a shortcut to the concatenation of [[hostInfo]] and [[url]]. * @return string the currently requested absolute URL. */ public function getAbsoluteUrl() { return $this->getHostInfo() . $this->getUrl(); } private $_url; /** * 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 may be URL-encoded depending on the client. * @throws InvalidConfigException if the URL cannot be determined due to unusual server configuration */ public function getUrl() { if ($this->_url === null) { $this->_url = $this->resolveRequestUri(); } return $this->_url; } /** * Sets the currently requested relative URL. * 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 setUrl($value) { $this->_url = $value; } /** * 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|bool the request URI portion for the currently requested URL. * Note that the URI returned may be URL-encoded depending on the client. * @throws InvalidConfigException if the request URI cannot be determined due to unusual server configuration */ protected function resolveRequestUri() { if ($this->headers->has('X-Rewrite-Url')) { // IIS $requestUri = $this->headers->get('X-Rewrite-Url'); } elseif (isset($_SERVER['REQUEST_URI'])) { $requestUri = $_SERVER['REQUEST_URI']; if ($requestUri !== '' && $requestUri[0] !== '/') { $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 { throw new InvalidConfigException('Unable to determine the request URI.'); } return $requestUri; } /** * 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() { return isset($_SERVER['QUERY_STRING']) ? $_SERVER['QUERY_STRING'] : ''; } /** * Return if the request is sent via secure channel (https). * @return bool if the request is sent via secure channel (https) */ public function getIsSecureConnection() { if (isset($_SERVER['HTTPS']) && (strcasecmp($_SERVER['HTTPS'], 'on') === 0 || $_SERVER['HTTPS'] == 1)) { return true; } if (($proto = $this->getSecureForwardedHeaderTrustedPart('proto')) !== null) { return strcasecmp($proto, 'https') === 0; } foreach ($this->secureProtocolHeaders as $header => $values) { if (($headerValue = $this->headers->get($header, null)) !== null) { foreach ($values as $value) { if (strcasecmp($headerValue, $value) === 0) { return true; } } } } return false; } /** * Returns the server name. * @return string|null server name, null if not available */ public function getServerName() { return isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : null; } /** * Returns the server port number. If a port is specified via a forwarding header (e.g. 'X-Forwarded-Port') * and the remote host is a "trusted host" the that port will be used (see [[portHeaders]]), * otherwise the default server port will be returned. * @return int|null server port number, null if not available * @see portHeaders */ public function getServerPort() { foreach ($this->portHeaders as $portHeader) { if ($this->headers->has($portHeader)) { $port = $this->headers->get($portHeader); if ($port !== null) { return $port; } } } return isset($_SERVER['SERVER_PORT']) ? (int) $_SERVER['SERVER_PORT'] : null; } /** * Returns the URL referrer. * @return string|null URL referrer, null if not available */ public function getReferrer() { return $this->headers->get('Referer'); } /** * Returns the URL origin of a CORS request. * * The return value is taken from the `Origin` [[getHeaders()|header]] sent by the browser. * * Note that the origin request header indicates where a fetch originates from. * It doesn't include any path information, but only the server name. * It is sent with a CORS requests, as well as with POST requests. * It is similar to the referer header, but, unlike this header, it doesn't disclose the whole path. * Please refer to
for more information. * * @return string|null URL origin of a CORS request, `null` if not available. * @see getHeaders() * @since 2.0.13 */ public function getOrigin() { return $this->getHeaders()->get('origin'); } /** * Returns the user agent. * @return string|null user agent, null if not available */ public function getUserAgent() { return $this->headers->get('User-Agent'); } /** * Returns the user IP address from [[ipHeaders]]. * @return string|null user IP address, null if not available * @see ipHeaders * @since 2.0.28 */ protected function getUserIpFromIpHeaders() { $ip = $this->getSecureForwardedHeaderTrustedPart('for'); if ($ip !== null && preg_match( '/^\[?(?P
(?:(?:(?:[0-9a-f]{1,4}:){1,6}(?:[0-9a-f]{1,4})?(?:(?::[0-9a-f]{1,4}){1,6}))|(?:\d{1,3}\.){3}\d{1,3}))\]?(?::(?P
\d+))?$/', $ip, $matches )) { $ip = $this->getUserIpFromIpHeader($matches['ip']); if ($ip !== null) { return $ip; } } foreach ($this->ipHeaders as $ipHeader) { if ($this->headers->has($ipHeader)) { $ip = $this->getUserIpFromIpHeader($this->headers->get($ipHeader)); if ($ip !== null) { return $ip; } } } return null; } private $_ip = null; /** * Returns the user IP address. * The IP is determined using headers and / or `$_SERVER` variables. * @return string|null user IP address, null if not available */ public function getUserIP() { if ($this->_ip === null) { $this->_ip = $this->getUserIpFromIpHeaders(); if ($this->_ip === null) { $this->_ip = $this->getRemoteIP(); } } return $this->_ip; } /** * Return user IP's from IP header. * * @param string $ips comma separated IP list * @return string|null IP as string. Null is returned if IP can not be determined from header. * @see getUserHost() * @see ipHeaders * @see getTrustedHeaders() * @since 2.0.28 */ protected function getUserIpFromIpHeader($ips) { $ips = trim($ips); if ($ips === '') { return null; } $ips = preg_split('/\s*,\s*/', $ips, -1, PREG_SPLIT_NO_EMPTY); krsort($ips); $validator = $this->getIpValidator(); $resultIp = null; foreach ($ips as $ip) { $validator->setRanges('any'); if (!$validator->validate($ip) /* checking IP format */) { break; } $resultIp = $ip; $isTrusted = false; foreach ($this->trustedHosts as $trustedCidr => $trustedCidrOrHeaders) { if (!is_array($trustedCidrOrHeaders)) { $trustedCidr = $trustedCidrOrHeaders; } $validator->setRanges($trustedCidr); if ($validator->validate($ip) /* checking trusted range */) { $isTrusted = true; break; } } if (!$isTrusted) { break; } } return $resultIp; } /** * Returns the user host name. * The HOST is determined using headers and / or `$_SERVER` variables. * @return string|null user host name, null if not available */ public function getUserHost() { $userIp = $this->getUserIpFromIpHeaders(); if($userIp === null) { return $this->getRemoteHost(); } return gethostbyaddr($userIp); } /** * Returns the IP on the other end of this connection. * This is always the next hop, any headers are ignored. * @return string|null remote IP address, `null` if not available. * @since 2.0.13 */ public function getRemoteIP() { return isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : null; } /** * Returns the host name of the other end of this connection. * This is always the next hop, any headers are ignored. * @return string|null remote host name, `null` if not available * @see getUserHost() * @see getRemoteIP() * @since 2.0.13 */ public function getRemoteHost() { return isset($_SERVER['REMOTE_HOST']) ? $_SERVER['REMOTE_HOST'] : null; } /** * @return string|null the username sent via HTTP authentication, `null` if the username is not given * @see getAuthCredentials() to get both username and password in one call */ public function getAuthUser() { return $this->getAuthCredentials()[0]; } /** * @return string|null the password sent via HTTP authentication, `null` if the password is not given * @see getAuthCredentials() to get both username and password in one call */ public function getAuthPassword() { return $this->getAuthCredentials()[1]; } /** * @return array that contains exactly two elements: * - 0: the username sent via HTTP authentication, `null` if the username is not given * - 1: the password sent via HTTP authentication, `null` if the password is not given * @see getAuthUser() to get only username * @see getAuthPassword() to get only password * @since 2.0.13 */ public function getAuthCredentials() { $username = isset($_SERVER['PHP_AUTH_USER']) ? $_SERVER['PHP_AUTH_USER'] : null; $password = isset($_SERVER['PHP_AUTH_PW']) ? $_SERVER['PHP_AUTH_PW'] : null; if ($username !== null || $password !== null) { return [$username, $password]; } /** * Apache with php-cgi does not pass HTTP Basic authentication to PHP by default. * To make it work, add one of the following lines to to your .htaccess file: * * SetEnvIf Authorization .+ HTTP_AUTHORIZATION=$0 * --OR-- * RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}] */ $auth_token = $this->getHeaders()->get('Authorization'); if ($auth_token !== null && strncasecmp($auth_token, 'basic', 5) === 0) { $parts = array_map(function ($value) { return strlen($value) === 0 ? null : $value; }, explode(':', base64_decode(mb_substr($auth_token, 6)), 2)); if (count($parts) < 2) { return [$parts[0], null]; } return $parts; } return [null, null]; } private $_port; /** * 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 int port number for insecure requests. * @see setPort() */ public function getPort() { if ($this->_port === null) { $serverPort = $this->getServerPort(); $this->_port = !$this->getIsSecureConnection() && $serverPort !== null ? $serverPort : 80; } 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 int $value port number. */ public function setPort($value) { if ($value != $this->_port) { $this->_port = (int) $value; $this->_hostInfo = null; } } 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 int port number for secure requests. * @see setSecurePort() */ public function getSecurePort() { if ($this->_securePort === null) { $serverPort = $this->getServerPort(); $this->_securePort = $this->getIsSecureConnection() && $serverPort !== null ? $serverPort : 443; } 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 int $value port number. */ public function setSecurePort($value) { if ($value != $this->_securePort) { $this->_securePort = (int) $value; $this->_hostInfo = null; } } private $_contentTypes; /** * Returns the content types acceptable by the end user. * * This is determined by the `Accept` HTTP header. For example, * * ```php * $_SERVER['HTTP_ACCEPT'] = 'text/plain; q=0.5, application/json; version=1.0, application/xml; version=2.0;'; * $types = $request->getAcceptableContentTypes(); * print_r($types); * // displays: * // [ * // 'application/json' => ['q' => 1, 'version' => '1.0'], * // 'application/xml' => ['q' => 1, 'version' => '2.0'], * // 'text/plain' => ['q' => 0.5], * // ] * ``` * * @return array the content types ordered by the quality score. Types with the highest scores * will be returned first. The array keys are the content types, while the array values * are the corresponding quality score and other parameters as given in the header. */ public function getAcceptableContentTypes() { if ($this->_contentTypes === null) { if ($this->headers->get('Accept') !== null) { $this->_contentTypes = $this->parseAcceptHeader($this->headers->get('Accept')); } else { $this->_contentTypes = []; } } return $this->_contentTypes; } /** * Sets the acceptable content types. * Please refer to [[getAcceptableContentTypes()]] on the format of the parameter. * @param array $value the content types that are acceptable by the end user. They should * be ordered by the preference level. * @see getAcceptableContentTypes() * @see parseAcceptHeader() */ public function setAcceptableContentTypes($value) { $this->_contentTypes = $value; } /** * 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. Empty string is returned if this information is not available. * @link https://tools.ietf.org/html/rfc2616#section-14.17 * HTTP 1.1 header field definitions */ public function getContentType() { if (isset($_SERVER['CONTENT_TYPE'])) { return $_SERVER['CONTENT_TYPE']; } //fix bug https://bugs.php.net/bug.php?id=66606 return $this->headers->get('Content-Type') ?: ''; } private $_languages; /** * Returns the languages acceptable by the end user. * This is determined by the `Accept-Language` HTTP header. * @return array the languages ordered by the preference level. The first element * represents the most preferred language. */ public function getAcceptableLanguages() { if ($this->_languages === null) { if ($this->headers->has('Accept-Language')) { $this->_languages = array_keys($this->parseAcceptHeader($this->headers->get('Accept-Language'))); } else { $this->_languages = []; } } return $this->_languages; } /** * @param array $value the languages that are acceptable by the end user. They should * be ordered by the preference level. */ public function setAcceptableLanguages($value) { $this->_languages = $value; } /** * Parses the given `Accept` (or `Accept-Language`) header. * * This method will return the acceptable values with their quality scores and the corresponding parameters * as specified in the given `Accept` header. The array keys of the return value are the acceptable values, * while the array values consisting of the corresponding quality scores and parameters. The acceptable * values with the highest quality scores will be returned first. For example, * * ```php * $header = 'text/plain; q=0.5, application/json; version=1.0, application/xml; version=2.0;'; * $accepts = $request->parseAcceptHeader($header); * print_r($accepts); * // displays: * // [ * // 'application/json' => ['q' => 1, 'version' => '1.0'], * // 'application/xml' => ['q' => 1, 'version' => '2.0'], * // 'text/plain' => ['q' => 0.5], * // ] * ``` * * @param string $header the header to be parsed * @return array the acceptable values ordered by their quality score. The values with the highest scores * will be returned first. */ public function parseAcceptHeader($header) { $accepts = []; foreach (explode(',', $header) as $i => $part) { $params = preg_split('/\s*;\s*/', trim($part), -1, PREG_SPLIT_NO_EMPTY); if (empty($params)) { continue; } $values = [ 'q' => [$i, array_shift($params), 1], ]; foreach ($params as $param) { if (strpos($param, '=') !== false) { list($key, $value) = explode('=', $param, 2); if ($key === 'q') { $values['q'][2] = (float) $value; } else { $values[$key] = $value; } } else { $values[] = $param; } } $accepts[] = $values; } usort($accepts, function ($a, $b) { $a = $a['q']; // index, name, q $b = $b['q']; if ($a[2] > $b[2]) { return -1; } if ($a[2] < $b[2]) { return 1; } if ($a[1] === $b[1]) { return $a[0] > $b[0] ? 1 : -1; } if ($a[1] === '*/*') { return 1; } if ($b[1] === '*/*') { return -1; } $wa = $a[1][strlen($a[1]) - 1] === '*'; $wb = $b[1][strlen($b[1]) - 1] === '*'; if ($wa xor $wb) { return $wa ? 1 : -1; } return $a[0] > $b[0] ? 1 : -1; }); $result = []; foreach ($accepts as $accept) { $name = $accept['q'][1]; $accept['q'] = $accept['q'][2]; $result[$name] = $accept; } return $result; } /** * Returns the user-preferred language that should be used by this application. * The language resolution is based on the user preferred languages and the languages * supported by the application. The method will try to find the best match. * @param array $languages a list of the languages supported by the application. If this is empty, the current * application language will be returned without further processing. * @return string the language that the application should use. */ public function getPreferredLanguage(array $languages = []) { if (empty($languages)) { return Yii::$app->language; } foreach ($this->getAcceptableLanguages() as $acceptableLanguage) { $acceptableLanguage = str_replace('_', '-', strtolower($acceptableLanguage)); foreach ($languages as $language) { $normalizedLanguage = str_replace('_', '-', strtolower($language)); if ( $normalizedLanguage === $acceptableLanguage // en-us==en-us || strpos($acceptableLanguage, $normalizedLanguage . '-') === 0 // en==en-us || strpos($normalizedLanguage, $acceptableLanguage . '-') === 0 // en-us==en ) { return $language; } } } return reset($languages); } /** * Gets the Etags. * * @return array The entity tags */ public function getETags() { if ($this->headers->has('If-None-Match')) { return preg_split('/[\s,]+/', str_replace('-gzip', '', $this->headers->get('If-None-Match')), -1, PREG_SPLIT_NO_EMPTY); } return []; } /** * Returns the cookie collection. * * Through the returned cookie collection, you may access a cookie using the following syntax: * * ```php * $cookie = $request->cookies['name'] * if ($cookie !== null) { * $value = $cookie->value; * } * * // alternatively * $value = $request->cookies->getValue('name'); * ``` * * @return CookieCollection the cookie collection. */ public function getCookies() { if ($this->_cookies === null) { $this->_cookies = new CookieCollection($this->loadCookies(), [ 'readOnly' => true, ]); } return $this->_cookies; } /** * Converts `$_COOKIE` into an array of [[Cookie]]. * @return array the cookies obtained from request * @throws InvalidConfigException if [[cookieValidationKey]] is not set when [[enableCookieValidation]] is true */ protected function loadCookies() { $cookies = []; if ($this->enableCookieValidation) { if ($this->cookieValidationKey == '') { throw new InvalidConfigException(get_class($this) . '::cookieValidationKey must be configured with a secret key.'); } foreach ($_COOKIE as $name => $value) { if (!is_string($value)) { continue; } $data = Yii::$app->getSecurity()->validateData($value, $this->cookieValidationKey); if ($data === false) { continue; } if (defined('PHP_VERSION_ID') && PHP_VERSION_ID >= 70000) { $data = @unserialize($data, ['allowed_classes' => false]); } else { $data = @unserialize($data); } if (is_array($data) && isset($data[0], $data[1]) && $data[0] === $name) { $cookies[$name] = Yii::createObject([ 'class' => 'yii\web\Cookie', 'name' => $name, 'value' => $data[1], 'expire' => null, ]); } } } else { foreach ($_COOKIE as $name => $value) { $cookies[$name] = Yii::createObject([ 'class' => 'yii\web\Cookie', 'name' => $name, 'value' => $value, 'expire' => null, ]); } } return $cookies; } private $_csrfToken; /** * Returns the token used to perform CSRF validation. * * This token is generated in a way to prevent [BREACH attacks](https://en.wikipedia.org/wiki/BREACH). It may be passed * along via a hidden field of an HTML form or an HTTP header value to support CSRF validation. * @param bool $regenerate whether to regenerate CSRF token. When this parameter is true, each time * this method is called, a new CSRF token will be generated and persisted (in session or cookie). * @return string the token used to perform CSRF validation. */ public function getCsrfToken($regenerate = false) { if ($this->_csrfToken === null || $regenerate) { $token = $this->loadCsrfToken(); if ($regenerate || empty($token)) { $token = $this->generateCsrfToken(); } $this->_csrfToken = Yii::$app->security->maskToken($token); } return $this->_csrfToken; } /** * Loads the CSRF token from cookie or session. * @return string|null the CSRF token loaded from cookie or session. Null is returned if the cookie or session * does not have CSRF token. */ protected function loadCsrfToken() { if ($this->enableCsrfCookie) { return $this->getCookies()->getValue($this->csrfParam); } return Yii::$app->getSession()->get($this->csrfParam); } /** * Generates an unmasked random token used to perform CSRF validation. * @return string the random token for CSRF validation. */ protected function generateCsrfToken() { $token = Yii::$app->getSecurity()->generateRandomString(); if ($this->enableCsrfCookie) { $cookie = $this->createCsrfCookie($token); Yii::$app->getResponse()->getCookies()->add($cookie); } else { Yii::$app->getSession()->set($this->csrfParam, $token); } return $token; } /** * @return string|null the CSRF token sent via [[CSRF_HEADER]] by browser. Null is returned if no such header is sent. */ public function getCsrfTokenFromHeader() { return $this->headers->get(static::CSRF_HEADER); } /** * Creates a cookie with a randomly generated CSRF token. * Initial values specified in [[csrfCookie]] will be applied to the generated cookie. * @param string $token the CSRF token * @return Cookie the generated cookie * @see enableCsrfValidation */ protected function createCsrfCookie($token) { $options = $this->csrfCookie; return Yii::createObject(array_merge($options, [ 'class' => 'yii\web\Cookie', 'name' => $this->csrfParam, 'value' => $token, ])); } /** * Performs the CSRF validation. * * This method will validate the user-provided CSRF token by comparing it with the one stored in cookie or session. * This method is mainly called in [[Controller::beforeAction()]]. * * Note that the method will NOT perform CSRF validation if [[enableCsrfValidation]] is false or the HTTP method * is among GET, HEAD or OPTIONS. * * @param string|null $clientSuppliedToken the user-provided CSRF token to be validated. If null, the token will be retrieved from * the [[csrfParam]] POST field or HTTP header. * This parameter is available since version 2.0.4. * @return bool whether CSRF token is valid. If [[enableCsrfValidation]] is false, this method will return true. */ public function validateCsrfToken($clientSuppliedToken = null) { $method = $this->getMethod(); // only validate CSRF token on non-"safe" methods https://tools.ietf.org/html/rfc2616#section-9.1.1 if (!$this->enableCsrfValidation || in_array($method, ['GET', 'HEAD', 'OPTIONS'], true)) { return true; } $trueToken = $this->getCsrfToken(); if ($clientSuppliedToken !== null) { return $this->validateCsrfTokenInternal($clientSuppliedToken, $trueToken); } return $this->validateCsrfTokenInternal($this->getBodyParam($this->csrfParam), $trueToken) || $this->validateCsrfTokenInternal($this->getCsrfTokenFromHeader(), $trueToken); } /** * Validates CSRF token. * * @param string $clientSuppliedToken The masked client-supplied token. * @param string $trueToken The masked true token. * @return bool */ private function validateCsrfTokenInternal($clientSuppliedToken, $trueToken) { if (!is_string($clientSuppliedToken)) { return false; } $security = Yii::$app->security; return $security->compareString($security->unmaskToken($clientSuppliedToken), $security->unmaskToken($trueToken)); } /** * Gets first `Forwarded` header value for token * * @param string $token Header token * * @return string|null * * @since 2.0.31 */ protected function getSecureForwardedHeaderTrustedPart($token) { $token = strtolower($token); if ($parts = $this->getSecureForwardedHeaderTrustedParts()) { $lastElement = array_pop($parts); if ($lastElement && isset($lastElement[$token])) { return $lastElement[$token]; } } return null; } private $_secureForwardedHeaderTrustedParts; /** * Gets only trusted `Forwarded` header parts * * @return array * * @since 2.0.31 */ protected function getSecureForwardedHeaderTrustedParts() { if ($this->_secureForwardedHeaderTrustedParts !== null) { return $this->_secureForwardedHeaderTrustedParts; } $validator = $this->getIpValidator(); $trustedHosts = []; foreach ($this->trustedHosts as $trustedCidr => $trustedCidrOrHeaders) { if (!is_array($trustedCidrOrHeaders)) { $trustedCidr = $trustedCidrOrHeaders; } $trustedHosts[] = $trustedCidr; } $validator->setRanges($trustedHosts); $this->_secureForwardedHeaderTrustedParts = array_filter( $this->getSecureForwardedHeaderParts(), function ($headerPart) use ($validator) { return isset($headerPart['for']) ? !$validator->validate($headerPart['for']) : true; } ); return $this->_secureForwardedHeaderTrustedParts; } private $_secureForwardedHeaderParts; /** * Returns decoded forwarded header * * @return array * * @since 2.0.31 */ protected function getSecureForwardedHeaderParts() { if ($this->_secureForwardedHeaderParts !== null) { return $this->_secureForwardedHeaderParts; } if (count(preg_grep('/^forwarded$/i', $this->secureHeaders)) === 0) { return $this->_secureForwardedHeaderParts = []; } /* * First header is always correct, because proxy CAN add headers * after last one is found. * Keep in mind that it is NOT enforced, therefore we cannot be * sure, that this is really a first one. * * FPM keeps last header sent which is a bug. You need to merge * headers together on your web server before letting FPM handle it * @see https://bugs.php.net/bug.php?id=78844 */ $forwarded = $this->headers->get('Forwarded', ''); if ($forwarded === '') { return $this->_secureForwardedHeaderParts = []; } preg_match_all('/(?:[^",]++|"[^"]++")+/', $forwarded, $forwardedElements); foreach ($forwardedElements[0] as $forwardedPairs) { preg_match_all('/(?P
\w+)\s*=\s*(?:(?P
[^",;]*[^",;\s])|"(?P
[^"]+)")/', $forwardedPairs, $matches, PREG_SET_ORDER); $this->_secureForwardedHeaderParts[] = array_reduce($matches, function ($carry, $item) { $value = $item['value']; if (isset($item['value2']) && $item['value2'] !== '') { $value = $item['value2']; } $carry[strtolower($item['key'])] = $value; return $carry; }, []); } return $this->_secureForwardedHeaderParts; } }