X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FHelper%2FHttp.php;h=e3d03644ab473131203325c9c3736d00e9af7fd8;hb=bcf72dda17486e2800b66c4527bc4b5f4d54fc7a;hp=09be1f3a0ee655530927e1512468fb59f8c196fb;hpb=9ff27b2483717ec728dda6a9045d2146e85bde86;p=plcapi.git diff --git a/src/Helper/Http.php b/src/Helper/Http.php index 09be1f3..e3d0364 100644 --- a/src/Helper/Http.php +++ b/src/Helper/Http.php @@ -2,18 +2,19 @@ namespace PhpXmlRpc\Helper; +use PhpXmlRpc\Exception\HttpException; use PhpXmlRpc\PhpXmlRpc; class Http { /** - * Decode a string that is encoded w/ "chunked" transfer encoding - * as defined in rfc2068 par. 19.4.6 - * code shamelessly stolen from nusoap library by Dietrich Ayala. + * Decode a string that is encoded with "chunked" transfer encoding as defined in rfc2068 par. 19.4.6 + * Code shamelessly stolen from nusoap library by Dietrich Ayala. * * @param string $buffer the string to be decoded * * @return string + * @internal this function will become protected in the future */ public static function decodeChunked($buffer) { @@ -23,16 +24,16 @@ class Http // read chunk-size, chunk-extension (if any) and crlf // get the position of the linebreak - $chunkend = strpos($buffer, "\r\n") + 2; - $temp = substr($buffer, 0, $chunkend); - $chunk_size = hexdec(trim($temp)); - $chunkstart = $chunkend; - while ($chunk_size > 0) { - $chunkend = strpos($buffer, "\r\n", $chunkstart + $chunk_size); + $chunkEnd = strpos($buffer, "\r\n") + 2; + $temp = substr($buffer, 0, $chunkEnd); + $chunkSize = hexdec(trim($temp)); + $chunkStart = $chunkEnd; + while ($chunkSize > 0) { + $chunkEnd = strpos($buffer, "\r\n", $chunkStart + $chunkSize); // just in case we got a broken connection - if ($chunkend == false) { - $chunk = substr($buffer, $chunkstart); + if ($chunkEnd == false) { + $chunk = substr($buffer, $chunkStart); // append chunk-data to entity-body $new .= $chunk; $length += strlen($chunk); @@ -40,21 +41,21 @@ class Http } // read chunk-data and crlf - $chunk = substr($buffer, $chunkstart, $chunkend - $chunkstart); + $chunk = substr($buffer, $chunkStart, $chunkEnd - $chunkStart); // append chunk-data to entity-body $new .= $chunk; // length := length + chunk-size $length += strlen($chunk); // read chunk-size and crlf - $chunkstart = $chunkend + 2; + $chunkStart = $chunkEnd + 2; - $chunkend = strpos($buffer, "\r\n", $chunkstart) + 2; - if ($chunkend == false) { + $chunkEnd = strpos($buffer, "\r\n", $chunkStart) + 2; + if ($chunkEnd == false) { break; //just in case we got a broken connection } - $temp = substr($buffer, $chunkstart, $chunkend - $chunkstart); - $chunk_size = hexdec(trim($temp)); - $chunkstart = $chunkend; + $temp = substr($buffer, $chunkStart, $chunkEnd - $chunkStart); + $chunkSize = hexdec(trim($temp)); + $chunkStart = $chunkEnd; } return $new; @@ -63,17 +64,17 @@ class Http /** * Parses HTTP an http response headers and separates them from the body. * - * @param string $data the http response,headers and body. It will be stripped of headers + * @param string $data the http response, headers and body. It will be stripped of headers * @param bool $headersProcessed when true, we assume that response inflating and dechunking has been already carried out * - * @return array with keys 'headers' and 'cookies' - * @throws \Exception + * @return array with keys 'headers', 'cookies', 'raw_data' and 'status_code' + * @throws HttpException */ public function parseResponseHeaders(&$data, $headersProcessed = false, $debug=0) { - $httpResponse = array('raw_data' => $data, 'headers'=> array(), 'cookies' => array()); + $httpResponse = array('raw_data' => $data, 'headers'=> array(), 'cookies' => array(), 'status_code' => null); - // Support "web-proxy-tunelling" connections for https through proxies + // Support "web-proxy-tunnelling" connections for https through proxies if (preg_match('/^HTTP\/1\.[0-1] 200 Connection established/', $data)) { // Look for CR/LF or simple LF as line separator, // (even though it is not valid http) @@ -94,8 +95,8 @@ class Http // maybe we could take them into account, too? $data = substr($data, $bd); } else { - error_log('XML-RPC: ' . __METHOD__ . ': HTTPS via proxy error, tunnel connection possibly failed'); - throw new \Exception(PhpXmlRpc::$xmlrpcstr['http_error'] . ' (HTTPS via proxy error, tunnel connection possibly failed)', PhpXmlRpc::$xmlrpcerr['http_error']); + Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': HTTPS via proxy error, tunnel connection possibly failed'); + throw new HttpException(PhpXmlRpc::$xmlrpcstr['http_error'] . ' (HTTPS via proxy error, tunnel connection possibly failed)', PhpXmlRpc::$xmlrpcerr['http_error']); } } @@ -105,16 +106,29 @@ class Http // server sent a Continue header without any (valid) content following... // give the client a chance to know it if (!$pos && !is_int($pos)) { - // works fine in php 3, 4 and 5 + /// @todo this construct works fine in php 3, 4 and 5 - 8; would it not be enough to have !== false now ? break; } $data = substr($data, $pos); } - if (!preg_match('/^HTTP\/[0-9.]+ 200 /', $data)) { + + // When using Curl to query servers using Digest Auth, we get back a double set of http headers. + // We strip out the 1st... + if ($headersProcessed && preg_match('/^HTTP\/[0-9]\.[0-9] 401 /', $data)) { + if (preg_match('/(\r?\n){2}HTTP\/[0-9]\.[0-9] 200 /', $data)) { + $data = preg_replace('/^HTTP\/[0-9]\.[0-9] 401 .+?(?:\r?\n){2}(HTTP\/[0-9.]+ 200 )/s', '$1', $data, 1); + } + } + + if (preg_match('/^HTTP\/[0-9]\.[0-9] ([0-9]{3}) /', $data, $matches)) { + $httpResponse['status_code'] = $matches[1]; + } + + if ($httpResponse['status_code'] !== '200') { $errstr = substr($data, 0, strpos($data, "\n") - 1); - error_log('XML-RPC: ' . __METHOD__ . ': HTTP error, got response: ' . $errstr); - throw new \Exception(PhpXmlRpc::$xmlrpcstr['http_error'] . ' (' . $errstr . ')', PhpXmlRpc::$xmlrpcerr['http_error']); + Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': HTTP error, got response: ' . $errstr); + throw new HttpException(PhpXmlRpc::$xmlrpcstr['http_error'] . ' (' . $errstr . ')', PhpXmlRpc::$xmlrpcerr['http_error'], null, $httpResponse['status_code'] ); } // be tolerant to usage of \n instead of \r\n to separate headers and data @@ -132,19 +146,21 @@ class Http $bd = 0; } } + // be tolerant to line endings, and extra empty lines $ar = preg_split("/\r?\n/", trim(substr($data, 0, $pos))); - while (list(, $line) = @each($ar)) { + + foreach($ar as $line) { // take care of multi-line headers and cookies $arr = explode(':', $line, 2); if (count($arr) > 1) { - $header_name = strtolower(trim($arr[0])); + $headerName = strtolower(trim($arr[0])); /// @todo some other headers (the ones that allow a CSV list of values) /// do allow many values to be passed using multiple header lines. - /// We should add content to $xmlrpc->_xh['headers'][$header_name] + /// We should add content to $xmlrpc->_xh['headers'][$headerName] /// instead of replacing it for those... - if ($header_name == 'set-cookie' || $header_name == 'set-cookie2') { - if ($header_name == 'set-cookie2') { + if ($headerName == 'set-cookie' || $headerName == 'set-cookie2') { + if ($headerName == 'set-cookie2') { // version 2 cookies: // there could be many cookies on one line, comma separated $cookies = explode(',', $arr[1]); @@ -154,10 +170,10 @@ class Http foreach ($cookies as $cookie) { // glue together all received cookies, using a comma to separate them // (same as php does with getallheaders()) - if (isset($httpResponse['headers'][$header_name])) { - $httpResponse['headers'][$header_name] .= ', ' . trim($cookie); + if (isset($httpResponse['headers'][$headerName])) { + $httpResponse['headers'][$headerName] .= ', ' . trim($cookie); } else { - $httpResponse['headers'][$header_name] = trim($cookie); + $httpResponse['headers'][$headerName] = trim($cookie); } // parse cookie attributes, in case user wants to correctly honour them // feature creep: only allow rfc-compliant cookie attributes? @@ -180,11 +196,11 @@ class Http } } } else { - $httpResponse['headers'][$header_name] = trim($arr[1]); + $httpResponse['headers'][$headerName] = trim($arr[1]); } - } elseif (isset($header_name)) { + } elseif (isset($headerName)) { /// @todo version1 cookies might span multiple lines, thus breaking the parsing above - $httpResponse['headers'][$header_name] .= ' ' . trim($line); + $httpResponse['headers'][$headerName] .= ' ' . trim($line); } } @@ -198,17 +214,18 @@ class Http foreach ($httpResponse['cookies'] as $header => $value) { $msg .= "COOKIE: $header={$value['value']}\n"; } - $this->debugMessage($msg); + Logger::instance()->debugMessage($msg); } // if CURL was used for the call, http headers have been processed, // and dechunking + reinflating have been carried out if (!$headersProcessed) { + // Decode chunked encoding sent by http 1.1 servers if (isset($httpResponse['headers']['transfer-encoding']) && $httpResponse['headers']['transfer-encoding'] == 'chunked') { - if (!$data = Http::decodeChunked($data)) { - error_log('XML-RPC: ' . __METHOD__ . ': errors occurred when trying to rebuild the chunked data received from server'); - throw new \Exception(PhpXmlRpc::$xmlrpcstr['dechunk_fail'], PhpXmlRpc::$xmlrpcerr['dechunk_fail']); + if (!$data = static::decodeChunked($data)) { + Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': errors occurred when trying to rebuild the chunked data received from server'); + throw new HttpException(PhpXmlRpc::$xmlrpcstr['dechunk_fail'], PhpXmlRpc::$xmlrpcerr['dechunk_fail'], null, $httpResponse['status_code']); } } @@ -222,20 +239,20 @@ class Http if ($httpResponse['headers']['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data)) { $data = $degzdata; if ($debug) { - $this->debugMessage("---INFLATED RESPONSE---[" . strlen($data) . " chars]---\n$data\n---END---"); + Logger::instance()->debugMessage("---INFLATED RESPONSE---[" . strlen($data) . " chars]---\n$data\n---END---"); } } elseif ($httpResponse['headers']['content-encoding'] == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) { $data = $degzdata; if ($debug) { - $this->debugMessage("---INFLATED RESPONSE---[" . strlen($data) . " chars]---\n$data\n---END---"); + Logger::instance()->debugMessage("---INFLATED RESPONSE---[" . strlen($data) . " chars]---\n$data\n---END---"); } } else { - error_log('XML-RPC: ' . __METHOD__ . ': errors occurred when trying to decode the deflated data received from server'); - throw new \Exception(PhpXmlRpc::$xmlrpcstr['decompress_fail'], PhpXmlRpc::$xmlrpcerr['decompress_fail']); + Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': errors occurred when trying to decode the deflated data received from server'); + throw new HttpException(PhpXmlRpc::$xmlrpcstr['decompress_fail'], PhpXmlRpc::$xmlrpcerr['decompress_fail'], null, $httpResponse['status_code']); } } else { - error_log('XML-RPC: ' . __METHOD__ . ': the server sent deflated data. Your php install must have the Zlib extension compiled in to support this.'); - throw new \Exception(PhpXmlRpc::$xmlrpcstr['cannot_decompress'], PhpXmlRpc::$xmlrpcerr['cannot_decompress']); + Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': the server sent deflated data. Your php install must have the Zlib extension compiled in to support this.'); + throw new HttpException(PhpXmlRpc::$xmlrpcstr['cannot_decompress'], PhpXmlRpc::$xmlrpcerr['cannot_decompress'], null, $httpResponse['status_code']); } } } @@ -243,19 +260,4 @@ class Http return $httpResponse; } - - /** - * Echoes a debug message, taking care of escaping it when not in console mode - * - * @param string $message - */ - protected function debugMessage($message) - { - if (PHP_SAPI != 'cli') { - print "
\n".htmlentities($message)."\n
"; - } - else { - print "\n$message\n"; - } - } }