Notifications: Updated watch control to show parent status

app/Activity/Controllers/WatchController.php

@@ -3,7 +3,7 @@
 namespace BookStack\Activity\Controllers;
 
 use BookStack\Activity\Models\Watch;
-use BookStack\Activity\Tools\UserWatchOptions;
+use BookStack\Activity\Tools\UserEntityWatchOptions;
 use BookStack\App\Model;
 use BookStack\Entities\Models\Entity;
 use BookStack\Http\Controller;
@@ -20,8 +20,8 @@ class WatchController extends Controller
         ]);
 
         $watchable = $this->getValidatedModelFromRequest($request);
-        $watchOptions = new UserWatchOptions(user());
-        $watchOptions->updateEntityWatchLevel($watchable, $requestData['level']);
+        $watchOptions = new UserEntityWatchOptions(user(), $watchable);
+        $watchOptions->updateWatchLevel($requestData['level']);
 
         $this->showSuccessNotification(trans('activities.watch_update_level_notification'));
 

app/Activity/Tools/UserEntityWatchOptions.php

@@ -0,0 +1,124 @@
+<?php
+
+namespace BookStack\Activity\Tools;
+
+use BookStack\Activity\Models\Watch;
+use BookStack\Activity\WatchLevels;
+use BookStack\Entities\Models\BookChild;
+use BookStack\Entities\Models\Entity;
+use BookStack\Entities\Models\Page;
+use BookStack\Users\Models\User;
+use Illuminate\Database\Eloquent\Builder;
+
+class UserEntityWatchOptions
+{
+    protected ?array $watchMap = null;
+
+    public function __construct(
+        protected User $user,
+        protected Entity $entity,
+    ) {
+    }
+
+    public function canWatch(): bool
+    {
+        return $this->user->can('receive-notifications') && !$this->user->isDefault();
+    }
+
+    public function getWatchLevel(): string
+    {
+        return WatchLevels::levelValueToName($this->getWatchLevelValue());
+    }
+
+    public function isWatching(): bool
+    {
+        return $this->getWatchLevelValue() !== WatchLevels::DEFAULT;
+    }
+
+    public function getWatchedParent(): ?WatchedParentDetails
+    {
+        $watchMap = $this->getWatchMap();
+        unset($watchMap[$this->entity->getMorphClass()]);
+
+        if (isset($watchMap['chapter'])) {
+            return new WatchedParentDetails('chapter', $watchMap['chapter']);
+        }
+
+        if (isset($watchMap['book'])) {
+            return new WatchedParentDetails('book', $watchMap['book']);
+        }
+
+        return null;
+    }
+
+    public function updateWatchLevel(string $level): void
+    {
+        $levelValue = WatchLevels::levelNameToValue($level);
+        if ($levelValue < 0) {
+            $this->remove();
+            return;
+        }
+
+        $this->updateLevel($levelValue);
+    }
+
+    public function getWatchMap(): array
+    {
+        if (!is_null($this->watchMap)) {
+            return $this->watchMap;
+        }
+
+        $entities = [$this->entity];
+        if ($this->entity instanceof BookChild) {
+            $entities[] = $this->entity->book;
+        }
+        if ($this->entity instanceof Page && $this->entity->chapter) {
+            $entities[] = $this->entity->chapter;
+        }
+
+        $query = Watch::query()->where(function (Builder $subQuery) use ($entities) {
+            foreach ($entities as $entity) {
+                $subQuery->orWhere(function (Builder $whereQuery) use ($entity) {
+                    $whereQuery->where('watchable_type', '=', $entity->getMorphClass())
+                        ->where('watchable_id', '=', $entity->id);
+                });
+            }
+        });
+
+        $this->watchMap = $query->get(['watchable_type', 'level'])
+            ->pluck('level', 'watchable_type')
+            ->toArray();
+
+        return $this->watchMap;
+    }
+
+    protected function getWatchLevelValue()
+    {
+        return $this->getWatchMap()[$this->entity->getMorphClass()] ?? WatchLevels::DEFAULT;
+    }
+
+    protected function updateLevel(int $levelValue): void
+    {
+        Watch::query()->updateOrCreate([
+            'watchable_id' => $this->entity->id,
+            'watchable_type' => $this->entity->getMorphClass(),
+            'user_id' => $this->user->id,
+        ], [
+            'level' => $levelValue,
+        ]);
+        $this->watchMap = null;
+    }
+
+    protected function remove(): void
+    {
+        $this->entityQuery()->delete();
+        $this->watchMap = null;
+    }
+
+    protected function entityQuery(): Builder
+    {
+        return Watch::query()->where('watchable_id', '=', $this->entity->id)
+            ->where('watchable_type', '=', $this->entity->getMorphClass())
+            ->where('user_id', '=', $this->user->id);
+    }
+}

app/Activity/Tools/UserWatchOptions.php

