Merge branch 'stable' into develop
[akkoma] / lib / pleroma / web / router.ex
1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
4
5 defmodule Pleroma.Web.Router do
6 use Pleroma.Web, :router
7 import Phoenix.LiveDashboard.Router
8
9 pipeline :accepts_html do
10 plug(:accepts, ["html"])
11 end
12
13 pipeline :accepts_html_xml do
14 plug(:accepts, ["html", "xml", "rss", "atom"])
15 end
16
17 pipeline :accepts_html_json do
18 plug(:accepts, ["html", "activity+json", "json"])
19 end
20
21 pipeline :accepts_html_xml_json do
22 plug(:accepts, ["html", "xml", "rss", "atom", "activity+json", "json"])
23 end
24
25 pipeline :accepts_xml_rss_atom do
26 plug(:accepts, ["xml", "rss", "atom"])
27 end
28
29 pipeline :browser do
30 plug(:accepts, ["html"])
31 plug(:fetch_session)
32 end
33
34 pipeline :oauth do
35 plug(:fetch_session)
36 plug(Pleroma.Web.Plugs.OAuthPlug)
37 plug(Pleroma.Web.Plugs.UserEnabledPlug)
38 plug(Pleroma.Web.Plugs.EnsureUserTokenAssignsPlug)
39 end
40
41 # Note: expects _user_ authentication (user-unbound app-bound tokens don't qualify)
42 pipeline :expect_user_authentication do
43 plug(Pleroma.Web.Plugs.ExpectAuthenticatedCheckPlug)
44 end
45
46 # Note: expects public instance or _user_ authentication (user-unbound tokens don't qualify)
47 pipeline :expect_public_instance_or_user_authentication do
48 plug(Pleroma.Web.Plugs.ExpectPublicOrAuthenticatedCheckPlug)
49 end
50
51 pipeline :authenticate do
52 plug(Pleroma.Web.Plugs.OAuthPlug)
53 plug(Pleroma.Web.Plugs.BasicAuthDecoderPlug)
54 plug(Pleroma.Web.Plugs.UserFetcherPlug)
55 plug(Pleroma.Web.Plugs.AuthenticationPlug)
56 end
57
58 pipeline :after_auth do
59 plug(Pleroma.Web.Plugs.UserEnabledPlug)
60 plug(Pleroma.Web.Plugs.SetUserSessionIdPlug)
61 plug(Pleroma.Web.Plugs.EnsureUserTokenAssignsPlug)
62 plug(Pleroma.Web.Plugs.UserTrackingPlug)
63 end
64
65 pipeline :base_api do
66 plug(:accepts, ["json"])
67 plug(:fetch_session)
68 plug(:authenticate)
69 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
70 end
71
72 pipeline :no_auth_or_privacy_expectations_api do
73 plug(:base_api)
74 plug(:after_auth)
75 plug(Pleroma.Web.Plugs.IdempotencyPlug)
76 end
77
78 # Pipeline for app-related endpoints (no user auth checks — app-bound tokens must be supported)
79 pipeline :app_api do
80 plug(:no_auth_or_privacy_expectations_api)
81 end
82
83 pipeline :api do
84 plug(:expect_public_instance_or_user_authentication)
85 plug(:no_auth_or_privacy_expectations_api)
86 end
87
88 pipeline :authenticated_api do
89 plug(:expect_user_authentication)
90 plug(:no_auth_or_privacy_expectations_api)
91 plug(Pleroma.Web.Plugs.EnsureAuthenticatedPlug)
92 end
93
94 pipeline :admin_api do
95 plug(:expect_user_authentication)
96 plug(:base_api)
97 plug(Pleroma.Web.Plugs.AdminSecretAuthenticationPlug)
98 plug(:after_auth)
99 plug(Pleroma.Web.Plugs.EnsureAuthenticatedPlug)
100 plug(Pleroma.Web.Plugs.UserIsStaffPlug)
101 plug(Pleroma.Web.Plugs.IdempotencyPlug)
102 end
103
104 pipeline :require_privileged_staff do
105 plug(Pleroma.Web.Plugs.EnsureStaffPrivilegedPlug)
106 end
107
108 pipeline :require_admin do
109 plug(Pleroma.Web.Plugs.UserIsAdminPlug)
110 end
111
112 pipeline :mastodon_html do
113 plug(:browser)
114 plug(:authenticate)
115 plug(:after_auth)
116 end
117
118 pipeline :pleroma_html do
119 plug(:browser)
120 plug(:authenticate)
121 plug(Pleroma.Web.Plugs.EnsureUserTokenAssignsPlug)
122 end
123
124 pipeline :well_known do
125 plug(:accepts, ["json", "jrd+json", "xml", "xrd+xml"])
126 end
127
128 pipeline :config do
129 plug(:accepts, ["json", "xml"])
130 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
131 end
132
133 pipeline :pleroma_api do
134 plug(:accepts, ["html", "json"])
135 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
136 end
137
138 pipeline :mailbox_preview do
139 plug(:accepts, ["html"])
140
141 plug(:put_secure_browser_headers, %{
142 "content-security-policy" =>
143 "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' 'unsafe-eval'"
144 })
145 end
146
147 pipeline :http_signature do
148 plug(Pleroma.Web.Plugs.HTTPSignaturePlug)
149 plug(Pleroma.Web.Plugs.MappedSignatureToIdentityPlug)
150 end
151
152 pipeline :static_fe do
153 plug(Pleroma.Web.Plugs.StaticFEPlug)
154 end
155
156 scope "/api/v1/pleroma", Pleroma.Web.TwitterAPI do
157 pipe_through(:pleroma_api)
158
159 get("/password_reset/:token", PasswordController, :reset, as: :reset_password)
160 post("/password_reset", PasswordController, :do_reset, as: :reset_password)
161 get("/emoji", UtilController, :emoji)
162 get("/captcha", UtilController, :captcha)
163 get("/healthcheck", UtilController, :healthcheck)
164 post("/remote_interaction", UtilController, :remote_interaction)
165 end
166
167 scope "/api/v1/pleroma", Pleroma.Web do
168 pipe_through(:pleroma_api)
169 post("/uploader_callback/:upload_path", UploaderController, :callback)
170 end
171
172 # AdminAPI: only admins can perform these actions
173 scope "/api/v1/pleroma/admin", Pleroma.Web.AdminAPI do
174 pipe_through([:admin_api, :require_admin])
175
176 put("/users/disable_mfa", AdminAPIController, :disable_mfa)
177
178 get("/users/:nickname/permission_group", AdminAPIController, :right_get)
179 get("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_get)
180
181 post("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_add)
182
183 delete(
184 "/users/:nickname/permission_group/:permission_group",
185 AdminAPIController,
186 :right_delete
187 )
188
189 post("/users/permission_group/:permission_group", AdminAPIController, :right_add_multiple)
190
191 delete(
192 "/users/permission_group/:permission_group",
193 AdminAPIController,
194 :right_delete_multiple
195 )
196
197 post("/users/follow", UserController, :follow)
198 post("/users/unfollow", UserController, :unfollow)
199 post("/users", UserController, :create)
200
201 patch("/users/suggest", UserController, :suggest)
202 patch("/users/unsuggest", UserController, :unsuggest)
203
204 get("/relay", RelayController, :index)
205 post("/relay", RelayController, :follow)
206 delete("/relay", RelayController, :unfollow)
207
208 patch("/users/force_password_reset", AdminAPIController, :force_password_reset)
209 get("/users/:nickname/credentials", AdminAPIController, :show_user_credentials)
210 patch("/users/:nickname/credentials", AdminAPIController, :update_user_credentials)
211
212 get("/instance_document/:name", InstanceDocumentController, :show)
213 patch("/instance_document/:name", InstanceDocumentController, :update)
214 delete("/instance_document/:name", InstanceDocumentController, :delete)
215
216 patch("/users/confirm_email", AdminAPIController, :confirm_email)
217 patch("/users/resend_confirmation_email", AdminAPIController, :resend_confirmation_email)
218
219 get("/config", ConfigController, :show)
220 post("/config", ConfigController, :update)
221 get("/config/descriptions", ConfigController, :descriptions)
222 get("/need_reboot", AdminAPIController, :need_reboot)
223 get("/restart", AdminAPIController, :restart)
224
225 get("/oauth_app", OAuthAppController, :index)
226 post("/oauth_app", OAuthAppController, :create)
227 patch("/oauth_app/:id", OAuthAppController, :update)
228 delete("/oauth_app/:id", OAuthAppController, :delete)
229
230 get("/media_proxy_caches", MediaProxyCacheController, :index)
231 post("/media_proxy_caches/delete", MediaProxyCacheController, :delete)
232 post("/media_proxy_caches/purge", MediaProxyCacheController, :purge)
233
234 get("/frontends", FrontendController, :index)
235 post("/frontends/install", FrontendController, :install)
236
237 post("/backups", AdminAPIController, :create_backup)
238
239 get("/announcements", AnnouncementController, :index)
240 post("/announcements", AnnouncementController, :create)
241 get("/announcements/:id", AnnouncementController, :show)
242 patch("/announcements/:id", AnnouncementController, :change)
243 delete("/announcements/:id", AnnouncementController, :delete)
244 end
245
246 # AdminAPI: admins and mods (staff) can perform these actions (if enabled by config)
247 scope "/api/v1/pleroma/admin", Pleroma.Web.AdminAPI do
248 pipe_through([:admin_api, :require_privileged_staff])
249
250 delete("/users", UserController, :delete)
251
252 get("/users/:nickname/password_reset", AdminAPIController, :get_password_reset)
253 patch("/users/:nickname/credentials", AdminAPIController, :update_user_credentials)
254
255 get("/users/:nickname/statuses", AdminAPIController, :list_user_statuses)
256
257 get("/statuses", StatusController, :index)
258 end
259
260 # AdminAPI: admins and mods (staff) can perform these actions
261 scope "/api/v1/pleroma/admin", Pleroma.Web.AdminAPI do
262 pipe_through(:admin_api)
263
264 put("/users/tag", AdminAPIController, :tag_users)
265 delete("/users/tag", AdminAPIController, :untag_users)
266
267 patch("/users/:nickname/toggle_activation", UserController, :toggle_activation)
268 patch("/users/activate", UserController, :activate)
269 patch("/users/deactivate", UserController, :deactivate)
270 patch("/users/approve", UserController, :approve)
271
272 post("/users/invite_token", InviteController, :create)
273 get("/users/invites", InviteController, :index)
274 post("/users/revoke_invite", InviteController, :revoke)
275 post("/users/email_invite", InviteController, :email)
276
277 get("/users", UserController, :index)
278 get("/users/:nickname", UserController, :show)
279
280 get("/instances/:instance/statuses", InstanceController, :list_statuses)
281 delete("/instances/:instance", InstanceController, :delete)
282
283 get("/reports", ReportController, :index)
284 get("/reports/:id", ReportController, :show)
285 patch("/reports", ReportController, :update)
286 post("/reports/:id/notes", ReportController, :notes_create)
287 delete("/reports/:report_id/notes/:id", ReportController, :notes_delete)
288
289 get("/statuses/:id", StatusController, :show)
290 put("/statuses/:id", StatusController, :update)
291 delete("/statuses/:id", StatusController, :delete)
292
293 get("/moderation_log", AdminAPIController, :list_log)
294
295 post("/reload_emoji", AdminAPIController, :reload_emoji)
296 get("/stats", AdminAPIController, :stats)
297 end
298
299 scope "/api/v1/pleroma/emoji", Pleroma.Web.PleromaAPI do
300 scope "/pack" do
301 pipe_through(:admin_api)
302
303 post("/", EmojiPackController, :create)
304 patch("/", EmojiPackController, :update)
305 delete("/", EmojiPackController, :delete)
306 end
307
308 scope "/pack" do
309 pipe_through(:api)
310
311 get("/", EmojiPackController, :show)
312 end
313
314 # Modifying packs
315 scope "/packs" do
316 pipe_through(:admin_api)
317
318 get("/import", EmojiPackController, :import_from_filesystem)
319 get("/remote", EmojiPackController, :remote)
320 post("/download", EmojiPackController, :download)
321
322 post("/files", EmojiFileController, :create)
323 patch("/files", EmojiFileController, :update)
324 delete("/files", EmojiFileController, :delete)
325 end
326
327 # Pack info / downloading
328 scope "/packs" do
329 pipe_through(:api)
330
331 get("/", EmojiPackController, :index)
332 get("/archive", EmojiPackController, :archive)
333 end
334 end
335
336 scope "/", Pleroma.Web.TwitterAPI do
337 pipe_through(:pleroma_html)
338
339 post("/main/ostatus", UtilController, :remote_subscribe)
340 get("/ostatus_subscribe", RemoteFollowController, :follow)
341 post("/ostatus_subscribe", RemoteFollowController, :do_follow)
342 end
343
344 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
345 pipe_through(:authenticated_api)
346
347 post("/change_email", UtilController, :change_email)
348 post("/change_password", UtilController, :change_password)
349 post("/delete_account", UtilController, :delete_account)
350 put("/notification_settings", UtilController, :update_notificaton_settings)
351 post("/disable_account", UtilController, :disable_account)
352 post("/move_account", UtilController, :move_account)
353
354 put("/aliases", UtilController, :add_alias)
355 get("/aliases", UtilController, :list_aliases)
356 delete("/aliases", UtilController, :delete_alias)
357 end
358
359 scope "/api/pleroma", Pleroma.Web.PleromaAPI do
360 pipe_through(:authenticated_api)
361
362 post("/mutes_import", UserImportController, :mutes)
363 post("/blocks_import", UserImportController, :blocks)
364 post("/follow_import", UserImportController, :follow)
365
366 get("/accounts/mfa", TwoFactorAuthenticationController, :settings)
367 get("/accounts/mfa/backup_codes", TwoFactorAuthenticationController, :backup_codes)
368 get("/accounts/mfa/setup/:method", TwoFactorAuthenticationController, :setup)
369 post("/accounts/mfa/confirm/:method", TwoFactorAuthenticationController, :confirm)
370 delete("/accounts/mfa/:method", TwoFactorAuthenticationController, :disable)
371 end
372
373 scope "/oauth", Pleroma.Web.OAuth do
374 # Note: use /api/v1/accounts/verify_credentials for userinfo of signed-in user
375
376 get("/registration_details", OAuthController, :registration_details)
377
378 post("/mfa/verify", MFAController, :verify, as: :mfa_verify)
379 get("/mfa", MFAController, :show)
380
381 scope [] do
382 pipe_through(:oauth)
383
384 get("/authorize", OAuthController, :authorize)
385 post("/authorize", OAuthController, :create_authorization)
386 end
387
388 scope [] do
389 pipe_through(:fetch_session)
390
391 post("/token", OAuthController, :token_exchange)
392 post("/revoke", OAuthController, :token_revoke)
393 post("/mfa/challenge", MFAController, :challenge)
394 end
395
396 scope [] do
397 pipe_through(:browser)
398
399 get("/prepare_request", OAuthController, :prepare_request)
400 get("/:provider", OAuthController, :request)
401 get("/:provider/callback", OAuthController, :callback)
402 post("/register", OAuthController, :register)
403 end
404 end
405
406 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
407 pipe_through(:api)
408
409 get("/apps", AppController, :index)
410 get("/statuses/:id/reactions/:emoji", EmojiReactionController, :index)
411 get("/statuses/:id/reactions", EmojiReactionController, :index)
412 end
413
414 scope "/api/v0/pleroma", Pleroma.Web.PleromaAPI do
415 pipe_through(:authenticated_api)
416 get("/reports", ReportController, :index)
417 get("/reports/:id", ReportController, :show)
418 end
419
420 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
421 scope [] do
422 pipe_through(:authenticated_api)
423
424 get("/conversations/:id/statuses", ConversationController, :statuses)
425 get("/conversations/:id", ConversationController, :show)
426 post("/conversations/read", ConversationController, :mark_as_read)
427 patch("/conversations/:id", ConversationController, :update)
428
429 put("/statuses/:id/reactions/:emoji", EmojiReactionController, :create)
430 delete("/statuses/:id/reactions/:emoji", EmojiReactionController, :delete)
431 post("/notifications/read", NotificationController, :mark_as_read)
432
433 get("/mascot", MascotController, :show)
434 put("/mascot", MascotController, :update)
435
436 get("/backups", BackupController, :index)
437 post("/backups", BackupController, :create)
438 end
439
440 scope [] do
441 pipe_through(:api)
442 get("/accounts/:id/favourites", AccountController, :favourites)
443 end
444
445 scope [] do
446 pipe_through(:authenticated_api)
447
448 post("/accounts/:id/subscribe", AccountController, :subscribe)
449 post("/accounts/:id/unsubscribe", AccountController, :unsubscribe)
450 end
451
452 post("/accounts/confirmation_resend", AccountController, :confirmation_resend)
453 end
454
455 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
456 pipe_through(:api)
457 get("/federation_status", InstancesController, :show)
458 end
459
460 scope "/api/v1", Pleroma.Web.MastodonAPI do
461 pipe_through(:authenticated_api)
462
463 get("/accounts/verify_credentials", AccountController, :verify_credentials)
464 patch("/accounts/update_credentials", AccountController, :update_credentials)
465
466 get("/accounts/relationships", AccountController, :relationships)
467 get("/accounts/:id/lists", AccountController, :lists)
468 get("/accounts/:id/identity_proofs", AccountController, :identity_proofs)
469 get("/endorsements", AccountController, :endorsements)
470 get("/blocks", AccountController, :blocks)
471 get("/mutes", AccountController, :mutes)
472
473 post("/follows", AccountController, :follow_by_uri)
474 post("/accounts/:id/follow", AccountController, :follow)
475 post("/accounts/:id/unfollow", AccountController, :unfollow)
476 post("/accounts/:id/block", AccountController, :block)
477 post("/accounts/:id/unblock", AccountController, :unblock)
478 post("/accounts/:id/mute", AccountController, :mute)
479 post("/accounts/:id/unmute", AccountController, :unmute)
480 post("/accounts/:id/note", AccountController, :note)
481
482 get("/conversations", ConversationController, :index)
483 post("/conversations/:id/read", ConversationController, :mark_as_read)
484 delete("/conversations/:id", ConversationController, :delete)
485
486 get("/domain_blocks", DomainBlockController, :index)
487 post("/domain_blocks", DomainBlockController, :create)
488 delete("/domain_blocks", DomainBlockController, :delete)
489
490 get("/filters", FilterController, :index)
491
492 post("/filters", FilterController, :create)
493 get("/filters/:id", FilterController, :show)
494 put("/filters/:id", FilterController, :update)
495 delete("/filters/:id", FilterController, :delete)
496
497 get("/follow_requests", FollowRequestController, :index)
498 post("/follow_requests/:id/authorize", FollowRequestController, :authorize)
499 post("/follow_requests/:id/reject", FollowRequestController, :reject)
500
501 get("/lists", ListController, :index)
502 get("/lists/:id", ListController, :show)
503 get("/lists/:id/accounts", ListController, :list_accounts)
504
505 delete("/lists/:id", ListController, :delete)
506 post("/lists", ListController, :create)
507 put("/lists/:id", ListController, :update)
508 post("/lists/:id/accounts", ListController, :add_to_list)
509 delete("/lists/:id/accounts", ListController, :remove_from_list)
510
511 get("/markers", MarkerController, :index)
512 post("/markers", MarkerController, :upsert)
513
514 post("/media", MediaController, :create)
515 get("/media/:id", MediaController, :show)
516 put("/media/:id", MediaController, :update)
517
518 get("/notifications", NotificationController, :index)
519 get("/notifications/:id", NotificationController, :show)
520
521 post("/notifications/:id/dismiss", NotificationController, :dismiss)
522 post("/notifications/clear", NotificationController, :clear)
523 delete("/notifications/destroy_multiple", NotificationController, :destroy_multiple)
524
525 post("/polls/:id/votes", PollController, :vote)
526
527 post("/reports", ReportController, :create)
528
529 get("/scheduled_statuses", ScheduledActivityController, :index)
530 get("/scheduled_statuses/:id", ScheduledActivityController, :show)
531
532 put("/scheduled_statuses/:id", ScheduledActivityController, :update)
533 delete("/scheduled_statuses/:id", ScheduledActivityController, :delete)
534
535 # Unlike `GET /api/v1/accounts/:id/favourites`, demands authentication
536 get("/favourites", StatusController, :favourites)
537 get("/bookmarks", StatusController, :bookmarks)
538
539 post("/statuses", StatusController, :create)
540 delete("/statuses/:id", StatusController, :delete)
541 post("/statuses/:id/reblog", StatusController, :reblog)
542 post("/statuses/:id/unreblog", StatusController, :unreblog)
543 post("/statuses/:id/favourite", StatusController, :favourite)
544 post("/statuses/:id/unfavourite", StatusController, :unfavourite)
545 post("/statuses/:id/pin", StatusController, :pin)
546 post("/statuses/:id/unpin", StatusController, :unpin)
547 post("/statuses/:id/bookmark", StatusController, :bookmark)
548 post("/statuses/:id/unbookmark", StatusController, :unbookmark)
549 post("/statuses/:id/mute", StatusController, :mute_conversation)
550 post("/statuses/:id/unmute", StatusController, :unmute_conversation)
551
552 post("/push/subscription", SubscriptionController, :create)
553 get("/push/subscription", SubscriptionController, :show)
554 put("/push/subscription", SubscriptionController, :update)
555 delete("/push/subscription", SubscriptionController, :delete)
556
557 get("/suggestions", SuggestionController, :index)
558 delete("/suggestions/:account_id", SuggestionController, :dismiss)
559
560 get("/timelines/home", TimelineController, :home)
561 get("/timelines/direct", TimelineController, :direct)
562 get("/timelines/list/:list_id", TimelineController, :list)
563 get("/timelines/bubble", TimelineController, :bubble)
564
565 get("/announcements", AnnouncementController, :index)
566 post("/announcements/:id/dismiss", AnnouncementController, :mark_read)
567 end
568
569 scope "/api/web", Pleroma.Web do
570 pipe_through(:authenticated_api)
571
572 # Backend-obscure settings blob for MastoFE, don't parse/reuse elsewhere
573 put("/settings", MastoFEController, :put_settings)
574 end
575
576 scope "/api/v1", Pleroma.Web.MastodonAPI do
577 pipe_through(:app_api)
578
579 post("/apps", AppController, :create)
580 get("/apps/verify_credentials", AppController, :verify_credentials)
581 end
582
583 scope "/api/v1", Pleroma.Web.MastodonAPI do
584 pipe_through(:api)
585
586 get("/accounts/search", SearchController, :account_search)
587 get("/accounts/lookup", AccountController, :lookup)
588
589 get("/accounts/:id/statuses", AccountController, :statuses)
590 get("/accounts/:id/followers", AccountController, :followers)
591 get("/accounts/:id/following", AccountController, :following)
592 get("/accounts/:id", AccountController, :show)
593
594 post("/accounts", AccountController, :create)
595
596 get("/instance", InstanceController, :show)
597 get("/instance/peers", InstanceController, :peers)
598
599 get("/statuses", StatusController, :index)
600 get("/statuses/:id", StatusController, :show)
601 get("/statuses/:id/context", StatusController, :context)
602 get("/statuses/:id/favourited_by", StatusController, :favourited_by)
603 get("/statuses/:id/reblogged_by", StatusController, :reblogged_by)
604
605 get("/custom_emojis", CustomEmojiController, :index)
606
607 get("/trends", MastodonAPIController, :empty_array)
608
609 get("/timelines/public", TimelineController, :public)
610 get("/timelines/tag/:tag", TimelineController, :hashtag)
611
612 get("/polls/:id", PollController, :show)
613
614 get("/directory", DirectoryController, :index)
615 end
616
617 scope "/api/v2", Pleroma.Web.MastodonAPI do
618 pipe_through(:api)
619 get("/search", SearchController, :search2)
620
621 post("/media", MediaController, :create2)
622
623 get("/suggestions", SuggestionController, :index2)
624 end
625
626 scope "/api", Pleroma.Web do
627 pipe_through(:config)
628
629 get("/pleroma/frontend_configurations", TwitterAPI.UtilController, :frontend_configurations)
630 end
631
632 scope "/api", Pleroma.Web do
633 pipe_through(:api)
634
635 get(
636 "/account/confirm_email/:user_id/:token",
637 TwitterAPI.Controller,
638 :confirm_email,
639 as: :confirm_email
640 )
641 end
642
643 scope "/api" do
644 pipe_through(:base_api)
645
646 get("/openapi", OpenApiSpex.Plug.RenderSpec, [])
647 end
648
649 scope "/api", Pleroma.Web, as: :authenticated_twitter_api do
650 pipe_through(:authenticated_api)
651
652 get("/oauth_tokens", TwitterAPI.Controller, :oauth_tokens)
653 delete("/oauth_tokens/:id", TwitterAPI.Controller, :revoke_token)
654 end
655
656 scope "/", Pleroma.Web do
657 # Note: html format is supported only if static FE is enabled
658 # Note: http signature is only considered for json requests (no auth for non-json requests)
659 pipe_through([:accepts_html_json, :http_signature, :static_fe])
660
661 get("/objects/:uuid", OStatus.OStatusController, :object)
662 get("/activities/:uuid", OStatus.OStatusController, :activity)
663 get("/notice/:id", OStatus.OStatusController, :notice)
664
665 # Notice compatibility routes for other frontends
666 get("/@:nickname/:id", OStatus.OStatusController, :notice)
667 get("/@:nickname/posts/:id", OStatus.OStatusController, :notice)
668 get("/:nickname/status/:id", OStatus.OStatusController, :notice)
669
670 # Mastodon compatibility routes
671 get("/users/:nickname/statuses/:id", OStatus.OStatusController, :object)
672 get("/users/:nickname/statuses/:id/activity", OStatus.OStatusController, :activity)
673 end
674
675 scope "/", Pleroma.Web do
676 # Note: html format is supported only if static FE is enabled
677 # Note: http signature is only considered for json requests (no auth for non-json requests)
678 pipe_through([:accepts_html_xml_json, :http_signature, :static_fe])
679
680 # Note: returns user _profile_ for json requests, redirects to user _feed_ for non-json ones
681 get("/users/:nickname", Feed.UserController, :feed_redirect, as: :user_feed)
682 end
683
684 scope "/", Pleroma.Web do
685 # Note: html format is supported only if static FE is enabled
686 pipe_through([:accepts_html_xml, :static_fe])
687
688 get("/users/:nickname/feed", Feed.UserController, :feed, as: :user_feed)
689 end
690
691 scope "/", Pleroma.Web do
692 pipe_through(:accepts_html)
693 get("/notice/:id/embed_player", OStatus.OStatusController, :notice_player)
694 end
695
696 scope "/", Pleroma.Web do
697 pipe_through(:accepts_xml_rss_atom)
698 get("/tags/:tag", Feed.TagController, :feed, as: :tag_feed)
699 end
700
701 scope "/", Pleroma.Web do
702 pipe_through(:browser)
703 get("/mailer/unsubscribe/:token", Mailer.SubscriptionController, :unsubscribe)
704 end
705
706 pipeline :ap_service_actor do
707 plug(:accepts, ["activity+json", "json"])
708 end
709
710 # Server to Server (S2S) AP interactions
711 pipeline :activitypub do
712 plug(:ap_service_actor)
713 plug(:http_signature)
714 end
715
716 # Client to Server (C2S) AP interactions
717 pipeline :activitypub_client do
718 plug(:ap_service_actor)
719 plug(:fetch_session)
720 plug(:authenticate)
721 plug(:after_auth)
722 end
723
724 scope "/", Pleroma.Web.ActivityPub do
725 pipe_through([:activitypub_client])
726
727 get("/api/ap/whoami", ActivityPubController, :whoami)
728 get("/users/:nickname/inbox", ActivityPubController, :read_inbox)
729
730 get("/users/:nickname/outbox", ActivityPubController, :outbox)
731 post("/users/:nickname/outbox", ActivityPubController, :update_outbox)
732 post("/api/ap/upload_media", ActivityPubController, :upload_media)
733
734 # The following two are S2S as well, see `ActivityPub.fetch_follow_information_for_user/1`:
735 get("/users/:nickname/followers", ActivityPubController, :followers)
736 get("/users/:nickname/following", ActivityPubController, :following)
737 get("/users/:nickname/collections/featured", ActivityPubController, :pinned)
738 end
739
740 scope "/", Pleroma.Web.ActivityPub do
741 pipe_through(:activitypub)
742 post("/inbox", ActivityPubController, :inbox)
743 post("/users/:nickname/inbox", ActivityPubController, :inbox)
744 end
745
746 scope "/relay", Pleroma.Web.ActivityPub do
747 pipe_through(:ap_service_actor)
748
749 get("/", ActivityPubController, :relay)
750
751 scope [] do
752 pipe_through(:http_signature)
753 post("/inbox", ActivityPubController, :inbox)
754 end
755
756 get("/following", ActivityPubController, :relay_following)
757 get("/followers", ActivityPubController, :relay_followers)
758 end
759
760 scope "/internal/fetch", Pleroma.Web.ActivityPub do
761 pipe_through(:ap_service_actor)
762
763 get("/", ActivityPubController, :internal_fetch)
764 post("/inbox", ActivityPubController, :inbox)
765 end
766
767 scope "/.well-known", Pleroma.Web do
768 pipe_through(:well_known)
769
770 get("/host-meta", WebFinger.WebFingerController, :host_meta)
771 get("/webfinger", WebFinger.WebFingerController, :webfinger)
772 get("/nodeinfo", Nodeinfo.NodeinfoController, :schemas)
773 end
774
775 scope "/nodeinfo", Pleroma.Web do
776 get("/:version", Nodeinfo.NodeinfoController, :nodeinfo)
777 end
778
779 scope "/", Pleroma.Web do
780 pipe_through(:api)
781
782 get("/manifest.json", ManifestController, :show)
783 get("/web/manifest.json", MastoFEController, :manifest)
784 end
785
786 scope "/", Pleroma.Web do
787 pipe_through(:mastodon_html)
788
789 get("/web/login", MastodonAPI.AuthController, :login)
790 delete("/auth/sign_out", MastodonAPI.AuthController, :logout)
791
792 post("/auth/password", MastodonAPI.AuthController, :password_reset)
793
794 get("/web/*path", MastoFEController, :index)
795
796 get("/embed/:id", EmbedController, :show)
797 end
798
799 scope "/proxy/", Pleroma.Web do
800 get("/preview/:sig/:url", MediaProxy.MediaProxyController, :preview)
801 get("/preview/:sig/:url/:filename", MediaProxy.MediaProxyController, :preview)
802 get("/:sig/:url", MediaProxy.MediaProxyController, :remote)
803 get("/:sig/:url/:filename", MediaProxy.MediaProxyController, :remote)
804 end
805
806 if Pleroma.Config.get(:env) == :dev do
807 scope "/dev" do
808 pipe_through([:mailbox_preview])
809
810 forward("/mailbox", Plug.Swoosh.MailboxPreview, base_path: "/dev/mailbox")
811 end
812 end
813
814 scope "/" do
815 pipe_through([:pleroma_html, :authenticate, :require_admin])
816 live_dashboard("/phoenix/live_dashboard")
817 end
818
819 # Test-only routes needed to test action dispatching and plug chain execution
820 if Pleroma.Config.get(:env) == :test do
821 @test_actions [
822 :do_oauth_check,
823 :fallback_oauth_check,
824 :skip_oauth_check,
825 :fallback_oauth_skip_publicity_check,
826 :skip_oauth_skip_publicity_check,
827 :missing_oauth_check_definition
828 ]
829
830 scope "/test/api", Pleroma.Tests do
831 pipe_through(:api)
832
833 for action <- @test_actions do
834 get("/#{action}", AuthTestController, action)
835 end
836 end
837
838 scope "/test/authenticated_api", Pleroma.Tests do
839 pipe_through(:authenticated_api)
840
841 for action <- @test_actions do
842 get("/#{action}", AuthTestController, action)
843 end
844 end
845 end
846
847 scope "/", Pleroma.Web.MongooseIM do
848 get("/user_exists", MongooseIMController, :user_exists)
849 get("/check_password", MongooseIMController, :check_password)
850 end
851
852 scope "/", Pleroma.Web.Fallback do
853 get("/registration/:token", RedirectController, :registration_page)
854 get("/:maybe_nickname_or_id", RedirectController, :redirector_with_meta)
855 match(:*, "/api/pleroma*path", LegacyPleromaApiRerouterPlug, [])
856 get("/api*path", RedirectController, :api_not_implemented)
857 get("/*path", RedirectController, :redirector_with_preload)
858
859 options("/*path", RedirectController, :empty)
860 end
861
862 # TODO: Change to Phoenix.Router.routes/1 for Phoenix 1.6.0+
863 def get_api_routes do
864 __MODULE__.__routes__()
865 |> Enum.reject(fn r -> r.plug == Pleroma.Web.Fallback.RedirectController end)
866 |> Enum.map(fn r ->
867 r.path
868 |> String.split("/", trim: true)
869 |> List.first()
870 end)
871 |> Enum.uniq()
872 end
873 end