diff options
author | Pytal <24800714+Pytal@users.noreply.github.com> | 2022-10-13 21:26:44 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-13 21:26:44 +0300 |
commit | 7f498d0fa06df3f94f5b9e718c97e1b0faf83105 (patch) | |
tree | 9b93107f154c3cda35804bca009d6417bc25bca3 | |
parent | 7c4a5b0dd17280b11288a7fb37f7af2f1c9c7e83 (diff) | |
parent | 1309459fee56b7375744189e3e2994f4d6487f44 (diff) |
Merge pull request #34587 from nextcloud/backport/34461/stable25
[stable25] Fix missing background on upgrade
-rw-r--r-- | apps/theming/appinfo/info.xml | 3 | ||||
-rw-r--r-- | apps/theming/lib/Jobs/MigrateBackgroundImages.php | 107 | ||||
-rw-r--r-- | apps/theming/lib/Migration/InitBackgroundImagesMigration.php | 48 | ||||
-rw-r--r-- | apps/theming/lib/Service/BackgroundService.php | 18 | ||||
-rw-r--r-- | core/Migrations/Version25000Date20221007010957.php | 72 | ||||
-rw-r--r-- | lib/composer/composer/autoload_classmap.php | 1 | ||||
-rw-r--r-- | lib/composer/composer/autoload_static.php | 1 |
7 files changed, 245 insertions, 5 deletions
diff --git a/apps/theming/appinfo/info.xml b/apps/theming/appinfo/info.xml index 6823a9fbd88..91caea1d718 100644 --- a/apps/theming/appinfo/info.xml +++ b/apps/theming/appinfo/info.xml @@ -31,6 +31,9 @@ <pre-migration> <step>OCA\Theming\Migration\MigrateUserConfig</step> </pre-migration> + <post-migration> + <step>OCA\Theming\Migration\InitBackgroundImagesMigration</step> + </post-migration> </repair-steps> <commands> diff --git a/apps/theming/lib/Jobs/MigrateBackgroundImages.php b/apps/theming/lib/Jobs/MigrateBackgroundImages.php new file mode 100644 index 00000000000..97806fa600a --- /dev/null +++ b/apps/theming/lib/Jobs/MigrateBackgroundImages.php @@ -0,0 +1,107 @@ +<?php + +declare(strict_types=1); + +/** + * @copyright Copyright (c) 2022 Arthur Schiwon <blizzz@arthur-schiwon.de> + * + * @author Arthur Schiwon <blizzz@arthur-schiwon.de> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <https://www.gnu.org/licenses/>. + * + */ + +namespace OCA\Theming\Jobs; + +use OCA\Theming\AppInfo\Application; +use OCP\App\IAppManager; +use OCP\AppFramework\Utility\ITimeFactory; +use OCP\BackgroundJob\IJobList; +use OCP\BackgroundJob\QueuedJob; +use OCP\Files\AppData\IAppDataFactory; +use OCP\Files\NotFoundException; +use OCP\Files\NotPermittedException; +use OCP\IConfig; + +class MigrateBackgroundImages extends QueuedJob { + public const TIME_SENSITIVE = 0; + + private IConfig $config; + private IAppManager $appManager; + private IAppDataFactory $appDataFactory; + private IJobList $jobList; + + public function __construct(ITimeFactory $time, IAppDataFactory $appDataFactory, IConfig $config, IAppManager $appManager, IJobList $jobList) { + parent::__construct($time); + $this->config = $config; + $this->appManager = $appManager; + $this->appDataFactory = $appDataFactory; + $this->jobList = $jobList; + } + + protected function run($argument): void { + if (!$this->appManager->isEnabledForUser('dashboard')) { + return; + } + + $themingData = $this->appDataFactory->get(Application::APP_ID); + $dashboardData = $this->appDataFactory->get('dashboard'); + + $userIds = $this->config->getUsersForUserValue('theming', 'background', 'custom'); + + $notSoFastMode = \count($userIds) > 5000; + $reTrigger = false; + $processed = 0; + + foreach ($userIds as $userId) { + try { + // precondition + if ($notSoFastMode) { + if ($this->config->getUserValue($userId, 'theming', 'background-migrated', '0') === '1') { + // already migrated + continue; + } + $reTrigger = true; + } + + // migration + $file = $dashboardData->getFolder($userId)->getFile('background.jpg'); + try { + $targetDir = $themingData->getFolder($userId); + } catch (NotFoundException $e) { + $targetDir = $themingData->newFolder($userId); + } + if (!$targetDir->fileExists('background.jpg')) { + $targetDir->newFile('background.jpg', $file->getContent()); + } + $file->delete(); + } catch (NotFoundException|NotPermittedException $e) { + } + // capture state + if ($notSoFastMode) { + $this->config->setUserValue($userId, 'theming', 'background-migrated', '1'); + $processed++; + } + if ($processed > 4999) { + break; + } + } + + if ($reTrigger) { + $this->jobList->add(self::class); + } + } +} diff --git a/apps/theming/lib/Migration/InitBackgroundImagesMigration.php b/apps/theming/lib/Migration/InitBackgroundImagesMigration.php new file mode 100644 index 00000000000..c23a9176843 --- /dev/null +++ b/apps/theming/lib/Migration/InitBackgroundImagesMigration.php @@ -0,0 +1,48 @@ +<?php + +declare(strict_types=1); + +/** + * @copyright Copyright (c) 2022 Arthur Schiwon <blizzz@arthur-schiwon.de> + * + * @author Arthur Schiwon <blizzz@arthur-schiwon.de> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <https://www.gnu.org/licenses/>. + * + */ + +namespace OCA\Theming\Migration; + +use OCA\Theming\Jobs\MigrateBackgroundImages; +use OCP\BackgroundJob\IJobList; +use OCP\Migration\IOutput; + +class InitBackgroundImagesMigration implements \OCP\Migration\IRepairStep { + + private IJobList $jobList; + + public function __construct(IJobList $jobList) { + $this->jobList = $jobList; + } + + public function getName() { + return 'Initialize migration of background images from dashboard to theming app'; + } + + public function run(IOutput $output) { + $this->jobList->add(MigrateBackgroundImages::class); + } +} diff --git a/apps/theming/lib/Service/BackgroundService.php b/apps/theming/lib/Service/BackgroundService.php index 0614fe00357..36623735728 100644 --- a/apps/theming/lib/Service/BackgroundService.php +++ b/apps/theming/lib/Service/BackgroundService.php @@ -30,6 +30,7 @@ namespace OCA\Theming\Service; use InvalidArgumentException; use OC\User\NoUserException; use OCA\Theming\AppInfo\Application; +use OCP\Files\AppData\IAppDataFactory; use OCP\Files\File; use OCP\Files\IAppData; use OCP\Files\IRootFolder; @@ -133,20 +134,22 @@ class BackgroundService { private IAppData $appData; private IConfig $config; private string $userId; + private IAppDataFactory $appDataFactory; public function __construct( - IRootFolder $rootFolder, - IAppData $appData, - IConfig $config, - ?string $userId + IRootFolder $rootFolder, + IAppDataFactory $appDataFactory, + IConfig $config, + ?string $userId ) { if ($userId === null) { return; } $this->rootFolder = $rootFolder; - $this->appData = $appData; + $this->appData = $appDataFactory->get(Application::APP_ID); $this->config = $config; $this->userId = $userId; + $this->appDataFactory = $appDataFactory; } public function setDefaultBackground(): void { @@ -193,6 +196,11 @@ class BackgroundService { try { return $this->getAppDataFolder()->getFile('background.jpg'); } catch (NotFoundException | NotPermittedException $e) { + try { + // Fallback can be removed in 26 + $dashboardFolder = $this->appDataFactory->get('dashboard'); + return $dashboardFolder->getFolder($this->userId)->getFile('background.jpg'); + } catch (\Throwable $t) {} } } return null; diff --git a/core/Migrations/Version25000Date20221007010957.php b/core/Migrations/Version25000Date20221007010957.php new file mode 100644 index 00000000000..21c62acae21 --- /dev/null +++ b/core/Migrations/Version25000Date20221007010957.php @@ -0,0 +1,72 @@ +<?php + +declare(strict_types=1); + +/** + * @copyright 2022 Christopher Ng <chrng8@gmail.com> + * + * @author Christopher Ng <chrng8@gmail.com> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +namespace OC\Core\Migrations; + +use Closure; +use OCP\IDBConnection; +use OCP\Migration\IOutput; +use OCP\Migration\SimpleMigrationStep; + +/** + * User background settings handling was moved from the + * dashboard app to the theming app so we migrate the + * respective preference values here + * + */ +class Version25000Date20221007010957 extends SimpleMigrationStep { + protected IDBConnection $connection; + + public function __construct(IDBConnection $connection) { + $this->connection = $connection; + } + + /** + * @param IOutput $output + * @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` + * @param array $options + */ + public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void { + $cleanUpQuery = $this->connection->getQueryBuilder(); + $cleanUpQuery->delete('preferences') + ->where($cleanUpQuery->expr()->eq('appid', $cleanUpQuery->createNamedParameter('theming'))) + ->andWhere($cleanUpQuery->expr()->orX( + $cleanUpQuery->expr()->eq('configkey', $cleanUpQuery->createNamedParameter('background')), + $cleanUpQuery->expr()->eq('configkey', $cleanUpQuery->createNamedParameter('backgroundVersion')), + )); + $cleanUpQuery->executeStatement(); + + $updateQuery = $this->connection->getQueryBuilder(); + $updateQuery->update('preferences') + ->set('appid', $updateQuery->createNamedParameter('theming')) + ->where($updateQuery->expr()->eq('appid', $updateQuery->createNamedParameter('dashboard'))) + ->andWhere($updateQuery->expr()->orX( + $updateQuery->expr()->eq('configkey', $updateQuery->createNamedParameter('background')), + $updateQuery->expr()->eq('configkey', $updateQuery->createNamedParameter('backgroundVersion')), + )); + $updateQuery->executeStatement(); + } +} diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index dad4a864f8d..0d9b99ab1c1 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -1063,6 +1063,7 @@ return array( 'OC\\Core\\Migrations\\Version24000Date20220425072957' => $baseDir . '/core/Migrations/Version24000Date20220425072957.php', 'OC\\Core\\Migrations\\Version25000Date20220515204012' => $baseDir . '/core/Migrations/Version25000Date20220515204012.php', 'OC\\Core\\Migrations\\Version25000Date20220602190540' => $baseDir . '/core/Migrations/Version25000Date20220602190540.php', + 'OC\\Core\\Migrations\\Version25000Date20221007010957' => $baseDir . '/core/Migrations/Version25000Date20221007010957.php', 'OC\\Core\\Notification\\CoreNotifier' => $baseDir . '/core/Notification/CoreNotifier.php', 'OC\\Core\\Service\\LoginFlowV2Service' => $baseDir . '/core/Service/LoginFlowV2Service.php', 'OC\\DB\\Adapter' => $baseDir . '/lib/private/DB/Adapter.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index f2436f4302f..d69298c0263 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -1096,6 +1096,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2 'OC\\Core\\Migrations\\Version24000Date20220425072957' => __DIR__ . '/../../..' . '/core/Migrations/Version24000Date20220425072957.php', 'OC\\Core\\Migrations\\Version25000Date20220515204012' => __DIR__ . '/../../..' . '/core/Migrations/Version25000Date20220515204012.php', 'OC\\Core\\Migrations\\Version25000Date20220602190540' => __DIR__ . '/../../..' . '/core/Migrations/Version25000Date20220602190540.php', + 'OC\\Core\\Migrations\\Version25000Date20221007010957' => __DIR__ . '/../../..' . '/core/Migrations/Version25000Date20221007010957.php', 'OC\\Core\\Notification\\CoreNotifier' => __DIR__ . '/../../..' . '/core/Notification/CoreNotifier.php', 'OC\\Core\\Service\\LoginFlowV2Service' => __DIR__ . '/../../..' . '/core/Service/LoginFlowV2Service.php', 'OC\\DB\\Adapter' => __DIR__ . '/../../..' . '/lib/private/DB/Adapter.php', |