Updated version and assets for release v21.10

Revert "Update german translation"

.env.example.complete

@@ -100,7 +100,8 @@ MEMCACHED_SERVERS=127.0.0.1:11211:100
 REDIS_SERVERS=127.0.0.1:6379:0
 
 # Queue driver to use
-# Can be 'sync', 'database' or 'redis'
+# Queue not really currently used but may be configurable in the future.
+# Would advise not to change this for now.
 QUEUE_CONNECTION=sync
 
 # Storage system to use
@@ -133,7 +134,7 @@ STORAGE_S3_ENDPOINT=https://my-custom-s3-compatible.service.com:8001
 STORAGE_URL=false
 
 # Authentication method to use
-# Can be 'standard', 'ldap', 'saml2' or 'oidc'
+# Can be 'standard', 'ldap' or 'saml2'
 AUTH_METHOD=standard
 
 # Social authentication configuration
@@ -241,7 +242,6 @@ SAML2_GROUP_ATTRIBUTE=group
 SAML2_REMOVE_FROM_GROUPS=false
 
 # OpenID Connect authentication configuration
-# Refer to https://www.bookstackapp.com/docs/admin/oidc-auth/
 OIDC_NAME=SSO
 OIDC_DISPLAY_NAME_CLAIMS=name
 OIDC_CLIENT_ID=null
@@ -293,10 +293,6 @@ REVISION_LIMIT=50
 # Set to -1 for unlimited recycle bin lifetime.
 RECYCLE_BIN_LIFETIME=30
 
-# File Upload Limit
-# Maximum file size, in megabytes, that can be uploaded to the system.
-FILE_UPLOAD_SIZE_LIMIT=50
-
 # Allow <script> tags in page content
 # Note, if set to 'true' the page editor may still escape scripts.
 ALLOW_CONTENT_SCRIPTS=false

.github/SECURITY.md

