mirror of
https://github.com/nextcloud/server.git
synced 2024-08-16 14:12:54 +02:00
206 lines
5.1 KiB
PHP
206 lines
5.1 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* @copyright 2018, Maxence Lange <maxence@artificial-owl.com>
|
|
*
|
|
* @author Maxence Lange <maxence@artificial-owl.com>
|
|
*
|
|
* @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 OC\FullTextSearch;
|
|
|
|
use OCP\FullTextSearch\Exceptions\FullTextSearchAppNotAvailableException;
|
|
use OCP\FullTextSearch\IFullTextSearchManager;
|
|
use OCP\FullTextSearch\Model\IIndex;
|
|
use OCP\FullTextSearch\Model\ISearchResult;
|
|
use OCP\FullTextSearch\Service\IIndexService;
|
|
use OCP\FullTextSearch\Service\IProviderService;
|
|
use OCP\FullTextSearch\Service\ISearchService;
|
|
|
|
/**
|
|
* Class FullTextSearchManager
|
|
*
|
|
* @package OC\FullTextSearch
|
|
*/
|
|
class FullTextSearchManager implements IFullTextSearchManager {
|
|
private ?IProviderService $providerService = null;
|
|
|
|
private ?IIndexService $indexService = null;
|
|
|
|
private ?ISearchService $searchService = null;
|
|
|
|
/**
|
|
* @since 15.0.0
|
|
*/
|
|
public function registerProviderService(IProviderService $providerService): void {
|
|
$this->providerService = $providerService;
|
|
}
|
|
|
|
/**
|
|
* @since 15.0.0
|
|
*/
|
|
public function registerIndexService(IIndexService $indexService): void {
|
|
$this->indexService = $indexService;
|
|
}
|
|
|
|
/**
|
|
* @since 15.0.0
|
|
*/
|
|
public function registerSearchService(ISearchService $searchService): void {
|
|
$this->searchService = $searchService;
|
|
}
|
|
|
|
/**
|
|
* @since 16.0.0
|
|
*/
|
|
public function isAvailable(): bool {
|
|
if ($this->indexService === null ||
|
|
$this->providerService === null ||
|
|
$this->searchService === null) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
/**
|
|
* @throws FullTextSearchAppNotAvailableException
|
|
*/
|
|
private function getProviderService(): IProviderService {
|
|
if ($this->providerService === null) {
|
|
throw new FullTextSearchAppNotAvailableException('No IProviderService registered');
|
|
}
|
|
|
|
return $this->providerService;
|
|
}
|
|
|
|
|
|
/**
|
|
* @throws FullTextSearchAppNotAvailableException
|
|
*/
|
|
private function getIndexService(): IIndexService {
|
|
if ($this->indexService === null) {
|
|
throw new FullTextSearchAppNotAvailableException('No IIndexService registered');
|
|
}
|
|
|
|
return $this->indexService;
|
|
}
|
|
|
|
|
|
/**
|
|
* @throws FullTextSearchAppNotAvailableException
|
|
*/
|
|
private function getSearchService(): ISearchService {
|
|
if ($this->searchService === null) {
|
|
throw new FullTextSearchAppNotAvailableException('No ISearchService registered');
|
|
}
|
|
|
|
return $this->searchService;
|
|
}
|
|
|
|
|
|
/**
|
|
* @throws FullTextSearchAppNotAvailableException
|
|
*/
|
|
public function addJavascriptAPI(): void {
|
|
$this->getProviderService()->addJavascriptAPI();
|
|
}
|
|
|
|
|
|
/**
|
|
* @throws FullTextSearchAppNotAvailableException
|
|
*/
|
|
public function isProviderIndexed(string $providerId): bool {
|
|
return $this->getProviderService()->isProviderIndexed($providerId);
|
|
}
|
|
|
|
|
|
/**
|
|
* @throws FullTextSearchAppNotAvailableException
|
|
*/
|
|
public function getIndex(string $providerId, string $documentId): IIndex {
|
|
return $this->getIndexService()->getIndex($providerId, $documentId);
|
|
}
|
|
|
|
/**
|
|
* @see IIndex for available value for $status.
|
|
*
|
|
* @throws FullTextSearchAppNotAvailableException
|
|
*/
|
|
public function createIndex(
|
|
string $providerId,
|
|
string $documentId,
|
|
string $userId,
|
|
int $status = 0,
|
|
): IIndex {
|
|
return $this->getIndexService()->createIndex($providerId, $documentId, $userId, $status);
|
|
}
|
|
|
|
|
|
/**
|
|
* @see IIndex for available value for $status.
|
|
*
|
|
* @throws FullTextSearchAppNotAvailableException
|
|
*/
|
|
public function updateIndexStatus(
|
|
string $providerId,
|
|
string $documentId,
|
|
int $status,
|
|
bool $reset = false,
|
|
): void {
|
|
$this->getIndexService()->updateIndexStatus($providerId, $documentId, $status, $reset);
|
|
}
|
|
|
|
/**
|
|
* @see IIndex for available value for $status.
|
|
*
|
|
* @throws FullTextSearchAppNotAvailableException
|
|
*/
|
|
public function updateIndexesStatus(
|
|
string $providerId,
|
|
array $documentIds,
|
|
int $status,
|
|
bool $reset = false,
|
|
): void {
|
|
$this->getIndexService()->updateIndexesStatus($providerId, $documentIds, $status, $reset);
|
|
}
|
|
|
|
|
|
/**
|
|
* @param IIndex[] $indexes
|
|
*
|
|
* @throws FullTextSearchAppNotAvailableException
|
|
*/
|
|
public function updateIndexes(array $indexes): void {
|
|
$this->getIndexService()->updateIndexes($indexes);
|
|
}
|
|
|
|
|
|
/**
|
|
* @return ISearchResult[]
|
|
* @throws FullTextSearchAppNotAvailableException
|
|
*/
|
|
public function search(array $request, string $userId = ''): array {
|
|
$searchRequest = $this->getSearchService()->generateSearchRequest($request);
|
|
|
|
return $this->getSearchService()->search($userId, $searchRequest);
|
|
}
|
|
}
|