Add frontend preference route
[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 plug(Pleroma.Web.Plugs.EnsureHTTPSignaturePlug)
151 end
152
153 pipeline :static_fe do
154 plug(:fetch_session)
155 plug(:authenticate)
156 plug(Pleroma.Web.Plugs.StaticFEPlug)
157 end
158
159 scope "/api/v1/pleroma", Pleroma.Web.TwitterAPI do
160 pipe_through(:pleroma_api)
161
162 get("/password_reset/:token", PasswordController, :reset, as: :reset_password)
163 post("/password_reset", PasswordController, :do_reset, as: :reset_password)
164 get("/emoji", UtilController, :emoji)
165 get("/captcha", UtilController, :captcha)
166 get("/healthcheck", UtilController, :healthcheck)
167 post("/remote_interaction", UtilController, :remote_interaction)
168 end
169
170 scope "/api/v1/pleroma", Pleroma.Web do
171 pipe_through(:pleroma_api)
172 post("/uploader_callback/:upload_path", UploaderController, :callback)
173 end
174
175 # AdminAPI: only admins can perform these actions
176 scope "/api/v1/pleroma/admin", Pleroma.Web.AdminAPI do
177 pipe_through([:admin_api, :require_admin])
178
179 put("/users/disable_mfa", AdminAPIController, :disable_mfa)
180
181 get("/users/:nickname/permission_group", AdminAPIController, :right_get)
182 get("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_get)
183
184 post("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_add)
185
186 delete(
187 "/users/:nickname/permission_group/:permission_group",
188 AdminAPIController,
189 :right_delete
190 )
191
192 post("/users/permission_group/:permission_group", AdminAPIController, :right_add_multiple)
193
194 delete(
195 "/users/permission_group/:permission_group",
196 AdminAPIController,
197 :right_delete_multiple
198 )
199
200 post("/users/follow", UserController, :follow)
201 post("/users/unfollow", UserController, :unfollow)
202 post("/users", UserController, :create)
203
204 patch("/users/suggest", UserController, :suggest)
205 patch("/users/unsuggest", UserController, :unsuggest)
206
207 get("/relay", RelayController, :index)
208 post("/relay", RelayController, :follow)
209 delete("/relay", RelayController, :unfollow)
210
211 patch("/users/force_password_reset", AdminAPIController, :force_password_reset)
212 get("/users/:nickname/credentials", AdminAPIController, :show_user_credentials)
213 patch("/users/:nickname/credentials", AdminAPIController, :update_user_credentials)
214
215 get("/instance_document/:name", InstanceDocumentController, :show)
216 patch("/instance_document/:name", InstanceDocumentController, :update)
217 delete("/instance_document/:name", InstanceDocumentController, :delete)
218
219 patch("/users/confirm_email", AdminAPIController, :confirm_email)
220 patch("/users/resend_confirmation_email", AdminAPIController, :resend_confirmation_email)
221
222 get("/config", ConfigController, :show)
223 post("/config", ConfigController, :update)
224 get("/config/descriptions", ConfigController, :descriptions)
225 get("/need_reboot", AdminAPIController, :need_reboot)
226 get("/restart", AdminAPIController, :restart)
227
228 get("/oauth_app", OAuthAppController, :index)
229 post("/oauth_app", OAuthAppController, :create)
230 patch("/oauth_app/:id", OAuthAppController, :update)
231 delete("/oauth_app/:id", OAuthAppController, :delete)
232
233 get("/media_proxy_caches", MediaProxyCacheController, :index)
234 post("/media_proxy_caches/delete", MediaProxyCacheController, :delete)
235 post("/media_proxy_caches/purge", MediaProxyCacheController, :purge)
236
237 get("/frontends", FrontendController, :index)
238 post("/frontends/install", FrontendController, :install)
239
240 post("/backups", AdminAPIController, :create_backup)
241
242 get("/announcements", AnnouncementController, :index)
243 post("/announcements", AnnouncementController, :create)
244 get("/announcements/:id", AnnouncementController, :show)
245 patch("/announcements/:id", AnnouncementController, :change)
246 delete("/announcements/:id", AnnouncementController, :delete)
247 end
248
249 # AdminAPI: admins and mods (staff) can perform these actions (if enabled by config)
250 scope "/api/v1/pleroma/admin", Pleroma.Web.AdminAPI do
251 pipe_through([:admin_api, :require_privileged_staff])
252
253 delete("/users", UserController, :delete)
254
255 get("/users/:nickname/password_reset", AdminAPIController, :get_password_reset)
256 patch("/users/:nickname/credentials", AdminAPIController, :update_user_credentials)
257
258 get("/users/:nickname/statuses", AdminAPIController, :list_user_statuses)
259
260 get("/statuses", StatusController, :index)
261 end
262
263 # AdminAPI: admins and mods (staff) can perform these actions
264 scope "/api/v1/pleroma/admin", Pleroma.Web.AdminAPI do
265 pipe_through(:admin_api)
266
267 put("/users/tag", AdminAPIController, :tag_users)
268 delete("/users/tag", AdminAPIController, :untag_users)
269
270 patch("/users/:nickname/toggle_activation", UserController, :toggle_activation)
271 patch("/users/activate", UserController, :activate)
272 patch("/users/deactivate", UserController, :deactivate)
273 patch("/users/approve", UserController, :approve)
274
275 post("/users/invite_token", InviteController, :create)
276 get("/users/invites", InviteController, :index)
277 post("/users/revoke_invite", InviteController, :revoke)
278 post("/users/email_invite", InviteController, :email)
279
280 get("/users", UserController, :index)
281 get("/users/:nickname", UserController, :show)
282
283 get("/instances/:instance/statuses", InstanceController, :list_statuses)
284 delete("/instances/:instance", InstanceController, :delete)
285
286 get("/reports", ReportController, :index)
287 get("/reports/:id", ReportController, :show)
288 patch("/reports", ReportController, :update)
289 post("/reports/:id/notes", ReportController, :notes_create)
290 delete("/reports/:report_id/notes/:id", ReportController, :notes_delete)
291
292 get("/statuses/:id", StatusController, :show)
293 put("/statuses/:id", StatusController, :update)
294 delete("/statuses/:id", StatusController, :delete)
295
296 get("/moderation_log", AdminAPIController, :list_log)
297
298 post("/reload_emoji", AdminAPIController, :reload_emoji)
299 get("/stats", AdminAPIController, :stats)
300 end
301
302 scope "/api/v1/pleroma/emoji", Pleroma.Web.PleromaAPI do
303 scope "/pack" do
304 pipe_through(:admin_api)
305
306 post("/", EmojiPackController, :create)
307 patch("/", EmojiPackController, :update)
308 delete("/", EmojiPackController, :delete)
309 end
310
311 scope "/pack" do
312 pipe_through(:api)
313
314 get("/", EmojiPackController, :show)
315 end
316
317 # Modifying packs
318 scope "/packs" do
319 pipe_through(:admin_api)
320
321 get("/import", EmojiPackController, :import_from_filesystem)
322 get("/remote", EmojiPackController, :remote)
323 post("/download", EmojiPackController, :download)
324
325 post("/files", EmojiFileController, :create)
326 patch("/files", EmojiFileController, :update)
327 delete("/files", EmojiFileController, :delete)
328 end
329
330 # Pack info / downloading
331 scope "/packs" do
332 pipe_through(:api)
333
334 get("/", EmojiPackController, :index)
335 get("/archive", EmojiPackController, :archive)
336 end
337 end
338
339 scope "/", Pleroma.Web.TwitterAPI do
340 pipe_through(:pleroma_html)
341
342 post("/main/ostatus", UtilController, :remote_subscribe)
343 get("/main/ostatus", UtilController, :show_subscribe_form)
344 get("/ostatus_subscribe", RemoteFollowController, :follow)
345 post("/ostatus_subscribe", RemoteFollowController, :do_follow)
346 end
347
348 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
349 pipe_through(:authenticated_api)
350
351 post("/change_email", UtilController, :change_email)
352 post("/change_password", UtilController, :change_password)
353 post("/delete_account", UtilController, :delete_account)
354 put("/notification_settings", UtilController, :update_notificaton_settings)
355 post("/disable_account", UtilController, :disable_account)
356 post("/move_account", UtilController, :move_account)
357
358 put("/aliases", UtilController, :add_alias)
359 get("/aliases", UtilController, :list_aliases)
360 delete("/aliases", UtilController, :delete_alias)
361 end
362
363 scope "/api/pleroma", Pleroma.Web.PleromaAPI do
364 pipe_through(:authenticated_api)
365
366 post("/mutes_import", UserImportController, :mutes)
367 post("/blocks_import", UserImportController, :blocks)
368 post("/follow_import", UserImportController, :follow)
369
370 get("/accounts/mfa", TwoFactorAuthenticationController, :settings)
371 get("/accounts/mfa/backup_codes", TwoFactorAuthenticationController, :backup_codes)
372 get("/accounts/mfa/setup/:method", TwoFactorAuthenticationController, :setup)
373 post("/accounts/mfa/confirm/:method", TwoFactorAuthenticationController, :confirm)
374 delete("/accounts/mfa/:method", TwoFactorAuthenticationController, :disable)
375 end
376
377 scope "/oauth", Pleroma.Web.OAuth do
378 # Note: use /api/v1/accounts/verify_credentials for userinfo of signed-in user
379
380 get("/registration_details", OAuthController, :registration_details)
381
382 post("/mfa/verify", MFAController, :verify, as: :mfa_verify)
383 get("/mfa", MFAController, :show)
384
385 scope [] do
386 pipe_through(:oauth)
387
388 get("/authorize", OAuthController, :authorize)
389 post("/authorize", OAuthController, :create_authorization)
390 end
391
392 scope [] do
393 pipe_through(:fetch_session)
394
395 post("/token", OAuthController, :token_exchange)
396 post("/revoke", OAuthController, :token_revoke)
397 post("/mfa/challenge", MFAController, :challenge)
398 end
399
400 scope [] do
401 pipe_through(:browser)
402
403 get("/prepare_request", OAuthController, :prepare_request)
404 get("/:provider", OAuthController, :request)
405 get("/:provider/callback", OAuthController, :callback)
406 post("/register", OAuthController, :register)
407 end
408 end
409
410 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
411 pipe_through(:api)
412
413 get("/apps", AppController, :index)
414 get("/statuses/:id/reactions/:emoji", EmojiReactionController, :index)
415 get("/statuses/:id/reactions", EmojiReactionController, :index)
416 end
417
418 scope "/api/v0/pleroma", Pleroma.Web.PleromaAPI do
419 pipe_through(:authenticated_api)
420 get("/reports", ReportController, :index)
421 get("/reports/:id", ReportController, :show)
422 end
423
424 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
425 scope [] do
426 pipe_through(:authenticated_api)
427
428 get("/conversations/:id/statuses", ConversationController, :statuses)
429 get("/conversations/:id", ConversationController, :show)
430 post("/conversations/read", ConversationController, :mark_as_read)
431 patch("/conversations/:id", ConversationController, :update)
432
433 put("/statuses/:id/reactions/:emoji", EmojiReactionController, :create)
434 delete("/statuses/:id/reactions/:emoji", EmojiReactionController, :delete)
435 post("/notifications/read", NotificationController, :mark_as_read)
436
437 get("/mascot", MascotController, :show)
438 put("/mascot", MascotController, :update)
439
440 get("/backups", BackupController, :index)
441 post("/backups", BackupController, :create)
442 end
443
444 scope [] do
445 pipe_through(:api)
446 get("/accounts/:id/favourites", AccountController, :favourites)
447 end
448
449 scope [] do
450 pipe_through(:authenticated_api)
451
452 post("/accounts/:id/subscribe", AccountController, :subscribe)
453 post("/accounts/:id/unsubscribe", AccountController, :unsubscribe)
454 end
455
456 post("/accounts/confirmation_resend", AccountController, :confirmation_resend)
457 end
458
459 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
460 pipe_through(:api)
461 get("/federation_status", InstancesController, :show)
462 end
463
464 scope "/api/v1", Pleroma.Web.PleromaAPI do
465 pipe_through(:authenticated_api)
466 put("/statuses/:id/emoji_reactions/:emoji", EmojiReactionController, :create)
467 end
468
469 scope "/api/v1/akkoma", Pleroma.Web.AkkomaAPI do
470 pipe_through(:api)
471
472 get(
473 "/api/v1/akkoma/preferred_frontend/available",
474 FrontendSettingsController,
475 :available_frontends
476 )
477
478 put(
479 "/api/v1/akkoma/preferred_frontend",
480 FrontendSettingsController,
481 :update_preferred_frontend
482 )
483 end
484
485 scope "/api/v1/akkoma", Pleroma.Web.AkkomaAPI do
486 pipe_through(:authenticated_api)
487 get("/metrics", MetricsController, :show)
488 get("/translation/languages", TranslationController, :languages)
489
490 get("/frontend_settings/:frontend_name", FrontendSettingsController, :list_profiles)
491
492 get(
493 "/frontend_settings/:frontend_name/:profile_name",
494 FrontendSettingsController,
495 :get_profile
496 )
497
498 put(
499 "/frontend_settings/:frontend_name/:profile_name",
500 FrontendSettingsController,
501 :update_profile
502 )
503
504 delete(
505 "/frontend_settings/:frontend_name/:profile_name",
506 FrontendSettingsController,
507 :delete_profile
508 )
509 end
510
511 scope "/api/v1", Pleroma.Web.MastodonAPI do
512 pipe_through(:authenticated_api)
513
514 get("/accounts/verify_credentials", AccountController, :verify_credentials)
515 patch("/accounts/update_credentials", AccountController, :update_credentials)
516
517 get("/accounts/relationships", AccountController, :relationships)
518 get("/accounts/:id/lists", AccountController, :lists)
519 get("/accounts/:id/identity_proofs", AccountController, :identity_proofs)
520 get("/endorsements", AccountController, :endorsements)
521 get("/blocks", AccountController, :blocks)
522 get("/mutes", AccountController, :mutes)
523
524 post("/follows", AccountController, :follow_by_uri)
525 post("/accounts/:id/follow", AccountController, :follow)
526 post("/accounts/:id/unfollow", AccountController, :unfollow)
527 post("/accounts/:id/block", AccountController, :block)
528 post("/accounts/:id/unblock", AccountController, :unblock)
529 post("/accounts/:id/mute", AccountController, :mute)
530 post("/accounts/:id/unmute", AccountController, :unmute)
531 post("/accounts/:id/note", AccountController, :note)
532 post("/accounts/:id/remove_from_followers", AccountController, :remove_from_followers)
533
534 get("/conversations", ConversationController, :index)
535 post("/conversations/:id/read", ConversationController, :mark_as_read)
536 delete("/conversations/:id", ConversationController, :delete)
537
538 get("/domain_blocks", DomainBlockController, :index)
539 post("/domain_blocks", DomainBlockController, :create)
540 delete("/domain_blocks", DomainBlockController, :delete)
541
542 get("/filters", FilterController, :index)
543
544 post("/filters", FilterController, :create)
545 get("/filters/:id", FilterController, :show)
546 put("/filters/:id", FilterController, :update)
547 delete("/filters/:id", FilterController, :delete)
548
549 get("/follow_requests", FollowRequestController, :index)
550 post("/follow_requests/:id/authorize", FollowRequestController, :authorize)
551 post("/follow_requests/:id/reject", FollowRequestController, :reject)
552
553 get("/lists", ListController, :index)
554 get("/lists/:id", ListController, :show)
555 get("/lists/:id/accounts", ListController, :list_accounts)
556
557 delete("/lists/:id", ListController, :delete)
558 post("/lists", ListController, :create)
559 put("/lists/:id", ListController, :update)
560 post("/lists/:id/accounts", ListController, :add_to_list)
561 delete("/lists/:id/accounts", ListController, :remove_from_list)
562
563 get("/markers", MarkerController, :index)
564 post("/markers", MarkerController, :upsert)
565
566 post("/media", MediaController, :create)
567 get("/media/:id", MediaController, :show)
568 put("/media/:id", MediaController, :update)
569
570 get("/notifications", NotificationController, :index)
571 get("/notifications/:id", NotificationController, :show)
572
573 post("/notifications/:id/dismiss", NotificationController, :dismiss)
574 post("/notifications/clear", NotificationController, :clear)
575 delete("/notifications/destroy_multiple", NotificationController, :destroy_multiple)
576
577 post("/polls/:id/votes", PollController, :vote)
578
579 post("/reports", ReportController, :create)
580
581 get("/scheduled_statuses", ScheduledActivityController, :index)
582 get("/scheduled_statuses/:id", ScheduledActivityController, :show)
583
584 put("/scheduled_statuses/:id", ScheduledActivityController, :update)
585 delete("/scheduled_statuses/:id", ScheduledActivityController, :delete)
586
587 # Unlike `GET /api/v1/accounts/:id/favourites`, demands authentication
588 get("/favourites", StatusController, :favourites)
589 get("/bookmarks", StatusController, :bookmarks)
590
591 post("/statuses", StatusController, :create)
592 put("/statuses/:id", StatusController, :update)
593 delete("/statuses/:id", StatusController, :delete)
594 post("/statuses/:id/reblog", StatusController, :reblog)
595 post("/statuses/:id/unreblog", StatusController, :unreblog)
596 post("/statuses/:id/favourite", StatusController, :favourite)
597 post("/statuses/:id/unfavourite", StatusController, :unfavourite)
598 post("/statuses/:id/pin", StatusController, :pin)
599 post("/statuses/:id/unpin", StatusController, :unpin)
600 post("/statuses/:id/bookmark", StatusController, :bookmark)
601 post("/statuses/:id/unbookmark", StatusController, :unbookmark)
602 post("/statuses/:id/mute", StatusController, :mute_conversation)
603 post("/statuses/:id/unmute", StatusController, :unmute_conversation)
604 get("/statuses/:id/translations/:language", StatusController, :translate)
605
606 post("/push/subscription", SubscriptionController, :create)
607 get("/push/subscription", SubscriptionController, :show)
608 put("/push/subscription", SubscriptionController, :update)
609 delete("/push/subscription", SubscriptionController, :delete)
610
611 get("/suggestions", SuggestionController, :index)
612 delete("/suggestions/:account_id", SuggestionController, :dismiss)
613
614 get("/timelines/home", TimelineController, :home)
615 get("/timelines/direct", TimelineController, :direct)
616 get("/timelines/list/:list_id", TimelineController, :list)
617 get("/timelines/bubble", TimelineController, :bubble)
618
619 get("/announcements", AnnouncementController, :index)
620 post("/announcements/:id/dismiss", AnnouncementController, :mark_read)
621
622 get("/tags/:id", TagController, :show)
623 post("/tags/:id/follow", TagController, :follow)
624 post("/tags/:id/unfollow", TagController, :unfollow)
625 get("/followed_tags", TagController, :show_followed)
626 end
627
628 scope "/api/web", Pleroma.Web do
629 pipe_through(:authenticated_api)
630
631 # Backend-obscure settings blob for MastoFE, don't parse/reuse elsewhere
632 put("/settings", MastoFEController, :put_settings)
633 end
634
635 scope "/api/v1", Pleroma.Web.MastodonAPI do
636 pipe_through(:app_api)
637
638 post("/apps", AppController, :create)
639 get("/apps/verify_credentials", AppController, :verify_credentials)
640 end
641
642 scope "/api/v1", Pleroma.Web.MastodonAPI do
643 pipe_through(:api)
644
645 get("/accounts/search", SearchController, :account_search)
646 get("/accounts/lookup", AccountController, :lookup)
647
648 get("/accounts/:id/statuses", AccountController, :statuses)
649 get("/accounts/:id/followers", AccountController, :followers)
650 get("/accounts/:id/following", AccountController, :following)
651 get("/accounts/:id", AccountController, :show)
652
653 post("/accounts", AccountController, :create)
654
655 get("/instance", InstanceController, :show)
656 get("/instance/peers", InstanceController, :peers)
657
658 get("/statuses", StatusController, :index)
659 get("/statuses/:id", StatusController, :show)
660 get("/statuses/:id/context", StatusController, :context)
661 get("/statuses/:id/favourited_by", StatusController, :favourited_by)
662 get("/statuses/:id/reblogged_by", StatusController, :reblogged_by)
663 get("/statuses/:id/history", StatusController, :show_history)
664 get("/statuses/:id/source", StatusController, :show_source)
665
666 get("/custom_emojis", CustomEmojiController, :index)
667
668 get("/trends", MastodonAPIController, :empty_array)
669
670 get("/timelines/public", TimelineController, :public)
671 get("/timelines/tag/:tag", TimelineController, :hashtag)
672
673 get("/polls/:id", PollController, :show)
674
675 get("/directory", DirectoryController, :index)
676 end
677
678 scope "/api/v2", Pleroma.Web.MastodonAPI do
679 pipe_through(:api)
680 get("/search", SearchController, :search2)
681
682 post("/media", MediaController, :create2)
683
684 get("/suggestions", SuggestionController, :index2)
685 end
686
687 scope "/api", Pleroma.Web do
688 pipe_through(:config)
689
690 get("/pleroma/frontend_configurations", TwitterAPI.UtilController, :frontend_configurations)
691 end
692
693 scope "/api", Pleroma.Web do
694 pipe_through(:api)
695
696 get(
697 "/account/confirm_email/:user_id/:token",
698 TwitterAPI.Controller,
699 :confirm_email,
700 as: :confirm_email
701 )
702 end
703
704 scope "/api" do
705 pipe_through(:base_api)
706
707 get("/openapi", OpenApiSpex.Plug.RenderSpec, [])
708 end
709
710 scope "/api", Pleroma.Web, as: :authenticated_twitter_api do
711 pipe_through(:authenticated_api)
712
713 get("/oauth_tokens", TwitterAPI.Controller, :oauth_tokens)
714 delete("/oauth_tokens/:id", TwitterAPI.Controller, :revoke_token)
715 end
716
717 scope "/", Pleroma.Web do
718 # Note: html format is supported only if static FE is enabled
719 # Note: http signature is only considered for json requests (no auth for non-json requests)
720 pipe_through([:accepts_html_json, :http_signature, :static_fe])
721
722 get("/objects/:uuid", OStatus.OStatusController, :object)
723 get("/activities/:uuid", OStatus.OStatusController, :activity)
724 get("/notice/:id", OStatus.OStatusController, :notice)
725
726 # Notice compatibility routes for other frontends
727 get("/@:nickname/:id", OStatus.OStatusController, :notice)
728 get("/@:nickname/posts/:id", OStatus.OStatusController, :notice)
729 get("/:nickname/status/:id", OStatus.OStatusController, :notice)
730
731 # Mastodon compatibility routes
732 get("/users/:nickname/statuses/:id", OStatus.OStatusController, :object)
733 get("/users/:nickname/statuses/:id/activity", OStatus.OStatusController, :activity)
734 end
735
736 scope "/", Pleroma.Web do
737 # Note: html format is supported only if static FE is enabled
738 # Note: http signature is only considered for json requests (no auth for non-json requests)
739 pipe_through([:accepts_html_xml_json, :http_signature, :static_fe])
740
741 # Note: returns user _profile_ for json requests, redirects to user _feed_ for non-json ones
742 get("/users/:nickname", Feed.UserController, :feed_redirect, as: :user_feed)
743 end
744
745 scope "/", Pleroma.Web do
746 # Note: html format is supported only if static FE is enabled
747 pipe_through([:accepts_html_xml, :static_fe])
748
749 get("/users/:nickname/feed", Feed.UserController, :feed, as: :user_feed)
750 end
751
752 scope "/", Pleroma.Web.StaticFE do
753 # Profile pages for static-fe
754 get("/users/:nickname/with_replies", StaticFEController, :show)
755 get("/users/:nickname/media", StaticFEController, :show)
756 end
757
758 scope "/", Pleroma.Web do
759 pipe_through(:accepts_html)
760 get("/notice/:id/embed_player", OStatus.OStatusController, :notice_player)
761 end
762
763 scope "/", Pleroma.Web do
764 pipe_through(:accepts_xml_rss_atom)
765 get("/tags/:tag", Feed.TagController, :feed, as: :tag_feed)
766 end
767
768 scope "/", Pleroma.Web do
769 pipe_through(:browser)
770 get("/mailer/unsubscribe/:token", Mailer.SubscriptionController, :unsubscribe)
771 end
772
773 pipeline :ap_service_actor do
774 plug(:accepts, ["activity+json", "json"])
775 end
776
777 # Server to Server (S2S) AP interactions
778 pipeline :activitypub do
779 plug(:ap_service_actor)
780 plug(:http_signature)
781 end
782
783 # Client to Server (C2S) AP interactions
784 pipeline :activitypub_client do
785 plug(:ap_service_actor)
786 plug(:fetch_session)
787 plug(:authenticate)
788 plug(:after_auth)
789 end
790
791 scope "/", Pleroma.Web.ActivityPub do
792 pipe_through([:activitypub_client])
793
794 get("/api/ap/whoami", ActivityPubController, :whoami)
795 get("/users/:nickname/inbox", ActivityPubController, :read_inbox)
796
797 get("/users/:nickname/outbox", ActivityPubController, :outbox)
798 post("/users/:nickname/outbox", ActivityPubController, :update_outbox)
799 post("/api/ap/upload_media", ActivityPubController, :upload_media)
800
801 get("/users/:nickname/collections/featured", ActivityPubController, :pinned)
802 end
803
804 scope "/", Pleroma.Web.ActivityPub do
805 # Note: html format is supported only if static FE is enabled
806 pipe_through([:accepts_html_json, :static_fe, :activitypub_client])
807
808 # The following two are S2S as well, see `ActivityPub.fetch_follow_information_for_user/1`:
809 get("/users/:nickname/followers", ActivityPubController, :followers)
810 get("/users/:nickname/following", ActivityPubController, :following)
811 end
812
813 scope "/", Pleroma.Web.ActivityPub do
814 pipe_through(:activitypub)
815 post("/inbox", ActivityPubController, :inbox)
816 post("/users/:nickname/inbox", ActivityPubController, :inbox)
817 end
818
819 scope "/relay", Pleroma.Web.ActivityPub do
820 pipe_through(:ap_service_actor)
821
822 get("/", ActivityPubController, :relay)
823
824 scope [] do
825 pipe_through(:http_signature)
826 post("/inbox", ActivityPubController, :inbox)
827 end
828
829 get("/following", ActivityPubController, :relay_following)
830 get("/followers", ActivityPubController, :relay_followers)
831 end
832
833 scope "/internal/fetch", Pleroma.Web.ActivityPub do
834 pipe_through(:ap_service_actor)
835
836 get("/", ActivityPubController, :internal_fetch)
837 post("/inbox", ActivityPubController, :inbox)
838 end
839
840 scope "/.well-known", Pleroma.Web do
841 pipe_through(:well_known)
842
843 get("/host-meta", WebFinger.WebFingerController, :host_meta)
844 get("/webfinger", WebFinger.WebFingerController, :webfinger)
845 get("/nodeinfo", Nodeinfo.NodeinfoController, :schemas)
846 end
847
848 scope "/nodeinfo", Pleroma.Web do
849 get("/:version", Nodeinfo.NodeinfoController, :nodeinfo)
850 end
851
852 scope "/", Pleroma.Web do
853 pipe_through(:api)
854
855 get("/manifest.json", ManifestController, :show)
856 get("/web/manifest.json", MastoFEController, :manifest)
857 end
858
859 scope "/", Pleroma.Web do
860 pipe_through(:mastodon_html)
861
862 get("/web/login", MastodonAPI.AuthController, :login)
863 delete("/auth/sign_out", MastodonAPI.AuthController, :logout)
864
865 post("/auth/password", MastodonAPI.AuthController, :password_reset)
866
867 get("/web/*path", MastoFEController, :index)
868
869 get("/embed/:id", EmbedController, :show)
870 end
871
872 scope "/proxy/", Pleroma.Web do
873 get("/preview/:sig/:url", MediaProxy.MediaProxyController, :preview)
874 get("/preview/:sig/:url/:filename", MediaProxy.MediaProxyController, :preview)
875 get("/:sig/:url", MediaProxy.MediaProxyController, :remote)
876 get("/:sig/:url/:filename", MediaProxy.MediaProxyController, :remote)
877 end
878
879 if Pleroma.Config.get(:env) == :dev do
880 scope "/dev" do
881 pipe_through([:mailbox_preview])
882
883 forward("/mailbox", Plug.Swoosh.MailboxPreview, base_path: "/dev/mailbox")
884 end
885 end
886
887 scope "/" do
888 pipe_through([:pleroma_html, :authenticate, :require_admin])
889
890 live_dashboard("/phoenix/live_dashboard",
891 metrics: {Pleroma.Web.Telemetry, :live_dashboard_metrics},
892 csp_nonce_assign_key: :csp_nonce
893 )
894 end
895
896 # Test-only routes needed to test action dispatching and plug chain execution
897 if Pleroma.Config.get(:env) == :test do
898 @test_actions [
899 :do_oauth_check,
900 :fallback_oauth_check,
901 :skip_oauth_check,
902 :fallback_oauth_skip_publicity_check,
903 :skip_oauth_skip_publicity_check,
904 :missing_oauth_check_definition
905 ]
906
907 scope "/test/api", Pleroma.Tests do
908 pipe_through(:api)
909
910 for action <- @test_actions do
911 get("/#{action}", AuthTestController, action)
912 end
913 end
914
915 scope "/test/authenticated_api", Pleroma.Tests do
916 pipe_through(:authenticated_api)
917
918 for action <- @test_actions do
919 get("/#{action}", AuthTestController, action)
920 end
921 end
922 end
923
924 scope "/", Pleroma.Web.MongooseIM do
925 get("/user_exists", MongooseIMController, :user_exists)
926 get("/check_password", MongooseIMController, :check_password)
927 end
928
929 scope "/", Pleroma.Web.Fallback do
930 get("/registration/:token", RedirectController, :registration_page)
931 get("/:maybe_nickname_or_id", RedirectController, :redirector_with_meta)
932 get("/api/*path", RedirectController, :api_not_implemented)
933 get("/*path", RedirectController, :redirector_with_preload)
934
935 options("/*path", RedirectController, :empty)
936 end
937
938 # TODO: Change to Phoenix.Router.routes/1 for Phoenix 1.6.0+
939 def get_api_routes do
940 Phoenix.Router.routes(__MODULE__)
941 |> Enum.reject(fn r -> r.plug == Pleroma.Web.Fallback.RedirectController end)
942 |> Enum.map(fn r ->
943 r.path
944 |> String.split("/", trim: true)
945 |> List.first()
946 end)
947 |> Enum.uniq()
948 end
949 end