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