OCA\Files_FullTextSearch\Service\GroupFoldersService

Complexity

Total Complexity

18

Size/Duplication

Total Lines	218
Duplicated Lines	17.89 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	13	13	1
A	initGroupShares()	0	8	2
A	getFileSource()	0	12	2
B	updateDocumentAccess()	0	29	2
A	getShareUsers()	0	8	2
A	isMountFullGlobal()	15	15	4
A	getGroupFolderMount()	11	11	3
A	getGroupFoldersMounts()	0	18	2

<?php
/**
 * Files_FullTextSearch - Index the content of your files
 *
 * 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 2018
 * @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\Files_FullTextSearch\Service;


use OCA\Files_FullTextSearch\Exceptions\FileIsNotIndexableException;
use OCA\Files_FullTextSearch\Exceptions\KnownFileSourceException;
use OCA\Files_FullTextSearch\Model\FilesDocument;
use OCA\Files_FullTextSearch\Model\GroupFolderMount;
use OCP\App;
use OCP\Files\IRootFolder;
use OCP\Files\Node;
use OCP\IUserManager;
use OCP\Share\IManager;

class GroupFoldersService {


	const DOCUMENT_SOURCE = 'group_folders';

	/** @var IRootFolder */
	private $rootFolder;

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

	/** @var IManager */
	private $shareManager;

	/** @var LocalFilesService */
	private $localFilesService;

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

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


	/** @var GroupFolderMount[] */
	private $groupFolders = [];


	/**
	 * ExternalFilesService constructor.
	 *
	 * @param IRootFolder $rootFolder
	 * @param IUserManager $userManager
	 * @param IManager $shareManager
	 * @param LocalFilesService $localFilesService
	 * @param ConfigService $configService
	 * @param MiscService $miscService
	 */
	public function __construct(

This method seems to be duplicated in your project.

		IRootFolder $rootFolder, IUserManager $userManager, IManager $shareManager,
		LocalFilesService $localFilesService, ConfigService $configService, MiscService $miscService
	) {
		$this->rootFolder = $rootFolder;
		$this->userManager = $userManager;
		$this->shareManager = $shareManager;

		$this->localFilesService = $localFilesService;

		$this->configService = $configService;
		$this->miscService = $miscService;
	}


	/**
	 *
	 */
	public function initGroupShares() {
		$this->groupFolders = [];
		if (!App::isEnabled('groupfolders')) {
			return;
		}

		$this->groupFolders = $this->getGroupFoldersMounts();
	}


	/**
	 * @param Node $file
	 *
	 * @param string $source
	 *
	 * @throws KnownFileSourceException
	 */
	public function getFileSource(Node $file, &$source) {


		try {
			$this->getGroupFolderMount($file);
		} catch (FileIsNotIndexableException $e) {
			return;
		}

		$source = self::DOCUMENT_SOURCE;
		throw new KnownFileSourceException();
	}

//

40% of this comment could be valid code. Did you maybe forget this after debugging?

//	/**
//	 * @param DocumentAccess $access
//	 *
//	 * @return array
//	 */
//	public function getAllSharesFromExternalFile(DocumentAccess $access) {
//		$result = $access->getUsers();
//
//		if ($access->getOwnerId() !== '') {
//			array_push($result, $access->getOwnerId());
//		}
//
//		// TODO: get users from groups & circles.
//		return $result;
//	}


	/**
	 * @param FilesDocument $document
	 * @param Node $file
	 */
	public function updateDocumentAccess(FilesDocument &$document, Node $file) {

The parameter $file is not used and could be removed.

		if ($document->getSource() !== self::DOCUMENT_SOURCE) {
			return;
		}

//		try {

49% of this comment could be valid code. Did you maybe forget this after debugging?

//			$mount = $this->getGroupFolderMount($file);
//		} catch (FileIsNotIndexableException $e) {
//			return;
//		}

		$access = $document->getAccess();
		echo json_encode($access);
//		if ($this->isMountFullGlobal($mount)) {

63% of this comment could be valid code. Did you maybe forget this after debugging?

//			$access->addUsers(['__all']);
//		} else {
//			$access->addUsers($mount->getUsers());
//			$access->addGroups($mount->getGroups());
////		 	$access->addCircles($mount->getCircles());
//		}
//
//		// twist 'n tweak.
//		if (!$mount->isGlobal()) {
//			$access->setOwnerId($mount->getUsers()[0]);
//		}

		$document->setAccess($access);
	}


	/**
	 * @param FilesDocument $document
	 * @param array $users
	 */
	public function getShareUsers(FilesDocument $document, &$users) {

		if ($document->getSource() !== self::DOCUMENT_SOURCE) {
			return;
		}

		$this->localFilesService->getSharedUsersFromAccess($document->getAccess(), $users);
	}


	/**
	 * @param GroupFolderMount $mount
	 *
	 * @return bool
	 */
	public function isMountFullGlobal(GroupFolderMount $mount) {

This method seems to be duplicated in your project.

		if (sizeof($mount->getGroups()) > 0) {
			return false;
		}

		if (sizeof($mount->getUsers()) !== 1) {
			return false;
		}

		if ($mount->getUsers()[0] === 'all') {

This if statement, and the following return statement can be replaced with return $mount->getUsers()[0] === 'all';.

			return true;
		}

		return false;
	}


	/**
	 * @param Node $file
	 *
	 * @return GroupFolderMount
	 * @throws FileIsNotIndexableException
	 */
	private function getGroupFolderMount(Node $file) {

This method seems to be duplicated in your project.

		foreach ($this->groupFolders as $mount) {
			if (strpos($file->getPath(), $mount->getPath()) === 0) {
				return $mount;
			}
		}

		throw new FileIsNotIndexableException();

	}


	/**
	 * @return GroupFolderMount[]
	 */
	private function getGroupFoldersMounts() {

		$groupFolders = [];

		// TODO: deprecated - use UserGlobalStoragesService::getStorages() and UserStoragesService::getStorages()

37% of this comment could be valid code. Did you maybe forget this after debugging?

This line exceeds maximum limit of 100 characters; contains 107 characters

		$mounts = [];
		foreach ($mounts as $mountPoint => $mount) {
			$groupFolder = new GroupFolderMount();
//			$externalMount->setId($mount['id'])

76% of this comment could be valid code. Did you maybe forget this after debugging?

//						  ->setPath($mountPoint)
//						  ->setGroups($mount['applicable']['groups'])
//						  ->setUsers($mount['applicable']['users'])
//						  ->setGlobal((!$mount['personal']));
			$groupFolders[] = $groupFolder;
		}

		return $groupFolders;
	}


}