* * @author Arthur Schiwon * @author Christoph Wurst * @author Joas Schilling * @author John Molakvoæ * @author Roeland Jago Douma * @author Kate Döen * * @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 OC\Core\Controller; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\OCSController; use OCP\Collaboration\AutoComplete\AutoCompleteEvent; use OCP\Collaboration\AutoComplete\IManager; use OCP\Collaboration\Collaborators\ISearch; use OCP\EventDispatcher\IEventDispatcher; use OCP\IRequest; use OCP\Share\IShare; class AutoCompleteController extends OCSController { public function __construct( string $appName, IRequest $request, private ISearch $collaboratorSearch, private IManager $autoCompleteManager, private IEventDispatcher $dispatcher, ) { parent::__construct($appName, $request); } /** * @NoAdminRequired * @param string|null $sorter can be piped, top prio first, e.g.: "commenters|share-recipients" */ public function get(string $search, ?string $itemType, ?string $itemId, ?string $sorter = null, array $shareTypes = [IShare::TYPE_USER], int $limit = 10): DataResponse { // if enumeration/user listings are disabled, we'll receive an empty // result from search() – thus nothing else to do here. [$results,] = $this->collaboratorSearch->search($search, $shareTypes, false, $limit, 0); $event = new AutoCompleteEvent([ 'search' => $search, 'results' => $results, 'itemType' => $itemType, 'itemId' => $itemId, 'sorter' => $sorter, 'shareTypes' => $shareTypes, 'limit' => $limit, ]); $this->dispatcher->dispatch(IManager::class . '::filterResults', $event); $results = $event->getResults(); $exactMatches = $results['exact']; unset($results['exact']); $results = array_merge_recursive($exactMatches, $results); if ($sorter !== null) { $sorters = array_reverse(explode('|', $sorter)); $this->autoCompleteManager->runSorters($sorters, $results, [ 'itemType' => $itemType, 'itemId' => $itemId, ]); } // transform to expected format $results = $this->prepareResultArray($results); return new DataResponse($results); } protected function prepareResultArray(array $results): array { $output = []; foreach ($results as $type => $subResult) { foreach ($subResult as $result) { $output[] = [ 'id' => (string) $result['value']['shareWith'], 'label' => $result['label'], 'icon' => $result['icon'] ?? '', 'source' => $type, 'status' => $result['status'] ?? '', 'subline' => $result['subline'] ?? '', 'shareWithDisplayNameUnique' => $result['shareWithDisplayNameUnique'] ?? '', ]; } } return $output; } }