StorageFolder::exists() - Code Metrics - Inspection of "Refactor StorageFolder::newFile() and newFolder()" - nextcloud/cms_pico - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#167)

by Daniel

created 2021-04-01 22:34 UTC

StorageFolder::exists() A

↳ Parent: StorageFolder

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
eloc	2
c	3
b	0
f	0
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
cc	1
nc	1
nop	1
crap	1

<?php
/**
 * CMS Pico - Create websites using Pico CMS for Nextcloud.
 *
 * @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\Files;

use OC\Files\Utils\Scanner;
use OC\ForbiddenException;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\Files\AlreadyExistsException;
use OCP\Files\Folder as OCFolder;
use OCP\Files\InvalidPathException;
use OCP\Files\NotPermittedException;
use OCP\IDBConnection;
use OCP\ILogger;
use OCP\ITempManager;

class StorageFolder extends AbstractStorageNode implements FolderInterface
{
	use FolderTrait;

	/** @var array<string,string> */
	private static $localPathCache = [];

	/** @var OCFolder */
	protected $node;

	/** @var ITempManager */
	private $tempManager;

	/** @var IDBConnection */
	private $connection;

	/** @var ILogger */
	private $logger;

	/** @var IEventDispatcher */
	private $eventDispatcher;

	/** @var StorageFolder|null */
	private $baseFolder;

	/**
	 * StorageFolder constructor.
	 *
	 * @param OCFolder    $folder
	 * @param string|null $basePath
	 *
	 * @throws InvalidPathException
	 */
	public function __construct(OCFolder $folder, string $basePath = null)
	{
		$this->tempManager = \OC::$server->getTempManager();
		$this->tempManager = /** @scrutinizer ignore-deprecated */ \OC::$server->getTempManager();
		$this->connection = \OC::$server->query(IDBConnection::class);
		$this->connection = /** @scrutinizer ignore-deprecated */ \OC::$server->query(IDBConnection::class);
		$this->logger = \OC::$server->query(ILogger::class);
		$this->logger = /** @scrutinizer ignore-deprecated */ \OC::$server->query(ILogger::class);
		$this->eventDispatcher = \OC::$server->query(IEventDispatcher::class);
		$this->eventDispatcher = /** @scrutinizer ignore-deprecated */ \OC::$server->query(IEventDispatcher::class);

		parent::__construct($folder, $basePath);
	}

	/**
	 * {@inheritDoc}
	 */
	public function getLocalPath(): string
	{
		if ($this->isLocal()) {
			return parent::getLocalPath();
		}

		$cachePath = $this->getOCNode()->getPath();
		if (!isset(self::$localPathCache[$cachePath])) {
			self::$localPathCache[$cachePath] = $this->tempManager->getTemporaryFolder();
		}

		return self::$localPathCache[$cachePath];
	}

	/**
	 * {@inheritDoc}
	 */
	public function listing(): array
	{
		return iterator_to_array($this->getGenerator());
	}

	/**
	 * {@inheritDoc}
	 */
	protected function getGenerator(): \Generator
	{
		$basePath = $this->getPath();
		foreach ($this->node->getDirectoryListing() as $node) {
			yield $this->repackNode($node, $basePath);
		}
	}

	/**
	 * {@inheritDoc}
	 */
	public function exists(string $path): bool
	{
		$path = $this->normalizePath($this->getPath() . '/' . $path);
		return $this->getBaseFolder()->getOCNode()->nodeExists($path);
	}

	/**
	 * {@inheritDoc}
	 */
	public function get(string $path): NodeInterface
	{
		$path = $this->normalizePath($this->getPath() . '/' . $path);
		$basePath = ($path !== '/') ? dirname($path) : null;
		return $this->repackNode($this->getBaseFolder()->getOCNode()->get($path), $basePath);
	}

	/**
	 * {@inheritDoc}
	 */
	public function newFolder(string $path): FolderInterface
	{
		if ($this->exists($path)) {
			throw new AlreadyExistsException();
		}

		$path = $this->normalizePath($this->getPath() . '/' . $path);

		$name = basename($path);
		$parentPath = dirname($path);
		$basePath = ($path !== '/') ? $parentPath : null;

		/** @var StorageFolder $parentFolder */
		$parentFolder = $this->newFolderRecursive($parentPath);

		if (!$parentFolder->isCreatable()) {
			throw new NotPermittedException();
		}

		return new StorageFolder($parentFolder->getOCNode()->newFolder($name), $basePath);
	}

	/**
	 * {@inheritDoc}
	 */
	public function newFile(string $path): FileInterface
	{
		if ($this->exists($path)) {
			throw new AlreadyExistsException();
		}

		$path = $this->normalizePath($this->getPath() . '/' . $path);

		$name = basename($path);
		$parentPath = dirname($path);
		$basePath = ($path !== '/') ? $parentPath : null;

		/** @var StorageFolder $parentFolder */
		$parentFolder = $this->newFolderRecursive($parentPath);

		if (!$parentFolder->isCreatable()) {
			throw new NotPermittedException();
		}

		return new StorageFile($parentFolder->getOCNode()->newFile($name), $basePath);
	}

	/**
	 * {@inheritDoc}
	 */
	public function fakeRoot(): FolderInterface
	{
		return new StorageFolder($this->node);
	}

	/**
	 * {@inheritDoc}
	 */
	public function sync(bool $recursive = FolderInterface::SYNC_RECURSIVE): void
	{
		$scanner = new Scanner(null, $this->connection, $this->eventDispatcher, $this->logger);

		try {
			$scanner->scan($this->node->getPath(), $recursive);
		} catch (ForbiddenException $e) {
			throw new NotPermittedException();
		}
	}

	/**
	 * {@inheritDoc}
	 */
	public function isCreatable(): bool
	{
		return $this->node->isCreatable();
	}

	/**
	 * @return StorageFolder
	 */
	private function getBaseFolder(): self
	{
		if ($this->getPath() === '/') {
			return $this;
		}

		if ($this->baseFolder === null) {
			$ocFolder = $this->node;
			for ($i = 0; $i < substr_count($this->getPath(), '/'); $i++) {
				$ocFolder = $ocFolder->getParent();
			}

			$this->baseFolder = new StorageFolder($ocFolder);
		}

		return $this->baseFolder;
	}
}


nextcloud / cms_pico

Pull Request — master (#167)

StorageFolder::exists() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like