Merge pull request #6 from stefanak-michal/up_to_v4.1

Refactored to support versioning. Updated up to bolt protocol version 4.1.

Author: stefanak-michal

Bolt.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Bolt\PackStream;
+
+/**
+ * Interface IPacker
+ *
+ * @author Michal Stefanak
+ * @link https://github.com/stefanak-michal/Bolt
+ * @package Bolt\PackStream
+ */
+interface IPacker
+{
+    /**
+     * @param $signature
+     * @param mixed ...$params
+     * @return string
+     */
+    public function pack($signature, ...$params): string;
+}

PackStream/IPacker.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Bolt\PackStream;
+
+/**
+ * Interface IUnpacker
+ *
+ * @author Michal Stefanak
+ * @link https://github.com/stefanak-michal/Bolt
+ * @package Bolt\PackStream
+ */
+interface IUnpacker
+{
+    /**
+     * @param string $msg
+     * @param int $signature
+     * @return mixed
+     */
+    public function unpack(string $msg, int &$signature = 0);
+}

PackStream/IUnpacker.php

@@ -1,16 +1,18 @@
 <?php
 
-namespace Bolt;
+namespace Bolt\PackStream\v1;
 
 use Exception;
+use Bolt\PackStream\IPacker;
 
 /**
- * Class Packer
- * Pack bolt messages
+ * Class Packer of PackStream version 1
  *
  * @author Michal Stefanak
+ * @link https://github.com/stefanak-michal/Bolt
+ * @package Bolt\PackStream\v1
  */
