CurlTransport.php

Go to the documentation of this file.

<?php
namespace Magento\FunctionalTestingFramework\Util\Protocol;

use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;

class CurlTransport implements CurlInterface
{
    protected $config = [];

    protected $resource;

    protected $allowedParams = [
        'timeout' => CURLOPT_TIMEOUT,
        'maxredirects' => CURLOPT_MAXREDIRS,
        'proxy' => CURLOPT_PROXY,
        'ssl_cert' => CURLOPT_SSLCERT,
        'userpwd' => CURLOPT_USERPWD,
    ];

    protected $options = [];

    const SUCCESSFUL_HTTP_CODES = [200, 201, 202, 203, 204, 205];

    protected function applyConfig()
    {
        // apply additional options to cURL
        foreach ($this->options as $option => $value) {
            curl_setopt($this->getResource(), $option, $value);
        }

        if (empty($this->config)) {
            return $this;
        }
        foreach (array_keys($this->config) as $param) {
            if (array_key_exists($param, $this->allowedParams)) {
                curl_setopt($this->getResource(), $this->allowedParams[$param], $this->config[$param]);
            }
        }
        return $this;
    }

    public function setOptions(array $options = [])
    {
        $this->options = $options;
        return $this;
    }

    public function addOption($option, $value)
    {
        $this->options[$option] = $value;
        return $this;
    }

    public function setConfig(array $config = [])
    {
        $this->config = $config;
        return $this;
    }

    public function write($url, $body = [], $method = CurlInterface::POST, $headers = [])
    {
        $this->applyConfig();
        $options = [
            CURLOPT_URL => $url,
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_FOLLOWLOCATION => true,
            CURLOPT_COOKIEFILE => '',
            CURLOPT_HTTPHEADER => $headers,
            CURLOPT_SSL_VERIFYPEER => false,
            CURLOPT_SSL_VERIFYHOST => false,
        ];
        switch ($method) {
            case CurlInterface::POST:
                $options[CURLOPT_POST] = true;
                $options[CURLOPT_POSTFIELDS] = $body;
                break;
            case CurlInterface::PUT:
                $options[CURLOPT_CUSTOMREQUEST] = self::PUT;
                $options[CURLOPT_POSTFIELDS] = $body;
                break;
            case CurlInterface::DELETE:
                $options[CURLOPT_CUSTOMREQUEST] = self::DELETE;
                break;
            case CurlInterface::GET:
                $options[CURLOPT_HTTPGET] = true;
                break;
            default:
                throw new TestFrameworkException("Undefined curl method: $method");
        }

        curl_setopt_array($this->getResource(), $options);
    }

    public function read($successRegex = null, $returnRegex = null)
    {
        $response = curl_exec($this->getResource());

        if ($response === false) {
            throw new TestFrameworkException(curl_error($this->getResource()));
        }
        $http_code = $this->getInfo(CURLINFO_HTTP_CODE);
        if (!in_array($http_code, self::SUCCESSFUL_HTTP_CODES)) {
            throw new TestFrameworkException('Error HTTP response code: ' . $http_code . '    Response:' . $response);
        }

        return $response;
    }

    public function close()
    {
        curl_close($this->getResource());
        $this->resource = null;
    }

    protected function getResource()
    {
        if ($this->resource === null) {
            $this->resource = curl_init();
        }
        return $this->resource;
    }

    public function getErrno()
    {
        return curl_errno($this->getResource());
    }

    public function getError()
    {
        return curl_error($this->getResource());
    }

    public function getInfo($opt = 0)
    {
        return curl_getinfo($this->getResource(), $opt);
    }

    public function multiRequest(array $urls, array $options = [])
    {
        $handles = [];
        $result = [];

        $multiHandle = curl_multi_init();

        foreach ($urls as $key => $url) {
            $handles[$key] = curl_init();
            curl_setopt($handles[$key], CURLOPT_URL, $url);
            curl_setopt($handles[$key], CURLOPT_HEADER, 0);
            curl_setopt($handles[$key], CURLOPT_RETURNTRANSFER, 1);
            if (!empty($options)) {
                curl_setopt_array($handles[$key], $options);
            }
            curl_multi_add_handle($multiHandle, $handles[$key]);
        }
        $process = null;
        do {
            curl_multi_exec($multiHandle, $process);
            usleep(100);
        } while ($process > 0);

        foreach ($handles as $key => $handle) {
            $result[$key] = curl_multi_getcontent($handle);
            curl_multi_remove_handle($multiHandle, $handle);
        }
        curl_multi_close($multiHandle);
        return $result;
    }

    public static function extractCode($responseStr)
    {
        preg_match("|^HTTP/[\d\.x]+ (\d+)|", $responseStr, $m);

        if (isset($m[1])) {
            return (int)$m[1];
        } else {
            return false;
        }
    }
}