Files: Extend search to also cover tagstags/v25.0.0beta1
'OCA\\SystemTags\\Activity\\Setting' => $baseDir . '/../lib/Activity/Setting.php', | 'OCA\\SystemTags\\Activity\\Setting' => $baseDir . '/../lib/Activity/Setting.php', | ||||
'OCA\\SystemTags\\AppInfo\\Application' => $baseDir . '/../lib/AppInfo/Application.php', | 'OCA\\SystemTags\\AppInfo\\Application' => $baseDir . '/../lib/AppInfo/Application.php', | ||||
'OCA\\SystemTags\\Controller\\LastUsedController' => $baseDir . '/../lib/Controller/LastUsedController.php', | 'OCA\\SystemTags\\Controller\\LastUsedController' => $baseDir . '/../lib/Controller/LastUsedController.php', | ||||
'OCA\\SystemTags\\Search\\TagSearchProvider' => $baseDir . '/../lib/Search/TagSearchProvider.php', | |||||
'OCA\\SystemTags\\Settings\\Admin' => $baseDir . '/../lib/Settings/Admin.php', | 'OCA\\SystemTags\\Settings\\Admin' => $baseDir . '/../lib/Settings/Admin.php', | ||||
); | ); |
'OCA\\SystemTags\\Activity\\Setting' => __DIR__ . '/..' . '/../lib/Activity/Setting.php', | 'OCA\\SystemTags\\Activity\\Setting' => __DIR__ . '/..' . '/../lib/Activity/Setting.php', | ||||
'OCA\\SystemTags\\AppInfo\\Application' => __DIR__ . '/..' . '/../lib/AppInfo/Application.php', | 'OCA\\SystemTags\\AppInfo\\Application' => __DIR__ . '/..' . '/../lib/AppInfo/Application.php', | ||||
'OCA\\SystemTags\\Controller\\LastUsedController' => __DIR__ . '/..' . '/../lib/Controller/LastUsedController.php', | 'OCA\\SystemTags\\Controller\\LastUsedController' => __DIR__ . '/..' . '/../lib/Controller/LastUsedController.php', | ||||
'OCA\\SystemTags\\Search\\TagSearchProvider' => __DIR__ . '/..' . '/../lib/Search/TagSearchProvider.php', | |||||
'OCA\\SystemTags\\Settings\\Admin' => __DIR__ . '/..' . '/../lib/Settings/Admin.php', | 'OCA\\SystemTags\\Settings\\Admin' => __DIR__ . '/..' . '/../lib/Settings/Admin.php', | ||||
); | ); | ||||
*/ | */ | ||||
namespace OCA\SystemTags\AppInfo; | namespace OCA\SystemTags\AppInfo; | ||||
use OCA\SystemTags\Search\TagSearchProvider; | |||||
use OCA\SystemTags\Activity\Listener; | use OCA\SystemTags\Activity\Listener; | ||||
use OCP\AppFramework\App; | use OCP\AppFramework\App; | ||||
use OCP\AppFramework\Bootstrap\IBootContext; | use OCP\AppFramework\Bootstrap\IBootContext; | ||||
} | } | ||||
public function register(IRegistrationContext $context): void { | public function register(IRegistrationContext $context): void { | ||||
$context->registerSearchProvider(TagSearchProvider::class); | |||||
} | } | ||||
public function boot(IBootContext $context): void { | public function boot(IBootContext $context): void { |
<?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\SearchBinaryOperator; | |||||
use OC\Files\Search\SearchComparison; | |||||
use OC\Files\Search\SearchOrder; | |||||
use OC\Files\Search\SearchQuery; | |||||
use OCP\SystemTag\ISystemTag; | |||||
use OCP\SystemTag\ISystemTagManager; | |||||
use OCP\SystemTag\ISystemTagObjectMapper; | |||||
use OCP\Files\FileInfo; | |||||
use OCP\Files\IMimeTypeDetector; | |||||
use OCP\Files\IRootFolder; | |||||
use OCP\Files\Search\ISearchComparison; | |||||
use OCP\Files\Node; | |||||
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 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 { | |||||
$userFolder = $this->rootFolder->getUserFolder($user->getUID()); | |||||
$fileQuery = new SearchQuery( | |||||
new SearchBinaryOperator(SearchBinaryOperator::OPERATOR_OR, [ | |||||
new SearchComparison(ISearchComparison::COMPARE_LIKE, 'tagname', '%' . $query->getTerm() . '%'), | |||||
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'); | |||||
$relevantTags = $this->tagManager->getTagsByIds(array_unique($this->flattenArray($matchedTags))); | |||||
// 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; | |||||
}, array_filter($relevantTags, function($tag) use ($query) { | |||||
return $tag->isUserVisible() && strpos($tag->getName(), $query->getTerm()) !== false; | |||||
})); | |||||
// 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); | |||||
} | |||||
} |
return this._fileList | return this._fileList | ||||
} | } | ||||
const tagsParam = (new URL(window.location.href)).searchParams.get('tags') | |||||
const initialTags = tagsParam ? tagsParam.split(',').map(parseInt) : [] | |||||
this._fileList = new OCA.SystemTags.FileList( | this._fileList = new OCA.SystemTags.FileList( | ||||
$el, | $el, | ||||
{ | { | ||||
// done if handling the event with the file list already | // done if handling the event with the file list already | ||||
// created. | // created. | ||||
shown: true, | shown: true, | ||||
systemTagIds: initialTags | |||||
} | } | ||||
) | ) | ||||
_initFilterField($container) { | _initFilterField($container) { | ||||
const self = this | const self = this | ||||
this.$filterField = $('<input type="hidden" name="tags"/>') | this.$filterField = $('<input type="hidden" name="tags"/>') | ||||
this.$filterField.val(this._systemTagIds.join(',')) | |||||
$container.append(this.$filterField) | $container.append(this.$filterField) | ||||
this.$filterField.select2({ | this.$filterField.select2({ | ||||
placeholder: t('systemtags', 'Select tags to filter by'), | placeholder: t('systemtags', 'Select tags to filter by'), | ||||
tags.push(tag.toJSON()) | tags.push(tag.toJSON()) | ||||
} | } | ||||
}) | }) | ||||
callback(tags) | callback(tags) | ||||
self._onTagsChanged({ target: element }) | |||||
}, | }, | ||||
}) | }) | ||||
} else { | } else { |
public function selectFileCache(string $alias = null) { | public function selectFileCache(string $alias = null) { | ||||
$name = $alias ? $alias : 'filecache'; | $name = $alias ? $alias : 'filecache'; | ||||
$this->select("$name.fileid", 'storage', 'path', 'path_hash', "$name.parent", 'name', 'mimetype', 'mimepart', 'size', 'mtime', | |||||
$this->select("$name.fileid", 'storage', 'path', 'path_hash', "$name.parent", "$name.name", 'mimetype', 'mimepart', 'size', 'mtime', | |||||
'storage_mtime', 'encrypted', 'etag', 'permissions', 'checksum', 'metadata_etag', 'creation_time', 'upload_time') | 'storage_mtime', 'encrypted', 'etag', 'permissions', 'checksum', 'metadata_etag', 'creation_time', 'upload_time') | ||||
->from('filecache', $name) | ->from('filecache', $name) | ||||
->leftJoin($name, 'filecache_extended', 'fe', $this->expr()->eq("$name.fileid", 'fe.fileid')); | ->leftJoin($name, 'filecache_extended', 'fe', $this->expr()->eq("$name.fileid", 'fe.fileid')); |
use OC\Files\Search\QueryOptimizer\QueryOptimizer; | use OC\Files\Search\QueryOptimizer\QueryOptimizer; | ||||
use OC\Files\Search\SearchBinaryOperator; | use OC\Files\Search\SearchBinaryOperator; | ||||
use OC\SystemConfig; | use OC\SystemConfig; | ||||
use OCP\DB\QueryBuilder\IQueryBuilder; | |||||
use OCP\Files\Cache\ICache; | use OCP\Files\Cache\ICache; | ||||
use OCP\Files\Cache\ICacheEntry; | use OCP\Files\Cache\ICacheEntry; | ||||
use OCP\Files\IMimeTypeLoader; | use OCP\Files\IMimeTypeLoader; | ||||
throw new \InvalidArgumentException("Searching by tag requires the user to be set in the query"); | throw new \InvalidArgumentException("Searching by tag requires the user to be set in the query"); | ||||
} | } | ||||
$query | $query | ||||
->innerJoin('file', 'vcategory_to_object', 'tagmap', $builder->expr()->eq('file.fileid', 'tagmap.objid')) | |||||
->innerJoin('tagmap', 'vcategory', 'tag', $builder->expr()->andX( | |||||
->leftJoin('file', 'vcategory_to_object', 'tagmap', $builder->expr()->eq('file.fileid', 'tagmap.objid')) | |||||
->leftJoin('tagmap', 'vcategory', 'tag', $builder->expr()->andX( | |||||
$builder->expr()->eq('tagmap.type', 'tag.type'), | $builder->expr()->eq('tagmap.type', 'tag.type'), | ||||
$builder->expr()->eq('tagmap.categoryid', 'tag.id') | |||||
$builder->expr()->eq('tagmap.categoryid', 'tag.id'), | |||||
$builder->expr()->eq('tag.type', $builder->createNamedParameter('files')), | |||||
$builder->expr()->eq('tag.uid', $builder->createNamedParameter($user->getUID())) | |||||
)) | )) | ||||
->andWhere($builder->expr()->eq('tag.type', $builder->createNamedParameter('files'))) | |||||
->andWhere($builder->expr()->eq('tag.uid', $builder->createNamedParameter($user->getUID()))); | |||||
->leftJoin('file', 'systemtag_object_mapping', 'systemtagmap', $builder->expr()->andX( | |||||
$builder->expr()->eq('file.fileid', $builder->expr()->castColumn('systemtagmap.objectid', IQueryBuilder::PARAM_INT)), | |||||
$builder->expr()->eq('systemtagmap.objecttype', $builder->createNamedParameter('files')) | |||||
)) | |||||
->leftJoin('systemtagmap', 'systemtag', 'systemtag', $builder->expr()->andX( | |||||
$builder->expr()->eq('systemtag.id', 'systemtagmap.systemtagid'), | |||||
$builder->expr()->eq('systemtag.visibility', $builder->createNamedParameter(true)) | |||||
)); | |||||
} | } | ||||
$storageFilters = array_values(array_map(function (ICache $cache) { | $storageFilters = array_values(array_map(function (ICache $cache) { |
return $shouldJoin || $this->shouldJoinTags($operator); | return $shouldJoin || $this->shouldJoinTags($operator); | ||||
}, false); | }, false); | ||||
} elseif ($operator instanceof ISearchComparison) { | } elseif ($operator instanceof ISearchComparison) { | ||||
return $operator->getField() === 'tagname' || $operator->getField() === 'favorite'; | |||||
return $operator->getField() === 'tagname' || $operator->getField() === 'favorite' || $operator->getField() === 'systemtag'; | |||||
} | } | ||||
return false; | return false; | ||||
} | } | ||||
} elseif ($field === 'favorite') { | } elseif ($field === 'favorite') { | ||||
$field = 'tag.category'; | $field = 'tag.category'; | ||||
$value = self::TAG_FAVORITE; | $value = self::TAG_FAVORITE; | ||||
} elseif ($field === 'name') { | |||||
$field = 'file.name'; | |||||
} elseif ($field === 'tagname') { | } elseif ($field === 'tagname') { | ||||
$field = 'tag.category'; | $field = 'tag.category'; | ||||
} elseif ($field === 'systemtag') { | |||||
$field = 'systemtag.name'; | |||||
} elseif ($field === 'fileid') { | } elseif ($field === 'fileid') { | ||||
$field = 'file.fileid'; | $field = 'file.fileid'; | ||||
} elseif ($field === 'path' && $type === ISearchComparison::COMPARE_EQUAL && $operator->getQueryHint(ISearchComparison::HINT_PATH_EQ_HASH, true)) { | } elseif ($field === 'path' && $type === ISearchComparison::COMPARE_EQUAL && $operator->getQueryHint(ISearchComparison::HINT_PATH_EQ_HASH, true)) { | ||||
'path' => 'string', | 'path' => 'string', | ||||
'size' => 'integer', | 'size' => 'integer', | ||||
'tagname' => 'string', | 'tagname' => 'string', | ||||
'systemtag' => 'string', | |||||
'favorite' => 'boolean', | 'favorite' => 'boolean', | ||||
'fileid' => 'integer', | 'fileid' => 'integer', | ||||
'storage' => 'integer', | 'storage' => 'integer', | ||||
'path' => ['eq', 'like', 'clike'], | 'path' => ['eq', 'like', 'clike'], | ||||
'size' => ['eq', 'gt', 'lt', 'gte', 'lte'], | 'size' => ['eq', 'gt', 'lt', 'gte', 'lte'], | ||||
'tagname' => ['eq', 'like'], | 'tagname' => ['eq', 'like'], | ||||
'systemtag' => ['eq', 'like'], | |||||
'favorite' => ['eq'], | 'favorite' => ['eq'], | ||||
'fileid' => ['eq'], | 'fileid' => ['eq'], | ||||
'storage' => ['eq'], | 'storage' => ['eq'], |
$this->numericStorageId = 10000; | $this->numericStorageId = 10000; | ||||
$this->builder->select(['fileid']) | $this->builder->select(['fileid']) | ||||
->from('filecache') | |||||
->from('filecache', 'file') // alias needed for QuerySearchHelper#getOperatorFieldAndValue | |||||
->where($this->builder->expr()->eq('storage', new Literal($this->numericStorageId))); | ->where($this->builder->expr()->eq('storage', new Literal($this->numericStorageId))); | ||||
} | } | ||||