enwikipedia-acc / waca

includes/Helpers/HttpHelper.php

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 * ACC Development Team. Please see team.json for a list of contributors.     *
 *                                                                            *
 * This is free and unencumbered software released into the public domain.    *
 * Please see LICENSE.md for the full licencing statement.                    *
 ******************************************************************************/

namespace Waca\Helpers;

use Waca\Exceptions\CurlException;
use Waca\SiteConfiguration;

class HttpHelper
{
    private $curlHandle;

    /**
     * HttpHelper constructor.
     *
     * @param SiteConfiguration $siteConfiguration
     * @param string            $cookieJar
     */
    public function __construct($siteConfiguration, $cookieJar = null)
    {
        $this->curlHandle = curl_init();

        curl_setopt($this->curlHandle, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($this->curlHandle, CURLOPT_USERAGENT, $siteConfiguration->getUserAgent());
        curl_setopt($this->curlHandle, CURLOPT_FAILONERROR, true);

        if ($siteConfiguration->getCurlDisableVerifyPeer()) {
            curl_setopt($this->curlHandle, CURLOPT_SSL_VERIFYPEER, false);
        }

        if ($cookieJar !== null) {
            curl_setopt($this->curlHandle, CURLOPT_COOKIEFILE, $cookieJar);
            curl_setopt($this->curlHandle, CURLOPT_COOKIEJAR, $cookieJar);
        }
    }

    public function __destruct()
    {
        curl_close($this->curlHandle);
    }

    /**
     * Fetches the content of a URL, with an optional parameter set.
     *
     * @param string     $url        The URL to fetch.
     * @param null|array $parameters Key/value pair of GET parameters to add to the request.
     *                               Null lets you handle it yourself.
     *
     * @param array      $headers
     * @param int        $timeout Timeout in ms
     *
     * @return string
     * @throws CurlException
     */
    public function get($url, $parameters = null, $headers = array(), $timeout = 300000)
    {
        if ($parameters !== null && is_array($parameters)) {
            $getString = '?' . http_build_query($parameters);
            $url .= $getString;
        }

        curl_setopt($this->curlHandle, CURLOPT_URL, $url);

        // Make sure we're doing a GET
        curl_setopt($this->curlHandle, CURLOPT_POST, false);

        curl_setopt($this->curlHandle, CURLOPT_HTTPHEADER, $headers);

        curl_setopt($this->curlHandle, CURLOPT_CONNECTTIMEOUT_MS, $timeout);
        curl_setopt($this->curlHandle, CURLOPT_TIMEOUT_MS, $timeout);

        $result = curl_exec($this->curlHandle);

        if ($result === false) {
            $error = curl_error($this->curlHandle);
            throw new CurlException('Remote request failed with error ' . $error);
        }

        return $result;

The expression return $result also could return the type true which is incompatible with the documented return type string.

    }

    /**
     * Posts data to a URL
     *
     * @param string $url        The URL to fetch.
     * @param array  $parameters Key/value pair of POST parameters to add to the request.
     * @param array  $headers
     *
     * @return string
     * @throws CurlException
     */
    public function post($url, $parameters, $headers = array())
    {
        curl_setopt($this->curlHandle, CURLOPT_URL, $url);

        // Make sure we're doing a POST
        curl_setopt($this->curlHandle, CURLOPT_POST, true);
        curl_setopt($this->curlHandle, CURLOPT_POSTFIELDS, http_build_query($parameters));

        curl_setopt($this->curlHandle, CURLOPT_HTTPHEADER, $headers);

        $result = curl_exec($this->curlHandle);

        if ($result === false) {
            $error = curl_error($this->curlHandle);
            throw new CurlException('Remote request failed with error ' . $error);
        }

        return $result;

The expression return $result also could return the type true which is incompatible with the documented return type string.

    }

    /**
     * @return string
     */
    public function getError()
    {
        return curl_error($this->curlHandle);
    }
}