-<?php namespace BookStack\Http\Controllers;
-
-use BookStack\Actions\ViewService;
-use BookStack\Entities\Book;
-use BookStack\Entities\Bookshelf;
-use BookStack\Entities\Entity;
-use BookStack\Entities\Managers\EntityContext;
-use BookStack\Entities\SearchService;
+<?php
+
+namespace BookStack\Http\Controllers;
+
+use BookStack\Entities\Queries\Popular;
+use BookStack\Entities\Tools\SiblingFetcher;
+use BookStack\Search\SearchOptions;
+use BookStack\Search\SearchResultsFormatter;
+use BookStack\Search\SearchRunner;
use Illuminate\Http\Request;
class SearchController extends Controller
{
- protected $viewService;
- protected $searchService;
- protected $entityContextManager;
+ protected SearchRunner $searchRunner;
- /**
- * SearchController constructor.
- */
- public function __construct(
- ViewService $viewService,
- SearchService $searchService,
- EntityContext $entityContextManager
- ) {
- $this->viewService = $viewService;
- $this->searchService = $searchService;
- $this->entityContextManager = $entityContextManager;
- parent::__construct();
+ public function __construct(SearchRunner $searchRunner)
+ {
+ $this->searchRunner = $searchRunner;
}
/**
* Searches all entities.
*/
- public function search(Request $request)
+ public function search(Request $request, SearchResultsFormatter $formatter)
{
- $searchTerm = $request->get('term');
- $this->setPageTitle(trans('entities.search_for_term', ['term' => $searchTerm]));
+ $searchOpts = SearchOptions::fromRequest($request);
+ $fullSearchString = $searchOpts->toString();
+ $this->setPageTitle(trans('entities.search_for_term', ['term' => $fullSearchString]));
$page = intval($request->get('page', '0')) ?: 1;
- $nextPageLink = url('/search?term=' . urlencode($searchTerm) . '&page=' . ($page+1));
+ $nextPageLink = url('/search?term=' . urlencode($fullSearchString) . '&page=' . ($page + 1));
- $results = $this->searchService->searchEntities($searchTerm, 'all', $page, 20);
+ $results = $this->searchRunner->searchEntities($searchOpts, 'all', $page, 20);
+ $formatter->format($results['results']->all(), $searchOpts);
return view('search.all', [
- 'entities' => $results['results'],
+ 'entities' => $results['results'],
'totalResults' => $results['total'],
- 'searchTerm' => $searchTerm,
- 'hasNextPage' => $results['has_more'],
- 'nextPageLink' => $nextPageLink
+ 'searchTerm' => $fullSearchString,
+ 'hasNextPage' => $results['has_more'],
+ 'nextPageLink' => $nextPageLink,
+ 'options' => $searchOpts,
]);
}
-
/**
* Searches all entities within a book.
*/
public function searchBook(Request $request, int $bookId)
{
$term = $request->get('term', '');
- $results = $this->searchService->searchBook($bookId, $term);
- return view('partials.entity-list', ['entities' => $results]);
+ $results = $this->searchRunner->searchBook($bookId, $term);
+
+ return view('entities.list', ['entities' => $results]);
}
/**
public function searchChapter(Request $request, int $chapterId)
{
$term = $request->get('term', '');
- $results = $this->searchService->searchChapter($chapterId, $term);
- return view('partials.entity-list', ['entities' => $results]);
+ $results = $this->searchRunner->searchChapter($chapterId, $term);
+
+ return view('entities.list', ['entities' => $results]);
}
/**
* Search for a list of entities and return a partial HTML response of matching entities.
* Returns the most popular entities if no search is provided.
*/
- public function searchEntitiesAjax(Request $request)
+ public function searchForSelector(Request $request)
{
$entityTypes = $request->filled('types') ? explode(',', $request->get('types')) : ['page', 'chapter', 'book'];
- $searchTerm = $request->get('term', false);
+ $searchTerm = $request->get('term', false);
$permission = $request->get('permission', 'view');
// Search for entities otherwise show most popular
if ($searchTerm !== false) {
- $searchTerm .= ' {type:'. implode('|', $entityTypes) .'}';
- $entities = $this->searchService->searchEntities($searchTerm, 'all', 1, 20, $permission)['results'];
+ $searchTerm .= ' {type:' . implode('|', $entityTypes) . '}';
+ $entities = $this->searchRunner->searchEntities(SearchOptions::fromString($searchTerm), 'all', 1, 20)['results'];
} else {
- $entities = $this->viewService->getPopular(20, 0, $entityTypes, $permission);
+ $entities = (new Popular())->run(20, 0, $entityTypes);
}
- return view('search.entity-ajax-list', ['entities' => $entities]);
+ return view('search.parts.entity-selector-list', ['entities' => $entities, 'permission' => $permission]);
}
/**
- * Search siblings items in the system.
+ * Search for a list of entities and return a partial HTML response of matching entities
+ * to be used as a result preview suggestion list for global system searches.
*/
- public function searchSiblings(Request $request)
+ public function searchSuggestions(Request $request)
{
- $type = $request->get('entity_type', null);
- $id = $request->get('entity_id', null);
+ $searchTerm = $request->get('term', '');
+ $entities = $this->searchRunner->searchEntities(SearchOptions::fromString($searchTerm), 'all', 1, 5)['results'];
- $entity = Entity::getEntityInstance($type)->newQuery()->visible()->find($id);
- if (!$entity) {
- return $this->jsonError(trans('errors.entity_not_found'), 404);
+ foreach ($entities as $entity) {
+ $entity->setAttribute('preview_content', '');
}
- $entities = [];
-
- // Page in chapter
- if ($entity->isA('page') && $entity->chapter) {
- $entities = $entity->chapter->visiblePages();
- }
-
- // Page in book or chapter
- if (($entity->isA('page') && !$entity->chapter) || $entity->isA('chapter')) {
- $entities = $entity->book->getDirectChildren();
- }
+ return view('search.parts.entity-suggestion-list', [
+ 'entities' => $entities->slice(0, 5)
+ ]);
+ }
- // Book
- // Gets just the books in a shelf if shelf is in context
- if ($entity->isA('book')) {
- $contextShelf = $this->entityContextManager->getContextualShelfForBook($entity);
- if ($contextShelf) {
- $entities = $contextShelf->visibleBooks()->get();
- } else {
- $entities = Book::visible()->get();
- }
- }
+ /**
+ * Search siblings items in the system.
+ */
+ public function searchSiblings(Request $request)
+ {
+ $type = $request->get('entity_type', null);
+ $id = $request->get('entity_id', null);
- // Shelve
- if ($entity->isA('bookshelf')) {
- $entities = Bookshelf::visible()->get();
- }
+ $entities = (new SiblingFetcher())->fetch($type, $id);
- return view('partials.entity-list-basic', ['entities' => $entities, 'style' => 'compact']);
+ return view('entities.list-basic', ['entities' => $entities, 'style' => 'compact']);
}
}