/** * Cast to HTTP query string * * @param mixed $url * @param Zend\OAuth\Config $config * @param null|array $params * @return string */ public function toQueryString($url, Config $config, array $params = null) { $uri = new URI\URL($url); if (!$uri->isValid() || !in_array($uri->getScheme(), array('http', 'https'))) { throw new OAuth\Exception('\'' . $url . '\' is not a valid URI'); } $params = $this->_httpUtility->assembleParams($url, $config, $params); return $this->_httpUtility->toEncodedQueryString($params); }
/** * Attempt to turn a relative URI into an absolute URI */ protected function _absolutiseUri($link, $uri = null) { if (!URI\URL::validate($link)) { if (!is_null($uri)) { $uri = new URI\URL($uri); if ($link[0] !== '/') { $link = $uri->getPath() . '/' . $link; } $link = $uri->getScheme() . '://' . $uri->getHost() . '/' . $this->_canonicalizePath($link); if (!URI\Zend\Uri\Uri::check($link)) { $link = null; } } } return $link; }
public function testReloadAllowsCustomURI() { $uriOverride = 'http://www.example.org'; $etag = 'ABCD1234'; $this->service->setMajorProtocolVersion(2); $this->adapter->setResponse($this->httpEntrySample); $entry = $this->service->newEntry(); $entry->link = array(new Extension\Link('http://www.example.com', 'edit', 'application/atom+xml')); $entry->setEtag($etag); $newEntry = $entry->reload($uriOverride); $requestUri = $this->adapter->popRequest()->uri; $uriOverrideObject = new URI\URL($uriOverride); $uriOverrideObject->setPort('80'); $this->assertEquals($uriOverrideObject, $requestUri); }
/** * 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('Invalid URI specified'); } $host = $uri->getHost(); if (empty($host)) { throw new Exception('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("Invalid value passed for \$ret_as: {$ret_as}"); break; } } 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 = '') { // 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; }
/** * Adds an enclosure to the entry. * * @param array $enclosures */ public function setEnclosure(array $enclosure) { if (!isset($enclosure['type'])) { throw new Feed\Exception('Enclosure "type" is not set'); } if (!isset($enclosure['length'])) { throw new Feed\Exception('Enclosure "length" is not set'); } if (!isset($enclosure['uri'])) { throw new Feed\Exception('Enclosure "uri" is not set'); } if (!\Zend\URI\URL::validate($enclosure['uri'])) { throw new Feed\Exception('Enclosure "uri" is not a valid URI/IRI'); } if ((int) $enclosure['length'] <= 0) { throw new Feed\Exception('Enclosure "length" must be an integer' . ' indicating the content\'s length in bytes'); } $this->_data['enclosure'] = $enclosure; }
/** * Set new feed URL * * @param string $value * @return \Zend\Feed\Writer\Extension\ITunes\Feed */ public function setItunesNewFeedUrl($value) { if (!\Zend\URI\URL::validate($value)) { throw new \Zend\Feed\Exception('invalid parameter: "newFeedUrl" may only' . ' be a valid URI/IRI'); } $this->_data['newFeedUrl'] = $value; return $this; }
/** * Set entry identifier * * @param DOMDocument $dom * @param DOMElement $root * @return void */ protected function _setId(\DOMDocument $dom, \DOMElement $root) { if (!$this->getDataContainer()->getId() && !$this->getDataContainer()->getLink()) { return; } $id = $dom->createElement('guid'); $root->appendChild($id); if (!$this->getDataContainer()->getId()) { $this->getDataContainer()->setId($this->getDataContainer()->getLink()); } $text = $dom->createTextNode($this->getDataContainer()->getId()); $id->appendChild($text); if (!\Zend\URI\URL::validate($this->getDataContainer()->getId())) { $id->setAttribute('isPermaLink', 'false'); } }
/** * 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\Client::GET: $curlMethod = CURLOPT_HTTPGET; break; case Client\Client::POST: $curlMethod = CURLOPT_POST; break; case Client\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\Client::DELETE: $curlMethod = CURLOPT_CUSTOMREQUEST; $curlValue = "DELETE"; break; case Client\Client::OPTIONS: $curlMethod = CURLOPT_CUSTOMREQUEST; $curlValue = "OPTIONS"; break; case Client\Client::TRACE: $curlMethod = CURLOPT_CUSTOMREQUEST; $curlValue = "TRACE"; 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\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\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; }
/** * 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; } }
/** * Constructor * * If a $uri is passed, the object will attempt to populate itself using * that information. * * @param string|\Zend\Uri\Uri $uri * @return void * @throws \Zend\Controller\Request\Exception when invalid URI passed */ public function __construct($uri = null) { if (null !== $uri) { if (!$uri instanceof URI\URL) { $uri = new URI\URL($uri); } if ($uri->isValid()) { $path = $uri->getPath(); $query = $uri->getQuery(); if (!empty($query)) { $path .= '?' . $query; } $this->setRequestUri($path); } else { throw new Exception('Invalid URI provided to constructor'); } } else { $this->setRequestUri(); } }
/** * 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 ($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; }
/** * Determine if a given URL is valid * * @param string $url * @return void * @throws Zend\OAuth\Exception */ protected function _validateUrl($url) { $uri = new URI\URL($url); if (!$uri->isValid()) { throw new OAuth\Exception(sprintf("'%s' is not a valid URI", $url)); } elseif (!in_array($uri->getScheme(), array('http', 'https'))) { throw new OAuth\Exception(sprintf("'%s' is not a valid URI", $url)); } }
/** * Add a URL to a topic (Atom or RSS feed) which has been updated * * @param string $url * @return \Zend\Feed\PubSubHubbub\Publisher */ public function addUpdatedTopicUrl($url) { if (empty($url) || !is_string($url) || !\Zend\URI\URL::validate($url)) { throw new Exception('Invalid parameter "url"' . ' of "' . $url . '" must be a non-empty string and a valid' . 'URL'); } $this->_updatedTopicUrls[] = $url; return $this; }
/** * Set link to feed * * @param DOMDocument $dom * @param DOMElement $root * @return void */ protected function _setLink(\DOMDocument $dom, \DOMElement $root) { $value = $this->getDataContainer()->getLink(); if (!$value) { $message = 'RSS 2.0 feed elements MUST contain exactly one' . ' link element but one has not been set'; $exception = new Feed\Exception($message); if (!$this->_ignoreExceptions) { throw $exception; } else { $this->_exceptions[] = $exception; return; } } $link = $dom->createElement('link'); $root->appendChild($link); $text = $dom->createTextNode($value); $link->appendChild($text); if (!\Zend\URI\URL::validate($value)) { $link->setAttribute('isPermaLink', 'false'); } }
public function setBy(array $by) { $author = array(); if (!array_key_exists('name', $by) || empty($by['name']) || !is_string($by['name'])) { throw new Feed\Exception('Invalid parameter: author array must include a "name" key with a non-empty string value'); } $author['name'] = $by['name']; if (isset($by['email'])) { if (empty($by['email']) || !is_string($by['email'])) { throw new Feed\Exception('Invalid parameter: "email" array value must be a non-empty string'); } $author['email'] = $by['email']; } if (isset($by['uri'])) { if (empty($by['uri']) || !is_string($by['uri']) || !\Zend\URI\URL::validate($by['uri'])) { throw new Feed\Exception('Invalid parameter: "uri" array value must be a non-empty string and valid URI/IRI'); } $author['uri'] = $by['uri']; } $this->_data['by'] = $author; }
/** * Attempt to absolutise the URI, i.e. if a relative URI apply the * xml:base value as a prefix to turn into an absolute URI. */ protected function _absolutiseUri($link) { if (!\Zend\URI\URL::validate($link)) { if (!is_null($this->getBaseUrl())) { $link = $this->getBaseUrl() . $link; if (!\Zend\URI\URL::validate($link)) { $link = null; } } } return $link; }
/** * Set entry identifier * * @param \DOMDocument $dom * @param \DOMElement $root * @return void */ protected function _setId(\DOMDocument $dom, \DOMElement $root) { if (!$this->getDataContainer()->getId() && !$this->getDataContainer()->getLink()) { $message = 'Atom 1.0 entry elements MUST contain exactly one ' . 'atom:id element, or as an alternative, we can use the same ' . 'value as atom:link however neither a suitable link nor an ' . 'id have been set'; $exception = new Writer\Exception($message); if (!$this->_ignoreExceptions) { throw $exception; } else { $this->_exceptions[] = $exception; return; } } if (!$this->getDataContainer()->getId()) { $this->getDataContainer()->setId($this->getDataContainer()->getLink()); } if (!URI\URL::validate($this->getDataContainer()->getId()) && !preg_match("#^urn:[a-zA-Z0-9][a-zA-Z0-9\\-]{1,31}:([a-zA-Z0-9\\(\\)\\+\\,\\.\\:\\=\\@\\;\$\\_\\!\\*\\-]|%[0-9a-fA-F]{2})*#", $this->getDataContainer()->getId()) && !$this->_validateTagUri($this->getDataContainer()->getId())) { throw new Exception('Atom 1.0 IDs must be a valid URI/IRI'); } $id = $dom->createElement('id'); $root->appendChild($id); $text = $dom->createTextNode($this->getDataContainer()->getId()); $id->appendChild($text); }
/** * @group ZF-1480 */ public function testRemoveQueryParametersModifiesQueryAndReturnsOldQuery() { $url = new URL('http://example.com/foo/?a=1&b=2&c=3&d=4'); $url->removeQueryParameters(array('b', 'd', 'e')); $this->assertEquals(array('a' => 1, 'c' => 3), $url->getQueryAsArray()); $this->assertEquals('a=1&c=3', $url->getQuery()); }
/** * Checks validity of the request simply by making a quick pass and * confirming the presence of all REQUIRED parameters. * * @param array $httpGetData * @return bool */ public function isValidHubVerification(array $httpGetData) { /** * As per the specification, the hub.verify_token is OPTIONAL. This * implementation of Pubsubhubbub considers it REQUIRED and will * always send a hub.verify_token parameter to be echoed back * by the Hub Server. Therefore, its absence is considered invalid. */ if (strtolower($_SERVER['REQUEST_METHOD']) !== 'get') { return false; } $required = array('hub_mode', 'hub_topic', 'hub_challenge', 'hub_verify_token'); foreach ($required as $key) { if (!array_key_exists($key, $httpGetData)) { return false; } } if ($httpGetData['hub_mode'] !== 'subscribe' && $httpGetData['hub_mode'] !== 'unsubscribe') { return false; } if ($httpGetData['hub_mode'] == 'subscribe' && !array_key_exists('hub_lease_seconds', $httpGetData)) { return false; } if (!\Zend\URI\URL::validate($httpGetData['hub_topic'])) { return false; } /** * Attempt to retrieve any Verification Token Key attached to Callback * URL's path by our Subscriber implementation */ if (!$this->_hasValidVerifyToken($httpGetData)) { return false; } return true; }
/** * 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, HTTP\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; }