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 Illuminate\Support\Facades\Route;

33

34 Route::get('/status', [StatusController::class, 'show']);

35 Route::get('/robots.txt', [HomeController::class, 'robots']);

36

37 // Authenticated routes...

38 Route::middleware('auth')->group(function () {

39

40 // Secure images routing

41 Route::get('/uploads/images/{path}', [Images\ImageController::class, 'showImage'])

42 ->where('path', '.*$');

43

44 // API docs routes

45 Route::redirect('/api', '/api/docs');

46 Route::get('/api/docs', [Api\ApiDocsController::class, 'display']);

47

48 Route::get('/pages/recently-updated', [PageController::class, 'showRecentlyUpdated']);

49

50 // Shelves

51 Route::get('/create-shelf', [BookshelfController::class, 'create']);

52 Route::get('/shelves/', [BookshelfController::class, 'index']);

53 Route::post('/shelves/', [BookshelfController::class, 'store']);

54 Route::get('/shelves/{slug}/edit', [BookshelfController::class, 'edit']);

55 Route::get('/shelves/{slug}/delete', [BookshelfController::class, 'showDelete']);

56 Route::get('/shelves/{slug}', [BookshelfController::class, 'show']);

57 Route::put('/shelves/{slug}', [BookshelfController::class, 'update']);

58 Route::delete('/shelves/{slug}', [BookshelfController::class, 'destroy']);

59 Route::get('/shelves/{slug}/permissions', [BookshelfController::class, 'showPermissions']);

60 Route::put('/shelves/{slug}/permissions', [BookshelfController::class, 'permissions']);

61 Route::post('/shelves/{slug}/copy-permissions', [BookshelfController::class, 'copyPermissions']);

62

63 // Book Creation

64 Route::get('/shelves/{shelfSlug}/create-book', [BookController::class, 'create']);

65 Route::post('/shelves/{shelfSlug}/create-book', [BookController::class, 'store']);

66 Route::get('/create-book', [BookController::class, 'create']);

67

68 // Books

69 Route::get('/books/', [BookController::class, 'index']);

70 Route::post('/books/', [BookController::class, 'store']);

71 Route::get('/books/{slug}/edit', [BookController::class, 'edit']);

72 Route::put('/books/{slug}', [BookController::class, 'update']);

73 Route::delete('/books/{id}', [BookController::class, 'destroy']);

74 Route::get('/books/{slug}/sort-item', [BookSortController::class, 'showItem']);

75 Route::get('/books/{slug}', [BookController::class, 'show']);

76 Route::get('/books/{bookSlug}/permissions', [BookController::class, 'showPermissions']);

77 Route::put('/books/{bookSlug}/permissions', [BookController::class, 'permissions']);

78 Route::get('/books/{slug}/delete', [BookController::class, 'showDelete']);

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

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

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

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

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

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

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

86

87 // Pages

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

109

110 // Revisions

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

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

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

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

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

116

117 // Chapters

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

135

136 // User Profile routes

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

138

139 // Image routes

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

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

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

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

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

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

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

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

148

149 // Attachments routes

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

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

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

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

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

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

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

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

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

159

160 // AJAX routes

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

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

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

164

165 // Tag routes

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

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

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

169

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

171

172 // Comments

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

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

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

176

177 // Links

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

179

180 // Search

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

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

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

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

185

186 // User Search

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

188

189 // Template System

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

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

192

193 // Favourites

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

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

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

197

198 // Other Pages

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

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

201 Route::get('/custom-head-content', [HomeController::class, 'customHeadContent']);

202

203 // Settings

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

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

206

207 // Maintenance

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

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

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

211

212 // Recycle Bin

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

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

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

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

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

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

219

220 // Audit Log

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

222

223 // Users

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

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

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

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

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

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

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

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

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

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

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

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

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

237

238 // User API Tokens

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

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

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

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

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

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

245

246 // Roles

247 Route::get('/settings/roles', [RoleController::class, 'list']);

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

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

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

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

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

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

254 });

255

256 // MFA routes

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

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

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

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

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

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

263 });

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

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

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

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

268 });

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

270

271 // Social auth routes

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

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

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

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

276

277 // Login/Logout routes

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

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

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

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

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

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

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

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

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

287

288 // SAML routes

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

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

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

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

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

294 \Illuminate\Session\Middleware\StartSession::class,

295 \Illuminate\View\Middleware\ShareErrorsFromSession::class,

296 \BookStack\Http\Middleware\VerifyCsrfToken::class,

297 ]);

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

299

300 // OIDC routes

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

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

303

304 // User invitation routes

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

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

307

308 // Password reset link request routes...

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

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

311

312 // Password reset routes...

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

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

315

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