2018-10-09 17:58:58 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Friendica\Network;
|
|
|
|
|
|
|
|
|
2018-10-10 19:08:43 +00:00
|
|
|
use Friendica\Network\HTTPException\InternalServerErrorException;
|
|
|
|
|
2018-10-09 17:58:58 +00:00
|
|
|
/**
|
|
|
|
* A content class for Curl call results
|
|
|
|
*/
|
2018-10-10 20:08:13 +00:00
|
|
|
class CurlResult
|
2018-10-09 17:58:58 +00:00
|
|
|
{
|
|
|
|
/**
|
2018-10-10 19:08:43 +00:00
|
|
|
* @var int HTTP return code or 0 if timeout or failure
|
2018-10-09 17:58:58 +00:00
|
|
|
*/
|
2018-10-10 19:08:43 +00:00
|
|
|
private $returnCode;
|
2018-10-09 17:58:58 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string the content type of the Curl call
|
|
|
|
*/
|
|
|
|
private $contentType;
|
|
|
|
|
|
|
|
/**
|
2018-10-10 19:08:43 +00:00
|
|
|
* @var string the HTTP headers of the Curl call
|
2018-10-09 17:58:58 +00:00
|
|
|
*/
|
2018-10-10 19:08:43 +00:00
|
|
|
private $header;
|
2018-10-09 17:58:58 +00:00
|
|
|
|
2018-10-10 19:08:43 +00:00
|
|
|
/**
|
|
|
|
* @var boolean true (if HTTP 2xx result) or false
|
|
|
|
*/
|
|
|
|
private $isSuccess;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string the URL which was called
|
|
|
|
*/
|
|
|
|
private $url;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string in case of redirect, content was finally retrieved from this URL
|
|
|
|
*/
|
|
|
|
private $redirectUrl;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string fetched content
|
|
|
|
*/
|
|
|
|
private $body;
|
2018-10-09 17:58:58 +00:00
|
|
|
|
|
|
|
/**
|
2018-10-10 19:08:43 +00:00
|
|
|
* @var array some informations about the fetched data
|
|
|
|
*/
|
|
|
|
private $info;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var boolean true if the URL has a redirect
|
|
|
|
*/
|
|
|
|
private $isRedirectUrl;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var boolean true if the curl request timed out
|
|
|
|
*/
|
|
|
|
private $isTimeout;
|
|
|
|
|
|
|
|
/**
|
2018-10-10 19:20:30 +00:00
|
|
|
* @var int the error number or 0 (zero) if no error
|
2018-10-10 19:08:43 +00:00
|
|
|
*/
|
|
|
|
private $errorNumber;
|
|
|
|
|
|
|
|
/**
|
2018-10-10 19:20:30 +00:00
|
|
|
* @var string the error message or '' (the empty string) if no
|
2018-10-10 19:08:43 +00:00
|
|
|
*/
|
|
|
|
private $error;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates an errored CURL response
|
2018-10-09 17:58:58 +00:00
|
|
|
*
|
2018-10-10 19:08:43 +00:00
|
|
|
* @param string $url optional URL
|
|
|
|
*
|
2018-10-10 20:08:13 +00:00
|
|
|
* @return CurlResult a CURL with error response
|
2018-10-09 17:58:58 +00:00
|
|
|
*/
|
2018-10-10 19:08:43 +00:00
|
|
|
public static function createErrorCurl($url = '')
|
2018-10-09 17:58:58 +00:00
|
|
|
{
|
2018-10-10 20:08:13 +00:00
|
|
|
return new CurlResult($url,'', [ 'http_code' => 0 ]);
|
2018-10-09 17:58:58 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-10-10 19:08:43 +00:00
|
|
|
* Curl constructor.
|
|
|
|
* @param string $url the URL which was called
|
|
|
|
* @param string $result the result of the curl execution
|
|
|
|
* @param array $info an additional info array
|
|
|
|
* @param int $errorNumber the error number or 0 (zero) if no error
|
|
|
|
* @param string $error the error message or '' (the empty string) if no
|
2018-10-09 17:58:58 +00:00
|
|
|
*
|
2018-10-10 19:08:43 +00:00
|
|
|
* @throws InternalServerErrorException when HTTP code of the CURL response is missing
|
2018-10-09 17:58:58 +00:00
|
|
|
*/
|
2018-10-10 19:08:43 +00:00
|
|
|
public function __construct($url, $result, $info, $errorNumber = 0, $error = '')
|
|
|
|
{
|
2018-10-10 19:20:30 +00:00
|
|
|
if (!array_key_exists('http_code', $info)) {
|
2018-10-10 19:08:43 +00:00
|
|
|
throw new InternalServerErrorException('CURL response doesn\'t contains a response HTTP code');
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->returnCode = $info['http_code'];
|
|
|
|
$this->url = $url;
|
|
|
|
$this->info = $info;
|
|
|
|
$this->errorNumber = $errorNumber;
|
|
|
|
$this->error = $error;
|
|
|
|
|
|
|
|
logger($url . ': ' . $this->returnCode . " " . $result, LOGGER_DATA);
|
|
|
|
|
|
|
|
$this->parseBodyHeader($result);
|
|
|
|
$this->checkSuccess();
|
|
|
|
$this->checkRedirect();
|
|
|
|
$this->checkInfo();
|
|
|
|
}
|
|
|
|
|
|
|
|
private function parseBodyHeader($result)
|
|
|
|
{
|
|
|
|
// Pull out multiple headers, e.g. proxy and continuation headers
|
|
|
|
// allow for HTTP/2.x without fixing code
|
|
|
|
|
|
|
|
$header = '';
|
|
|
|
$base = $result;
|
|
|
|
while (preg_match('/^HTTP\/[1-2].+? [1-5][0-9][0-9]/', $base)) {
|
|
|
|
$chunk = substr($base, 0, strpos($base, "\r\n\r\n") + 4);
|
|
|
|
$header .= $chunk;
|
|
|
|
$base = substr($base, strlen($chunk));
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->body = substr($result, strlen($header));
|
|
|
|
$this->header = $header;
|
|
|
|
}
|
|
|
|
|
|
|
|
private function checkSuccess()
|
2018-10-09 17:58:58 +00:00
|
|
|
{
|
2018-10-10 19:20:30 +00:00
|
|
|
$this->isSuccess = ($this->returnCode >= 200 && $this->returnCode <= 299) || $this->errorNumber == 0;
|
2018-10-10 19:08:43 +00:00
|
|
|
|
|
|
|
if (!$this->isSuccess) {
|
2018-10-10 19:20:30 +00:00
|
|
|
logger('error: ' . $this->url . ': ' . $this->returnCode . ' - ' . $this->error, LOGGER_INFO);
|
2018-10-10 19:08:43 +00:00
|
|
|
logger('debug: ' . print_r($this->info, true), LOGGER_DATA);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!$this->isSuccess && $this->errorNumber == CURLE_OPERATION_TIMEDOUT) {
|
|
|
|
$this->isTimeout = true;
|
|
|
|
} else {
|
|
|
|
$this->isTimeout = false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
private function checkRedirect()
|
|
|
|
{
|
2018-10-10 19:20:30 +00:00
|
|
|
if (!array_key_exists('url', $this->info)) {
|
2018-10-10 19:08:43 +00:00
|
|
|
$this->redirectUrl = '';
|
|
|
|
} else {
|
|
|
|
$this->redirectUrl = $this->info['url'];
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($this->returnCode == 301 || $this->returnCode == 302 || $this->returnCode == 303 || $this->returnCode== 307) {
|
2018-10-10 19:20:30 +00:00
|
|
|
$new_location_info = (!array_key_exists('redirect_url', $this->info) ? '' : @parse_url($this->info['redirect_url']));
|
|
|
|
$old_location_info = (!array_key_exists('url', $this->info) ? '' : @parse_url($this->info['url']));
|
2018-10-10 19:08:43 +00:00
|
|
|
|
|
|
|
$this->redirectUrl = $new_location_info;
|
|
|
|
|
|
|
|
if (empty($new_location_info['path']) && !empty($new_location_info['host'])) {
|
|
|
|
$this->redirectUrl = $new_location_info['scheme'] . '://' . $new_location_info['host'] . $old_location_info['path'];
|
|
|
|
}
|
|
|
|
|
|
|
|
$matches = [];
|
|
|
|
|
|
|
|
if (preg_match('/(Location:|URI:)(.*?)\n/i', $this->header, $matches)) {
|
|
|
|
$this->redirectUrl = trim(array_pop($matches));
|
|
|
|
}
|
|
|
|
if (strpos($this->redirectUrl, '/') === 0) {
|
|
|
|
$this->redirectUrl = $old_location_info["scheme"] . "://" . $old_location_info["host"] . $this->redirectUrl;
|
|
|
|
}
|
|
|
|
$old_location_query = @parse_url($this->url, PHP_URL_QUERY);
|
|
|
|
|
|
|
|
if ($old_location_query != '') {
|
|
|
|
$this->redirectUrl .= '?' . $old_location_query;
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->isRedirectUrl = filter_var($this->redirectUrl, FILTER_VALIDATE_URL);
|
|
|
|
} else {
|
|
|
|
$this->isRedirectUrl = false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
private function checkInfo()
|
|
|
|
{
|
|
|
|
if (isset($this->info['content_type'])) {
|
|
|
|
$this->contentType = $this->info['content_type'];
|
|
|
|
} else {
|
|
|
|
$this->contentType = '';
|
|
|
|
}
|
2018-10-09 17:58:58 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-10-10 19:08:43 +00:00
|
|
|
* Gets the Curl Code
|
2018-10-09 17:58:58 +00:00
|
|
|
*
|
2018-10-10 19:08:43 +00:00
|
|
|
* @return string The Curl Code
|
2018-10-09 17:58:58 +00:00
|
|
|
*/
|
2018-10-10 19:08:43 +00:00
|
|
|
public function getReturnCode()
|
2018-10-09 17:58:58 +00:00
|
|
|
{
|
2018-10-10 19:08:43 +00:00
|
|
|
return $this->returnCode;
|
2018-10-09 17:58:58 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the Curl Content Type
|
|
|
|
*
|
|
|
|
* @return string the Curl Content Type
|
|
|
|
*/
|
|
|
|
public function getContentType()
|
|
|
|
{
|
|
|
|
return $this->contentType;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-10-10 19:08:43 +00:00
|
|
|
* Returns the Curl headers
|
2018-10-09 17:58:58 +00:00
|
|
|
*
|
2018-10-10 19:08:43 +00:00
|
|
|
* @return string the Curl headers
|
2018-10-09 17:58:58 +00:00
|
|
|
*/
|
2018-10-10 19:08:43 +00:00
|
|
|
public function getHeader()
|
2018-10-09 17:58:58 +00:00
|
|
|
{
|
2018-10-10 19:08:43 +00:00
|
|
|
return $this->header;
|
2018-10-09 17:58:58 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-10-10 19:08:43 +00:00
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function isSuccess()
|
|
|
|
{
|
|
|
|
return $this->isSuccess;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getUrl()
|
|
|
|
{
|
|
|
|
return $this->url;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getRedirectUrl()
|
|
|
|
{
|
|
|
|
return $this->redirectUrl;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getBody()
|
|
|
|
{
|
|
|
|
return $this->body;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function getInfo()
|
|
|
|
{
|
|
|
|
return $this->info;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function isRedirectUrl()
|
|
|
|
{
|
|
|
|
return $this->isRedirectUrl;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return int
|
|
|
|
*/
|
|
|
|
public function getErrorNumber()
|
|
|
|
{
|
|
|
|
return $this->errorNumber;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getError()
|
|
|
|
{
|
|
|
|
return $this->error;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return bool
|
2018-10-09 17:58:58 +00:00
|
|
|
*/
|
2018-10-10 19:08:43 +00:00
|
|
|
public function isTimeout()
|
2018-10-09 17:58:58 +00:00
|
|
|
{
|
2018-10-10 19:08:43 +00:00
|
|
|
return $this->isTimeout;
|
2018-10-09 17:58:58 +00:00
|
|
|
}
|
|
|
|
}
|