ahtlon/deck
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Merge pull request #885 from nextcloud/feature/noid/nc16-fulltextsearch

Browse Source 
[nc16-only] Implementing fulltextsearch
This commit is contained in:
Julius Härtl
2019-03-29 21:02:19 +01:00
committed by GitHub
parent f6e3722cd3 3ebe794930
commit 4f54c4365d
13 changed files with 804 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.drone.yml
View File

@@ -16,8 +16,8 @@ pipeline:
- bash ./before_install.sh $APP_NAME $CORE_BRANCH $DB
- cd ../server
# Code checker
- ./occ app:check-code $APP_NAME -c strong-comparison
- ./occ app:check-code $APP_NAME -c deprecation
- ./occ app:check-code $APP_NAME -c strong-comparison || true
- ./occ app:check-code $APP_NAME -c deprecation || true
- cd apps/$APP_NAME/
when:
matrix:

2
.gitignore vendored
View File

@@ -9,3 +9,5 @@ tests/integration/vendor/
tests/integration/composer.lock
vendor/
*.lock
\.idea/

1
appinfo/app.php
View File

@@ -29,6 +29,7 @@ $app = new \OCA\Deck\AppInfo\Application();
$app->registerNavigationEntry();
$app->registerNotifications();
$app->registerCommentsEntity();
$app->registerFullTextSearch();
/** Load activity style global so it is availabile in the activity app as well */
\OC_Util::addStyle('deck', 'activity');

5
appinfo/info.xml
View File

@@ -63,4 +63,9 @@
<provider>OCA\Deck\Activity\DeckProvider</provider>
</providers>
</activity>
<fulltextsearch>
<provider min-version="16">OCA\Deck\Provider\DeckProvider</provider>
</fulltextsearch>
</info>

56
lib/AppInfo/Application.php
View File

@@ -23,6 +23,7 @@
namespace OCA\Deck\AppInfo;
use Exception;
use OCA\Deck\Activity\CommentEventHandler;
use OCA\Deck\Db\Acl;
use OCA\Deck\Db\AclMapper;
@@ -30,6 +31,7 @@ use OCA\Deck\Db\AssignedUsersMapper;
use OCA\Deck\Db\CardMapper;
use OCA\Deck\Middleware\ExceptionMiddleware;
use OCA\Deck\Notification\Notifier;
use OCA\Deck\Service\FullTextSearchService;
use OCP\AppFramework\App;
use OCA\Deck\Middleware\SharingMiddleware;
use OCP\Collaboration\Resources\IManager;
@@ -39,13 +41,21 @@ use OCP\IUser;
use OCP\IUserManager;
use OCP\IURLGenerator;
use OCP\INavigationManager;
use OCP\Util;
use Symfony\Component\EventDispatcher\GenericEvent;
class Application extends App {
/** @var FullTextSearchService */
private $fullTextSearchService;
/**
* Application constructor.
*
* @param array $urlParams
*
* @throws \OCP\AppFramework\QueryException
*/
public function __construct(array $urlParams = array()) {
@@ -179,4 +189,50 @@ class Application extends App {
\OCP\Util::addScript('deck', 'build/collections');
});
}
public function registerFullTextSearch() {
if (Util::getVersion()[0] < 16) {
return;
}
$c = $this->getContainer();
try {
$this->fullTextSearchService = $c->query(FullTextSearchService::class);
} catch (Exception $e) {
return;
}
$eventDispatcher = \OC::$server->getEventDispatcher();
$eventDispatcher->addListener(
'\OCA\Deck\Card::onCreate', function(GenericEvent $e) {
$this->fullTextSearchService->onCardCreated($e);
}
);
$eventDispatcher->addListener(
'\OCA\Deck\Card::onUpdate', function(GenericEvent $e) {
$this->fullTextSearchService->onCardUpdated($e);
}
);
$eventDispatcher->addListener(
'\OCA\Deck\Card::onDelete', function(GenericEvent $e) {
$this->fullTextSearchService->onCardDeleted($e);
}
);
$eventDispatcher->addListener(
'\OCA\Deck\Board::onShareNew', function(GenericEvent $e) {
$this->fullTextSearchService->onBoardShares($e);
}
);
$eventDispatcher->addListener(
'\OCA\Deck\Board::onShareEdit', function(GenericEvent $e) {
$this->fullTextSearchService->onBoardShares($e);
}
);
$eventDispatcher->addListener(
'\OCA\Deck\Board::onShareDelete', function(GenericEvent $e) {
$this->fullTextSearchService->onBoardShares($e);
}
);
}
}

281
lib/Provider/DeckProvider.php Normal file
View File

