<?php namespace BookStack\Actions;
use BookStack\Auth\Permissions\PermissionService;
-use BookStack\Entities\Entity;
-use Session;
+use BookStack\Auth\User;
+use BookStack\Entities\Models\Chapter;
+use BookStack\Entities\Models\Entity;
+use BookStack\Entities\Models\Page;
+use BookStack\Interfaces\Loggable;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Relations\Relation;
+use Illuminate\Support\Facades\Log;
class ActivityService
{
protected $activity;
- protected $user;
protected $permissionService;
- /**
- * ActivityService constructor.
- * @param \BookStack\Actions\Activity $activity
- * @param PermissionService $permissionService
- */
public function __construct(Activity $activity, PermissionService $permissionService)
{
$this->activity = $activity;
$this->permissionService = $permissionService;
- $this->user = user();
}
/**
- * Add activity data to database.
- * @param Entity $entity
- * @param $activityKey
- * @param int $bookId
- * @param bool $extra
+ * Add activity data to database for an entity.
*/
- public function add(Entity $entity, $activityKey, $bookId = 0, $extra = false)
+ public function addForEntity(Entity $entity, string $type)
{
- $activity = $this->activity->newInstance();
- $activity->user_id = $this->user->id;
- $activity->book_id = $bookId;
- $activity->key = strtolower($activityKey);
- if ($extra !== false) {
- $activity->extra = $extra;
- }
+ $activity = $this->newActivityForUser($type);
$entity->activity()->save($activity);
- $this->setNotification($activityKey);
+ $this->setNotification($type);
}
/**
- * Adds a activity history with a message & without binding to a entity.
- * @param $activityKey
- * @param int $bookId
- * @param bool|false $extra
+ * Add a generic activity event to the database.
+ * @param string|Loggable $detail
*/
- public function addMessage($activityKey, $bookId = 0, $extra = false)
+ public function add(string $type, $detail = '')
{
- $this->activity->user_id = $this->user->id;
- $this->activity->book_id = $bookId;
- $this->activity->key = strtolower($activityKey);
- if ($extra !== false) {
- $this->activity->extra = $extra;
+ if ($detail instanceof Loggable) {
+ $detail = $detail->logDescriptor();
}
- $this->activity->save();
- $this->setNotification($activityKey);
+
+ $activity = $this->newActivityForUser($type);
+ $activity->detail = $detail;
+ $activity->save();
+ $this->setNotification($type);
}
+ /**
+ * Get a new activity instance for the current user.
+ */
+ protected function newActivityForUser(string $type): Activity
+ {
+ return $this->activity->newInstance()->forceFill([
+ 'type' => strtolower($type),
+ 'user_id' => user()->id,
+ ]);
+ }
/**
* 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;
- foreach ($activities as $activity) {
- $activity->extra = $entity->name;
- $activity->entity_id = 0;
- $activity->entity_type = null;
- $activity->save();
- }
- return $activities;
+ $entity->activity()->update([
+ 'detail' => $entity->name,
+ 'entity_id' => null,
+ 'entity_type' => null,
+ ]);
}
/**
* Gets the latest activity.
- * @param int $count
- * @param int $page
- * @return array
*/
- public function latest($count = 20, $page = 0)
+ public function latest(int $count = 20, int $page = 0): array
{
$activityList = $this->permissionService
->filterRestrictedEntityRelations($this->activity, 'activities', 'entity_id', 'entity_type')
- ->orderBy('created_at', 'desc')->with('user', 'entity')->skip($count * $page)->take($count)->get();
+ ->orderBy('created_at', 'desc')
+ ->with(['user', 'entity'])
+ ->skip($count * $page)
+ ->take($count)
+ ->get();
return $this->filterSimilar($activityList);
}
/**
* Gets the latest activity for an entity, Filtering out similar
* items to prevent a message activity list.
- * @param Entity $entity
- * @param int $count
- * @param int $page
- * @return array
*/
- public function entityActivity($entity, $count = 20, $page = 1)
+ public function entityActivity(Entity $entity, int $count = 20, int $page = 1): array
{
+ /** @var [string => int[]] $queryIds */
+ $queryIds = [$entity->getMorphClass() => [$entity->id]];
+
if ($entity->isA('book')) {
- $query = $this->activity->where('book_id', '=', $entity->id);
- } else {
- $query = $this->activity->where('entity_type', '=', $entity->getMorphClass())
- ->where('entity_id', '=', $entity->id);
+ $queryIds[(new Chapter)->getMorphClass()] = $entity->chapters()->visible()->pluck('id');
}
-
- $activity = $this->permissionService
- ->filterRestrictedEntityRelations($query, 'activities', 'entity_id', 'entity_type')
- ->orderBy('created_at', 'desc')
- ->with(['entity', 'user.avatar'])
+ if ($entity->isA('book') || $entity->isA('chapter')) {
+ $queryIds[(new Page)->getMorphClass()] = $entity->pages()->visible()->pluck('id');
+ }
+
+ $query = $this->activity->newQuery();
+ $query->where(function (Builder $query) use ($queryIds) {
+ foreach ($queryIds as $morphClass => $idArr) {
+ $query->orWhere(function (Builder $innerQuery) use ($morphClass, $idArr) {
+ $innerQuery->where('entity_type', '=', $morphClass)
+ ->whereIn('entity_id', $idArr);
+ });
+ }
+ });
+
+ $activity = $query->orderBy('created_at', 'desc')
+ ->with(['entity' => function (Relation $query) {
+ $query->withTrashed();
+ }, 'user.avatar'])
->skip($count * ($page - 1))
->take($count)
->get();
}
/**
- * Get latest activity for a user, Filtering out similar
- * items.
- * @param $user
- * @param int $count
- * @param int $page
- * @return array
+ * Get latest activity for a user, Filtering out similar items.
*/
- public function userActivity($user, $count = 20, $page = 0)
+ public function userActivity(User $user, int $count = 20, int $page = 0): array
{
$activityList = $this->permissionService
->filterRestrictedEntityRelations($this->activity, 'activities', 'entity_id', 'entity_type')
- ->orderBy('created_at', 'desc')->where('user_id', '=', $user->id)->skip($count * $page)->take($count)->get();
+ ->orderBy('created_at', 'desc')
+ ->where('user_id', '=', $user->id)
+ ->skip($count * $page)
+ ->take($count)
+ ->get();
+
return $this->filterSimilar($activityList);
}
* @param Activity[] $activities
* @return array
*/
- protected function filterSimilar($activities)
+ protected function filterSimilar(iterable $activities): array
{
$newActivity = [];
- $previousItem = false;
+ $previousItem = null;
+
foreach ($activities as $activityItem) {
- if ($previousItem === false) {
- $previousItem = $activityItem;
- $newActivity[] = $activityItem;
- continue;
- }
- if (!$activityItem->isSimilarTo($previousItem)) {
+ if (!$previousItem || !$activityItem->isSimilarTo($previousItem)) {
$newActivity[] = $activityItem;
}
+
$previousItem = $activityItem;
}
+
return $newActivity;
}
/**
* Flashes a notification message to the session if an appropriate message is available.
- * @param $activityKey
*/
- protected function setNotification($activityKey)
+ protected function setNotification(string $type)
{
- $notificationTextKey = 'activities.' . $activityKey . '_notification';
+ $notificationTextKey = 'activities.' . $type . '_notification';
if (trans()->has($notificationTextKey)) {
$message = trans($notificationTextKey);
- Session::flash('success', $message);
+ session()->flash('success', $message);
}
}
+
+ /**
+ * Log out a failed login attempt, Providing the given username
+ * as part of the message if the '%u' string is used.
+ */
+ public function logFailedLogin(string $username)
+ {
+ $message = config('logging.failed_login.message');
+ if (!$message) {
+ return;
+ }
+
+ $message = str_replace("%u", $username, $message);
+ $channel = config('logging.failed_login.channel');
+ Log::channel($channel)->warning($message);
+ }
}
projects / bookstack / blobdiff