@@ -1,67 +0,0 @@
-<?php
-
-namespace BookStack\Activity\Tools;
-
-use BookStack\Activity\Models\Watch;
-use BookStack\Activity\WatchLevels;
-use BookStack\Entities\Models\Entity;
-use BookStack\Users\Models\User;
-use Illuminate\Database\Eloquent\Builder;
-
-class UserWatchOptions
-{
-    public function __construct(
-        protected User $user,
-    ) {
-    }
-
-    public function canWatch(): bool
-    {
-        return $this->user->can('receive-notifications') && !$this->user->isDefault();
-    }
-
-    public function getEntityWatchLevel(Entity $entity): string
-    {
-        $levelValue = $this->entityQuery($entity)->first(['level'])->level ?? -1;
-        return WatchLevels::levelValueToName($levelValue);
-    }
-
-    public function isWatching(Entity $entity): bool
-    {
-        return $this->entityQuery($entity)->exists();
-    }
-
-    public function updateEntityWatchLevel(Entity $entity, string $level): void
-    {
-        $levelValue = WatchLevels::levelNameToValue($level);
-        if ($levelValue < 0) {
-            $this->removeForEntity($entity);
-            return;
-        }
-
-        $this->updateForEntity($entity, $levelValue);
-    }
-
-    protected function updateForEntity(Entity $entity, int $levelValue): void
-    {
-        Watch::query()->updateOrCreate([
-            'watchable_id' => $entity->id,
-            'watchable_type' => $entity->getMorphClass(),
-            'user_id' => $this->user->id,
-        ], [
-            'level' => $levelValue,
-        ]);
-    }
-
-    protected function removeForEntity(Entity $entity): void
-    {
-        $this->entityQuery($entity)->delete();
-    }
-
-    protected function entityQuery(Entity $entity): Builder
-    {
-        return Watch::query()->where('watchable_id', '=', $entity->id)
-            ->where('watchable_type', '=', $entity->getMorphClass())
-            ->where('user_id', '=', $this->user->id);
-    }
-}

app/Activity/Tools/WatchedParentDetails.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace BookStack\Activity\Tools;
+
+use BookStack\Activity\WatchLevels;
+
+class WatchedParentDetails
+{
+    public function __construct(
+        public string $type,
+        public int $level,
+    ) {
+    }
+
+    public function ignoring(): bool
+    {
+        return $this->level === WatchLevels::IGNORE;
+    }
+}

app/Entities/Controllers/BookController.php

@@ -5,7 +5,7 @@ namespace BookStack\Entities\Controllers;
 use BookStack\Activity\ActivityQueries;
 use BookStack\Activity\ActivityType;
 use BookStack\Activity\Models\View;
-use BookStack\Activity\Tools\UserWatchOptions;
+use BookStack\Activity\Tools\UserEntityWatchOptions;
 use BookStack\Entities\Models\Bookshelf;
 use BookStack\Entities\Repos\BookRepo;
 use BookStack\Entities\Tools\BookContents;
@@ -139,7 +139,7 @@ class BookController extends Controller
             'current'           => $book,
             'bookChildren'      => $bookChildren,
             'bookParentShelves' => $bookParentShelves,
-            'watchOptions'      => new UserWatchOptions(user()),
+            'watchOptions'      => new UserEntityWatchOptions(user(), $book),
             'activity'          => $activities->entityActivity($book, 20, 1),
             'referenceCount'    => $this->referenceFetcher->getPageReferenceCountToEntity($book),
         ]);

app/Entities/Controllers/ChapterController.php

@@ -3,7 +3,7 @@
 namespace BookStack\Entities\Controllers;
 
 use BookStack\Activity\Models\View;
-use BookStack\Activity\Tools\UserWatchOptions;
+use BookStack\Activity\Tools\UserEntityWatchOptions;
 use BookStack\Entities\Models\Book;
 use BookStack\Entities\Repos\ChapterRepo;
 use BookStack\Entities\Tools\BookContents;
@@ -82,7 +82,7 @@ class ChapterController extends Controller
             'chapter'        => $chapter,
             'current'        => $chapter,
             'sidebarTree'    => $sidebarTree,
-            'watchOptions'   => new UserWatchOptions(user()),
+            'watchOptions'   => new UserEntityWatchOptions(user(), $chapter),
             'pages'          => $pages,
             'next'           => $nextPreviousLocator->getNext(),
             'previous'       => $nextPreviousLocator->getPrevious(),

app/Entities/Controllers/PageController.php

@@ -4,7 +4,7 @@ namespace BookStack\Entities\Controllers;
 
 use BookStack\Activity\Models\View;
 use BookStack\Activity\Tools\CommentTree;
-use BookStack\Activity\Tools\UserWatchOptions;
+use BookStack\Activity\Tools\UserEntityWatchOptions;
 use BookStack\Entities\Models\Page;
 use BookStack\Entities\Repos\PageRepo;
 use BookStack\Entities\Tools\BookContents;
@@ -152,7 +152,7 @@ class PageController extends Controller
             'sidebarTree'     => $sidebarTree,
             'commentTree'     => $commentTree,
             'pageNav'         => $pageNav,
-            'watchOptions'    => new UserWatchOptions(user()),
+            'watchOptions'    => new UserEntityWatchOptions(user(), $page),
             'next'            => $nextPreviousLocator->getNext(),
             'previous'        => $nextPreviousLocator->getPrevious(),
             'referenceCount'  => $this->referenceFetcher->getPageReferenceCountToEntity($page),