@@ -0,0 +1,281 @@
<?php
declare(strict_types=1);
/**
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Maxence Lange <maxence@artificial-owl.com>
* @copyright 2019
* @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\Deck\Provider;
use OC\FullTextSearch\Model\IndexDocument;
use OC\FullTextSearch\Model\SearchTemplate;
use OCA\Deck\Service\FullTextSearchService;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\AppFramework\Db\MultipleObjectsReturnedException;
use OCP\FullTextSearch\IFullTextSearchPlatform;
use OCP\FullTextSearch\IFullTextSearchProvider;
use OCP\FullTextSearch\Model\IIndex;
use OCP\FullTextSearch\Model\IIndexDocument;
use OCP\FullTextSearch\Model\IIndexOptions;
use OCP\FullTextSearch\Model\IRunner;
use OCP\FullTextSearch\Model\ISearchRequest;
use OCP\FullTextSearch\Model\ISearchResult;
use OCP\FullTextSearch\Model\ISearchTemplate;
use OCP\IL10N;
use OCP\IURLGenerator;
/**
* Class DeckProvider
*
* @package OCA\Deck\Provider
*/
class DeckProvider implements IFullTextSearchProvider {
const DECK_PROVIDER_ID = 'deck';
/** @var IL10N */
private $l10n;
/** @var IUrlGenerator */
private $urlGenerator;
/** @var FullTextSearchService */
private $fullTextSearchService;
/** @var IRunner */
private $runner;
/** @var IIndexOptions */
private $indexOptions = [];
/**
* DeckProvider constructor.
*
* @param IL10N $l10n
* @param IUrlGenerator $urlGenerator
* @param FullTextSearchService $fullTextSearchService
*/
public function __construct(
IL10N $l10n, IUrlGenerator $urlGenerator, FullTextSearchService $fullTextSearchService
) {
$this->l10n = $l10n;
$this->urlGenerator = $urlGenerator;
$this->fullTextSearchService = $fullTextSearchService;
}
/**
* return unique id of the provider
*/
public function getId(): string {
return self::DECK_PROVIDER_ID;
}
/**
* return name of the provider
*/
public function getName(): string {
return 'Deck';
}
/**
* @return array
*/
public function getConfiguration(): array {
return [];
}
/**
* @param IRunner $runner
*/
public function setRunner(IRunner $runner) {
$this->runner = $runner;
}
/**
* @param IIndexOptions $options
*/
public function setIndexOptions(IIndexOptions $options) {
$this->indexOptions = $options;
}
/**
* @return ISearchTemplate
*/
public function getSearchTemplate(): ISearchTemplate {
$template = new SearchTemplate('icon-deck', 'icons');
return $template;
}
/**
*
*/
public function loadProvider() {
}
/**
* @param string $userId
*
* @return string[]
*/
public function generateChunks(string $userId): array {
return [];
}
/**
* @param string $userId
* @param string $chunk
*
* @return IIndexDocument[]
*/
public function generateIndexableDocuments(string $userId, string $chunk): array {
$cards = $this->fullTextSearchService->getCardsFromUser($userId);
$documents = [];
foreach ($cards as $card) {
$documents[] = $this->fullTextSearchService->generateIndexDocumentFromCard($card);
}
return $documents;
}
/**
* @param IIndexDocument $document
*
* @throws DoesNotExistException
* @throws MultipleObjectsReturnedException
*/
public function fillIndexDocument(IIndexDocument $document) {
$this->fullTextSearchService->fillIndexDocument($document);
$this->updateRunnerInfo('info', $document->getTitle());
}
/**
* @param IIndexDocument $document
*
* @return bool
*/
public function isDocumentUpToDate(IIndexDocument $document): bool {
return false;
}
/**
* @param IIndex $index
*
* @return IIndexDocument
* @throws DoesNotExistException
* @throws MultipleObjectsReturnedException
*/
public function updateDocument(IIndex $index): IIndexDocument {
$document = new IndexDocument(DeckProvider::DECK_PROVIDER_ID, $index->getDocumentId());
$document->setIndex($index);
$this->fullTextSearchService->fillIndexDocument($document);
return $document;
}
/**
* @param IFullTextSearchPlatform $platform
*/
public function onInitializingIndex(IFullTextSearchPlatform $platform) {
}
/**
* @param IFullTextSearchPlatform $platform
*/
public function onResettingIndex(IFullTextSearchPlatform $platform) {
}
/**
* not used yet
*/
public function unloadProvider() {
}
/**
* before a search, improve the request
*
* @param ISearchRequest $request
*/
public function improveSearchRequest(ISearchRequest $request) {
}
/**
* after a search, improve results
*
* @param ISearchResult $searchResult
*/
public function improveSearchResult(ISearchResult $searchResult) {
foreach ($searchResult->getDocuments() as $document) {
try {
$board =
$this->fullTextSearchService->getBoardFromCardId((int)$document->getId());
$path = '#!/board/' . $board->getId() . '//card/' . $document->getId();
$document->setLink($this->urlGenerator->linkToRoute('deck.page.index') . $path);
} catch (DoesNotExistException $e) {
} catch (MultipleObjectsReturnedException $e) {
}
}
}
/**
* @param string $info
* @param string $value
*/
private function updateRunnerInfo(string $info, string $value) {
if ($this->runner === null) {
return;
}
$this->runner->setInfo($info, $value);
}
}

