37962869632

Committed 09 Oct 2026 04:57PM UTC coverage: 90.806% (+0.09%) from 90.718%

Build # 37962869632

Build Type

push

github

Committed by

web-flow

Commit Message

test: adjust `CURLRequestExceptionTest` to 4.8's base URI handling (#10612)

Coverage Stats

26034 of 28670 relevant lines covered (90.81%)

250.84 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

98.33

/system/HTTP/CURLRequest.php

<?php

declare(strict_types=1);

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\HTTP;

use CodeIgniter\Exceptions\InvalidArgumentException;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use Config\App;
use Config\CURLRequest as ConfigCURLRequest;
use CurlShareHandle;
use SensitiveParameter;

/**
 * A lightweight HTTP client for sending synchronous HTTP requests via cURL.
 *
 * @see \CodeIgniter\HTTP\CURLRequestTest
 */
class CURLRequest extends OutgoingRequest
{
    /**
     * The response object associated with this request
     *
     * @var ResponseInterface|null
     */
    protected $response;

    /**
     * The original response object associated with this request
     *
     * @var ResponseInterface|null
     */
    protected $responseOrig;

    /**
     * The URI associated with this request
     *
     * @var URI
     */
    protected $baseURI;

    /**
     * The constructor's base URI, preserved independently of per-request changes.
     */
    private readonly URI $defaultBaseURI;

    /**
     * The setting values
     *
     * @var array<string, mixed>
     */
    protected $config;

    /**
     * The default setting values
     *
     * @var array<string, mixed>
     */
    protected $defaultConfig = [
        'timeout'         => 0.0,
        'connect_timeout' => 150,
        'debug'           => false,
        'verify'          => true,
    ];

    /**
     * Default values for when 'allow_redirects'
     * option is true.
     *
     * @var array<string, mixed>
     */
    protected $redirectDefaults = [
        'max'       => 5,
        'strict'    => true,
        'protocols' => [
            'http',
            'https',
        ],
    ];

    /**
     * Default values for when 'retry' is enabled.
     *
     * @var array<string, bool|int|list<int>>
     */
    protected array $retryDefaults = [
        'max_retries'         => 3,
        'delay'               => 1000,
        'max_delay'           => 30_000,
        'status_codes'        => [429, 503, 504],
        'curl_errors'         => false,
        'respect_retry_after' => true,
    ];

    /**
     * cURL error numbers that may succeed on another attempt.
     *
     * @var list<int>
     */
    protected array $transientCurlErrors = [];

    /**
     * The number of milliseconds to delay before
     * sending the request.
     *
     * @var float
     */
    protected $delay = 0.0;

    /**
     * The last cURL error number.
     */
    protected int $lastCurlError = 0;

    /**
     * The default options from the constructor. Applied to all requests.
     *
     * @var array<string, mixed>
     */
    private readonly array $defaultOptions;

    /**
     * Whether share options between requests or not.
     *
     * If true, all the options won't be reset between requests.
     * It may cause an error request with unnecessary headers.
     */
    private readonly bool $shareOptions;

    /**
     * The share connection instance.
     */
    protected ?CurlShareHandle $shareConnection = null;

    /**
     * Takes an array of options to set the following possible class properties:
     *
     *  - baseURI
     *  - timeout
     *  - any other request options to use as defaults.
     *
     * @todo v4.8.0 Remove $config parameter since unused
     *
     * @param array<string, mixed> $options
     *
     * @phpstan-ignore-next-line constructor.unusedParameter
     */
    public function __construct(App $config, URI $uri, ?ResponseInterface $response = null, array $options = [])
    {
        if (! function_exists('curl_version')) {
            throw HTTPException::forMissingCurl(); // @codeCoverageIgnore
        }

        $this->transientCurlErrors = [
            CURLE_COULDNT_RESOLVE_HOST,
            CURLE_COULDNT_CONNECT,
            CURLE_OPERATION_TIMEDOUT,
            CURLE_SEND_ERROR,
            CURLE_RECV_ERROR,
        ];

        parent::__construct(Method::GET, $uri);

        $this->responseOrig = $response ?? new Response();
        // Remove the default Content-Type header.
        $this->responseOrig->removeHeader('Content-Type');

        $this->baseURI        = $uri->useRawQueryString();
        $this->defaultOptions = $options;

        $this->shareOptions = config(ConfigCURLRequest::class)->shareOptions;

        $this->config = $this->defaultConfig;
        $this->parseOptions($options);
        $this->defaultBaseURI = clone $this->baseURI;

        // Share Connection
        $optShareConnection = config(ConfigCURLRequest::class)->shareConnectionOptions ?? [ // @phpstan-ignore nullCoalesce.property
            CURL_LOCK_DATA_CONNECT,
            CURL_LOCK_DATA_DNS,
        ];

        if ($optShareConnection !== []) {
            $this->shareConnection = curl_share_init();

            foreach (array_unique($optShareConnection) as $opt) {
                curl_share_setopt($this->shareConnection, CURLSHOPT_SHARE, $opt);
            }
        }
    }

