1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 

<?php
/**
 * fsockopen HTTP transport
 *
 * @package Requests
 * @subpackage Transport
 */

/**
 * fsockopen HTTP transport
 *
 * @package Requests
 * @subpackage Transport
 */
class Requests_Transport_fsockopen implements Requests_Transport {
    /**
     * Second to microsecond conversion
     *
     * @var integer
     */
    const SECOND_IN_MICROSECONDS = 1000000;

    /**
     * Raw HTTP data
     *
     * @var string
     */
    public $headers = '';

    /**
     * Stream metadata
     *
     * @var array Associative array of properties, see {@see https://secure.php.net/stream_get_meta_data}
     */
    public $info;

    /**
     * What's the maximum number of bytes we should keep?
     *
     * @var int|bool Byte count, or false if no limit.
     */
    protected $max_bytes = false;

    protected $connect_error = '';

    /**
     * Perform a request
     *
     * @throws Requests_Exception On failure to connect to socket (`fsockopenerror`)
     * @throws Requests_Exception On socket timeout (`timeout`)
     *
     * @param string $url URL to request
     * @param array $headers Associative array of request headers
     * @param string|array $data Data to send either as the POST body, or as parameters in the URL for a GET/HEAD
     * @param array $options Request options, see {@see Requests::response()} for documentation
     * @return string Raw HTTP result
     */
    public function request($url, $headers = array(), $data = array(), $options = array()) {
        $options['hooks']->dispatch('fsockopen.before_request');

        $url_parts = parse_url($url);
        if (empty($url_parts)) {
            throw new Requests_Exception('Invalid URL.', 'invalidurl', $url);
        }
        $host                     = $url_parts['host'];
        $context                  = stream_context_create();
        $verifyname               = false;
        $case_insensitive_headers = new Requests_Utility_CaseInsensitiveDictionary($headers);

        // HTTPS support
        if (isset($url_parts['scheme']) && strtolower($url_parts['scheme']) === 'https') {
            $remote_socket = 'ssl://' . $host;
            if (!isset($url_parts['port'])) {
                $url_parts['port'] = 443;
            }

            $context_options = array(
                'verify_peer'       => true,
                'capture_peer_cert' => true,
            );
            $verifyname      = true;

            // SNI, if enabled (OpenSSL >=0.9.8j)
            // phpcs:ignore PHPCompatibility.Constants.NewConstants.openssl_tlsext_server_nameFound
            if (defined('OPENSSL_TLSEXT_SERVER_NAME') && OPENSSL_TLSEXT_SERVER_NAME) {
                $context_options['SNI_enabled'] = true;
                if (isset($options['verifyname']) && $options['verifyname'] === false) {
                    $context_options['SNI_enabled'] = false;
                }
            }

            if (isset($options['verify'])) {
                if ($options['verify'] === false) {
                    $context_options['verify_peer']      = false;
                    $context_options['verify_peer_name'] = false;
                    $verifyname                          = false;
                }
                elseif (is_string($options['verify'])) {
                    $context_options['cafile'] = $options['verify'];
                }
            }

            if (isset($options['verifyname']) && $options['verifyname'] === false) {
                $context_options['verify_peer_name'] = false;
                $verifyname                          = false;
            }

            stream_context_set_option($context, array('ssl' => $context_options));
        }
        else {
            $remote_socket = 'tcp://' . $host;
        }

        $this->max_bytes = $options['max_bytes'];

        if (!isset($url_parts['port'])) {
            $url_parts['port'] = 80;
        }
        $remote_socket .= ':' . $url_parts['port'];

        // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_set_error_handler
        set_error_handler(array($this, 'connect_error_handler'), E_WARNING | E_NOTICE);

        $options['hooks']->dispatch('fsockopen.remote_socket', array(&$remote_socket));

        $socket = stream_socket_client($remote_socket, $errno, $errstr, ceil($options['connect_timeout']), STREAM_CLIENT_CONNECT, $context);

        restore_error_handler();

        if ($verifyname && !$this->verify_certificate_from_context($host, $context)) {
            throw new Requests_Exception('SSL certificate did not match the requested domain name', 'ssl.no_match');
        }

        if (!$socket) {
            if ($errno === 0) {
                // Connection issue
                throw new Requests_Exception(rtrim($this->connect_error), 'fsockopen.connect_error');
            }

            throw new Requests_Exception($errstr, 'fsockopenerror', null, $errno);
        }

        $data_format = $options['data_format'];

        if ($data_format === 'query') {
            $path = self::format_get($url_parts, $data);
            $data = '';
        }
        else {
            $path = self::format_get($url_parts, array());
        }

        $options['hooks']->dispatch('fsockopen.remote_host_path', array(&$path, $url));

        $request_body = '';
        $out          = sprintf("%s %s HTTP/%.1F\r\n", $options['type'], $path, $options['protocol_version']);

        if ($options['type'] !== Requests::TRACE) {
            if (is_array($data)) {
                $request_body = http_build_query($data, '', '&');
            }
            else {
                $request_body = $data;
            }

            // Always include Content-length on POST requests to prevent
            // 411 errors from some servers when the body is empty.
            if (!empty($data) || $options['type'] === Requests::POST) {
                if (!isset($case_insensitive_headers['Content-Length'])) {
                    $headers['Content-Length'] = strlen($request_body);
                }

                if (!isset($case_insensitive_headers['Content-Type'])) {
                    $headers['Content-Type'] = 'application/x-www-form-urlencoded; charset=UTF-8';
                }
            }
        }

        if (!isset($case_insensitive_headers['Host'])) {
            $out .= sprintf('Host: %s', $url_parts['host']);

            if ((strtolower($url_parts['scheme']) === 'http' && $url_parts['port'] !== 80) || (strtolower($url_parts['scheme']) === 'https' && $url_parts['port'] !== 443)) {
                $out .= ':' . $url_parts['port'];
            }
            $out .= "\r\n";
        }

        if (!isset($case_insensitive_headers['User-Agent'])) {
            $out .= sprintf("User-Agent: %s\r\n", $options['useragent']);
        }

        $accept_encoding = $this->accept_encoding();
        if (!isset($case_insensitive_headers['Accept-Encoding']) && !empty($accept_encoding)) {
            $out .= sprintf("Accept-Encoding: %s\r\n", $accept_encoding);
        }

        $headers = Requests::flatten($headers);

        if (!empty($headers)) {
            $out .= implode("\r\n", $headers) . "\r\n";
        }

        $options['hooks']->dispatch('fsockopen.after_headers', array(&$out));

        if (substr($out, -2) !== "\r\n") {
            $out .= "\r\n";
        }

        if (!isset($case_insensitive_headers['Connection'])) {
            $out .= "Connection: Close\r\n";
        }

        $out .= "\r\n" . $request_body;

        $options['hooks']->dispatch('fsockopen.before_send', array(&$out));

        fwrite($socket, $out);
        $options['hooks']->dispatch('fsockopen.after_send', array($out));

        if (!$options['blocking']) {
            fclose($socket);
            $fake_headers = '';
            $options['hooks']->dispatch('fsockopen.after_request', array(&$fake_headers));
            return '';
        }

        $timeout_sec = (int) floor($options['timeout']);
        if ($timeout_sec === $options['timeout']) {
            $timeout_msec = 0;
        }
        else {
            $timeout_msec = self::SECOND_IN_MICROSECONDS * $options['timeout'] % self::SECOND_IN_MICROSECONDS;
        }
        stream_set_timeout($socket, $timeout_sec, $timeout_msec);

        $response   = '';
        $body       = '';
        $headers    = '';
        $this->info = stream_get_meta_data($socket);
        $size       = 0;
        $doingbody  = false;
        $download   = false;
        if ($options['filename']) {
            $download = fopen($options['filename'], 'wb');
        }

        while (!feof($socket)) {
            $this->info = stream_get_meta_data($socket);
            if ($this->info['timed_out']) {
                throw new Requests_Exception('fsocket timed out', 'timeout');
            }

            $block = fread($socket, Requests::BUFFER_SIZE);
            if (!$doingbody) {
                $response .= $block;
                if (strpos($response, "\r\n\r\n")) {
                    list($headers, $block) = explode("\r\n\r\n", $response, 2);
                    $doingbody             = true;
                }
            }

            // Are we in body mode now?
            if ($doingbody) {
                $options['hooks']->dispatch('request.progress', array($block, $size, $this->max_bytes));
                $data_length = strlen($block);
                if ($this->max_bytes) {
                    // Have we already hit a limit?
                    if ($size === $this->max_bytes) {
                        continue;
                    }
                    if (($size + $data_length) > $this->max_bytes) {
                        // Limit the length
                        $limited_length = ($this->max_bytes - $size);
                        $block          = substr($block, 0, $limited_length);
                    }
                }

                $size += strlen($block);
                if ($download) {
                    fwrite($download, $block);
                }
                else {
                    $body .= $block;
                }
            }
        }
        $this->headers = $headers;

        if ($download) {
            fclose($download);
        }
        else {
            $this->headers .= "\r\n\r\n" . $body;
        }
        fclose($socket);

        $options['hooks']->dispatch('fsockopen.after_request', array(&$this->headers, &$this->info));
        return $this->headers;
    }

