Updated version and assets for release v21.08.2

Revert "Update german translation"

.env.example

@@ -41,4 +41,4 @@ MAIL_HOST=localhost
 MAIL_PORT=1025
 MAIL_USERNAME=null
 MAIL_PASSWORD=null
-MAIL_ENCRYPTION=null
+MAIL_ENCRYPTION=null

.env.example.complete

@@ -42,14 +42,6 @@ APP_TIMEZONE=UTC
 # overrides can be made. Defaults to disabled.
 APP_THEME=false
 
-# Trusted Proxies
-# Used to indicate trust of systems that proxy to the application so
-# certain header values (Such as "X-Forwarded-For") can be used from the
-# incoming proxy request to provide origin detail.
-# Set to an IP address, or multiple comma seperated IP addresses.
-# Can alternatively be set to "*" to trust all proxy addresses.
-APP_PROXIES=null
-
 # Database details
 # Host can contain a port (localhost:3306) or a separate DB_PORT option can be used.
 DB_HOST=localhost
@@ -100,7 +92,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 +126,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
@@ -231,8 +224,6 @@ SAML2_ONELOGIN_OVERRIDES=null
 SAML2_DUMP_USER_DETAILS=false
 SAML2_AUTOLOAD_METADATA=false
 SAML2_IDP_AUTHNCONTEXT=true
-SAML2_SP_x509=null
-SAML2_SP_x509_KEY=null
 
 # SAML group sync configuration
 # Refer to https://www.bookstackapp.com/docs/admin/saml2-auth/
@@ -240,19 +231,6 @@ SAML2_USER_TO_GROUPS=false
 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
-OIDC_CLIENT_SECRET=null
-OIDC_ISSUER=null
-OIDC_ISSUER_DISCOVER=false
-OIDC_PUBLIC_KEY=null
-OIDC_AUTH_ENDPOINT=null
-OIDC_TOKEN_ENDPOINT=null
-OIDC_DUMP_USER_DETAILS=false
-
 # Disable default third-party services such as Gravatar and Draw.IO
 # Service-specific options will override this option
 DISABLE_EXTERNAL_SERVICES=false
@@ -293,10 +271,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/ISSUE_TEMPLATE/api_request.md

@@ -0,0 +1,17 @@
+---
+name: New API Endpoint or Feature
+about: Request a new endpoint or API feature be added
+labels: ":nut_and_bolt: API Request"
+---
+
+#### API Endpoint or Feature
+
+Clearly describe what you'd like to have added to the API. 
+
+#### Use-Case
+
+Explain the use-case that you're working-on that requires the above request.
+
+#### Additional Context
+
+If required, add any other context about the feature request here.

.github/ISSUE_TEMPLATE/api_request.yml

@@ -1,26 +0,0 @@
-name: New API Endpoint or API Ability
-description: Request a new endpoint or API feature be added
-title: "[API Request]: "
-labels: [":nut_and_bolt: API Request"]
-body:
-  - type: textarea
-    id: feature
-    attributes:
-      label: API Endpoint or Feature
-      description: Clearly describe what you'd like to have added to the API.
-    validations:
-      required: true
-  - type: textarea
-    id: usecase
-    attributes:
-      label: Use-Case
-      description: Explain the use-case that you're working-on that requires the above request.
-    validations:
-      required: true
-  - type: textarea
-    id: context
-    attributes:
-      label: Additional context
-      description: Add any other context about the feature request here.
-    validations:
-      required: false

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Steps To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Your Configuration (please complete the following information):**
+ - Exact BookStack Version (Found in settings):
+ - PHP Version:
+ - Hosting Method (Nginx/Apache/Docker): 
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,62 +0,0 @@
-name: Bug Report
-description: Create a report to help us improve or fix things
-title: "[Bug Report]: "
-labels: [":bug: Bug"]
-body:
-  - type: textarea
-    id: description
-    attributes:
-      label: Describe the Bug
-      description: Provide a clear and concise description of what the bug is.
-    validations:
-      required: true
-  - type: textarea
-    id: reproduction
-    attributes:
-      label: Steps to Reproduce
-      description: Detail the steps that would replicate this issue
-      placeholder: |
-        1. Go to '...'
-        2. Click on '....'
-        3. Scroll down to '....'
-        4. See error
-    validations:
-      required: true
-  - type: textarea
-    id: expected
-    attributes:
-      label: Expected Behaviour
-      description: Provide clear and concise description of what you expected to happen.
-    validations:
-      required: true
-  - type: textarea
-    id: context
-    attributes:
-      label: Screenshots or Additional Context
-      description: Provide any additional context and screenshots here to help us solve this issue
-    validations:
-      required: false
-  - type: input
-    id: bsversion
-    attributes:
-      label: Exact BookStack Version
-      description: This can be found in the settings view of BookStack. Please provide an exact version.
-      placeholder: (eg. v21.08.5)
-    validations:
-      required: true
-  - type: input
-    id: phpversion
-    attributes:
-      label: PHP Version
-      description: Keep in mind your command-line PHP version may differ to that of your webserver. Provide that relevant to the issue.
-      placeholder: (eg. 7.4)
-    validations:
-      required: false
-  - type: textarea
-    id: hosting
-    attributes:
-      label: Hosting Environment
-      description: Describe your hosting environment as much as possible including any proxies used (If applicable).
-      placeholder: (eg. Ubuntu 20.04 VPS, installed using official installation script)
-    validations:
-      required: true

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+
+---
+
+**Describe the feature you'd like**
+A clear description of the feature you'd like implemented in BookStack.
+
+**Describe the benefits this feature would bring to BookStack users**
+Explain the measurable benefits this feature would achieve.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,26 +0,0 @@
-name: Feature Request
-description: Request a new language to be added to CrowdIn for you to translate
-title: "[Feature Request]: "
-labels: [":hammer: Feature Request"]
-body:
-  - type: textarea
-    id: description
-    attributes:
-      label: Describe the feature you'd like
-      description: Provide a clear description of the feature you'd like implemented in BookStack
-    validations:
-      required: true
-  - type: textarea
-    id: benefits
-    attributes:
-      label: Describe the benefits this feature would bring to BookStack users
-      description: Explain the measurable benefits this feature would achieve for existing BookStack users
-    validations:
-      required: true
-  - type: textarea
-    id: context
-    attributes:
-      label: Additional context
-      description: Add any other context or screenshots about the feature request here.
-    validations:
-      required: false

.github/ISSUE_TEMPLATE/language_request.md

