Merge pull request #76 from neo4j-php/pack_structures

pack structures

Author: stefanak-michal

composer.json

@@ -9,7 +9,8 @@
     "minimum-stability": "stable",
     "require": {
         "php": ">=7.1.0",
-        "ext-mbstring": "*"
+        "ext-mbstring": "*",
+        "ext-bcmath": "*"
     },
     "require-dev": {
         "phpunit/phpunit": ">=7.5.0"

phpunit.xml

@@ -14,6 +14,7 @@
             <directory suffix=".php">src/PackStream</directory>
             <directory suffix=".php">src/protocol</directory>
             <directory suffix=".php">src/helpers</directory>
+            <directory suffix=".php">src/structures</directory>
             <file>src/Bolt.php</file>
         </whitelist>
     </filter>

src/PackStream/v1/Packer.php

@@ -5,6 +5,19 @@
 use Bolt\PackStream\IPacker;
 use Bolt\error\PackException;
 use Generator;
+use Bolt\structures\{
+    IStructure,
+    Relationship,
+    Date,
+    Time,
+    LocalTime,
+    DateTime,
+    DateTimeZoneId,
+    LocalDateTime,
+    Duration,
+    Point2D,
+    Point3D
+};
 
 /**
  * Class Packer of PackStream version 1
@@ -20,6 +33,19 @@ class Packer implements IPacker
     private const LARGE = 65536;
     private const HUGE = 4294967295;
 
+    private $structuresLt = [
+        Relationship::class => [0x52, 'packInteger', 'packInteger', 'packInteger', 'packString', 'packMap'],
+        Date::class => [0x44, 'packInteger'],
+        Time::class => [0x54, 'packInteger', 'packInteger'],
+        LocalTime::class => [0x74, 'packInteger'],
+        DateTime::class => [0x46, 'packInteger', 'packInteger', 'packInteger'],
+        DateTimeZoneId::class => [0x66, 'packInteger', 'packInteger', 'packString'],
+        LocalDateTime::class => [0x64, 'packInteger', 'packInteger'],
+        Duration::class => [0x45, 'packInteger', 'packInteger', 'packInteger', 'packInteger'],
+        Point2D::class => [0x58, 'packInteger', 'packFloat', 'packFloat'],
+        Point3D::class => [0x59, 'packInteger', 'packFloat', 'packFloat', 'packFloat']
+    ];
+
     /**
      * Pack message with parameters
      * @param $signature
@@ -77,6 +103,8 @@ private function p($param): string
             $output .= chr($param ? 0xC3 : 0xC2);
         } elseif (is_string($param)) {
             $output .= $this->packString($param);
+        } elseif ($param instanceof IStructure) {
+            $output .= $this->packStructure($param);
         } elseif (is_array($param)) {
             $keys = array_keys($param);
             if (count($param) == 0 || count(array_filter($keys, 'is_int')) == count($keys)) {
@@ -222,4 +250,34 @@ private function packList(array $arr): string
         return $output;
     }
 
+    /**
+     * @param IStructure $structure
+     * @return string
+     * @throws PackException
+     */
+    private function packStructure(IStructure $structure): string
+    {
+        $reflection = new \ReflectionClass($structure);
+        $properties = $reflection->getProperties();
+        $cnt = count($properties);
+
+        if (!array_key_exists(get_class($structure), $this->structuresLt)) {
+            throw new PackException('Provided structure as parameter is not supported');
+        }
+
+        $arr = $this->structuresLt[get_class($structure)];
+        if (count($arr) != $cnt + 1) {
+            throw new PackException('Invalid amount of structure properties');
+        }
+
+        $output = pack('C', 0b10110000 | $cnt);
+        $output .= chr(array_shift($arr));
+        foreach ($arr as $i => $method) {
+            $properties[$i]->setAccessible(true);
+            $output .= $this->{$method}($properties[$i]->getValue($structure));
+        }
+
+        return $output;
+    }
+
 }

src/structures/Date.php

@@ -10,6 +10,7 @@
  *
  * @author Michal Stefanak
  * @link https://github.com/neo4j-php/Bolt
+ * @link https://7687.org/packstream/packstream-specification-1.html#date---structure
  * @package Bolt\structures
  */
 class Date implements IStructure
@@ -39,6 +40,6 @@ public function days(): int
 
     public function __toString(): string
     {
-        return date('Y-m-d', strtotime($this->days . ' days'));
+        return gmdate('Y-m-d', strtotime('+' . $this->days . ' days +0000', 0));
     }
 }

src/structures/DateTime.php

@@ -14,6 +14,7 @@
  *
  * @author Michal Stefanak
  * @link https://github.com/neo4j-php/Bolt
+ * @link https://7687.org/packstream/packstream-specification-1.html#datetime---structure
  * @package Bolt\structures
  */
 class DateTime implements IStructure
@@ -65,7 +66,7 @@ public function nanoseconds(): int
     }
 
     /**
-     * specifies the offset in minutes from UTC
+     * specifies the offset in seconds from UTC
      * @return int
      */
     public function tz_offset_seconds(): int
