Chris@0: <?php
Chris@0: /**
Chris@12:  * @see       https://github.com/zendframework/zend-diactoros for the canonical source repository
Chris@12:  * @copyright Copyright (c) 2015-2017 Zend Technologies USA Inc. (http://www.zend.com)
Chris@0:  * @license   https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
Chris@0:  */
Chris@0: 
Chris@0: namespace Zend\Diactoros;
Chris@0: 
Chris@0: use InvalidArgumentException;
Chris@0: use Psr\Http\Message\UploadedFileInterface;
Chris@0: use stdClass;
Chris@0: use UnexpectedValueException;
Chris@0: 
Chris@16: use function array_change_key_case;
Chris@16: use function array_key_exists;
Chris@16: use function explode;
Chris@16: use function implode;
Chris@16: use function is_array;
Chris@16: use function is_callable;
Chris@16: use function strtolower;
Chris@16: 
Chris@16: use const CASE_LOWER;
Chris@16: 
Chris@0: /**
Chris@0:  * Class for marshaling a request object from the current PHP environment.
Chris@0:  *
Chris@0:  * Logic largely refactored from the ZF2 Zend\Http\PhpEnvironment\Request class.
Chris@0:  *
Chris@0:  * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
Chris@0:  * @license   http://framework.zend.com/license/new-bsd New BSD License
Chris@0:  */
Chris@0: abstract class ServerRequestFactory
Chris@0: {
Chris@0:     /**
Chris@0:      * Function to use to get apache request headers; present only to simplify mocking.
Chris@0:      *
Chris@0:      * @var callable
Chris@0:      */
Chris@0:     private static $apacheRequestHeaders = 'apache_request_headers';
Chris@0: 
Chris@0:     /**
Chris@0:      * Create a request from the supplied superglobal values.
Chris@0:      *
Chris@0:      * If any argument is not supplied, the corresponding superglobal value will
Chris@0:      * be used.
Chris@0:      *
Chris@0:      * The ServerRequest created is then passed to the fromServer() method in
Chris@0:      * order to marshal the request URI and headers.
Chris@0:      *
Chris@0:      * @see fromServer()
Chris@0:      * @param array $server $_SERVER superglobal
Chris@0:      * @param array $query $_GET superglobal
Chris@0:      * @param array $body $_POST superglobal
Chris@0:      * @param array $cookies $_COOKIE superglobal
Chris@0:      * @param array $files $_FILES superglobal
Chris@0:      * @return ServerRequest
Chris@0:      * @throws InvalidArgumentException for invalid file values
Chris@0:      */
Chris@0:     public static function fromGlobals(
Chris@0:         array $server = null,
Chris@0:         array $query = null,
Chris@0:         array $body = null,
Chris@0:         array $cookies = null,
Chris@0:         array $files = null
Chris@0:     ) {
Chris@16:         $server = normalizeServer(
Chris@16:             $server ?: $_SERVER,
Chris@16:             is_callable(self::$apacheRequestHeaders) ? self::$apacheRequestHeaders : null
Chris@16:         );
Chris@16:         $files   = normalizeUploadedFiles($files ?: $_FILES);
Chris@16:         $headers = marshalHeadersFromSapi($server);
Chris@0: 
Chris@0:         if (null === $cookies && array_key_exists('cookie', $headers)) {
Chris@16:             $cookies = parseCookieHeader($headers['cookie']);
Chris@0:         }
Chris@0: 
Chris@0:         return new ServerRequest(
Chris@0:             $server,
Chris@0:             $files,
Chris@16:             marshalUriFromSapi($server, $headers),
Chris@16:             marshalMethodFromSapi($server),
Chris@0:             'php://input',
Chris@0:             $headers,
Chris@0:             $cookies ?: $_COOKIE,
Chris@0:             $query ?: $_GET,
Chris@0:             $body ?: $_POST,
Chris@16:             marshalProtocolVersionFromSapi($server)
Chris@0:         );
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Access a value in an array, returning a default value if not found
Chris@0:      *
Chris@16:      * @deprecated since 1.8.0; no longer used internally.
Chris@0:      * @param string $key
Chris@0:      * @param array $values
Chris@0:      * @param mixed $default
Chris@0:      * @return mixed
Chris@0:      */
Chris@0:     public static function get($key, array $values, $default = null)
Chris@0:     {
Chris@0:         if (array_key_exists($key, $values)) {
Chris@0:             return $values[$key];
Chris@0:         }
Chris@0: 
Chris@0:         return $default;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Search for a header value.
Chris@0:      *
Chris@0:      * Does a case-insensitive search for a matching header.
Chris@0:      *
Chris@0:      * If found, it is returned as a string, using comma concatenation.
Chris@0:      *
Chris@0:      * If not, the $default is returned.
Chris@0:      *
Chris@16:      * @deprecated since 1.8.0; no longer used internally.
Chris@0:      * @param string $header
Chris@0:      * @param array $headers
Chris@0:      * @param mixed $default
Chris@0:      * @return string
Chris@0:      */
Chris@0:     public static function getHeader($header, array $headers, $default = null)
Chris@0:     {
Chris@17:         $header  = strtolower($header);
Chris@0:         $headers = array_change_key_case($headers, CASE_LOWER);
Chris@0:         if (array_key_exists($header, $headers)) {
Chris@0:             $value = is_array($headers[$header]) ? implode(', ', $headers[$header]) : $headers[$header];
Chris@0:             return $value;
Chris@0:         }
Chris@0: 
Chris@0:         return $default;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Marshal the $_SERVER array
Chris@0:      *
Chris@0:      * Pre-processes and returns the $_SERVER superglobal.
Chris@0:      *
Chris@16:      * @deprected since 1.8.0; use Zend\Diactoros\normalizeServer() instead.
Chris@0:      * @param array $server
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public static function normalizeServer(array $server)
Chris@0:     {
Chris@16:         return normalizeServer(
Chris@16:             $server ?: $_SERVER,
Chris@16:             is_callable(self::$apacheRequestHeaders) ? self::$apacheRequestHeaders : null
Chris@16:         );
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Normalize uploaded files
Chris@0:      *
Chris@0:      * Transforms each value into an UploadedFileInterface instance, and ensures
Chris@0:      * that nested arrays are normalized.
Chris@0:      *
Chris@16:      * @deprecated since 1.8.0; use \Zend\Diactoros\normalizeUploadedFiles instead.
Chris@0:      * @param array $files
Chris@0:      * @return array
Chris@0:      * @throws InvalidArgumentException for unrecognized values
Chris@0:      */
Chris@0:     public static function normalizeFiles(array $files)
Chris@0:     {
Chris@16:         return normalizeUploadedFiles($files);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Marshal headers from $_SERVER
Chris@0:      *
Chris@16:      * @deprecated since 1.8.0; use Zend\Diactoros\marshalHeadersFromSapi().
Chris@0:      * @param array $server
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public static function marshalHeaders(array $server)
Chris@0:     {
Chris@16:         return marshalHeadersFromSapi($server);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Marshal the URI from the $_SERVER array and headers
Chris@0:      *
Chris@16:      * @deprecated since 1.8.0; use Zend\Diactoros\marshalUriFromSapi() instead.
Chris@0:      * @param array $server
Chris@0:      * @param array $headers
Chris@0:      * @return Uri
Chris@0:      */
Chris@0:     public static function marshalUriFromServer(array $server, array $headers)
Chris@0:     {
Chris@16:         return marshalUriFromSapi($server, $headers);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Marshal the host and port from HTTP headers and/or the PHP environment
Chris@0:      *
Chris@16:      * @deprecated since 1.8.0; use Zend\Diactoros\marshalUriFromSapi() instead,
Chris@16:      *     and pull the host and port from the Uri instance that function
Chris@16:      *     returns.
Chris@0:      * @param stdClass $accumulator
Chris@0:      * @param array $server
Chris@0:      * @param array $headers
Chris@0:      */
Chris@0:     public static function marshalHostAndPortFromHeaders(stdClass $accumulator, array $server, array $headers)
Chris@0:     {
Chris@16:         $uri = marshalUriFromSapi($server, $headers);
Chris@16:         $accumulator->host = $uri->getHost();
Chris@16:         $accumulator->port = $uri->getPort();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Detect the base URI for the request
Chris@0:      *
Chris@0:      * Looks at a variety of criteria in order to attempt to autodetect a base
Chris@0:      * URI, including rewrite URIs, proxy URIs, etc.
Chris@0:      *
Chris@16:      * @deprecated since 1.8.0; use Zend\Diactoros\marshalUriFromSapi() instead,
Chris@16:      *     and pull the path from the Uri instance that function returns.
Chris@0:      * @param array $server
Chris@0:      * @return string
Chris@0:      */
Chris@0:     public static function marshalRequestUri(array $server)
Chris@0:     {
Chris@16:         $uri = marshalUriFromSapi($server, []);
Chris@16:         return $uri->getPath();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Strip the query string from a path
Chris@0:      *
Chris@16:      * @deprecated since 1.8.0; no longer used internally.
Chris@0:      * @param mixed $path
Chris@0:      * @return string
Chris@0:      */
Chris@0:     public static function stripQueryString($path)
Chris@0:     {
Chris@16:         return explode('?', $path, 2)[0];
Chris@0:     }
Chris@0: }