@@ -1,32 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-Only the [latest version](https://github.com/BookStackApp/BookStack/releases) of BookStack is supported.
-We generally don't support older versions of BookStack due to maintenance effort and
-since we aim to provide a fairly stable upgrade path for new versions.
-
-## Security Notifications
-
-If you'd like to be notified of new potential security concerns you can [sign-up to the BookStack security mailing list](https://updates.bookstackapp.com/signup/bookstack-security-updates).
-
-## Reporting a Vulnerability
-
-If you've found an issue that likely has no impact to existing users (For example, in a development-only branch)
-feel free to raise it via a standard GitHub bug report issue.
-
-If the issue could have a security impact to BookStack instances, please use one of the below 
-methods to report the vulnerability:
-
-- Directly contact the lead maintainer [@ssddanbrown](https://github.com/ssddanbrown). 
-  - You will need to login to be able to see the email address on the [GitHub profile page](https://github.com/ssddanbrown).
-  - Alternatively you can send a DM via Twitter to [@ssddanbrown](https://twitter.com/ssddanbrown).
-- [Disclose via huntr.dev](https://huntr.dev/bounties/disclose)
-  - Bounties may be available to you through this platform.
-  - Be sure to use `https://github.com/BookStackApp/BookStack` as the repository URL.
-
-Please be patient while the vulnerability is being reviewed. Deploying the fix to address the vulnerability
-can often take a little time due to the amount of preparation required, to ensure the vulnerability has
-been covered, and to create the content required to adequately notify the user-base.
-
-Thank you for keeping BookStack instances safe!

.github/translators.txt

@@ -126,7 +126,7 @@ Zenahr Barzani (Zenahr) :: German; Japanese; Dutch; German Informal
 tatsuya.info :: Japanese
 fadiapp :: Arabic
 Jakub Bouček (jakubboucek) :: Czech
-Marco (cdrfun) :: German; German Informal
+Marco (cdrfun) :: German
 10935336 :: Chinese Simplified
 孟繁阳 (FanyangMeng) :: Chinese Simplified
 Andrej Močan (andrejm) :: Slovenian
@@ -196,17 +196,3 @@ Indrek Haav (IndrekHaav) :: Estonian
 na3shkw :: Japanese
 Giancarlo Di Massa (digitall-it) :: Italian
 M Nafis Al Mukhdi (mnafisalmukhdi1) :: Indonesian
-sulfo :: Danish
-Raukze :: German
-zygimantus :: Lithuanian
-marinkaberg :: Russian
-Vitaliy (gviabcua) :: Ukrainian
-mannycarreiro :: Portuguese
-Thiago Rafael Pereira de Carvalho (thiago.rafael) :: Portuguese, Brazilian
-Ken Roger Bolgnes (kenbo124) :: Norwegian Bokmal
-Nguyen Hung Phuong (hnwolf) :: Vietnamese
-Umut ERGENE (umutergene67) :: Turkish
-Tomáš Batelka (Vofy) :: Czech
-Mundo Racional (ismael.mesquita) :: Portuguese, Brazilian
-Zarik (3apuk) :: Russian
-Ali Shaatani (a.shaatani) :: Arabic

.github/workflows/phpstan.yml

@@ -1,41 +0,0 @@
-name: phpstan
-
-on:
-  push:
-    branches-ignore:
-      - l10n_master
-  pull_request:
-    branches-ignore:
-      - l10n_master
-
-jobs:
-  build:
-    runs-on: ubuntu-20.04
-    strategy:
-      matrix:
-        php: ['7.3']
-    steps:
-    - uses: actions/checkout@v1
-
-    - name: Setup PHP
-      uses: shivammathur/setup-php@v2
-      with:
-        php-version: ${{ matrix.php }}
-        extensions: gd, mbstring, json, curl, xml, mysql, ldap
-
-    - name: Get Composer Cache Directory
-      id: composer-cache
-      run: |
-        echo "::set-output name=dir::$(composer config cache-files-dir)"
-
-    - name: Cache composer packages
-      uses: actions/cache@v1
-      with:
-        path: ${{ steps.composer-cache.outputs.dir }}
-        key: ${{ runner.os }}-composer-${{ matrix.php }}
-
-    - name: Install composer dependencies
-      run: composer install --prefer-dist --no-interaction --ansi
-
-    - name: Run PHPStan
-      run: php${{ matrix.php }} ./vendor/bin/phpstan analyse --memory-limit=2G

.github/workflows/phpunit.yml

@@ -13,12 +13,12 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php: ['7.3', '7.4', '8.0', '8.1']
+        php: ['7.3', '7.4', '8.0']
     steps:
     - uses: actions/checkout@v1
 
     - name: Setup PHP
-      uses: shivammathur/setup-php@v2
+      uses: shivammathur/setup-php@b7d1d9c9a92d8d8463ce36d7f60da34d461724f8
       with:
         php-version: ${{ matrix.php }}
         extensions: gd, mbstring, json, curl, xml, mysql, ldap
@@ -36,7 +36,7 @@ jobs:
 
     - name: Start Database
       run: |
-        sudo systemctl start mysql
+        sudo /etc/init.d/mysql start
 
     - name: Setup Database
       run: |
@@ -45,7 +45,7 @@ jobs:
         mysql -uroot -proot -e "GRANT ALL ON \`bookstack-test\`.* TO 'bookstack-test'@'localhost';"
         mysql -uroot -proot -e 'FLUSH PRIVILEGES;'
 
-    - name: Install composer dependencies
+    - name: Install composer dependencies & Test
       run: composer install --prefer-dist --no-interaction --ansi
 
     - name: Migrate and seed the database

.github/workflows/test-migrations.yml

@@ -13,12 +13,12 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php: ['7.3', '7.4', '8.0', '8.1']
+        php: ['7.3', '7.4', '8.0']
     steps:
       - uses: actions/checkout@v1
 
       - name: Setup PHP
-        uses: shivammathur/setup-php@v2
+        uses: shivammathur/setup-php@b7d1d9c9a92d8d8463ce36d7f60da34d461724f8
         with:
           php-version: ${{ matrix.php }}
           extensions: gd, mbstring, json, curl, xml, mysql, ldap
@@ -36,7 +36,7 @@ jobs:
 
       - name: Start MySQL
         run: |
-          sudo systemctl start mysql
+          sudo /etc/init.d/mysql start
 
       - name: Create database & user
         run: |

.gitignore

@@ -5,10 +5,10 @@ Homestead.yaml
 .idea
 npm-debug.log
 yarn-error.log
-/public/dist
+/public/dist/*.map
 /public/plugins
-/public/css
-/public/js
+/public/css/*.map
+/public/js/*.map
 /public/bower
 /public/build/
 /storage/images
@@ -23,5 +23,4 @@ nbproject
 .settings/
 webpack-stats.json
 .phpunit.result.cache
-.DS_Store
-phpstan.neon
+.DS_Store

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-present, Dan Brown and the BookStack Project contributors
+Copyright (c) 2020 Dan Brown and the BookStack Project contributors
 https://github.com/BookStackApp/BookStack/graphs/contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

TODO

@@ -1,49 +0,0 @@
-### Next
-
-- Table cell height resize & cell width resize via width style
-  - Column resize source: https://github.com/ProseMirror/prosemirror-tables/blob/master/src/columnresizing.js
-  - Have updated column resizing to set cell widths
-    - Now need to handle table overall size on change, then heights. 
-
-- Details/Summary
-  - Need view to control summary editability, make readonly but editable via popover.
-  - Need some default styles to visualise details boundary.
-  - Markdown parser needs to be updated to handle separate open/close tags for blocks. 
-
-### In-Progress
-
-- Tables
-- Details/Summary
-
-### Features
-
-- Images
-- Drawings
-- LTR/RTL control
-- Fullscreen
-- Paste Image Uploading
-- Drag + Drop Image Uploading
-- Checkbox/TODO list items
-- Code blocks
-- Indents
-- Attachment integration (Drag & drop)
-- Template system integration.
-
-### Improvements
-
-- List type changing.
-- Color picker options should have "clear" option.
-- Color picker buttons should be split, with button to re-apply last selected color.
-- Color picker options should change color if different instead of remove.
-- Clear formatting, If no selection range, clear the formatting of parent block.
-  - If no marks, clear the block type if text type?
-- Remove links button? (Action already in place if link href is empty).
-- Links - Validate URL.
-- Links - Integrate entity picker.
-- iFrame - Parse iframe HTML & auto-convert youtube/vimeo urls to embeds. 
-
-### Notes
-
-- Use NodeViews for embedded content (Code, Drawings) where control is needed.
-- Probably still easiest to have seperate (codemirror) MD editor. Can alter display output via NodeViews to make MD like
-  but its tricky since editing the markdown content would change the block definition/type while editing.

app/Actions/Activity.php

@@ -61,7 +61,7 @@ class Activity extends Model
     /**
      * Checks if another Activity matches the general information of another.
      */
-    public function isSimilarTo(self $activityB): bool
+    public function isSimilarTo(Activity $activityB): bool
     {
         return [$this->type, $this->entity_type, $this->entity_id] === [$activityB->type, $activityB->entity_type, $activityB->entity_id];
     }

app/Actions/ActivityLogger.php

@@ -1,115 +0,0 @@
-<?php
-
-namespace BookStack\Actions;
-
-use BookStack\Auth\Permissions\PermissionService;
-use BookStack\Entities\Models\Entity;
-use BookStack\Interfaces\Loggable;
-use Illuminate\Database\Eloquent\Builder;
-use Illuminate\Support\Facades\Log;
-
-class ActivityLogger
-{
-    protected $permissionService;
-
-    public function __construct(PermissionService $permissionService)
-    {
-        $this->permissionService = $permissionService;
-    }
-
-    /**
-     * Add a generic activity event to the database.
-     *
-     * @param string|Loggable $detail
-     */
-    public function add(string $type, $detail = '')
-    {
-        $detailToStore = ($detail instanceof Loggable) ? $detail->logDescriptor() : $detail;
-
-        $activity = $this->newActivityForUser($type);
-        $activity->detail = $detailToStore;
-
-        if ($detail instanceof Entity) {
-            $activity->entity_id = $detail->id;
-            $activity->entity_type = $detail->getMorphClass();
-        }
-
-        $activity->save();
-        $this->setNotification($type);
-        $this->dispatchWebhooks($type, $detail);
-    }
-
-    /**
-     * Get a new activity instance for the current user.
-     */
-    protected function newActivityForUser(string $type): Activity
-    {
-        $ip = request()->ip() ?? '';
-
-        return (new Activity())->forceFill([
-            'type'     => strtolower($type),
-            'user_id'  => user()->id,
-            'ip'       => config('app.env') === 'demo' ? '127.0.0.1' : $ip,
-        ]);
-    }
-
-    /**
-     * 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.
-     */
-    public function removeEntity(Entity $entity)
-    {
-        $entity->activity()->update([
-            'detail'       => $entity->name,
-            'entity_id'    => null,
-            'entity_type'  => null,
-        ]);
-    }
-
-    /**
-     * Flashes a notification message to the session if an appropriate message is available.
-     */
-    protected function setNotification(string $type): void
-    {
-        $notificationTextKey = 'activities.' . $type . '_notification';
-        if (trans()->has($notificationTextKey)) {
-            $message = trans($notificationTextKey);
-            session()->flash('success', $message);
-        }
-    }
-
-    /**
-     * @param string|Loggable $detail
-     */
-    protected function dispatchWebhooks(string $type, $detail): void
-    {
-        $webhooks = Webhook::query()
-            ->whereHas('trackedEvents', function (Builder $query) use ($type) {
-                $query->where('event', '=', $type)
-                    ->orWhere('event', '=', 'all');
-            })
-            ->where('active', '=', true)
-            ->get();
-
-        foreach ($webhooks as $webhook) {
-            dispatch(new DispatchWebhookJob($webhook, $type, $detail));
-        }
-    }
-
-    /**
-     * 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);
-    }
-}

app/Actions/ActivityQueries.php

@@ -1,112 +0,0 @@
-<?php
-
-namespace BookStack\Actions;
-
-use BookStack\Auth\Permissions\PermissionService;
-use BookStack\Auth\User;
-use BookStack\Entities\Models\Book;
-use BookStack\Entities\Models\Chapter;
-use BookStack\Entities\Models\Entity;
-use BookStack\Entities\Models\Page;
-use Illuminate\Database\Eloquent\Builder;
-use Illuminate\Database\Eloquent\Relations\Relation;
-
-class ActivityQueries
-{
-    protected $permissionService;
-
-    public function __construct(PermissionService $permissionService)
-    {
-        $this->permissionService = $permissionService;
-    }
-
-    /**
-     * Gets the latest activity.
-     */
-    public function latest(int $count = 20, int $page = 0): array
-    {
-        $activityList = $this->permissionService
-            ->filterRestrictedEntityRelations(Activity::query(), 'activities', 'entity_id', 'entity_type')
-            ->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.
-     */
-    public function entityActivity(Entity $entity, int $count = 20, int $page = 1): array
-    {
-        /** @var array<string, int[]> $queryIds */
-        $queryIds = [$entity->getMorphClass() => [$entity->id]];
-
-        if ($entity instanceof Book) {
-            $queryIds[(new Chapter())->getMorphClass()] = $entity->chapters()->scopes('visible')->pluck('id');
-        }
-        if ($entity instanceof Book || $entity instanceof Chapter) {
-            $queryIds[(new Page())->getMorphClass()] = $entity->pages()->scopes('visible')->pluck('id');
-        }
-
-        $query = Activity::query();
-        $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();
-
-        return $this->filterSimilar($activity);
-    }
-
-    /**
-     * Get the latest activity for a user, Filtering out similar items.
-     */
-    public function userActivity(User $user, int $count = 20, int $page = 0): array
-    {
-        $activityList = $this->permissionService
-            ->filterRestrictedEntityRelations(Activity::query(), 'activities', 'entity_id', 'entity_type')
-            ->orderBy('created_at', 'desc')
-            ->where('user_id', '=', $user->id)
-            ->skip($count * $page)
-            ->take($count)
-            ->get();
-
-        return $this->filterSimilar($activityList);
-    }
-
-    /**
-     * Filters out similar activity.
-     *
-     * @param Activity[] $activities
-     */
-    protected function filterSimilar(iterable $activities): array
-    {
-        $newActivity = [];
-        $previousItem = null;
-
-        foreach ($activities as $activityItem) {
-            if (!$previousItem || !$activityItem->isSimilarTo($previousItem)) {
-                $newActivity[] = $activityItem;
-            }
-
-            $previousItem = $activityItem;
-        }
-
-        return $newActivity;
-    }
-}

app/Actions/ActivityService.php

@@ -0,0 +1,200 @@
+<?php
+
+namespace BookStack\Actions;
+
+use BookStack\Auth\Permissions\PermissionService;
+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 $permissionService;
+
+    public function __construct(Activity $activity, PermissionService $permissionService)
+    {
+        $this->activity = $activity;
+        $this->permissionService = $permissionService;
+    }
+
+    /**
+     * Add activity data to database for an entity.
+     */
+    public function addForEntity(Entity $entity, string $type)
+    {
+        $activity = $this->newActivityForUser($type);
+        $entity->activity()->save($activity);
+        $this->setNotification($type);
+    }
+
+    /**
+     * Add a generic activity event to the database.
+     *
+     * @param string|Loggable $detail
+     */
+    public function add(string $type, $detail = '')
+    {
+        if ($detail instanceof Loggable) {
+            $detail = $detail->logDescriptor();
+        }
+
+        $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
+    {
+        $ip = request()->ip() ?? '';
+
+        return $this->activity->newInstance()->forceFill([
+            'type'     => strtolower($type),
+            'user_id'  => user()->id,
+            'ip'       => config('app.env') === 'demo' ? '127.0.0.1' : $ip,
+        ]);
+    }
+
+    /**
+     * 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.
+     */
+    public function removeEntity(Entity $entity)
+    {
+        $entity->activity()->update([
+            'detail'       => $entity->name,
+            'entity_id'    => null,
+            'entity_type'  => null,
+        ]);
+    }
+
+    /**
+     * Gets the latest activity.
+     */
+    public function latest(int $count = 20, int $page = 0): array
+    {
+        $activityList = $this->permissionService
+            ->filterRestrictedEntityRelations($this->activity->newQuery(), 'activities', 'entity_id', 'entity_type')
+            ->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.
+     */
+    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')) {
+            $queryIds[(new Chapter())->getMorphClass()] = $entity->chapters()->visible()->pluck('id');
+        }
+        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();
+
+        return $this->filterSimilar($activity);
+    }
+
+    /**
+     * Get latest activity for a user, Filtering out similar items.
+     */
+    public function userActivity(User $user, int $count = 20, int $page = 0): array
+    {
+        $activityList = $this->permissionService
+            ->filterRestrictedEntityRelations($this->activity->newQuery(), 'activities', 'entity_id', 'entity_type')
+            ->orderBy('created_at', 'desc')
+            ->where('user_id', '=', $user->id)
+            ->skip($count * $page)
+            ->take($count)
+            ->get();
+
+        return $this->filterSimilar($activityList);
+    }
+
+    /**
+     * Filters out similar activity.
+     *
+     * @param Activity[] $activities
+     *
+     * @return array
+     */
+    protected function filterSimilar(iterable $activities): array
+    {
+        $newActivity = [];
+        $previousItem = null;
+
+        foreach ($activities as $activityItem) {
+            if (!$previousItem || !$activityItem->isSimilarTo($previousItem)) {
+                $newActivity[] = $activityItem;
+            }
+
+            $previousItem = $activityItem;
+        }
+
+        return $newActivity;
+    }
+
+    /**
+     * Flashes a notification message to the session if an appropriate message is available.
+     */
+    protected function setNotification(string $type)
+    {
+        $notificationTextKey = 'activities.' . $type . '_notification';
+        if (trans()->has($notificationTextKey)) {
+            $message = trans($notificationTextKey);
+            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);
+    }
+}

app/Actions/ActivityType.php

@@ -53,16 +53,4 @@ class ActivityType
 
     const MFA_SETUP_METHOD = 'mfa_setup_method';
     const MFA_REMOVE_METHOD = 'mfa_remove_method';
-
-    const WEBHOOK_CREATE = 'webhook_create';
-    const WEBHOOK_UPDATE = 'webhook_update';
-    const WEBHOOK_DELETE = 'webhook_delete';
-
-    /**
-     * Get all the possible values.
-     */
-    public static function all(): array
-    {
-        return (new \ReflectionClass(static::class))->getConstants();
-    }
 }

app/Actions/Comment.php

@@ -4,7 +4,6 @@ namespace BookStack\Actions;
 
 use BookStack\Model;
 use BookStack\Traits\HasCreatorAndUpdater;
-use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 
 /**
@@ -16,7 +15,6 @@ use Illuminate\Database\Eloquent\Relations\MorphTo;
  */
 class Comment extends Model
 {
-    use HasFactory;
     use HasCreatorAndUpdater;
 
     protected $fillable = ['text', 'parent_id'];

app/Actions/CommentRepo.php

@@ -45,7 +45,7 @@ class CommentRepo
         $comment->parent_id = $parent_id;
 
         $entity->comments()->save($comment);
-        ActivityService::add(ActivityType::COMMENTED_ON, $entity);
+        ActivityService::addForEntity($entity, ActivityType::COMMENTED_ON);
 
         return $comment;
     }
@@ -66,13 +66,13 @@ class CommentRepo
     /**
      * Delete a comment from the system.
      */
-    public function delete(Comment $comment): void
+    public function delete(Comment $comment)
     {
         $comment->delete();
     }
 
     /**
-     * Convert the given comment Markdown to HTML.
+     * Convert the given comment markdown text to HTML.
      */
     public function commentToHtml(string $commentText): string
     {
@@ -90,9 +90,8 @@ class CommentRepo
      */
     protected function getNextLocalId(Entity $entity): int
     {
-        /** @var Comment $comment */
-        $comment = $entity->comments(false)->orderBy('local_id', 'desc')->first();
+        $comments = $entity->comments(false)->orderBy('local_id', 'desc')->first();
 
-        return ($comment->local_id ?? 0) + 1;
+        return ($comments->local_id ?? 0) + 1;
     }
 }

app/Actions/DispatchWebhookJob.php

@@ -1,132 +0,0 @@
-<?php
-
-namespace BookStack\Actions;
-
-use BookStack\Auth\User;
-use BookStack\Entities\Models\Entity;
-use BookStack\Facades\Theme;
-use BookStack\Interfaces\Loggable;
-use BookStack\Model;
-use BookStack\Theming\ThemeEvents;
-use Illuminate\Bus\Queueable;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Queue\SerializesModels;
-use Illuminate\Support\Carbon;
-use Illuminate\Support\Facades\Http;
-use Illuminate\Support\Facades\Log;
-
-class DispatchWebhookJob implements ShouldQueue
-{
-    use Dispatchable;
-    use InteractsWithQueue;
-    use Queueable;
-    use SerializesModels;
-
-    /**
-     * @var Webhook
-     */
-    protected $webhook;
-
-    /**
-     * @var string
-     */
-    protected $event;
-
-    /**
-     * @var string|Loggable
-     */
-    protected $detail;
-
-    /**
-     * @var User
-     */
-    protected $initiator;
-
-    /**
-     * @var int
-     */
-    protected $initiatedTime;
-
-    /**
-     * Create a new job instance.
-     *
-     * @return void
-     */
-    public function __construct(Webhook $webhook, string $event, $detail)
-    {
-        $this->webhook = $webhook;
-        $this->event = $event;
-        $this->detail = $detail;
-        $this->initiator = user();
-        $this->initiatedTime = time();
-    }
-
-    /**
-     * Execute the job.
-     *
-     * @return void
-     */
-    public function handle()
-    {
-        $themeResponse = Theme::dispatch(ThemeEvents::WEBHOOK_CALL_BEFORE, $this->event, $this->webhook, $this->detail);
-        $webhookData = $themeResponse ?? $this->buildWebhookData();
-        $lastError = null;
-
-        try {
-            $response = Http::asJson()
-                ->withOptions(['allow_redirects' => ['strict' => true]])
-                ->timeout($this->webhook->timeout)
-                ->post($this->webhook->endpoint, $webhookData);
-        } catch (\Exception $exception) {
-            $lastError = $exception->getMessage();
-            Log::error("Webhook call to endpoint {$this->webhook->endpoint} failed with error \"{$lastError}\"");
-        }
-
-        if (isset($response) && $response->failed()) {
-            $lastError = "Response status from endpoint was {$response->status()}";
-            Log::error("Webhook call to endpoint {$this->webhook->endpoint} failed with status {$response->status()}");
-        }
-
-        $this->webhook->last_called_at = now();
-        if ($lastError) {
-            $this->webhook->last_errored_at = now();
-            $this->webhook->last_error = $lastError;
-        }
-
-        $this->webhook->save();
-    }
-
-    protected function buildWebhookData(): array
-    {
-        $textParts = [
-            $this->initiator->name,
-            trans('activities.' . $this->event),
-        ];
-
-        if ($this->detail instanceof Entity) {
-            $textParts[] = '"' . $this->detail->name . '"';
-        }
-
-        $data = [
-            'event'                    => $this->event,
-            'text'                     => implode(' ', $textParts),
-            'triggered_at'             => Carbon::createFromTimestampUTC($this->initiatedTime)->toISOString(),
-            'triggered_by'             => $this->initiator->attributesToArray(),
-            'triggered_by_profile_url' => $this->initiator->getProfileUrl(),
-            'webhook_id'               => $this->webhook->id,
-            'webhook_name'             => $this->webhook->name,
-        ];
-
-        if (method_exists($this->detail, 'getUrl')) {
-            $data['url'] = $this->detail->getUrl();
-        }
-
-        if ($this->detail instanceof Model) {
-            $data['related_item'] = $this->detail->attributesToArray();
-        }
-
-        return $data;
-    }
-}

app/Actions/Tag.php

@@ -3,19 +3,10 @@
 namespace BookStack\Actions;
 
 use BookStack\Model;
-use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 
-/**
- * @property int    $id
- * @property string $name
- * @property string $value
- * @property int    $order
- */
 class Tag extends Model
 {
-    use HasFactory;
-
     protected $fillable = ['name', 'value', 'order'];
     protected $hidden = ['id', 'entity_id', 'entity_type', 'created_at', 'updated_at'];
 

app/Actions/TagRepo.php

@@ -4,7 +4,6 @@ namespace BookStack\Actions;
 
 use BookStack\Auth\Permissions\PermissionService;
 use BookStack\Entities\Models\Entity;
-use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
 
@@ -13,45 +12,13 @@ class TagRepo
     protected $tag;
     protected $permissionService;
 
-    public function __construct(PermissionService $ps)
-    {
-        $this->permissionService = $ps;
-    }
-
     /**
-     * Start a query against all tags in the system.
+     * TagRepo constructor.
      */
-    public function queryWithTotals(string $searchTerm, string $nameFilter): Builder
+    public function __construct(Tag $tag, PermissionService $ps)
     {
-        $query = Tag::query()
-            ->select([
-                'name',
-                ($searchTerm || $nameFilter) ? 'value' : DB::raw('COUNT(distinct value) as `values`'),
-                DB::raw('COUNT(id) as usages'),
-                DB::raw('SUM(IF(entity_type = \'BookStack\\\\Page\', 1, 0)) as page_count'),
-                DB::raw('SUM(IF(entity_type = \'BookStack\\\\Chapter\', 1, 0)) as chapter_count'),
-                DB::raw('SUM(IF(entity_type = \'BookStack\\\\Book\', 1, 0)) as book_count'),
-                DB::raw('SUM(IF(entity_type = \'BookStack\\\\BookShelf\', 1, 0)) as shelf_count'),
-            ])
-            ->orderBy($nameFilter ? 'value' : 'name');
-
-        if ($nameFilter) {
-            $query->where('name', '=', $nameFilter);
-            $query->groupBy('value');
-        } elseif ($searchTerm) {
-            $query->groupBy('name', 'value');
-        } else {
-            $query->groupBy('name');
-        }
-
-        if ($searchTerm) {
-            $query->where(function (Builder $query) use ($searchTerm) {
-                $query->where('name', 'like', '%' . $searchTerm . '%')
-                    ->orWhere('value', 'like', '%' . $searchTerm . '%');
-            });
-        }
-
-        return $this->permissionService->filterRestrictedEntityRelations($query, 'tags', 'entity_id', 'entity_type');
+        $this->tag = $tag;
+        $this->permissionService = $ps;
     }
 
     /**
@@ -60,7 +27,7 @@ class TagRepo
      */
     public function getNameSuggestions(?string $searchTerm): Collection
     {
-        $query = Tag::query()
+        $query = $this->tag->newQuery()
             ->select('*', DB::raw('count(*) as count'))
             ->groupBy('name');
 
@@ -82,7 +49,7 @@ class TagRepo
      */
     public function getValueSuggestions(?string $searchTerm, ?string $tagName): Collection
     {
-        $query = Tag::query()
+        $query = $this->tag->newQuery()
             ->select('*', DB::raw('count(*) as count'))
             ->groupBy('value');
 
@@ -123,9 +90,9 @@ class TagRepo
      */
     protected function newInstanceFromInput(array $input): Tag
     {
-        return new Tag([
-            'name'  => trim($input['name']),
-            'value' => trim($input['value'] ?? ''),
-        ]);
+        $name = trim($input['name']);
+        $value = isset($input['value']) ? trim($input['value']) : '';
+
+        return $this->tag->newInstance(['name' => $name, 'value' => $value]);
     }
 }

app/Actions/Webhook.php

@@ -1,85 +0,0 @@
-<?php
-
-namespace BookStack\Actions;
-
-use BookStack\Interfaces\Loggable;
-use Carbon\Carbon;
-use Illuminate\Database\Eloquent\Collection;
-use Illuminate\Database\Eloquent\Factories\HasFactory;
-use Illuminate\Database\Eloquent\Model;
-use Illuminate\Database\Eloquent\Relations\HasMany;
-
-/**
- * @property int        $id
- * @property string     $name
- * @property string     $endpoint
- * @property Collection $trackedEvents
- * @property bool       $active
- * @property int        $timeout
- * @property string     $last_error
- * @property Carbon     $last_called_at
- * @property Carbon     $last_errored_at
- */
-class Webhook extends Model implements Loggable
-{
-    protected $fillable = ['name', 'endpoint', 'timeout'];
-
-    use HasFactory;
-
-    protected $casts = [
-        'last_called_at'  => 'datetime',
-        'last_errored_at' => 'datetime',
-    ];
-
-    /**
-     * Define the tracked event relation a webhook.
-     */
-    public function trackedEvents(): HasMany
-    {
-        return $this->hasMany(WebhookTrackedEvent::class);
-    }
-
-    /**
-     * Update the tracked events for a webhook from the given list of event types.
-     */
-    public function updateTrackedEvents(array $events): void
-    {
-        $this->trackedEvents()->delete();
-
-        $eventsToStore = array_intersect($events, array_values(ActivityType::all()));
-        if (in_array('all', $events)) {
-            $eventsToStore = ['all'];
-        }
-
-        $trackedEvents = [];
-        foreach ($eventsToStore as $event) {
-            $trackedEvents[] = new WebhookTrackedEvent(['event' => $event]);
-        }
-
-        $this->trackedEvents()->saveMany($trackedEvents);
-    }
-
-    /**
-     * Check if this webhook tracks the given event.
-     */
-    public function tracksEvent(string $event): bool
-    {
-        return $this->trackedEvents->pluck('event')->contains($event);
-    }
-
-    /**
-     * Get a URL for this webhook within the settings interface.
-     */
-    public function getUrl(string $path = ''): string
-    {
-        return url('/settings/webhooks/' . $this->id . '/' . ltrim($path, '/'));
-    }
-
-    /**
-     * Get the string descriptor for this item.
-     */
-    public function logDescriptor(): string
-    {
-        return "({$this->id}) {$this->name}";
-    }
-}

app/Actions/WebhookTrackedEvent.php

@@ -1,18 +0,0 @@
-<?php
-
-namespace BookStack\Actions;
-
-use Illuminate\Database\Eloquent\Factories\HasFactory;
-use Illuminate\Database\Eloquent\Model;
-
-/**
- * @property int    $id
- * @property int    $webhook_id
- * @property string $event
- */
-class WebhookTrackedEvent extends Model
-{
-    protected $fillable = ['event'];
-
-    use HasFactory;
-}

app/Api/ApiDocsGenerator.php

@@ -28,7 +28,7 @@ class ApiDocsGenerator
         if (Cache::has($cacheKey) && config('app.env') === 'production') {
             $docs = Cache::get($cacheKey);
         } else {
-            $docs = (new ApiDocsGenerator())->generate();
+            $docs = (new static())->generate();
             Cache::put($cacheKey, $docs, 60 * 24);
         }
 
@@ -55,16 +55,10 @@ class ApiDocsGenerator
     {
         return $routes->map(function (array $route) {
             $exampleTypes = ['request', 'response'];
-            $fileTypes = ['json', 'http'];
             foreach ($exampleTypes as $exampleType) {
-                foreach ($fileTypes as $fileType) {
-                    $exampleFile = base_path("dev/api/{$exampleType}s/{$route['name']}." . $fileType);
-                    if (file_exists($exampleFile)) {
-                        $route["example_{$exampleType}"] = file_get_contents($exampleFile);
-                        continue 2;
-                    }
-                }
-                $route["example_{$exampleType}"] = null;
+                $exampleFile = base_path("dev/api/{$exampleType}s/{$route['name']}.json");
+                $exampleContent = file_exists($exampleFile) ? file_get_contents($exampleFile) : null;
+                $route["example_{$exampleType}"] = $exampleContent;
             }
 
             return $route;
@@ -101,14 +95,17 @@ class ApiDocsGenerator
         }
 
         $rules = $class->getValdationRules()[$methodName] ?? [];
+        foreach ($rules as $param => $ruleString) {
+            $rules[$param] = explode('|', $ruleString);
+        }
 
-        return empty($rules) ? null : $rules;
+        return count($rules) > 0 ? $rules : null;
     }
 
     /**
      * Parse out the description text from a class method comment.
      */
-    protected function parseDescriptionFromMethodComment(string $comment): string
+    protected function parseDescriptionFromMethodComment(string $comment)
     {
         $matches = [];
         preg_match_all('/^\s*?\*\s((?![@\s]).*?)$/m', $comment, $matches);

app/Api/ApiToken.php

@@ -43,7 +43,7 @@ class ApiToken extends Model implements Loggable
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function logDescriptor(): string
     {

app/Api/ApiTokenGuard.php

@@ -42,7 +42,7 @@ class ApiTokenGuard implements Guard
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function user()
     {
@@ -152,7 +152,7 @@ class ApiTokenGuard implements Guard
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function validate(array $credentials = [])
     {

app/Auth/Access/ExternalBaseUserProvider.php

@@ -4,7 +4,6 @@ namespace BookStack\Auth\Access;
 
 use Illuminate\Contracts\Auth\Authenticatable;
 use Illuminate\Contracts\Auth\UserProvider;
-use Illuminate\Database\Eloquent\Model;
 
 class ExternalBaseUserProvider implements UserProvider
 {
@@ -17,6 +16,8 @@ class ExternalBaseUserProvider implements UserProvider
 
     /**
      * LdapUserProvider constructor.
+     *
+     * @param $model
      */
     public function __construct(string $model)
     {
@@ -26,7 +27,7 @@ class ExternalBaseUserProvider implements UserProvider
     /**
      * Create a new instance of the model.
      *
-     * @return Model
+     * @return \Illuminate\Database\Eloquent\Model
      */
     public function createModel()
     {
@@ -40,7 +41,7 @@ class ExternalBaseUserProvider implements UserProvider
      *
      * @param mixed $identifier
      *
-     * @return Authenticatable|null
+     * @return \Illuminate\Contracts\Auth\Authenticatable|null
      */
     public function retrieveById($identifier)
     {
@@ -53,7 +54,7 @@ class ExternalBaseUserProvider implements UserProvider
      * @param mixed  $identifier
      * @param string $token
      *
-     * @return Authenticatable|null
+     * @return \Illuminate\Contracts\Auth\Authenticatable|null
      */
     public function retrieveByToken($identifier, $token)
     {
@@ -63,8 +64,8 @@ class ExternalBaseUserProvider implements UserProvider
     /**
      * Update the "remember me" token for the given user in storage.
      *
-     * @param Authenticatable $user
-     * @param string          $token
+     * @param \Illuminate\Contracts\Auth\Authenticatable $user
+     * @param string                                     $token
      *
      * @return void
      */
@@ -78,7 +79,7 @@ class ExternalBaseUserProvider implements UserProvider
      *
      * @param array $credentials
      *
-     * @return Authenticatable|null
+     * @return \Illuminate\Contracts\Auth\Authenticatable|null
      */
     public function retrieveByCredentials(array $credentials)
     {
@@ -93,8 +94,8 @@ class ExternalBaseUserProvider implements UserProvider
     /**
      * Validate a user against the given credentials.
      *
-     * @param Authenticatable $user
-     * @param array           $credentials
+     * @param \Illuminate\Contracts\Auth\Authenticatable $user
+     * @param array                                      $credentials
      *
      * @return bool
      */

app/Auth/Access/Guards/LdapSessionGuard.php

@@ -94,7 +94,7 @@ class LdapSessionGuard extends ExternalBaseSessionGuard
         }
 
         // Attach avatar if non-existent
-        if (!$user->avatar()->exists()) {
+        if (is_null($user->avatar)) {
             $this->ldapService->saveAndAttachAvatar($user, $userDetails);
         }
 

app/Auth/Access/Ldap.php

@@ -10,11 +10,14 @@ namespace BookStack\Auth\Access;
 class Ldap
 {
     /**
-     * Connect to an LDAP server.
+     * Connect to a LDAP server.
+     *
+     * @param string $hostName
+     * @param int    $port
      *
      * @return resource
      */
-    public function connect(string $hostName, int $port)
+    public function connect($hostName, $port)
     {
         return ldap_connect($hostName, $port);
     }
@@ -23,9 +26,12 @@ class Ldap
      * Set the value of a LDAP option for the given connection.
      *
      * @param resource $ldapConnection
+     * @param int      $option
      * @param mixed    $value
+     *
+     * @return bool
      */
-    public function setOption($ldapConnection, int $option, $value): bool
+    public function setOption($ldapConnection, $option, $value)
     {
         return ldap_set_option($ldapConnection, $option, $value);
     }
@@ -41,9 +47,12 @@ class Ldap
     /**
      * Set the version number for the given ldap connection.
      *
-     * @param resource $ldapConnection
+     * @param $ldapConnection
+     * @param $version
+     *
+     * @return bool
      */
-    public function setVersion($ldapConnection, int $version): bool
+    public function setVersion($ldapConnection, $version)
     {
         return $this->setOption($ldapConnection, LDAP_OPT_PROTOCOL_VERSION, $version);
     }

app/Auth/Access/LdapService.php

@@ -165,7 +165,7 @@ class LdapService
      * Bind the system user to the LDAP connection using the given credentials
      * otherwise anonymous access is attempted.
      *
-     * @param resource $connection
+     * @param $connection
      *
      * @throws LdapException
      */

app/Auth/Access/Oidc/OidcJwtSigningKey.php

@@ -41,18 +41,16 @@ class OidcJwtSigningKey
     protected function loadFromPath(string $path)
     {
         try {
-            $key = PublicKeyLoader::load(
+            $this->key = PublicKeyLoader::load(
                 file_get_contents($path)
-            );
+            )->withPadding(RSA::SIGNATURE_PKCS1);
         } catch (\Exception $exception) {
             throw new OidcInvalidKeyException("Failed to load key from file path with error: {$exception->getMessage()}");
         }
 
-        if (!$key instanceof RSA) {
+        if (!($this->key instanceof RSA)) {
             throw new OidcInvalidKeyException('Key loaded from file path is not an RSA key as expected');
         }
-
-        $this->key = $key->withPadding(RSA::SIGNATURE_PKCS1);
     }
 
     /**
@@ -83,19 +81,14 @@ class OidcJwtSigningKey
         $n = strtr($jwk['n'] ?? '', '-_', '+/');
 
         try {
-            $key = PublicKeyLoader::load([
+            /** @var RSA $key */
+            $this->key = PublicKeyLoader::load([
                 'e' => new BigInteger(base64_decode($jwk['e']), 256),
                 'n' => new BigInteger(base64_decode($n), 256),
-            ]);
+            ])->withPadding(RSA::SIGNATURE_PKCS1);
         } catch (\Exception $exception) {
             throw new OidcInvalidKeyException("Failed to load key from JWK parameters with error: {$exception->getMessage()}");
         }
-
-        if (!$key instanceof RSA) {
-            throw new OidcInvalidKeyException('Key loaded from file path is not an RSA key as expected');
-        }
-
-        $this->key = $key->withPadding(RSA::SIGNATURE_PKCS1);
     }
 
     /**

app/Auth/Access/Saml2Service.php

@@ -99,7 +99,7 @@ class Saml2Service
      * @throws JsonDebugException
      * @throws UserRegistrationException
      */
-    public function processAcsResponse(?string $requestId, string $samlResponse): ?User
+    public function processAcsResponse(string $requestId, string $samlResponse): ?User
     {
         // The SAML2 toolkit expects the response to be within the $_POST superglobal
         // so we need to manually put it back there at this point.

app/Auth/Access/SocialAuthService.php

@@ -12,7 +12,6 @@ use Illuminate\Support\Str;
 use Laravel\Socialite\Contracts\Factory as Socialite;
 use Laravel\Socialite\Contracts\Provider;
 use Laravel\Socialite\Contracts\User as SocialUser;
-use Laravel\Socialite\Two\GoogleProvider;
 use SocialiteProviders\Manager\SocialiteWasCalled;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 
@@ -279,9 +278,12 @@ class SocialAuthService
     {
         $driver = $this->socialite->driver($driverName);
 
-        if ($driver instanceof GoogleProvider && config('services.google.select_account')) {
+        if ($driverName === 'google' && config('services.google.select_account')) {
             $driver->with(['prompt' => 'select_account']);
         }
+        if ($driverName === 'azure') {
+            $driver->with(['resource' => 'https://graph.windows.net']);
+        }
 
         if (isset($this->configureForRedirectCallbacks[$driverName])) {
             $this->configureForRedirectCallbacks[$driverName]($driver);

app/Auth/Permissions/PermissionService.php

@@ -602,35 +602,25 @@ class PermissionService
 
     /**
      * Filter items that have entities set as a polymorphic relation.
-     * For simplicity, this will not return results attached to draft pages.
-     * Draft pages should never really have related items though.
      *
      * @param Builder|QueryBuilder $query
      */
     public function filterRestrictedEntityRelations($query, string $tableName, string $entityIdColumn, string $entityTypeColumn, string $action = 'view')
     {
         $tableDetails = ['tableName' => $tableName, 'entityIdColumn' => $entityIdColumn, 'entityTypeColumn' => $entityTypeColumn];
-        $pageMorphClass = (new Page())->getMorphClass();
 
-        $q = $query->whereExists(function ($permissionQuery) use (&$tableDetails, $action) {
-            /** @var Builder $permissionQuery */
-            $permissionQuery->select(['role_id'])->from('joint_permissions')
-                ->whereColumn('joint_permissions.entity_id', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn'])
-                ->whereColumn('joint_permissions.entity_type', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityTypeColumn'])
-                ->where('joint_permissions.action', '=', $action)
-                ->whereIn('joint_permissions.role_id', $this->getCurrentUserRoles())
-                ->where(function (QueryBuilder $query) {
-                    $this->addJointHasPermissionCheck($query, $this->currentUser()->id);
-                });
-        })->where(function ($query) use ($tableDetails, $pageMorphClass) {
-            /** @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'])
-                        ->where($tableDetails['tableName'] . '.' . $tableDetails['entityTypeColumn'], '=', $pageMorphClass)
-                        ->where('pages.draft', '=', false);
-                });
+        $q = $query->where(function ($query) use ($tableDetails, $action) {
+            $query->whereExists(function ($permissionQuery) use (&$tableDetails, $action) {
+                /** @var Builder $permissionQuery */
+                $permissionQuery->select(['role_id'])->from('joint_permissions')
+                    ->whereColumn('joint_permissions.entity_id', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn'])
+                    ->whereColumn('joint_permissions.entity_type', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityTypeColumn'])
+                    ->where('action', '=', $action)
+                    ->whereIn('role_id', $this->getCurrentUserRoles())
+                    ->where(function (QueryBuilder $query) {
+                        $this->addJointHasPermissionCheck($query, $this->currentUser()->id);
+                    });
+            });
         });
 
         $this->clean();
@@ -644,39 +634,25 @@ class PermissionService
      */
     public function filterRelatedEntity(string $entityClass, Builder $query, string $tableName, string $entityIdColumn): Builder
     {
-        $fullEntityIdColumn = $tableName . '.' . $entityIdColumn;
-        $instance = new $entityClass();
-        $morphClass = $instance->getMorphClass();
+        $tableDetails = ['tableName' => $tableName, 'entityIdColumn' => $entityIdColumn];
+        $morphClass = app($entityClass)->getMorphClass();
 
-        $existsQuery = function ($permissionQuery) use ($fullEntityIdColumn, $morphClass) {
-            /** @var Builder $permissionQuery */
-            $permissionQuery->select('joint_permissions.role_id')->from('joint_permissions')
-                ->whereColumn('joint_permissions.entity_id', '=', $fullEntityIdColumn)
-                ->where('joint_permissions.entity_type', '=', $morphClass)
-                ->where('joint_permissions.action', '=', 'view')
-                ->whereIn('joint_permissions.role_id', $this->getCurrentUserRoles())
-                ->where(function (QueryBuilder $query) {
-                    $this->addJointHasPermissionCheck($query, $this->currentUser()->id);
+        $q = $query->where(function ($query) use ($tableDetails, $morphClass) {
+            $query->where(function ($query) use (&$tableDetails, $morphClass) {
+                $query->whereExists(function ($permissionQuery) use (&$tableDetails, $morphClass) {
+                    /** @var Builder $permissionQuery */
+                    $permissionQuery->select('id')->from('joint_permissions')
+                        ->whereColumn('joint_permissions.entity_id', '=', $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn'])
+                        ->where('entity_type', '=', $morphClass)
+                        ->where('action', '=', 'view')
+                        ->whereIn('role_id', $this->getCurrentUserRoles())
+                        ->where(function (QueryBuilder $query) {
+                            $this->addJointHasPermissionCheck($query, $this->currentUser()->id);
+                        });
                 });
-        };
-
-        $q = $query->where(function ($query) use ($existsQuery, $fullEntityIdColumn) {
-            $query->whereExists($existsQuery)
-                ->orWhere($fullEntityIdColumn, '=', 0);
+            })->orWhere($tableDetails['entityIdColumn'], '=', 0);
         });
 
-        if ($instance instanceof Page) {
-            // Prevent visibility of non-owned draft pages
-            $q->whereExists(function (QueryBuilder $query) use ($fullEntityIdColumn) {
-                $query->select('id')->from('pages')
-                    ->whereColumn('pages.id', '=', $fullEntityIdColumn)
-                    ->where(function (QueryBuilder $query) {
-                        $query->where('pages.draft', '=', false)
-                            ->orWhere('pages.owned_by', '=', $this->currentUser()->id);
-                    });
-            });
-        }
-
         $this->clean();
 
         return $q;
@@ -690,9 +666,9 @@ class PermissionService
      */
     protected function addJointHasPermissionCheck($query, int $userIdToCheck)
     {
-        $query->where('joint_permissions.has_permission', '=', true)->orWhere(function ($query) use ($userIdToCheck) {
-            $query->where('joint_permissions.has_permission_own', '=', true)
-                ->where('joint_permissions.owned_by', '=', $userIdToCheck);
+        $query->where('has_permission', '=', true)->orWhere(function ($query) use ($userIdToCheck) {
+            $query->where('has_permission_own', '=', true)
+                ->where('owned_by', '=', $userIdToCheck);
         });
     }
 

app/Auth/Permissions/RolePermission.php

@@ -4,7 +4,6 @@ namespace BookStack\Auth\Permissions;
 
 use BookStack\Auth\Role;
 use BookStack\Model;
-use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 
 /**
  * @property int $id
@@ -14,15 +13,19 @@ class RolePermission extends Model
     /**
      * The roles that belong to the permission.
      */
-    public function roles(): BelongsToMany
+    public function roles()
     {
         return $this->belongsToMany(Role::class, 'permission_role', 'permission_id', 'role_id');
     }
 
     /**
      * Get the permission object by name.
+     *
+     * @param $name
+     *
+     * @return mixed
      */
-    public static function getByName(string $name): ?RolePermission
+    public static function getByName($name)
     {
         return static::where('name', '=', $name)->first();
     }

app/Auth/Role.php

@@ -7,7 +7,6 @@ use BookStack\Auth\Permissions\RolePermission;
 use BookStack\Interfaces\Loggable;
 use BookStack\Model;
 use Illuminate\Database\Eloquent\Collection;
-use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 
@@ -24,8 +23,6 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
  */
 class Role extends Model implements Loggable
 {
-    use HasFactory;
-
     protected $fillable = ['display_name', 'description', 'external_auth_id'];
 
     /**
@@ -86,7 +83,7 @@ class Role extends Model implements Loggable
     /**
      * Get the role of the specified display name.
      */
-    public static function getRole(string $displayName): ?self
+    public static function getRole(string $displayName): ?Role
     {
         return static::query()->where('display_name', '=', $displayName)->first();
     }
@@ -94,7 +91,7 @@ class Role extends Model implements Loggable
     /**
      * Get the role object for the specified system role.
      */
-    public static function getSystemRole(string $systemName): ?self
+    public static function getSystemRole(string $systemName): ?Role
     {
         return static::query()->where('system_name', '=', $systemName)->first();
     }
@@ -119,7 +116,7 @@ class Role extends Model implements Loggable
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function logDescriptor(): string
     {

app/Auth/SocialAccount.php

@@ -21,7 +21,7 @@ class SocialAccount extends Model implements Loggable
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function logDescriptor(): string
     {

app/Auth/User.php

@@ -18,7 +18,6 @@ use Illuminate\Auth\Passwords\CanResetPassword;
 use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
 use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
 use Illuminate\Database\Eloquent\Builder;
-use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasMany;
@@ -28,7 +27,7 @@ use Illuminate\Support\Collection;
 /**
  * Class User.
  *
- * @property int        $id
+ * @property string     $id
  * @property string     $name
  * @property string     $slug
  * @property string     $email
@@ -44,7 +43,6 @@ use Illuminate\Support\Collection;
  */
 class User extends Model implements AuthenticatableContract, CanResetPasswordContract, Loggable, Sluggable
 {
-    use HasFactory;
     use Authenticatable;
     use CanResetPassword;
     use Notifiable;
@@ -92,7 +90,7 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
     /**
      * Returns the default public user.
      */
-    public static function getDefault(): self
+    public static function getDefault(): User
     {
         if (!is_null(static::$defaultUser)) {
             return static::$defaultUser;
@@ -178,6 +176,7 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
             ->leftJoin('permission_role', 'ru.role_id', '=', 'permission_role.role_id')
             ->leftJoin('role_permissions', 'permission_role.permission_id', '=', 'role_permissions.id')
             ->where('ru.user_id', '=', $this->id)
+            ->get()
             ->pluck('name');
 
         return $this->permissions;
@@ -337,7 +336,7 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function logDescriptor(): string
     {
@@ -345,7 +344,7 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function refreshSlug(): string
     {

app/Auth/UserRepo.php

@@ -2,6 +2,7 @@
 
 namespace BookStack\Auth;
 
+use Activity;
 use BookStack\Entities\EntityProvider;
 use BookStack\Entities\Models\Book;
 use BookStack\Entities\Models\Bookshelf;
@@ -62,16 +63,13 @@ class UserRepo
 
     /**
      * Get all the users with their permissions in a paginated format.
-     * Note: Due to the use of email search this should only be used when
-     * user is assumed to be trusted. (Admin users).
-     * Email search can be abused to extract email addresses.
      */
     public function getAllUsersPaginatedAndSorted(int $count, array $sortData): LengthAwarePaginator
     {
         $sort = $sortData['sort'];
 
         $query = User::query()->select(['*'])
-            ->scopes(['withLastActivityAt'])
+            ->withLastActivityAt()
             ->with(['roles', 'avatar'])
             ->withCount('mfaValues')
             ->orderBy($sort, $sortData['order']);
@@ -217,6 +215,14 @@ class UserRepo
         }
     }
 
+    /**
+     * Get the latest activity for a user.
+     */
+    public function getActivity(User $user, int $count = 20, int $page = 0): array
+    {
+        return Activity::userActivity($user, $count, $page);
+    }
+
     /**
      * Get the recently created content for this given user.
      */

app/Config/app.php

@@ -31,9 +31,6 @@ return [
     // Set to -1 for unlimited recycle bin lifetime.
     'recycle_bin_lifetime' => env('RECYCLE_BIN_LIFETIME', 30),
 
-    // The limit for all uploaded files, including images and attachments in MB.
-    'upload_limit' => env('FILE_UPLOAD_SIZE_LIMIT', 50),
-
     // Allow <script> tags to entered within page content.
     // <script> tags are escaped by default.
     // Even when overridden the WYSIWYG editor may still escape script content.
@@ -146,6 +143,7 @@ return [
 
     // Class aliases, Registered on application start
     'aliases' => [
+
         // Laravel
         'App'          => Illuminate\Support\Facades\App::class,
         'Arr'          => Illuminate\Support\Arr::class,
@@ -157,23 +155,21 @@ return [
         'Config'       => Illuminate\Support\Facades\Config::class,
         'Cookie'       => Illuminate\Support\Facades\Cookie::class,
         'Crypt'        => Illuminate\Support\Facades\Crypt::class,
-        'Date'         => Illuminate\Support\Facades\Date::class,
         'DB'           => Illuminate\Support\Facades\DB::class,
         'Eloquent'     => Illuminate\Database\Eloquent\Model::class,
         'Event'        => Illuminate\Support\Facades\Event::class,
         'File'         => Illuminate\Support\Facades\File::class,
-        'Gate'         => Illuminate\Support\Facades\Gate::class,
         'Hash'         => Illuminate\Support\Facades\Hash::class,
-        'Http'         => Illuminate\Support\Facades\Http::class,
+        'Input'        => Illuminate\Support\Facades\Input::class,
+        'Inspiring'    => Illuminate\Foundation\Inspiring::class,
         'Lang'         => Illuminate\Support\Facades\Lang::class,
         'Log'          => Illuminate\Support\Facades\Log::class,
         'Mail'         => Illuminate\Support\Facades\Mail::class,
         'Notification' => Illuminate\Support\Facades\Notification::class,
         'Password'     => Illuminate\Support\Facades\Password::class,
         'Queue'        => Illuminate\Support\Facades\Queue::class,
-        'RateLimiter'  => Illuminate\Support\Facades\RateLimiter::class,
         'Redirect'     => Illuminate\Support\Facades\Redirect::class,
-        // 'Redis'        => Illuminate\Support\Facades\Redis::class,
+        'Redis'        => Illuminate\Support\Facades\Redis::class,
         'Request'      => Illuminate\Support\Facades\Request::class,
         'Response'     => Illuminate\Support\Facades\Response::class,
         'Route'        => Illuminate\Support\Facades\Route::class,
@@ -184,8 +180,6 @@ return [
         'URL'          => Illuminate\Support\Facades\URL::class,
         'Validator'    => Illuminate\Support\Facades\Validator::class,
         'View'         => Illuminate\Support\Facades\View::class,
-
-        // Laravel Packages
         'Socialite'    => Laravel\Socialite\Facades\Socialite::class,
 
         // Third Party

app/Config/auth.php

@@ -10,6 +10,7 @@
 
 return [
 
+    // Method of authentication to use
     // Options: standard, ldap, saml2, oidc
     'method' => env('AUTH_METHOD', 'standard'),
 
@@ -44,7 +45,7 @@ return [
             'provider' => 'external',
         ],
         'api' => [
-            'driver'   => 'api-token',
+            'driver' => 'api-token',
         ],
     ],
 
@@ -57,16 +58,10 @@ return [
             'driver' => 'eloquent',
             'model'  => \BookStack\Auth\User::class,
         ],
-
         'external' => [
             'driver' => 'external-users',
             'model'  => \BookStack\Auth\User::class,
         ],
-
-        // 'users' => [
-        //     'driver' => 'database',
-        //     'table' => 'users',
-        // ],
     ],
 
     // Resetting Passwords
@@ -83,10 +78,4 @@ return [
         ],
     ],
 
-    // Password Confirmation Timeout
-    // Here you may define the amount of seconds before a password confirmation
-    // times out and the user is prompted to re-enter their password via the
-    // confirmation screen. By default, the timeout lasts for three hours.
-    'password_timeout' => 10800,
-
 ];

app/Config/cache.php

@@ -1,7 +1,5 @@
 <?php
 
-use Illuminate\Support\Str;
-
 /**
  * Caching configuration options.
  *
@@ -40,15 +38,13 @@ return [
         ],
 
         'array' => [
-            'driver'    => 'array',
-            'serialize' => false,
+            'driver' => 'array',
         ],
 
         'database' => [
-            'driver'          => 'database',
-            'table'           => 'cache',
-            'connection'      => null,
-            'lock_connection' => null,
+            'driver'     => 'database',
+            'table'      => 'cache',
+            'connection' => null,
         ],
 
         'file' => [
@@ -57,36 +53,19 @@ return [
         ],
 
         'memcached' => [
-            'driver'        => 'memcached',
-            'options'       => [
-                // Memcached::OPT_CONNECT_TIMEOUT => 2000,
-            ],
-            'servers' => $memcachedServers ?? [],
+            'driver'  => 'memcached',
+            'servers' => env('CACHE_DRIVER') === 'memcached' ? $memcachedServers : [],
         ],
 
         'redis' => [
-            'driver'          => 'redis',
-            'connection'      => 'default',
-            'lock_connection' => 'default',
-        ],
-
-        'octane' => [
-            'driver' => 'octane',
+            'driver'     => 'redis',
+            'connection' => 'default',
         ],
 
     ],
 
-    /*
-    |--------------------------------------------------------------------------
-    | Cache Key Prefix
-    |--------------------------------------------------------------------------
-    |
-    | When utilizing a RAM based store such as APC or Memcached, there might
-    | be other applications utilizing the same cache. So, we'll specify a
-    | value to get prefixed to all our keys so we can avoid collisions.
-    |
-    */
-
-    'prefix' => env('CACHE_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_') . '_cache'),
+    // Cache key prefix
+    // Used to prevent collisions in shared cache systems.
+    'prefix' => env('CACHE_PREFIX', 'bookstack_cache'),
 
 ];

app/Config/clockwork.php

@@ -1,415 +0,0 @@
-<?php
-
-return [
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Enable Clockwork
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | Clockwork is enabled by default only when your application is in debug mode. Here you can explicitly enable or
-    | disable Clockwork. When disabled, no data is collected and the api and web ui are inactive.
-    |
-    */
-
-    'enable' => env('CLOCKWORK_ENABLE', false),
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Features
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | You can enable or disable various Clockwork features here. Some features have additional settings (eg. slow query
-    | threshold for database queries).
-    |
-    */
-
-    'features' => [
-
-        // Cache usage stats and cache queries including results
-        'cache' => [
-            'enabled' => true,
-
-            // Collect cache queries
-            'collect_queries' => true,
-
-            // Collect values from cache queries (high performance impact with a very high number of queries)
-            'collect_values' => false,
-        ],
-
-        // Database usage stats and queries
-        'database' => [
-            'enabled' => true,
-
-            // Collect database queries (high performance impact with a very high number of queries)
-            'collect_queries' => true,
-
-            // Collect details of models updates (high performance impact with a lot of model updates)
-            'collect_models_actions' => true,
-
-            // Collect details of retrieved models (very high performance impact with a lot of models retrieved)
-            'collect_models_retrieved' => false,
-
-            // Query execution time threshold in miliseconds after which the query will be marked as slow
-            'slow_threshold' => null,
-
-            // Collect only slow database queries
-            'slow_only' => false,
-
-            // Detect and report duplicate (N+1) queries
-            'detect_duplicate_queries' => false,
-        ],
-
-        // Dispatched events
-        'events' => [
-            'enabled' => true,
-
-            // Ignored events (framework events are ignored by default)
-            'ignored_events' => [
-                // App\Events\UserRegistered::class,
-                // 'user.registered'
-            ],
-        ],
-
-        // Laravel log (you can still log directly to Clockwork with laravel log disabled)
-        'log' => [
-            'enabled' => true,
-        ],
-
-        // Sent notifications
-        'notifications' => [
-            'enabled' => true,
-        ],
-
-        // Performance metrics
-        'performance' => [
-            // Allow collecting of client metrics. Requires separate clockwork-browser npm package.
-            'client_metrics' => true,
-        ],
-
-        // Dispatched queue jobs
-        'queue' => [
-            'enabled' => true,
-        ],
-
-        // Redis commands
-        'redis' => [
-            'enabled' => true,
-        ],
-
-        // Routes list
-        'routes' => [
-            'enabled' => false,
-
-            // Collect only routes from particular namespaces (only application routes by default)
-            'only_namespaces' => ['App'],
-        ],
-
-        // Rendered views
-        'views' => [
-            'enabled' => true,
-
-            // Collect views including view data (high performance impact with a high number of views)
-            'collect_data' => false,
-
-            // Use Twig profiler instead of Laravel events for apps using laravel-twigbridge (more precise, but does
-            // not support collecting view data)
-            'use_twig_profiler' => false,
-        ],
-
-    ],
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Enable web UI
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | Clockwork comes with a web UI accessibla via http://your.app/clockwork. Here you can enable or disable this
-    | feature. You can also set a custom path for the web UI.
-    |
-    */
-
-    'web' => true,
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Enable toolbar
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | Clockwork can show a toolbar with basic metrics on all responses. Here you can enable or disable this feature.
-    | Requires a separate clockwork-browser npm library.
-    | For installation instructions see https://underground.works/clockwork/#docs-viewing-data
-    |
-    */
-
-    'toolbar' => true,
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | HTTP requests collection
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | Clockwork collects data about HTTP requests to your app. Here you can choose which requests should be collected.
-    |
-    */
-
-    'requests' => [
-        // With on-demand mode enabled, Clockwork will only profile requests when the browser extension is open or you
-        // manually pass a "clockwork-profile" cookie or get/post data key.
-        // Optionally you can specify a "secret" that has to be passed as the value to enable profiling.
-        'on_demand' => false,
-
-        // Collect only errors (requests with HTTP 4xx and 5xx responses)
-        'errors_only' => false,
-
-        // Response time threshold in miliseconds after which the request will be marked as slow
-        'slow_threshold' => null,
-
-        // Collect only slow requests
-        'slow_only' => false,
-
-        // Sample the collected requests (eg. set to 100 to collect only 1 in 100 requests)
-        'sample' => false,
-
-        // List of URIs that should not be collected
-        'except' => [
-            '/horizon/.*', // Laravel Horizon requests
-            '/telescope/.*', // Laravel Telescope requests
-            '/_debugbar/.*', // Laravel DebugBar requests
-        ],
-
-        // List of URIs that should be collected, any other URI will not be collected if not empty
-        'only' => [
-            // '/api/.*'
-        ],
-
-        // Don't collect OPTIONS requests, mostly used in the CSRF pre-flight requests and are rarely of interest
-        'except_preflight' => true,
-    ],
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Artisan commands collection
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | Clockwork can collect data about executed artisan commands. Here you can enable and configure which commands
-    | should be collected.
-    |
-    */
-
-    'artisan' => [
-        // Enable or disable collection of executed Artisan commands
-        'collect' => false,
-
-        // List of commands that should not be collected (built-in commands are not collected by default)
-        'except' => [
-            // 'inspire'
-        ],
-
-        // List of commands that should be collected, any other command will not be collected if not empty
-        'only' => [
-            // 'inspire'
-        ],
-
-        // Enable or disable collection of command output
-        'collect_output' => false,
-
-        // Enable or disable collection of built-in Laravel commands
-        'except_laravel_commands' => true,
-    ],
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Queue jobs collection
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | Clockwork can collect data about executed queue jobs. Here you can enable and configure which queue jobs should
-    | be collected.
-    |
-    */
-
-    'queue' => [
-        // Enable or disable collection of executed queue jobs
-        'collect' => false,
-
-        // List of queue jobs that should not be collected
-        'except' => [
-            // App\Jobs\ExpensiveJob::class
-        ],
-
-        // List of queue jobs that should be collected, any other queue job will not be collected if not empty
-        'only' => [
-            // App\Jobs\BuggyJob::class
-        ],
-    ],
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Tests collection
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | Clockwork can collect data about executed tests. Here you can enable and configure which tests should be
-    | collected.
-    |
-    */
-
-    'tests' => [
-        // Enable or disable collection of ran tests
-        'collect' => false,
-
-        // List of tests that should not be collected
-        'except' => [
-            // Tests\Unit\ExampleTest::class
-        ],
-    ],
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Enable data collection when Clockwork is disabled
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | You can enable this setting to collect data even when Clockwork is disabled. Eg. for future analysis.
-    |
-    */
-
-    'collect_data_always' => false,
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Metadata storage
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | Configure how is the metadata collected by Clockwork stored. Two options are available:
-    |   - files - A simple fast storage implementation storing data in one-per-request files.
-    |   - sql - Stores requests in a sql database. Supports MySQL, Postgresql, Sqlite and requires PDO.
-    |
-    */
-
-    'storage' => 'files',
-
-    // Path where the Clockwork metadata is stored
-    'storage_files_path' => storage_path('clockwork'),
-
-    // Compress the metadata files using gzip, trading a little bit of performance for lower disk usage
-    'storage_files_compress' => false,
-
-    // SQL database to use, can be a name of database configured in database.php or a path to a sqlite file
-    'storage_sql_database' => storage_path('clockwork.sqlite'),
-
-    // SQL table name to use, the table is automatically created and udpated when needed
-    'storage_sql_table' => 'clockwork',
-
-    // Maximum lifetime of collected metadata in minutes, older requests will automatically be deleted, false to disable
-    'storage_expiration' => 60 * 24 * 7,
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Authentication
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | Clockwork can be configured to require authentication before allowing access to the collected data. This might be
-    | useful when the application is publicly accessible. Setting to true will enable a simple authentication with a
-    | pre-configured password. You can also pass a class name of a custom implementation.
-    |
-    */
-
-    'authentication' => false,
-
-    // Password for the simple authentication
-    'authentication_password' => 'VerySecretPassword',
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Stack traces collection
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | Clockwork can collect stack traces for log messages and certain data like database queries. Here you can set
-    | whether to collect stack traces, limit the number of collected frames and set further configuration. Collecting
-    | long stack traces considerably increases metadata size.
-    |
-    */
-
-    'stack_traces' => [
-        // Enable or disable collecting of stack traces
-        'enabled' => true,
-
-        // Limit the number of frames to be collected
-        'limit' => 10,
-
-        // List of vendor names to skip when determining caller, common vendors are automatically added
-        'skip_vendors' => [
-            // 'phpunit'
-        ],
-
-        // List of namespaces to skip when determining caller
-        'skip_namespaces' => [
-            // 'Laravel'
-        ],
-
-        // List of class names to skip when determining caller
-        'skip_classes' => [
-            // App\CustomLog::class
-        ],
-
-    ],
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Serialization
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | Clockwork serializes the collected data to json for storage and transfer. Here you can configure certain aspects
-    | of serialization. Serialization has a large effect on the cpu time and memory usage.
-    |
-    */
-
-    // Maximum depth of serialized multi-level arrays and objects
-    'serialization_depth' => 10,
-
-    // A list of classes that will never be serialized (eg. a common service container class)
-    'serialization_blackbox' => [
-        \Illuminate\Container\Container::class,
-        \Illuminate\Foundation\Application::class,
-    ],
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Register helpers
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | Clockwork comes with a "clock" global helper function. You can use this helper to quickly log something and to
-    | access the Clockwork instance.
-    |
-    */
-
-    'register_helpers' => true,
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Send Headers for AJAX request
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | When trying to collect data the AJAX method can sometimes fail if it is missing required headers. For example, an
-    | API might require a version number using Accept headers to route the HTTP request to the correct codebase.
-    |
-    */
-
-    'headers' => [
-        // 'Accept' => 'application/vnd.com.whatever.v1+json',
-    ],
-
-    /*
-    |------------------------------------------------------------------------------------------------------------------
-    | Server-Timing
-    |------------------------------------------------------------------------------------------------------------------
-    |
-    | Clockwork supports the W3C Server Timing specification, which allows for collecting a simple performance metrics
-    | in a cross-browser way. Eg. in Chrome, your app, database and timeline event timings will be shown in the Dev
-    | Tools network tab. This setting specifies the max number of timeline events that will be sent. Setting to false
-    | will disable the feature.
-    |
-    */
-
-    'server_timing' => 10,
-
-];

app/Config/database.php

@@ -105,6 +105,6 @@ return [
     'migrations' => 'migrations',
 
     // Redis configuration to use if set
-    'redis' => $redisConfig ?? [],
+    'redis' => env('REDIS_SERVERS', false) ? $redisConfig : [],
 
 ];

app/Config/filesystems.php

@@ -25,14 +25,16 @@ return [
     // file storage service, such as s3, to store publicly accessible assets.
     'url' => env('STORAGE_URL', false),
 
+    // Default Cloud Filesystem Disk
+    'cloud' => 's3',
+
     // Available filesystem disks
     // Only local, local_secure & s3 are supported by BookStack
     'disks' => [
 
         'local' => [
-            'driver'     => 'local',
-            'root'       => public_path(),
-            'visibility' => 'public',
+            'driver' => 'local',
+            'root'   => public_path(),
         ],
 
         'local_secure_attachments' => [
@@ -41,9 +43,8 @@ return [
         ],
 
         'local_secure_images' => [
-            'driver'     => 'local',
-            'root'       => storage_path('uploads/images/'),
-            'visibility' => 'public',
+            'driver' => 'local',
+            'root'   => storage_path('uploads/images/'),
         ],
 
         's3' => [
@@ -58,12 +59,4 @@ return [
 
     ],
 
-    // Symbolic Links
-    // Here you may configure the symbolic links that will be created when the
-    // `storage:link` Artisan command is executed. The array keys should be
-    // the locations of the links and the values should be their targets.
-    'links' => [
-        public_path('storage') => storage_path('app/public'),
-    ],
-
 ];

app/Config/logging.php

@@ -49,9 +49,16 @@ return [
             'days'   => 7,
         ],
 
+        'slack' => [
+            'driver'   => 'slack',
+            'url'      => env('LOG_SLACK_WEBHOOK_URL'),
+            'username' => 'Laravel Log',
+            'emoji'    => ':boom:',
+            'level'    => 'critical',
+        ],
+
         'stderr' => [
             'driver'  => 'monolog',
-            'level'   => 'debug',
             'handler' => StreamHandler::class,
             'with'    => [
                 'stream' => 'php://stderr',
@@ -92,10 +99,6 @@ return [
         'testing' => [
             'driver' => 'testing',
         ],
-
-        'emergency' => [
-            'path' => storage_path('logs/laravel.log'),
-        ],
     ],
 
     // Failed Login Message

app/Config/mail.php

@@ -11,8 +11,6 @@
 return [
 
     // Mail driver to use.
-    // From Laravel 7+ this is MAIL_MAILER in laravel.
-    // Kept as MAIL_DRIVER in BookStack to prevent breaking change.
     // Options: smtp, sendmail, log, array
     'driver' => env('MAIL_DRIVER', 'smtp'),
 

app/Config/queue.php

@@ -11,7 +11,7 @@
 return [
 
     // Default driver to use for the queue
-    // Options: sync, database, redis
+    // Options: null, sync, redis
     'default' => env('QUEUE_CONNECTION', 'sync'),
 
     // Queue connection configuration
@@ -22,29 +22,25 @@ return [
         ],
 
         'database' => [
-            'driver'       => 'database',
-            'table'        => 'jobs',
-            'queue'        => 'default',
-            'retry_after'  => 90,
-            'after_commit' => false,
+            'driver'      => 'database',
+            'table'       => 'jobs',
+            'queue'       => 'default',
+            'retry_after' => 90,
         ],
 
         'redis' => [
-            'driver'       => 'redis',
-            'connection'   => 'default',
-            'queue'        => env('REDIS_QUEUE', 'default'),
-            'retry_after'  => 90,
-            'block_for'    => null,
-            'after_commit' => false,
+            'driver'      => 'redis',
+            'connection'  => 'default',
+            'queue'       => env('REDIS_QUEUE', 'default'),
+            'retry_after' => 90,
+            'block_for'   => null,
         ],
 
     ],
 
     // Failed queue job logging
     'failed' => [
-        'driver'   => 'database-uuids',
-        'database' => 'mysql',
-        'table'    => 'failed_jobs',
+        'database' => 'mysql', 'table' => 'failed_jobs',
     ],
 
 ];

app/Console/Commands/CreateAdmin.php

@@ -4,10 +4,6 @@ namespace BookStack\Console\Commands;
 
 use BookStack\Auth\UserRepo;
 use Illuminate\Console\Command;
-use Illuminate\Support\Facades\Validator;
-use Illuminate\Validation\Rules\Password;
-use Illuminate\Validation\Rules\Unique;
-use Symfony\Component\Console\Command\Command as SymfonyCommand;
 
 class CreateAdmin extends Command
 {
@@ -48,40 +44,40 @@ class CreateAdmin extends Command
      */
     public function handle()
     {
-        $details = $this->options();
-
-        if (empty($details['email'])) {
-            $details['email'] = $this->ask('Please specify an email address for the new admin user');
+        $email = trim($this->option('email'));
+        if (empty($email)) {
+            $email = $this->ask('Please specify an email address for the new admin user');
         }
-        if (empty($details['name'])) {
-            $details['name'] = $this->ask('Please specify a name for the new admin user');
-        }
-        if (empty($details['password'])) {
-            $details['password'] = $this->ask('Please specify a password for the new admin user (8 characters min)');
+        if (mb_strlen($email) < 5 || !filter_var($email, FILTER_VALIDATE_EMAIL)) {
+            return $this->error('Invalid email address provided');
         }
 
-        $validator = Validator::make($details, [
-            'email'    => ['required', 'email', 'min:5', new Unique('users', 'email')],
-            'name'     => ['required', 'min:2'],
-            'password' => ['required', Password::default()],
-        ]);
-
-        if ($validator->fails()) {
-            foreach ($validator->errors()->all() as $error) {
-                $this->error($error);
-            }
-
-            return SymfonyCommand::FAILURE;
+        if ($this->userRepo->getByEmail($email) !== null) {
+            return $this->error('A user with the provided email already exists!');
         }
 
-        $user = $this->userRepo->create($validator->validated());
+        $name = trim($this->option('name'));
+        if (empty($name)) {
+            $name = $this->ask('Please specify an name for the new admin user');
+        }
+        if (mb_strlen($name) < 2) {
+            return $this->error('Invalid name provided');
+        }
+
+        $password = trim($this->option('password'));
+        if (empty($password)) {
+            $password = $this->secret('Please specify a password for the new admin user');
+        }
+        if (mb_strlen($password) < 5) {
+            return $this->error('Invalid password provided, Must be at least 5 characters');
+        }
+
+        $user = $this->userRepo->create(['email' => $email, 'name' => $name, 'password' => $password]);
         $this->userRepo->attachSystemRole($user, 'admin');
         $this->userRepo->downloadAndAssignUserAvatar($user);
         $user->email_confirmed = true;
         $user->save();
 
         $this->info("Admin account with email \"{$user->email}\" successfully created!");
-
-        return SymfonyCommand::SUCCESS;
     }
 }

app/Console/Commands/RegenerateSearch.php

@@ -2,7 +2,6 @@
 
 namespace BookStack\Console\Commands;
 
-use BookStack\Entities\Models\Entity;
 use BookStack\Entities\Tools\SearchIndex;
 use Illuminate\Console\Command;
 use Illuminate\Support\Facades\DB;
@@ -23,9 +22,6 @@ class RegenerateSearch extends Command
      */
     protected $description = 'Re-index all content for searching';
 
-    /**
-     * @var SearchIndex
-     */
     protected $searchIndex;
 
     /**
@@ -49,13 +45,8 @@ class RegenerateSearch extends Command
             DB::setDefaultConnection($this->option('database'));
         }
 
-        $this->searchIndex->indexAllEntities(function (Entity $model, int $processed, int $total): void {
-            $this->info('Indexed ' . class_basename($model) . ' entries (' . $processed . '/' . $total . ')');
-        });
-
+        $this->searchIndex->indexAllEntities();
         DB::setDefaultConnection($connection);
-        $this->line('Search index regenerated!');
-
-        return static::SUCCESS;
+        $this->comment('Search index regenerated');
     }
 }

app/Console/Commands/ResetMfa.php

@@ -49,10 +49,9 @@ class ResetMfa extends Command
             return 1;
         }
 
+        /** @var User $user */
         $field = $id ? 'id' : 'email';
         $value = $id ?: $email;
-
-        /** @var User $user */
         $user = User::query()
             ->where($field, '=', $value)
             ->first();

app/Entities/Models/Book.php

@@ -4,7 +4,6 @@ namespace BookStack\Entities\Models;
 
 use BookStack\Uploads\Image;
 use Exception;
-use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasMany;
@@ -22,9 +21,7 @@ use Illuminate\Support\Collection;
  */
 class Book extends Entity implements HasCoverImage
 {
-    use HasFactory;
-
-    public $searchFactor = 1.2;
+    public $searchFactor = 2;
 
     protected $fillable = ['name', 'description'];
     protected $hidden = ['restricted', 'pivot', 'image_id', 'deleted_at'];
@@ -79,43 +76,53 @@ class Book extends Entity implements HasCoverImage
 
     /**
      * Get all pages within this book.
+     *
+     * @return HasMany
      */
-    public function pages(): HasMany
+    public function pages()
     {
         return $this->hasMany(Page::class);
     }
 
     /**
      * Get the direct child pages of this book.
+     *
+     * @return HasMany
      */
-    public function directPages(): HasMany
+    public function directPages()
     {
         return $this->pages()->where('chapter_id', '=', '0');
     }
 
     /**
      * Get all chapters within this book.
+     *
+     * @return HasMany
      */
-    public function chapters(): HasMany
+    public function chapters()
     {
         return $this->hasMany(Chapter::class);
     }
 
     /**
      * Get the shelves this book is contained within.
+     *
+     * @return BelongsToMany
      */
-    public function shelves(): BelongsToMany
+    public function shelves()
     {
         return $this->belongsToMany(Bookshelf::class, 'bookshelves_books', 'book_id', 'bookshelf_id');
     }
 
     /**
      * Get the direct child items within this book.
+     *
+     * @return Collection
      */
     public function getDirectChildren(): Collection
     {
-        $pages = $this->directPages()->scopes('visible')->get();
-        $chapters = $this->chapters()->scopes('visible')->get();
+        $pages = $this->directPages()->visible()->get();
+        $chapters = $this->chapters()->visible()->get();
 
         return $pages->concat($chapters)->sortBy('priority')->sortByDesc('draft');
     }

app/Entities/Models/Bookshelf.php

@@ -3,17 +3,14 @@
 namespace BookStack\Entities\Models;
 
 use BookStack\Uploads\Image;
-use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 
 class Bookshelf extends Entity implements HasCoverImage
 {
-    use HasFactory;
-
     protected $table = 'bookshelves';
 
-    public $searchFactor = 1.2;
+    public $searchFactor = 3;
 
     protected $fillable = ['name', 'description', 'image_id'];
 
@@ -37,7 +34,7 @@ class Bookshelf extends Entity implements HasCoverImage
      */
     public function visibleBooks(): BelongsToMany
     {
-        return $this->books()->scopes('visible');
+        return $this->books()->visible();
     }
 
     /**

app/Entities/Models/Chapter.php

@@ -2,31 +2,29 @@
 
 namespace BookStack\Entities\Models;
 
-use Illuminate\Database\Eloquent\Factories\HasFactory;
-use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Support\Collection;
 
 /**
  * Class Chapter.
  *
  * @property Collection<Page> $pages
- * @property string           $description
+ * @property mixed description
  */
 class Chapter extends BookChild
 {
-    use HasFactory;
+    public $searchFactor = 1.3;
 
-    public $searchFactor = 1.2;
-
-    protected $fillable = ['name', 'description', 'priority'];
+    protected $fillable = ['name', 'description', 'priority', 'book_id'];
     protected $hidden = ['restricted', 'pivot', 'deleted_at'];
 
     /**
      * Get the pages that this chapter contains.
      *
-     * @return HasMany<Page>
+     * @param string $dir
+     *
+     * @return mixed
      */
-    public function pages(string $dir = 'ASC'): HasMany
+    public function pages($dir = 'ASC')
     {
         return $this->hasMany(Page::class)->orderBy('priority', $dir);
     }
@@ -34,7 +32,7 @@ class Chapter extends BookChild
     /**
      * Get the url of this chapter.
      */
-    public function getUrl(string $path = ''): string
+    public function getUrl($path = ''): string
     {
         $parts = [
             'books',
@@ -52,8 +50,7 @@ class Chapter extends BookChild
      */
     public function getVisiblePages(): Collection
     {
-        return $this->pages()
-        ->scopes('visible')
+        return $this->pages()->visible()
         ->orderBy('draft', 'desc')
         ->orderBy('priority', 'asc')
         ->get();

app/Entities/Models/Deletion.php

@@ -3,14 +3,13 @@
 namespace BookStack\Entities\Models;
 
 use BookStack\Auth\User;
-use BookStack\Interfaces\Deletable;
 use BookStack\Interfaces\Loggable;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 
 /**
- * @property Deletable $deletable
+ * @property Model deletable
  */
 class Deletion extends Model implements Loggable
 {
@@ -23,7 +22,7 @@ class Deletion extends Model implements Loggable
     }
 
     /**
-     * Get the user that performed the deletion.
+     * The the user that performed the deletion.
      */
     public function deleter(): BelongsTo
     {
@@ -33,7 +32,7 @@ class Deletion extends Model implements Loggable
     /**
      * Create a new deletion record for the provided entity.
      */
-    public static function createForEntity(Entity $entity): self
+    public static function createForEntity(Entity $entity): Deletion
     {
         $record = (new self())->forceFill([
             'deleted_by'     => user()->id,
@@ -49,11 +48,7 @@ class Deletion extends Model implements Loggable
     {
         $deletable = $this->deletable()->first();
 
-        if ($deletable instanceof Entity) {
-            return "Deletion ({$this->id}) for {$deletable->getType()} ({$deletable->id}) {$deletable->name}";
-        }
-
-        return "Deletion ({$this->id})";
+        return "Deletion ({$this->id}) for {$deletable->getType()} ({$deletable->id}) {$deletable->name}";
     }
 
     /**

app/Entities/Models/Entity.php

@@ -12,9 +12,7 @@ use BookStack\Auth\Permissions\JointPermission;
 use BookStack\Entities\Tools\SearchIndex;
 use BookStack\Entities\Tools\SlugGenerator;
 use BookStack\Facades\Permissions;
-use BookStack\Interfaces\Deletable;
 use BookStack\Interfaces\Favouritable;
-use BookStack\Interfaces\Loggable;
 use BookStack\Interfaces\Sluggable;
 use BookStack\Interfaces\Viewable;
 use BookStack\Model;
@@ -46,7 +44,7 @@ use Illuminate\Database\Eloquent\SoftDeletes;
  * @method static Builder withLastView()
  * @method static Builder withViewCount()
  */
-abstract class Entity extends Model implements Sluggable, Favouritable, Viewable, Deletable, Loggable
+abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
 {
     use SoftDeletes;
     use HasCreatorAndUpdater;
@@ -108,7 +106,7 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
      * Compares this entity to another given entity.
      * Matches by comparing class and id.
      */
-    public function matches(self $entity): bool
+    public function matches(Entity $entity): bool
     {
         return [get_class($this), $this->id] === [get_class($entity), $entity->id];
     }
@@ -116,17 +114,17 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
     /**
      * Checks if the current entity matches or contains the given.
      */
-    public function matchesOrContains(self $entity): bool
+    public function matchesOrContains(Entity $entity): bool
     {
         if ($this->matches($entity)) {
             return true;
         }
 
-        if (($entity instanceof BookChild) && $this instanceof Book) {
+        if (($entity->isA('chapter') || $entity->isA('page')) && $this->isA('book')) {
             return $entity->book_id === $this->id;
         }
 
-        if ($entity instanceof Page && $this instanceof Chapter) {
+        if ($entity->isA('page') && $this->isA('chapter')) {
             return $entity->chapter_id === $this->id;
         }
 
@@ -212,8 +210,6 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
     /**
      * Check if this instance or class is a certain type of entity.
      * Examples of $type are 'page', 'book', 'chapter'.
-     *
-     * @deprecated Use instanceof instead.
      */
     public static function isA(string $type): bool
     {
@@ -242,12 +238,20 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
         return mb_substr($this->name, 0, $length - 3) . '...';
     }
 
+    /**
+     * Get the body text of this entity.
+     */
+    public function getText(): string
+    {
+        return $this->{$this->textField} ?? '';
+    }
+
     /**
      * Get an excerpt of this entity's descriptive content to the specified length.
      */
     public function getExcerpt(int $length = 100): string
     {
-        $text = $this->{$this->textField} ?? '';
+        $text = $this->getText();
 
         if (mb_strlen($text) > $length) {
             $text = mb_substr($text, 0, $length - 3) . '...';
@@ -266,7 +270,7 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
      * This is the "static" parent and does not include dynamic
      * relations such as shelves to books.
      */
-    public function getParent(): ?self
+    public function getParent(): ?Entity
     {
         if ($this instanceof Page) {
             return $this->chapter_id ? $this->chapter()->withTrashed()->first() : $this->book()->withTrashed()->first();
@@ -296,7 +300,7 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function refreshSlug(): string
     {
@@ -306,7 +310,7 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function favourites(): MorphMany
     {
@@ -322,12 +326,4 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
             ->where('user_id', '=', user()->id)
             ->exists();
     }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function logDescriptor(): string
-    {
-        return "({$this->id}) {$this->name}";
-    }
 }

app/Entities/Models/Page.php

@@ -3,13 +3,12 @@
 namespace BookStack\Entities\Models;
 
 use BookStack\Entities\Tools\PageContent;
-use BookStack\Facades\Permissions;
 use BookStack\Uploads\Attachment;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection;
-use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use Permissions;
 
 /**
  * Class Page.
@@ -26,8 +25,6 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
  */
 class Page extends BookChild
 {
-    use HasFactory;
-
     public static $listAttributes = ['name', 'id', 'slug', 'book_id', 'chapter_id', 'draft', 'template', 'text', 'created_at', 'updated_at', 'priority'];
     public static $contentAttributes = ['name', 'id', 'slug', 'book_id', 'chapter_id', 'draft', 'template', 'html', 'text', 'created_at', 'updated_at', 'priority'];
 
@@ -64,8 +61,10 @@ class Page extends BookChild
 
     /**
      * Check if this page has a chapter.
+     *
+     * @return bool
      */
-    public function hasChapter(): bool
+    public function hasChapter()
     {
         return $this->chapter()->count() > 0;
     }
@@ -104,7 +103,7 @@ class Page extends BookChild
     /**
      * Get the url of this page.
      */
-    public function getUrl(string $path = ''): string
+    public function getUrl($path = ''): string
     {
         $parts = [
             'books',
@@ -130,7 +129,7 @@ class Page extends BookChild
     /**
      * Get this page for JSON display.
      */
-    public function forJsonDisplay(): self
+    public function forJsonDisplay(): Page
     {
         $refreshed = $this->refresh()->unsetRelations()->load(['tags', 'createdBy', 'updatedBy', 'ownedBy']);
         $refreshed->setHidden(array_diff($refreshed->getHidden(), ['html', 'markdown']));

app/Entities/Models/PageRevision.php

@@ -22,7 +22,6 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo;
  * @property string $html
  * @property int    $revision_number
  * @property Page   $page
- * @property-read ?User $createdBy
  */
 class PageRevision extends Model
 {
@@ -63,8 +62,10 @@ class PageRevision extends Model
 
     /**
      * Get the previous revision for the same page if existing.
+     *
+     * @return \BookStack\Entities\PageRevision|null
      */
-    public function getPrevious(): ?PageRevision
+    public function getPrevious()
     {
         $id = static::newQuery()->where('page_id', '=', $this->page_id)
             ->where('id', '<', $this->id)
@@ -82,9 +83,11 @@ class PageRevision extends Model
      * Included here to align with entities in similar use cases.
      * (Yup, Bit of an awkward hack).
      *
-     * @deprecated Use instanceof instead.
+     * @param $type
+     *
+     * @return bool
      */
-    public static function isA(string $type): bool
+    public static function isA($type)
     {
         return $type === 'revision';
     }

app/Entities/Repos/BaseRepo.php

@@ -67,12 +67,10 @@ class BaseRepo
     /**
      * Update the given items' cover image, or clear it.
      *
-     * @param Entity&HasCoverImage $entity
-     *
      * @throws ImageUploadException
      * @throws \Exception
      */
-    public function updateCoverImage($entity, ?UploadedFile $coverImage, bool $removeImage = false)
+    public function updateCoverImage(HasCoverImage $entity, ?UploadedFile $coverImage, bool $removeImage = false)
     {
         if ($coverImage) {
             $this->imageRepo->destroyImage($entity->cover);

app/Entities/Repos/BookRepo.php

@@ -91,7 +91,7 @@ class BookRepo
     {
         $book = new Book();
         $this->baseRepo->create($book, $input);
-        Activity::add(ActivityType::BOOK_CREATE, $book);
+        Activity::addForEntity($book, ActivityType::BOOK_CREATE);
 
         return $book;
     }
@@ -102,7 +102,7 @@ class BookRepo
     public function update(Book $book, array $input): Book
     {
         $this->baseRepo->update($book, $input);
-        Activity::add(ActivityType::BOOK_UPDATE, $book);
+        Activity::addForEntity($book, ActivityType::BOOK_UPDATE);
 
         return $book;
     }
@@ -127,7 +127,7 @@ class BookRepo
     {
         $trashCan = new TrashCan();
         $trashCan->softDestroyBook($book);
-        Activity::add(ActivityType::BOOK_DELETE, $book);
+        Activity::addForEntity($book, ActivityType::BOOK_DELETE);
 
         $trashCan->autoClearOld();
     }

app/Entities/Repos/BookshelfRepo.php

@@ -90,7 +90,7 @@ class BookshelfRepo
         $shelf = new Bookshelf();
         $this->baseRepo->create($shelf, $input);
         $this->updateBooks($shelf, $bookIds);
-        Activity::add(ActivityType::BOOKSHELF_CREATE, $shelf);
+        Activity::addForEntity($shelf, ActivityType::BOOKSHELF_CREATE);
 
         return $shelf;
     }
@@ -106,7 +106,7 @@ class BookshelfRepo
             $this->updateBooks($shelf, $bookIds);
         }
 
-        Activity::add(ActivityType::BOOKSHELF_UPDATE, $shelf);
+        Activity::addForEntity($shelf, ActivityType::BOOKSHELF_UPDATE);
 
         return $shelf;
     }
@@ -124,8 +124,7 @@ class BookshelfRepo
 
         $syncData = Book::visible()
             ->whereIn('id', $bookIds)
-            ->pluck('id')
-            ->mapWithKeys(function ($bookId) use ($numericIDs) {
+            ->get(['id'])->pluck('id')->mapWithKeys(function ($bookId) use ($numericIDs) {
                 return [$bookId => ['order' => $numericIDs->search($bookId)]];
             });
 
@@ -177,7 +176,7 @@ class BookshelfRepo
     {
         $trashCan = new TrashCan();
         $trashCan->softDestroyShelf($shelf);
-        Activity::add(ActivityType::BOOKSHELF_DELETE, $shelf);
+        Activity::addForEntity($shelf, ActivityType::BOOKSHELF_DELETE);
         $trashCan->autoClearOld();
     }
 }

app/Entities/Repos/ChapterRepo.php

@@ -5,12 +5,10 @@ namespace BookStack\Entities\Repos;
 use BookStack\Actions\ActivityType;
 use BookStack\Entities\Models\Book;
 use BookStack\Entities\Models\Chapter;
-use BookStack\Entities\Models\Entity;
 use BookStack\Entities\Tools\BookContents;
 use BookStack\Entities\Tools\TrashCan;
 use BookStack\Exceptions\MoveOperationException;
 use BookStack\Exceptions\NotFoundException;
-use BookStack\Exceptions\PermissionsException;
 use BookStack\Facades\Activity;
 use Exception;
 
@@ -51,7 +49,7 @@ class ChapterRepo
         $chapter->book_id = $parentBook->id;
         $chapter->priority = (new BookContents($parentBook))->getLastPriority() + 1;
         $this->baseRepo->create($chapter, $input);
-        Activity::add(ActivityType::CHAPTER_CREATE, $chapter);
+        Activity::addForEntity($chapter, ActivityType::CHAPTER_CREATE);
 
         return $chapter;
     }
@@ -62,7 +60,7 @@ class ChapterRepo
     public function update(Chapter $chapter, array $input): Chapter
     {
         $this->baseRepo->update($chapter, $input);
-        Activity::add(ActivityType::CHAPTER_UPDATE, $chapter);
+        Activity::addForEntity($chapter, ActivityType::CHAPTER_UPDATE);
 
         return $chapter;
     }
@@ -76,7 +74,7 @@ class ChapterRepo
     {
         $trashCan = new TrashCan();
         $trashCan->softDestroyChapter($chapter);
-        Activity::add(ActivityType::CHAPTER_DELETE, $chapter);
+        Activity::addForEntity($chapter, ActivityType::CHAPTER_DELETE);
         $trashCan->autoClearOld();
     }
 
@@ -86,43 +84,27 @@ class ChapterRepo
      * 'book:<id>' (book:5).
      *
      * @throws MoveOperationException
-     * @throws PermissionsException
      */
     public function move(Chapter $chapter, string $parentIdentifier): Book
     {
-        $parent = $this->findParentByIdentifier($parentIdentifier);
-        if (is_null($parent)) {
-            throw new MoveOperationException('Book to move chapter into not found');
-        }
-
-        if (!userCan('chapter-create', $parent)) {
-            throw new PermissionsException('User does not have permission to create a chapter within the chosen book');
-        }
-
-        $chapter->changeBook($parent->id);
-        $chapter->rebuildPermissions();
-        Activity::add(ActivityType::CHAPTER_MOVE, $chapter);
-
-        return $parent;
-    }
-
-    /**
-     * Find a page parent entity via an identifier string in the format:
-     * {type}:{id}
-     * Example: (book:5).
-     *
-     * @throws MoveOperationException
-     */
-    public function findParentByIdentifier(string $identifier): ?Book
-    {
-        $stringExploded = explode(':', $identifier);
+        $stringExploded = explode(':', $parentIdentifier);
         $entityType = $stringExploded[0];
         $entityId = intval($stringExploded[1]);
 
         if ($entityType !== 'book') {
-            throw new MoveOperationException('Chapters can only be in books');
+            throw new MoveOperationException('Chapters can only be moved into books');
         }
 
-        return Book::visible()->where('id', '=', $entityId)->first();
+        /** @var Book $parent */
+        $parent = Book::visible()->where('id', '=', $entityId)->first();
+        if ($parent === null) {
+            throw new MoveOperationException('Book to move chapter into not found');
+        }
+
+        $chapter->changeBook($parent->id);
+        $chapter->rebuildPermissions();
+        Activity::addForEntity($chapter, ActivityType::CHAPTER_MOVE);
+
+        return $parent;
     }
 }

app/Entities/Repos/PageRepo.php

@@ -69,10 +69,9 @@ class PageRepo
      */
     public function getByOldSlug(string $bookSlug, string $pageSlug): ?Page
     {
-        /** @var ?PageRevision $revision */
         $revision = PageRevision::query()
             ->whereHas('page', function (Builder $query) {
-                $query->scopes('visible');
+                $query->visible();
             })
             ->where('slug', '=', $pageSlug)
             ->where('type', '=', 'version')
@@ -81,7 +80,7 @@ class PageRepo
             ->with('page')
             ->first();
 
-        return $revision->page ?? null;
+        return $revision ? $revision->page : null;
     }
 
     /**
@@ -158,8 +157,8 @@ class PageRepo
      */
     public function publishDraft(Page $draft, array $input): Page
     {
-        $this->updateTemplateStatusAndContentFromInput($draft, $input);
         $this->baseRepo->update($draft, $input);
+        $this->updateTemplateStatusAndContentFromInput($draft, $input);
 
         $draft->draft = false;
         $draft->revision_count = 1;
@@ -171,7 +170,7 @@ class PageRepo
         $draft->indexForSearch();
         $draft->refresh();
 
-        Activity::add(ActivityType::PAGE_CREATE, $draft);
+        Activity::addForEntity($draft, ActivityType::PAGE_CREATE);
 
         return $draft;
     }
@@ -205,7 +204,7 @@ class PageRepo
             $this->savePageRevision($page, $summary);
         }
 
-        Activity::add(ActivityType::PAGE_UPDATE, $page);
+        Activity::addForEntity($page, ActivityType::PAGE_UPDATE);
 
         return $page;
     }
@@ -253,7 +252,9 @@ class PageRepo
     {
         // If the page itself is a draft simply update that
         if ($page->draft) {
-            $this->updateTemplateStatusAndContentFromInput($page, $input);
+            if (isset($input['html'])) {
+                (new PageContent($page))->setNewHTML($input['html']);
+            }
             $page->fill($input);
             $page->save();
 
@@ -281,7 +282,7 @@ class PageRepo
     {
         $trashCan = new TrashCan();
         $trashCan->softDestroyPage($page);
-        Activity::add(ActivityType::PAGE_DELETE, $page);
+        Activity::addForEntity($page, ActivityType::PAGE_DELETE);
         $trashCan->autoClearOld();
     }
 
@@ -291,8 +292,6 @@ class PageRepo
     public function restoreRevision(Page $page, int $revisionId): Page
     {
         $page->revision_count++;
-
-        /** @var PageRevision $revision */
         $revision = $page->revisions()->where('id', '=', $revisionId)->first();
 
         $page->fill($revision->toArray());
@@ -312,7 +311,7 @@ class PageRepo
         $summary = trans('entities.pages_revision_restored_from', ['id' => strval($revisionId), 'summary' => $revision->summary]);
         $this->savePageRevision($page, $summary);
 
-        Activity::add(ActivityType::PAGE_RESTORE, $page);
+        Activity::addForEntity($page, ActivityType::PAGE_RESTORE);
 
         return $page;
     }
@@ -328,7 +327,7 @@ class PageRepo
     public function move(Page $page, string $parentIdentifier): Entity
     {
         $parent = $this->findParentByIdentifier($parentIdentifier);
-        if (is_null($parent)) {
+        if ($parent === null) {
             throw new MoveOperationException('Book or chapter to move page into not found');
         }
 
@@ -337,23 +336,59 @@ class PageRepo
         }
 
         $page->chapter_id = ($parent instanceof Chapter) ? $parent->id : null;
-        $newBookId = ($parent instanceof Chapter) ? $parent->book->id : $parent->id;
-        $page->changeBook($newBookId);
+        $page->changeBook($parent instanceof Book ? $parent->id : $parent->book->id);
         $page->rebuildPermissions();
 
-        Activity::add(ActivityType::PAGE_MOVE, $page);
+        Activity::addForEntity($page, ActivityType::PAGE_MOVE);
 
         return $parent;
     }
 
     /**
-     * Find a page parent entity via an identifier string in the format:
+     * Copy an existing page in the system.
+     * Optionally providing a new parent via string identifier and a new name.
+     *
+     * @throws MoveOperationException
+     * @throws PermissionsException
+     */
+    public function copy(Page $page, string $parentIdentifier = null, string $newName = null): Page
+    {
+        $parent = $parentIdentifier ? $this->findParentByIdentifier($parentIdentifier) : $page->getParent();
+        if ($parent === null) {
+            throw new MoveOperationException('Book or chapter to move page into not found');
+        }
+
+        if (!userCan('page-create', $parent)) {
+            throw new PermissionsException('User does not have permission to create a page within the new parent');
+        }
+
+        $copyPage = $this->getNewDraftPage($parent);
+        $pageData = $page->getAttributes();
+
+        // Update name
+        if (!empty($newName)) {
+            $pageData['name'] = $newName;
+        }
+
+        // Copy tags from previous page if set
+        if ($page->tags) {
+            $pageData['tags'] = [];
+            foreach ($page->tags as $tag) {
+                $pageData['tags'][] = ['name' => $tag->name, 'value' => $tag->value];
+            }
+        }
+
+        return $this->publishDraft($copyPage, $pageData);
+    }
+
+    /**
+     * Find a page parent entity via a identifier string in the format:
      * {type}:{id}
      * Example: (book:5).
      *
      * @throws MoveOperationException
      */
-    public function findParentByIdentifier(string $identifier): ?Entity
+    protected function findParentByIdentifier(string $identifier): ?Entity
     {
         $stringExploded = explode(':', $identifier);
         $entityType = $stringExploded[0];
@@ -373,7 +408,7 @@ class PageRepo
      */
     protected function changeParent(Page $page, Entity $parent)
     {
-        $book = ($parent instanceof Chapter) ? $parent->book : $parent;
+        $book = ($parent instanceof Book) ? $parent : $parent->book;
         $page->chapter_id = ($parent instanceof Chapter) ? $parent->id : 0;
         $page->save();
 
@@ -434,7 +469,6 @@ class PageRepo
     {
         $parent = $page->getParent();
         if ($parent instanceof Chapter) {
-            /** @var ?Page $lastPage */
             $lastPage = $parent->pages('desc')->first();
 
             return $lastPage ? $lastPage->priority + 1 : 0;

app/Entities/Tools/BookContents.php

@@ -7,6 +7,7 @@ use BookStack\Entities\Models\BookChild;
 use BookStack\Entities\Models\Chapter;
 use BookStack\Entities\Models\Entity;
 use BookStack\Entities\Models\Page;
+use BookStack\Exceptions\SortOperationException;
 use Illuminate\Support\Collection;
 
 class BookContents
@@ -66,7 +67,7 @@ class BookContents
         $all->each(function (Entity $entity) use ($renderPages) {
             $entity->setRelation('book', $this->book);
 
-            if ($renderPages && $entity instanceof Page) {
+            if ($renderPages && $entity->isA('page')) {
                 $entity->html = (new PageContent($entity))->render();
             }
         });
@@ -106,209 +107,111 @@ class BookContents
     }
 
     /**
-     * Sort the books content using the given sort map.
+     * Sort the books content using the given map.
+     * The map is a single-dimension collection of objects in the following format:
+     *   {
+     *     +"id": "294" (ID of item)
+     *     +"sort": 1 (Sort order index)
+     *     +"parentChapter": false (ID of parent chapter, as string, or false)
+     *     +"type": "page" (Entity type of item)
+     *     +"book": "1" (Id of book to place item in)
+     *   }.
+     *
      * Returns a list of books that were involved in the operation.
      *
-     * @returns Book[]
+     * @throws SortOperationException
      */
-    public function sortUsingMap(BookSortMap $sortMap): array
+    public function sortUsingMap(Collection $sortMap): Collection
     {
         // Load models into map
-        $modelMap = $this->loadModelsFromSortMap($sortMap);
-
-        // Sort our changes from our map to be chapters first
-        // Since they need to be process to ensure book alignment for child page changes.
-        $sortMapItems = $sortMap->all();
-        usort($sortMapItems, function (BookSortMapItem $itemA, BookSortMapItem $itemB) {
-            $aScore = $itemA->type === 'page' ? 2 : 1;
-            $bScore = $itemB->type === 'page' ? 2 : 1;
-
-            return $aScore - $bScore;
-        });
+        $this->loadModelsIntoSortMap($sortMap);
+        $booksInvolved = $this->getBooksInvolvedInSort($sortMap);
 
         // Perform the sort
-        foreach ($sortMapItems as $item) {
-            $this->applySortUpdates($item, $modelMap);
-        }
+        $sortMap->each(function ($mapItem) {
+            $this->applySortUpdates($mapItem);
+        });
 
-        /** @var Book[] $booksInvolved */
-        $booksInvolved = array_values(array_filter($modelMap, function (string $key) {
-            return strpos($key, 'book:') === 0;
-        }, ARRAY_FILTER_USE_KEY));
-
-        // Update permissions of books involved
-        foreach ($booksInvolved as $book) {
+        // Update permissions and activity.
+        $booksInvolved->each(function (Book $book) {
             $book->rebuildPermissions();
-        }
+        });
 
         return $booksInvolved;
     }
 
     /**
      * Using the given sort map item, detect changes for the related model
-     * and update it if required. Changes where permissions are lacking will
-     * be skipped and not throw an error.
-     *
-     * @param array<string, Entity> $modelMap
+     * and update it if required.
      */
-    protected function applySortUpdates(BookSortMapItem $sortMapItem, array $modelMap): void
+    protected function applySortUpdates(\stdClass $sortMapItem)
     {
         /** @var BookChild $model */
-        $model = $modelMap[$sortMapItem->type . ':' . $sortMapItem->id] ?? null;
-        if (!$model) {
-            return;
-        }
+        $model = $sortMapItem->model;
 
-        $priorityChanged = $model->priority !== $sortMapItem->sort;
-        $bookChanged = $model->book_id !== $sortMapItem->parentBookId;
-        $chapterChanged = ($model instanceof Page) && $model->chapter_id !== $sortMapItem->parentChapterId;
+        $priorityChanged = intval($model->priority) !== intval($sortMapItem->sort);
+        $bookChanged = intval($model->book_id) !== intval($sortMapItem->book);
+        $chapterChanged = ($sortMapItem->type === 'page') && intval($model->chapter_id) !== $sortMapItem->parentChapter;
 
-        // Stop if there's no change
-        if (!$priorityChanged && !$bookChanged && !$chapterChanged) {
-            return;
-        }
-
-        $currentParentKey = 'book:' . $model->book_id;
-        if ($model instanceof Page && $model->chapter_id) {
-            $currentParentKey = 'chapter:' . $model->chapter_id;
-        }
-
-        $currentParent = $modelMap[$currentParentKey] ?? null;
-        /** @var Book $newBook */
-        $newBook = $modelMap['book:' . $sortMapItem->parentBookId] ?? null;
-        /** @var ?Chapter $newChapter */
-        $newChapter = $sortMapItem->parentChapterId ? ($modelMap['chapter:' . $sortMapItem->parentChapterId] ?? null) : null;
-
-        if (!$this->isSortChangePermissible($sortMapItem, $model, $currentParent, $newBook, $newChapter)) {
-            return;
-        }
-
-        // Action the required changes
         if ($bookChanged) {
-            $model->changeBook($newBook->id);
+            $model->changeBook($sortMapItem->book);
         }
 
         if ($chapterChanged) {
-            $model->chapter_id = $newChapter->id ?? 0;
+            $model->chapter_id = intval($sortMapItem->parentChapter);
+            $model->save();
         }
 
         if ($priorityChanged) {
-            $model->priority = $sortMapItem->sort;
-        }
-
-        if ($chapterChanged || $priorityChanged) {
+            $model->priority = intval($sortMapItem->sort);
             $model->save();
         }
     }
 
     /**
-     * Check if the current user has permissions to apply the given sorting change.
-     * Is quite complex since items can gain a different parent change. Acts as a:
-     * - Update of old parent element (Change of content/order).
-     * - Update of sorted/moved element.
-     * - Deletion of element (Relative to parent upon move).
-     * - Creation of element within parent (Upon move to new parent).
+     * Load models from the database into the given sort map.
      */
-    protected function isSortChangePermissible(BookSortMapItem $sortMapItem, BookChild $model, ?Entity $currentParent, ?Entity $newBook, ?Entity $newChapter): bool
+    protected function loadModelsIntoSortMap(Collection $sortMap): void
     {
-        // Stop if we can't see the current parent or new book.
-        if (!$currentParent || !$newBook) {
-            return false;
+        $keyMap = $sortMap->keyBy(function (\stdClass $sortMapItem) {
+            return  $sortMapItem->type . ':' . $sortMapItem->id;
+        });
+        $pageIds = $sortMap->where('type', '=', 'page')->pluck('id');
+        $chapterIds = $sortMap->where('type', '=', 'chapter')->pluck('id');
+
+        $pages = Page::visible()->whereIn('id', $pageIds)->get();
+        $chapters = Chapter::visible()->whereIn('id', $chapterIds)->get();
+
+        foreach ($pages as $page) {
+            $sortItem = $keyMap->get('page:' . $page->id);
+            $sortItem->model = $page;
         }
 
-        $hasNewParent = $newBook->id !== $model->book_id || ($model instanceof Page && $model->chapter_id !== ($sortMapItem->parentChapterId ?? 0));
-        if ($model instanceof Chapter) {
-            $hasPermission = userCan('book-update', $currentParent)
-                && userCan('book-update', $newBook)
-                && userCan('chapter-update', $model)
-                && (!$hasNewParent || userCan('chapter-create', $newBook))
-                && (!$hasNewParent || userCan('chapter-delete', $model));
-
-            if (!$hasPermission) {
-                return false;
-            }
+        foreach ($chapters as $chapter) {
+            $sortItem = $keyMap->get('chapter:' . $chapter->id);
+            $sortItem->model = $chapter;
         }
-
-        if ($model instanceof Page) {
-            $parentPermission = ($currentParent instanceof Chapter) ? 'chapter-update' : 'book-update';
-            $hasCurrentParentPermission = userCan($parentPermission, $currentParent);
-
-            // This needs to check if there was an intended chapter location in the original sort map
-            // rather than inferring from the $newChapter since that variable may be null
-            // due to other reasons (Visibility).
-            $newParent = $sortMapItem->parentChapterId ? $newChapter : $newBook;
-            if (!$newParent) {
-                return false;
-            }
-
-            $hasPageEditPermission = userCan('page-update', $model);
-            $newParentInRightLocation = ($newParent instanceof Book || $newParent->book_id === $newBook->id);
-            $newParentPermission = ($newParent instanceof Chapter) ? 'chapter-update' : 'book-update';
-            $hasNewParentPermission = userCan($newParentPermission, $newParent);
-
-            $hasDeletePermissionIfMoving = (!$hasNewParent || userCan('page-delete', $model));
-            $hasCreatePermissionIfMoving = (!$hasNewParent || userCan('page-create', $newParent));
-
-            $hasPermission = $hasCurrentParentPermission
-                && $newParentInRightLocation
-                && $hasNewParentPermission
-                && $hasPageEditPermission
-                && $hasDeletePermissionIfMoving
-                && $hasCreatePermissionIfMoving;
-
-            if (!$hasPermission) {
-                return false;
-            }
-        }
-
-        return true;
     }
 
     /**
-     * Load models from the database into the given sort map.
+     * Get the books involved in a sort.
+     * The given sort map should have its models loaded first.
      *
-     * @return array<string, Entity>
+     * @throws SortOperationException
      */
-    protected function loadModelsFromSortMap(BookSortMap $sortMap): array
+    protected function getBooksInvolvedInSort(Collection $sortMap): Collection
     {
-        $modelMap = [];
-        $ids = [
-            'chapter' => [],
-            'page'    => [],
-            'book'    => [],
-        ];
+        $bookIdsInvolved = collect([$this->book->id]);
+        $bookIdsInvolved = $bookIdsInvolved->concat($sortMap->pluck('book'));
+        $bookIdsInvolved = $bookIdsInvolved->concat($sortMap->pluck('model.book_id'));
+        $bookIdsInvolved = $bookIdsInvolved->unique()->toArray();
 
-        foreach ($sortMap->all() as $sortMapItem) {
-            $ids[$sortMapItem->type][] = $sortMapItem->id;
-            $ids['book'][] = $sortMapItem->parentBookId;
-            if ($sortMapItem->parentChapterId) {
-                $ids['chapter'][] = $sortMapItem->parentChapterId;
-            }
+        $books = Book::hasPermission('update')->whereIn('id', $bookIdsInvolved)->get();
+
+        if (count($books) !== count($bookIdsInvolved)) {
+            throw new SortOperationException('Could not find all books requested in sort operation');
         }
 
-        $pages = Page::visible()->whereIn('id', array_unique($ids['page']))->get(Page::$listAttributes);
-        /** @var Page $page */
-        foreach ($pages as $page) {
-            $modelMap['page:' . $page->id] = $page;
-            $ids['book'][] = $page->book_id;
-            if ($page->chapter_id) {
-                $ids['chapter'][] = $page->chapter_id;
-            }
-        }
-
-        $chapters = Chapter::visible()->whereIn('id', array_unique($ids['chapter']))->get();
-        /** @var Chapter $chapter */
-        foreach ($chapters as $chapter) {
-            $modelMap['chapter:' . $chapter->id] = $chapter;
-            $ids['book'][] = $chapter->book_id;
-        }
-
-        $books = Book::visible()->whereIn('id', array_unique($ids['book']))->get();
-        /** @var Book $book */
-        foreach ($books as $book) {
-            $modelMap['book:' . $book->id] = $book;
-        }
-
-        return $modelMap;
+        return $books;
     }
 }

app/Entities/Tools/BookSortMap.php

@@ -1,44 +0,0 @@
-<?php
-
-namespace BookStack\Entities\Tools;
-
-class BookSortMap
-{
-    /**
-     * @var BookSortMapItem[]
-     */
-    protected $mapData = [];
-
-    public function addItem(BookSortMapItem $mapItem): void
-    {
-        $this->mapData[] = $mapItem;
-    }
-
-    /**
-     * @return BookSortMapItem[]
-     */
-    public function all(): array
-    {
-        return $this->mapData;
-    }
-
-    public static function fromJson(string $json): self
-    {
-        $map = new BookSortMap();
-        $mapData = json_decode($json);
-
-        foreach ($mapData as $mapDataItem) {
-            $item = new BookSortMapItem(
-                intval($mapDataItem->id),
-                intval($mapDataItem->sort),
-                $mapDataItem->parentChapter ? intval($mapDataItem->parentChapter) : null,
-                $mapDataItem->type,
-                intval($mapDataItem->book)
-            );
-
-            $map->addItem($item);
-        }
-
-        return $map;
-    }
-}

app/Entities/Tools/BookSortMapItem.php

@@ -1,40 +0,0 @@
-<?php
-
-namespace BookStack\Entities\Tools;
-
-class BookSortMapItem
-{
-    /**
-     * @var int
-     */
-    public $id;
-
-    /**
-     * @var int
-     */
-    public $sort;
-
-    /**
-     * @var ?int
-     */
-    public $parentChapterId;
-
-    /**
-     * @var string
-     */
-    public $type;
-
-    /**
-     * @var int
-     */
-    public $parentBookId;
-
-    public function __construct(int $id, int $sort, ?int $parentChapterId, string $type, int $parentBookId)
-    {
-        $this->id = $id;
-        $this->sort = $sort;
-        $this->parentChapterId = $parentChapterId;
-        $this->type = $type;
-        $this->parentBookId = $parentBookId;
-    }
-}

app/Entities/Tools/Cloner.php

@@ -1,147 +0,0 @@
-<?php
-
-namespace BookStack\Entities\Tools;
-
-use BookStack\Actions\Tag;
-use BookStack\Entities\Models\Book;
-use BookStack\Entities\Models\Chapter;
-use BookStack\Entities\Models\Entity;
-use BookStack\Entities\Models\Page;
-use BookStack\Entities\Repos\BookRepo;
-use BookStack\Entities\Repos\ChapterRepo;
-use BookStack\Entities\Repos\PageRepo;
-use BookStack\Uploads\Image;
-use BookStack\Uploads\ImageService;
-use Illuminate\Http\UploadedFile;
-
-class Cloner
-{
-    /**
-     * @var PageRepo
-     */
-    protected $pageRepo;
-
-    /**
-     * @var ChapterRepo
-     */
-    protected $chapterRepo;
-
-    /**
-     * @var BookRepo
-     */
-    protected $bookRepo;
-
-    /**
-     * @var ImageService
-     */
-    protected $imageService;
-
-    public function __construct(PageRepo $pageRepo, ChapterRepo $chapterRepo, BookRepo $bookRepo, ImageService $imageService)
-    {
-        $this->pageRepo = $pageRepo;
-        $this->chapterRepo = $chapterRepo;
-        $this->bookRepo = $bookRepo;
-        $this->imageService = $imageService;
-    }
-
-    /**
-     * Clone the given page into the given parent using the provided name.
-     */
-    public function clonePage(Page $original, Entity $parent, string $newName): Page
-    {
-        $copyPage = $this->pageRepo->getNewDraftPage($parent);
-        $pageData = $original->getAttributes();
-
-        // Update name & tags
-        $pageData['name'] = $newName;
-        $pageData['tags'] = $this->entityTagsToInputArray($original);
-
-        return $this->pageRepo->publishDraft($copyPage, $pageData);
-    }
-
-    /**
-     * Clone the given page into the given parent using the provided name.
-     * Clones all child pages.
-     */
-    public function cloneChapter(Chapter $original, Book $parent, string $newName): Chapter
-    {
-        $chapterDetails = $original->getAttributes();
-        $chapterDetails['name'] = $newName;
-        $chapterDetails['tags'] = $this->entityTagsToInputArray($original);
-
-        $copyChapter = $this->chapterRepo->create($chapterDetails, $parent);
-
-        if (userCan('page-create', $copyChapter)) {
-            /** @var Page $page */
-            foreach ($original->getVisiblePages() as $page) {
-                $this->clonePage($page, $copyChapter, $page->name);
-            }
-        }
-
-        return $copyChapter;
-    }
-
-    /**
-     * Clone the given book.
-     * Clones all child chapters & pages.
-     */
-    public function cloneBook(Book $original, string $newName): Book
-    {
-        $bookDetails = $original->getAttributes();
-        $bookDetails['name'] = $newName;
-        $bookDetails['tags'] = $this->entityTagsToInputArray($original);
-
-        $copyBook = $this->bookRepo->create($bookDetails);
-
-        $directChildren = $original->getDirectChildren();
-        foreach ($directChildren as $child) {
-            if ($child instanceof Chapter && userCan('chapter-create', $copyBook)) {
-                $this->cloneChapter($child, $copyBook, $child->name);
-            }
-
-            if ($child instanceof Page && !$child->draft && userCan('page-create', $copyBook)) {
-                $this->clonePage($child, $copyBook, $child->name);
-            }
-        }
-
-        if ($original->cover) {
-            try {
-                $tmpImgFile = tmpfile();
-                $uploadedFile = $this->imageToUploadedFile($original->cover, $tmpImgFile);
-                $this->bookRepo->updateCoverImage($copyBook, $uploadedFile, false);
-            } catch (\Exception $exception) {
-            }
-        }
-
-        return $copyBook;
-    }
-
-    /**
-     * Convert an image instance to an UploadedFile instance to mimic
-     * a file being uploaded.
-     */
-    protected function imageToUploadedFile(Image $image, &$tmpFile): ?UploadedFile
-    {
-        $imgData = $this->imageService->getImageData($image);
-        $tmpImgFilePath = stream_get_meta_data($tmpFile)['uri'];
-        file_put_contents($tmpImgFilePath, $imgData);
-
-        return new UploadedFile($tmpImgFilePath, basename($image->path));
-    }
-
-    /**
-     * Convert the tags on the given entity to the raw format
-     * that's used for incoming request data.
-     */
-    protected function entityTagsToInputArray(Entity $entity): array
-    {
-        $tags = [];
-
-        /** @var Tag $tag */
-        foreach ($entity->tags as $tag) {
-            $tags[] = ['name' => $tag->name, 'value' => $tag->value];
-        }
-
-        return $tags;
-    }
-}

app/Entities/Tools/ExportFormatter.php

@@ -7,24 +7,21 @@ use BookStack\Entities\Models\Chapter;
 use BookStack\Entities\Models\Page;
 use BookStack\Entities\Tools\Markdown\HtmlToMarkdown;
 use BookStack\Uploads\ImageService;
-use DOMDocument;
-use DOMElement;
-use DOMXPath;
+use DomPDF;
 use Exception;
+use SnappyPDF;
 use Throwable;
 
 class ExportFormatter
 {
     protected $imageService;
-    protected $pdfGenerator;
 
     /**
      * ExportService constructor.
      */
-    public function __construct(ImageService $imageService, PdfGenerator $pdfGenerator)
+    public function __construct(ImageService $imageService)
     {
         $this->imageService = $imageService;
-        $this->pdfGenerator = $pdfGenerator;
     }
 
     /**
@@ -142,40 +139,16 @@ class ExportFormatter
      */
     protected function htmlToPdf(string $html): string
     {
-        $html = $this->containHtml($html);
-        $html = $this->replaceIframesWithLinks($html);
-
-        return $this->pdfGenerator->fromHtml($html);
-    }
-
-    /**
-     * Within the given HTML content, replace any iframe elements
-     * with anchor links within paragraph blocks.
-     */
-    protected function replaceIframesWithLinks(string $html): string
-    {
-        libxml_use_internal_errors(true);
-
-        $doc = new DOMDocument();
-        $doc->loadHTML(mb_convert_encoding($html, 'HTML-ENTITIES', 'UTF-8'));
-        $xPath = new DOMXPath($doc);
-
-        $iframes = $xPath->query('//iframe');
-        /** @var DOMElement $iframe */
-        foreach ($iframes as $iframe) {
-            $link = $iframe->getAttribute('src');
-            if (strpos($link, '//') === 0) {
-                $link = 'https:' . $link;
-            }
-
-            $anchor = $doc->createElement('a', $link);
-            $anchor->setAttribute('href', $link);
-            $paragraph = $doc->createElement('p');
-            $paragraph->appendChild($anchor);
-            $iframe->parentNode->replaceChild($paragraph, $iframe);
+        $containedHtml = $this->containHtml($html);
+        $useWKHTML = config('snappy.pdf.binary') !== false && config('app.allow_untrusted_server_fetching') === true;
+        if ($useWKHTML) {
+            $pdf = SnappyPDF::loadHTML($containedHtml);
+            $pdf->setOption('print-media-type', true);
+        } else {
+            $pdf = DomPDF::loadHTML($containedHtml);
         }
 
-        return $doc->saveHTML();
+        return $pdf->output();
     }
 
     /**

app/Entities/Tools/NextPreviousContentLocator.php

@@ -64,7 +64,7 @@ class NextPreviousContentLocator
         /** @var Entity $item */
         foreach ($bookTree->all() as $item) {
             $flatOrdered->push($item);
-            $childPages = $item->getAttribute('visible_pages') ?? [];
+            $childPages = $item->visible_pages ?? [];
             $flatOrdered = $flatOrdered->concat($childPages);
         }
 

app/Entities/Tools/PageContent.php

@@ -9,11 +9,8 @@ use BookStack\Exceptions\ImageUploadException;
 use BookStack\Facades\Theme;
 use BookStack\Theming\ThemeEvents;
 use BookStack\Uploads\ImageRepo;
-use BookStack\Uploads\ImageService;
 use BookStack\Util\HtmlContentFilter;
 use DOMDocument;
-use DOMElement;
-use DOMNode;
 use DOMNodeList;
 use DOMXPath;
 use Illuminate\Support\Str;
@@ -89,13 +86,30 @@ class PageContent
         $body = $container->childNodes->item(0);
         $childNodes = $body->childNodes;
         $xPath = new DOMXPath($doc);
+        $imageRepo = app()->make(ImageRepo::class);
 
         // Get all img elements with image data blobs
         $imageNodes = $xPath->query('//img[contains(@src, \'data:image\')]');
         foreach ($imageNodes as $imageNode) {
             $imageSrc = $imageNode->getAttribute('src');
-            $newUrl = $this->base64ImageUriToUploadedImageUrl($imageSrc);
-            $imageNode->setAttribute('src', $newUrl);
+            [$dataDefinition, $base64ImageData] = explode(',', $imageSrc, 2);
+            $extension = strtolower(preg_split('/[\/;]/', $dataDefinition)[1] ?? 'png');
+
+            // Validate extension
+            if (!$imageRepo->imageExtensionSupported($extension)) {
+                $imageNode->setAttribute('src', '');
+                continue;
+            }
+
+            // Save image from data with a random name
+            $imageName = 'embedded-image-' . Str::random(8) . '.' . $extension;
+
+            try {
+                $image = $imageRepo->saveNewFromData($imageName, base64_decode($base64ImageData), 'gallery', $this->page->id);
+                $imageNode->setAttribute('src', $image->url);
+            } catch (ImageUploadException $exception) {
+                $imageNode->setAttribute('src', '');
+            }
         }
 
         // Generate inner html as a string
@@ -112,65 +126,34 @@ class PageContent
      */
     protected function extractBase64ImagesFromMarkdown(string $markdown)
     {
+        $imageRepo = app()->make(ImageRepo::class);
         $matches = [];
         preg_match_all('/!\[.*?]\(.*?(data:image\/.*?)[)"\s]/', $markdown, $matches);
 
         foreach ($matches[1] as $base64Match) {
-            $newUrl = $this->base64ImageUriToUploadedImageUrl($base64Match);
-            $markdown = str_replace($base64Match, $newUrl, $markdown);
+            [$dataDefinition, $base64ImageData] = explode(',', $base64Match, 2);
+            $extension = strtolower(preg_split('/[\/;]/', $dataDefinition)[1] ?? 'png');
+
+            // Validate extension
+            if (!$imageRepo->imageExtensionSupported($extension)) {
+                $markdown = str_replace($base64Match, '', $markdown);
+                continue;
+            }
+
+            // Save image from data with a random name
+            $imageName = 'embedded-image-' . Str::random(8) . '.' . $extension;
+
+            try {
+                $image = $imageRepo->saveNewFromData($imageName, base64_decode($base64ImageData), 'gallery', $this->page->id);
+                $markdown = str_replace($base64Match, $image->url, $markdown);
+            } catch (ImageUploadException $exception) {
+                $markdown = str_replace($base64Match, '', $markdown);
+            }
         }
 
         return $markdown;
     }
 
-    /**
-     * Parse the given base64 image URI and return the URL to the created image instance.
-     * Returns an empty string if the parsed URI is invalid or causes an error upon upload.
-     */
-    protected function base64ImageUriToUploadedImageUrl(string $uri): string
-    {
-        $imageRepo = app()->make(ImageRepo::class);
-        $imageInfo = $this->parseBase64ImageUri($uri);
-
-        // Validate extension and content
-        if (empty($imageInfo['data']) || !ImageService::isExtensionSupported($imageInfo['extension'])) {
-            return '';
-        }
-
-        // Validate that the content is not over our upload limit
-        $uploadLimitBytes = (config('app.upload_limit') * 1000000);
-        if (strlen($imageInfo['data']) > $uploadLimitBytes) {
-            return '';
-        }
-
-        // Save image from data with a random name
-        $imageName = 'embedded-image-' . Str::random(8) . '.' . $imageInfo['extension'];
-
-        try {
-            $image = $imageRepo->saveNewFromData($imageName, $imageInfo['data'], 'gallery', $this->page->id);
-        } catch (ImageUploadException $exception) {
-            return '';
-        }
-
-        return $image->url;
-    }
-
-    /**
-     * Parse a base64 image URI into the data and extension.
-     *
-     * @return array{extension: string, data: string}
-     */
-    protected function parseBase64ImageUri(string $uri): array
-    {
-        [$dataDefinition, $base64ImageData] = explode(',', $uri, 2);
-        $extension = strtolower(preg_split('/[\/;]/', $dataDefinition)[1] ?? '');
-
-        return [
-            'extension' => $extension,
-            'data'      => base64_decode($base64ImageData) ?: '',
-        ];
-    }
-
     /**
      * Formats a page's html to be tagged correctly within the system.
      */
@@ -195,15 +178,6 @@ class PageContent
             }
         }
 
-        // Set ids on nested header nodes
-        $nestedHeaders = $xPath->query('//body//*//h1|//body//*//h2|//body//*//h3|//body//*//h4|//body//*//h5|//body//*//h6');
-        foreach ($nestedHeaders as $nestedHeader) {
-            [$oldId, $newId] = $this->setUniqueId($nestedHeader, $idMap);
-            if ($newId && $newId !== $oldId) {
-                $this->updateLinks($xPath, '#' . $oldId, '#' . $newId);
-            }
-        }
-
         // Ensure no duplicate ids within child items
         $idElems = $xPath->query('//body//*//*[@id]');
         foreach ($idElems as $domElem) {
@@ -239,9 +213,9 @@ class PageContent
      * A map for existing ID's should be passed in to check for current existence.
      * Returns a pair of strings in the format [old_id, new_id].
      */
-    protected function setUniqueId(DOMNode $element, array &$idMap): array
+    protected function setUniqueId(\DOMNode $element, array &$idMap): array
     {
-        if (!$element instanceof DOMElement) {
+        if (get_class($element) !== 'DOMElement') {
             return ['', ''];
         }
 
@@ -253,7 +227,7 @@ class PageContent
             return [$existingId, $existingId];
         }
 
-        // Create a unique id for the element
+        // Create an unique id for the element
         // Uses the content as a basis to ensure output is the same every time
         // the same content is passed through.
         $contentId = 'bkmrk-' . mb_substr(strtolower(preg_replace('/\s+/', '-', trim($element->nodeValue))), 0, 20);
@@ -323,7 +297,7 @@ class PageContent
      */
     protected function headerNodesToLevelList(DOMNodeList $nodeList): array
     {
-        $tree = collect($nodeList)->map(function (DOMElement $header) {
+        $tree = collect($nodeList)->map(function ($header) {
             $text = trim(str_replace("\xc2\xa0", '', $header->nodeValue));
             $text = mb_substr($text, 0, 100);
 
@@ -401,7 +375,7 @@ class PageContent
      */
     protected function fetchSectionOfPage(Page $page, string $sectionId): string
     {
-        $topLevelTags = ['table', 'ul', 'ol', 'pre'];
+        $topLevelTags = ['table', 'ul', 'ol'];
         $doc = $this->loadDocumentFromHtml($page->html);
 
         // Search included content for the id given and blank out if not exists.

app/Entities/Tools/PageEditActivity.php

@@ -35,13 +35,7 @@ class PageEditActivity
         $pageDraftEdits = $this->activePageEditingQuery(60)->get();
         $count = $pageDraftEdits->count();
 
-        $userMessage = trans('entities.pages_draft_edit_active.start_a', ['count' => $count]);
-        if ($count === 1) {
-            /** @var PageRevision $firstDraft */
-            $firstDraft = $pageDraftEdits->first();
-            $userMessage = trans('entities.pages_draft_edit_active.start_b', ['userName' => $firstDraft->createdBy->name ?? '']);
-        }
-
+        $userMessage = $count > 1 ? trans('entities.pages_draft_edit_active.start_a', ['count' => $count]) : trans('entities.pages_draft_edit_active.start_b', ['userName' => $pageDraftEdits->first()->createdBy->name]);
         $timeMessage = trans('entities.pages_draft_edit_active.time_b', ['minCount'=> 60]);
 
         return trans('entities.pages_draft_edit_active.message', ['start' => $userMessage, 'time' => $timeMessage]);

app/Entities/Tools/PdfGenerator.php

@@ -1,26 +0,0 @@
-<?php
-
-namespace BookStack\Entities\Tools;
-
-use Barryvdh\DomPDF\Facade as DomPDF;
-use Barryvdh\Snappy\Facades\SnappyPdf;
-
-class PdfGenerator
-{
-    /**
-     * Generate PDF content from the given HTML content.
-     */
-    public function fromHtml(string $html): string
-    {
-        $useWKHTML = config('snappy.pdf.binary') !== false && config('app.allow_untrusted_server_fetching') === true;
-
-        if ($useWKHTML) {
-            $pdf = SnappyPDF::loadHTML($html);
-            $pdf->setOption('print-media-type', true);
-        } else {
-            $pdf = DomPDF::loadHTML($html);
-        }
-
-        return $pdf->output();
-    }
-}

app/Entities/Tools/PermissionsUpdater.php

@@ -35,7 +35,7 @@ class PermissionsUpdater
         $entity->save();
         $entity->rebuildPermissions();
 
-        Activity::add(ActivityType::PERMISSIONS_UPDATE, $entity);
+        Activity::addForEntity($entity, ActivityType::PERMISSIONS_UPDATE);
     }
 
     /**

app/Entities/Tools/SearchIndex.php

@@ -2,32 +2,26 @@
 
 namespace BookStack\Entities\Tools;
 
-use BookStack\Actions\Tag;
 use BookStack\Entities\EntityProvider;
 use BookStack\Entities\Models\Entity;
-use BookStack\Entities\Models\Page;
 use BookStack\Entities\Models\SearchTerm;
-use DOMDocument;
-use DOMNode;
-use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Support\Collection;
 
 class SearchIndex
 {
     /**
-     * A list of delimiter characters used to break-up parsed content into terms for indexing.
-     *
-     * @var string
+     * @var SearchTerm
      */
-    public static $delimiters = " \n\t.,!?:;()[]{}<>`'\"";
+    protected $searchTerm;
 
     /**
      * @var EntityProvider
      */
     protected $entityProvider;
 
-    public function __construct(EntityProvider $entityProvider)
+    public function __construct(SearchTerm $searchTerm, EntityProvider $entityProvider)
     {
+        $this->searchTerm = $searchTerm;
         $this->entityProvider = $entityProvider;
     }
 
@@ -37,8 +31,14 @@ class SearchIndex
     public function indexEntity(Entity $entity)
     {
         $this->deleteEntityTerms($entity);
-        $terms = $this->entityToTermDataArray($entity);
-        SearchTerm::query()->insert($terms);
+        $nameTerms = $this->generateTermArrayFromText($entity->name, 5 * $entity->searchFactor);
+        $bodyTerms = $this->generateTermArrayFromText($entity->getText(), 1 * $entity->searchFactor);
+        $terms = array_merge($nameTerms, $bodyTerms);
+        foreach ($terms as $index => $term) {
+            $terms[$index]['entity_type'] = $entity->getMorphClass();
+            $terms[$index]['entity_id'] = $entity->id;
+        }
+        $this->searchTerm->newQuery()->insert($terms);
     }
 
     /**
@@ -46,56 +46,40 @@ class SearchIndex
      *
      * @param Entity[] $entities
      */
-    public function indexEntities(array $entities)
+    protected function indexEntities(array $entities)
     {
         $terms = [];
         foreach ($entities as $entity) {
-            $entityTerms = $this->entityToTermDataArray($entity);
-            array_push($terms, ...$entityTerms);
+            $nameTerms = $this->generateTermArrayFromText($entity->name, 5 * $entity->searchFactor);
+            $bodyTerms = $this->generateTermArrayFromText($entity->getText(), 1 * $entity->searchFactor);
+            foreach (array_merge($nameTerms, $bodyTerms) as $term) {
+                $term['entity_id'] = $entity->id;
+                $term['entity_type'] = $entity->getMorphClass();
+                $terms[] = $term;
+            }
         }
 
         $chunkedTerms = array_chunk($terms, 500);
         foreach ($chunkedTerms as $termChunk) {
-            SearchTerm::query()->insert($termChunk);
+            $this->searchTerm->newQuery()->insert($termChunk);
         }
     }
 
     /**
      * Delete and re-index the terms for all entities in the system.
-     * Can take a callback which is used for reporting progress.
-     * Callback receives three arguments:
-     * - An instance of the model being processed
-     * - The number that have been processed so far.
-     * - The total number of that model to be processed.
-     *
-     * @param callable(Entity, int, int):void|null $progressCallback
      */
-    public function indexAllEntities(?callable $progressCallback = null)
+    public function indexAllEntities()
     {
-        SearchTerm::query()->truncate();
+        $this->searchTerm->newQuery()->truncate();
 
         foreach ($this->entityProvider->all() as $entityModel) {
-            $indexContentField = $entityModel instanceof Page ? 'html' : 'description';
-            $selectFields = ['id', 'name', $indexContentField];
-            /** @var Builder<Entity> $query */
-            $query = $entityModel->newQuery();
-            $total = $query->withTrashed()->count();
-            $chunkSize = 250;
-            $processed = 0;
-
-            $chunkCallback = function (Collection $entities) use ($progressCallback, &$processed, $total, $chunkSize, $entityModel) {
-                $this->indexEntities($entities->all());
-                $processed = min($processed + $chunkSize, $total);
-
-                if (is_callable($progressCallback)) {
-                    $progressCallback($entityModel, $processed, $total);
-                }
-            };
-
+            $selectFields = ['id', 'name', $entityModel->textField];
             $entityModel->newQuery()
+                ->withTrashed()
                 ->select($selectFields)
-                ->with(['tags:id,name,value,entity_id,entity_type'])
-                ->chunk($chunkSize, $chunkCallback);
+                ->chunk(1000, function (Collection $entities) {
+                    $this->indexEntities($entities->all());
+                });
         }
     }
 
@@ -108,97 +92,12 @@ class SearchIndex
     }
 
     /**
-     * Create a scored term array from the given text, where the keys are the terms
-     * and the values are their scores.
-     *
-     * @returns array<string, int>
+     * Create a scored term array from the given text.
      */
-    protected function generateTermScoreMapFromText(string $text, int $scoreAdjustment = 1): array
-    {
-        $termMap = $this->textToTermCountMap($text);
-
-        foreach ($termMap as $term => $count) {
-            $termMap[$term] = $count * $scoreAdjustment;
-        }
-
-        return $termMap;
-    }
-
-    /**
-     * Create a scored term array from the given HTML, where the keys are the terms
-     * and the values are their scores.
-     *
-     * @returns array<string, int>
-     */
-    protected function generateTermScoreMapFromHtml(string $html): array
-    {
-        if (empty($html)) {
-            return [];
-        }
-
-        $scoresByTerm = [];
-        $elementScoreAdjustmentMap = [
-            'h1' => 10,
-            'h2' => 5,
-            'h3' => 4,
-            'h4' => 3,
-            'h5' => 2,
-            'h6' => 1.5,
-        ];
-
-        $html = '<body>' . $html . '</body>';
-        libxml_use_internal_errors(true);
-        $doc = new DOMDocument();
-        $doc->loadHTML(mb_convert_encoding($html, 'HTML-ENTITIES', 'UTF-8'));
-
-        $topElems = $doc->documentElement->childNodes->item(0)->childNodes;
-        /** @var DOMNode $child */
-        foreach ($topElems as $child) {
-            $nodeName = $child->nodeName;
-            $termCounts = $this->textToTermCountMap(trim($child->textContent));
-            foreach ($termCounts as $term => $count) {
-                $scoreChange = $count * ($elementScoreAdjustmentMap[$nodeName] ?? 1);
-                $scoresByTerm[$term] = ($scoresByTerm[$term] ?? 0) + $scoreChange;
-            }
-        }
-
-        return $scoresByTerm;
-    }
-
-    /**
-     * Create a scored term map from the given set of entity tags.
-     *
-     * @param Tag[] $tags
-     *
-     * @returns array<string, int>
-     */
-    protected function generateTermScoreMapFromTags(array $tags): array
-    {
-        $scoreMap = [];
-        $names = [];
-        $values = [];
-
-        foreach ($tags as $tag) {
-            $names[] = $tag->name;
-            $values[] = $tag->value;
-        }
-
-        $nameMap = $this->generateTermScoreMapFromText(implode(' ', $names), 3);
-        $valueMap = $this->generateTermScoreMapFromText(implode(' ', $values), 5);
-
-        return $this->mergeTermScoreMaps($nameMap, $valueMap);
-    }
-
-    /**
-     * For the given text, return an array where the keys are the unique term words
-     * and the values are the frequency of that term.
-     *
-     * @returns array<string, int>
-     */
-    protected function textToTermCountMap(string $text): array
+    protected function generateTermArrayFromText(string $text, int $scoreAdjustment = 1): array
     {
         $tokenMap = []; // {TextToken => OccurrenceCount}
-        $splitChars = static::$delimiters;
+        $splitChars = " \n\t.,!?:;()[]{}<>`'\"";
         $token = strtok($text, $splitChars);
 
         while ($token !== false) {
@@ -209,61 +108,14 @@ class SearchIndex
             $token = strtok($splitChars);
         }
 
-        return $tokenMap;
-    }
-
-    /**
-     * For the given entity, Generate an array of term data details.
-     * Is the raw term data, not instances of SearchTerm models.
-     *
-     * @returns array{term: string, score: float, entity_id: int, entity_type: string}[]
-     */
-    protected function entityToTermDataArray(Entity $entity): array
-    {
-        $nameTermsMap = $this->generateTermScoreMapFromText($entity->name, 40 * $entity->searchFactor);
-        $tagTermsMap = $this->generateTermScoreMapFromTags($entity->tags->all());
-
-        if ($entity instanceof Page) {
-            $bodyTermsMap = $this->generateTermScoreMapFromHtml($entity->html);
-        } else {
-            $bodyTermsMap = $this->generateTermScoreMapFromText($entity->getAttribute('description') ?? '', $entity->searchFactor);
-        }
-
-        $mergedScoreMap = $this->mergeTermScoreMaps($nameTermsMap, $bodyTermsMap, $tagTermsMap);
-
-        $dataArray = [];
-        $entityId = $entity->id;
-        $entityType = $entity->getMorphClass();
-        foreach ($mergedScoreMap as $term => $score) {
-            $dataArray[] = [
-                'term'        => $term,
-                'score'       => $score,
-                'entity_type' => $entityType,
-                'entity_id'   => $entityId,
+        $terms = [];
+        foreach ($tokenMap as $token => $count) {
+            $terms[] = [
+                'term'  => $token,
+                'score' => $count * $scoreAdjustment,
             ];
         }
 
-        return $dataArray;
-    }
-
-    /**
-     * For the given term data arrays, Merge their contents by term
-     * while combining any scores.
-     *
-     * @param array<string, int>[] ...$scoreMaps
-     *
-     * @returns array<string, int>
-     */
-    protected function mergeTermScoreMaps(...$scoreMaps): array
-    {
-        $mergedMap = [];
-
-        foreach ($scoreMaps as $scoreMap) {
-            foreach ($scoreMap as $term => $score) {
-                $mergedMap[$term] = ($mergedMap[$term] ?? 0) + $score;
-            }
-        }
-
-        return $mergedMap;
+        return $terms;
     }
 }

app/Entities/Tools/SearchOptions.php

@@ -29,10 +29,10 @@ class SearchOptions
     /**
      * Create a new instance from a search string.
      */
-    public static function fromString(string $search): self
+    public static function fromString(string $search): SearchOptions
     {
         $decoded = static::decode($search);
-        $instance = new SearchOptions();
+        $instance = new static();
         foreach ($decoded as $type => $value) {
             $instance->$type = $value;
         }
@@ -45,7 +45,7 @@ class SearchOptions
      * Will look for a classic string term and use that
      * Otherwise we'll use the details from an advanced search form.
      */
-    public static function fromRequest(Request $request): self
+    public static function fromRequest(Request $request): SearchOptions
     {
         if (!$request->has('search') && !$request->has('term')) {
             return static::fromString('');
@@ -55,24 +55,17 @@ class SearchOptions
             return static::fromString($request->get('term'));
         }
 
-        $instance = new SearchOptions();
+        $instance = new static();
         $inputs = $request->only(['search', 'types', 'filters', 'exact', 'tags']);
-
-        $parsedStandardTerms = static::parseStandardTermString($inputs['search'] ?? '');
-        $instance->searches = $parsedStandardTerms['terms'];
-        $instance->exacts = $parsedStandardTerms['exacts'];
-
-        array_push($instance->exacts, ...array_filter($inputs['exact'] ?? []));
-
+        $instance->searches = explode(' ', $inputs['search'] ?? []);
+        $instance->exacts = array_filter($inputs['exact'] ?? []);
         $instance->tags = array_filter($inputs['tags'] ?? []);
-
         foreach (($inputs['filters'] ?? []) as $filterKey => $filterVal) {
             if (empty($filterVal)) {
                 continue;
             }
             $instance->filters[$filterKey] = $filterVal === 'true' ? '' : $filterVal;
         }
-
         if (isset($inputs['types']) && count($inputs['types']) < 4) {
             $instance->filters['type'] = implode('|', $inputs['types']);
         }
@@ -109,9 +102,11 @@ class SearchOptions
         }
 
         // Parse standard terms
-        $parsedStandardTerms = static::parseStandardTermString($searchString);
-        array_push($terms['searches'], ...$parsedStandardTerms['terms']);
-        array_push($terms['exacts'], ...$parsedStandardTerms['exacts']);
+        foreach (explode(' ', trim($searchString)) as $searchTerm) {
+            if ($searchTerm !== '') {
+                $terms['searches'][] = $searchTerm;
+            }
+        }
 
         // Split filter values out
         $splitFilters = [];
@@ -124,33 +119,6 @@ class SearchOptions
         return $terms;
     }
 
-    /**
-     * Parse a standard search term string into individual search terms and
-     * extract any exact terms searches to be made.
-     *
-     * @return array{terms: array<string>, exacts: array<string>}
-     */
-    protected static function parseStandardTermString(string $termString): array
-    {
-        $terms = explode(' ', $termString);
-        $indexDelimiters = SearchIndex::$delimiters;
-        $parsed = [
-            'terms'  => [],
-            'exacts' => [],
-        ];
-
-        foreach ($terms as $searchTerm) {
-            if ($searchTerm === '') {
-                continue;
-            }
-
-            $parsedList = (strpbrk($searchTerm, $indexDelimiters) === false) ? 'terms' : 'exacts';
-            $parsed[$parsedList][] = $searchTerm;
-        }
-
-        return $parsed;
-    }
-
     /**
      * Encode this instance to a search string.
      */

app/Entities/Tools/SearchResultsFormatter.php

@@ -1,236 +0,0 @@
-<?php
-
-namespace BookStack\Entities\Tools;
-
-use BookStack\Actions\Tag;
-use BookStack\Entities\Models\Entity;
-use Illuminate\Support\HtmlString;
-
-class SearchResultsFormatter
-{
-    /**
-     * For the given array of entities, Prepare the models to be shown in search result
-     * output. This sets a series of additional attributes.
-     *
-     * @param Entity[] $results
-     */
-    public function format(array $results, SearchOptions $options): void
-    {
-        foreach ($results as $result) {
-            $this->setSearchPreview($result, $options);
-        }
-    }
-
-    /**
-     * Update the given entity model to set attributes used for previews of the item
-     * primarily within search result lists.
-     */
-    protected function setSearchPreview(Entity $entity, SearchOptions $options)
-    {
-        $textProperty = $entity->textField;
-        $textContent = $entity->$textProperty;
-        $terms = array_merge($options->exacts, $options->searches);
-
-        $originalContentByNewAttribute = [
-            'preview_name'    => $entity->name,
-            'preview_content' => $textContent,
-        ];
-
-        foreach ($originalContentByNewAttribute as $attributeName => $content) {
-            $targetLength = ($attributeName === 'preview_name') ? 0 : 260;
-            $matchRefs = $this->getMatchPositions($content, $terms);
-            $mergedRefs = $this->sortAndMergeMatchPositions($matchRefs);
-            $formatted = $this->formatTextUsingMatchPositions($mergedRefs, $content, $targetLength);
-            $entity->setAttribute($attributeName, new HtmlString($formatted));
-        }
-
-        $tags = $entity->relationLoaded('tags') ? $entity->tags->all() : [];
-        $this->highlightTagsContainingTerms($tags, $terms);
-    }
-
-    /**
-     * Highlight tags which match the given terms.
-     *
-     * @param Tag[]    $tags
-     * @param string[] $terms
-     */
-    protected function highlightTagsContainingTerms(array $tags, array $terms): void
-    {
-        foreach ($tags as $tag) {
-            $tagName = mb_strtolower($tag->name);
-            $tagValue = mb_strtolower($tag->value);
-
-            foreach ($terms as $term) {
-                $termLower = mb_strtolower($term);
-
-                if (mb_strpos($tagName, $termLower) !== false) {
-                    $tag->setAttribute('highlight_name', true);
-                }
-
-                if (mb_strpos($tagValue, $termLower) !== false) {
-                    $tag->setAttribute('highlight_value', true);
-                }
-            }
-        }
-    }
-
-    /**
-     * Get positions of the given terms within the given text.
-     * Is in the array format of [int $startIndex => int $endIndex] where the indexes
-     * are positions within the provided text.
-     *
-     * @return array<int, int>
-     */
-    protected function getMatchPositions(string $text, array $terms): array
-    {
-        $matchRefs = [];
-        $text = mb_strtolower($text);
-
-        foreach ($terms as $term) {
-            $offset = 0;
-            $term = mb_strtolower($term);
-            $pos = mb_strpos($text, $term, $offset);
-            while ($pos !== false) {
-                $end = $pos + mb_strlen($term);
-                $matchRefs[$pos] = $end;
-                $offset = $end;
-                $pos = mb_strpos($text, $term, $offset);
-            }
-        }
-
-        return $matchRefs;
-    }
-
-    /**
-     * Sort the given match positions before merging them where they're
-     * adjacent or where they overlap.
-     *
-     * @param array<int, int> $matchPositions
-     *
-     * @return array<int, int>
-     */
-    protected function sortAndMergeMatchPositions(array $matchPositions): array
-    {
-        ksort($matchPositions);
-        $mergedRefs = [];
-        $lastStart = 0;
-        $lastEnd = 0;
-
-        foreach ($matchPositions as $start => $end) {
-            if ($start > $lastEnd) {
-                $mergedRefs[$start] = $end;
-                $lastStart = $start;
-                $lastEnd = $end;
-            } elseif ($end > $lastEnd) {
-                $mergedRefs[$lastStart] = $end;
-                $lastEnd = $end;
-            }
-        }
-
-        return $mergedRefs;
-    }
-
-    /**
-     * Format the given original text, returning a version where terms are highlighted within.
-     * Returned content is in HTML text format.
-     * A given $targetLength of 0 asserts no target length limit.
-     *
-     * This is a complex function but written to be relatively efficient, going through the term matches in order
-     * so that we're only doing a one-time loop through of the matches. There is no further searching
-     * done within here.
-     */
-    protected function formatTextUsingMatchPositions(array $matchPositions, string $originalText, int $targetLength): string
-    {
-        $maxEnd = mb_strlen($originalText);
-        $fetchAll = ($targetLength === 0);
-        $contextLength = ($fetchAll ? 0 : 32);
-
-        $firstStart = null;
-        $lastEnd = 0;
-        $content = '';
-        $contentTextLength = 0;
-
-        if ($fetchAll) {
-            $targetLength = $maxEnd * 2;
-        }
-
-        foreach ($matchPositions as $start => $end) {
-            // Get our outer text ranges for the added context we want to show upon the result.
-            $contextStart = max($start - $contextLength, 0, $lastEnd);
-            $contextEnd = min($end + $contextLength, $maxEnd);
-
-            // Adjust the start if we're going to be touching the previous match.
-            $startDiff = $start - $lastEnd;
-            if ($startDiff < 0) {
-                $contextStart = $start;
-                // Trims off '$startDiff' number of characters to bring it back to the start
-                // if this current match zone.
-                $content = mb_substr($content, 0, mb_strlen($content) + $startDiff);
-                $contentTextLength += $startDiff;
-            }
-
-            // Add ellipsis between results
-            if (!$fetchAll && $contextStart !== 0 && $contextStart !== $start) {
-                $content .= ' ...';
-                $contentTextLength += 4;
-            } elseif ($fetchAll) {
-                // Or fill in gap since the previous match
-                $fillLength = $contextStart - $lastEnd;
-                $content .= e(mb_substr($originalText, $lastEnd, $fillLength));
-                $contentTextLength += $fillLength;
-            }
-
-            // Add our content including the bolded matching text
-            $content .= e(mb_substr($originalText, $contextStart, $start - $contextStart));
-            $contentTextLength += $start - $contextStart;
-            $content .= '<strong>' . e(mb_substr($originalText, $start, $end - $start)) . '</strong>';
-            $contentTextLength += $end - $start;
-            $content .= e(mb_substr($originalText, $end, $contextEnd - $end));
-            $contentTextLength += $contextEnd - $end;
-
-            // Update our last end position
-            $lastEnd = $contextEnd;
-
-            // Update the first start position if it's not already been set
-            if (is_null($firstStart)) {
-                $firstStart = $contextStart;
-            }
-
-            // Stop if we're near our target
-            if ($contentTextLength >= $targetLength - 10) {
-                break;
-            }
-        }
-
-        // Just copy out the content if we haven't moved along anywhere.
-        if ($lastEnd === 0) {
-            $content = e(mb_substr($originalText, 0, $targetLength));
-            $contentTextLength = $targetLength;
-            $lastEnd = $targetLength;
-        }
-
-        // Pad out the end if we're low
-        $remainder = $targetLength - $contentTextLength;
-        if ($remainder > 10) {
-            $padEndLength = min($maxEnd - $lastEnd, $remainder);
-            $content .= e(mb_substr($originalText, $lastEnd, $padEndLength));
-            $lastEnd += $padEndLength;
-            $contentTextLength += $padEndLength;
-        }
-
-        // Pad out the start if we're still low
-        $remainder = $targetLength - $contentTextLength;
-        $firstStart = $firstStart ?: 0;
-        if (!$fetchAll && $remainder > 10 && $firstStart !== 0) {
-            $padStart = max(0, $firstStart - $remainder);
-            $content = ($padStart === 0 ? '' : '...') . e(mb_substr($originalText, $padStart, $firstStart - $padStart)) . mb_substr($content, 4);
-        }
-
-        // Add ellipsis if we're not at the end
-        if ($lastEnd < $maxEnd) {
-            $content .= '...';
-        }
-
-        return $content;
-    }
-}

app/Entities/Tools/SearchRunner.php

@@ -5,19 +5,13 @@ namespace BookStack\Entities\Tools;
 use BookStack\Auth\Permissions\PermissionService;
 use BookStack\Auth\User;
 use BookStack\Entities\EntityProvider;
-use BookStack\Entities\Models\BookChild;
 use BookStack\Entities\Models\Entity;
-use BookStack\Entities\Models\Page;
-use BookStack\Entities\Models\SearchTerm;
 use Illuminate\Database\Connection;
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
-use Illuminate\Database\Eloquent\Collection as EloquentCollection;
-use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Query\Builder;
+use Illuminate\Database\Query\JoinClause;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Str;
-use SplObjectStorage;
 
 class SearchRunner
 {
@@ -26,6 +20,11 @@ class SearchRunner
      */
     protected $entityProvider;
 
+    /**
+     * @var Connection
+     */
+    protected $db;
+
     /**
      * @var PermissionService
      */
@@ -38,27 +37,17 @@ class SearchRunner
      */
     protected $queryOperators = ['<=', '>=', '=', '<', '>', 'like', '!='];
 
-    /**
-     * Retain a cache of score adjusted terms for specific search options.
-     * From PHP>=8 this can be made into a WeakMap instead.
-     *
-     * @var SplObjectStorage
-     */
-    protected $termAdjustmentCache;
-
-    public function __construct(EntityProvider $entityProvider, PermissionService $permissionService)
+    public function __construct(EntityProvider $entityProvider, Connection $db, PermissionService $permissionService)
     {
         $this->entityProvider = $entityProvider;
+        $this->db = $db;
         $this->permissionService = $permissionService;
-        $this->termAdjustmentCache = new SplObjectStorage();
     }
 
     /**
      * Search all entities in the system.
      * The provided count is for each entity to search,
-     * Total returned could be larger and not guaranteed.
-     *
-     * @return array{total: int, count: int, has_more: bool, results: Entity[]}
+     * Total returned could can be larger and not guaranteed.
      */
     public function searchEntities(SearchOptions $searchOpts, string $entityType = 'all', int $page = 1, int $count = 20, string $action = 'view'): array
     {
@@ -79,18 +68,13 @@ class SearchRunner
             if (!in_array($entityType, $entityTypes)) {
                 continue;
             }
-
-            $entityModelInstance = $this->entityProvider->get($entityType);
-            $searchQuery = $this->buildQuery($searchOpts, $entityModelInstance, $action);
-            $entityTotal = $searchQuery->count();
-            $searchResults = $this->getPageOfDataFromQuery($searchQuery, $entityModelInstance, $page, $count);
-
-            if ($entityTotal > ($page * $count)) {
+            $search = $this->searchEntityTable($searchOpts, $entityType, $page, $count, $action);
+            $entityTotal = $this->searchEntityTable($searchOpts, $entityType, $page, $count, $action, true);
+            if ($entityTotal > $page * $count) {
                 $hasMore = true;
             }
-
             $total += $entityTotal;
-            $results = $results->merge($searchResults);
+            $results = $results->merge($search);
         }
 
         return [
@@ -115,9 +99,7 @@ class SearchRunner
             if (!in_array($entityType, $entityTypes)) {
                 continue;
             }
-
-            $entityModelInstance = $this->entityProvider->get($entityType);
-            $search = $this->buildQuery($opts, $entityModelInstance)->where('book_id', '=', $bookId)->take(20)->get();
+            $search = $this->buildEntitySearchQuery($opts, $entityType)->where('book_id', '=', $bookId)->take(20)->get();
             $results = $results->merge($search);
         }
 
@@ -130,199 +112,78 @@ class SearchRunner
     public function searchChapter(int $chapterId, string $searchString): Collection
     {
         $opts = SearchOptions::fromString($searchString);
-        $entityModelInstance = $this->entityProvider->get('page');
-        $pages = $this->buildQuery($opts, $entityModelInstance)->where('chapter_id', '=', $chapterId)->take(20)->get();
+        $pages = $this->buildEntitySearchQuery($opts, 'page')->where('chapter_id', '=', $chapterId)->take(20)->get();
 
         return $pages->sortByDesc('score');
     }
 
     /**
-     * Get a page of result data from the given query based on the provided page parameters.
+     * Search across a particular entity type.
+     * Setting getCount = true will return the total
+     * matching instead of the items themselves.
+     *
+     * @return \Illuminate\Database\Eloquent\Collection|int|static[]
      */
-    protected function getPageOfDataFromQuery(EloquentBuilder $query, Entity $entityModelInstance, int $page = 1, int $count = 20): EloquentCollection
+    protected function searchEntityTable(SearchOptions $searchOpts, string $entityType = 'page', int $page = 1, int $count = 20, string $action = 'view', bool $getCount = false)
     {
-        $relations = ['tags'];
-
-        if ($entityModelInstance instanceof BookChild) {
-            $relations['book'] = function (BelongsTo $query) {
-                $query->scopes('visible');
-            };
+        $query = $this->buildEntitySearchQuery($searchOpts, $entityType, $action);
+        if ($getCount) {
+            return $query->count();
         }
 
-        if ($entityModelInstance instanceof Page) {
-            $relations['chapter'] = function (BelongsTo $query) {
-                $query->scopes('visible');
-            };
-        }
+        $query = $query->skip(($page - 1) * $count)->take($count);
 
-        return $query->clone()
-            ->with(array_filter($relations))
-            ->skip(($page - 1) * $count)
-            ->take($count)
-            ->get();
+        return $query->get();
     }
 
     /**
      * Create a search query for an entity.
      */
-    protected function buildQuery(SearchOptions $searchOpts, Entity $entityModelInstance, string $action = 'view'): EloquentBuilder
+    protected function buildEntitySearchQuery(SearchOptions $searchOpts, string $entityType = 'page', string $action = 'view'): EloquentBuilder
     {
-        $entityQuery = $entityModelInstance->newQuery();
-
-        if ($entityModelInstance instanceof Page) {
-            $entityQuery->select($entityModelInstance::$listAttributes);
-        } else {
-            $entityQuery->select(['*']);
-        }
+        $entity = $this->entityProvider->get($entityType);
+        $entitySelect = $entity->newQuery();
 
         // Handle normal search terms
-        $this->applyTermSearch($entityQuery, $searchOpts, $entityModelInstance);
+        if (count($searchOpts->searches) > 0) {
+            $rawScoreSum = $this->db->raw('SUM(score) as score');
+            $subQuery = $this->db->table('search_terms')->select('entity_id', 'entity_type', $rawScoreSum);
+            $subQuery->where('entity_type', '=', $entity->getMorphClass());
+            $subQuery->where(function (Builder $query) use ($searchOpts) {
+                foreach ($searchOpts->searches as $inputTerm) {
+                    $query->orWhere('term', 'like', $inputTerm . '%');
+                }
+            })->groupBy('entity_type', 'entity_id');
+            $entitySelect->join($this->db->raw('(' . $subQuery->toSql() . ') as s'), function (JoinClause $join) {
+                $join->on('id', '=', 'entity_id');
+            })->addSelect($entity->getTable() . '.*')
+                ->selectRaw('s.score')
+                ->orderBy('score', 'desc');
+            $entitySelect->mergeBindings($subQuery);
+        }
 
         // Handle exact term matching
         foreach ($searchOpts->exacts as $inputTerm) {
-            $entityQuery->where(function (EloquentBuilder $query) use ($inputTerm, $entityModelInstance) {
+            $entitySelect->where(function (EloquentBuilder $query) use ($inputTerm, $entity) {
                 $query->where('name', 'like', '%' . $inputTerm . '%')
-                    ->orWhere($entityModelInstance->textField, 'like', '%' . $inputTerm . '%');
+                    ->orWhere($entity->textField, 'like', '%' . $inputTerm . '%');
             });
         }
 
         // Handle tag searches
         foreach ($searchOpts->tags as $inputTerm) {
-            $this->applyTagSearch($entityQuery, $inputTerm);
+            $this->applyTagSearch($entitySelect, $inputTerm);
         }
 
         // Handle filters
         foreach ($searchOpts->filters as $filterTerm => $filterValue) {
             $functionName = Str::camel('filter_' . $filterTerm);
             if (method_exists($this, $functionName)) {
-                $this->$functionName($entityQuery, $entityModelInstance, $filterValue);
+                $this->$functionName($entitySelect, $entity, $filterValue);
             }
         }
 
-        return $this->permissionService->enforceEntityRestrictions($entityModelInstance, $entityQuery, $action);
-    }
-
-    /**
-     * For the given search query, apply the queries for handling the regular search terms.
-     */
-    protected function applyTermSearch(EloquentBuilder $entityQuery, SearchOptions $options, Entity $entity): void
-    {
-        $terms = $options->searches;
-        if (count($terms) === 0) {
-            return;
-        }
-
-        $scoredTerms = $this->getTermAdjustments($options);
-        $scoreSelect = $this->selectForScoredTerms($scoredTerms);
-
-        $subQuery = DB::table('search_terms')->select([
-            'entity_id',
-            'entity_type',
-            DB::raw($scoreSelect['statement']),
-        ]);
-
-        $subQuery->addBinding($scoreSelect['bindings'], 'select');
-
-        $subQuery->where('entity_type', '=', $entity->getMorphClass());
-        $subQuery->where(function (Builder $query) use ($terms) {
-            foreach ($terms as $inputTerm) {
-                $query->orWhere('term', 'like', $inputTerm . '%');
-            }
-        });
-        $subQuery->groupBy('entity_type', 'entity_id');
-
-        $entityQuery->joinSub($subQuery, 's', 'id', '=', 'entity_id');
-        $entityQuery->addSelect('s.score');
-        $entityQuery->orderBy('score', 'desc');
-    }
-
-    /**
-     * Create a select statement, with prepared bindings, for the given
-     * set of scored search terms.
-     *
-     * @param array<string, float> $scoredTerms
-     *
-     * @return array{statement: string, bindings: string[]}
-     */
-    protected function selectForScoredTerms(array $scoredTerms): array
-    {
-        // Within this we walk backwards to create the chain of 'if' statements
-        // so that each previous statement is used in the 'else' condition of
-        // the next (earlier) to be built. We start at '0' to have no score
-        // on no match (Should never actually get to this case).
-        $ifChain = '0';
-        $bindings = [];
-        foreach ($scoredTerms as $term => $score) {
-            $ifChain = 'IF(term like ?, score * ' . (float) $score . ', ' . $ifChain . ')';
-            $bindings[] = $term . '%';
-        }
-
-        return [
-            'statement' => 'SUM(' . $ifChain . ') as score',
-            'bindings'  => array_reverse($bindings),
-        ];
-    }
-
-    /**
-     * For the terms in the given search options, query their popularity across all
-     * search terms then provide that back as score adjustment multiplier applicable
-     * for their rarity. Returns an array of float multipliers, keyed by term.
-     *
-     * @return array<string, float>
-     */
-    protected function getTermAdjustments(SearchOptions $options): array
-    {
-        if (isset($this->termAdjustmentCache[$options])) {
-            return $this->termAdjustmentCache[$options];
-        }
-
-        $termQuery = SearchTerm::query()->toBase();
-        $whenStatements = [];
-        $whenBindings = [];
-
-        foreach ($options->searches as $term) {
-            $whenStatements[] = 'WHEN term LIKE ? THEN ?';
-            $whenBindings[] = $term . '%';
-            $whenBindings[] = $term;
-
-            $termQuery->orWhere('term', 'like', $term . '%');
-        }
-
-        $case = 'CASE ' . implode(' ', $whenStatements) . ' END';
-        $termQuery->selectRaw($case . ' as term', $whenBindings);
-        $termQuery->selectRaw('COUNT(*) as count');
-        $termQuery->groupByRaw($case, $whenBindings);
-
-        $termCounts = $termQuery->pluck('count', 'term')->toArray();
-        $adjusted = $this->rawTermCountsToAdjustments($termCounts);
-
-        $this->termAdjustmentCache[$options] = $adjusted;
-
-        return $this->termAdjustmentCache[$options];
-    }
-
-    /**
-     * Convert counts of terms into a relative-count normalised multiplier.
-     *
-     * @param array<string, int> $termCounts
-     *
-     * @return array<string, int>
-     */
-    protected function rawTermCountsToAdjustments(array $termCounts): array
-    {
-        if (empty($termCounts)) {
-            return [];
-        }
-
-        $multipliers = [];
-        $max = max(array_values($termCounts));
-
-        foreach ($termCounts as $term => $count) {
-            $percent = round($count / $max, 5);
-            $multipliers[$term] = 1.3 - $percent;
-        }
-
-        return $multipliers;
+        return $this->permissionService->enforceEntityRestrictions($entity, $entitySelect, $action);
     }
 
     /**
@@ -335,7 +196,7 @@ class SearchRunner
             $escapedOperators[] = preg_quote($operator);
         }
 
-        return implode('|', $escapedOperators);
+        return join('|', $escapedOperators);
     }
 
     /**
@@ -357,9 +218,7 @@ class SearchRunner
                     // We have to do a raw sql query for this since otherwise PDO will quote the value and MySQL will
                     // search the value as a string which prevents being able to do number-based operations
                     // on the tag values. We ensure it has a numeric value and then cast it just to be sure.
-                    /** @var Connection $connection */
-                    $connection = $query->getConnection();
-                    $tagValue = (float) trim($connection->getPdo()->quote($tagValue), "'");
+                    $tagValue = (float) trim($query->getConnection()->getPdo()->quote($tagValue), "'");
                     $query->whereRaw("value ${tagOperator} ${tagValue}");
                 } else {
                     $query->where('value', $tagOperator, $tagValue);
@@ -375,40 +234,44 @@ class SearchRunner
     /**
      * Custom entity search filters.
      */
-    protected function filterUpdatedAfter(EloquentBuilder $query, Entity $model, $input): void
+    protected function filterUpdatedAfter(EloquentBuilder $query, Entity $model, $input)
     {
         try {
             $date = date_create($input);
-            $query->where('updated_at', '>=', $date);
         } catch (\Exception $e) {
+            return;
         }
+        $query->where('updated_at', '>=', $date);
     }
 
-    protected function filterUpdatedBefore(EloquentBuilder $query, Entity $model, $input): void
+    protected function filterUpdatedBefore(EloquentBuilder $query, Entity $model, $input)
     {
         try {
             $date = date_create($input);
-            $query->where('updated_at', '<', $date);
         } catch (\Exception $e) {
+            return;
         }
+        $query->where('updated_at', '<', $date);
     }
 
-    protected function filterCreatedAfter(EloquentBuilder $query, Entity $model, $input): void
+    protected function filterCreatedAfter(EloquentBuilder $query, Entity $model, $input)
     {
         try {
             $date = date_create($input);
-            $query->where('created_at', '>=', $date);
         } catch (\Exception $e) {
+            return;
         }
+        $query->where('created_at', '>=', $date);
     }
 
     protected function filterCreatedBefore(EloquentBuilder $query, Entity $model, $input)
     {
         try {
             $date = date_create($input);
-            $query->where('created_at', '<', $date);
         } catch (\Exception $e) {
+            return;
         }
+        $query->where('created_at', '<', $date);
     }
 
     protected function filterCreatedBy(EloquentBuilder $query, Entity $model, $input)
@@ -485,9 +348,9 @@ class SearchRunner
      */
     protected function sortByLastCommented(EloquentBuilder $query, Entity $model)
     {
-        $commentsTable = DB::getTablePrefix() . 'comments';
+        $commentsTable = $this->db->getTablePrefix() . 'comments';
         $morphClass = str_replace('\\', '\\\\', $model->getMorphClass());
-        $commentQuery = DB::raw('(SELECT c1.entity_id, c1.entity_type, c1.created_at as last_commented FROM ' . $commentsTable . ' c1 LEFT JOIN ' . $commentsTable . ' c2 ON (c1.entity_id = c2.entity_id AND c1.entity_type = c2.entity_type AND c1.created_at < c2.created_at) WHERE c1.entity_type = \'' . $morphClass . '\' AND c2.created_at IS NULL) as comments');
+        $commentQuery = $this->db->raw('(SELECT c1.entity_id, c1.entity_type, c1.created_at as last_commented FROM ' . $commentsTable . ' c1 LEFT JOIN ' . $commentsTable . ' c2 ON (c1.entity_id = c2.entity_id AND c1.entity_type = c2.entity_type AND c1.created_at < c2.created_at) WHERE c1.entity_type = \'' . $morphClass . '\' AND c2.created_at IS NULL) as comments');
 
         $query->join($commentQuery, $model->getTable() . '.id', '=', 'comments.entity_id')->orderBy('last_commented', 'desc');
     }

app/Entities/Tools/SiblingFetcher.php

@@ -5,8 +5,6 @@ namespace BookStack\Entities\Tools;
 use BookStack\Entities\EntityProvider;
 use BookStack\Entities\Models\Book;
 use BookStack\Entities\Models\Bookshelf;
-use BookStack\Entities\Models\Chapter;
-use BookStack\Entities\Models\Page;
 use Illuminate\Support\Collection;
 
 class SiblingFetcher
@@ -20,18 +18,18 @@ class SiblingFetcher
         $entities = [];
 
         // Page in chapter
-        if ($entity instanceof Page && $entity->chapter) {
+        if ($entity->isA('page') && $entity->chapter) {
             $entities = $entity->chapter->getVisiblePages();
         }
 
         // Page in book or chapter
-        if (($entity instanceof Page && !$entity->chapter) || $entity instanceof Chapter) {
+        if (($entity->isA('page') && !$entity->chapter) || $entity->isA('chapter')) {
             $entities = $entity->book->getDirectChildren();
         }
 
         // Book
         // Gets just the books in a shelf if shelf is in context
-        if ($entity instanceof Book) {
+        if ($entity->isA('book')) {
             $contextShelf = (new ShelfContext())->getContextualShelfForBook($entity);
             if ($contextShelf) {
                 $entities = $contextShelf->visibleBooks()->get();
@@ -40,8 +38,8 @@ class SiblingFetcher
             }
         }
 
-        // Shelf
-        if ($entity instanceof Bookshelf) {
+        // Shelve
+        if ($entity->isA('bookshelf')) {
             $entities = Bookshelf::visible()->get();
         }
 

app/Entities/Tools/SlugGenerator.php

@@ -4,14 +4,13 @@ namespace BookStack\Entities\Tools;
 
 use BookStack\Entities\Models\BookChild;
 use BookStack\Interfaces\Sluggable;
-use BookStack\Model;
 use Illuminate\Support\Str;
 
 class SlugGenerator
 {
     /**
      * Generate a fresh slug for the given entity.
-     * The slug will be generated so that it doesn't conflict within the same parent item.
+     * The slug will generated so it does not conflict within the same parent item.
      */
     public function generate(Sluggable $model): string
     {
@@ -39,8 +38,6 @@ class SlugGenerator
     /**
      * Check if a slug is already in-use for this
      * type of model within the same parent.
-     *
-     * @param Sluggable&Model $model
      */
     protected function slugInUse(string $slug, Sluggable $model): bool
     {

app/Entities/Tools/TrashCan.php

@@ -15,7 +15,6 @@ use BookStack\Facades\Activity;
 use BookStack\Uploads\AttachmentService;
 use BookStack\Uploads\ImageService;
 use Exception;
-use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Support\Carbon;
 
 class TrashCan
@@ -142,9 +141,11 @@ class TrashCan
     {
         $count = 0;
         $pages = $chapter->pages()->withTrashed()->get();
-        foreach ($pages as $page) {
-            $this->destroyPage($page);
-            $count++;
+        if (count($pages)) {
+            foreach ($pages as $page) {
+                $this->destroyPage($page);
+                $count++;
+            }
         }
 
         $this->destroyCommonRelations($chapter);
@@ -182,10 +183,9 @@ class TrashCan
     {
         $counts = [];
 
+        /** @var Entity $instance */
         foreach ((new EntityProvider())->all() as $key => $instance) {
-            /** @var Builder<Entity> $query */
-            $query = $instance->newQuery();
-            $counts[$key] = $query->onlyTrashed()->count();
+            $counts[$key] = $instance->newQuery()->onlyTrashed()->count();
         }
 
         return $counts;
@@ -235,15 +235,13 @@ class TrashCan
     {
         $shouldRestore = true;
         $restoreCount = 0;
+        $parent = $deletion->deletable->getParent();
 
-        if ($deletion->deletable instanceof Entity) {
-            $parent = $deletion->deletable->getParent();
-            if ($parent && $parent->trashed()) {
-                $shouldRestore = false;
-            }
+        if ($parent && $parent->trashed()) {
+            $shouldRestore = false;
         }
 
-        if ($deletion->deletable instanceof Entity && $shouldRestore) {
+        if ($shouldRestore) {
             $restoreCount = $this->restoreEntity($deletion->deletable);
         }
 
@@ -325,8 +323,6 @@ class TrashCan
         if ($entity instanceof Bookshelf) {
             return $this->destroyShelf($entity);
         }
-
-        return 0;
     }
 
     /**
@@ -344,9 +340,9 @@ class TrashCan
         $entity->deletions()->delete();
         $entity->favourites()->delete();
 
-        if ($entity instanceof HasCoverImage && $entity->cover()->exists()) {
+        if ($entity instanceof HasCoverImage && $entity->cover) {
             $imageService = app()->make(ImageService::class);
-            $imageService->destroy($entity->cover()->first());
+            $imageService->destroy($entity->cover);
         }
     }
 }

app/Exceptions/Handler.php

@@ -4,13 +4,11 @@ namespace BookStack\Exceptions;
 
 use Exception;
 use Illuminate\Auth\AuthenticationException;
-use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;
 use Symfony\Component\HttpKernel\Exception\HttpException;
-use Throwable;
 
 class Handler extends ExceptionHandler
 {
@@ -29,7 +27,6 @@ class Handler extends ExceptionHandler
      * @var array
      */
     protected $dontFlash = [
-        'current_password',
         'password',
         'password_confirmation',
     ];
@@ -37,13 +34,13 @@ class Handler extends ExceptionHandler
     /**
      * Report or log an exception.
      *
-     * @param \Throwable $exception
+     * @param Exception $exception
      *
-     * @throws \Throwable
+     * @throws Exception
      *
      * @return void
      */
-    public function report(Throwable $exception)
+    public function report(Exception $exception)
     {
         parent::report($exception);
     }
@@ -56,7 +53,7 @@ class Handler extends ExceptionHandler
      *
      * @return \Illuminate\Http\Response
      */
-    public function render($request, Throwable $e)
+    public function render($request, Exception $e)
     {
         if ($this->isApiRequest($request)) {
             return $this->renderApiException($e);
@@ -76,20 +73,15 @@ class Handler extends ExceptionHandler
     /**
      * Render an exception when the API is in use.
      */
-    protected function renderApiException(Throwable $e): JsonResponse
+    protected function renderApiException(Exception $e): JsonResponse
     {
-        $code = 500;
+        $code = $e->getCode() === 0 ? 500 : $e->getCode();
         $headers = [];
-
         if ($e instanceof HttpException) {
             $code = $e->getStatusCode();
             $headers = $e->getHeaders();
         }
 
-        if ($e instanceof ModelNotFoundException) {
-            $code = 404;
-        }
-
         $responseData = [
             'error' => [
                 'message' => $e->getMessage(),

app/Exceptions/NotifyException.php

@@ -23,7 +23,7 @@ class NotifyException extends Exception implements Responsable
     /**
      * Send the response for this type of exception.
      *
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function toResponse($request)
     {

app/Exceptions/PrettyException.php

@@ -20,7 +20,7 @@ class PrettyException extends Exception implements Responsable
     /**
      * Render a response for when this exception occurs.
      *
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function toResponse($request)
     {

app/Exceptions/SortOperationException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace BookStack\Exceptions;
+
+use Exception;
+
+class SortOperationException extends Exception
+{
+}

app/Exceptions/StoppedAuthenticationException.php

@@ -23,7 +23,7 @@ class StoppedAuthenticationException extends \Exception implements Responsable
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function toResponse($request)
     {

app/Facades/Activity.php

@@ -4,9 +4,6 @@ namespace BookStack\Facades;
 
 use Illuminate\Support\Facades\Facade;
 
-/**
- * @see \BookStack\Actions\ActivityLogger
- */
 class Activity extends Facade
 {
     /**

app/Http/Controllers/Api/ApiController.php

@@ -24,14 +24,9 @@ abstract class ApiController extends Controller
 
     /**
      * Get the validation rules for this controller.
-     * Defaults to a $rules property but can be a rules() method.
      */
     public function getValdationRules(): array
     {
-        if (method_exists($this, 'rules')) {
-            return $this->rules();
-        }
-
         return $this->rules;
     }
 }

app/Http/Controllers/Api/AttachmentApiController.php

@@ -15,6 +15,21 @@ class AttachmentApiController extends ApiController
 {
     protected $attachmentService;
 
+    protected $rules = [
+        'create' => [
+            'name'        => 'required|min:1|max:255|string',
+            'uploaded_to' => 'required|integer|exists:pages,id',
+            'file'        => 'required_without:link|file',
+            'link'        => 'required_without:file|min:1|max:255|safe_url',
+        ],
+        'update' => [
+            'name'        => 'min:1|max:255|string',
+            'uploaded_to' => 'integer|exists:pages,id',
+            'file'        => 'file',
+            'link'        => 'min:1|max:255|safe_url',
+        ],
+    ];
+
     public function __construct(AttachmentService $attachmentService)
     {
         $this->attachmentService = $attachmentService;
@@ -46,7 +61,7 @@ class AttachmentApiController extends ApiController
     public function create(Request $request)
     {
         $this->checkPermission('attachment-create-all');
-        $requestData = $this->validate($request, $this->rules()['create']);
+        $requestData = $this->validate($request, $this->rules['create']);
 
         $pageId = $request->get('uploaded_to');
         $page = Page::visible()->findOrFail($pageId);
@@ -107,7 +122,7 @@ class AttachmentApiController extends ApiController
      */
     public function update(Request $request, string $id)
     {
-        $requestData = $this->validate($request, $this->rules()['update']);
+        $requestData = $this->validate($request, $this->rules['update']);
         /** @var Attachment $attachment */
         $attachment = Attachment::visible()->findOrFail($id);
 
@@ -147,22 +162,4 @@ class AttachmentApiController extends ApiController
 
         return response('', 204);
     }
-
-    protected function rules(): array
-    {
-        return [
-            'create' => [
-                'name'        => ['required', 'min:1', 'max:255', 'string'],
-                'uploaded_to' => ['required', 'integer', 'exists:pages,id'],
-                'file'        => array_merge(['required_without:link'], $this->attachmentService->getFileValidationRules()),
-                'link'        => ['required_without:file', 'min:1', 'max:255', 'safe_url'],
-            ],
-            'update' => [
-                'name'        => ['min:1', 'max:255', 'string'],
-                'uploaded_to' => ['integer', 'exists:pages,id'],
-                'file'        => $this->attachmentService->getFileValidationRules(),
-                'link'        => ['min:1', 'max:255', 'safe_url'],
-            ],
-        ];
-    }
 }

app/Http/Controllers/Api/BookApiController.php

@@ -13,14 +13,14 @@ class BookApiController extends ApiController
 
     protected $rules = [
         'create' => [
-            'name'        => ['required', 'string', 'max:255'],
-            'description' => ['string', 'max:1000'],
-            'tags'        => ['array'],
+            'name'        => 'required|string|max:255',
+            'description' => 'string|max:1000',
+            'tags'        => 'array',
         ],
         'update' => [
-            'name'        => ['string', 'min:1', 'max:255'],
-            'description' => ['string', 'max:1000'],
-            'tags'        => ['array'],
+            'name'        => 'string|min:1|max:255',
+            'description' => 'string|max:1000',
+            'tags'        => 'array',
         ],
     ];
 

app/Http/Controllers/Api/BookshelfApiController.php

@@ -18,14 +18,14 @@ class BookshelfApiController extends ApiController
 
     protected $rules = [
         'create' => [
-            'name'        => ['required', 'string', 'max:255'],
-            'description' => ['string', 'max:1000'],
-            'books'       => ['array'],
+            'name'        => 'required|string|max:255',
+            'description' => 'string|max:1000',
+            'books'       => 'array',
         ],
         'update' => [
-            'name'        => ['string', 'min:1', 'max:255'],
-            'description' => ['string', 'max:1000'],
-            'books'       => ['array'],
+            'name'        => 'string|min:1|max:255',
+            'description' => 'string|max:1000',
+            'books'       => 'array',
         ],
     ];
 
@@ -75,7 +75,7 @@ class BookshelfApiController extends ApiController
         $shelf = Bookshelf::visible()->with([
             'tags', 'cover', 'createdBy', 'updatedBy', 'ownedBy',
             'books' => function (BelongsToMany $query) {
-                $query->scopes('visible')->get(['id', 'name', 'slug']);
+                $query->visible()->get(['id', 'name', 'slug']);
             },
         ])->findOrFail($id);
 

app/Http/Controllers/Api/ChapterApiController.php

@@ -14,16 +14,16 @@ class ChapterApiController extends ApiController
 
     protected $rules = [
         'create' => [
-            'book_id'     => ['required', 'integer'],
-            'name'        => ['required', 'string', 'max:255'],
-            'description' => ['string', 'max:1000'],
-            'tags'        => ['array'],
+            'book_id'     => 'required|integer',
+            'name'        => 'required|string|max:255',
+            'description' => 'string|max:1000',
+            'tags'        => 'array',
         ],
         'update' => [
-            'book_id'     => ['integer'],
-            'name'        => ['string', 'min:1', 'max:255'],
-            'description' => ['string', 'max:1000'],
-            'tags'        => ['array'],
+            'book_id'     => 'integer',
+            'name'        => 'string|min:1|max:255',
+            'description' => 'string|max:1000',
+            'tags'        => 'array',
         ],
     ];
 
@@ -70,7 +70,7 @@ class ChapterApiController extends ApiController
     public function read(string $id)
     {
         $chapter = Chapter::visible()->with(['tags', 'createdBy', 'updatedBy', 'ownedBy', 'pages' => function (HasMany $query) {
-            $query->scopes('visible')->get(['id', 'name', 'slug']);
+            $query->visible()->get(['id', 'name', 'slug']);
         }])->findOrFail($id);
 
         return response()->json($chapter);

app/Http/Controllers/Api/PageApiController.php

@@ -16,20 +16,20 @@ class PageApiController extends ApiController
 
     protected $rules = [
         'create' => [
-            'book_id'    => ['required_without:chapter_id', 'integer'],
-            'chapter_id' => ['required_without:book_id', 'integer'],
-            'name'       => ['required', 'string', 'max:255'],
-            'html'       => ['required_without:markdown', 'string'],
-            'markdown'   => ['required_without:html', 'string'],
-            'tags'       => ['array'],
+            'book_id'    => 'required_without:chapter_id|integer',
+            'chapter_id' => 'required_without:book_id|integer',
+            'name'       => 'required|string|max:255',
+            'html'       => 'required_without:markdown|string',
+            'markdown'   => 'required_without:html|string',
+            'tags'       => 'array',
         ],
         'update' => [
-            'book_id'    => ['required', 'integer'],
-            'chapter_id' => ['required', 'integer'],
-            'name'       => ['string', 'min:1', 'max:255'],
-            'html'       => ['string'],
-            'markdown'   => ['string'],
-            'tags'       => ['array'],
+            'book_id'    => 'required|integer',
+            'chapter_id' => 'required|integer',
+            'name'       => 'string|min:1|max:255',
+            'html'       => 'string',
+            'markdown'   => 'string',
+            'tags'       => 'array',
         ],
     ];
 

app/Http/Controllers/Api/SearchApiController.php

@@ -1,74 +0,0 @@
-<?php
-
-namespace BookStack\Http\Controllers\Api;
-
-use BookStack\Entities\Models\Entity;
-use BookStack\Entities\Tools\SearchOptions;
-use BookStack\Entities\Tools\SearchResultsFormatter;
-use BookStack\Entities\Tools\SearchRunner;
-use Illuminate\Http\Request;
-
-class SearchApiController extends ApiController
-{
-    protected $searchRunner;
-    protected $resultsFormatter;
-
-    protected $rules = [
-        'all' => [
-            'query'  => ['required'],
-            'page'   => ['integer', 'min:1'],
-            'count'  => ['integer', 'min:1', 'max:100'],
-        ],
-    ];
-
-    public function __construct(SearchRunner $searchRunner, SearchResultsFormatter $resultsFormatter)
-    {
-        $this->searchRunner = $searchRunner;
-        $this->resultsFormatter = $resultsFormatter;
-    }
-
-    /**
-     * Run a search query against all main content types (shelves, books, chapters & pages)
-     * in the system. Takes the same input as the main search bar within the BookStack
-     * interface as a 'query' parameter. See https://www.bookstackapp.com/docs/user/searching/
-     * for a full list of search term options. Results contain a 'type' property to distinguish
-     * between: bookshelf, book, chapter & page.
-     *
-     * The paging parameters and response format emulates a standard listing endpoint
-     * but standard sorting and filtering cannot be done on this endpoint. If a count value
-     * is provided this will only be taken as a suggestion. The results in the response
-     * may currently be up to 4x this value.
-     */
-    public function all(Request $request)
-    {
-        $this->validate($request, $this->rules['all']);
-
-        $options = SearchOptions::fromString($request->get('query') ?? '');
-        $page = intval($request->get('page', '0')) ?: 1;
-        $count = min(intval($request->get('count', '0')) ?: 20, 100);
-
-        $results = $this->searchRunner->searchEntities($options, 'all', $page, $count);
-        $this->resultsFormatter->format($results['results']->all(), $options);
-
-        /** @var Entity $result */
-        foreach ($results['results'] as $result) {
-            $result->setVisible([
-                'id', 'name', 'slug', 'book_id',
-                'chapter_id', 'draft', 'template',
-                'created_at', 'updated_at',
-                'tags', 'type', 'preview_html', 'url',
-            ]);
-            $result->setAttribute('type', $result->getType());
-            $result->setAttribute('url', $result->getUrl());
-            $result->setAttribute('preview_html', [
-                'name'    => (string) $result->getAttribute('preview_name'),
-                'content' => (string) $result->getAttribute('preview_content'),
-            ]);
-        }
-
-        return response()->json([
-            'data'  => $results['results'],
-            'total' => $results['total'],
-        ]);
-    }
-}

app/Http/Controllers/AttachmentController.php

@@ -36,8 +36,8 @@ class AttachmentController extends Controller
     public function upload(Request $request)
     {
         $this->validate($request, [
-            'uploaded_to' => ['required', 'integer', 'exists:pages,id'],
-            'file'        => array_merge(['required'], $this->attachmentService->getFileValidationRules()),
+            'uploaded_to' => 'required|integer|exists:pages,id',
+            'file'        => 'required|file',
         ]);
 
         $pageId = $request->get('uploaded_to');
@@ -65,10 +65,9 @@ class AttachmentController extends Controller
     public function uploadUpdate(Request $request, $attachmentId)
     {
         $this->validate($request, [
-            'file' => array_merge(['required'], $this->attachmentService->getFileValidationRules()),
+            'file' => 'required|file',
         ]);
 
-        /** @var Attachment $attachment */
         $attachment = Attachment::query()->findOrFail($attachmentId);
         $this->checkOwnablePermission('view', $attachment->page);
         $this->checkOwnablePermission('page-update', $attachment->page);
@@ -87,10 +86,11 @@ class AttachmentController extends Controller
 
     /**
      * Get the update form for an attachment.
+     *
+     * @return \Illuminate\Contracts\Foundation\Application|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
      */
     public function getUpdateForm(string $attachmentId)
     {
-        /** @var Attachment $attachment */
         $attachment = Attachment::query()->findOrFail($attachmentId);
 
         $this->checkOwnablePermission('page-update', $attachment->page);
@@ -111,8 +111,8 @@ class AttachmentController extends Controller
 
         try {
             $this->validate($request, [
-                'attachment_edit_name' => ['required', 'string', 'min:1', 'max:255'],
-                'attachment_edit_url'  => ['string', 'min:1', 'max:255', 'safe_url'],
+                'attachment_edit_name' => 'required|string|min:1|max:255',
+                'attachment_edit_url'  => 'string|min:1|max:255|safe_url',
             ]);
         } catch (ValidationException $exception) {
             return response()->view('attachments.manager-edit-form', array_merge($request->only(['attachment_edit_name', 'attachment_edit_url']), [
@@ -146,9 +146,9 @@ class AttachmentController extends Controller
 
         try {
             $this->validate($request, [
-                'attachment_link_uploaded_to' => ['required', 'integer', 'exists:pages,id'],
-                'attachment_link_name'        => ['required', 'string', 'min:1', 'max:255'],
-                'attachment_link_url'         => ['required', 'string', 'min:1', 'max:255', 'safe_url'],
+                'attachment_link_uploaded_to' => 'required|integer|exists:pages,id',
+                'attachment_link_name'        => 'required|string|min:1|max:255',
+                'attachment_link_url'         => 'required|string|min:1|max:255|safe_url',
             ]);
         } catch (ValidationException $exception) {
             return response()->view('attachments.manager-link-form', array_merge($request->only(['attachment_link_name', 'attachment_link_url']), [
@@ -173,8 +173,6 @@ class AttachmentController extends Controller
 
     /**
      * Get the attachments for a specific page.
-     *
-     * @throws NotFoundException
      */
     public function listForPage(int $pageId)
     {
@@ -195,7 +193,7 @@ class AttachmentController extends Controller
     public function sortForPage(Request $request, int $pageId)
     {
         $this->validate($request, [
-            'order' => ['required', 'array'],
+            'order' => 'required|array',
         ]);
         $page = $this->pageRepo->getById($pageId);
         $this->checkOwnablePermission('page-update', $page);

app/Http/Controllers/AuditLogController.php

@@ -20,7 +20,6 @@ class AuditLogController extends Controller
             'date_from' => $request->get('date_from', ''),
             'date_to'   => $request->get('date_to', ''),
             'user'      => $request->get('user', ''),
-            'ip'        => $request->get('ip', ''),
         ];
 
         $query = Activity::query()
@@ -45,9 +44,6 @@ class AuditLogController extends Controller
         if ($listDetails['date_to']) {
             $query->where('created_at', '<=', $listDetails['date_to']);
         }
-        if ($listDetails['ip']) {
-            $query->where('ip', 'like', $listDetails['ip'] . '%');
-        }
 
         $activities = $query->paginate(100);
         $activities->appends($listDetails);

app/Http/Controllers/Auth/ConfirmEmailController.php

@@ -10,7 +10,10 @@ use BookStack\Exceptions\UserTokenExpiredException;
 use BookStack\Exceptions\UserTokenNotFoundException;
 use BookStack\Http\Controllers\Controller;
 use Exception;
+use Illuminate\Http\RedirectResponse;
 use Illuminate\Http\Request;
+use Illuminate\Routing\Redirector;
+use Illuminate\View\View;
 
 class ConfirmEmailController extends Controller
 {
@@ -54,23 +57,33 @@ class ConfirmEmailController extends Controller
     /**
      * Confirms an email via a token and logs the user into the system.
      *
+     * @param $token
+     *
      * @throws ConfirmationEmailException
      * @throws Exception
+     *
+     * @return RedirectResponse|Redirector
      */
-    public function confirm(string $token)
+    public function confirm($token)
     {
         try {
             $userId = $this->emailConfirmationService->checkTokenAndGetUserId($token);
-        } catch (UserTokenNotFoundException $exception) {
-            $this->showErrorNotification(trans('errors.email_confirmation_invalid'));
+        } catch (Exception $exception) {
+            if ($exception instanceof UserTokenNotFoundException) {
+                $this->showErrorNotification(trans('errors.email_confirmation_invalid'));
 
-            return redirect('/register');
-        } catch (UserTokenExpiredException $exception) {
-            $user = $this->userRepo->getById($exception->userId);
-            $this->emailConfirmationService->sendConfirmation($user);
-            $this->showErrorNotification(trans('errors.email_confirmation_expired'));
+                return redirect('/register');
+            }
 
-            return redirect('/register/confirm');
+            if ($exception instanceof UserTokenExpiredException) {
+                $user = $this->userRepo->getById($exception->userId);
+                $this->emailConfirmationService->sendConfirmation($user);
+                $this->showErrorNotification(trans('errors.email_confirmation_expired'));
+
+                return redirect('/register/confirm');
+            }
+
+            throw $exception;
         }
 
         $user = $this->userRepo->getById($userId);
@@ -79,17 +92,22 @@ class ConfirmEmailController extends Controller
 
         $this->emailConfirmationService->deleteByUser($user);
         $this->showSuccessNotification(trans('auth.email_confirm_success'));
+        $this->loginService->login($user, auth()->getDefaultDriver());
 
-        return redirect('/login');
+        return redirect('/');
     }
 
     /**
      * Resend the confirmation email.
+     *
+     * @param Request $request
+     *
+     * @return View
      */
     public function resend(Request $request)
     {
         $this->validate($request, [
-            'email' => ['required', 'email', 'exists:users,email'],
+            'email' => 'required|email|exists:users,email',
         ]);
         $user = $this->userRepo->getByEmail($request->get('email'));
 

app/Http/Controllers/Auth/ForgotPasswordController.php

@@ -43,9 +43,7 @@ class ForgotPasswordController extends Controller
      */
     public function sendResetLinkEmail(Request $request)
     {
-        $this->validate($request, [
-            'email' => ['required', 'email'],
-        ]);
+        $this->validate($request, ['email' => 'required|email']);
 
         // We will send the password reset link to this user. Once we have attempted
         // to send the link, we will examine the response then see the message we

app/Http/Controllers/Auth/LoginController.php

@@ -2,11 +2,11 @@
 
 namespace BookStack\Http\Controllers\Auth;
 
+use Activity;
 use BookStack\Auth\Access\LoginService;
 use BookStack\Auth\Access\SocialAuthService;
 use BookStack\Exceptions\LoginAttemptEmailNeededException;
 use BookStack\Exceptions\LoginAttemptException;
-use BookStack\Facades\Activity;
 use BookStack\Http\Controllers\Controller;
 use Illuminate\Foundation\Auth\AuthenticatesUsers;
 use Illuminate\Http\Request;
@@ -176,16 +176,16 @@ class LoginController extends Controller
      */
     protected function validateLogin(Request $request)
     {
-        $rules = ['password' => ['required', 'string']];
+        $rules = ['password' => 'required|string'];
         $authMethod = config('auth.method');
 
         if ($authMethod === 'standard') {
-            $rules['email'] = ['required', 'email'];
+            $rules['email'] = 'required|email';
         }
 
         if ($authMethod === 'ldap') {
-            $rules['username'] = ['required', 'string'];
-            $rules['email'] = ['email'];
+            $rules['username'] = 'required|string';
+            $rules['email'] = 'email';
         }
 
         $request->validate($rules);

app/Http/Controllers/Auth/MfaBackupCodesController.php

@@ -29,8 +29,6 @@ class MfaBackupCodesController extends Controller
 
         $downloadUrl = 'data:application/octet-stream;base64,' . base64_encode(implode("\n\n", $codes));
 
-        $this->setPageTitle(trans('auth.mfa_gen_backup_codes_title'));
-
         return view('mfa.backup-codes-generate', [
             'codes'       => $codes,
             'downloadUrl' => $downloadUrl,
@@ -75,7 +73,8 @@ class MfaBackupCodesController extends Controller
 
         $this->validate($request, [
             'code' => [
-                'required', 'max:12', 'min:8',
+                'required',
+                'max:12', 'min:8',
                 function ($attribute, $value, $fail) use ($codeService, $codes) {
                     if (!$codeService->inputCodeExistsInSet($value, $codes)) {
                         $fail(trans('validation.backup_codes'));

app/Http/Controllers/Auth/MfaController.php

@@ -21,8 +21,6 @@ class MfaController extends Controller
             ->get(['id', 'method'])
             ->groupBy('method');
 
-        $this->setPageTitle(trans('auth.mfa_setup'));
-
         return view('mfa.setup', [
             'userMethods' => $userMethods,
         ]);

app/Http/Controllers/Auth/MfaTotpController.php

@@ -34,8 +34,6 @@ class MfaTotpController extends Controller
         $qrCodeUrl = $totp->generateUrl($totpSecret, $this->currentOrLastAttemptedUser());
         $svg = $totp->generateQrCodeSvg($qrCodeUrl);
 
-        $this->setPageTitle(trans('auth.mfa_gen_totp_title'));
-
         return view('mfa.totp-generate', [
             'url' => $qrCodeUrl,
             'svg' => $svg,

app/Http/Controllers/Auth/RegisterController.php

@@ -13,7 +13,6 @@ use Illuminate\Foundation\Auth\RegistersUsers;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Hash;
 use Illuminate\Support\Facades\Validator;
-use Illuminate\Validation\Rules\Password;
 
 class RegisterController extends Controller
 {
@@ -69,9 +68,9 @@ class RegisterController extends Controller
     protected function validator(array $data)
     {
         return Validator::make($data, [
-            'name'     => ['required', 'min:2', 'max:255'],
-            'email'    => ['required', 'email', 'max:255', 'unique:users'],
-            'password' => ['required', Password::default()],
+            'name'     => 'required|min:2|max:255',
+            'email'    => 'required|email|max:255|unique:users',
+            'password' => 'required|min:8',
         ]);
     }