|
|
@@ -0,0 +1,455 @@
|
|
|
+<?php
|
|
|
+/**
|
|
|
+ * HTTP Response from HttpSocket.
|
|
|
+ *
|
|
|
+ * PHP 5
|
|
|
+ *
|
|
|
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
|
|
+ * Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
|
+ *
|
|
|
+ * Licensed under The MIT License
|
|
|
+ * Redistributions of files must retain the above copyright notice.
|
|
|
+ *
|
|
|
+ * @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
|
+ * @link http://cakephp.org CakePHP(tm) Project
|
|
|
+ * @since CakePHP(tm) v 2.0.0
|
|
|
+ * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
|
|
|
+ */
|
|
|
+
|
|
|
+/**
|
|
|
+ * HTTP Response from HttpSocket.
|
|
|
+ *
|
|
|
+ * @package Cake.Network.Http
|
|
|
+ */
|
|
|
+class HttpSocketResponse implements ArrayAccess {
|
|
|
+
|
|
|
+/**
|
|
|
+ * Body content
|
|
|
+ *
|
|
|
+ * @var string
|
|
|
+ */
|
|
|
+ public $body = '';
|
|
|
+
|
|
|
+/**
|
|
|
+ * Headers
|
|
|
+ *
|
|
|
+ * @var array
|
|
|
+ */
|
|
|
+ public $headers = array();
|
|
|
+
|
|
|
+/**
|
|
|
+ * Cookies
|
|
|
+ *
|
|
|
+ * @var array
|
|
|
+ */
|
|
|
+ public $cookies = array();
|
|
|
+
|
|
|
+/**
|
|
|
+ * HTTP version
|
|
|
+ *
|
|
|
+ * @var string
|
|
|
+ */
|
|
|
+ public $httpVersion = 'HTTP/1.1';
|
|
|
+
|
|
|
+/**
|
|
|
+ * Response code
|
|
|
+ *
|
|
|
+ * @var integer
|
|
|
+ */
|
|
|
+ public $code = 0;
|
|
|
+
|
|
|
+/**
|
|
|
+ * Reason phrase
|
|
|
+ *
|
|
|
+ * @var string
|
|
|
+ */
|
|
|
+ public $reasonPhrase = '';
|
|
|
+
|
|
|
+/**
|
|
|
+ * Pure raw content
|
|
|
+ *
|
|
|
+ * @var string
|
|
|
+ */
|
|
|
+ public $raw = '';
|
|
|
+
|
|
|
+/**
|
|
|
+ * Context data in the response.
|
|
|
+ * Contains SSL certificates for example.
|
|
|
+ *
|
|
|
+ * @var array
|
|
|
+ */
|
|
|
+ public $context = array();
|
|
|
+
|
|
|
+/**
|
|
|
+ * Constructor
|
|
|
+ *
|
|
|
+ * @param string $message
|
|
|
+ */
|
|
|
+ public function __construct($message = null) {
|
|
|
+ if ($message !== null) {
|
|
|
+ $this->parseResponse($message);
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * Body content
|
|
|
+ *
|
|
|
+ * @return string
|
|
|
+ */
|
|
|
+ public function body() {
|
|
|
+ return (string)$this->body;
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * Get header in case insensitive
|
|
|
+ *
|
|
|
+ * @param string $name Header name
|
|
|
+ * @param array $headers
|
|
|
+ * @return mixed String if header exists or null
|
|
|
+ */
|
|
|
+ public function getHeader($name, $headers = null) {
|
|
|
+ if (!is_array($headers)) {
|
|
|
+ $headers =& $this->headers;
|
|
|
+ }
|
|
|
+ if (isset($headers[$name])) {
|
|
|
+ return $headers[$name];
|
|
|
+ }
|
|
|
+ foreach ($headers as $key => $value) {
|
|
|
+ if (strcasecmp($key, $name) === 0) {
|
|
|
+ return $value;
|
|
|
+ }
|
|
|
+ }
|
|
|
+ return null;
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * If return is 200 (OK)
|
|
|
+ *
|
|
|
+ * @return boolean
|
|
|
+ */
|
|
|
+ public function isOk() {
|
|
|
+ return $this->code == 200;
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * If return is a valid 3xx (Redirection)
|
|
|
+ *
|
|
|
+ * @return boolean
|
|
|
+ */
|
|
|
+ public function isRedirect() {
|
|
|
+ return in_array($this->code, array(301, 302, 303, 307)) && !is_null($this->getHeader('Location'));
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * Parses the given message and breaks it down in parts.
|
|
|
+ *
|
|
|
+ * @param string $message Message to parse
|
|
|
+ * @return void
|
|
|
+ * @throws SocketException
|
|
|
+ */
|
|
|
+ public function parseResponse($message) {
|
|
|
+ if (!is_string($message)) {
|
|
|
+ throw new SocketException(__d('cake_dev', 'Invalid response.'));
|
|
|
+ }
|
|
|
+
|
|
|
+ if (!preg_match("/^(.+\r\n)(.*)(?<=\r\n)\r\n/Us", $message, $match)) {
|
|
|
+ throw new SocketException(__d('cake_dev', 'Invalid HTTP response.'));
|
|
|
+ }
|
|
|
+
|
|
|
+ list(, $statusLine, $header) = $match;
|
|
|
+ $this->raw = $message;
|
|
|
+ $this->body = (string)substr($message, strlen($match[0]));
|
|
|
+
|
|
|
+ if (preg_match("/(.+) ([0-9]{3}) (.+)\r\n/DU", $statusLine, $match)) {
|
|
|
+ $this->httpVersion = $match[1];
|
|
|
+ $this->code = $match[2];
|
|
|
+ $this->reasonPhrase = $match[3];
|
|
|
+ }
|
|
|
+
|
|
|
+ $this->headers = $this->_parseHeader($header);
|
|
|
+ $transferEncoding = $this->getHeader('Transfer-Encoding');
|
|
|
+ $decoded = $this->_decodeBody($this->body, $transferEncoding);
|
|
|
+ $this->body = $decoded['body'];
|
|
|
+
|
|
|
+ if (!empty($decoded['header'])) {
|
|
|
+ $this->headers = $this->_parseHeader($this->_buildHeader($this->headers) . $this->_buildHeader($decoded['header']));
|
|
|
+ }
|
|
|
+
|
|
|
+ if (!empty($this->headers)) {
|
|
|
+ $this->cookies = $this->parseCookies($this->headers);
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * Generic function to decode a $body with a given $encoding. Returns either an array with the keys
|
|
|
+ * 'body' and 'header' or false on failure.
|
|
|
+ *
|
|
|
+ * @param string $body A string containing the body to decode.
|
|
|
+ * @param string|boolean $encoding Can be false in case no encoding is being used, or a string representing the encoding.
|
|
|
+ * @return mixed Array of response headers and body or false.
|
|
|
+ */
|
|
|
+ protected function _decodeBody($body, $encoding = 'chunked') {
|
|
|
+ if (!is_string($body)) {
|
|
|
+ return false;
|
|
|
+ }
|
|
|
+ if (empty($encoding)) {
|
|
|
+ return array('body' => $body, 'header' => false);
|
|
|
+ }
|
|
|
+ $decodeMethod = '_decode' . Inflector::camelize(str_replace('-', '_', $encoding)) . 'Body';
|
|
|
+
|
|
|
+ if (!is_callable(array(&$this, $decodeMethod))) {
|
|
|
+ return array('body' => $body, 'header' => false);
|
|
|
+ }
|
|
|
+ return $this->{$decodeMethod}($body);
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * Decodes a chunked message $body and returns either an array with the keys 'body' and 'header' or false as
|
|
|
+ * a result.
|
|
|
+ *
|
|
|
+ * @param string $body A string containing the chunked body to decode.
|
|
|
+ * @return mixed Array of response headers and body or false.
|
|
|
+ * @throws SocketException
|
|
|
+ */
|
|
|
+ protected function _decodeChunkedBody($body) {
|
|
|
+ if (!is_string($body)) {
|
|
|
+ return false;
|
|
|
+ }
|
|
|
+
|
|
|
+ $decodedBody = null;
|
|
|
+ $chunkLength = null;
|
|
|
+
|
|
|
+ while ($chunkLength !== 0) {
|
|
|
+ if (!preg_match('/^([0-9a-f]+) *(?:;(.+)=(.+))?(?:\r\n|\n)/iU', $body, $match)) {
|
|
|
+ throw new SocketException(__d('cake_dev', 'HttpSocket::_decodeChunkedBody - Could not parse malformed chunk.'));
|
|
|
+ }
|
|
|
+
|
|
|
+ $chunkSize = 0;
|
|
|
+ $hexLength = 0;
|
|
|
+ $chunkExtensionName = '';
|
|
|
+ $chunkExtensionValue = '';
|
|
|
+ if (isset($match[0])) {
|
|
|
+ $chunkSize = $match[0];
|
|
|
+ }
|
|
|
+ if (isset($match[1])) {
|
|
|
+ $hexLength = $match[1];
|
|
|
+ }
|
|
|
+ if (isset($match[2])) {
|
|
|
+ $chunkExtensionName = $match[2];
|
|
|
+ }
|
|
|
+ if (isset($match[3])) {
|
|
|
+ $chunkExtensionValue = $match[3];
|
|
|
+ }
|
|
|
+
|
|
|
+ $body = substr($body, strlen($chunkSize));
|
|
|
+ $chunkLength = hexdec($hexLength);
|
|
|
+ $chunk = substr($body, 0, $chunkLength);
|
|
|
+ if (!empty($chunkExtensionName)) {
|
|
|
+ // @todo See if there are popular chunk extensions we should implement
|
|
|
+ }
|
|
|
+ $decodedBody .= $chunk;
|
|
|
+ if ($chunkLength !== 0) {
|
|
|
+ $body = substr($body, $chunkLength + strlen("\r\n"));
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ $entityHeader = false;
|
|
|
+ if (!empty($body)) {
|
|
|
+ $entityHeader = $this->_parseHeader($body);
|
|
|
+ }
|
|
|
+ return array('body' => $decodedBody, 'header' => $entityHeader);
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * Parses an array based header.
|
|
|
+ *
|
|
|
+ * @param array $header Header as an indexed array (field => value)
|
|
|
+ * @return array Parsed header
|
|
|
+ */
|
|
|
+ protected function _parseHeader($header) {
|
|
|
+ if (is_array($header)) {
|
|
|
+ return $header;
|
|
|
+ } elseif (!is_string($header)) {
|
|
|
+ return false;
|
|
|
+ }
|
|
|
+
|
|
|
+ preg_match_all("/(.+):(.+)(?:(?<![\t ])\r\n|\$)/Uis", $header, $matches, PREG_SET_ORDER);
|
|
|
+
|
|
|
+ $header = array();
|
|
|
+ foreach ($matches as $match) {
|
|
|
+ list(, $field, $value) = $match;
|
|
|
+
|
|
|
+ $value = trim($value);
|
|
|
+ $value = preg_replace("/[\t ]\r\n/", "\r\n", $value);
|
|
|
+
|
|
|
+ $field = $this->_unescapeToken($field);
|
|
|
+
|
|
|
+ if (!isset($header[$field])) {
|
|
|
+ $header[$field] = $value;
|
|
|
+ } else {
|
|
|
+ $header[$field] = array_merge((array)$header[$field], (array)$value);
|
|
|
+ }
|
|
|
+ }
|
|
|
+ return $header;
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * Parses cookies in response headers.
|
|
|
+ *
|
|
|
+ * @param array $header Header array containing one ore more 'Set-Cookie' headers.
|
|
|
+ * @return mixed Either false on no cookies, or an array of cookies received.
|
|
|
+ * @todo Make this 100% RFC 2965 confirm
|
|
|
+ */
|
|
|
+ public function parseCookies($header) {
|
|
|
+ $cookieHeader = $this->getHeader('Set-Cookie', $header);
|
|
|
+ if (!$cookieHeader) {
|
|
|
+ return false;
|
|
|
+ }
|
|
|
+
|
|
|
+ $cookies = array();
|
|
|
+ foreach ((array)$cookieHeader as $cookie) {
|
|
|
+ if (strpos($cookie, '";"') !== false) {
|
|
|
+ $cookie = str_replace('";"', "{__cookie_replace__}", $cookie);
|
|
|
+ $parts = str_replace("{__cookie_replace__}", '";"', explode(';', $cookie));
|
|
|
+ } else {
|
|
|
+ $parts = preg_split('/\;[ \t]*/', $cookie);
|
|
|
+ }
|
|
|
+
|
|
|
+ list($name, $value) = explode('=', array_shift($parts), 2);
|
|
|
+ $cookies[$name] = compact('value');
|
|
|
+
|
|
|
+ foreach ($parts as $part) {
|
|
|
+ if (strpos($part, '=') !== false) {
|
|
|
+ list($key, $value) = explode('=', $part);
|
|
|
+ } else {
|
|
|
+ $key = $part;
|
|
|
+ $value = true;
|
|
|
+ }
|
|
|
+
|
|
|
+ $key = strtolower($key);
|
|
|
+ if (!isset($cookies[$name][$key])) {
|
|
|
+ $cookies[$name][$key] = $value;
|
|
|
+ }
|
|
|
+ }
|
|
|
+ }
|
|
|
+ return $cookies;
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * Unescapes a given $token according to RFC 2616 (HTTP 1.1 specs)
|
|
|
+ *
|
|
|
+ * @param string $token Token to unescape
|
|
|
+ * @param array $chars
|
|
|
+ * @return string Unescaped token
|
|
|
+ * @todo Test $chars parameter
|
|
|
+ */
|
|
|
+ protected function _unescapeToken($token, $chars = null) {
|
|
|
+ $regex = '/"([' . implode('', $this->_tokenEscapeChars(true, $chars)) . '])"/';
|
|
|
+ $token = preg_replace($regex, '\\1', $token);
|
|
|
+ return $token;
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * Gets escape chars according to RFC 2616 (HTTP 1.1 specs).
|
|
|
+ *
|
|
|
+ * @param boolean $hex true to get them as HEX values, false otherwise
|
|
|
+ * @param array $chars
|
|
|
+ * @return array Escape chars
|
|
|
+ * @todo Test $chars parameter
|
|
|
+ */
|
|
|
+ protected function _tokenEscapeChars($hex = true, $chars = null) {
|
|
|
+ if (!empty($chars)) {
|
|
|
+ $escape = $chars;
|
|
|
+ } else {
|
|
|
+ $escape = array('"', "(", ")", "<", ">", "@", ",", ";", ":", "\\", "/", "[", "]", "?", "=", "{", "}", " ");
|
|
|
+ for ($i = 0; $i <= 31; $i++) {
|
|
|
+ $escape[] = chr($i);
|
|
|
+ }
|
|
|
+ $escape[] = chr(127);
|
|
|
+ }
|
|
|
+
|
|
|
+ if (!$hex) {
|
|
|
+ return $escape;
|
|
|
+ }
|
|
|
+ foreach ($escape as $key => $char) {
|
|
|
+ $escape[$key] = '\\x' . str_pad(dechex(ord($char)), 2, '0', STR_PAD_LEFT);
|
|
|
+ }
|
|
|
+ return $escape;
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * ArrayAccess - Offset Exists
|
|
|
+ *
|
|
|
+ * @param string $offset
|
|
|
+ * @return boolean
|
|
|
+ */
|
|
|
+ public function offsetExists($offset) {
|
|
|
+ return in_array($offset, array('raw', 'status', 'header', 'body', 'cookies'));
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * ArrayAccess - Offset Get
|
|
|
+ *
|
|
|
+ * @param string $offset
|
|
|
+ * @return mixed
|
|
|
+ */
|
|
|
+ public function offsetGet($offset) {
|
|
|
+ switch ($offset) {
|
|
|
+ case 'raw':
|
|
|
+ $firstLineLength = strpos($this->raw, "\r\n") + 2;
|
|
|
+ if ($this->raw[$firstLineLength] === "\r") {
|
|
|
+ $header = null;
|
|
|
+ } else {
|
|
|
+ $header = substr($this->raw, $firstLineLength, strpos($this->raw, "\r\n\r\n") - $firstLineLength) . "\r\n";
|
|
|
+ }
|
|
|
+ return array(
|
|
|
+ 'status-line' => $this->httpVersion . ' ' . $this->code . ' ' . $this->reasonPhrase . "\r\n",
|
|
|
+ 'header' => $header,
|
|
|
+ 'body' => $this->body,
|
|
|
+ 'response' => $this->raw
|
|
|
+ );
|
|
|
+ case 'status':
|
|
|
+ return array(
|
|
|
+ 'http-version' => $this->httpVersion,
|
|
|
+ 'code' => $this->code,
|
|
|
+ 'reason-phrase' => $this->reasonPhrase
|
|
|
+ );
|
|
|
+ case 'header':
|
|
|
+ return $this->headers;
|
|
|
+ case 'body':
|
|
|
+ return $this->body;
|
|
|
+ case 'cookies':
|
|
|
+ return $this->cookies;
|
|
|
+ }
|
|
|
+ return null;
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * ArrayAccess - Offset Set
|
|
|
+ *
|
|
|
+ * @param string $offset
|
|
|
+ * @param mixed $value
|
|
|
+ * @return void
|
|
|
+ */
|
|
|
+ public function offsetSet($offset, $value) {
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * ArrayAccess - Offset Unset
|
|
|
+ *
|
|
|
+ * @param string $offset
|
|
|
+ * @return void
|
|
|
+ */
|
|
|
+ public function offsetUnset($offset) {
|
|
|
+ }
|
|
|
+
|
|
|
+/**
|
|
|
+ * Instance as string
|
|
|
+ *
|
|
|
+ * @return string
|
|
|
+ */
|
|
|
+ public function __toString() {
|
|
|
+ return $this->body();
|
|
|
+ }
|
|
|
+
|
|
|
+}
|
Mark Story