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