-class Packer
+class Packer implements IPacker
 {
     private const SMALL = 16;
     private const MEDIUM = 256;
@@ -24,7 +26,7 @@ class Packer
      * @return string
      * @throws Exception
      */
-    public function pack($signature, ...$params)
+    public function pack($signature, ...$params): string
     {
         $output = '';
 

Packer.php renamed to PackStream/v1/Packer.php

@@ -1,22 +1,24 @@
 <?php
 
-namespace Bolt;
+namespace Bolt\PackStream\v1;
 
 use Bolt\structures\{
     Node,
     Path,
     Relationship,
     UnboundRelationship
 };
+use Bolt\PackStream\IUnpacker;
 use Exception;
 
 /**
- * Class Unpacker
- * Unpack bolt messages
+ * Class Unpacker of PackStream version 1
  *
  * @author Michal Stefanak
+ * @link https://github.com/stefanak-michal/Bolt
+ * @package Bolt\PackStream\v1
  */
-class Unpacker
+class Unpacker implements IUnpacker
 {
     /**
      * @var string

Unpacker.php renamed to PackStream/v1/Unpacker.php

@@ -1,10 +1,21 @@
 # Bolt
-Bolt protocol library over TCP socket. Bolt protocol is primary used for communication with [Neo4j](https://neo4j.com/) Graph database. The documentation is available at https://boltprotocol.org/v1/
+Bolt protocol library over TCP socket. Bolt protocol is primary used for communication with [Neo4j](https://neo4j.com/) Graph database. The documentation is available at [https://7687.org/](https://7687.org/).
 
 ## Supported version
-Bolt < 4.0
+Bolt <= 4.1
 
-Neo4j version 4.0 is out for some time and I'm sorry to tell you, but this software won't work with it. Reason is outdated documentation for Bolt protocol handled by Neo4j team, which is still available only for version 1.0. Suddenly Neo4j 4.0 drops support for Bolt V1.
+| Neo4j Version | Bolt 1 | Bolt 2 | Bolt 3 | Bolt 4.0 | Bolt 4.1 |
+|:-------------:|:------:|:------:|:------:|:--------:|:--------:|
+| 3.0           | x      |        |        |          |          |
+| 3.1           | x      |        |        |          |          |
+| 3.2           | x      |        |        |          |          |
+| 3.3           | x      |        |        |          |          |
+| 3.4           | (x)    | x      |        |          |          |
+| 3.5           |        | (x)    | x      |          |          |
+| 4.0           |        |        | (x)    | x        |          |
+| 4.1           |        |        | (x)    | (x)      | x        |
+
+<sup>The (x) denotes that support could be removed in next version of Neo4j.</sup>
 
 ## Requirements
 PHP >= 7.1  
@@ -13,10 +24,10 @@ extensions:
 - mbstring https://www.php.net/manual/en/book.mbstring.php
 
 ## Usage
-See ``index.php`` file. It contains few examples how you can use this library. All files are loaded with require_once at the beginning of file, because this example doesn't contain autoloader. Of course you need to set up your username and password.
+See ``index.php`` file. It contains few examples how you can use this library. Of course you need to set up your username and password. This repository contains simple `autoload.php` file.
 
 ## Exceptions
-Throwing exceptions is default behaviour. If you want, you can assign own callable error handler to ``\Bolt\Bolt::$errorHandler``. It's called on error and methods (init, run, pullAll, ...) will return false.
+Throwing exceptions is default behaviour. If you want, you can assign own callable error handler to ``\Bolt\Bolt::$errorHandler``. It's called on error and methods (init, run, pullAll, ...) will therefore return false.
 
 ## Author note
 I really like Neo4j and I wanted to use it with PHP. But after I looked on official php library, I was really disappointed. Too much dependencies. I don't like if I need to install 10 things because of one. First I decided to use HTTP API for communication, but it wasn't fast enough. I went through bolt protocol documentation and I said to myself, why not to create own simpler library?

README.md

@@ -0,0 +1,140 @@
+<?php
+
+namespace Bolt;
+
+use Bolt\PackStream\IUnpacker;
+use Exception;
+
+/**
+ * Static class Socket
+ *
+ * @author Michal Stefanak
+ * @link https://github.com/stefanak-michal/Bolt
+ * @package Bolt
+ */
+final class Socket
+{
+    /**
+     * @var resource
+     */
+    public static $socket;
+
+    /**
+     * @param string $ip
+     * @param int $port
+     * @param int $timeout
+     * @throws Exception
+     */
+    public static function initialize(string $ip, int $port, int $timeout)
+    {
+        if (is_resource(self::$socket))
+            return;
+
+        if (!extension_loaded('sockets')) {
+            Bolt::error('PHP Extension sockets not enabled');
+            return;
+        }
+
+        self::$socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
+        if (!is_resource(self::$socket)) {
+            Bolt::error('Cannot create socket');
+            return;
+        }
+
+        socket_set_block(Socket::$socket);
+        socket_set_option(Socket::$socket, SOL_TCP, TCP_NODELAY, 1);
+        socket_set_option(Socket::$socket, SOL_SOCKET, SO_KEEPALIVE, 1);
+        socket_set_option(Socket::$socket, SOL_SOCKET, SO_RCVTIMEO, ['sec' => $timeout, 'usec' => 0]);
+        socket_set_option(Socket::$socket, SOL_SOCKET, SO_SNDTIMEO, ['sec' => $timeout, 'usec' => 0]);
+
+        $conn = socket_connect(self::$socket, $ip, $port);
+        if (!$conn) {
+            $code = socket_last_error(Socket::$socket);
+            Bolt::error(socket_strerror($code), $code);
+            return;
+        }
+    }
+
+    /**
+     * Write to socket
+     * @param string $buffer
+     * @throws Exception
+     */
+    public static function write(string $buffer)
+    {
+        if (!is_resource(self::$socket)) {
+            Bolt::error('Not initialized socket');
+            return;
+        }
+
+        $size = mb_strlen($buffer, '8bit');
+        $sent = 0;
+
+        if (Bolt::$debug)
+            Bolt::printHex($buffer);
+
+        while ($sent < $size) {
+            $sent = socket_write(self::$socket, $buffer, $size);
+            if ($sent === false) {
+                $code = socket_last_error(self::$socket);
+                Bolt::error(socket_strerror($code), $code);
+                return;
+            }
+
+            $buffer = mb_strcut($buffer, $sent, null, '8bit');
+            $size -= $sent;
+        }
+    }
+
+    /**
+     * Read unpacked from socket
+     * @param IUnpacker $unpacker
+     * @return mixed
+     * @throws Exception
+     */
+    public static function read(IUnpacker $unpacker)
+    {
+        if (!is_resource(self::$socket)) {
+            Bolt::error('Not initialized socket');
+            return;
+        }
+
+        $msg = '';
+        while (true) {
+            $header = self::readBuffer(2);
+            if (ord($header[0]) == 0x00 && ord($header[1]) == 0x00)
+                break;
+            $length = unpack('n', $header)[1] ?? 0;
+            $msg .= self::readBuffer($length);
+        }
+
+        $output = null;
+        $signature = 0;
+        if (!empty($msg)) {
+            if (Bolt::$debug)
+                Bolt::printHex($msg, false);
+
+            try {
+                $output = $unpacker->unpack($msg, $signature);
+            } catch (Exception $ex) {
+                Bolt::error($ex->getMessage());
+            }
+        }
+
+        return [$signature, $output];
+    }
+
+    /**
+     * Read buffer from socket
+     * @param int $length
+     * @return string
+     */
+    public static function readBuffer(int $length = 2048): string
+    {
+        $output = '';
+        do {
+            $output .= socket_read(self::$socket, $length - mb_strlen($output, '8bit'), PHP_BINARY_READ);
+        } while (mb_strlen($output, '8bit') < $length);
+        return $output;
+    }
+}

Socket.php

@@ -0,0 +1,20 @@
+<?php
+
+define('BASE_PATH', dirname(__DIR__));
+define('DS', DIRECTORY_SEPARATOR);
+
+spl_autoload_register(function ($name) {
+    $parts = explode("\\", $name);
+    $parts = array_filter($parts);
+
+    /*
+     * namespace calls
+     */
+
+    //compose standart namespaced path to file
+    $path = BASE_PATH . DS . implode(DS, $parts) . '.php';
+    if (file_exists($path)) {
+        require_once $path;
+        return;
+    }
+});

autoload.php

@@ -1,20 +1,27 @@
 <?php
 
-require_once 'Bolt.php';
-require_once 'Packer.php';
-require_once 'Unpacker.php';
-require_once 'structures' . DIRECTORY_SEPARATOR . 'Node.php';
-require_once 'structures' . DIRECTORY_SEPARATOR . 'Relationship.php';
-require_once 'structures' . DIRECTORY_SEPARATOR . 'Path.php';
-require_once 'structures' . DIRECTORY_SEPARATOR . 'UnboundRelationship.php';
+/**
+ * Bolt protocol library
+ * This index.php file serve as usage preview and functional test. It can be removed.
+ *
+ * @author Michal Stefanak
+ * @link https://github.com/stefanak-michal/Bolt
+ */
+
+require_once 'autoload.php';
 
 set_time_limit(3);
 
 $user = 'neo4j';
 $password = 'nothing';
 
+//\Bolt\Bolt::$debug = true;
+
 try {
+
     $neo4j = new \Bolt\Bolt();
+    $neo4j->setProtocolVersions(4.1);
+
     if (!$neo4j->init('MyClient/1.0', $user, $password)) {
         throw new Exception('Wrong login');
     }
@@ -26,30 +33,52 @@
     }
 
     //test record
-    $res = $neo4j->pullAll();
+    $res = $neo4j->pull();
     if (($res[0][0] ?? 0) != 1 || ($res[0][1] ?? 0) != 2) {
         throw new Exception('Wrong record');
     }
 
 
     //test node create
     $neo4j->run('CREATE (a:Test) RETURN a, ID(a)');
-    $created = $neo4j->pullAll();
+    $created = $neo4j->pull();
     if (!($created[0][0] instanceof \Bolt\structures\Node)) {
         throw new Exception('Unsuccussful node create');
     }
 
+    //get neo4j version to use right placeholders
+    $neo4j->run('call dbms.components() yield versions unwind versions as version return version');
+    $neo4jVersion = $neo4j->pull()[0][0] ?? '';
+    $t = version_compare($neo4jVersion, '4') == -1;
+
     //test delete created node
-    $neo4j->run('MATCH (a:Test) WHERE ID(a) = {a} DELETE a', [
+    $neo4j->run('MATCH (a:Test) WHERE ID(a) = ' . ($t ? '{a}' : '$a') . ' DELETE a', [
         'a' => $created[0][1]
     ]);
-    $res = $neo4j->pullAll();
+    $res = $neo4j->pull();
     if (($res[0]['stats']['nodes-deleted'] ?? 0) != 1) {
         throw new Exception('Unsuccussful node delete');
     }
 
+    //transaction
+    if ($neo4j->getProtocolVersion() >= 3) {
+        $neo4j->begin();
+        $neo4j->run('CREATE (a:Test) RETURN a, ID(a)');
+        $created = $neo4j->pull();
+        $neo4j->rollback();
+
+        $neo4j->run('MATCH (a:Test) WHERE ID(a) = ' . ($t ? '{a}' : '$a') . ' RETURN COUNT(a)', [
+            'a' => $created[0][1]
+        ]);
+        $res = $neo4j->pull();
+        if ($res[0][0] != 0)
+            throw new Exception('Unsuccussful transaction rollback');
+    }
+
+    unset($neo4j);
+
+    echo '<br><br>Test successful';
 
-    echo 'Test successful';
 } catch (Exception $e) {
     var_dump($e->getMessage());
 }