BookStack Code Mirror - bookstack/blob - app/Actions/ActivityQueries.php

   1 <?php
   2
   3 namespace BookStack\Actions;
   4
   5 use BookStack\Auth\Permissions\PermissionApplicator;
   6 use BookStack\Auth\User;
   7 use BookStack\Entities\Models\Book;
   8 use BookStack\Entities\Models\Chapter;
   9 use BookStack\Entities\Models\Entity;
  10 use BookStack\Entities\Models\Page;
  11 use Illuminate\Database\Eloquent\Builder;
  12 use Illuminate\Database\Eloquent\Relations\Relation;
  13
  14 class ActivityQueries
  15 {
  16     protected PermissionApplicator $permissions;
  17
  18     protected array $fieldsForLists = ['id', 'type', 'detail', 'activities.entity_type', 'activities.entity_id', 'user_id', 'created_at'];
  19
  20     public function __construct(PermissionApplicator $permissions)
  21     {
  22         $this->permissions = $permissions;
  23     }
  24
  25     /**
  26      * Gets the latest activity.
  27      */
  28     public function latest(int $count = 20, int $page = 0): array
  29     {
  30         $query = Activity::query()->select($this->fieldsForLists);
  31         $activityList = $this->permissions
  32             ->restrictEntityRelationQuery($query, 'activities', 'entity_id', 'entity_type')
  33             ->orderBy('created_at', 'desc')
  34             ->with(['user', 'entity'])
  35             ->skip($count * $page)
  36             ->take($count)
  37             ->get();
  38
  39         return $this->filterSimilar($activityList);
  40     }
  41
  42     /**
  43      * Gets the latest activity for an entity, Filtering out similar
  44      * items to prevent a message activity list.
  45      */
  46     public function entityActivity(Entity $entity, int $count = 20, int $page = 1): array
  47     {
  48         /** @var array<string, int[]> $queryIds */
  49         $queryIds = [$entity->getMorphClass() => [$entity->id]];
  50
  51         if ($entity instanceof Book) {
  52             $queryIds[(new Chapter())->getMorphClass()] = $entity->chapters()->scopes('visible')->pluck('id');
  53         }
  54         if ($entity instanceof Book || $entity instanceof Chapter) {
  55             $queryIds[(new Page())->getMorphClass()] = $entity->pages()->scopes('visible')->pluck('id');
  56         }
  57
  58         $query = Activity::query();
  59         $query->where(function (Builder $query) use ($queryIds) {
  60             foreach ($queryIds as $morphClass => $idArr) {
  61                 $query->orWhere(function (Builder $innerQuery) use ($morphClass, $idArr) {
  62                     $innerQuery->where('entity_type', '=', $morphClass)
  63                         ->whereIn('entity_id', $idArr);
  64                 });
  65             }
  66         });
  67
  68         $activity = $query->orderBy('created_at', 'desc')
  69             ->with(['entity' => function (Relation $query) {
  70                 $query->withTrashed();
  71             }, 'user.avatar'])
  72             ->skip($count * ($page - 1))
  73             ->take($count)
  74             ->get();
  75
  76         return $this->filterSimilar($activity);
  77     }
  78
  79     /**
  80      * Get the latest activity for a user, Filtering out similar items.
  81      */
  82     public function userActivity(User $user, int $count = 20, int $page = 0): array
  83     {
  84         $query = Activity::query()->select($this->fieldsForLists);
  85         $activityList = $this->permissions
  86             ->restrictEntityRelationQuery($query, 'activities', 'entity_id', 'entity_type')
  87             ->orderBy('created_at', 'desc')
  88             ->where('user_id', '=', $user->id)
  89             ->skip($count * $page)
  90             ->take($count)
  91             ->get();
  92
  93         return $this->filterSimilar($activityList);
  94     }
  95
  96     /**
  97      * Filters out similar activity.
  98      *
  99      * @param Activity[] $activities
 100      */
 101     protected function filterSimilar(iterable $activities): array
 102     {
 103         $newActivity = [];
 104         $previousItem = null;
 105
 106         foreach ($activities as $activityItem) {
 107             if (!$previousItem || !$activityItem->isSimilarTo($previousItem)) {
 108                 $newActivity[] = $activityItem;
 109             }
 110
 111             $previousItem = $activityItem;
 112         }
 113
 114         return $newActivity;
 115     }
 116 }