Skip to content

Commit af67bc1

Browse files
authored
Merge pull request #58905 from nextcloud/feat/stable30/backport-preview-cleanup
[stable30] feat: backport command to cleanup previews
2 parents 1541f12 + d3973c3 commit af67bc1

4 files changed

Lines changed: 92 additions & 0 deletions

File tree

core/Command/Preview/Cleanup.php

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
/**
6+
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
7+
* SPDX-License-Identifier: AGPL-3.0-or-later
8+
*/
9+
10+
namespace OC\Core\Command\Preview;
11+
12+
use OC\Core\Command\Base;
13+
use OCP\Files\Folder;
14+
use OCP\Files\IRootFolder;
15+
use OCP\Files\NotFoundException;
16+
use OCP\Files\NotPermittedException;
17+
use Psr\Log\LoggerInterface;
18+
use Symfony\Component\Console\Input\InputInterface;
19+
use Symfony\Component\Console\Output\OutputInterface;
20+
21+
class Cleanup extends Base {
22+
23+
public function __construct(
24+
private IRootFolder $rootFolder,
25+
private LoggerInterface $logger,
26+
) {
27+
parent::__construct();
28+
}
29+
30+
protected function configure(): void {
31+
$this
32+
->setName('preview:cleanup')
33+
->setDescription('Removes existing preview files');
34+
}
35+
36+
protected function execute(InputInterface $input, OutputInterface $output): int {
37+
try {
38+
$appDataFolder = $this->rootFolder->get($this->rootFolder->getAppDataDirectoryName());
39+
40+
if (!$appDataFolder instanceof Folder) {
41+
$this->logger->error("Previews can't be removed: appdata is not a folder");
42+
$output->writeln("Previews can't be removed: appdata is not a folder");
43+
return 1;
44+
}
45+
46+
/** @var Folder $previewFolder */
47+
$previewFolder = $appDataFolder->get('preview');
48+
49+
} catch (NotFoundException $e) {
50+
$this->logger->error("Previews can't be removed: appdata folder can't be found", ['exception' => $e]);
51+
$output->writeln("Previews can't be removed: preview folder isn't deletable");
52+
return 1;
53+
}
54+
55+
if (!$previewFolder->isDeletable()) {
56+
$this->logger->error("Previews can't be removed: preview folder isn't deletable");
57+
$output->writeln("Previews can't be removed: preview folder isn't deletable");
58+
return 1;
59+
}
60+
61+
try {
62+
$previewFolder->delete();
63+
$this->logger->debug('Preview folder deleted');
64+
$output->writeln('Preview folder deleted', OutputInterface::VERBOSITY_VERBOSE);
65+
} catch (NotFoundException $e) {
66+
$output->writeln("Previews weren't deleted: preview folder was not found while deleting it");
67+
$this->logger->error("Previews weren't deleted: preview folder was not found while deleting it", ['exception' => $e]);
68+
return 1;
69+
} catch (NotPermittedException $e) {
70+
$output->writeln("Previews weren't deleted: you don't have the permission to delete preview folder");
71+
$this->logger->error("Previews weren't deleted: you don't have the permission to delete preview folder", ['exception' => $e]);
72+
return 1;
73+
}
74+
75+
try {
76+
$createdFolder = $appDataFolder->newFolder('preview');
77+
$this->logger->error('newly created appdata folder', ['folder' => $createdFolder->getPath()]);
78+
$this->logger->debug('Preview folder recreated');
79+
$output->writeln('Preview folder recreated', OutputInterface::VERBOSITY_VERBOSE);
80+
} catch (NotPermittedException $e) {
81+
$output->writeln("Preview folder was deleted, but you don't have the permission to create preview folder");
82+
$this->logger->error("Preview folder was deleted, but you don't have the permission to create preview folder", ['exception' => $e]);
83+
return 1;
84+
}
85+
86+
$output->writeln('Previews removed');
87+
return 0;
88+
}
89+
}

core/register_command.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@
102102
$application->add(Server::get(Command\Maintenance\Repair::class));
103103
$application->add(Server::get(Command\Maintenance\RepairShareOwnership::class));
104104

105+
$application->add(Server::get(Command\Preview\Cleanup::class));
105106
$application->add(Server::get(Command\Preview\Generate::class));
106107
$application->add(Server::get(Command\Preview\Repair::class));
107108
$application->add(Server::get(Command\Preview\ResetRenderedTexts::class));

lib/composer/composer/autoload_classmap.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1220,6 +1220,7 @@
12201220
'OC\\Core\\Command\\Memcache\\DistributedDelete' => $baseDir . '/core/Command/Memcache/DistributedDelete.php',
12211221
'OC\\Core\\Command\\Memcache\\DistributedGet' => $baseDir . '/core/Command/Memcache/DistributedGet.php',
12221222
'OC\\Core\\Command\\Memcache\\DistributedSet' => $baseDir . '/core/Command/Memcache/DistributedSet.php',
1223+
'OC\\Core\\Command\\Preview\\Cleanup' => $baseDir . '/core/Command/Preview/Cleanup.php',
12231224
'OC\\Core\\Command\\Preview\\Generate' => $baseDir . '/core/Command/Preview/Generate.php',
12241225
'OC\\Core\\Command\\Preview\\Repair' => $baseDir . '/core/Command/Preview/Repair.php',
12251226
'OC\\Core\\Command\\Preview\\ResetRenderedTexts' => $baseDir . '/core/Command/Preview/ResetRenderedTexts.php',

lib/composer/composer/autoload_static.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1253,6 +1253,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
12531253
'OC\\Core\\Command\\Memcache\\DistributedDelete' => __DIR__ . '/../../..' . '/core/Command/Memcache/DistributedDelete.php',
12541254
'OC\\Core\\Command\\Memcache\\DistributedGet' => __DIR__ . '/../../..' . '/core/Command/Memcache/DistributedGet.php',
12551255
'OC\\Core\\Command\\Memcache\\DistributedSet' => __DIR__ . '/../../..' . '/core/Command/Memcache/DistributedSet.php',
1256+
'OC\\Core\\Command\\Preview\\Cleanup' => __DIR__ . '/../../..' . '/core/Command/Preview/Cleanup.php',
12561257
'OC\\Core\\Command\\Preview\\Generate' => __DIR__ . '/../../..' . '/core/Command/Preview/Generate.php',
12571258
'OC\\Core\\Command\\Preview\\Repair' => __DIR__ . '/../../..' . '/core/Command/Preview/Repair.php',
12581259
'OC\\Core\\Command\\Preview\\ResetRenderedTexts' => __DIR__ . '/../../..' . '/core/Command/Preview/ResetRenderedTexts.php',

0 commit comments

Comments
 (0)