danielgp\io_operations\InputOutputCurl

Complexity

Total Complexity

21

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Importance

Changes	7
Bugs	0	Features	3

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setUserAgent()	0	4	2
A	handleSecureConnection()	0	9	3
A	setPostingDetails()	0	6	2
A	getContentFromUrlThroughCurl()	0	18	3
A	setForceIpv4()	0	5	4
A	handleCurlOptions()	0	17	3
A	validateUrl()	0	7	2
A	setNoBody()	0	4	2

<?php

/*
 * The MIT License
 *
 * Copyright 2019 - 2024 Daniel Popiniuc
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace danielgp\io_operations;

trait InputOutputCurl
{

    public function getContentFromUrlThroughCurl(string $fullURL, array $features = [])
    {
        $chanel     = curl_init();
        $inScopeUrl = $this->validateUrl($fullURL);
        $this->handleCurlOptions($chanel, $inScopeUrl, $features);

It seems like $chanel can also be of type resource; however, parameter $chanel of danielgp\io_operations\InputOutputCurl::handleCurlOptions() does only seem to accept CurlHandle|false, maybe add an additional type check?

        $aReturn    = [
            'response' => curl_exec($chanel),
            'errNo'    => curl_errno($chanel),
            'errMsg'   => curl_error($chanel),
        ];
        if (array_key_exists('includeStatistics', $features)) {
            $aReturn['info'] = curl_getinfo($chanel);
        }
        if (array_key_exists('NoBody', $features)) {
            unset($aReturn['response']);
        }
        curl_close($chanel);
        return $aReturn;
    }

    private function handleCurlOptions(\CurlHandle|false $chanel, string $inScopeUrl, array $features): void
    {
        $this->setUserAgent($chanel, $features);
        $this->handleSecureConnection($chanel, $inScopeUrl, $features);
        $this->setForceIpv4($chanel, $features);
        $this->setNoBody($chanel, $features);
        curl_setopt($chanel, CURLOPT_FAILONERROR, true);

It seems like $chanel can also be of type false; however, parameter $handle of curl_setopt() does only seem to accept CurlHandle|resource, maybe add an additional type check?

        curl_setopt($chanel, CURLOPT_FOLLOWLOCATION, true);
        curl_setopt($chanel, CURLOPT_FRESH_CONNECT, true); //avoid a cached response
        curl_setopt($chanel, CURLOPT_HEADER, false);
        curl_setopt($chanel, CURLOPT_MAXREDIRS, 10);
        curl_setopt($chanel, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($chanel, CURLOPT_TCP_FASTOPEN, true);
        curl_setopt($chanel, CURLOPT_URL, $inScopeUrl);
        $this->setPostingDetails($chanel, $features);
        if (array_key_exists('HttpHeader', $features) && !array_key_exists('PostFields', $features)) {
            curl_setopt($chanel, CURLOPT_HTTPHEADER, $features['HttpHeader']);
        }
    }

    private function handleSecureConnection(\CurlHandle|false $chanel, string $fullURL, array $features): void
    {
        if ((substr(strtolower($fullURL), 0, 5) === 'https')) {
            $chk = false;
            if (array_key_exists('forceSSLverification', $features)) {
                $chk = true;
            }
            curl_setopt($chanel, CURLOPT_SSL_VERIFYHOST, $chk);

It seems like $chanel can also be of type false; however, parameter $handle of curl_setopt() does only seem to accept CurlHandle|resource, maybe add an additional type check?

            curl_setopt($chanel, CURLOPT_SSL_VERIFYPEER, $chk);
        }
    }

    private function setForceIpv4(\CurlHandle|false $chanel, array $features): void
    {
        if (array_key_exists('forceIpV4', $features)) {
            if (defined('CURLOPT_IPRESOLVE') && defined('CURL_IPRESOLVE_V4')) {
                curl_setopt($chanel, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);

It seems like $chanel can also be of type false; however, parameter $handle of curl_setopt() does only seem to accept CurlHandle|resource, maybe add an additional type check?

            }
        }
    }

    private function setNoBody(\CurlHandle|false $chanel, array $features): void
    {
        if (array_key_exists('NoBody', $features)) {
            curl_setopt($chanel, CURLOPT_NOBODY, true);

It seems like $chanel can also be of type false; however, parameter $handle of curl_setopt() does only seem to accept CurlHandle|resource, maybe add an additional type check?

        }
    }

    private function setPostingDetails(\CurlHandle|false $chanel, array $features): void
    {
        if (array_key_exists('PostFields', $features)) {
            curl_setopt($chanel, CURLOPT_POST, true);

It seems like $chanel can also be of type false; however, parameter $handle of curl_setopt() does only seem to accept CurlHandle|resource, maybe add an additional type check?

            curl_setopt($chanel, CURLOPT_POSTFIELDS, $features['PostFields']);
            curl_setopt($chanel, CURLOPT_HTTPHEADER, $features['HttpHeader']);
        }
    }

    private function setUserAgent(\CurlHandle|false $chanel, array $features): void
    {
        if (array_key_exists('setUserAgent', $features)) {
            curl_setopt($chanel, CURLOPT_USERAGENT, $features['setUserAgent']);

It seems like $chanel can also be of type false; however, parameter $handle of curl_setopt() does only seem to accept CurlHandle|resource, maybe add an additional type check?

        }
    }

    private function validateUrl(string $strUrl): string
    {
        $inScopeUrl = filter_var($strUrl, FILTER_VALIDATE_URL);
        if ($inScopeUrl === false) {
            throw new \Exception('Invalid URL provided...');
        }
        return $inScopeUrl;
    }
}