DB: Got most view queries working for new stucture

Author: ssddanbrown

app/Entities/Models/Bookshelf.php

@@ -13,8 +13,6 @@ class Bookshelf extends Entity implements CoverImageInterface, HtmlDescriptionIn
     use HasFactory;
     use HtmlDescriptionTrait;
 
-    protected $table = 'bookshelves';
-
     public float $searchFactor = 1.2;
 
     protected $fillable = ['name', 'description', 'image_id'];
@@ -24,10 +22,8 @@ class Bookshelf extends Entity implements CoverImageInterface, HtmlDescriptionIn
     /**
      * Get the books in this shelf.
      * Should not be used directly since does not take into account permissions.
-     *
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
      */
-    public function books()
+    public function books(): BelongsToMany
     {
         return $this->belongsToMany(Book::class, 'bookshelves_books', 'bookshelf_id', 'book_id')
             ->withPivot('order')
@@ -105,13 +101,4 @@ public function appendBook(Book $book)
         $maxOrder = $this->books()->max('order');
         $this->books()->attach($book->id, ['order' => $maxOrder + 1]);
     }
-
-    /**
-     * Get a visible shelf by its slug.
-     * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
-     */
-    public static function getBySlug(string $slug): self
-    {
-        return static::visible()->where('slug', '=', $slug)->firstOrFail();
-    }
 }

app/Entities/Models/Entity.php

@@ -77,6 +77,19 @@ abstract class Entity extends Model implements
      */
     public float $searchFactor = 1.0;
 
+    /**
+     * Set the table to be that used by all entities.
+     */
+    protected $table = 'entities';
+
+    /**
+     * Set global scopes to limit queries down to just the right type of entity.
+     */
+    protected static function booted(): void
+    {
+        static::addGlobalScope('entity', new EntityScope());
+    }
+
     /**
      * Get the entities that are visible to the current user.
      */

app/Entities/Models/EntityScope.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace BookStack\Entities\Models;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Scope;
+use Illuminate\Database\Query\JoinClause;
+
+class EntityScope implements Scope
+{
+    /**
+     * Apply the scope to a given Eloquent query builder.
+     */
+    public function apply(Builder $builder, Model $model): void
+    {
+        $builder = $builder->where('type', '=', $model->getMorphClass());
+        if ($model instanceof Page) {
+            $builder->leftJoin('entity_page_data', 'entity_page_data.page_id', '=', 'entities.id');
+        } else {
+            $builder->leftJoin('entity_container_data', function (JoinClause $join) use ($model) {
+                $join->on('entity_container_data.entity_id', '=', 'entities.id')
+                    ->where('entity_container_data.entity_type', '=', $model->getMorphClass());
+            });
+        }
+    }
+}

app/Entities/Queries/ChapterQueries.php

@@ -61,12 +61,14 @@ public function usingSlugs(string $bookSlug, string $chapterSlug): Builder
 
     public function visibleForList(): Builder
     {
+        // TODO - Review this is working as expected
         return $this->start()
             ->scopes('visible')
             ->select(array_merge(static::$listAttributes, ['book_slug' => function ($builder) {
                 $builder->select('slug')
-                    ->from('books')
-                    ->whereColumn('books.id', '=', 'chapters.book_id');
+                    ->from('entities as books')
+                    ->where('type', '=', 'book')
+                    ->whereColumn('books.id', '=', 'entities.book_id');
             }]));
     }
 }

app/Entities/Queries/PageQueries.php

@@ -112,10 +112,12 @@ public function visibleTemplates(): Builder
 
     protected function mergeBookSlugForSelect(array $columns): array
     {
+        // TODO - Review this is working as expected
         return array_merge($columns, ['book_slug' => function ($builder) {
             $builder->select('slug')
-                ->from('books')
-                ->whereColumn('books.id', '=', 'pages.book_id');
+                ->from('entities as books')
+                ->where('type', '=', 'book')
+                ->whereColumn('books.id', '=', 'entities.book_id');
         }]);
     }
 }

app/Permissions/PermissionApplicator.php

@@ -40,10 +40,6 @@ public function checkOwnableUserAccess(Model&OwnableInterface $ownable, string|P
         $ownerField = $ownable->getOwnerFieldName();
         $ownableFieldVal = $ownable->getAttribute($ownerField);
 
-        if (is_null($ownableFieldVal)) {
-            throw new InvalidArgumentException("{$ownerField} field used but has not been loaded");
-        }
-
         $isOwner = $user->id === $ownableFieldVal;
         $hasRolePermission = $allRolePermission || ($isOwner && $ownRolePermission);
 
@@ -144,10 +140,10 @@ public function restrictEntityRelationQuery(Builder $query, string $tableName, s
                 /** @var Builder $query */
                 $query->where($tableDetails['entityTypeColumn'], '!=', $pageMorphClass)
                 ->orWhereExists(function (QueryBuilder $query) use ($tableDetails, $pageMorphClass) {
-                    $query->select('id')->from('pages')
-                        ->whereColumn('pages.id', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn'])
+                    $query->select('page_id')->from('entity_page_data')
+                        ->whereColumn('entity_page_data.page_id', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn'])
                         ->where($tableDetails['tableName'] . '.' . $tableDetails['entityTypeColumn'], '=', $pageMorphClass)
-                        ->where('pages.draft', '=', false);
+                        ->where('entity_page_data.draft', '=', false);
                 });
             });
     }