friendica/src/Network/CurlResult.php

387 lines
8.2 KiB
PHP
Raw Normal View History

2020-02-09 22:48:04 +01:00
<?php
2020-02-09 15:45:36 +01:00
/**
* @copyright Copyright (C) 2020, Friendica
*
* @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/>.
*
2020-02-09 22:48:04 +01:00
*/
namespace Friendica\Network;
2018-10-29 22:20:46 +01:00
use Friendica\Core\Logger;
use Friendica\Network\HTTPException\InternalServerErrorException;
use Friendica\Util\Network;
/**
* A content class for Curl call results
*/
2018-10-10 22:08:13 +02:00
class CurlResult
{
/**
* @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;
2019-10-02 05:45:32 +02:00
/**
* @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
*
2018-10-10 22:08:13 +02:00
* @return CurlResult a CURL with error response
2019-01-06 22:06:53 +01:00
* @throws InternalServerErrorException
*/
public static function createErrorCurl($url = '')
{
2018-10-10 22:51:26 +02:00
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::log($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;
2018-10-11 22:18:27 +02:00
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;
2019-10-02 06:10:36 +02:00
$this->header_fields = []; // Is filled on demand
}
private function checkSuccess()
{
$this->isSuccess = ($this->returnCode >= 200 && $this->returnCode <= 299) || $this->errorNumber == 0;
2018-11-12 05:12:36 +01:00
// Everything higher or equal 400 is not a success
if ($this->returnCode >= 400) {
$this->isSuccess = false;
}
if (!$this->isSuccess) {
Logger::log('error: ' . $this->url . ': ' . $this->returnCode . ' - ' . $this->error, Logger::INFO);
Logger::log('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()
{
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 = [];
}
2018-11-24 10:01:10 +01:00
/// @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);
2018-12-04 08:12:55 +01:00
$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 = '';
}
}
/**
* Gets the Curl Code
*
* @return string The Curl Code
*/
public function getReturnCode()
{
return $this->returnCode;
}
/**
* Returns the Curl Content Type
*
* @return string the Curl Content Type
*/
public function getContentType()
{
return $this->contentType;
}
/**
* Returns the Curl headers
*
* @param string $field optional header field. Return all fields if empty
*
2019-10-01 21:02:26 +02:00
* @return string the Curl headers or the specified content of the header variable
*/
public function getHeader(string $field = '')
{
if (empty($field)) {
return $this->header;
}
$field = strtolower(trim($field));
2019-10-02 05:31:58 +02:00
$headers = $this->getHeaderArray();
if (isset($headers[$field])) {
return $headers[$field];
}
2019-10-02 11:37:05 +02:00
return '';
}
/**
* Check if a specified header exists
*
* @param string $field header field
*
* @return boolean "true" if header exists
*/
2019-10-02 08:24:29 +02:00
public function inHeader(string $field)
{
$field = strtolower(trim($field));
2019-10-02 05:31:58 +02:00
$headers = $this->getHeaderArray();
return array_key_exists($field, $headers);
}
/**
* Returns the Curl headers as an associated array
*
* @return array associated header array
*/
public function getHeaderArray()
{
2019-10-02 05:45:32 +02:00
if (!empty($this->header_fields)) {
return $this->header_fields;
}
2019-10-02 05:45:32 +02:00
$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));
2019-10-02 05:45:32 +02:00
$this->header_fields[$headerfield] = $headerdata;
}
2019-10-02 05:45:32 +02:00
return $this->header_fields;
}
/**
* @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
*/
public function isTimeout()
{
return $this->isTimeout;
}
}