OCA\Files_FullTextSearch\Provider\FilesProvider

Complexity

Total Complexity

23

Size/Duplication

Total Lines	322
Duplicated Lines	3.73 %

Coupling/Cohesion

Components	2
Dependencies	6

Importance

Changes

0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	onInitializingIndex()	0	3	1
A	onResettingIndex()	0	3	1
A	unloadProvider()	0	2	1
A	improveSearchRequest()	0	3	1
A	improveSearchResult()	0	3	1
A	__construct()	12	12	1
A	getId()	0	3	1
A	getName()	0	3	1
A	getVersion()	0	3	1
A	getConfiguration()	0	3	1
A	getAppId()	0	3	1
A	setRunner()	0	3	1
A	setIndexOptions()	0	3	1
B	getOptionsTemplate()	0	63	1
A	getOptions()	0	3	1
A	loadProvider()	0	10	1
A	generateIndexableDocuments()	0	5	1
A	fillIndexDocuments()	0	3	1
A	fillIndexDocument()	0	5	1
A	isDocumentUpToDate()	0	3	1
A	updateDocument()	0	6	1
A	updateRunnerInfo()	0	7	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\Provider;

use OCA\Files_FullTextSearch\AppInfo\Application;
use OCA\Files_FullTextSearch\Exceptions\FileIsNotIndexableException;
use OCA\Files_FullTextSearch\Model\FilesDocument;
use OCA\Files_FullTextSearch\Service\ConfigService;
use OCA\Files_FullTextSearch\Service\ElasticSearchService;
use OCA\Files_FullTextSearch\Service\FilesService;
use OCA\Files_FullTextSearch\Service\MiscService;
use OCA\Files_FullTextSearch\Service\SearchService;
use OCA\FullTextSearch\IFullTextSearchPlatform;
use OCA\FullTextSearch\IFullTextSearchProvider;
use OCA\FullTextSearch\Model\Index;
use OCA\FullTextSearch\Model\IndexDocument;
use OCA\FullTextSearch\Model\IndexOptions;
use OCA\FullTextSearch\Model\Runner;
use OCA\FullTextSearch\Model\SearchRequest;
use OCA\FullTextSearch\Model\SearchResult;
use OCP\AppFramework\QueryException;
use OCP\Files\InvalidPathException;
use OCP\Files\NotFoundException;
use OCP\Files\NotPermittedException;
use OCP\IL10N;

class FilesProvider implements IFullTextSearchProvider {


	const FILES_PROVIDER_ID = 'files';


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

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

	/** @var FilesService */
	private $filesService;

	/** @var SearchService */
	private $searchService;

	/** @var ElasticSearchService */
	private $elasticSearchService;

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


	/** @var Runner */
	private $runner;

	/** @var IndexOptions */
	private $indexOptions = [];


	public function __construct(

This method seems to be duplicated in your project.

		IL10N $l10n, ConfigService $configService, FilesService $filesService,
		SearchService $searchService, ElasticSearchService $elasticSearchService,
		MiscService $miscService
	) {
		$this->l10n = $l10n;
		$this->configService = $configService;
		$this->filesService = $filesService;
		$this->searchService = $searchService;
		$this->elasticSearchService = $elasticSearchService;
		$this->miscService = $miscService;
	}

	/**
	 * return unique id of the provider
	 */
	public function getId() {
		return self::FILES_PROVIDER_ID;
	}


	/**
	 * return name of the provider
	 */
	public function getName() {
		return 'Files';
	}


	/**
	 * @deprecated
	 * @return string
	 */
	public function getVersion() {
		return '';
	}


	/**
	 * @return array
	 */
	public function getConfiguration() {
		return $this->configService->getConfig();
	}


	/**
	 * @deprecated
	 * @return string
	 */
	public function getAppId() {
		return '';
	}


	public function setRunner(Runner $runner) {
		$this->runner = $runner;
	}


	/**
	 * @param IndexOptions $options
	 */
	public function setIndexOptions($options) {
		$this->indexOptions = $options;
	}