@@ -0,0 +1,13 @@
+---
+name: Language Request
+about: Request a new language to be added to Crowdin for you to translate
+
+---
+
+### Language To Add
+
+_Specify here the language you want to add._
+
+----
+
+_This issue template is to request a new language be added to our [Crowdin translation management project](https://crowdin.com/project/bookstack). Please don't use this template to request a new language that you are not prepared to provide translations for._   

.github/ISSUE_TEMPLATE/language_request.yml

@@ -1,32 +0,0 @@
-name: Language Request
-description: Request a new language to be added to CrowdIn for you to translate
-title: "[Language Request]: "
-labels: [":earth_africa: Translations"]
-assignees:
-  - ssddanbrown
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for offering to help start a new translation for BookStack!
-  - type: input
-    id: language
-    attributes:
-      label: Language to Add
-      description: What language (and region if applicable) are you offering to help add to BookStack?
-    validations:
-      required: true
-  - type: checkboxes
-    id: confirm
-    attributes:
-      label: Confirmation of Intent
-      description: |
-        This issue template is to request a new language be added to our [Crowdin translation management project](https://crowdin.com/project/bookstack).
-        Please don't use this template to request a new language that you are not prepared to provide translations for.
-      options:
-        - label: I confirm I'm offering to help translate for this new language via CrowdIn.
-          required: true
-  - type: markdown
-    attributes:
-      value: |
-        *__Note: New languages are added at specific points of the development process so it may be a small while before the requested language is added for translation.__*

.github/ISSUE_TEMPLATE/support_request.yml

@@ -1,63 +0,0 @@
-name: Support Request
-description: Request support for a specific problem you have not been able to solve yourself
-title: "[Support Request]: "
-labels: [":dog2: Support"]
-body:
-  - type: checkboxes
-    id: useddocs
-    attributes:
-      label: Attempted Debugging
-      description: |
-        I have read the [BookStack debugging](https://www.bookstackapp.com/docs/admin/debugging/) page and seeked resolution or more
-        detail for the issue.
-      options:
-        - label: I have read the debugging page
-          required: true
-  - type: checkboxes
-    id: searchissue
-    attributes:
-      label: Searched GitHub Issues
-      description: |
-        I have searched for the issue and potential resolutions within the [project's GitHub issue list](https://github.com/BookStackApp/BookStack/issues)
-      options:
-        - label: I have searched GitHub for the issue.
-          required: true
-  - type: textarea
-    id: scenario
-    attributes:
-      label: Describe the Scenario
-      description: Detail the problem that you're having or what you need support with.
-    validations:
-      required: true
-  - type: input
-    id: bsversion
-    attributes:
-      label: Exact BookStack Version
-      description: This can be found in the settings view of BookStack. Please provide an exact version.
-      placeholder: (eg. v21.08.5)
-    validations:
-      required: true
-  - type: textarea
-    id: logs
-    attributes:
-      label: Log Content
-      description: If the issue has produced an error, provide any [BookStack or server log](https://www.bookstackapp.com/docs/admin/debugging/) content below.
-      placeholder: Be sure to remove any confidential details in your logs
-    validations:
-      required: false
-  - type: input
-    id: phpversion
-    attributes:
-      label: PHP Version
-      description: Keep in mind your command-line PHP version may differ to that of your webserver. Provide that most relevant to the issue.
-      placeholder: (eg. 7.4)
-    validations:
-      required: false
-  - type: textarea
-    id: hosting
-    attributes:
-      label: Hosting Environment
-      description: Describe your hosting environment as much as possible including any proxies used (If applicable).
-      placeholder: (eg. Ubuntu 20.04 VPS, installed using official installation script)
-    validations:
-      required: true

.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
@@ -184,29 +184,3 @@ Frost-ZX :: Chinese Simplified
 Kuzma Simonov (ovmach) :: Russian
 Vojtěch Krystek (acantophis) :: Czech
 Michał Lipok (mLipok) :: Polish
-Nicolas Pawlak (Mikolajek) :: French; Polish; German
-Thomas Hansen (thomasdk81) :: Danish
-Hl2run :: Slovak
-Ngo Tri Hoai (trihoai) :: Vietnamese
-Atalonica :: Catalan
-慕容潭谈 (591442386) :: Chinese Simplified
-Radim Pesek (ramess18) :: Czech
-anastasiia.motylko :: Ukrainian
-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,197 @@
+<?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
+    {
+        return $this->activity->newInstance()->forceFill([
+            'type'     => strtolower($type),
+            'user_id'  => user()->id,
+        ]);
+    }
+
+    /**
+     * Removes the entity attachment from each of its activities
+     * and instead uses the 'extra' field with the entities name.
+     * Used when an entity is deleted.
+     */
+    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,19 +4,16 @@ namespace BookStack\Actions;
 
 use BookStack\Model;
 use BookStack\Traits\HasCreatorAndUpdater;
-use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 
 /**
- * @property int      $id
- * @property string   $text
- * @property string   $html
- * @property int|null $parent_id
- * @property int      $local_id
+ * @property string text
+ * @property string html
+ * @property int|null parent_id
+ * @property int local_id
  */
 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,54 +4,21 @@ namespace BookStack\Actions;
 
 use BookStack\Auth\Permissions\PermissionService;
 use BookStack\Entities\Models\Entity;
-use Illuminate\Database\Eloquent\Builder;
+use DB;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Facades\DB;
 
 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/ExternalAuthService.php

@@ -6,7 +6,7 @@ use BookStack\Auth\Role;
 use BookStack\Auth\User;
 use Illuminate\Support\Collection;
 
-class GroupSyncService
+class ExternalAuthService
 {
     /**
      * Check a role against an array of group names to see if it matches.
@@ -60,13 +60,13 @@ class GroupSyncService
     /**
      * Sync the groups to the user roles for the current user.
      */
-    public function syncUserWithFoundGroups(User $user, array $userGroups, bool $detachExisting): void
+    public function syncWithGroups(User $user, array $userGroups): void
     {
         // Get the ids for the roles from the names
         $groupsAsRoles = $this->matchGroupsToSystemsRoles($userGroups);
 
         // Sync groups
-        if ($detachExisting) {
+        if ($this->config['remove_from_groups']) {
             $user->roles()->sync($groupsAsRoles);
             $user->attachDefaultRole();
         } else {

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/Guards/Saml2SessionGuard.php

@@ -10,7 +10,7 @@ namespace BookStack\Auth\Access\Guards;
  * via the Saml2 controller & Saml2Service. This class provides a safer, thin
  * version of SessionGuard.
  */
-class AsyncExternalBaseSessionGuard extends ExternalBaseSessionGuard
+class Saml2SessionGuard extends ExternalBaseSessionGuard
 {
     /**
      * Validate a user's credentials.

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

@@ -13,10 +13,9 @@ use Illuminate\Support\Facades\Log;
  * Class LdapService
  * Handles any app-specific LDAP tasks.
  */
-class LdapService
+class LdapService extends ExternalAuthService
 {
     protected $ldap;
-    protected $groupSyncService;
     protected $ldapConnection;
     protected $userAvatars;
     protected $config;
@@ -25,19 +24,20 @@ class LdapService
     /**
      * LdapService constructor.
      */
-    public function __construct(Ldap $ldap, UserAvatars $userAvatars, GroupSyncService $groupSyncService)
+    public function __construct(Ldap $ldap, UserAvatars $userAvatars)
     {
         $this->ldap = $ldap;
         $this->userAvatars = $userAvatars;
-        $this->groupSyncService = $groupSyncService;
         $this->config = config('services.ldap');
         $this->enabled = config('auth.method') === 'ldap';
     }
 
     /**
      * Check if groups should be synced.
+     *
+     * @return bool
      */
-    public function shouldSyncGroups(): bool
+    public function shouldSyncGroups()
     {
         return $this->enabled && $this->config['user_to_groups'] !== false;
     }
@@ -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
      */
@@ -285,8 +285,9 @@ class LdapService
         }
 
         $userGroups = $this->groupFilter($user);
+        $userGroups = $this->getGroupsRecursive($userGroups, []);
 
-        return $this->getGroupsRecursive($userGroups, []);
+        return $userGroups;
     }
 
     /**
@@ -373,7 +374,7 @@ class LdapService
     public function syncGroups(User $user, string $username)
     {
         $userLdapGroups = $this->getUserGroups($username);
-        $this->groupSyncService->syncUserWithFoundGroups($user, $userLdapGroups, $this->config['remove_from_groups']);
+        $this->syncWithGroups($user, $userLdapGroups);
     }
 
     /**

app/Auth/Access/LoginService.php

@@ -47,7 +47,7 @@ class LoginService
 
         // Authenticate on all session guards if a likely admin
         if ($user->can('users-manage') && $user->can('user-roles-manage')) {
-            $guards = ['standard', 'ldap', 'saml2', 'oidc'];
+            $guards = ['standard', 'ldap', 'saml2'];
             foreach ($guards as $guard) {
                 auth($guard)->login($user);
             }

app/Auth/Access/Mfa/TotpService.php

@@ -8,7 +8,6 @@ use BaconQrCode\Renderer\ImageRenderer;
 use BaconQrCode\Renderer\RendererStyle\Fill;
 use BaconQrCode\Renderer\RendererStyle\RendererStyle;
 use BaconQrCode\Writer;
-use BookStack\Auth\User;
 use PragmaRX\Google2FA\Google2FA;
 use PragmaRX\Google2FA\Support\Constants;
 
@@ -37,11 +36,11 @@ class TotpService
     /**
      * Generate a TOTP URL from secret key.
      */
-    public function generateUrl(string $secret, User $user): string
+    public function generateUrl(string $secret): string
     {
         return $this->google2fa->getQRCodeUrl(
             setting('app-name'),
-            $user->email,
+            user()->email,
             $secret
         );
     }
@@ -55,7 +54,7 @@ class TotpService
 
         return (new Writer(
             new ImageRenderer(
-                new RendererStyle(192, 4, null, null, $color),
+                new RendererStyle(192, 0, null, null, $color),
                 new SvgImageBackEnd()
             )
         ))->writeString($url);

app/Auth/Access/Oidc/OidcAccessToken.php

@@ -1,53 +0,0 @@
-<?php
-
-namespace BookStack\Auth\Access\Oidc;
-
-use InvalidArgumentException;
-use League\OAuth2\Client\Token\AccessToken;
-
-class OidcAccessToken extends AccessToken
-{
-    /**
-     * Constructs an access token.
-     *
-     * @param array $options An array of options returned by the service provider
-     *                       in the access token request. The `access_token` option is required.
-     *
-     * @throws InvalidArgumentException if `access_token` is not provided in `$options`.
-     */
-    public function __construct(array $options = [])
-    {
-        parent::__construct($options);
-        $this->validate($options);
-    }
-
-    /**
-     * Validate this access token response for OIDC.
-     * As per https://openid.net/specs/openid-connect-basic-1_0.html#TokenOK.
-     */
-    private function validate(array $options): void
-    {
-        // access_token: REQUIRED. Access Token for the UserInfo Endpoint.
-        // Performed on the extended class
-
-        // token_type: REQUIRED. OAuth 2.0 Token Type value. The value MUST be Bearer, as specified in OAuth 2.0
-        // Bearer Token Usage [RFC6750], for Clients using this subset.
-        // Note that the token_type value is case-insensitive.
-        if (strtolower(($options['token_type'] ?? '')) !== 'bearer') {
-            throw new InvalidArgumentException('The response token type MUST be "Bearer"');
-        }
-
-        // id_token: REQUIRED. ID Token.
-        if (empty($options['id_token'])) {
-            throw new InvalidArgumentException('An "id_token" property must be provided');
-        }
-    }
-
-    /**
-     * Get the id token value from this access token response.
-     */
-    public function getIdToken(): string
-    {
-        return $this->getValues()['id_token'];
-    }
-}

app/Auth/Access/Oidc/OidcIdToken.php

@@ -1,238 +0,0 @@
-<?php
-
-namespace BookStack\Auth\Access\Oidc;
-
-class OidcIdToken
-{
-    /**
-     * @var array
-     */
-    protected $header;
-
-    /**
-     * @var array
-     */
-    protected $payload;
-
-    /**
-     * @var string
-     */
-    protected $signature;
-
-    /**
-     * @var array[]|string[]
-     */
-    protected $keys;
-
-    /**
-     * @var string
-     */
-    protected $issuer;
-
-    /**
-     * @var array
-     */
-    protected $tokenParts = [];
-
-    public function __construct(string $token, string $issuer, array $keys)
-    {
-        $this->keys = $keys;
-        $this->issuer = $issuer;
-        $this->parse($token);
-    }
-
-    /**
-     * Parse the token content into its components.
-     */
-    protected function parse(string $token): void
-    {
-        $this->tokenParts = explode('.', $token);
-        $this->header = $this->parseEncodedTokenPart($this->tokenParts[0]);
-        $this->payload = $this->parseEncodedTokenPart($this->tokenParts[1] ?? '');
-        $this->signature = $this->base64UrlDecode($this->tokenParts[2] ?? '') ?: '';
-    }
-
-    /**
-     * Parse a Base64-JSON encoded token part.
-     * Returns the data as a key-value array or empty array upon error.
-     */
-    protected function parseEncodedTokenPart(string $part): array
-    {
-        $json = $this->base64UrlDecode($part) ?: '{}';
-        $decoded = json_decode($json, true);
-
-        return is_array($decoded) ? $decoded : [];
-    }
-
-    /**
-     * Base64URL decode. Needs some character conversions to be compatible
-     * with PHP's default base64 handling.
-     */
-    protected function base64UrlDecode(string $encoded): string
-    {
-        return base64_decode(strtr($encoded, '-_', '+/'));
-    }
-
-    /**
-     * Validate all possible parts of the id token.
-     *
-     * @throws OidcInvalidTokenException
-     */
-    public function validate(string $clientId): bool
-    {
-        $this->validateTokenStructure();
-        $this->validateTokenSignature();
-        $this->validateTokenClaims($clientId);
-
-        return true;
-    }
-
-    /**
-     * Fetch a specific claim from this token.
-     * Returns null if it is null or does not exist.
-     *
-     * @return mixed|null
-     */
-    public function getClaim(string $claim)
-    {
-        return $this->payload[$claim] ?? null;
-    }
-
-    /**
-     * Get all returned claims within the token.
-     */
-    public function getAllClaims(): array
-    {
-        return $this->payload;
-    }
-
-    /**
-     * Validate the structure of the given token and ensure we have the required pieces.
-     * As per https://datatracker.ietf.org/doc/html/rfc7519#section-7.2.
-     *
-     * @throws OidcInvalidTokenException
-     */
-    protected function validateTokenStructure(): void
-    {
-        foreach (['header', 'payload'] as $prop) {
-            if (empty($this->$prop) || !is_array($this->$prop)) {
-                throw new OidcInvalidTokenException("Could not parse out a valid {$prop} within the provided token");
-            }
-        }
-
-        if (empty($this->signature) || !is_string($this->signature)) {
-            throw new OidcInvalidTokenException('Could not parse out a valid signature within the provided token');
-        }
-    }
-
-    /**
-     * Validate the signature of the given token and ensure it validates against the provided key.
-     *
-     * @throws OidcInvalidTokenException
-     */
-    protected function validateTokenSignature(): void
-    {
-        if ($this->header['alg'] !== 'RS256') {
-            throw new OidcInvalidTokenException("Only RS256 signature validation is supported. Token reports using {$this->header['alg']}");
-        }
-
-        $parsedKeys = array_map(function ($key) {
-            try {
-                return new OidcJwtSigningKey($key);
-            } catch (OidcInvalidKeyException $e) {
-                throw new OidcInvalidTokenException('Failed to read signing key with error: ' . $e->getMessage());
-            }
-        }, $this->keys);
-
-        $parsedKeys = array_filter($parsedKeys);
-
-        $contentToSign = $this->tokenParts[0] . '.' . $this->tokenParts[1];
-        /** @var OidcJwtSigningKey $parsedKey */
-        foreach ($parsedKeys as $parsedKey) {
-            if ($parsedKey->verify($contentToSign, $this->signature)) {
-                return;
-            }
-        }
-
-        throw new OidcInvalidTokenException('Token signature could not be validated using the provided keys');
-    }
-
-    /**
-     * Validate the claims of the token.
-     * As per https://openid.net/specs/openid-connect-basic-1_0.html#IDTokenValidation.
-     *
-     * @throws OidcInvalidTokenException
-     */
-    protected function validateTokenClaims(string $clientId): void
-    {
-        // 1. The Issuer Identifier for the OpenID Provider (which is typically obtained during Discovery)
-        // MUST exactly match the value of the iss (issuer) Claim.
-        if (empty($this->payload['iss']) || $this->issuer !== $this->payload['iss']) {
-            throw new OidcInvalidTokenException('Missing or non-matching token issuer value');
-        }
-
-        // 2. The Client MUST validate that the aud (audience) Claim contains its client_id value registered
-        // at the Issuer identified by the iss (issuer) Claim as an audience. The ID Token MUST be rejected
-        // if the ID Token does not list the Client as a valid audience, or if it contains additional
-        // audiences not trusted by the Client.
-        if (empty($this->payload['aud'])) {
-            throw new OidcInvalidTokenException('Missing token audience value');
-        }
-
-        $aud = is_string($this->payload['aud']) ? [$this->payload['aud']] : $this->payload['aud'];
-        if (count($aud) !== 1) {
-            throw new OidcInvalidTokenException('Token audience value has ' . count($aud) . ' values, Expected 1');
-        }
-
-        if ($aud[0] !== $clientId) {
-            throw new OidcInvalidTokenException('Token audience value did not match the expected client_id');
-        }
-
-        // 3. If the ID Token contains multiple audiences, the Client SHOULD verify that an azp Claim is present.
-        // NOTE: Addressed by enforcing a count of 1 above.
-
-        // 4. If an azp (authorized party) Claim is present, the Client SHOULD verify that its client_id
-        // is the Claim Value.
-        if (isset($this->payload['azp']) && $this->payload['azp'] !== $clientId) {
-            throw new OidcInvalidTokenException('Token authorized party exists but does not match the expected client_id');
-        }
-
-        // 5. The current time MUST be before the time represented by the exp Claim
-        // (possibly allowing for some small leeway to account for clock skew).
-        if (empty($this->payload['exp'])) {
-            throw new OidcInvalidTokenException('Missing token expiration time value');
-        }
-
-        $skewSeconds = 120;
-        $now = time();
-        if ($now >= (intval($this->payload['exp']) + $skewSeconds)) {
-            throw new OidcInvalidTokenException('Token has expired');
-        }
-
-        // 6. The iat Claim can be used to reject tokens that were issued too far away from the current time,
-        // limiting the amount of time that nonces need to be stored to prevent attacks.
-        // The acceptable range is Client specific.
-        if (empty($this->payload['iat'])) {
-            throw new OidcInvalidTokenException('Missing token issued at time value');
-        }
-
-        $dayAgo = time() - 86400;
-        $iat = intval($this->payload['iat']);
-        if ($iat > ($now + $skewSeconds) || $iat < $dayAgo) {
-            throw new OidcInvalidTokenException('Token issue at time is not recent or is invalid');
-        }
-
-        // 7. If the acr Claim was requested, the Client SHOULD check that the asserted Claim Value is appropriate.
-        // The meaning and processing of acr Claim Values is out of scope for this document.
-        // NOTE: Not used for our case here. acr is not requested.
-
-        // 8. When a max_age request is made, the Client SHOULD check the auth_time Claim value and request
-        // re-authentication if it determines too much time has elapsed since the last End-User authentication.
-        // NOTE: Not used for our case here. A max_age request is not made.
-
-        // Custom: Ensure the "sub" (Subject) Claim exists and has a value.
-        if (empty($this->payload['sub'])) {
-            throw new OidcInvalidTokenException('Missing token subject value');
-        }
-    }
-}

app/Auth/Access/Oidc/OidcInvalidKeyException.php

@@ -1,7 +0,0 @@
-<?php
-
-namespace BookStack\Auth\Access\Oidc;
-
-class OidcInvalidKeyException extends \Exception
-{
-}

app/Auth/Access/Oidc/OidcInvalidTokenException.php

@@ -1,9 +0,0 @@
-<?php
-
-namespace BookStack\Auth\Access\Oidc;
-
-use Exception;
-
-class OidcInvalidTokenException extends Exception
-{
-}

app/Auth/Access/Oidc/OidcIssuerDiscoveryException.php

@@ -1,7 +0,0 @@
-<?php
-
-namespace BookStack\Auth\Access\Oidc;
-
-class OidcIssuerDiscoveryException extends \Exception
-{
-}

app/Auth/Access/Oidc/OidcJwtSigningKey.php

@@ -1,116 +0,0 @@
-<?php
-
-namespace BookStack\Auth\Access\Oidc;
-
-use phpseclib3\Crypt\Common\PublicKey;
-use phpseclib3\Crypt\PublicKeyLoader;
-use phpseclib3\Crypt\RSA;
-use phpseclib3\Math\BigInteger;
-
-class OidcJwtSigningKey
-{
-    /**
-     * @var PublicKey
-     */
-    protected $key;
-
-    /**
-     * Can be created either from a JWK parameter array or local file path to load a certificate from.
-     * Examples:
-     * 'file:///var/www/cert.pem'
-     * ['kty' => 'RSA', 'alg' => 'RS256', 'n' => 'abc123...'].
-     *
-     * @param array|string $jwkOrKeyPath
-     *
-     * @throws OidcInvalidKeyException
-     */
-    public function __construct($jwkOrKeyPath)
-    {
-        if (is_array($jwkOrKeyPath)) {
-            $this->loadFromJwkArray($jwkOrKeyPath);
-        } elseif (is_string($jwkOrKeyPath) && strpos($jwkOrKeyPath, 'file://') === 0) {
-            $this->loadFromPath($jwkOrKeyPath);
-        } else {
-            throw new OidcInvalidKeyException('Unexpected type of key value provided');
-        }
-    }
-
-    /**
-     * @throws OidcInvalidKeyException
-     */
-    protected function loadFromPath(string $path)
-    {
-        try {
-            $key = PublicKeyLoader::load(
-                file_get_contents($path)
-            );
-        } catch (\Exception $exception) {
-            throw new OidcInvalidKeyException("Failed to load key from file path 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);
-    }
-
-    /**
-     * @throws OidcInvalidKeyException
-     */
-    protected function loadFromJwkArray(array $jwk)
-    {
-        if ($jwk['alg'] !== 'RS256') {
-            throw new OidcInvalidKeyException("Only RS256 keys are currently supported. Found key using {$jwk['alg']}");
-        }
-
-        if (empty($jwk['use'])) {
-            throw new OidcInvalidKeyException('A "use" parameter on the provided key is expected');
-        }
-
-        if ($jwk['use'] !== 'sig') {
-            throw new OidcInvalidKeyException("Only signature keys are currently supported. Found key for use {$jwk['use']}");
-        }
-
-        if (empty($jwk['e'])) {
-            throw new OidcInvalidKeyException('An "e" parameter on the provided key is expected');
-        }
-
-        if (empty($jwk['n'])) {
-            throw new OidcInvalidKeyException('A "n" parameter on the provided key is expected');
-        }
-
-        $n = strtr($jwk['n'] ?? '', '-_', '+/');
-
-        try {
-            $key = PublicKeyLoader::load([
-                'e' => new BigInteger(base64_decode($jwk['e']), 256),
-                'n' => new BigInteger(base64_decode($n), 256),
-            ]);
-        } 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);
-    }
-
-    /**
-     * Use this key to sign the given content and return the signature.
-     */
-    public function verify(string $content, string $signature): bool
-    {
-        return $this->key->verify($content, $signature);
-    }
-
-    /**
-     * Convert the key to a PEM encoded key string.
-     */
-    public function toPem(): string
-    {
-        return $this->key->toString('PKCS8');
-    }
-}

app/Auth/Access/Oidc/OidcOAuthProvider.php

@@ -1,127 +0,0 @@
-<?php
-
-namespace BookStack\Auth\Access\Oidc;
-
-use League\OAuth2\Client\Grant\AbstractGrant;
-use League\OAuth2\Client\Provider\AbstractProvider;
-use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
-use League\OAuth2\Client\Provider\GenericResourceOwner;
-use League\OAuth2\Client\Provider\ResourceOwnerInterface;
-use League\OAuth2\Client\Token\AccessToken;
-use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
-use Psr\Http\Message\ResponseInterface;
-
-/**
- * Extended OAuth2Provider for using with OIDC.
- * Credit to the https://github.com/steverhoades/oauth2-openid-connect-client
- * project for the idea of extending a League\OAuth2 client for this use-case.
- */
-class OidcOAuthProvider extends AbstractProvider
-{
-    use BearerAuthorizationTrait;
-
-    /**
-     * @var string
-     */
-    protected $authorizationEndpoint;
-
-    /**
-     * @var string
-     */
-    protected $tokenEndpoint;
-
-    /**
-     * Returns the base URL for authorizing a client.
-     */
-    public function getBaseAuthorizationUrl(): string
-    {
-        return $this->authorizationEndpoint;
-    }
-
-    /**
-     * Returns the base URL for requesting an access token.
-     */
-    public function getBaseAccessTokenUrl(array $params): string
-    {
-        return $this->tokenEndpoint;
-    }
-
-    /**
-     * Returns the URL for requesting the resource owner's details.
-     */
-    public function getResourceOwnerDetailsUrl(AccessToken $token): string
-    {
-        return '';
-    }
-
-    /**
-     * Returns the default scopes used by this provider.
-     *
-     * This should only be the scopes that are required to request the details
-     * of the resource owner, rather than all the available scopes.
-     */
-    protected function getDefaultScopes(): array
-    {
-        return ['openid', 'profile', 'email'];
-    }
-
-    /**
-     * Returns the string that should be used to separate scopes when building
-     * the URL for requesting an access token.
-     */
-    protected function getScopeSeparator(): string
-    {
-        return ' ';
-    }
-
-    /**
-     * Checks a provider response for errors.
-     *
-     * @param ResponseInterface $response
-     * @param array|string      $data     Parsed response data
-     *
-     * @throws IdentityProviderException
-     *
-     * @return void
-     */
-    protected function checkResponse(ResponseInterface $response, $data)
-    {
-        if ($response->getStatusCode() >= 400 || isset($data['error'])) {
-            throw new IdentityProviderException(
-                $data['error'] ?? $response->getReasonPhrase(),
-                $response->getStatusCode(),
-                (string) $response->getBody()
-            );
-        }
-    }
-
-    /**
-     * Generates a resource owner object from a successful resource owner
-     * details request.
-     *
-     * @param array       $response
-     * @param AccessToken $token
-     *
-     * @return ResourceOwnerInterface
-     */
-    protected function createResourceOwner(array $response, AccessToken $token)
-    {
-        return new GenericResourceOwner($response, '');
-    }
-
-    /**
-     * Creates an access token from a response.
-     *
-     * The grant that was used to fetch the response can be used to provide
-     * additional context.
-     *
-     * @param array         $response
-     * @param AbstractGrant $grant
-     *
-     * @return OidcAccessToken
-     */
-    protected function createAccessToken(array $response, AbstractGrant $grant)
-    {
-        return new OidcAccessToken($response);
-    }
-}

app/Auth/Access/Oidc/OidcProviderSettings.php

@@ -1,203 +0,0 @@
-<?php
-
-namespace BookStack\Auth\Access\Oidc;
-
-use GuzzleHttp\Psr7\Request;
-use Illuminate\Contracts\Cache\Repository;
-use InvalidArgumentException;
-use Psr\Http\Client\ClientExceptionInterface;
-use Psr\Http\Client\ClientInterface;
-
-/**
- * OpenIdConnectProviderSettings
- * Acts as a DTO for settings used within the oidc request and token handling.
- * Performs auto-discovery upon request.
- */
-class OidcProviderSettings
-{
-    /**
-     * @var string
-     */
-    public $issuer;
-
-    /**
-     * @var string
-     */
-    public $clientId;
-
-    /**
-     * @var string
-     */
-    public $clientSecret;
-
-    /**
-     * @var string
-     */
-    public $redirectUri;
-
-    /**
-     * @var string
-     */
-    public $authorizationEndpoint;
-
-    /**
-     * @var string
-     */
-    public $tokenEndpoint;
-
-    /**
-     * @var string[]|array[]
-     */
-    public $keys = [];
-
-    public function __construct(array $settings)
-    {
-        $this->applySettingsFromArray($settings);
-        $this->validateInitial();
-    }
-
-    /**
-     * Apply an array of settings to populate setting properties within this class.
-     */
-    protected function applySettingsFromArray(array $settingsArray)
-    {
-        foreach ($settingsArray as $key => $value) {
-            if (property_exists($this, $key)) {
-                $this->$key = $value;
-            }
-        }
-    }
-
-    /**
-     * Validate any core, required properties have been set.
-     *
-     * @throws InvalidArgumentException
-     */
-    protected function validateInitial()
-    {
-        $required = ['clientId', 'clientSecret', 'redirectUri', 'issuer'];
-        foreach ($required as $prop) {
-            if (empty($this->$prop)) {
-                throw new InvalidArgumentException("Missing required configuration \"{$prop}\" value");
-            }
-        }
-
-        if (strpos($this->issuer, 'https://') !== 0) {
-            throw new InvalidArgumentException('Issuer value must start with https://');
-        }
-    }
-
-    /**
-     * Perform a full validation on these settings.
-     *
-     * @throws InvalidArgumentException
-     */
-    public function validate(): void
-    {
-        $this->validateInitial();
-        $required = ['keys', 'tokenEndpoint', 'authorizationEndpoint'];
-        foreach ($required as $prop) {
-            if (empty($this->$prop)) {
-                throw new InvalidArgumentException("Missing required configuration \"{$prop}\" value");
-            }
-        }
-    }
-
-    /**
-     * Discover and autoload settings from the configured issuer.
-     *
-     * @throws OidcIssuerDiscoveryException
-     */
-    public function discoverFromIssuer(ClientInterface $httpClient, Repository $cache, int $cacheMinutes)
-    {
-        try {
-            $cacheKey = 'oidc-discovery::' . $this->issuer;
-            $discoveredSettings = $cache->remember($cacheKey, $cacheMinutes * 60, function () use ($httpClient) {
-                return $this->loadSettingsFromIssuerDiscovery($httpClient);
-            });
-            $this->applySettingsFromArray($discoveredSettings);
-        } catch (ClientExceptionInterface $exception) {
-            throw new OidcIssuerDiscoveryException("HTTP request failed during discovery with error: {$exception->getMessage()}");
-        }
-    }
-
-    /**
-     * @throws OidcIssuerDiscoveryException
-     * @throws ClientExceptionInterface
-     */
-    protected function loadSettingsFromIssuerDiscovery(ClientInterface $httpClient): array
-    {
-        $issuerUrl = rtrim($this->issuer, '/') . '/.well-known/openid-configuration';
-        $request = new Request('GET', $issuerUrl);
-        $response = $httpClient->sendRequest($request);
-        $result = json_decode($response->getBody()->getContents(), true);
-
-        if (empty($result) || !is_array($result)) {
-            throw new OidcIssuerDiscoveryException("Error discovering provider settings from issuer at URL {$issuerUrl}");
-        }
-
-        if ($result['issuer'] !== $this->issuer) {
-            throw new OidcIssuerDiscoveryException('Unexpected issuer value found on discovery response');
-        }
-
-        $discoveredSettings = [];
-
-        if (!empty($result['authorization_endpoint'])) {
-            $discoveredSettings['authorizationEndpoint'] = $result['authorization_endpoint'];
-        }
-
-        if (!empty($result['token_endpoint'])) {
-            $discoveredSettings['tokenEndpoint'] = $result['token_endpoint'];
-        }
-
-        if (!empty($result['jwks_uri'])) {
-            $keys = $this->loadKeysFromUri($result['jwks_uri'], $httpClient);
-            $discoveredSettings['keys'] = $this->filterKeys($keys);
-        }
-
-        return $discoveredSettings;
-    }
-
-    /**
-     * Filter the given JWK keys down to just those we support.
-     */
-    protected function filterKeys(array $keys): array
-    {
-        return array_filter($keys, function (array $key) {
-            return $key['kty'] === 'RSA' && $key['use'] === 'sig' && $key['alg'] === 'RS256';
-        });
-    }
-
-    /**
-     * Return an array of jwks as PHP key=>value arrays.
-     *
-     * @throws ClientExceptionInterface
-     * @throws OidcIssuerDiscoveryException
-     */
-    protected function loadKeysFromUri(string $uri, ClientInterface $httpClient): array
-    {
-        $request = new Request('GET', $uri);
-        $response = $httpClient->sendRequest($request);
-        $result = json_decode($response->getBody()->getContents(), true);
-
-        if (empty($result) || !is_array($result) || !isset($result['keys'])) {
-            throw new OidcIssuerDiscoveryException('Error reading keys from issuer jwks_uri');
-        }
-
-        return $result['keys'];
-    }
-
-    /**
-     * Get the settings needed by an OAuth provider, as a key=>value array.
-     */
-    public function arrayForProvider(): array
-    {
-        $settingKeys = ['clientId', 'clientSecret', 'redirectUri', 'authorizationEndpoint', 'tokenEndpoint'];
-        $settings = [];
-        foreach ($settingKeys as $setting) {
-            $settings[$setting] = $this->$setting;
-        }
-
-        return $settings;
-    }
-}

app/Auth/Access/Oidc/OidcService.php

@@ -1,221 +0,0 @@
-<?php
-
-namespace BookStack\Auth\Access\Oidc;
-
-use function auth;
-use BookStack\Auth\Access\LoginService;
-use BookStack\Auth\Access\RegistrationService;
-use BookStack\Auth\User;
-use BookStack\Exceptions\JsonDebugException;
-use BookStack\Exceptions\OpenIdConnectException;
-use BookStack\Exceptions\StoppedAuthenticationException;
-use BookStack\Exceptions\UserRegistrationException;
-use function config;
-use Exception;
-use Illuminate\Support\Facades\Cache;
-use League\OAuth2\Client\OptionProvider\HttpBasicAuthOptionProvider;
-use Psr\Http\Client\ClientExceptionInterface;
-use Psr\Http\Client\ClientInterface as HttpClient;
-use function trans;
-use function url;
-
-/**
- * Class OpenIdConnectService
- * Handles any app-specific OIDC tasks.
- */
-class OidcService
-{
-    protected $registrationService;
-    protected $loginService;
-    protected $httpClient;
-
-    /**
-     * OpenIdService constructor.
-     */
-    public function __construct(RegistrationService $registrationService, LoginService $loginService, HttpClient $httpClient)
-    {
-        $this->registrationService = $registrationService;
-        $this->loginService = $loginService;
-        $this->httpClient = $httpClient;
-    }
-
-    /**
-     * Initiate an authorization flow.
-     *
-     * @return array{url: string, state: string}
-     */
-    public function login(): array
-    {
-        $settings = $this->getProviderSettings();
-        $provider = $this->getProvider($settings);
-
-        return [
-            'url'   => $provider->getAuthorizationUrl(),
-            'state' => $provider->getState(),
-        ];
-    }
-
-    /**
-     * Process the Authorization response from the authorization server and
-     * return the matching, or new if registration active, user matched to
-     * the authorization server.
-     * Returns null if not authenticated.
-     *
-     * @throws Exception
-     * @throws ClientExceptionInterface
-     */
-    public function processAuthorizeResponse(?string $authorizationCode): ?User
-    {
-        $settings = $this->getProviderSettings();
-        $provider = $this->getProvider($settings);
-
-        // Try to exchange authorization code for access token
-        $accessToken = $provider->getAccessToken('authorization_code', [
-            'code' => $authorizationCode,
-        ]);
-
-        return $this->processAccessTokenCallback($accessToken, $settings);
-    }
-
-    /**
-     * @throws OidcIssuerDiscoveryException
-     * @throws ClientExceptionInterface
-     */
-    protected function getProviderSettings(): OidcProviderSettings
-    {
-        $config = $this->config();
-        $settings = new OidcProviderSettings([
-            'issuer'                => $config['issuer'],
-            'clientId'              => $config['client_id'],
-            'clientSecret'          => $config['client_secret'],
-            'redirectUri'           => url('/oidc/callback'),
-            'authorizationEndpoint' => $config['authorization_endpoint'],
-            'tokenEndpoint'         => $config['token_endpoint'],
-        ]);
-
-        // Use keys if configured
-        if (!empty($config['jwt_public_key'])) {
-            $settings->keys = [$config['jwt_public_key']];
-        }
-
-        // Run discovery
-        if ($config['discover'] ?? false) {
-            $settings->discoverFromIssuer($this->httpClient, Cache::store(null), 15);
-        }
-
-        $settings->validate();
-
-        return $settings;
-    }
-
-    /**
-     * Load the underlying OpenID Connect Provider.
-     */
-    protected function getProvider(OidcProviderSettings $settings): OidcOAuthProvider
-    {
-        return new OidcOAuthProvider($settings->arrayForProvider(), [
-            'httpClient'     => $this->httpClient,
-            'optionProvider' => new HttpBasicAuthOptionProvider(),
-        ]);
-    }
-
-    /**
-     * Calculate the display name.
-     */
-    protected function getUserDisplayName(OidcIdToken $token, string $defaultValue): string
-    {
-        $displayNameAttr = $this->config()['display_name_claims'];
-
-        $displayName = [];
-        foreach ($displayNameAttr as $dnAttr) {
-            $dnComponent = $token->getClaim($dnAttr) ?? '';
-            if ($dnComponent !== '') {
-                $displayName[] = $dnComponent;
-            }
-        }
-
-        if (count($displayName) == 0) {
-            $displayName[] = $defaultValue;
-        }
-
-        return implode(' ', $displayName);
-    }
-
-    /**
-     * Extract the details of a user from an ID token.
-     *
-     * @return array{name: string, email: string, external_id: string}
-     */
-    protected function getUserDetails(OidcIdToken $token): array
-    {
-        $id = $token->getClaim('sub');
-
-        return [
-            'external_id' => $id,
-            'email'       => $token->getClaim('email'),
-            'name'        => $this->getUserDisplayName($token, $id),
-        ];
-    }
-
-    /**
-     * Processes a received access token for a user. Login the user when
-     * they exist, optionally registering them automatically.
-     *
-     * @throws OpenIdConnectException
-     * @throws JsonDebugException
-     * @throws UserRegistrationException
-     * @throws StoppedAuthenticationException
-     */
-    protected function processAccessTokenCallback(OidcAccessToken $accessToken, OidcProviderSettings $settings): User
-    {
-        $idTokenText = $accessToken->getIdToken();
-        $idToken = new OidcIdToken(
-            $idTokenText,
-            $settings->issuer,
-            $settings->keys,
-        );
-
-        if ($this->config()['dump_user_details']) {
-            throw new JsonDebugException($idToken->getAllClaims());
-        }
-
-        try {
-            $idToken->validate($settings->clientId);
-        } catch (OidcInvalidTokenException $exception) {
-            throw new OpenIdConnectException("ID token validate failed with error: {$exception->getMessage()}");
-        }
-
-        $userDetails = $this->getUserDetails($idToken);
-        $isLoggedIn = auth()->check();
-
-        if (empty($userDetails['email'])) {
-            throw new OpenIdConnectException(trans('errors.oidc_no_email_address'));
-        }
-
-        if ($isLoggedIn) {
-            throw new OpenIdConnectException(trans('errors.oidc_already_logged_in'), '/login');
-        }
-
-        $user = $this->registrationService->findOrRegister(
-            $userDetails['name'],
-            $userDetails['email'],
-            $userDetails['external_id']
-        );
-
-        if ($user === null) {
-            throw new OpenIdConnectException(trans('errors.oidc_user_not_registered', ['name' => $userDetails['external_id']]), '/login');
-        }
-
-        $this->loginService->login($user, 'oidc');
-
-        return $user;
-    }
-
-    /**
-     * Get the OIDC config from the application.
-     */
-    protected function config(): array
-    {
-        return config('oidc');
-    }
-}

app/Auth/Access/RegistrationService.php

@@ -11,7 +11,6 @@ use BookStack\Facades\Activity;
 use BookStack\Facades\Theme;
 use BookStack\Theming\ThemeEvents;
 use Exception;
-use Illuminate\Support\Str;
 
 class RegistrationService
 {
@@ -51,32 +50,6 @@ class RegistrationService
         return in_array($authMethod, $authMethodsWithRegistration) && setting('registration-enabled');
     }
 
-    /**
-     * Attempt to find a user in the system otherwise register them as a new
-     * user. For use with external auth systems since password is auto-generated.
-     *
-     * @throws UserRegistrationException
-     */
-    public function findOrRegister(string $name, string $email, string $externalId): User
-    {
-        $user = User::query()
-            ->where('external_auth_id', '=', $externalId)
-            ->first();
-
-        if (is_null($user)) {
-            $userData = [
-                'name'             => $name,
-                'email'            => $email,
-                'password'         => Str::random(32),
-                'external_auth_id' => $externalId,
-            ];
-
-            $user = $this->registerUser($userData, null, false);
-        }
-
-        return $user;
-    }
-
     /**
      * The registrations flow for all users.
      *

app/Auth/Access/Saml2Service.php

@@ -8,8 +8,8 @@ use BookStack\Exceptions\SamlException;
 use BookStack\Exceptions\StoppedAuthenticationException;
 use BookStack\Exceptions\UserRegistrationException;
 use Exception;
+use Illuminate\Support\Str;
 use OneLogin\Saml2\Auth;
-use OneLogin\Saml2\Constants;
 use OneLogin\Saml2\Error;
 use OneLogin\Saml2\IdPMetadataParser;
 use OneLogin\Saml2\ValidationError;
@@ -18,25 +18,20 @@ use OneLogin\Saml2\ValidationError;
  * Class Saml2Service
  * Handles any app-specific SAML tasks.
  */
-class Saml2Service
+class Saml2Service extends ExternalAuthService
 {
     protected $config;
     protected $registrationService;
     protected $loginService;
-    protected $groupSyncService;
 
     /**
      * Saml2Service constructor.
      */
-    public function __construct(
-        RegistrationService $registrationService,
-        LoginService $loginService,
-        GroupSyncService $groupSyncService
-    ) {
+    public function __construct(RegistrationService $registrationService, LoginService $loginService)
+    {
         $this->config = config('saml2');
         $this->registrationService = $registrationService;
         $this->loginService = $loginService;
-        $this->groupSyncService = $groupSyncService;
     }
 
     /**
@@ -60,20 +55,13 @@ class Saml2Service
      *
      * @throws Error
      */
-    public function logout(User $user): array
+    public function logout(): array
     {
         $toolKit = $this->getToolkit();
         $returnRoute = url('/');
 
         try {
-            $url = $toolKit->logout(
-                $returnRoute,
-                [],
-                $user->email,
-                null,
-                true,
-                Constants::NAMEID_EMAIL_ADDRESS
-            );
+            $url = $toolKit->logout($returnRoute, [], null, null, true);
             $id = $toolKit->getLastRequestID();
         } catch (Error $error) {
             if ($error->getCode() !== Error::SAML_SINGLE_LOGOUT_NOT_SUPPORTED) {
@@ -99,11 +87,8 @@ class Saml2Service
      * @throws JsonDebugException
      * @throws UserRegistrationException
      */
-    public function processAcsResponse(?string $requestId, string $samlResponse): ?User
+    public function processAcsResponse(?string $requestId): ?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.
-        $_POST['SAMLResponse'] = $samlResponse;
         $toolkit = $this->getToolkit();
         $toolkit->processResponse($requestId);
         $errors = $toolkit->getErrors();
@@ -132,13 +117,8 @@ class Saml2Service
     public function processSlsResponse(?string $requestId): ?string
     {
         $toolkit = $this->getToolkit();
+        $redirect = $toolkit->processSLO(true, $requestId, false, null, true);
 
-        // The $retrieveParametersFromServer in the call below will mean the library will take the query
-        // parameters, used for the response signing, from the raw $_SERVER['QUERY_STRING']
-        // value so that the exact encoding format is matched when checking the signature.
-        // This is primarily due to ADFS encoding query params with lowercase percent encoding while
-        // PHP (And most other sensible providers) standardise on uppercase.
-        $redirect = $toolkit->processSLO(true, $requestId, true, null, true);
         $errors = $toolkit->getErrors();
 
         if (!empty($errors)) {
@@ -278,8 +258,6 @@ class Saml2Service
 
     /**
      * Extract the details of a user from a SAML response.
-     *
-     * @return array{external_id: string, name: string, email: string, saml_id: string}
      */
     protected function getUserDetails(string $samlID, $samlAttributes): array
     {
@@ -344,6 +322,31 @@ class Saml2Service
         return $defaultValue;
     }
 
+    /**
+     * Get the user from the database for the specified details.
+     *
+     * @throws UserRegistrationException
+     */
+    protected function getOrRegisterUser(array $userDetails): ?User
+    {
+        $user = User::query()
+          ->where('external_auth_id', '=', $userDetails['external_id'])
+          ->first();
+
+        if (is_null($user)) {
+            $userData = [
+                'name'             => $userDetails['name'],
+                'email'            => $userDetails['email'],
+                'password'         => Str::random(32),
+                'external_auth_id' => $userDetails['external_id'],
+            ];
+
+            $user = $this->registrationService->registerUser($userData, null, false);
+        }
+
+        return $user;
+    }
+
     /**
      * Process the SAML response for a user. Login the user when
      * they exist, optionally registering them automatically.
@@ -374,19 +377,14 @@ class Saml2Service
             throw new SamlException(trans('errors.saml_already_logged_in'), '/login');
         }
 
-        $user = $this->registrationService->findOrRegister(
-            $userDetails['name'],
-            $userDetails['email'],
-            $userDetails['external_id']
-        );
-
+        $user = $this->getOrRegisterUser($userDetails);
         if ($user === null) {
             throw new SamlException(trans('errors.saml_user_not_registered', ['name' => $userDetails['external_id']]), '/login');
         }
 
         if ($this->shouldSyncGroups()) {
             $groups = $this->getUserGroups($samlAttributes);
-            $this->groupSyncService->syncUserWithFoundGroups($user, $groups, $this->config['remove_from_groups']);
+            $this->syncWithGroups($user, $groups);
         }
 
         $this->loginService->login($user, 'saml2');

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;
 
@@ -142,7 +141,7 @@ class SocialAuthService
         // When a user is not logged in and a matching SocialAccount exists,
         // Simply log the user into the application.
         if (!$isLoggedIn && $socialAccount !== null) {
-            $this->loginService->login($socialAccount->user, $socialDriver);
+            $this->loginService->login($socialAccount->user, $socialAccount);
 
             return redirect()->intended('/');
         }
@@ -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,24 @@ 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
+     * @param Builder|\Illuminate\Database\Query\Builder $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) {
+                $permissionQuery->select(['role_id'])->from('joint_permissions')
+                    ->whereRaw('joint_permissions.entity_id=' . $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn'])
+                    ->whereRaw('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 +633,24 @@ 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) {
+                    $permissionQuery->select('id')->from('joint_permissions')
+                        ->whereRaw('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 +664,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,25 +7,21 @@ 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;
 
 /**
  * Class Role.
  *
- * @property int        $id
- * @property string     $display_name
- * @property string     $description
- * @property string     $external_auth_id
- * @property string     $system_name
- * @property bool       $mfa_enforced
- * @property Collection $users
+ * @property int    $id
+ * @property string $display_name
+ * @property string $description
+ * @property string $external_auth_id
+ * @property string $system_name
+ * @property bool   $mfa_enforced
  */
 class Role extends Model implements Loggable
 {
-    use HasFactory;
-
     protected $fillable = ['display_name', 'description', 'external_auth_id'];
 
     /**
@@ -86,7 +82,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 +90,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 +115,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;
@@ -14,7 +15,7 @@ use Exception;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Pagination\LengthAwarePaginator;
-use Illuminate\Support\Facades\Log;
+use Log;
 
 class UserRepo
 {
@@ -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.
@@ -64,7 +61,7 @@ return [
     'locale' => env('APP_LANG', 'en'),
 
     // Locales available
-    'locales' => ['en', 'ar', 'bg', 'bs', 'ca', 'cs', 'da', 'de', 'de_informal', 'es', 'es_AR', 'et', 'fa', 'fr', 'he', 'hr', 'hu', 'id', 'it', 'ja', 'ko', 'lt', 'lv', 'nl', 'nb', 'pt', 'pt_BR', 'sk', 'sl', 'sv', 'pl',  'ru', 'th', 'tr', 'uk', 'vi', 'zh_CN', 'zh_TW'],
+    'locales' => ['en', 'ar', 'bg', 'bs', 'ca', 'cs', 'da', 'de', 'de_informal', 'es', 'es_AR', 'fa', 'fr', 'he', 'hr', 'hu', 'id', 'it', 'ja', 'ko', 'lt', 'lv', 'nl', 'nb', 'pt', 'pt_BR', 'sk', 'sl', 'sv', 'pl',  'ru', 'th', 'tr', 'uk', 'vi', 'zh_CN', 'zh_TW'],
 
     //  Application Fallback Locale
     'fallback_locale' => 'en',
@@ -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,7 +10,8 @@
 
 return [
 
-    // Options: standard, ldap, saml2, oidc
+    // Method of authentication to use
+    // Options: standard, ldap, saml2
     'method' => env('AUTH_METHOD', 'standard'),
 
     // Authentication Defaults
@@ -25,7 +26,7 @@ return [
     // All authentication drivers have a user provider. This defines how the
     // users are actually retrieved out of your database or other storage
     // mechanisms used by this application to persist your user's data.
-    // Supported drivers: "session", "api-token", "ldap-session", "async-external-session"
+    // Supported drivers: "session", "api-token", "ldap-session"
     'guards' => [
         'standard' => [
             'driver'   => 'session',
@@ -36,15 +37,11 @@ return [
             'provider' => 'external',
         ],
         'saml2' => [
-            'driver'   => 'async-external-session',
-            'provider' => 'external',
-        ],
-        'oidc' => [
-            'driver'   => 'async-external-session',
+            'driver'   => 'saml2-session',
             'provider' => 'external',
         ],
         'api' => [
-            'driver'   => 'api-token',
+            'driver' => 'api-token',
         ],
     ],
 
@@ -57,16 +54,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
@@ -79,14 +70,7 @@ return [
             'email'    => 'emails.password',
             'table'    => 'password_resets',
             'expire'   => 60,
-            'throttle' => 60,
         ],
     ],
 
-    // 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

@@ -69,10 +69,7 @@ return [
             'port'           => $mysql_port,
             'charset'        => 'utf8mb4',
             'collation'      => 'utf8mb4_unicode_ci',
-            // Prefixes are only semi-supported and may be unstable
-            // since they are not tested as part of our automated test suite.
-            // If used, the prefix should not be changed otherwise you will likely receive errors.
-            'prefix'         => env('DB_TABLE_PREFIX', ''),
+            'prefix'         => '',
             'prefix_indexes' => true,
             'strict'         => false,
             'engine'         => null,
@@ -105,6 +102,6 @@ return [
     'migrations' => 'migrations',
 
     // Redis configuration to use if set
-    'redis' => $redisConfig ?? [],
+    'redis' => env('REDIS_SERVERS', false) ? $redisConfig : [],
 
 ];

app/Config/dompdf.php

@@ -70,7 +70,7 @@ return [
          * direct class use like:
          * $dompdf = new DOMPDF();  $dompdf->load_html($htmldata); $dompdf->render(); $pdfdata = $dompdf->output();
          */
-        'chroot' => realpath(public_path()),
+        'chroot' => realpath(base_path()),
 
         /**
          * Whether to use Unicode fonts or not.

app/Config/filesystems.php

@@ -25,25 +25,21 @@ 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',
-        ],
-
-        'local_secure_attachments' => [
             'driver' => 'local',
-            'root'   => storage_path('uploads/files/'),
+            'root'   => public_path(),
         ],
 
-        'local_secure_images' => [
-            'driver'     => 'local',
-            'root'       => storage_path('uploads/images/'),
-            'visibility' => 'public',
+        'local_secure' => [
+            'driver' => 'local',
+            'root'   => storage_path(),
         ],
 
         's3' => [
@@ -58,12 +54,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/oidc.php

@@ -1,35 +0,0 @@
-<?php
-
-return [
-
-    // Display name, shown to users, for OpenId option
-    'name' => env('OIDC_NAME', 'SSO'),
-
-    // Dump user details after a login request for debugging purposes
-    'dump_user_details' => env('OIDC_DUMP_USER_DETAILS', false),
-
-    // Attribute, within a OpenId token, to find the user's display name
-    'display_name_claims' => explode('|', env('OIDC_DISPLAY_NAME_CLAIMS', 'name')),
-
-    // OAuth2/OpenId client id, as configured in your Authorization server.
-    'client_id' => env('OIDC_CLIENT_ID', null),
-
-    // OAuth2/OpenId client secret, as configured in your Authorization server.
-    'client_secret' => env('OIDC_CLIENT_SECRET', null),
-
-    // The issuer of the identity token (id_token) this will be compared with
-    // what is returned in the token.
-    'issuer' => env('OIDC_ISSUER', null),
-
-    // Auto-discover the relevant endpoints and keys from the issuer.
-    // Fetched details are cached for 15 minutes.
-    'discover' => env('OIDC_ISSUER_DISCOVER', false),
-
-    // Public key that's used to verify the JWT token with.
-    // Can be the key value itself or a local 'file://public.key' reference.
-    'jwt_public_key' => env('OIDC_PUBLIC_KEY', null),
-
-    // OAuth2 endpoints.
-    'authorization_endpoint' => env('OIDC_AUTH_ENDPOINT', null),
-    'token_endpoint'         => env('OIDC_TOKEN_ENDPOINT', null),
-];

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/Config/saml2.php

@@ -1,7 +1,6 @@
 <?php
 
 $SAML2_IDP_AUTHNCONTEXT = env('SAML2_IDP_AUTHNCONTEXT', true);
-$SAML2_SP_x509 = env('SAML2_SP_x509', false);
 
 return [
 
@@ -79,11 +78,10 @@ return [
             // represent the requested subject.
             // Take a look on lib/Saml2/Constants.php to see the NameIdFormat supported
             'NameIDFormat' => 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress',
-
             // Usually x509cert and privateKey of the SP are provided by files placed at
             // the certs folder. But we can also provide them with the following parameters
-            'x509cert'   => $SAML2_SP_x509 ?: '',
-            'privateKey' => env('SAML2_SP_x509_KEY', ''),
+            'x509cert'   => '',
+            'privateKey' => '',
         ],
         // Identity Provider Data that we want connect with our SP
         'idp' => [
@@ -149,11 +147,6 @@ return [
             // Multiple forced values can be passed via a space separated array, For example:
             // SAML2_IDP_AUTHNCONTEXT="urn:federation:authentication:windows urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport"
             'requestedAuthnContext' => is_string($SAML2_IDP_AUTHNCONTEXT) ? explode(' ', $SAML2_IDP_AUTHNCONTEXT) : $SAML2_IDP_AUTHNCONTEXT,
-            // Sign requests and responses if a certificate is in use
-            'logoutRequestSigned'   => (bool) $SAML2_SP_x509,
-            'logoutResponseSigned'  => (bool) $SAML2_SP_x509,
-            'authnRequestsSigned'   => (bool) $SAML2_SP_x509,
-            'lowercaseUrlencoding'  => false,
         ],
     ],
 

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,10 +2,9 @@
 
 namespace BookStack\Console\Commands;
 
-use BookStack\Entities\Models\Entity;
 use BookStack\Entities\Tools\SearchIndex;
+use DB;
 use Illuminate\Console\Command;
-use Illuminate\Support\Facades\DB;
 
 class RegenerateSearch extends Command
 {
@@ -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;
@@ -13,18 +12,13 @@ use Illuminate\Support\Collection;
 /**
  * Class Book.
  *
- * @property string                                   $description
- * @property int                                      $image_id
- * @property Image|null                               $cover
- * @property \Illuminate\Database\Eloquent\Collection $chapters
- * @property \Illuminate\Database\Eloquent\Collection $pages
- * @property \Illuminate\Database\Eloquent\Collection $directPages
+ * @property string     $description
+ * @property int        $image_id
+ * @property Image|null $cover
  */
 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 +73,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,12 +25,10 @@ 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'];
 
-    protected $fillable = ['name', 'priority'];
+    protected $fillable = ['name', 'priority', 'markdown'];
 
     public $textField = 'text';
 
@@ -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

@@ -5,7 +5,6 @@ namespace BookStack\Entities\Models;
 use BookStack\Auth\User;
 use BookStack\Model;
 use Carbon\Carbon;
-use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 /**
  * Class PageRevision.
@@ -15,14 +14,11 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo;
  * @property string $book_slug
  * @property int    $created_by
  * @property Carbon $created_at
- * @property Carbon $updated_at
  * @property string $type
  * @property string $summary
  * @property string $markdown
  * @property string $html
  * @property int    $revision_number
- * @property Page   $page
- * @property-read ?User $createdBy
  */
 class PageRevision extends Model
 {
@@ -30,16 +26,20 @@ class PageRevision extends Model
 
     /**
      * Get the user that created the page revision.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
-    public function createdBy(): BelongsTo
+    public function createdBy()
     {
         return $this->belongsTo(User::class, 'created_by');
     }
 
     /**
      * Get the page this revision originates from.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
-    public function page(): BelongsTo
+    public function page()
     {
         return $this->belongsTo(Page::class);
     }
@@ -63,8 +63,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 +84,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;
@@ -40,7 +37,7 @@ class PageContent
      */
     public function setNewHTML(string $html)
     {
-        $html = $this->extractBase64ImagesFromHtml($html);
+        $html = $this->extractBase64Images($this->page, $html);
         $this->page->html = $this->formatHtml($html);
         $this->page->text = $this->toPlainText();
         $this->page->markdown = '';
@@ -51,7 +48,6 @@ class PageContent
      */
     public function setNewMarkdown(string $markdown)
     {
-        $markdown = $this->extractBase64ImagesFromMarkdown($markdown);
         $this->page->markdown = $markdown;
         $html = $this->markdownToHtml($markdown);
         $this->page->html = $this->formatHtml($html);
@@ -78,7 +74,7 @@ class PageContent
     /**
      * Convert all base64 image data to saved images.
      */
-    protected function extractBase64ImagesFromHtml(string $htmlText): string
+    public function extractBase64Images(Page $page, string $htmlText): string
     {
         if (empty($htmlText) || strpos($htmlText, 'data:image') === false) {
             return $htmlText;
@@ -89,13 +85,31 @@ class PageContent
         $body = $container->childNodes->item(0);
         $childNodes = $body->childNodes;
         $xPath = new DOMXPath($doc);
+        $imageRepo = app()->make(ImageRepo::class);
+        $allowedExtensions = ['jpg', 'jpeg', 'png', 'gif', 'webp'];
 
         // 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 (!in_array($extension, $allowedExtensions)) {
+                $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', $page->id);
+                $imageNode->setAttribute('src', $image->url);
+            } catch (ImageUploadException $exception) {
+                $imageNode->setAttribute('src', '');
+            }
         }
 
         // Generate inner html as a string
@@ -107,70 +121,6 @@ class PageContent
         return $html;
     }
 
-    /**
-     * Convert all inline base64 content to uploaded image files.
-     */
-    protected function extractBase64ImagesFromMarkdown(string $markdown)
-    {
-        $matches = [];
-        preg_match_all('/!\[.*?]\(.*?(data:image\/.*?)[)"\s]/', $markdown, $matches);
-
-        foreach ($matches[1] as $base64Match) {
-            $newUrl = $this->base64ImageUriToUploadedImageUrl($base64Match);
-            $markdown = str_replace($base64Match, $newUrl, $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 +145,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 +180,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 +194,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 +264,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);
 
@@ -375,7 +316,6 @@ class PageContent
             }
 
             // Find page and skip this if page not found
-            /** @var ?Page $matchedPage */
             $matchedPage = Page::visible()->find($pageId);
             if ($matchedPage === null) {
                 $html = str_replace($fullMatch, '', $html);
@@ -401,7 +341,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

@@ -21,6 +21,8 @@ class PageEditActivity
 
     /**
      * Check if there's active editing being performed on this page.
+     *
+     * @return bool
      */
     public function hasActiveEditing(): bool
     {
@@ -35,50 +37,18 @@ 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]);
     }
 
-    /**
-     * Get any editor clash warning messages to show for the given draft revision.
-     *
-     * @param PageRevision|Page $draft
-     *
-     * @return string[]
-     */
-    public function getWarningMessagesForDraft($draft): array
-    {
-        $warnings = [];
-
-        if ($this->hasActiveEditing()) {
-            $warnings[] = $this->activeEditingMessage();
-        }
-
-        if ($draft instanceof PageRevision && $this->hasPageBeenUpdatedSinceDraftCreated($draft)) {
-            $warnings[] = trans('entities.pages_draft_page_changed_since_creation');
-        }
-
-        return $warnings;
-    }
-
-    /**
-     * Check if the page has been updated since the draft has been saved.
-     */
-    protected function hasPageBeenUpdatedSinceDraftCreated(PageRevision $draft): bool
-    {
-        return $draft->page->updated_at->timestamp > $draft->created_at->timestamp;
-    }
-
     /**
      * Get the message to show when the user will be editing one of their drafts.
+     *
+     * @param PageRevision $draft
+     *
+     * @return string
      */
     public function getEditingActiveDraftMessage(PageRevision $draft): string
     {

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;
-    }
-}