123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215 |
- <?php
- declare(strict_types=1);
- /**
- * @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Joas Schilling <coding@schilljs.com>
- * @author John Molakvoæ <skjnldsv@protonmail.com>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Marcel Klehr <mklehr@gmx.net>
- *
- * @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\SystemTags\Search;
- use OC\Files\Search\SearchComparison;
- use OC\Files\Search\SearchOrder;
- use OC\Files\Search\SearchQuery;
- 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\ISearchOrder;
- use OCP\IL10N;
- use OCP\IURLGenerator;
- use OCP\IUser;
- use OCP\Search\IProvider;
- use OCP\Search\ISearchQuery;
- use OCP\Search\SearchResult;
- use OCP\Search\SearchResultEntry;
- use OCP\SystemTag\ISystemTag;
- use OCP\SystemTag\ISystemTagManager;
- use OCP\SystemTag\ISystemTagObjectMapper;
- use RecursiveArrayIterator;
- use RecursiveIteratorIterator;
- class TagSearchProvider implements IProvider {
- /** @var IL10N */
- private $l10n;
- /** @var IURLGenerator */
- private $urlGenerator;
- /** @var IMimeTypeDetector */
- private $mimeTypeDetector;
- /** @var IRootFolder */
- private $rootFolder;
- private ISystemTagObjectMapper $objectMapper;
- private ISystemTagManager $tagManager;
- public function __construct(
- IL10N $l10n,
- IURLGenerator $urlGenerator,
- IMimeTypeDetector $mimeTypeDetector,
- IRootFolder $rootFolder,
- ISystemTagObjectMapper $objectMapper,
- ISystemTagManager $tagManager
- ) {
- $this->l10n = $l10n;
- $this->urlGenerator = $urlGenerator;
- $this->mimeTypeDetector = $mimeTypeDetector;
- $this->rootFolder = $rootFolder;
- $this->objectMapper = $objectMapper;
- $this->tagManager = $tagManager;
- }
- /**
- * @inheritDoc
- */
- public function getId(): string {
- return 'systemtags';
- }
- /**
- * @inheritDoc
- */
- public function getName(): string {
- return $this->l10n->t('Tags');
- }
- /**
- * @inheritDoc
- */
- public function getOrder(string $route, array $routeParameters): int {
- if ($route === 'files.View.index') {
- return -4;
- }
- return 6;
- }
- /**
- * @inheritDoc
- */
- public function search(IUser $user, ISearchQuery $query): SearchResult {
- $matchingTags = $this->tagManager->getAllTags(true, $query->getTerm());
- if (count($matchingTags) === 0) {
- return SearchResult::complete($this->l10n->t('Tags'), []);
- }
- $userFolder = $this->rootFolder->getUserFolder($user->getUID());
- $fileQuery = new SearchQuery(
- new SearchComparison(ISearchComparison::COMPARE_LIKE, 'systemtag', '%' . $query->getTerm() . '%'),
- $query->getLimit(),
- (int)$query->getCursor(),
- $query->getSortOrder() === ISearchQuery::SORT_DATE_DESC ? [
- new SearchOrder(ISearchOrder::DIRECTION_DESCENDING, 'mtime'),
- ] : [],
- $user
- );
- // do search
- $searchResults = $userFolder->search($fileQuery);
- $resultIds = array_map(function (Node $node) {
- return $node->getId();
- }, $searchResults);
- $matchedTags = $this->objectMapper->getTagIdsForObjects($resultIds, 'files');
- // prepare direct tag results
- $tagResults = array_map(function (ISystemTag $tag) {
- $thumbnailUrl = '';
- $link = $this->urlGenerator->linkToRoute(
- 'files.view.index'
- ) . '?view=systemtagsfilter&tags='.$tag->getId();
- $searchResultEntry = new SearchResultEntry(
- $thumbnailUrl,
- $this->l10n->t('All tagged %s …', [$tag->getName()]),
- '',
- $this->urlGenerator->getAbsoluteURL($link),
- 'icon-tag'
- );
- return $searchResultEntry;
- }, $matchingTags);
- // prepare files results
- return SearchResult::paginated(
- $this->l10n->t('Tags'),
- array_map(function (Node $result) use ($userFolder, $matchedTags, $query) {
- // Generate thumbnail url
- $thumbnailUrl = $this->urlGenerator->linkToRouteAbsolute('core.Preview.getPreviewByFileId', ['x' => 32, 'y' => 32, 'fileId' => $result->getId()]);
- $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($query, $matchedTags[$result->getId()]),
- $this->urlGenerator->getAbsoluteURL($link),
- $result->getMimetype() === FileInfo::MIMETYPE_FOLDER ? 'icon-folder' : $this->mimeTypeDetector->mimeTypeIcon($result->getMimetype())
- );
- $searchResultEntry->addAttribute('fileId', (string)$result->getId());
- $searchResultEntry->addAttribute('path', $path);
- return $searchResultEntry;
- }, $searchResults)
- + $tagResults,
- $query->getCursor() + $query->getLimit()
- );
- }
- /**
- * Format subline for tagged files: Show the first 3 tags
- *
- * @param $query
- * @param array $tagInfo
- * @return string
- */
- private function formatSubline(ISearchQuery $query, array $tagInfo): string {
- /**
- * @var ISystemTag[]
- */
- $tags = $this->tagManager->getTagsByIds($tagInfo);
- $tagNames = array_map(function ($tag) {
- return $tag->getName();
- }, array_filter($tags, function ($tag) {
- return $tag->isUserVisible();
- }));
- // show the tag that you have searched for first
- usort($tagNames, function ($tagName) use ($query) {
- return strpos($tagName, $query->getTerm()) !== false? -1 : 1;
- });
- return $this->l10n->t('tagged %s', [implode(', ', array_slice($tagNames, 0, 3))]);
- }
- private function flattenArray($array) {
- $it = new RecursiveIteratorIterator(new RecursiveArrayIterator($array));
- return iterator_to_array($it, true);
- }
- }
|