2018-05-20 17:16:01 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace BookStack\Console\Commands;
|
|
|
|
|
2018-09-25 11:30:50 +00:00
|
|
|
use BookStack\Uploads\ImageService;
|
2018-05-20 17:16:01 +00:00
|
|
|
use Illuminate\Console\Command;
|
2018-05-27 13:33:50 +00:00
|
|
|
use Symfony\Component\Console\Output\OutputInterface;
|
2018-05-20 17:16:01 +00:00
|
|
|
|
2023-05-24 12:21:46 +00:00
|
|
|
class CleanupImagesCommand extends Command
|
2018-05-20 17:16:01 +00:00
|
|
|
{
|
|
|
|
/**
|
|
|
|
* The name and signature of the console command.
|
|
|
|
*
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
protected $signature = 'bookstack:cleanup-images
|
2020-12-18 22:54:53 +00:00
|
|
|
{--a|all : Also delete images that are only used in old revisions}
|
|
|
|
{--f|force : Actually run the deletions, Defaults to a dry-run}
|
2018-05-20 17:16:01 +00:00
|
|
|
';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The console command description.
|
|
|
|
*
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
protected $description = 'Cleanup images and drawings';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Execute the console command.
|
|
|
|
*/
|
2023-05-24 11:59:50 +00:00
|
|
|
public function handle(ImageService $imageService): int
|
2018-05-20 17:16:01 +00:00
|
|
|
{
|
2023-05-24 11:59:50 +00:00
|
|
|
$checkRevisions = !$this->option('all');
|
|
|
|
$dryRun = !$this->option('force');
|
2018-05-20 17:16:01 +00:00
|
|
|
|
|
|
|
if (!$dryRun) {
|
2023-05-24 09:34:43 +00:00
|
|
|
$this->warn("This operation is destructive and is not guaranteed to be fully accurate.\nEnsure you have a backup of your images.\n");
|
|
|
|
$proceed = $this->confirm("Are you sure you want to proceed?");
|
2018-05-20 17:16:01 +00:00
|
|
|
if (!$proceed) {
|
2023-05-24 11:59:50 +00:00
|
|
|
return 0;
|
2018-05-20 17:16:01 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-05-24 11:59:50 +00:00
|
|
|
$deleted = $imageService->deleteUnusedImages($checkRevisions, $dryRun);
|
2018-05-27 13:33:50 +00:00
|
|
|
$deleteCount = count($deleted);
|
2018-05-20 17:16:01 +00:00
|
|
|
|
|
|
|
if ($dryRun) {
|
2023-05-24 09:34:43 +00:00
|
|
|
$this->comment('Dry run, no images have been deleted');
|
2018-05-20 17:16:01 +00:00
|
|
|
$this->comment($deleteCount . ' images found that would have been deleted');
|
2018-05-27 13:33:50 +00:00
|
|
|
$this->showDeletedImages($deleted);
|
2018-05-20 17:16:01 +00:00
|
|
|
$this->comment('Run with -f or --force to perform deletions');
|
2021-06-26 15:23:15 +00:00
|
|
|
|
2023-05-24 11:59:50 +00:00
|
|
|
return 0;
|
2018-05-20 17:16:01 +00:00
|
|
|
}
|
|
|
|
|
2018-05-27 13:33:50 +00:00
|
|
|
$this->showDeletedImages($deleted);
|
2018-05-20 17:16:01 +00:00
|
|
|
$this->comment($deleteCount . ' images deleted');
|
2023-05-24 11:59:50 +00:00
|
|
|
return 0;
|
2018-05-20 17:16:01 +00:00
|
|
|
}
|
2018-05-27 13:33:50 +00:00
|
|
|
|
2023-05-24 11:59:50 +00:00
|
|
|
protected function showDeletedImages($paths): void
|
2018-05-27 13:33:50 +00:00
|
|
|
{
|
2018-09-21 17:48:47 +00:00
|
|
|
if ($this->getOutput()->getVerbosity() <= OutputInterface::VERBOSITY_NORMAL) {
|
|
|
|
return;
|
|
|
|
}
|
2023-05-24 11:59:50 +00:00
|
|
|
|
2018-05-27 13:33:50 +00:00
|
|
|
if (count($paths) > 0) {
|
|
|
|
$this->line('Images to delete:');
|
|
|
|
}
|
2023-05-24 11:59:50 +00:00
|
|
|
|
2018-05-27 13:33:50 +00:00
|
|
|
foreach ($paths as $path) {
|
|
|
|
$this->line($path);
|
|
|
|
}
|
|
|
|
}
|
2018-05-20 17:16:01 +00:00
|
|
|
}
|