OCA\CMSPico\Migration\AppDataRepairStep

Complexity

Total Complexity

37

Size/Duplication

Total Lines	280
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	6
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	logChanges()	0	15	4
A	syncAppDataFolder()	0	3	1
A	publishSystemThemes()	0	16	3
A	__construct()	0	12	1
A	getName()	0	3	1
A	copyConfig()	0	22	5
A	run()	0	16	1
A	publishCustomThemes()	0	19	5
A	publishPlugins()	0	9	1
A	log()	0	3	1
A	publishCustomPlugins()	0	19	5
A	publishThemes()	0	9	1
A	publishSystemPlugins()	0	16	3
A	copyTemplates()	0	22	5

<?php
/**
 * CMS Pico - Create websites using Pico CMS for Nextcloud.
 *
 * @copyright Copyright (c) 2019, Daniel Rudolf (<picocms.org@daniel-rudolf.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 <http://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace OCA\CMSPico\Migration;

use OCA\CMSPico\AppInfo\Application;
use OCA\CMSPico\Service\ConfigService;
use OCA\CMSPico\Service\FileService;
use OCA\CMSPico\Service\PicoService;
use OCA\CMSPico\Service\PluginsService;
use OCA\CMSPico\Service\ThemesService;
use OCP\Files\NotFoundException;
use OCP\ILogger;
use OCP\Migration\IOutput;
use OCP\Migration\IRepairStep;

class AppDataRepairStep implements IRepairStep
{
	/** @var ILogger */
	private $logger;

	/** @var ConfigService */
	private $configService;

	/** @var ThemesService */
	private $themesService;

	/** @var PluginsService */
	private $pluginsService;

	/** @var FileService */
	private $fileService;

	/**
	 * AppDataRepairStep constructor.
	 *
	 * @param ILogger        $logger
	 * @param ConfigService  $configService
	 * @param ThemesService  $themesService
	 * @param PluginsService $pluginsService
	 * @param FileService    $fileService
	 */
	public function __construct(
		ILogger $logger,
		ConfigService $configService,
		ThemesService $themesService,
		PluginsService $pluginsService,
		FileService $fileService
	) {
		$this->logger = $logger;
		$this->configService = $configService;
		$this->themesService = $themesService;
		$this->pluginsService = $pluginsService;
		$this->fileService = $fileService;
	}

	/**
	 * @return string
	 */
	public function getName(): string
	{
		return 'Preparing app data of Pico CMS for Nextcloud';
	}

	/**
	 * @param IOutput $output
	 */
	public function run(IOutput $output)
	{
		$this->log('Syncing Pico CMS app data folder …');
		$this->syncAppDataFolder();

		$this->log('Copying Pico CMS config …');
		$this->copyConfig();

		$this->log('Copying Pico CMS templates …');
		$this->copyTemplates();

		$this->log('Publishing Pico CMS themes …');
		$this->publishThemes();

		$this->log('Publishing Pico CMS plugins …');
		$this->publishPlugins();
	}

	/**
	 * @return void
	 */
	private function syncAppDataFolder()
	{
		$this->fileService->syncAppDataFolder();
	}

	/**
	 * @return void
	 */
	private function copyConfig()
	{
		$appDataConfigFolder = $this->fileService->getAppDataFolder(PicoService::DIR_CONFIG);
		$systemConfigFolder = $this->fileService->getSystemFolder(PicoService::DIR_CONFIG);

		foreach ($systemConfigFolder as $configFile) {
			$configFileName = $configFile->getName();

			if (!$configFile->isFile()) {
				continue;
			}

			try {
				$appDataConfigFolder->getFile($configFileName)->delete();
				$this->log(sprintf('Replacing %s "%s"', 'config file', $configFileName), ILogger::WARN);
			} catch (NotFoundException $e) {
				$this->log(sprintf('Adding %s "%s"', 'config file', $configFileName));
			} catch (\Exception $e) {
				$this->log(sprintf('Unable to create %s "%s"', 'config file', $configFileName), ILogger::ERROR);
			}

			$configFile->copy($appDataConfigFolder);
		}
	}

	/**
	 * @return void
	 */
	private function copyTemplates()
	{
		$appDataTemplatesFolder = $this->fileService->getAppDataFolder(PicoService::DIR_TEMPLATES);
		$systemTemplatesFolder = $this->fileService->getSystemFolder(PicoService::DIR_TEMPLATES);

		foreach ($systemTemplatesFolder as $templateFolder) {
			$templateFileName = $templateFolder->getName();

			if (!$templateFolder->isFolder()) {
				continue;
			}

			try {
				$appDataTemplatesFolder->getFolder($templateFileName)->delete();
				$this->log(sprintf('Replacing %s "%s"', 'template', $templateFileName), ILogger::WARN);
			} catch (NotFoundException $e) {
				$this->log(sprintf('Adding %s "%s"', 'template', $templateFileName));
			} catch (\Exception $e) {
				$this->log(sprintf('Unable to create %s "%s"', 'template', $templateFileName), ILogger::ERROR);
			}

			$templateFolder->copy($appDataTemplatesFolder);
		}
	}

	/**
	 * @return void
	 */
	private function publishThemes()
	{
		$publicThemesFolder = $this->fileService->getPublicFolder(PicoService::DIR_THEMES);
		$publicThemesFolder->truncate();

		$this->configService->deleteAppValue(ConfigService::THEMES_ETAG);

		$this->publishSystemThemes();
		$this->publishCustomThemes();
	}

	/**
	 * @return void
	 */
	private function publishSystemThemes()
	{
		$systemThemesFolder = $this->fileService->getSystemFolder(PicoService::DIR_THEMES);

		$oldSystemThemes = $this->themesService->getSystemThemes();
		$this->configService->deleteAppValue(ConfigService::SYSTEM_THEMES);

		foreach ($systemThemesFolder as $themeFolder) {
			$themeName = $themeFolder->getName();
			if ($themeFolder->isFolder()) {
				$this->themesService->publishSystemTheme($themeName);
			}
		}

		$newSystemThemes = $this->themesService->getSystemThemes();
		$this->logChanges('system theme', array_keys($newSystemThemes), array_keys($oldSystemThemes));
	}

	/**
	 * @return void
	 */
	private function publishCustomThemes()
	{
		$appDataThemesFolder = $this->fileService->getAppDataFolder(PicoService::DIR_THEMES);

		$oldCustomThemes = $this->themesService->getCustomThemes();
		$this->configService->deleteAppValue(ConfigService::CUSTOM_THEMES);

		$systemThemes = $this->themesService->getSystemThemes();
		foreach ($appDataThemesFolder as $themeFolder) {
			$themeName = $themeFolder->getName();
			if ($themeFolder->isFolder()) {
				if (isset($oldCustomThemes[$themeName]) && !isset($systemThemes[$themeName])) {
					$this->themesService->publishCustomTheme($themeName);
				}
			}
		}

		$newCustomThemes = $this->themesService->getCustomThemes();
		$this->logChanges('custom theme', array_keys($newCustomThemes), array_keys($oldCustomThemes));
	}

	/**
	 * @return void
	 */
	private function publishPlugins()
	{
		$publicPluginsFolder = $this->fileService->getPublicFolder(PicoService::DIR_PLUGINS);
		$publicPluginsFolder->truncate();

		$this->configService->deleteAppValue(ConfigService::PLUGINS_ETAG);

		$this->publishSystemPlugins();
		$this->publishCustomPlugins();
	}

	/**
	 * @return void
	 */
	private function publishSystemPlugins()
	{
		$systemPluginsFolder = $this->fileService->getSystemFolder(PicoService::DIR_PLUGINS);

		$oldSystemPlugins = $this->pluginsService->getSystemPlugins();
		$this->configService->deleteAppValue(ConfigService::SYSTEM_PLUGINS);

		foreach ($systemPluginsFolder as $pluginFolder) {
			$pluginName = $pluginFolder->getName();
			if ($pluginFolder->isFolder()) {
				$this->pluginsService->publishSystemPlugin($pluginName);
			}
		}

		$newSystemPlugins = $this->pluginsService->getSystemPlugins();
		$this->logChanges('system plugin', array_keys($newSystemPlugins), array_keys($oldSystemPlugins));
	}

	/**
	 * @return void
	 */
	private function publishCustomPlugins()
	{
		$appDataPluginsFolder = $this->fileService->getAppDataFolder(PicoService::DIR_PLUGINS);

		$oldCustomPlugins = $this->pluginsService->getCustomPlugins();
		$this->configService->deleteAppValue(ConfigService::CUSTOM_PLUGINS);

		$systemPlugins = $this->pluginsService->getSystemPlugins();
		foreach ($appDataPluginsFolder as $pluginFolder) {
			$pluginName = $pluginFolder->getName();
			if ($pluginFolder->isFolder()) {
				if (isset($oldCustomPlugins[$pluginName]) && !isset($systemPlugins[$pluginName])) {
					$this->pluginsService->publishCustomPlugin($pluginName);
				}
			}
		}

		$newCustomPlugins = $this->pluginsService->getCustomPlugins();
		$this->logChanges('custom plugin', array_keys($newCustomPlugins), array_keys($oldCustomPlugins));
	}

	/**
	 * @param string $message
	 * @param int    $level
	 */
	private function log(string $message, int $level = ILogger::DEBUG)
	{
		$this->logger->log($level, $message, [ 'app' => Application::APP_NAME ]);
	}

	/**
	 * @param string $title
	 * @param array  $newItems
	 * @param array  $oldItems
	 */
	private function logChanges(string $title, array $newItems, array $oldItems)
	{
		$addedItems = array_diff($newItems, $oldItems);
		foreach ($addedItems as $item) {
			$this->log(sprintf('Adding %s "%s"', $title, $item));
		}

		$updatedItems = array_intersect($newItems, $oldItems);
		foreach ($updatedItems as $item) {
			$this->log(sprintf('Replacing %s "%s"', $title, $item), ILogger::WARN);
		}

		$removedItems = array_diff($oldItems, $newItems);
		foreach ($removedItems as $item) {
			$this->log(sprintf('Removing %s "%s"', $title, $item), ILogger::WARN);
		}
	}
}