| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458 |
- <?php
- declare(strict_types=1);
- namespace GuzzleHttp\Psr7;
- use InvalidArgumentException;
- use Psr\Http\Message\ServerRequestInterface;
- use Psr\Http\Message\StreamInterface;
- use Psr\Http\Message\UploadedFileInterface;
- use Psr\Http\Message\UriInterface;
- /**
- * Server-side HTTP request
- *
- * Extends the Request definition to add methods for accessing incoming data,
- * specifically server parameters, cookies, matched path parameters, query
- * string arguments, body parameters, and upload file information.
- *
- * "Attributes" are discovered via decomposing the request (and usually
- * specifically the URI path), and typically will be injected by the application.
- *
- * Requests are considered immutable; all methods that might change state are
- * implemented such that they retain the internal state of the current
- * message and return a new instance that contains the changed state.
- */
- class ServerRequest extends Request implements ServerRequestInterface
- {
- /**
- * @var array
- */
- private $attributes = [];
- /**
- * @var array
- */
- private $cookieParams = [];
- /**
- * @var array|object|null
- */
- private $parsedBody;
- /**
- * @var array
- */
- private $queryParams = [];
- /**
- * @var array
- */
- private $serverParams;
- /**
- * @var array
- */
- private $uploadedFiles = [];
- /**
- * @param string $method HTTP method
- * @param string|UriInterface $uri URI
- * @param (string|string[])[] $headers Request headers
- * @param string|resource|StreamInterface|null $body Request body
- * @param string $version Protocol version
- * @param array $serverParams Typically the $_SERVER superglobal
- */
- public function __construct(
- string $method,
- $uri,
- array $headers = [],
- $body = null,
- string $version = '1.1',
- array $serverParams = []
- ) {
- $this->serverParams = $serverParams;
- parent::__construct($method, $uri, $headers, $body, $version);
- }
- /**
- * Return an UploadedFile instance array.
- *
- * @param array $files An array which respect $_FILES structure
- *
- * @throws InvalidArgumentException for unrecognized values
- */
- public static function normalizeFiles(array $files): array
- {
- $normalized = [];
- foreach ($files as $key => $value) {
- if ($value instanceof UploadedFileInterface) {
- $normalized[$key] = $value;
- } elseif (is_array($value) && isset($value['tmp_name'])) {
- $normalized[$key] = self::createUploadedFileFromSpec($value);
- } elseif (is_array($value)) {
- $normalized[$key] = self::normalizeFiles($value);
- continue;
- } else {
- throw new InvalidArgumentException('Invalid value in files specification');
- }
- }
- return $normalized;
- }
- /**
- * Create and return an UploadedFile instance from a $_FILES specification.
- *
- * If the specification represents an array of values, this method will
- * delegate to normalizeNestedFileSpec() and return that return value.
- *
- * @param array $value $_FILES struct
- *
- * @return UploadedFileInterface|UploadedFileInterface[]
- */
- private static function createUploadedFileFromSpec(array $value)
- {
- if (is_array($value['tmp_name'])) {
- return self::normalizeNestedFileSpec($value);
- }
- return new UploadedFile(
- $value['tmp_name'],
- (int) $value['size'],
- (int) $value['error'],
- $value['name'],
- $value['type']
- );
- }
- /**
- * Normalize an array of file specifications.
- *
- * Loops through all nested files and returns a normalized array of
- * UploadedFileInterface instances.
- *
- * @return UploadedFileInterface[]
- */
- private static function normalizeNestedFileSpec(array $files = []): array
- {
- $normalizedFiles = [];
- foreach (array_keys($files['tmp_name']) as $key) {
- $spec = [
- 'tmp_name' => $files['tmp_name'][$key],
- 'size' => $files['size'][$key] ?? null,
- 'error' => $files['error'][$key] ?? null,
- 'name' => $files['name'][$key] ?? null,
- 'type' => $files['type'][$key] ?? null,
- ];
- $normalizedFiles[$key] = self::createUploadedFileFromSpec($spec);
- }
- return $normalizedFiles;
- }
- /**
- * Return a ServerRequest populated with superglobals:
- * $_GET
- * $_POST
- * $_COOKIE
- * $_FILES
- * $_SERVER
- */
- public static function fromGlobals(): ServerRequestInterface
- {
- $method = Utils::asciiToUpper(self::getServerParam('REQUEST_METHOD') ?? 'GET');
- $headers = self::removeInvalidHostHeader(self::getAllHeaders());
- $uri = self::getUriFromGlobals();
- $body = new CachingStream(new LazyOpenStream('php://input', 'r+'));
- $serverProtocol = self::getServerParam('SERVER_PROTOCOL');
- $protocol = $serverProtocol !== null ? str_replace('HTTP/', '', $serverProtocol) : '1.1';
- $serverRequest = new ServerRequest($method, $uri, $headers, $body, $protocol, $_SERVER);
- return $serverRequest
- ->withCookieParams($_COOKIE)
- ->withQueryParams($_GET)
- ->withParsedBody($_POST)
- ->withUploadedFiles(self::normalizeFiles($_FILES));
- }
- /**
- * @return array<array-key, string>
- */
- private static function getAllHeaders(): array
- {
- return self::normalizeHeaderValues(getallheaders());
- }
- /**
- * @param array<array-key, mixed> $headers
- *
- * @return array<array-key, string>
- */
- private static function normalizeHeaderValues(array $headers): array
- {
- $normalized = [];
- foreach ($headers as $name => $value) {
- if (is_scalar($value) || (is_object($value) && method_exists($value, '__toString'))) {
- $normalized[$name] = (string) $value;
- }
- }
- return $normalized;
- }
- private static function getServerParam(string $key): ?string
- {
- return isset($_SERVER[$key]) && is_string($_SERVER[$key]) ? $_SERVER[$key] : null;
- }
- /**
- * @param array<array-key, string> $headers
- *
- * @return array<array-key, string>
- */
- private static function removeInvalidHostHeader(array $headers): array
- {
- foreach ($headers as $name => $value) {
- if (Utils::asciiToLower((string) $name) !== 'host') {
- continue;
- }
- if (Rfc7230::parseHostHeader($value) === null) {
- unset($headers[$name]);
- }
- }
- return $headers;
- }
- /**
- * @return array{0: string|null, 1: int|null}
- */
- private static function extractHostAndPortFromAuthority(string $authority): array
- {
- return Rfc7230::parseHostHeader($authority) ?? [null, null];
- }
- /**
- * Get a Uri populated with values from $_SERVER.
- */
- public static function getUriFromGlobals(): UriInterface
- {
- $uri = new Uri('');
- $https = self::getServerParam('HTTPS');
- $uri = $uri->withScheme(!empty($https) && $https !== 'off' ? 'https' : 'http');
- $hasPort = false;
- $authority = self::getServerParam('HTTP_HOST');
- if ($authority !== null) {
- [$host, $port] = self::extractHostAndPortFromAuthority($authority);
- if ($host !== null) {
- $uri = $uri->withHost($host);
- }
- if ($port !== null) {
- $hasPort = true;
- $uri = $uri->withPort($port);
- }
- } elseif (($serverName = self::getServerParam('SERVER_NAME')) !== null) {
- $uri = $uri->withHost($serverName);
- } elseif (($serverAddr = self::getServerParam('SERVER_ADDR')) !== null) {
- $uri = $uri->withHost($serverAddr);
- }
- $serverPort = self::getServerParam('SERVER_PORT');
- if (!$hasPort && $serverPort !== null && preg_match('/^[+-]?\d+$/D', $serverPort) === 1) {
- $uri = $uri->withPort((int) $serverPort);
- }
- $hasQuery = false;
- $requestUri = self::getServerParam('REQUEST_URI');
- if ($requestUri !== null) {
- $requestUriParts = explode('?', $requestUri, 2);
- $uri = $uri->withPath($requestUriParts[0]);
- if (isset($requestUriParts[1])) {
- $hasQuery = true;
- $uri = $uri->withQuery($requestUriParts[1]);
- }
- }
- $queryString = self::getServerParam('QUERY_STRING');
- if (!$hasQuery && $queryString !== null) {
- $uri = $uri->withQuery($queryString);
- }
- return $uri;
- }
- public function getServerParams(): array
- {
- return $this->serverParams;
- }
- public function getUploadedFiles(): array
- {
- return $this->uploadedFiles;
- }
- public function withUploadedFiles(array $uploadedFiles): ServerRequestInterface
- {
- $invalidUploadedFileFound = false;
- $invalidUploadedFile = null;
- $stack = [$uploadedFiles];
- while ($stack !== []) {
- foreach (\array_pop($stack) as $uploadedFile) {
- if ($uploadedFile instanceof UploadedFileInterface) {
- continue;
- }
- if (\is_array($uploadedFile)) {
- $stack[] = $uploadedFile;
- continue;
- }
- $invalidUploadedFileFound = true;
- $invalidUploadedFile = $uploadedFile;
- break 2;
- }
- }
- if ($invalidUploadedFileFound) {
- \trigger_deprecation(
- 'guzzlehttp/psr7',
- '2.11',
- 'Passing %s inside ServerRequestInterface::withUploadedFiles() is deprecated; guzzlehttp/psr7 3.0 requires an UploadedFileInterface[] tree.',
- \get_debug_type($invalidUploadedFile)
- );
- }
- $new = clone $this;
- $new->uploadedFiles = $uploadedFiles;
- return $new;
- }
- public function getCookieParams(): array
- {
- return $this->cookieParams;
- }
- public function withCookieParams(array $cookies): ServerRequestInterface
- {
- $new = clone $this;
- $new->cookieParams = $cookies;
- return $new;
- }
- public function getQueryParams(): array
- {
- return $this->queryParams;
- }
- public function withQueryParams(array $query): ServerRequestInterface
- {
- $new = clone $this;
- $new->queryParams = $query;
- return $new;
- }
- /**
- * @return array|object|null
- */
- public function getParsedBody()
- {
- return $this->parsedBody;
- }
- public function withParsedBody($data): ServerRequestInterface
- {
- if ($data !== null && !\is_array($data) && !\is_object($data)) {
- \trigger_deprecation(
- 'guzzlehttp/psr7',
- '2.11',
- 'Passing %s to ServerRequestInterface::withParsedBody() is deprecated; guzzlehttp/psr7 3.0 requires array|object|null.',
- \get_debug_type($data)
- );
- }
- $new = clone $this;
- $new->parsedBody = $data;
- return $new;
- }
- public function getAttributes(): array
- {
- return $this->attributes;
- }
- /**
- * @return mixed
- */
- public function getAttribute($attribute, $default = null)
- {
- if (!\is_string($attribute)) {
- \trigger_deprecation(
- 'guzzlehttp/psr7',
- '2.11',
- 'Passing %s to ServerRequestInterface::getAttribute() is deprecated; guzzlehttp/psr7 3.0 requires string for $attribute.',
- \get_debug_type($attribute)
- );
- }
- if (false === array_key_exists($attribute, $this->attributes)) {
- return $default;
- }
- return $this->attributes[$attribute];
- }
- public function withAttribute($attribute, $value): ServerRequestInterface
- {
- if (!\is_string($attribute)) {
- \trigger_deprecation(
- 'guzzlehttp/psr7',
- '2.11',
- 'Passing %s to ServerRequestInterface::withAttribute() is deprecated; guzzlehttp/psr7 3.0 requires string for $attribute.',
- \get_debug_type($attribute)
- );
- }
- $new = clone $this;
- $new->attributes[$attribute] = $value;
- return $new;
- }
- public function withoutAttribute($attribute): ServerRequestInterface
- {
- if (!\is_string($attribute)) {
- \trigger_deprecation(
- 'guzzlehttp/psr7',
- '2.11',
- 'Passing %s to ServerRequestInterface::withoutAttribute() is deprecated; guzzlehttp/psr7 3.0 requires string for $attribute.',
- \get_debug_type($attribute)
- );
- }
- if (false === array_key_exists($attribute, $this->attributes)) {
- return $this;
- }
- $new = clone $this;
- unset($new->attributes[$attribute]);
- return $new;
- }
- }
|