-<?php namespace Tests\Entity;
+<?php
-use BookStack\Actions\Tag;
-use BookStack\Entities\Book;
-use BookStack\Entities\Bookshelf;
-use BookStack\Entities\Chapter;
-use BookStack\Entities\Page;
+namespace Tests\Entity;
+
+use BookStack\Activity\Models\Tag;
+use BookStack\Entities\Models\Book;
+use BookStack\Entities\Models\Bookshelf;
+use BookStack\Entities\Models\Chapter;
use Tests\TestCase;
class EntitySearchTest extends TestCase
{
-
public function test_page_search()
{
- $book = Book::all()->first();
+ $book = $this->entities->book();
$page = $book->pages->first();
$search = $this->asEditor()->get('/search?term=' . urlencode($page->name));
$search->assertSee('Search Results');
- $search->assertSee($page->name);
+ $search->assertSeeText($page->name, true);
}
public function test_bookshelf_search()
{
- $shelf = Bookshelf::first();
- $search = $this->asEditor()->get('/search?term=' . urlencode(mb_substr($shelf->name, 0, 3)) . ' {type:bookshelf}');
- $search->assertStatus(200);
- $search->assertSee($shelf->name);
+ $shelf = $this->entities->shelf();
+
+ $search = $this->asEditor()->get('/search?term=' . urlencode($shelf->name) . ' {type:bookshelf}');
+ $search->assertSee('Search Results');
+ $search->assertSeeText($shelf->name, true);
}
public function test_invalid_page_search()
public function test_searching_accents_and_small_terms()
{
- $page = $this->newPage(['name' => 'My new test quaffleachits', 'html' => 'some áéííúü¿¡ test content a2 orange dog']);
+ $page = $this->entities->newPage(['name' => 'My new test quaffleachits', 'html' => 'some áéííúü¿¡ test content a2 orange dog']);
$this->asEditor();
$accentSearch = $this->get('/search?term=' . urlencode('áéíí'));
public function test_chapter_search()
{
- $chapter = Chapter::has('pages')->first();
+ $chapter = $this->entities->chapterHasPages();
$page = $chapter->pages[0];
$pageTestResp = $this->asEditor()->get('/search/chapter/' . $chapter->id . '?term=' . urlencode($page->name));
{
$newTags = [
new Tag([
- 'name' => 'animal',
- 'value' => 'cat'
+ 'name' => 'animal',
+ 'value' => 'cat',
]),
new Tag([
- 'name' => 'color',
- 'value' => 'red'
- ])
+ 'name' => 'color',
+ 'value' => 'red',
+ ]),
];
- $pageA = Page::first();
+ $pageA = $this->entities->page();
$pageA->tags()->saveMany($newTags);
- $pageB = Page::all()->last();
+ $pageB = $this->entities->page();
$pageB->tags()->create(['name' => 'animal', 'value' => 'dog']);
$this->asEditor();
public function test_exact_searches()
{
- $page = $this->newPage(['name' => 'My new test page', 'html' => 'this is a story about an orange donkey']);
+ $page = $this->entities->newPage(['name' => 'My new test page', 'html' => 'this is a story about an orange donkey']);
$exactSearchA = $this->asEditor()->get('/search?term=' . urlencode('"story about an orange"'));
$exactSearchA->assertStatus(200)->assertSee($page->name);
$exactSearchB->assertStatus(200)->assertDontSee($page->name);
}
- public function test_search_filters()
+ public function test_search_terms_with_delimiters_are_converted_to_exact_matches()
{
- $page = $this->newPage(['name' => 'My new test quaffleachits', 'html' => 'this is about an orange donkey danzorbhsing']);
$this->asEditor();
- $editorId = $this->getEditor()->id;
+ $page = $this->entities->newPage(['name' => 'Delimiter test', 'html' => '<p>1.1 2,2 3?3 4:4 5;5 (8) <9> "10" \'11\' `12`</p>']);
+ $terms = explode(' ', '1.1 2,2 3?3 4:4 5;5 (8) <9> "10" \'11\' `12`');
+
+ foreach ($terms as $term) {
+ $search = $this->get('/search?term=' . urlencode($term));
+ $search->assertSee($page->name);
+ }
+ }
+
+ public function test_search_filters()
+ {
+ $page = $this->entities->newPage(['name' => 'My new test quaffleachits', 'html' => 'this is about an orange donkey danzorbhsing']);
+ $editor = $this->users->editor();
+ $this->actingAs($editor);
// Viewed filter searches
$this->get('/search?term=' . urlencode('danzorbhsing {not_viewed_by_me}'))->assertSee($page->name);
// User filters
$this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertDontSee($page->name);
$this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
- $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:'.$editorId.'}'))->assertDontSee($page->name);
- $page->created_by = $editorId;
+ $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
+ $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editor->slug . '}'))->assertDontSee($page->name);
+ $page->created_by = $editor->id;
$page->save();
$this->get('/search?term=' . urlencode('danzorbhsing {created_by:me}'))->assertSee($page->name);
- $this->get('/search?term=' . urlencode('danzorbhsing {created_by:'.$editorId.'}'))->assertSee($page->name);
+ $this->get('/search?term=' . urlencode('danzorbhsing {created_by: ' . $editor->slug . '}'))->assertSee($page->name);
$this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertDontSee($page->name);
- $page->updated_by = $editorId;
+ $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
+ $page->updated_by = $editor->id;
$page->save();
$this->get('/search?term=' . urlencode('danzorbhsing {updated_by:me}'))->assertSee($page->name);
- $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:'.$editorId.'}'))->assertSee($page->name);
+ $this->get('/search?term=' . urlencode('danzorbhsing {updated_by:' . $editor->slug . '}'))->assertSee($page->name);
+ $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertDontSee($page->name);
+ $page->owned_by = $editor->id;
+ $page->save();
+ $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:me}'))->assertSee($page->name);
+ $this->get('/search?term=' . urlencode('danzorbhsing {owned_by:' . $editor->slug . '}'))->assertSee($page->name);
// Content filters
$this->get('/search?term=' . urlencode('{in_name:danzorbhsing}'))->assertDontSee($page->name);
// Restricted filter
$this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertDontSee($page->name);
- $page->restricted = true;
- $page->save();
+ $this->permissions->setEntityPermissions($page, ['view'], [$editor->roles->first()]);
$this->get('/search?term=' . urlencode('danzorbhsing {is_restricted}'))->assertSee($page->name);
// Date filters
$this->get('/search?term=' . urlencode('danzorbhsing {created_before:2037-01-01}'))->assertDontSee($page->name);
}
- public function test_ajax_entity_search()
+ public function test_entity_selector_search()
{
- $page = $this->newPage(['name' => 'my ajax search test', 'html' => 'ajax test']);
- $notVisitedPage = Page::first();
+ $page = $this->entities->newPage(['name' => 'my ajax search test', 'html' => 'ajax test']);
+ $notVisitedPage = $this->entities->page();
// Visit the page to make popular
$this->asEditor()->get($page->getUrl());
- $normalSearch = $this->get('/ajax/search/entities?term=' . urlencode($page->name));
+ $normalSearch = $this->get('/search/entity-selector?term=' . urlencode($page->name));
$normalSearch->assertSee($page->name);
- $bookSearch = $this->get('/ajax/search/entities?types=book&term=' . urlencode($page->name));
+ $bookSearch = $this->get('/search/entity-selector?types=book&term=' . urlencode($page->name));
$bookSearch->assertDontSee($page->name);
- $defaultListTest = $this->get('/ajax/search/entities');
+ $defaultListTest = $this->get('/search/entity-selector');
$defaultListTest->assertSee($page->name);
$defaultListTest->assertDontSee($notVisitedPage->name);
}
- public function test_ajax_entity_serach_shows_breadcrumbs()
+ public function test_entity_selector_search_shows_breadcrumbs()
{
- $chapter = Chapter::first();
+ $chapter = $this->entities->chapter();
$page = $chapter->pages->first();
$this->asEditor();
- $pageSearch = $this->get('/ajax/search/entities?term=' . urlencode($page->name));
+ $pageSearch = $this->get('/search/entity-selector?term=' . urlencode($page->name));
$pageSearch->assertSee($page->name);
$pageSearch->assertSee($chapter->getShortName(42));
$pageSearch->assertSee($page->book->getShortName(42));
- $chapterSearch = $this->get('/ajax/search/entities?term=' . urlencode($chapter->name));
+ $chapterSearch = $this->get('/search/entity-selector?term=' . urlencode($chapter->name));
$chapterSearch->assertSee($chapter->name);
$chapterSearch->assertSee($chapter->book->getShortName(42));
}
+ public function test_entity_selector_shows_breadcrumbs_on_default_view()
+ {
+ $page = $this->entities->pageWithinChapter();
+ $this->asEditor()->get($page->chapter->getUrl());
+
+ $resp = $this->asEditor()->get('/search/entity-selector?types=book,chapter&permission=page-create');
+ $html = $this->withHtml($resp);
+ $html->assertElementContains('.chapter.entity-list-item', $page->chapter->name);
+ $html->assertElementContains('.chapter.entity-list-item .entity-item-snippet', $page->book->getShortName(42));
+ }
+
+ public function test_entity_selector_search_reflects_items_without_permission()
+ {
+ $page = $this->entities->page();
+ $baseSelector = 'a[data-entity-type="page"][data-entity-id="' . $page->id . '"]';
+ $searchUrl = '/search/entity-selector?permission=update&term=' . urlencode($page->name);
+
+ $resp = $this->asEditor()->get($searchUrl);
+ $this->withHtml($resp)->assertElementContains($baseSelector, $page->name);
+ $this->withHtml($resp)->assertElementNotContains($baseSelector, "You don't have the required permissions to select this item");
+
+ $resp = $this->actingAs($this->users->viewer())->get($searchUrl);
+ $this->withHtml($resp)->assertElementContains($baseSelector, $page->name);
+ $this->withHtml($resp)->assertElementContains($baseSelector, "You don't have the required permissions to select this item");
+ }
+
+ public function test_entity_template_selector_search()
+ {
+ $templatePage = $this->entities->newPage(['name' => 'Template search test', 'html' => 'template test']);
+ $templatePage->template = true;
+ $templatePage->save();
+
+ $nonTemplatePage = $this->entities->newPage(['name' => 'Nontemplate page', 'html' => 'nontemplate', 'template' => false]);
+
+ // Visit both to make popular
+ $this->asEditor()->get($templatePage->getUrl());
+ $this->get($nonTemplatePage->getUrl());
+
+ $normalSearch = $this->get('/search/entity-selector-templates?term=test');
+ $normalSearch->assertSee($templatePage->name);
+ $normalSearch->assertDontSee($nonTemplatePage->name);
+
+ $normalSearch = $this->get('/search/entity-selector-templates?term=beans');
+ $normalSearch->assertDontSee($templatePage->name);
+ $normalSearch->assertDontSee($nonTemplatePage->name);
+
+ $defaultListTest = $this->get('/search/entity-selector-templates');
+ $defaultListTest->assertSee($templatePage->name);
+ $defaultListTest->assertDontSee($nonTemplatePage->name);
+
+ $this->permissions->disableEntityInheritedPermissions($templatePage);
+
+ $normalSearch = $this->get('/search/entity-selector-templates?term=test');
+ $normalSearch->assertDontSee($templatePage->name);
+
+ $defaultListTest = $this->get('/search/entity-selector-templates');
+ $defaultListTest->assertDontSee($templatePage->name);
+ }
+
public function test_sibling_search_for_pages()
{
- $chapter = Chapter::query()->with('pages')->first();
+ $chapter = $this->entities->chapterHasPages();
$this->assertGreaterThan(2, count($chapter->pages), 'Ensure we\'re testing with at least 1 sibling');
$page = $chapter->pages->first();
- $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
+ $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
$search->assertSuccessful();
foreach ($chapter->pages as $page) {
$search->assertSee($page->name);
public function test_sibling_search_for_pages_without_chapter()
{
- $page = Page::query()->where('chapter_id', '=', 0)->firstOrFail();
+ $page = $this->entities->pageNotWithinChapter();
$bookChildren = $page->book->getDirectChildren();
$this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
- $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
+ $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$page->id}&entity_type=page");
$search->assertSuccessful();
foreach ($bookChildren as $child) {
$search->assertSee($child->name);
public function test_sibling_search_for_chapters()
{
- $chapter = Chapter::query()->firstOrFail();
+ $chapter = $this->entities->chapter();
$bookChildren = $chapter->book->getDirectChildren();
$this->assertGreaterThan(2, count($bookChildren), 'Ensure we\'re testing with at least 1 sibling');
- $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$chapter->id}&entity_type=chapter");
+ $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$chapter->id}&entity_type=chapter");
$search->assertSuccessful();
foreach ($bookChildren as $child) {
$search->assertSee($child->name);
$book = $books->first();
$this->assertGreaterThan(2, count($books), 'Ensure we\'re testing with at least 1 sibling');
- $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$book->id}&entity_type=book");
+ $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$book->id}&entity_type=book");
$search->assertSuccessful();
foreach ($books as $expectedBook) {
$search->assertSee($expectedBook->name);
$shelf = $shelves->first();
$this->assertGreaterThan(2, count($shelves), 'Ensure we\'re testing with at least 1 sibling');
- $search = $this->actingAs($this->getViewer())->get("/search/entity/siblings?entity_id={$shelf->id}&entity_type=bookshelf");
+ $search = $this->actingAs($this->users->viewer())->get("/search/entity/siblings?entity_id={$shelf->id}&entity_type=bookshelf");
$search->assertSuccessful();
foreach ($shelves as $expectedShelf) {
$search->assertSee($expectedShelf->name);
}
}
+
+ public function test_search_works_on_updated_page_content()
+ {
+ $page = $this->entities->page();
+ $this->asEditor();
+
+ $update = $this->put($page->getUrl(), [
+ 'name' => $page->name,
+ 'html' => '<p>dog pandabearmonster spaghetti</p>',
+ ]);
+
+ $search = $this->asEditor()->get('/search?term=pandabearmonster');
+ $search->assertStatus(200);
+ $search->assertSeeText($page->name);
+ $search->assertSee($page->getUrl());
+ }
+
+ public function test_search_ranks_common_words_lower()
+ {
+ $this->entities->newPage(['name' => 'Test page A', 'html' => '<p>dog biscuit dog dog</p>']);
+ $this->entities->newPage(['name' => 'Test page B', 'html' => '<p>cat biscuit</p>']);
+
+ $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
+ $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(1)', 'Test page A');
+ $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(2)', 'Test page B');
+
+ for ($i = 0; $i < 2; $i++) {
+ $this->entities->newPage(['name' => 'Test page ' . $i, 'html' => '<p>dog</p>']);
+ }
+
+ $search = $this->asEditor()->get('/search?term=cat+dog+biscuit');
+ $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(1)', 'Test page B');
+ $this->withHtml($search)->assertElementContains('.entity-list > .page:nth-child(2)', 'Test page A');
+ }
+
+ public function test_terms_in_headers_have_an_adjusted_index_score()
+ {
+ $page = $this->entities->newPage(['name' => 'Test page A', 'html' => '
+ <p>TermA</p>
+ <h1>TermB <strong>TermNested</strong></h1>
+ <h2>TermC</h2>
+ <h3>TermD</h3>
+ <h4>TermE</h4>
+ <h5>TermF</h5>
+ <h6>TermG</h6>
+ ']);
+
+ $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
+
+ $this->assertEquals(1, $scoreByTerm->get('TermA'));
+ $this->assertEquals(10, $scoreByTerm->get('TermB'));
+ $this->assertEquals(10, $scoreByTerm->get('TermNested'));
+ $this->assertEquals(5, $scoreByTerm->get('TermC'));
+ $this->assertEquals(4, $scoreByTerm->get('TermD'));
+ $this->assertEquals(3, $scoreByTerm->get('TermE'));
+ $this->assertEquals(2, $scoreByTerm->get('TermF'));
+ // Is 1.5 but stored as integer, rounding up
+ $this->assertEquals(2, $scoreByTerm->get('TermG'));
+ }
+
+ public function test_name_and_content_terms_are_merged_to_single_score()
+ {
+ $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
+ <p>TermA</p>
+ ']);
+
+ $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
+
+ // Scores 40 for being in the name then 1 for being in the content
+ $this->assertEquals(41, $scoreByTerm->get('TermA'));
+ }
+
+ public function test_tag_names_and_values_are_indexed_for_search()
+ {
+ $page = $this->entities->newPage(['name' => 'PageA', 'html' => '<p>content</p>', 'tags' => [
+ ['name' => 'Animal', 'value' => 'MeowieCat'],
+ ['name' => 'SuperImportant'],
+ ]]);
+
+ $scoreByTerm = $page->searchTerms()->pluck('score', 'term');
+ $this->assertEquals(5, $scoreByTerm->get('MeowieCat'));
+ $this->assertEquals(3, $scoreByTerm->get('Animal'));
+ $this->assertEquals(3, $scoreByTerm->get('SuperImportant'));
+ }
+
+ public function test_matching_terms_in_search_results_are_highlighted()
+ {
+ $this->entities->newPage(['name' => 'My Meowie Cat', 'html' => '<p>A superimportant page about meowieable animals</p>', 'tags' => [
+ ['name' => 'Animal', 'value' => 'MeowieCat'],
+ ['name' => 'SuperImportant'],
+ ]]);
+
+ $search = $this->asEditor()->get('/search?term=SuperImportant+Meowie');
+ // Title
+ $search->assertSee('My <strong>Meowie</strong> Cat', false);
+ // Content
+ $search->assertSee('A <strong>superimportant</strong> page about <strong>meowie</strong>able animals', false);
+ // Tag name
+ $this->withHtml($search)->assertElementContains('.tag-name.highlight', 'SuperImportant');
+ // Tag value
+ $this->withHtml($search)->assertElementContains('.tag-value.highlight', 'MeowieCat');
+ }
+
+ public function test_match_highlighting_works_with_multibyte_content()
+ {
+ $this->entities->newPage([
+ 'name' => 'Test Page',
+ 'html' => '<p>На мен ми трябва нещо добро test</p>',
+ ]);
+
+ $search = $this->asEditor()->get('/search?term=' . urlencode('На мен ми трябва нещо добро'));
+ $search->assertSee('<strong>На</strong> <strong>мен</strong> <strong>ми</strong> <strong>трябва</strong> <strong>нещо</strong> <strong>добро</strong> test', false);
+ }
+
+ public function test_html_entities_in_item_details_remains_escaped_in_search_results()
+ {
+ $this->entities->newPage(['name' => 'My <cool> TestPageContent', 'html' => '<p>My supercool <great> TestPageContent page</p>']);
+
+ $search = $this->asEditor()->get('/search?term=TestPageContent');
+ $search->assertSee('My <cool> <strong>TestPageContent</strong>', false);
+ $search->assertSee('My supercool <great> <strong>TestPageContent</strong> page', false);
+ }
+
+ public function test_words_adjacent_to_lines_breaks_can_be_matched_with_normal_terms()
+ {
+ $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
+ <p>TermA<br>TermB<br>TermC</p>
+ ']);
+
+ $search = $this->asEditor()->get('/search?term=' . urlencode('TermB TermC'));
+
+ $search->assertSee($page->getUrl(), false);
+ }
+
+ public function test_backslashes_can_be_searched_upon()
+ {
+ $page = $this->entities->newPage(['name' => 'TermA', 'html' => '
+ <p>More info is at the path \\\\cat\\dog\\badger</p>
+ ']);
+ $page->tags()->save(new Tag(['name' => '\\Category', 'value' => '\\animals\\fluffy']));
+
+ $search = $this->asEditor()->get('/search?term=' . urlencode('\\\\cat\\dog'));
+ $search->assertSee($page->getUrl(), false);
+
+ $search = $this->asEditor()->get('/search?term=' . urlencode('"\\dog\\\\"'));
+ $search->assertSee($page->getUrl(), false);
+
+ $search = $this->asEditor()->get('/search?term=' . urlencode('"\\badger\\\\"'));
+ $search->assertDontSee($page->getUrl(), false);
+
+ $search = $this->asEditor()->get('/search?term=' . urlencode('[\\Categorylike%\\fluffy]'));
+ $search->assertSee($page->getUrl(), false);
+ }
+
+ public function test_searches_with_user_filters_adds_them_into_advanced_search_form()
+ {
+ $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:dan} {created_by:dan}'));
+ $this->withHtml($resp)->assertElementExists('form input[name="filters[updated_by]"][value="dan"]');
+ $this->withHtml($resp)->assertElementExists('form input[name="filters[created_by]"][value="dan"]');
+ }
+
+ public function test_searches_with_user_filters_using_me_adds_them_into_advanced_search_form()
+ {
+ $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:me} {created_by:me}'));
+ $this->withHtml($resp)->assertElementExists('form input[name="filters[updated_by]"][value="me"][checked="checked"]');
+ $this->withHtml($resp)->assertElementExists('form input[name="filters[created_by]"][value="me"][checked="checked"]');
+ }
+
+ public function test_search_suggestion_endpoint()
+ {
+ $this->entities->newPage(['name' => 'My suggestion page', 'html' => '<p>My supercool suggestion page</p>']);
+
+ // Test specific search
+ $resp = $this->asEditor()->get('/search/suggest?term="supercool+suggestion"');
+ $resp->assertSee('My suggestion page');
+ $resp->assertDontSee('My supercool suggestion page');
+ $resp->assertDontSee('No items available');
+ $this->withHtml($resp)->assertElementCount('a', 1);
+
+ // Test search limit
+ $resp = $this->asEditor()->get('/search/suggest?term=et');
+ $this->withHtml($resp)->assertElementCount('a', 5);
+
+ // Test empty state
+ $resp = $this->asEditor()->get('/search/suggest?term=spaghettisaurusrex');
+ $this->withHtml($resp)->assertElementCount('a', 0);
+ $resp->assertSee('No items available');
+ }
}
projects / bookstack / blobdiff