113 lines
3.4 KiB
PHP
113 lines
3.4 KiB
PHP
<?php namespace BookStack\Actions;
|
|
|
|
use BookStack\Auth\Permissions\PermissionService;
|
|
use BookStack\Entities\Entity;
|
|
use BookStack\Entities\EntityProvider;
|
|
use Illuminate\Support\Collection;
|
|
|
|
class ViewService
|
|
{
|
|
protected $view;
|
|
protected $permissionService;
|
|
protected $entityProvider;
|
|
|
|
/**
|
|
* ViewService constructor.
|
|
* @param \BookStack\Actions\View $view
|
|
* @param \BookStack\Auth\Permissions\PermissionService $permissionService
|
|
* @param EntityProvider $entityProvider
|
|
*/
|
|
public function __construct(View $view, PermissionService $permissionService, EntityProvider $entityProvider)
|
|
{
|
|
$this->view = $view;
|
|
$this->permissionService = $permissionService;
|
|
$this->entityProvider = $entityProvider;
|
|
}
|
|
|
|
/**
|
|
* Add a view to the given entity.
|
|
* @param Entity $entity
|
|
* @return int
|
|
*/
|
|
public function add(Entity $entity)
|
|
{
|
|
$user = user();
|
|
if ($user === null || $user->isDefault()) {
|
|
return 0;
|
|
}
|
|
$view = $entity->views()->where('user_id', '=', $user->id)->first();
|
|
// Add view if model exists
|
|
if ($view) {
|
|
$view->increment('views');
|
|
return $view->views;
|
|
}
|
|
|
|
// Otherwise create new view count
|
|
$entity->views()->save($this->view->create([
|
|
'user_id' => $user->id,
|
|
'views' => 1
|
|
]));
|
|
|
|
return 1;
|
|
}
|
|
|
|
/**
|
|
* Get the entities with the most views.
|
|
* @param int $count
|
|
* @param int $page
|
|
* @param string|array $filterModels
|
|
* @param string $action - used for permission checking
|
|
* @return Collection
|
|
*/
|
|
public function getPopular(int $count = 10, int $page = 0, $filterModels = null, string $action = 'view')
|
|
{
|
|
$skipCount = $count * $page;
|
|
$query = $this->permissionService
|
|
->filterRestrictedEntityRelations($this->view, 'views', 'viewable_id', 'viewable_type', $action)
|
|
->select('*', 'viewable_id', 'viewable_type', \DB::raw('SUM(views) as view_count'))
|
|
->groupBy('viewable_id', 'viewable_type')
|
|
->orderBy('view_count', 'desc');
|
|
|
|
if ($filterModels) {
|
|
$query->whereIn('viewable_type', $this->entityProvider->getMorphClasses($filterModels));
|
|
}
|
|
|
|
return $query->with('viewable')->skip($skipCount)->take($count)->get()->pluck('viewable');
|
|
}
|
|
|
|
/**
|
|
* Get all recently viewed entities for the current user.
|
|
* @param int $count
|
|
* @param int $page
|
|
* @param Entity|bool $filterModel
|
|
* @return mixed
|
|
*/
|
|
public function getUserRecentlyViewed($count = 10, $page = 0, $filterModel = false)
|
|
{
|
|
$user = user();
|
|
if ($user === null || $user->isDefault()) {
|
|
return collect();
|
|
}
|
|
|
|
$query = $this->permissionService
|
|
->filterRestrictedEntityRelations($this->view, 'views', 'viewable_id', 'viewable_type');
|
|
|
|
if ($filterModel) {
|
|
$query = $query->where('viewable_type', '=', $filterModel->getMorphClass());
|
|
}
|
|
$query = $query->where('user_id', '=', $user->id);
|
|
|
|
$viewables = $query->with('viewable')->orderBy('updated_at', 'desc')
|
|
->skip($count * $page)->take($count)->get()->pluck('viewable');
|
|
return $viewables;
|
|
}
|
|
|
|
/**
|
|
* Reset all view counts by deleting all views.
|
|
*/
|
|
public function resetAll()
|
|
{
|
|
$this->view->truncate();
|
|
}
|
|
}
|