	/**
	 * @return array

Consider making the return type a bit more specific; maybe use array<string,array>.

	 */
	public function getOptionsTemplate() {
//				'template' => 'options.panel',
		return [
			'panel'      => [
				'options' => [
					[
						'name'  => 'files_within_dir',
						'title' => $this->l10n->t('Within current directory'),
						'type'  => 'checkbox'
					],
					[
						'name'  => 'files_local',
						'title' => $this->l10n->t('Within local files'),
						'type'  => 'checkbox'
					],
					[
						'name'  => 'files_external',
						'title' => $this->l10n->t('Within external files'),
						'type'  => 'checkbox'
					],
					[
						'name'  => 'files_group_folders',
						'title' => $this->l10n->t('Within group folders'),
						'type'  => 'checkbox'
					],
					[
						'name'        => 'files_extension',
						'title'       => $this->l10n->t('Filter by extension'),
						'type'        => 'input',
						'size'        => 'small',
						'placeholder' => 'txt'
					]
				]
			],
			'navigation' => [
				'icon'    => 'icon-fts-files',
				'options' => [
					[
						'name'  => 'files_local',
						'title' => $this->l10n->t('Local Files'),
						'type'  => 'checkbox'
					],
					[
						'name'  => 'files_external',
						'title' => $this->l10n->t('External Files'),
						'type'  => 'checkbox'
					],
					[
						'name'  => 'files_group_folders',
						'title' => $this->l10n->t('Group Folders'),
						'type'  => 'checkbox'
					],
					[
						'name'        => 'files_extension',
						'title'       => $this->l10n->t('Extension'),
						'type'        => 'input',
						'size'        => 'small',
						'placeholder' => 'txt'
					]
				]
			]
		];
	}


	/**
	 * @deprecated
	 */
	public function getOptions() {
		return $this->getOptionsTemplate();
	}


	/**
	 * called when loading all providers.
	 *
	 * Loading some containers.
	 *
	 * @throws QueryException
	 */
	public function loadProvider() {
		$app = new Application();

		$container = $app->getContainer();
		$this->configService = $container->query(ConfigService::class);
		$this->filesService = $container->query(FilesService::class);
		$this->searchService = $container->query(SearchService::class);
		$this->elasticSearchService = $container->query(ElasticSearchService::class);
		$this->miscService = $container->query(MiscService::class);
	}


	/**
	 * returns all indexable document for a user.
	 * There is no need to fill the document with content at this point.
	 *
	 * $platform is provided if the mapping needs to be changed.
	 *
	 * @param string $userId
	 *
	 * @return IndexDocument[]

Consider making the return type a bit more specific; maybe use FilesDocument[].

	 * @throws InvalidPathException
	 * @throws NotFoundException
	 */
	public function generateIndexableDocuments($userId) {
		$files = $this->filesService->getFilesFromUser($userId, $this->indexOptions);

		return $files;
	}


	/**
	 * generate documents prior to the indexing.
	 * throw NoResultException if no more result
	 *
	 * @param IndexDocument[] $chunk
	 *
	 * @return IndexDocument[]
	 * @deprecated
	 */
	public function fillIndexDocuments($chunk) {
		return [];
	}


	/**
	 * @param IndexDocument $document
	 */
	public function fillIndexDocument(IndexDocument $document) {
		/** @var FilesDocument $document */
		$this->filesService->generateDocument($document);
		$this->updateRunnerInfo('info', $document->getMimetype());
	}


	/**
	 * @param IndexDocument $document
	 *
	 * @return bool
	 */
	public function isDocumentUpToDate($document) {
		return $this->filesService->isDocumentUpToDate($document);
	}


	/**
	 * @param Index $index
	 *
	 * @return IndexDocument

Consider making the return type a bit more specific; maybe use FilesDocument.

	 * @throws InvalidPathException
	 * @throws NotFoundException
	 * @throws NotPermittedException
	 * @throws FileIsNotIndexableException
	 */
	public function updateDocument(Index $index) {
		$document = $this->filesService->updateDocument($index);
		$this->updateRunnerInfo('info', $document->getMimetype());

		return $document;
	}


	/**
	 * @param IFullTextSearchPlatform $platform
	 */
	public function onInitializingIndex(IFullTextSearchPlatform $platform) {
		$this->elasticSearchService->onInitializingIndex($platform);
	}


	/**
	 * @param IFullTextSearchPlatform $platform
	 */
	public function onResettingIndex(IFullTextSearchPlatform $platform) {
		$this->elasticSearchService->onResettingIndex($platform);
	}


	/**
	 * not used yet
	 */
	public function unloadProvider() {
	}


	/**
	 * before a search, improve the request
	 *
	 * @param SearchRequest $request
	 */
	public function improveSearchRequest(SearchRequest $request) {
		$this->searchService->improveSearchRequest($request);
	}


	/**
	 * after a search, improve results
	 *
	 * @param SearchResult $searchResult
	 */
	public function improveSearchResult(SearchResult $searchResult) {
		$this->searchService->improveSearchResult($searchResult);
	}


	/**
	 * @param string $info
	 * @param string $value
	 */
	private function updateRunnerInfo($info, $value) {
		if ($this->runner === null) {
			return;
		}

		$this->runner->setInfo($info, $value);
	}


}