BookStack Code Mirror - bookstack/blob

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}/copy', [BookController::class, 'showCopy']);

84 Route::post('/books/{bookSlug}/copy', [BookController::class, 'copy']);

85 Route::get('/books/{bookSlug}/sort', [BookSortController::class, 'show']);

86 Route::put('/books/{bookSlug}/sort', [BookSortController::class, 'update']);

87 Route::get('/books/{bookSlug}/export/html', [BookExportController::class, 'html']);

88 Route::get('/books/{bookSlug}/export/pdf', [BookExportController::class, 'pdf']);

89 Route::get('/books/{bookSlug}/export/markdown', [BookExportController::class, 'markdown']);

90 Route::get('/books/{bookSlug}/export/zip', [BookExportController::class, 'zip']);

91 Route::get('/books/{bookSlug}/export/plaintext', [BookExportController::class, 'plainText']);

92

93 // Pages

94 Route::get('/books/{bookSlug}/create-page', [PageController::class, 'create']);

95 Route::post('/books/{bookSlug}/create-guest-page', [PageController::class, 'createAsGuest']);

96 Route::get('/books/{bookSlug}/draft/{pageId}', [PageController::class, 'editDraft']);

97 Route::post('/books/{bookSlug}/draft/{pageId}', [PageController::class, 'store']);

98 Route::get('/books/{bookSlug}/page/{pageSlug}', [PageController::class, 'show']);

99 Route::get('/books/{bookSlug}/page/{pageSlug}/export/pdf', [PageExportController::class, 'pdf']);

100 Route::get('/books/{bookSlug}/page/{pageSlug}/export/html', [PageExportController::class, 'html']);

101 Route::get('/books/{bookSlug}/page/{pageSlug}/export/markdown', [PageExportController::class, 'markdown']);

102 Route::get('/books/{bookSlug}/page/{pageSlug}/export/plaintext', [PageExportController::class, 'plainText']);

103 Route::get('/books/{bookSlug}/page/{pageSlug}/edit', [PageController::class, 'edit']);

104 Route::get('/books/{bookSlug}/page/{pageSlug}/move', [PageController::class, 'showMove']);

105 Route::put('/books/{bookSlug}/page/{pageSlug}/move', [PageController::class, 'move']);

106 Route::get('/books/{bookSlug}/page/{pageSlug}/copy', [PageController::class, 'showCopy']);

107 Route::post('/books/{bookSlug}/page/{pageSlug}/copy', [PageController::class, 'copy']);

108 Route::get('/books/{bookSlug}/page/{pageSlug}/delete', [PageController::class, 'showDelete']);

109 Route::get('/books/{bookSlug}/draft/{pageId}/delete', [PageController::class, 'showDeleteDraft']);

110 Route::get('/books/{bookSlug}/page/{pageSlug}/permissions', [PageController::class, 'showPermissions']);

111 Route::put('/books/{bookSlug}/page/{pageSlug}/permissions', [PageController::class, 'permissions']);

112 Route::put('/books/{bookSlug}/page/{pageSlug}', [PageController::class, 'update']);

113 Route::delete('/books/{bookSlug}/page/{pageSlug}', [PageController::class, 'destroy']);

114 Route::delete('/books/{bookSlug}/draft/{pageId}', [PageController::class, 'destroyDraft']);

115

116 // Revisions

117 Route::get('/books/{bookSlug}/page/{pageSlug}/revisions', [PageRevisionController::class, 'index']);

118 Route::get('/books/{bookSlug}/page/{pageSlug}/revisions/{revId}', [PageRevisionController::class, 'show']);

119 Route::get('/books/{bookSlug}/page/{pageSlug}/revisions/{revId}/changes', [PageRevisionController::class, 'changes']);

120 Route::put('/books/{bookSlug}/page/{pageSlug}/revisions/{revId}/restore', [PageRevisionController::class, 'restore']);

121 Route::delete('/books/{bookSlug}/page/{pageSlug}/revisions/{revId}/delete', [PageRevisionController::class, 'destroy']);

122

123 // Chapters

124 Route::get('/books/{bookSlug}/chapter/{chapterSlug}/create-page', [PageController::class, 'create']);

125 Route::post('/books/{bookSlug}/chapter/{chapterSlug}/create-guest-page', [PageController::class, 'createAsGuest']);

126 Route::get('/books/{bookSlug}/create-chapter', [ChapterController::class, 'create']);

127 Route::post('/books/{bookSlug}/create-chapter', [ChapterController::class, 'store']);

128 Route::get('/books/{bookSlug}/chapter/{chapterSlug}', [ChapterController::class, 'show']);

129 Route::put('/books/{bookSlug}/chapter/{chapterSlug}', [ChapterController::class, 'update']);

130 Route::get('/books/{bookSlug}/chapter/{chapterSlug}/move', [ChapterController::class, 'showMove']);

131 Route::put('/books/{bookSlug}/chapter/{chapterSlug}/move', [ChapterController::class, 'move']);

132 Route::get('/books/{bookSlug}/chapter/{chapterSlug}/copy', [ChapterController::class, 'showCopy']);

133 Route::post('/books/{bookSlug}/chapter/{chapterSlug}/copy', [ChapterController::class, 'copy']);

134 Route::get('/books/{bookSlug}/chapter/{chapterSlug}/edit', [ChapterController::class, 'edit']);

135 Route::get('/books/{bookSlug}/chapter/{chapterSlug}/permissions', [ChapterController::class, 'showPermissions']);

136 Route::get('/books/{bookSlug}/chapter/{chapterSlug}/export/pdf', [ChapterExportController::class, 'pdf']);

137 Route::get('/books/{bookSlug}/chapter/{chapterSlug}/export/html', [ChapterExportController::class, 'html']);

138 Route::get('/books/{bookSlug}/chapter/{chapterSlug}/export/markdown', [ChapterExportController::class, 'markdown']);

139 Route::get('/books/{bookSlug}/chapter/{chapterSlug}/export/plaintext', [ChapterExportController::class, 'plainText']);

140 Route::put('/books/{bookSlug}/chapter/{chapterSlug}/permissions', [ChapterController::class, 'permissions']);

141 Route::get('/books/{bookSlug}/chapter/{chapterSlug}/delete', [ChapterController::class, 'showDelete']);

142 Route::delete('/books/{bookSlug}/chapter/{chapterSlug}', [ChapterController::class, 'destroy']);

143

144 // User Profile routes

145 Route::get('/user/{slug}', [UserProfileController::class, 'show']);

146

147 // Image routes

148 Route::get('/images/gallery', [Images\GalleryImageController::class, 'list']);

149 Route::post('/images/gallery', [Images\GalleryImageController::class, 'create']);

150 Route::get('/images/drawio', [Images\DrawioImageController::class, 'list']);

151 Route::get('/images/drawio/base64/{id}', [Images\DrawioImageController::class, 'getAsBase64']);

152 Route::post('/images/drawio', [Images\DrawioImageController::class, 'create']);

153 Route::get('/images/edit/{id}', [Images\ImageController::class, 'edit']);

154 Route::put('/images/{id}', [Images\ImageController::class, 'update']);

155 Route::delete('/images/{id}', [Images\ImageController::class, 'destroy']);

156

157 // Attachments routes

158 Route::get('/attachments/{id}', [AttachmentController::class, 'get']);

159 Route::post('/attachments/upload', [AttachmentController::class, 'upload']);

160 Route::post('/attachments/upload/{id}', [AttachmentController::class, 'uploadUpdate']);

161 Route::post('/attachments/link', [AttachmentController::class, 'attachLink']);

162 Route::put('/attachments/{id}', [AttachmentController::class, 'update']);

163 Route::get('/attachments/edit/{id}', [AttachmentController::class, 'getUpdateForm']);

164 Route::get('/attachments/get/page/{pageId}', [AttachmentController::class, 'listForPage']);

165 Route::put('/attachments/sort/page/{pageId}', [AttachmentController::class, 'sortForPage']);

166 Route::delete('/attachments/{id}', [AttachmentController::class, 'delete']);

167

168 // AJAX routes

169 Route::put('/ajax/page/{id}/save-draft', [PageController::class, 'saveDraft']);

170 Route::get('/ajax/page/{id}', [PageController::class, 'getPageAjax']);

171 Route::delete('/ajax/page/{id}', [PageController::class, 'ajaxDestroy']);

172

173 // Tag routes

174 Route::get('/tags', [TagController::class, 'index']);

175 Route::get('/ajax/tags/suggest/names', [TagController::class, 'getNameSuggestions']);

176 Route::get('/ajax/tags/suggest/values', [TagController::class, 'getValueSuggestions']);

177

178 Route::get('/ajax/search/entities', [SearchController::class, 'searchEntitiesAjax']);

179

180 // Comments

181 Route::post('/comment/{pageId}', [CommentController::class, 'savePageComment']);

182 Route::put('/comment/{id}', [CommentController::class, 'update']);

183 Route::delete('/comment/{id}', [CommentController::class, 'destroy']);

184

185 // Links

186 Route::get('/link/{id}', [PageController::class, 'redirectFromLink']);

187

188 // Search

189 Route::get('/search', [SearchController::class, 'search']);

190 Route::get('/search/book/{bookId}', [SearchController::class, 'searchBook']);

191 Route::get('/search/chapter/{bookId}', [SearchController::class, 'searchChapter']);

192 Route::get('/search/entity/siblings', [SearchController::class, 'searchSiblings']);

193

194 // User Search

195 Route::get('/search/users/select', [UserSearchController::class, 'forSelect']);

196

197 // Template System

198 Route::get('/templates', [PageTemplateController::class, 'list']);

199 Route::get('/templates/{templateId}', [PageTemplateController::class, 'get']);

200

201 // Favourites

202 Route::get('/favourites', [FavouriteController::class, 'index']);

203 Route::post('/favourites/add', [FavouriteController::class, 'add']);

204 Route::post('/favourites/remove', [FavouriteController::class, 'remove']);

205

206 // Other Pages

207 Route::get('/', [HomeController::class, 'index']);

208 Route::get('/home', [HomeController::class, 'index']);

209

210 // Settings

211 Route::get('/settings', [SettingController::class, 'index'])->name('settings');

212 Route::post('/settings', [SettingController::class, 'update']);

213

214 // Maintenance

215 Route::get('/settings/maintenance', [MaintenanceController::class, 'index']);

216 Route::delete('/settings/maintenance/cleanup-images', [MaintenanceController::class, 'cleanupImages']);

217 Route::post('/settings/maintenance/send-test-email', [MaintenanceController::class, 'sendTestEmail']);

218

219 // Recycle Bin

220 Route::get('/settings/recycle-bin', [RecycleBinController::class, 'index']);

221 Route::post('/settings/recycle-bin/empty', [RecycleBinController::class, 'empty']);

222 Route::get('/settings/recycle-bin/{id}/destroy', [RecycleBinController::class, 'showDestroy']);

223 Route::delete('/settings/recycle-bin/{id}', [RecycleBinController::class, 'destroy']);

224 Route::get('/settings/recycle-bin/{id}/restore', [RecycleBinController::class, 'showRestore']);

225 Route::post('/settings/recycle-bin/{id}/restore', [RecycleBinController::class, 'restore']);

226

227 // Audit Log

228 Route::get('/settings/audit', [AuditLogController::class, 'index']);

229

230 // Users

231 Route::get('/settings/users', [UserController::class, 'index']);

232 Route::get('/settings/users/create', [UserController::class, 'create']);

233 Route::get('/settings/users/{id}/delete', [UserController::class, 'delete']);

234 Route::patch('/settings/users/{id}/switch-books-view', [UserController::class, 'switchBooksView']);

235 Route::patch('/settings/users/{id}/switch-shelves-view', [UserController::class, 'switchShelvesView']);

236 Route::patch('/settings/users/{id}/switch-shelf-view', [UserController::class, 'switchShelfView']);

237 Route::patch('/settings/users/{id}/change-sort/{type}', [UserController::class, 'changeSort']);

238 Route::patch('/settings/users/{id}/update-expansion-preference/{key}', [UserController::class, 'updateExpansionPreference']);

239 Route::patch('/settings/users/toggle-dark-mode', [UserController::class, 'toggleDarkMode']);

240 Route::post('/settings/users/create', [UserController::class, 'store']);

241 Route::get('/settings/users/{id}', [UserController::class, 'edit']);

242 Route::put('/settings/users/{id}', [UserController::class, 'update']);

243 Route::delete('/settings/users/{id}', [UserController::class, 'destroy']);

244

245 // User API Tokens

246 Route::get('/settings/users/{userId}/create-api-token', [UserApiTokenController::class, 'create']);

247 Route::post('/settings/users/{userId}/create-api-token', [UserApiTokenController::class, 'store']);

248 Route::get('/settings/users/{userId}/api-tokens/{tokenId}', [UserApiTokenController::class, 'edit']);

249 Route::put('/settings/users/{userId}/api-tokens/{tokenId}', [UserApiTokenController::class, 'update']);

250 Route::get('/settings/users/{userId}/api-tokens/{tokenId}/delete', [UserApiTokenController::class, 'delete']);

251 Route::delete('/settings/users/{userId}/api-tokens/{tokenId}', [UserApiTokenController::class, 'destroy']);

252

253 // Roles

254 Route::get('/settings/roles', [RoleController::class, 'index']);

255 Route::get('/settings/roles/new', [RoleController::class, 'create']);

256 Route::post('/settings/roles/new', [RoleController::class, 'store']);

257 Route::get('/settings/roles/delete/{id}', [RoleController::class, 'showDelete']);

258 Route::delete('/settings/roles/delete/{id}', [RoleController::class, 'delete']);

259 Route::get('/settings/roles/{id}', [RoleController::class, 'edit']);

260 Route::put('/settings/roles/{id}', [RoleController::class, 'update']);

261

262 // Webhooks

263 Route::get('/settings/webhooks', [WebhookController::class, 'index']);

264 Route::get('/settings/webhooks/create', [WebhookController::class, 'create']);

265 Route::post('/settings/webhooks/create', [WebhookController::class, 'store']);

266 Route::get('/settings/webhooks/{id}', [WebhookController::class, 'edit']);

267 Route::put('/settings/webhooks/{id}', [WebhookController::class, 'update']);

268 Route::get('/settings/webhooks/{id}/delete', [WebhookController::class, 'delete']);

269 Route::delete('/settings/webhooks/{id}', [WebhookController::class, 'destroy']);

270 });

271

272 // MFA routes

273 Route::middleware('mfa-setup')->group(function () {

274 Route::get('/mfa/setup', [Auth\MfaController::class, 'setup']);

275 Route::get('/mfa/totp/generate', [Auth\MfaTotpController::class, 'generate']);

276 Route::post('/mfa/totp/confirm', [Auth\MfaTotpController::class, 'confirm']);

277 Route::get('/mfa/backup_codes/generate', [Auth\MfaBackupCodesController::class, 'generate']);

278 Route::post('/mfa/backup_codes/confirm', [Auth\MfaBackupCodesController::class, 'confirm']);

279 });

280 Route::middleware('guest')->group(function () {

281 Route::get('/mfa/verify', [Auth\MfaController::class, 'verify']);

282 Route::post('/mfa/totp/verify', [Auth\MfaTotpController::class, 'verify']);

283 Route::post('/mfa/backup_codes/verify', [Auth\MfaBackupCodesController::class, 'verify']);

284 });

285 Route::delete('/mfa/{method}/remove', [Auth\MfaController::class, 'remove'])->middleware('auth');

286

287 // Social auth routes

288 Route::get('/login/service/{socialDriver}', [Auth\SocialController::class, 'login']);

289 Route::get('/login/service/{socialDriver}/callback', [Auth\SocialController::class, 'callback']);

290 Route::post('/login/service/{socialDriver}/detach', [Auth\SocialController::class, 'detach'])->middleware('auth');

291 Route::get('/register/service/{socialDriver}', [Auth\SocialController::class, 'register']);

292

293 // Login/Logout routes

294 Route::get('/login', [Auth\LoginController::class, 'getLogin']);

295 Route::post('/login', [Auth\LoginController::class, 'login']);

296 Route::post('/logout', [Auth\LoginController::class, 'logout']);

297 Route::get('/register', [Auth\RegisterController::class, 'getRegister']);

298 Route::get('/register/confirm', [Auth\ConfirmEmailController::class, 'show']);

299 Route::get('/register/confirm/awaiting', [Auth\ConfirmEmailController::class, 'showAwaiting']);

300 Route::post('/register/confirm/resend', [Auth\ConfirmEmailController::class, 'resend']);

301 Route::get('/register/confirm/{token}', [Auth\ConfirmEmailController::class, 'confirm']);

302 Route::post('/register', [Auth\RegisterController::class, 'postRegister']);

303

304 // SAML routes

305 Route::post('/saml2/login', [Auth\Saml2Controller::class, 'login']);

306 Route::post('/saml2/logout', [Auth\Saml2Controller::class, 'logout']);

307 Route::get('/saml2/metadata', [Auth\Saml2Controller::class, 'metadata']);

308 Route::get('/saml2/sls', [Auth\Saml2Controller::class, 'sls']);

309 Route::post('/saml2/acs', [Auth\Saml2Controller::class, 'startAcs'])->withoutMiddleware([

310 StartSession::class,

311 ShareErrorsFromSession::class,

312 VerifyCsrfToken::class,

313 ]);

314 Route::get('/saml2/acs', [Auth\Saml2Controller::class, 'processAcs']);

315

316 // OIDC routes

317 Route::post('/oidc/login', [Auth\OidcController::class, 'login']);

318 Route::get('/oidc/callback', [Auth\OidcController::class, 'callback']);

319

320 // User invitation routes

321 Route::get('/register/invite/{token}', [Auth\UserInviteController::class, 'showSetPassword']);

322 Route::post('/register/invite/{token}', [Auth\UserInviteController::class, 'setPassword']);

323

324 // Password reset link request routes

325 Route::get('/password/email', [Auth\ForgotPasswordController::class, 'showLinkRequestForm']);

326 Route::post('/password/email', [Auth\ForgotPasswordController::class, 'sendResetLinkEmail']);

327

328 // Password reset routes

329 Route::get('/password/reset/{token}', [Auth\ResetPasswordController::class, 'showResetForm']);

330 Route::post('/password/reset', [Auth\ResetPasswordController::class, 'reset']);

331

332 // Metadata routes

333 Route::view('/help/wysiwyg', 'help.wysiwyg');

334

335 Route::fallback([HomeController::class, 'notFound'])->name('fallback');