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 BookStack\Entities\Models\Chapter;
   9 use BookStack\Entities\Models\Page;
  10 use Tests\TestCase;
  11
  12 class EntitySearchTest extends TestCase
  13 {
  14     public function test_page_search()
  15     {
  16         $book = Book::all()->first();
  17         $page = $book->pages->first();
  18
  19         $search = $this->asEditor()->get('/search?term=' . urlencode($page->name));
  20         $search->assertSee('Search Results');
  21         $search->assertSeeText($page->name, true);
  22     }
  23
  24     public function test_bookshelf_search()
  25     {
  26         /** @var Bookshelf $shelf */
  27         $shelf = Bookshelf::query()->first();
  28
  29         $search = $this->asEditor()->get('/search?term=' . urlencode($shelf->name) . '  {type:bookshelf}');
  30         $search->assertSee('Search Results');
  31         $search->assertSeeText($shelf->name, true);
  32     }
  33
  34     public function test_invalid_page_search()
  35     {
  36         $resp = $this->asEditor()->get('/search?term=' . urlencode('<p>test</p>'));
  37         $resp->assertSee('Search Results');
  38         $resp->assertStatus(200);
  39         $this->get('/search?term=cat+-')->assertStatus(200);
  40     }
  41
  42     public function test_empty_search_shows_search_page()
  43     {
  44         $res = $this->asEditor()->get('/search');
  45         $res->assertStatus(200);
  46     }
  47
  48     public function test_searching_accents_and_small_terms()
  49     {
  50         $page = $this->newPage(['name' => 'My new test quaffleachits', 'html' => 'some áéííúü¿¡ test content a2 orange dog']);
  51         $this->asEditor();
  52
  53         $accentSearch = $this->get('/search?term=' . urlencode('áéíí'));
  54         $accentSearch->assertStatus(200)->assertSee($page->name);
  55
  56         $smallSearch = $this->get('/search?term=' . urlencode('a2'));
  57         $smallSearch->assertStatus(200)->assertSee($page->name);
  58     }
  59
  60     public function test_book_search()
  61     {
  62         $book = Book::first();
  63         $page = $book->pages->last();
  64         $chapter = $book->chapters->last();
  65
  66         $pageTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($page->name));
  67         $pageTestResp->assertSee($page->name);
  68
  69         $chapterTestResp = $this->asEditor()->get('/search/book/' . $book->id . '?term=' . urlencode($chapter->name));
  70         $chapterTestResp->assertSee($chapter->name);
  71     }
  72
  73     public function test_chapter_search()
  74     {
  75         $chapter = Chapter::has('pages')->first();
  76         $page = $chapter->pages[0];
  77
  78         $pageTestResp = $this->asEditor()->get('/search/chapter/' . $chapter->id . '?term=' . urlencode($page->name));
  79         $pageTestResp->assertSee($page->name);
  80     }
  81
  82     public function test_tag_search()
  83     {
  84         $newTags = [
  85             new Tag([
  86                 'name'  => 'animal',
  87                 'value' => 'cat',
  88             ]),
  89             new Tag([
  90                 'name'  => 'color',
  91                 'value' => 'red',
  92             ]),
  93         ];
  94
  95         $pageA = Page::first();
  96         $pageA->tags()->saveMany($newTags);
  97
  98         $pageB = Page::all()->last();
  99         $pageB->tags()->create(['name' => 'animal', 'value' => 'dog']);
 100
 101         $this->asEditor();
 102         $tNameSearch = $this->get('/search?term=%5Banimal%5D');
 103         $tNameSearch->assertSee($pageA->name)->assertSee($pageB->name);
 104
 105         $tNameSearch2 = $this->get('/search?term=%5Bcolor%5D');
 106         $tNameSearch2->assertSee($pageA->name)->assertDontSee($pageB->name);
 107
 108         $tNameValSearch = $this->get('/search?term=%5Banimal%3Dcat%5D');
 109         $tNameValSearch->assertSee($pageA->name)->assertDontSee($pageB->name);
 110     }
 111
 112     public function test_exact_searches()
 113     {
 114         $page = $this->newPage(['name' => 'My new test page', 'html' => 'this is a story about an orange donkey']);
 115
 116         $exactSearchA = $this->asEditor()->get('/search?term=' . urlencode('"story about an orange"'));
 117         $exactSearchA->assertStatus(200)->assertSee($page->name);
 118
 119         $exactSearchB = $this->asEditor()->get('/search?term=' . urlencode('"story not about an orange"'));
 120         $exactSearchB->assertStatus(200)->assertDontSee($page->name);
 121     }
 122
 123     public function test_search_terms_with_delimiters_are_converted_to_exact_matches()
 124     {
 125         $this->asEditor();
 126         $page = $this->newPage(['name' => 'Delimiter test', 'html' => '<p>1.1 2,2 3?3 4:4 5;5 (8) &lt;9&gt; "10" \'11\' `12`</p>']);
 127         $terms = explode(' ', '1.1 2,2 3?3 4:4 5;5 (8) <9> "10" \'11\' `12`');
 128
 129         foreach ($terms as $term) {
 130             $search = $this->get('/search?term=' . urlencode($term));
 131             $search->assertSee($page->name);
 132         }
 133     }
 134
 135     public function test_search_filters()
 136     {
 137         $page = $this->newPage(['name' => 'My new test quaffleachits', 'html' => 'this is about an orange donkey danzorbhsing']);
 138         $this->asEditor();
 139         $editorId = $this->getEditor()->id;
 140         $editorSlug = $this->getEditor()->slug;
 141
 142         // Viewed filter searches
 143         $this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertSee($page->name);
 144         $this->get('/search?term=' . urlencode('danzorbhsing {viewed_by_me}'))->assertDontSee($page->name);
 145         $this->get($page->getUrl());
 146         $this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertDontSee($page->name);
 147         $this->get('/search?term=' . urlencode('danzorbhsing {viewed_by_me}'))->assertSee($page->name);
 148
 149         // User filters
 150         $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertDontSee($page->name);
 151         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
 152         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
 153         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editorSlug . '}'))->assertDontSee($page->name);
 154         $page->created_by = $editorId;
 155         $page->save();
 156         $this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertSee($page->name);
 157         $this->get('/search?term=' . urlencode('danzorbhsing {created_by: ' . $editorSlug . '}'))->assertSee($page->name);
 158         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
 159         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
 160         $page->updated_by = $editorId;
 161         $page->save();
 162         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertSee($page->name);
 163         $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editorSlug . '}'))->assertSee($page->name);
 164         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
 165         $page->owned_by = $editorId;
 166         $page->save();
 167         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertSee($page->name);
 168         $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:' . $editorSlug . '}'))->assertSee($page->name);
 169
 170         // Content filters
 171         $this->get('/search?term=' . urlencode('{in_name:danzorbhsing}'))->assertDontSee($page->name);
 172         $this->get('/search?term=' . urlencode('{in_body:danzorbhsing}'))->assertSee($page->name);
 173         $this->get('/search?term=' . urlencode('{in_name:test quaffleachits}'))->assertSee($page->name);
 174         $this->get('/search?term=' . urlencode('{in_body:test quaffleachits}'))->assertDontSee($page->name);
 175
 176         // Restricted filter
 177         $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertDontSee($page->name);
 178         $page->restricted = true;
 179         $page->save();
 180         $this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertSee($page->name);
 181
 182         // Date filters
 183         $this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertDontSee($page->name);
 184         $this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertSee($page->name);
 185         $page->updated_at = '2037-02-01';
 186         $page->save();
 187         $this->get('/search?term=' . urlencode('danzorbhsing {updated_after:2037-01-01}'))->assertSee($page->name);
 188         $this->get('/search?term=' . urlencode('danzorbhsing {updated_before:2037-01-01}'))->assertDontSee($page->name);
 189
 190         $this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertDontSee($page->name);
 191         $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertSee($page->name);
 192         $page->created_at = '2037-02-01';
 193         $page->save();
 194         $this->get('/search?term=' . urlencode('danzorbhsing {created_after:2037-01-01}'))->assertSee($page->name);
 195         $this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertDontSee($page->name);
 196     }
 197
 198     public function test_ajax_entity_search()
 199     {
 200         $page = $this->newPage(['name' => 'my ajax search test', 'html' => 'ajax test']);
 201         $notVisitedPage = Page::first();
 202
 203         // Visit the page to make popular
 204         $this->asEditor()->get($page->getUrl());
 205
 206         $normalSearch = $this->get('/ajax/search/entities?term=' . urlencode($page->name));
 207         $normalSearch->assertSee($page->name);
 208
 209         $bookSearch = $this->get('/ajax/search/entities?types=book&term=' . urlencode($page->name));
 210         $bookSearch->assertDontSee($page->name);
 211
 212         $defaultListTest = $this->get('/ajax/search/entities');
 213         $defaultListTest->assertSee($page->name);
 214         $defaultListTest->assertDontSee($notVisitedPage->name);
 215     }
 216
 217     public function test_ajax_entity_serach_shows_breadcrumbs()
 218     {
 219         $chapter = Chapter::first();
 220         $page = $chapter->pages->first();
 221         $this->asEditor();
 222
 223         $pageSearch = $this->get('/ajax/search/entities?term=' . urlencode($page->name));
 224         $pageSearch->assertSee($page->name);
 225         $pageSearch->assertSee($chapter->getShortName(42));
 226         $pageSearch->assertSee($page->book->getShortName(42));
 227
 228         $chapterSearch = $this->get('/ajax/search/entities?term=' . urlencode($chapter->name));
 229         $chapterSearch->assertSee($chapter->name);
 230         $chapterSearch->assertSee($chapter->book->getShortName(42));
 231     }
 232
 233     public function test_sibling_search_for_pages()
 234     {
 235         $chapter = Chapter::query()->with('pages')->first();
 236         $this->assertGreaterThan(2, count($chapter->pages), 'Ensure we\'re testing with at least 1 sibling');
 237         $page = $chapter->pages->first();
 238
 239         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
 240         $search->assertSuccessful();
 241         foreach ($chapter->pages as $page) {
 242             $search->assertSee($page->name);
 243         }
 244
 245         $search->assertDontSee($chapter->name);
 246     }
 247
 248     public function test_sibling_search_for_pages_without_chapter()
 249     {
 250         $page = Page::query()->where('chapter_id', '=', 0)->firstOrFail();
 251         $bookChildren = $page->book->getDirectChildren();
 252         $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
 253
 254         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
 255         $search->assertSuccessful();
 256         foreach ($bookChildren as $child) {
 257             $search->assertSee($child->name);
 258         }
 259
 260         $search->assertDontSee($page->book->name);
 261     }
 262
 263     public function test_sibling_search_for_chapters()
 264     {
 265         $chapter = Chapter::query()->firstOrFail();
 266         $bookChildren = $chapter->book->getDirectChildren();
 267         $this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
 268
 269         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$chapter->id}&entity_type=chapter");
 270         $search->assertSuccessful();
 271         foreach ($bookChildren as $child) {
 272             $search->assertSee($child->name);
 273         }
 274
 275         $search->assertDontSee($chapter->book->name);
 276     }
 277
 278     public function test_sibling_search_for_books()
 279     {
 280         $books = Book::query()->take(10)->get();
 281         $book = $books->first();
 282         $this->assertGreaterThan(2, count($books), 'Ensure we\'re testing with at least 1 sibling');
 283
 284         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$book->id}&entity_type=book");
 285         $search->assertSuccessful();
 286         foreach ($books as $expectedBook) {
 287             $search->assertSee($expectedBook->name);
 288         }
 289     }
 290
 291     public function test_sibling_search_for_shelves()
 292     {
 293         $shelves = Bookshelf::query()->take(10)->get();
 294         $shelf = $shelves->first();
 295         $this->assertGreaterThan(2, count($shelves), 'Ensure we\'re testing with at least 1 sibling');
 296
 297         $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$shelf->id}&entity_type=bookshelf");
 298         $search->assertSuccessful();
 299         foreach ($shelves as $expectedShelf) {
 300             $search->assertSee($expectedShelf->name);
 301         }
 302     }
 303
 304     public function test_search_works_on_updated_page_content()
 305     {
 306         $page = Page::query()->first();
 307         $this->asEditor();
 308
 309         $update = $this->put($page->getUrl(), [
 310             'name' => $page->name,
 311             'html' => '<p>dog pandabearmonster spaghetti</p>',
 312         ]);
 313
 314         $search = $this->asEditor()->get('/search?term=pandabearmonster');
 315         $search->assertStatus(200);
 316         $search->assertSeeText($page->name);
 317         $search->assertSee($page->getUrl());
 318     }
 319
 320     public function test_search_ranks_common_words_lower()
 321     {
 322         $this->newPage(['name' => 'Test page A', 'html' => '<p>dog biscuit dog dog</p>']);
 323         $this->newPage(['name' => 'Test page B', 'html' => '<p>cat biscuit</p>']);
 324
 325         $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
 326         $search->assertElementContains('.entity-list > .page', 'Test page A', 1);
 327         $search->assertElementContains('.entity-list > .page', 'Test page B', 2);
 328
 329         for ($i = 0; $i < 2; $i++) {
 330             $this->newPage(['name' => 'Test page ' . $i, 'html' => '<p>dog</p>']);
 331         }
 332
 333         $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
 334         $search->assertElementContains('.entity-list > .page', 'Test page B', 1);
 335         $search->assertElementContains('.entity-list > .page', 'Test page A', 2);
 336     }
 337
 338     public function test_terms_in_headers_have_an_adjusted_index_score()
 339     {
 340         $page = $this->newPage(['name' => 'Test page A', 'html' => '
 341             <p>TermA</p>
 342             <h1>TermB <strong>TermNested</strong></h1>
 343             <h2>TermC</h2>
 344             <h3>TermD</h3>
 345             <h4>TermE</h4>
 346             <h5>TermF</h5>
 347             <h6>TermG</h6>
 348         ']);
 349
 350         $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
 351
 352         $this->assertEquals(1, $scoreByTerm->get('TermA'));
 353         $this->assertEquals(10, $scoreByTerm->get('TermB'));
 354         $this->assertEquals(10, $scoreByTerm->get('TermNested'));
 355         $this->assertEquals(5, $scoreByTerm->get('TermC'));
 356         $this->assertEquals(4, $scoreByTerm->get('TermD'));
 357         $this->assertEquals(3, $scoreByTerm->get('TermE'));
 358         $this->assertEquals(2, $scoreByTerm->get('TermF'));
 359         // Is 1.5 but stored as integer, rounding up
 360         $this->assertEquals(2, $scoreByTerm->get('TermG'));
 361     }
 362
 363     public function test_name_and_content_terms_are_merged_to_single_score()
 364     {
 365         $page = $this->newPage(['name' => 'TermA', 'html' => '
 366             <p>TermA</p>
 367         ']);
 368
 369         $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
 370
 371         // Scores 40 for being in the name then 1 for being in the content
 372         $this->assertEquals(41, $scoreByTerm->get('TermA'));
 373     }
 374
 375     public function test_tag_names_and_values_are_indexed_for_search()
 376     {
 377         $page = $this->newPage(['name' => 'PageA', 'html' => '<p>content</p>', 'tags' => [
 378             ['name' => 'Animal', 'value' => 'MeowieCat'],
 379             ['name' => 'SuperImportant'],
 380         ]]);
 381
 382         $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
 383         $this->assertEquals(5, $scoreByTerm->get('MeowieCat'));
 384         $this->assertEquals(3, $scoreByTerm->get('Animal'));
 385         $this->assertEquals(3, $scoreByTerm->get('SuperImportant'));
 386     }
 387
 388     public function test_matching_terms_in_search_results_are_highlighted()
 389     {
 390         $this->newPage(['name' => 'My Meowie Cat', 'html' => '<p>A superimportant page about meowieable animals</p>', 'tags' => [
 391             ['name' => 'Animal', 'value' => 'MeowieCat'],
 392             ['name' => 'SuperImportant'],
 393         ]]);
 394
 395         $search = $this->asEditor()->get('/search?term=SuperImportant+Meowie');
 396         // Title
 397         $search->assertSee('My <strong>Meowie</strong> Cat', false);
 398         // Content
 399         $search->assertSee('A <strong>superimportant</strong> page about <strong>meowie</strong>able animals', false);
 400         // Tag name
 401         $search->assertElementContains('.tag-name.highlight', 'SuperImportant');
 402         // Tag value
 403         $search->assertElementContains('.tag-value.highlight', 'MeowieCat');
 404     }
 405
 406     public function test_html_entities_in_item_details_remains_escaped_in_search_results()
 407     {
 408         $this->newPage(['name' => 'My <cool> TestPageContent', 'html' => '<p>My supercool &lt;great&gt; TestPageContent page</p>']);
 409
 410         $search = $this->asEditor()->get('/search?term=TestPageContent');
 411         $search->assertSee('My &lt;cool&gt; <strong>TestPageContent</strong>', false);
 412         $search->assertSee('My supercool &lt;great&gt; <strong>TestPageContent</strong> page', false);
 413     }
 414 }