Merge pull request #5987 from WoltLab/acp-dahsboard-box-hight

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / system / io / RemoteFile.class.php

<?php

namespace wcf\system\io;

use wcf\system\exception\SystemException;

/**
 * The RemoteFile class opens a connection to a remote host as a file.
 *
 * @author  Marcel Werk
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 */
class RemoteFile extends File
{
    /**
     * host address
     * @var string
     */
    protected $host = '';

    /**
     * port
     * @var int
     */
    protected $port = 0;

    /**
     * error number
     * @var int
     */
    protected $errorNumber = 0;

    /**
     * error description
     * @var string
     */
    protected $errorDesc = '';

    /**
     * true if PHP supports SSL/TLS
     * @var bool
     */
    private static $hasSSLSupport;

    /** @noinspection PhpMissingParentConstructorInspection */

    /**
     * Opens a new connection to a remote host.
     *
     * @param string $host
     * @param int $port
     * @param int $timeout
     * @param array $options
     * @throws  SystemException
     */
    public function __construct($host, $port, $timeout = 30, $options = [])
    {
        $this->host = $host;
        $this->port = $port;

        if (!\preg_match('/^[a-z0-9]+:/', $this->host)) {
            $this->host = 'tcp://' . $this->host;
        }

        $context = \stream_context_create($options);
        try {
            $this->resource = \stream_socket_client(
                $this->host . ':' . $this->port,
                $this->errorNumber,
                $this->errorDesc,
                $timeout,
                \STREAM_CLIENT_CONNECT,
                $context
            );
            if ($this->resource === false) {
                throw new \Exception('stream_socket_client returned false: ' . $this->errorDesc, $this->errorNumber);
            }
        } catch (\Exception $e) {
            throw new SystemException('Can not connect to ' . $host, 0, $this->errorDesc, $e);
        }

        \stream_set_timeout($this->resource, $timeout);
    }

    /**
     * Returns the error number of the last error.
     *
     * @return  int
     */
    public function getErrorNumber()
    {
        return $this->errorNumber;
    }

    /**
     * Returns the error description of the last error.
     *
     * @return  string
     */
    public function getErrorDesc()
    {
        return $this->errorDesc;
    }

    /**
     * Switches TLS support for this connection.
     * Usually used in combination with 'STARTTLS'
     *
     * @param bool $enable Whether TLS support should be enabled
     * @return  bool            True on success, false otherwise
     */
    public function setTLS($enable)
    {
        if (!$this->hasTLSSupport()) {
            return false;
        }

        $cryptoType = \STREAM_CRYPTO_METHOD_TLS_CLIENT;

        // PHP 5.6.8+ defines STREAM_CRYPTO_METHOD_TLS_CLIENT as STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT for BC reasons.
        // STREAM_CRYPTO_METHOD_TLS_ANY_CLIENT was introduced in PHP 5.6.8, but is not exposed to userland. Try to use
        // it for forward compatibility.
        //
        // As of PHP 7.2+ STREAM_CRYPTO_METHOD_TLS_CLIENT is equivalent to STREAM_CRYPTO_METHOD_TLS_ANY_CLIENT.
        // see: https://wiki.php.net/rfc/improved-tls-constants
        // see: https://github.com/php/php-src/blob/197cac65fdf712effb19ad3e40688ceb7ebc7f7d/main/streams/php_stream_transport.h#L173-L175
        if (\defined('STREAM_CRYPTO_METHOD_TLS_ANY_CLIENT')) {
            $cryptoType |= STREAM_CRYPTO_METHOD_TLS_ANY_CLIENT;
        }

        // Add bits for all known TLS versions for the reasons above.
        if (\defined('STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT')) {
            $cryptoType |= \STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT;
        }
        if (\defined('STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT')) {
            $cryptoType |= \STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT;
        }
        if (\defined('STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT')) {
            $cryptoType |= \STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT;
        }
        if (\defined('STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT')) {
            $cryptoType |= \STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT;
        }

        return \stream_socket_enable_crypto($this->resource, $enable, $cryptoType);
    }

    /**
     * Returns whether TLS support is available.
     *
     * @return  bool
     */
    public function hasTLSSupport()
    {
        return \function_exists('stream_socket_enable_crypto');
    }

    /**
     * @deprecated 6.0 This method is effectively returning bogus data, because the majority of TLS communication uses Guzzle/cURL.
     */
    public static function supportsSSL()
    {
        if (static::$hasSSLSupport === null) {
            static::$hasSSLSupport = false;

            $transports = \stream_get_transports();
            foreach ($transports as $transport) {
                if (\preg_match('~^(ssl(v[23])?|tls(v[0-9\.]+)?)$~', $transport)) {
                    static::$hasSSLSupport = true;
                    break;
                }
            }
        }

        return static::$hasSSLSupport;
    }

    /**
     * @deprecated 6.0 See RemoteFile::supportsSSL(). The implementation is a noop.
     */
    public static function disableSSL()
    {
    }
}