header = new HttpHeader(); $this->header->l11n = $l11n ?? new Localization(); $this->uri = $uri ?? new HttpUri(''); } /** * Init request. * * This is used in order to either initialize the current http request or a batch of GET requests * * @return void * * @since 1.0.0 */ public function initRequest() : void { $this->initCurrentRequest(); self::cleanupGlobals(); $this->data = \array_change_key_case($this->data, \CASE_LOWER); $this->data = Guard::unslash($this->data); } /** * Init current request * * @return void * * @since 1.0.0 */ private function initCurrentRequest() : void { $this->uri = HttpUri::fromCurrent(); $this->data = $_POST + $_GET; $this->files = $_FILES; $this->header->initCurrentRequest(); $this->header->l11n->language = $this->getRequestLanguage(); $this->header->l11n->country = $this->getRequestCountry(); $this->initNonGetData(); } /** * Init non get data * * @return void * * @throws \Exception * * @since 1.0.0 */ private function initNonGetData() : void { if (!isset($_SERVER['CONTENT_TYPE'])) { return; } if (\stripos($_SERVER['CONTENT_TYPE'], 'application/json') !== false) { // @codeCoverageIgnoreStart // Tested but coverage doesn't show up $stream = \fopen('php://input', 'r'); if ($stream === false) { return; } $input = ''; $size = 0; while (($lineRaw = \fgets($stream, 1024)) !== false) { // Limit json data to 1MB if ($size > 1000000) { \fclose($stream); return; } $input .= $lineRaw; $size += \strlen($lineRaw); } \fclose($stream); if (empty($input)) { return; } $json = \json_decode($input, true); if (!\is_array($json)) { throw new \Exception('Is not valid json ' . $input); } $this->data = $json + $this->data; // @codeCoverageIgnoreEnd } elseif (\stripos($_SERVER['CONTENT_TYPE'], 'application/x-www-form-urlencoded') !== false) { // @codeCoverageIgnoreStart // Tested but coverage doesn't show up $stream = \fopen('php://input', 'r'); if ($stream === false) { return; } $content = ''; $size = 0; while (($lineRaw = \fgets($stream, 1024)) !== false) { // Limit json data to 1MB if ($size > 1000000) { \fclose($stream); return; } $content .= $lineRaw; $size += \strlen($lineRaw); } \fclose($stream); if (empty($content)) { return; } \parse_str($content, $temp); $this->data += $temp; // @codeCoverageIgnoreEnd } elseif (\stripos($_SERVER['CONTENT_TYPE'], 'multipart/form-data') !== false) { // @codeCoverageIgnoreStart // Tested but coverage doesn't show up $stream = \fopen('php://input', 'r'); $partInfo = null; $boundary = null; if ($stream === false) { return; } // @codeCoverageIgnoreEnd while (($lineRaw = \fgets($stream)) !== false) { // @codeCoverageIgnoreStart // Tested but coverage doesn't show up if (\str_starts_with($lineRaw, '--')) { $boundary ??= \rtrim($lineRaw); continue; } $line = \rtrim($lineRaw); if ($line === '') { if (!empty($partInfo['Content-Disposition']['filename'])) { /* Is file */ $tempdir = \sys_get_temp_dir(); $name = $partInfo['Content-Disposition']['name']; $this->files[$name] = []; $this->files[$name]['name'] = $partInfo['Content-Disposition']['filename']; $this->files[$name]['type'] = $partInfo['Content-Type']['value'] ?? null; $tempname = \tempnam($tempdir, 'oms_upl_'); if ($tempname === false) { $this->files[$name]['error'] = \UPLOAD_ERR_NO_TMP_DIR; return; } $outFP = \fopen($tempname, 'wb'); if ($outFP === false) { $this->files[$name]['error'] = \UPLOAD_ERR_CANT_WRITE; return; } $lastLine = null; while (($lineRaw = \fgets($stream, 4096)) !== false) { if ($lastLine !== null) { if ($boundary === null || \str_starts_with($lineRaw, $boundary)) { break; } if (\fwrite($outFP, $lastLine) === false) { $this->files[$name] = \UPLOAD_ERR_CANT_WRITE; return; } } $lastLine = $lineRaw; } if ($lastLine !== null && \fwrite($outFP, \rtrim($lastLine, "\r\n")) === false) { $this->files[$name]['error'] = \UPLOAD_ERR_CANT_WRITE; return; } \fclose($outFP); $this->files[$name]['error'] = \UPLOAD_ERR_OK; $this->files[$name]['size'] = \filesize($tempname); $this->files[$name]['tmp_name'] = $tempname; // @codeCoverageIgnoreEnd } elseif ($partInfo !== null) { /* Is variable */ // @codeCoverageIgnoreStart // Tested but coverage doesn't show up $fullValue = ''; $lastLine = null; while (($lineRaw = \fgets($stream)) !== false && $boundary !== null && !\str_starts_with($lineRaw, $boundary)) { if ($lastLine !== null) { $fullValue .= $lastLine; } $lastLine = $lineRaw; } if ($lastLine !== null) { $fullValue .= \rtrim($lastLine, "\r\n"); } $this->data[$partInfo['Content-Disposition']['name']] = $fullValue; // @codeCoverageIgnoreEnd } $partInfo = null; continue; } // @codeCoverageIgnoreStart // Tested but coverage doesn't show up $delim = \strpos($line, ':'); if ($delim === false) { continue; } $headerKey = \substr($line, 0, $delim); $headerVal = \substr($line, $delim + 1); $header = []; $regex = '/(^|;)\s*(?P[^=:,;\s"]*):?(=("(?P[^"]*(\\.[^"]*)*)")|(\s*(?P[^=,;\s"]*)))?/mx'; $matches = null; \preg_match_all($regex, $headerVal, $matches, \PREG_SET_ORDER); $length = \count($matches); for ($i = 0; $i < $length; ++$i) { $match = $matches[$i]; $name = $match['name']; $quotedValue = $match['quotedValue']; $value = empty($quotedValue) ? $value = $match['value'] : \stripcslashes($quotedValue); if ($name === $headerKey && $i === 0) { $name = 'value'; } elseif ($value === '') { $value = $name; $name = 'value'; } $header[$name] = $value; } $partInfo[$headerKey] = $header; // @codeCoverageIgnoreEnd } \fclose($stream); } } /** * Set request method. * * @param string $method Request method * * @return void * * @since 1.0.0 */ public function setMethod(string $method) : void { $this->method = $method; } /** * Get request language * * @return string * * @since 1.0.0 */ private function getRequestLanguage() : string { $locale = $this->getLocale(); $firstLocalComponents = \explode('_', $locale); $language = \strtolower($firstLocalComponents[0]); return ISO639x1Enum::isValidValue($language) ? $language : 'en'; } /** * Get request country * * @return string * * @since 1.0.0 */ private function getRequestCountry() : string { $locale = $this->getLocale(); $firstLocalComponents = \explode('_', $locale); $country = \strtoupper($firstLocalComponents[1] ?? ''); return ISO3166TwoEnum::isValidValue($country) ? $country : 'US'; } /** * Get request locale * * @return string * * @since 1.0.0 */ public function getLocale() : string { if (!empty($this->locale)) { return $this->locale = $this->header->l11n->language . '_' . $this->header->l11n->country; } if (!isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) { return 'en_US'; } // @codeCoverageIgnoreStart $components = \explode(';', $_SERVER['HTTP_ACCEPT_LANGUAGE']); $locals = \stripos($components[0], ',') !== false ? $locals = \explode(',', $components[0]) : $components; // @codeCoverageIgnoreEnd $this->locale = \strtr($locals[0], '-', '_'); // @codeCoverageIgnore return $this->locale; } /** * Clean up globals that musn't be used any longer * * @return void * * @since 1.0.0 */ public static function cleanupGlobals() : void { unset($_FILES); unset($_GET); unset($_POST); unset($_REQUEST); } /** * Create request from superglobals. * * @return HttpRequest * * @since 1.0.0 */ public static function createFromSuperglobals() : self { $request = new self(); $request->initRequest(); return $request; } /** * Set request uri. * * @param UriInterface $uri Uri * * @return void * * @since 1.0.0 */ public function setUri(UriInterface $uri) : void { $this->uri = $uri; $this->data += $uri->getQueryArray(); } /** * Create request hashs of current request * * The hashes are based on the request path and can be used as unique id. * * @param int $start Start hash from n-th path element * * @return void * * @since 1.0.0 */ public function createRequestHashs(int $start = 0) : void { $this->hash = [\sha1('')]; $pathArray = $this->uri->getPathElements(); $pathLength = \count($pathArray); for ($i = $start; $i < $pathLength; ++$i) { if ($pathArray[$i] === '') { continue; } $paths = []; for ($j = $start; $j <= $i; ++$j) { $paths[] = $pathArray[$j]; } // @bug Since we are hashing the path elements without delimiter /test/path/here is the same as /testpath/here // The reason for doing this without delimiter was probably because of different environments (web vs socket vs console) // However, we could literally choose any delimiter INTERNALLY as long as it is the same across all Request classes. // If this ever gets changed remember to also change the Navigation/ApiController.php file $this->hash[] = \sha1(\implode('', $paths)); } } /** * Is Mobile * * @return bool * * @since 1.0.0 */ public function isMobile() : bool { $useragent = $_SERVER['HTTP_USER_AGENT'] ?? ''; if (\preg_match('/(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows (ce|phone)|xda|xiino/i', $useragent) || \preg_match('/1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i', $useragent)) { return true; // @codeCoverageIgnore } return false; } /** * {@inheritdoc} */ public function getRequestInfo() : array { if (!isset($this->info)) { $this->info['browser'] = $this->getBrowser(); $this->info['os'] = $this->getOS(); } return $this->info; } /** * Determine request browser. * * @return string * * @since 1.0.0 */ public function getBrowser() : string { if (!isset($this->browser)) { $arr = BrowserType::getConstants(); $httpUserAgent = \strtolower($_SERVER['HTTP_USER_AGENT'] ?? ''); foreach ($arr as $key => $val) { if (\stripos($httpUserAgent, $val)) { // @codeCoverageIgnoreStart $this->browser = $val; return $this->browser; // @codeCoverageIgnoreEnd } } $this->browser = BrowserType::UNKNOWN; } return $this->browser; } /** * Set browser type * * @param string $browser Browser type * * @return void * * @since 1.0.0 */ public function setBrowser(string $browser) : void { $this->browser = $browser; } /** * Determine request OS. * * @return string * * @since 1.0.0 */ public function getOS() : string { if (!isset($this->os)) { $arr = OSType::getConstants(); $httpUserAgent = \strtolower($_SERVER['HTTP_USER_AGENT'] ?? ''); foreach ($arr as $val) { if (\stripos($httpUserAgent, $val)) { // @codeCoverageIgnoreStart $this->os = $val; return $this->os; // @codeCoverageIgnoreEnd } } $this->os = OSType::UNKNOWN; } return $this->os; } /** * Set OS type * * @param string $os OS type * * @return void * * @since 1.0.0 */ public function setOS(string $os) : void { $this->os = $os; } /** * {@inheritdoc} */ public function getOrigin() : string { return $_SERVER['REMOTE_ADDR'] ?? '127.0.0.1'; } /** * Is request made via https. * * @param int $port Secure port * * @return bool * * @throws \OutOfRangeException This exception is thrown if the port is out of range * * @since 1.0.0 */ public static function isHttps(int $port = 443) : bool { if ($port < 1 || $port > 65535) { throw new \OutOfRangeException('Value "' . $port . '" is out of range.'); } return (!empty($_SERVER['HTTPS'] ?? '') && ($_SERVER['HTTPS'] ?? '') !== 'off') || (($_SERVER['HTTP_X_FORWARDED_PROTO'] ?? '') === 'https') || (($_SERVER['HTTP_X_FORWARDED_SSL'] ?? '') === 'on') || ($_SERVER['SERVER_PORT'] ?? '') === $port; } /** * {@inheritdoc} */ public function getBody() : string { $body = \file_get_contents('php://input'); return $body === false ? '' : $body; } /** * Get route verb. * * @return int * * @throws \Exception * * @since 1.0.0 */ public function getRouteVerb() : int { switch ($this->getMethod()) { case RequestMethod::GET: return RouteVerb::GET; case RequestMethod::PUT: return RouteVerb::PUT; case RequestMethod::POST: return RouteVerb::SET; case RequestMethod::DELETE: return RouteVerb::DELETE; default: throw new \Exception(); } } /** * Get referer. * * @return string * * @since 1.0.0 */ public function getReferer() : string { return $_SERVER['HTTP_REFERER'] ?? ''; } /** * Get request method. * * @return string * * @since 1.0.0 */ public function getMethod() : string { if (!isset($this->method)) { $this->method = $_SERVER['REQUEST_METHOD'] ?? RequestMethod::GET; } return $this->method; } /** * Perform rest request * * @return HttpResponse * * @since 1.0.0 */ public function rest() : HttpResponse { return Rest::request($this); } /** * {@inheritdoc} */ public function __toString() : string { if ($this->getMethod() === RequestMethod::GET && !empty($this->data)) { return $this->uri->__toString() . (\parse_url($this->uri->__toString(), \PHP_URL_QUERY) ? '&' : '?') . \http_build_query($this->data); } return parent::__toString(); } }