BookStack Code Mirror - bookstack/blob - app/Search/SearchController.php

   1 <?php
   2
   3 namespace BookStack\Search;
   4
   5 use BookStack\Entities\Models\Page;
   6 use BookStack\Entities\Queries\Popular;
   7 use BookStack\Entities\Tools\SiblingFetcher;
   8 use BookStack\Http\Controller;
   9 use Illuminate\Http\Request;
  10
  11 class SearchController extends Controller
  12 {
  13     public function __construct(
  14         protected SearchRunner $searchRunner
  15     ) {
  16     }
  17
  18     /**
  19      * Searches all entities.
  20      */
  21     public function search(Request $request, SearchResultsFormatter $formatter)
  22     {
  23         $searchOpts = SearchOptions::fromRequest($request);
  24         $fullSearchString = $searchOpts->toString();
  25         $this->setPageTitle(trans('entities.search_for_term', ['term' => $fullSearchString]));
  26
  27         $page = intval($request->get('page', '0')) ?: 1;
  28         $nextPageLink = url('/search?term=' . urlencode($fullSearchString) . '&page=' . ($page + 1));
  29
  30         $results = $this->searchRunner->searchEntities($searchOpts, 'all', $page, 20);
  31         $formatter->format($results['results']->all(), $searchOpts);
  32
  33         return view('search.all', [
  34             'entities'     => $results['results'],
  35             'totalResults' => $results['total'],
  36             'searchTerm'   => $fullSearchString,
  37             'hasNextPage'  => $results['has_more'],
  38             'nextPageLink' => $nextPageLink,
  39             'options'      => $searchOpts,
  40         ]);
  41     }
  42
  43     /**
  44      * Searches all entities within a book.
  45      */
  46     public function searchBook(Request $request, int $bookId)
  47     {
  48         $term = $request->get('term', '');
  49         $results = $this->searchRunner->searchBook($bookId, $term);
  50
  51         return view('entities.list', ['entities' => $results]);
  52     }
  53
  54     /**
  55      * Searches all entities within a chapter.
  56      */
  57     public function searchChapter(Request $request, int $chapterId)
  58     {
  59         $term = $request->get('term', '');
  60         $results = $this->searchRunner->searchChapter($chapterId, $term);
  61
  62         return view('entities.list', ['entities' => $results]);
  63     }
  64
  65     /**
  66      * Search for a list of entities and return a partial HTML response of matching entities.
  67      * Returns the most popular entities if no search is provided.
  68      */
  69     public function searchForSelector(Request $request)
  70     {
  71         $entityTypes = $request->filled('types') ? explode(',', $request->get('types')) : ['page', 'chapter', 'book'];
  72         $searchTerm = $request->get('term', false);
  73         $permission = $request->get('permission', 'view');
  74
  75         // Search for entities otherwise show most popular
  76         if ($searchTerm !== false) {
  77             $searchTerm .= ' {type:' . implode('|', $entityTypes) . '}';
  78             $entities = $this->searchRunner->searchEntities(SearchOptions::fromString($searchTerm), 'all', 1, 20)['results'];
  79         } else {
  80             $entities = (new Popular())->run(20, 0, $entityTypes);
  81         }
  82
  83         return view('search.parts.entity-selector-list', ['entities' => $entities, 'permission' => $permission]);
  84     }
  85
  86     /**
  87      * Search for a list of templates to choose from.
  88      */
  89     public function templatesForSelector(Request $request)
  90     {
  91         $searchTerm = $request->get('term', false);
  92
  93         if ($searchTerm !== false) {
  94             $searchOptions = SearchOptions::fromString($searchTerm);
  95             $searchOptions->setFilter('is_template');
  96             $entities = $this->searchRunner->searchEntities($searchOptions, 'page', 1, 20)['results'];
  97         } else {
  98             $entities = Page::visible()
  99                 ->where('template', '=', true)
 100                 ->where('draft', '=', false)
 101                 ->orderBy('updated_at', 'desc')
 102                 ->take(20)
 103                 ->get(Page::$listAttributes);
 104         }
 105
 106         return view('search.parts.entity-selector-list', [
 107             'entities' => $entities,
 108             'permission' => 'view'
 109         ]);
 110     }
 111
 112     /**
 113      * Search for a list of entities and return a partial HTML response of matching entities
 114      * to be used as a result preview suggestion list for global system searches.
 115      */
 116     public function searchSuggestions(Request $request)
 117     {
 118         $searchTerm = $request->get('term', '');
 119         $entities = $this->searchRunner->searchEntities(SearchOptions::fromString($searchTerm), 'all', 1, 5)['results'];
 120
 121         foreach ($entities as $entity) {
 122             $entity->setAttribute('preview_content', '');
 123         }
 124
 125         return view('search.parts.entity-suggestion-list', [
 126             'entities' => $entities->slice(0, 5)
 127         ]);
 128     }
 129
 130     /**
 131      * Search siblings items in the system.
 132      */
 133     public function searchSiblings(Request $request)
 134     {
 135         $type = $request->get('entity_type', null);
 136         $id = $request->get('entity_id', null);
 137
 138         $entities = (new SiblingFetcher())->fetch($type, $id);
 139
 140         return view('entities.list-basic', ['entities' => $entities, 'style' => 'compact']);
 141     }
 142 }