Updated/added tests to cover.
Support for actual search queries still remains.
--- /dev/null
+<?php
+
+namespace BookStack\Search\Options;
+
+class ExactSearchOption extends SearchOption
+{
+ public function toString(): string
+ {
+ $escaped = str_replace('\\', '\\\\', $this->value);
+ $escaped = str_replace('"', '\"', $escaped);
+ return ($this->negated ? '-' : '') . '"' . $escaped . '"';
+ }
+}
--- /dev/null
+<?php
+
+namespace BookStack\Search\Options;
+
+class FilterSearchOption extends SearchOption
+{
+ protected string $name;
+
+ public function __construct(
+ string $value,
+ string $name,
+ bool $negated = false,
+ ) {
+ parent::__construct($value, $negated);
+ $this->name = $name;
+ }
+
+ public function toString(): string
+ {
+ $valueText = ($this->value ? ':' . $this->value : '');
+ $filterBrace = '{' . $this->name . $valueText . '}';
+ return ($this->negated ? '-' : '') . $filterBrace;
+ }
+
+ public function getKey(): string
+ {
+ return $this->name;
+ }
+
+ public static function fromContentString(string $value, bool $negated = false): self
+ {
+ $explodedFilter = explode(':', $value, 2);
+ $filterValue = (count($explodedFilter) > 1) ? $explodedFilter[1] : '';
+ $filterName = $explodedFilter[0];
+ return new self($filterValue, $filterName, $negated);
+ }
+}
--- /dev/null
+<?php
+
+namespace BookStack\Search\Options;
+
+abstract class SearchOption
+{
+ public function __construct(
+ public string $value,
+ public bool $negated = false,
+ ) {
+ }
+
+ /**
+ * Get the key used for this option when used in a map.
+ * Null indicates to use the index of the containing array.
+ */
+ public function getKey(): string|null
+ {
+ return null;
+ }
+
+ /**
+ * Get the search string representation for this search option.
+ */
+ abstract public function toString(): string;
+}
--- /dev/null
+<?php
+
+namespace BookStack\Search\Options;
+
+class TagSearchOption extends SearchOption
+{
+ public function toString(): string
+ {
+ return ($this->negated ? '-' : '') . "[{$this->value}]";
+ }
+}
--- /dev/null
+<?php
+
+namespace BookStack\Search\Options;
+
+class TermSearchOption extends SearchOption
+{
+ public function toString(): string
+ {
+ return $this->value;
+ }
+}
+++ /dev/null
-<?php
-
-namespace BookStack\Search;
-
-class SearchOption
-{
- public function __construct(
- public string $value,
- public bool $negated = false,
- ) {
- }
-}
namespace BookStack\Search;
+use BookStack\Search\Options\SearchOption;
+
class SearchOptionSet
{
/**
* @var SearchOption[]
*/
- public array $options = [];
+ protected array $options = [];
public function __construct(array $options = [])
{
public function toValueMap(): array
{
$map = [];
- foreach ($this->options as $key => $option) {
+ foreach ($this->options as $index => $option) {
+ $key = $option->getKey() ?? $index;
$map[$key] = $option->value;
}
return $map;
public function filterEmpty(): self
{
- $filteredOptions = array_filter($this->options, fn (SearchOption $option) => !empty($option->value));
+ $filteredOptions = array_values(array_filter($this->options, fn (SearchOption $option) => !empty($option->value)));
return new self($filteredOptions);
}
- public static function fromValueArray(array $values): self
+ /**
+ * @param class-string<SearchOption> $class
+ */
+ public static function fromValueArray(array $values, string $class): self
{
- $options = array_map(fn($val) => new SearchOption($val), $values);
+ $options = array_map(fn($val) => new $class($val), $values);
return new self($options);
}
- public static function fromMapArray(array $values): self
+ /**
+ * @return SearchOption[]
+ */
+ public function all(): array
{
- $options = [];
- foreach ($values as $key => $value) {
- $options[$key] = new SearchOption($value);
- }
- return new self($options);
+ return $this->options;
+ }
+
+ /**
+ * @return SearchOption[]
+ */
+ public function negated(): array
+ {
+ return array_values(array_filter($this->options, fn (SearchOption $option) => $option->negated));
}
}
namespace BookStack\Search;
+use BookStack\Search\Options\ExactSearchOption;
+use BookStack\Search\Options\FilterSearchOption;
+use BookStack\Search\Options\SearchOption;
+use BookStack\Search\Options\TagSearchOption;
+use BookStack\Search\Options\TermSearchOption;
use Illuminate\Http\Request;
class SearchOptions
}
$instance = new SearchOptions();
- $inputs = $request->only(['search', 'types', 'filters', 'exact', 'tags']);
+ $inputs = $request->only(['search', 'types', 'filters', 'exact', 'tags', 'extras']);
$parsedStandardTerms = static::parseStandardTermString($inputs['search'] ?? '');
$inputExacts = array_filter($inputs['exact'] ?? []);
- $instance->searches = SearchOptionSet::fromValueArray(array_filter($parsedStandardTerms['terms']));
- $instance->exacts = SearchOptionSet::fromValueArray(array_filter($parsedStandardTerms['exacts']));
- $instance->exacts = $instance->exacts->merge(SearchOptionSet::fromValueArray($inputExacts));
- $instance->tags = SearchOptionSet::fromValueArray(array_filter($inputs['tags'] ?? []));
+ $instance->searches = SearchOptionSet::fromValueArray(array_filter($parsedStandardTerms['terms']), TermSearchOption::class);
+ $instance->exacts = SearchOptionSet::fromValueArray(array_filter($parsedStandardTerms['exacts']), ExactSearchOption::class);
+ $instance->exacts = $instance->exacts->merge(SearchOptionSet::fromValueArray($inputExacts, ExactSearchOption::class));
+ $instance->tags = SearchOptionSet::fromValueArray(array_filter($inputs['tags'] ?? []), TagSearchOption::class);
- $keyedFilters = [];
+ $cleanedFilters = [];
foreach (($inputs['filters'] ?? []) as $filterKey => $filterVal) {
if (empty($filterVal)) {
continue;
}
$cleanedFilterVal = $filterVal === 'true' ? '' : $filterVal;
- $keyedFilters[$filterKey] = new SearchOption($cleanedFilterVal);
+ $cleanedFilters[] = new FilterSearchOption($cleanedFilterVal, $filterKey);
}
if (isset($inputs['types']) && count($inputs['types']) < 4) {
- $keyedFilters['type'] = new SearchOption(implode('|', $inputs['types']));
+ $cleanedFilters[] = new FilterSearchOption(implode('|', $inputs['types']), 'types');
}
- $instance->filters = new SearchOptionSet($keyedFilters);
+ $instance->filters = new SearchOptionSet($cleanedFilters);
+
+ // Parse and merge in extras if provided
+ if (!empty($inputs['extras'])) {
+ $extras = static::fromString($inputs['extras']);
+ $instance->searches = $instance->searches->merge($extras->searches);
+ $instance->exacts = $instance->exacts->merge($extras->exacts);
+ $instance->tags = $instance->tags->merge($extras->tags);
+ $instance->filters = $instance->filters->merge($extras->filters);
+ }
return $instance;
}
*/
protected function addOptionsFromString(string $searchString): void
{
- /** @var array<string, string[]> $terms */
+ /** @var array<string, SearchOption[]> $terms */
$terms = [
'exacts' => [],
'tags' => [],
];
$patterns = [
- 'exacts' => '/"((?:\\\\.|[^"\\\\])*)"/',
- 'tags' => '/\[(.*?)\]/',
- 'filters' => '/\{(.*?)\}/',
+ 'exacts' => '/-?"((?:\\\\.|[^"\\\\])*)"/',
+ 'tags' => '/-?\[(.*?)\]/',
+ 'filters' => '/-?\{(.*?)\}/',
+ ];
+
+ $constructors = [
+ 'exacts' => fn(string $value, bool $negated) => new ExactSearchOption($value, $negated),
+ 'tags' => fn(string $value, bool $negated) => new TagSearchOption($value, $negated),
+ 'filters' => fn(string $value, bool $negated) => FilterSearchOption::fromContentString($value, $negated),
];
// Parse special terms
$matches = [];
preg_match_all($pattern, $searchString, $matches);
if (count($matches) > 0) {
- $terms[$termType] = $matches[1];
+ foreach ($matches[1] as $index => $value) {
+ $negated = str_starts_with($matches[0][$index], '-');
+ $terms[$termType][] = $constructors[$termType]($value, $negated);
+ }
$searchString = preg_replace($pattern, '', $searchString);
}
}
// Unescape exacts and backslash escapes
- $escapedExacts = array_map(fn(string $term) => static::decodeEscapes($term), $terms['exacts']);
+ foreach ($terms['exacts'] as $exact) {
+ $exact->value = static::decodeEscapes($exact->value);
+ }
// Parse standard terms
$parsedStandardTerms = static::parseStandardTermString($searchString);
$this->searches = $this->searches
- ->merge(SearchOptionSet::fromValueArray($parsedStandardTerms['terms']))
+ ->merge(SearchOptionSet::fromValueArray($parsedStandardTerms['terms'], TermSearchOption::class))
->filterEmpty();
$this->exacts = $this->exacts
- ->merge(SearchOptionSet::fromValueArray($escapedExacts))
- ->merge(SearchOptionSet::fromValueArray($parsedStandardTerms['exacts']))
+ ->merge(new SearchOptionSet($terms['exacts']))
+ ->merge(SearchOptionSet::fromValueArray($parsedStandardTerms['exacts'], ExactSearchOption::class))
->filterEmpty();
- // Add tags
- $this->tags = $this->tags->merge(SearchOptionSet::fromValueArray($terms['tags']));
-
- // Split filter values out
- /** @var array<string, SearchOption> $splitFilters */
- $splitFilters = [];
- foreach ($terms['filters'] as $filter) {
- $explodedFilter = explode(':', $filter, 2);
- $filterValue = (count($explodedFilter) > 1) ? $explodedFilter[1] : '';
- $splitFilters[$explodedFilter[0]] = new SearchOption($filterValue);
- }
- $this->filters = $this->filters->merge(new SearchOptionSet($splitFilters));
+ // Add tags & filters
+ $this->tags = $this->tags->merge(new SearchOptionSet($terms['tags']));
+ $this->filters = $this->filters->merge(new SearchOptionSet($terms['filters']));
}
/**
public function setFilter(string $filterName, string $filterValue = ''): void
{
$this->filters = $this->filters->merge(
- new SearchOptionSet([$filterName => new SearchOption($filterValue)])
+ new SearchOptionSet([new FilterSearchOption($filterValue, $filterName)])
);
}
*/
public function toString(): string
{
- $parts = $this->searches->toValueArray();
-
- foreach ($this->exacts->toValueArray() as $term) {
- $escaped = str_replace('\\', '\\\\', $term);
- $escaped = str_replace('"', '\"', $escaped);
- $parts[] = '"' . $escaped . '"';
- }
-
- foreach ($this->tags->toValueArray() as $term) {
- $parts[] = "[{$term}]";
- }
+ $options = [
+ ...$this->searches->all(),
+ ...$this->exacts->all(),
+ ...$this->tags->all(),
+ ...$this->filters->all(),
+ ];
- foreach ($this->filters->toValueMap() as $filterName => $filterVal) {
- $parts[] = '{' . $filterName . ($filterVal ? ':' . $filterVal : '') . '}';
- }
+ $parts = array_map(fn(SearchOption $o) => $o->toString(), $options);
return implode(' ', $parts);
}
* Get the search options that don't have UI controls provided for.
* Provided back as a key => value array with the keys being expected
* input names for a search form, and values being the option value.
- *
- * @return array<string, string>
*/
- public function getHiddenInputValuesByFieldName(): array
+ public function getAdditionalOptionsString(): string
{
$options = [];
// Non-[created/updated]-by-me options
- $filterMap = $this->filters->toValueMap();
- foreach (['updated_by', 'created_by', 'owned_by'] as $filter) {
- $value = $filterMap[$filter] ?? null;
- if ($value !== null && $value !== 'me') {
- $options["filters[$filter]"] = $value;
+ $userFilters = ['updated_by', 'created_by', 'owned_by'];
+ foreach ($this->filters->all() as $filter) {
+ if (in_array($filter->getKey(), $userFilters, true) && $filter->value !== null && $filter->value !== 'me') {
+ $options[] = $filter;
}
}
- // TODO - Negated
+ // Negated items
+ array_push($options, ...$this->exacts->negated());
+ array_push($options, ...$this->tags->negated());
+ array_push($options, ...$this->filters->negated());
- return $options;
+ return implode(' ', array_map(fn(SearchOption $o) => $o->toString(), $options));
}
}
@include('search.parts.type-filter', ['checked' => !$hasTypes || in_array('page', $types), 'entity' => 'page', 'transKey' => 'page'])
@include('search.parts.type-filter', ['checked' => !$hasTypes || in_array('chapter', $types), 'entity' => 'chapter', 'transKey' => 'chapter'])
<br>
- @include('search.parts.type-filter', ['checked' => !$hasTypes || in_array('book', $types), 'entity' => 'book', 'transKey' => 'book'])
- @include('search.parts.type-filter', ['checked' => !$hasTypes || in_array('bookshelf', $types), 'entity' => 'bookshelf', 'transKey' => 'shelf'])
+ @include('search.parts.type-filter', ['checked' => !$hasTypes || in_array('book', $types), 'entity' => 'book', 'transKey' => 'book'])
+ @include('search.parts.type-filter', ['checked' => !$hasTypes || in_array('bookshelf', $types), 'entity' => 'bookshelf', 'transKey' => 'shelf'])
</div>
<h6>{{ trans('entities.search_exact_matches') }}</h6>
@include('search.parts.date-filter', ['name' => 'created_after', 'filters' => $filterMap])
@include('search.parts.date-filter', ['name' => 'created_before', 'filters' => $filterMap])
- @foreach($options->getHiddenInputValuesByFieldName() as $fieldName => $value)
- <input type="hidden" name="{{ $fieldName }}" value="{{ $value }}">
- @endforeach
-
+ <input type="hidden" name="extras" value="{{ $options->getAdditionalOptionsString() }}">
<button type="submit" class="button">{{ trans('entities.search_update') }}</button>
</form>
<div class="card content-wrap">
<h1 class="list-heading">{{ trans('entities.search_results') }}</h1>
- <form action="{{ url('/search') }}" method="GET" class="search-box flexible hide-over-l">
- <input value="{{$searchTerm}}" type="text" name="term" placeholder="{{ trans('common.search') }}">
+ <form action="{{ url('/search') }}" method="GET" class="search-box flexible hide-over-l">
+ <input value="{{$searchTerm}}" type="text" name="term"
+ placeholder="{{ trans('common.search') }}">
<button type="submit"
aria-label="{{ trans('common.search') }}"
tabindex="-1">@icon('search')</button>
$search->assertSee($page->getUrl(), false);
}
- public function test_searches_with_user_filters_adds_them_into_advanced_search_form()
+ public function test_searches_with_terms_without_controls_includes_them_in_extras()
{
- $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"]');
+ $resp = $this->asEditor()->get('/search?term=' . urlencode('test {updated_by:dan} {created_by:dan} -{viewed_by_me} -[a=b] -"dog"'));
+ $this->withHtml($resp)->assertFieldHasValue('extras', '{updated_by:dan} {created_by:dan} -"dog" -[a=b] -{viewed_by_me}');
}
public function test_searches_with_user_filters_using_me_adds_them_into_advanced_search_form()
namespace Tests\Entity;
+use BookStack\Search\Options\ExactSearchOption;
+use BookStack\Search\Options\FilterSearchOption;
+use BookStack\Search\Options\TagSearchOption;
+use BookStack\Search\Options\TermSearchOption;
use BookStack\Search\SearchOptions;
use BookStack\Search\SearchOptionSet;
use Illuminate\Http\Request;
$this->assertEquals(['is_tree' => ''], $options->filters->toValueMap());
}
+ public function test_from_string_parses_negations()
+ {
+ $options = SearchOptions::fromString('cat -"dog" -[tag=good] -{is_tree}');
+
+ $this->assertEquals(['cat'], $options->searches->toValueArray());
+ $this->assertTrue($options->exacts->all()[0]->negated);
+ $this->assertTrue($options->tags->all()[0]->negated);
+ $this->assertTrue($options->filters->all()[0]->negated);
+ }
+
public function test_from_string_properly_parses_escaped_quotes()
{
$options = SearchOptions::fromString('"\"cat\"" surprise "\"\"" "\"donkey" "\"" "\\\\"');
public function test_to_string_includes_all_items_in_the_correct_format()
{
- $expected = 'cat "dog" [tag=good] {is_tree}';
+ $expected = 'cat "dog" [tag=good] {is_tree} {beans:valid}';
$options = new SearchOptions();
- $options->searches = SearchOptionSet::fromValueArray(['cat']);
- $options->exacts = SearchOptionSet::fromValueArray(['dog']);
- $options->tags = SearchOptionSet::fromValueArray(['tag=good']);
- $options->filters = SearchOptionSet::fromMapArray(['is_tree' => '']);
+ $options->searches = SearchOptionSet::fromValueArray(['cat'], TermSearchOption::class);
+ $options->exacts = SearchOptionSet::fromValueArray(['dog'], ExactSearchOption::class);
+ $options->tags = SearchOptionSet::fromValueArray(['tag=good'], TagSearchOption::class);
+ $options->filters = new SearchOptionSet([
+ new FilterSearchOption('', 'is_tree'),
+ new FilterSearchOption('valid', 'beans'),
+ ]);
+
+ $output = $options->toString();
+ foreach (explode(' ', $expected) as $term) {
+ $this->assertStringContainsString($term, $output);
+ }
+ }
+
+ public function test_to_string_handles_negations_as_expected()
+ {
+ $expected = 'cat -"dog" -[tag=good] -{is_tree}';
+ $options = new SearchOptions();
+ $options->searches = new SearchOptionSet([new TermSearchOption('cat')]);
+ $options->exacts = new SearchOptionSet([new ExactSearchOption('dog', true)]);
+ $options->tags = new SearchOptionSet([new TagSearchOption('tag=good', true)]);
+ $options->filters = new SearchOptionSet([
+ new FilterSearchOption('', 'is_tree', true),
+ ]);
$output = $options->toString();
foreach (explode(' ', $expected) as $term) {
public function test_to_string_escapes_as_expected()
{
$options = new SearchOptions();
- $options->exacts = SearchOptionSet::fromValueArray(['"cat"', '""', '"donkey', '"', '\\', '\\"']);
+ $options->exacts = SearchOptionSet::fromValueArray(['"cat"', '""', '"donkey', '"', '\\', '\\"'], ExactSearchOption::class);
$output = $options->toString();
$this->assertEquals('"\"cat\"" "\"\"" "\"donkey" "\"" "\\\\" "\\\\\""', $output);
$this->assertEquals(["biscuits"], $options->searches->toValueArray());
$this->assertEquals(['"cheese"', '""', '"baked', 'beans"'], $options->exacts->toValueArray());
}
+
+ public function test_from_request_properly_parses_out_extras_as_string()
+ {
+ $request = new Request([
+ 'search' => '',
+ 'tags' => ['a=b'],
+ 'extras' => '-[b=c] -{viewed_by_me} -"dino"'
+ ]);
+
+ $options = SearchOptions::fromRequest($request);
+ $this->assertCount(2, $options->tags->all());
+ $this->assertEquals('b=c', $options->tags->negated()[0]->value);
+ $this->assertEquals('viewed_by_me', $options->filters->all()[0]->getKey());
+ $this->assertTrue($options->filters->all()[0]->negated);
+ $this->assertEquals('dino', $options->exacts->all()[0]->value);
+ $this->assertTrue($options->exacts->all()[0]->negated);
+ }
}
projects / bookstack / commitdiff