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