New disableRestore setting

composer.json

@@ -26,7 +26,7 @@
         "weareferal/remote-core": "4.1.2"
     },
     "require-dev": {
-        "phpstan/phpstan": "1.8.x-dev",
+        "phpstan/phpstan": "1.11.x-dev",
         "craftcms/phpstan": "dev-main",
         "craftcms/rector": "dev-main"
     },

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,
+    ],
 ];

src/console/controllers/DatabaseController.php

@@ -119,6 +119,9 @@ public function actionPull($filename)
             $this->requirePluginEnabled();
             $this->requirePluginConfigured();
             $startTime = microtime(true);
+            if (RemoteSync::getInstance()->getSettings()->disableRestore) {
+                throw new \Exception(Craft::t('remote-sync', 'Restore not enabled for this environment'));
+            }
             RemoteSync::getInstance()->provider->pullDatabase($filename);
             $this->stdout("Pulled and restored remote database:" . PHP_EOL, Console::FG_GREEN);
             $this->stdout("- " . $filename . PHP_EOL);

src/console/controllers/VolumeController.php

@@ -123,6 +123,9 @@ public function actionPull($filename)
             $this->requirePluginEnabled();
             $this->requirePluginConfigured();
             $startTime = microtime(true);
+            if (RemoteSync::getInstance()->getSettings()->disableRestore) {
+                throw new \Exception(Craft::t('remote-sync', 'Restore not enabled for this environment'));
+            }
             RemoteSync::getInstance()->provider->pullVolume($filename);
             $this->stdout("Pulled and restored remote volume:" . PHP_EOL, Console::FG_GREEN);
             $this->stdout("- " . $filename . PHP_EOL);

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([

src/migrations/m240319_070857_add_disable_restore_setting.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace weareferal\remotesync\migrations;
+
+use Craft;
+use craft\db\Migration;
+
+/**
+ * m240319_070857_add_disable_restore_setting migration.
+ */
+class m240319_070857_add_disable_restore_setting extends Migration
+{
+    /**
+     * @inheritdoc
+     */
+    public function safeUp(): bool
+    {
+        // Create the disableRestore setting, if it doesn't already exist
+        $remoteSync = Craft::$app->plugins->getPlugin("remote-sync");
+        $settings = $remoteSync->getSettings();
+        if (!property_exists($settings, 'disableRestore')) {
+            Craft::$app->getPlugins()->savePluginSettings($remoteSync, [
+                'disableRestore' => 'boolean',
+            ]);
+        }
+        return true;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function safeDown(): bool
+    {
+        return true;
+    }
+}

src/models/Settings.php

@@ -7,6 +7,7 @@
 
 class Settings extends BaseSettings
 {
+    public $disableRestore = false;
     public $keepEmergencyBackup = true;
     public $prune = false;
     public $pruneLimit = 10;
@@ -16,7 +17,7 @@ public function rules(): array
         $rules = parent::rules();
         return $rules + [
             [
-                ['keepEmergencyBackup', 'prune'],
+                ['disableRestore', 'keepEmergencyBackup', 'prune'],
                 'boolean'
             ],
             [

src/templates/settings.twig

@@ -36,4 +36,14 @@
         errors: settings.getErrors('keepEmergencyBackup'),
         warning: configWarning('keepEmergencyBackup', 'remote-sync')
     }) }}
+
+    {{ forms.lightswitchField({
+        label: "Disable pull and restore"|t('remote-sync'),
+        instructions: "Disable pulling & restoring for this environment."|t('remote-sync'),
+        name: 'disableRestore',
+        id: 'disableRestore',
+        on: settings.disableRestore,
+        errors: settings.getErrors('disableRestore'),
+        warning: configWarning('disableRestore', 'remote-sync')
+    }) }}
 {% endblock %}

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>

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 %}

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
         ]);
     }