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::get('/api/docs', [Api\ApiDocsController::class, 'display']);

46

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

48

49 // Shelves

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

51 Route::prefix('shelves')->group(function () {

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

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

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

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

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

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

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

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

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

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

62

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

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

65 });

66

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

68 Route::prefix('books')->group(function () {

69

70 // Books

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

88

89 // Pages

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

111

112 // Revisions

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

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

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

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

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

118

119 // Chapters

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

137 });

138

139 // User Profile routes

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

141

142 // Image routes

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

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

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

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

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

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

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

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

151

152 // Attachments routes

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

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

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

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

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

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

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

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

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

162

163 // AJAX routes

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

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

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

167

168 // Tag routes

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

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

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

172

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

174

175 // Comments

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

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

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

179

180 // Links

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

182

183 // Search

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

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

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

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

188

189 // User Search

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

191

192 // Template System

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

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

195

196 // Favourites

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

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

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

200

201 // Other Pages

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

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

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

205

206 // Settings

207 Route::prefix('settings')->group(function () {

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

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

210

211 // Maintenance

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

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

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

215

216 // Recycle Bin

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

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

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

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

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

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

223

224 // Audit Log

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

226

227 // Users

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

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

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

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

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

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

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

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

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

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

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

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

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

241

242 // User API Tokens

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

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

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

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

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

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

249

250 // Roles

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

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

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

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

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

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

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

258 });

259 });

260

261 // MFA routes

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

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

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

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

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

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

268 });

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

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

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

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

273 });

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

275

276 // Social auth routes

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

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

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

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

281

282 // Login/Logout routes

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

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

285 Route::get('/logout', [Auth\LoginController::class, 'logout']);

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

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

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

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

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

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

292

293 // SAML routes

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

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

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

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

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

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

300

301 // OIDC routes

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

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

304

305 // User invitation routes

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

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

308

309 // Password reset link request routes...

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

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

312

313 // Password reset routes...

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

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

316

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