Delta revert previews

assets/components/versionx/css/mgr/mgr.css

@@ -102,7 +102,8 @@
 .x-grid3-row.x-grid3-row-last .versionx-grid-main-col {
     margin-bottom: 10px;
 }
-.x-grid3-row.x-grid3-row-first .versionx-diff-revert-all-btn {
+.x-grid3-row.x-grid3-row-first .versionx-diff-revert-all-btn,
+.x-grid3-row.x-grid3-row-first .versionx-diff-revert-all-preview-btn {
     display: none;
 }
 

assets/components/versionx/js/mgr/grid.deltas.js

@@ -22,6 +22,7 @@ VersionX.grid.Deltas = function(config) {
             {name: 'time_start', type: 'string'},
             {name: 'time_end', type: 'string'},
             {name: 'diffs', type: 'string'},
+            {name: 'show_previews', type: 'boolean'},
         ],
         paging: true,
         remoteSort: true,
@@ -197,6 +198,11 @@ Ext.extend(VersionX.grid.Deltas, MODx.grid.Grid, {
                 });
             break;
 
+            case 'versionx-diff-preview-btn':
+            case 'versionx-diff-revert-all-preview-btn':
+                this.loadPreview(t.dataset);
+                break;
+
             case 'versionx-diff-revert-all-btn':
                 let time = Ext.util.Format.date(t.dataset.time_start, `${MODx.config.manager_date_format} H:i:s`);
                 MODx.msg.confirm({
@@ -228,7 +234,8 @@ Ext.extend(VersionX.grid.Deltas, MODx.grid.Grid, {
             name = rec.get('username'),
             time_start = rec.get('time_start'),
             time_end = rec.get('time_end'),
-            milestone = rec.get('milestone');
+            milestone = rec.get('milestone'),
+            showPreviews = rec.get('show_previews');
 
         // If we've got a milestone, set a class for it, so it can be rendered differently
         let milestone_class = milestone ? ' ' + _('versionx.deltas.milestone') : '',
@@ -259,6 +266,35 @@ Ext.extend(VersionX.grid.Deltas, MODx.grid.Grid, {
                 ${_('versionx.deltas.revert_these_changes')}
             </button>
         `;
+
+        // Only allow previews for resources
+        let pitPreviewBtn = '';
+        if (
+            showPreviews
+            && typeof rec.json.principal_class !== 'undefined'
+            && rec.json.principal_class === 'modResource'
+        ) {
+            // Delta revert preview button
+            buttonRow += `<button 
+                class="versionx-diff-preview-btn x-btn x-btn-small x-btn-icon-small-left" 
+                type="button" 
+                data-id="${version_id}"
+                data-revert="delta"
+            >
+                <i class="icon icon-eye"></i>&nbsp;&nbsp;${_('versionx.deltas.preview')}
+            </button>`;
+
+            // Point in time preview button
+            pitPreviewBtn = `<button 
+                class="versionx-diff-revert-all-preview-btn x-btn x-btn-small x-btn-icon-small-left" 
+                type="button" 
+                data-id="${version_id}"
+                data-revert="pit"
+            >
+                <i class="icon icon-eye"></i>&nbsp;&nbsp;${_('versionx.deltas.preview')}
+            </button>`;
+        }
+
         // Display initial delta differently
         if (milestone === '_initial_') {
             buttonRow = '';
@@ -273,14 +309,17 @@ Ext.extend(VersionX.grid.Deltas, MODx.grid.Grid, {
                         <div class="versionx-grid-timeline-point"></div>
                     </div>
                     <div class="versionx-grid-main-col">
-                        <button 
-                            class="versionx-diff-revert-all-btn x-btn x-btn-small x-btn-icon-small-left" 
-                            type="button" 
-                            data-time_start="${time_start}" 
-                            data-id="${version_id}"
-                        >
-                            <i class="icon icon-undo"></i> &nbsp;&nbsp;${_('versionx.deltas.revert_all_fields_to_point_in_time')}
-                        </button>
+                        <div class="versionx-pit-buttons">
+                            <button 
+                                class="versionx-diff-revert-all-btn x-btn x-btn-small x-btn-icon-small-left" 
+                                type="button" 
+                                data-time_start="${time_start}" 
+                                data-id="${version_id}"
+                            >
+                                <i class="icon icon-undo"></i>&nbsp;&nbsp;${_('versionx.deltas.revert_all_fields_to_point_in_time')}
+                            </button>
+                            ${pitPreviewBtn}
+                        </div>
                         <div class="versionx-grid-column-diff">
                             <div class="versionx-diff-top-row">
                                 <div class="versionx-diff-top-row-left">
@@ -298,5 +337,48 @@ Ext.extend(VersionX.grid.Deltas, MODx.grid.Grid, {
                     </div>
                 </div>`;
     },
+    loadPreview: function(dataset) {
+        const self = this;
+        let previewUrl = MODx.config.manager_url
+            + '?namespace=magicpreview&a=preview&resource='
+            + this.config.principal;
+
+        if (!self.previewWindows) {
+            self.previewWindows = {};
+        }
+
+        // Check if a window for the given dataset.id already exists
+        if (self.previewWindows[dataset.id] && !self.previewWindows[dataset.id].closed) {
+            self.previewWindows[dataset.id].focus();
+        } else {
+            // Open a new window and store the reference
+            self.previewWindows[dataset.id] = window.open(previewUrl + '#loading', 'MagicPreview_' + dataset.id);
+            self.previewWindows[dataset.id].opener = window; // Pass reference to the main window
+        }
+
+        MODx.Ajax.request({
+            url: VersionX.config.connector_url,
+            params: {
+                action: 'mgr/deltas/preview',
+                id: this.config.principal,
+                class_key: this.config.principal_class,
+                delta_id: dataset.id,
+                revert: dataset.revert,
+                versionx: true, // required or the VersionX plugin will ignore the OnResourceMagicPreview event
+            },
+            listeners: {
+                success: {
+                    fn: function (r) {
+                        if (r.object && r.object.preview_hash) {
+                            self.previewWindows[dataset.id].location = previewUrl
+                                + '&revert=' + dataset.revert
+                                + '&version=' + dataset.id
+                                + '#' + r.object.preview_hash;
+                        }
+                    }
+                }
+            }
+        });
+    }
 });
 Ext.reg('versionx-grid-deltas', VersionX.grid.Deltas);

core/components/versionx/elements/plugins/versionx.plugin.php

@@ -16,6 +16,8 @@
  * @var modPlugin|\MODX\Revolution\modPluginEvent $plugin
 */
 
+use Carbon\Carbon;
+use modmore\VersionX\Enums\RevertAction;
 use modmore\VersionX\Types\Chunk;
 use modmore\VersionX\Types\Plugin;
 use modmore\VersionX\Types\Snippet;
@@ -121,6 +123,47 @@
         }
         break;
 
+    case 'OnResourceMagicPreview':
+        if (empty($properties['versionx'])) {
+            break;
+        }
+
+        /**  @var array $properties */
+        $versionX = new VersionX($modx);
+        $deltaId = $properties['delta_id'];
+
+        $delta = $modx->getObject(\vxDelta::class, ['id' => $deltaId]);
+        if ($delta->get('type_class') !== Resource::class) {
+            break;
+        };
+
+        $previewType = new \modmore\VersionX\Types\ResourcePreview($versionX);
+
+        // Check type of revert preview ('delta' or 'point in time')
+        if ($properties['revert'] === 'delta') {
+            $now = Carbon::now()->toDateTimeString();
+            $fields = $modx->getCollection(\vxDeltaField::class, [
+                'delta' => $deltaId,
+            ]);
+            foreach ($fields as $field) {
+                $resource->set($field->get('field'), $field->get('before'));
+            }
+            $resource = $previewType->afterRevert(RevertAction::DELTA, $fields, $resource, $now);
+        }
+        elseif ($properties['revert'] === 'pit') {
+            // Get the first version of every field after the "time_end" on the selected delta
+            $fields = [];
+            foreach ($versionX->deltas()->getClosestDeltaFields($previewType, $resource, [], $delta->get('time_start')) as $item) {
+                $fields[$item->get('field')] = $item;
+            }
+            // Apply the field values to the object
+            // We want to revert to all fields to the after value of a specific point in time.
+            foreach ($fields as $field) {
+                $resource->set($field->get('field'), $field->get('before'));
+            }
+        }
+
+        break;
 }
 
 return true;

core/components/versionx/lexicon/cs/default.inc.php

@@ -24,6 +24,7 @@
 $_lang['versionx.deltas.milestone'] = 'milestone';
 $_lang['versionx.deltas.milestone_remove'] = 'Remove milestone status from delta';
 $_lang['versionx.deltas.milestone_make'] = 'Make this delta a milestone';
+$_lang['versionx.deltas.preview'] = 'Preview';
 $_lang['versionx.deltas.revert_these_changes'] = 'Revert these changes';
 
 // Grid filters

core/components/versionx/lexicon/da/default.inc.php

@@ -24,6 +24,7 @@
 $_lang['versionx.deltas.milestone'] = 'milestone';
 $_lang['versionx.deltas.milestone_remove'] = 'Remove milestone status from delta';
 $_lang['versionx.deltas.milestone_make'] = 'Make this delta a milestone';
+$_lang['versionx.deltas.preview'] = 'Preview';
 $_lang['versionx.deltas.revert_these_changes'] = 'Revert these changes';
 
 // Grid filters

core/components/versionx/lexicon/de/default.inc.php

@@ -27,6 +27,7 @@
 $_lang['versionx.deltas.milestone'] = 'milestone';
 $_lang['versionx.deltas.milestone_remove'] = 'Remove milestone status from delta';
 $_lang['versionx.deltas.milestone_make'] = 'Make this delta a milestone';
+$_lang['versionx.deltas.preview'] = 'Preview';
 $_lang['versionx.deltas.revert_these_changes'] = 'Revert these changes';
 
 // Grid filters

core/components/versionx/lexicon/en/default.inc.php

@@ -27,6 +27,7 @@
 $_lang['versionx.deltas.milestone'] = 'milestone';
 $_lang['versionx.deltas.milestone_remove'] = 'Remove milestone status from delta';
 $_lang['versionx.deltas.milestone_make'] = 'Make this delta a milestone';
+$_lang['versionx.deltas.preview'] = 'Preview';
 $_lang['versionx.deltas.revert_these_changes'] = 'Revert these changes';
 
 // Grid filters

core/components/versionx/lexicon/fr/default.inc.php

@@ -24,6 +24,7 @@
 $_lang['versionx.deltas.milestone'] = 'milestone';
 $_lang['versionx.deltas.milestone_remove'] = 'Remove milestone status from delta';
 $_lang['versionx.deltas.milestone_make'] = 'Make this delta a milestone';
+$_lang['versionx.deltas.preview'] = 'Preview';
 $_lang['versionx.deltas.revert_these_changes'] = 'Revert these changes';
 
 // Grid filters

core/components/versionx/lexicon/nl/default.inc.php

@@ -24,6 +24,7 @@
 $_lang['versionx.deltas.milestone'] = 'milestone';
 $_lang['versionx.deltas.milestone_remove'] = 'Remove milestone status from delta';
 $_lang['versionx.deltas.milestone_make'] = 'Make this delta a milestone';
+$_lang['versionx.deltas.preview'] = 'Preview';
 $_lang['versionx.deltas.revert_these_changes'] = 'Revert these changes';
 
 // Grid filters

core/components/versionx/lexicon/ru/default.inc.php

@@ -24,6 +24,7 @@
 $_lang['versionx.deltas.milestone'] = 'milestone';
 $_lang['versionx.deltas.milestone_remove'] = 'Remove milestone status from delta';
 $_lang['versionx.deltas.milestone_make'] = 'Make this delta a milestone';
+$_lang['versionx.deltas.preview'] = 'Preview';
 $_lang['versionx.deltas.revert_these_changes'] = 'Revert these changes';
 
 // Grid filters

core/components/versionx/lexicon/sv/default.inc.php

@@ -24,6 +24,7 @@
 $_lang['versionx.deltas.milestone'] = 'milestone';
 $_lang['versionx.deltas.milestone_remove'] = 'Remove milestone status from delta';
 $_lang['versionx.deltas.milestone_make'] = 'Make this delta a milestone';
+$_lang['versionx.deltas.preview'] = 'Preview';
 $_lang['versionx.deltas.revert_these_changes'] = 'Revert these changes';
 
 // Grid filters

core/components/versionx/processors/mgr/deltas/getlist.class.php

@@ -10,6 +10,9 @@ class VersionXDeltasGetlistProcessor extends modObjectGetListProcessor {
     public \modmore\VersionX\VersionX $versionX;
     public \modmore\VersionX\Types\Type $type;
 
+    /** @var bool $magicPreviewLoaded - if set to true, delta previews will be activated */
+    protected bool $magicPreviewLoaded = false;
+
     public function initialize(): bool
     {
         $init = parent::initialize();
@@ -26,6 +29,8 @@ public function initialize(): bool
             'template_dir' => $this->versionX->config['templates_path'],
         ]);
 
+        $this->magicPreviewLoaded = $this->versionX->magicPreviewLoaded();
+
         return $init;
     }
 
@@ -119,6 +124,9 @@ public function prepareRow(xPDOObject $object): array
 
         $row = $object->toArray();
 
+        // Flag if MagicPreview is loaded so preview buttons can be used
+        $row['show_previews'] = $this->magicPreviewLoaded;
+
         $diffFile = $this->versionX->config['templates_path'] . 'mgr/diff.tpl';
         if (!file_exists($diffFile)) {
             return [];

core/components/versionx/processors/mgr/deltas/preview.class.php

@@ -0,0 +1,41 @@
+<?php
+
+class VersionXRevertPreviewProcessor extends modProcessor
+{
+    public \modmore\VersionX\VersionX $versionX;
+    public ?\MagicPreview $magicPreview = null;
+
+    public function initialize()
+    {
+        $init = parent::initialize();
+        $path = $this->modx->getOption(
+            'magicpreview.core_path',
+            null,
+            $this->modx->getOption('core_path') . 'components/magicpreview/'
+        );
+        $this->magicPreview ??= $this->modx->getService(
+            'magicpreview',
+            'MagicPreview',
+            $path . '/model/magicpreview/'
+        );
+
+        return $init;
+    }
+
+    public function process()
+    {
+        $resource = $this->modx->getObject(modResource::class, ['id' => $this->getProperty('id')]);
+        if (!$resource) {
+            return $this->failure('Resource not found');
+        }
+
+        $properties = array_merge($this->properties, $resource->toArray());
+        /** @var modProcessorResponse $response */
+        $response = $this->modx->runProcessor('resource/preview', $properties, [
+            'processors_path' => $this->magicPreview->config['processorsPath'],
+        ]);
+
+        return $this->success('wooo', $response->getResponse()['object']);
+    }
+}
+return 'VersionXRevertPreviewProcessor';

core/components/versionx/src/Types/Resource.php

@@ -143,7 +143,8 @@ public function afterRevert(string $action, array $fields, \xPDOObject $object,
             $this->revertTVValues($field, $object, $tvs);
         }
 
-        if (!$object->save(true)) {
+        // Skip saving if not allowed e.g. in ResourcePreview
+        if ($this->persistChanges && !$object->save(true)) {
             $this->modx->log(MODX_LOG_LEVEL_ERROR,
                 '[VersionX] Error saving ' . get_class($object) . ' with id: ' . $object->get('id'));
         }
@@ -170,7 +171,11 @@ protected function revertTVValues(\vxDeltaField $field, \xPDOObject $object, arr
                 ]);
 
                 $tvObj->set('value', $field->get('before'));
-                $tvObj->save();
+
+                // Skip saving if not allowed e.g. in ResourcePreview
+                if ($this->persistChanges) {
+                    $tvObj->save();
+                }
             }
         }
     }

core/components/versionx/src/Types/ResourcePreview.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace modmore\VersionX\Types;
+
+class ResourcePreview extends Resource
+{
+    protected bool $persistChanges = false;
+}