]> BookStack Code Mirror - bookstack/blob - tests/Entity/EntitySearchTest.php
Merge branch 'fix/oidc-logout' into development
[bookstack] / tests / Entity / EntitySearchTest.php
1 <?php
2
3 namespace Tests\Entity;
4
5 use BookStack\Activity\Models\Tag;
6 use BookStack\Entities\Models\Book;
7 use BookStack\Entities\Models\Bookshelf;
8 use BookStack\Entities\Models\Chapter;
9 use Tests\TestCase;
10
11 class EntitySearchTest extends TestCase
12 {
13     public function test_page_search()
14     {
15         $book = $this->entities->book();
16         $page = $book->pages->first();
17
18         $search = $this->asEditor()->get('/search?term=' . urlencode($page->name));
19         $search->assertSee('Search Results');
20         $search->assertSeeText($page->name, true);
21     }
22
23     public function test_bookshelf_search()
24     {
25         $shelf = $this->entities->shelf();
26
27         $search = $this->asEditor()->get('/search?term=' . urlencode($shelf->name) . '  {type:bookshelf}');
28         $search->assertSee('Search Results');
29         $search->assertSeeText($shelf->name, true);
30     }
31
32     public function test_invalid_page_search()
33     {
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);
38     }
39
40     public function test_empty_search_shows_search_page()
41     {
42         $res = $this->asEditor()->get('/search');
43         $res->assertStatus(200);
44     }
45
46     public function test_searching_accents_and_small_terms()
47     {
48         $page = $this->entities->newPage(['name' => 'My new test quaffleachits', 'html' => 'some áéííúü¿¡ test content a2 orange dog']);
49         $this->asEditor();
50
51         $accentSearch = $this->get('/search?term=' . urlencode('áéíí'));
52         $accentSearch->assertStatus(200)->assertSee($page->name);
53
54         $smallSearch = $this->get('/search?term=' . urlencode('a2'));
55         $smallSearch->assertStatus(200)->assertSee($page->name);
56     }
57
58     public function test_book_search()
59     {
60         $book = Book::first();
61         $page = $book->pages->last();
62         $chapter = $book->chapters->last();
63
64         $pageTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($page->name));
65         $pageTestResp->assertSee($page->name);
66
67         $chapterTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($chapter->name));
68         $chapterTestResp->assertSee($chapter->name);
69     }
70
71     public function test_chapter_search()
72     {
73         $chapter = $this->entities->chapterHasPages();
74         $page = $chapter->pages[0];
75
76         $pageTestResp = $this->asEditor()->get('/search/chapter/' . $chapter->id . '?term=' . urlencode($page->name));
77         $pageTestResp->assertSee($page->name);
78     }
79
80     public function test_tag_search()
81     {
82         $newTags = [
83             new Tag([
84                 'name'  => 'animal',
85                 'value' => 'cat',
86             ]),
87             new Tag([
88                 'name'  => 'color',
89                 'value' => 'red',
90             ]),
91         ];
92
93         $pageA = $this->entities->page();
94         $pageA->tags()->saveMany($newTags);
95
96         $pageB = $this->entities->page();
97         $pageB->tags()->create(['name' => 'animal', 'value' => 'dog']);
98
99         $this->asEditor();
100         $tNameSearch = $this->get('/search?term=%5Banimal%5D');
101         $tNameSearch->assertSee($pageA->name)->assertSee($pageB->name);
102
103         $tNameSearch2 = $this->get('/search?term=%5Bcolor%5D');
104         $tNameSearch2->assertSee($pageA->name)->assertDontSee($pageB->name);
105
106         $tNameValSearch = $this->get('/search?term=%5Banimal%3Dcat%5D');
107         $tNameValSearch->assertSee($pageA->name)->assertDontSee($pageB->name);
108     }
109
110     public function test_exact_searches()
111     {
112         $page = $this->entities->newPage(['name' => 'My new test page', 'html' => 'this is a story about an orange donkey']);
113
114         $exactSearchA = $this->asEditor()->get('/search?term=' . urlencode('"story about an orange"'));
115         $exactSearchA->assertStatus(200)->assertSee($page->name);
116
117         $exactSearchB = $this->asEditor()->get('/search?term=' . urlencode('"story not about an orange"'));
118         $exactSearchB->assertStatus(200)->assertDontSee($page->name);
119     }
120
121     public function test_search_terms_with_delimiters_are_converted_to_exact_matches()
122     {
123         $this->asEditor();
124         $page = $this->entities->newPage(['name' => 'Delimiter test', 'html' => '<p>1.1 2,2 3?3 4:4 5;5 (8) &lt;9&gt; "10" \'11\' `12`</p>']);
125         $terms = explode(' ', '1.1 2,2 3?3 4:4 5;5 (8) <9> "10" \'11\' `12`');
126
127         foreach ($terms as $term) {
128             $search = $this->get('/search?term=' . urlencode($term));
129             $search->assertSee($page->name);
130         }
131     }
132
133     public function test_search_filters()
134     {
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);
138
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);
145
146         // User filters
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;
152         $page->save();
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;
158         $page->save();
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;
163         $page->save();
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);
166
167         // Content filters
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);
172
173         // Restricted filter
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);
177
178         // Date filters
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';
182         $page->save();
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);
185
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';
189         $page->save();
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);
192     }
193
194     public function test_entity_selector_search()
195     {
196         $page = $this->entities->newPage(['name' => 'my ajax search test', 'html' => 'ajax test']);
197         $notVisitedPage = $this->entities->page();
198
199         // Visit the page to make popular
200         $this->asEditor()->get($page->getUrl());
201
202         $normalSearch = $this->get('/search/entity-selector?term=' . urlencode($page->name));
203         $normalSearch->assertSee($page->name);
204
205         $bookSearch = $this->get('/search/entity-selector?types=book&term=' . urlencode($page->name));
206         $bookSearch->assertDontSee($page->name);
207
208         $defaultListTest = $this->get('/search/entity-selector');
209         $defaultListTest->assertSee($page->name);
210         $defaultListTest->assertDontSee($notVisitedPage->name);
211     }
212
213     public function test_entity_selector_search_shows_breadcrumbs()
214     {
215         $chapter = $this->entities->chapter();
216         $page = $chapter->pages->first();
217         $this->asEditor();
218
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));
223
224         $chapterSearch = $this->get('/search/entity-selector?term=' . urlencode($chapter->name));
225         $chapterSearch->assertSee($chapter->name);
226         $chapterSearch->assertSee($chapter->book->getShortName(42));
227     }
228
229     public function test_entity_selector_shows_breadcrumbs_on_default_view()
230     {
231         $page = $this->entities->pageWithinChapter();
232         $this->asEditor()->get($page->chapter->getUrl());
233
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));
238     }
239
240     public function test_entity_selector_search_reflects_items_without_permission()
241     {
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);
245
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");
249
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");
253     }
254
255     public function test_sibling_search_for_pages()
256     {
257         $chapter = $this->entities->chapterHasPages();
258         $this->assertGreaterThan(2, count($chapter->pages), 'Ensure we\'re testing with at least 1 sibling');
259         $page = $chapter->pages->first();
260
261         $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
262         $search->assertSuccessful();
263         foreach ($chapter->pages as $page) {
264             $search->assertSee($page->name);
265         }
266
267         $search->assertDontSee($chapter->name);
268     }
269
270     public function test_sibling_search_for_pages_without_chapter()
271     {
272         $page = $this->entities->pageNotWithinChapter();
273         $bookChildren = $page->book->getDirectChildren();
274         $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
275
276         $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
277         $search->assertSuccessful();
278         foreach ($bookChildren as $child) {
279             $search->assertSee($child->name);
280         }
281
282         $search->assertDontSee($page->book->name);
283     }
284
285     public function test_sibling_search_for_chapters()
286     {
287         $chapter = $this->entities->chapter();
288         $bookChildren = $chapter->book->getDirectChildren();
289         $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
290
291         $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$chapter->id}&entity_type=chapter");
292         $search->assertSuccessful();
293         foreach ($bookChildren as $child) {
294             $search->assertSee($child->name);
295         }
296
297         $search->assertDontSee($chapter->book->name);
298     }
299
300     public function test_sibling_search_for_books()
301     {
302         $books = Book::query()->take(10)->get();
303         $book = $books->first();
304         $this->assertGreaterThan(2, count($books), 'Ensure we\'re testing with at least 1 sibling');
305
306         $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$book->id}&entity_type=book");
307         $search->assertSuccessful();
308         foreach ($books as $expectedBook) {
309             $search->assertSee($expectedBook->name);
310         }
311     }
312
313     public function test_sibling_search_for_shelves()
314     {
315         $shelves = Bookshelf::query()->take(10)->get();
316         $shelf = $shelves->first();
317         $this->assertGreaterThan(2, count($shelves), 'Ensure we\'re testing with at least 1 sibling');
318
319         $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$shelf->id}&entity_type=bookshelf");
320         $search->assertSuccessful();
321         foreach ($shelves as $expectedShelf) {
322             $search->assertSee($expectedShelf->name);
323         }
324     }
325
326     public function test_search_works_on_updated_page_content()
327     {
328         $page = $this->entities->page();
329         $this->asEditor();
330
331         $update = $this->put($page->getUrl(), [
332             'name' => $page->name,
333             'html' => '<p>dog pandabearmonster spaghetti</p>',
334         ]);
335
336         $search = $this->asEditor()->get('/search?term=pandabearmonster');
337         $search->assertStatus(200);
338         $search->assertSeeText($page->name);
339         $search->assertSee($page->getUrl());
340     }
341
342     public function test_search_ranks_common_words_lower()
343     {
344         $this->entities->newPage(['name' => 'Test page A', 'html' => '<p>dog biscuit dog dog</p>']);
345         $this->entities->newPage(['name' => 'Test page B', 'html' => '<p>cat biscuit</p>']);
346
347         $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
348         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(1)', 'Test page A');
349         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(2)', 'Test page B');
350
351         for ($i = 0; $i < 2; $i++) {
352             $this->entities->newPage(['name' => 'Test page ' . $i, 'html' => '<p>dog</p>']);
353         }
354
355         $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
356         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(1)', 'Test page B');
357         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(2)', 'Test page A');
358     }
359
360     public function test_terms_in_headers_have_an_adjusted_index_score()
361     {
362         $page = $this->entities->newPage(['name' => 'Test page A', 'html' => '
363             <p>TermA</p>
364             <h1>TermB <strong>TermNested</strong></h1>
365             <h2>TermC</h2>
366             <h3>TermD</h3>
367             <h4>TermE</h4>
368             <h5>TermF</h5>
369             <h6>TermG</h6>
370         ']);
371
372         $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
373
374         $this->assertEquals(1, $scoreByTerm->get('TermA'));
375         $this->assertEquals(10, $scoreByTerm->get('TermB'));
376         $this->assertEquals(10, $scoreByTerm->get('TermNested'));
377         $this->assertEquals(5, $scoreByTerm->get('TermC'));
378         $this->assertEquals(4, $scoreByTerm->get('TermD'));
379         $this->assertEquals(3, $scoreByTerm->get('TermE'));
380         $this->assertEquals(2, $scoreByTerm->get('TermF'));
381         // Is 1.5 but stored as integer, rounding up
382         $this->assertEquals(2, $scoreByTerm->get('TermG'));
383     }
384
385     public function test_name_and_content_terms_are_merged_to_single_score()
386     {
387         $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
388             <p>TermA</p>
389         ']);
390
391         $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
392
393         // Scores 40 for being in the name then 1 for being in the content
394         $this->assertEquals(41, $scoreByTerm->get('TermA'));
395     }
396
397     public function test_tag_names_and_values_are_indexed_for_search()
398     {
399         $page = $this->entities->newPage(['name' => 'PageA', 'html' => '<p>content</p>', 'tags' => [
400             ['name' => 'Animal', 'value' => 'MeowieCat'],
401             ['name' => 'SuperImportant'],
402         ]]);
403
404         $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
405         $this->assertEquals(5, $scoreByTerm->get('MeowieCat'));
406         $this->assertEquals(3, $scoreByTerm->get('Animal'));
407         $this->assertEquals(3, $scoreByTerm->get('SuperImportant'));
408     }
409
410     public function test_matching_terms_in_search_results_are_highlighted()
411     {
412         $this->entities->newPage(['name' => 'My Meowie Cat', 'html' => '<p>A superimportant page about meowieable animals</p>', 'tags' => [
413             ['name' => 'Animal', 'value' => 'MeowieCat'],
414             ['name' => 'SuperImportant'],
415         ]]);
416
417         $search = $this->asEditor()->get('/search?term=SuperImportant+Meowie');
418         // Title
419         $search->assertSee('My <strong>Meowie</strong> Cat', false);
420         // Content
421         $search->assertSee('A <strong>superimportant</strong> page about <strong>meowie</strong>able animals', false);
422         // Tag name
423         $this->withHtml($search)->assertElementContains('.tag-name.highlight', 'SuperImportant');
424         // Tag value
425         $this->withHtml($search)->assertElementContains('.tag-value.highlight', 'MeowieCat');
426     }
427
428     public function test_match_highlighting_works_with_multibyte_content()
429     {
430         $this->entities->newPage([
431             'name' => 'Test Page',
432             'html' => '<p>На мен ми трябва нещо добро test</p>',
433         ]);
434
435         $search = $this->asEditor()->get('/search?term=' . urlencode('На мен ми трябва нещо добро'));
436         $search->assertSee('<strong>На</strong> <strong>мен</strong> <strong>ми</strong> <strong>трябва</strong> <strong>нещо</strong> <strong>добро</strong> test', false);
437     }
438
439     public function test_html_entities_in_item_details_remains_escaped_in_search_results()
440     {
441         $this->entities->newPage(['name' => 'My <cool> TestPageContent', 'html' => '<p>My supercool &lt;great&gt; TestPageContent page</p>']);
442
443         $search = $this->asEditor()->get('/search?term=TestPageContent');
444         $search->assertSee('My &lt;cool&gt; <strong>TestPageContent</strong>', false);
445         $search->assertSee('My supercool &lt;great&gt; <strong>TestPageContent</strong> page', false);
446     }
447
448     public function test_words_adjacent_to_lines_breaks_can_be_matched_with_normal_terms()
449     {
450         $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
451             <p>TermA<br>TermB<br>TermC</p>
452         ']);
453
454         $search = $this->asEditor()->get('/search?term=' . urlencode('TermB TermC'));
455
456         $search->assertSee($page->getUrl(), false);
457     }
458
459     public function test_backslashes_can_be_searched_upon()
460     {
461         $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
462             <p>More info is at the path \\\\cat\\dog\\badger</p>
463         ']);
464         $page->tags()->save(new Tag(['name' => '\\Category', 'value' => '\\animals\\fluffy']));
465
466         $search = $this->asEditor()->get('/search?term=' . urlencode('\\\\cat\\dog'));
467         $search->assertSee($page->getUrl(), false);
468
469         $search = $this->asEditor()->get('/search?term=' . urlencode('"\\dog\\\\"'));
470         $search->assertSee($page->getUrl(), false);
471
472         $search = $this->asEditor()->get('/search?term=' . urlencode('"\\badger\\\\"'));
473         $search->assertDontSee($page->getUrl(), false);
474
475         $search = $this->asEditor()->get('/search?term=' . urlencode('[\\Categorylike%\\fluffy]'));
476         $search->assertSee($page->getUrl(), false);
477     }
478
479     public function test_searches_with_user_filters_adds_them_into_advanced_search_form()
480     {
481         $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:dan} {created_by:dan}'));
482         $this->withHtml($resp)->assertElementExists('form input[name="filters[updated_by]"][value="dan"]');
483         $this->withHtml($resp)->assertElementExists('form input[name="filters[created_by]"][value="dan"]');
484     }
485
486     public function test_searches_with_user_filters_using_me_adds_them_into_advanced_search_form()
487     {
488         $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:me} {created_by:me}'));
489         $this->withHtml($resp)->assertElementExists('form input[name="filters[updated_by]"][value="me"][checked="checked"]');
490         $this->withHtml($resp)->assertElementExists('form input[name="filters[created_by]"][value="me"][checked="checked"]');
491     }
492
493     public function test_search_suggestion_endpoint()
494     {
495         $this->entities->newPage(['name' => 'My suggestion page', 'html' => '<p>My supercool suggestion page</p>']);
496
497         // Test specific search
498         $resp = $this->asEditor()->get('/search/suggest?term="supercool+suggestion"');
499         $resp->assertSee('My suggestion page');
500         $resp->assertDontSee('My supercool suggestion page');
501         $resp->assertDontSee('No items available');
502         $this->withHtml($resp)->assertElementCount('a', 1);
503
504         // Test search limit
505         $resp = $this->asEditor()->get('/search/suggest?term=et');
506         $this->withHtml($resp)->assertElementCount('a', 5);
507
508         // Test empty state
509         $resp = $this->asEditor()->get('/search/suggest?term=spaghettisaurusrex');
510         $this->withHtml($resp)->assertElementCount('a', 0);
511         $resp->assertSee('No items available');
512     }
513 }