Switch from serialize to json_encode. Restrict via a list of accepted…

… value types. Shrink varchar size to 7. Code tweaks.
modmore · Nov 1, 2024 · 8d4a850 · 8d4a850
1 parent d6fac55
commit 8d4a850
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 19 deletions.
diff --git a/_build/schema/versionx.mysql.schema.xml b/_build/schema/versionx.mysql.schema.xml
@@ -101,8 +101,8 @@
             Keep track of the before and after value types so reverting doesn't decode an intended json string,
             or cast an int as a string etc. Empty value means it's a string.
         -->
-        <field key="before_type" dbtype="varchar" precision="20" phptype="string" null="false" default="" />
-        <field key="after_type" dbtype="varchar" precision="20" phptype="string" null="false" default="" />
+        <field key="before_type" dbtype="varchar" precision="7" phptype="string" null="false" default="" />
+        <field key="after_type" dbtype="varchar" precision="7" phptype="string" null="false" default="" />
 
         <field key="before" dbtype="mediumtext" phptype="string" null="false" default="" />
         <field key="after" dbtype="mediumtext" phptype="string" null="false" default="" />

diff --git a/core/components/versionx/model/versionx/mysql/vxdeltafield.map.inc.php b/core/components/versionx/model/versionx/mysql/vxdeltafield.map.inc.php
@@ -68,15 +68,15 @@
     'before_type' => 
     array (
       'dbtype' => 'varchar',
-      'precision' => '20',
+      'precision' => '7',
       'phptype' => 'string',
       'null' => false,
       'default' => '',
     ),
     'after_type' => 
     array (
       'dbtype' => 'varchar',
-      'precision' => '20',
+      'precision' => '7',
       'phptype' => 'string',
       'null' => false,
       'default' => '',

diff --git a/core/components/versionx/src/DeltaManager.php b/core/components/versionx/src/DeltaManager.php
@@ -4,6 +4,7 @@
 
 use Carbon\Carbon;
 use Jfcherng\Diff\DiffHelper;
+use modmore\VersionX\Fields\Field;
 use modmore\VersionX\Types\Type;
 use modmore\VersionX\Enums\RevertAction;
 use MODX\Revolution\modX;
@@ -31,7 +32,6 @@ class DeltaManager
         'showHeader' => false,
     ];
 
-
     function __construct(VersionX $versionX)
     {
         $this->versionX = $versionX;
@@ -118,12 +118,16 @@ public function createDelta(int $id, Type $type, bool $isSnapshot = false): ?\vx
             $fieldType = $type->getFieldClass($field);
             $fieldTypeObj = new $fieldType($value);
 
-            // Flatten any arrays and set the value as a string
+            // Get the value and the value type
             $value = $fieldTypeObj->getValue();
             $valueType = gettype($value);
+            // If the value is not an accepted type, default to string
+            if (!in_array(strtolower($valueType), Field::ACCEPTED_VALUE_TYPES)) {
+                $valueType = '';
+            }
 
-            if (is_array($value)) {
-                $value = serialize($value);
+            if (is_array($value) || is_object($value)) {
+                $value = json_encode($value);
             } else {
                 $value = (string)$value;
             }
@@ -150,7 +154,7 @@ public function createDelta(int $id, Type $type, bool $isSnapshot = false): ?\vx
                 'field' => $field,
                 'field_type' => $fieldType,
                 'before_type' => $prevValueType,
-                'after_type' => $valueType !== 'string' ? $valueType : '',
+                'after_type' => $valueType,
                 'before' => $prevValue,
                 'after' => $value,
                 'diff' => $renderedDiff, // Not persisted. Kept on object until cached.

diff --git a/core/components/versionx/src/Fields/Field.php b/core/components/versionx/src/Fields/Field.php
@@ -12,6 +12,18 @@ abstract class Field
     protected array $options = [];
     protected string $tpl = '';
 
+    public const ACCEPTED_VALUE_TYPES = [
+        'array',
+        'object',
+        'boolean',
+        'bool',
+        'integer',
+        'int',
+        'float',
+        'double',
+        'null'
+    ];
+
     function __construct($value, $name = '', $options = [])
     {
         if (!$this->value) {

diff --git a/core/components/versionx/src/Fields/Properties.php b/core/components/versionx/src/Fields/Properties.php
@@ -63,21 +63,17 @@ public static function revertPropertyValue(\vxDeltaField $field, &$data)
                 continue;
             }
 
+            // The last 'piece' will be the key we're after.
             if ($piece === $last) {
-//                $json = json_decode($field->get('before'), true);
-//                if (json_last_error() === JSON_ERROR_NONE) {
-//                    $data[$piece] = $json;
-//                }
-
                 $beforeValue = $field->get('before');
                 $beforeType = $field->get('before_type');
 
-                if ($beforeType === 'array') {
-                    // Unserialize if it's meant to be an array
-                    $unserialized = unserialize($beforeValue);
-                    $data[$piece] = $unserialized !== false ? $unserialized : $field->get('before');
+                if (in_array($beforeType, ['array', 'object'])) {
+                    // Decode if it's meant to be an array/object
+                    $decoded = json_decode($beforeValue, true);
+                    $data[$piece] = $decoded ?: $field->get('before');
                 }
-                else if (in_array($beforeType, ['boolean', 'bool', 'integer', 'int', 'float', 'double'])) {
+                else if (in_array(strtolower($beforeType), self::ACCEPTED_VALUE_TYPES)) {
                     // Cast as the set type
                     $data[$piece] = settype($beforeValue, $beforeType);
                 }