BookStack Code Mirror - bookstack/blob - app/Http/Controllers/SearchController.php

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