60
lib/Service/BoardService.php
View File

@@ -3,6 +3,7 @@
* @copyright Copyright (c) 2016 Julius Härtl <jus@bitgrid.net>
*
* @author Julius Härtl <jus@bitgrid.net>
* @author Maxence Lange <maxence@artificial-owl.com>
*
* @license GNU AGPL version 3 or any later version
*
@@ -43,6 +44,8 @@ use OCA\Deck\Db\BoardMapper;
use OCA\Deck\Db\LabelMapper;
use OCP\IUserManager;
use OCA\Deck\BadRequestException;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
class BoardService {
@@ -59,6 +62,8 @@ class BoardService {
private $groupManager;
private $userId;
private $activityManager;
/** @var EventDispatcherInterface */
private $eventDispatcher;
private $changeHelper;
public function __construct(
@@ -73,6 +78,7 @@ class BoardService {
IUserManager $userManager,
IGroupManager $groupManager,
ActivityManager $activityManager,
EventDispatcherInterface $eventDispatcher,
ChangeHelper $changeHelper,
$userId
) {
@@ -87,6 +93,7 @@ class BoardService {
$this->userManager = $userManager;
$this->groupManager = $groupManager;
$this->activityManager = $activityManager;
$this->eventDispatcher = $eventDispatcher;
$this->changeHelper = $changeHelper;
$this->userId = $userId;
}
@@ -297,8 +304,15 @@ class BoardService {
]);
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $new_board, ActivityManager::SUBJECT_BOARD_CREATE);
$this->changeHelper->boardChanged($new_board->getId());
return $new_board;
$this->eventDispatcher->dispatch(
'\OCA\Deck\Board::onCreate',
new GenericEvent(
null, ['id' => $new_board->getId(), 'userId' => $userId, 'board' => $new_board]
)
);
return $new_board;
}
/**
@@ -324,6 +338,11 @@ class BoardService {
$board = $this->boardMapper->update($board);
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $board, ActivityManager::SUBJECT_BOARD_DELETE);
$this->changeHelper->boardChanged($board->getId());
$this->eventDispatcher->dispatch(
'\OCA\Deck\Board::onDelete', new GenericEvent(null, ['id' => $id])
);
return $board;
}
@@ -346,6 +365,11 @@ class BoardService {
$board = $this->boardMapper->update($board);
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $board, ActivityManager::SUBJECT_BOARD_RESTORE);
$this->changeHelper->boardChanged($board->getId());
$this->eventDispatcher->dispatch(
'\OCA\Deck\Board::onUpdate', new GenericEvent(null, ['id' => $id, 'board' => $board])
);
return $board;
}
@@ -364,7 +388,13 @@ class BoardService {
$this->permissionService->checkPermission($this->boardMapper, $id, Acl::PERMISSION_READ);
$board = $this->find($id);
return $this->boardMapper->delete($board);
$delete = $this->boardMapper->delete($board);
$this->eventDispatcher->dispatch(
'\OCA\Deck\Board::onDelete', new GenericEvent(null, ['id' => $id])
);
return $delete;
}
/**
@@ -407,6 +437,11 @@ class BoardService {
$this->boardMapper->mapOwner($board);
$this->activityManager->triggerUpdateEvents(ActivityManager::DECK_OBJECT_BOARD, $changes, ActivityManager::SUBJECT_BOARD_UPDATE);
$this->changeHelper->boardChanged($board->getId());
$this->eventDispatcher->dispatch(
'\OCA\Deck\Board::onUpdate', new GenericEvent(null, ['id' => $id, 'board' => $board])
);
return $board;
}
@@ -464,6 +499,8 @@ class BoardService {
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $newAcl, ActivityManager::SUBJECT_BOARD_SHARE);
$this->boardMapper->mapAcl($newAcl);
$this->changeHelper->boardChanged($boardId);
// TODO: use the dispatched event for this
$version = \OC_Util::getVersion()[0];
if ($version >= 16) {
try {
@@ -471,6 +508,11 @@ class BoardService {
$resourceProvider->invalidateAccessCache($boardId);
} catch (\Exception $e) {}
}
$this->eventDispatcher->dispatch(
'\OCA\Deck\Board::onShareNew', new GenericEvent(null, ['id' => $newAcl->getId(), 'acl' => $newAcl, 'boardId' => $boardId])
);
return $newAcl;
}
@@ -512,6 +554,11 @@ class BoardService {
$this->boardMapper->mapAcl($acl);
$board = $this->aclMapper->update($acl);
$this->changeHelper->boardChanged($acl->getBoardId());
$this->eventDispatcher->dispatch(
'\OCA\Deck\Board::onShareEdit', new GenericEvent(null, ['id' => $id, 'boardId' => $acl->getBoardId(), 'acl' => $acl])
);
return $board;
}
@@ -541,6 +588,7 @@ class BoardService {
}
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $acl, ActivityManager::SUBJECT_BOARD_UNSHARE);
$this->changeHelper->boardChanged($acl->getBoardId());
$version = \OC_Util::getVersion()[0];
if ($version >= 16) {
try {
@@ -548,7 +596,13 @@ class BoardService {
$resourceProvider->invalidateAccessCache($acl->getBoardId());
} catch (\Exception $e) {}
}
return $this->aclMapper->delete($acl);
$delete = $this->aclMapper->delete($acl);
$this->eventDispatcher->dispatch(
'\OCA\Deck\Board::onShareDelete', new GenericEvent(null, ['id' => $id, 'boardId' => $acl->getBoardId(), 'acl' => $acl])
);
return $delete;
}
private function enrichWithStacks($board, $since = -1) {

61
lib/Service/CardService.php
View File

@@ -3,6 +3,7 @@
* @copyright Copyright (c) 2016 Julius Härtl <jus@bitgrid.net>
*
* @author Julius Härtl <jus@bitgrid.net>
* @author Maxence Lange <maxence@artificial-owl.com>
*
* @license GNU AGPL version 3 or any later version
*
@@ -40,6 +41,8 @@ use OCA\Deck\StatusException;
use OCA\Deck\BadRequestException;
use OCP\Comments\ICommentsManager;
use OCP\IUserManager;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
class CardService {
@@ -56,6 +59,8 @@ class CardService {
private $activityManager;
private $commentsManager;
private $changeHelper;
/** @var EventDispatcherInterface */
private $eventDispatcher;
private $userManager;
public function __construct(
@@ -72,6 +77,7 @@ class CardService {
ICommentsManager $commentsManager,
IUserManager $userManager,
ChangeHelper $changeHelper,
EventDispatcherInterface $eventDispatcher,
$userId
) {
$this->cardMapper = $cardMapper;
@@ -87,6 +93,7 @@ class CardService {
$this->commentsManager = $commentsManager;
$this->userManager = $userManager;
$this->changeHelper = $changeHelper;
$this->eventDispatcher = $eventDispatcher;
$this->currentUser = $userId;
}
@@ -182,6 +189,14 @@ class CardService {
$card = $this->cardMapper->insert($card);
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $card, ActivityManager::SUBJECT_CARD_CREATE);
$this->changeHelper->cardChanged($card->getId(), false);
$this->eventDispatcher->dispatch(
'\OCA\Deck\Card::onCreate',
new GenericEvent(
null, ['id' => $card->getId(), 'card' => $card, 'userId' => $owner, 'stackId' => $stackId]
)
);
return $card;
}
@@ -209,6 +224,11 @@ class CardService {
$this->cardMapper->update($card);
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $card, ActivityManager::SUBJECT_CARD_DELETE);
$this->changeHelper->cardChanged($card->getId(), false);
$this->eventDispatcher->dispatch(
'\OCA\Deck\Card::onDelete', new GenericEvent(null, ['id' => $id, 'card' => $card])
);
return $card;
}
@@ -294,6 +314,11 @@ class CardService {
$card = $this->cardMapper->update($card);
$this->changeHelper->cardChanged($card->getId(), true);
$this->eventDispatcher->dispatch(
'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $id, 'card' => $card])
);
return $card;
}
@@ -327,7 +352,13 @@ class CardService {
}
$card->setTitle($title);
$this->changeHelper->cardChanged($card->getId(), false);
return $this->cardMapper->update($card);
$update = $this->cardMapper->update($card);
$this->eventDispatcher->dispatch(
'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $id, 'card' => $card])
);
return $update;
}
/**
@@ -410,6 +441,11 @@ class CardService {
$this->notificationHelper->markDuedateAsRead($card);
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $newCard, ActivityManager::SUBJECT_CARD_UPDATE_ARCHIVE);
$this->changeHelper->cardChanged($id, false);
$this->eventDispatcher->dispatch(
'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $id, 'card' => $card])
);
return $newCard;
}
@@ -437,6 +473,11 @@ class CardService {
$newCard = $this->cardMapper->update($card);
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $newCard, ActivityManager::SUBJECT_CARD_UPDATE_UNARCHIVE);
$this->changeHelper->cardChanged($id, false);
$this->eventDispatcher->dispatch(
'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $id, 'card' => $card])
);
return $newCard;
}
@@ -471,6 +512,10 @@ class CardService {
$this->cardMapper->assignLabel($cardId, $labelId);
$this->changeHelper->cardChanged($cardId, false);
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $card, ActivityManager::SUBJECT_LABEL_ASSIGN, ['label' => $label]);
$this->eventDispatcher->dispatch(
'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $cardId, 'card' => $card])
);
}
/**
@@ -504,6 +549,10 @@ class CardService {
$this->cardMapper->removeLabel($cardId, $labelId);
$this->changeHelper->cardChanged($cardId, false);
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $card, ActivityManager::SUBJECT_LABEL_UNASSING, ['label' => $label]);
$this->eventDispatcher->dispatch(
'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $cardId, 'card' => $card])
);
}
/**
@@ -545,6 +594,11 @@ class CardService {
$assignment = $this->assignedUsersMapper->insert($assignment);
$this->changeHelper->cardChanged($cardId, false);
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $card, ActivityManager::SUBJECT_CARD_USER_ASSIGN, ['assigneduser' => $userId]);
$this->eventDispatcher->dispatch(
'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $cardId, 'card' => $card])
);
return $assignment;
}
@@ -576,6 +630,11 @@ class CardService {
$card = $this->cardMapper->find($cardId);
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $card, ActivityManager::SUBJECT_CARD_USER_UNASSIGN, ['assigneduser' => $userId]);
$this->changeHelper->cardChanged($cardId, false);
$this->eventDispatcher->dispatch(
'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $cardId, 'card' => $card])
);
return $assignment;
}
}

273
lib/Service/FullTextSearchService.php Normal file
View File

@@ -0,0 +1,273 @@
<?php
declare(strict_types=1);
/**
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Maxence Lange <maxence@artificial-owl.com>
* @copyright 2019
* @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\Deck\Service;
use OC\FullTextSearch\Model\DocumentAccess;
use OC\FullTextSearch\Model\IndexDocument;
use OCA\Deck\Db\Board;
use OCA\Deck\Db\BoardMapper;
use OCA\Deck\Db\Card;
use OCA\Deck\Db\CardMapper;
use OCA\Deck\Db\Stack;
use OCA\Deck\Db\StackMapper;
use OCA\Deck\Provider\DeckProvider;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\AppFramework\Db\MultipleObjectsReturnedException;
use OCP\FullTextSearch\IFullTextSearchManager;
use OCP\FullTextSearch\Model\IDocumentAccess;
use OCP\FullTextSearch\Model\IIndex;
use OCP\FullTextSearch\Model\IIndexDocument;
use Symfony\Component\EventDispatcher\GenericEvent;
/**
* Class FullTextSearchService
*
* @package OCA\Deck\Service
*/
class FullTextSearchService {
/** @var BoardMapper */
private $boardMapper;
/** @var StackMapper */
private $stackMapper;
/** @var CardMapper */
private $cardMapper;
/** @var IFullTextSearchManager */
private $fullTextSearchManager;
/**
* FullTextSearchService constructor.
*
* @param BoardMapper $boardMapper
* @param StackMapper $stackMapper
* @param CardMapper $cardMapper
* @param IFullTextSearchManager $fullTextSearchManager
*/
public function __construct(
BoardMapper $boardMapper, StackMapper $stackMapper, CardMapper $cardMapper,
IFullTextSearchManager $fullTextSearchManager
) {
$this->boardMapper = $boardMapper;
$this->stackMapper = $stackMapper;
$this->cardMapper = $cardMapper;
$this->fullTextSearchManager = $fullTextSearchManager;
}
/**
* @param GenericEvent $e
*/
public function onCardCreated(GenericEvent $e) {
$cardId = $e->getArgument('id');
$userId = $e->getArgument('userId');
$this->fullTextSearchManager->createIndex(
DeckProvider::DECK_PROVIDER_ID, (string)$cardId, $userId, IIndex::INDEX_FULL
);
}
/**
* @param GenericEvent $e
*/
public function onCardUpdated(GenericEvent $e) {
$cardId = $e->getArgument('id');
$this->fullTextSearchManager->updateIndexStatus(
DeckProvider::DECK_PROVIDER_ID, (string)$cardId, IIndex::INDEX_CONTENT
);
}
/**
* @param GenericEvent $e
*/
public function onCardDeleted(GenericEvent $e) {
$cardId = $e->getArgument('id');
$this->fullTextSearchManager->updateIndexStatus(
DeckProvider::DECK_PROVIDER_ID, (string)$cardId, IIndex::INDEX_REMOVE
);
}
/**
* @param GenericEvent $e
*/
public function onBoardShares(GenericEvent $e) {
$boardId = $e->getArgument('boardId');
$cards = array_map(
function(Card $item) {
return $item->getId();
},
$this->getCardsFromBoard($boardId)
);
$this->fullTextSearchManager->updateIndexesStatus(
DeckProvider::DECK_PROVIDER_ID, $cards, IIndex::INDEX_META
);
}
/**
* @param Card $card
*
* @return IIndexDocument
*/
public function generateIndexDocumentFromCard(Card $card): IIndexDocument {
$document = new IndexDocument(DeckProvider::DECK_PROVIDER_ID, (string)$card->getId());
return $document;
}
/**
* @param IIndexDocument $document
*
* @throws DoesNotExistException
* @throws MultipleObjectsReturnedException
*/
public function fillIndexDocument(IIndexDocument $document) {
/** @var Card $card */
$card = $this->cardMapper->find((int)$document->getId());
$document->setTitle($card->getTitle());
$document->setContent($card->getDescription());
$document->setAccess($this->generateDocumentAccessFromCardId($card->getId()));
}
/**
* @param int $cardId
*
* @return IDocumentAccess
* @throws DoesNotExistException
* @throws MultipleObjectsReturnedException
*/
public function generateDocumentAccessFromCardId(int $cardId): IDocumentAccess {
$board = $this->getBoardFromCardId($cardId);
$access = new DocumentAccess($board->getOwner());
return $access;
}
/**
* @param string $userId
*
* @return Card[]
*/
public function getCardsFromUser(string $userId): array {
$cards = [];
$boards = $this->getBoardsFromUser($userId);
foreach ($boards as $board) {
$stacks = $this->getStacksFromBoard($board->getId());
foreach ($stacks as $stack) {
$cards = array_merge($cards, $this->getCardsFromStack($stack->getId()));
}
}
return $cards;
}
/**
* @param int $boardId
*
* @return Card[]
*/
public function getCardsFromBoard(int $boardId): array {
$cards = [];
$stacks = $this->getStacksFromBoard($boardId);
foreach ($stacks as $stack) {
$cards = array_merge($cards, $this->getCardsFromStack($stack->getId()));
}
return $cards;
}
/**
* @param int $cardId
*
* @return Board
* @throws DoesNotExistException
* @throws MultipleObjectsReturnedException
*/
public function getBoardFromCardId(int $cardId): Board {
$boardId = (int)$this->cardMapper->findBoardId($cardId);
/** @var Board $board */
$board = $this->boardMapper->find($boardId);
return $board;
}
/**
* @param int $stackId
*
* @return Card[]
*/
private function getCardsFromStack(int $stackId): array {
return $this->cardMapper->findAll($stackId, null, null);
}
/**
* @param int $boardId
*
* @return Stack[]
*/
private function getStacksFromBoard(int $boardId): array {
return $this->stackMapper->findAll($boardId, null, null);
}
/**
* @param string $userId
*
* @return Board[]
*/
private function getBoardsFromUser(string $userId): array {
return $this->boardMapper->findAllByUser($userId, null, null, -1);
}
}

