3 namespace Tests\Entity;
5 use BookStack\Activity\Models\Tag;
6 use BookStack\Entities\Models\Book;
7 use BookStack\Entities\Models\Bookshelf;
8 use BookStack\Entities\Models\Chapter;
11 class EntitySearchTest extends TestCase
13 public function test_page_search()
15 $book = $this->entities->book();
16 $page = $book->pages->first();
18 $search = $this->asEditor()->get('/search?term=' . urlencode($page->name));
19 $search->assertSee('Search Results');
20 $search->assertSeeText($page->name, true);
23 public function test_bookshelf_search()
25 $shelf = $this->entities->shelf();
27 $search = $this->asEditor()->get('/search?term=' . urlencode($shelf->name) . ' {type:bookshelf}');
28 $search->assertSee('Search Results');
29 $search->assertSeeText($shelf->name, true);
32 public function test_invalid_page_search()
34 $resp = $this->asEditor()->get('/search?term=' . urlencode('<p>test</p>'));
35 $resp->assertSee('Search Results');
36 $resp->assertStatus(200);
37 $this->get('/search?term=cat+-')->assertStatus(200);
40 public function test_empty_search_shows_search_page()
42 $res = $this->asEditor()->get('/search');
43 $res->assertStatus(200);
46 public function test_searching_accents_and_small_terms()
48 $page = $this->entities->newPage(['name' => 'My new test quaffleachits', 'html' => 'some áéííúü¿¡ test content a2 orange dog']);
51 $accentSearch = $this->get('/search?term=' . urlencode('áéíí'));
52 $accentSearch->assertStatus(200)->assertSee($page->name);
54 $smallSearch = $this->get('/search?term=' . urlencode('a2'));
55 $smallSearch->assertStatus(200)->assertSee($page->name);
58 public function test_book_search()
60 $book = Book::first();
61 $page = $book->pages->last();
62 $chapter = $book->chapters->last();
64 $pageTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($page->name));
65 $pageTestResp->assertSee($page->name);
67 $chapterTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($chapter->name));
68 $chapterTestResp->assertSee($chapter->name);
71 public function test_chapter_search()
73 $chapter = $this->entities->chapterHasPages();
74 $page = $chapter->pages[0];
76 $pageTestResp = $this->asEditor()->get('/search/chapter/' . $chapter->id . '?term=' . urlencode($page->name));
77 $pageTestResp->assertSee($page->name);
80 public function test_tag_search()
93 $pageA = $this->entities->page();
94 $pageA->tags()->saveMany($newTags);
96 $pageB = $this->entities->page();
97 $pageB->tags()->create(['name' => 'animal', 'value' => 'dog']);
100 $tNameSearch = $this->get('/search?term=%5Banimal%5D');
101 $tNameSearch->assertSee($pageA->name)->assertSee($pageB->name);
103 $tNameSearch2 = $this->get('/search?term=%5Bcolor%5D');
104 $tNameSearch2->assertSee($pageA->name)->assertDontSee($pageB->name);
106 $tNameValSearch = $this->get('/search?term=%5Banimal%3Dcat%5D');
107 $tNameValSearch->assertSee($pageA->name)->assertDontSee($pageB->name);
110 public function test_exact_searches()
112 $page = $this->entities->newPage(['name' => 'My new test page', 'html' => 'this is a story about an orange donkey']);
114 $exactSearchA = $this->asEditor()->get('/search?term=' . urlencode('"story about an orange"'));
115 $exactSearchA->assertStatus(200)->assertSee($page->name);
117 $exactSearchB = $this->asEditor()->get('/search?term=' . urlencode('"story not about an orange"'));
118 $exactSearchB->assertStatus(200)->assertDontSee($page->name);
121 public function test_search_terms_with_delimiters_are_converted_to_exact_matches()
124 $page = $this->entities->newPage(['name' => 'Delimiter test', 'html' => '<p>1.1 2,2 3?3 4:4 5;5 (8) <9> "10" \'11\' `12`</p>']);
125 $terms = explode(' ', '1.1 2,2 3?3 4:4 5;5 (8) <9> "10" \'11\' `12`');
127 foreach ($terms as $term) {
128 $search = $this->get('/search?term=' . urlencode($term));
129 $search->assertSee($page->name);
133 public function test_search_filters()
135 $page = $this->entities->newPage(['name' => 'My new test quaffleachits', 'html' => 'this is about an orange donkey danzorbhsing']);
136 $editor = $this->users->editor();
137 $this->actingAs($editor);
139 // Viewed filter searches
140 $this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertSee($page->name);
141 $this->get('/search?term=' . urlencode('danzorbhsing {viewed_by_me}'))->assertDontSee($page->name);
142 $this->get($page->getUrl());
143 $this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertDontSee($page->name);
144 $this->get('/search?term=' . urlencode('danzorbhsing {viewed_by_me}'))->assertSee($page->name);
147 $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertDontSee($page->name);
148 $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
149 $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
150 $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editor->slug . '}'))->assertDontSee($page->name);
151 $page->created_by = $editor->id;
153 $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertSee($page->name);
154 $this->get('/search?term=' . urlencode('danzorbhsing {created_by: ' . $editor->slug . '}'))->assertSee($page->name);
155 $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
156 $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
157 $page->updated_by = $editor->id;
159 $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertSee($page->name);
160 $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editor->slug . '}'))->assertSee($page->name);
161 $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
162 $page->owned_by = $editor->id;
164 $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertSee($page->name);
165 $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:' . $editor->slug . '}'))->assertSee($page->name);
168 $this->get('/search?term=' . urlencode('{in_name:danzorbhsing}'))->assertDontSee($page->name);
169 $this->get('/search?term=' . urlencode('{in_body:danzorbhsing}'))->assertSee($page->name);
170 $this->get('/search?term=' . urlencode('{in_name:test quaffleachits}'))->assertSee($page->name);
171 $this->get('/search?term=' . urlencode('{in_body:test quaffleachits}'))->assertDontSee($page->name);
174 $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertDontSee($page->name);
175 $this->permissions->setEntityPermissions($page, ['view'], [$editor->roles->first()]);
176 $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertSee($page->name);
179 $this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertDontSee($page->name);
180 $this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertSee($page->name);
181 $page->updated_at = '2037-02-01';
183 $this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertSee($page->name);
184 $this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertDontSee($page->name);
186 $this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertDontSee($page->name);
187 $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertSee($page->name);
188 $page->created_at = '2037-02-01';
190 $this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertSee($page->name);
191 $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertDontSee($page->name);
194 public function test_entity_selector_search()
196 $page = $this->entities->newPage(['name' => 'my ajax search test', 'html' => 'ajax test']);
197 $notVisitedPage = $this->entities->page();
199 // Visit the page to make popular
200 $this->asEditor()->get($page->getUrl());
202 $normalSearch = $this->get('/search/entity-selector?term=' . urlencode($page->name));
203 $normalSearch->assertSee($page->name);
205 $bookSearch = $this->get('/search/entity-selector?types=book&term=' . urlencode($page->name));
206 $bookSearch->assertDontSee($page->name);
208 $defaultListTest = $this->get('/search/entity-selector');
209 $defaultListTest->assertSee($page->name);
210 $defaultListTest->assertDontSee($notVisitedPage->name);
213 public function test_entity_selector_search_shows_breadcrumbs()
215 $chapter = $this->entities->chapter();
216 $page = $chapter->pages->first();
219 $pageSearch = $this->get('/search/entity-selector?term=' . urlencode($page->name));
220 $pageSearch->assertSee($page->name);
221 $pageSearch->assertSee($chapter->getShortName(42));
222 $pageSearch->assertSee($page->book->getShortName(42));
224 $chapterSearch = $this->get('/search/entity-selector?term=' . urlencode($chapter->name));
225 $chapterSearch->assertSee($chapter->name);
226 $chapterSearch->assertSee($chapter->book->getShortName(42));
229 public function test_entity_selector_shows_breadcrumbs_on_default_view()
231 $page = $this->entities->pageWithinChapter();
232 $this->asEditor()->get($page->chapter->getUrl());
234 $resp = $this->asEditor()->get('/search/entity-selector?types=book,chapter&permission=page-create');
235 $html = $this->withHtml($resp);
236 $html->assertElementContains('.chapter.entity-list-item', $page->chapter->name);
237 $html->assertElementContains('.chapter.entity-list-item .entity-item-snippet', $page->book->getShortName(42));
240 public function test_entity_selector_search_reflects_items_without_permission()
242 $page = $this->entities->page();
243 $baseSelector = 'a[data-entity-type="page"][data-entity-id="' . $page->id . '"]';
244 $searchUrl = '/search/entity-selector?permission=update&term=' . urlencode($page->name);
246 $resp = $this->asEditor()->get($searchUrl);
247 $this->withHtml($resp)->assertElementContains($baseSelector, $page->name);
248 $this->withHtml($resp)->assertElementNotContains($baseSelector, "You don't have the required permissions to select this item");
250 $resp = $this->actingAs($this->users->viewer())->get($searchUrl);
251 $this->withHtml($resp)->assertElementContains($baseSelector, $page->name);
252 $this->withHtml($resp)->assertElementContains($baseSelector, "You don't have the required permissions to select this item");
255 public function test_entity_template_selector_search()
257 $templatePage = $this->entities->newPage(['name' => 'Template search test', 'html' => 'template test']);
258 $templatePage->template = true;
259 $templatePage->save();
261 $nonTemplatePage = $this->entities->newPage(['name' => 'Nontemplate page', 'html' => 'nontemplate', 'template' => false]);
263 // Visit both to make popular
264 $this->asEditor()->get($templatePage->getUrl());
265 $this->get($nonTemplatePage->getUrl());
267 $normalSearch = $this->get('/search/entity-selector-templates?term=test');
268 $normalSearch->assertSee($templatePage->name);
269 $normalSearch->assertDontSee($nonTemplatePage->name);
271 $normalSearch = $this->get('/search/entity-selector-templates?term=beans');
272 $normalSearch->assertDontSee($templatePage->name);
273 $normalSearch->assertDontSee($nonTemplatePage->name);
275 $defaultListTest = $this->get('/search/entity-selector-templates');
276 $defaultListTest->assertSee($templatePage->name);
277 $defaultListTest->assertDontSee($nonTemplatePage->name);
279 $this->permissions->disableEntityInheritedPermissions($templatePage);
281 $normalSearch = $this->get('/search/entity-selector-templates?term=test');
282 $normalSearch->assertDontSee($templatePage->name);
284 $defaultListTest = $this->get('/search/entity-selector-templates');
285 $defaultListTest->assertDontSee($templatePage->name);
288 public function test_sibling_search_for_pages()
290 $chapter = $this->entities->chapterHasPages();
291 $this->assertGreaterThan(2, count($chapter->pages), 'Ensure we\'re testing with at least 1 sibling');
292 $page = $chapter->pages->first();
294 $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
295 $search->assertSuccessful();
296 foreach ($chapter->pages as $page) {
297 $search->assertSee($page->name);
300 $search->assertDontSee($chapter->name);
303 public function test_sibling_search_for_pages_without_chapter()
305 $page = $this->entities->pageNotWithinChapter();
306 $bookChildren = $page->book->getDirectVisibleChildren();
307 $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
309 $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
310 $search->assertSuccessful();
311 foreach ($bookChildren as $child) {
312 $search->assertSee($child->name);
315 $search->assertDontSee($page->book->name);
318 public function test_sibling_search_for_chapters()
320 $chapter = $this->entities->chapter();
321 $bookChildren = $chapter->book->getDirectVisibleChildren();
322 $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
324 $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$chapter->id}&entity_type=chapter");
325 $search->assertSuccessful();
326 foreach ($bookChildren as $child) {
327 $search->assertSee($child->name);
330 $search->assertDontSee($chapter->book->name);
333 public function test_sibling_search_for_books()
335 $books = Book::query()->take(10)->get();
336 $book = $books->first();
337 $this->assertGreaterThan(2, count($books), 'Ensure we\'re testing with at least 1 sibling');
339 $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$book->id}&entity_type=book");
340 $search->assertSuccessful();
341 foreach ($books as $expectedBook) {
342 $search->assertSee($expectedBook->name);
346 public function test_sibling_search_for_shelves()
348 $shelves = Bookshelf::query()->take(10)->get();
349 $shelf = $shelves->first();
350 $this->assertGreaterThan(2, count($shelves), 'Ensure we\'re testing with at least 1 sibling');
352 $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$shelf->id}&entity_type=bookshelf");
353 $search->assertSuccessful();
354 foreach ($shelves as $expectedShelf) {
355 $search->assertSee($expectedShelf->name);
359 public function test_search_works_on_updated_page_content()
361 $page = $this->entities->page();
364 $update = $this->put($page->getUrl(), [
365 'name' => $page->name,
366 'html' => '<p>dog pandabearmonster spaghetti</p>',
369 $search = $this->asEditor()->get('/search?term=pandabearmonster');
370 $search->assertStatus(200);
371 $search->assertSeeText($page->name);
372 $search->assertSee($page->getUrl());
375 public function test_search_ranks_common_words_lower()
377 $this->entities->newPage(['name' => 'Test page A', 'html' => '<p>dog biscuit dog dog</p>']);
378 $this->entities->newPage(['name' => 'Test page B', 'html' => '<p>cat biscuit</p>']);
380 $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
381 $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(1)', 'Test page A');
382 $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(2)', 'Test page B');
384 for ($i = 0; $i < 2; $i++) {
385 $this->entities->newPage(['name' => 'Test page ' . $i, 'html' => '<p>dog</p>']);
388 $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
389 $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(1)', 'Test page B');
390 $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(2)', 'Test page A');
393 public function test_terms_in_headers_have_an_adjusted_index_score()
395 $page = $this->entities->newPage(['name' => 'Test page A', 'html' => '
397 <h1>TermB <strong>TermNested</strong></h1>
405 $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
407 $this->assertEquals(1, $scoreByTerm->get('TermA'));
408 $this->assertEquals(10, $scoreByTerm->get('TermB'));
409 $this->assertEquals(10, $scoreByTerm->get('TermNested'));
410 $this->assertEquals(5, $scoreByTerm->get('TermC'));
411 $this->assertEquals(4, $scoreByTerm->get('TermD'));
412 $this->assertEquals(3, $scoreByTerm->get('TermE'));
413 $this->assertEquals(2, $scoreByTerm->get('TermF'));
414 // Is 1.5 but stored as integer, rounding up
415 $this->assertEquals(2, $scoreByTerm->get('TermG'));
418 public function test_name_and_content_terms_are_merged_to_single_score()
420 $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
424 $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
426 // Scores 40 for being in the name then 1 for being in the content
427 $this->assertEquals(41, $scoreByTerm->get('TermA'));
430 public function test_tag_names_and_values_are_indexed_for_search()
432 $page = $this->entities->newPage(['name' => 'PageA', 'html' => '<p>content</p>', 'tags' => [
433 ['name' => 'Animal', 'value' => 'MeowieCat'],
434 ['name' => 'SuperImportant'],
437 $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
438 $this->assertEquals(5, $scoreByTerm->get('MeowieCat'));
439 $this->assertEquals(3, $scoreByTerm->get('Animal'));
440 $this->assertEquals(3, $scoreByTerm->get('SuperImportant'));
443 public function test_matching_terms_in_search_results_are_highlighted()
445 $this->entities->newPage(['name' => 'My Meowie Cat', 'html' => '<p>A superimportant page about meowieable animals</p>', 'tags' => [
446 ['name' => 'Animal', 'value' => 'MeowieCat'],
447 ['name' => 'SuperImportant'],
450 $search = $this->asEditor()->get('/search?term=SuperImportant+Meowie');
452 $search->assertSee('My <strong>Meowie</strong> Cat', false);
454 $search->assertSee('A <strong>superimportant</strong> page about <strong>meowie</strong>able animals', false);
456 $this->withHtml($search)->assertElementContains('.tag-name.highlight', 'SuperImportant');
458 $this->withHtml($search)->assertElementContains('.tag-value.highlight', 'MeowieCat');
461 public function test_match_highlighting_works_with_multibyte_content()
463 $this->entities->newPage([
464 'name' => 'Test Page',
465 'html' => '<p>На мен ми трябва нещо добро test</p>',
468 $search = $this->asEditor()->get('/search?term=' . urlencode('На мен ми трябва нещо добро'));
469 $search->assertSee('<strong>На</strong> <strong>мен</strong> <strong>ми</strong> <strong>трябва</strong> <strong>нещо</strong> <strong>добро</strong> test', false);
472 public function test_html_entities_in_item_details_remains_escaped_in_search_results()
474 $this->entities->newPage(['name' => 'My <cool> TestPageContent', 'html' => '<p>My supercool <great> TestPageContent page</p>']);
476 $search = $this->asEditor()->get('/search?term=TestPageContent');
477 $search->assertSee('My <cool> <strong>TestPageContent</strong>', false);
478 $search->assertSee('My supercool <great> <strong>TestPageContent</strong> page', false);
481 public function test_words_adjacent_to_lines_breaks_can_be_matched_with_normal_terms()
483 $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
484 <p>TermA<br>TermB<br>TermC</p>
487 $search = $this->asEditor()->get('/search?term=' . urlencode('TermB TermC'));
489 $search->assertSee($page->getUrl(), false);
492 public function test_backslashes_can_be_searched_upon()
494 $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
495 <p>More info is at the path \\\\cat\\dog\\badger</p>
497 $page->tags()->save(new Tag(['name' => '\\Category', 'value' => '\\animals\\fluffy']));
499 $search = $this->asEditor()->get('/search?term=' . urlencode('\\\\cat\\dog'));
500 $search->assertSee($page->getUrl(), false);
502 $search = $this->asEditor()->get('/search?term=' . urlencode('"\\dog\\\\"'));
503 $search->assertSee($page->getUrl(), false);
505 $search = $this->asEditor()->get('/search?term=' . urlencode('"\\badger\\\\"'));
506 $search->assertDontSee($page->getUrl(), false);
508 $search = $this->asEditor()->get('/search?term=' . urlencode('[\\Categorylike%\\fluffy]'));
509 $search->assertSee($page->getUrl(), false);
512 public function test_searches_with_user_filters_adds_them_into_advanced_search_form()
514 $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:dan} {created_by:dan}'));
515 $this->withHtml($resp)->assertElementExists('form input[name="filters[updated_by]"][value="dan"]');
516 $this->withHtml($resp)->assertElementExists('form input[name="filters[created_by]"][value="dan"]');
519 public function test_searches_with_user_filters_using_me_adds_them_into_advanced_search_form()
521 $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:me} {created_by:me}'));
522 $this->withHtml($resp)->assertElementExists('form input[name="filters[updated_by]"][value="me"][checked="checked"]');
523 $this->withHtml($resp)->assertElementExists('form input[name="filters[created_by]"][value="me"][checked="checked"]');
526 public function test_search_suggestion_endpoint()
528 $this->entities->newPage(['name' => 'My suggestion page', 'html' => '<p>My supercool suggestion page</p>']);
530 // Test specific search
531 $resp = $this->asEditor()->get('/search/suggest?term="supercool+suggestion"');
532 $resp->assertSee('My suggestion page');
533 $resp->assertDontSee('My supercool suggestion page');
534 $resp->assertDontSee('No items available');
535 $this->withHtml($resp)->assertElementCount('a', 1);
538 $resp = $this->asEditor()->get('/search/suggest?term=et');
539 $this->withHtml($resp)->assertElementCount('a', 5);
542 $resp = $this->asEditor()->get('/search/suggest?term=spaghettisaurusrex');
543 $this->withHtml($resp)->assertElementCount('a', 0);
544 $resp->assertSee('No items available');