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