public function testAllParts()
{
$url = new Url('http://*****:*****@www.zend.com:8080/path/to/file?a=1&b=2#top');
$this->assertEquals('http', $url->getScheme());
$this->assertEquals('andi', $url->getUsername());
$this->assertEquals('password', $url->getPassword());
$this->assertEquals('www.zend.com', $url->getHost());
$this->assertEquals('8080', $url->getPort());
$this->assertEquals('/path/to/file', $url->getPath());
$this->assertEquals('a=1&b=2', $url->getQuery());
$this->assertEquals('top', $url->getFragment());
$this->assertTrue($url->isValid());
}
/**
* Attempt to turn a relative URI into an absolute URI
*/
protected function _absolutiseUri($link, $uri = null)
{
if (!Uri\Url::validate($link)) {
if ($uri !== null) {
$uri = new Uri\Url($uri);
if ($link[0] !== '/') {
$link = $uri->getPath() . '/' . $link;
}
$link = $uri->getScheme() . '://' . $uri->getHost() . '/' . $this->_canonicalizePath($link);
if (!URI\URL::validate($link)) {
$link = null;
}
}
}
return $link;
}
/**
* Get a specific cookie according to a URI and name
*
* @param \Zend\Uri\Url|string $uri The uri (domain and path) to match
* @param string $cookie_name The cookie's name
* @param int $ret_as Whether to return cookies as objects of \Zend\Http\Cookie or as strings
* @return \Zend\Http\Cookie|string
*/
public function getCookie($uri, $cookie_name, $ret_as = self::COOKIE_OBJECT)
{
if (is_string($uri)) {
$uri = new Uri\Url($uri);
}
if (! $uri instanceof Uri\Url) {
throw new Exception\InvalidArgumentException('Invalid URI specified');
}
$host = $uri->getHost();
if (empty($host)) {
throw new Exception\InvalidArgumentException('Invalid URI specified; host missing');
}
// Get correct cookie path
$path = $uri->getPath();
$path = substr($path, 0, strrpos($path, '/'));
if (! $path) $path = '/';
if (isset($this->cookies[$uri->getHost()][$path][$cookie_name])) {
$cookie = $this->cookies[$uri->getHost()][$path][$cookie_name];
switch ($ret_as) {
case self::COOKIE_OBJECT:
return $cookie;
break;
case self::COOKIE_STRING_ARRAY:
case self::COOKIE_STRING_CONCAT:
return $cookie->__toString();
break;
default:
throw new Exception\InvalidArgumentException("Invalid value passed for \$ret_as: {$ret_as}");
break;
}
} else {
return false;
}
}
/**
* Generate a new Cookie object from a cookie string
* (for example the value of the Set-Cookie HTTP header)
*
* @param string $cookieStr
* @param \Zend\Uri\Url|string $refUri Reference URI for default values (domain, path)
* @param boolean $encodeValue Weither or not the cookie's value should be
* passed through urlencode/urldecode
* @return \Zend\Http\Cookie A new \Zend\Http\Cookie object or false on failure.
*/
public static function fromString($cookieStr, $refUri = null, $encodeValue = true)
{
// Set default values
if (is_string($refUri)) {
$refUri = new Uri\Url($refUri);
}
$name = '';
$value = '';
$domain = '';
$path = '';
$expires = null;
$secure = false;
$parts = explode(';', $cookieStr);
// If first part does not include '=', fail
if (strpos($parts[0], '=') === false) {
return false;
}
// Get the name and value of the cookie
list($name, $value) = explode('=', trim(array_shift($parts)), 2);
$name = trim($name);
if ($encodeValue) {
$value = urldecode(trim($value));
}
// Set default domain and path
if ($refUri instanceof Uri\Url) {
$domain = $refUri->getHost();
$path = $refUri->getPath();
$path = substr($path, 0, strrpos($path, '/'));
}
// Set other cookie parameters
foreach ($parts as $part) {
$part = trim($part);
if (strtolower($part) == 'secure') {
$secure = true;
continue;
}
$keyValue = explode('=', $part, 2);
if (count($keyValue) == 2) {
list($k, $v) = $keyValue;
switch (strtolower($k)) {
case 'expires':
if (($expires = strtotime($v)) === false) {
/**
* The expiration is past Tue, 19 Jan 2038 03:14:07 UTC
* the maximum for 32-bit signed integer. Zend_Date
* can get around that limit.
*/
$expireDate = new \Zend\Date\Date($v);
$expires = $expireDate->getTimestamp();
}
break;
case 'path':
$path = $v;
break;
case 'domain':
$domain = $v;
break;
default:
break;
}
}
}
if ($name !== '') {
$ret = new self($name, $value, $domain, $expires, $path, $secure);
$ret->encodeValue = $encodeValue ? true : false;
return $ret;
} else {
return false;
}
}
/**
* Send request to the remote server
*
* @param string $method
* @param \Zend\Uri\Url $uri
* @param string $http_ver
* @param array $headers
* @param string $body
* @return string Request as string
*/
public function write($method, $uri, $http_ver = '1.1', $headers = array(), $body = '')
{
$host = $uri->getHost();
$host = (strtolower($uri->getScheme()) == 'https' ? 'sslv2://' . $host : $host);
// Build request headers
$path = $uri->getPath();
if (empty($path)) {
$path = '/';
}
if ($uri->getQuery()) $path .= '?' . $uri->getQuery();
$request = "{$method} {$path} HTTP/{$http_ver}\r\n";
foreach ($headers as $k => $v) {
if (is_string($k)) $v = ucfirst($k) . ": $v";
$request .= "$v\r\n";
}
// Add the request body
$request .= "\r\n" . $body;
// Do nothing - just return the request as string
return $request;
}
/**
* Send request to the remote server
*
* @param string $method
* @param \Zend\Uri\Url $uri
* @param string $http_ver
* @param array $headers
* @param string $body
* @return string Request as string
*/
public function write($method, $uri, $http_ver = '1.1', $headers = array(), $body = '')
{
// Make sure we're properly connected
if (!$this->socket) {
throw new Exception('Trying to write but we are not connected');
}
$host = $uri->getHost();
$host = (strtolower($uri->getScheme()) == 'https' ? $this->config['ssltransport'] : 'tcp') . '://' . $host;
if ($this->connected_to[0] != $host || $this->connected_to[1] != $uri->getPort()) {
throw new Exception('Trying to write but we are connected to the wrong host');
}
// Save request method for later
$this->method = $method;
// Build request headers
$path = $uri->getPath();
if ($uri->getQuery()) {
$path .= '?' . $uri->getQuery();
}
$request = "{$method} {$path} HTTP/{$http_ver}\r\n";
foreach ($headers as $k => $v) {
if (is_string($k)) {
$v = ucfirst($k) . ": {$v}";
}
$request .= "{$v}\r\n";
}
if (is_resource($body)) {
$request .= "\r\n";
} else {
// Add the request body
$request .= "\r\n" . $body;
}
// Send the request
if (!@fwrite($this->socket, $request)) {
throw new Exception('Error writing request to server');
}
if (is_resource($body)) {
if (stream_copy_to_stream($body, $this->socket) == 0) {
throw new Exception('Error writing request to server');
}
}
return $request;
}
/**
* Send request to the remote server
*
* @param string $method
* @param \Zend\Uri\Url $uri
* @param float $http_ver
* @param array $headers
* @param string $body
* @return string $request
* @throws \Zend\Http\Client\Adapter\Exception If connection fails, connected to wrong host, no PUT file defined, unsupported method, or unsupported cURL option
*/
public function write($method, $uri, $httpVersion = 1.1, $headers = array(), $body = '')
{
// Make sure we're properly connected
if (!$this->_curl) {
throw new Exception("Trying to write but we are not connected");
}
if ($this->_connected_to[0] != $uri->getHost() || $this->_connected_to[1] != $uri->getPort()) {
throw new Exception("Trying to write but we are connected to the wrong host");
}
// set URL
curl_setopt($this->_curl, CURLOPT_URL, $uri->__toString());
// ensure correct curl call
$curlValue = true;
switch ($method) {
case Client::GET:
$curlMethod = CURLOPT_HTTPGET;
break;
case Client::POST:
$curlMethod = CURLOPT_POST;
break;
case Client::PUT:
// There are two different types of PUT request, either a Raw Data string has been set
// or CURLOPT_INFILE and CURLOPT_INFILESIZE are used.
if (is_resource($body)) {
$this->_config['curloptions'][CURLOPT_INFILE] = $body;
}
if (isset($this->_config['curloptions'][CURLOPT_INFILE])) {
// Now we will probably already have Content-Length set, so that we have to delete it
// from $headers at this point:
foreach ($headers as $k => $header) {
if (preg_match('/Content-Length:\\s*(\\d+)/i', $header, $m)) {
if (is_resource($body)) {
$this->_config['curloptions'][CURLOPT_INFILESIZE] = (int) $m[1];
}
unset($headers[$k]);
}
}
if (!isset($this->_config['curloptions'][CURLOPT_INFILESIZE])) {
throw new Exception("Cannot set a file-handle for cURL option CURLOPT_INFILE without also setting its size in CURLOPT_INFILESIZE.");
}
if (is_resource($body)) {
$body = '';
}
$curlMethod = CURLOPT_PUT;
} else {
$curlMethod = CURLOPT_CUSTOMREQUEST;
$curlValue = "PUT";
}
break;
case Client::DELETE:
$curlMethod = CURLOPT_CUSTOMREQUEST;
$curlValue = "DELETE";
break;
case Client::OPTIONS:
$curlMethod = CURLOPT_CUSTOMREQUEST;
$curlValue = "OPTIONS";
break;
case Client::TRACE:
$curlMethod = CURLOPT_CUSTOMREQUEST;
$curlValue = "TRACE";
break;
case Client::HEAD:
$curlMethod = CURLOPT_CUSTOMREQUEST;
$curlValue = "HEAD";
break;
default:
// For now, through an exception for unsupported request methods
throw new Exception("Method currently not supported");
}
if (is_resource($body) && $curlMethod != CURLOPT_PUT) {
throw new Exception("Streaming requests are allowed only with PUT");
}
// get http version to use
$curlHttp = $httpVersion == 1.1 ? CURL_HTTP_VERSION_1_1 : CURL_HTTP_VERSION_1_0;
// mark as HTTP request and set HTTP method
curl_setopt($this->_curl, $curlHttp, true);
curl_setopt($this->_curl, $curlMethod, $curlValue);
if ($this->out_stream) {
// headers will be read into the response
curl_setopt($this->_curl, CURLOPT_HEADER, false);
curl_setopt($this->_curl, CURLOPT_HEADERFUNCTION, array($this, "readHeader"));
// and data will be written into the file
curl_setopt($this->_curl, CURLOPT_FILE, $this->out_stream);
} else {
// ensure headers are also returned
curl_setopt($this->_curl, CURLOPT_HEADER, true);
// ensure actual response is returned
curl_setopt($this->_curl, CURLOPT_RETURNTRANSFER, true);
}
// set additional headers
$headers['Accept'] = '';
curl_setopt($this->_curl, CURLOPT_HTTPHEADER, $headers);
/**
* Make sure POSTFIELDS is set after $curlMethod is set:
* @link http://de2.php.net/manual/en/function.curl-setopt.php#81161
*/
if ($method == Client::POST) {
curl_setopt($this->_curl, CURLOPT_POSTFIELDS, $body);
} elseif ($curlMethod == CURLOPT_PUT) {
// this covers a PUT by file-handle:
// Make the setting of this options explicit (rather than setting it through the loop following a bit lower)
// to group common functionality together.
curl_setopt($this->_curl, CURLOPT_INFILE, $this->_config['curloptions'][CURLOPT_INFILE]);
curl_setopt($this->_curl, CURLOPT_INFILESIZE, $this->_config['curloptions'][CURLOPT_INFILESIZE]);
unset($this->_config['curloptions'][CURLOPT_INFILE]);
unset($this->_config['curloptions'][CURLOPT_INFILESIZE]);
} elseif ($method == Client::PUT) {
// This is a PUT by a setRawData string, not by file-handle
curl_setopt($this->_curl, CURLOPT_POSTFIELDS, $body);
}
// set additional curl options
if (isset($this->_config['curloptions'])) {
foreach ((array) $this->_config['curloptions'] as $k => $v) {
if (!in_array($k, $this->_invalidOverwritableCurlOptions)) {
if (curl_setopt($this->_curl, $k, $v) == false) {
throw new Client\Exception(sprintf("Unknown or erroreous cURL option '%s' set", $k));
}
}
}
}
// send the request
$response = curl_exec($this->_curl);
// if we used streaming, headers are already there
if (!is_resource($this->out_stream)) {
$this->_response = $response;
}
$request = curl_getinfo($this->_curl, CURLINFO_HEADER_OUT);
$request .= $body;
if (empty($this->_response)) {
throw new Client\Exception("Error in cURL request: " . curl_error($this->_curl));
}
// cURL automatically decodes chunked-messages, this means we have to disallow the Zend\Http\Response to do it again
if (stripos($this->_response, "Transfer-Encoding: chunked\r\n")) {
$this->_response = str_ireplace("Transfer-Encoding: chunked\r\n", '', $this->_response);
}
// Eliminate multiple HTTP responses.
do {
$parts = preg_split('|(?:\\r?\\n){2}|m', $this->_response, 2);
$again = false;
if (isset($parts[1]) && preg_match("|^HTTP/1\\.[01](.*?)\r\n|mi", $parts[1])) {
$this->_response = $parts[1];
$again = true;
}
} while ($again);
// cURL automatically handles Proxy rewrites, remove the "HTTP/1.0 200 Connection established" string:
if (stripos($this->_response, "HTTP/1.0 200 Connection established\r\n\r\n") !== false) {
$this->_response = str_ireplace("HTTP/1.0 200 Connection established\r\n\r\n", '', $this->_response);
}
return $request;
}
/**
* Prepare the request headers
*
* @return array
*/
protected function _prepareHeaders()
{
$headers = array();
// Set the host header
if (!isset($this->headers['host'])) {
$host = $this->uri->getHost();
// If the port is not default, add it
if (!($this->uri->getScheme() == 'http' && $this->uri->getPort() == 80 || $this->uri->getScheme() == 'https' && $this->uri->getPort() == 443)) {
$host .= ':' . $this->uri->getPort();
}
$headers[] = "Host: {$host}";
}
// Set the connection header
if (!isset($this->headers['connection'])) {
if (!$this->config['keepalive']) {
$headers[] = "Connection: close";
}
}
// Set the Accept-encoding header if not set - depending on whether
// zlib is available or not.
if (!isset($this->headers['accept-encoding'])) {
if (function_exists('gzinflate')) {
$headers[] = 'Accept-encoding: gzip, deflate';
} else {
$headers[] = 'Accept-encoding: identity';
}
}
// Set the Content-Type header
if ($this->method == self::POST && (!isset($this->headers[strtolower(self::CONTENT_TYPE)]) && isset($this->enctype))) {
$headers[] = self::CONTENT_TYPE . ': ' . $this->enctype;
}
// Set the user agent header
if (!isset($this->headers['user-agent']) && isset($this->config['useragent'])) {
$headers[] = "User-Agent: {$this->config['useragent']}";
}
// Set HTTP authentication if needed
if (is_array($this->auth)) {
$auth = self::encodeAuthHeader($this->auth['user'], $this->auth['password'], $this->auth['type']);
$headers[] = "Authorization: {$auth}";
}
// Load cookies from cookie jar
if (isset($this->cookiejar)) {
$cookstr = $this->cookiejar->getMatchingCookies($this->uri, true, CookieJar::COOKIE_STRING_CONCAT);
if ($cookstr) {
$headers[] = "Cookie: {$cookstr}";
}
}
// Add all other user defined headers
foreach ($this->headers as $header) {
list($name, $value) = $header;
if (is_array($value)) {
$value = implode(', ', $value);
}
$headers[] = "{$name}: {$value}";
}
return $headers;
}