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