    /**
     * Sends an HTTP request to the specified $url. If this is a relative
     * URL, it will be merged with $this->baseURI to form a complete URL.
     *
     * @param string               $method  HTTP method
     * @param array<string, mixed> $options
     */
    public function request($method, string $url, array $options = []): ResponseInterface
    {
        $this->response = clone $this->responseOrig;

        try {
            $this->parseOptions($options);

            $url = $this->prepareURL($url);

            $method = esc(strip_tags($method));

            $this->send($method, $url);
        } finally {
            if ($this->shareOptions === false) {
                $this->resetOptions();
            }
        }

        return $this->response;
    }

    /**
     * Reset all options to default.
     *
     * @return void
     */
    protected function resetOptions()
    {
        // Reset headers
        $this->headers   = [];
        $this->headerMap = [];

        // Reset body
        $this->body = null;

        // Reset configs
        $this->config = $this->defaultConfig;

        $this->baseURI = clone $this->defaultBaseURI;
        $this->delay   = 0.0;

        // Set the default options for next request
        $this->parseOptions($this->defaultOptions);
    }

    /**
     * Convenience method for sending a GET request.
     *
     * @param array<string, mixed> $options
     */
    public function get(string $url, array $options = []): ResponseInterface
    {
        return $this->request(Method::GET, $url, $options);
    }

    /**
     * Convenience method for sending a DELETE request.
     *
     * @param array<string, mixed> $options
     */
    public function delete(string $url, array $options = []): ResponseInterface
    {
        return $this->request('DELETE', $url, $options);
    }

    /**
     * Convenience method for sending a HEAD request.
     *
     * @param array<string, mixed> $options
     */
    public function head(string $url, array $options = []): ResponseInterface
    {
        return $this->request('HEAD', $url, $options);
    }

    /**
     * Convenience method for sending an OPTIONS request.
     *
     * @param array<string, mixed> $options
     */
    public function options(string $url, array $options = []): ResponseInterface
    {
        return $this->request('OPTIONS', $url, $options);
    }

    /**
     * Convenience method for sending a PATCH request.
     *
     * @param array<string, mixed> $options
     */
    public function patch(string $url, array $options = []): ResponseInterface
    {
        return $this->request('PATCH', $url, $options);
    }

    /**
     * Convenience method for sending a POST request.
     *
     * @param array<string, mixed> $options
     */
    public function post(string $url, array $options = []): ResponseInterface
    {
        return $this->request(Method::POST, $url, $options);
    }

    /**
     * Convenience method for sending a PUT request.
     *
     * @param array<string, mixed> $options
     */
    public function put(string $url, array $options = []): ResponseInterface
    {
        return $this->request(Method::PUT, $url, $options);
    }

    /**
     * Convenience method for sending a QUERY request.
     *
     * @param array<string, mixed> $options
     */
    public function query(string $url, array $options = []): ResponseInterface
    {
        return $this->request(Method::QUERY, $url, $options);
    }

