From 5611c8c0da8927cd4831a9dd23a022a2d9bcfa18 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Sat, 30 May 2026 21:44:25 +0100 Subject: [PATCH 01/37] Maintenance: Started work on PHPStan Level 5 --- app/Access/ExternalBaseUserProvider.php | 2 +- app/Access/Guards/ExternalBaseSessionGuard.php | 8 ++++++-- app/Access/Guards/LdapSessionGuard.php | 4 ++++ app/Access/Oidc/OidcJwtWithClaims.php | 2 -- app/Activity/Models/Comment.php | 8 +++++++- app/Api/ApiDocsGenerator.php | 4 ++-- app/App/Providers/ThemeServiceProvider.php | 7 ++++++- app/App/helpers.php | 3 ++- app/Entities/Models/Entity.php | 2 +- app/Entities/Queries/QueryPopular.php | 2 ++ app/Entities/Queries/QueryRecentlyViewed.php | 2 ++ app/Entities/Queries/QueryTopFavourites.php | 2 ++ app/Http/Controller.php | 3 ++- app/Util/DatabaseTransaction.php | 3 ++- phpstan.neon.dist | 2 +- 15 files changed, 40 insertions(+), 14 deletions(-) diff --git a/app/Access/ExternalBaseUserProvider.php b/app/Access/ExternalBaseUserProvider.php index 2165fd4591e..2bc15cb0305 100644 --- a/app/Access/ExternalBaseUserProvider.php +++ b/app/Access/ExternalBaseUserProvider.php @@ -42,7 +42,7 @@ public function updateRememberToken(Authenticatable $user, $token) /** * Retrieve a user by the given credentials. */ - public function retrieveByCredentials(array $credentials): ?Authenticatable + public function retrieveByCredentials(array $credentials): ?User { return User::query() ->where('external_auth_id', $credentials['external_auth_id']) diff --git a/app/Access/Guards/ExternalBaseSessionGuard.php b/app/Access/Guards/ExternalBaseSessionGuard.php index 91239599ba9..b7bf174a1de 100644 --- a/app/Access/Guards/ExternalBaseSessionGuard.php +++ b/app/Access/Guards/ExternalBaseSessionGuard.php @@ -50,8 +50,12 @@ class ExternalBaseSessionGuard implements StatefulGuard /** * Create a new authentication guard. */ - public function __construct(string $name, UserProvider $provider, Session $session, RegistrationService $registrationService) - { + public function __construct( + string $name, + UserProvider $provider, + Session $session, + RegistrationService $registrationService + ) { $this->name = $name; $this->session = $session; $this->provider = $provider; diff --git a/app/Access/Guards/LdapSessionGuard.php b/app/Access/Guards/LdapSessionGuard.php index 9455d530dfe..f3628c897d8 100644 --- a/app/Access/Guards/LdapSessionGuard.php +++ b/app/Access/Guards/LdapSessionGuard.php @@ -83,6 +83,10 @@ public function attempt(array $credentials = [], $remember = false): bool } } + if (!($user instanceof User)) { + throw new LoginAttemptException('Could not find or create a user for LDAP login.'); + } + // Sync LDAP groups if required if ($this->ldapService->shouldSyncGroups()) { $this->ldapService->syncGroups($user, $username); diff --git a/app/Access/Oidc/OidcJwtWithClaims.php b/app/Access/Oidc/OidcJwtWithClaims.php index 9d7eeead1a9..9763ab15864 100644 --- a/app/Access/Oidc/OidcJwtWithClaims.php +++ b/app/Access/Oidc/OidcJwtWithClaims.php @@ -131,8 +131,6 @@ protected function validateTokenSignature(): void } }, $this->keys); - $parsedKeys = array_filter($parsedKeys); - $contentToSign = $this->tokenParts[0] . '.' . $this->tokenParts[1]; /** @var OidcJwtSigningKey $parsedKey */ foreach ($parsedKeys as $parsedKey) { diff --git a/app/Activity/Models/Comment.php b/app/Activity/Models/Comment.php index 3faa76657b6..b49eb456488 100644 --- a/app/Activity/Models/Comment.php +++ b/app/Activity/Models/Comment.php @@ -3,6 +3,7 @@ namespace BookStack\Activity\Models; use BookStack\App\Model; +use BookStack\Entities\Models\Page; use BookStack\Permissions\Models\JointPermission; use BookStack\Permissions\PermissionApplicator; use BookStack\Users\Models\HasCreatorAndUpdater; @@ -40,6 +41,9 @@ class Comment extends Model implements Loggable, OwnableInterface /** * Get the entity that this comment belongs to. + * It's only pages right now hence the typing below. + * Would need a deeper audit if that changes as many areas assume this is always a page. + * @return MorphTo */ public function entity(): MorphTo { @@ -55,7 +59,9 @@ public function entity(): MorphTo // Ultimately, we could just align the method name to 'commentable' but that would be a potential // breaking change and not really worthwhile in a patch due to the risk of creating extra problems. - return $this->morphTo(null, 'commentable_type', 'commentable_id'); + /** @var MorphTo $relation */ + $relation = $this->morphTo(null, 'commentable_type', 'commentable_id'); + return $relation; } /** diff --git a/app/Api/ApiDocsGenerator.php b/app/Api/ApiDocsGenerator.php index 53cb2890a7e..8d1be79c88f 100644 --- a/app/Api/ApiDocsGenerator.php +++ b/app/Api/ApiDocsGenerator.php @@ -138,8 +138,8 @@ protected function getValidationAsString($validation): string return $validation; } - if (is_object($validation) && method_exists($validation, '__toString')) { - return strval($validation); + if (is_object($validation) && $validation instanceof \Stringable) { + return $validation->__toString(); } if ($validation instanceof Password) { diff --git a/app/App/Providers/ThemeServiceProvider.php b/app/App/Providers/ThemeServiceProvider.php index 671e5e1df74..9b0f7001e81 100644 --- a/app/App/Providers/ThemeServiceProvider.php +++ b/app/App/Providers/ThemeServiceProvider.php @@ -7,6 +7,7 @@ use BookStack\Theming\ThemeViews; use Illuminate\Support\Facades\Blade; use Illuminate\Support\ServiceProvider; +use Illuminate\View\FileViewFinder; class ThemeServiceProvider extends ServiceProvider { @@ -27,7 +28,11 @@ public function boot(): void // Boot up the theme system $themeService = $this->app->make(ThemeService::class); $viewFactory = $this->app->make('view'); - $themeViews = new ThemeViews($viewFactory->getFinder()); + $viewFinder = $viewFactory->getFinder(); + if (!($viewFinder instanceof FileViewFinder)) { + throw new \Exception('Only the file view finder is supported for the theme system'); + } + $themeViews = new ThemeViews($viewFinder); // Use a custom include so that we can insert theme views before/after includes. // This is done, even if no theme is active, so that view caching does not create problems diff --git a/app/App/helpers.php b/app/App/helpers.php index 8f210ecafd4..45a84da8db7 100644 --- a/app/App/helpers.php +++ b/app/App/helpers.php @@ -6,6 +6,7 @@ use BookStack\Permissions\Permission; use BookStack\Permissions\PermissionApplicator; use BookStack\Settings\SettingService; +use BookStack\Users\Models\OwnableInterface; use BookStack\Users\Models\User; /** @@ -40,7 +41,7 @@ function user(): User * Check if the current user has a permission. If an ownable element * is passed in the jointPermissions are checked against that particular item. */ -function userCan(string|Permission $permission, ?Model $ownable = null): bool +function userCan(string|Permission $permission, (Model&OwnableInterface)|null $ownable = null): bool { if (is_null($ownable)) { return user()->can($permission); diff --git a/app/Entities/Models/Entity.php b/app/Entities/Models/Entity.php index 27cfccaa836..296bd3a6621 100644 --- a/app/Entities/Models/Entity.php +++ b/app/Entities/Models/Entity.php @@ -46,7 +46,7 @@ * @property int|null $created_by * @property int|null $updated_by * @property int|null $owned_by - * @property Collection $tags + * @property Collection $tags * * @method static Entity|Builder visible() * @method static Builder withLastView() diff --git a/app/Entities/Queries/QueryPopular.php b/app/Entities/Queries/QueryPopular.php index 065ae82ef82..1782070de86 100644 --- a/app/Entities/Queries/QueryPopular.php +++ b/app/Entities/Queries/QueryPopular.php @@ -6,6 +6,7 @@ use BookStack\Entities\EntityProvider; use BookStack\Entities\Tools\MixedEntityListLoader; use BookStack\Permissions\PermissionApplicator; +use Illuminate\Database\Eloquent\Builder; use Illuminate\Support\Collection; use Illuminate\Support\Facades\DB; @@ -20,6 +21,7 @@ public function __construct( public function run(int $count, int $page, array $filterModels): Collection { + /** @var Builder $query */ $query = $this->permissions ->restrictEntityRelationQuery(View::query(), 'views', 'viewable_id', 'viewable_type') ->select('*', 'viewable_id', 'viewable_type', DB::raw('SUM(views) as view_count')) diff --git a/app/Entities/Queries/QueryRecentlyViewed.php b/app/Entities/Queries/QueryRecentlyViewed.php index f28b8f8652f..8ba1a57badd 100644 --- a/app/Entities/Queries/QueryRecentlyViewed.php +++ b/app/Entities/Queries/QueryRecentlyViewed.php @@ -5,6 +5,7 @@ use BookStack\Activity\Models\View; use BookStack\Entities\Tools\MixedEntityListLoader; use BookStack\Permissions\PermissionApplicator; +use Illuminate\Database\Eloquent\Builder; use Illuminate\Support\Collection; class QueryRecentlyViewed @@ -22,6 +23,7 @@ public function run(int $count, int $page): Collection return collect(); } + /** @var Builder $query */ $query = $this->permissions->restrictEntityRelationQuery( View::query(), 'views', diff --git a/app/Entities/Queries/QueryTopFavourites.php b/app/Entities/Queries/QueryTopFavourites.php index 6340e35ef18..2719e94bc8b 100644 --- a/app/Entities/Queries/QueryTopFavourites.php +++ b/app/Entities/Queries/QueryTopFavourites.php @@ -5,6 +5,7 @@ use BookStack\Activity\Models\Favourite; use BookStack\Entities\Tools\MixedEntityListLoader; use BookStack\Permissions\PermissionApplicator; +use Illuminate\Database\Eloquent\Builder; use Illuminate\Database\Query\JoinClause; class QueryTopFavourites @@ -22,6 +23,7 @@ public function run(int $count, int $skip = 0) return collect(); } + /** @var Builder $query */ $query = $this->permissions ->restrictEntityRelationQuery(Favourite::query(), 'favourites', 'favouritable_id', 'favouritable_type') ->select('favourites.*') diff --git a/app/Http/Controller.php b/app/Http/Controller.php index 796505795e5..09c38ee6123 100644 --- a/app/Http/Controller.php +++ b/app/Http/Controller.php @@ -7,6 +7,7 @@ use BookStack\Exceptions\NotifyException; use BookStack\Facades\Activity; use BookStack\Permissions\Permission; +use BookStack\Users\Models\OwnableInterface; use Illuminate\Foundation\Bus\DispatchesJobs; use Illuminate\Foundation\Validation\ValidatesRequests; use Illuminate\Http\JsonResponse; @@ -80,7 +81,7 @@ protected function preventGuestAccess(): void /** * Check the current user's permissions against an ownable item otherwise throw an exception. */ - protected function checkOwnablePermission(string|Permission $permission, Model $ownable, string $redirectLocation = '/'): void + protected function checkOwnablePermission(string|Permission $permission, Model&OwnableInterface $ownable, string $redirectLocation = '/'): void { if (!userCan($permission, $ownable)) { $this->showPermissionError($redirectLocation); diff --git a/app/Util/DatabaseTransaction.php b/app/Util/DatabaseTransaction.php index e36bd2ef310..2e57b6479a1 100644 --- a/app/Util/DatabaseTransaction.php +++ b/app/Util/DatabaseTransaction.php @@ -3,6 +3,7 @@ namespace BookStack\Util; use Closure; +use Illuminate\Database\Connection; use Illuminate\Support\Facades\DB; use Throwable; @@ -24,7 +25,7 @@ class DatabaseTransaction { /** - * @param (Closure(static): TReturn) $callback + * @param (Closure(Connection): TReturn) $callback */ public function __construct( protected Closure $callback diff --git a/phpstan.neon.dist b/phpstan.neon.dist index bab28ea0eb3..54403adfefc 100644 --- a/phpstan.neon.dist +++ b/phpstan.neon.dist @@ -7,7 +7,7 @@ parameters: - app # The level 8 is the highest level - level: 4 + level: 5 phpVersion: min: 80200 From 03c9ddd14fed16177ebe59adaef36fd6eb5bded4 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Sun, 31 May 2026 11:12:23 +0100 Subject: [PATCH 02/37] Maintenance: Further PHPStan level 5 type fixes --- app/Access/Oidc/OidcService.php | 1 + app/Activity/ActivityQueries.php | 3 ++ app/Activity/Tools/WebhookFormatter.php | 8 +++- .../Controllers/PageApiController.php | 20 ++++++---- app/Entities/Controllers/PageController.php | 5 ++- .../Controllers/PageRevisionController.php | 2 +- .../Tools/Markdown/CustomListItemRenderer.php | 6 ++- app/Entities/Tools/PageContent.php | 37 +++++++++++++------ app/Entities/Tools/PageIncludeParser.php | 4 +- app/Entities/Tools/SlugGenerator.php | 2 +- 10 files changed, 59 insertions(+), 29 deletions(-) diff --git a/app/Access/Oidc/OidcService.php b/app/Access/Oidc/OidcService.php index a84bd320513..19120e2d3c3 100644 --- a/app/Access/Oidc/OidcService.php +++ b/app/Access/Oidc/OidcService.php @@ -80,6 +80,7 @@ public function processAuthorizeResponse(?string $authorizationCode): User $provider->setPkceCode($pkceCode); // Try to exchange authorization code for access token + /** @var OidcAccessToken $accessToken */ $accessToken = $provider->getAccessToken('authorization_code', [ 'code' => $authorizationCode, ]); diff --git a/app/Activity/ActivityQueries.php b/app/Activity/ActivityQueries.php index d5b047937fb..a3383e80933 100644 --- a/app/Activity/ActivityQueries.php +++ b/app/Activity/ActivityQueries.php @@ -11,6 +11,7 @@ use BookStack\Permissions\PermissionApplicator; use BookStack\Users\Models\User; use Illuminate\Database\Eloquent\Builder; +use Illuminate\Database\Eloquent\Collection; use Illuminate\Database\Eloquent\Relations\MorphTo; use Illuminate\Database\Eloquent\Relations\Relation; @@ -27,6 +28,7 @@ public function __construct( */ public function latest(int $count = 20, int $page = 0): array { + /** @var Collection $activityList */ $activityList = $this->permissions ->restrictEntityRelationQuery(Activity::query(), 'activities', 'loggable_id', 'loggable_type') ->orderBy('created_at', 'desc') @@ -83,6 +85,7 @@ public function entityActivity(Entity $entity, int $count = 20, int $page = 1): */ public function userActivity(User $user, int $count = 20, int $page = 0): array { + /** @var Collection $activityList */ $activityList = $this->permissions ->restrictEntityRelationQuery(Activity::query(), 'activities', 'loggable_id', 'loggable_type') ->orderBy('created_at', 'desc') diff --git a/app/Activity/Tools/WebhookFormatter.php b/app/Activity/Tools/WebhookFormatter.php index cb4e9cb0a9c..111efd5d498 100644 --- a/app/Activity/Tools/WebhookFormatter.php +++ b/app/Activity/Tools/WebhookFormatter.php @@ -73,13 +73,17 @@ public function addDefaultModelFormatters(): void // Load entity owner, creator, updater details $this->addModelFormatter( fn ($event, $model) => ($model instanceof Entity), - fn ($model) => $model->load(['ownedBy', 'createdBy', 'updatedBy']) + function ($model) { + $model->load(['ownedBy', 'createdBy', 'updatedBy']); + } ); // Load revision detail for page update and create events $this->addModelFormatter( fn ($event, $model) => ($model instanceof Page && ($event === ActivityType::PAGE_CREATE || $event === ActivityType::PAGE_UPDATE)), - fn ($model) => $model->load('currentRevision') + function ($model) { + $model->load('currentRevision'); + } ); } diff --git a/app/Entities/Controllers/PageApiController.php b/app/Entities/Controllers/PageApiController.php index 38042e67058..ca8989f0764 100644 --- a/app/Entities/Controllers/PageApiController.php +++ b/app/Entities/Controllers/PageApiController.php @@ -1,5 +1,7 @@ queries->visibleForList() ->addSelect(['created_by', 'updated_by', 'revision_count', 'editor']); @@ -69,7 +73,7 @@ public function list() * Any images included via base64 data URIs will be extracted and saved as gallery * images against the page during upload. */ - public function create(Request $request) + public function create(Request $request): JsonResponse { $this->validate($request, $this->rules['create']); @@ -102,9 +106,9 @@ public function create(Request $request) * Comments for the page are provided in a tree-structure representing the hierarchy of top-level * comments and replies, for both archived and active comments. */ - public function read(string $id) + public function read(string $id): JsonResponse { - $page = $this->queries->findVisibleByIdOrFail($id); + $page = $this->queries->findVisibleByIdOrFail(intval($id)); $page = $page->forJsonDisplay(); $commentTree = (new CommentTree($page)); @@ -124,11 +128,11 @@ public function read(string $id) * Providing a 'book_id' or 'chapter_id' property will essentially move * the page into that parent element if you have permissions to do so. */ - public function update(Request $request, string $id) + public function update(Request $request, string $id): JsonResponse { $requestData = $this->validate($request, $this->rules['update']); - $page = $this->queries->findVisibleByIdOrFail($id); + $page = $this->queries->findVisibleByIdOrFail(intval($id)); $this->checkOwnablePermission(Permission::PageUpdate, $page); $parent = null; @@ -161,9 +165,9 @@ public function update(Request $request, string $id) * Delete a page. * This will typically send the page to the recycle bin. */ - public function delete(string $id) + public function delete(string $id): Response { - $page = $this->queries->findVisibleByIdOrFail($id); + $page = $this->queries->findVisibleByIdOrFail(intval($id)); $this->checkOwnablePermission(Permission::PageDelete, $page); $this->pageRepo->destroy($page); diff --git a/app/Entities/Controllers/PageController.php b/app/Entities/Controllers/PageController.php index 82edfbc2763..dd655e7abb3 100644 --- a/app/Entities/Controllers/PageController.php +++ b/app/Entities/Controllers/PageController.php @@ -25,6 +25,7 @@ use BookStack\Util\HtmlContentFilterConfig; use Exception; use Illuminate\Database\Eloquent\Relations\BelongsTo; +use Illuminate\Database\Eloquent\Relations\Relation; use Illuminate\Http\Request; use Illuminate\Validation\ValidationException; use Throwable; @@ -358,8 +359,8 @@ public function destroyDraft(string $bookSlug, int $pageId) */ public function showRecentlyUpdated() { - $visibleBelongsScope = function (BelongsTo $query) { - $query->scopes('visible'); + $visibleBelongsScope = function (Relation $relation): void { + $relation->scopes('visible'); }; $pages = $this->queries->visibleForList() diff --git a/app/Entities/Controllers/PageRevisionController.php b/app/Entities/Controllers/PageRevisionController.php index cc6b79bfe45..801aeed3ed3 100644 --- a/app/Entities/Controllers/PageRevisionController.php +++ b/app/Entities/Controllers/PageRevisionController.php @@ -177,7 +177,7 @@ public function destroy(string $bookSlug, string $pageSlug, int $revId) */ public function destroyUserDraft(string $pageId) { - $page = $this->pageQueries->findVisibleByIdOrFail($pageId); + $page = $this->pageQueries->findVisibleByIdOrFail(intval($pageId)); $this->revisionRepo->deleteDraftsForCurrentUser($page); return response('', 200); diff --git a/app/Entities/Tools/Markdown/CustomListItemRenderer.php b/app/Entities/Tools/Markdown/CustomListItemRenderer.php index 0c506d7f9b5..14cdaa2eaa4 100644 --- a/app/Entities/Tools/Markdown/CustomListItemRenderer.php +++ b/app/Entities/Tools/Markdown/CustomListItemRenderer.php @@ -25,9 +25,13 @@ public function __construct() */ public function render(Node $node, ChildNodeRendererInterface $childRenderer) { + if (!($node instanceof ListItem)) { + return null; + } + $listItem = $this->baseRenderer->render($node, $childRenderer); - if ($node instanceof ListItem && $this->startsTaskListItem($node) && $listItem instanceof HtmlElement) { + if ($this->startsTaskListItem($node) && $listItem instanceof HtmlElement) { $listItem->setAttribute('class', 'task-list-item'); } diff --git a/app/Entities/Tools/PageContent.php b/app/Entities/Tools/PageContent.php index 9fb4596f5a0..c66dcbe4151 100644 --- a/app/Entities/Tools/PageContent.php +++ b/app/Entities/Tools/PageContent.php @@ -421,28 +421,41 @@ public function getNavigation(string $htmlContent): array */ protected function headerNodesToLevelList(DOMNodeList $nodeList): array { - $tree = collect($nodeList)->map(function (DOMElement $header) { + $minLevel = 6; + + $headerDetails = array_map(function (DOMNode $header) use (&$minLevel) { + if (!$header instanceof DOMElement) { + return null; + } + $text = trim(str_replace("\xc2\xa0", ' ', $header->nodeValue)); $text = mb_substr($text, 0, 100); + if (empty($text)) { + return null; + } + + $level = intval(str_replace('h', '', $header->nodeName)); + if ($level < $minLevel) { + $minLevel = $level; + } + return [ 'nodeName' => strtolower($header->nodeName), - 'level' => intval(str_replace('h', '', $header->nodeName)), + 'level' => $level, 'link' => '#' . $header->getAttribute('id'), 'text' => $text, ]; - })->filter(function ($header) { - return mb_strlen($header['text']) > 0; - }); + }, [...$nodeList]); - // Shift headers if only smaller headers have been used - $levelChange = ($tree->pluck('level')->min() - 1); - $tree = $tree->map(function ($header) use ($levelChange) { - $header['level'] -= ($levelChange); + $filtered = array_values(array_filter($headerDetails)); - return $header; - }); + // Shift headers if only smaller headers have been used + $levelChange = ($minLevel - 1); + foreach ($filtered as $index => $header) { + $filtered[$index]['level'] -= $levelChange; + } - return $tree->toArray(); + return $filtered; } } diff --git a/app/Entities/Tools/PageIncludeParser.php b/app/Entities/Tools/PageIncludeParser.php index af7ed4fc6a1..16917f41c8e 100644 --- a/app/Entities/Tools/PageIncludeParser.php +++ b/app/Entities/Tools/PageIncludeParser.php @@ -192,10 +192,10 @@ protected function splitNodeAtChildNode(DOMElement $parentNode, DOMNode $domNode /** * Get the parent paragraph of the given node, if existing. */ - protected function getParentParagraph(DOMNode $parent): ?DOMNode + protected function getParentParagraph(DOMNode $parent): ?DOMElement { do { - if (strtolower($parent->nodeName) === 'p') { + if (strtolower($parent->nodeName) === 'p' && $parent instanceof DOMElement) { return $parent; } diff --git a/app/Entities/Tools/SlugGenerator.php b/app/Entities/Tools/SlugGenerator.php index 6eec84a91c1..ac003b97a8f 100644 --- a/app/Entities/Tools/SlugGenerator.php +++ b/app/Entities/Tools/SlugGenerator.php @@ -52,7 +52,7 @@ protected function formatNameAsSlug(string $name): string { $slug = Str::slug($name); if ($slug === '') { - $slug = substr(md5(rand(1, 500)), 0, 5); + $slug = substr(md5(strval(rand(1, 500))), 0, 5); } return $slug; From fa3b7f77b9d430304ac5683a0db374adca2f85d3 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Sun, 31 May 2026 15:42:54 +0100 Subject: [PATCH 03/37] Maintenance: Addressed all phpstan level 5 issues --- app/Entities/Models/Book.php | 8 ++++---- app/Entities/Models/Page.php | 4 ++-- app/Exports/ImportRepo.php | 5 +++++ app/Exports/ZipExports/ZipImportRunner.php | 2 +- app/Permissions/JointPermissionBuilder.php | 3 +++ app/References/Reference.php | 2 +- app/References/ReferenceFetcher.php | 4 ++++ app/Search/SearchRunner.php | 4 ++++ app/Settings/SettingService.php | 6 +++--- app/Sorting/SortRule.php | 14 ++++++++++++++ app/Uploads/AttachmentService.php | 2 +- app/Users/Controllers/RoleApiController.php | 2 +- app/Users/Controllers/RoleController.php | 6 +++--- app/Users/Controllers/UserApiController.php | 8 ++++---- 14 files changed, 50 insertions(+), 20 deletions(-) diff --git a/app/Entities/Models/Book.php b/app/Entities/Models/Book.php index 10f04695a5e..abb081d712f 100644 --- a/app/Entities/Models/Book.php +++ b/app/Entities/Models/Book.php @@ -20,10 +20,10 @@ * @property ?int $image_id * @property ?int $default_template_id * @property ?int $sort_rule_id - * @property \Illuminate\Database\Eloquent\Collection $chapters - * @property \Illuminate\Database\Eloquent\Collection $pages - * @property \Illuminate\Database\Eloquent\Collection $directPages - * @property \Illuminate\Database\Eloquent\Collection $shelves + * @property \Illuminate\Database\Eloquent\Collection $chapters + * @property \Illuminate\Database\Eloquent\Collection $pages + * @property \Illuminate\Database\Eloquent\Collection $directPages + * @property \Illuminate\Database\Eloquent\Collection $shelves * @property ?SortRule $sortRule */ class Book extends Entity implements HasDescriptionInterface, HasCoverInterface, HasDefaultTemplateInterface diff --git a/app/Entities/Models/Page.php b/app/Entities/Models/Page.php index d3a392da6fa..c38f33af3ca 100644 --- a/app/Entities/Models/Page.php +++ b/app/Entities/Models/Page.php @@ -24,8 +24,8 @@ * @property int $revision_count * @property string $editor * @property Chapter|null $chapter - * @property Collection $attachments - * @property Collection $revisions + * @property Collection $attachments + * @property Collection $revisions * @property PageRevision $currentRevision */ class Page extends BookChild diff --git a/app/Exports/ImportRepo.php b/app/Exports/ImportRepo.php index 79db69fca8f..ed631409be3 100644 --- a/app/Exports/ImportRepo.php +++ b/app/Exports/ImportRepo.php @@ -3,6 +3,8 @@ namespace BookStack\Exports; use BookStack\Activity\ActivityType; +use BookStack\Entities\Models\Book; +use BookStack\Entities\Models\Chapter; use BookStack\Entities\Models\Entity; use BookStack\Entities\Queries\EntityQueries; use BookStack\Exceptions\FileUploadException; @@ -119,6 +121,9 @@ public function runImport(Import $import, ?string $parent = null): Entity $parentModel = null; if ($import->type === 'page' || $import->type === 'chapter') { $parentModel = $parent ? $this->entityQueries->findVisibleByStringIdentifier($parent) : null; + if ($parentModel && !($parentModel instanceof Book || $parentModel instanceof Chapter)) { + throw new ZipImportException(['Selected parent is not a book or chapter']); + } } DB::beginTransaction(); diff --git a/app/Exports/ZipExports/ZipImportRunner.php b/app/Exports/ZipExports/ZipImportRunner.php index 9fa7dec3afe..37f6c0b8d33 100644 --- a/app/Exports/ZipExports/ZipImportRunner.php +++ b/app/Exports/ZipExports/ZipImportRunner.php @@ -48,7 +48,7 @@ public function __construct( * Returns the top-level entity item which was imported. * @throws ZipImportException */ - public function run(Import $import, ?Entity $parent = null): Entity + public function run(Import $import, Book|Chapter|null $parent = null): Entity { $zipPath = $this->getZipPath($import); $reader = new ZipExportReader($zipPath); diff --git a/app/Permissions/JointPermissionBuilder.php b/app/Permissions/JointPermissionBuilder.php index 94f18916d4a..f2159375df1 100644 --- a/app/Permissions/JointPermissionBuilder.php +++ b/app/Permissions/JointPermissionBuilder.php @@ -101,6 +101,7 @@ public function rebuildForRole(Role $role) /** * Get a query for fetching a book with its children. + * @return Builder */ protected function bookFetchQuery(): Builder { @@ -117,9 +118,11 @@ protected function bookFetchQuery(): Builder /** * Build joint permissions for the given book and role combinations. + * @param EloquentCollection $books */ protected function buildJointPermissionsForBooks(EloquentCollection $books, array $roles, bool $deleteOld = false): void { + /** @var EloquentCollection $entities */ $entities = clone $books; /** @var Book $book */ diff --git a/app/References/Reference.php b/app/References/Reference.php index df8a3a78932..602e19eab59 100644 --- a/app/References/Reference.php +++ b/app/References/Reference.php @@ -2,8 +2,8 @@ namespace BookStack\References; +use BookStack\App\Model; use BookStack\Permissions\Models\JointPermission; -use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\HasMany; use Illuminate\Database\Eloquent\Relations\MorphTo; diff --git a/app/References/ReferenceFetcher.php b/app/References/ReferenceFetcher.php index 8588c6e2c8e..0c76b46982c 100644 --- a/app/References/ReferenceFetcher.php +++ b/app/References/ReferenceFetcher.php @@ -22,6 +22,7 @@ public function __construct( */ public function getReferencesToEntity(Entity $entity, bool $withContents = false): Collection { + /** @var Collection $references */ $references = $this->queryReferencesToEntity($entity)->get(); $this->mixedEntityListLoader->loadIntoRelations($references->all(), 'from', false, $withContents); @@ -37,6 +38,9 @@ public function getReferenceCountToEntity(Entity $entity): int return $this->queryReferencesToEntity($entity)->count(); } + /** + * @return Builder + */ protected function queryReferencesToEntity(Entity $entity): Builder { $baseQuery = Reference::query() diff --git a/app/Search/SearchRunner.php b/app/Search/SearchRunner.php index 3912541723f..c2f3b96c9e6 100644 --- a/app/Search/SearchRunner.php +++ b/app/Search/SearchRunner.php @@ -4,6 +4,7 @@ use BookStack\Entities\EntityProvider; use BookStack\Entities\Models\Entity; +use BookStack\Entities\Models\EntityTable; use BookStack\Entities\Queries\EntityQueries; use BookStack\Entities\Tools\EntityHydrator; use BookStack\Permissions\PermissionApplicator; @@ -90,6 +91,8 @@ public function searchChapter(int $chapterId, string $searchString): Collection /** * Get a page of result data from the given query based on the provided page parameters. + * @param EloquentBuilder $query + * @return Collection */ protected function getPageOfDataFromQuery(EloquentBuilder $query, int $page, int $count): Collection { @@ -106,6 +109,7 @@ protected function getPageOfDataFromQuery(EloquentBuilder $query, int $page, int /** * Create a search query for an entity. * @param string[] $entityTypes + * @return EloquentBuilder */ protected function buildQuery(SearchOptions $searchOpts, array $entityTypes): EloquentBuilder { diff --git a/app/Settings/SettingService.php b/app/Settings/SettingService.php index e0b13618012..d35f7711795 100644 --- a/app/Settings/SettingService.php +++ b/app/Settings/SettingService.php @@ -243,9 +243,9 @@ public function putForCurrentUser(string $key, string $value): bool /** * Convert a setting key into a user-specific key. */ - protected function userKey(string $userId, string $key = ''): string + protected function userKey(int $userId, string $key = ''): string { - return 'user:' . $userId . ':' . $key; + return 'user:' . strval($userId) . ':' . $key; } /** @@ -267,7 +267,7 @@ public function remove(string $key): void /** * Delete settings for a given user id. */ - public function deleteUserSettings(string $userId): void + public function deleteUserSettings(int $userId): void { Setting::query() ->where('setting_key', 'like', $this->userKey($userId) . '%') diff --git a/app/Sorting/SortRule.php b/app/Sorting/SortRule.php index bf53365a201..ffe2d411534 100644 --- a/app/Sorting/SortRule.php +++ b/app/Sorting/SortRule.php @@ -38,21 +38,35 @@ public function setOperations(array $options): void $this->sequence = implode(',', $values); } + /** + * @inheritDoc + */ public function logDescriptor(): string { return "({$this->id}) {$this->name}"; } + /** + * Get the URL to where this rule can be managed. + */ public function getUrl(): string { return url("/settings/sorting/rules/{$this->id}"); } + /** + * Get the books which are specifically set to use this sort rule. + * @return HasMany + */ public function books(): HasMany { return $this->hasMany(Book::class, 'entity_container_data.sort_rule_id', 'id'); } + /** + * Get all the available sort rules, ordered by name, with the number of books using each. + * @return Collection + */ public static function allByName(): Collection { return static::query() diff --git a/app/Uploads/AttachmentService.php b/app/Uploads/AttachmentService.php index dabd537292f..3de84bdd0a8 100644 --- a/app/Uploads/AttachmentService.php +++ b/app/Uploads/AttachmentService.php @@ -102,7 +102,7 @@ public function saveNewFromLink(string $name, string $link, int $page_id): Attac /** * Updates the ordering for a listing of attached files. */ - public function updateFileOrderWithinPage(array $attachmentOrder, string $pageId) + public function updateFileOrderWithinPage(array $attachmentOrder, int $pageId) { foreach ($attachmentOrder as $index => $attachmentId) { Attachment::query()->where('uploaded_to', '=', $pageId) diff --git a/app/Users/Controllers/RoleApiController.php b/app/Users/Controllers/RoleApiController.php index 93ecc549bb4..6f0c59651a5 100644 --- a/app/Users/Controllers/RoleApiController.php +++ b/app/Users/Controllers/RoleApiController.php @@ -87,7 +87,7 @@ public function create(Request $request) */ public function read(string $id) { - $role = $this->permissionsRepo->getRoleById($id); + $role = $this->permissionsRepo->getRoleById(intval($id)); $this->singleFormatter($role); return response()->json($role); diff --git a/app/Users/Controllers/RoleController.php b/app/Users/Controllers/RoleController.php index b9f06dace84..56a6c7416ca 100644 --- a/app/Users/Controllers/RoleController.php +++ b/app/Users/Controllers/RoleController.php @@ -94,7 +94,7 @@ public function store(Request $request) public function edit(string $id) { $this->checkPermission(Permission::UserRolesManage); - $role = $this->permissionsRepo->getRoleById($id); + $role = $this->permissionsRepo->getRoleById(intval($id)); $this->setPageTitle(trans('settings.role_edit')); @@ -129,7 +129,7 @@ public function update(Request $request, string $id) public function showDelete(string $id) { $this->checkPermission(Permission::UserRolesManage); - $role = $this->permissionsRepo->getRoleById($id); + $role = $this->permissionsRepo->getRoleById(intval($id)); $roles = $this->permissionsRepo->getAllRolesExcept($role); $blankRole = $role->newInstance(['display_name' => trans('settings.role_delete_no_migration')]); $roles->prepend($blankRole); @@ -151,7 +151,7 @@ public function delete(Request $request, string $id) try { $migrateRoleId = intval($request->input('migrate_role_id') ?: "0"); - $this->permissionsRepo->deleteRole($id, $migrateRoleId); + $this->permissionsRepo->deleteRole(intval($id), $migrateRoleId); } catch (PermissionsException $e) { $this->showErrorNotification($e->getMessage()); diff --git a/app/Users/Controllers/UserApiController.php b/app/Users/Controllers/UserApiController.php index ebc17e262f3..07eefadc7b1 100644 --- a/app/Users/Controllers/UserApiController.php +++ b/app/Users/Controllers/UserApiController.php @@ -110,7 +110,7 @@ public function create(Request $request) */ public function read(string $id) { - $user = $this->userRepo->getById($id); + $user = $this->userRepo->getById(intval($id)); $this->singleFormatter($user); return response()->json($user); @@ -124,8 +124,8 @@ public function read(string $id) */ public function update(Request $request, string $id) { - $data = $this->validate($request, $this->rules($id)['update']); - $user = $this->userRepo->getById($id); + $data = $this->validate($request, $this->rules(intval($id))['update']); + $user = $this->userRepo->getById(intval($id)); $this->userRepo->update($user, $data, userCan(Permission::UsersManage)); $this->singleFormatter($user); @@ -140,7 +140,7 @@ public function update(Request $request, string $id) */ public function delete(Request $request, string $id) { - $user = $this->userRepo->getById($id); + $user = $this->userRepo->getById(intval($id)); $newOwnerId = $request->input('migrate_ownership_id', null); $this->userRepo->destroy($user, $newOwnerId); From 26a3cb8b7e36a421c4491ad987e053d96ee84075 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Thu, 6 Aug 2026 15:32:17 +0100 Subject: [PATCH 04/37] Views: Started implementation of new sidebar back-end --- .../Providers/ViewTweaksServiceProvider.php | 2 + app/Entities/Controllers/BookController.php | 2 - app/View/SidebarSection.php | 16 ++++++ app/View/SidebarSectionInterface.php | 20 ++++++++ app/View/SidebarSectionManager.php | 51 +++++++++++++++++++ .../SidebarSections/BooksIndexRecents.php | 26 ++++++++++ resources/views/books/index.blade.php | 4 +- 7 files changed, 118 insertions(+), 3 deletions(-) create mode 100644 app/View/SidebarSection.php create mode 100644 app/View/SidebarSectionInterface.php create mode 100644 app/View/SidebarSectionManager.php create mode 100644 app/View/SidebarSections/BooksIndexRecents.php diff --git a/app/App/Providers/ViewTweaksServiceProvider.php b/app/App/Providers/ViewTweaksServiceProvider.php index 6771e513fa6..d2d45abcc5d 100644 --- a/app/App/Providers/ViewTweaksServiceProvider.php +++ b/app/App/Providers/ViewTweaksServiceProvider.php @@ -4,6 +4,7 @@ use BookStack\Entities\BreadcrumbsViewComposer; use BookStack\Util\DateFormatter; +use BookStack\View\SidebarSectionManager; use Illuminate\Pagination\Paginator; use Illuminate\Support\Facades\Blade; use Illuminate\Support\Facades\View; @@ -33,6 +34,7 @@ public function boot(): void // View Globals View::share('dates', $this->app->make(DateFormatter::class)); + View::share('sidebar', $this->app->make(SidebarSectionManager::class)); // Custom blade view directives Blade::directive('icon', function ($expression) { diff --git a/app/Entities/Controllers/BookController.php b/app/Entities/Controllers/BookController.php index 98470d91ce8..9fa64d2934c 100644 --- a/app/Entities/Controllers/BookController.php +++ b/app/Entities/Controllers/BookController.php @@ -53,7 +53,6 @@ public function index(Request $request) $books = $this->queries->visibleForListWithCover() ->orderBy($listOptions->getSort(), $listOptions->getOrder()) ->paginate(setting()->getInteger('lists-page-count-books', 18, 1, 1000)); - $recents = $this->isSignedIn() ? $this->queries->recentlyViewedForCurrentUser()->take(4)->get() : false; $popular = $this->queries->popularForList()->take(4)->get(); $new = $this->queries->visibleForList()->orderBy('created_at', 'desc')->take(4)->get(); @@ -63,7 +62,6 @@ public function index(Request $request) return view('books.index', [ 'books' => $books, - 'recents' => $recents, 'popular' => $popular, 'new' => $new, 'view' => $view, diff --git a/app/View/SidebarSection.php b/app/View/SidebarSection.php new file mode 100644 index 00000000000..68e1aa29193 --- /dev/null +++ b/app/View/SidebarSection.php @@ -0,0 +1,16 @@ +view; + } +} diff --git a/app/View/SidebarSectionInterface.php b/app/View/SidebarSectionInterface.php new file mode 100644 index 00000000000..84032ab6174 --- /dev/null +++ b/app/View/SidebarSectionInterface.php @@ -0,0 +1,20 @@ + + */ + public function withData(array $viewData, Request $request): array; +} diff --git a/app/View/SidebarSectionManager.php b/app/View/SidebarSectionManager.php new file mode 100644 index 00000000000..82af3721ec4 --- /dev/null +++ b/app/View/SidebarSectionManager.php @@ -0,0 +1,51 @@ +[]>> + */ + protected array $sectionByLocation = [ + 'books-index' => [ + 'left' => [ + BooksIndexRecents::class, + ] + ], + ]; + + /** + * Register a sidebar section to be displayed at the given location and position. + * @param class-string $sectionClass + */ + public function register(string $location, string $position, string $sectionClass): void + { + if (!isset($this->sectionByLocation[$location])) { + $this->sectionByLocation[$location] = []; + } + + if (!isset($this->sectionByLocation[$location][$position])) { + $this->sectionByLocation[$location][$position] = []; + } + + $this->sectionByLocation[$location][$position][] = $sectionClass; + } + + /** + * Get all sidebar sections registered for a given location. + * + * @return SidebarSectionInterface[] + * @throws BindingResolutionException + */ + public function getSectionsForLocation(string $location, string $position): array + { + $sections = array_unique($this->sectionByLocation[$location][$position] ?? []); + return array_map(function (string $className) { + return app()->make($className); + }, $sections); + } +} diff --git a/app/View/SidebarSections/BooksIndexRecents.php b/app/View/SidebarSections/BooksIndexRecents.php new file mode 100644 index 00000000000..485e6d431fc --- /dev/null +++ b/app/View/SidebarSections/BooksIndexRecents.php @@ -0,0 +1,26 @@ +isGuest(); + $recents = $userSignedIn ? $this->queries->recentlyViewedForCurrentUser()->take(4)->get() : null; + return [ + 'recents' => $recents, + ]; + } +} diff --git a/resources/views/books/index.blade.php b/resources/views/books/index.blade.php index 660c008dfb1..60152410cb9 100644 --- a/resources/views/books/index.blade.php +++ b/resources/views/books/index.blade.php @@ -5,7 +5,9 @@ @stop @section('left') - @include('books.parts.index-sidebar-section-recents', ['recents' => $recents]) + @foreach($sidebar->getSectionsForLocation('books-index', 'left') as $section) + @include($section->getView(), $section->withData(get_defined_vars(), request())) + @endforeach @include('books.parts.index-sidebar-section-popular', ['popular' => $popular]) @include('books.parts.index-sidebar-section-new', ['new' => $new]) @stop From dead0bfb5fd5b725230a5020973ddd4fa9560a95 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Fri, 7 Aug 2026 08:32:27 +0100 Subject: [PATCH 05/37] Views: Extracted books index/show sidebar sections --- app/Entities/Controllers/BookController.php | 15 +-------- app/View/SidebarSectionManager.php | 28 +++++++++++++++- .../SidebarSections/BooksIndexActions.php | 18 +++++++++++ app/View/SidebarSections/BooksIndexNew.php | 29 +++++++++++++++++ .../SidebarSections/BooksIndexPopular.php | 24 ++++++++++++++ app/View/SidebarSections/BooksShowActions.php | 24 ++++++++++++++ .../SidebarSections/BooksShowActivity.php | 28 ++++++++++++++++ app/View/SidebarSections/BooksShowDetails.php | 32 +++++++++++++++++++ .../SidebarSections/BooksShowSearchForm.php | 18 +++++++++++ app/View/SidebarSections/BooksShowShelves.php | 23 +++++++++++++ app/View/SidebarSections/BooksShowTags.php | 18 +++++++++++ resources/views/books/index.blade.php | 8 ++--- .../show-sidebar-section-details.blade.php | 2 +- .../show-sidebar-section-shelves.blade.php | 4 +-- resources/views/books/show.blade.php | 13 +++----- .../views/common/sidebar-sections.blade.php | 11 +++++++ 16 files changed, 262 insertions(+), 33 deletions(-) create mode 100644 app/View/SidebarSections/BooksIndexActions.php create mode 100644 app/View/SidebarSections/BooksIndexNew.php create mode 100644 app/View/SidebarSections/BooksIndexPopular.php create mode 100644 app/View/SidebarSections/BooksShowActions.php create mode 100644 app/View/SidebarSections/BooksShowActivity.php create mode 100644 app/View/SidebarSections/BooksShowDetails.php create mode 100644 app/View/SidebarSections/BooksShowSearchForm.php create mode 100644 app/View/SidebarSections/BooksShowShelves.php create mode 100644 app/View/SidebarSections/BooksShowTags.php create mode 100644 resources/views/common/sidebar-sections.blade.php diff --git a/app/Entities/Controllers/BookController.php b/app/Entities/Controllers/BookController.php index 9fa64d2934c..aa4f99daa6d 100644 --- a/app/Entities/Controllers/BookController.php +++ b/app/Entities/Controllers/BookController.php @@ -2,10 +2,8 @@ namespace BookStack\Entities\Controllers; -use BookStack\Activity\ActivityQueries; use BookStack\Activity\ActivityType; use BookStack\Activity\Models\View; -use BookStack\Activity\Tools\UserEntityWatchOptions; use BookStack\Entities\Queries\BookQueries; use BookStack\Entities\Queries\BookshelfQueries; use BookStack\Entities\Queries\EntityQueries; @@ -19,7 +17,6 @@ use BookStack\Facades\Activity; use BookStack\Http\Controller; use BookStack\Permissions\Permission; -use BookStack\References\ReferenceFetcher; use BookStack\Util\DatabaseTransaction; use BookStack\Util\SimpleListOptions; use Illuminate\Http\Request; @@ -34,7 +31,6 @@ public function __construct( protected BookQueries $queries, protected EntityQueries $entityQueries, protected BookshelfQueries $shelfQueries, - protected ReferenceFetcher $referenceFetcher, ) { } @@ -53,8 +49,6 @@ public function index(Request $request) $books = $this->queries->visibleForListWithCover() ->orderBy($listOptions->getSort(), $listOptions->getOrder()) ->paginate(setting()->getInteger('lists-page-count-books', 18, 1, 1000)); - $popular = $this->queries->popularForList()->take(4)->get(); - $new = $this->queries->visibleForList()->orderBy('created_at', 'desc')->take(4)->get(); $this->shelfContext->clearShelfContext(); @@ -62,8 +56,6 @@ public function index(Request $request) return view('books.index', [ 'books' => $books, - 'popular' => $popular, - 'new' => $new, 'view' => $view, 'listOptions' => $listOptions, ]); @@ -125,7 +117,7 @@ public function store(Request $request, ?string $shelfSlug = null) /** * Display the specified book. */ - public function show(Request $request, ActivityQueries $activities, string $slug) + public function show(Request $request, string $slug) { try { $book = $this->queries->findVisibleBySlugOrFail($slug); @@ -138,7 +130,6 @@ public function show(Request $request, ActivityQueries $activities, string $slug } $bookChildren = (new BookContents($book))->getTree(true); - $bookParentShelves = $book->shelves()->scopes('visible')->get(); View::incrementFor($book); if ($request->has('shelf')) { @@ -151,10 +142,6 @@ public function show(Request $request, ActivityQueries $activities, string $slug 'book' => $book, 'current' => $book, 'bookChildren' => $bookChildren, - 'bookParentShelves' => $bookParentShelves, - 'watchOptions' => new UserEntityWatchOptions(user(), $book), - 'activity' => $activities->entityActivity($book, 20, 1), - 'referenceCount' => $this->referenceFetcher->getReferenceCountToEntity($book), ]); } diff --git a/app/View/SidebarSectionManager.php b/app/View/SidebarSectionManager.php index 82af3721ec4..d83b7afb0ea 100644 --- a/app/View/SidebarSectionManager.php +++ b/app/View/SidebarSectionManager.php @@ -2,7 +2,16 @@ namespace BookStack\View; +use BookStack\View\SidebarSections\BooksIndexActions; +use BookStack\View\SidebarSections\BooksIndexNew; +use BookStack\View\SidebarSections\BooksIndexPopular; use BookStack\View\SidebarSections\BooksIndexRecents; +use BookStack\View\SidebarSections\BooksShowActions; +use BookStack\View\SidebarSections\BooksShowActivity; +use BookStack\View\SidebarSections\BooksShowDetails; +use BookStack\View\SidebarSections\BooksShowSearchForm; +use BookStack\View\SidebarSections\BooksShowShelves; +use BookStack\View\SidebarSections\BooksShowTags; use Illuminate\Contracts\Container\BindingResolutionException; class SidebarSectionManager @@ -14,7 +23,24 @@ class SidebarSectionManager 'books-index' => [ 'left' => [ BooksIndexRecents::class, - ] + BooksIndexPopular::class, + BooksIndexNew::class, + ], + 'right' => [ + BooksIndexActions::class, + ], + ], + 'books-show' => [ + 'left' => [ + BooksShowSearchForm::class, + BooksShowTags::class, + BooksShowShelves::class, + BooksShowActivity::class, + ], + 'right' => [ + BooksShowDetails::class, + BooksShowActions::class, + ], ], ]; diff --git a/app/View/SidebarSections/BooksIndexActions.php b/app/View/SidebarSections/BooksIndexActions.php new file mode 100644 index 00000000000..62f856a651b --- /dev/null +++ b/app/View/SidebarSections/BooksIndexActions.php @@ -0,0 +1,18 @@ + $viewData['view'], + ]; + } +} diff --git a/app/View/SidebarSections/BooksIndexNew.php b/app/View/SidebarSections/BooksIndexNew.php new file mode 100644 index 00000000000..33a57f9d996 --- /dev/null +++ b/app/View/SidebarSections/BooksIndexNew.php @@ -0,0 +1,29 @@ +queries->visibleForList() + ->orderBy('created_at', 'desc') + ->take(4) + ->get(); + + return [ + 'new' => $new, + ]; + } +} diff --git a/app/View/SidebarSections/BooksIndexPopular.php b/app/View/SidebarSections/BooksIndexPopular.php new file mode 100644 index 00000000000..9f5cc613f91 --- /dev/null +++ b/app/View/SidebarSections/BooksIndexPopular.php @@ -0,0 +1,24 @@ + $this->queries->popularForList()->take(4)->get(), + ]; + } +} diff --git a/app/View/SidebarSections/BooksShowActions.php b/app/View/SidebarSections/BooksShowActions.php new file mode 100644 index 00000000000..0f97e625c6a --- /dev/null +++ b/app/View/SidebarSections/BooksShowActions.php @@ -0,0 +1,24 @@ + $book, + 'watchOptions' => new UserEntityWatchOptions(user(), $book), + ]; + } +} diff --git a/app/View/SidebarSections/BooksShowActivity.php b/app/View/SidebarSections/BooksShowActivity.php new file mode 100644 index 00000000000..d892c5ea730 --- /dev/null +++ b/app/View/SidebarSections/BooksShowActivity.php @@ -0,0 +1,28 @@ + $this->activityQueries->entityActivity($book, 20, 1), + ]; + } +} diff --git a/app/View/SidebarSections/BooksShowDetails.php b/app/View/SidebarSections/BooksShowDetails.php new file mode 100644 index 00000000000..bd91663b229 --- /dev/null +++ b/app/View/SidebarSections/BooksShowDetails.php @@ -0,0 +1,32 @@ +referenceFetcher->getReferenceCountToEntity($book); + + return [ + 'book' => $book, + 'watchOptions' => new UserEntityWatchOptions(user(), $book), + 'referenceCount' => $referenceCount, + ]; + } +} diff --git a/app/View/SidebarSections/BooksShowSearchForm.php b/app/View/SidebarSections/BooksShowSearchForm.php new file mode 100644 index 00000000000..8fa24134b15 --- /dev/null +++ b/app/View/SidebarSections/BooksShowSearchForm.php @@ -0,0 +1,18 @@ + trans('entities.books_search_this'), + ]; + } +} diff --git a/app/View/SidebarSections/BooksShowShelves.php b/app/View/SidebarSections/BooksShowShelves.php new file mode 100644 index 00000000000..28d2d8aa9f0 --- /dev/null +++ b/app/View/SidebarSections/BooksShowShelves.php @@ -0,0 +1,23 @@ +shelves()->scopes('visible')->get(); + + return [ + 'shelves' => $shelves, + ]; + } +} diff --git a/app/View/SidebarSections/BooksShowTags.php b/app/View/SidebarSections/BooksShowTags.php new file mode 100644 index 00000000000..351686c7f8a --- /dev/null +++ b/app/View/SidebarSections/BooksShowTags.php @@ -0,0 +1,18 @@ + $viewData['book'], + ]; + } +} diff --git a/resources/views/books/index.blade.php b/resources/views/books/index.blade.php index 60152410cb9..020cb096638 100644 --- a/resources/views/books/index.blade.php +++ b/resources/views/books/index.blade.php @@ -5,13 +5,9 @@ @stop @section('left') - @foreach($sidebar->getSectionsForLocation('books-index', 'left') as $section) - @include($section->getView(), $section->withData(get_defined_vars(), request())) - @endforeach - @include('books.parts.index-sidebar-section-popular', ['popular' => $popular]) - @include('books.parts.index-sidebar-section-new', ['new' => $new]) + @include('common.sidebar-sections', ['location' => 'books-index', 'position' => 'left']) @stop @section('right') - @include('books.parts.index-sidebar-section-actions', ['view' => $view]) + @include('common.sidebar-sections', ['location' => 'books-index', 'position' => 'right']) @stop diff --git a/resources/views/books/parts/show-sidebar-section-details.blade.php b/resources/views/books/parts/show-sidebar-section-details.blade.php index 709d0ffd9a1..2c3d6d141dd 100644 --- a/resources/views/books/parts/show-sidebar-section-details.blade.php +++ b/resources/views/books/parts/show-sidebar-section-details.blade.php @@ -1,7 +1,7 @@
{{ trans('common.details') }}
- @include('entities.meta', ['entity' => $book, 'watchOptions' => $watchOptions]) + @include('entities.meta', ['entity' => $book, 'watchOptions' => $watchOptions, 'referenceCount' => $referenceCount]) @if($book->hasPermissions())
@if(userCan(\BookStack\Permissions\Permission::RestrictionsManage, $book)) diff --git a/resources/views/books/parts/show-sidebar-section-shelves.blade.php b/resources/views/books/parts/show-sidebar-section-shelves.blade.php index 9de9b95c62e..9704c180c43 100644 --- a/resources/views/books/parts/show-sidebar-section-shelves.blade.php +++ b/resources/views/books/parts/show-sidebar-section-shelves.blade.php @@ -1,6 +1,6 @@ -@if(count($bookParentShelves) > 0) +@if(count($shelves) > 0)
{{ trans('entities.shelves') }}
- @include('entities.list', ['entities' => $bookParentShelves, 'style' => 'compact']) + @include('entities.list', ['entities' => $shelves, 'style' => 'compact'])
@endif \ No newline at end of file diff --git a/resources/views/books/show.blade.php b/resources/views/books/show.blade.php index 4eb83164f4d..48a95113252 100644 --- a/resources/views/books/show.blade.php +++ b/resources/views/books/show.blade.php @@ -66,15 +66,10 @@ @stop -@section('right') - @include('books.parts.show-sidebar-section-details', ['book' => $book, 'watchOptions' => $watchOptions]) - @include('books.parts.show-sidebar-section-actions', ['book' => $book, 'watchOptions' => $watchOptions]) -@stop - @section('left') - @include('entities.search-form', ['label' => trans('entities.books_search_this')]) - @include('books.parts.show-sidebar-section-tags', ['book' => $book]) - @include('books.parts.show-sidebar-section-shelves', ['bookParentShelves' => $bookParentShelves]) - @include('books.parts.show-sidebar-section-activity', ['activity' => $activity]) + @include('common.sidebar-sections', ['location' => 'books-show', 'position' => 'left']) @stop +@section('right') + @include('common.sidebar-sections', ['location' => 'books-show', 'position' => 'right']) +@stop diff --git a/resources/views/common/sidebar-sections.blade.php b/resources/views/common/sidebar-sections.blade.php new file mode 100644 index 00000000000..a4a055e6a6f --- /dev/null +++ b/resources/views/common/sidebar-sections.blade.php @@ -0,0 +1,11 @@ +{{-- +$location - string +$position - string +--}} +@php + $sectionVars = get_defined_vars(); + $sectionRequest = request(); +@endphp +@foreach($sidebar->getSectionsForLocation($location, $position) as $section) + @include($section->getView(), $section->withData($sectionVars, $sectionRequest)) +@endforeach \ No newline at end of file From b462c67e2ff7a44c1942486967888d48b0d06380 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Fri, 7 Aug 2026 12:54:38 +0100 Subject: [PATCH 06/37] Views: Extracted sidebar blocks for main entity pages --- .../Controllers/BookshelfController.php | 16 +---- .../Controllers/ChapterController.php | 11 +--- app/Entities/Controllers/PageController.php | 13 +--- app/View/SidebarSectionManager.php | 62 +++++++++++++++++++ .../SidebarSections/BooksIndexRecents.php | 7 ++- .../SidebarSections/ChaptersShowActions.php | 24 +++++++ .../SidebarSections/ChaptersShowBookTree.php | 23 +++++++ .../SidebarSections/ChaptersShowDetails.php | 37 +++++++++++ .../ChaptersShowSearchForm.php | 18 ++++++ app/View/SidebarSections/ChaptersShowTags.php | 22 +++++++ app/View/SidebarSections/PagesShowActions.php | 24 +++++++ .../SidebarSections/PagesShowAttachments.php | 22 +++++++ .../SidebarSections/PagesShowBookTree.php | 23 +++++++ app/View/SidebarSections/PagesShowDetails.php | 37 +++++++++++ app/View/SidebarSections/PagesShowPageNav.php | 26 ++++++++ app/View/SidebarSections/PagesShowTags.php | 22 +++++++ .../SidebarSections/ShelvesIndexActions.php | 18 ++++++ app/View/SidebarSections/ShelvesIndexNew.php | 29 +++++++++ .../SidebarSections/ShelvesIndexPopular.php | 24 +++++++ .../SidebarSections/ShelvesIndexRecents.php | 29 +++++++++ .../SidebarSections/ShelvesShowActions.php | 22 +++++++ .../SidebarSections/ShelvesShowActivity.php | 28 +++++++++ .../SidebarSections/ShelvesShowDetails.php | 30 +++++++++ app/View/SidebarSections/ShelvesShowTags.php | 18 ++++++ resources/views/chapters/show.blade.php | 13 ++-- resources/views/entities/book-tree.blade.php | 2 +- resources/views/pages/show.blade.php | 8 +-- resources/views/shelves/index.blade.php | 12 ++-- resources/views/shelves/show.blade.php | 10 +-- 29 files changed, 564 insertions(+), 66 deletions(-) create mode 100644 app/View/SidebarSections/ChaptersShowActions.php create mode 100644 app/View/SidebarSections/ChaptersShowBookTree.php create mode 100644 app/View/SidebarSections/ChaptersShowDetails.php create mode 100644 app/View/SidebarSections/ChaptersShowSearchForm.php create mode 100644 app/View/SidebarSections/ChaptersShowTags.php create mode 100644 app/View/SidebarSections/PagesShowActions.php create mode 100644 app/View/SidebarSections/PagesShowAttachments.php create mode 100644 app/View/SidebarSections/PagesShowBookTree.php create mode 100644 app/View/SidebarSections/PagesShowDetails.php create mode 100644 app/View/SidebarSections/PagesShowPageNav.php create mode 100644 app/View/SidebarSections/PagesShowTags.php create mode 100644 app/View/SidebarSections/ShelvesIndexActions.php create mode 100644 app/View/SidebarSections/ShelvesIndexNew.php create mode 100644 app/View/SidebarSections/ShelvesIndexPopular.php create mode 100644 app/View/SidebarSections/ShelvesIndexRecents.php create mode 100644 app/View/SidebarSections/ShelvesShowActions.php create mode 100644 app/View/SidebarSections/ShelvesShowActivity.php create mode 100644 app/View/SidebarSections/ShelvesShowDetails.php create mode 100644 app/View/SidebarSections/ShelvesShowTags.php diff --git a/app/Entities/Controllers/BookshelfController.php b/app/Entities/Controllers/BookshelfController.php index 1e8b26b5156..a918c48f185 100644 --- a/app/Entities/Controllers/BookshelfController.php +++ b/app/Entities/Controllers/BookshelfController.php @@ -2,7 +2,6 @@ namespace BookStack\Entities\Controllers; -use BookStack\Activity\ActivityQueries; use BookStack\Activity\Models\View; use BookStack\Entities\Queries\BookQueries; use BookStack\Entities\Queries\BookshelfQueries; @@ -13,7 +12,6 @@ use BookStack\Exceptions\NotFoundException; use BookStack\Http\Controller; use BookStack\Permissions\Permission; -use BookStack\References\ReferenceFetcher; use BookStack\Util\SimpleListOptions; use Exception; use Illuminate\Http\Request; @@ -27,7 +25,6 @@ public function __construct( protected EntityQueries $entityQueries, protected BookQueries $bookQueries, protected ShelfContext $shelfContext, - protected ReferenceFetcher $referenceFetcher, ) { } @@ -46,21 +43,12 @@ public function index(Request $request) $shelves = $this->queries->visibleForListWithCover() ->orderBy($listOptions->getSort(), $listOptions->getOrder()) ->paginate(setting()->getInteger('lists-page-count-shelves', 18, 1, 1000)); - $recents = $this->isSignedIn() ? $this->queries->recentlyViewedForCurrentUser()->get() : false; - $popular = $this->queries->popularForList()->get(); - $new = $this->queries->visibleForList() - ->orderBy('created_at', 'desc') - ->take(4) - ->get(); $this->shelfContext->clearShelfContext(); $this->setPageTitle(trans('entities.shelves')); return view('shelves.index', [ 'shelves' => $shelves, - 'recents' => $recents, - 'popular' => $popular, - 'new' => $new, 'view' => $view, 'listOptions' => $listOptions, ]); @@ -105,7 +93,7 @@ public function store(Request $request) * * @throws NotFoundException */ - public function show(Request $request, ActivityQueries $activities, string $slug) + public function show(Request $request, string $slug) { try { $shelf = $this->queries->findVisibleBySlugOrFail($slug); @@ -144,9 +132,7 @@ public function show(Request $request, ActivityQueries $activities, string $slug 'shelf' => $shelf, 'sortedVisibleShelfBooks' => $sortedVisibleShelfBooks, 'view' => $view, - 'activity' => $activities->entityActivity($shelf, 20, 1), 'listOptions' => $listOptions, - 'referenceCount' => $this->referenceFetcher->getReferenceCountToEntity($shelf), ]); } diff --git a/app/Entities/Controllers/ChapterController.php b/app/Entities/Controllers/ChapterController.php index db2391599ab..c089d357512 100644 --- a/app/Entities/Controllers/ChapterController.php +++ b/app/Entities/Controllers/ChapterController.php @@ -3,7 +3,6 @@ namespace BookStack\Entities\Controllers; use BookStack\Activity\Models\View; -use BookStack\Activity\Tools\UserEntityWatchOptions; use BookStack\Entities\Models\Book; use BookStack\Entities\Queries\ChapterQueries; use BookStack\Entities\Queries\EntityQueries; @@ -18,7 +17,6 @@ use BookStack\Exceptions\PermissionsException; use BookStack\Http\Controller; use BookStack\Permissions\Permission; -use BookStack\References\ReferenceFetcher; use BookStack\Util\DatabaseTransaction; use Illuminate\Http\Request; use Illuminate\Validation\ValidationException; @@ -30,7 +28,6 @@ public function __construct( protected ChapterRepo $chapterRepo, protected ChapterQueries $queries, protected EntityQueries $entityQueries, - protected ReferenceFetcher $referenceFetcher, ) { } @@ -87,10 +84,10 @@ public function show(string $bookSlug, string $chapterSlug) return redirect($chapter->getUrl()); } - $sidebarTree = (new BookContents($chapter->book))->getTree(); $pages = $this->entityQueries->pages->visibleForChapterList($chapter->id)->get(); - $nextPreviousLocator = new NextPreviousContentLocator($chapter, $sidebarTree); + $bookTree = (new BookContents($chapter->book))->getTree(); + $nextPreviousLocator = new NextPreviousContentLocator($chapter, $bookTree); View::incrementFor($chapter); $this->setPageTitle($chapter->getShortName()); @@ -99,12 +96,10 @@ public function show(string $bookSlug, string $chapterSlug) 'book' => $chapter->book, 'chapter' => $chapter, 'current' => $chapter, - 'sidebarTree' => $sidebarTree, - 'watchOptions' => new UserEntityWatchOptions(user(), $chapter), 'pages' => $pages, 'next' => $nextPreviousLocator->getNext(), 'previous' => $nextPreviousLocator->getPrevious(), - 'referenceCount' => $this->referenceFetcher->getReferenceCountToEntity($chapter), + 'bookTree' => $bookTree, ]); } diff --git a/app/Entities/Controllers/PageController.php b/app/Entities/Controllers/PageController.php index 82edfbc2763..ec3affc60a9 100644 --- a/app/Entities/Controllers/PageController.php +++ b/app/Entities/Controllers/PageController.php @@ -4,7 +4,6 @@ use BookStack\Activity\Models\View; use BookStack\Activity\Tools\CommentTree; -use BookStack\Activity\Tools\UserEntityWatchOptions; use BookStack\Entities\Models\Book; use BookStack\Entities\Models\Chapter; use BookStack\Entities\Queries\EntityQueries; @@ -20,7 +19,6 @@ use BookStack\Exceptions\PermissionsException; use BookStack\Http\Controller; use BookStack\Permissions\Permission; -use BookStack\References\ReferenceFetcher; use BookStack\Util\HtmlContentFilter; use BookStack\Util\HtmlContentFilterConfig; use Exception; @@ -35,7 +33,6 @@ public function __construct( protected PageRepo $pageRepo, protected PageQueries $queries, protected EntityQueries $entityQueries, - protected ReferenceFetcher $referenceFetcher ) { } @@ -151,11 +148,10 @@ public function show(string $bookSlug, string $pageSlug) $pageContent = (new PageContent($page)); $page->html = $pageContent->render(); - $pageNav = $pageContent->getNavigation($page->html); - $sidebarTree = (new BookContents($page->book))->getTree(); + $bookTree = (new BookContents($page->book))->getTree(); $commentTree = (new CommentTree($page)); - $nextPreviousLocator = new NextPreviousContentLocator($page, $sidebarTree); + $nextPreviousLocator = new NextPreviousContentLocator($page, $bookTree); View::incrementFor($page); $this->setPageTitle($page->getShortName()); @@ -164,13 +160,10 @@ public function show(string $bookSlug, string $pageSlug) 'page' => $page, 'book' => $page->book, 'current' => $page, - 'sidebarTree' => $sidebarTree, + 'bookTree' => $bookTree, 'commentTree' => $commentTree, - 'pageNav' => $pageNav, - 'watchOptions' => new UserEntityWatchOptions(user(), $page), 'next' => $nextPreviousLocator->getNext(), 'previous' => $nextPreviousLocator->getPrevious(), - 'referenceCount' => $this->referenceFetcher->getReferenceCountToEntity($page), ]); } diff --git a/app/View/SidebarSectionManager.php b/app/View/SidebarSectionManager.php index d83b7afb0ea..d0105fef396 100644 --- a/app/View/SidebarSectionManager.php +++ b/app/View/SidebarSectionManager.php @@ -12,6 +12,25 @@ use BookStack\View\SidebarSections\BooksShowSearchForm; use BookStack\View\SidebarSections\BooksShowShelves; use BookStack\View\SidebarSections\BooksShowTags; +use BookStack\View\SidebarSections\ChaptersShowActions; +use BookStack\View\SidebarSections\ChaptersShowBookTree; +use BookStack\View\SidebarSections\ChaptersShowDetails; +use BookStack\View\SidebarSections\ChaptersShowSearchForm; +use BookStack\View\SidebarSections\ChaptersShowTags; +use BookStack\View\SidebarSections\PagesShowActions; +use BookStack\View\SidebarSections\PagesShowAttachments; +use BookStack\View\SidebarSections\PagesShowBookTree; +use BookStack\View\SidebarSections\PagesShowDetails; +use BookStack\View\SidebarSections\PagesShowPageNav; +use BookStack\View\SidebarSections\PagesShowTags; +use BookStack\View\SidebarSections\ShelvesIndexActions; +use BookStack\View\SidebarSections\ShelvesIndexNew; +use BookStack\View\SidebarSections\ShelvesIndexPopular; +use BookStack\View\SidebarSections\ShelvesIndexRecents; +use BookStack\View\SidebarSections\ShelvesShowActions; +use BookStack\View\SidebarSections\ShelvesShowActivity; +use BookStack\View\SidebarSections\ShelvesShowDetails; +use BookStack\View\SidebarSections\ShelvesShowTags; use Illuminate\Contracts\Container\BindingResolutionException; class SidebarSectionManager @@ -20,6 +39,26 @@ class SidebarSectionManager * @var array[]>> */ protected array $sectionByLocation = [ + 'shelves-index' => [ + 'left' => [ + ShelvesIndexRecents::class, + ShelvesIndexPopular::class, + ShelvesIndexNew::class, + ], + 'right' => [ + ShelvesIndexActions::class, + ], + ], + 'shelves-show' => [ + 'left' => [ + ShelvesShowTags::class, + ShelvesShowDetails::class, + ShelvesShowActivity::class, + ], + 'right' => [ + ShelvesShowActions::class, + ], + ], 'books-index' => [ 'left' => [ BooksIndexRecents::class, @@ -42,6 +81,29 @@ class SidebarSectionManager BooksShowActions::class, ], ], + 'chapters-show' => [ + 'left' => [ + ChaptersShowSearchForm::class, + ChaptersShowTags::class, + ChaptersShowBookTree::class, + ], + 'right' => [ + ChaptersShowDetails::class, + ChaptersShowActions::class, + ], + ], + 'pages-show' => [ + 'left' => [ + PagesShowTags::class, + PagesShowAttachments::class, + PagesShowPageNav::class, + PagesShowBookTree::class, + ], + 'right' => [ + PagesShowDetails::class, + PagesShowActions::class, + ], + ], ]; /** diff --git a/app/View/SidebarSections/BooksIndexRecents.php b/app/View/SidebarSections/BooksIndexRecents.php index 485e6d431fc..dcc5c94deb3 100644 --- a/app/View/SidebarSections/BooksIndexRecents.php +++ b/app/View/SidebarSections/BooksIndexRecents.php @@ -17,8 +17,11 @@ public function __construct( public function withData(array $viewData, Request $request): array { - $userSignedIn = !user()->isGuest(); - $recents = $userSignedIn ? $this->queries->recentlyViewedForCurrentUser()->take(4)->get() : null; + $recents = null; + if (!user()->isGuest()) { + $recents = $this->queries->recentlyViewedForCurrentUser()->take(4)->get(); + } + return [ 'recents' => $recents, ]; diff --git a/app/View/SidebarSections/ChaptersShowActions.php b/app/View/SidebarSections/ChaptersShowActions.php new file mode 100644 index 00000000000..91e990d2f72 --- /dev/null +++ b/app/View/SidebarSections/ChaptersShowActions.php @@ -0,0 +1,24 @@ + $chapter, + 'watchOptions' => new UserEntityWatchOptions(user(), $chapter), + ]; + } +} diff --git a/app/View/SidebarSections/ChaptersShowBookTree.php b/app/View/SidebarSections/ChaptersShowBookTree.php new file mode 100644 index 00000000000..d0de183f9a7 --- /dev/null +++ b/app/View/SidebarSections/ChaptersShowBookTree.php @@ -0,0 +1,23 @@ + $book, + 'bookTree' => $viewData['bookTree'], + ]; + } +} diff --git a/app/View/SidebarSections/ChaptersShowDetails.php b/app/View/SidebarSections/ChaptersShowDetails.php new file mode 100644 index 00000000000..1453ceb9da4 --- /dev/null +++ b/app/View/SidebarSections/ChaptersShowDetails.php @@ -0,0 +1,37 @@ +referenceFetcher->getReferenceCountToEntity($chapter); + + return [ + 'chapter' => $chapter, + 'book' => $book, + 'watchOptions' => new UserEntityWatchOptions(user(), $chapter), + 'referenceCount' => $referenceCount, + ]; + } +} diff --git a/app/View/SidebarSections/ChaptersShowSearchForm.php b/app/View/SidebarSections/ChaptersShowSearchForm.php new file mode 100644 index 00000000000..2ae71bc053e --- /dev/null +++ b/app/View/SidebarSections/ChaptersShowSearchForm.php @@ -0,0 +1,18 @@ + trans('entities.chapters_search_this'), + ]; + } +} diff --git a/app/View/SidebarSections/ChaptersShowTags.php b/app/View/SidebarSections/ChaptersShowTags.php new file mode 100644 index 00000000000..df806d1917f --- /dev/null +++ b/app/View/SidebarSections/ChaptersShowTags.php @@ -0,0 +1,22 @@ + $chapter, + ]; + } +} diff --git a/app/View/SidebarSections/PagesShowActions.php b/app/View/SidebarSections/PagesShowActions.php new file mode 100644 index 00000000000..de832e77561 --- /dev/null +++ b/app/View/SidebarSections/PagesShowActions.php @@ -0,0 +1,24 @@ + $page, + 'watchOptions' => new UserEntityWatchOptions(user(), $page), + ]; + } +} diff --git a/app/View/SidebarSections/PagesShowAttachments.php b/app/View/SidebarSections/PagesShowAttachments.php new file mode 100644 index 00000000000..ef1dec4a088 --- /dev/null +++ b/app/View/SidebarSections/PagesShowAttachments.php @@ -0,0 +1,22 @@ + $page, + ]; + } +} diff --git a/app/View/SidebarSections/PagesShowBookTree.php b/app/View/SidebarSections/PagesShowBookTree.php new file mode 100644 index 00000000000..3de85db491b --- /dev/null +++ b/app/View/SidebarSections/PagesShowBookTree.php @@ -0,0 +1,23 @@ + $book, + 'bookTree' => $viewData['bookTree'], + ]; + } +} diff --git a/app/View/SidebarSections/PagesShowDetails.php b/app/View/SidebarSections/PagesShowDetails.php new file mode 100644 index 00000000000..e8ddfd34184 --- /dev/null +++ b/app/View/SidebarSections/PagesShowDetails.php @@ -0,0 +1,37 @@ +referenceFetcher->getReferenceCountToEntity($page); + + return [ + 'page' => $page, + 'book' => $book, + 'watchOptions' => new UserEntityWatchOptions(user(), $page), + 'referenceCount' => $referenceCount, + ]; + } +} diff --git a/app/View/SidebarSections/PagesShowPageNav.php b/app/View/SidebarSections/PagesShowPageNav.php new file mode 100644 index 00000000000..6f9d96652bf --- /dev/null +++ b/app/View/SidebarSections/PagesShowPageNav.php @@ -0,0 +1,26 @@ +getNavigation($page->html); + + return [ + 'pageNav' => $pageNav, + ]; + } +} diff --git a/app/View/SidebarSections/PagesShowTags.php b/app/View/SidebarSections/PagesShowTags.php new file mode 100644 index 00000000000..5fa46dc1726 --- /dev/null +++ b/app/View/SidebarSections/PagesShowTags.php @@ -0,0 +1,22 @@ + $page, + ]; + } +} diff --git a/app/View/SidebarSections/ShelvesIndexActions.php b/app/View/SidebarSections/ShelvesIndexActions.php new file mode 100644 index 00000000000..f15feecbe81 --- /dev/null +++ b/app/View/SidebarSections/ShelvesIndexActions.php @@ -0,0 +1,18 @@ + $viewData['view'], + ]; + } +} diff --git a/app/View/SidebarSections/ShelvesIndexNew.php b/app/View/SidebarSections/ShelvesIndexNew.php new file mode 100644 index 00000000000..90fda49852f --- /dev/null +++ b/app/View/SidebarSections/ShelvesIndexNew.php @@ -0,0 +1,29 @@ +queries->visibleForList() + ->orderBy('created_at', 'desc') + ->take(4) + ->get(); + + return [ + 'new' => $new, + ]; + } +} diff --git a/app/View/SidebarSections/ShelvesIndexPopular.php b/app/View/SidebarSections/ShelvesIndexPopular.php new file mode 100644 index 00000000000..4860b8c71e7 --- /dev/null +++ b/app/View/SidebarSections/ShelvesIndexPopular.php @@ -0,0 +1,24 @@ + $this->queries->popularForList()->take(4)->get(), + ]; + } +} diff --git a/app/View/SidebarSections/ShelvesIndexRecents.php b/app/View/SidebarSections/ShelvesIndexRecents.php new file mode 100644 index 00000000000..72b6430eb92 --- /dev/null +++ b/app/View/SidebarSections/ShelvesIndexRecents.php @@ -0,0 +1,29 @@ +isGuest()) { + $recents = $this->queries->recentlyViewedForCurrentUser()->take(4)->get(); + } + + return [ + 'recents' => $recents, + ]; + } +} diff --git a/app/View/SidebarSections/ShelvesShowActions.php b/app/View/SidebarSections/ShelvesShowActions.php new file mode 100644 index 00000000000..b28abab6fdd --- /dev/null +++ b/app/View/SidebarSections/ShelvesShowActions.php @@ -0,0 +1,22 @@ + $shelf, + ]; + } +} diff --git a/app/View/SidebarSections/ShelvesShowActivity.php b/app/View/SidebarSections/ShelvesShowActivity.php new file mode 100644 index 00000000000..90de335e22b --- /dev/null +++ b/app/View/SidebarSections/ShelvesShowActivity.php @@ -0,0 +1,28 @@ + $this->activityQueries->entityActivity($shelf, 20, 1), + ]; + } +} diff --git a/app/View/SidebarSections/ShelvesShowDetails.php b/app/View/SidebarSections/ShelvesShowDetails.php new file mode 100644 index 00000000000..62dc9bab2db --- /dev/null +++ b/app/View/SidebarSections/ShelvesShowDetails.php @@ -0,0 +1,30 @@ +referenceFetcher->getReferenceCountToEntity($shelf); + + return [ + 'shelf' => $shelf, + 'referenceCount' => $referenceCount, + ]; + } +} diff --git a/app/View/SidebarSections/ShelvesShowTags.php b/app/View/SidebarSections/ShelvesShowTags.php new file mode 100644 index 00000000000..7c02c50fcc5 --- /dev/null +++ b/app/View/SidebarSections/ShelvesShowTags.php @@ -0,0 +1,18 @@ + $viewData['book'], + ]; + } +} diff --git a/resources/views/chapters/show.blade.php b/resources/views/chapters/show.blade.php index 7ef877661c0..569d901f66a 100644 --- a/resources/views/chapters/show.blade.php +++ b/resources/views/chapters/show.blade.php @@ -62,15 +62,10 @@ @stop -@section('right') - @include('chapters.parts.show-sidebar-section-details', ['chapter' => $chapter, 'book' => $book, 'watchOptions' => $watchOptions]) - @include('chapters.parts.show-sidebar-section-actions', ['chapter' => $chapter, 'watchOptions' => $watchOptions]) -@stop - @section('left') - @include('entities.search-form', ['label' => trans('entities.chapters_search_this')]) - @include('chapters.parts.show-sidebar-section-tags', ['chapter' => $chapter]) - @include('entities.book-tree', ['book' => $book, 'sidebarTree' => $sidebarTree]) + @include('common.sidebar-sections', ['location' => 'chapters-show', 'position' => 'left']) @stop - +@section('right') + @include('common.sidebar-sections', ['location' => 'chapters-show', 'position' => 'right']) +@stop diff --git a/resources/views/entities/book-tree.blade.php b/resources/views/entities/book-tree.blade.php index c95b1eebc43..81dbd302e2b 100644 --- a/resources/views/entities/book-tree.blade.php +++ b/resources/views/entities/book-tree.blade.php @@ -11,7 +11,7 @@ class="book-tree mb-xl" @endif - @foreach($sidebarTree as $bookChild) + @foreach($bookTree as $bookChild)
  • @include('entities.list-item-basic', ['entity' => $bookChild, 'classes' => $current->matches($bookChild)? 'selected' : '']) diff --git a/resources/views/pages/show.blade.php b/resources/views/pages/show.blade.php index d34bfc6aee5..08d01973d45 100644 --- a/resources/views/pages/show.blade.php +++ b/resources/views/pages/show.blade.php @@ -36,13 +36,9 @@ class="page-content clearfix"> @stop @section('left') - @include('pages.parts.show-sidebar-section-tags', ['page' => $page]) - @include('pages.parts.show-sidebar-section-attachments', ['page' => $page]) - @include('pages.parts.show-sidebar-section-page-nav', ['pageNav' => $pageNav]) - @include('entities.book-tree', ['book' => $book, 'sidebarTree' => $sidebarTree]) + @include('common.sidebar-sections', ['location' => 'pages-show', 'position' => 'left']) @stop @section('right') - @include('pages.parts.show-sidebar-section-details', ['page' => $page, 'watchOptions' => $watchOptions, 'book' => $book]) - @include('pages.parts.show-sidebar-section-actions', ['page' => $page, 'watchOptions' => $watchOptions]) + @include('common.sidebar-sections', ['location' => 'pages-show', 'position' => 'right']) @stop diff --git a/resources/views/shelves/index.blade.php b/resources/views/shelves/index.blade.php index 70357068d7e..2fc78fa50c9 100644 --- a/resources/views/shelves/index.blade.php +++ b/resources/views/shelves/index.blade.php @@ -4,12 +4,10 @@ @include('shelves.parts.list', ['shelves' => $shelves, 'view' => $view, 'listOptions' => $listOptions]) @stop -@section('right') - @include('shelves.parts.index-sidebar-section-actions', ['view' => $view]) +@section('left') + @include('common.sidebar-sections', ['location' => 'shelves-index', 'position' => 'left']) @stop -@section('left') - @include('shelves.parts.index-sidebar-section-recents', ['recents' => $recents]) - @include('shelves.parts.index-sidebar-section-popular', ['popular' => $popular]) - @include('shelves.parts.index-sidebar-section-new', ['new' => $new]) -@stop \ No newline at end of file +@section('right') + @include('common.sidebar-sections', ['location' => 'shelves-index', 'position' => 'right']) +@stop diff --git a/resources/views/shelves/show.blade.php b/resources/views/shelves/show.blade.php index 9d07e5da018..320e1066c6c 100644 --- a/resources/views/shelves/show.blade.php +++ b/resources/views/shelves/show.blade.php @@ -69,15 +69,9 @@ @stop @section('left') - @include('shelves.parts.show-sidebar-section-tags', ['shelf' => $shelf]) - @include('shelves.parts.show-sidebar-section-details', ['shelf' => $shelf]) - @include('shelves.parts.show-sidebar-section-activity', ['activity' => $activity]) + @include('common.sidebar-sections', ['location' => 'shelves-show', 'position' => 'left']) @stop @section('right') - @include('shelves.parts.show-sidebar-section-actions', ['shelf' => $shelf, 'view' => $view]) + @include('common.sidebar-sections', ['location' => 'shelves-show', 'position' => 'right']) @stop - - - - From d4d90cc39c803f10f27bf8501088b116bcfc8d6c Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Fri, 7 Aug 2026 16:00:04 +0100 Subject: [PATCH 07/37] Views: Renamed SidebarSections to ViewBlocks --- .../Providers/ViewTweaksServiceProvider.php | 4 +- app/View/SidebarSectionManager.php | 139 ------------------ .../{SidebarSection.php => ViewBlock.php} | 2 +- ...onInterface.php => ViewBlockInterface.php} | 4 +- app/View/ViewBlockManager.php | 139 ++++++++++++++++++ .../BooksIndexActions.php | 6 +- .../BooksIndexNew.php | 6 +- .../BooksIndexPopular.php | 6 +- .../BooksIndexRecents.php | 6 +- .../BooksShowActions.php | 6 +- .../BooksShowActivity.php | 6 +- .../BooksShowDetails.php | 6 +- .../BooksShowSearchForm.php | 6 +- .../BooksShowShelves.php | 6 +- .../BooksShowTags.php | 6 +- .../ChaptersShowActions.php | 6 +- .../ChaptersShowBookTree.php | 6 +- .../ChaptersShowDetails.php | 6 +- .../ChaptersShowSearchForm.php | 6 +- .../ChaptersShowTags.php | 6 +- .../PagesShowActions.php | 6 +- .../PagesShowAttachments.php | 6 +- .../PagesShowBookTree.php | 6 +- .../PagesShowDetails.php | 6 +- .../PagesShowPageNav.php | 6 +- .../PagesShowTags.php | 6 +- .../ShelvesIndexActions.php | 6 +- .../ShelvesIndexNew.php | 6 +- .../ShelvesIndexPopular.php | 6 +- .../ShelvesIndexRecents.php | 6 +- .../ShelvesShowActions.php | 6 +- .../ShelvesShowActivity.php | 6 +- .../ShelvesShowDetails.php | 6 +- .../ShelvesShowTags.php | 6 +- .../views/common/sidebar-sections.blade.php | 2 +- 35 files changed, 232 insertions(+), 232 deletions(-) delete mode 100644 app/View/SidebarSectionManager.php rename app/View/{SidebarSection.php => ViewBlock.php} (73%) rename app/View/{SidebarSectionInterface.php => ViewBlockInterface.php} (82%) create mode 100644 app/View/ViewBlockManager.php rename app/View/{SidebarSections => ViewBlocks}/BooksIndexActions.php (68%) rename app/View/{SidebarSections => ViewBlocks}/BooksIndexNew.php (81%) rename app/View/{SidebarSections => ViewBlocks}/BooksIndexPopular.php (77%) rename app/View/{SidebarSections => ViewBlocks}/BooksIndexRecents.php (81%) rename app/View/{SidebarSections => ViewBlocks}/BooksShowActions.php (79%) rename app/View/{SidebarSections => ViewBlocks}/BooksShowActivity.php (81%) rename app/View/{SidebarSections => ViewBlocks}/BooksShowDetails.php (86%) rename app/View/{SidebarSections => ViewBlocks}/BooksShowSearchForm.php (67%) rename app/View/{SidebarSections => ViewBlocks}/BooksShowShelves.php (77%) rename app/View/{SidebarSections => ViewBlocks}/BooksShowTags.php (68%) rename app/View/{SidebarSections => ViewBlocks}/ChaptersShowActions.php (80%) rename app/View/{SidebarSections => ViewBlocks}/ChaptersShowBookTree.php (75%) rename app/View/{SidebarSections => ViewBlocks}/ChaptersShowDetails.php (88%) rename app/View/{SidebarSections => ViewBlocks}/ChaptersShowSearchForm.php (67%) rename app/View/{SidebarSections => ViewBlocks}/ChaptersShowTags.php (75%) rename app/View/{SidebarSections => ViewBlocks}/PagesShowActions.php (79%) rename app/View/{SidebarSections => ViewBlocks}/PagesShowAttachments.php (74%) rename app/View/{SidebarSections => ViewBlocks}/PagesShowBookTree.php (75%) rename app/View/{SidebarSections => ViewBlocks}/PagesShowDetails.php (87%) rename app/View/{SidebarSections => ViewBlocks}/PagesShowPageNav.php (80%) rename app/View/{SidebarSections => ViewBlocks}/PagesShowTags.php (74%) rename app/View/{SidebarSections => ViewBlocks}/ShelvesIndexActions.php (68%) rename app/View/{SidebarSections => ViewBlocks}/ShelvesIndexNew.php (81%) rename app/View/{SidebarSections => ViewBlocks}/ShelvesIndexPopular.php (78%) rename app/View/{SidebarSections => ViewBlocks}/ShelvesIndexRecents.php (81%) rename app/View/{SidebarSections => ViewBlocks}/ShelvesShowActions.php (75%) rename app/View/{SidebarSections => ViewBlocks}/ShelvesShowActivity.php (81%) rename app/View/{SidebarSections => ViewBlocks}/ShelvesShowDetails.php (83%) rename app/View/{SidebarSections => ViewBlocks}/ShelvesShowTags.php (68%) diff --git a/app/App/Providers/ViewTweaksServiceProvider.php b/app/App/Providers/ViewTweaksServiceProvider.php index d2d45abcc5d..0c68aa1c00f 100644 --- a/app/App/Providers/ViewTweaksServiceProvider.php +++ b/app/App/Providers/ViewTweaksServiceProvider.php @@ -4,7 +4,7 @@ use BookStack\Entities\BreadcrumbsViewComposer; use BookStack\Util\DateFormatter; -use BookStack\View\SidebarSectionManager; +use BookStack\View\ViewBlockManager; use Illuminate\Pagination\Paginator; use Illuminate\Support\Facades\Blade; use Illuminate\Support\Facades\View; @@ -34,7 +34,7 @@ public function boot(): void // View Globals View::share('dates', $this->app->make(DateFormatter::class)); - View::share('sidebar', $this->app->make(SidebarSectionManager::class)); + View::share('viewBlocks', $this->app->make(ViewBlockManager::class)); // Custom blade view directives Blade::directive('icon', function ($expression) { diff --git a/app/View/SidebarSectionManager.php b/app/View/SidebarSectionManager.php deleted file mode 100644 index d0105fef396..00000000000 --- a/app/View/SidebarSectionManager.php +++ /dev/null @@ -1,139 +0,0 @@ -[]>> - */ - protected array $sectionByLocation = [ - 'shelves-index' => [ - 'left' => [ - ShelvesIndexRecents::class, - ShelvesIndexPopular::class, - ShelvesIndexNew::class, - ], - 'right' => [ - ShelvesIndexActions::class, - ], - ], - 'shelves-show' => [ - 'left' => [ - ShelvesShowTags::class, - ShelvesShowDetails::class, - ShelvesShowActivity::class, - ], - 'right' => [ - ShelvesShowActions::class, - ], - ], - 'books-index' => [ - 'left' => [ - BooksIndexRecents::class, - BooksIndexPopular::class, - BooksIndexNew::class, - ], - 'right' => [ - BooksIndexActions::class, - ], - ], - 'books-show' => [ - 'left' => [ - BooksShowSearchForm::class, - BooksShowTags::class, - BooksShowShelves::class, - BooksShowActivity::class, - ], - 'right' => [ - BooksShowDetails::class, - BooksShowActions::class, - ], - ], - 'chapters-show' => [ - 'left' => [ - ChaptersShowSearchForm::class, - ChaptersShowTags::class, - ChaptersShowBookTree::class, - ], - 'right' => [ - ChaptersShowDetails::class, - ChaptersShowActions::class, - ], - ], - 'pages-show' => [ - 'left' => [ - PagesShowTags::class, - PagesShowAttachments::class, - PagesShowPageNav::class, - PagesShowBookTree::class, - ], - 'right' => [ - PagesShowDetails::class, - PagesShowActions::class, - ], - ], - ]; - - /** - * Register a sidebar section to be displayed at the given location and position. - * @param class-string $sectionClass - */ - public function register(string $location, string $position, string $sectionClass): void - { - if (!isset($this->sectionByLocation[$location])) { - $this->sectionByLocation[$location] = []; - } - - if (!isset($this->sectionByLocation[$location][$position])) { - $this->sectionByLocation[$location][$position] = []; - } - - $this->sectionByLocation[$location][$position][] = $sectionClass; - } - - /** - * Get all sidebar sections registered for a given location. - * - * @return SidebarSectionInterface[] - * @throws BindingResolutionException - */ - public function getSectionsForLocation(string $location, string $position): array - { - $sections = array_unique($this->sectionByLocation[$location][$position] ?? []); - return array_map(function (string $className) { - return app()->make($className); - }, $sections); - } -} diff --git a/app/View/SidebarSection.php b/app/View/ViewBlock.php similarity index 73% rename from app/View/SidebarSection.php rename to app/View/ViewBlock.php index 68e1aa29193..a835e70754e 100644 --- a/app/View/SidebarSection.php +++ b/app/View/ViewBlock.php @@ -2,7 +2,7 @@ namespace BookStack\View; -abstract class SidebarSection implements SidebarSectionInterface +abstract class ViewBlock implements ViewBlockInterface { protected string $view; diff --git a/app/View/SidebarSectionInterface.php b/app/View/ViewBlockInterface.php similarity index 82% rename from app/View/SidebarSectionInterface.php rename to app/View/ViewBlockInterface.php index 84032ab6174..b9c25e9f65f 100644 --- a/app/View/SidebarSectionInterface.php +++ b/app/View/ViewBlockInterface.php @@ -4,10 +4,10 @@ use Illuminate\Http\Request; -interface SidebarSectionInterface +interface ViewBlockInterface { /** - * Get the view to render for this section. + * Get the view to render for this block. */ public function getView(): string; diff --git a/app/View/ViewBlockManager.php b/app/View/ViewBlockManager.php new file mode 100644 index 00000000000..88d86613587 --- /dev/null +++ b/app/View/ViewBlockManager.php @@ -0,0 +1,139 @@ +[]>> + */ + protected array $blocksByLocationAndPosition = [ + 'shelves-index' => [ + 'left' => [ + ShelvesIndexRecents::class, + ShelvesIndexPopular::class, + ShelvesIndexNew::class, + ], + 'right' => [ + ShelvesIndexActions::class, + ], + ], + 'shelves-show' => [ + 'left' => [ + ShelvesShowTags::class, + ShelvesShowDetails::class, + ShelvesShowActivity::class, + ], + 'right' => [ + ShelvesShowActions::class, + ], + ], + 'books-index' => [ + 'left' => [ + BooksIndexRecents::class, + BooksIndexPopular::class, + BooksIndexNew::class, + ], + 'right' => [ + BooksIndexActions::class, + ], + ], + 'books-show' => [ + 'left' => [ + BooksShowSearchForm::class, + BooksShowTags::class, + BooksShowShelves::class, + BooksShowActivity::class, + ], + 'right' => [ + BooksShowDetails::class, + BooksShowActions::class, + ], + ], + 'chapters-show' => [ + 'left' => [ + ChaptersShowSearchForm::class, + ChaptersShowTags::class, + ChaptersShowBookTree::class, + ], + 'right' => [ + ChaptersShowDetails::class, + ChaptersShowActions::class, + ], + ], + 'pages-show' => [ + 'left' => [ + PagesShowTags::class, + PagesShowAttachments::class, + PagesShowPageNav::class, + PagesShowBookTree::class, + ], + 'right' => [ + PagesShowDetails::class, + PagesShowActions::class, + ], + ], + ]; + + /** + * Register a block type to be displayed at the given location and position. + * @param class-string $blockClass + */ + public function register(string $location, string $position, string $blockClass): void + { + if (!isset($this->blocksByLocationAndPosition[$location])) { + $this->blocksByLocationAndPosition[$location] = []; + } + + if (!isset($this->blocksByLocationAndPosition[$location][$position])) { + $this->blocksByLocationAndPosition[$location][$position] = []; + } + + $this->blocksByLocationAndPosition[$location][$position][] = $blockClass; + } + + /** + * Get all blocks registered for a given location and position. + * + * @return ViewBlockInterface[] + * @throws BindingResolutionException + */ + public function getForLocation(string $location, string $position): array + { + $sections = array_unique($this->blocksByLocationAndPosition[$location][$position] ?? []); + return array_map(function (string $className) { + return app()->make($className); + }, $sections); + } +} diff --git a/app/View/SidebarSections/BooksIndexActions.php b/app/View/ViewBlocks/BooksIndexActions.php similarity index 68% rename from app/View/SidebarSections/BooksIndexActions.php rename to app/View/ViewBlocks/BooksIndexActions.php index 62f856a651b..fd290c601b1 100644 --- a/app/View/SidebarSections/BooksIndexActions.php +++ b/app/View/ViewBlocks/BooksIndexActions.php @@ -1,11 +1,11 @@ getSectionsForLocation($location, $position) as $section) +@foreach($viewBlocks->getForLocation($location, $position) as $section) @include($section->getView(), $section->withData($sectionVars, $sectionRequest)) @endforeach \ No newline at end of file From e3ebcb22508112f6e599151f3d134e93c5851209 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Sun, 9 Aug 2026 11:54:42 +0100 Subject: [PATCH 08/37] Views: Extracted homepage sections into their own views --- resources/views/home/default.blade.php | 57 ++----------------- .../default-card-recent-activity.blade.php | 6 ++ .../default-card-recent-drafts.blade.php | 11 ++++ ...ault-card-recently-updates-pages.blade.php | 16 ++++++ ...-recently-viewed-or-recent-books.blade.php | 14 +++++ .../default-card-top-favourites.blade.php | 15 +++++ .../sidebar-section-recent-activity.blade.php | 7 +++ .../sidebar-section-recent-drafts.blade.php | 9 +++ ...r-section-recently-updated-pages.blade.php | 14 +++++ ...-recently-viewed-or-recent-books.blade.php | 11 ++++ .../sidebar-section-top-favourites.blade.php | 13 +++++ resources/views/home/parts/sidebar.blade.php | 48 ++-------------- 12 files changed, 126 insertions(+), 95 deletions(-) create mode 100644 resources/views/home/parts/default-card-recent-activity.blade.php create mode 100644 resources/views/home/parts/default-card-recent-drafts.blade.php create mode 100644 resources/views/home/parts/default-card-recently-updates-pages.blade.php create mode 100644 resources/views/home/parts/default-card-recently-viewed-or-recent-books.blade.php create mode 100644 resources/views/home/parts/default-card-top-favourites.blade.php create mode 100644 resources/views/home/parts/sidebar-section-recent-activity.blade.php create mode 100644 resources/views/home/parts/sidebar-section-recent-drafts.blade.php create mode 100644 resources/views/home/parts/sidebar-section-recently-updated-pages.blade.php create mode 100644 resources/views/home/parts/sidebar-section-recently-viewed-or-recent-books.blade.php create mode 100644 resources/views/home/parts/sidebar-section-top-favourites.blade.php diff --git a/resources/views/home/default.blade.php b/resources/views/home/default.blade.php index a546ddecacb..7d229d6acc1 100644 --- a/resources/views/home/default.blade.php +++ b/resources/views/home/default.blade.php @@ -16,65 +16,18 @@
    - @if(count($draftPages) > 0) -
    -

    {{ trans('entities.my_recent_drafts') }}

    -
    - @include('entities.list', ['entities' => $draftPages, 'style' => 'compact']) -
    -
    - @endif - -
    -

    {{ trans('entities.' . (auth()->check() ? 'my_recently_viewed' : 'books_recent')) }}

    -
    - @include('entities.list', [ - 'entities' => $recents, - 'style' => 'compact', - 'emptyText' => auth()->check() ? trans('entities.no_pages_viewed') : trans('entities.books_empty') - ]) -
    -
    + @include('home.parts.default-card-recent-drafts', ['draftPages' => $draftPages]) + @include('home.parts.default-card-recently-viewed-or-recent-books', ['recents' => $recents])
    - @if(count($favourites) > 0) -
    -

    {{ trans('entities.my_most_viewed_favourites') }}

    -
    - @include('entities.list', [ - 'entities' => $favourites, - 'style' => 'compact', - ]) -
    - {{ trans('common.view_all') }} -
    - @endif - -
    -

    {{ trans('entities.recently_updated_pages') }}

    -
    - @include('entities.list', [ - 'entities' => $recentlyUpdatedPages, - 'style' => 'compact', - 'emptyText' => trans('entities.no_pages_recently_updated'), - ]) -
    - @if(count($recentlyUpdatedPages) > 0) - {{ trans('common.view_all') }} - @endif -
    + @include('home.parts.default-card-top-favourites', ['favourites' => $favourites]) + @include('home.parts.default-card-recently-updates-pages', ['recentlyUpdatedPages' => $recentlyUpdatedPages])
    -
    -

    {{ trans('entities.recent_activity') }}

    -
    - @include('common.activity-list', ['activity' => $activity]) -
    -
    + @include('home.parts.default-card-recent-activity', ['activity' => $activity])
    -
    diff --git a/resources/views/home/parts/default-card-recent-activity.blade.php b/resources/views/home/parts/default-card-recent-activity.blade.php new file mode 100644 index 00000000000..035cd998736 --- /dev/null +++ b/resources/views/home/parts/default-card-recent-activity.blade.php @@ -0,0 +1,6 @@ +
    +

    {{ trans('entities.recent_activity') }}

    +
    + @include('common.activity-list', ['activity' => $activity]) +
    +
    j \ No newline at end of file diff --git a/resources/views/home/parts/default-card-recent-drafts.blade.php b/resources/views/home/parts/default-card-recent-drafts.blade.php new file mode 100644 index 00000000000..d9d7a51304f --- /dev/null +++ b/resources/views/home/parts/default-card-recent-drafts.blade.php @@ -0,0 +1,11 @@ +{{-- +$draftPages - array +--}} +@if(count($draftPages) > 0) +
    +

    {{ trans('entities.my_recent_drafts') }}

    +
    + @include('entities.list', ['entities' => $draftPages, 'style' => 'compact']) +
    +
    +@endif diff --git a/resources/views/home/parts/default-card-recently-updates-pages.blade.php b/resources/views/home/parts/default-card-recently-updates-pages.blade.php new file mode 100644 index 00000000000..6e637d710d8 --- /dev/null +++ b/resources/views/home/parts/default-card-recently-updates-pages.blade.php @@ -0,0 +1,16 @@ +{{-- +$recentlyUpdatedPages - array +--}} +
    +

    {{ trans('entities.recently_updated_pages') }}

    +
    + @include('entities.list', [ + 'entities' => $recentlyUpdatedPages, + 'style' => 'compact', + 'emptyText' => trans('entities.no_pages_recently_updated'), + ]) +
    + @if(count($recentlyUpdatedPages) > 0) + {{ trans('common.view_all') }} + @endif +
    \ No newline at end of file diff --git a/resources/views/home/parts/default-card-recently-viewed-or-recent-books.blade.php b/resources/views/home/parts/default-card-recently-viewed-or-recent-books.blade.php new file mode 100644 index 00000000000..31bafaa2b02 --- /dev/null +++ b/resources/views/home/parts/default-card-recently-viewed-or-recent-books.blade.php @@ -0,0 +1,14 @@ +{{-- +$recents - array +--}} + +
    +

    {{ trans('entities.' . (auth()->check() ? 'my_recently_viewed' : 'books_recent')) }}

    +
    + @include('entities.list', [ + 'entities' => $recents, + 'style' => 'compact', + 'emptyText' => auth()->check() ? trans('entities.no_pages_viewed') : trans('entities.books_empty') + ]) +
    +
    \ No newline at end of file diff --git a/resources/views/home/parts/default-card-top-favourites.blade.php b/resources/views/home/parts/default-card-top-favourites.blade.php new file mode 100644 index 00000000000..81f3895c68a --- /dev/null +++ b/resources/views/home/parts/default-card-top-favourites.blade.php @@ -0,0 +1,15 @@ +{{-- +$favourites - array +--}} +@if(count($favourites) > 0) +
    +

    {{ trans('entities.my_most_viewed_favourites') }}

    +
    + @include('entities.list', [ + 'entities' => $favourites, + 'style' => 'compact', + ]) +
    + {{ trans('common.view_all') }} +
    +@endif \ No newline at end of file diff --git a/resources/views/home/parts/sidebar-section-recent-activity.blade.php b/resources/views/home/parts/sidebar-section-recent-activity.blade.php new file mode 100644 index 00000000000..8a82f90061f --- /dev/null +++ b/resources/views/home/parts/sidebar-section-recent-activity.blade.php @@ -0,0 +1,7 @@ +{{-- +$activity - array +--}} +
    +
    {{ trans('entities.recent_activity') }}
    + @include('common.activity-list', ['activity' => $activity]) +
    \ No newline at end of file diff --git a/resources/views/home/parts/sidebar-section-recent-drafts.blade.php b/resources/views/home/parts/sidebar-section-recent-drafts.blade.php new file mode 100644 index 00000000000..648f541556d --- /dev/null +++ b/resources/views/home/parts/sidebar-section-recent-drafts.blade.php @@ -0,0 +1,9 @@ +{{-- +$draftPages - array +--}} +@if(count($draftPages) > 0) +
    +
    {{ trans('entities.my_recent_drafts') }}
    + @include('entities.list', ['entities' => $draftPages, 'style' => 'compact']) +
    +@endif \ No newline at end of file diff --git a/resources/views/home/parts/sidebar-section-recently-updated-pages.blade.php b/resources/views/home/parts/sidebar-section-recently-updated-pages.blade.php new file mode 100644 index 00000000000..290c385a169 --- /dev/null +++ b/resources/views/home/parts/sidebar-section-recently-updated-pages.blade.php @@ -0,0 +1,14 @@ +{{-- +$recentlyUpdatedPages - array +--}} +
    +
    {{ trans('entities.recently_updated_pages') }}
    +
    + @include('entities.list', [ + 'entities' => $recentlyUpdatedPages, + 'style' => 'compact', + 'emptyText' => trans('entities.no_pages_recently_updated') + ]) +
    + {{ trans('common.view_all') }} +
    \ No newline at end of file diff --git a/resources/views/home/parts/sidebar-section-recently-viewed-or-recent-books.blade.php b/resources/views/home/parts/sidebar-section-recently-viewed-or-recent-books.blade.php new file mode 100644 index 00000000000..d9c6edea811 --- /dev/null +++ b/resources/views/home/parts/sidebar-section-recently-viewed-or-recent-books.blade.php @@ -0,0 +1,11 @@ +{{-- +$recents - array +--}} +
    +
    {{ trans('entities.' . (auth()->check() ? 'my_recently_viewed' : 'books_recent')) }}
    + @include('entities.list', [ + 'entities' => $recents, + 'style' => 'compact', + 'emptyText' => auth()->check() ? trans('entities.no_pages_viewed') : trans('entities.books_empty') + ]) +
    \ No newline at end of file diff --git a/resources/views/home/parts/sidebar-section-top-favourites.blade.php b/resources/views/home/parts/sidebar-section-top-favourites.blade.php new file mode 100644 index 00000000000..09b33b17655 --- /dev/null +++ b/resources/views/home/parts/sidebar-section-top-favourites.blade.php @@ -0,0 +1,13 @@ +{{-- +$favourites - array +--}} +@if(count($favourites) > 0) +
    +
    {{ trans('entities.my_most_viewed_favourites') }}
    + @include('entities.list', [ + 'entities' => $favourites, + 'style' => 'compact', + ]) + {{ trans('common.view_all') }} +
    +@endif \ No newline at end of file diff --git a/resources/views/home/parts/sidebar.blade.php b/resources/views/home/parts/sidebar.blade.php index 78f7e7a8085..07c199f9e68 100644 --- a/resources/views/home/parts/sidebar.blade.php +++ b/resources/views/home/parts/sidebar.blade.php @@ -1,43 +1,5 @@ -@if(count($draftPages) > 0) -
    -
    {{ trans('entities.my_recent_drafts') }}
    - @include('entities.list', ['entities' => $draftPages, 'style' => 'compact']) -
    -@endif - -@if(count($favourites) > 0) -
    -
    {{ trans('entities.my_most_viewed_favourites') }}
    - @include('entities.list', [ - 'entities' => $favourites, - 'style' => 'compact', - ]) - {{ trans('common.view_all') }} -
    -@endif - -
    -
    {{ trans('entities.' . (auth()->check() ? 'my_recently_viewed' : 'books_recent')) }}
    - @include('entities.list', [ - 'entities' => $recents, - 'style' => 'compact', - 'emptyText' => auth()->check() ? trans('entities.no_pages_viewed') : trans('entities.books_empty') - ]) -
    - -
    -
    {{ trans('entities.recently_updated_pages') }}
    -
    - @include('entities.list', [ - 'entities' => $recentlyUpdatedPages, - 'style' => 'compact', - 'emptyText' => trans('entities.no_pages_recently_updated') - ]) -
    - {{ trans('common.view_all') }} -
    - -
    -
    {{ trans('entities.recent_activity') }}
    - @include('common.activity-list', ['activity' => $activity]) -
    \ No newline at end of file +@include('home.parts.sidebar-section-recent-drafts', ['draftPages' => $draftPages]) +@include('home.parts.sidebar-section-top-favourites', ['favourites' => $favourites]) +@include('home.parts.sidebar-section-recently-viewed-or-recent-books', ['recents' => $recents]) +@include('home.parts.sidebar-section-recently-updated-pages', ['recentlyUpdatedPages' => $recentlyUpdatedPages]) +@include('home.parts.sidebar-section-recent-activity', ['activity' => $activity]) \ No newline at end of file From 600497b1109d65c3c3c7853dc3a924b75e6e124b Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Sun, 9 Aug 2026 15:12:07 +0100 Subject: [PATCH 09/37] Views: Extracted home view sections into blocks Also removed unused request from block interface. --- app/App/HomeController.php | 51 ++++--------------- app/View/ViewBlock.php | 2 +- app/View/ViewBlockInterface.php | 7 ++- app/View/ViewBlockManager.php | 31 +++++++++++ app/View/ViewBlocks/BooksIndexActions.php | 2 +- app/View/ViewBlocks/BooksIndexNew.php | 2 +- app/View/ViewBlocks/BooksIndexPopular.php | 2 +- app/View/ViewBlocks/BooksIndexRecents.php | 2 +- app/View/ViewBlocks/BooksShowActions.php | 2 +- app/View/ViewBlocks/BooksShowActivity.php | 2 +- app/View/ViewBlocks/BooksShowDetails.php | 2 +- app/View/ViewBlocks/BooksShowSearchForm.php | 2 +- app/View/ViewBlocks/BooksShowShelves.php | 2 +- app/View/ViewBlocks/BooksShowTags.php | 2 +- app/View/ViewBlocks/ChaptersShowActions.php | 2 +- app/View/ViewBlocks/ChaptersShowBookTree.php | 2 +- app/View/ViewBlocks/ChaptersShowDetails.php | 2 +- .../ViewBlocks/ChaptersShowSearchForm.php | 2 +- app/View/ViewBlocks/ChaptersShowTags.php | 2 +- app/View/ViewBlocks/HomeActions.php | 19 +++++++ app/View/ViewBlocks/HomeRecentActivity.php | 32 ++++++++++++ app/View/ViewBlocks/HomeRecentDrafts.php | 40 +++++++++++++++ .../ViewBlocks/HomeRecentlyUpdatedPages.php | 37 ++++++++++++++ .../HomeRecentlyViewedOrRecentBooks.php | 43 ++++++++++++++++ app/View/ViewBlocks/HomeTopFavourites.php | 32 ++++++++++++ app/View/ViewBlocks/PagesShowActions.php | 2 +- app/View/ViewBlocks/PagesShowAttachments.php | 2 +- app/View/ViewBlocks/PagesShowBookTree.php | 2 +- app/View/ViewBlocks/PagesShowDetails.php | 2 +- app/View/ViewBlocks/PagesShowPageNav.php | 2 +- app/View/ViewBlocks/PagesShowTags.php | 2 +- app/View/ViewBlocks/ShelvesIndexActions.php | 2 +- app/View/ViewBlocks/ShelvesIndexNew.php | 2 +- app/View/ViewBlocks/ShelvesIndexPopular.php | 2 +- app/View/ViewBlocks/ShelvesIndexRecents.php | 2 +- app/View/ViewBlocks/ShelvesShowActions.php | 2 +- app/View/ViewBlocks/ShelvesShowActivity.php | 2 +- app/View/ViewBlocks/ShelvesShowDetails.php | 2 +- app/View/ViewBlocks/ShelvesShowTags.php | 2 +- resources/views/books/index.blade.php | 4 +- resources/views/books/show.blade.php | 4 +- resources/views/chapters/show.blade.php | 4 +- ...ctions.blade.php => view-blocks.blade.php} | 3 +- resources/views/home/books.blade.php | 21 +------- resources/views/home/default.blade.php | 8 ++- .../configured-section-actions.blade.php | 36 +++++++++++++ ...figured-section-recent-activity.blade.php} | 0 ...onfigured-section-recent-drafts.blade.php} | 0 ...-section-recently-updated-pages.blade.php} | 0 ...recently-viewed-or-recent-books.blade.php} | 0 ...nfigured-section-top-favourites.blade.php} | 0 .../default-card-recent-activity.blade.php | 5 +- ...ult-card-recently-updated-pages.blade.php} | 0 resources/views/home/parts/sidebar.blade.php | 5 -- resources/views/home/shelves.blade.php | 21 +------- resources/views/home/specific-page.blade.php | 10 +--- resources/views/pages/show.blade.php | 4 +- resources/views/shelves/index.blade.php | 4 +- resources/views/shelves/show.blade.php | 4 +- 59 files changed, 338 insertions(+), 147 deletions(-) create mode 100644 app/View/ViewBlocks/HomeActions.php create mode 100644 app/View/ViewBlocks/HomeRecentActivity.php create mode 100644 app/View/ViewBlocks/HomeRecentDrafts.php create mode 100644 app/View/ViewBlocks/HomeRecentlyUpdatedPages.php create mode 100644 app/View/ViewBlocks/HomeRecentlyViewedOrRecentBooks.php create mode 100644 app/View/ViewBlocks/HomeTopFavourites.php rename resources/views/common/{sidebar-sections.blade.php => view-blocks.blade.php} (60%) create mode 100644 resources/views/home/parts/configured-section-actions.blade.php rename resources/views/home/parts/{sidebar-section-recent-activity.blade.php => configured-section-recent-activity.blade.php} (100%) rename resources/views/home/parts/{sidebar-section-recent-drafts.blade.php => configured-section-recent-drafts.blade.php} (100%) rename resources/views/home/parts/{sidebar-section-recently-updated-pages.blade.php => configured-section-recently-updated-pages.blade.php} (100%) rename resources/views/home/parts/{sidebar-section-recently-viewed-or-recent-books.blade.php => configured-section-recently-viewed-or-recent-books.blade.php} (100%) rename resources/views/home/parts/{sidebar-section-top-favourites.blade.php => configured-section-top-favourites.blade.php} (100%) rename resources/views/home/parts/{default-card-recently-updates-pages.blade.php => default-card-recently-updated-pages.blade.php} (100%) delete mode 100644 resources/views/home/parts/sidebar.blade.php diff --git a/app/App/HomeController.php b/app/App/HomeController.php index 00e2db3df43..bbff07902b0 100644 --- a/app/App/HomeController.php +++ b/app/App/HomeController.php @@ -2,11 +2,8 @@ namespace BookStack\App; -use BookStack\Activity\ActivityQueries; use BookStack\Entities\Models\Page; use BookStack\Entities\Queries\EntityQueries; -use BookStack\Entities\Queries\QueryRecentlyViewed; -use BookStack\Entities\Queries\QueryTopFavourites; use BookStack\Entities\Tools\PageContent; use BookStack\Http\Controller; use BookStack\Util\SimpleListOptions; @@ -24,49 +21,19 @@ public function __construct( */ public function index( Request $request, - ActivityQueries $activities, - QueryRecentlyViewed $recentlyViewed, - QueryTopFavourites $topFavourites, ) { - $activity = $activities->latest(10); - $draftPages = []; - - if ($this->isSignedIn()) { - $draftPages = $this->queries->pages->currentUserDraftsForList() - ->orderBy('updated_at', 'desc') - ->with('book') - ->take(6) - ->get(); - } - - $recentFactor = count($draftPages) > 0 ? 0.5 : 1; - $recents = $this->isSignedIn() ? - $recentlyViewed->run(12 * $recentFactor, 1) - : $this->queries->books->visibleForList()->orderBy('created_at', 'desc')->take(12 * $recentFactor)->get(); - $favourites = $topFavourites->run(6); - $recentlyUpdatedPages = $this->queries->pages->visibleForList() - ->where('draft', false) - ->orderBy('updated_at', 'desc') - ->take($favourites->count() > 0 ? 5 : 10) - ->get(); - - $homepageOptions = ['default', 'books', 'bookshelves', 'page']; - $homepageOption = setting('app-homepage-type', 'default'); - if (!in_array($homepageOption, $homepageOptions)) { - $homepageOption = 'default'; + $homepageType = setting('app-homepage-type', 'default'); + if (!in_array($homepageType, ['default', 'books', 'bookshelves', 'page'])) { + $homepageType = 'default'; } $commonData = [ - 'activity' => $activity, - 'recents' => $recents, - 'recentlyUpdatedPages' => $recentlyUpdatedPages, - 'draftPages' => $draftPages, - 'favourites' => $favourites, + 'homeView' => $homepageType, ]; // Add required list ordering & sorting for books & shelves views. - if ($homepageOption === 'bookshelves' || $homepageOption === 'books') { - $key = $homepageOption; + if ($homepageType === 'bookshelves' || $homepageType === 'books') { + $key = $homepageType; $view = setting()->getForCurrentUser($key . '_view_type'); $listOptions = SimpleListOptions::fromRequest($request, $key)->withSortOptions([ 'name' => trans('common.sort_name'), @@ -80,7 +47,7 @@ public function index( ]); } - if ($homepageOption === 'bookshelves') { + if ($homepageType === 'bookshelves') { $shelves = $this->queries->shelves->visibleForListWithCover() ->orderBy($commonData['listOptions']->getSort(), $commonData['listOptions']->getOrder()) ->paginate(setting()->getInteger('lists-page-count-shelves', 18, 1, 1000)); @@ -89,7 +56,7 @@ public function index( return view('home.shelves', $data); } - if ($homepageOption === 'books') { + if ($homepageType === 'books') { $books = $this->queries->books->visibleForListWithCover() ->orderBy($commonData['listOptions']->getSort(), $commonData['listOptions']->getOrder()) ->paginate(setting()->getInteger('lists-page-count-books', 18, 1, 1000)); @@ -98,7 +65,7 @@ public function index( return view('home.books', $data); } - if ($homepageOption === 'page') { + if ($homepageType === 'page') { $homepageSetting = setting('app-homepage', '0:'); $id = intval(explode(':', $homepageSetting)[0]); /** @var Page $customHomepage */ diff --git a/app/View/ViewBlock.php b/app/View/ViewBlock.php index a835e70754e..636746044f0 100644 --- a/app/View/ViewBlock.php +++ b/app/View/ViewBlock.php @@ -9,7 +9,7 @@ abstract class ViewBlock implements ViewBlockInterface /** * @inheritDoc */ - public function getView(): string + public function getView(array $viewData): string { return $this->view; } diff --git a/app/View/ViewBlockInterface.php b/app/View/ViewBlockInterface.php index b9c25e9f65f..756cf4298f6 100644 --- a/app/View/ViewBlockInterface.php +++ b/app/View/ViewBlockInterface.php @@ -2,19 +2,18 @@ namespace BookStack\View; -use Illuminate\Http\Request; - interface ViewBlockInterface { /** * Get the view to render for this block. + * Is provided with the existing parent view data. */ - public function getView(): string; + public function getView(array $viewData): string; /** * Specify the data to pass to the view on render. * Is provided with the existing parent view data and the original request. * @return array */ - public function withData(array $viewData, Request $request): array; + public function withData(array $viewData): array; } diff --git a/app/View/ViewBlockManager.php b/app/View/ViewBlockManager.php index 88d86613587..7287c029357 100644 --- a/app/View/ViewBlockManager.php +++ b/app/View/ViewBlockManager.php @@ -17,6 +17,12 @@ use BookStack\View\ViewBlocks\ChaptersShowDetails; use BookStack\View\ViewBlocks\ChaptersShowSearchForm; use BookStack\View\ViewBlocks\ChaptersShowTags; +use BookStack\View\ViewBlocks\HomeActions; +use BookStack\View\ViewBlocks\HomeRecentActivity; +use BookStack\View\ViewBlocks\HomeRecentDrafts; +use BookStack\View\ViewBlocks\HomeRecentlyUpdatedPages; +use BookStack\View\ViewBlocks\HomeRecentlyViewedOrRecentBooks; +use BookStack\View\ViewBlocks\HomeTopFavourites; use BookStack\View\ViewBlocks\PagesShowActions; use BookStack\View\ViewBlocks\PagesShowAttachments; use BookStack\View\ViewBlocks\PagesShowBookTree; @@ -39,6 +45,31 @@ class ViewBlockManager * @var array[]>> */ protected array $blocksByLocationAndPosition = [ + 'home-default' => [ + 'left' => [ + HomeRecentDrafts::class, + HomeRecentlyViewedOrRecentBooks::class, + ], + 'center' => [ + HomeTopFavourites::class, + HomeRecentlyUpdatedPages::class, + ], + 'right' => [ + HomeRecentActivity::class, + ], + ], + 'home-non-default' => [ + 'left' => [ + HomeRecentDrafts::class, + HomeTopFavourites::class, + HomeRecentlyViewedOrRecentBooks::class, + HomeRecentlyUpdatedPages::class, + HomeRecentActivity::class, + ], + 'right' => [ + HomeActions::class, + ], + ], 'shelves-index' => [ 'left' => [ ShelvesIndexRecents::class, diff --git a/app/View/ViewBlocks/BooksIndexActions.php b/app/View/ViewBlocks/BooksIndexActions.php index fd290c601b1..8e6721ddf25 100644 --- a/app/View/ViewBlocks/BooksIndexActions.php +++ b/app/View/ViewBlocks/BooksIndexActions.php @@ -9,7 +9,7 @@ class BooksIndexActions extends ViewBlock { protected string $view = 'books.parts.index-sidebar-section-actions'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { return [ 'view' => $viewData['view'], diff --git a/app/View/ViewBlocks/BooksIndexNew.php b/app/View/ViewBlocks/BooksIndexNew.php index dee863b3611..76d2750ba93 100644 --- a/app/View/ViewBlocks/BooksIndexNew.php +++ b/app/View/ViewBlocks/BooksIndexNew.php @@ -15,7 +15,7 @@ public function __construct( ) { } - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { $new = $this->queries->visibleForList() ->orderBy('created_at', 'desc') diff --git a/app/View/ViewBlocks/BooksIndexPopular.php b/app/View/ViewBlocks/BooksIndexPopular.php index cb478170da1..ee3138f79de 100644 --- a/app/View/ViewBlocks/BooksIndexPopular.php +++ b/app/View/ViewBlocks/BooksIndexPopular.php @@ -15,7 +15,7 @@ public function __construct( ) { } - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { return [ 'popular' => $this->queries->popularForList()->take(4)->get(), diff --git a/app/View/ViewBlocks/BooksIndexRecents.php b/app/View/ViewBlocks/BooksIndexRecents.php index e3a632e54d7..1c7b865d8dd 100644 --- a/app/View/ViewBlocks/BooksIndexRecents.php +++ b/app/View/ViewBlocks/BooksIndexRecents.php @@ -15,7 +15,7 @@ public function __construct( ) { } - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { $recents = null; if (!user()->isGuest()) { diff --git a/app/View/ViewBlocks/BooksShowActions.php b/app/View/ViewBlocks/BooksShowActions.php index 43f63c24ec0..155c0c7ba85 100644 --- a/app/View/ViewBlocks/BooksShowActions.php +++ b/app/View/ViewBlocks/BooksShowActions.php @@ -11,7 +11,7 @@ class BooksShowActions extends ViewBlock { protected string $view = 'books.parts.show-sidebar-section-actions'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Book $book */ $book = $viewData['book']; diff --git a/app/View/ViewBlocks/BooksShowActivity.php b/app/View/ViewBlocks/BooksShowActivity.php index 4ba8697c541..ecf626df526 100644 --- a/app/View/ViewBlocks/BooksShowActivity.php +++ b/app/View/ViewBlocks/BooksShowActivity.php @@ -16,7 +16,7 @@ public function __construct( ) { } - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Book $book */ $book = $viewData['book']; diff --git a/app/View/ViewBlocks/BooksShowDetails.php b/app/View/ViewBlocks/BooksShowDetails.php index 12699d5a02b..9a0ef8b4786 100644 --- a/app/View/ViewBlocks/BooksShowDetails.php +++ b/app/View/ViewBlocks/BooksShowDetails.php @@ -17,7 +17,7 @@ public function __construct( ) { } - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Book $book */ $book = $viewData['book']; diff --git a/app/View/ViewBlocks/BooksShowSearchForm.php b/app/View/ViewBlocks/BooksShowSearchForm.php index d75db3d9303..061875d3dc1 100644 --- a/app/View/ViewBlocks/BooksShowSearchForm.php +++ b/app/View/ViewBlocks/BooksShowSearchForm.php @@ -9,7 +9,7 @@ class BooksShowSearchForm extends ViewBlock { protected string $view = 'entities.search-form'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { return [ 'label' => trans('entities.books_search_this'), diff --git a/app/View/ViewBlocks/BooksShowShelves.php b/app/View/ViewBlocks/BooksShowShelves.php index 48a3208fc77..42d8325895f 100644 --- a/app/View/ViewBlocks/BooksShowShelves.php +++ b/app/View/ViewBlocks/BooksShowShelves.php @@ -10,7 +10,7 @@ class BooksShowShelves extends ViewBlock { protected string $view = 'books.parts.show-sidebar-section-shelves'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Book $book */ $book = $viewData['book']; diff --git a/app/View/ViewBlocks/BooksShowTags.php b/app/View/ViewBlocks/BooksShowTags.php index 60603b91af3..5c5aa8fd9c6 100644 --- a/app/View/ViewBlocks/BooksShowTags.php +++ b/app/View/ViewBlocks/BooksShowTags.php @@ -9,7 +9,7 @@ class BooksShowTags extends ViewBlock { protected string $view = 'books.parts.show-sidebar-section-tags'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { return [ 'book' => $viewData['book'], diff --git a/app/View/ViewBlocks/ChaptersShowActions.php b/app/View/ViewBlocks/ChaptersShowActions.php index e75b86a1e2d..9b6137a20ef 100644 --- a/app/View/ViewBlocks/ChaptersShowActions.php +++ b/app/View/ViewBlocks/ChaptersShowActions.php @@ -11,7 +11,7 @@ class ChaptersShowActions extends ViewBlock { protected string $view = 'chapters.parts.show-sidebar-section-actions'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Chapter $chapter */ $chapter = $viewData['chapter']; diff --git a/app/View/ViewBlocks/ChaptersShowBookTree.php b/app/View/ViewBlocks/ChaptersShowBookTree.php index 79e65908b0e..827e8d9175d 100644 --- a/app/View/ViewBlocks/ChaptersShowBookTree.php +++ b/app/View/ViewBlocks/ChaptersShowBookTree.php @@ -10,7 +10,7 @@ class ChaptersShowBookTree extends ViewBlock { protected string $view = 'entities.book-tree'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Book $book */ $book = $viewData['book']; diff --git a/app/View/ViewBlocks/ChaptersShowDetails.php b/app/View/ViewBlocks/ChaptersShowDetails.php index ed7efaa893c..fd235fbe1fb 100644 --- a/app/View/ViewBlocks/ChaptersShowDetails.php +++ b/app/View/ViewBlocks/ChaptersShowDetails.php @@ -18,7 +18,7 @@ public function __construct( ) { } - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Book $book */ $book = $viewData['book']; diff --git a/app/View/ViewBlocks/ChaptersShowSearchForm.php b/app/View/ViewBlocks/ChaptersShowSearchForm.php index ad671a2d37c..92664e5f554 100644 --- a/app/View/ViewBlocks/ChaptersShowSearchForm.php +++ b/app/View/ViewBlocks/ChaptersShowSearchForm.php @@ -9,7 +9,7 @@ class ChaptersShowSearchForm extends ViewBlock { protected string $view = 'entities.search-form'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { return [ 'label' => trans('entities.chapters_search_this'), diff --git a/app/View/ViewBlocks/ChaptersShowTags.php b/app/View/ViewBlocks/ChaptersShowTags.php index 369946e2b2b..198604eee82 100644 --- a/app/View/ViewBlocks/ChaptersShowTags.php +++ b/app/View/ViewBlocks/ChaptersShowTags.php @@ -10,7 +10,7 @@ class ChaptersShowTags extends ViewBlock { protected string $view = 'chapters.parts.show-sidebar-section-tags'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Chapter $chapter */ $chapter = $viewData['chapter']; diff --git a/app/View/ViewBlocks/HomeActions.php b/app/View/ViewBlocks/HomeActions.php new file mode 100644 index 00000000000..f4e4295b88c --- /dev/null +++ b/app/View/ViewBlocks/HomeActions.php @@ -0,0 +1,19 @@ + $viewData['view'] ?? '', + 'homeView' => $viewData['homeView'] ?? 'default', + ]; + } +} diff --git a/app/View/ViewBlocks/HomeRecentActivity.php b/app/View/ViewBlocks/HomeRecentActivity.php new file mode 100644 index 00000000000..1f915061c12 --- /dev/null +++ b/app/View/ViewBlocks/HomeRecentActivity.php @@ -0,0 +1,32 @@ +activityQueries->latest(10); + return [ + 'activity' => $activity, + ]; + } +} diff --git a/app/View/ViewBlocks/HomeRecentDrafts.php b/app/View/ViewBlocks/HomeRecentDrafts.php new file mode 100644 index 00000000000..71586d83a19 --- /dev/null +++ b/app/View/ViewBlocks/HomeRecentDrafts.php @@ -0,0 +1,40 @@ +isGuest()) { + $draftPages = $this->pageQueries->currentUserDraftsForList() + ->orderBy('updated_at', 'desc') + ->with('book') + ->take(6) + ->get(); + } + + return [ + 'draftPages' => $draftPages, + ]; + } +} diff --git a/app/View/ViewBlocks/HomeRecentlyUpdatedPages.php b/app/View/ViewBlocks/HomeRecentlyUpdatedPages.php new file mode 100644 index 00000000000..3f669ee6eb7 --- /dev/null +++ b/app/View/ViewBlocks/HomeRecentlyUpdatedPages.php @@ -0,0 +1,37 @@ +queries->visibleForList() + ->where('draft', false) + ->orderBy('updated_at', 'desc') + ->take(8) + ->get(); + + return [ + 'recentlyUpdatedPages' => $recentlyUpdatedPages, + ]; + } +} diff --git a/app/View/ViewBlocks/HomeRecentlyViewedOrRecentBooks.php b/app/View/ViewBlocks/HomeRecentlyViewedOrRecentBooks.php new file mode 100644 index 00000000000..7db3d793590 --- /dev/null +++ b/app/View/ViewBlocks/HomeRecentlyViewedOrRecentBooks.php @@ -0,0 +1,43 @@ +isGuest()) { + $recents = $this->queries->books->visibleForList() + ->orderBy('created_at', 'desc') + ->take(10) + ->get(); + } else { + $recents = $this->recentlyViewed->run(10, 1); + } + + return [ + 'recents' => $recents + ]; + } +} diff --git a/app/View/ViewBlocks/HomeTopFavourites.php b/app/View/ViewBlocks/HomeTopFavourites.php new file mode 100644 index 00000000000..9ce84aa3dd1 --- /dev/null +++ b/app/View/ViewBlocks/HomeTopFavourites.php @@ -0,0 +1,32 @@ +topFavourites->run(6); + return [ + 'favourites' => $favourites + ]; + } +} diff --git a/app/View/ViewBlocks/PagesShowActions.php b/app/View/ViewBlocks/PagesShowActions.php index b09a6408105..5486b59a45b 100644 --- a/app/View/ViewBlocks/PagesShowActions.php +++ b/app/View/ViewBlocks/PagesShowActions.php @@ -11,7 +11,7 @@ class PagesShowActions extends ViewBlock { protected string $view = 'pages.parts.show-sidebar-section-actions'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Page $page */ $page = $viewData['page']; diff --git a/app/View/ViewBlocks/PagesShowAttachments.php b/app/View/ViewBlocks/PagesShowAttachments.php index 43e076671f2..5d0cd23baab 100644 --- a/app/View/ViewBlocks/PagesShowAttachments.php +++ b/app/View/ViewBlocks/PagesShowAttachments.php @@ -10,7 +10,7 @@ class PagesShowAttachments extends ViewBlock { protected string $view = 'pages.parts.show-sidebar-section-attachments'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Page $page */ $page = $viewData['page']; diff --git a/app/View/ViewBlocks/PagesShowBookTree.php b/app/View/ViewBlocks/PagesShowBookTree.php index 4631e4ef4bd..b0947a208cf 100644 --- a/app/View/ViewBlocks/PagesShowBookTree.php +++ b/app/View/ViewBlocks/PagesShowBookTree.php @@ -10,7 +10,7 @@ class PagesShowBookTree extends ViewBlock { protected string $view = 'entities.book-tree'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Book $book */ $book = $viewData['book']; diff --git a/app/View/ViewBlocks/PagesShowDetails.php b/app/View/ViewBlocks/PagesShowDetails.php index 9fcaadac9b6..2dfd61417ca 100644 --- a/app/View/ViewBlocks/PagesShowDetails.php +++ b/app/View/ViewBlocks/PagesShowDetails.php @@ -18,7 +18,7 @@ public function __construct( ) { } - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Book $book */ $book = $viewData['book']; diff --git a/app/View/ViewBlocks/PagesShowPageNav.php b/app/View/ViewBlocks/PagesShowPageNav.php index c43b4d7f8b0..dbee578ab31 100644 --- a/app/View/ViewBlocks/PagesShowPageNav.php +++ b/app/View/ViewBlocks/PagesShowPageNav.php @@ -11,7 +11,7 @@ class PagesShowPageNav extends ViewBlock { protected string $view = 'pages.parts.show-sidebar-section-page-nav'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Page $page */ $page = $viewData['page']; diff --git a/app/View/ViewBlocks/PagesShowTags.php b/app/View/ViewBlocks/PagesShowTags.php index bee6846f16d..a2197a16130 100644 --- a/app/View/ViewBlocks/PagesShowTags.php +++ b/app/View/ViewBlocks/PagesShowTags.php @@ -10,7 +10,7 @@ class PagesShowTags extends ViewBlock { protected string $view = 'pages.parts.show-sidebar-section-tags'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Page $page */ $page = $viewData['page']; diff --git a/app/View/ViewBlocks/ShelvesIndexActions.php b/app/View/ViewBlocks/ShelvesIndexActions.php index 51d4b3a8953..2cc4361169a 100644 --- a/app/View/ViewBlocks/ShelvesIndexActions.php +++ b/app/View/ViewBlocks/ShelvesIndexActions.php @@ -9,7 +9,7 @@ class ShelvesIndexActions extends ViewBlock { protected string $view = 'shelves.parts.index-sidebar-section-actions'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { return [ 'view' => $viewData['view'], diff --git a/app/View/ViewBlocks/ShelvesIndexNew.php b/app/View/ViewBlocks/ShelvesIndexNew.php index f3ad4a650a0..1d6af72c0ed 100644 --- a/app/View/ViewBlocks/ShelvesIndexNew.php +++ b/app/View/ViewBlocks/ShelvesIndexNew.php @@ -15,7 +15,7 @@ public function __construct( ) { } - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { $new = $this->queries->visibleForList() ->orderBy('created_at', 'desc') diff --git a/app/View/ViewBlocks/ShelvesIndexPopular.php b/app/View/ViewBlocks/ShelvesIndexPopular.php index 5e880e18e8a..fc2950b9260 100644 --- a/app/View/ViewBlocks/ShelvesIndexPopular.php +++ b/app/View/ViewBlocks/ShelvesIndexPopular.php @@ -15,7 +15,7 @@ public function __construct( ) { } - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { return [ 'popular' => $this->queries->popularForList()->take(4)->get(), diff --git a/app/View/ViewBlocks/ShelvesIndexRecents.php b/app/View/ViewBlocks/ShelvesIndexRecents.php index 77e3a2af4cf..6570841a922 100644 --- a/app/View/ViewBlocks/ShelvesIndexRecents.php +++ b/app/View/ViewBlocks/ShelvesIndexRecents.php @@ -15,7 +15,7 @@ public function __construct( ) { } - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { $recents = null; if (!user()->isGuest()) { diff --git a/app/View/ViewBlocks/ShelvesShowActions.php b/app/View/ViewBlocks/ShelvesShowActions.php index 9c0ab73218c..d1bb965c834 100644 --- a/app/View/ViewBlocks/ShelvesShowActions.php +++ b/app/View/ViewBlocks/ShelvesShowActions.php @@ -10,7 +10,7 @@ class ShelvesShowActions extends ViewBlock { protected string $view = 'shelves.parts.show-sidebar-section-actions'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Bookshelf $shelf */ $shelf = $viewData['shelf']; diff --git a/app/View/ViewBlocks/ShelvesShowActivity.php b/app/View/ViewBlocks/ShelvesShowActivity.php index a4ae874beec..40e715bcdbc 100644 --- a/app/View/ViewBlocks/ShelvesShowActivity.php +++ b/app/View/ViewBlocks/ShelvesShowActivity.php @@ -16,7 +16,7 @@ public function __construct( ) { } - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Bookshelf $shelf */ $shelf = $viewData['shelf']; diff --git a/app/View/ViewBlocks/ShelvesShowDetails.php b/app/View/ViewBlocks/ShelvesShowDetails.php index 2a892cf8882..413b4796c24 100644 --- a/app/View/ViewBlocks/ShelvesShowDetails.php +++ b/app/View/ViewBlocks/ShelvesShowDetails.php @@ -16,7 +16,7 @@ public function __construct( ) { } - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { /** @var Bookshelf $shelf */ $shelf = $viewData['shelf']; diff --git a/app/View/ViewBlocks/ShelvesShowTags.php b/app/View/ViewBlocks/ShelvesShowTags.php index 35dd56edeb0..9a61cc94d74 100644 --- a/app/View/ViewBlocks/ShelvesShowTags.php +++ b/app/View/ViewBlocks/ShelvesShowTags.php @@ -9,7 +9,7 @@ class ShelvesShowTags extends ViewBlock { protected string $view = 'shelves.parts.show-sidebar-section-tags'; - public function withData(array $viewData, Request $request): array + public function withData(array $viewData): array { return [ 'book' => $viewData['book'], diff --git a/resources/views/books/index.blade.php b/resources/views/books/index.blade.php index 020cb096638..6e311a88bae 100644 --- a/resources/views/books/index.blade.php +++ b/resources/views/books/index.blade.php @@ -5,9 +5,9 @@ @stop @section('left') - @include('common.sidebar-sections', ['location' => 'books-index', 'position' => 'left']) + @include('common.view-blocks', ['location' => 'books-index', 'position' => 'left']) @stop @section('right') - @include('common.sidebar-sections', ['location' => 'books-index', 'position' => 'right']) + @include('common.view-blocks', ['location' => 'books-index', 'position' => 'right']) @stop diff --git a/resources/views/books/show.blade.php b/resources/views/books/show.blade.php index 48a95113252..b2fa0b3932b 100644 --- a/resources/views/books/show.blade.php +++ b/resources/views/books/show.blade.php @@ -67,9 +67,9 @@ @stop @section('left') - @include('common.sidebar-sections', ['location' => 'books-show', 'position' => 'left']) + @include('common.view-blocks', ['location' => 'books-show', 'position' => 'left']) @stop @section('right') - @include('common.sidebar-sections', ['location' => 'books-show', 'position' => 'right']) + @include('common.view-blocks', ['location' => 'books-show', 'position' => 'right']) @stop diff --git a/resources/views/chapters/show.blade.php b/resources/views/chapters/show.blade.php index 569d901f66a..2c481ee14fa 100644 --- a/resources/views/chapters/show.blade.php +++ b/resources/views/chapters/show.blade.php @@ -63,9 +63,9 @@ @stop @section('left') - @include('common.sidebar-sections', ['location' => 'chapters-show', 'position' => 'left']) + @include('common.view-blocks', ['location' => 'chapters-show', 'position' => 'left']) @stop @section('right') - @include('common.sidebar-sections', ['location' => 'chapters-show', 'position' => 'right']) + @include('common.view-blocks', ['location' => 'chapters-show', 'position' => 'right']) @stop diff --git a/resources/views/common/sidebar-sections.blade.php b/resources/views/common/view-blocks.blade.php similarity index 60% rename from resources/views/common/sidebar-sections.blade.php rename to resources/views/common/view-blocks.blade.php index f18f9e4c24d..fb5e83e191b 100644 --- a/resources/views/common/sidebar-sections.blade.php +++ b/resources/views/common/view-blocks.blade.php @@ -4,8 +4,7 @@ --}} @php $sectionVars = get_defined_vars(); - $sectionRequest = request(); @endphp @foreach($viewBlocks->getForLocation($location, $position) as $section) - @include($section->getView(), $section->withData($sectionVars, $sectionRequest)) + @include($section->getView($sectionVars), $section->withData($sectionVars)) @endforeach \ No newline at end of file diff --git a/resources/views/home/books.blade.php b/resources/views/home/books.blade.php index afd3f30fce2..3c4225b5636 100644 --- a/resources/views/home/books.blade.php +++ b/resources/views/home/books.blade.php @@ -5,26 +5,9 @@ @stop @section('left') - @include('home.parts.sidebar') + @include('common.view-blocks', ['location' => 'home-non-default', 'position' => 'left']) @stop @section('right') -
    -
    {{ trans('common.actions') }}
    -
    - @if(userCan(\BookStack\Permissions\Permission::BookCreateAll)) - - @icon('add') - {{ trans('entities.books_create') }} - - @endif - @include('entities.view-toggle', ['view' => $view, 'type' => 'books']) - - @icon('tag') - {{ trans('entities.tags_view_tags') }} - - @include('home.parts.expand-toggle', ['classes' => 'text-link', 'target' => '.entity-list.compact .entity-item-snippet', 'key' => 'home-details']) - @include('common.dark-mode-toggle', ['classes' => 'icon-list-item text-link']) -
    -
    + @include('common.view-blocks', ['location' => 'home-non-default', 'position' => 'right']) @stop diff --git a/resources/views/home/default.blade.php b/resources/views/home/default.blade.php index 7d229d6acc1..508631c8cdb 100644 --- a/resources/views/home/default.blade.php +++ b/resources/views/home/default.blade.php @@ -16,17 +16,15 @@
    - @include('home.parts.default-card-recent-drafts', ['draftPages' => $draftPages]) - @include('home.parts.default-card-recently-viewed-or-recent-books', ['recents' => $recents]) + @include('common.view-blocks', ['location' => 'home-default', 'position' => 'left'])
    - @include('home.parts.default-card-top-favourites', ['favourites' => $favourites]) - @include('home.parts.default-card-recently-updates-pages', ['recentlyUpdatedPages' => $recentlyUpdatedPages]) + @include('common.view-blocks', ['location' => 'home-default', 'position' => 'center'])
    - @include('home.parts.default-card-recent-activity', ['activity' => $activity]) + @include('common.view-blocks', ['location' => 'home-default', 'position' => 'right'])
    diff --git a/resources/views/home/parts/configured-section-actions.blade.php b/resources/views/home/parts/configured-section-actions.blade.php new file mode 100644 index 00000000000..6386670d5b9 --- /dev/null +++ b/resources/views/home/parts/configured-section-actions.blade.php @@ -0,0 +1,36 @@ +{{-- +$homeView - string - The type of home view being used +$view - string - Configured view type from parent (for books/shelves list/grid view) +--}} +
    +
    {{ trans('common.actions') }}
    +
    + @if($homeView === 'books') + @if(userCan(\BookStack\Permissions\Permission::BookCreateAll)) + + @icon('add') + {{ trans('entities.books_create') }} + + @endif + @include('entities.view-toggle', ['view' => $view, 'type' => 'books']) + + @icon('tag') + {{ trans('entities.tags_view_tags') }} + + @elseif ($homeView === 'bookshelves') + @if(userCan(\BookStack\Permissions\Permission::BookshelfCreateAll)) + + @icon('add') + {{ trans('entities.shelves_new_action') }} + + @endif + @include('entities.view-toggle', ['view' => $view, 'type' => 'bookshelves']) + + @icon('tag') + {{ trans('entities.tags_view_tags') }} + + @endif + @include('home.parts.expand-toggle', ['classes' => 'text-link', 'target' => '.entity-list.compact .entity-item-snippet', 'key' => 'home-details']) + @include('common.dark-mode-toggle', ['classes' => 'icon-list-item text-link']) +
    +
    \ No newline at end of file diff --git a/resources/views/home/parts/sidebar-section-recent-activity.blade.php b/resources/views/home/parts/configured-section-recent-activity.blade.php similarity index 100% rename from resources/views/home/parts/sidebar-section-recent-activity.blade.php rename to resources/views/home/parts/configured-section-recent-activity.blade.php diff --git a/resources/views/home/parts/sidebar-section-recent-drafts.blade.php b/resources/views/home/parts/configured-section-recent-drafts.blade.php similarity index 100% rename from resources/views/home/parts/sidebar-section-recent-drafts.blade.php rename to resources/views/home/parts/configured-section-recent-drafts.blade.php diff --git a/resources/views/home/parts/sidebar-section-recently-updated-pages.blade.php b/resources/views/home/parts/configured-section-recently-updated-pages.blade.php similarity index 100% rename from resources/views/home/parts/sidebar-section-recently-updated-pages.blade.php rename to resources/views/home/parts/configured-section-recently-updated-pages.blade.php diff --git a/resources/views/home/parts/sidebar-section-recently-viewed-or-recent-books.blade.php b/resources/views/home/parts/configured-section-recently-viewed-or-recent-books.blade.php similarity index 100% rename from resources/views/home/parts/sidebar-section-recently-viewed-or-recent-books.blade.php rename to resources/views/home/parts/configured-section-recently-viewed-or-recent-books.blade.php diff --git a/resources/views/home/parts/sidebar-section-top-favourites.blade.php b/resources/views/home/parts/configured-section-top-favourites.blade.php similarity index 100% rename from resources/views/home/parts/sidebar-section-top-favourites.blade.php rename to resources/views/home/parts/configured-section-top-favourites.blade.php diff --git a/resources/views/home/parts/default-card-recent-activity.blade.php b/resources/views/home/parts/default-card-recent-activity.blade.php index 035cd998736..c848ff1bca5 100644 --- a/resources/views/home/parts/default-card-recent-activity.blade.php +++ b/resources/views/home/parts/default-card-recent-activity.blade.php @@ -1,6 +1,9 @@ +{{-- +$activity - array +--}}

    {{ trans('entities.recent_activity') }}

    @include('common.activity-list', ['activity' => $activity])
    -
    j \ No newline at end of file +
    • \ No newline at end of file diff --git a/resources/views/home/parts/default-card-recently-updates-pages.blade.php b/resources/views/home/parts/default-card-recently-updated-pages.blade.php similarity index 100% rename from resources/views/home/parts/default-card-recently-updates-pages.blade.php rename to resources/views/home/parts/default-card-recently-updated-pages.blade.php diff --git a/resources/views/home/parts/sidebar.blade.php b/resources/views/home/parts/sidebar.blade.php deleted file mode 100644 index 07c199f9e68..00000000000 --- a/resources/views/home/parts/sidebar.blade.php +++ /dev/null @@ -1,5 +0,0 @@ -@include('home.parts.sidebar-section-recent-drafts', ['draftPages' => $draftPages]) -@include('home.parts.sidebar-section-top-favourites', ['favourites' => $favourites]) -@include('home.parts.sidebar-section-recently-viewed-or-recent-books', ['recents' => $recents]) -@include('home.parts.sidebar-section-recently-updated-pages', ['recentlyUpdatedPages' => $recentlyUpdatedPages]) -@include('home.parts.sidebar-section-recent-activity', ['activity' => $activity]) \ No newline at end of file diff --git a/resources/views/home/shelves.blade.php b/resources/views/home/shelves.blade.php index 7a4d002a0ac..64795154315 100644 --- a/resources/views/home/shelves.blade.php +++ b/resources/views/home/shelves.blade.php @@ -5,26 +5,9 @@ @stop @section('left') - @include('home.parts.sidebar') + @include('common.view-blocks', ['location' => 'home-non-default', 'position' => 'left']) @stop @section('right') -
    -
    {{ trans('common.actions') }}
    -
    - @if(userCan(\BookStack\Permissions\Permission::BookshelfCreateAll)) - - @icon('add') - {{ trans('entities.shelves_new_action') }} - - @endif - @include('entities.view-toggle', ['view' => $view, 'type' => 'bookshelves']) - - @icon('tag') - {{ trans('entities.tags_view_tags') }} - - @include('home.parts.expand-toggle', ['classes' => 'text-link', 'target' => '.entity-list.compact .entity-item-snippet', 'key' => 'home-details']) - @include('common.dark-mode-toggle', ['classes' => 'icon-list-item text-link']) -
    -
    + @include('common.view-blocks', ['location' => 'home-non-default', 'position' => 'right']) @stop diff --git a/resources/views/home/specific-page.blade.php b/resources/views/home/specific-page.blade.php index 10ffe9629b6..329c4a6c244 100644 --- a/resources/views/home/specific-page.blade.php +++ b/resources/views/home/specific-page.blade.php @@ -13,15 +13,9 @@ class="page-content"> @stop @section('left') - @include('home.parts.sidebar') + @include('common.view-blocks', ['location' => 'home-non-default', 'position' => 'left']) @stop @section('right') -
    -
    {{ trans('common.actions') }}
    -
    - @include('home.parts.expand-toggle', ['classes' => 'text-link', 'target' => '.entity-list.compact .entity-item-snippet', 'key' => 'home-details']) - @include('common.dark-mode-toggle', ['classes' => 'icon-list-item text-link']) -
    -
    + @include('common.view-blocks', ['location' => 'home-non-default', 'position' => 'right']) @stop \ No newline at end of file diff --git a/resources/views/pages/show.blade.php b/resources/views/pages/show.blade.php index 08d01973d45..eef559320d8 100644 --- a/resources/views/pages/show.blade.php +++ b/resources/views/pages/show.blade.php @@ -36,9 +36,9 @@ class="page-content clearfix"> @stop @section('left') - @include('common.sidebar-sections', ['location' => 'pages-show', 'position' => 'left']) + @include('common.view-blocks', ['location' => 'pages-show', 'position' => 'left']) @stop @section('right') - @include('common.sidebar-sections', ['location' => 'pages-show', 'position' => 'right']) + @include('common.view-blocks', ['location' => 'pages-show', 'position' => 'right']) @stop diff --git a/resources/views/shelves/index.blade.php b/resources/views/shelves/index.blade.php index 2fc78fa50c9..87c6392983f 100644 --- a/resources/views/shelves/index.blade.php +++ b/resources/views/shelves/index.blade.php @@ -5,9 +5,9 @@ @stop @section('left') - @include('common.sidebar-sections', ['location' => 'shelves-index', 'position' => 'left']) + @include('common.view-blocks', ['location' => 'shelves-index', 'position' => 'left']) @stop @section('right') - @include('common.sidebar-sections', ['location' => 'shelves-index', 'position' => 'right']) + @include('common.view-blocks', ['location' => 'shelves-index', 'position' => 'right']) @stop diff --git a/resources/views/shelves/show.blade.php b/resources/views/shelves/show.blade.php index 320e1066c6c..b942f35ff7a 100644 --- a/resources/views/shelves/show.blade.php +++ b/resources/views/shelves/show.blade.php @@ -69,9 +69,9 @@ @stop @section('left') - @include('common.sidebar-sections', ['location' => 'shelves-show', 'position' => 'left']) + @include('common.view-blocks', ['location' => 'shelves-show', 'position' => 'left']) @stop @section('right') - @include('common.sidebar-sections', ['location' => 'shelves-show', 'position' => 'right']) + @include('common.view-blocks', ['location' => 'shelves-show', 'position' => 'right']) @stop From 45ff36714ff78afa27078b4948edeae1e854b105 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Sun, 9 Aug 2026 18:35:10 +0100 Subject: [PATCH 10/37] View Blocks: Extracted default set, added labels to each --- app/View/ViewBlock.php | 9 ++ app/View/ViewBlockDefaults.php | 110 +++++++++++++++ app/View/ViewBlockInterface.php | 5 + app/View/ViewBlockManager.php | 133 +----------------- app/View/ViewBlocks/BooksIndexActions.php | 1 + app/View/ViewBlocks/BooksIndexNew.php | 1 + app/View/ViewBlocks/BooksIndexPopular.php | 1 + app/View/ViewBlocks/BooksIndexRecents.php | 1 + app/View/ViewBlocks/BooksShowActions.php | 1 + app/View/ViewBlocks/BooksShowActivity.php | 1 + app/View/ViewBlocks/BooksShowDetails.php | 1 + app/View/ViewBlocks/BooksShowSearchForm.php | 1 + app/View/ViewBlocks/BooksShowShelves.php | 1 + app/View/ViewBlocks/BooksShowTags.php | 1 + app/View/ViewBlocks/ChaptersShowActions.php | 1 + app/View/ViewBlocks/ChaptersShowBookTree.php | 1 + app/View/ViewBlocks/ChaptersShowDetails.php | 1 + .../ViewBlocks/ChaptersShowSearchForm.php | 1 + app/View/ViewBlocks/ChaptersShowTags.php | 1 + app/View/ViewBlocks/HomeActions.php | 2 +- app/View/ViewBlocks/HomeRecentActivity.php | 5 + app/View/ViewBlocks/HomeRecentDrafts.php | 5 + .../ViewBlocks/HomeRecentlyUpdatedPages.php | 5 + .../HomeRecentlyViewedOrRecentBooks.php | 6 + app/View/ViewBlocks/HomeTopFavourites.php | 5 + app/View/ViewBlocks/PagesShowActions.php | 1 + app/View/ViewBlocks/PagesShowAttachments.php | 1 + app/View/ViewBlocks/PagesShowBookTree.php | 1 + app/View/ViewBlocks/PagesShowDetails.php | 1 + app/View/ViewBlocks/PagesShowPageNav.php | 1 + app/View/ViewBlocks/PagesShowTags.php | 1 + app/View/ViewBlocks/ShelvesIndexActions.php | 1 + app/View/ViewBlocks/ShelvesIndexNew.php | 1 + app/View/ViewBlocks/ShelvesIndexPopular.php | 1 + app/View/ViewBlocks/ShelvesIndexRecents.php | 1 + app/View/ViewBlocks/ShelvesShowActions.php | 1 + app/View/ViewBlocks/ShelvesShowActivity.php | 1 + app/View/ViewBlocks/ShelvesShowDetails.php | 1 + app/View/ViewBlocks/ShelvesShowTags.php | 1 + 39 files changed, 185 insertions(+), 129 deletions(-) create mode 100644 app/View/ViewBlockDefaults.php diff --git a/app/View/ViewBlock.php b/app/View/ViewBlock.php index 636746044f0..921ecd342f2 100644 --- a/app/View/ViewBlock.php +++ b/app/View/ViewBlock.php @@ -5,6 +5,7 @@ abstract class ViewBlock implements ViewBlockInterface { protected string $view; + protected string $labelTranslationKey; /** * @inheritDoc @@ -13,4 +14,12 @@ public function getView(array $viewData): string { return $this->view; } + + /** + * @inheritDoc + */ + public function getLabel(): string + { + return trans($this->labelTranslationKey); + } } diff --git a/app/View/ViewBlockDefaults.php b/app/View/ViewBlockDefaults.php new file mode 100644 index 00000000000..33a08adc1b0 --- /dev/null +++ b/app/View/ViewBlockDefaults.php @@ -0,0 +1,110 @@ +[]>> + */ + protected static array $defaults = [ + 'home-default' => [ + 'left' => [ + ViewBlocks\HomeRecentDrafts::class, + ViewBlocks\HomeRecentlyViewedOrRecentBooks::class, + ], + 'center' => [ + ViewBlocks\HomeTopFavourites::class, + ViewBlocks\HomeRecentlyUpdatedPages::class, + ], + 'right' => [ + ViewBlocks\HomeRecentActivity::class, + ], + ], + 'home-non-default' => [ + 'left' => [ + ViewBlocks\HomeRecentDrafts::class, + ViewBlocks\HomeTopFavourites::class, + ViewBlocks\HomeRecentlyViewedOrRecentBooks::class, + ViewBlocks\HomeRecentlyUpdatedPages::class, + ViewBlocks\HomeRecentActivity::class, + ], + 'right' => [ + ViewBlocks\HomeActions::class, + ], + ], + 'shelves-index' => [ + 'left' => [ + ViewBlocks\ShelvesIndexRecents::class, + ViewBlocks\ShelvesIndexPopular::class, + ViewBlocks\ShelvesIndexNew::class, + ], + 'right' => [ + ViewBlocks\ShelvesIndexActions::class, + ], + ], + 'shelves-show' => [ + 'left' => [ + ViewBlocks\ShelvesShowTags::class, + ViewBlocks\ShelvesShowDetails::class, + ViewBlocks\ShelvesShowActivity::class, + ], + 'right' => [ + ViewBlocks\ShelvesShowActions::class, + ], + ], + 'books-index' => [ + 'left' => [ + ViewBlocks\BooksIndexRecents::class, + ViewBlocks\BooksIndexPopular::class, + ViewBlocks\BooksIndexNew::class, + ], + 'right' => [ + ViewBlocks\BooksIndexActions::class, + ], + ], + 'books-show' => [ + 'left' => [ + ViewBlocks\BooksShowSearchForm::class, + ViewBlocks\BooksShowTags::class, + ViewBlocks\BooksShowShelves::class, + ViewBlocks\BooksShowActivity::class, + ], + 'right' => [ + ViewBlocks\BooksShowDetails::class, + ViewBlocks\BooksShowActions::class, + ], + ], + 'chapters-show' => [ + 'left' => [ + ViewBlocks\ChaptersShowSearchForm::class, + ViewBlocks\ChaptersShowTags::class, + ViewBlocks\ChaptersShowBookTree::class, + ], + 'right' => [ + ViewBlocks\ChaptersShowDetails::class, + ViewBlocks\ChaptersShowActions::class, + ], + ], + 'pages-show' => [ + 'left' => [ + ViewBlocks\PagesShowTags::class, + ViewBlocks\PagesShowAttachments::class, + ViewBlocks\PagesShowPageNav::class, + ViewBlocks\PagesShowBookTree::class, + ], + 'right' => [ + ViewBlocks\PagesShowDetails::class, + ViewBlocks\PagesShowActions::class, + ], + ], + ]; + + /** + * Get the default view blocks for the given location. + */ + public static function getForLocation(string $location): array + { + return self::$defaults[$location] ?? []; + } +} diff --git a/app/View/ViewBlockInterface.php b/app/View/ViewBlockInterface.php index 756cf4298f6..d724568709f 100644 --- a/app/View/ViewBlockInterface.php +++ b/app/View/ViewBlockInterface.php @@ -4,6 +4,11 @@ interface ViewBlockInterface { + /** + * Get the label for this block. + */ + public function getLabel(): string; + /** * Get the view to render for this block. * Is provided with the existing parent view data. diff --git a/app/View/ViewBlockManager.php b/app/View/ViewBlockManager.php index 7287c029357..00535b2c127 100644 --- a/app/View/ViewBlockManager.php +++ b/app/View/ViewBlockManager.php @@ -2,41 +2,6 @@ namespace BookStack\View; -use BookStack\View\ViewBlocks\BooksIndexActions; -use BookStack\View\ViewBlocks\BooksIndexNew; -use BookStack\View\ViewBlocks\BooksIndexPopular; -use BookStack\View\ViewBlocks\BooksIndexRecents; -use BookStack\View\ViewBlocks\BooksShowActions; -use BookStack\View\ViewBlocks\BooksShowActivity; -use BookStack\View\ViewBlocks\BooksShowDetails; -use BookStack\View\ViewBlocks\BooksShowSearchForm; -use BookStack\View\ViewBlocks\BooksShowShelves; -use BookStack\View\ViewBlocks\BooksShowTags; -use BookStack\View\ViewBlocks\ChaptersShowActions; -use BookStack\View\ViewBlocks\ChaptersShowBookTree; -use BookStack\View\ViewBlocks\ChaptersShowDetails; -use BookStack\View\ViewBlocks\ChaptersShowSearchForm; -use BookStack\View\ViewBlocks\ChaptersShowTags; -use BookStack\View\ViewBlocks\HomeActions; -use BookStack\View\ViewBlocks\HomeRecentActivity; -use BookStack\View\ViewBlocks\HomeRecentDrafts; -use BookStack\View\ViewBlocks\HomeRecentlyUpdatedPages; -use BookStack\View\ViewBlocks\HomeRecentlyViewedOrRecentBooks; -use BookStack\View\ViewBlocks\HomeTopFavourites; -use BookStack\View\ViewBlocks\PagesShowActions; -use BookStack\View\ViewBlocks\PagesShowAttachments; -use BookStack\View\ViewBlocks\PagesShowBookTree; -use BookStack\View\ViewBlocks\PagesShowDetails; -use BookStack\View\ViewBlocks\PagesShowPageNav; -use BookStack\View\ViewBlocks\PagesShowTags; -use BookStack\View\ViewBlocks\ShelvesIndexActions; -use BookStack\View\ViewBlocks\ShelvesIndexNew; -use BookStack\View\ViewBlocks\ShelvesIndexPopular; -use BookStack\View\ViewBlocks\ShelvesIndexRecents; -use BookStack\View\ViewBlocks\ShelvesShowActions; -use BookStack\View\ViewBlocks\ShelvesShowActivity; -use BookStack\View\ViewBlocks\ShelvesShowDetails; -use BookStack\View\ViewBlocks\ShelvesShowTags; use Illuminate\Contracts\Container\BindingResolutionException; class ViewBlockManager @@ -44,98 +9,7 @@ class ViewBlockManager /** * @var array[]>> */ - protected array $blocksByLocationAndPosition = [ - 'home-default' => [ - 'left' => [ - HomeRecentDrafts::class, - HomeRecentlyViewedOrRecentBooks::class, - ], - 'center' => [ - HomeTopFavourites::class, - HomeRecentlyUpdatedPages::class, - ], - 'right' => [ - HomeRecentActivity::class, - ], - ], - 'home-non-default' => [ - 'left' => [ - HomeRecentDrafts::class, - HomeTopFavourites::class, - HomeRecentlyViewedOrRecentBooks::class, - HomeRecentlyUpdatedPages::class, - HomeRecentActivity::class, - ], - 'right' => [ - HomeActions::class, - ], - ], - 'shelves-index' => [ - 'left' => [ - ShelvesIndexRecents::class, - ShelvesIndexPopular::class, - ShelvesIndexNew::class, - ], - 'right' => [ - ShelvesIndexActions::class, - ], - ], - 'shelves-show' => [ - 'left' => [ - ShelvesShowTags::class, - ShelvesShowDetails::class, - ShelvesShowActivity::class, - ], - 'right' => [ - ShelvesShowActions::class, - ], - ], - 'books-index' => [ - 'left' => [ - BooksIndexRecents::class, - BooksIndexPopular::class, - BooksIndexNew::class, - ], - 'right' => [ - BooksIndexActions::class, - ], - ], - 'books-show' => [ - 'left' => [ - BooksShowSearchForm::class, - BooksShowTags::class, - BooksShowShelves::class, - BooksShowActivity::class, - ], - 'right' => [ - BooksShowDetails::class, - BooksShowActions::class, - ], - ], - 'chapters-show' => [ - 'left' => [ - ChaptersShowSearchForm::class, - ChaptersShowTags::class, - ChaptersShowBookTree::class, - ], - 'right' => [ - ChaptersShowDetails::class, - ChaptersShowActions::class, - ], - ], - 'pages-show' => [ - 'left' => [ - PagesShowTags::class, - PagesShowAttachments::class, - PagesShowPageNav::class, - PagesShowBookTree::class, - ], - 'right' => [ - PagesShowDetails::class, - PagesShowActions::class, - ], - ], - ]; + protected array $blocksByLocationAndPosition = []; /** * Register a block type to be displayed at the given location and position. @@ -162,7 +36,10 @@ public function register(string $location, string $position, string $blockClass) */ public function getForLocation(string $location, string $position): array { - $sections = array_unique($this->blocksByLocationAndPosition[$location][$position] ?? []); + $defaults = ViewBlockDefaults::getForLocation($location)[$position] ?? []; + $registered = $this->blocksByLocationAndPosition[$location][$position] ?? []; + $sections = array_unique(array_merge($defaults, $registered)); + return array_map(function (string $className) { return app()->make($className); }, $sections); diff --git a/app/View/ViewBlocks/BooksIndexActions.php b/app/View/ViewBlocks/BooksIndexActions.php index 8e6721ddf25..2802809f5bf 100644 --- a/app/View/ViewBlocks/BooksIndexActions.php +++ b/app/View/ViewBlocks/BooksIndexActions.php @@ -8,6 +8,7 @@ class BooksIndexActions extends ViewBlock { protected string $view = 'books.parts.index-sidebar-section-actions'; + protected string $labelTranslationKey = 'common.actions'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/BooksIndexNew.php b/app/View/ViewBlocks/BooksIndexNew.php index 76d2750ba93..ef88976e34f 100644 --- a/app/View/ViewBlocks/BooksIndexNew.php +++ b/app/View/ViewBlocks/BooksIndexNew.php @@ -9,6 +9,7 @@ class BooksIndexNew extends ViewBlock { protected string $view = 'books.parts.index-sidebar-section-new'; + protected string $labelTranslationKey = 'entities.books_new'; public function __construct( protected BookQueries $queries, diff --git a/app/View/ViewBlocks/BooksIndexPopular.php b/app/View/ViewBlocks/BooksIndexPopular.php index ee3138f79de..6428a6098c3 100644 --- a/app/View/ViewBlocks/BooksIndexPopular.php +++ b/app/View/ViewBlocks/BooksIndexPopular.php @@ -9,6 +9,7 @@ class BooksIndexPopular extends ViewBlock { protected string $view = 'books.parts.index-sidebar-section-popular'; + protected string $labelTranslationKey = 'entities.books_popular'; public function __construct( protected BookQueries $queries, diff --git a/app/View/ViewBlocks/BooksIndexRecents.php b/app/View/ViewBlocks/BooksIndexRecents.php index 1c7b865d8dd..a6bb90a84bf 100644 --- a/app/View/ViewBlocks/BooksIndexRecents.php +++ b/app/View/ViewBlocks/BooksIndexRecents.php @@ -9,6 +9,7 @@ class BooksIndexRecents extends ViewBlock { protected string $view = 'books.parts.index-sidebar-section-recents'; + protected string $labelTranslationKey = 'entities.recently_viewed'; public function __construct( protected BookQueries $queries, diff --git a/app/View/ViewBlocks/BooksShowActions.php b/app/View/ViewBlocks/BooksShowActions.php index 155c0c7ba85..4f868e4a3df 100644 --- a/app/View/ViewBlocks/BooksShowActions.php +++ b/app/View/ViewBlocks/BooksShowActions.php @@ -10,6 +10,7 @@ class BooksShowActions extends ViewBlock { protected string $view = 'books.parts.show-sidebar-section-actions'; + protected string $labelTranslationKey = 'common.actions'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/BooksShowActivity.php b/app/View/ViewBlocks/BooksShowActivity.php index ecf626df526..e5c0acdd264 100644 --- a/app/View/ViewBlocks/BooksShowActivity.php +++ b/app/View/ViewBlocks/BooksShowActivity.php @@ -10,6 +10,7 @@ class BooksShowActivity extends ViewBlock { protected string $view = 'books.parts.show-sidebar-section-activity'; + protected string $labelTranslationKey = 'entities.recent_activity'; public function __construct( protected ActivityQueries $activityQueries, diff --git a/app/View/ViewBlocks/BooksShowDetails.php b/app/View/ViewBlocks/BooksShowDetails.php index 9a0ef8b4786..ccd7a770434 100644 --- a/app/View/ViewBlocks/BooksShowDetails.php +++ b/app/View/ViewBlocks/BooksShowDetails.php @@ -11,6 +11,7 @@ class BooksShowDetails extends ViewBlock { protected string $view = 'books.parts.show-sidebar-section-details'; + protected string $labelTranslationKey = 'common.details'; public function __construct( protected ReferenceFetcher $referenceFetcher, diff --git a/app/View/ViewBlocks/BooksShowSearchForm.php b/app/View/ViewBlocks/BooksShowSearchForm.php index 061875d3dc1..492579505d4 100644 --- a/app/View/ViewBlocks/BooksShowSearchForm.php +++ b/app/View/ViewBlocks/BooksShowSearchForm.php @@ -8,6 +8,7 @@ class BooksShowSearchForm extends ViewBlock { protected string $view = 'entities.search-form'; + protected string $labelTranslationKey = 'common.search'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/BooksShowShelves.php b/app/View/ViewBlocks/BooksShowShelves.php index 42d8325895f..310bdffef70 100644 --- a/app/View/ViewBlocks/BooksShowShelves.php +++ b/app/View/ViewBlocks/BooksShowShelves.php @@ -9,6 +9,7 @@ class BooksShowShelves extends ViewBlock { protected string $view = 'books.parts.show-sidebar-section-shelves'; + protected string $labelTranslationKey = 'entities.shelves'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/BooksShowTags.php b/app/View/ViewBlocks/BooksShowTags.php index 5c5aa8fd9c6..ac9f4c1ef30 100644 --- a/app/View/ViewBlocks/BooksShowTags.php +++ b/app/View/ViewBlocks/BooksShowTags.php @@ -8,6 +8,7 @@ class BooksShowTags extends ViewBlock { protected string $view = 'books.parts.show-sidebar-section-tags'; + protected string $labelTranslationKey = 'entities.tags'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/ChaptersShowActions.php b/app/View/ViewBlocks/ChaptersShowActions.php index 9b6137a20ef..6fe1b69550a 100644 --- a/app/View/ViewBlocks/ChaptersShowActions.php +++ b/app/View/ViewBlocks/ChaptersShowActions.php @@ -10,6 +10,7 @@ class ChaptersShowActions extends ViewBlock { protected string $view = 'chapters.parts.show-sidebar-section-actions'; + protected string $labelTranslationKey = 'common.actions'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/ChaptersShowBookTree.php b/app/View/ViewBlocks/ChaptersShowBookTree.php index 827e8d9175d..3f6d93418d7 100644 --- a/app/View/ViewBlocks/ChaptersShowBookTree.php +++ b/app/View/ViewBlocks/ChaptersShowBookTree.php @@ -9,6 +9,7 @@ class ChaptersShowBookTree extends ViewBlock { protected string $view = 'entities.book-tree'; + protected string $labelTranslationKey = 'entities.books_navigation'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/ChaptersShowDetails.php b/app/View/ViewBlocks/ChaptersShowDetails.php index fd235fbe1fb..7a90c905809 100644 --- a/app/View/ViewBlocks/ChaptersShowDetails.php +++ b/app/View/ViewBlocks/ChaptersShowDetails.php @@ -12,6 +12,7 @@ class ChaptersShowDetails extends ViewBlock { protected string $view = 'chapters.parts.show-sidebar-section-details'; + protected string $labelTranslationKey = 'common.details'; public function __construct( protected ReferenceFetcher $referenceFetcher, diff --git a/app/View/ViewBlocks/ChaptersShowSearchForm.php b/app/View/ViewBlocks/ChaptersShowSearchForm.php index 92664e5f554..6c2b8aa5a94 100644 --- a/app/View/ViewBlocks/ChaptersShowSearchForm.php +++ b/app/View/ViewBlocks/ChaptersShowSearchForm.php @@ -8,6 +8,7 @@ class ChaptersShowSearchForm extends ViewBlock { protected string $view = 'entities.search-form'; + protected string $labelTranslationKey = 'common.search'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/ChaptersShowTags.php b/app/View/ViewBlocks/ChaptersShowTags.php index 198604eee82..fa7fa200df3 100644 --- a/app/View/ViewBlocks/ChaptersShowTags.php +++ b/app/View/ViewBlocks/ChaptersShowTags.php @@ -9,6 +9,7 @@ class ChaptersShowTags extends ViewBlock { protected string $view = 'chapters.parts.show-sidebar-section-tags'; + protected string $labelTranslationKey = 'entities.tags'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/HomeActions.php b/app/View/ViewBlocks/HomeActions.php index f4e4295b88c..2e64c97fb2d 100644 --- a/app/View/ViewBlocks/HomeActions.php +++ b/app/View/ViewBlocks/HomeActions.php @@ -3,11 +3,11 @@ namespace BookStack\View\ViewBlocks; use BookStack\View\ViewBlock; -use Illuminate\Http\Request; class HomeActions extends ViewBlock { protected string $view = 'home.parts.configured-section-actions'; + protected string $labelTranslationKey = 'common.actions'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/HomeRecentActivity.php b/app/View/ViewBlocks/HomeRecentActivity.php index 1f915061c12..7b5a74ecba2 100644 --- a/app/View/ViewBlocks/HomeRecentActivity.php +++ b/app/View/ViewBlocks/HomeRecentActivity.php @@ -13,6 +13,11 @@ public function __construct( ) { } + public function getLabel(): string + { + return trans('entities.recent_activity'); + } + public function getView(array $viewData): string { if ($viewData['homeView'] === 'default') { diff --git a/app/View/ViewBlocks/HomeRecentDrafts.php b/app/View/ViewBlocks/HomeRecentDrafts.php index 71586d83a19..e65078cb4ea 100644 --- a/app/View/ViewBlocks/HomeRecentDrafts.php +++ b/app/View/ViewBlocks/HomeRecentDrafts.php @@ -12,6 +12,11 @@ public function __construct( ) { } + public function getLabel(): string + { + return trans('entities.my_recent_drafts'); + } + public function getView(array $viewData): string { if ($viewData['homeView'] === 'default') { diff --git a/app/View/ViewBlocks/HomeRecentlyUpdatedPages.php b/app/View/ViewBlocks/HomeRecentlyUpdatedPages.php index 3f669ee6eb7..b56a91acd5a 100644 --- a/app/View/ViewBlocks/HomeRecentlyUpdatedPages.php +++ b/app/View/ViewBlocks/HomeRecentlyUpdatedPages.php @@ -13,6 +13,11 @@ public function __construct( ) { } + public function getLabel(): string + { + return trans('entities.recently_updated_pages'); + } + public function getView(array $viewData): string { if ($viewData['homeView'] === 'default') { diff --git a/app/View/ViewBlocks/HomeRecentlyViewedOrRecentBooks.php b/app/View/ViewBlocks/HomeRecentlyViewedOrRecentBooks.php index 7db3d793590..99666e2c811 100644 --- a/app/View/ViewBlocks/HomeRecentlyViewedOrRecentBooks.php +++ b/app/View/ViewBlocks/HomeRecentlyViewedOrRecentBooks.php @@ -16,6 +16,12 @@ public function __construct( ) { } + public function getLabel(): string + { + $key = user()->isGuest() ? 'books_recent' : 'my_recently_viewed'; + return trans("entities.{$key}"); + } + public function getView(array $viewData): string { if ($viewData['homeView'] === 'default') { diff --git a/app/View/ViewBlocks/HomeTopFavourites.php b/app/View/ViewBlocks/HomeTopFavourites.php index 9ce84aa3dd1..be753a719ec 100644 --- a/app/View/ViewBlocks/HomeTopFavourites.php +++ b/app/View/ViewBlocks/HomeTopFavourites.php @@ -13,6 +13,11 @@ public function __construct( ) { } + public function getLabel(): string + { + return trans('entities.my_most_viewed_favourites'); + } + public function getView(array $viewData): string { if ($viewData['homeView'] === 'default') { diff --git a/app/View/ViewBlocks/PagesShowActions.php b/app/View/ViewBlocks/PagesShowActions.php index 5486b59a45b..8abfc8a6e93 100644 --- a/app/View/ViewBlocks/PagesShowActions.php +++ b/app/View/ViewBlocks/PagesShowActions.php @@ -10,6 +10,7 @@ class PagesShowActions extends ViewBlock { protected string $view = 'pages.parts.show-sidebar-section-actions'; + protected string $labelTranslationKey = 'common.actions'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/PagesShowAttachments.php b/app/View/ViewBlocks/PagesShowAttachments.php index 5d0cd23baab..baf8713f189 100644 --- a/app/View/ViewBlocks/PagesShowAttachments.php +++ b/app/View/ViewBlocks/PagesShowAttachments.php @@ -9,6 +9,7 @@ class PagesShowAttachments extends ViewBlock { protected string $view = 'pages.parts.show-sidebar-section-attachments'; + protected string $labelTranslationKey = 'entities.pages_attachments'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/PagesShowBookTree.php b/app/View/ViewBlocks/PagesShowBookTree.php index b0947a208cf..05c4c9a1fd1 100644 --- a/app/View/ViewBlocks/PagesShowBookTree.php +++ b/app/View/ViewBlocks/PagesShowBookTree.php @@ -9,6 +9,7 @@ class PagesShowBookTree extends ViewBlock { protected string $view = 'entities.book-tree'; + protected string $labelTranslationKey = 'entities.books_navigation'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/PagesShowDetails.php b/app/View/ViewBlocks/PagesShowDetails.php index 2dfd61417ca..eb50e859cc2 100644 --- a/app/View/ViewBlocks/PagesShowDetails.php +++ b/app/View/ViewBlocks/PagesShowDetails.php @@ -12,6 +12,7 @@ class PagesShowDetails extends ViewBlock { protected string $view = 'pages.parts.show-sidebar-section-details'; + protected string $labelTranslationKey = 'common.details'; public function __construct( protected ReferenceFetcher $referenceFetcher, diff --git a/app/View/ViewBlocks/PagesShowPageNav.php b/app/View/ViewBlocks/PagesShowPageNav.php index dbee578ab31..cbde72f2158 100644 --- a/app/View/ViewBlocks/PagesShowPageNav.php +++ b/app/View/ViewBlocks/PagesShowPageNav.php @@ -10,6 +10,7 @@ class PagesShowPageNav extends ViewBlock { protected string $view = 'pages.parts.show-sidebar-section-page-nav'; + protected string $labelTranslationKey = 'entities.pages_navigation'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/PagesShowTags.php b/app/View/ViewBlocks/PagesShowTags.php index a2197a16130..c200f197a3c 100644 --- a/app/View/ViewBlocks/PagesShowTags.php +++ b/app/View/ViewBlocks/PagesShowTags.php @@ -9,6 +9,7 @@ class PagesShowTags extends ViewBlock { protected string $view = 'pages.parts.show-sidebar-section-tags'; + protected string $labelTranslationKey = 'entities.tags'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/ShelvesIndexActions.php b/app/View/ViewBlocks/ShelvesIndexActions.php index 2cc4361169a..81a35ded653 100644 --- a/app/View/ViewBlocks/ShelvesIndexActions.php +++ b/app/View/ViewBlocks/ShelvesIndexActions.php @@ -8,6 +8,7 @@ class ShelvesIndexActions extends ViewBlock { protected string $view = 'shelves.parts.index-sidebar-section-actions'; + protected string $labelTranslationKey = 'common.actions'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/ShelvesIndexNew.php b/app/View/ViewBlocks/ShelvesIndexNew.php index 1d6af72c0ed..5a09a46af72 100644 --- a/app/View/ViewBlocks/ShelvesIndexNew.php +++ b/app/View/ViewBlocks/ShelvesIndexNew.php @@ -9,6 +9,7 @@ class ShelvesIndexNew extends ViewBlock { protected string $view = 'shelves.parts.index-sidebar-section-new'; + protected string $labelTranslationKey = 'entities.shelves_new'; public function __construct( protected BookshelfQueries $queries, diff --git a/app/View/ViewBlocks/ShelvesIndexPopular.php b/app/View/ViewBlocks/ShelvesIndexPopular.php index fc2950b9260..5bf811ac527 100644 --- a/app/View/ViewBlocks/ShelvesIndexPopular.php +++ b/app/View/ViewBlocks/ShelvesIndexPopular.php @@ -9,6 +9,7 @@ class ShelvesIndexPopular extends ViewBlock { protected string $view = 'shelves.parts.index-sidebar-section-popular'; + protected string $labelTranslationKey = 'entities.shelves_popular'; public function __construct( protected BookshelfQueries $queries, diff --git a/app/View/ViewBlocks/ShelvesIndexRecents.php b/app/View/ViewBlocks/ShelvesIndexRecents.php index 6570841a922..219cae5597d 100644 --- a/app/View/ViewBlocks/ShelvesIndexRecents.php +++ b/app/View/ViewBlocks/ShelvesIndexRecents.php @@ -9,6 +9,7 @@ class ShelvesIndexRecents extends ViewBlock { protected string $view = 'shelves.parts.index-sidebar-section-recents'; + protected string $labelTranslationKey = 'entities.recently_viewed'; public function __construct( protected BookshelfQueries $queries, diff --git a/app/View/ViewBlocks/ShelvesShowActions.php b/app/View/ViewBlocks/ShelvesShowActions.php index d1bb965c834..d9683714db2 100644 --- a/app/View/ViewBlocks/ShelvesShowActions.php +++ b/app/View/ViewBlocks/ShelvesShowActions.php @@ -9,6 +9,7 @@ class ShelvesShowActions extends ViewBlock { protected string $view = 'shelves.parts.show-sidebar-section-actions'; + protected string $labelTranslationKey = 'common.actions'; public function withData(array $viewData): array { diff --git a/app/View/ViewBlocks/ShelvesShowActivity.php b/app/View/ViewBlocks/ShelvesShowActivity.php index 40e715bcdbc..e6bb612cc12 100644 --- a/app/View/ViewBlocks/ShelvesShowActivity.php +++ b/app/View/ViewBlocks/ShelvesShowActivity.php @@ -10,6 +10,7 @@ class ShelvesShowActivity extends ViewBlock { protected string $view = 'shelves.parts.show-sidebar-section-activity'; + protected string $labelTranslationKey = 'entities.recent_activity'; public function __construct( protected ActivityQueries $activityQueries, diff --git a/app/View/ViewBlocks/ShelvesShowDetails.php b/app/View/ViewBlocks/ShelvesShowDetails.php index 413b4796c24..1d5d69cec63 100644 --- a/app/View/ViewBlocks/ShelvesShowDetails.php +++ b/app/View/ViewBlocks/ShelvesShowDetails.php @@ -10,6 +10,7 @@ class ShelvesShowDetails extends ViewBlock { protected string $view = 'shelves.parts.show-sidebar-section-details'; + protected string $labelTranslationKey = 'common.details'; public function __construct( protected ReferenceFetcher $referenceFetcher, diff --git a/app/View/ViewBlocks/ShelvesShowTags.php b/app/View/ViewBlocks/ShelvesShowTags.php index 9a61cc94d74..c8efa24314f 100644 --- a/app/View/ViewBlocks/ShelvesShowTags.php +++ b/app/View/ViewBlocks/ShelvesShowTags.php @@ -8,6 +8,7 @@ class ShelvesShowTags extends ViewBlock { protected string $view = 'shelves.parts.show-sidebar-section-tags'; + protected string $labelTranslationKey = 'entities.tags'; public function withData(array $viewData): array { From 3205e73bb933cfcd26c0a74fedde99bac1afcb23 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Mon, 10 Aug 2026 19:18:05 +0100 Subject: [PATCH 11/37] User Prefs: Added new interface preferences section --- .../Controllers/UserAccountController.php | 14 +++++ app/View/ViewBlockDefaults.php | 22 ++++++++ app/View/ViewBlockManager.php | 21 ++++++++ lang/en/preferences.php | 6 +++ resources/icons/interface.svg | 1 + .../views/users/account/interface.blade.php | 53 +++++++++++++++++++ .../views/users/account/layout.blade.php | 1 + routes/web.php | 1 + 8 files changed, 119 insertions(+) create mode 100644 resources/icons/interface.svg create mode 100644 resources/views/users/account/interface.blade.php diff --git a/app/Users/Controllers/UserAccountController.php b/app/Users/Controllers/UserAccountController.php index 21816d5b89b..a72025422e4 100644 --- a/app/Users/Controllers/UserAccountController.php +++ b/app/Users/Controllers/UserAccountController.php @@ -10,6 +10,7 @@ use BookStack\Settings\UserShortcutMap; use BookStack\Uploads\ImageRepo; use BookStack\Users\UserRepo; +use BookStack\View\ViewBlockManager; use Closure; use Illuminate\Http\Request; use Illuminate\Validation\Rules\Password; @@ -159,6 +160,19 @@ public function updateNotifications(Request $request) return redirect('/my-account/notifications'); } + /** + * Show the view for the "Interface Preferences" user account area. + */ + public function showInterface(ViewBlockManager $viewBlockManager) + { + // TODO - Handle language save + + return view('users.account.interface', [ + 'category' => 'interface', + 'namedLocations' => $viewBlockManager->getNamedLocations(), + ]); + } + /** * Show the view for the "Access & Security" account options. */ diff --git a/app/View/ViewBlockDefaults.php b/app/View/ViewBlockDefaults.php index 33a08adc1b0..1e235b7515a 100644 --- a/app/View/ViewBlockDefaults.php +++ b/app/View/ViewBlockDefaults.php @@ -107,4 +107,26 @@ public static function getForLocation(string $location): array { return self::$defaults[$location] ?? []; } + + /** + * Get the locations for all default blocks. + */ + public static function getLocations(): array + { + return array_keys(self::$defaults); + } + + public static function getLocationLabels(): array + { + return [ + 'home-default' => trans('common.homepage'), + 'home-non-default' => trans('preferences.layouts_home_non_default'), + 'shelves-index' => trans('entities.shelves'), + 'shelves-show' => trans('entities.shelf'), + 'books-index' => trans('entities.books'), + 'books-show' => trans('entities.book'), + 'chapters-show' => trans('entities.chapter'), + 'pages-show' => trans('entities.page'), + ]; + } } diff --git a/app/View/ViewBlockManager.php b/app/View/ViewBlockManager.php index 00535b2c127..939e4107d75 100644 --- a/app/View/ViewBlockManager.php +++ b/app/View/ViewBlockManager.php @@ -44,4 +44,25 @@ public function getForLocation(string $location, string $position): array return app()->make($className); }, $sections); } + + /** + * Get the names of all locations where blocks are registered. + * Returns an array where the keys are location strings, and the + * values are translated labels for that location. + * @return array + */ + public function getNamedLocations(): array + { + $labels = ViewBlockDefaults::getLocationLabels(); + $defaults = ViewBlockDefaults::getLocations(); + $registered = array_keys($this->blocksByLocationAndPosition); + $merged = array_unique(array_merge($defaults, $registered)); + + $results = []; + foreach ($merged as $location) { + $results[$location] = $labels[$location] ?? $location; + } + + return $results; + } } diff --git a/lang/en/preferences.php b/lang/en/preferences.php index f4459d738e4..e197efd9755 100644 --- a/lang/en/preferences.php +++ b/lang/en/preferences.php @@ -19,6 +19,12 @@ 'shortcuts_update_success' => 'Shortcut preferences have been updated!', 'shortcuts_overview_desc' => 'Manage keyboard shortcuts you can use to navigate the system user interface.', + 'interface' => 'Interface Preferences', + 'interface_desc' => 'Customize various user interface elements you see across the application.', + 'layouts' => 'Customize UI Layout', + 'layouts_desc' => 'Customize the layout of sections shown in the user interface across various views.', + 'layouts_home_non_default' => 'Homepage (non-default)', + 'notifications' => 'Notification Preferences', 'notifications_desc' => 'Control the email notifications you receive when certain activity is performed within the system.', 'notifications_opt_own_page_changes' => 'Notify upon changes to pages I own', diff --git a/resources/icons/interface.svg b/resources/icons/interface.svg new file mode 100644 index 00000000000..af1c5fc4975 --- /dev/null +++ b/resources/icons/interface.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/resources/views/users/account/interface.blade.php b/resources/views/users/account/interface.blade.php new file mode 100644 index 00000000000..8831b055ada --- /dev/null +++ b/resources/views/users/account/interface.blade.php @@ -0,0 +1,53 @@ +@extends('users.account.layout') + +@section('main') +
    +
    + {{ method_field('put') }} + {{ csrf_field() }} + +

    {{ trans('preferences.interface') }}

    +

    {{ trans('preferences.interface_desc') }}

    + +
    + @include('users.parts.language-option-row', ['value' => old('language') ?? user()->getLocale()->appLocale()]) +
    + +
    + +
    + +
    +
    + +
    +

    {{ trans('preferences.layouts') }}

    +

    {{ trans('preferences.layouts_desc') }}

    + +
    + @foreach($namedLocations as $locationKey => $locationName) +
    +
    + {{ $locationName }} +
    +
    + {{ trans('common.configure') }} +
    +
    + @endforeach +
    + +
    + +
    +
    +
    +

    {{ trans('preferences.shortcuts_interface') }}

    +

    {{ trans('preferences.shortcuts_overview_desc') }}

    +
    +
    + {{ trans('common.open') }} +
    +
    +
    +@stop diff --git a/resources/views/users/account/layout.blade.php b/resources/views/users/account/layout.blade.php index df8ebc2d904..94f1f328de0 100644 --- a/resources/views/users/account/layout.blade.php +++ b/resources/views/users/account/layout.blade.php @@ -11,6 +11,7 @@