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         $editor = $this->getEditor();
 136         $this->actingAs($editor);
 137
 138         // Viewed filter searches
 139         $this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertSee($page->name);
 140         $this->get('/search?term=' . urlencode('danzorbhsing {viewed_by_me}'))->assertDontSee($page->name);
 141         $this->get($page->getUrl());
 142         $this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertDontSee($page->name);
 143         $this->get('/search?term=' . urlencode('danzorbhsing {viewed_by_me}'))->assertSee($page->name);
 144
 145         // User filters
 146         $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertDontSee($page->name);
 147         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
 148         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
 149         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editor->slug . '}'))->assertDontSee($page->name);
 150         $page->created_by = $editor->id;
 151         $page->save();
 152         $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertSee($page->name);
 153         $this->get('/search?term=' . urlencode('danzorbhsing {created_by: ' . $editor->slug . '}'))->assertSee($page->name);
 154         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
 155         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
 156         $page->updated_by = $editor->id;
 157         $page->save();
 158         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertSee($page->name);
 159         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editor->slug . '}'))->assertSee($page->name);
 160         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
 161         $page->owned_by = $editor->id;
 162         $page->save();
 163         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertSee($page->name);
 164         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:' . $editor->slug . '}'))->assertSee($page->name);
 165
 166         // Content filters
 167         $this->get('/search?term=' . urlencode('{in_name:danzorbhsing}'))->assertDontSee($page->name);
 168         $this->get('/search?term=' . urlencode('{in_body:danzorbhsing}'))->assertSee($page->name);
 169         $this->get('/search?term=' . urlencode('{in_name:test quaffleachits}'))->assertSee($page->name);
 170         $this->get('/search?term=' . urlencode('{in_body:test quaffleachits}'))->assertDontSee($page->name);
 171
 172         // Restricted filter
 173         $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertDontSee($page->name);
 174         $this->entities->setPermissions($page, ['view'], [$editor->roles->first()]);
 175         $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertSee($page->name);
 176
 177         // Date filters
 178         $this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertDontSee($page->name);
 179         $this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertSee($page->name);
 180         $page->updated_at = '2037-02-01';
 181         $page->save();
 182         $this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertSee($page->name);
 183         $this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertDontSee($page->name);
 184
 185         $this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertDontSee($page->name);
 186         $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertSee($page->name);
 187         $page->created_at = '2037-02-01';
 188         $page->save();
 189         $this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertSee($page->name);
 190         $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertDontSee($page->name);
 191     }
 192
 193     public function test_ajax_entity_search()
 194     {
 195         $page = $this->entities->newPage(['name' => 'my ajax search test', 'html' => 'ajax test']);
 196         $notVisitedPage = $this->entities->page();
 197
 198         // Visit the page to make popular
 199         $this->asEditor()->get($page->getUrl());
 200
 201         $normalSearch = $this->get('/ajax/search/entities?term=' . urlencode($page->name));
 202         $normalSearch->assertSee($page->name);
 203
 204         $bookSearch = $this->get('/ajax/search/entities?types=book&term=' . urlencode($page->name));
 205         $bookSearch->assertDontSee($page->name);
 206
 207         $defaultListTest = $this->get('/ajax/search/entities');
 208         $defaultListTest->assertSee($page->name);
 209         $defaultListTest->assertDontSee($notVisitedPage->name);
 210     }
 211
 212     public function test_ajax_entity_search_shows_breadcrumbs()
 213     {
 214         $chapter = $this->entities->chapter();
 215         $page = $chapter->pages->first();
 216         $this->asEditor();
 217
 218         $pageSearch = $this->get('/ajax/search/entities?term=' . urlencode($page->name));
 219         $pageSearch->assertSee($page->name);
 220         $pageSearch->assertSee($chapter->getShortName(42));
 221         $pageSearch->assertSee($page->book->getShortName(42));
 222
 223         $chapterSearch = $this->get('/ajax/search/entities?term=' . urlencode($chapter->name));
 224         $chapterSearch->assertSee($chapter->name);
 225         $chapterSearch->assertSee($chapter->book->getShortName(42));
 226     }
 227
 228     public function test_ajax_entity_search_reflects_items_without_permission()
 229     {
 230         $page = $this->entities->page();
 231         $baseSelector = 'a[data-entity-type="page"][data-entity-id="' . $page->id . '"]';
 232         $searchUrl = '/ajax/search/entities?permission=update&term=' . urlencode($page->name);
 233
 234         $resp = $this->asEditor()->get($searchUrl);
 235         $this->withHtml($resp)->assertElementContains($baseSelector, $page->name);
 236         $this->withHtml($resp)->assertElementNotContains($baseSelector, "You don't have the required permissions to select this item");
 237
 238         $resp = $this->actingAs($this->getViewer())->get($searchUrl);
 239         $this->withHtml($resp)->assertElementContains($baseSelector, $page->name);
 240         $this->withHtml($resp)->assertElementContains($baseSelector, "You don't have the required permissions to select this item");
 241     }
 242
 243     public function test_sibling_search_for_pages()
 244     {
 245         $chapter = $this->entities->chapterHasPages();
 246         $this->assertGreaterThan(2, count($chapter->pages), 'Ensure we\'re testing with at least 1 sibling');
 247         $page = $chapter->pages->first();
 248
 249         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
 250         $search->assertSuccessful();
 251         foreach ($chapter->pages as $page) {
 252             $search->assertSee($page->name);
 253         }
 254
 255         $search->assertDontSee($chapter->name);
 256     }
 257
 258     public function test_sibling_search_for_pages_without_chapter()
 259     {
 260         $page = $this->entities->pageNotWithinChapter();
 261         $bookChildren = $page->book->getDirectChildren();
 262         $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
 263
 264         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
 265         $search->assertSuccessful();
 266         foreach ($bookChildren as $child) {
 267             $search->assertSee($child->name);
 268         }
 269
 270         $search->assertDontSee($page->book->name);
 271     }
 272
 273     public function test_sibling_search_for_chapters()
 274     {
 275         $chapter = $this->entities->chapter();
 276         $bookChildren = $chapter->book->getDirectChildren();
 277         $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
 278
 279         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$chapter->id}&entity_type=chapter");
 280         $search->assertSuccessful();
 281         foreach ($bookChildren as $child) {
 282             $search->assertSee($child->name);
 283         }
 284
 285         $search->assertDontSee($chapter->book->name);
 286     }
 287
 288     public function test_sibling_search_for_books()
 289     {
 290         $books = Book::query()->take(10)->get();
 291         $book = $books->first();
 292         $this->assertGreaterThan(2, count($books), 'Ensure we\'re testing with at least 1 sibling');
 293
 294         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$book->id}&entity_type=book");
 295         $search->assertSuccessful();
 296         foreach ($books as $expectedBook) {
 297             $search->assertSee($expectedBook->name);
 298         }
 299     }
 300
 301     public function test_sibling_search_for_shelves()
 302     {
 303         $shelves = Bookshelf::query()->take(10)->get();
 304         $shelf = $shelves->first();
 305         $this->assertGreaterThan(2, count($shelves), 'Ensure we\'re testing with at least 1 sibling');
 306
 307         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$shelf->id}&entity_type=bookshelf");
 308         $search->assertSuccessful();
 309         foreach ($shelves as $expectedShelf) {
 310             $search->assertSee($expectedShelf->name);
 311         }
 312     }
 313
 314     public function test_search_works_on_updated_page_content()
 315     {
 316         $page = $this->entities->page();
 317         $this->asEditor();
 318
 319         $update = $this->put($page->getUrl(), [
 320             'name' => $page->name,
 321             'html' => '<p>dog pandabearmonster spaghetti</p>',
 322         ]);
 323
 324         $search = $this->asEditor()->get('/search?term=pandabearmonster');
 325         $search->assertStatus(200);
 326         $search->assertSeeText($page->name);
 327         $search->assertSee($page->getUrl());
 328     }
 329
 330     public function test_search_ranks_common_words_lower()
 331     {
 332         $this->entities->newPage(['name' => 'Test page A', 'html' => '<p>dog biscuit dog dog</p>']);
 333         $this->entities->newPage(['name' => 'Test page B', 'html' => '<p>cat biscuit</p>']);
 334
 335         $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
 336         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(1)', 'Test page A');
 337         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(2)', 'Test page B');
 338
 339         for ($i = 0; $i < 2; $i++) {
 340             $this->entities->newPage(['name' => 'Test page ' . $i, 'html' => '<p>dog</p>']);
 341         }
 342
 343         $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
 344         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(1)', 'Test page B');
 345         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(2)', 'Test page A');
 346     }
 347
 348     public function test_terms_in_headers_have_an_adjusted_index_score()
 349     {
 350         $page = $this->entities->newPage(['name' => 'Test page A', 'html' => '
 351             <p>TermA</p>
 352             <h1>TermB <strong>TermNested</strong></h1>
 353             <h2>TermC</h2>
 354             <h3>TermD</h3>
 355             <h4>TermE</h4>
 356             <h5>TermF</h5>
 357             <h6>TermG</h6>
 358         ']);
 359
 360         $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
 361
 362         $this->assertEquals(1, $scoreByTerm->get('TermA'));
 363         $this->assertEquals(10, $scoreByTerm->get('TermB'));
 364         $this->assertEquals(10, $scoreByTerm->get('TermNested'));
 365         $this->assertEquals(5, $scoreByTerm->get('TermC'));
 366         $this->assertEquals(4, $scoreByTerm->get('TermD'));
 367         $this->assertEquals(3, $scoreByTerm->get('TermE'));
 368         $this->assertEquals(2, $scoreByTerm->get('TermF'));
 369         // Is 1.5 but stored as integer, rounding up
 370         $this->assertEquals(2, $scoreByTerm->get('TermG'));
 371     }
 372
 373     public function test_name_and_content_terms_are_merged_to_single_score()
 374     {
 375         $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
 376             <p>TermA</p>
 377         ']);
 378
 379         $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
 380
 381         // Scores 40 for being in the name then 1 for being in the content
 382         $this->assertEquals(41, $scoreByTerm->get('TermA'));
 383     }
 384
 385     public function test_tag_names_and_values_are_indexed_for_search()
 386     {
 387         $page = $this->entities->newPage(['name' => 'PageA', 'html' => '<p>content</p>', 'tags' => [
 388             ['name' => 'Animal', 'value' => 'MeowieCat'],
 389             ['name' => 'SuperImportant'],
 390         ]]);
 391
 392         $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
 393         $this->assertEquals(5, $scoreByTerm->get('MeowieCat'));
 394         $this->assertEquals(3, $scoreByTerm->get('Animal'));
 395         $this->assertEquals(3, $scoreByTerm->get('SuperImportant'));
 396     }
 397
 398     public function test_matching_terms_in_search_results_are_highlighted()
 399     {
 400         $this->entities->newPage(['name' => 'My Meowie Cat', 'html' => '<p>A superimportant page about meowieable animals</p>', 'tags' => [
 401             ['name' => 'Animal', 'value' => 'MeowieCat'],
 402             ['name' => 'SuperImportant'],
 403         ]]);
 404
 405         $search = $this->asEditor()->get('/search?term=SuperImportant+Meowie');
 406         // Title
 407         $search->assertSee('My <strong>Meowie</strong> Cat', false);
 408         // Content
 409         $search->assertSee('A <strong>superimportant</strong> page about <strong>meowie</strong>able animals', false);
 410         // Tag name
 411         $this->withHtml($search)->assertElementContains('.tag-name.highlight', 'SuperImportant');
 412         // Tag value
 413         $this->withHtml($search)->assertElementContains('.tag-value.highlight', 'MeowieCat');
 414     }
 415
 416     public function test_match_highlighting_works_with_multibyte_content()
 417     {
 418         $this->entities->newPage([
 419             'name' => 'Test Page',
 420             'html' => '<p>На мен ми трябва нещо добро test</p>',
 421         ]);
 422
 423         $search = $this->asEditor()->get('/search?term=' . urlencode('На мен ми трябва нещо добро'));
 424         $search->assertSee('<strong>На</strong> <strong>мен</strong> <strong>ми</strong> <strong>трябва</strong> <strong>нещо</strong> <strong>добро</strong> test', false);
 425     }
 426
 427     public function test_html_entities_in_item_details_remains_escaped_in_search_results()
 428     {
 429         $this->entities->newPage(['name' => 'My <cool> TestPageContent', 'html' => '<p>My supercool &lt;great&gt; TestPageContent page</p>']);
 430
 431         $search = $this->asEditor()->get('/search?term=TestPageContent');
 432         $search->assertSee('My &lt;cool&gt; <strong>TestPageContent</strong>', false);
 433         $search->assertSee('My supercool &lt;great&gt; <strong>TestPageContent</strong> page', false);
 434     }
 435
 436     public function test_words_adjacent_to_lines_breaks_can_be_matched_with_normal_terms()
 437     {
 438         $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
 439             <p>TermA<br>TermB<br>TermC</p>
 440         ']);
 441
 442         $search = $this->asEditor()->get('/search?term=' . urlencode('TermB TermC'));
 443
 444         $search->assertSee($page->getUrl(), false);
 445     }
 446
 447     public function test_searches_with_user_filters_adds_them_into_advanced_search_form()
 448     {
 449         $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:dan} {created_by:dan}'));
 450         $this->withHtml($resp)->assertElementExists('form input[name="filters[updated_by]"][value="dan"]');
 451         $this->withHtml($resp)->assertElementExists('form input[name="filters[created_by]"][value="dan"]');
 452     }
 453
 454     public function test_searches_with_user_filters_using_me_adds_them_into_advanced_search_form()
 455     {
 456         $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:me} {created_by:me}'));
 457         $this->withHtml($resp)->assertElementExists('form input[name="filters[updated_by]"][value="me"][checked="checked"]');
 458         $this->withHtml($resp)->assertElementExists('form input[name="filters[created_by]"][value="me"][checked="checked"]');
 459     }
 460 }