]> BookStack Code Mirror - bookstack/blob - routes/web.php
Fixed permission row permission check
[bookstack] / routes / web.php
1 <?php
2
3 use BookStack\Http\Controllers\Api;
4 use BookStack\Http\Controllers\AttachmentController;
5 use BookStack\Http\Controllers\AuditLogController;
6 use BookStack\Http\Controllers\Auth;
7 use BookStack\Http\Controllers\BookController;
8 use BookStack\Http\Controllers\BookExportController;
9 use BookStack\Http\Controllers\BookshelfController;
10 use BookStack\Http\Controllers\BookSortController;
11 use BookStack\Http\Controllers\ChapterController;
12 use BookStack\Http\Controllers\ChapterExportController;
13 use BookStack\Http\Controllers\CommentController;
14 use BookStack\Http\Controllers\FavouriteController;
15 use BookStack\Http\Controllers\HomeController;
16 use BookStack\Http\Controllers\Images;
17 use BookStack\Http\Controllers\MaintenanceController;
18 use BookStack\Http\Controllers\PageController;
19 use BookStack\Http\Controllers\PageExportController;
20 use BookStack\Http\Controllers\PageRevisionController;
21 use BookStack\Http\Controllers\PageTemplateController;
22 use BookStack\Http\Controllers\PermissionsController;
23 use BookStack\Http\Controllers\RecycleBinController;
24 use BookStack\Http\Controllers\ReferenceController;
25 use BookStack\Http\Controllers\RoleController;
26 use BookStack\Http\Controllers\SearchController;
27 use BookStack\Http\Controllers\SettingController;
28 use BookStack\Http\Controllers\StatusController;
29 use BookStack\Http\Controllers\TagController;
30 use BookStack\Http\Controllers\UserApiTokenController;
31 use BookStack\Http\Controllers\UserController;
32 use BookStack\Http\Controllers\UserProfileController;
33 use BookStack\Http\Controllers\UserSearchController;
34 use BookStack\Http\Controllers\WebhookController;
35 use BookStack\Http\Middleware\VerifyCsrfToken;
36 use Illuminate\Session\Middleware\StartSession;
37 use Illuminate\Support\Facades\Route;
38 use Illuminate\View\Middleware\ShareErrorsFromSession;
39
40 Route::get('/status', [StatusController::class, 'show']);
41 Route::get('/robots.txt', [HomeController::class, 'robots']);
42
43 // Authenticated routes...
44 Route::middleware('auth')->group(function () {
45
46     // Secure images routing
47     Route::get('/uploads/images/{path}', [Images\ImageController::class, 'showImage'])
48         ->where('path', '.*$');
49
50     // API docs routes
51     Route::redirect('/api', '/api/docs');
52     Route::get('/api/docs', [Api\ApiDocsController::class, 'display']);
53
54     Route::get('/pages/recently-updated', [PageController::class, 'showRecentlyUpdated']);
55
56     // Shelves
57     Route::get('/create-shelf', [BookshelfController::class, 'create']);
58     Route::get('/shelves/', [BookshelfController::class, 'index']);
59     Route::post('/shelves/', [BookshelfController::class, 'store']);
60     Route::get('/shelves/{slug}/edit', [BookshelfController::class, 'edit']);
61     Route::get('/shelves/{slug}/delete', [BookshelfController::class, 'showDelete']);
62     Route::get('/shelves/{slug}', [BookshelfController::class, 'show']);
63     Route::put('/shelves/{slug}', [BookshelfController::class, 'update']);
64     Route::delete('/shelves/{slug}', [BookshelfController::class, 'destroy']);
65     Route::get('/shelves/{slug}/permissions', [PermissionsController::class, 'showForShelf']);
66     Route::put('/shelves/{slug}/permissions', [PermissionsController::class, 'updateForShelf']);
67     Route::post('/shelves/{slug}/copy-permissions', [PermissionsController::class, 'copyShelfPermissionsToBooks']);
68     Route::get('/shelves/{slug}/references', [ReferenceController::class, 'shelf']);
69
70     // Book Creation
71     Route::get('/shelves/{shelfSlug}/create-book', [BookController::class, 'create']);
72     Route::post('/shelves/{shelfSlug}/create-book', [BookController::class, 'store']);
73     Route::get('/create-book', [BookController::class, 'create']);
74
75     // Books
76     Route::get('/books/', [BookController::class, 'index']);
77     Route::post('/books/', [BookController::class, 'store']);
78     Route::get('/books/{slug}/edit', [BookController::class, 'edit']);
79     Route::put('/books/{slug}', [BookController::class, 'update']);
80     Route::delete('/books/{id}', [BookController::class, 'destroy']);
81     Route::get('/books/{slug}/sort-item', [BookSortController::class, 'showItem']);
82     Route::get('/books/{slug}', [BookController::class, 'show']);
83     Route::get('/books/{bookSlug}/permissions', [PermissionsController::class, 'showForBook']);
84     Route::put('/books/{bookSlug}/permissions', [PermissionsController::class, 'updateForBook']);
85     Route::get('/books/{slug}/delete', [BookController::class, 'showDelete']);
86     Route::get('/books/{bookSlug}/copy', [BookController::class, 'showCopy']);
87     Route::post('/books/{bookSlug}/copy', [BookController::class, 'copy']);
88     Route::post('/books/{bookSlug}/convert-to-shelf', [BookController::class, 'convertToShelf']);
89     Route::get('/books/{bookSlug}/sort', [BookSortController::class, 'show']);
90     Route::put('/books/{bookSlug}/sort', [BookSortController::class, 'update']);
91     Route::get('/books/{slug}/references', [ReferenceController::class, 'book']);
92     Route::get('/books/{bookSlug}/export/html', [BookExportController::class, 'html']);
93     Route::get('/books/{bookSlug}/export/pdf', [BookExportController::class, 'pdf']);
94     Route::get('/books/{bookSlug}/export/markdown', [BookExportController::class, 'markdown']);
95     Route::get('/books/{bookSlug}/export/zip', [BookExportController::class, 'zip']);
96     Route::get('/books/{bookSlug}/export/plaintext', [BookExportController::class, 'plainText']);
97
98     // Pages
99     Route::get('/books/{bookSlug}/create-page', [PageController::class, 'create']);
100     Route::post('/books/{bookSlug}/create-guest-page', [PageController::class, 'createAsGuest']);
101     Route::get('/books/{bookSlug}/draft/{pageId}', [PageController::class, 'editDraft']);
102     Route::post('/books/{bookSlug}/draft/{pageId}', [PageController::class, 'store']);
103     Route::get('/books/{bookSlug}/page/{pageSlug}', [PageController::class, 'show']);
104     Route::get('/books/{bookSlug}/page/{pageSlug}/export/pdf', [PageExportController::class, 'pdf']);
105     Route::get('/books/{bookSlug}/page/{pageSlug}/export/html', [PageExportController::class, 'html']);
106     Route::get('/books/{bookSlug}/page/{pageSlug}/export/markdown', [PageExportController::class, 'markdown']);
107     Route::get('/books/{bookSlug}/page/{pageSlug}/export/plaintext', [PageExportController::class, 'plainText']);
108     Route::get('/books/{bookSlug}/page/{pageSlug}/edit', [PageController::class, 'edit']);
109     Route::get('/books/{bookSlug}/page/{pageSlug}/move', [PageController::class, 'showMove']);
110     Route::put('/books/{bookSlug}/page/{pageSlug}/move', [PageController::class, 'move']);
111     Route::get('/books/{bookSlug}/page/{pageSlug}/copy', [PageController::class, 'showCopy']);
112     Route::post('/books/{bookSlug}/page/{pageSlug}/copy', [PageController::class, 'copy']);
113     Route::get('/books/{bookSlug}/page/{pageSlug}/delete', [PageController::class, 'showDelete']);
114     Route::get('/books/{bookSlug}/draft/{pageId}/delete', [PageController::class, 'showDeleteDraft']);
115     Route::get('/books/{bookSlug}/page/{pageSlug}/permissions', [PermissionsController::class, 'showForPage']);
116     Route::put('/books/{bookSlug}/page/{pageSlug}/permissions', [PermissionsController::class, 'updateForPage']);
117     Route::get('/books/{bookSlug}/page/{pageSlug}/references', [ReferenceController::class, 'page']);
118     Route::put('/books/{bookSlug}/page/{pageSlug}', [PageController::class, 'update']);
119     Route::delete('/books/{bookSlug}/page/{pageSlug}', [PageController::class, 'destroy']);
120     Route::delete('/books/{bookSlug}/draft/{pageId}', [PageController::class, 'destroyDraft']);
121
122     // Revisions
123     Route::get('/books/{bookSlug}/page/{pageSlug}/revisions', [PageRevisionController::class, 'index']);
124     Route::get('/books/{bookSlug}/page/{pageSlug}/revisions/{revId}', [PageRevisionController::class, 'show']);
125     Route::get('/books/{bookSlug}/page/{pageSlug}/revisions/{revId}/changes', [PageRevisionController::class, 'changes']);
126     Route::put('/books/{bookSlug}/page/{pageSlug}/revisions/{revId}/restore', [PageRevisionController::class, 'restore']);
127     Route::delete('/books/{bookSlug}/page/{pageSlug}/revisions/{revId}/delete', [PageRevisionController::class, 'destroy']);
128
129     // Chapters
130     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/create-page', [PageController::class, 'create']);
131     Route::post('/books/{bookSlug}/chapter/{chapterSlug}/create-guest-page', [PageController::class, 'createAsGuest']);
132     Route::get('/books/{bookSlug}/create-chapter', [ChapterController::class, 'create']);
133     Route::post('/books/{bookSlug}/create-chapter', [ChapterController::class, 'store']);
134     Route::get('/books/{bookSlug}/chapter/{chapterSlug}', [ChapterController::class, 'show']);
135     Route::put('/books/{bookSlug}/chapter/{chapterSlug}', [ChapterController::class, 'update']);
136     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/move', [ChapterController::class, 'showMove']);
137     Route::put('/books/{bookSlug}/chapter/{chapterSlug}/move', [ChapterController::class, 'move']);
138     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/copy', [ChapterController::class, 'showCopy']);
139     Route::post('/books/{bookSlug}/chapter/{chapterSlug}/copy', [ChapterController::class, 'copy']);
140     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/edit', [ChapterController::class, 'edit']);
141     Route::post('/books/{bookSlug}/chapter/{chapterSlug}/convert-to-book', [ChapterController::class, 'convertToBook']);
142     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/permissions', [PermissionsController::class, 'showForChapter']);
143     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/export/pdf', [ChapterExportController::class, 'pdf']);
144     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/export/html', [ChapterExportController::class, 'html']);
145     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/export/markdown', [ChapterExportController::class, 'markdown']);
146     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/export/plaintext', [ChapterExportController::class, 'plainText']);
147     Route::put('/books/{bookSlug}/chapter/{chapterSlug}/permissions', [PermissionsController::class, 'updateForChapter']);
148     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/references', [ReferenceController::class, 'chapter']);
149     Route::get('/books/{bookSlug}/chapter/{chapterSlug}/delete', [ChapterController::class, 'showDelete']);
150     Route::delete('/books/{bookSlug}/chapter/{chapterSlug}', [ChapterController::class, 'destroy']);
151
152     // User Profile routes
153     Route::get('/user/{slug}', [UserProfileController::class, 'show']);
154
155     // Image routes
156     Route::get('/images/gallery', [Images\GalleryImageController::class, 'list']);
157     Route::post('/images/gallery', [Images\GalleryImageController::class, 'create']);
158     Route::get('/images/drawio', [Images\DrawioImageController::class, 'list']);
159     Route::get('/images/drawio/base64/{id}', [Images\DrawioImageController::class, 'getAsBase64']);
160     Route::post('/images/drawio', [Images\DrawioImageController::class, 'create']);
161     Route::get('/images/edit/{id}', [Images\ImageController::class, 'edit']);
162     Route::put('/images/{id}', [Images\ImageController::class, 'update']);
163     Route::delete('/images/{id}', [Images\ImageController::class, 'destroy']);
164
165     // Attachments routes
166     Route::get('/attachments/{id}', [AttachmentController::class, 'get']);
167     Route::post('/attachments/upload', [AttachmentController::class, 'upload']);
168     Route::post('/attachments/upload/{id}', [AttachmentController::class, 'uploadUpdate']);
169     Route::post('/attachments/link', [AttachmentController::class, 'attachLink']);
170     Route::put('/attachments/{id}', [AttachmentController::class, 'update']);
171     Route::get('/attachments/edit/{id}', [AttachmentController::class, 'getUpdateForm']);
172     Route::get('/attachments/get/page/{pageId}', [AttachmentController::class, 'listForPage']);
173     Route::put('/attachments/sort/page/{pageId}', [AttachmentController::class, 'sortForPage']);
174     Route::delete('/attachments/{id}', [AttachmentController::class, 'delete']);
175
176     // AJAX routes
177     Route::put('/ajax/page/{id}/save-draft', [PageController::class, 'saveDraft']);
178     Route::get('/ajax/page/{id}', [PageController::class, 'getPageAjax']);
179     Route::delete('/ajax/page/{id}', [PageController::class, 'ajaxDestroy']);
180
181     // Tag routes
182     Route::get('/tags', [TagController::class, 'index']);
183     Route::get('/ajax/tags/suggest/names', [TagController::class, 'getNameSuggestions']);
184     Route::get('/ajax/tags/suggest/values', [TagController::class, 'getValueSuggestions']);
185
186     Route::get('/ajax/search/entities', [SearchController::class, 'searchEntitiesAjax']);
187
188     // Comments
189     Route::post('/comment/{pageId}', [CommentController::class, 'savePageComment']);
190     Route::put('/comment/{id}', [CommentController::class, 'update']);
191     Route::delete('/comment/{id}', [CommentController::class, 'destroy']);
192
193     // Links
194     Route::get('/link/{id}', [PageController::class, 'redirectFromLink']);
195
196     // Search
197     Route::get('/search', [SearchController::class, 'search']);
198     Route::get('/search/book/{bookId}', [SearchController::class, 'searchBook']);
199     Route::get('/search/chapter/{bookId}', [SearchController::class, 'searchChapter']);
200     Route::get('/search/entity/siblings', [SearchController::class, 'searchSiblings']);
201
202     // User Search
203     Route::get('/search/users/select', [UserSearchController::class, 'forSelect']);
204
205     // Template System
206     Route::get('/templates', [PageTemplateController::class, 'list']);
207     Route::get('/templates/{templateId}', [PageTemplateController::class, 'get']);
208
209     // Favourites
210     Route::get('/favourites', [FavouriteController::class, 'index']);
211     Route::post('/favourites/add', [FavouriteController::class, 'add']);
212     Route::post('/favourites/remove', [FavouriteController::class, 'remove']);
213
214     // Other Pages
215     Route::get('/', [HomeController::class, 'index']);
216     Route::get('/home', [HomeController::class, 'index']);
217
218     // Permissions
219     Route::get('/permissions/form-row/{entityType}/{roleId}', [PermissionsController::class, 'formRowForRole']);
220
221     // Maintenance
222     Route::get('/settings/maintenance', [MaintenanceController::class, 'index']);
223     Route::delete('/settings/maintenance/cleanup-images', [MaintenanceController::class, 'cleanupImages']);
224     Route::post('/settings/maintenance/send-test-email', [MaintenanceController::class, 'sendTestEmail']);
225     Route::post('/settings/maintenance/regenerate-references', [MaintenanceController::class, 'regenerateReferences']);
226
227     // Recycle Bin
228     Route::get('/settings/recycle-bin', [RecycleBinController::class, 'index']);
229     Route::post('/settings/recycle-bin/empty', [RecycleBinController::class, 'empty']);
230     Route::get('/settings/recycle-bin/{id}/destroy', [RecycleBinController::class, 'showDestroy']);
231     Route::delete('/settings/recycle-bin/{id}', [RecycleBinController::class, 'destroy']);
232     Route::get('/settings/recycle-bin/{id}/restore', [RecycleBinController::class, 'showRestore']);
233     Route::post('/settings/recycle-bin/{id}/restore', [RecycleBinController::class, 'restore']);
234
235     // Audit Log
236     Route::get('/settings/audit', [AuditLogController::class, 'index']);
237
238     // Users
239     Route::get('/settings/users', [UserController::class, 'index']);
240     Route::get('/settings/users/create', [UserController::class, 'create']);
241     Route::get('/settings/users/{id}/delete', [UserController::class, 'delete']);
242     Route::patch('/settings/users/{id}/switch-books-view', [UserController::class, 'switchBooksView']);
243     Route::patch('/settings/users/{id}/switch-shelves-view', [UserController::class, 'switchShelvesView']);
244     Route::patch('/settings/users/{id}/switch-shelf-view', [UserController::class, 'switchShelfView']);
245     Route::patch('/settings/users/{id}/change-sort/{type}', [UserController::class, 'changeSort']);
246     Route::patch('/settings/users/{id}/update-expansion-preference/{key}', [UserController::class, 'updateExpansionPreference']);
247     Route::patch('/settings/users/toggle-dark-mode', [UserController::class, 'toggleDarkMode']);
248     Route::patch('/settings/users/update-code-language-favourite', [UserController::class, 'updateCodeLanguageFavourite']);
249     Route::post('/settings/users/create', [UserController::class, 'store']);
250     Route::get('/settings/users/{id}', [UserController::class, 'edit']);
251     Route::put('/settings/users/{id}', [UserController::class, 'update']);
252     Route::delete('/settings/users/{id}', [UserController::class, 'destroy']);
253
254     // User API Tokens
255     Route::get('/settings/users/{userId}/create-api-token', [UserApiTokenController::class, 'create']);
256     Route::post('/settings/users/{userId}/create-api-token', [UserApiTokenController::class, 'store']);
257     Route::get('/settings/users/{userId}/api-tokens/{tokenId}', [UserApiTokenController::class, 'edit']);
258     Route::put('/settings/users/{userId}/api-tokens/{tokenId}', [UserApiTokenController::class, 'update']);
259     Route::get('/settings/users/{userId}/api-tokens/{tokenId}/delete', [UserApiTokenController::class, 'delete']);
260     Route::delete('/settings/users/{userId}/api-tokens/{tokenId}', [UserApiTokenController::class, 'destroy']);
261
262     // Roles
263     Route::get('/settings/roles', [RoleController::class, 'index']);
264     Route::get('/settings/roles/new', [RoleController::class, 'create']);
265     Route::post('/settings/roles/new', [RoleController::class, 'store']);
266     Route::get('/settings/roles/delete/{id}', [RoleController::class, 'showDelete']);
267     Route::delete('/settings/roles/delete/{id}', [RoleController::class, 'delete']);
268     Route::get('/settings/roles/{id}', [RoleController::class, 'edit']);
269     Route::put('/settings/roles/{id}', [RoleController::class, 'update']);
270
271     // Webhooks
272     Route::get('/settings/webhooks', [WebhookController::class, 'index']);
273     Route::get('/settings/webhooks/create', [WebhookController::class, 'create']);
274     Route::post('/settings/webhooks/create', [WebhookController::class, 'store']);
275     Route::get('/settings/webhooks/{id}', [WebhookController::class, 'edit']);
276     Route::put('/settings/webhooks/{id}', [WebhookController::class, 'update']);
277     Route::get('/settings/webhooks/{id}/delete', [WebhookController::class, 'delete']);
278     Route::delete('/settings/webhooks/{id}', [WebhookController::class, 'destroy']);
279
280     // Settings
281     Route::get('/settings', [SettingController::class, 'index'])->name('settings');
282     Route::get('/settings/{category}', [SettingController::class, 'category'])->name('settings.category');
283     Route::post('/settings/{category}', [SettingController::class, 'update']);
284 });
285
286 // MFA routes
287 Route::middleware('mfa-setup')->group(function () {
288     Route::get('/mfa/setup', [Auth\MfaController::class, 'setup']);
289     Route::get('/mfa/totp/generate', [Auth\MfaTotpController::class, 'generate']);
290     Route::post('/mfa/totp/confirm', [Auth\MfaTotpController::class, 'confirm']);
291     Route::get('/mfa/backup_codes/generate', [Auth\MfaBackupCodesController::class, 'generate']);
292     Route::post('/mfa/backup_codes/confirm', [Auth\MfaBackupCodesController::class, 'confirm']);
293 });
294 Route::middleware('guest')->group(function () {
295     Route::get('/mfa/verify', [Auth\MfaController::class, 'verify']);
296     Route::post('/mfa/totp/verify', [Auth\MfaTotpController::class, 'verify']);
297     Route::post('/mfa/backup_codes/verify', [Auth\MfaBackupCodesController::class, 'verify']);
298 });
299 Route::delete('/mfa/{method}/remove', [Auth\MfaController::class, 'remove'])->middleware('auth');
300
301 // Social auth routes
302 Route::get('/login/service/{socialDriver}', [Auth\SocialController::class, 'login']);
303 Route::get('/login/service/{socialDriver}/callback', [Auth\SocialController::class, 'callback']);
304 Route::post('/login/service/{socialDriver}/detach', [Auth\SocialController::class, 'detach'])->middleware('auth');
305 Route::get('/register/service/{socialDriver}', [Auth\SocialController::class, 'register']);
306
307 // Login/Logout routes
308 Route::get('/login', [Auth\LoginController::class, 'getLogin']);
309 Route::post('/login', [Auth\LoginController::class, 'login']);
310 Route::post('/logout', [Auth\LoginController::class, 'logout']);
311 Route::get('/register', [Auth\RegisterController::class, 'getRegister']);
312 Route::get('/register/confirm', [Auth\ConfirmEmailController::class, 'show']);
313 Route::get('/register/confirm/awaiting', [Auth\ConfirmEmailController::class, 'showAwaiting']);
314 Route::post('/register/confirm/resend', [Auth\ConfirmEmailController::class, 'resend']);
315 Route::get('/register/confirm/{token}', [Auth\ConfirmEmailController::class, 'confirm']);
316 Route::post('/register', [Auth\RegisterController::class, 'postRegister']);
317
318 // SAML routes
319 Route::post('/saml2/login', [Auth\Saml2Controller::class, 'login']);
320 Route::post('/saml2/logout', [Auth\Saml2Controller::class, 'logout']);
321 Route::get('/saml2/metadata', [Auth\Saml2Controller::class, 'metadata']);
322 Route::get('/saml2/sls', [Auth\Saml2Controller::class, 'sls']);
323 Route::post('/saml2/acs', [Auth\Saml2Controller::class, 'startAcs'])->withoutMiddleware([
324     StartSession::class,
325     ShareErrorsFromSession::class,
326     VerifyCsrfToken::class,
327 ]);
328 Route::get('/saml2/acs', [Auth\Saml2Controller::class, 'processAcs']);
329
330 // OIDC routes
331 Route::post('/oidc/login', [Auth\OidcController::class, 'login']);
332 Route::get('/oidc/callback', [Auth\OidcController::class, 'callback']);
333
334 // User invitation routes
335 Route::get('/register/invite/{token}', [Auth\UserInviteController::class, 'showSetPassword']);
336 Route::post('/register/invite/{token}', [Auth\UserInviteController::class, 'setPassword']);
337
338 // Password reset link request routes
339 Route::get('/password/email', [Auth\ForgotPasswordController::class, 'showLinkRequestForm']);
340 Route::post('/password/email', [Auth\ForgotPasswordController::class, 'sendResetLinkEmail']);
341
342 // Password reset routes
343 Route::get('/password/reset/{token}', [Auth\ResetPasswordController::class, 'showResetForm']);
344 Route::post('/password/reset', [Auth\ResetPasswordController::class, 'reset']);
345
346 // Metadata routes
347 Route::view('/help/wysiwyg', 'help.wysiwyg');
348
349 Route::fallback([HomeController::class, 'notFound'])->name('fallback');