@@ -75,11 +76,9 @@ public function tz_offset_seconds(): int
 
     public function __toString(): string
     {
-        $dt = \DateTime::createFromFormat('U', $this->seconds, new \DateTimeZone('UTC'));
-        $fraction = new \DateInterval('PT0S');
-        $fraction->f = $this->nanoseconds / 1000000000;
-        $dt->add($fraction);
-        $dt->setTimezone(new \DateTimeZone(sprintf('+%04d', $this->tz_offset_seconds / 3600 * 100)));
-        return $dt->format('Y-m-d\TH:i:s.uP');
+        $ts = bcadd($this->seconds - $this->tz_offset_seconds, bcdiv($this->nanoseconds, 10e8, 6), 6);
+        return \DateTime::createFromFormat('U.u', $ts, new \DateTimeZone('UTC'))
+            ->setTimezone(new \DateTimeZone(sprintf("%+'05d", $this->tz_offset_seconds / 3600 * 100)))
+            ->format('Y-m-d\TH:i:s.uP');
     }
 }

src/structures/DateTimeZoneId.php

@@ -14,6 +14,7 @@
  *
  * @author Michal Stefanak
  * @link https://github.com/neo4j-php/Bolt
+ * @link https://7687.org/packstream/packstream-specification-1.html#datetimezoneid---structure
  * @package Bolt\structures
  */
 class DateTimeZoneId implements IStructure
@@ -75,11 +76,8 @@ public function tz_id(): string
 
     public function __toString(): string
     {
-        $dt = \DateTime::createFromFormat('U', $this->seconds, new \DateTimeZone('UTC'));
-        $fraction = new \DateInterval('PT0S');
-        $fraction->f = $this->nanoseconds / 1000000000;
-        $dt->add($fraction);
-        $dt->setTimezone(new \DateTimeZone($this->tz_id));
-        return $dt->format('Y-m-d\TH:i:s.uP');
+        $timestamp = bcadd($this->seconds(), bcdiv($this->nanoseconds, 10e8, 6), 6);
+        return \DateTime::createFromFormat('U.u', $timestamp, new \DateTimeZone($this->tz_id))
+                ->format('Y-m-d\TH:i:s.u') . '[' . $this->tz_id . ']';
     }
 }

src/structures/Duration.php

@@ -10,6 +10,7 @@
  *
  * @author Michal Stefanak
  * @link https://github.com/neo4j-php/Bolt
+ * @link https://7687.org/packstream/packstream-specification-1.html#duration---structure
  * @package Bolt\structures
  */
 class Duration implements IStructure
@@ -84,6 +85,30 @@ public function nanoseconds(): int
 
     public function __toString(): string
     {
-        return 'P' . $this->months . 'M' . $this->days . 'DT' . ($this->seconds + $this->nanoseconds / 1000000000) . 'S';
+        $output = 'P';
+        $years = floor($this->months / 12);
+        if (!empty($years))
+            $output .= $years . 'Y';
+        if (!empty($this->months % 12))
+            $output .= ($this->months % 12) . 'M';
+        if (!empty($this->days))
+            $output .= $this->days . 'D';
+
+        $time = '';
+        $hours = floor($this->seconds / 3600);
+        if (!empty($hours))
+            $time .= $hours . 'H';
+        $minutes = floor($this->seconds % 3600 / 60);
+        if (!empty($minutes))
+            $time .= $minutes . 'M';
+
+        $seconds = rtrim(bcadd($this->seconds % 3600 % 60, bcdiv($this->nanoseconds, 10e8, 6), 6), '0.');
+        if (!empty($seconds))
+            $time .= $seconds . 'S';
+
+        if (!empty($time))
+            $output .= 'T' . $time;
+
+        return $output;
     }
 }

src/structures/LocalDateTime.php

@@ -10,6 +10,7 @@
  *
  * @author Michal Stefanak
  * @link https://github.com/neo4j-php/Bolt
+ * @link https://7687.org/packstream/packstream-specification-1.html#localdatetime---structure
  * @package Bolt\structures
  */
 class LocalDateTime implements IStructure
@@ -55,11 +56,8 @@ public function nanoseconds(): int
 
     public function __toString(): string
     {
-        $dt = \DateTime::createFromFormat('U', $this->seconds, new \DateTimeZone('UTC'));
-        $fraction = new \DateInterval('PT0S');
-        $fraction->f = $this->nanoseconds / 1000000000;
-        $dt->add($fraction);
-        return $dt->format('Y-m-d\TH:i:s.u');
+        return \DateTime::createFromFormat('U.u', bcadd($this->seconds, bcdiv($this->nanoseconds, 10e8, 6), 6))
+            ->format('Y-m-d\TH:i:s.u');
     }
 
 }

src/structures/LocalTime.php

@@ -10,6 +10,7 @@
  *
  * @author Michal Stefanak
  * @link https://github.com/neo4j-php/Bolt
+ * @link https://7687.org/packstream/packstream-specification-1.html#localtime---structure
  * @package Bolt\structures
  */
 class LocalTime implements IStructure
@@ -39,6 +40,7 @@ public function nanoseconds(): int
 
     public function __toString(): string
     {
-        return date('H:i:s', floor($this->nanoseconds / 1000000000)) . '.' . $this->nanoseconds % 1000000000;
+        return \DateTime::createFromFormat('U.u', bcdiv($this->nanoseconds, 10e8, 6))
+            ->format('H:i:s.u');
     }
 }

src/structures/Node.php

@@ -8,6 +8,7 @@
  *
  * @author Michal Stefanak
  * @link https://github.com/neo4j-php/Bolt
+ * @link https://7687.org/packstream/packstream-specification-1.html#node---structure
  * @package Bolt\structures
  */
 class Node implements IStructure