Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions config/search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,4 +79,31 @@
'fields' => ['title'],
],

/*
|--------------------------------------------------------------------------
| Indexing Queue
|--------------------------------------------------------------------------
|
| Here you may configure the queue name and connection used when indexing
| documents.
|
*/

'queue' => env('STATAMIC_SEARCH_QUEUE'),

'queue_connection' => env('STATAMIC_SEARCH_QUEUE_CONNECTION'),

/*
|--------------------------------------------------------------------------
| Chunk Size
|--------------------------------------------------------------------------
|
| Here you can configure the chunk size used when indexing documents.
| The higher you make it, the more memory it will use, but the quicker
| the indexing process will be.
|
*/

'chunk_size' => 100,

];
2 changes: 1 addition & 1 deletion src/Search/Algolia/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ public function search($query)
return (new Query($this))->query($query);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
$documents = $documents->map(function ($item, $id) {
$item['objectID'] = $id;
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Comb/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ public function delete($document)
$this->save($data);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
try {
$data = $this->data();
Expand Down
22 changes: 14 additions & 8 deletions src/Search/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@

use Closure;
use Statamic\Contracts\Search\Searchable;
use Statamic\Support\Arr;
use Statamic\Support\Str;

abstract class Index
Expand All@@ -20,7 +19,7 @@ abstract public function delete($document);

abstract public function exists();

abstract protected function insertDocuments(Documents $documents);
abstract public function insertDocuments(Documents $documents);

abstract protected function deleteIndex();

Expand DownExpand Up@@ -84,20 +83,27 @@ public function ensureExists()

public function insert($document)
{
return $this->insertMultiple(Arr::wrap($document));
return $this->insertMultiple(collect($document));
}

public function insertMultiple($documents)
{
$documents = (new Documents($documents))->mapWithKeys(function (Searchable $item) {
return [$item->getSearchReference() => $this->searchables()->fields($item)];
});

$this->insertDocuments($documents);
$documents
->chunk(config('statamic.search.chunk_size'))
->each(fn ($documents) => InsertMultipleJob::dispatch(
name: Str::beforeLast($this->name, '_'),
locale: $this->locale,
documents: $documents
));

return $this;
}

public function fields(Searchable $searchable)
{
return $this->searchables()->fields($searchable);
}

public function shouldIndex($searchable)
{
return $this->searchables()->contains($searchable);
Expand Down
52 changes: 52 additions & 0 deletions src/Search/InsertMultipleJob.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<?php

namespace Statamic\Search;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Queue\Queueable;
use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Search\Searchable;
use Statamic\Facades\Search;
use Statamic\Search\Searchables\Providers;
use Statamic\Support\Str;

class InsertMultipleJob implements ShouldQueue
{
use Queueable;

/**
* Create a new job instance.
*/
public function __construct(
public string $name,
public ?string $locale,
public Collection|LazyCollection $documents,
) {
$this->onConnection($connection = config('statamic.search.queue_connection', config('queue.default')));
$this->onQueue(config('statamic.search.queue', config("queue.connections.{$connection}.queue")));
}

/**
* Execute the job.
*/
public function handle(): void
{
$providers = app(Providers::class);
$index = Search::index($this->name, $this->locale);

$documents = $this->documents
->groupBy(fn ($document) => explode('::', $document)[0])
->flatMap(function ($documents, $prefix) use ($providers) {
return $providers
->getByPrefix($prefix)
->find($documents->map(fn ($reference) => Str::after($reference, '::'))->all())
->all();
})
->mapWithKeys(function (Searchable $item) use ($index) {
return [$item->getSearchReference() => $index->fields($item)];
});

$index->insertDocuments(new Documents($documents));
}
}
2 changes: 1 addition & 1 deletion src/Search/Null/NullIndex.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ public function exists()
return true;
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
//
}
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,7 +51,7 @@ public function updateWithinIndexes(Searchable $searchable)
$exists = $index->exists();

if ($shouldIndex && $exists) {
$index->insert($searchable);
$index->insert($searchable->getSearchReference());
} elseif ($shouldIndex && ! $exists) {
$index->update();
} elseif ($exists) {
Expand Down
4 changes: 3 additions & 1 deletion src/Search/Searchables/Assets.php
Comment thread
jasonvarga marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ public function provide(): Collection
: AssetCollection::make($this->keys)
->flatMap(fn ($key) => Asset::whereContainer($key));

return $assets->filter($this->filter())->values();
// TODO: query scope support?

return $assets->filter($this->filter())->values()->map->reference();
}

public function contains($searchable): bool
Expand Down
26 changes: 24 additions & 2 deletions src/Search/Searchables/Entries.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,19 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

$query->where('status', 'published');

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -48,7 +60,17 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Entry::query()
->where('status', 'published')
->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
16 changes: 16 additions & 0 deletions src/Search/Searchables/Provider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,11 @@

namespace Statamic\Search\Searchables;

use Statamic\Facades\Scope;
use Statamic\Facades\Search;
use Statamic\Search\Index;
use Statamic\Search\ProvidesSearchables;
use Statamic\Support\Arr;

abstract class Provider implements ProvidesSearchables
{
Expand DownExpand Up@@ -55,6 +57,20 @@ protected function usesWildcard()
return in_array('*', $this->keys);
}

protected function applyQueryScope($query)
{
if (! $scope = $this->index->config()['query_scope'] ?? null) {
return;
}

Scope::find($scope)->apply($query, []);
}

protected function hasFilter()
{
return Arr::has($this->index->config(), 'filter');
}

protected function filter()
{
$filter = $this->index->config()['filter'] ?? null;
Expand Down
22 changes: 20 additions & 2 deletions src/Search/Searchables/Terms.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,17 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -49,7 +59,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Term::query()->where('reference', $searchable->reference());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $refs): Collection
Expand Down
27 changes: 24 additions & 3 deletions src/Search/Searchables/Users.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Search\Searchables;

use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Auth\User as UserContract;
use Statamic\Facades\User;

Expand All@@ -18,9 +19,21 @@ public static function referencePrefix(): string
return 'user';
}

public function provide(): Collection
public function provide(): Collection|LazyCollection
{
return User::all()->filter($this->filter())->values();
$query = User::query();

$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -29,7 +42,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = User::query()->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
3 changes: 2 additions & 1 deletion tests/Search/SearchTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ public function it_updates_indexes($updateMock)
{
$index = Mockery::mock(Index::class);
$item = Mockery::mock(Searchable::class);
$item->shouldReceive('getSearchReference')->andReturn('a');

$updateMock($index, $item);

Expand All@@ -37,7 +38,7 @@ public static function saveProvider()
function ($mock, $entry) {
$mock->shouldReceive('shouldIndex')->with($entry)->andReturnTrue();
$mock->shouldReceive('exists')->andReturnTrue();
$mock->shouldReceive('insert')->once()->with($entry);
$mock->shouldReceive('insert')->once()->with($entry->getSearchReference());
},
],

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions config/search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,4 +79,31 @@
'fields' => ['title'],
],

/*
|--------------------------------------------------------------------------
| Indexing Queue
|--------------------------------------------------------------------------
|
| Here you may configure the queue name and connection used when indexing
| documents.
|
*/

'queue' => env('STATAMIC_SEARCH_QUEUE'),

'queue_connection' => env('STATAMIC_SEARCH_QUEUE_CONNECTION'),

/*
|--------------------------------------------------------------------------
| Chunk Size
|--------------------------------------------------------------------------
|
| Here you can configure the chunk size used when indexing documents.
| The higher you make it, the more memory it will use, but the quicker
| the indexing process will be.
|
*/

'chunk_size' => 100,

];
2 changes: 1 addition & 1 deletion src/Search/Algolia/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ public function search($query)
return (new Query($this))->query($query);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
$documents = $documents->map(function ($item, $id) {
$item['objectID'] = $id;
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Comb/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ public function delete($document)
$this->save($data);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
try {
$data = $this->data();
Expand Down
22 changes: 14 additions & 8 deletions src/Search/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@

use Closure;
use Statamic\Contracts\Search\Searchable;
use Statamic\Support\Arr;
use Statamic\Support\Str;

abstract class Index
Expand All@@ -20,7 +19,7 @@ abstract public function delete($document);

abstract public function exists();

abstract protected function insertDocuments(Documents $documents);
abstract public function insertDocuments(Documents $documents);

abstract protected function deleteIndex();

Expand DownExpand Up@@ -84,20 +83,27 @@ public function ensureExists()

public function insert($document)
{
return $this->insertMultiple(Arr::wrap($document));
return $this->insertMultiple(collect($document));
}

public function insertMultiple($documents)
{
$documents = (new Documents($documents))->mapWithKeys(function (Searchable $item) {
return [$item->getSearchReference() => $this->searchables()->fields($item)];
});

$this->insertDocuments($documents);
$documents
->chunk(config('statamic.search.chunk_size'))
->each(fn ($documents) => InsertMultipleJob::dispatch(
name: Str::beforeLast($this->name, '_'),
locale: $this->locale,
documents: $documents
));

return $this;
}

public function fields(Searchable $searchable)
{
return $this->searchables()->fields($searchable);
}

public function shouldIndex($searchable)
{
return $this->searchables()->contains($searchable);
Expand Down
52 changes: 52 additions & 0 deletions src/Search/InsertMultipleJob.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<?php

namespace Statamic\Search;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Queue\Queueable;
use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Search\Searchable;
use Statamic\Facades\Search;
use Statamic\Search\Searchables\Providers;
use Statamic\Support\Str;

class InsertMultipleJob implements ShouldQueue
{
use Queueable;

/**
* Create a new job instance.
*/
public function __construct(
public string $name,
public ?string $locale,
public Collection|LazyCollection $documents,
) {
$this->onConnection($connection = config('statamic.search.queue_connection', config('queue.default')));
$this->onQueue(config('statamic.search.queue', config("queue.connections.{$connection}.queue")));
}

/**
* Execute the job.
*/
public function handle(): void
{
$providers = app(Providers::class);
$index = Search::index($this->name, $this->locale);

$documents = $this->documents
->groupBy(fn ($document) => explode('::', $document)[0])
->flatMap(function ($documents, $prefix) use ($providers) {
return $providers
->getByPrefix($prefix)
->find($documents->map(fn ($reference) => Str::after($reference, '::'))->all())
->all();
})
->mapWithKeys(function (Searchable $item) use ($index) {
return [$item->getSearchReference() => $index->fields($item)];
});

$index->insertDocuments(new Documents($documents));
}
}
2 changes: 1 addition & 1 deletion src/Search/Null/NullIndex.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ public function exists()
return true;
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
//
}
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,7 +51,7 @@ public function updateWithinIndexes(Searchable $searchable)
$exists = $index->exists();

if ($shouldIndex && $exists) {
$index->insert($searchable);
$index->insert($searchable->getSearchReference());
} elseif ($shouldIndex && ! $exists) {
$index->update();
} elseif ($exists) {
Expand Down
4 changes: 3 additions & 1 deletion src/Search/Searchables/Assets.php
Comment thread
jasonvarga marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ public function provide(): Collection
: AssetCollection::make($this->keys)
->flatMap(fn ($key) => Asset::whereContainer($key));

return $assets->filter($this->filter())->values();
// TODO: query scope support?

return $assets->filter($this->filter())->values()->map->reference();
}

public function contains($searchable): bool
Expand Down
26 changes: 24 additions & 2 deletions src/Search/Searchables/Entries.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,19 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

$query->where('status', 'published');

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -48,7 +60,17 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Entry::query()
->where('status', 'published')
->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
16 changes: 16 additions & 0 deletions src/Search/Searchables/Provider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,11 @@

namespace Statamic\Search\Searchables;

use Statamic\Facades\Scope;
use Statamic\Facades\Search;
use Statamic\Search\Index;
use Statamic\Search\ProvidesSearchables;
use Statamic\Support\Arr;

abstract class Provider implements ProvidesSearchables
{
Expand DownExpand Up@@ -55,6 +57,20 @@ protected function usesWildcard()
return in_array('*', $this->keys);
}

protected function applyQueryScope($query)
{
if (! $scope = $this->index->config()['query_scope'] ?? null) {
return;
}

Scope::find($scope)->apply($query, []);
}

protected function hasFilter()
{
return Arr::has($this->index->config(), 'filter');
}

protected function filter()
{
$filter = $this->index->config()['filter'] ?? null;
Expand Down
22 changes: 20 additions & 2 deletions src/Search/Searchables/Terms.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,17 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -49,7 +59,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Term::query()->where('reference', $searchable->reference());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $refs): Collection
Expand Down
27 changes: 24 additions & 3 deletions src/Search/Searchables/Users.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Search\Searchables;

use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Auth\User as UserContract;
use Statamic\Facades\User;

Expand All@@ -18,9 +19,21 @@ public static function referencePrefix(): string
return 'user';
}

public function provide(): Collection
public function provide(): Collection|LazyCollection
{
return User::all()->filter($this->filter())->values();
$query = User::query();

$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -29,7 +42,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = User::query()->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
3 changes: 2 additions & 1 deletion tests/Search/SearchTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ public function it_updates_indexes($updateMock)
{
$index = Mockery::mock(Index::class);
$item = Mockery::mock(Searchable::class);
$item->shouldReceive('getSearchReference')->andReturn('a');

$updateMock($index, $item);

Expand All@@ -37,7 +38,7 @@ public static function saveProvider()
function ($mock, $entry) {
$mock->shouldReceive('shouldIndex')->with($entry)->andReturnTrue();
$mock->shouldReceive('exists')->andReturnTrue();
$mock->shouldReceive('insert')->once()->with($entry);
$mock->shouldReceive('insert')->once()->with($entry->getSearchReference());
},
],

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions config/search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,4 +79,31 @@
'fields' => ['title'],
],

/*
|--------------------------------------------------------------------------
| Indexing Queue
|--------------------------------------------------------------------------
|
| Here you may configure the queue name and connection used when indexing
| documents.
|
*/

'queue' => env('STATAMIC_SEARCH_QUEUE'),

'queue_connection' => env('STATAMIC_SEARCH_QUEUE_CONNECTION'),

/*
|--------------------------------------------------------------------------
| Chunk Size
|--------------------------------------------------------------------------
|
| Here you can configure the chunk size used when indexing documents.
| The higher you make it, the more memory it will use, but the quicker
| the indexing process will be.
|
*/

'chunk_size' => 100,

];
2 changes: 1 addition & 1 deletion src/Search/Algolia/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ public function search($query)
return (new Query($this))->query($query);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
$documents = $documents->map(function ($item, $id) {
$item['objectID'] = $id;
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Comb/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ public function delete($document)
$this->save($data);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
try {
$data = $this->data();
Expand Down
22 changes: 14 additions & 8 deletions src/Search/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@

use Closure;
use Statamic\Contracts\Search\Searchable;
use Statamic\Support\Arr;
use Statamic\Support\Str;

abstract class Index
Expand All@@ -20,7 +19,7 @@ abstract public function delete($document);

abstract public function exists();

abstract protected function insertDocuments(Documents $documents);
abstract public function insertDocuments(Documents $documents);

abstract protected function deleteIndex();

Expand DownExpand Up@@ -84,20 +83,27 @@ public function ensureExists()

public function insert($document)
{
return $this->insertMultiple(Arr::wrap($document));
return $this->insertMultiple(collect($document));
}

public function insertMultiple($documents)
{
$documents = (new Documents($documents))->mapWithKeys(function (Searchable $item) {
return [$item->getSearchReference() => $this->searchables()->fields($item)];
});

$this->insertDocuments($documents);
$documents
->chunk(config('statamic.search.chunk_size'))
->each(fn ($documents) => InsertMultipleJob::dispatch(
name: Str::beforeLast($this->name, '_'),
locale: $this->locale,
documents: $documents
));

return $this;
}

public function fields(Searchable $searchable)
{
return $this->searchables()->fields($searchable);
}

public function shouldIndex($searchable)
{
return $this->searchables()->contains($searchable);
Expand Down
52 changes: 52 additions & 0 deletions src/Search/InsertMultipleJob.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<?php

namespace Statamic\Search;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Queue\Queueable;
use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Search\Searchable;
use Statamic\Facades\Search;
use Statamic\Search\Searchables\Providers;
use Statamic\Support\Str;

class InsertMultipleJob implements ShouldQueue
{
use Queueable;

/**
* Create a new job instance.
*/
public function __construct(
public string $name,
public ?string $locale,
public Collection|LazyCollection $documents,
) {
$this->onConnection($connection = config('statamic.search.queue_connection', config('queue.default')));
$this->onQueue(config('statamic.search.queue', config("queue.connections.{$connection}.queue")));
}

/**
* Execute the job.
*/
public function handle(): void
{
$providers = app(Providers::class);
$index = Search::index($this->name, $this->locale);

$documents = $this->documents
->groupBy(fn ($document) => explode('::', $document)[0])
->flatMap(function ($documents, $prefix) use ($providers) {
return $providers
->getByPrefix($prefix)
->find($documents->map(fn ($reference) => Str::after($reference, '::'))->all())
->all();
})
->mapWithKeys(function (Searchable $item) use ($index) {
return [$item->getSearchReference() => $index->fields($item)];
});

$index->insertDocuments(new Documents($documents));
}
}
2 changes: 1 addition & 1 deletion src/Search/Null/NullIndex.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ public function exists()
return true;
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
//
}
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,7 +51,7 @@ public function updateWithinIndexes(Searchable $searchable)
$exists = $index->exists();

if ($shouldIndex && $exists) {
$index->insert($searchable);
$index->insert($searchable->getSearchReference());
} elseif ($shouldIndex && ! $exists) {
$index->update();
} elseif ($exists) {
Expand Down
4 changes: 3 additions & 1 deletion src/Search/Searchables/Assets.php
Comment thread
jasonvarga marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ public function provide(): Collection
: AssetCollection::make($this->keys)
->flatMap(fn ($key) => Asset::whereContainer($key));

return $assets->filter($this->filter())->values();
// TODO: query scope support?

return $assets->filter($this->filter())->values()->map->reference();
}

public function contains($searchable): bool
Expand Down
26 changes: 24 additions & 2 deletions src/Search/Searchables/Entries.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,19 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

$query->where('status', 'published');

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -48,7 +60,17 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Entry::query()
->where('status', 'published')
->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
16 changes: 16 additions & 0 deletions src/Search/Searchables/Provider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,11 @@

namespace Statamic\Search\Searchables;

use Statamic\Facades\Scope;
use Statamic\Facades\Search;
use Statamic\Search\Index;
use Statamic\Search\ProvidesSearchables;
use Statamic\Support\Arr;

abstract class Provider implements ProvidesSearchables
{
Expand DownExpand Up@@ -55,6 +57,20 @@ protected function usesWildcard()
return in_array('*', $this->keys);
}

protected function applyQueryScope($query)
{
if (! $scope = $this->index->config()['query_scope'] ?? null) {
return;
}

Scope::find($scope)->apply($query, []);
}

protected function hasFilter()
{
return Arr::has($this->index->config(), 'filter');
}

protected function filter()
{
$filter = $this->index->config()['filter'] ?? null;
Expand Down
22 changes: 20 additions & 2 deletions src/Search/Searchables/Terms.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,17 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -49,7 +59,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Term::query()->where('reference', $searchable->reference());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $refs): Collection
Expand Down
27 changes: 24 additions & 3 deletions src/Search/Searchables/Users.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Search\Searchables;

use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Auth\User as UserContract;
use Statamic\Facades\User;

Expand All@@ -18,9 +19,21 @@ public static function referencePrefix(): string
return 'user';
}

public function provide(): Collection
public function provide(): Collection|LazyCollection
{
return User::all()->filter($this->filter())->values();
$query = User::query();

$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -29,7 +42,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = User::query()->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
3 changes: 2 additions & 1 deletion tests/Search/SearchTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ public function it_updates_indexes($updateMock)
{
$index = Mockery::mock(Index::class);
$item = Mockery::mock(Searchable::class);
$item->shouldReceive('getSearchReference')->andReturn('a');

$updateMock($index, $item);

Expand All@@ -37,7 +38,7 @@ public static function saveProvider()
function ($mock, $entry) {
$mock->shouldReceive('shouldIndex')->with($entry)->andReturnTrue();
$mock->shouldReceive('exists')->andReturnTrue();
$mock->shouldReceive('insert')->once()->with($entry);
$mock->shouldReceive('insert')->once()->with($entry->getSearchReference());
},
],

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions config/search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,4 +79,31 @@
'fields' => ['title'],
],

/*
|--------------------------------------------------------------------------
| Indexing Queue
|--------------------------------------------------------------------------
|
| Here you may configure the queue name and connection used when indexing
| documents.
|
*/

'queue' => env('STATAMIC_SEARCH_QUEUE'),

'queue_connection' => env('STATAMIC_SEARCH_QUEUE_CONNECTION'),

/*
|--------------------------------------------------------------------------
| Chunk Size
|--------------------------------------------------------------------------
|
| Here you can configure the chunk size used when indexing documents.
| The higher you make it, the more memory it will use, but the quicker
| the indexing process will be.
|
*/

'chunk_size' => 100,

];
2 changes: 1 addition & 1 deletion src/Search/Algolia/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ public function search($query)
return (new Query($this))->query($query);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
$documents = $documents->map(function ($item, $id) {
$item['objectID'] = $id;
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Comb/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ public function delete($document)
$this->save($data);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
try {
$data = $this->data();
Expand Down
22 changes: 14 additions & 8 deletions src/Search/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@

use Closure;
use Statamic\Contracts\Search\Searchable;
use Statamic\Support\Arr;
use Statamic\Support\Str;

abstract class Index
Expand All@@ -20,7 +19,7 @@ abstract public function delete($document);

abstract public function exists();

abstract protected function insertDocuments(Documents $documents);
abstract public function insertDocuments(Documents $documents);

abstract protected function deleteIndex();

Expand DownExpand Up@@ -84,20 +83,27 @@ public function ensureExists()

public function insert($document)
{
return $this->insertMultiple(Arr::wrap($document));
return $this->insertMultiple(collect($document));
}

public function insertMultiple($documents)
{
$documents = (new Documents($documents))->mapWithKeys(function (Searchable $item) {
return [$item->getSearchReference() => $this->searchables()->fields($item)];
});

$this->insertDocuments($documents);
$documents
->chunk(config('statamic.search.chunk_size'))
->each(fn ($documents) => InsertMultipleJob::dispatch(
name: Str::beforeLast($this->name, '_'),
locale: $this->locale,
documents: $documents
));

return $this;
}

public function fields(Searchable $searchable)
{
return $this->searchables()->fields($searchable);
}

public function shouldIndex($searchable)
{
return $this->searchables()->contains($searchable);
Expand Down
52 changes: 52 additions & 0 deletions src/Search/InsertMultipleJob.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<?php

namespace Statamic\Search;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Queue\Queueable;
use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Search\Searchable;
use Statamic\Facades\Search;
use Statamic\Search\Searchables\Providers;
use Statamic\Support\Str;

class InsertMultipleJob implements ShouldQueue
{
use Queueable;

/**
* Create a new job instance.
*/
public function __construct(
public string $name,
public ?string $locale,
public Collection|LazyCollection $documents,
) {
$this->onConnection($connection = config('statamic.search.queue_connection', config('queue.default')));
$this->onQueue(config('statamic.search.queue', config("queue.connections.{$connection}.queue")));
}

/**
* Execute the job.
*/
public function handle(): void
{
$providers = app(Providers::class);
$index = Search::index($this->name, $this->locale);

$documents = $this->documents
->groupBy(fn ($document) => explode('::', $document)[0])
->flatMap(function ($documents, $prefix) use ($providers) {
return $providers
->getByPrefix($prefix)
->find($documents->map(fn ($reference) => Str::after($reference, '::'))->all())
->all();
})
->mapWithKeys(function (Searchable $item) use ($index) {
return [$item->getSearchReference() => $index->fields($item)];
});

$index->insertDocuments(new Documents($documents));
}
}
2 changes: 1 addition & 1 deletion src/Search/Null/NullIndex.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ public function exists()
return true;
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
//
}
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,7 +51,7 @@ public function updateWithinIndexes(Searchable $searchable)
$exists = $index->exists();

if ($shouldIndex && $exists) {
$index->insert($searchable);
$index->insert($searchable->getSearchReference());
} elseif ($shouldIndex && ! $exists) {
$index->update();
} elseif ($exists) {
Expand Down
4 changes: 3 additions & 1 deletion src/Search/Searchables/Assets.php
Comment thread
jasonvarga marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ public function provide(): Collection
: AssetCollection::make($this->keys)
->flatMap(fn ($key) => Asset::whereContainer($key));

return $assets->filter($this->filter())->values();
// TODO: query scope support?

return $assets->filter($this->filter())->values()->map->reference();
}

public function contains($searchable): bool
Expand Down
26 changes: 24 additions & 2 deletions src/Search/Searchables/Entries.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,19 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

$query->where('status', 'published');

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -48,7 +60,17 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Entry::query()
->where('status', 'published')
->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
16 changes: 16 additions & 0 deletions src/Search/Searchables/Provider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,11 @@

namespace Statamic\Search\Searchables;

use Statamic\Facades\Scope;
use Statamic\Facades\Search;
use Statamic\Search\Index;
use Statamic\Search\ProvidesSearchables;
use Statamic\Support\Arr;

abstract class Provider implements ProvidesSearchables
{
Expand DownExpand Up@@ -55,6 +57,20 @@ protected function usesWildcard()
return in_array('*', $this->keys);
}

protected function applyQueryScope($query)
{
if (! $scope = $this->index->config()['query_scope'] ?? null) {
return;
}

Scope::find($scope)->apply($query, []);
}

protected function hasFilter()
{
return Arr::has($this->index->config(), 'filter');
}

protected function filter()
{
$filter = $this->index->config()['filter'] ?? null;
Expand Down
22 changes: 20 additions & 2 deletions src/Search/Searchables/Terms.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,17 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -49,7 +59,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Term::query()->where('reference', $searchable->reference());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $refs): Collection
Expand Down
27 changes: 24 additions & 3 deletions src/Search/Searchables/Users.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Search\Searchables;

use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Auth\User as UserContract;
use Statamic\Facades\User;

Expand All@@ -18,9 +19,21 @@ public static function referencePrefix(): string
return 'user';
}

public function provide(): Collection
public function provide(): Collection|LazyCollection
{
return User::all()->filter($this->filter())->values();
$query = User::query();

$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -29,7 +42,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = User::query()->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
3 changes: 2 additions & 1 deletion tests/Search/SearchTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ public function it_updates_indexes($updateMock)
{
$index = Mockery::mock(Index::class);
$item = Mockery::mock(Searchable::class);
$item->shouldReceive('getSearchReference')->andReturn('a');

$updateMock($index, $item);

Expand All@@ -37,7 +38,7 @@ public static function saveProvider()
function ($mock, $entry) {
$mock->shouldReceive('shouldIndex')->with($entry)->andReturnTrue();
$mock->shouldReceive('exists')->andReturnTrue();
$mock->shouldReceive('insert')->once()->with($entry);
$mock->shouldReceive('insert')->once()->with($entry->getSearchReference());
},
],

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions config/search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,4 +79,31 @@
'fields' => ['title'],
],

/*
|--------------------------------------------------------------------------
| Indexing Queue
|--------------------------------------------------------------------------
|
| Here you may configure the queue name and connection used when indexing
| documents.
|
*/

'queue' => env('STATAMIC_SEARCH_QUEUE'),

'queue_connection' => env('STATAMIC_SEARCH_QUEUE_CONNECTION'),

/*
|--------------------------------------------------------------------------
| Chunk Size
|--------------------------------------------------------------------------
|
| Here you can configure the chunk size used when indexing documents.
| The higher you make it, the more memory it will use, but the quicker
| the indexing process will be.
|
*/

'chunk_size' => 100,

];
2 changes: 1 addition & 1 deletion src/Search/Algolia/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ public function search($query)
return (new Query($this))->query($query);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
$documents = $documents->map(function ($item, $id) {
$item['objectID'] = $id;
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Comb/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ public function delete($document)
$this->save($data);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
try {
$data = $this->data();
Expand Down
22 changes: 14 additions & 8 deletions src/Search/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@

use Closure;
use Statamic\Contracts\Search\Searchable;
use Statamic\Support\Arr;
use Statamic\Support\Str;

abstract class Index
Expand All@@ -20,7 +19,7 @@ abstract public function delete($document);

abstract public function exists();

abstract protected function insertDocuments(Documents $documents);
abstract public function insertDocuments(Documents $documents);

abstract protected function deleteIndex();

Expand DownExpand Up@@ -84,20 +83,27 @@ public function ensureExists()

public function insert($document)
{
return $this->insertMultiple(Arr::wrap($document));
return $this->insertMultiple(collect($document));
}

public function insertMultiple($documents)
{
$documents = (new Documents($documents))->mapWithKeys(function (Searchable $item) {
return [$item->getSearchReference() => $this->searchables()->fields($item)];
});

$this->insertDocuments($documents);
$documents
->chunk(config('statamic.search.chunk_size'))
->each(fn ($documents) => InsertMultipleJob::dispatch(
name: Str::beforeLast($this->name, '_'),
locale: $this->locale,
documents: $documents
));

return $this;
}

public function fields(Searchable $searchable)
{
return $this->searchables()->fields($searchable);
}

public function shouldIndex($searchable)
{
return $this->searchables()->contains($searchable);
Expand Down
52 changes: 52 additions & 0 deletions src/Search/InsertMultipleJob.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<?php

namespace Statamic\Search;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Queue\Queueable;
use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Search\Searchable;
use Statamic\Facades\Search;
use Statamic\Search\Searchables\Providers;
use Statamic\Support\Str;

class InsertMultipleJob implements ShouldQueue
{
use Queueable;

/**
* Create a new job instance.
*/
public function __construct(
public string $name,
public ?string $locale,
public Collection|LazyCollection $documents,
) {
$this->onConnection($connection = config('statamic.search.queue_connection', config('queue.default')));
$this->onQueue(config('statamic.search.queue', config("queue.connections.{$connection}.queue")));
}

/**
* Execute the job.
*/
public function handle(): void
{
$providers = app(Providers::class);
$index = Search::index($this->name, $this->locale);

$documents = $this->documents
->groupBy(fn ($document) => explode('::', $document)[0])
->flatMap(function ($documents, $prefix) use ($providers) {
return $providers
->getByPrefix($prefix)
->find($documents->map(fn ($reference) => Str::after($reference, '::'))->all())
->all();
})
->mapWithKeys(function (Searchable $item) use ($index) {
return [$item->getSearchReference() => $index->fields($item)];
});

$index->insertDocuments(new Documents($documents));
}
}
2 changes: 1 addition & 1 deletion src/Search/Null/NullIndex.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ public function exists()
return true;
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
//
}
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,7 +51,7 @@ public function updateWithinIndexes(Searchable $searchable)
$exists = $index->exists();

if ($shouldIndex && $exists) {
$index->insert($searchable);
$index->insert($searchable->getSearchReference());
} elseif ($shouldIndex && ! $exists) {
$index->update();
} elseif ($exists) {
Expand Down
4 changes: 3 additions & 1 deletion src/Search/Searchables/Assets.php
Comment thread
jasonvarga marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ public function provide(): Collection
: AssetCollection::make($this->keys)
->flatMap(fn ($key) => Asset::whereContainer($key));

return $assets->filter($this->filter())->values();
// TODO: query scope support?

return $assets->filter($this->filter())->values()->map->reference();
}

public function contains($searchable): bool
Expand Down
26 changes: 24 additions & 2 deletions src/Search/Searchables/Entries.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,19 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

$query->where('status', 'published');

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -48,7 +60,17 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Entry::query()
->where('status', 'published')
->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
16 changes: 16 additions & 0 deletions src/Search/Searchables/Provider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,11 @@

namespace Statamic\Search\Searchables;

use Statamic\Facades\Scope;
use Statamic\Facades\Search;
use Statamic\Search\Index;
use Statamic\Search\ProvidesSearchables;
use Statamic\Support\Arr;

abstract class Provider implements ProvidesSearchables
{
Expand DownExpand Up@@ -55,6 +57,20 @@ protected function usesWildcard()
return in_array('*', $this->keys);
}

protected function applyQueryScope($query)
{
if (! $scope = $this->index->config()['query_scope'] ?? null) {
return;
}

Scope::find($scope)->apply($query, []);
}

protected function hasFilter()
{
return Arr::has($this->index->config(), 'filter');
}

protected function filter()
{
$filter = $this->index->config()['filter'] ?? null;
Expand Down
22 changes: 20 additions & 2 deletions src/Search/Searchables/Terms.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,17 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -49,7 +59,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Term::query()->where('reference', $searchable->reference());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $refs): Collection
Expand Down
27 changes: 24 additions & 3 deletions src/Search/Searchables/Users.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Search\Searchables;

use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Auth\User as UserContract;
use Statamic\Facades\User;

Expand All@@ -18,9 +19,21 @@ public static function referencePrefix(): string
return 'user';
}

public function provide(): Collection
public function provide(): Collection|LazyCollection
{
return User::all()->filter($this->filter())->values();
$query = User::query();

$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -29,7 +42,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = User::query()->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
3 changes: 2 additions & 1 deletion tests/Search/SearchTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ public function it_updates_indexes($updateMock)
{
$index = Mockery::mock(Index::class);
$item = Mockery::mock(Searchable::class);
$item->shouldReceive('getSearchReference')->andReturn('a');

$updateMock($index, $item);

Expand All@@ -37,7 +38,7 @@ public static function saveProvider()
function ($mock, $entry) {
$mock->shouldReceive('shouldIndex')->with($entry)->andReturnTrue();
$mock->shouldReceive('exists')->andReturnTrue();
$mock->shouldReceive('insert')->once()->with($entry);
$mock->shouldReceive('insert')->once()->with($entry->getSearchReference());
},
],

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions config/search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,4 +79,31 @@
'fields' => ['title'],
],

/*
|--------------------------------------------------------------------------
| Indexing Queue
|--------------------------------------------------------------------------
|
| Here you may configure the queue name and connection used when indexing
| documents.
|
*/

'queue' => env('STATAMIC_SEARCH_QUEUE'),

'queue_connection' => env('STATAMIC_SEARCH_QUEUE_CONNECTION'),

/*
|--------------------------------------------------------------------------
| Chunk Size
|--------------------------------------------------------------------------
|
| Here you can configure the chunk size used when indexing documents.
| The higher you make it, the more memory it will use, but the quicker
| the indexing process will be.
|
*/

'chunk_size' => 100,

];
2 changes: 1 addition & 1 deletion src/Search/Algolia/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ public function search($query)
return (new Query($this))->query($query);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
$documents = $documents->map(function ($item, $id) {
$item['objectID'] = $id;
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Comb/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ public function delete($document)
$this->save($data);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
try {
$data = $this->data();
Expand Down
22 changes: 14 additions & 8 deletions src/Search/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@

use Closure;
use Statamic\Contracts\Search\Searchable;
use Statamic\Support\Arr;
use Statamic\Support\Str;

abstract class Index
Expand All@@ -20,7 +19,7 @@ abstract public function delete($document);

abstract public function exists();

abstract protected function insertDocuments(Documents $documents);
abstract public function insertDocuments(Documents $documents);

abstract protected function deleteIndex();

Expand DownExpand Up@@ -84,20 +83,27 @@ public function ensureExists()

public function insert($document)
{
return $this->insertMultiple(Arr::wrap($document));
return $this->insertMultiple(collect($document));
}

public function insertMultiple($documents)
{
$documents = (new Documents($documents))->mapWithKeys(function (Searchable $item) {
return [$item->getSearchReference() => $this->searchables()->fields($item)];
});

$this->insertDocuments($documents);
$documents
->chunk(config('statamic.search.chunk_size'))
->each(fn ($documents) => InsertMultipleJob::dispatch(
name: Str::beforeLast($this->name, '_'),
locale: $this->locale,
documents: $documents
));

return $this;
}

public function fields(Searchable $searchable)
{
return $this->searchables()->fields($searchable);
}

public function shouldIndex($searchable)
{
return $this->searchables()->contains($searchable);
Expand Down
52 changes: 52 additions & 0 deletions src/Search/InsertMultipleJob.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<?php

namespace Statamic\Search;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Queue\Queueable;
use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Search\Searchable;
use Statamic\Facades\Search;
use Statamic\Search\Searchables\Providers;
use Statamic\Support\Str;

class InsertMultipleJob implements ShouldQueue
{
use Queueable;

/**
* Create a new job instance.
*/
public function __construct(
public string $name,
public ?string $locale,
public Collection|LazyCollection $documents,
) {
$this->onConnection($connection = config('statamic.search.queue_connection', config('queue.default')));
$this->onQueue(config('statamic.search.queue', config("queue.connections.{$connection}.queue")));
}

/**
* Execute the job.
*/
public function handle(): void
{
$providers = app(Providers::class);
$index = Search::index($this->name, $this->locale);

$documents = $this->documents
->groupBy(fn ($document) => explode('::', $document)[0])
->flatMap(function ($documents, $prefix) use ($providers) {
return $providers
->getByPrefix($prefix)
->find($documents->map(fn ($reference) => Str::after($reference, '::'))->all())
->all();
})
->mapWithKeys(function (Searchable $item) use ($index) {
return [$item->getSearchReference() => $index->fields($item)];
});

$index->insertDocuments(new Documents($documents));
}
}
2 changes: 1 addition & 1 deletion src/Search/Null/NullIndex.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ public function exists()
return true;
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
//
}
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,7 +51,7 @@ public function updateWithinIndexes(Searchable $searchable)
$exists = $index->exists();

if ($shouldIndex && $exists) {
$index->insert($searchable);
$index->insert($searchable->getSearchReference());
} elseif ($shouldIndex && ! $exists) {
$index->update();
} elseif ($exists) {
Expand Down
4 changes: 3 additions & 1 deletion src/Search/Searchables/Assets.php
Comment thread
jasonvarga marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ public function provide(): Collection
: AssetCollection::make($this->keys)
->flatMap(fn ($key) => Asset::whereContainer($key));

return $assets->filter($this->filter())->values();
// TODO: query scope support?

return $assets->filter($this->filter())->values()->map->reference();
}

public function contains($searchable): bool
Expand Down
26 changes: 24 additions & 2 deletions src/Search/Searchables/Entries.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,19 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

$query->where('status', 'published');

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -48,7 +60,17 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Entry::query()
->where('status', 'published')
->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
16 changes: 16 additions & 0 deletions src/Search/Searchables/Provider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,11 @@

namespace Statamic\Search\Searchables;

use Statamic\Facades\Scope;
use Statamic\Facades\Search;
use Statamic\Search\Index;
use Statamic\Search\ProvidesSearchables;
use Statamic\Support\Arr;

abstract class Provider implements ProvidesSearchables
{
Expand DownExpand Up@@ -55,6 +57,20 @@ protected function usesWildcard()
return in_array('*', $this->keys);
}

protected function applyQueryScope($query)
{
if (! $scope = $this->index->config()['query_scope'] ?? null) {
return;
}

Scope::find($scope)->apply($query, []);
}

protected function hasFilter()
{
return Arr::has($this->index->config(), 'filter');
}

protected function filter()
{
$filter = $this->index->config()['filter'] ?? null;
Expand Down
22 changes: 20 additions & 2 deletions src/Search/Searchables/Terms.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,17 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -49,7 +59,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Term::query()->where('reference', $searchable->reference());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $refs): Collection
Expand Down
27 changes: 24 additions & 3 deletions src/Search/Searchables/Users.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Search\Searchables;

use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Auth\User as UserContract;
use Statamic\Facades\User;

Expand All@@ -18,9 +19,21 @@ public static function referencePrefix(): string
return 'user';
}

public function provide(): Collection
public function provide(): Collection|LazyCollection
{
return User::all()->filter($this->filter())->values();
$query = User::query();

$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -29,7 +42,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = User::query()->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
3 changes: 2 additions & 1 deletion tests/Search/SearchTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ public function it_updates_indexes($updateMock)
{
$index = Mockery::mock(Index::class);
$item = Mockery::mock(Searchable::class);
$item->shouldReceive('getSearchReference')->andReturn('a');

$updateMock($index, $item);

Expand All@@ -37,7 +38,7 @@ public static function saveProvider()
function ($mock, $entry) {
$mock->shouldReceive('shouldIndex')->with($entry)->andReturnTrue();
$mock->shouldReceive('exists')->andReturnTrue();
$mock->shouldReceive('insert')->once()->with($entry);
$mock->shouldReceive('insert')->once()->with($entry->getSearchReference());
},
],

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions config/search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,4 +79,31 @@
'fields' => ['title'],
],

/*
|--------------------------------------------------------------------------
| Indexing Queue
|--------------------------------------------------------------------------
|
| Here you may configure the queue name and connection used when indexing
| documents.
|
*/

'queue' => env('STATAMIC_SEARCH_QUEUE'),

'queue_connection' => env('STATAMIC_SEARCH_QUEUE_CONNECTION'),

/*
|--------------------------------------------------------------------------
| Chunk Size
|--------------------------------------------------------------------------
|
| Here you can configure the chunk size used when indexing documents.
| The higher you make it, the more memory it will use, but the quicker
| the indexing process will be.
|
*/

'chunk_size' => 100,

];
2 changes: 1 addition & 1 deletion src/Search/Algolia/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ public function search($query)
return (new Query($this))->query($query);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
$documents = $documents->map(function ($item, $id) {
$item['objectID'] = $id;
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Comb/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ public function delete($document)
$this->save($data);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
try {
$data = $this->data();
Expand Down
22 changes: 14 additions & 8 deletions src/Search/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@

use Closure;
use Statamic\Contracts\Search\Searchable;
use Statamic\Support\Arr;
use Statamic\Support\Str;

abstract class Index
Expand All@@ -20,7 +19,7 @@ abstract public function delete($document);

abstract public function exists();

abstract protected function insertDocuments(Documents $documents);
abstract public function insertDocuments(Documents $documents);

abstract protected function deleteIndex();

Expand DownExpand Up@@ -84,20 +83,27 @@ public function ensureExists()

public function insert($document)
{
return $this->insertMultiple(Arr::wrap($document));
return $this->insertMultiple(collect($document));
}

public function insertMultiple($documents)
{
$documents = (new Documents($documents))->mapWithKeys(function (Searchable $item) {
return [$item->getSearchReference() => $this->searchables()->fields($item)];
});

$this->insertDocuments($documents);
$documents
->chunk(config('statamic.search.chunk_size'))
->each(fn ($documents) => InsertMultipleJob::dispatch(
name: Str::beforeLast($this->name, '_'),
locale: $this->locale,
documents: $documents
));

return $this;
}

public function fields(Searchable $searchable)
{
return $this->searchables()->fields($searchable);
}

public function shouldIndex($searchable)
{
return $this->searchables()->contains($searchable);
Expand Down
52 changes: 52 additions & 0 deletions src/Search/InsertMultipleJob.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<?php

namespace Statamic\Search;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Queue\Queueable;
use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Search\Searchable;
use Statamic\Facades\Search;
use Statamic\Search\Searchables\Providers;
use Statamic\Support\Str;

class InsertMultipleJob implements ShouldQueue
{
use Queueable;

/**
* Create a new job instance.
*/
public function __construct(
public string $name,
public ?string $locale,
public Collection|LazyCollection $documents,
) {
$this->onConnection($connection = config('statamic.search.queue_connection', config('queue.default')));
$this->onQueue(config('statamic.search.queue', config("queue.connections.{$connection}.queue")));
}

/**
* Execute the job.
*/
public function handle(): void
{
$providers = app(Providers::class);
$index = Search::index($this->name, $this->locale);

$documents = $this->documents
->groupBy(fn ($document) => explode('::', $document)[0])
->flatMap(function ($documents, $prefix) use ($providers) {
return $providers
->getByPrefix($prefix)
->find($documents->map(fn ($reference) => Str::after($reference, '::'))->all())
->all();
})
->mapWithKeys(function (Searchable $item) use ($index) {
return [$item->getSearchReference() => $index->fields($item)];
});

$index->insertDocuments(new Documents($documents));
}
}
2 changes: 1 addition & 1 deletion src/Search/Null/NullIndex.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ public function exists()
return true;
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
//
}
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,7 +51,7 @@ public function updateWithinIndexes(Searchable $searchable)
$exists = $index->exists();

if ($shouldIndex && $exists) {
$index->insert($searchable);
$index->insert($searchable->getSearchReference());
} elseif ($shouldIndex && ! $exists) {
$index->update();
} elseif ($exists) {
Expand Down
4 changes: 3 additions & 1 deletion src/Search/Searchables/Assets.php
Comment thread
jasonvarga marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ public function provide(): Collection
: AssetCollection::make($this->keys)
->flatMap(fn ($key) => Asset::whereContainer($key));

return $assets->filter($this->filter())->values();
// TODO: query scope support?

return $assets->filter($this->filter())->values()->map->reference();
}

public function contains($searchable): bool
Expand Down
26 changes: 24 additions & 2 deletions src/Search/Searchables/Entries.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,19 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

$query->where('status', 'published');

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -48,7 +60,17 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Entry::query()
->where('status', 'published')
->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
16 changes: 16 additions & 0 deletions src/Search/Searchables/Provider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,11 @@

namespace Statamic\Search\Searchables;

use Statamic\Facades\Scope;
use Statamic\Facades\Search;
use Statamic\Search\Index;
use Statamic\Search\ProvidesSearchables;
use Statamic\Support\Arr;

abstract class Provider implements ProvidesSearchables
{
Expand DownExpand Up@@ -55,6 +57,20 @@ protected function usesWildcard()
return in_array('*', $this->keys);
}

protected function applyQueryScope($query)
{
if (! $scope = $this->index->config()['query_scope'] ?? null) {
return;
}

Scope::find($scope)->apply($query, []);
}

protected function hasFilter()
{
return Arr::has($this->index->config(), 'filter');
}

protected function filter()
{
$filter = $this->index->config()['filter'] ?? null;
Expand Down
22 changes: 20 additions & 2 deletions src/Search/Searchables/Terms.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,17 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -49,7 +59,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Term::query()->where('reference', $searchable->reference());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $refs): Collection
Expand Down
27 changes: 24 additions & 3 deletions src/Search/Searchables/Users.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Search\Searchables;

use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Auth\User as UserContract;
use Statamic\Facades\User;

Expand All@@ -18,9 +19,21 @@ public static function referencePrefix(): string
return 'user';
}

public function provide(): Collection
public function provide(): Collection|LazyCollection
{
return User::all()->filter($this->filter())->values();
$query = User::query();

$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -29,7 +42,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = User::query()->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
3 changes: 2 additions & 1 deletion tests/Search/SearchTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ public function it_updates_indexes($updateMock)
{
$index = Mockery::mock(Index::class);
$item = Mockery::mock(Searchable::class);
$item->shouldReceive('getSearchReference')->andReturn('a');

$updateMock($index, $item);

Expand All@@ -37,7 +38,7 @@ public static function saveProvider()
function ($mock, $entry) {
$mock->shouldReceive('shouldIndex')->with($entry)->andReturnTrue();
$mock->shouldReceive('exists')->andReturnTrue();
$mock->shouldReceive('insert')->once()->with($entry);
$mock->shouldReceive('insert')->once()->with($entry->getSearchReference());
},
],

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions config/search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,4 +79,31 @@
'fields' => ['title'],
],

/*
|--------------------------------------------------------------------------
| Indexing Queue
|--------------------------------------------------------------------------
|
| Here you may configure the queue name and connection used when indexing
| documents.
|
*/

'queue' => env('STATAMIC_SEARCH_QUEUE'),

'queue_connection' => env('STATAMIC_SEARCH_QUEUE_CONNECTION'),

/*
|--------------------------------------------------------------------------
| Chunk Size
|--------------------------------------------------------------------------
|
| Here you can configure the chunk size used when indexing documents.
| The higher you make it, the more memory it will use, but the quicker
| the indexing process will be.
|
*/

'chunk_size' => 100,

];
2 changes: 1 addition & 1 deletion src/Search/Algolia/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ public function search($query)
return (new Query($this))->query($query);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
$documents = $documents->map(function ($item, $id) {
$item['objectID'] = $id;
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Comb/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,7 @@ public function delete($document)
$this->save($data);
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
try {
$data = $this->data();
Expand Down
22 changes: 14 additions & 8 deletions src/Search/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@

use Closure;
use Statamic\Contracts\Search\Searchable;
use Statamic\Support\Arr;
use Statamic\Support\Str;

abstract class Index
Expand All@@ -20,7 +19,7 @@ abstract public function delete($document);

abstract public function exists();

abstract protected function insertDocuments(Documents $documents);
abstract public function insertDocuments(Documents $documents);

abstract protected function deleteIndex();

Expand DownExpand Up@@ -84,20 +83,27 @@ public function ensureExists()

public function insert($document)
{
return $this->insertMultiple(Arr::wrap($document));
return $this->insertMultiple(collect($document));
}

public function insertMultiple($documents)
{
$documents = (new Documents($documents))->mapWithKeys(function (Searchable $item) {
return [$item->getSearchReference() => $this->searchables()->fields($item)];
});

$this->insertDocuments($documents);
$documents
->chunk(config('statamic.search.chunk_size'))
->each(fn ($documents) => InsertMultipleJob::dispatch(
name: Str::beforeLast($this->name, '_'),
locale: $this->locale,
documents: $documents
));

return $this;
}

public function fields(Searchable $searchable)
{
return $this->searchables()->fields($searchable);
}

public function shouldIndex($searchable)
{
return $this->searchables()->contains($searchable);
Expand Down
52 changes: 52 additions & 0 deletions src/Search/InsertMultipleJob.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<?php

namespace Statamic\Search;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Queue\Queueable;
use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Search\Searchable;
use Statamic\Facades\Search;
use Statamic\Search\Searchables\Providers;
use Statamic\Support\Str;

class InsertMultipleJob implements ShouldQueue
{
use Queueable;

/**
* Create a new job instance.
*/
public function __construct(
public string $name,
public ?string $locale,
public Collection|LazyCollection $documents,
) {
$this->onConnection($connection = config('statamic.search.queue_connection', config('queue.default')));
$this->onQueue(config('statamic.search.queue', config("queue.connections.{$connection}.queue")));
}

/**
* Execute the job.
*/
public function handle(): void
{
$providers = app(Providers::class);
$index = Search::index($this->name, $this->locale);

$documents = $this->documents
->groupBy(fn ($document) => explode('::', $document)[0])
->flatMap(function ($documents, $prefix) use ($providers) {
return $providers
->getByPrefix($prefix)
->find($documents->map(fn ($reference) => Str::after($reference, '::'))->all())
->all();
})
->mapWithKeys(function (Searchable $item) use ($index) {
return [$item->getSearchReference() => $index->fields($item)];
});

$index->insertDocuments(new Documents($documents));
}
}
2 changes: 1 addition & 1 deletion src/Search/Null/NullIndex.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ public function exists()
return true;
}

protected function insertDocuments(Documents $documents)
public function insertDocuments(Documents $documents)
{
//
}
Expand Down
2 changes: 1 addition & 1 deletion src/Search/Search.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,7 +51,7 @@ public function updateWithinIndexes(Searchable $searchable)
$exists = $index->exists();

if ($shouldIndex && $exists) {
$index->insert($searchable);
$index->insert($searchable->getSearchReference());
} elseif ($shouldIndex && ! $exists) {
$index->update();
} elseif ($exists) {
Expand Down
4 changes: 3 additions & 1 deletion src/Search/Searchables/Assets.php
Comment thread
jasonvarga marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ public function provide(): Collection
: AssetCollection::make($this->keys)
->flatMap(fn ($key) => Asset::whereContainer($key));

return $assets->filter($this->filter())->values();
// TODO: query scope support?

return $assets->filter($this->filter())->values()->map->reference();
}

public function contains($searchable): bool
Expand Down
26 changes: 24 additions & 2 deletions src/Search/Searchables/Entries.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,19 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

$query->where('status', 'published');

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -48,7 +60,17 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Entry::query()
->where('status', 'published')
->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
16 changes: 16 additions & 0 deletions src/Search/Searchables/Provider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,11 @@

namespace Statamic\Search\Searchables;

use Statamic\Facades\Scope;
use Statamic\Facades\Search;
use Statamic\Search\Index;
use Statamic\Search\ProvidesSearchables;
use Statamic\Support\Arr;

abstract class Provider implements ProvidesSearchables
{
Expand DownExpand Up@@ -55,6 +57,20 @@ protected function usesWildcard()
return in_array('*', $this->keys);
}

protected function applyQueryScope($query)
{
if (! $scope = $this->index->config()['query_scope'] ?? null) {
return;
}

Scope::find($scope)->apply($query, []);
}

protected function hasFilter()
{
return Arr::has($this->index->config(), 'filter');
}

protected function filter()
{
$filter = $this->index->config()['filter'] ?? null;
Expand Down
22 changes: 20 additions & 2 deletions src/Search/Searchables/Terms.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,17 @@ public function provide(): Collection|LazyCollection
$query->where('site', $site);
}

return $query->lazy(100)->filter($this->filter())->values();
$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -49,7 +59,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = Term::query()->where('reference', $searchable->reference());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $refs): Collection
Expand Down
27 changes: 24 additions & 3 deletions src/Search/Searchables/Users.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Search\Searchables;

use Illuminate\Support\Collection;
use Illuminate\Support\LazyCollection;
use Statamic\Contracts\Auth\User as UserContract;
use Statamic\Facades\User;

Expand All@@ -18,9 +19,21 @@ public static function referencePrefix(): string
return 'user';
}

public function provide(): Collection
public function provide(): Collection|LazyCollection
{
return User::all()->filter($this->filter())->values();
$query = User::query();

$this->applyQueryScope($query);

if ($this->hasFilter()) {
return $query
->lazy(config('statamic.search.chunk_size'))
->filter($this->filter())
->values()
->map->reference();
}

return $query->pluck('reference');
}

public function contains($searchable): bool
Expand All@@ -29,7 +42,15 @@ public function contains($searchable): bool
return false;
}

return $this->filter()($searchable);
if ($this->hasFilter()) {
return $this->filter()($searchable);
}

$query = User::query()->where('id', $searchable->id());

$this->applyQueryScope($query);

return $query->exists();
}

public function find(array $ids): Collection
Expand Down
3 changes: 2 additions & 1 deletion tests/Search/SearchTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ public function it_updates_indexes($updateMock)
{
$index = Mockery::mock(Index::class);
$item = Mockery::mock(Searchable::class);
$item->shouldReceive('getSearchReference')->andReturn('a');

$updateMock($index, $item);

Expand All@@ -37,7 +38,7 @@ public static function saveProvider()
function ($mock, $entry) {
$mock->shouldReceive('shouldIndex')->with($entry)->andReturnTrue();
$mock->shouldReceive('exists')->andReturnTrue();
$mock->shouldReceive('insert')->once()->with($entry);
$mock->shouldReceive('insert')->once()->with($entry->getSearchReference());
},
],

Expand Down
Loading