/**
* Send a HTTP request to a URI using streams with fopen().
*
* @access public
* @since 2.7.0
*
* @param string $url
* @param str|array $args Optional. Override the defaults.
* @return array 'headers', 'body', 'response', 'cookies' and 'filename' keys.
*/
function request($url, $args = array())
{
$defaults = array('method' => 'GET', 'timeout' => 5, 'redirection' => 5, 'httpversion' => '1.0', 'blocking' => true, 'headers' => array(), 'body' => null, 'cookies' => array());
$r = array_merge($defaults, $args);
if (isset($r['headers']['User-Agent'])) {
$r['user-agent'] = $r['headers']['User-Agent'];
unset($r['headers']['User-Agent']);
} else {
if (isset($r['headers']['user-agent'])) {
$r['user-agent'] = $r['headers']['user-agent'];
unset($r['headers']['user-agent']);
}
}
// Construct Cookie: header if any cookies are set
\Leeflets\Http::buildCookieHeader($r);
$arrURL = parse_url($url);
if (false === $arrURL) {
return new \Leeflets\Error('http_request_failed', sprintf(__('Malformed URL: %s'), $url));
}
if ('http' != $arrURL['scheme'] && 'https' != $arrURL['scheme']) {
$url = preg_replace('|^' . preg_quote($arrURL['scheme'], '|') . '|', 'http', $url);
}
// Convert Header array to string.
$strHeaders = '';
if (is_array($r['headers'])) {
foreach ($r['headers'] as $name => $value) {
$strHeaders .= "{$name}: {$value}\r\n";
}
} else {
if (is_string($r['headers'])) {
$strHeaders = $r['headers'];
}
}
$is_local = isset($args['local']) && $args['local'];
$ssl_verify = isset($args['sslverify']) && $args['sslverify'];
if ($is_local) {
$ssl_verify = $this->hook->apply('https_local_ssl_verify', $ssl_verify);
} elseif (!$is_local) {
$ssl_verify = $this->hook->apply('https_ssl_verify', $ssl_verify);
}
$arrContext = array('http' => array('method' => strtoupper($r['method']), 'user_agent' => $r['user-agent'], 'max_redirects' => $r['redirection'] + 1, 'protocol_version' => (double) $r['httpversion'], 'header' => $strHeaders, 'ignore_errors' => true, 'timeout' => $r['timeout'], 'ssl' => array('verify_peer' => $ssl_verify, 'verify_host' => $ssl_verify)));
$proxy = new Proxy();
if ($proxy->is_enabled() && $proxy->send_through_proxy($url)) {
$arrContext['http']['proxy'] = 'tcp://' . $proxy->host() . ':' . $proxy->port();
$arrContext['http']['request_fulluri'] = true;
// We only support Basic authentication so this will only work if that is what your proxy supports.
if ($proxy->use_authentication()) {
$arrContext['http']['header'] .= $proxy->authentication_header() . "\r\n";
}
}
if (!is_null($r['body'])) {
$arrContext['http']['content'] = $r['body'];
}
$context = stream_context_create($arrContext);
if (!$this->config->debug) {
$handle = @fopen($url, 'r', false, $context);
} else {
$handle = fopen($url, 'r', false, $context);
}
if (!$handle) {
return new \Leeflets\Error('http_request_failed', sprintf(__('Could not open handle for fopen() to %s'), $url));
}
$timeout = (int) floor($r['timeout']);
$utimeout = $timeout == $r['timeout'] ? 0 : 1000000 * $r['timeout'] % 1000000;
stream_set_timeout($handle, $timeout, $utimeout);
if (!$r['blocking']) {
stream_set_blocking($handle, 0);
fclose($handle);
return array('headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array());
}
if ($r['stream']) {
if (!$this->config->debug) {
$stream_handle = @fopen($r['filename'], 'w+');
} else {
$stream_handle = fopen($r['filename'], 'w+');
}
if (!$stream_handle) {
return new \Leeflets\Error('http_request_failed', sprintf(__('Could not open handle for fopen() to %s'), $r['filename']));
}
stream_copy_to_stream($handle, $stream_handle);
fclose($stream_handle);
$strResponse = '';
} else {
$strResponse = stream_get_contents($handle);
}
$meta = stream_get_meta_data($handle);
fclose($handle);
$processedHeaders = array();
if (isset($meta['wrapper_data']['headers'])) {
$processedHeaders = \Leeflets\Http::processHeaders($meta['wrapper_data']['headers']);
} else {
$processedHeaders = \Leeflets\Http::processHeaders($meta['wrapper_data']);
}
// Streams does not provide an error code which we can use to see why the request stream stopped.
// We can however test to see if a location header is present and return based on that.
if (isset($processedHeaders['headers']['location']) && 0 !== $args['_redirection']) {
return new \Leeflets\Error('http_request_failed', __('Too many redirects.'));
}
if (!empty($strResponse) && isset($processedHeaders['headers']['transfer-encoding']) && 'chunked' == $processedHeaders['headers']['transfer-encoding']) {
$strResponse = \Leeflets\Http::chunkTransferDecode($strResponse);
}
if (true === $r['decompress'] && true === Encoding::should_decode($processedHeaders['headers'])) {
$strResponse = Encoding::decompress($strResponse);
}
return array('headers' => $processedHeaders['headers'], 'body' => $strResponse, 'response' => $processedHeaders['response'], 'cookies' => $processedHeaders['cookies'], 'filename' => $r['filename']);
}
/**
* Send a HTTP request to a URI using cURL extension.
*
* @access public
* @since 2.7.0
*
* @param string $url
* @param str|array $args Optional. Override the defaults.
* @return array 'headers', 'body', 'response', 'cookies' and 'filename' keys.
*/
function request($url, $args = array())
{
$defaults = array('method' => 'GET', 'timeout' => 5, 'redirection' => 5, 'httpversion' => '1.0', 'blocking' => true, 'headers' => array(), 'body' => null, 'cookies' => array());
$r = array_merge($defaults, $args);
if (isset($r['headers']['User-Agent'])) {
$r['user-agent'] = $r['headers']['User-Agent'];
unset($r['headers']['User-Agent']);
} else {
if (isset($r['headers']['user-agent'])) {
$r['user-agent'] = $r['headers']['user-agent'];
unset($r['headers']['user-agent']);
}
}
// Construct Cookie: header if any cookies are set.
\Leeflets\Http::buildCookieHeader($r);
$handle = curl_init();
// cURL offers really easy proxy support.
$proxy = new Proxy();
if ($proxy->is_enabled() && $proxy->send_through_proxy($url)) {
curl_setopt($handle, CURLOPT_PROXYTYPE, CURLPROXY_HTTP);
curl_setopt($handle, CURLOPT_PROXY, $proxy->host());
curl_setopt($handle, CURLOPT_PROXYPORT, $proxy->port());
if ($proxy->use_authentication()) {
curl_setopt($handle, CURLOPT_PROXYAUTH, CURLAUTH_ANY);
curl_setopt($handle, CURLOPT_PROXYUSERPWD, $proxy->authentication());
}
}
$is_local = isset($r['local']) && $r['local'];
$ssl_verify = isset($r['sslverify']) && $r['sslverify'];
if ($is_local) {
$ssl_verify = $this->hook->apply('https_local_ssl_verify', $ssl_verify);
} elseif (!$is_local) {
$ssl_verify = $this->hook->apply('https_ssl_verify', $ssl_verify);
}
// CURLOPT_TIMEOUT and CURLOPT_CONNECTTIMEOUT expect integers. Have to use ceil since
// a value of 0 will allow an unlimited timeout.
$timeout = (int) ceil($r['timeout']);
curl_setopt($handle, CURLOPT_CONNECTTIMEOUT, $timeout);
curl_setopt($handle, CURLOPT_TIMEOUT, $timeout);
curl_setopt($handle, CURLOPT_URL, $url);
curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
curl_setopt($handle, CURLOPT_SSL_VERIFYHOST, $ssl_verify === true ? 2 : false);
curl_setopt($handle, CURLOPT_SSL_VERIFYPEER, $ssl_verify);
curl_setopt($handle, CURLOPT_USERAGENT, $r['user-agent']);
// The option doesn't work with safe mode or when open_basedir is set, and there's a
// bug #17490 with redirected POST requests, so handle redirections outside Curl.
curl_setopt($handle, CURLOPT_FOLLOWLOCATION, false);
switch ($r['method']) {
case 'HEAD':
curl_setopt($handle, CURLOPT_NOBODY, true);
break;
case 'POST':
curl_setopt($handle, CURLOPT_POST, true);
curl_setopt($handle, CURLOPT_POSTFIELDS, $r['body']);
break;
case 'PUT':
curl_setopt($handle, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($handle, CURLOPT_POSTFIELDS, $r['body']);
break;
default:
curl_setopt($handle, CURLOPT_CUSTOMREQUEST, $r['method']);
if (!is_null($r['body'])) {
curl_setopt($handle, CURLOPT_POSTFIELDS, $r['body']);
}
break;
}
if (true === $r['blocking']) {
curl_setopt($handle, CURLOPT_HEADERFUNCTION, array($this, 'stream_headers'));
}
curl_setopt($handle, CURLOPT_HEADER, false);
// If streaming to a file open a file handle, and setup our curl streaming handler
if ($r['stream']) {
if (!$this->config->debug) {
$stream_handle = @fopen($r['filename'], 'w+');
} else {
$stream_handle = fopen($r['filename'], 'w+');
}
if (!$stream_handle) {
return new \Leeflets\Error('http_request_failed', sprintf(__('Could not open handle for fopen() to %s'), $r['filename']));
}
curl_setopt($handle, CURLOPT_FILE, $stream_handle);
}
if (!empty($r['headers'])) {
// cURL expects full header strings in each element
$headers = array();
foreach ($r['headers'] as $name => $value) {
$headers[] = "{$name}: {$value}";
}
curl_setopt($handle, CURLOPT_HTTPHEADER, $headers);
}
if ($r['httpversion'] == '1.0') {
curl_setopt($handle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);
} else {
curl_setopt($handle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
}
// Cookies are not handled by the HTTP API currently. Allow for plugin authors to handle it
// themselves... Although, it is somewhat pointless without some reference.
//do_action_ref_array( 'http_api_curl', array( &$handle ) );
// We don't need to return the body, so don't. Just execute request and return.
if (!$r['blocking']) {
curl_exec($handle);
curl_close($handle);
return array('headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array());
}
$theResponse = curl_exec($handle);
$theBody = '';
$theHeaders = \Leeflets\Http::processHeaders($this->headers);
if (strlen($theResponse) > 0 && !is_bool($theResponse)) {
// is_bool: when using $args['stream'], curl_exec will return (bool)true
$theBody = $theResponse;
}
// If no response
if (0 == strlen($theResponse) && empty($theHeaders['headers'])) {
if ($curl_error = curl_error($handle)) {
return new \Leeflets\Error('http_request_failed', $curl_error);
}
if (in_array(curl_getinfo($handle, CURLINFO_HTTP_CODE), array(301, 302))) {
return new \Leeflets\Error('http_request_failed', __('Too many redirects.'));
}
}
$this->headers = '';
$response = array();
$response['code'] = curl_getinfo($handle, CURLINFO_HTTP_CODE);
$response['message'] = \Leeflets\Http::get_status_header_desc($response['code']);
curl_close($handle);
if ($r['stream']) {
fclose($stream_handle);
}
// See #11305 - When running under safe mode, redirection is disabled above. Handle it manually.
if (!empty($theHeaders['headers']['location']) && 0 !== $r['_redirection']) {
// _redirection: The requested number of redirections
if ($r['redirection']-- > 0) {
return $this->request(\Leeflets\Http::make_absolute_url($theHeaders['headers']['location'], $url), $r);
} else {
return new \Leeflets\Error('http_request_failed', __('Too many redirects.'));
}
}
if (true === $r['decompress'] && true === Encoding::should_decode($theHeaders['headers'])) {
$theBody = Encoding::decompress($theBody);
}
return array('headers' => $theHeaders['headers'], 'body' => $theBody, 'response' => $response, 'cookies' => $theHeaders['cookies'], 'filename' => $r['filename']);
}
/**
* Send a HTTP request to a URI using fsockopen().
*
* Does not support non-blocking mode.
*
* @see \Leeflets\Http::request For default options descriptions.
*
* @since 2.7
* @access public
* @param string $url URI resource.
* @param str|array $args Optional. Override the defaults.
* @return array 'headers', 'body', 'response', 'cookies' and 'filename' keys.
*/
function request($url, $args = array())
{
$defaults = array('method' => 'GET', 'timeout' => 5, 'redirection' => 5, 'httpversion' => '1.0', 'blocking' => true, 'headers' => array(), 'body' => null, 'cookies' => array());
$r = array_merge($defaults, $args);
if (isset($r['headers']['User-Agent'])) {
$r['user-agent'] = $r['headers']['User-Agent'];
unset($r['headers']['User-Agent']);
} else {
if (isset($r['headers']['user-agent'])) {
$r['user-agent'] = $r['headers']['user-agent'];
unset($r['headers']['user-agent']);
}
}
// Construct Cookie: header if any cookies are set
\Leeflets\Http::buildCookieHeader($r);
$iError = null;
// Store error number
$strError = null;
// Store error string
$arrURL = parse_url($url);
$fsockopen_host = $arrURL['host'];
$secure_transport = false;
if (!isset($arrURL['port'])) {
if (($arrURL['scheme'] == 'ssl' || $arrURL['scheme'] == 'https') && extension_loaded('openssl')) {
$fsockopen_host = "ssl://{$fsockopen_host}";
$arrURL['port'] = 443;
$secure_transport = true;
} else {
$arrURL['port'] = 80;
}
}
//fsockopen has issues with 'localhost' with IPv6 with certain versions of PHP, It attempts to connect to ::1,
// which fails when the server is not set up for it. For compatibility, always connect to the IPv4 address.
if ('localhost' == strtolower($fsockopen_host)) {
$fsockopen_host = '127.0.0.1';
}
// There are issues with the HTTPS and SSL protocols that cause errors that can be safely
// ignored and should be ignored.
if (true === $secure_transport) {
$error_reporting = error_reporting(0);
}
$startDelay = time();
$proxy = new Proxy();
if (!$this->config->debug) {
if ($proxy->is_enabled() && $proxy->send_through_proxy($url)) {
$handle = @fsockopen($proxy->host(), $proxy->port(), $iError, $strError, $r['timeout']);
} else {
$handle = @fsockopen($fsockopen_host, $arrURL['port'], $iError, $strError, $r['timeout']);
}
} else {
if ($proxy->is_enabled() && $proxy->send_through_proxy($url)) {
$handle = fsockopen($proxy->host(), $proxy->port(), $iError, $strError, $r['timeout']);
} else {
$handle = fsockopen($fsockopen_host, $arrURL['port'], $iError, $strError, $r['timeout']);
}
}
$endDelay = time();
// If the delay is greater than the timeout then fsockopen shouldn't be used, because it will
// cause a long delay.
$elapseDelay = $endDelay - $startDelay > $r['timeout'];
if (true === $elapseDelay) {
add_option('disable_fsockopen', $endDelay, null, true);
}
if (false === $handle) {
return new \Leeflets\Error('http_request_failed', $iError . ': ' . $strError);
}
$timeout = (int) floor($r['timeout']);
$utimeout = $timeout == $r['timeout'] ? 0 : 1000000 * $r['timeout'] % 1000000;
stream_set_timeout($handle, $timeout, $utimeout);
if ($proxy->is_enabled() && $proxy->send_through_proxy($url)) {
//Some proxies require full URL in this field.
$requestPath = $url;
} else {
$requestPath = $arrURL['path'] . (isset($arrURL['query']) ? '?' . $arrURL['query'] : '');
}
if (empty($requestPath)) {
$requestPath .= '/';
}
$strHeaders = strtoupper($r['method']) . ' ' . $requestPath . ' HTTP/' . $r['httpversion'] . "\r\n";
if ($proxy->is_enabled() && $proxy->send_through_proxy($url)) {
$strHeaders .= 'Host: ' . $arrURL['host'] . ':' . $arrURL['port'] . "\r\n";
} else {
$strHeaders .= 'Host: ' . $arrURL['host'] . "\r\n";
}
if (isset($r['user-agent'])) {
$strHeaders .= 'User-agent: ' . $r['user-agent'] . "\r\n";
}
if (is_array($r['headers'])) {
foreach ((array) $r['headers'] as $header => $headerValue) {
$strHeaders .= $header . ': ' . $headerValue . "\r\n";
}
} else {
$strHeaders .= $r['headers'];
}
if ($proxy->use_authentication()) {
$strHeaders .= $proxy->authentication_header() . "\r\n";
}
$strHeaders .= "\r\n";
if (!is_null($r['body'])) {
$strHeaders .= $r['body'];
}
fwrite($handle, $strHeaders);
if (!$r['blocking']) {
fclose($handle);
return array('headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array());
}
$strResponse = '';
$bodyStarted = false;
// If streaming to a file setup the file handle
if ($r['stream']) {
if (!$this->config->debug) {
$stream_handle = @fopen($r['filename'], 'w+');
} else {
$stream_handle = fopen($r['filename'], 'w+');
}
if (!$stream_handle) {
return new \Leeflets\Error('http_request_failed', sprintf(__('Could not open handle for fopen() to %s'), $r['filename']));
}
while (!feof($handle)) {
$block = fread($handle, 4096);
if ($bodyStarted) {
fwrite($stream_handle, $block);
} else {
$strResponse .= $block;
if (strpos($strResponse, "\r\n\r\n")) {
$process = \Leeflets\Http::processResponse($strResponse);
$bodyStarted = true;
fwrite($stream_handle, $process['body']);
unset($strResponse);
$process['body'] = '';
}
}
}
fclose($stream_handle);
} else {
while (!feof($handle)) {
$strResponse .= fread($handle, 4096);
}
$process = \Leeflets\Http::processResponse($strResponse);
unset($strResponse);
}
fclose($handle);
if (true === $secure_transport) {
error_reporting($error_reporting);
}
$arrHeaders = \Leeflets\Http::processHeaders($process['headers']);
// If location is found, then assume redirect and redirect to location.
if (isset($arrHeaders['headers']['location']) && 0 !== $r['_redirection']) {
if ($r['redirection']-- > 0) {
return $this->request(\Leeflets\Http::make_absolute_url($arrHeaders['headers']['location'], $url), $r);
} else {
return new \Leeflets\Error('http_request_failed', __('Too many redirects.'));
}
}
// If the body was chunk encoded, then decode it.
if (!empty($process['body']) && isset($arrHeaders['headers']['transfer-encoding']) && 'chunked' == $arrHeaders['headers']['transfer-encoding']) {
$process['body'] = \Leeflets\Http::chunkTransferDecode($process['body']);
}
if (true === $r['decompress'] && true === Encoding::should_decode($arrHeaders['headers'])) {
$process['body'] = Encoding::decompress($process['body']);
}
return array('headers' => $arrHeaders['headers'], 'body' => $process['body'], 'response' => $arrHeaders['response'], 'cookies' => $arrHeaders['cookies'], 'filename' => $r['filename']);
}