mirror/FreshRSS
0
0
Fork 0
mirror of https://github.com/FreshRSS/FreshRSS.git synced 2026-05-14 18:23:52 -04:00
Code Issues Packages Projects Releases Wiki Activity

feat(cli): automatic periodic SQLite export with retention (#8819)

Browse Source 
Add an opt-in CLI that exports each user's database to
`data/users/<user>/sqlite-backups/<YYYYMMDDTHHMMSSZ>.sqlite` (UTC) and
prunes older files to a configured count. Gated by two new settings,
`auto_sqlite_export.enabled` and `auto_sqlite_export.retention`.

Kept separate from `cli/db-backup.php` / `cli/db-restore.php`, which
stay the fixed-filename migration tool. First step of #8183.

Co-authored-by: Bjørn A. Andersen <polybjorn@users.noreply.github.com>
This commit is contained in:
polybjorn
2026-05-12 06:44:00 +00:00
committed by GitHub
parent 557e190a40
commit d74337deb6
5 changed files with 110 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
cli/export-sqlite-auto.php Executable file
View File

@@ -0,0 +1,75 @@
#!/usr/bin/env php
<?php
declare(strict_types=1);
require __DIR__ . '/_cli.php';
performRequirementCheck(FreshRSS_Context::systemConf()->db['type'] ?? '');
$cliOptions = new class extends CliOptionsParser {
public bool $quiet;
public function __construct() {
$this->addOption('quiet', (new CliOption('quiet', 'q'))->withValueNone());
parent::__construct();
}
};
if (!empty($cliOptions->errors)) {
fail('FreshRSS error: ' . array_shift($cliOptions->errors) . "\n" . $cliOptions->usage);
}
$config = FreshRSS_Context::systemConf()->auto_sqlite_export;
$enabled = !empty($config['enabled']);
$retention = max(1, (int)($config['retention'] ?? 7));
$verbose = !$cliOptions->quiet;
if (!$enabled) {
if ($verbose) {
echo "FreshRSS automatic SQLite export is disabled (see `auto_sqlite_export.enabled` in `data/config.php`).\n";
}
exit(0);
}
$ok = true;
$timestamp = gmdate('Ymd\THis\Z');
foreach (FreshRSS_user_Controller::listUsers() as $username) {
$username = cliInitUser($username);
$exportDir = DATA_PATH . '/users/' . $username . '/sqlite-backups';
if (!is_dir($exportDir) && !@mkdir($exportDir, 0755, true)) {
fwrite(STDERR, "FreshRSS error: unable to create export directory: {$exportDir}\n");
$ok = false;
continue;
}
$filename = $exportDir . '/' . $timestamp . '.sqlite';
if ($verbose) {
echo 'FreshRSS automatic SQLite export for user “', $username, '” -> ', $filename, "\n";
}
$databaseDAO = FreshRSS_Factory::createDatabaseDAO($username);
$exported = $databaseDAO->dbCopy($filename, FreshRSS_DatabaseDAO::SQLITE_EXPORT, false, $verbose);
$ok = $ok && $exported;
if (!$exported) {
continue;
}
$existing = glob($exportDir . '/*.sqlite') ?: [];
if (count($existing) > $retention) {
sort($existing);
$toDelete = array_slice($existing, 0, count($existing) - $retention);
foreach ($toDelete as $old) {
if (@unlink($old)) {
if ($verbose) {
echo "Pruned old export: {$old}\n";
}
} else {
fwrite(STDERR, "FreshRSS warning: failed to prune old export: {$old}\n");
}
}
}
}
done($ok);