-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate comments to unified search API
Signed-off-by: Christoph Wurst <[email protected]>
- Loading branch information
1 parent
052048d
commit 1a58419
Showing
7 changed files
with
222 additions
and
77 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright 2020 Christoph Wurst <[email protected]> | ||
| * | ||
| * @author 2020 Christoph Wurst <[email protected]> | ||
| * | ||
| * @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\Comments\Search; | ||
|
|
||
| use OCP\Search\ASearchResultEntry; | ||
|
|
||
| class CommentsSearchResultEntry extends ASearchResultEntry { | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright (c) 2018 Joas Schilling <[email protected]> | ||
| * | ||
| * @author Joas Schilling <[email protected]> | ||
| * | ||
| * @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\Comments\Search; | ||
|
|
||
| use OCP\Comments\IComment; | ||
| use OCP\Files\Folder; | ||
| use OCP\Files\Node; | ||
| use OCP\Files\NotFoundException; | ||
| use OCP\IUser; | ||
| use OCP\Search\Provider; | ||
| use function count; | ||
|
|
||
| class LegacyProvider extends Provider { | ||
|
|
||
| /** | ||
| * Search for $query | ||
| * | ||
| * @param string $query | ||
| * @return array An array of OCP\Search\Result's | ||
| * @since 7.0.0 | ||
| */ | ||
| public function search($query): array { | ||
| $cm = \OC::$server->getCommentsManager(); | ||
| $us = \OC::$server->getUserSession(); | ||
|
|
||
| $user = $us->getUser(); | ||
| if (!$user instanceof IUser) { | ||
| return []; | ||
| } | ||
| $uf = \OC::$server->getUserFolder($user->getUID()); | ||
|
|
||
| if ($uf === null) { | ||
| return []; | ||
| } | ||
|
|
||
| $result = []; | ||
| $numComments = 50; | ||
| $offset = 0; | ||
|
|
||
| while (count($result) < $numComments) { | ||
| /** @var IComment[] $comments */ | ||
| $comments = $cm->search($query, 'files', '', 'comment', $offset, $numComments); | ||
|
|
||
| foreach ($comments as $comment) { | ||
| if ($comment->getActorType() !== 'users') { | ||
| continue; | ||
| } | ||
|
|
||
| $displayName = $cm->resolveDisplayName('user', $comment->getActorId()); | ||
|
|
||
| try { | ||
| $file = $this->getFileForComment($uf, $comment); | ||
| $result[] = new Result($query, | ||
| $comment, | ||
| $displayName, | ||
| $file->getPath() | ||
| ); | ||
| } catch (NotFoundException $e) { | ||
| continue; | ||
| } | ||
| } | ||
|
|
||
| if (count($comments) < $numComments) { | ||
| // Didn't find more comments when we tried to get, so there are no more comments. | ||
| return $result; | ||
| } | ||
|
|
||
| $offset += $numComments; | ||
| $numComments = 50 - count($result); | ||
| } | ||
|
|
||
| return $result; | ||
| } | ||
|
|
||
| /** | ||
| * @param Folder $userFolder | ||
| * @param IComment $comment | ||
| * @return Node | ||
| * @throws NotFoundException | ||
| */ | ||
| protected function getFileForComment(Folder $userFolder, IComment $comment): Node { | ||
| $nodes = $userFolder->getById((int) $comment->getObjectId()); | ||
| if (empty($nodes)) { | ||
| throw new NotFoundException('File not found'); | ||
| } | ||
|
|
||
| return array_shift($nodes); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,11 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright (c) 2018 Joas Schilling <[email protected]> | ||
| * @copyright 2020 Christoph Wurst <[email protected]> | ||
| * | ||
| * @author Joas Schilling <[email protected]> | ||
| * @author 2020 Christoph Wurst <[email protected]> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
|
|
@@ -17,92 +20,62 @@ | |
| * 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/>. | ||
| * | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| namespace OCA\Comments\Search; | ||
|
|
||
| use OCP\Comments\IComment; | ||
| use OCP\Files\Folder; | ||
| use OCP\Files\Node; | ||
| use OCP\Files\NotFoundException; | ||
| use OCP\IL10N; | ||
| use OCP\IURLGenerator; | ||
| use OCP\IUser; | ||
| use OCP\Search\IProvider; | ||
| use OCP\Search\ISearchQuery; | ||
| use OCP\Search\SearchResult; | ||
| use function array_map; | ||
| use function pathinfo; | ||
|
|
||
| class Provider extends \OCP\Search\Provider { | ||
|
|
||
| /** | ||
| * Search for $query | ||
| * | ||
| * @param string $query | ||
| * @return array An array of OCP\Search\Result's | ||
| * @since 7.0.0 | ||
| */ | ||
| public function search($query): array { | ||
| $cm = \OC::$server->getCommentsManager(); | ||
| $us = \OC::$server->getUserSession(); | ||
|
|
||
| $user = $us->getUser(); | ||
| if (!$user instanceof IUser) { | ||
| return []; | ||
| } | ||
| $uf = \OC::$server->getUserFolder($user->getUID()); | ||
|
|
||
| if ($uf === null) { | ||
| return []; | ||
| } | ||
| class Provider implements IProvider { | ||
|
|
||
| $result = []; | ||
| $numComments = 50; | ||
| $offset = 0; | ||
| /** @var IL10N */ | ||
| private $l10n; | ||
|
|
||
| while (\count($result) < $numComments) { | ||
| /** @var IComment[] $comments */ | ||
| $comments = $cm->search($query, 'files', '', 'comment', $offset, $numComments); | ||
| /** @var IURLGenerator */ | ||
| private $urlGenerator; | ||
|
|
||
| foreach ($comments as $comment) { | ||
| if ($comment->getActorType() !== 'users') { | ||
| continue; | ||
| } | ||
| /** @var LegacyProvider */ | ||
| private $legacyProvider; | ||
|
|
||
| $displayName = $cm->resolveDisplayName('user', $comment->getActorId()); | ||
|
|
||
| try { | ||
| $file = $this->getFileForComment($uf, $comment); | ||
| $result[] = new Result($query, | ||
| $comment, | ||
| $displayName, | ||
| $file->getPath() | ||
| ); | ||
| } catch (NotFoundException $e) { | ||
| continue; | ||
| } | ||
| } | ||
|
|
||
| if (\count($comments) < $numComments) { | ||
| // Didn't find more comments when we tried to get, so there are no more comments. | ||
| return $result; | ||
| } | ||
|
|
||
| $offset += $numComments; | ||
| $numComments = 50 - \count($result); | ||
| } | ||
|
|
||
| return $result; | ||
| public function __construct(IL10N $l10n, | ||
| IURLGenerator $urlGenerator, | ||
| LegacyProvider $legacyProvider) { | ||
| $this->l10n = $l10n; | ||
| $this->urlGenerator = $urlGenerator; | ||
| $this->legacyProvider = $legacyProvider; | ||
| } | ||
|
|
||
| /** | ||
| * @param Folder $userFolder | ||
| * @param IComment $comment | ||
| * @return Node | ||
| * @throws NotFoundException | ||
| */ | ||
| protected function getFileForComment(Folder $userFolder, IComment $comment): Node { | ||
| $nodes = $userFolder->getById((int) $comment->getObjectId()); | ||
| if (empty($nodes)) { | ||
| throw new NotFoundException('File not found'); | ||
| } | ||
| public function getId(): string { | ||
| return 'comments'; | ||
| } | ||
|
|
||
| return array_shift($nodes); | ||
| public function search(IUser $user, ISearchQuery $query): SearchResult { | ||
| return SearchResult::complete( | ||
| $this->l10n->t('Comments'), | ||
| array_map(function (Result $result) { | ||
| $path = $result->path; | ||
| $pathInfo = pathinfo($path); | ||
| return new CommentsSearchResultEntry( | ||
| $this->urlGenerator->linkToRoute('core.Preview.getPreviewByFileId', ['x' => 32, 'y' => 32, 'fileId' => $result->id]), | ||
| $result->name, | ||
| $path, | ||
| $this->urlGenerator->linkToRoute( | ||
| 'files.view.index', | ||
| [ | ||
| 'dir' => $pathInfo['dirname'], | ||
| 'scrollto' => $pathInfo['basename'], | ||
| ] | ||
| ) | ||
| ); | ||
| }, $this->legacyProvider->search($query->getTerm())) | ||
| ); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters