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