New disableRestore setting

New setting that allows the restore functionality to be disabled. For example, enables Craft admins to disable restore on one environment, like production, to avoid accidental overwrites.
timmyomahony · Mar 19, 2024 · 4684f74 · 4684f74
1 parent ff7aae3
commit 4684f74
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 3 deletions.
diff --git a/src/config/remote-sync.example.php b/src/config/remote-sync.example.php
@@ -24,9 +24,15 @@
         'hideDatabases' => false,
 
         // Hide the volume sync panel on the utilities page
-        'hideVolumes' => false
+        'hideVolumes' => false,
+
+        // Enable pull and restore functionality
+        'disableRestore' => false,
     ],
     'dev' => [],
     'staging' => [],
-    'production' => [],
+    'production' => [
+        // Disable pull and restore only in production environment
+        'disableRestore' => true,
+    ],
 ];
diff --git a/src/controllers/RemoteSyncController.php b/src/controllers/RemoteSyncController.php
@@ -199,6 +199,10 @@ public function actionPullDatabase()
         $plugin = RemoteSync::getInstance();
         $settings = $plugin->getSettings();
 
+        if ($settings->disableRestore) {
+            return $this->asErrorJson(Craft::t('remote-sync', 'Restore not enabled for this environment'));
+        }
+
         try {
             if ($settings->useQueue) {
                 Craft::$app->queue->push(new PullDatabaseJob([
@@ -231,6 +235,10 @@ public function actionPullVolume()
         $plugin = RemoteSync::getInstance();
         $settings = $plugin->getSettings();
 
+        if ($settings->disableRestore) {
+            return $this->asErrorJson(Craft::t('remote-sync', 'Restore not enabled for this environment'));
+        }
+
         try {
             if ($settings->useQueue) {
                 Craft::$app->queue->push(new PullVolumeJob([

diff --git a/src/models/Settings.php b/src/models/Settings.php
@@ -16,7 +16,7 @@ public function rules(): array
         $rules = parent::rules();
         return $rules + [
             [
-                ['keepEmergencyBackup', 'prune'],
+                ['disableRestore', 'keepEmergencyBackup', 'prune'],
                 'boolean'
             ],
             [

diff --git a/src/templates/utilities/_includes/_remote-sync-section.html b/src/templates/utilities/_includes/_remote-sync-section.html
@@ -28,7 +28,9 @@ <h2 data-icon="{{ icon }}">{{ "Remote " ~ labelPlural|t('remote-sync') }}</h2>
                 <td></td>
                 <td></td>
                 <td class="thin">
+                {% if not disableRestore %}
                     <button class="btn small pull-button" title="{{ 'Pull and restore ' ~ label|lower|t }}">{{ 'Restore'|t }}</button>
+                {% endif %}
                     <button class="btn small delete-button" title="{{ 'Delete ' ~ label|lower|t }}">{{ 'Delete'|t }}</button>
                 </td>
             </tr>

diff --git a/src/templates/utilities/remote-sync.html b/src/templates/utilities/remote-sync.html
@@ -45,6 +45,7 @@
                     pushAction: 'remote-sync/remote-sync/push-database',
                     pullAction: 'remote-sync/remote-sync/pull-database',
                     deleteAction: 'remote-sync/remote-sync/delete-database',
+                    disableRestore: disableRestore,
                     disabled: false
                 } %}
             {% endif %}
@@ -62,6 +63,7 @@
                     pushAction: 'remote-sync/remote-sync/push-volume',
                     pullAction: 'remote-sync/remote-sync/pull-volume',
                     deleteAction: 'remote-sync/remote-sync/delete-volume',
+                    disableRestore: disableRestore,
                     disabled: not haveVolumes
                 } %}
                     {% block message %}

diff --git a/src/utilities/RemoteSyncUtility.php b/src/utilities/RemoteSyncUtility.php
@@ -47,6 +47,7 @@ public static function contentHtml(): string
             "hideDatabases" => $settings->hideDatabases,
             "hideVolumes" => $settings->hideVolumes,
             "haveVolumes" => !$settings->hideVolumes && $haveVolumes,
+            "disableRestore" => $settings->disableRestore,
             "queueActive" => $queueActive
         ]);
     }