split bolt connection factory into seperate factories

Author: transistive

src/Bolt/AConnectionFactory.php

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Neo4j PHP Client and Driver package.
+ *
+ * (c) Nagels <https://nagels.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\Bolt;
+
+use Bolt\connection\IConnection;
+
+class Connection
+{
+    private IConnection $connection;
+    /** ''|'s'|'ssc' */
+    private string $ssl;
+
+    /**
+     * @param IConnection $connection
+     * @param ''|'s'|'ssc' $ssl
+     */
+    public function __construct(IConnection $connection, string $ssl)
+    {
+        $this->connection = $connection;
+        $this->ssl = $ssl;
+    }
+
+    public function connect(): bool
+    {
+        return $this->connection->connect();
+    }
+
+    public function write(string $buffer): void
+    {
+        $this->connection->write($buffer);
+    }
+
+    public function read(int $length = 2048): string
+    {
+        return $this->connection->read($length);
+    }
+
+    public function disconnect(): void
+    {
+        $this->connection->disconnect();
+    }
+
+    public function getIp(): string
+    {
+        return $this->connection->getIp();
+    }
+
+    public function getPort(): int
+    {
+        return $this->connection->getPort();
+    }
+
+    public function getTimeout(): float
+    {
+        return $this->connection->getTimeout();
+    }
+
+    public function setTimeout(float $timeout): void
+    {
+        $this->connection->setTimeout($timeout);
+    }
+
+    /**
+     * @return ''|'s'|'ssc'
+     */
+    public function getEncryptionLevel(): string
+    {
+        return $this->ssl;
+    }
+}

src/Bolt/Connection.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Neo4j PHP Client and Driver package.
+ *
+ * (c) Nagels <https://nagels.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\Bolt;
+
+use Bolt\connection\Socket;
+
+final class SocketConnectionFactory
+{
+    private StreamConnectionFactory $factory;
+
+    public function __construct(StreamConnectionFactory $factory)
+    {
+        $this->factory = $factory;
+    }
+
+    public function create(UriConfiguration $config): Connection
+    {
+        if ($config->getSslLevel() !== '') {
+            return $this->factory->create($config);
+        }
+
+        $connection = new Socket($config->getHost(), $config->getPort(), $config->getTimeout());
+
+        return new Connection($connection, '');
+    }
+}

src/Bolt/SocketConnectionFactory.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Laudis\Neo4j\Bolt;
+
+use Laudis\Neo4j\Databags\SslConfiguration;
+use Laudis\Neo4j\Enum\SslMode;
+use Psr\Http\Message\UriInterface;
+
+use function explode;
+use function filter_var;
+
+use const FILTER_VALIDATE_IP;
+
+class SslConfigurationFactory
+{
+    /**
+     * @param UriInterface $uri
+     * @param SslConfiguration $config
+     *
+     * @return array{0: 's'|'ssc'|'s', 1: array}
+     */
+    public function create(UriInterface $uri, SslConfiguration $config): array
+    {
+        $mode = $config->getMode();
+        $sslConfig = '';
+        if ($mode === SslMode::FROM_URL()) {
+            $scheme = $uri->getScheme();
+            $explosion = explode('+', $scheme, 2);
+            $sslConfig = $explosion[1] ?? '';
+        } elseif ($mode === SslMode::ENABLE()) {
+            $sslConfig = 's';
+        } elseif ($mode === SslMode::ENABLE_WITH_SELF_SIGNED()) {
+            $sslConfig = 'ssc';
+        }
+
+        if (str_starts_with($sslConfig, 's')) {
+            return [$sslConfig, $this->enableSsl($uri->getHost(), $sslConfig, $config)];
+        }
+
+        return [$sslConfig, null];
+    }
+
+    private function enableSsl(string $host, string $sslConfig, SslConfiguration $config): ?array
+    {
+        $options = [
+            'verify_peer' => $config->isVerifyPeer(),
+            'peer_name' => $host,
+        ];
+        if (!filter_var($host, FILTER_VALIDATE_IP)) {
+            $options['SNI_enabled'] = true;
+        }
+        if ($sslConfig === 's') {
+            return $options;
+        }
+
+        if ($sslConfig === 'ssc') {
+            $options['allow_self_signed'] = true;
+
+            return $options;
+        }
+
+        return null;
+    }
+}

src/Bolt/SslConfigurationFactory.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Neo4j PHP Client and Driver package.
+ *
+ * (c) Nagels <https://nagels.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\Bolt;
+
+use Bolt\connection\IConnection;
+use Bolt\connection\StreamSocket;
+use function explode;
+use const FILTER_VALIDATE_IP;
+use function filter_var;
+use Laudis\Neo4j\Databags\SslConfiguration;
+use Laudis\Neo4j\Enum\SslMode;
+use Psr\Http\Message\UriInterface;
+
+final class StreamConnectionFactory
+{
+    public function create(UriConfiguration $config): Connection
+    {
+        $connection = new StreamSocket($config->getHost(), $config->getPort(), $config->getTimeout());
+        if ($config->getSslLevel() !== '') {
+            $connection->setSslContextOptions($config->getSslConfiguration());
+        }
+
+        return new Connection($connection, $config->getSslLevel());
+    }
+}

src/Bolt/StreamConnectionFactory.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Neo4j PHP Client and Driver package.
+ *
+ * (c) Nagels <https://nagels.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\Bolt;
+
+use function extension_loaded;
+
+/**
+ * Singleton connection factory based on the installed extensions.
+ */
+class SystemWideConnectionFactory
+{
+    /**
+     * @var SocketConnectionFactory|StreamConnectionFactory
+     */
+    private $factory;
+    private static ?SystemWideConnectionFactory $instance = null;
+
+    /**
+     * @param SocketConnectionFactory|StreamConnectionFactory $factory
+     */
+    private function __construct($factory)
+    {
+        $this->factory = $factory;
+    }
+
+    public static function getInstance(): SystemWideConnectionFactory
+    {
+        if (self::$instance === null) {
+            $factory = new StreamConnectionFactory();
+            if (extension_loaded('sockets')) {
+                self::$instance = new self(new SocketConnectionFactory($factory));
+            } else {
+                self::$instance = new self($factory);
+            }
+        }
+
+        return self::$instance;
+    }
+
+    public function create(UriConfiguration $config): Connection
+    {
+        return $this->factory->create($config);
+    }
+}