* * @author Christoph Wurst * @author Joas Schilling * @author John Molakvoæ * @author Robin Appelman * @author Roeland Jago Douma * * @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 . * */ namespace OCA\Files\Search; use InvalidArgumentException; use OC\Files\Search\SearchBinaryOperator; use OC\Files\Search\SearchComparison; use OC\Files\Search\SearchOrder; use OC\Files\Search\SearchQuery; use OC\Search\Filter\GroupFilter; use OC\Search\Filter\UserFilter; use OCP\Files\FileInfo; use OCP\Files\IMimeTypeDetector; use OCP\Files\IRootFolder; use OCP\Files\Node; use OCP\Files\Search\ISearchComparison; use OCP\Files\Search\ISearchOperator; use OCP\Files\Search\ISearchOrder; use OCP\IL10N; use OCP\IPreview; use OCP\IURLGenerator; use OCP\IUser; use OCP\Search\FilterDefinition; use OCP\Search\IFilter; use OCP\Search\IFilteringProvider; use OCP\Search\ISearchQuery; use OCP\Search\SearchResult; use OCP\Search\SearchResultEntry; use OCP\Share\IShare; class FilesSearchProvider implements IFilteringProvider { /** @var IL10N */ private $l10n; /** @var IURLGenerator */ private $urlGenerator; /** @var IMimeTypeDetector */ private $mimeTypeDetector; /** @var IRootFolder */ private $rootFolder; public function __construct( IL10N $l10n, IURLGenerator $urlGenerator, IMimeTypeDetector $mimeTypeDetector, IRootFolder $rootFolder, private IPreview $previewManager, ) { $this->l10n = $l10n; $this->urlGenerator = $urlGenerator; $this->mimeTypeDetector = $mimeTypeDetector; $this->rootFolder = $rootFolder; } /** * @inheritDoc */ public function getId(): string { return 'files'; } /** * @inheritDoc */ public function getName(): string { return $this->l10n->t('Files'); } /** * @inheritDoc */ public function getOrder(string $route, array $routeParameters): int { if ($route === 'files.View.index') { // Before comments return -5; } return 5; } public function getSupportedFilters(): array { return [ 'term', 'since', 'until', 'person', 'min-size', 'max-size', 'mime', 'type', 'path', 'is-favorite', 'title-only', ]; } public function getAlternateIds(): array { return []; } public function getCustomFilters(): array { return [ new FilterDefinition('min-size', FilterDefinition::TYPE_INT), new FilterDefinition('max-size', FilterDefinition::TYPE_INT), new FilterDefinition('mime', FilterDefinition::TYPE_STRING), new FilterDefinition('type', FilterDefinition::TYPE_STRING), new FilterDefinition('path', FilterDefinition::TYPE_STRING), new FilterDefinition('is-favorite', FilterDefinition::TYPE_BOOL), ]; } public function search(IUser $user, ISearchQuery $query): SearchResult { $userFolder = $this->rootFolder->getUserFolder($user->getUID()); $fileQuery = $this->buildSearchQuery($query, $user); return SearchResult::paginated( $this->l10n->t('Files'), array_map(function (Node $result) use ($userFolder) { $thumbnailUrl = $this->previewManager->isMimeSupported($result->getMimetype()) ? $this->urlGenerator->linkToRouteAbsolute('core.Preview.getPreviewByFileId', ['x' => 32, 'y' => 32, 'fileId' => $result->getId()]) : ''; $icon = $result->getMimetype() === FileInfo::MIMETYPE_FOLDER ? 'icon-folder' : $this->mimeTypeDetector->mimeTypeIcon($result->getMimetype()); $path = $userFolder->getRelativePath($result->getPath()); // Use shortened link to centralize the various // files/folder url redirection in files.View.showFile $link = $this->urlGenerator->linkToRoute( 'files.View.showFile', ['fileid' => $result->getId()] ); $searchResultEntry = new SearchResultEntry( $thumbnailUrl, $result->getName(), $this->formatSubline($path), $this->urlGenerator->getAbsoluteURL($link), $icon, ); $searchResultEntry->addAttribute('fileId', (string)$result->getId()); $searchResultEntry->addAttribute('path', $path); return $searchResultEntry; }, $userFolder->search($fileQuery)), $query->getCursor() + $query->getLimit() ); } private function buildSearchQuery(ISearchQuery $query, IUser $user): SearchQuery { $comparisons = []; foreach ($query->getFilters() as $name => $filter) { $comparisons[] = match ($name) { 'term' => new SearchComparison(ISearchComparison::COMPARE_LIKE, 'name', '%' . $filter->get() . '%'), 'since' => new SearchComparison(ISearchComparison::COMPARE_GREATER_THAN_EQUAL, 'mtime', $filter->get()->getTimestamp()), 'until' => new SearchComparison(ISearchComparison::COMPARE_LESS_THAN_EQUAL, 'mtime', $filter->get()->getTimestamp()), 'min-size' => new SearchComparison(ISearchComparison::COMPARE_GREATER_THAN_EQUAL, 'size', $filter->get()), 'max-size' => new SearchComparison(ISearchComparison::COMPARE_LESS_THAN_EQUAL, 'size', $filter->get()), 'mime' => new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'mimetype', $filter->get()), 'type' => new SearchComparison(ISearchComparison::COMPARE_LIKE, 'mimetype', $filter->get() . '/%'), 'path' => new SearchComparison(ISearchComparison::COMPARE_LIKE, 'path', 'files/' . ltrim($filter->get(), '/') . '%'), 'person' => $this->buildPersonSearchQuery($filter), default => throw new InvalidArgumentException('Unsupported comparison'), }; } return new SearchQuery( new SearchBinaryOperator(SearchBinaryOperator::OPERATOR_AND, $comparisons), $query->getLimit(), (int) $query->getCursor(), $query->getSortOrder() === ISearchQuery::SORT_DATE_DESC ? [new SearchOrder(ISearchOrder::DIRECTION_DESCENDING, 'mtime')] : [], $user ); } private function buildPersonSearchQuery(IFilter $person): ISearchOperator { if ($person instanceof UserFilter) { return new SearchBinaryOperator(SearchBinaryOperator::OPERATOR_OR, [ new SearchBinaryOperator(SearchBinaryOperator::OPERATOR_AND, [ new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'share_with', $person->get()->getUID()), new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'share_type', IShare::TYPE_USER), ]), new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'owner', $person->get()->getUID()), ]); } if ($person instanceof GroupFilter) { return new SearchBinaryOperator(SearchBinaryOperator::OPERATOR_AND, [ new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'share_with', $person->get()->getGID()), new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'share_type', IShare::TYPE_GROUP), ]); } throw new InvalidArgumentException('Unsupported filter type'); } /** * Format subline for files * * @param string $path * @return string */ private function formatSubline(string $path): string { // Do not show the location if the file is in root if (strrpos($path, '/') > 0) { $path = ltrim(dirname($path), '/'); return $this->l10n->t('in %s', [$path]); } else { return ''; } } }