1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.Router do
6 use Pleroma.Web, :router
7 import Phoenix.LiveDashboard.Router
9 pipeline :accepts_html do
10 plug(:accepts, ["html"])
13 pipeline :accepts_html_xml do
14 plug(:accepts, ["html", "xml", "rss", "atom"])
17 pipeline :accepts_html_json do
18 plug(:accepts, ["html", "activity+json", "json"])
21 pipeline :accepts_html_xml_json do
22 plug(:accepts, ["html", "xml", "rss", "atom", "activity+json", "json"])
25 pipeline :accepts_xml_rss_atom do
26 plug(:accepts, ["xml", "rss", "atom"])
30 plug(:accepts, ["html"])
36 plug(Pleroma.Web.Plugs.OAuthPlug)
37 plug(Pleroma.Web.Plugs.UserEnabledPlug)
38 plug(Pleroma.Web.Plugs.EnsureUserTokenAssignsPlug)
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)
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)
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)
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)
66 plug(:accepts, ["json"])
69 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
72 pipeline :no_auth_or_privacy_expectations_api do
75 plug(Pleroma.Web.Plugs.IdempotencyPlug)
78 # Pipeline for app-related endpoints (no user auth checks — app-bound tokens must be supported)
80 plug(:no_auth_or_privacy_expectations_api)
84 plug(:expect_public_instance_or_user_authentication)
85 plug(:no_auth_or_privacy_expectations_api)
88 pipeline :authenticated_api do
89 plug(:expect_user_authentication)
90 plug(:no_auth_or_privacy_expectations_api)
91 plug(Pleroma.Web.Plugs.EnsureAuthenticatedPlug)
94 pipeline :admin_api do
95 plug(:expect_user_authentication)
97 plug(Pleroma.Web.Plugs.AdminSecretAuthenticationPlug)
99 plug(Pleroma.Web.Plugs.EnsureAuthenticatedPlug)
100 plug(Pleroma.Web.Plugs.UserIsStaffPlug)
101 plug(Pleroma.Web.Plugs.IdempotencyPlug)
104 pipeline :require_privileged_staff do
105 plug(Pleroma.Web.Plugs.EnsureStaffPrivilegedPlug)
108 pipeline :require_admin do
109 plug(Pleroma.Web.Plugs.UserIsAdminPlug)
112 pipeline :mastodon_html do
118 pipeline :pleroma_html do
121 plug(Pleroma.Web.Plugs.EnsureUserTokenAssignsPlug)
124 pipeline :well_known do
125 plug(:accepts, ["json", "jrd+json", "xml", "xrd+xml"])
129 plug(:accepts, ["json", "xml"])
130 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
133 pipeline :pleroma_api do
134 plug(:accepts, ["html", "json"])
135 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
138 pipeline :mailbox_preview do
139 plug(:accepts, ["html"])
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'"
147 pipeline :http_signature do
148 plug(Pleroma.Web.Plugs.HTTPSignaturePlug)
149 plug(Pleroma.Web.Plugs.MappedSignatureToIdentityPlug)
150 plug(Pleroma.Web.Plugs.EnsureHTTPSignaturePlug)
153 pipeline :static_fe do
156 plug(Pleroma.Web.Plugs.StaticFEPlug)
159 scope "/api/v1/pleroma", Pleroma.Web.TwitterAPI do
160 pipe_through(:pleroma_api)
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)
170 scope "/api/v1/pleroma", Pleroma.Web do
171 pipe_through(:pleroma_api)
172 post("/uploader_callback/:upload_path", UploaderController, :callback)
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])
179 put("/users/disable_mfa", AdminAPIController, :disable_mfa)
181 get("/users/:nickname/permission_group", AdminAPIController, :right_get)
182 get("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_get)
184 post("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_add)
187 "/users/:nickname/permission_group/:permission_group",
192 post("/users/permission_group/:permission_group", AdminAPIController, :right_add_multiple)
195 "/users/permission_group/:permission_group",
197 :right_delete_multiple
200 post("/users/follow", UserController, :follow)
201 post("/users/unfollow", UserController, :unfollow)
202 post("/users", UserController, :create)
204 patch("/users/suggest", UserController, :suggest)
205 patch("/users/unsuggest", UserController, :unsuggest)
207 get("/relay", RelayController, :index)
208 post("/relay", RelayController, :follow)
209 delete("/relay", RelayController, :unfollow)
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)
215 get("/instance_document/:name", InstanceDocumentController, :show)
216 patch("/instance_document/:name", InstanceDocumentController, :update)
217 delete("/instance_document/:name", InstanceDocumentController, :delete)
219 patch("/users/confirm_email", AdminAPIController, :confirm_email)
220 patch("/users/resend_confirmation_email", AdminAPIController, :resend_confirmation_email)
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)
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)
233 get("/media_proxy_caches", MediaProxyCacheController, :index)
234 post("/media_proxy_caches/delete", MediaProxyCacheController, :delete)
235 post("/media_proxy_caches/purge", MediaProxyCacheController, :purge)
237 get("/frontends", FrontendController, :index)
238 post("/frontends/install", FrontendController, :install)
240 post("/backups", AdminAPIController, :create_backup)
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)
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])
253 delete("/users", UserController, :delete)
255 get("/users/:nickname/password_reset", AdminAPIController, :get_password_reset)
256 patch("/users/:nickname/credentials", AdminAPIController, :update_user_credentials)
258 get("/users/:nickname/statuses", AdminAPIController, :list_user_statuses)
260 get("/statuses", StatusController, :index)
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)
267 put("/users/tag", AdminAPIController, :tag_users)
268 delete("/users/tag", AdminAPIController, :untag_users)
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)
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)
280 get("/users", UserController, :index)
281 get("/users/:nickname", UserController, :show)
283 get("/instances/:instance/statuses", InstanceController, :list_statuses)
284 delete("/instances/:instance", InstanceController, :delete)
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)
292 get("/statuses/:id", StatusController, :show)
293 put("/statuses/:id", StatusController, :update)
294 delete("/statuses/:id", StatusController, :delete)
296 get("/moderation_log", AdminAPIController, :list_log)
298 post("/reload_emoji", AdminAPIController, :reload_emoji)
299 get("/stats", AdminAPIController, :stats)
302 scope "/api/v1/pleroma/emoji", Pleroma.Web.PleromaAPI do
304 pipe_through(:admin_api)
306 post("/", EmojiPackController, :create)
307 patch("/", EmojiPackController, :update)
308 delete("/", EmojiPackController, :delete)
314 get("/", EmojiPackController, :show)
319 pipe_through(:admin_api)
321 get("/import", EmojiPackController, :import_from_filesystem)
322 get("/remote", EmojiPackController, :remote)
323 post("/download", EmojiPackController, :download)
325 post("/files", EmojiFileController, :create)
326 patch("/files", EmojiFileController, :update)
327 delete("/files", EmojiFileController, :delete)
330 # Pack info / downloading
334 get("/", EmojiPackController, :index)
335 get("/archive", EmojiPackController, :archive)
339 scope "/", Pleroma.Web.TwitterAPI do
340 pipe_through(:pleroma_html)
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)
348 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
349 pipe_through(:authenticated_api)
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)
358 put("/aliases", UtilController, :add_alias)
359 get("/aliases", UtilController, :list_aliases)
360 delete("/aliases", UtilController, :delete_alias)
363 scope "/api/pleroma", Pleroma.Web.PleromaAPI do
364 pipe_through(:authenticated_api)
366 post("/mutes_import", UserImportController, :mutes)
367 post("/blocks_import", UserImportController, :blocks)
368 post("/follow_import", UserImportController, :follow)
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)
377 scope "/oauth", Pleroma.Web.OAuth do
378 # Note: use /api/v1/accounts/verify_credentials for userinfo of signed-in user
380 get("/registration_details", OAuthController, :registration_details)
382 post("/mfa/verify", MFAController, :verify, as: :mfa_verify)
383 get("/mfa", MFAController, :show)
388 get("/authorize", OAuthController, :authorize)
389 post("/authorize", OAuthController, :create_authorization)
393 pipe_through(:fetch_session)
395 post("/token", OAuthController, :token_exchange)
396 post("/revoke", OAuthController, :token_revoke)
397 post("/mfa/challenge", MFAController, :challenge)
401 pipe_through(:browser)
403 get("/prepare_request", OAuthController, :prepare_request)
404 get("/:provider", OAuthController, :request)
405 get("/:provider/callback", OAuthController, :callback)
406 post("/register", OAuthController, :register)
410 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
413 get("/apps", AppController, :index)
414 get("/statuses/:id/reactions/:emoji", EmojiReactionController, :index)
415 get("/statuses/:id/reactions", EmojiReactionController, :index)
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)
424 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
426 pipe_through(:authenticated_api)
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)
433 put("/statuses/:id/reactions/:emoji", EmojiReactionController, :create)
434 delete("/statuses/:id/reactions/:emoji", EmojiReactionController, :delete)
435 post("/notifications/read", NotificationController, :mark_as_read)
437 get("/mascot", MascotController, :show)
438 put("/mascot", MascotController, :update)
440 get("/backups", BackupController, :index)
441 post("/backups", BackupController, :create)
446 get("/accounts/:id/favourites", AccountController, :favourites)
450 pipe_through(:authenticated_api)
452 post("/accounts/:id/subscribe", AccountController, :subscribe)
453 post("/accounts/:id/unsubscribe", AccountController, :unsubscribe)
456 post("/accounts/confirmation_resend", AccountController, :confirmation_resend)
459 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
461 get("/federation_status", InstancesController, :show)
464 scope "/api/v1", Pleroma.Web.PleromaAPI do
465 pipe_through(:authenticated_api)
466 put("/statuses/:id/emoji_reactions/:emoji", EmojiReactionController, :create)
469 scope "/akkoma/", Pleroma.Web.AkkomaAPI do
470 pipe_through(:browser)
472 get("/frontend", FrontendSwitcherController, :switch)
473 post("/frontend", FrontendSwitcherController, :do_switch)
476 scope "/api/v1/akkoma", Pleroma.Web.AkkomaAPI do
480 "/api/v1/akkoma/preferred_frontend/available",
481 FrontendSettingsController,
486 "/api/v1/akkoma/preferred_frontend",
487 FrontendSettingsController,
488 :update_preferred_frontend
492 scope "/api/v1/akkoma", Pleroma.Web.AkkomaAPI do
493 pipe_through(:authenticated_api)
494 get("/metrics", MetricsController, :show)
495 get("/translation/languages", TranslationController, :languages)
497 get("/frontend_settings/:frontend_name", FrontendSettingsController, :list_profiles)
500 "/frontend_settings/:frontend_name/:profile_name",
501 FrontendSettingsController,
506 "/frontend_settings/:frontend_name/:profile_name",
507 FrontendSettingsController,
512 "/frontend_settings/:frontend_name/:profile_name",
513 FrontendSettingsController,
518 scope "/api/v1", Pleroma.Web.MastodonAPI do
519 pipe_through(:authenticated_api)
521 get("/accounts/verify_credentials", AccountController, :verify_credentials)
522 patch("/accounts/update_credentials", AccountController, :update_credentials)
524 get("/accounts/relationships", AccountController, :relationships)
525 get("/accounts/:id/lists", AccountController, :lists)
526 get("/accounts/:id/identity_proofs", AccountController, :identity_proofs)
527 get("/endorsements", AccountController, :endorsements)
528 get("/blocks", AccountController, :blocks)
529 get("/mutes", AccountController, :mutes)
531 post("/follows", AccountController, :follow_by_uri)
532 post("/accounts/:id/follow", AccountController, :follow)
533 post("/accounts/:id/unfollow", AccountController, :unfollow)
534 post("/accounts/:id/block", AccountController, :block)
535 post("/accounts/:id/unblock", AccountController, :unblock)
536 post("/accounts/:id/mute", AccountController, :mute)
537 post("/accounts/:id/unmute", AccountController, :unmute)
538 post("/accounts/:id/note", AccountController, :note)
539 post("/accounts/:id/remove_from_followers", AccountController, :remove_from_followers)
541 get("/conversations", ConversationController, :index)
542 post("/conversations/:id/read", ConversationController, :mark_as_read)
543 delete("/conversations/:id", ConversationController, :delete)
545 get("/domain_blocks", DomainBlockController, :index)
546 post("/domain_blocks", DomainBlockController, :create)
547 delete("/domain_blocks", DomainBlockController, :delete)
549 get("/filters", FilterController, :index)
551 post("/filters", FilterController, :create)
552 get("/filters/:id", FilterController, :show)
553 put("/filters/:id", FilterController, :update)
554 delete("/filters/:id", FilterController, :delete)
556 get("/follow_requests", FollowRequestController, :index)
557 post("/follow_requests/:id/authorize", FollowRequestController, :authorize)
558 post("/follow_requests/:id/reject", FollowRequestController, :reject)
560 get("/lists", ListController, :index)
561 get("/lists/:id", ListController, :show)
562 get("/lists/:id/accounts", ListController, :list_accounts)
564 delete("/lists/:id", ListController, :delete)
565 post("/lists", ListController, :create)
566 put("/lists/:id", ListController, :update)
567 post("/lists/:id/accounts", ListController, :add_to_list)
568 delete("/lists/:id/accounts", ListController, :remove_from_list)
570 get("/markers", MarkerController, :index)
571 post("/markers", MarkerController, :upsert)
573 post("/media", MediaController, :create)
574 get("/media/:id", MediaController, :show)
575 put("/media/:id", MediaController, :update)
577 get("/notifications", NotificationController, :index)
578 get("/notifications/:id", NotificationController, :show)
580 post("/notifications/:id/dismiss", NotificationController, :dismiss)
581 post("/notifications/clear", NotificationController, :clear)
582 delete("/notifications/destroy_multiple", NotificationController, :destroy_multiple)
584 post("/polls/:id/votes", PollController, :vote)
586 post("/reports", ReportController, :create)
588 get("/scheduled_statuses", ScheduledActivityController, :index)
589 get("/scheduled_statuses/:id", ScheduledActivityController, :show)
591 put("/scheduled_statuses/:id", ScheduledActivityController, :update)
592 delete("/scheduled_statuses/:id", ScheduledActivityController, :delete)
594 # Unlike `GET /api/v1/accounts/:id/favourites`, demands authentication
595 get("/favourites", StatusController, :favourites)
596 get("/bookmarks", StatusController, :bookmarks)
598 post("/statuses", StatusController, :create)
599 put("/statuses/:id", StatusController, :update)
600 delete("/statuses/:id", StatusController, :delete)
601 post("/statuses/:id/reblog", StatusController, :reblog)
602 post("/statuses/:id/unreblog", StatusController, :unreblog)
603 post("/statuses/:id/favourite", StatusController, :favourite)
604 post("/statuses/:id/unfavourite", StatusController, :unfavourite)
605 post("/statuses/:id/pin", StatusController, :pin)
606 post("/statuses/:id/unpin", StatusController, :unpin)
607 post("/statuses/:id/bookmark", StatusController, :bookmark)
608 post("/statuses/:id/unbookmark", StatusController, :unbookmark)
609 post("/statuses/:id/mute", StatusController, :mute_conversation)
610 post("/statuses/:id/unmute", StatusController, :unmute_conversation)
611 get("/statuses/:id/translations/:language", StatusController, :translate)
613 post("/push/subscription", SubscriptionController, :create)
614 get("/push/subscription", SubscriptionController, :show)
615 put("/push/subscription", SubscriptionController, :update)
616 delete("/push/subscription", SubscriptionController, :delete)
618 get("/suggestions", SuggestionController, :index)
619 delete("/suggestions/:account_id", SuggestionController, :dismiss)
621 get("/timelines/home", TimelineController, :home)
622 get("/timelines/direct", TimelineController, :direct)
623 get("/timelines/list/:list_id", TimelineController, :list)
625 get("/announcements", AnnouncementController, :index)
626 post("/announcements/:id/dismiss", AnnouncementController, :mark_read)
628 get("/tags/:id", TagController, :show)
629 post("/tags/:id/follow", TagController, :follow)
630 post("/tags/:id/unfollow", TagController, :unfollow)
631 get("/followed_tags", TagController, :show_followed)
634 scope "/api/web", Pleroma.Web do
635 pipe_through(:authenticated_api)
637 # Backend-obscure settings blob for MastoFE, don't parse/reuse elsewhere
638 put("/settings", MastoFEController, :put_settings)
641 scope "/api/v1", Pleroma.Web.MastodonAPI do
642 pipe_through(:app_api)
644 post("/apps", AppController, :create)
645 get("/apps/verify_credentials", AppController, :verify_credentials)
648 scope "/api/v1", Pleroma.Web.MastodonAPI do
651 get("/accounts/search", SearchController, :account_search)
652 get("/accounts/lookup", AccountController, :lookup)
654 get("/accounts/:id/statuses", AccountController, :statuses)
655 get("/accounts/:id/followers", AccountController, :followers)
656 get("/accounts/:id/following", AccountController, :following)
657 get("/accounts/:id", AccountController, :show)
659 post("/accounts", AccountController, :create)
661 get("/instance", InstanceController, :show)
662 get("/instance/peers", InstanceController, :peers)
664 get("/statuses", StatusController, :index)
665 get("/statuses/:id", StatusController, :show)
666 get("/statuses/:id/context", StatusController, :context)
667 get("/statuses/:id/favourited_by", StatusController, :favourited_by)
668 get("/statuses/:id/reblogged_by", StatusController, :reblogged_by)
669 get("/statuses/:id/history", StatusController, :show_history)
670 get("/statuses/:id/source", StatusController, :show_source)
672 get("/custom_emojis", CustomEmojiController, :index)
674 get("/trends", MastodonAPIController, :empty_array)
676 get("/timelines/public", TimelineController, :public)
677 get("/timelines/tag/:tag", TimelineController, :hashtag)
678 get("/timelines/bubble", TimelineController, :bubble)
680 get("/polls/:id", PollController, :show)
682 get("/directory", DirectoryController, :index)
685 scope "/api/v2", Pleroma.Web.MastodonAPI do
687 get("/search", SearchController, :search2)
689 post("/media", MediaController, :create2)
691 get("/suggestions", SuggestionController, :index2)
694 scope "/api", Pleroma.Web do
695 pipe_through(:config)
697 get("/pleroma/frontend_configurations", TwitterAPI.UtilController, :frontend_configurations)
700 scope "/api", Pleroma.Web do
704 "/account/confirm_email/:user_id/:token",
705 TwitterAPI.Controller,
712 pipe_through(:base_api)
714 get("/openapi", OpenApiSpex.Plug.RenderSpec, [])
717 scope "/api", Pleroma.Web, as: :authenticated_twitter_api do
718 pipe_through(:authenticated_api)
720 get("/oauth_tokens", TwitterAPI.Controller, :oauth_tokens)
721 delete("/oauth_tokens/:id", TwitterAPI.Controller, :revoke_token)
724 scope "/", Pleroma.Web do
725 # Note: html format is supported only if static FE is enabled
726 # Note: http signature is only considered for json requests (no auth for non-json requests)
727 pipe_through([:accepts_html_json, :http_signature, :static_fe])
729 get("/objects/:uuid", OStatus.OStatusController, :object)
730 get("/activities/:uuid", OStatus.OStatusController, :activity)
731 get("/notice/:id", OStatus.OStatusController, :notice)
733 # Notice compatibility routes for other frontends
734 get("/@:nickname/:id", OStatus.OStatusController, :notice)
735 get("/@:nickname/posts/:id", OStatus.OStatusController, :notice)
736 get("/:nickname/status/:id", OStatus.OStatusController, :notice)
738 # Mastodon compatibility routes
739 get("/users/:nickname/statuses/:id", OStatus.OStatusController, :object)
740 get("/users/:nickname/statuses/:id/activity", OStatus.OStatusController, :activity)
743 scope "/", Pleroma.Web do
744 # Note: html format is supported only if static FE is enabled
745 # Note: http signature is only considered for json requests (no auth for non-json requests)
746 pipe_through([:accepts_html_xml_json, :http_signature, :static_fe])
748 # Note: returns user _profile_ for json requests, redirects to user _feed_ for non-json ones
749 get("/users/:nickname", Feed.UserController, :feed_redirect, as: :user_feed)
752 scope "/", Pleroma.Web do
753 # Note: html format is supported only if static FE is enabled
754 pipe_through([:accepts_html_xml, :static_fe])
756 get("/users/:nickname/feed", Feed.UserController, :feed, as: :user_feed)
759 scope "/", Pleroma.Web.StaticFE do
760 # Profile pages for static-fe
761 get("/users/:nickname/with_replies", StaticFEController, :show)
762 get("/users/:nickname/media", StaticFEController, :show)
765 scope "/", Pleroma.Web do
766 pipe_through(:accepts_html)
767 get("/notice/:id/embed_player", OStatus.OStatusController, :notice_player)
770 scope "/", Pleroma.Web do
771 pipe_through(:accepts_xml_rss_atom)
772 get("/tags/:tag", Feed.TagController, :feed, as: :tag_feed)
775 scope "/", Pleroma.Web do
776 pipe_through(:browser)
777 get("/mailer/unsubscribe/:token", Mailer.SubscriptionController, :unsubscribe)
780 pipeline :ap_service_actor do
781 plug(:accepts, ["activity+json", "json"])
784 # Server to Server (S2S) AP interactions
785 pipeline :activitypub do
786 plug(:ap_service_actor)
787 plug(:http_signature)
790 # Client to Server (C2S) AP interactions
791 pipeline :activitypub_client do
792 plug(:ap_service_actor)
798 scope "/", Pleroma.Web.ActivityPub do
799 pipe_through([:activitypub_client])
801 get("/api/ap/whoami", ActivityPubController, :whoami)
802 get("/users/:nickname/inbox", ActivityPubController, :read_inbox)
804 get("/users/:nickname/outbox", ActivityPubController, :outbox)
805 post("/users/:nickname/outbox", ActivityPubController, :update_outbox)
806 post("/api/ap/upload_media", ActivityPubController, :upload_media)
808 get("/users/:nickname/collections/featured", ActivityPubController, :pinned)
811 scope "/", Pleroma.Web.ActivityPub do
812 # Note: html format is supported only if static FE is enabled
813 pipe_through([:accepts_html_json, :static_fe, :activitypub_client])
815 # The following two are S2S as well, see `ActivityPub.fetch_follow_information_for_user/1`:
816 get("/users/:nickname/followers", ActivityPubController, :followers)
817 get("/users/:nickname/following", ActivityPubController, :following)
820 scope "/", Pleroma.Web.ActivityPub do
821 pipe_through(:activitypub)
822 post("/inbox", ActivityPubController, :inbox)
823 post("/users/:nickname/inbox", ActivityPubController, :inbox)
826 scope "/relay", Pleroma.Web.ActivityPub do
827 pipe_through(:ap_service_actor)
829 get("/", ActivityPubController, :relay)
832 pipe_through(:http_signature)
833 post("/inbox", ActivityPubController, :inbox)
836 get("/following", ActivityPubController, :relay_following)
837 get("/followers", ActivityPubController, :relay_followers)
840 scope "/internal/fetch", Pleroma.Web.ActivityPub do
841 pipe_through(:ap_service_actor)
843 get("/", ActivityPubController, :internal_fetch)
844 post("/inbox", ActivityPubController, :inbox)
847 scope "/.well-known", Pleroma.Web do
848 pipe_through(:well_known)
850 get("/host-meta", WebFinger.WebFingerController, :host_meta)
851 get("/webfinger", WebFinger.WebFingerController, :webfinger)
852 get("/nodeinfo", Nodeinfo.NodeinfoController, :schemas)
855 scope "/nodeinfo", Pleroma.Web do
856 get("/:version", Nodeinfo.NodeinfoController, :nodeinfo)
859 scope "/", Pleroma.Web do
862 get("/manifest.json", ManifestController, :show)
863 get("/web/manifest.json", MastoFEController, :manifest)
866 scope "/", Pleroma.Web do
867 pipe_through(:mastodon_html)
869 get("/web/login", MastodonAPI.AuthController, :login)
870 delete("/auth/sign_out", MastodonAPI.AuthController, :logout)
872 post("/auth/password", MastodonAPI.AuthController, :password_reset)
874 get("/web/*path", MastoFEController, :index)
876 get("/embed/:id", EmbedController, :show)
879 scope "/proxy/", Pleroma.Web do
880 get("/preview/:sig/:url", MediaProxy.MediaProxyController, :preview)
881 get("/preview/:sig/:url/:filename", MediaProxy.MediaProxyController, :preview)
882 get("/:sig/:url", MediaProxy.MediaProxyController, :remote)
883 get("/:sig/:url/:filename", MediaProxy.MediaProxyController, :remote)
886 if Pleroma.Config.get(:env) == :dev do
888 pipe_through([:mailbox_preview])
890 forward("/mailbox", Plug.Swoosh.MailboxPreview, base_path: "/dev/mailbox")
895 pipe_through([:pleroma_html, :authenticate, :require_admin])
897 live_dashboard("/phoenix/live_dashboard",
898 metrics: {Pleroma.Web.Telemetry, :live_dashboard_metrics},
899 csp_nonce_assign_key: :csp_nonce
903 # Test-only routes needed to test action dispatching and plug chain execution
904 if Pleroma.Config.get(:env) == :test do
907 :fallback_oauth_check,
909 :fallback_oauth_skip_publicity_check,
910 :skip_oauth_skip_publicity_check,
911 :missing_oauth_check_definition
914 scope "/test/api", Pleroma.Tests do
917 for action <- @test_actions do
918 get("/#{action}", AuthTestController, action)
922 scope "/test/authenticated_api", Pleroma.Tests do
923 pipe_through(:authenticated_api)
925 for action <- @test_actions do
926 get("/#{action}", AuthTestController, action)
931 scope "/", Pleroma.Web.MongooseIM do
932 get("/user_exists", MongooseIMController, :user_exists)
933 get("/check_password", MongooseIMController, :check_password)
936 scope "/", Pleroma.Web.Fallback do
937 get("/registration/:token", RedirectController, :registration_page)
938 get("/:maybe_nickname_or_id", RedirectController, :redirector_with_meta)
939 get("/api/*path", RedirectController, :api_not_implemented)
940 get("/*path", RedirectController, :redirector_with_preload)
942 options("/*path", RedirectController, :empty)
945 # TODO: Change to Phoenix.Router.routes/1 for Phoenix 1.6.0+
946 def get_api_routes do
947 Phoenix.Router.routes(__MODULE__)
948 |> Enum.reject(fn r -> r.plug == Pleroma.Web.Fallback.RedirectController end)
951 |> String.split("/", trim: true)