BookStack Code Mirror - bookstack/blob - tests/Entity/EntitySearchTest.php

   1 <?php
   2
   3 namespace Tests\Entity;
   4
   5 use BookStack\Actions\Tag;
   6 use BookStack\Entities\Models\Book;
   7 use BookStack\Entities\Models\Bookshelf;
   8 use Tests\TestCase;
   9
  10 class EntitySearchTest extends TestCase
  11 {
  12     public function test_page_search()
  13     {
  14         $book = $this->entities->book();
  15         $page = $book->pages->first();
  16
  17         $search = $this->asEditor()->get('/search?term=' . urlencode($page->name));
  18         $search->assertSee('Search Results');
  19         $search->assertSeeText($page->name, true);
  20     }
  21
  22     public function test_bookshelf_search()
  23     {
  24         $shelf = $this->entities->shelf();
  25
  26         $search = $this->asEditor()->get('/search?term=' . urlencode($shelf->name) . '  {type:bookshelf}');
  27         $search->assertSee('Search Results');
  28         $search->assertSeeText($shelf->name, true);
  29     }
  30
  31     public function test_invalid_page_search()
  32     {
  33         $resp = $this->asEditor()->get('/search?term=' . urlencode('<p>test</p>'));
  34         $resp->assertSee('Search Results');
  35         $resp->assertStatus(200);
  36         $this->get('/search?term=cat+-')->assertStatus(200);
  37     }
  38
  39     public function test_empty_search_shows_search_page()
  40     {
  41         $res = $this->asEditor()->get('/search');
  42         $res->assertStatus(200);
  43     }
  44
  45     public function test_searching_accents_and_small_terms()
  46     {
  47         $page = $this->entities->newPage(['name' => 'My new test quaffleachits', 'html' => 'some áéííúü¿¡ test content a2 orange dog']);
  48         $this->asEditor();
  49
  50         $accentSearch = $this->get('/search?term=' . urlencode('áéíí'));
  51         $accentSearch->assertStatus(200)->assertSee($page->name);
  52
  53         $smallSearch = $this->get('/search?term=' . urlencode('a2'));
  54         $smallSearch->assertStatus(200)->assertSee($page->name);
  55     }
  56
  57     public function test_book_search()
  58     {
  59         $book = Book::first();
  60         $page = $book->pages->last();
  61         $chapter = $book->chapters->last();
  62
  63         $pageTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($page->name));
  64         $pageTestResp->assertSee($page->name);
  65
  66         $chapterTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($chapter->name));
  67         $chapterTestResp->assertSee($chapter->name);
  68     }
  69
  70     public function test_chapter_search()
  71     {
  72         $chapter = $this->entities->chapterHasPages();
  73         $page = $chapter->pages[0];
  74
  75         $pageTestResp = $this->asEditor()->get('/search/chapter/' . $chapter->id . '?term=' . urlencode($page->name));
  76         $pageTestResp->assertSee($page->name);
  77     }
  78
  79     public function test_tag_search()
  80     {
  81         $newTags = [
  82             new Tag([
  83                 'name'  => 'animal',
  84                 'value' => 'cat',
  85             ]),
  86             new Tag([
  87                 'name'  => 'color',
  88                 'value' => 'red',
  89             ]),
  90         ];
  91
  92         $pageA = $this->entities->page();
  93         $pageA->tags()->saveMany($newTags);
  94
  95         $pageB = $this->entities->page();
  96         $pageB->tags()->create(['name' => 'animal', 'value' => 'dog']);
  97
  98         $this->asEditor();
  99         $tNameSearch = $this->get('/search?term=%5Banimal%5D');
 100         $tNameSearch->assertSee($pageA->name)->assertSee($pageB->name);
 101
 102         $tNameSearch2 = $this->get('/search?term=%5Bcolor%5D');
 103         $tNameSearch2->assertSee($pageA->name)->assertDontSee($pageB->name);
 104
 105         $tNameValSearch = $this->get('/search?term=%5Banimal%3Dcat%5D');
 106         $tNameValSearch->assertSee($pageA->name)->assertDontSee($pageB->name);
 107     }
 108
 109     public function test_exact_searches()
 110     {
 111         $page = $this->entities->newPage(['name' => 'My new test page', 'html' => 'this is a story about an orange donkey']);
 112
 113         $exactSearchA = $this->asEditor()->get('/search?term=' . urlencode('"story about an orange"'));
 114         $exactSearchA->assertStatus(200)->assertSee($page->name);
 115
 116         $exactSearchB = $this->asEditor()->get('/search?term=' . urlencode('"story not about an orange"'));
 117         $exactSearchB->assertStatus(200)->assertDontSee($page->name);
 118     }
 119
 120     public function test_search_terms_with_delimiters_are_converted_to_exact_matches()
 121     {
 122         $this->asEditor();
 123         $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>']);
 124         $terms = explode(' ', '1.1 2,2 3?3 4:4 5;5 (8) <9> "10" \'11\' `12`');
 125
 126         foreach ($terms as $term) {
 127             $search = $this->get('/search?term=' . urlencode($term));
 128             $search->assertSee($page->name);
 129         }
 130     }
 131
 132     public function test_search_filters()
 133     {
 134         $page = $this->entities->newPage(['name' => 'My new test quaffleachits', 'html' => 'this is about an orange donkey danzorbhsing']);
 135         $this->asEditor();
 136         $editorId = $this->getEditor()->id;
 137         $editorSlug = $this->getEditor()->slug;
 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:' . $editorSlug . '}'))->assertDontSee($page->name);
 151         $page->created_by = $editorId;
 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: ' . $editorSlug . '}'))->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 = $editorId;
 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:' . $editorSlug . '}'))->assertSee($page->name);
 161         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
 162         $page->owned_by = $editorId;
 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:' . $editorSlug . '}'))->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->entities->setPermissions($page, [], []);
 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_ajax_entity_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('/ajax/search/entities?term=' . urlencode($page->name));
 203         $normalSearch->assertSee($page->name);
 204
 205         $bookSearch = $this->get('/ajax/search/entities?types=book&term=' . urlencode($page->name));
 206         $bookSearch->assertDontSee($page->name);
 207
 208         $defaultListTest = $this->get('/ajax/search/entities');
 209         $defaultListTest->assertSee($page->name);
 210         $defaultListTest->assertDontSee($notVisitedPage->name);
 211     }
 212
 213     public function test_ajax_entity_search_shows_breadcrumbs()
 214     {
 215         $chapter = $this->entities->chapter();
 216         $page = $chapter->pages->first();
 217         $this->asEditor();
 218
 219         $pageSearch = $this->get('/ajax/search/entities?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('/ajax/search/entities?term=' . urlencode($chapter->name));
 225         $chapterSearch->assertSee($chapter->name);
 226         $chapterSearch->assertSee($chapter->book->getShortName(42));
 227     }
 228
 229     public function test_ajax_entity_search_reflects_items_without_permission()
 230     {
 231         $page = $this->entities->page();
 232         $baseSelector = 'a[data-entity-type="page"][data-entity-id="' . $page->id . '"]';
 233         $searchUrl = '/ajax/search/entities?permission=update&term=' . urlencode($page->name);
 234
 235         $resp = $this->asEditor()->get($searchUrl);
 236         $this->withHtml($resp)->assertElementContains($baseSelector, $page->name);
 237         $this->withHtml($resp)->assertElementNotContains($baseSelector, "You don't have the required permissions to select this item");
 238
 239         $resp = $this->actingAs($this->getViewer())->get($searchUrl);
 240         $this->withHtml($resp)->assertElementContains($baseSelector, $page->name);
 241         $this->withHtml($resp)->assertElementContains($baseSelector, "You don't have the required permissions to select this item");
 242     }
 243
 244     public function test_sibling_search_for_pages()
 245     {
 246         $chapter = $this->entities->chapterHasPages();
 247         $this->assertGreaterThan(2, count($chapter->pages), 'Ensure we\'re testing with at least 1 sibling');
 248         $page = $chapter->pages->first();
 249
 250         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
 251         $search->assertSuccessful();
 252         foreach ($chapter->pages as $page) {
 253             $search->assertSee($page->name);
 254         }
 255
 256         $search->assertDontSee($chapter->name);
 257     }
 258
 259     public function test_sibling_search_for_pages_without_chapter()
 260     {
 261         $page = $this->entities->pageNotWithinChapter();
 262         $bookChildren = $page->book->getDirectChildren();
 263         $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
 264
 265         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
 266         $search->assertSuccessful();
 267         foreach ($bookChildren as $child) {
 268             $search->assertSee($child->name);
 269         }
 270
 271         $search->assertDontSee($page->book->name);
 272     }
 273
 274     public function test_sibling_search_for_chapters()
 275     {
 276         $chapter = $this->entities->chapter();
 277         $bookChildren = $chapter->book->getDirectChildren();
 278         $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
 279
 280         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$chapter->id}&entity_type=chapter");
 281         $search->assertSuccessful();
 282         foreach ($bookChildren as $child) {
 283             $search->assertSee($child->name);
 284         }
 285
 286         $search->assertDontSee($chapter->book->name);
 287     }
 288
 289     public function test_sibling_search_for_books()
 290     {
 291         $books = Book::query()->take(10)->get();
 292         $book = $books->first();
 293         $this->assertGreaterThan(2, count($books), 'Ensure we\'re testing with at least 1 sibling');
 294
 295         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$book->id}&entity_type=book");
 296         $search->assertSuccessful();
 297         foreach ($books as $expectedBook) {
 298             $search->assertSee($expectedBook->name);
 299         }
 300     }
 301
 302     public function test_sibling_search_for_shelves()
 303     {
 304         $shelves = Bookshelf::query()->take(10)->get();
 305         $shelf = $shelves->first();
 306         $this->assertGreaterThan(2, count($shelves), 'Ensure we\'re testing with at least 1 sibling');
 307
 308         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$shelf->id}&entity_type=bookshelf");
 309         $search->assertSuccessful();
 310         foreach ($shelves as $expectedShelf) {
 311             $search->assertSee($expectedShelf->name);
 312         }
 313     }
 314
 315     public function test_search_works_on_updated_page_content()
 316     {
 317         $page = $this->entities->page();
 318         $this->asEditor();
 319
 320         $update = $this->put($page->getUrl(), [
 321             'name' => $page->name,
 322             'html' => '<p>dog pandabearmonster spaghetti</p>',
 323         ]);
 324
 325         $search = $this->asEditor()->get('/search?term=pandabearmonster');
 326         $search->assertStatus(200);
 327         $search->assertSeeText($page->name);
 328         $search->assertSee($page->getUrl());
 329     }
 330
 331     public function test_search_ranks_common_words_lower()
 332     {
 333         $this->entities->newPage(['name' => 'Test page A', 'html' => '<p>dog biscuit dog dog</p>']);
 334         $this->entities->newPage(['name' => 'Test page B', 'html' => '<p>cat biscuit</p>']);
 335
 336         $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
 337         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(1)', 'Test page A');
 338         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(2)', 'Test page B');
 339
 340         for ($i = 0; $i < 2; $i++) {
 341             $this->entities->newPage(['name' => 'Test page ' . $i, 'html' => '<p>dog</p>']);
 342         }
 343
 344         $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
 345         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(1)', 'Test page B');
 346         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(2)', 'Test page A');
 347     }
 348
 349     public function test_terms_in_headers_have_an_adjusted_index_score()
 350     {
 351         $page = $this->entities->newPage(['name' => 'Test page A', 'html' => '
 352             <p>TermA</p>
 353             <h1>TermB <strong>TermNested</strong></h1>
 354             <h2>TermC</h2>
 355             <h3>TermD</h3>
 356             <h4>TermE</h4>
 357             <h5>TermF</h5>
 358             <h6>TermG</h6>
 359         ']);
 360
 361         $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
 362
 363         $this->assertEquals(1, $scoreByTerm->get('TermA'));
 364         $this->assertEquals(10, $scoreByTerm->get('TermB'));
 365         $this->assertEquals(10, $scoreByTerm->get('TermNested'));
 366         $this->assertEquals(5, $scoreByTerm->get('TermC'));
 367         $this->assertEquals(4, $scoreByTerm->get('TermD'));
 368         $this->assertEquals(3, $scoreByTerm->get('TermE'));
 369         $this->assertEquals(2, $scoreByTerm->get('TermF'));
 370         // Is 1.5 but stored as integer, rounding up
 371         $this->assertEquals(2, $scoreByTerm->get('TermG'));
 372     }
 373
 374     public function test_name_and_content_terms_are_merged_to_single_score()
 375     {
 376         $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
 377             <p>TermA</p>
 378         ']);
 379
 380         $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
 381
 382         // Scores 40 for being in the name then 1 for being in the content
 383         $this->assertEquals(41, $scoreByTerm->get('TermA'));
 384     }
 385
 386     public function test_tag_names_and_values_are_indexed_for_search()
 387     {
 388         $page = $this->entities->newPage(['name' => 'PageA', 'html' => '<p>content</p>', 'tags' => [
 389             ['name' => 'Animal', 'value' => 'MeowieCat'],
 390             ['name' => 'SuperImportant'],
 391         ]]);
 392
 393         $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
 394         $this->assertEquals(5, $scoreByTerm->get('MeowieCat'));
 395         $this->assertEquals(3, $scoreByTerm->get('Animal'));
 396         $this->assertEquals(3, $scoreByTerm->get('SuperImportant'));
 397     }
 398
 399     public function test_matching_terms_in_search_results_are_highlighted()
 400     {
 401         $this->entities->newPage(['name' => 'My Meowie Cat', 'html' => '<p>A superimportant page about meowieable animals</p>', 'tags' => [
 402             ['name' => 'Animal', 'value' => 'MeowieCat'],
 403             ['name' => 'SuperImportant'],
 404         ]]);
 405
 406         $search = $this->asEditor()->get('/search?term=SuperImportant+Meowie');
 407         // Title
 408         $search->assertSee('My <strong>Meowie</strong> Cat', false);
 409         // Content
 410         $search->assertSee('A <strong>superimportant</strong> page about <strong>meowie</strong>able animals', false);
 411         // Tag name
 412         $this->withHtml($search)->assertElementContains('.tag-name.highlight', 'SuperImportant');
 413         // Tag value
 414         $this->withHtml($search)->assertElementContains('.tag-value.highlight', 'MeowieCat');
 415     }
 416
 417     public function test_match_highlighting_works_with_multibyte_content()
 418     {
 419         $this->entities->newPage([
 420             'name' => 'Test Page',
 421             'html' => '<p>На мен ми трябва нещо добро test</p>',
 422         ]);
 423
 424         $search = $this->asEditor()->get('/search?term=' . urlencode('На мен ми трябва нещо добро'));
 425         $search->assertSee('<strong>На</strong> <strong>мен</strong> <strong>ми</strong> <strong>трябва</strong> <strong>нещо</strong> <strong>добро</strong> test', false);
 426     }
 427
 428     public function test_html_entities_in_item_details_remains_escaped_in_search_results()
 429     {
 430         $this->entities->newPage(['name' => 'My <cool> TestPageContent', 'html' => '<p>My supercool &lt;great&gt; TestPageContent page</p>']);
 431
 432         $search = $this->asEditor()->get('/search?term=TestPageContent');
 433         $search->assertSee('My &lt;cool&gt; <strong>TestPageContent</strong>', false);
 434         $search->assertSee('My supercool &lt;great&gt; <strong>TestPageContent</strong> page', false);
 435     }
 436
 437     public function test_words_adjacent_to_lines_breaks_can_be_matched_with_normal_terms()
 438     {
 439         $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
 440             <p>TermA<br>TermB<br>TermC</p>
 441         ']);
 442
 443         $search = $this->asEditor()->get('/search?term=' . urlencode('TermB TermC'));
 444
 445         $search->assertSee($page->getUrl(), false);
 446     }
 447
 448     public function test_searches_with_user_filters_adds_them_into_advanced_search_form()
 449     {
 450         $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:me} {created_by:dan}'));
 451         $this->withHtml($resp)->assertElementExists('form input[type="hidden"][name="filters[updated_by]"][value="me"]');
 452         $this->withHtml($resp)->assertElementExists('form input[type="hidden"][name="filters[created_by]"][value="dan"]');
 453     }
 454 }