    /**
     * Set the HTTP Authentication.
     *
     * @param string $type basic or digest
     *
     * @return $this
     */
    public function setAuth(string $username, #[SensitiveParameter] string $password, string $type = 'basic')
    {
        $this->config['auth'] = [$username, $password, $type];

        return $this;
    }

    /**
     * Set form data to be sent.
     *
     * @param bool                 $multipart Set TRUE if you are sending CURLFiles
     * @param array<string, mixed> $params
     *
     * @return $this
     */
    public function setForm(array $params, bool $multipart = false)
    {
        if ($multipart) {
            $this->config['multipart'] = $params;
        } else {
            $this->config['form_params'] = $params;
        }

        return $this;
    }

    /**
     * Set JSON data to be sent.
     *
     * @param mixed $data
     *
     * @return $this
     */
    public function setJSON($data)
    {
        $this->config['json'] = $data;

        return $this;
    }

    /**
     * Sets the correct settings based on the options array
     * passed in.
     *
     * @param array<string, mixed> $options
     *
     * @return void
     */
    protected function parseOptions(array $options)
    {
        if (array_key_exists('baseURI', $options)) {
            $this->baseURI = new URI($options['baseURI'], true);
            unset($options['baseURI']);
        }

        if (array_key_exists('headers', $options) && is_array($options['headers'])) {
            foreach ($options['headers'] as $name => $value) {
                $this->setHeader($name, $value);
            }

            unset($options['headers']);
        }

        if (array_key_exists('delay', $options)) {
            // Convert from the milliseconds passed in
            // to the seconds that sleep requires.
            $this->delay = (float) $options['delay'] / 1000;
            unset($options['delay']);
        }

        if (array_key_exists('body', $options)) {
            $this->setBody($options['body']);
            unset($options['body']);
        }

        foreach ($options as $key => $value) {
            $this->config[$key] = $value;
        }
    }

    /**
     * If the $url is a relative URL, will attempt to create
     * a full URL by prepending $this->baseURI to it.
     */
    protected function prepareURL(string $url): string
    {
        // If it's a full URI, then we have nothing to do here...
        if (str_contains($url, '://')) {
            return $url;
        }

        $uri = $this->baseURI->resolveRelativeURI($url);

        // Create the string instead of casting to prevent baseURL muddling
        return URI::createURIString(
            $uri->getScheme(),
            $uri->getAuthority(),
            $uri->getPath(),
            $uri->getQuery(),
            $uri->getFragment(),
        );
    }

    /**
     * Fires the actual cURL request.
     *
     * @return ResponseInterface
     */
    public function send(string $method, string $url)
    {
        // Reset our curl options so we're on a fresh slate.
        $curlOptions = [];
        $config      = $this->config;
        $retry       = $this->normalizeRetryOption($config['retry'] ?? false);

        $query = $this->config['query'] ?? [];

        if (is_array($query) && $query !== []) {
            // This is likely too naive a solution.
            // Should look into handling when $url already
            // has query vars on it.
            $url .= '?' . http_build_query($query);
            unset($this->config['query']);
        }

        $curlOptions[CURLOPT_URL]            = $url;
        $curlOptions[CURLOPT_RETURNTRANSFER] = true;

        if ($this->shareConnection instanceof CurlShareHandle) {
            $curlOptions[CURLOPT_SHARE] = $this->shareConnection;
        }

        $curlOptions[CURLOPT_HEADER] = true;
        // Disable @file uploads in post data.
        $curlOptions[CURLOPT_SAFE_UPLOAD] = true;

        $curlOptions = $this->setCURLOptions($curlOptions, $config);
        $curlOptions = $this->applyMethod($method, $curlOptions);
        $curlOptions = $this->applyRequestHeaders($curlOptions);

        if ($retry !== null) {
            $curlOptions[CURLOPT_FAILONERROR] = false;
        }

        // Do we need to delay this request?
        if ($this->delay > 0) {
            $this->sleep($this->delay);
        }

        if ($retry === null) {
            return $this->sendAttempt($curlOptions);
        }

        $httpErrors = array_key_exists('http_errors', $config) ? (bool) $config['http_errors'] : true;

        return $this->sendWithRetries($curlOptions, $retry, $httpErrors);
    }

    /**
     * Sends the request until it succeeds or retry attempts are exhausted.
     *
     * @param array<int, mixed>                 $curlOptions
     * @param array<string, bool|int|list<int>> $retry
     */
    protected function sendWithRetries(array $curlOptions, array $retry, bool $httpErrors): ResponseInterface
    {
        $attempt = 0;

        while (true) {
            $this->response = clone $this->responseOrig;

            try {
                $response = $this->sendAttempt($curlOptions);
            } catch (HTTPException $e) {
                if (! $this->shouldRetryCurlError($retry, $attempt)) {
                    throw $e;
                }

                $this->sleep($this->getRetryDelay($retry, $attempt) / 1000);
                $attempt++;

                continue;
            }

            if (! $this->shouldRetryResponse($response, $retry, $attempt)) {
                if ($httpErrors && $response->getStatusCode() >= 400) {
                    throw HTTPException::forCurlError((string) CURLE_HTTP_RETURNED_ERROR, 'The requested URL returned error: ' . $response->getStatusCode());
                }

                return $response;
            }

            $this->sleep($this->getRetryDelay($retry, $attempt, $response) / 1000);
            $attempt++;
        }
    }

    /**
     * Sends a single cURL request attempt and populates the response.
     *
     * @param array<int, mixed> $curlOptions
     */
    protected function sendAttempt(array $curlOptions): ResponseInterface
    {
        $this->lastCurlError = 0;

        $output = $this->sendRequest($curlOptions);

        // Set the string we want to break our response from
        $breakString = "\r\n\r\n";

        // Remove all intermediate responses
        $output = $this->removeIntermediateResponses($output, $breakString);

        // Split out our headers and body
        $break = strpos($output, $breakString);

        if ($break !== false) {
            // Our headers
            $headers = explode("\n", substr($output, 0, $break));

            $this->setResponseHeaders($headers);

            // Our body
            $body = substr($output, $break + 4);
            $this->response->setBody($body);
        } else {
            $this->response->setBody($output);
        }

        return $this->response;
    }

    /**
     * Normalizes the retry option into retry settings.
     *
     * @return array<string, bool|int|list<int>>|null
     */
    protected function normalizeRetryOption(mixed $retry): ?array
    {
        if (in_array($retry, [false, null, 0], true)) {
            return null;
        }

        $config = $this->retryDefaults;

        if (is_int($retry)) {
            $config['max_retries'] = $retry;
        } elseif (is_array($retry)) {
            $config = array_merge($config, $retry);
        } else {
            return null;
        }

        $config['max_retries'] = max(0, (int) $config['max_retries']);

        if ($config['max_retries'] === 0) {
            return null;
        }

        $config['delay']               = $this->normalizeRetryDelay($config['delay']);
        $config['max_delay']           = max(0, (int) $config['max_delay']);
        $config['status_codes']        = array_map(intval(...), (array) $config['status_codes']);
        $config['curl_errors']         = (bool) $config['curl_errors'];
        $config['respect_retry_after'] = (bool) $config['respect_retry_after'];

        return $config;
    }

    /**
     * Normalizes the retry delay setting.
     *
     * @return int|list<int>
     */
    protected function normalizeRetryDelay(mixed $delay): array|int
    {
        if (is_array($delay)) {
            return array_map(static fn ($value): int => max(0, (int) $value), $delay);
        }

        return max(0, (int) $delay);
    }

    /**
     * Determines whether a response should be retried.
     *
     * @param array<string, bool|int|list<int>> $retry
     */
    protected function shouldRetryResponse(ResponseInterface $response, array $retry, int $attempt): bool
    {
        if ($attempt >= $retry['max_retries']) {
            return false;
        }

        return in_array($response->getStatusCode(), $retry['status_codes'], true);
    }

    /**
     * Determines whether a cURL error should be retried.
     *
     * @param array<string, bool|int|list<int>> $retry
     */
    protected function shouldRetryCurlError(array $retry, int $attempt): bool
    {
        if ($attempt >= $retry['max_retries'] || $retry['curl_errors'] === false) {
            return false;
        }

        return in_array($this->lastCurlError, $this->transientCurlErrors, true);
    }

    /**
     * Returns the delay before the next retry attempt.
     *
     * @param array<string, bool|int|list<int>> $retry
     */
    protected function getRetryDelay(array $retry, int $attempt, ?ResponseInterface $response = null): int
    {
        if ($response instanceof ResponseInterface && $retry['respect_retry_after'] === true) {
            $retryAfter = $this->getRetryAfterDelay($response);

            if ($retryAfter !== null) {
                return $this->limitRetryDelay($retryAfter * 1000, $retry);
            }
        }

        $delay = $retry['delay'];

        if (is_array($delay)) {
            $lastDelay = $delay[array_key_last($delay)] ?? 0;

            return $this->limitRetryDelay((int) ($delay[$attempt] ?? $lastDelay), $retry);
        }

        return $this->limitRetryDelay((int) $delay, $retry);
    }

    /**
     * Caps the retry delay when configured.
     *
     * @param array<string, bool|int|list<int>> $retry
     */
    protected function limitRetryDelay(int $delay, array $retry): int
    {
        $maxDelay = (int) $retry['max_delay'];

        if ($maxDelay === 0) {
            return $delay;
        }

        return min($delay, $maxDelay);
    }

    /**
     * Returns the delay from a Retry-After header in seconds.
     */
    protected function getRetryAfterDelay(ResponseInterface $response): ?int
    {
        $retryAfter = $response->getHeaderLine('Retry-After');

        if ($retryAfter === '') {
            return null;
        }

        if (ctype_digit($retryAfter)) {
            return (int) $retryAfter;
        }

        $timestamp = strtotime($retryAfter);

        if ($timestamp === false) {
            return null;
        }

        return max(0, $timestamp - time());
    }

    /**
     * Sleeps for the configured number of seconds.
     */
    protected function sleep(float $seconds): void
    {
        usleep((int) ($seconds * 1_000_000));
    }

    /**
     * Adds $this->headers to the cURL request.
     *
     * @param array<int, mixed> $curlOptions
     *
     * @return array<int, mixed>
     */
    protected function applyRequestHeaders(array $curlOptions = []): array
    {
        if ($this->headers === []) {
            return $curlOptions;
        }

        $set = [];

        foreach (array_keys($this->headers) as $name) {
            $set[] = $name . ': ' . $this->getHeaderLine($name);
        }

        $curlOptions[CURLOPT_HTTPHEADER] = $set;

        return $curlOptions;
    }

    /**
     * Apply method
     *
     * @param array<int, mixed> $curlOptions
     *
     * @return array<int, mixed>
     */
    protected function applyMethod(string $method, array $curlOptions): array
    {
        $this->method                       = $method;
        $curlOptions[CURLOPT_CUSTOMREQUEST] = $method;

        $size = strlen($this->body ?? '');

        // Have content?
        if ($size > 0) {
            return $this->applyBody($curlOptions);
        }

        if ($method === Method::PUT || $method === Method::POST) {
            // See http://tools.ietf.org/html/rfc7230#section-3.3.2
            if ($this->header('content-length') === null && ! isset($this->config['multipart'])) {
                $this->setHeader('Content-Length', '0');
            }
        } elseif ($method === 'HEAD') {
            $curlOptions[CURLOPT_NOBODY] = 1;
        }

        return $curlOptions;
    }

    /**
     * Apply body
     *
     * @param array<int, mixed> $curlOptions
     *
     * @return array<int, mixed>
     */
    protected function applyBody(array $curlOptions = []): array
    {
        if (! in_array($this->body, [null, '', '0'], true)) {
            $curlOptions[CURLOPT_POSTFIELDS] = (string) $this->getBody();
        }

        return $curlOptions;
    }

    /**
     * Parses the header retrieved from the cURL response into
     * our Response object.
     *
     * @param list<string> $headers
     *
     * @return void
     */
    protected function setResponseHeaders(array $headers = [])
    {
        foreach ($headers as $header) {
            if (($pos = strpos($header, ':')) !== false) {
                $title = trim(substr($header, 0, $pos));
                $value = trim(substr($header, $pos + 1));

                if ($this->response instanceof Response) {
                    $this->response->addHeader($title, $value);
                } else {
                    $this->response->setHeader($title, $value);
                }
            } elseif (str_starts_with($header, 'HTTP')) {
                preg_match('#^HTTP\/([12](?:\.[01])?) (\d+)(?: (.+))?#', $header, $matches);

                if (isset($matches[1])) {
                    $this->response->setProtocolVersion($matches[1]);
                }

                if (isset($matches[2])) {
                    $this->response->setStatusCode((int) $matches[2], $matches[3] ?? '');
                }
            }
        }
    }

    /**
     * Set CURL options
     *
     * @param array<int, mixed>    $curlOptions
     * @param array<string, mixed> $config
     *
     * @return array<int, mixed>
     *
     * @throws InvalidArgumentException
     */
    protected function setCURLOptions(array $curlOptions = [], array $config = [])
    {
        $curlOptions = $this->applyAuthOptions($curlOptions, $config);
        $curlOptions = $this->applySslOptions($curlOptions, $config);
        $curlOptions = $this->applyProxyOptions($curlOptions, $config);
        $curlOptions = $this->applyDebugOptions($curlOptions, $config);
        $curlOptions = $this->applyRedirectOptions($curlOptions, $config);
        $curlOptions = $this->applyConnectionOptions($curlOptions, $config);
        $curlOptions = $this->applyBodyOptions($curlOptions, $config);
        $curlOptions = $this->applyResponseOptions($curlOptions, $config);
        $curlOptions = $this->applyProtocolOptions($curlOptions, $config);

        return $this->applyClientOptions($curlOptions, $config);
    }

    /**
     * @param array<int, mixed>    $curlOptions
     * @param array<string, mixed> $config
     *
     * @return array<int, mixed>
     */
    private function applyAuthOptions(array $curlOptions, array $config): array
    {
        // Auth Headers
        if (isset($config['auth']) && is_array($config['auth']) && count($config['auth']) >= 2) {
            $curlOptions[CURLOPT_USERPWD]  = $config['auth'][0] . ':' . $config['auth'][1];
            $curlOptions[CURLOPT_HTTPAUTH] = (isset($config['auth'][2]) && $config['auth'][2] !== '' && strtolower($config['auth'][2]) === 'digest')
                ? CURLAUTH_DIGEST
                : CURLAUTH_BASIC;
        }

        return $curlOptions;
    }

    /**
     * @param array<int, mixed>    $curlOptions
     * @param array<string, mixed> $config
     *
     * @return array<int, mixed>
     */
    private function applySslOptions(array $curlOptions, array $config): array
    {
        // Certificate
        $cert = $config['cert'] ?? null;

        if ((bool) $cert) {
            if (is_array($cert)) {
                $curlOptions[CURLOPT_SSLCERTPASSWD] = $cert[1];
                $cert                               = $cert[0];
            }

            if (! is_file($cert)) {
                throw HTTPException::forSSLCertNotFound($cert);
            }

            $curlOptions[CURLOPT_SSLCERT] = $cert;
        }

        // SSL Verification
        if (isset($config['verify'])) {
            if (is_string($config['verify'])) {
                $realPath = realpath($config['verify']);
                $file     = $realPath === false ? $config['verify'] : $realPath;

                if (! is_file($file)) {
                    throw HTTPException::forInvalidSSLKey($config['verify']);
                }

                $curlOptions[CURLOPT_CAINFO]         = $file;
                $curlOptions[CURLOPT_SSL_VERIFYPEER] = true;
                $curlOptions[CURLOPT_SSL_VERIFYHOST] = 2;
            } elseif (is_bool($config['verify'])) {
                $curlOptions[CURLOPT_SSL_VERIFYPEER] = $config['verify'];
                $curlOptions[CURLOPT_SSL_VERIFYHOST] = $config['verify'] ? 2 : 0;
            }
        }

        return $curlOptions;
    }

    /**
     * @param array<int, mixed>    $curlOptions
     * @param array<string, mixed> $config
     *
     * @return array<int, mixed>
     */
    private function applyProxyOptions(array $curlOptions, array $config): array
    {
        // Proxy
        if (isset($config['proxy'])) {
            $curlOptions[CURLOPT_HTTPPROXYTUNNEL] = true;
            $curlOptions[CURLOPT_PROXY]           = $config['proxy'];
        }

        return $curlOptions;
    }

    /**
     * @param array<int, mixed>    $curlOptions
     * @param array<string, mixed> $config
     *
     * @return array<int, mixed>
     */
    private function applyDebugOptions(array $curlOptions, array $config): array
    {
        // Debug
        if ((bool) ($config['debug'] ?? false)) {
            $curlOptions[CURLOPT_VERBOSE] = 1;
            $curlOptions[CURLOPT_STDERR]  = is_string($config['debug']) ? fopen($config['debug'], 'a+b') : fopen('php://stderr', 'wb');
        }

        return $curlOptions;
    }

    /**
     * @param array<int, mixed>    $curlOptions
     * @param array<string, mixed> $config
     *
     * @return array<int, mixed>
     */
    private function applyRedirectOptions(array $curlOptions, array $config): array
    {
        // Allow Redirects
        if (array_key_exists('allow_redirects', $config)) {
            $settings = $this->redirectDefaults;

            if (is_array($config['allow_redirects'])) {
                $settings = array_merge($settings, $config['allow_redirects']);
            }

            if ($config['allow_redirects'] === false) {
                $curlOptions[CURLOPT_FOLLOWLOCATION] = 0;
            } else {
                $curlOptions[CURLOPT_FOLLOWLOCATION] = 1;
                $curlOptions[CURLOPT_MAXREDIRS]      = $settings['max'];

                if ($settings['strict'] === true) {
                    $curlOptions[CURLOPT_POSTREDIR] = 1 | 2 | 4;
                }

                $protocols = 0;

                foreach ($settings['protocols'] as $proto) {
                    $protocols += constant('CURLPROTO_' . strtoupper($proto));
                }

                $curlOptions[CURLOPT_REDIR_PROTOCOLS] = $protocols;
            }
        }

        return $curlOptions;
    }

    /**
     * @param array<int, mixed>    $curlOptions
     * @param array<string, mixed> $config
     *
     * @return array<int, mixed>
     */
    private function applyConnectionOptions(array $curlOptions, array $config): array
    {
        // DNS Cache Timeout
        if (isset($config['dns_cache_timeout']) && is_numeric($config['dns_cache_timeout']) && $config['dns_cache_timeout'] >= -1) {
            $curlOptions[CURLOPT_DNS_CACHE_TIMEOUT] = (int) $config['dns_cache_timeout'];
        }

        // Fresh Connect (default true)
        $curlOptions[CURLOPT_FRESH_CONNECT] = isset($config['fresh_connect']) && is_bool($config['fresh_connect'])
            ? $config['fresh_connect']
            : true;

        // Timeout
        $curlOptions[CURLOPT_TIMEOUT_MS] = (float) ($config['timeout'] ?? 0) * 1000;

        // Connection Timeout
        $curlOptions[CURLOPT_CONNECTTIMEOUT_MS] = (float) ($config['connect_timeout'] ?? 150) * 1000;

        // Resolve IP
        if (array_key_exists('force_ip_resolve', $config)) {
            $curlOptions[CURLOPT_IPRESOLVE] = match ($config['force_ip_resolve']) {
                'v4'    => CURL_IPRESOLVE_V4,
                'v6'    => CURL_IPRESOLVE_V6,
                default => CURL_IPRESOLVE_WHATEVER,
            };
        }

        return $curlOptions;
    }

    /**
     * @param array<int, mixed>    $curlOptions
     * @param array<string, mixed> $config
     *
     * @return array<int, mixed>
     */
    private function applyBodyOptions(array $curlOptions, array $config): array
    {
        // Post Data - application/x-www-form-urlencoded
        if (isset($config['form_params']) && is_array($config['form_params']) && $config['form_params'] !== []) {
            $postFields                      = http_build_query($config['form_params']);
            $curlOptions[CURLOPT_POSTFIELDS] = $postFields;

            // Ensure content-length is set, since CURL doesn't seem to
            // calculate it when HTTPHEADER is set.
            $this->setHeader('Content-Length', (string) strlen($postFields));
            $this->setHeader('Content-Type', 'application/x-www-form-urlencoded');
        }

        // Post Data - multipart/form-data
        if (isset($config['multipart']) && is_array($config['multipart']) && $config['multipart'] !== []) {
            // setting the POSTFIELDS option automatically sets multipart
            $curlOptions[CURLOPT_POSTFIELDS] = $config['multipart'];
        }

        // JSON
        if (isset($config['json'])) {
            // Will be set as the body in `applyBody()`
            $json = json_encode($config['json']);
            $this->setBody($json);
            $this->setHeader('Content-Type', 'application/json');
            $this->setHeader('Content-Length', (string) strlen($json));
        }

        return $curlOptions;
    }

    /**
     * @param array<int, mixed>    $curlOptions
     * @param array<string, mixed> $config
     *
     * @return array<int, mixed>
     */
    private function applyResponseOptions(array $curlOptions, array $config): array
    {
        // Decode Content
        if ((bool) ($config['decode_content'] ?? false)) {
            $accept = $this->getHeaderLine('Accept-Encoding');

            if ($accept !== '') {
                $curlOptions[CURLOPT_ENCODING] = $accept;
            } else {
                $curlOptions[CURLOPT_ENCODING]   = '';
                $curlOptions[CURLOPT_HTTPHEADER] = 'Accept-Encoding';
            }
        }

        // HTTP Errors
        $curlOptions[CURLOPT_FAILONERROR] = array_key_exists('http_errors', $config) ? (bool) $config['http_errors'] : true;

        return $curlOptions;
    }

    /**
     * @param array<int, mixed>    $curlOptions
     * @param array<string, mixed> $config
     *
     * @return array<int, mixed>
     */
    private function applyProtocolOptions(array $curlOptions, array $config): array
    {
        if (! isset($config['version']) || (bool) $config['version'] === false) {
            return $curlOptions;
        }

        $version = sprintf('%.1F', (float) $config['version']);

        if ($version === '3.0' && ! defined('CURL_HTTP_VERSION_3')) {
            define('CURL_HTTP_VERSION_3', 30);
        }

        $curlVersion = match ($version) {
            '1.0'   => CURL_HTTP_VERSION_1_0,
            '1.1'   => CURL_HTTP_VERSION_1_1,
            '2.0'   => CURL_HTTP_VERSION_2_0,
            '3.0'   => CURL_HTTP_VERSION_3,
            default => null,
        };

        if ($curlVersion !== null) {
            $curlOptions[CURLOPT_HTTP_VERSION] = $curlVersion;
        }

        return $curlOptions;
    }

    /**
     * @param array<int, mixed>    $curlOptions
     * @param array<string, mixed> $config
     *
     * @return array<int, mixed>
     */
    private function applyClientOptions(array $curlOptions, array $config): array
    {
        // Cookie
        if (isset($config['cookie'])) {
            $curlOptions[CURLOPT_COOKIEJAR]  = $config['cookie'];
            $curlOptions[CURLOPT_COOKIEFILE] = $config['cookie'];
        }

        // User Agent
        if (isset($config['user_agent'])) {
            $curlOptions[CURLOPT_USERAGENT] = $config['user_agent'];
        }

        return $curlOptions;
    }

    /**
     * Does the actual work of initializing cURL, setting the options,
     * and grabbing the output.
     *
     * @param array<int, mixed> $curlOptions
     *
     * @codeCoverageIgnore
     */
    protected function sendRequest(array $curlOptions = []): string
    {
        $ch = curl_init();

        curl_setopt_array($ch, $curlOptions);

        // Send the request and wait for a response.
        $output = curl_exec($ch);

        if ($output === false) {
            $this->lastCurlError = curl_errno($ch);

            throw HTTPException::forCurlError((string) $this->lastCurlError, curl_error($ch));
        }

        return $output;
    }

    private function removeIntermediateResponses(string $output, string $breakString): string
    {
        while (true) {
            // Check if we should remove the current response
            if ($this->shouldRemoveCurrentResponse($output, $breakString)) {
                $breakStringPos = strpos($output, $breakString);
                if ($breakStringPos !== false) {
                    $output = substr($output, $breakStringPos + 4);

                    continue;
                }
            }

            // No more intermediate responses to remove
            break;
        }

        return $output;
    }

    /**
     * Check if the current response (at the beginning of output) should be removed.
     */
    private function shouldRemoveCurrentResponse(string $output, string $breakString): bool
    {
        // HTTP/x.x 1xx responses (Continue, Processing, etc.)
        if (preg_match('/^HTTP\/\d+(?:\.\d+)?\s+1\d\d\s/', $output)) {
            return true;
        }

        // HTTP/x.x 200 Connection established (proxy responses)
        if (preg_match('/^HTTP\/\d+(?:\.\d+)?\s+200\s+Connection\s+established/i', $output)) {
            return true;
        }

        // HTTP/x.x 3xx responses (redirects) - only if redirects are allowed
        $allowRedirects = isset($this->config['allow_redirects']) && $this->config['allow_redirects'] !== false;
        if ($allowRedirects && preg_match('/^HTTP\/\d+(?:\.\d+)?\s+3\d\d\s/', $output)) {
            // Check if there's a Location header
            $breakStringPos = strpos($output, $breakString);
            if ($breakStringPos !== false) {
                $headerSection = substr($output, 0, $breakStringPos);
                $headers       = explode("\n", $headerSection);

                foreach ($headers as $header) {
                    if (str_starts_with(strtolower($header), 'location:')) {
                        return true; // Found location header, this is a redirect to remove
                    }
                }
            }
        }

        // Digest auth challenges - only remove if there's another response after
        if (isset($this->config['auth'][2]) && $this->config['auth'][2] === 'digest') {
            $breakStringPos = strpos($output, $breakString);
            if ($breakStringPos !== false) {
                $headerSection = substr($output, 0, $breakStringPos);
                if (str_contains($headerSection, 'WWW-Authenticate: Digest')) {
                    $nextBreakPos = strpos($output, $breakString, $breakStringPos + 4);

                    return $nextBreakPos !== false; // Only remove if there's another response
                }
            }
        }

        return false;
    }
}

codeigniter4 / CodeIgniter4 / 37962869632

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous