%PDF- %PDF-
| Direktori : /home/graphicd/www/vebto/common/Database/Datasource/ |
| Current File : /home/graphicd/www/vebto/common/Database/Datasource/Datasource.php |
<?php
namespace Common\Database\Datasource;
use Common\Database\Datasource\Filters\AlgoliaFilterer;
use Common\Database\Datasource\Filters\ElasticFilterer;
use Common\Database\Datasource\Filters\MeilisearchFilterer;
use Common\Database\Datasource\Filters\MysqlFilterer;
use Common\Database\Datasource\Filters\TntFilterer;
use Common\Search\Searchable;
use Common\Workspaces\ActiveWorkspace;
use Illuminate\Container\Container;
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Query\Builder as QueryBuilder;
use Illuminate\Database\Query\Expression;
use Illuminate\Pagination\LengthAwarePaginator;
use Illuminate\Pagination\Paginator;
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use Illuminate\Support\Str;
use Laravel\Scout\Builder as ScoutBuilder;
use Laravel\Scout\Engines\Engine;
use Matchish\ScoutElasticSearch\Engines\ElasticSearchEngine;
use const App\Providers\WORKSPACED_RESOURCES;
class Datasource
{
/**
* @var EloquentBuilder
*/
private $builder;
/**
* @var Model
*/
private $model;
/**
* @var array
*/
private $params;
private $queryBuilt = false;
/**
* @var DatasourceFilters
*/
private $filters;
/**
* @var array|false
*/
public $order = null;
/**
* @var bool
*/
private $usingDefaultOrder = false;
/**
* @var string
*/
private $filtererName;
/**
* @var ScoutBuilder|null
*/
private $scoutBuilder;
public function __construct(
$model,
array $params,
DatasourceFilters $filters = null,
string $filtererName = 'mysql'
) {
$this->model = $model->getModel();
$this->params = $this->toCamelCase($params);
$this->builder = $model->newQuery();
$this->filters =
$filters ?? new DatasourceFilters($this->params['filters'] ?? null);
$this->filtererName = $filtererName;
}
public function paginate(): LengthAwarePaginator
{
$this->buildQuery();
$perPage = $this->limit();
$page = (int) $this->param('page', 1);
if ($this->scoutBuilder instanceof ScoutBuilder) {
/** @var Engine $engine */
$engine = $this->scoutBuilder->model->searchableUsing();
$rawResults = $engine->paginate(
$this->scoutBuilder,
$perPage,
$page,
);
$modelIds = $engine->mapIds($rawResults)->all();
$objectIdPositions = array_flip($modelIds);
$total = $engine->getTotalCount($rawResults);
$results = $this->builder
->whereIn('id', $modelIds)
->get()
->filter(function ($model) use ($modelIds) {
return in_array($model->getScoutKey(), $modelIds);
});
// if custom sort order was not supplied, order by relevance
if ($this->usingDefaultOrder) {
$results = $results->sortBy(function ($model) use (
$objectIdPositions
) {
return $objectIdPositions[$model->getScoutKey()];
});
}
$results = $results->values();
} else {
$total = $this->builder->toBase()->getCountForPagination();
$results = $total
? $this->builder->forPage($page, $perPage)->get()
: $this->model->newCollection();
}
return Container::getInstance()->makeWith(LengthAwarePaginator::class, [
'items' => $results,
'total' => $total,
'perPage' => $perPage,
'currentPage' => $page,
'options' => [
'path' => Paginator::resolveCurrentPath(),
'pageName' => 'page',
],
]);
}
public function get(): Collection
{
$this->buildQuery();
return $this->builder->limit($this->limit())->get();
}
public function param(string $name, $default = null)
{
return Arr::get($this->params, Str::camel($name)) ?: $default;
}
public function buildQuery(): self
{
if ($this->queryBuilt) {
return $this;
}
$with = array_filter(explode(',', $this->param('with', '')));
$withCount = array_filter(explode(',', $this->param('withCount', '')));
$searchTerm = $this->param('query');
// load specified relations and counts
if (!empty($with)) {
$this->builder->with($with);
}
if (!empty($withCount)) {
$this->builder->withCount($withCount);
}
$this->applyWorkspaceFilter();
$filterer = $this->resolveFilterer($searchTerm);
$this->scoutBuilder = (new $filterer(
$this->builder,
$this->filters,
$searchTerm,
))->apply();
// allow caller class to override order or
// prevent it completely by setting "false"
if ($this->order !== false) {
$order = $this->getOrder();
if (isset($order['col'])) {
$order['col'] =
$order['col'] === 'relevance'
? 'relevance'
: // can't qualify with table name because ordering by relationship count will not work
$order['col'];
$this->builder->orderBy(
Str::snake($order['col']),
$order['dir'] ?? 'desc',
);
}
}
$this->queryBuilt = true;
return $this;
}
private function resolveFilterer(string $searchTerm = null): string
{
$filtererName = $this->filtererName;
if (
!$searchTerm ||
!in_array(Searchable::class, class_uses_recursive($this->model)) ||
$filtererName === 'mysql'
) {
return MysqlFilterer::class;
} elseif ($filtererName === 'meilisearch') {
return MeilisearchFilterer::class;
} elseif ($filtererName === 'tntsearch') {
return TntFilterer::class;
} elseif ($filtererName === 'algolia') {
return AlgoliaFilterer::class;
} else if ($filtererName === ElasticSearchEngine::class) {
return ElasticFilterer::class;
}
}
private function applyWorkspaceFilter(): void
{
if (
!config('common.site.workspaces_integrated') ||
!config('common.site.new_workspace_filter') ||
!in_array(get_class($this->model), WORKSPACED_RESOURCES)
) {
return;
}
// TODO: test if these work after filterer refactor
if ($workspaceId = request()->header(ActiveWorkspace::HEADER)) {
$this->filters->where('workspace_id', '=', $workspaceId);
} elseif ($userId = $this->param('userId')) {
$this->filters
->where('user_id', '=', $userId)
->where('workspace_id', '=', null);
}
}
public function getOrder(): array
{
$defaultOrderDir = 'desc';
$defaultOrderCol = 'updated_at';
if (isset($this->order['col'])) {
$orderCol = $this->order['col'];
$orderDir = $this->order['dir'];
// order might be a single string: "column|direction"
} elseif ($specifiedOrder = $this->param('order')) {
$parts = preg_split('(\||:)', $specifiedOrder);
$orderCol = Arr::get($parts, 0, $defaultOrderCol);
$orderDir = Arr::get($parts, 1, $defaultOrderDir);
// order might be as separate params
} elseif ($this->param('orderBy') || $this->param('orderDir')) {
$orderCol = $this->param('orderBy');
$orderDir = $this->param('orderDir');
// try ordering be relevance, if it's a search query and
// using mysql fulltext, finally default to "updated_at" column
} elseif ($this->hasRelevanceColumn()) {
$orderCol = 'relevance';
$orderDir = 'desc';
} else {
$orderCol = $defaultOrderCol;
$orderDir = $defaultOrderDir;
$this->usingDefaultOrder = true;
}
return [
'col' => $orderCol,
'dir' => $orderDir,
];
}
private function toCamelCase(array $params): array
{
return collect($params)
->keyBy(function ($value, $key) {
return Str::camel($key);
})
->toArray();
}
private function hasRelevanceColumn(): bool
{
return !!Arr::first($this->getQueryBuilder() ?? [], function ($col) {
return $col instanceof Expression &&
Str::endsWith($col->getValue(), 'AS relevance');
});
}
private function limit(): int
{
if ($this->param('perPage')) {
return $this->param('perPage');
} else {
return $this->getQueryBuilder()->limit ?? 15;
}
}
private function getQueryBuilder(): QueryBuilder
{
$query = $this->builder->getQuery();
if ($query instanceof EloquentBuilder) {
$query = $query->getQuery();
}
return $query;
}
}