    /**
     * Send multiple requests simultaneously
     *
     * @param array $requests Request data (array of 'url', 'headers', 'data', 'options') as per {@see Requests_Transport::request}
     * @param array $options Global options, see {@see Requests::response()} for documentation
     * @return array Array of Requests_Response objects (may contain Requests_Exception or string responses as well)
     */
    public function request_multiple($requests, $options) {
        $responses = array();
        $class     = get_class($this);
        foreach ($requests as $id => $request) {
            try {
                $handler        = new $class();
                $responses[$id] = $handler->request($request['url'], $request['headers'], $request['data'], $request['options']);

                $request['options']['hooks']->dispatch('transport.internal.parse_response', array(&$responses[$id], $request));
            }
            catch (Requests_Exception $e) {
                $responses[$id] = $e;
            }

            if (!is_string($responses[$id])) {
                $request['options']['hooks']->dispatch('multiple.request.complete', array(&$responses[$id], $id));
            }
        }

        return $responses;
    }

    /**
     * Retrieve the encodings we can accept
     *
     * @return string Accept-Encoding header value
     */
    protected static function accept_encoding() {
        $type = array();
        if (function_exists('gzinflate')) {
            $type[] = 'deflate;q=1.0';
        }

        if (function_exists('gzuncompress')) {
            $type[] = 'compress;q=0.5';
        }

        $type[] = 'gzip;q=0.5';

        return implode(', ', $type);
    }

