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

   1 <?php
   2
   3 namespace Tests\Search;
   4
   5 use BookStack\Activity\Models\Tag;
   6 use BookStack\Entities\Models\Book;
   7 use Tests\TestCase;
   8
   9 class EntitySearchTest extends TestCase
  10 {
  11     public function test_page_search()
  12     {
  13         $book = $this->entities->book();
  14         $page = $book->pages->first();
  15
  16         $search = $this->asEditor()->get('/search?term=' . urlencode($page->name));
  17         $search->assertSee('Search Results');
  18         $search->assertSeeText($page->name, true);
  19     }
  20
  21     public function test_bookshelf_search()
  22     {
  23         $shelf = $this->entities->shelf();
  24
  25         $search = $this->asEditor()->get('/search?term=' . urlencode($shelf->name) . '  {type:bookshelf}');
  26         $search->assertSee('Search Results');
  27         $search->assertSeeText($shelf->name, true);
  28     }
  29
  30     public function test_search_shows_pagination()
  31     {
  32         $search = $this->asEditor()->get('/search?term=a');
  33         $this->withHtml($search)->assertLinkExists('/search?term=a&page=2', '2');
  34     }
  35
  36     public function test_invalid_page_search()
  37     {
  38         $resp = $this->asEditor()->get('/search?term=' . urlencode('<p>test</p>'));
  39         $resp->assertSee('Search Results');
  40         $resp->assertStatus(200);
  41         $this->get('/search?term=cat+-')->assertStatus(200);
  42     }
  43
  44     public function test_empty_search_shows_search_page()
  45     {
  46         $res = $this->asEditor()->get('/search');
  47         $res->assertStatus(200);
  48     }
  49
  50     public function test_searching_accents_and_small_terms()
  51     {
  52         $page = $this->entities->newPage(['name' => 'My new test quaffleachits', 'html' => 'some áéííúü¿¡ test content a2 orange dog']);
  53         $this->asEditor();
  54
  55         $accentSearch = $this->get('/search?term=' . urlencode('áéíí'));
  56         $accentSearch->assertStatus(200)->assertSee($page->name);
  57
  58         $smallSearch = $this->get('/search?term=' . urlencode('a2'));
  59         $smallSearch->assertStatus(200)->assertSee($page->name);
  60     }
  61
  62     public function test_book_search()
  63     {
  64         $book = Book::first();
  65         $page = $book->pages->last();
  66         $chapter = $book->chapters->last();
  67
  68         $pageTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($page->name));
  69         $pageTestResp->assertSee($page->name);
  70
  71         $chapterTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($chapter->name));
  72         $chapterTestResp->assertSee($chapter->name);
  73     }
  74
  75     public function test_chapter_search()
  76     {
  77         $chapter = $this->entities->chapterHasPages();
  78         $page = $chapter->pages[0];
  79
  80         $pageTestResp = $this->asEditor()->get('/search/chapter/' . $chapter->id . '?term=' . urlencode($page->name));
  81         $pageTestResp->assertSee($page->name);
  82     }
  83
  84     public function test_tag_search()
  85     {
  86         $newTags = [
  87             new Tag([
  88                 'name'  => 'animal',
  89                 'value' => 'cat',
  90             ]),
  91             new Tag([
  92                 'name'  => 'color',
  93                 'value' => 'red',
  94             ]),
  95         ];
  96
  97         $pageA = $this->entities->page();
  98         $pageA->tags()->saveMany($newTags);
  99
 100         $pageB = $this->entities->page();
 101         $pageB->tags()->create(['name' => 'animal', 'value' => 'dog']);
 102
 103         $this->asEditor();
 104         $tNameSearch = $this->get('/search?term=%5Banimal%5D');
 105         $tNameSearch->assertSee($pageA->name)->assertSee($pageB->name);
 106
 107         $tNameSearch2 = $this->get('/search?term=%5Bcolor%5D');
 108         $tNameSearch2->assertSee($pageA->name)->assertDontSee($pageB->name);
 109
 110         $tNameValSearch = $this->get('/search?term=%5Banimal%3Dcat%5D');
 111         $tNameValSearch->assertSee($pageA->name)->assertDontSee($pageB->name);
 112     }
 113
 114     public function test_exact_searches()
 115     {
 116         $page = $this->entities->newPage(['name' => 'My new test page', 'html' => 'this is a story about an orange donkey']);
 117
 118         $exactSearchA = $this->asEditor()->get('/search?term=' . urlencode('"story about an orange"'));
 119         $exactSearchA->assertStatus(200)->assertSee($page->name);
 120
 121         $exactSearchB = $this->asEditor()->get('/search?term=' . urlencode('"story not about an orange"'));
 122         $exactSearchB->assertStatus(200)->assertDontSee($page->name);
 123     }
 124
 125     public function test_negated_searches()
 126     {
 127         $page = $this->entities->newPage(['name' => 'My new test negation page', 'html' => '<p>An angry tortoise wore trumpeted plimsoles</p>']);
 128         $page->tags()->saveMany([new Tag(['name' => 'DonkCount', 'value' => '500'])]);
 129         $page->created_by = $this->users->admin()->id;
 130         $page->save();
 131
 132         $editor = $this->users->editor();
 133         $this->actingAs($editor);
 134
 135         $exactSearch = $this->get('/search?term=' . urlencode('negation -"tortoise"'));
 136         $exactSearch->assertStatus(200)->assertDontSeeText($page->name);
 137
 138         $tagSearchA = $this->get('/search?term=' . urlencode('negation [DonkCount=500]'));
 139         $tagSearchA->assertStatus(200)->assertSeeText($page->name);
 140         $tagSearchB = $this->get('/search?term=' . urlencode('negation -[DonkCount=500]'));
 141         $tagSearchB->assertStatus(200)->assertDontSeeText($page->name);
 142
 143         $filterSearchA = $this->get('/search?term=' . urlencode('negation -{created_by:me}'));
 144         $filterSearchA->assertStatus(200)->assertSeeText($page->name);
 145         $page->created_by = $editor->id;
 146         $page->save();
 147         $filterSearchB = $this->get('/search?term=' . urlencode('negation -{created_by:me}'));
 148         $filterSearchB->assertStatus(200)->assertDontSeeText($page->name);
 149     }
 150
 151     public function test_search_terms_with_delimiters_are_converted_to_exact_matches()
 152     {
 153         $this->asEditor();
 154         $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>']);
 155         $terms = explode(' ', '1.1 2,2 3?3 4:4 5;5 (8) <9> "10" \'11\' `12`');
 156
 157         foreach ($terms as $term) {
 158             $search = $this->get('/search?term=' . urlencode($term));
 159             $search->assertSee($page->name);
 160         }
 161     }
 162
 163     public function test_search_filters()
 164     {
 165         $page = $this->entities->newPage(['name' => 'My new test quaffleachits', 'html' => 'this is about an orange donkey danzorbhsing']);
 166         $editor = $this->users->editor();
 167         $this->actingAs($editor);
 168
 169         // Viewed filter searches
 170         $this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertSee($page->name);
 171         $this->get('/search?term=' . urlencode('danzorbhsing {viewed_by_me}'))->assertDontSee($page->name);
 172         $this->get($page->getUrl());
 173         $this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertDontSee($page->name);
 174         $this->get('/search?term=' . urlencode('danzorbhsing {viewed_by_me}'))->assertSee($page->name);
 175
 176         // User filters
 177         $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertDontSee($page->name);
 178         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
 179         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
 180         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editor->slug . '}'))->assertDontSee($page->name);
 181         $page->created_by = $editor->id;
 182         $page->save();
 183         $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertSee($page->name);
 184         $this->get('/search?term=' . urlencode('danzorbhsing {created_by: ' . $editor->slug . '}'))->assertSee($page->name);
 185         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
 186         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
 187         $page->updated_by = $editor->id;
 188         $page->save();
 189         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertSee($page->name);
 190         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editor->slug . '}'))->assertSee($page->name);
 191         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
 192         $page->owned_by = $editor->id;
 193         $page->save();
 194         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertSee($page->name);
 195         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:' . $editor->slug . '}'))->assertSee($page->name);
 196
 197         // Content filters
 198         $this->get('/search?term=' . urlencode('{in_name:danzorbhsing}'))->assertDontSee($page->name);
 199         $this->get('/search?term=' . urlencode('{in_body:danzorbhsing}'))->assertSee($page->name);
 200         $this->get('/search?term=' . urlencode('{in_name:test quaffleachits}'))->assertSee($page->name);
 201         $this->get('/search?term=' . urlencode('{in_body:test quaffleachits}'))->assertDontSee($page->name);
 202
 203         // Restricted filter
 204         $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertDontSee($page->name);
 205         $this->permissions->setEntityPermissions($page, ['view'], [$editor->roles->first()]);
 206         $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertSee($page->name);
 207
 208         // Date filters
 209         $this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertDontSee($page->name);
 210         $this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertSee($page->name);
 211         $page->updated_at = '2037-02-01';
 212         $page->save();
 213         $this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertSee($page->name);
 214         $this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertDontSee($page->name);
 215
 216         $this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertDontSee($page->name);
 217         $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertSee($page->name);
 218         $page->created_at = '2037-02-01';
 219         $page->save();
 220         $this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertSee($page->name);
 221         $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertDontSee($page->name);
 222     }
 223
 224     public function test_entity_selector_search()
 225     {
 226         $page = $this->entities->newPage(['name' => 'my ajax search test', 'html' => 'ajax test']);
 227         $notVisitedPage = $this->entities->page();
 228
 229         // Visit the page to make popular
 230         $this->asEditor()->get($page->getUrl());
 231
 232         $normalSearch = $this->get('/search/entity-selector?term=' . urlencode($page->name));
 233         $normalSearch->assertSee($page->name);
 234
 235         $bookSearch = $this->get('/search/entity-selector?types=book&term=' . urlencode($page->name));
 236         $bookSearch->assertDontSee($page->name);
 237
 238         $defaultListTest = $this->get('/search/entity-selector');
 239         $defaultListTest->assertSee($page->name);
 240         $defaultListTest->assertDontSee($notVisitedPage->name);
 241     }
 242
 243     public function test_entity_selector_search_shows_breadcrumbs()
 244     {
 245         $chapter = $this->entities->chapter();
 246         $page = $chapter->pages->first();
 247         $this->asEditor();
 248
 249         $pageSearch = $this->get('/search/entity-selector?term=' . urlencode($page->name));
 250         $pageSearch->assertSee($page->name);
 251         $pageSearch->assertSee($chapter->getShortName(42));
 252         $pageSearch->assertSee($page->book->getShortName(42));
 253
 254         $chapterSearch = $this->get('/search/entity-selector?term=' . urlencode($chapter->name));
 255         $chapterSearch->assertSee($chapter->name);
 256         $chapterSearch->assertSee($chapter->book->getShortName(42));
 257     }
 258
 259     public function test_entity_selector_shows_breadcrumbs_on_default_view()
 260     {
 261         $page = $this->entities->pageWithinChapter();
 262         $this->asEditor()->get($page->chapter->getUrl());
 263
 264         $resp = $this->asEditor()->get('/search/entity-selector?types=book,chapter&permission=page-create');
 265         $html = $this->withHtml($resp);
 266         $html->assertElementContains('.chapter.entity-list-item', $page->chapter->name);
 267         $html->assertElementContains('.chapter.entity-list-item .entity-item-snippet', $page->book->getShortName(42));
 268     }
 269
 270     public function test_entity_selector_search_reflects_items_without_permission()
 271     {
 272         $page = $this->entities->page();
 273         $baseSelector = 'a[data-entity-type="page"][data-entity-id="' . $page->id . '"]';
 274         $searchUrl = '/search/entity-selector?permission=update&term=' . urlencode($page->name);
 275
 276         $resp = $this->asEditor()->get($searchUrl);
 277         $this->withHtml($resp)->assertElementContains($baseSelector, $page->name);
 278         $this->withHtml($resp)->assertElementNotContains($baseSelector, "You don't have the required permissions to select this item");
 279
 280         $resp = $this->actingAs($this->users->viewer())->get($searchUrl);
 281         $this->withHtml($resp)->assertElementContains($baseSelector, $page->name);
 282         $this->withHtml($resp)->assertElementContains($baseSelector, "You don't have the required permissions to select this item");
 283     }
 284
 285     public function test_entity_template_selector_search()
 286     {
 287         $templatePage = $this->entities->newPage(['name' => 'Template search test', 'html' => 'template test']);
 288         $templatePage->template = true;
 289         $templatePage->save();
 290
 291         $nonTemplatePage = $this->entities->newPage(['name' => 'Nontemplate page', 'html' => 'nontemplate', 'template' => false]);
 292
 293         // Visit both to make popular
 294         $this->asEditor()->get($templatePage->getUrl());
 295         $this->get($nonTemplatePage->getUrl());
 296
 297         $normalSearch = $this->get('/search/entity-selector-templates?term=test');
 298         $normalSearch->assertSee($templatePage->name);
 299         $normalSearch->assertDontSee($nonTemplatePage->name);
 300
 301         $normalSearch = $this->get('/search/entity-selector-templates?term=beans');
 302         $normalSearch->assertDontSee($templatePage->name);
 303         $normalSearch->assertDontSee($nonTemplatePage->name);
 304
 305         $defaultListTest = $this->get('/search/entity-selector-templates');
 306         $defaultListTest->assertSee($templatePage->name);
 307         $defaultListTest->assertDontSee($nonTemplatePage->name);
 308
 309         $this->permissions->disableEntityInheritedPermissions($templatePage);
 310
 311         $normalSearch = $this->get('/search/entity-selector-templates?term=test');
 312         $normalSearch->assertDontSee($templatePage->name);
 313
 314         $defaultListTest = $this->get('/search/entity-selector-templates');
 315         $defaultListTest->assertDontSee($templatePage->name);
 316     }
 317
 318     public function test_search_works_on_updated_page_content()
 319     {
 320         $page = $this->entities->page();
 321         $this->asEditor();
 322
 323         $update = $this->put($page->getUrl(), [
 324             'name' => $page->name,
 325             'html' => '<p>dog pandabearmonster spaghetti</p>',
 326         ]);
 327
 328         $search = $this->asEditor()->get('/search?term=pandabearmonster');
 329         $search->assertStatus(200);
 330         $search->assertSeeText($page->name);
 331         $search->assertSee($page->getUrl());
 332     }
 333
 334     public function test_search_ranks_common_words_lower()
 335     {
 336         $this->entities->newPage(['name' => 'Test page A', 'html' => '<p>dog biscuit dog dog</p>']);
 337         $this->entities->newPage(['name' => 'Test page B', 'html' => '<p>cat biscuit</p>']);
 338
 339         $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
 340         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(1)', 'Test page A');
 341         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(2)', 'Test page B');
 342
 343         for ($i = 0; $i < 2; $i++) {
 344             $this->entities->newPage(['name' => 'Test page ' . $i, 'html' => '<p>dog</p>']);
 345         }
 346
 347         $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
 348         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(1)', 'Test page B');
 349         $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(2)', 'Test page A');
 350     }
 351
 352     public function test_matching_terms_in_search_results_are_highlighted()
 353     {
 354         $this->entities->newPage(['name' => 'My Meowie Cat', 'html' => '<p>A superimportant page about meowieable animals</p>', 'tags' => [
 355             ['name' => 'Animal', 'value' => 'MeowieCat'],
 356             ['name' => 'SuperImportant'],
 357         ]]);
 358
 359         $search = $this->asEditor()->get('/search?term=SuperImportant+Meowie');
 360         // Title
 361         $search->assertSee('My <strong>Meowie</strong> Cat', false);
 362         // Content
 363         $search->assertSee('A <strong>superimportant</strong> page about <strong>meowie</strong>able animals', false);
 364         // Tag name
 365         $this->withHtml($search)->assertElementContains('.tag-name.highlight', 'SuperImportant');
 366         // Tag value
 367         $this->withHtml($search)->assertElementContains('.tag-value.highlight', 'MeowieCat');
 368     }
 369
 370     public function test_match_highlighting_works_with_multibyte_content()
 371     {
 372         $this->entities->newPage([
 373             'name' => 'Test Page',
 374             'html' => '<p>На мен ми трябва нещо добро test</p>',
 375         ]);
 376
 377         $search = $this->asEditor()->get('/search?term=' . urlencode('На мен ми трябва нещо добро'));
 378         $search->assertSee('<strong>На</strong> <strong>мен</strong> <strong>ми</strong> <strong>трябва</strong> <strong>нещо</strong> <strong>добро</strong> test', false);
 379     }
 380
 381     public function test_match_highlighting_is_efficient_with_large_frequency_in_content()
 382     {
 383         $content = str_repeat('superbeans ', 10000);
 384         $this->entities->newPage([
 385             'name' => 'Test Page',
 386             'html' => "<p>{$content}</p>",
 387         ]);
 388
 389         $time = microtime(true);
 390         $resp = $this->asEditor()->get('/search?term=' . urlencode('superbeans'));
 391         $this->assertLessThan(0.5, microtime(true) - $time);
 392
 393         $resp->assertSee('<strong>superbeans</strong>', false);
 394     }
 395
 396     public function test_html_entities_in_item_details_remains_escaped_in_search_results()
 397     {
 398         $this->entities->newPage(['name' => 'My <cool> TestPageContent', 'html' => '<p>My supercool &lt;great&gt; TestPageContent page</p>']);
 399
 400         $search = $this->asEditor()->get('/search?term=TestPageContent');
 401         $search->assertSee('My &lt;cool&gt; <strong>TestPageContent</strong>', false);
 402         $search->assertSee('My supercool &lt;great&gt; <strong>TestPageContent</strong> page', false);
 403     }
 404
 405     public function test_words_adjacent_to_lines_breaks_can_be_matched_with_normal_terms()
 406     {
 407         $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
 408             <p>TermA<br>TermB<br>TermC</p>
 409         ']);
 410
 411         $search = $this->asEditor()->get('/search?term=' . urlencode('TermB TermC'));
 412
 413         $search->assertSee($page->getUrl(), false);
 414     }
 415
 416     public function test_backslashes_can_be_searched_upon()
 417     {
 418         $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
 419             <p>More info is at the path \\\\cat\\dog\\badger</p>
 420         ']);
 421         $page->tags()->save(new Tag(['name' => '\\Category', 'value' => '\\animals\\fluffy']));
 422
 423         $search = $this->asEditor()->get('/search?term=' . urlencode('\\\\cat\\dog'));
 424         $search->assertSee($page->getUrl(), false);
 425
 426         $search = $this->asEditor()->get('/search?term=' . urlencode('"\\dog\\\\"'));
 427         $search->assertSee($page->getUrl(), false);
 428
 429         $search = $this->asEditor()->get('/search?term=' . urlencode('"\\badger\\\\"'));
 430         $search->assertDontSee($page->getUrl(), false);
 431
 432         $search = $this->asEditor()->get('/search?term=' . urlencode('[\\Categorylike%\\fluffy]'));
 433         $search->assertSee($page->getUrl(), false);
 434     }
 435
 436     public function test_searches_with_terms_without_controls_includes_them_in_extras()
 437     {
 438         $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:dan} {created_by:dan} -{viewed_by_me} -[a=b] -"dog" {is_template} {sort_by:last_commented}'));
 439         $this->withHtml($resp)->assertFieldHasValue('extras', '{updated_by:dan} {created_by:dan} {is_template} {sort_by:last_commented} -"dog" -[a=b] -{viewed_by_me}');
 440     }
 441
 442     public function test_negated_searches_dont_show_in_inputs()
 443     {
 444         $resp = $this->asEditor()->get('/search?term=' . urlencode('-{created_by:me} -[a=b] -"dog"'));
 445         $this->withHtml($resp)->assertElementNotExists('input[name="tags[]"][value="a=b"]');
 446         $this->withHtml($resp)->assertElementNotExists('input[name="exact[]"][value="dog"]');
 447         $this->withHtml($resp)->assertElementNotExists('input[name="filters[created_by]"][value="me"][checked="checked"]');
 448     }
 449
 450     public function test_searches_with_user_filters_using_me_adds_them_into_advanced_search_form()
 451     {
 452         $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:me} {created_by:me}'));
 453         $this->withHtml($resp)->assertElementExists('form input[name="filters[updated_by]"][value="me"][checked="checked"]');
 454         $this->withHtml($resp)->assertElementExists('form input[name="filters[created_by]"][value="me"][checked="checked"]');
 455     }
 456
 457     public function test_search_suggestion_endpoint()
 458     {
 459         $this->entities->newPage(['name' => 'My suggestion page', 'html' => '<p>My supercool suggestion page</p>']);
 460
 461         // Test specific search
 462         $resp = $this->asEditor()->get('/search/suggest?term="supercool+suggestion"');
 463         $resp->assertSee('My suggestion page');
 464         $resp->assertDontSee('My supercool suggestion page');
 465         $resp->assertDontSee('No items available');
 466         $this->withHtml($resp)->assertElementCount('a', 1);
 467
 468         // Test search limit
 469         $resp = $this->asEditor()->get('/search/suggest?term=et');
 470         $this->withHtml($resp)->assertElementCount('a', 5);
 471
 472         // Test empty state
 473         $resp = $this->asEditor()->get('/search/suggest?term=spaghettisaurusrex');
 474         $this->withHtml($resp)->assertElementCount('a', 0);
 475         $resp->assertSee('No items available');
 476     }
 477 }