OCA\CMSPico\Service\TemplatesService

Complexity

Total Complexity

19

Size/Duplication

Total Lines	177
Duplicated Lines	19.77 %

Importance

Changes	3
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	generateFile()	0	13	3
A	getNewTemplatesList()	12	12	3
A	initWebsiteFolder()	0	3	1
A	__construct()	8	8	1
A	initFolder()	0	4	2
A	generateData()	0	4	1
A	templateHasToExist()	0	3	2
A	installTemplates()	0	18	3
A	getTemplatesList()	12	12	3

<?php
/**
 * CMS Pico - Integration of Pico within your files to create websites.
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Maxence Lange <maxence@artificial-owl.com>
 * @copyright 2017
 * @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 OCA\CMSPico\Service;

use DirectoryIterator;
use Exception;
use OCA\CMSPico\Exceptions\TemplateDoesNotExistException;
use OCA\CMSPico\Exceptions\WriteAccessException;
use OCA\CMSPico\Model\TemplateFile;
use OCA\CMSPico\Model\Website;
use OCP\Files\Folder;
use OCP\IL10N;

class TemplatesService {

	const TEMPLATES = ['sample_pico', 'empty'];
	const TEMPLATE_DIR = __DIR__ . '/../../Pico/templates/';

	/** @var IL10N */
	private $l10n;

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

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

	/** @var MiscService */
	private $miscService;

	/** @var Folder */
	private $websiteFolder;

	/**
	 * TemplatesService constructor.
	 *
	 * @param IL10N $l10n
	 * @param ConfigService $configService
	 * @param FileService $fileService
	 * @param MiscService $miscService
	 */
	function __construct(

This method seems to be duplicated in your project.

		IL10N $l10n, ConfigService $configService, FileService $fileService,
		MiscService $miscService
	) {
		$this->l10n = $l10n;
		$this->configService = $configService;
		$this->fileService = $fileService;
		$this->miscService = $miscService;
	}


	/**
	 * check if template exist.
	 *
	 * @param string $template
	 *
	 * @throws TemplateDoesNotExistException
	 */
	public function templateHasToExist($template) {
		if (!in_array($template, $this->getTemplatesList())) {
			throw new TemplateDoesNotExistException($this->l10n->t('Template does not exist'));
		}
	}


	/**
	 * returns all templates available to users.
	 *
	 * @param bool $customOnly
	 *
	 * @return array
	 */
	public function getTemplatesList($customOnly = false) {

This method seems to be duplicated in your project.

		$templates = [];
		if ($customOnly !== true) {
			$templates = self::TEMPLATES;
		}

		$customs = json_decode($this->configService->getAppValue(ConfigService::CUSTOM_TEMPLATES), true);
		if ($customs !== null) {
			$templates = array_merge($templates, $customs);
		}

		return $templates;
	}


	/**
	 * returns theme from the Pico/templates/ dir that are not available yet to users.
	 *
	 * @return array
	 */
	public function getNewTemplatesList() {

This method seems to be duplicated in your project.

		$newTemplates = [];
		$currTemplates = $this->getTemplatesList();
		$allTemplates = $this->fileService->getDirectoriesFromAppDataFolder(PicoService::DIR_TEMPLATES);
		foreach ($allTemplates as $template) {
			if (!in_array($template, $currTemplates)) {
				$newTemplates[] = $template;
			}
		}

		return $newTemplates;
	}


	/**
	 * Install templates into a new website.
	 * Templates will be parsed and formatted in the process.
	 *
	 * @param Website $website
	 */
	public function installTemplates(Website $website) {

		$dir = $this->fileService->getAppDataFolderAbsolutePath(PicoService::DIR_TEMPLATES);
		$dir .= MiscService::endSlash($website->getTemplateSource());

		$files = $this->fileService->getAppDataFiles($dir);

		$this->initWebsiteFolder($website);
		$data = $this->generateData($website);
		foreach ($files as $file) {

			if (substr($file, -1) === '/') {
				continue;
			}

			$template = new TemplateFile($dir, $file);
			$template->applyData($data);
			$this->generateFile($template, $website);
		}
	}


	/**
	 * @param TemplateFile $file
	 * @param Website $website
	 *
	 * @throws WriteAccessException
	 */
	private function generateFile(TemplateFile $file, Website $website) {
		try {
			$this->initFolder(pathinfo($website->getPath() . $file->getFilename(), PATHINFO_DIRNAME));

			if (substr($file->getFilename(), -5) === 'empty') {
				return;
			}

			$new = $this->websiteFolder->newFile($website->getPath() . $file->getFilename());
			$new->putContent($file->getContent());
		} catch (Exception $e) {
			throw new WriteAccessException(
				$this->l10n->t('Cannot generate template file in this folder')
			);
		}

	}


	/**
	 * @param Website $website
	 */
	private function initWebsiteFolder(Website $website) {
		$this->websiteFolder = \OC::$server->getUserFolder($website->getUserId());
		$this->initFolder($website->getPath());
	}


	/**
	 * @param Website $website
	 *
	 * @return array
	 */
	private function generateData(Website $website) {
		return [
			'site_title' => $website->getName(),
			'base_url'   => \OC::$WEBROOT . $website->getSite()
		];
	}


	/**
	 * @param $path
	 */
	private function initFolder($path) {

		if (!$this->websiteFolder->nodeExists($path)) {
			$this->websiteFolder->newFolder($path);
		}
	}


}