2021-06-26 15:23:15 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace BookStack\Actions;
|
2016-05-06 19:33:08 +00:00
|
|
|
|
2022-07-12 19:15:41 +00:00
|
|
|
use BookStack\Auth\Permissions\PermissionApplicator;
|
2020-11-22 00:17:45 +00:00
|
|
|
use BookStack\Entities\Models\Entity;
|
2021-11-06 16:30:20 +00:00
|
|
|
use Illuminate\Database\Eloquent\Builder;
|
2020-06-29 21:11:03 +00:00
|
|
|
use Illuminate\Support\Collection;
|
2021-09-26 14:48:22 +00:00
|
|
|
use Illuminate\Support\Facades\DB;
|
2016-05-06 19:33:08 +00:00
|
|
|
|
2016-05-13 20:20:21 +00:00
|
|
|
class TagRepo
|
2016-05-06 19:33:08 +00:00
|
|
|
{
|
2022-07-12 19:15:41 +00:00
|
|
|
protected PermissionApplicator $permissions;
|
2016-05-06 19:33:08 +00:00
|
|
|
|
2022-07-12 19:15:41 +00:00
|
|
|
public function __construct(PermissionApplicator $permissions)
|
2021-11-06 16:30:20 +00:00
|
|
|
{
|
2022-07-12 19:15:41 +00:00
|
|
|
$this->permissions = $permissions;
|
2021-11-06 16:30:20 +00:00
|
|
|
}
|
|
|
|
|
2016-05-06 19:33:08 +00:00
|
|
|
/**
|
2021-11-06 16:30:20 +00:00
|
|
|
* Start a query against all tags in the system.
|
2016-05-06 19:33:08 +00:00
|
|
|
*/
|
2021-11-06 16:30:20 +00:00
|
|
|
public function queryWithTotals(string $searchTerm, string $nameFilter): Builder
|
2016-05-06 19:33:08 +00:00
|
|
|
{
|
2021-11-06 16:30:20 +00:00
|
|
|
$query = Tag::query()
|
|
|
|
->select([
|
|
|
|
'name',
|
|
|
|
($searchTerm || $nameFilter) ? 'value' : DB::raw('COUNT(distinct value) as `values`'),
|
|
|
|
DB::raw('COUNT(id) as usages'),
|
2022-05-16 13:05:21 +00:00
|
|
|
DB::raw('SUM(IF(entity_type = \'page\', 1, 0)) as page_count'),
|
|
|
|
DB::raw('SUM(IF(entity_type = \'chapter\', 1, 0)) as chapter_count'),
|
|
|
|
DB::raw('SUM(IF(entity_type = \'book\', 1, 0)) as book_count'),
|
|
|
|
DB::raw('SUM(IF(entity_type = \'bookshelf\', 1, 0)) as shelf_count'),
|
2021-11-06 16:30:20 +00:00
|
|
|
])
|
2021-11-15 19:00:37 +00:00
|
|
|
->orderBy($nameFilter ? 'value' : 'name');
|
2021-11-06 16:30:20 +00:00
|
|
|
|
|
|
|
if ($nameFilter) {
|
|
|
|
$query->where('name', '=', $nameFilter);
|
2021-11-15 19:00:37 +00:00
|
|
|
$query->groupBy('value');
|
2021-11-16 12:29:50 +00:00
|
|
|
} elseif ($searchTerm) {
|
2021-11-15 19:00:37 +00:00
|
|
|
$query->groupBy('name', 'value');
|
|
|
|
} else {
|
|
|
|
$query->groupBy('name');
|
2021-11-06 16:30:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if ($searchTerm) {
|
2021-11-06 22:00:33 +00:00
|
|
|
$query->where(function (Builder $query) use ($searchTerm) {
|
2021-11-06 16:30:20 +00:00
|
|
|
$query->where('name', 'like', '%' . $searchTerm . '%')
|
|
|
|
->orWhere('value', 'like', '%' . $searchTerm . '%');
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2022-07-12 19:15:41 +00:00
|
|
|
return $this->permissions->filterRestrictedEntityRelations($query, 'tags', 'entity_id', 'entity_type');
|
2016-05-06 19:33:08 +00:00
|
|
|
}
|
|
|
|
|
2016-05-07 13:29:43 +00:00
|
|
|
/**
|
2016-05-13 20:20:21 +00:00
|
|
|
* Get tag name suggestions from scanning existing tag names.
|
2016-06-04 14:37:28 +00:00
|
|
|
* If no search term is given the 50 most popular tag names are provided.
|
2016-05-07 13:29:43 +00:00
|
|
|
*/
|
2020-06-29 21:11:03 +00:00
|
|
|
public function getNameSuggestions(?string $searchTerm): Collection
|
2016-05-07 13:29:43 +00:00
|
|
|
{
|
2021-11-06 16:30:20 +00:00
|
|
|
$query = Tag::query()
|
2021-03-14 19:52:07 +00:00
|
|
|
->select('*', DB::raw('count(*) as count'))
|
|
|
|
->groupBy('name');
|
2016-06-04 14:37:28 +00:00
|
|
|
|
|
|
|
if ($searchTerm) {
|
|
|
|
$query = $query->where('name', 'LIKE', $searchTerm . '%')->orderBy('name', 'desc');
|
|
|
|
} else {
|
|
|
|
$query = $query->orderBy('count', 'desc')->take(50);
|
|
|
|
}
|
|
|
|
|
2022-07-12 19:15:41 +00:00
|
|
|
$query = $this->permissions->filterRestrictedEntityRelations($query, 'tags', 'entity_id', 'entity_type');
|
2021-06-26 15:23:15 +00:00
|
|
|
|
2016-05-07 13:29:43 +00:00
|
|
|
return $query->get(['name'])->pluck('name');
|
|
|
|
}
|
|
|
|
|
2016-05-15 19:12:53 +00:00
|
|
|
/**
|
|
|
|
* Get tag value suggestions from scanning existing tag values.
|
2016-06-04 14:37:28 +00:00
|
|
|
* If no search is given the 50 most popular values are provided.
|
|
|
|
* Passing a tagName will only find values for a tags with a particular name.
|
2016-05-15 19:12:53 +00:00
|
|
|
*/
|
2020-06-29 21:11:03 +00:00
|
|
|
public function getValueSuggestions(?string $searchTerm, ?string $tagName): Collection
|
2016-05-15 19:12:53 +00:00
|
|
|
{
|
2021-11-06 16:30:20 +00:00
|
|
|
$query = Tag::query()
|
2021-03-14 19:52:07 +00:00
|
|
|
->select('*', DB::raw('count(*) as count'))
|
|
|
|
->groupBy('value');
|
2016-06-04 14:37:28 +00:00
|
|
|
|
|
|
|
if ($searchTerm) {
|
|
|
|
$query = $query->where('value', 'LIKE', $searchTerm . '%')->orderBy('value', 'desc');
|
|
|
|
} else {
|
|
|
|
$query = $query->orderBy('count', 'desc')->take(50);
|
2016-06-04 13:54:31 +00:00
|
|
|
}
|
2016-06-04 14:37:28 +00:00
|
|
|
|
2020-06-29 21:11:03 +00:00
|
|
|
if ($tagName) {
|
2018-01-28 16:58:52 +00:00
|
|
|
$query = $query->where('name', '=', $tagName);
|
|
|
|
}
|
2016-06-04 14:37:28 +00:00
|
|
|
|
2022-07-12 19:15:41 +00:00
|
|
|
$query = $this->permissions->filterRestrictedEntityRelations($query, 'tags', 'entity_id', 'entity_type');
|
2021-06-26 15:23:15 +00:00
|
|
|
|
2016-05-15 19:12:53 +00:00
|
|
|
return $query->get(['value'])->pluck('value');
|
|
|
|
}
|
2016-06-04 14:37:28 +00:00
|
|
|
|
2016-05-07 13:29:43 +00:00
|
|
|
/**
|
2021-06-26 15:23:15 +00:00
|
|
|
* Save an array of tags to an entity.
|
2016-05-07 13:29:43 +00:00
|
|
|
*/
|
2020-06-29 21:11:03 +00:00
|
|
|
public function saveTagsToEntity(Entity $entity, array $tags = []): iterable
|
2016-05-07 13:29:43 +00:00
|
|
|
{
|
2016-05-13 20:20:21 +00:00
|
|
|
$entity->tags()->delete();
|
2020-05-22 23:28:41 +00:00
|
|
|
|
2020-06-29 21:11:03 +00:00
|
|
|
$newTags = collect($tags)->filter(function ($tag) {
|
|
|
|
return boolval(trim($tag['name']));
|
|
|
|
})->map(function ($tag) {
|
|
|
|
return $this->newInstanceFromInput($tag);
|
|
|
|
})->all();
|
2016-05-07 13:29:43 +00:00
|
|
|
|
2016-05-13 20:20:21 +00:00
|
|
|
return $entity->tags()->saveMany($newTags);
|
2016-05-07 13:29:43 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-05-13 20:20:21 +00:00
|
|
|
* Create a new Tag instance from user input.
|
2020-06-29 21:11:03 +00:00
|
|
|
* Input must be an array with a 'name' and an optional 'value' key.
|
2016-05-07 13:29:43 +00:00
|
|
|
*/
|
2020-06-29 21:11:03 +00:00
|
|
|
protected function newInstanceFromInput(array $input): Tag
|
2016-05-07 13:29:43 +00:00
|
|
|
{
|
2021-11-06 16:30:20 +00:00
|
|
|
return new Tag([
|
|
|
|
'name' => trim($input['name']),
|
|
|
|
'value' => trim($input['value'] ?? ''),
|
|
|
|
]);
|
2016-05-07 13:29:43 +00:00
|
|
|
}
|
2018-01-28 16:58:52 +00:00
|
|
|
}
|