Upgrade on October CMS 4.x

- harmonized with Laravel 12 and October CMS 4,
- removed Doctrine at all,
- added automatic backup using prepared URL for external cron jobs,
- added the ability to backup more than the default theme.
---------
Co-authored-by: Jan Vince <jan@vince.cz>

Author: Rike-cz

Plugin.php

@@ -44,20 +44,20 @@ public function register()
      */
     public function registerSchedule($schedule)
     {
-        if (Models\Settings::get('db_auto')) {
+        if (Models\Settings::get('db_mode') == 'schedule') {
             // $schedule->command('smallbackup:db')->daily();
             // Workaround because of shared hostings disables proc_open
             $schedule->call(function () {
                 Artisan::call('smallbackup:db');
             })->daily();
         }
-        if (Models\Settings::get('theme_auto')) {
+        if (Models\Settings::get('theme_mode') == 'schedule') {
             // $schedule->command('smallbackup:theme')->daily();
             $schedule->call(function () {
                 Artisan::call('smallbackup:theme');
             })->daily();
         }
-        if (Models\Settings::get('storage_auto')) {
+        if (Models\Settings::get('storage_mode') == 'schedule') {
             // $schedule->command('smallbackup:storage')->daily();
             $schedule->call(function () {
                 Artisan::call('smallbackup:storage');
@@ -80,7 +80,7 @@ public function registerSettings()
                 'icon' => 'icon-database',
                 'class' => Models\Settings::class,
                 'url' => \Backend::url('webula/smallbackup/settings/update'),
-                'keywords' => 'database backup',
+                'keywords' => 'backup database theme storage',
                 'order' => 991,
                 'permissions' => ['webula.smallbackup.access_settings'],
             ]

README.md

@@ -1,6 +1,11 @@
 # Small Backup
 > Simple backup for database (MySQL, SQLite), active theme and CMS storages
 
+## Compatibility
+
+* plugin in version from 2.0.0. is intended **only for OctoberCMS v4 and newer**
+* [older versions](https://github.com/webula-cz/smallbackup/tree/v1) (1.x.x) will run fine only on OctoberCMS v1, v2 and v3
+
 
 ## Installation
 
@@ -61,7 +66,18 @@ There are default scheduler jobs for database and active theme to be backed up o
 
 ### Automatic backup (without scheduler)
 
-If you cannot run Cron command directly on your server/hosting, you can create custom CMS page like this:
+If you cannot run Cron command directly on your server/hosting, you can:
+
+#### Use prepared URL
+
+In plugin's backend settings page go to Settings tab and copy fixed part of the URL (which can be changed in plugin's `config/config.php` file) and a variable part (which can be changed here in Settings tab).
+
+The final URL is in form: `https://www.domain.com/webula/smallbackup/run/trigger-46d62cbc-5e27-4bb0-87dd-19bb0012345678`
+
+Don't forget to allow backups from external URL in plugin's settings tabs (Database, Theme, Storage).
+
+#### Use custom CMS page
+
 
 ```
 title = "artisan"
@@ -82,7 +98,7 @@ is_hidden = 0
 
 ### Manual backup
 
-You can create manual backup in plugin's Settings by clicking button `Backup now` on Database or Theme tab.
+You can create manual backup in plugin's Settings by clicking button `Backup now` on Database, Theme or Storage tab.
 
 #### Console commands
 

classes/DbBackupManager.php

@@ -34,8 +34,7 @@ public function backup(string $resource = null, bool $once = false): string
             if (!$once || !File::exists($this->getUseCompression() ? $pathname . '.zip' : $pathname)) {
                 $stream = (new Drivers\Mysql(
                         Db::connection($connectionName),
-                        $this->getExcludedTables(),
-                        $this->getCustomMapping()
+                        $this->getExcludedTables()
                     ))->backupStream();
                 File::put(
                     $pathname,
@@ -95,14 +94,4 @@ protected function getUseCompression(): bool
     {
         return boolval(Settings::get('db_use_compression'));
     }
-
-    /**
-     * Get custom columns mapping for db backup
-     *
-     * @return array
-     */
-    protected function getCustomMapping(): array
-    {
-        return array_pluck((array)Settings::get('db_custom_mapping'), 'doctrine_type', 'db_type');
-    }
 }

classes/ThemeBackupManager.php

@@ -3,6 +3,7 @@
 use File;
 use Exception;
 use Cms\Classes\Theme;
+use Webula\SmallBackup\Models\Settings;
 use October\Rain\Filesystem\Zip;
 
 class ThemeBackupManager extends BackupManager
@@ -15,30 +16,54 @@ class ThemeBackupManager extends BackupManager
     protected $prefix = 'wsb-theme-';
 
     /**
-     * Backup Theme(s) by connection name (null = default)
+     * Backup Theme(s) by connection name (null = default + included)
      *
      * @param string|null $resource
      * @param bool $once do not overwrite existing backup file
      * @return string backup file
      */
     public function backup(string $resource = null, bool $once = false): string
     {
-        $themeName = $resource ?: Theme::getActiveThemeCode();
+        if ($resource) {
+            $themes[] = $resource;
+        } else {
+            $themes = [
+                Theme::getActiveThemeCode(),
+                ...$this->getAdditionalThemes()
+            ];
+        }
 
-        if ($themeName && File::isDirectory(themes_path($themeName))) {
-            $filename = $this->prefix . str_slug($themeName) . '-' . now()->format('Y-m-d') . '.zip';
-            $pathname = $this->folder . DIRECTORY_SEPARATOR . $filename;
+        $pathnames = [];
+        foreach ($themes as $themeName) {
+            if ($themeName && File::isDirectory(themes_path($themeName))) {
+                $filename = $this->prefix . str_slug($themeName) . '-' . now()->format('Y-m-d') . '.zip';
+                $pathname = $this->folder . DIRECTORY_SEPARATOR . $filename;
 
-            if (!$once || !File::exists($pathname)) {
-                Zip::make(
-                    $pathname,
-                    themes_path($themeName)
-                );
+                if (!$once || !File::exists($pathname)) {
+                    Zip::make(
+                        $pathname,
+                        themes_path($themeName)
+                    );
+                }
+                $pathnames[] = $pathname;
+            } else {
+                throw new Exception(trans('webula.smallbackup::lang.backup.flash.unknown_theme', ['theme' => $themeName]));
             }
-
-            return $pathname;
-        } else {
-            throw new Exception(trans('webula.smallbackup::lang.backup.flash.unknown_theme', ['theme' => $themeName]));
         }
+
+        return implode(', ', $pathnames);
+    }
+
+    /**
+     * Get list of additional themes for theme backup
+     *
+     * @return array
+     */
+    protected function getAdditionalThemes(): array
+    {
+        $data = Settings::get('theme_additional_themes');
+        return $data
+            ? (is_array($data) ? $data : explode(',', $data))
+            : [];
     }
 }

classes/drivers/Mysql.php

@@ -19,12 +19,10 @@ class Mysql implements Contracts\BackupStream
     protected $excludedTables = [];
 
 
-    public function __construct(Connection $connection, array $excludedTables = [], array $customMapping = [])
+    public function __construct(Connection $connection, array $excludedTables = [])
     {
         $this->connection = $connection;
         $this->excludedTables = $excludedTables;
-
-        $this->syncPlatformMapping($customMapping);
     }
 
     /**
@@ -39,13 +37,7 @@ public function backupStream(): string
             $this->line() . PHP_EOL
         ;
 
-        $tables = collect($this->getListOfTables())
-            ->map(function ($item) {
-                return $item->getName();
-            })
-            ->diff($this->excludedTables)
-            ->toArray();
-
+        $tables = array_diff($this->getListOfTables(), $this->excludedTables);
         foreach ($tables as $table) {
             $stream .= $this->comment('Table structure: ' . $this->wrapTable($table)) . PHP_EOL .
                 $this->getDropTableStatement($table) . PHP_EOL .
@@ -56,13 +48,7 @@ public function backupStream(): string
             ;
         }
 
-        $views = collect($this->getListOfViews())
-            ->map(function ($item) {
-                return $item->getName();
-            })
-            ->diff($this->excludedTables)
-            ->toArray();
-
+        $views = array_diff($this->getListOfViews(), $this->excludedTables);
         foreach ($views as $view) {
             $stream .= $this->comment('View structure: ' . $this->wrapTable($view)) . PHP_EOL .
                 $this->getDropViewStatement($view) . PHP_EOL .
@@ -250,7 +236,8 @@ protected function getDatabaseName(): string
      */
     protected function getListOfTables(): array
     {
-        return $this->connection->getDoctrineSchemaManager()->listTables();
+        $list = $this->connection->getSchemaBuilder()->getTables($this->getDatabaseName());
+        return array_column($list, 'name');
     }
 
     /**
@@ -260,7 +247,8 @@ protected function getListOfTables(): array
      */
     protected function getListOfViews(): array
     {
-        return $this->connection->getDoctrineSchemaManager()->listViews();
+        $list = $this->connection->getSchemaBuilder()->getViews($this->getDatabaseName());
+        return array_column($list, 'name');
     }
 
     /**
@@ -271,11 +259,8 @@ protected function getListOfViews(): array
      */
     protected function getListOfColumns(string $table): array
     {
-        return collect($this->connection->getDoctrineSchemaManager()->listTableColumns($table))
-            ->map(function ($item) {
-                return $item->getName();
-            })
-            ->toArray();
+        $list = $this->connection->getSchemaBuilder()->getColumns($table);
+        return array_column($list, 'name');
     }
 
     /**
@@ -289,29 +274,6 @@ protected function getCharset(): string
     }
 
 
-    /**
-     * Sync doctrine platform mapping
-     *
-     * @param array $customMapping [original_type => backup_type]
-     * @return void
-     */
-    protected function syncPlatformMapping(array $customMapping = []): void
-    {
-        $platform = $this->connection->getDoctrineSchemaManager()->getDatabasePlatform();
-        if (!$platform->hasDoctrineTypeMappingFor('json')) {
-            $platform->registerDoctrineTypeMapping('json', 'text');
-        }
-        if (!$platform->hasDoctrineTypeMappingFor('enum')) {
-            $platform->registerDoctrineTypeMapping('enum', 'string');
-        }
-        if (!empty($customMapping)) {
-            foreach ($customMapping as $db_type => $doctrine_type) {
-                $platform->registerDoctrineTypeMapping($db_type, $doctrine_type);
-            }
-        }
-    }
-
-
     /**
      * Wrap table/database name
      *

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "webula/smallbackup-plugin",
-    "description": "Backup databases and theme",
+    "description": "Backup OctoberCMS databases, themes and storages",
     "homepage": "https://www.webula.cz",
     "type": "october-plugin",
     "authors": [
@@ -17,7 +17,8 @@
         }
     ],
     "require": {
-        "php": ">=7.2",
+        "php": "^8.2",
+        "october/rain": "^4.0",
         "composer/installers": "~1.0"
     },
     "autoload" : {

config/config.php

@@ -0,0 +1,6 @@
+<?php
+return [
+    'trigger' => [
+        'url_prefix' => 'webula/smallbackup/run/',
+    ],
+];