path: root/apps/files_external/3rdparty/php-opencloud/lib/OpenCloud/Common/Request/Curl.php

<?php

namespace OpenCloud\Common\Request;

use OpenCloud\Common\Base;
use OpenCloud\Common\Lang;
use OpenCloud\Common\Exceptions\HttpRetryError;
use OpenCloud\Common\Exceptions\HttpUrlError;
use OpenCloud\Common\Exceptions\HttpTimeoutError;
use OpenCloud\Common\Exceptions\HttpError;

/**
 * The CurlRequest class is a simple wrapper to CURL functions. Not only does
 * this permit stubbing of the interface as described under the HttpRequest
 * interface, it could potentially allow us to replace the interface methods
 * with other function calls in the future.
 *
 * @api
 * @author Glen Campbell <glen.campbell@rackspace.com>
 */
class Curl extends Base implements HttpRequestInterface
{

    private $url;
    private $method;
    private $handle;
    private $retries = 0;
    private $headers = array();
    private $returnheaders = array();

    /**
     * Initializes the CURL handle and HTTP method
     *
     * The constructor also sets a number of default values for options.
     *
     * @param string $url the URL to connect to
     * @param string $method the HTTP method (default "GET")
     * @param array $options optional hashed array of options => value pairs
     */
    public function __construct($url, $method = 'GET', array $options = array())
    {
        $this->url = $url;
        $this->method = $method;
        $this->handle = curl_init($url);

        // set our options
        $this->setOption(CURLOPT_CUSTOMREQUEST, $method);

        foreach($options as $opt => $value) {
            $this->getLogger()->info(Lang::translate('Setting option {key}={val}'), array(
                'key' => $opt, 
                'val' => $value
            ));
            $this->setOption($opt, $value);
        }

        // @codeCoverageIgnoreStart
        if (RAXSDK_SSL_VERIFYHOST != 2) {
            $this->getLogger()->warning("WARNING: RAXSDK_SSL_VERIFYHOST has reduced security, value [{value}]", array(
                'value' => RAXSDK_SSL_VERIFYHOST
            ));
        }

        if (RAXSDK_SSL_VERIFYPEER !== true) {
            $this->getLogger()->warning("WARNING: RAXSDK_SSL_VERIFYPEER has reduced security");
        }
        // @codeCoverageIgnoreEnd

        $this->setOption(CURLOPT_SSL_VERIFYHOST, RAXSDK_SSL_VERIFYHOST);
        $this->setOption(CURLOPT_SSL_VERIFYPEER, RAXSDK_SSL_VERIFYPEER);

        if (defined('RAXSDK_CACERTPEM') && file_exists(RAXSDK_CACERTPEM)) {
            $this->setOption(CURLOPT_CAINFO, RAXSDK_CACERTPEM);
        }

        //  curl code [18]
        //  message [transfer closed with x bytes remaining to read]
        if ($method === 'HEAD') {
            $this->setOption(CURLOPT_NOBODY, true);
        }

        // follow redirects
        $this->setOption(CURLOPT_FOLLOWLOCATION, true);

        // don't return the headers in the request
        $this->setOption(CURLOPT_HEADER, false);

        // retrieve headers via callback
        $this->setOption(CURLOPT_HEADERFUNCTION, array($this, '_get_header_cb'));

        // return the entire request on curl_exec()
        $this->setOption(CURLOPT_RETURNTRANSFER, true);

        // set default timeouts
        $this->setConnectTimeout(RAXSDK_CONNECTTIMEOUT);
        $this->setHttpTimeout(RAXSDK_TIMEOUT);
    }

    /**
     * Sets a CURL option
     *
     * @param const $name - a CURL named constant; e.g. CURLOPT_TIMEOUT
     * @param mixed $value - the value for the option
     */
    public function setOption($name, $value)
    {
        return curl_setopt($this->handle, $name, $value);
    }

    /**
     * Explicit method for setting the connect timeout
     *
     * The connect timeout is the time it takes for the initial connection
     * request to be established. It is different than the HTTP timeout, which
     * is the time for the entire request to be serviced.
     *
     * @param integer $value The connection timeout in seconds.
     *      Use 0 to wait indefinitely (NOT recommended)
     */
    public function setConnectTimeout($value)
    {
        $this->setOption(CURLOPT_CONNECTTIMEOUT, $value);
    }

