Website::getOptionsJSON() - Code Metrics - Inspection of "Merge pull request #99 from nextcloud/cms_pico-1.1" - nextcloud/cms_pico - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( fa41e0...4bd63f )

by Daniel
created 2022-02-01 13:42 UTC
Website::getOptionsJSON() A

↳ Parent: Website
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes
Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	0
crap	1
<?php
/**
 * CMS Pico - Create websites using Pico CMS for Nextcloud.
 *
 * @copyright Copyright (c) 2017, Maxence Lange (<[email protected]>)
 * @copyright Copyright (c) 2019, Daniel Rudolf (<[email protected]>)
 *
 * @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\Model;

use OCA\CMSPico\AppInfo\Application;
use OCA\CMSPico\Exceptions\ThemeNotCompatibleException;
use OCA\CMSPico\Exceptions\ThemeNotFoundException;
use OCA\CMSPico\Exceptions\WebsiteForeignOwnerException;
use OCA\CMSPico\Exceptions\WebsiteInvalidDataException;
use OCA\CMSPico\Exceptions\WebsiteInvalidFilesystemException;
use OCA\CMSPico\Exceptions\WebsiteInvalidOwnerException;
use OCA\CMSPico\Files\StorageFolder;
use OCA\CMSPico\Service\MiscService;
use OCA\CMSPico\Service\ThemesService;
use OCA\CMSPico\Service\WebsitesService;
use OCP\Files\InvalidPathException;
use OCP\Files\NotFoundException;
use OCP\IConfig;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\IUserManager;

class Website extends WebsiteCore
{
	/** @var int */
	public const SITE_LENGTH_MIN = 3;

	/** @var int */
	public const SITE_LENGTH_MAX = 255;

	/** @var string */
	public const SITE_REGEX = '^[a-z0-9][a-z0-9_-]+[a-z0-9]$';

	/** @var int */
	public const NAME_LENGTH_MIN = 3;

	/** @var int */
	public const NAME_LENGTH_MAX = 255;

	/** @var IConfig */
	private $config;

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

	/** @var IUserManager */
	private $userManager;

	/** @var IURLGenerator */
	private $urlGenerator;

	/** @var WebsitesService */
	private $websitesService;

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

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

	/** @var StorageFolder */
	private $folder;

	/**
	 * Website constructor.
	 *
	 * @param array|null $data
	 */
	public function __construct($data = null)
	{
		$this->config = \OC::$server->getConfig();
		$this->config = /** @scrutinizer ignore-deprecated */ \OC::$server->getConfig();
		$this->l10n = \OC::$server->getL10N(Application::APP_NAME);
		$this->l10n = /** @scrutinizer ignore-deprecated */ \OC::$server->getL10N(Application::APP_NAME);
		$this->userManager = \OC::$server->getUserManager();
		$this->userManager = /** @scrutinizer ignore-deprecated */ \OC::$server->getUserManager();
		$this->urlGenerator = \OC::$server->getURLGenerator();
		$this->urlGenerator = /** @scrutinizer ignore-deprecated */ \OC::$server->getURLGenerator();
		$this->websitesService = \OC::$server->query(WebsitesService::class);
		$this->websitesService = /** @scrutinizer ignore-deprecated */ \OC::$server->query(WebsitesService::class);
		$this->themesService = \OC::$server->query(ThemesService::class);
		$this->themesService = /** @scrutinizer ignore-deprecated */ \OC::$server->query(ThemesService::class);
		$this->miscService = \OC::$server->query(MiscService::class);
		$this->miscService = /** @scrutinizer ignore-deprecated */ \OC::$server->query(MiscService::class);

		parent::__construct($data);
	}

	/**
	 * @return string
	 */
	public function getOptionsJSON(): string
	{
		return json_encode($this->getOptions());
	}

	/**
	 * @return string
	 */
	public function getTimeZone(): string
	{
		$serverTimeZone = date_default_timezone_get() ?: 'UTC';
		return $this->config->getUserValue($this->getUserId(), 'core', 'timezone', $serverTimeZone);
	}

	/**
	 * {@inheritDoc}
	 */
	public function getData(): array
	{
		$data = parent::getData();
		$data['timezone'] = $this->getTimeZone();
		return $data;
	}

	/**
	 * @throws WebsiteInvalidOwnerException
	 */
	public function assertValidOwner(): void
	{
		$user = $this->userManager->get($this->getUserId());
		if ($user === null) {
			throw new WebsiteInvalidOwnerException();
		}
		if (!$user->isEnabled()) {
			throw new WebsiteInvalidOwnerException();
		}
		if (!$this->websitesService->isUserAllowed($this->getUserId())) {
			throw new WebsiteInvalidOwnerException();
		}
	}

	/**
	 * @throws WebsiteInvalidDataException
	 */
	public function assertValidName(): void
	{
		if (strlen($this->getName()) < self::NAME_LENGTH_MIN) {
			throw new WebsiteInvalidDataException('name', $this->l10n->t('The name of the website must be longer.'));
		}
		if (strlen($this->getName()) > self::NAME_LENGTH_MAX) {
			throw new WebsiteInvalidDataException('name', $this->l10n->t('The name of the website is too long.'));
		}
	}

	/**
	 * @throws WebsiteInvalidDataException
	 */
	public function assertValidSite(): void
	{
		if (strlen($this->getSite()) < self::SITE_LENGTH_MIN) {
			$error = $this->l10n->t('The identifier of the website must be longer.');
			throw new WebsiteInvalidDataException('site', $error);
		}
		if (strlen($this->getSite()) > self::SITE_LENGTH_MAX) {
			$error = $this->l10n->t('The identifier of the website is too long.');
			throw new WebsiteInvalidDataException('site', $error);
		}
		if (preg_match('/' . self::SITE_REGEX . '/', $this->getSite()) !== 1) {
			$error = $this->l10n->t('The identifier of the website can only contain lowercase alpha numeric chars.');
			throw new WebsiteInvalidDataException('site', $error);
		}
	}

	/**
	 * @throws WebsiteInvalidDataException
	 */
	public function assertValidPath(): void
	{
		try {
			$path = $this->miscService->normalizePath($this->getPath());
			if ($path === '') {
				throw new InvalidPathException();
			}
		} catch (InvalidPathException $e) {
			throw new WebsiteInvalidDataException(
				'path',
				$this->l10n->t('The path of the website is invalid.')
			);
		}

		$userFolder = new StorageFolder(\OC::$server->getUserFolder($this->getUserId()));
		$userFolder = new StorageFolder(/** @scrutinizer ignore-type */ \OC::$server->getUserFolder($this->getUserId()));

		try {
			$websiteBaseFolder = $userFolder->getFolder(dirname($path));

			try {
				$websiteFolder = $websiteBaseFolder->getFolder(basename($path));

				if (!$websiteFolder->isLocal()) {
					throw new WebsiteInvalidDataException(
						'path',
						$this->l10n->t('The website\'s path is stored on a non-local storage.')
					);
				}
			} catch (NotFoundException $e) {
				if (!$websiteBaseFolder->isLocal()) {
					throw new WebsiteInvalidDataException(
						'path',
						$this->l10n->t('The website\'s path is stored on a non-local storage.')
					);
				}
			}
		} catch (InvalidPathException | NotFoundException $e) {
			throw new WebsiteInvalidDataException(
				'path',
				$this->l10n->t('Parent folder of the website\'s path not found.')
			);
		}
	}

	/**
	 * @throws ThemeNotFoundException
	 * @throws ThemeNotCompatibleException
	 */
	public function assertValidTheme(): void
	{
		$this->themesService->assertValidTheme($this->getTheme());
	}

	/**
	 * @param string $userId
	 *
	 * @throws WebsiteForeignOwnerException
	 */
	public function assertOwnedBy(string $userId): void
	{
		if ($this->getUserId() !== $userId) {
			throw new WebsiteForeignOwnerException();
		}
	}

	/**
	 * @return StorageFolder
	 * @throws WebsiteInvalidFilesystemException
	 */
	public function getWebsiteFolder(): StorageFolder
	{
		if ($this->folder !== null) {
			try {
				// NC doesn't guarantee that mounts are present for the whole request lifetime
				// for example, if you call \OC\Files\Utils\Scanner::scan(), all mounts are reset
				// this makes OCNode instances, which rely on mounts of different users than the current, unusable
				// by calling OCFolder::get('') we can detect this situation and re-init the required mounts
				$this->folder->get('');
			} catch (\Exception $e) {
				$this->folder = null;
			}
		}

		if ($this->folder === null) {
			try {
				$ocUserFolder = \OC::$server->getUserFolder($this->getUserId());
				$ocUserFolder = /** @scrutinizer ignore-deprecated */ \OC::$server->getUserFolder($this->getUserId());
				$userFolder = new StorageFolder($ocUserFolder);
				$userFolder = new StorageFolder(/** @scrutinizer ignore-type */ $ocUserFolder);

				$websiteFolder = $userFolder->getFolder($this->getPath());
				$this->folder = $websiteFolder->fakeRoot();
			} catch (InvalidPathException | NotFoundException $e) {
				throw new WebsiteInvalidFilesystemException($e);
			}
		}

		return $this->folder;
	}

	/**
	 * @return string
	 * @throws WebsiteInvalidFilesystemException
	 */
	public function getWebsitePath(): string
	{
		try {
			return $this->getWebsiteFolder()->getLocalPath() . '/';
		} catch (InvalidPathException | NotFoundException $e) {
			throw new WebsiteInvalidFilesystemException($e);
		}
	}

	/**
	 * @param bool $proxyRequest
	 *
	 * @return string
	 */
	public function getWebsiteUrl(bool $proxyRequest = false): string
	{
		if (!$proxyRequest) {
			$route = Application::APP_NAME . '.Pico.getPage';
			$parameters = [ 'site' => $this->getSite(), 'page' => '' ];
			return $this->urlGenerator->linkToRoute($route, $parameters) . '/';
		} else {
			return \OC::$WEBROOT . '/sites/' . urlencode($this->getSite()) . '/';
		}
	}
}

nextcloud / cms_pico

Push — master ( fa41e0...4bd63f )

Website::getOptionsJSON() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
