|
<?php |
|
|
|
namespace Kanboard\Core\Http; |
|
|
|
use Kanboard\Core\Base; |
|
use Kanboard\Job\HttpAsyncJob; |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class Client extends Base |
|
{ |
|
|
|
|
|
|
|
|
|
|
|
const HTTP_USER_AGENT = 'Kanboard'; |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
public function get($url, array $headers = [], $raiseForErrors = false) |
|
{ |
|
return $this->doRequest('GET', $url, '', $headers, $raiseForErrors); |
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
public function getJson($url, array $headers = [], $raiseForErrors = false) |
|
{ |
|
$response = $this->doRequest('GET', $url, '', array_merge(['Accept: application/json'], $headers), $raiseForErrors); |
|
return json_decode($response, true) ?: []; |
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
public function postJson($url, array $data, array $headers = [], $raiseForErrors = false) |
|
{ |
|
return $this->doRequest( |
|
'POST', |
|
$url, |
|
json_encode($data), |
|
array_merge(['Content-type: application/json'], $headers), |
|
$raiseForErrors |
|
); |
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
public function postJsonAsync($url, array $data, array $headers = [], $raiseForErrors = false) |
|
{ |
|
$this->queueManager->push(HttpAsyncJob::getInstance($this->container)->withParams( |
|
'POST', |
|
$url, |
|
json_encode($data), |
|
array_merge(['Content-type: application/json'], $headers), |
|
$raiseForErrors |
|
)); |
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
public function postForm($url, array $data, array $headers = [], $raiseForErrors = false) |
|
{ |
|
return $this->doRequest( |
|
'POST', |
|
$url, |
|
http_build_query($data), |
|
array_merge(['Content-type: application/x-www-form-urlencoded'], $headers), |
|
$raiseForErrors |
|
); |
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
public function postFormAsync($url, array $data, array $headers = [], $raiseForErrors = false) |
|
{ |
|
$this->queueManager->push(HttpAsyncJob::getInstance($this->container)->withParams( |
|
'POST', |
|
$url, |
|
http_build_query($data), |
|
array_merge(['Content-type: application/x-www-form-urlencoded'], $headers), |
|
$raiseForErrors |
|
)); |
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
public function doRequest($method, $url, $content, array $headers, $raiseForErrors = false) |
|
{ |
|
$requestBody = ''; |
|
|
|
if (! empty($url)) { |
|
if (function_exists('curl_version')) { |
|
if (DEBUG) { |
|
$this->logger->debug('HttpClient::doRequest: cURL detected'); |
|
} |
|
$requestBody = $this->doRequestWithCurl($method, $url, $content, $headers, $raiseForErrors); |
|
} else { |
|
if (DEBUG) { |
|
$this->logger->debug('HttpClient::doRequest: using socket'); |
|
} |
|
$requestBody = $this->doRequestWithSocket($method, $url, $content, $headers, $raiseForErrors); |
|
} |
|
} |
|
|
|
return $requestBody; |
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
private function doRequestWithSocket($method, $url, $content, array $headers, $raiseForErrors = false) |
|
{ |
|
$startTime = microtime(true); |
|
$stream = @fopen(trim($url), 'r', false, stream_context_create($this->getContext($method, $content, $headers, $raiseForErrors))); |
|
|
|
if (! is_resource($stream)) { |
|
$this->logger->error('HttpClient: request failed ('.$url.')'); |
|
|
|
if ($raiseForErrors) { |
|
throw new ClientException('Unreachable URL: '.$url); |
|
} |
|
|
|
return ''; |
|
} |
|
|
|
$body = stream_get_contents($stream); |
|
$metadata = stream_get_meta_data($stream); |
|
|
|
if ($raiseForErrors && array_key_exists('wrapper_data', $metadata)) { |
|
$statusCode = $this->getStatusCode($metadata['wrapper_data']); |
|
|
|
if ($statusCode >= 400) { |
|
throw new InvalidStatusException('Request failed with status code '.$statusCode, $statusCode, $body); |
|
} |
|
} |
|
|
|
if (DEBUG) { |
|
$this->logger->debug('HttpClient: url='.$url); |
|
$this->logger->debug('HttpClient: headers='.var_export($headers, true)); |
|
$this->logger->debug('HttpClient: payload='.$content); |
|
$this->logger->debug('HttpClient: metadata='.var_export($metadata, true)); |
|
$this->logger->debug('HttpClient: body='.$body); |
|
$this->logger->debug('HttpClient: executionTime='.(microtime(true) - $startTime)); |
|
} |
|
|
|
return $body; |
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
private function doRequestWithCurl($method, $url, $content, array $headers, $raiseForErrors = false) |
|
{ |
|
$startTime = microtime(true); |
|
$curlSession = @curl_init(); |
|
|
|
curl_setopt($curlSession, CURLOPT_URL, trim($url)); |
|
curl_setopt($curlSession, CURLOPT_USERAGENT, self::HTTP_USER_AGENT); |
|
curl_setopt($curlSession, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1); |
|
curl_setopt($curlSession, CURLOPT_TIMEOUT, HTTP_TIMEOUT); |
|
curl_setopt($curlSession, CURLOPT_FORBID_REUSE, true); |
|
curl_setopt($curlSession, CURLOPT_MAXREDIRS, HTTP_MAX_REDIRECTS); |
|
curl_setopt($curlSession, CURLOPT_RETURNTRANSFER, true); |
|
curl_setopt($curlSession, CURLOPT_FOLLOWLOCATION, true); |
|
|
|
if ('POST' === $method) { |
|
curl_setopt($curlSession, CURLOPT_POST, true); |
|
curl_setopt($curlSession, CURLOPT_POSTFIELDS, $content); |
|
} elseif ('PUT' === $method) { |
|
curl_setopt($curlSession, CURLOPT_CUSTOMREQUEST, 'PUT'); |
|
curl_setopt($curlSession, CURLOPT_POST, true); |
|
curl_setopt($curlSession, CURLOPT_POSTFIELDS, $content); |
|
} |
|
|
|
if (! empty($headers)) { |
|
curl_setopt($curlSession, CURLOPT_HTTPHEADER, $headers); |
|
} |
|
|
|
if (HTTP_VERIFY_SSL_CERTIFICATE === false) { |
|
curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 0); |
|
curl_setopt($curlSession, CURLOPT_SSL_VERIFYPEER, false); |
|
} |
|
|
|
if (HTTP_PROXY_HOSTNAME) { |
|
curl_setopt($curlSession, CURLOPT_PROXY, HTTP_PROXY_HOSTNAME); |
|
curl_setopt($curlSession, CURLOPT_PROXYPORT, HTTP_PROXY_PORT); |
|
curl_setopt($curlSession, CURLOPT_NOPROXY, HTTP_PROXY_EXCLUDE); |
|
} |
|
|
|
if (HTTP_PROXY_USERNAME) { |
|
curl_setopt($curlSession, CURLOPT_PROXYAUTH, CURLAUTH_BASIC); |
|
curl_setopt($curlSession, CURLOPT_PROXYUSERPWD, HTTP_PROXY_USERNAME.':'.HTTP_PROXY_PASSWORD); |
|
} |
|
|
|
$body = curl_exec($curlSession); |
|
|
|
if ($body === false) { |
|
$errorMsg = curl_error($curlSession); |
|
curl_close($curlSession); |
|
|
|
$this->logger->error('HttpClient: request failed ('.$url.' - '.$errorMsg.')'); |
|
|
|
if ($raiseForErrors) { |
|
throw new ClientException('Unreachable URL: '.$url.' ('.$errorMsg.')'); |
|
} |
|
|
|
return ''; |
|
} |
|
|
|
if ($raiseForErrors) { |
|
$statusCode = curl_getinfo($curlSession, CURLINFO_RESPONSE_CODE); |
|
|
|
if ($statusCode >= 400) { |
|
curl_close($curlSession); |
|
throw new InvalidStatusException('Request failed with status code '.$statusCode, $statusCode, $body); |
|
} |
|
} |
|
|
|
if (DEBUG) { |
|
$this->logger->debug('HttpClient: url='.$url); |
|
$this->logger->debug('HttpClient: headers='.var_export($headers, true)); |
|
$this->logger->debug('HttpClient: payload='.$content); |
|
$this->logger->debug('HttpClient: metadata='.var_export(curl_getinfo($curlSession), true)); |
|
$this->logger->debug('HttpClient: body='.$body); |
|
$this->logger->debug('HttpClient: executionTime='.(microtime(true) - $startTime)); |
|
} |
|
|
|
curl_close($curlSession); |
|
return $body; |
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
private function getContext($method, $content, array $headers, $raiseForErrors = false) |
|
{ |
|
$default_headers = [ |
|
'User-Agent: '.self::HTTP_USER_AGENT, |
|
'Connection: close', |
|
]; |
|
|
|
if (HTTP_PROXY_USERNAME) { |
|
$default_headers[] = 'Proxy-Authorization: Basic '.base64_encode(HTTP_PROXY_USERNAME.':'.HTTP_PROXY_PASSWORD); |
|
} |
|
|
|
$headers = array_merge($default_headers, $headers); |
|
|
|
$context = [ |
|
'http' => [ |
|
'method' => $method, |
|
'protocol_version' => 1.1, |
|
'timeout' => HTTP_TIMEOUT, |
|
'max_redirects' => HTTP_MAX_REDIRECTS, |
|
'header' => implode("\r\n", $headers), |
|
'content' => $content, |
|
'ignore_errors' => $raiseForErrors, |
|
] |
|
]; |
|
|
|
if (HTTP_PROXY_HOSTNAME) { |
|
$context['http']['proxy'] = 'tcp://'.HTTP_PROXY_HOSTNAME.':'.HTTP_PROXY_PORT; |
|
$context['http']['request_fulluri'] = true; |
|
} |
|
|
|
if (HTTP_VERIFY_SSL_CERTIFICATE === false) { |
|
$context['ssl'] = [ |
|
'verify_peer' => false, |
|
'verify_peer_name' => false, |
|
'allow_self_signed' => true, |
|
]; |
|
} |
|
|
|
return $context; |
|
} |
|
|
|
private function getStatusCode(array $lines) |
|
{ |
|
$status = 200; |
|
|
|
foreach ($lines as $line) { |
|
if (strpos($line, 'HTTP/1') === 0) { |
|
$status = (int) substr($line, 9, 3); |
|
} |
|
} |
|
|
|
return $status; |
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
public static function backend() |
|
{ |
|
return function_exists('curl_version') ? 'cURL' : 'socket'; |
|
} |
|
} |
|
|