initial commit

rafaucau · rafaucau · commit ae91014152f2 · 2025-01-23T12:23:01.000+01:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,15 @@
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.{diff,md}]
+trim_trailing_whitespace = false
+
+[*.{php,xml,json}]
+indent_size = 4
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,20 @@
+**/.gitattributes export-ignore
+**/.gitignore export-ignore
+**/.gitmodules export-ignore
+**/.github export-ignore
+**/.travis export-ignore
+**/.travis.yml export-ignore
+**/.editorconfig export-ignore
+**/.styleci.yml export-ignore
+
+**/phpunit.xml export-ignore
+**/tests export-ignore
+
+**/js/dist/**/* -diff
+**/js/dist/**/* linguist-generated
+**/js/dist-typings/**/* -diff
+**/js/dist-typings/**/* linguist-generated
+**/js/yarn.lock -diff
+**/js/package-lock.json -diff
+
+* text=auto eol=lf
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1 @@
+github: [android-com-pl, rafaucau]
diff --git a/.github/workflows/backend.yml b/.github/workflows/backend.yml
@@ -0,0 +1,13 @@
+name: Flarum DB Dumper PHP
+
+on: [workflow_dispatch, push, pull_request]
+
+jobs:
+  run:
+    uses: flarum/framework/.github/workflows/REUSABLE_backend.yml@1.x
+    with:
+      enable_backend_testing: false
+      enable_phpstan: false
+      php_versions: '["8.1", "8.2", "8.3", "8.4"]'
+
+      backend_directory: .
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+.idea
+.vscode
+.fleet
+
+/vendor
+composer.lock
diff --git a/.styleci.yml b/.styleci.yml
@@ -0,0 +1,14 @@
+preset: recommended
+
+enabled:
+  - logical_not_operators_with_successor_space
+
+disabled:
+  - align_double_arrow
+  - blank_line_after_opening_tag
+  - multiline_array_trailing_comma
+  - new_with_braces
+  - phpdoc_align
+  - phpdoc_order
+  - phpdoc_separation
+  - phpdoc_types
diff --git a/README.md b/README.md
@@ -0,0 +1,47 @@
+# Flarum DB Dumper
+
+Database backup extension for Flarum that allows dumping database content using the `db:dump` command.
+
+## Installation
+
+```sh
+composer require acpl/flarum-db-dumper
+```
+
+## Usage
+
+Basic usage:
+```sh
+# Dump to storage/dumps/dump-YYYY-MM-DD-HHMMSS.sql
+php flarum db:dump
+
+# Dump to specific path/file
+php flarum db:dump /path/to/backup.sql
+php flarum db:dump ../backups/forum.sql
+
+# Dump with compression (based on extension)
+php flarum db:dump /backups/dump.sql.gz   # gzip compression
+php flarum db:dump /backups/dump.sql.bz2  # bzip2 compression
+```
+
+### Options
+
+- `--compress`: Use compression (`gz` or `bz2`), e.g. `--compress=gz` for gzip
+- `--include-tables=table1,table2`: Include only specific tables
+- `--exclude-tables=table1,table2`: Exclude specific tables
+- `--skip-structure`: Skip table structure
+- `--no-data`: Skip table data, dump only structure
+- `--skip-auto-increment`: Skip AUTO_INCREMENT values
+- `--no-column-statistics`: Disable column statistics (for MySQL 8 compatibility)
+- `--binary-path=/path/to/binary`: Custom mysqldump binary location
+
+## Requirements
+
+- `mysqldump` binary
+- `gzip` for `.gz` compression
+- `bzip2` for `.bz2` compression
+
+## Links
+
+- [Packagist](https://packagist.org/packages/acpl/flarum-db-dumper)
+- [GitHub](https://github.com/android-com-pl/flarum-db-dumper)
diff --git a/composer.json b/composer.json
@@ -0,0 +1,57 @@
+{
+    "name": "acpl/flarum-db-dumper",
+    "description": "Dump the contents of a Flarum database",
+    "type": "flarum-extension",
+    "homepage": "https://github.com/android-com-pl/flarum-db-dumper",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Rafał Całka",
+            "homepage": "https://github.com/rafaucau",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": ">=8.1",
+        "flarum/core": "^1.8",
+        "spatie/db-dumper": "^3.7"
+    },
+    "autoload": {
+        "psr-4": {
+            "ACPL\\FlarumDbDumper\\": "src/"
+        }
+    },
+    "extra": {
+        "flarum-extension": {
+            "title": "DB Dumper",
+            "category": "feature",
+            "icon": {
+                "name": "fas fa-database",
+                "backgroundColor": "#0F9D58",
+                "color": "#fff"
+            }
+        },
+        "flarum-cli": {
+            "modules": {
+                "admin": false,
+                "forum": false,
+                "js": false,
+                "jsCommon": false,
+                "gitConf": true,
+                "githubActions": true,
+                "prettier": false,
+                "typescript": false,
+                "bundlewatch": false,
+                "backendTesting": false,
+                "editorConfig": true,
+                "styleci": true,
+                "css": false
+            }
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "config": {
+        "sort-packages": true
+    }
+}
diff --git a/extend.php b/extend.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace ACPL\FlarumDbDumper;
+
+use Flarum\Extend;
+
+return [
+    (new Extend\Console())->command(DumbDbCommand::class),
+];
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,12 @@
+includes:
+  - vendor/flarum/phpstan/extension.neon
+
+parameters:
+  level: 5
+  paths:
+    - src
+    - extend.php
+  excludePaths:
+    - *.blade.php
+  checkMissingIterableValueType: false
+  databaseMigrationsPath: ['migrations']
diff --git a/src/DumbDbCommand.php b/src/DumbDbCommand.php
@@ -0,0 +1,163 @@
+<?php
+
+namespace ACPL\FlarumDbDumper;
+
+use Carbon\Carbon;
+use Exception;
+use Flarum\Console\AbstractCommand;
+use Flarum\Foundation\{Config, Paths};
+use Spatie\DbDumper\Databases\MySql;
+use Spatie\DbDumper\Compressors\{GzipCompressor, Bzip2Compressor};
+use Spatie\DbDumper\Exceptions\CannotSetParameter;
+use Symfony\Component\Console\Input\{InputArgument, InputOption};
+
+class DumbDbCommand extends AbstractCommand
+{
+    private const COMPRESSORS = [
+        'gz' => GzipCompressor::class,
+        'bz2' => Bzip2Compressor::class,
+    ];
+
+    public function __construct(protected Config $config, protected Paths $paths)
+    {
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setName('db:dump')
+            ->setDescription('Dump the contents of a database')
+            ->addArgument(
+                'path',
+                InputArgument::OPTIONAL,
+                'Path where to store the dump file',
+            )
+            ->addOption(
+                'compress',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'Compression type (gz, bz2)',
+            )
+            ->addOption(
+                'binary-path',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'Custom location for the mysqldump binary',
+            )
+            ->addOption(
+                'include-tables',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'Comma separated list of tables to include in the dump',
+            )
+            ->addOption(
+                'exclude-tables',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'Comma separated list of tables to exclude from the dump',
+            )
+            ->addOption(
+                'skip-structure',
+                null,
+                InputOption::VALUE_NONE,
+                'Skip table structure (CREATE TABLE statements)',
+            )
+            ->addOption(
+                'no-data',
+                null,
+                InputOption::VALUE_NONE,
+                'Do not write row data',
+            )
+            ->addOption(
+                'skip-auto-increment',
+                null,
+                InputOption::VALUE_NONE,
+                'Skip AUTO_INCREMENT values from the dump',
+            )
+            ->addOption(
+                'no-column-statistics',
+                null,
+                InputOption::VALUE_NONE,
+                'Do not use column statistics (for MySQL 8 compatibility with older versions)',
+            );
+    }
+
+    /**
+     * @throws CannotSetParameter
+     */
+    protected function fire(): int
+    {
+        $dbConfig = $this->config['database'];
+        $dumper = MySql::create()
+            ->setHost($dbConfig['host'])
+            ->setDbName($dbConfig['database'])
+            ->setPort($dbConfig['port'] ?? 3306)
+            ->setUserName($dbConfig['username'])
+            ->setPassword($dbConfig['password']);
+
+        $path = $this->input->getArgument('path');
+        if (empty($path)) {
+            $path = $this->paths->storage.'/dumps/dump-'.Carbon::now()->format('Y-m-d-His').'.sql';
+        }
+
+        $compression = $this->input->getOption('compress');
+        $extension = pathinfo($path, PATHINFO_EXTENSION);
+        // If compression is specified and different from path extension
+        if ($compression && $extension !== $compression) {
+            $path .= '.'.$compression;
+        } elseif (! $extension) {
+            $path .= '.sql';
+        }
+
+        $finalExtension = pathinfo($path, PATHINFO_EXTENSION);
+        if (isset(self::COMPRESSORS[$finalExtension])) {
+            $compressorClass = self::COMPRESSORS[$finalExtension];
+            $dumper->useCompressor(new $compressorClass());
+        }
+
+        $dir = dirname($path);
+        if (! file_exists($dir)) {
+            mkdir($dir, 0755, true);
+        }
+
+
+        if ($binaryPath = $this->input->getOption('binary-path')) {
+            $dumper->setDumpBinaryPath($binaryPath);
+        }
+
+        if ($includeTables = $this->input->getOption('include-tables')) {
+            $dumper->includeTables(explode(',', $includeTables));
+        }
+
+        if ($excludeTables = $this->input->getOption('exclude-tables')) {
+            $dumper->excludeTables(explode(',', $excludeTables));
+        }
+
+        if ($this->input->getOption('skip-structure')) {
+            $dumper->doNotCreateTables();
+        }
+
+        if ($this->input->getOption('no-data')) {
+            $dumper->doNotDumpData();
+        }
+
+        if ($this->input->getOption('skip-auto-increment')) {
+            $dumper->skipAutoIncrement();
+        }
+
+        if ($this->input->getOption('no-column-statistics')) {
+            $dumper->doNotUseColumnStatistics();
+        }
+
+        try {
+            $dumper->dumpToFile($path);
+            $this->info("Database dumped successfully to: $path");
+        } catch (Exception $e) {
+            $this->error('Failed to dump database: '.$e->getMessage());
+            return 1;
+        }
+
+        return 0;
+    }
+}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +.idea
 +.vscode
 +.fleet
++
 +/vendor
 +composer.lock