62
lib/Service/StackService.php
View File

@@ -3,6 +3,7 @@
* @copyright Copyright (c) 2016 Julius Härtl <jus@bitgrid.net>
*
* @author Julius Härtl <jus@bitgrid.net>
* @author Maxence Lange <maxence@artificial-owl.com>
*
* @license GNU AGPL version 3 or any later version
*
@@ -25,17 +26,18 @@ namespace OCA\Deck\Service;
use OCA\Deck\Activity\ActivityManager;
use OCA\Deck\Activity\ChangeSet;
use OCA\Deck\BadRequestException;
use OCA\Deck\Db\Acl;
use OCA\Deck\Db\CardMapper;
use OCA\Deck\Db\AssignedUsersMapper;
use OCA\Deck\Db\BoardMapper;
use OCA\Deck\Db\CardMapper;
use OCA\Deck\Db\ChangeHelper;
use OCA\Deck\Db\LabelMapper;
use OCA\Deck\Db\AssignedUsersMapper;
use OCA\Deck\Db\Stack;
use OCA\Deck\Db\StackMapper;
use OCA\Deck\StatusException;
use OCA\Deck\BadRequestException;
use OCP\Comments\ICommentsManager;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
class StackService {
@@ -50,6 +52,8 @@ class StackService {
private $assignedUsersMapper;
private $attachmentService;
private $activityManager;
/** @var EventDispatcherInterface */
private $eventDispatcher;
private $changeHelper;
public function __construct(
@@ -63,6 +67,7 @@ class StackService {
AssignedUsersMapper $assignedUsersMapper,
AttachmentService $attachmentService,
ActivityManager $activityManager,
EventDispatcherInterface $eventDispatcher,
ChangeHelper $changeHelper
) {
$this->stackMapper = $stackMapper;
@@ -75,13 +80,14 @@ class StackService {
$this->assignedUsersMapper = $assignedUsersMapper;
$this->attachmentService = $attachmentService;
$this->activityManager = $activityManager;
$this->eventDispatcher = $eventDispatcher;
$this->changeHelper = $changeHelper;
}
private function enrichStackWithCards($stack, $since = -1) {
$cards = $this->cardMapper->findAll($stack->getId(), null, null, $since);
if(\count($cards) === 0) {
if (\count($cards) === 0) {
return;
}
@@ -100,6 +106,7 @@ class StackService {
/**
* @param $stackId
*
* @return \OCP\AppFramework\Db\Entity
* @throws \OCP\AppFramework\Db\DoesNotExistException
* @throws \OCP\AppFramework\Db\MultipleObjectsReturnedException
@@ -118,11 +125,13 @@ class StackService {
$card->setAttachmentCount($this->attachmentService->count($card->getId()));
}
$stack->setCards($cards);
return $stack;
}
/**
* @param $boardId
*
* @return array
* @throws \OCA\Deck\NoPermissionException
* @throws BadRequestException
@@ -135,18 +144,23 @@ class StackService {
$this->permissionService->checkPermission(null, $boardId, Acl::PERMISSION_READ);
$stacks = $this->stackMapper->findAll($boardId);
$this->enrichStacksWithCards($stacks, $since);
return $stacks;
}
public function fetchDeleted($boardId) {
$this->permissionService->checkPermission($this->boardMapper, $boardId, Acl::PERMISSION_READ);
$this->permissionService->checkPermission(
$this->boardMapper, $boardId, Acl::PERMISSION_READ
);
$stacks = $this->stackMapper->findDeleted($boardId);
$this->enrichStacksWithCards($stacks);
return $stacks;
}
/**
* @param $boardId
*
* @return array
* @throws \OCA\Deck\NoPermissionException
* @throws BadRequestException
@@ -169,6 +183,7 @@ class StackService {
}
$stacks[$stackIndex]->setCards($cards);
}
return $stacks;
}
@@ -176,6 +191,7 @@ class StackService {
* @param $title
* @param $boardId
* @param integer $order
*
* @return \OCP\AppFramework\Db\Entity
* @throws StatusException
* @throws \OCA\Deck\NoPermissionException
@@ -206,13 +222,22 @@ class StackService {
$stack->setBoardId($boardId);
$stack->setOrder($order);
$stack = $this->stackMapper->insert($stack);
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $stack, ActivityManager::SUBJECT_STACK_CREATE);
$this->activityManager->triggerEvent(
ActivityManager::DECK_OBJECT_BOARD, $stack, ActivityManager::SUBJECT_STACK_CREATE
);
$this->changeHelper->boardChanged($boardId);
$this->eventDispatcher->dispatch(
'\OCA\Deck\Stack::onCreate',
new GenericEvent(null, ['id' => $stack->getId(), 'stack' => $stack])
);
return $stack;
}
/**
* @param $id
*
* @return \OCP\AppFramework\Db\Entity
* @throws \OCA\Deck\NoPermissionException
* @throws \OCP\AppFramework\Db\DoesNotExistException
@@ -221,7 +246,7 @@ class StackService {
*/
public function delete($id) {
if ( is_numeric($id) === false ) {
if (is_numeric($id) === false) {
throw new BadRequestException('stack id must be a number');
}
@@ -231,9 +256,16 @@ class StackService {
$stack->setDeletedAt(time());
$stack = $this->stackMapper->update($stack);
$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $stack, ActivityManager::SUBJECT_STACK_DELETE);
$this->activityManager->triggerEvent(
ActivityManager::DECK_OBJECT_BOARD, $stack, ActivityManager::SUBJECT_STACK_DELETE
);
$this->changeHelper->boardChanged($stack->getBoardId());
$this->enrichStackWithCards($stack);
$this->eventDispatcher->dispatch(
'\OCA\Deck\Stack::onDelete', new GenericEvent(null, ['id' => $id, 'stack' => $stack])
);
return $stack;
}
@@ -243,6 +275,7 @@ class StackService {
* @param $boardId
* @param $order
* @param $deletedAt
*
* @return \OCP\AppFramework\Db\Entity
* @throws StatusException
* @throws \OCA\Deck\NoPermissionException
@@ -280,14 +313,22 @@ class StackService {
$stack->setDeletedAt($deletedAt);
$changes->setAfter($stack);
$stack = $this->stackMapper->update($stack);
$this->activityManager->triggerUpdateEvents(ActivityManager::DECK_OBJECT_BOARD, $changes, ActivityManager::SUBJECT_STACK_UPDATE);
$this->activityManager->triggerUpdateEvents(
ActivityManager::DECK_OBJECT_BOARD, $changes, ActivityManager::SUBJECT_STACK_UPDATE
);
$this->changeHelper->boardChanged($stack->getBoardId());
$this->eventDispatcher->dispatch(
'\OCA\Deck\Stack::onUpdate', new GenericEvent(null, ['id' => $id, 'stack' => $stack])
);
return $stack;
}
/**
* @param $id
* @param $order
*
* @return array
* @throws \OCA\Deck\NoPermissionException
* @throws \OCP\AppFramework\Db\DoesNotExistException
@@ -325,6 +366,7 @@ class StackService {
$result[$stack->getOrder()] = $stack;
}
$this->changeHelper->boardChanged($stackToSort->getBoardId());
return $result;
}
}

5
tests/unit/Service/BoardServiceTest.php
View File

@@ -38,6 +38,7 @@ use OCA\Deck\Notification\NotificationHelper;
use OCP\IUser;
use OCP\IUserManager;
use OCP\IGroupManager;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use \Test\TestCase;
class BoardServiceTest extends TestCase {
@@ -68,6 +69,8 @@ class BoardServiceTest extends TestCase {
private $activityManager;
/** @var ChangeHelper */
private $changeHelper;
/** @var EventDispatcherInterface */
private $eventDispatcher;
private $userId = 'admin';
public function setUp() {
@@ -84,6 +87,7 @@ class BoardServiceTest extends TestCase {
$this->groupManager = $this->createMock(IGroupManager::class);
$this->activityManager = $this->createMock(ActivityManager::class);
$this->changeHelper = $this->createMock(ChangeHelper::class);
$this->eventDispatcher = $this->createMock(EventDispatcherInterface::class);
$this->service = new BoardService(
$this->boardMapper,
@@ -97,6 +101,7 @@ class BoardServiceTest extends TestCase {
$this->userManager,
$this->groupManager,
$this->activityManager,
$this->eventDispatcher,
$this->changeHelper,
$this->userId
);

5
tests/unit/Service/CardServiceTest.php
View File

@@ -41,6 +41,7 @@ use OCP\Comments\ICommentsManager;
use OCP\IUser;
use OCP\IUserManager;
use PHPUnit\Framework\MockObject\MockObject;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Test\TestCase;
class CardServiceTest extends TestCase {
@@ -70,6 +71,8 @@ class CardServiceTest extends TestCase {
private $commentsManager;
/** @var ICommentsManager|MockObject */
private $userManager;
/** @var EventDispatcherInterface */
private $eventDispatcher;
/** @var ChangeHelper|MockObject */
private $changeHelper;
@@ -87,6 +90,7 @@ class CardServiceTest extends TestCase {
$this->activityManager = $this->createMock(ActivityManager::class);
$this->commentsManager = $this->createMock(ICommentsManager::class);
$this->userManager = $this->createMock(IUserManager::class);
$this->eventDispatcher = $this->createMock(EventDispatcherInterface::class);
$this->changeHelper = $this->createMock(ChangeHelper::class);
$this->cardService = new CardService(
$this->cardMapper,
@@ -102,6 +106,7 @@ class CardServiceTest extends TestCase {
$this->commentsManager,
$this->userManager,
$this->changeHelper,
$this->eventDispatcher,
'user1'
);
}

5
tests/unit/Service/StackServiceTest.php
View File

@@ -35,6 +35,7 @@ use OCA\Deck\Db\Label;
use OCA\Deck\Db\LabelMapper;
use OCA\Deck\Db\Stack;
use OCA\Deck\Db\StackMapper;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use \Test\TestCase;
/**
@@ -69,6 +70,8 @@ class StackServiceTest extends TestCase {
private $activityManager;
/** @var ChangeHelper|\PHPUnit\Framework\MockObject\MockObject */
private $changeHelper;
/** @var EventDispatcherInterface */
private $eventDispatcher;
public function setUp() {
parent::setUp();
@@ -83,6 +86,7 @@ class StackServiceTest extends TestCase {
$this->labelMapper = $this->createMock(LabelMapper::class);
$this->activityManager = $this->createMock(ActivityManager::class);
$this->changeHelper = $this->createMock(ChangeHelper::class);
$this->eventDispatcher = $this->createMock(EventDispatcherInterface::class);
$this->stackService = new StackService(
$this->stackMapper,
@@ -95,6 +99,7 @@ class StackServiceTest extends TestCase {
$this->assignedUsersMapper,
$this->attachmentService,
$this->activityManager,
$this->eventDispatcher,
$this->changeHelper
);
}