2015-09-10 18:31:09 +00:00
|
|
|
<?php namespace BookStack\Services;
|
2015-08-16 17:59:23 +00:00
|
|
|
|
2015-09-10 18:31:09 +00:00
|
|
|
use BookStack\Activity;
|
|
|
|
use BookStack\Entity;
|
2015-08-29 15:00:19 +00:00
|
|
|
use Session;
|
2015-08-16 17:59:23 +00:00
|
|
|
|
|
|
|
class ActivityService
|
|
|
|
{
|
|
|
|
protected $activity;
|
|
|
|
protected $user;
|
2016-02-28 19:03:04 +00:00
|
|
|
protected $restrictionService;
|
2015-08-16 17:59:23 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* ActivityService constructor.
|
2016-02-28 19:03:04 +00:00
|
|
|
* @param Activity $activity
|
|
|
|
* @param RestrictionService $restrictionService
|
2015-08-16 17:59:23 +00:00
|
|
|
*/
|
2016-02-28 19:03:04 +00:00
|
|
|
public function __construct(Activity $activity, RestrictionService $restrictionService)
|
2015-08-16 17:59:23 +00:00
|
|
|
{
|
|
|
|
$this->activity = $activity;
|
2016-02-28 19:03:04 +00:00
|
|
|
$this->restrictionService = $restrictionService;
|
2015-11-21 17:22:14 +00:00
|
|
|
$this->user = auth()->user();
|
2015-08-16 17:59:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Add activity data to database.
|
2015-08-23 13:20:34 +00:00
|
|
|
* @param Entity $entity
|
2015-08-30 10:47:58 +00:00
|
|
|
* @param $activityKey
|
2016-03-06 13:17:46 +00:00
|
|
|
* @param int $bookId
|
|
|
|
* @param bool $extra
|
2015-08-16 17:59:23 +00:00
|
|
|
*/
|
|
|
|
public function add(Entity $entity, $activityKey, $bookId = 0, $extra = false)
|
|
|
|
{
|
2016-02-18 19:32:07 +00:00
|
|
|
$activity = $this->activity->newInstance();
|
|
|
|
$activity->user_id = $this->user->id;
|
|
|
|
$activity->book_id = $bookId;
|
|
|
|
$activity->key = strtolower($activityKey);
|
2015-08-30 10:47:58 +00:00
|
|
|
if ($extra !== false) {
|
2016-02-18 19:32:07 +00:00
|
|
|
$activity->extra = $extra;
|
2015-08-16 17:59:23 +00:00
|
|
|
}
|
2016-02-18 19:32:07 +00:00
|
|
|
$entity->activity()->save($activity);
|
2015-08-29 15:00:19 +00:00
|
|
|
$this->setNotification($activityKey);
|
2015-08-16 17:59:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-02-18 19:32:07 +00:00
|
|
|
* Adds a activity history with a message & without binding to a entity.
|
2015-08-30 10:47:58 +00:00
|
|
|
* @param $activityKey
|
2016-03-06 13:17:46 +00:00
|
|
|
* @param int $bookId
|
2015-08-16 17:59:23 +00:00
|
|
|
* @param bool|false $extra
|
|
|
|
*/
|
|
|
|
public function addMessage($activityKey, $bookId = 0, $extra = false)
|
|
|
|
{
|
|
|
|
$this->activity->user_id = $this->user->id;
|
|
|
|
$this->activity->book_id = $bookId;
|
|
|
|
$this->activity->key = strtolower($activityKey);
|
2015-08-30 10:47:58 +00:00
|
|
|
if ($extra !== false) {
|
2015-08-16 17:59:23 +00:00
|
|
|
$this->activity->extra = $extra;
|
|
|
|
}
|
|
|
|
$this->activity->save();
|
2015-08-29 15:00:19 +00:00
|
|
|
$this->setNotification($activityKey);
|
2015-08-16 17:59:23 +00:00
|
|
|
}
|
|
|
|
|
2015-08-29 15:00:19 +00:00
|
|
|
|
2015-08-23 13:20:34 +00:00
|
|
|
/**
|
|
|
|
* Removes the entity attachment from each of its activities
|
|
|
|
* and instead uses the 'extra' field with the entities name.
|
|
|
|
* Used when an entity is deleted.
|
|
|
|
* @param Entity $entity
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function removeEntity(Entity $entity)
|
|
|
|
{
|
|
|
|
$activities = $entity->activity;
|
2015-08-30 10:47:58 +00:00
|
|
|
foreach ($activities as $activity) {
|
2015-08-23 13:20:34 +00:00
|
|
|
$activity->extra = $entity->name;
|
|
|
|
$activity->entity_id = 0;
|
|
|
|
$activity->entity_type = null;
|
|
|
|
$activity->save();
|
|
|
|
}
|
|
|
|
return $activities;
|
|
|
|
}
|
|
|
|
|
2015-08-16 19:11:21 +00:00
|
|
|
/**
|
|
|
|
* Gets the latest activity.
|
|
|
|
* @param int $count
|
|
|
|
* @param int $page
|
2015-08-30 14:31:16 +00:00
|
|
|
* @return array
|
2015-08-16 19:11:21 +00:00
|
|
|
*/
|
|
|
|
public function latest($count = 20, $page = 0)
|
|
|
|
{
|
2016-03-06 13:17:46 +00:00
|
|
|
$activityList = $this->restrictionService
|
2016-02-28 19:03:04 +00:00
|
|
|
->filterRestrictedEntityRelations($this->activity, 'activities', 'entity_id', 'entity_type')
|
|
|
|
->orderBy('created_at', 'desc')->skip($count * $page)->take($count)->get();
|
|
|
|
|
2015-08-30 14:31:16 +00:00
|
|
|
return $this->filterSimilar($activityList);
|
2015-08-30 10:47:58 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-02-16 21:25:11 +00:00
|
|
|
* Gets the latest activity for an entity, Filtering out similar
|
2015-08-30 10:47:58 +00:00
|
|
|
* items to prevent a message activity list.
|
|
|
|
* @param Entity $entity
|
2016-03-06 13:17:46 +00:00
|
|
|
* @param int $count
|
|
|
|
* @param int $page
|
2015-08-30 10:47:58 +00:00
|
|
|
* @return array
|
|
|
|
*/
|
2016-02-16 21:25:11 +00:00
|
|
|
public function entityActivity($entity, $count = 20, $page = 0)
|
2015-08-30 10:47:58 +00:00
|
|
|
{
|
2016-04-24 15:54:20 +00:00
|
|
|
if ($entity->isA('book')) {
|
|
|
|
$query = $this->activity->where('book_id', '=', $entity->id);
|
|
|
|
} else {
|
|
|
|
$query = $this->activity->where('entity_type', '=', get_class($entity))
|
|
|
|
->where('entity_id', '=', $entity->id);
|
|
|
|
}
|
|
|
|
|
|
|
|
$activity = $this->restrictionService
|
|
|
|
->filterRestrictedEntityRelations($query, 'activities', 'entity_id', 'entity_type')
|
|
|
|
->orderBy('created_at', 'desc')->skip($count * $page)->take($count)->get();
|
2015-08-30 10:47:58 +00:00
|
|
|
|
|
|
|
return $this->filterSimilar($activity);
|
|
|
|
}
|
|
|
|
|
2016-02-16 21:25:11 +00:00
|
|
|
/**
|
|
|
|
* Get latest activity for a user, Filtering out similar
|
|
|
|
* items.
|
|
|
|
* @param $user
|
|
|
|
* @param int $count
|
|
|
|
* @param int $page
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function userActivity($user, $count = 20, $page = 0)
|
|
|
|
{
|
2016-03-06 13:17:46 +00:00
|
|
|
$activityList = $this->restrictionService
|
|
|
|
->filterRestrictedEntityRelations($this->activity, 'activities', 'entity_id', 'entity_type')
|
|
|
|
->orderBy('created_at', 'desc')->where('user_id', '=', $user->id)->skip($count * $page)->take($count)->get();
|
|
|
|
return $this->filterSimilar($activityList);
|
2016-02-16 21:25:11 +00:00
|
|
|
}
|
|
|
|
|
2015-08-30 10:47:58 +00:00
|
|
|
/**
|
2016-01-01 09:03:40 +00:00
|
|
|
* Filters out similar activity.
|
2016-02-16 21:25:11 +00:00
|
|
|
* @param Activity[] $activities
|
2015-08-30 10:47:58 +00:00
|
|
|
* @return array
|
|
|
|
*/
|
2016-02-16 21:25:11 +00:00
|
|
|
protected function filterSimilar($activities)
|
2015-08-30 14:31:16 +00:00
|
|
|
{
|
2015-08-30 10:47:58 +00:00
|
|
|
$newActivity = [];
|
|
|
|
$previousItem = false;
|
2016-02-16 21:25:11 +00:00
|
|
|
foreach ($activities as $activityItem) {
|
2015-08-30 14:31:16 +00:00
|
|
|
if ($previousItem === false) {
|
2015-08-30 10:47:58 +00:00
|
|
|
$previousItem = $activityItem;
|
|
|
|
$newActivity[] = $activityItem;
|
|
|
|
continue;
|
|
|
|
}
|
2015-08-30 14:31:16 +00:00
|
|
|
if (!$activityItem->isSimilarTo($previousItem)) {
|
2015-08-30 10:47:58 +00:00
|
|
|
$newActivity[] = $activityItem;
|
|
|
|
}
|
|
|
|
$previousItem = $activityItem;
|
|
|
|
}
|
|
|
|
return $newActivity;
|
2015-08-16 19:11:21 +00:00
|
|
|
}
|
|
|
|
|
2015-08-29 15:00:19 +00:00
|
|
|
/**
|
|
|
|
* Flashes a notification message to the session if an appropriate message is available.
|
|
|
|
* @param $activityKey
|
|
|
|
*/
|
|
|
|
protected function setNotification($activityKey)
|
|
|
|
{
|
|
|
|
$notificationTextKey = 'activities.' . $activityKey . '_notification';
|
|
|
|
if (trans()->has($notificationTextKey)) {
|
|
|
|
$message = trans($notificationTextKey);
|
|
|
|
Session::flash('success', $message);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-08-16 17:59:23 +00:00
|
|
|
}
|