    /**
     * Explicit method for setting the HTTP timeout
     *
     * The HTTP timeout is the time it takes for the HTTP request to be
     * serviced. This value is usually larger than the connect timeout
     * value.
     *
     * @param integer $value - the number of seconds to wait before timing out
     *      the HTTP request.
     */
    public function setHttpTimeout($value)
    {
        $this->setOption(CURLOPT_TIMEOUT, $value);
    }

    /**
     * Sets the number of retries
     *
     * If you set this to a non-zero value, then it will repeat the request
     * up to that number.
     */
    public function setRetries($value)
    {
        $this->retries = $value;
    }

    /**
     * Simplified method for setting lots of headers at once
     *
     * This method takes an associative array of header/value pairs and calls
     * the setheader() method on each of them.
     *
     * @param array $arr an associative array of headers
     */
    public function setheaders($array)
    {
        if (!is_array($array)) {
            throw new HttpError(Lang::translate(
                'Value passed to CurlRequest::setheaders() must be array'
            ));
        }

        foreach ($array as $name => $value) {
            $this->setHeader($name, $value);
        }
    }

    /**
     * Sets a single header
     *
     * For example, to set the content type to JSON:
     * `$request->SetHeader('Content-Type','application/json');`
     *
     * @param string $name The name of the header
     * @param mixed $value The value of the header
     */
    public function setHeader($name, $value)
    {
        $this->headers[$name] = $value;
    }

    /**
     * Executes the current request
     *
     * This method actually performs the request using the values set
     * previously. It throws a OpenCloud\HttpError exception on
     * any CURL error.
     *
     * @return OpenCloud\HttpResponse
     * @throws OpenCloud\HttpError
     * 
     * @codeCoverageIgnore
     */
    public function execute()
    {
        // set all the headers
        $headarr = array();

        foreach ($this->headers as $name => $value) {
            $headarr[] = $name.': '.$value;
        }

        $this->setOption(CURLOPT_HTTPHEADER, $headarr);

        // set up to retry if necessary
        $try_counter = 0;

        do {
            $data = curl_exec($this->handle);
            if (curl_errno($this->handle) && ($try_counter<$this->retries)) {
                $this->getLogger()->info(Lang::translate('Curl error [%d]; retrying [%s]'), array(
                    'error' => curl_errno($this->handle), 
                    'url'   => $this->url
                ));
            }

        } while((++$try_counter <= $this->retries) && (curl_errno($this->handle) != 0));

        // log retries error
        if ($this->retries && curl_errno($this->handle)) {
            throw new HttpRetryError(sprintf(
                Lang::translate('No more retries available, last error [%d]'), 
                curl_errno($this->handle)
            ));
        }

        // check for CURL errors
        switch(curl_errno($this->handle)) {
            case 0:
                // everything's ok
                break;
            case 3:
                throw new HttpUrlError(sprintf(Lang::translate('Malformed URL [%s]'), $this->url));
                break;
            case 28:
                // timeout
                throw new HttpTimeoutError(Lang::translate('Operation timed out; check RAXSDK_TIMEOUT value'));
                break;
            default:
                throw new HttpError(sprintf(
                    Lang::translate('HTTP error on [%s], curl code [%d] message [%s]'),
                    $this->url,
                    curl_errno($this->handle),
                    curl_error($this->handle)
                ));
        }

        // otherwise, return the HttpResponse
        return new Response\Http($this, $data);
    }

    /**
     * returns an array of information about the request
     */
    public function info()
    {
        return curl_getinfo($this->handle);
    }

    /**
     * returns the most recent CURL error number
     */
    public function errno()
    {
        return curl_errno($this->handle);
    }

    /**
     * returns the most recent CURL error string
     */
    public function error()
    {
        return curl_error($this->handle);
    }

    /**
     * Closes the HTTP request
     */
    public function close()
    {
        return curl_close($this->handle);
    }

    /**
     * Returns the headers as an array
     */
    public function returnHeaders()
    {
        return $this->returnheaders;
    }

    /**
     * This is a callback method used to handle the returned HTTP headers
     *
     * @param mixed $ch a CURL handle
     * @param string $header the header string in its entirety
     */
    public function _get_header_cb($ch, $header)
    {
        $this->returnheaders[] = $header;
        return strlen($header);
    }

}