    /**
     * Format a URL given GET data
     *
     * @param array $url_parts
     * @param array|object $data Data to build query using, see {@see https://secure.php.net/http_build_query}
     * @return string URL with data
     */
    protected static function format_get($url_parts, $data) {
        if (!empty($data)) {
            if (empty($url_parts['query'])) {
                $url_parts['query'] = '';
            }

            $url_parts['query'] .= '&' . http_build_query($data, '', '&');
            $url_parts['query']  = trim($url_parts['query'], '&');
        }
        if (isset($url_parts['path'])) {
            if (isset($url_parts['query'])) {
                $get = $url_parts['path'] . '?' . $url_parts['query'];
            }
            else {
                $get = $url_parts['path'];
            }
        }
        else {
            $get = '/';
        }
        return $get;
    }

    /**
     * Error handler for stream_socket_client()
     *
     * @param int $errno Error number (e.g. E_WARNING)
     * @param string $errstr Error message
     */
    public function connect_error_handler($errno, $errstr) {
        // Double-check we can handle it
        if (($errno & E_WARNING) === 0 && ($errno & E_NOTICE) === 0) {
            // Return false to indicate the default error handler should engage
            return false;
        }

        $this->connect_error .= $errstr . "\n";
        return true;
    }

    /**
     * Verify the certificate against common name and subject alternative names
     *
     * Unfortunately, PHP doesn't check the certificate against the alternative
     * names, leading things like 'https://www.github.com/' to be invalid.
     * Instead
     *
     * @see https://tools.ietf.org/html/rfc2818#section-3.1 RFC2818, Section 3.1
     *
     * @throws Requests_Exception On failure to connect via TLS (`fsockopen.ssl.connect_error`)
     * @throws Requests_Exception On not obtaining a match for the host (`fsockopen.ssl.no_match`)
     * @param string $host Host name to verify against
     * @param resource $context Stream context
     * @return bool
     */
    public function verify_certificate_from_context($host, $context) {
        $meta = stream_context_get_options($context);

        // If we don't have SSL options, then we couldn't make the connection at
        // all
        if (empty($meta) || empty($meta['ssl']) || empty($meta['ssl']['peer_certificate'])) {
            throw new Requests_Exception(rtrim($this->connect_error), 'ssl.connect_error');
        }

        $cert = openssl_x509_parse($meta['ssl']['peer_certificate']);

        return Requests_SSL::verify_certificate($host, $cert);
    }

    /**
     * Whether this transport is valid
     *
     * @codeCoverageIgnore
     * @return boolean True if the transport is valid, false otherwise.
     */
    public static function test($capabilities = array()) {
        if (!function_exists('fsockopen')) {
            return false;
        }

        // If needed, check that streams support SSL
        if (isset($capabilities['ssl']) && $capabilities['ssl']) {
            if (!extension_loaded('openssl') || !function_exists('openssl_x509_parse')) {
                return false;
            }

            // Currently broken, thanks to https://github.com/facebook/hhvm/issues/2156
            if (defined('HHVM_VERSION')) {
                return false;
            }
        }

        return true;
    }
}