mirror of
https://github.com/FreshRSS/FreshRSS.git
synced 2026-10-28 14:08:45 -04:00
abp002andAlejandro Borrego
48547b4a6c
Contributes to #6139 (export part; the import will follow in another PR) Exporting favourites was collecting the whole file in memory. With many articles, it fails with the default PHP memory limit. ## Changes - New `Minz_View::helperToFile()`, similar to `helperToString()`, writing the output of a helper into a file by chunks of 64 KiB instead of keeping it in memory. - `FreshRSS_Export_Service`: the `generate*()` methods now return the path of a temporary file instead of the content, and `zip()` builds the archive from those files (`ZipArchive::addFile()` instead of `addFromString()`). Temporary files are created in `TMP_PATH` (already required to be writable) and deleted at the end of the script. - The export is sent with `readfile()`: Web UI, `cli/export-zip-for-user.php`, `cli/export-opml-for-user.php` and the OPML export of the Google Reader API. - Note: this changes what `FreshRSS_Export_Service` returns (a path instead of the content). All callers in the repository are updated, and I could not find any public extension using this service. ## Measurements Peak PHP memory (`memory_get_peak_usage(true)`), SQLite database with synthetic starred articles: | Scenario | Before | After | |---|---|---| | Web, export your favourites, 10,000 articles (69 MB JSON) | 136 MB (fails with the default `memory_limit` of 128 MB) | 6 MB | | Web, ZIP (OPML + favourites + labelled articles + 4 feeds), 10,000 articles | 152 MB | 6 MB | | CLI `export-zip-for-user.php`, 10,000 articles | 189 MB (fails with 128 MB) | 8 MB | | Web, export your favourites, 30,000 articles (208 MB JSON) | 404 MB | 10 MB | Co-authored-by: Alejandro Borrego <210245044+abp002@users.noreply.github.com>
58 lines
1.7 KiB
PHP
Executable File
58 lines
1.7 KiB
PHP
Executable File
#!/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 string $user;
|
|
public int $maxFeedEntries;
|
|
|
|
public function __construct() {
|
|
$this->addRequiredOption('user', (new CliOption('user')));
|
|
$this->addOption('maxFeedEntries', (new CliOption('max-feed-entries'))->typeOfInt(), '100');
|
|
parent::__construct();
|
|
}
|
|
};
|
|
|
|
if (!empty($cliOptions->errors)) {
|
|
fail('FreshRSS error: ' . array_shift($cliOptions->errors) . "\n" . $cliOptions->usage);
|
|
}
|
|
|
|
if (!extension_loaded('zip')) {
|
|
fail('FreshRSS error: Lacking php-zip extension!');
|
|
}
|
|
|
|
$username = cliInitUser($cliOptions->user);
|
|
|
|
fwrite(STDERR, 'FreshRSS exporting ZIP for user “' . $username . "”…\n");
|
|
|
|
$export_service = new FreshRSS_Export_Service($username);
|
|
$number_entries = $cliOptions->maxFeedEntries;
|
|
$exported_files = [];
|
|
|
|
// First, we generate the OPML file
|
|
[$filename, $path] = $export_service->generateOpml();
|
|
$exported_files[$filename] = $path;
|
|
|
|
// Then, labelled and starred entries
|
|
[$filename, $path] = $export_service->generateStarredEntries('ST');
|
|
$exported_files[$filename] = $path;
|
|
|
|
// And a list of entries based on the complete list of feeds
|
|
$feeds_exported_files = $export_service->generateAllFeedEntries($number_entries);
|
|
$exported_files = array_merge($exported_files, $feeds_exported_files);
|
|
|
|
// Finally, we compress all these files into a single Zip archive and we output
|
|
// the content
|
|
[$filename, $path] = $export_service->zip($exported_files);
|
|
if ($path === false) {
|
|
fail('FreshRSS error: cannot create the Zip archive!');
|
|
}
|
|
readfile($path);
|
|
|
|
invalidateHttpCache($username);
|
|
|
|
done();
|