mirror of https://github.com/friendica/friendica
350 lines
8.0 KiB
PHP
350 lines
8.0 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (C) 2010-2021, the Friendica project
|
|
*
|
|
* @license GNU AGPL version 3 or any later version
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
namespace Friendica\Network;
|
|
|
|
use Friendica\Core\Logger;
|
|
use Friendica\Core\System;
|
|
use Friendica\Network\HTTPException\InternalServerErrorException;
|
|
use Friendica\Util\Network;
|
|
|
|
/**
|
|
* A content class for Curl call results
|
|
*/
|
|
class CurlResult implements IHTTPResult
|
|
{
|
|
/**
|
|
* @var int HTTP return code or 0 if timeout or failure
|
|
*/
|
|
private $returnCode;
|
|
|
|
/**
|
|
* @var string the content type of the Curl call
|
|
*/
|
|
private $contentType;
|
|
|
|
/**
|
|
* @var string the HTTP headers of the Curl call
|
|
*/
|
|
private $header;
|
|
|
|
/**
|
|
* @var array the HTTP headers of the Curl call
|
|
*/
|
|
private $header_fields;
|
|
|
|
/**
|
|
* @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;
|
|
|
|
/**
|
|
* @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;
|
|
|
|
/**
|
|
* @var int the error number or 0 (zero) if no error
|
|
*/
|
|
private $errorNumber;
|
|
|
|
/**
|
|
* @var string the error message or '' (the empty string) if no
|
|
*/
|
|
private $error;
|
|
|
|
/**
|
|
* Creates an errored CURL response
|
|
*
|
|
* @param string $url optional URL
|
|
*
|
|
* @return IHTTPResult a CURL with error response
|
|
* @throws InternalServerErrorException
|
|
*/
|
|
public static function createErrorCurl($url = '')
|
|
{
|
|
return new CurlResult($url, '', ['http_code' => 0]);
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
* @throws InternalServerErrorException when HTTP code of the CURL response is missing
|
|
*/
|
|
public function __construct($url, $result, $info, $errorNumber = 0, $error = '')
|
|
{
|
|
if (!array_key_exists('http_code', $info)) {
|
|
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::debug('construct', ['url' => $url, 'returncode' => $this->returnCode, 'result' => $result]);
|
|
|
|
$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\/.+? \d+/', $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;
|
|
$this->header_fields = []; // Is filled on demand
|
|
}
|
|
|
|
private function checkSuccess()
|
|
{
|
|
$this->isSuccess = ($this->returnCode >= 200 && $this->returnCode <= 299) || $this->errorNumber == 0;
|
|
|
|
// Everything higher or equal 400 is not a success
|
|
if ($this->returnCode >= 400) {
|
|
$this->isSuccess = false;
|
|
}
|
|
|
|
if (!$this->isSuccess) {
|
|
Logger::notice('http error', ['url' => $this->url, 'code' => $this->returnCode, 'error' => $this->error, 'callstack' => System::callstack(20)]);
|
|
Logger::debug('debug', ['info' => $this->info]);
|
|
}
|
|
|
|
if (!$this->isSuccess && $this->errorNumber == CURLE_OPERATION_TIMEDOUT) {
|
|
$this->isTimeout = true;
|
|
} else {
|
|
$this->isTimeout = false;
|
|
}
|
|
}
|
|
|
|
private function checkRedirect()
|
|
{
|
|
if (!array_key_exists('url', $this->info)) {
|
|
$this->redirectUrl = '';
|
|
} else {
|
|
$this->redirectUrl = $this->info['url'];
|
|
}
|
|
|
|
if ($this->returnCode == 301 || $this->returnCode == 302 || $this->returnCode == 303 || $this->returnCode== 307) {
|
|
$redirect_parts = parse_url($this->info['redirect_url'] ?? '');
|
|
if (empty($redirect_parts)) {
|
|
$redirect_parts = [];
|
|
}
|
|
|
|
if (preg_match('/(Location:|URI:)(.*?)\n/i', $this->header, $matches)) {
|
|
$redirect_parts2 = parse_url(trim(array_pop($matches)));
|
|
if (!empty($redirect_parts2)) {
|
|
$redirect_parts = array_merge($redirect_parts, $redirect_parts2);
|
|
}
|
|
}
|
|
|
|
$parts = parse_url($this->info['url'] ?? '');
|
|
if (empty($parts)) {
|
|
$parts = [];
|
|
}
|
|
|
|
/// @todo Checking the corresponding RFC which parts of a redirect can be ommitted.
|
|
$components = ['scheme', 'host', 'path', 'query', 'fragment'];
|
|
foreach ($components as $component) {
|
|
if (empty($redirect_parts[$component]) && !empty($parts[$component])) {
|
|
$redirect_parts[$component] = $parts[$component];
|
|
}
|
|
}
|
|
|
|
$this->redirectUrl = Network::unparseURL($redirect_parts);
|
|
|
|
$this->isRedirectUrl = true;
|
|
} else {
|
|
$this->isRedirectUrl = false;
|
|
}
|
|
}
|
|
|
|
private function checkInfo()
|
|
{
|
|
if (isset($this->info['content_type'])) {
|
|
$this->contentType = $this->info['content_type'];
|
|
} else {
|
|
$this->contentType = '';
|
|
}
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
public function getReturnCode()
|
|
{
|
|
return $this->returnCode;
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
public function getContentType()
|
|
{
|
|
return $this->contentType;
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
public function getHeader($header)
|
|
{
|
|
if (empty($header)) {
|
|
return [];
|
|
}
|
|
|
|
$header = strtolower(trim($header));
|
|
|
|
$headers = $this->getHeaderArray();
|
|
|
|
if (isset($headers[$header])) {
|
|
return $headers[$header];
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
public function getHeaders()
|
|
{
|
|
return $this->getHeaderArray();
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
public function inHeader(string $field)
|
|
{
|
|
$field = strtolower(trim($field));
|
|
|
|
$headers = $this->getHeaderArray();
|
|
|
|
return array_key_exists($field, $headers);
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
public function getHeaderArray()
|
|
{
|
|
if (!empty($this->header_fields)) {
|
|
return $this->header_fields;
|
|
}
|
|
|
|
$this->header_fields = [];
|
|
|
|
$lines = explode("\n", trim($this->header));
|
|
foreach ($lines as $line) {
|
|
$parts = explode(':', $line);
|
|
$headerfield = strtolower(trim(array_shift($parts)));
|
|
$headerdata = trim(implode(':', $parts));
|
|
if (empty($this->header_fields[$headerfield])) {
|
|
$this->header_fields[$headerfield] = [$headerdata];
|
|
} elseif (!in_array($headerdata, $this->header_fields[$headerfield])) {
|
|
$this->header_fields[$headerfield][] = $headerdata;
|
|
}
|
|
}
|
|
|
|
return $this->header_fields;
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
public function isSuccess()
|
|
{
|
|
return $this->isSuccess;
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
public function getUrl()
|
|
{
|
|
return $this->url;
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
public function getRedirectUrl()
|
|
{
|
|
return $this->redirectUrl;
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
public function getBody()
|
|
{
|
|
return $this->body;
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
public function isRedirectUrl()
|
|
{
|
|
return $this->isRedirectUrl;
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
public function getErrorNumber()
|
|
{
|
|
return $this->errorNumber;
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
public function getError()
|
|
{
|
|
return $this->error;
|
|
}
|
|
|
|
/** {@inheritDoc} */
|
|
public function isTimeout()
|
|
{
|
|
return $this->isTimeout;
|
|
}
|
|
}
|