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.EnsureUserTokenAssignsPlug)
61 plug(Pleroma.Web.Plugs.UserTrackingPlug)
65 plug(:accepts, ["json"])
68 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
71 pipeline :no_auth_or_privacy_expectations_api do
74 plug(Pleroma.Web.Plugs.IdempotencyPlug)
77 # Pipeline for app-related endpoints (no user auth checks — app-bound tokens must be supported)
79 plug(:no_auth_or_privacy_expectations_api)
83 plug(:expect_public_instance_or_user_authentication)
84 plug(:no_auth_or_privacy_expectations_api)
87 pipeline :authenticated_api do
88 plug(:expect_user_authentication)
89 plug(:no_auth_or_privacy_expectations_api)
90 plug(Pleroma.Web.Plugs.EnsureAuthenticatedPlug)
93 pipeline :admin_api do
94 plug(:expect_user_authentication)
96 plug(Pleroma.Web.Plugs.AdminSecretAuthenticationPlug)
98 plug(Pleroma.Web.Plugs.EnsureAuthenticatedPlug)
99 plug(Pleroma.Web.Plugs.UserIsStaffPlug)
100 plug(Pleroma.Web.Plugs.IdempotencyPlug)
103 pipeline :require_privileged_staff do
104 plug(Pleroma.Web.Plugs.EnsureStaffPrivilegedPlug)
107 pipeline :require_admin do
108 plug(Pleroma.Web.Plugs.UserIsAdminPlug)
111 pipeline :mastodon_html do
117 pipeline :pleroma_html do
120 plug(Pleroma.Web.Plugs.EnsureUserTokenAssignsPlug)
123 pipeline :well_known do
124 plug(:accepts, ["json", "jrd+json", "xml", "xrd+xml"])
128 plug(:accepts, ["json", "xml"])
129 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
132 pipeline :pleroma_api do
133 plug(:accepts, ["html", "json"])
134 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
137 pipeline :mailbox_preview do
138 plug(:accepts, ["html"])
140 plug(:put_secure_browser_headers, %{
141 "content-security-policy" =>
142 "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' 'unsafe-eval'"
146 pipeline :http_signature do
147 plug(Pleroma.Web.Plugs.HTTPSignaturePlug)
148 plug(Pleroma.Web.Plugs.MappedSignatureToIdentityPlug)
151 pipeline :static_fe do
152 plug(Pleroma.Web.Plugs.StaticFEPlug)
155 scope "/api/v1/pleroma", Pleroma.Web.TwitterAPI do
156 pipe_through(:pleroma_api)
158 get("/password_reset/:token", PasswordController, :reset, as: :reset_password)
159 post("/password_reset", PasswordController, :do_reset, as: :reset_password)
160 get("/emoji", UtilController, :emoji)
161 get("/captcha", UtilController, :captcha)
162 get("/healthcheck", UtilController, :healthcheck)
163 post("/remote_interaction", UtilController, :remote_interaction)
166 scope "/api/v1/pleroma", Pleroma.Web do
167 pipe_through(:pleroma_api)
168 post("/uploader_callback/:upload_path", UploaderController, :callback)
171 # AdminAPI: only admins can perform these actions
172 scope "/api/v1/pleroma/admin", Pleroma.Web.AdminAPI do
173 pipe_through([:admin_api, :require_admin])
175 put("/users/disable_mfa", AdminAPIController, :disable_mfa)
177 get("/users/:nickname/permission_group", AdminAPIController, :right_get)
178 get("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_get)
180 post("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_add)
183 "/users/:nickname/permission_group/:permission_group",
188 post("/users/permission_group/:permission_group", AdminAPIController, :right_add_multiple)
191 "/users/permission_group/:permission_group",
193 :right_delete_multiple
196 post("/users/follow", UserController, :follow)
197 post("/users/unfollow", UserController, :unfollow)
198 post("/users", UserController, :create)
200 patch("/users/suggest", UserController, :suggest)
201 patch("/users/unsuggest", UserController, :unsuggest)
203 get("/relay", RelayController, :index)
204 post("/relay", RelayController, :follow)
205 delete("/relay", RelayController, :unfollow)
207 patch("/users/force_password_reset", AdminAPIController, :force_password_reset)
208 get("/users/:nickname/credentials", AdminAPIController, :show_user_credentials)
209 patch("/users/:nickname/credentials", AdminAPIController, :update_user_credentials)
211 get("/instance_document/:name", InstanceDocumentController, :show)
212 patch("/instance_document/:name", InstanceDocumentController, :update)
213 delete("/instance_document/:name", InstanceDocumentController, :delete)
215 patch("/users/confirm_email", AdminAPIController, :confirm_email)
216 patch("/users/resend_confirmation_email", AdminAPIController, :resend_confirmation_email)
218 get("/config", ConfigController, :show)
219 post("/config", ConfigController, :update)
220 get("/config/descriptions", ConfigController, :descriptions)
221 get("/need_reboot", AdminAPIController, :need_reboot)
222 get("/restart", AdminAPIController, :restart)
224 get("/oauth_app", OAuthAppController, :index)
225 post("/oauth_app", OAuthAppController, :create)
226 patch("/oauth_app/:id", OAuthAppController, :update)
227 delete("/oauth_app/:id", OAuthAppController, :delete)
229 get("/media_proxy_caches", MediaProxyCacheController, :index)
230 post("/media_proxy_caches/delete", MediaProxyCacheController, :delete)
231 post("/media_proxy_caches/purge", MediaProxyCacheController, :purge)
233 get("/frontends", FrontendController, :index)
234 post("/frontends/install", FrontendController, :install)
236 post("/backups", AdminAPIController, :create_backup)
238 get("/announcements", AnnouncementController, :index)
239 post("/announcements", AnnouncementController, :create)
240 get("/announcements/:id", AnnouncementController, :show)
241 patch("/announcements/:id", AnnouncementController, :change)
242 delete("/announcements/:id", AnnouncementController, :delete)
245 # AdminAPI: admins and mods (staff) can perform these actions (if enabled by config)
246 scope "/api/v1/pleroma/admin", Pleroma.Web.AdminAPI do
247 pipe_through([:admin_api, :require_privileged_staff])
249 delete("/users", UserController, :delete)
251 get("/users/:nickname/password_reset", AdminAPIController, :get_password_reset)
252 patch("/users/:nickname/credentials", AdminAPIController, :update_user_credentials)
254 get("/users/:nickname/statuses", AdminAPIController, :list_user_statuses)
256 get("/statuses", StatusController, :index)
259 # AdminAPI: admins and mods (staff) can perform these actions
260 scope "/api/v1/pleroma/admin", Pleroma.Web.AdminAPI do
261 pipe_through(:admin_api)
263 put("/users/tag", AdminAPIController, :tag_users)
264 delete("/users/tag", AdminAPIController, :untag_users)
266 patch("/users/:nickname/toggle_activation", UserController, :toggle_activation)
267 patch("/users/activate", UserController, :activate)
268 patch("/users/deactivate", UserController, :deactivate)
269 patch("/users/approve", UserController, :approve)
271 post("/users/invite_token", InviteController, :create)
272 get("/users/invites", InviteController, :index)
273 post("/users/revoke_invite", InviteController, :revoke)
274 post("/users/email_invite", InviteController, :email)
276 get("/users", UserController, :index)
277 get("/users/:nickname", UserController, :show)
279 get("/instances/:instance/statuses", InstanceController, :list_statuses)
280 delete("/instances/:instance", InstanceController, :delete)
282 get("/reports", ReportController, :index)
283 get("/reports/:id", ReportController, :show)
284 patch("/reports", ReportController, :update)
285 post("/reports/:id/notes", ReportController, :notes_create)
286 delete("/reports/:report_id/notes/:id", ReportController, :notes_delete)
288 get("/statuses/:id", StatusController, :show)
289 put("/statuses/:id", StatusController, :update)
290 delete("/statuses/:id", StatusController, :delete)
292 get("/moderation_log", AdminAPIController, :list_log)
294 post("/reload_emoji", AdminAPIController, :reload_emoji)
295 get("/stats", AdminAPIController, :stats)
298 scope "/api/v1/pleroma/emoji", Pleroma.Web.PleromaAPI do
300 pipe_through(:admin_api)
302 post("/", EmojiPackController, :create)
303 patch("/", EmojiPackController, :update)
304 delete("/", EmojiPackController, :delete)
310 get("/", EmojiPackController, :show)
315 pipe_through(:admin_api)
317 get("/import", EmojiPackController, :import_from_filesystem)
318 get("/remote", EmojiPackController, :remote)
319 post("/download", EmojiPackController, :download)
321 post("/files", EmojiFileController, :create)
322 patch("/files", EmojiFileController, :update)
323 delete("/files", EmojiFileController, :delete)
326 # Pack info / downloading
330 get("/", EmojiPackController, :index)
331 get("/archive", EmojiPackController, :archive)
335 scope "/", Pleroma.Web.TwitterAPI do
336 pipe_through(:pleroma_html)
338 post("/main/ostatus", UtilController, :remote_subscribe)
339 get("/ostatus_subscribe", RemoteFollowController, :follow)
340 post("/ostatus_subscribe", RemoteFollowController, :do_follow)
343 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
344 pipe_through(:authenticated_api)
346 post("/change_email", UtilController, :change_email)
347 post("/change_password", UtilController, :change_password)
348 post("/delete_account", UtilController, :delete_account)
349 put("/notification_settings", UtilController, :update_notificaton_settings)
350 post("/disable_account", UtilController, :disable_account)
351 post("/move_account", UtilController, :move_account)
353 put("/aliases", UtilController, :add_alias)
354 get("/aliases", UtilController, :list_aliases)
355 delete("/aliases", UtilController, :delete_alias)
358 scope "/api/pleroma", Pleroma.Web.PleromaAPI do
359 pipe_through(:authenticated_api)
361 post("/mutes_import", UserImportController, :mutes)
362 post("/blocks_import", UserImportController, :blocks)
363 post("/follow_import", UserImportController, :follow)
365 get("/accounts/mfa", TwoFactorAuthenticationController, :settings)
366 get("/accounts/mfa/backup_codes", TwoFactorAuthenticationController, :backup_codes)
367 get("/accounts/mfa/setup/:method", TwoFactorAuthenticationController, :setup)
368 post("/accounts/mfa/confirm/:method", TwoFactorAuthenticationController, :confirm)
369 delete("/accounts/mfa/:method", TwoFactorAuthenticationController, :disable)
372 scope "/oauth", Pleroma.Web.OAuth do
373 # Note: use /api/v1/accounts/verify_credentials for userinfo of signed-in user
375 get("/registration_details", OAuthController, :registration_details)
377 post("/mfa/verify", MFAController, :verify, as: :mfa_verify)
378 get("/mfa", MFAController, :show)
383 get("/authorize", OAuthController, :authorize)
384 post("/authorize", OAuthController, :create_authorization)
388 pipe_through(:fetch_session)
390 post("/token", OAuthController, :token_exchange)
391 post("/revoke", OAuthController, :token_revoke)
392 post("/mfa/challenge", MFAController, :challenge)
396 pipe_through(:browser)
398 get("/prepare_request", OAuthController, :prepare_request)
399 get("/:provider", OAuthController, :request)
400 get("/:provider/callback", OAuthController, :callback)
401 post("/register", OAuthController, :register)
405 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
408 get("/apps", AppController, :index)
409 get("/statuses/:id/reactions/:emoji", EmojiReactionController, :index)
410 get("/statuses/:id/reactions", EmojiReactionController, :index)
413 scope "/api/v0/pleroma", Pleroma.Web.PleromaAPI do
414 pipe_through(:authenticated_api)
415 get("/reports", ReportController, :index)
416 get("/reports/:id", ReportController, :show)
419 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
421 pipe_through(:authenticated_api)
423 get("/conversations/:id/statuses", ConversationController, :statuses)
424 get("/conversations/:id", ConversationController, :show)
425 post("/conversations/read", ConversationController, :mark_as_read)
426 patch("/conversations/:id", ConversationController, :update)
428 put("/statuses/:id/reactions/:emoji", EmojiReactionController, :create)
429 delete("/statuses/:id/reactions/:emoji", EmojiReactionController, :delete)
430 post("/notifications/read", NotificationController, :mark_as_read)
432 get("/mascot", MascotController, :show)
433 put("/mascot", MascotController, :update)
435 get("/backups", BackupController, :index)
436 post("/backups", BackupController, :create)
441 get("/accounts/:id/favourites", AccountController, :favourites)
445 pipe_through(:authenticated_api)
447 post("/accounts/:id/subscribe", AccountController, :subscribe)
448 post("/accounts/:id/unsubscribe", AccountController, :unsubscribe)
451 post("/accounts/confirmation_resend", AccountController, :confirmation_resend)
454 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
456 get("/federation_status", InstancesController, :show)
459 scope "/api/v1", Pleroma.Web.PleromaAPI do
460 pipe_through(:authenticated_api)
461 put("/statuses/:id/emoji_reactions/:emoji", EmojiReactionController, :create)
464 scope "/api/v1", Pleroma.Web.MastodonAPI do
465 pipe_through(:authenticated_api)
467 get("/accounts/verify_credentials", AccountController, :verify_credentials)
468 patch("/accounts/update_credentials", AccountController, :update_credentials)
470 get("/accounts/relationships", AccountController, :relationships)
471 get("/accounts/:id/lists", AccountController, :lists)
472 get("/accounts/:id/identity_proofs", AccountController, :identity_proofs)
473 get("/endorsements", AccountController, :endorsements)
474 get("/blocks", AccountController, :blocks)
475 get("/mutes", AccountController, :mutes)
477 post("/follows", AccountController, :follow_by_uri)
478 post("/accounts/:id/follow", AccountController, :follow)
479 post("/accounts/:id/unfollow", AccountController, :unfollow)
480 post("/accounts/:id/block", AccountController, :block)
481 post("/accounts/:id/unblock", AccountController, :unblock)
482 post("/accounts/:id/mute", AccountController, :mute)
483 post("/accounts/:id/unmute", AccountController, :unmute)
484 post("/accounts/:id/note", AccountController, :note)
486 get("/conversations", ConversationController, :index)
487 post("/conversations/:id/read", ConversationController, :mark_as_read)
488 delete("/conversations/:id", ConversationController, :delete)
490 get("/domain_blocks", DomainBlockController, :index)
491 post("/domain_blocks", DomainBlockController, :create)
492 delete("/domain_blocks", DomainBlockController, :delete)
494 get("/filters", FilterController, :index)
496 post("/filters", FilterController, :create)
497 get("/filters/:id", FilterController, :show)
498 put("/filters/:id", FilterController, :update)
499 delete("/filters/:id", FilterController, :delete)
501 get("/follow_requests", FollowRequestController, :index)
502 post("/follow_requests/:id/authorize", FollowRequestController, :authorize)
503 post("/follow_requests/:id/reject", FollowRequestController, :reject)
505 get("/lists", ListController, :index)
506 get("/lists/:id", ListController, :show)
507 get("/lists/:id/accounts", ListController, :list_accounts)
509 delete("/lists/:id", ListController, :delete)
510 post("/lists", ListController, :create)
511 put("/lists/:id", ListController, :update)
512 post("/lists/:id/accounts", ListController, :add_to_list)
513 delete("/lists/:id/accounts", ListController, :remove_from_list)
515 get("/markers", MarkerController, :index)
516 post("/markers", MarkerController, :upsert)
518 post("/media", MediaController, :create)
519 get("/media/:id", MediaController, :show)
520 put("/media/:id", MediaController, :update)
522 get("/notifications", NotificationController, :index)
523 get("/notifications/:id", NotificationController, :show)
525 post("/notifications/:id/dismiss", NotificationController, :dismiss)
526 post("/notifications/clear", NotificationController, :clear)
527 delete("/notifications/destroy_multiple", NotificationController, :destroy_multiple)
529 post("/polls/:id/votes", PollController, :vote)
531 post("/reports", ReportController, :create)
533 get("/scheduled_statuses", ScheduledActivityController, :index)
534 get("/scheduled_statuses/:id", ScheduledActivityController, :show)
536 put("/scheduled_statuses/:id", ScheduledActivityController, :update)
537 delete("/scheduled_statuses/:id", ScheduledActivityController, :delete)
539 # Unlike `GET /api/v1/accounts/:id/favourites`, demands authentication
540 get("/favourites", StatusController, :favourites)
541 get("/bookmarks", StatusController, :bookmarks)
543 post("/statuses", StatusController, :create)
544 delete("/statuses/:id", StatusController, :delete)
545 post("/statuses/:id/reblog", StatusController, :reblog)
546 post("/statuses/:id/unreblog", StatusController, :unreblog)
547 post("/statuses/:id/favourite", StatusController, :favourite)
548 post("/statuses/:id/unfavourite", StatusController, :unfavourite)
549 post("/statuses/:id/pin", StatusController, :pin)
550 post("/statuses/:id/unpin", StatusController, :unpin)
551 post("/statuses/:id/bookmark", StatusController, :bookmark)
552 post("/statuses/:id/unbookmark", StatusController, :unbookmark)
553 post("/statuses/:id/mute", StatusController, :mute_conversation)
554 post("/statuses/:id/unmute", StatusController, :unmute_conversation)
556 post("/push/subscription", SubscriptionController, :create)
557 get("/push/subscription", SubscriptionController, :show)
558 put("/push/subscription", SubscriptionController, :update)
559 delete("/push/subscription", SubscriptionController, :delete)
561 get("/suggestions", SuggestionController, :index)
562 delete("/suggestions/:account_id", SuggestionController, :dismiss)
564 get("/timelines/home", TimelineController, :home)
565 get("/timelines/direct", TimelineController, :direct)
566 get("/timelines/list/:list_id", TimelineController, :list)
567 get("/timelines/bubble", TimelineController, :bubble)
569 get("/announcements", AnnouncementController, :index)
570 post("/announcements/:id/dismiss", AnnouncementController, :mark_read)
573 scope "/api/web", Pleroma.Web do
574 pipe_through(:authenticated_api)
576 # Backend-obscure settings blob for MastoFE, don't parse/reuse elsewhere
577 put("/settings", MastoFEController, :put_settings)
580 scope "/api/v1", Pleroma.Web.MastodonAPI do
581 pipe_through(:app_api)
583 post("/apps", AppController, :create)
584 get("/apps/verify_credentials", AppController, :verify_credentials)
587 scope "/api/v1", Pleroma.Web.MastodonAPI do
590 get("/accounts/search", SearchController, :account_search)
591 get("/accounts/lookup", AccountController, :lookup)
593 get("/accounts/:id/statuses", AccountController, :statuses)
594 get("/accounts/:id/followers", AccountController, :followers)
595 get("/accounts/:id/following", AccountController, :following)
596 get("/accounts/:id", AccountController, :show)
598 post("/accounts", AccountController, :create)
600 get("/instance", InstanceController, :show)
601 get("/instance/peers", InstanceController, :peers)
603 get("/statuses", StatusController, :index)
604 get("/statuses/:id", StatusController, :show)
605 get("/statuses/:id/context", StatusController, :context)
606 get("/statuses/:id/favourited_by", StatusController, :favourited_by)
607 get("/statuses/:id/reblogged_by", StatusController, :reblogged_by)
609 get("/custom_emojis", CustomEmojiController, :index)
611 get("/trends", MastodonAPIController, :empty_array)
613 get("/timelines/public", TimelineController, :public)
614 get("/timelines/tag/:tag", TimelineController, :hashtag)
616 get("/polls/:id", PollController, :show)
618 get("/directory", DirectoryController, :index)
621 scope "/api/v2", Pleroma.Web.MastodonAPI do
623 get("/search", SearchController, :search2)
625 post("/media", MediaController, :create2)
627 get("/suggestions", SuggestionController, :index2)
630 scope "/api", Pleroma.Web do
631 pipe_through(:config)
633 get("/pleroma/frontend_configurations", TwitterAPI.UtilController, :frontend_configurations)
636 scope "/api", Pleroma.Web do
640 "/account/confirm_email/:user_id/:token",
641 TwitterAPI.Controller,
648 pipe_through(:base_api)
650 get("/openapi", OpenApiSpex.Plug.RenderSpec, [])
653 scope "/api", Pleroma.Web, as: :authenticated_twitter_api do
654 pipe_through(:authenticated_api)
656 get("/oauth_tokens", TwitterAPI.Controller, :oauth_tokens)
657 delete("/oauth_tokens/:id", TwitterAPI.Controller, :revoke_token)
660 scope "/", Pleroma.Web do
661 # Note: html format is supported only if static FE is enabled
662 # Note: http signature is only considered for json requests (no auth for non-json requests)
663 pipe_through([:accepts_html_json, :http_signature, :static_fe])
665 get("/objects/:uuid", OStatus.OStatusController, :object)
666 get("/activities/:uuid", OStatus.OStatusController, :activity)
667 get("/notice/:id", OStatus.OStatusController, :notice)
669 # Notice compatibility routes for other frontends
670 get("/@:nickname/:id", OStatus.OStatusController, :notice)
671 get("/@:nickname/posts/:id", OStatus.OStatusController, :notice)
672 get("/:nickname/status/:id", OStatus.OStatusController, :notice)
674 # Mastodon compatibility routes
675 get("/users/:nickname/statuses/:id", OStatus.OStatusController, :object)
676 get("/users/:nickname/statuses/:id/activity", OStatus.OStatusController, :activity)
679 scope "/", Pleroma.Web do
680 # Note: html format is supported only if static FE is enabled
681 # Note: http signature is only considered for json requests (no auth for non-json requests)
682 pipe_through([:accepts_html_xml_json, :http_signature, :static_fe])
684 # Note: returns user _profile_ for json requests, redirects to user _feed_ for non-json ones
685 get("/users/:nickname", Feed.UserController, :feed_redirect, as: :user_feed)
688 scope "/", Pleroma.Web do
689 # Note: html format is supported only if static FE is enabled
690 pipe_through([:accepts_html_xml, :static_fe])
692 get("/users/:nickname/feed", Feed.UserController, :feed, as: :user_feed)
695 scope "/", Pleroma.Web do
696 pipe_through(:accepts_html)
697 get("/notice/:id/embed_player", OStatus.OStatusController, :notice_player)
700 scope "/", Pleroma.Web do
701 pipe_through(:accepts_xml_rss_atom)
702 get("/tags/:tag", Feed.TagController, :feed, as: :tag_feed)
705 scope "/", Pleroma.Web do
706 pipe_through(:browser)
707 get("/mailer/unsubscribe/:token", Mailer.SubscriptionController, :unsubscribe)
710 pipeline :ap_service_actor do
711 plug(:accepts, ["activity+json", "json"])
714 # Server to Server (S2S) AP interactions
715 pipeline :activitypub do
716 plug(:ap_service_actor)
717 plug(:http_signature)
720 # Client to Server (C2S) AP interactions
721 pipeline :activitypub_client do
722 plug(:ap_service_actor)
728 scope "/", Pleroma.Web.ActivityPub do
729 pipe_through([:activitypub_client])
731 get("/api/ap/whoami", ActivityPubController, :whoami)
732 get("/users/:nickname/inbox", ActivityPubController, :read_inbox)
734 get("/users/:nickname/outbox", ActivityPubController, :outbox)
735 post("/users/:nickname/outbox", ActivityPubController, :update_outbox)
736 post("/api/ap/upload_media", ActivityPubController, :upload_media)
738 # The following two are S2S as well, see `ActivityPub.fetch_follow_information_for_user/1`:
739 get("/users/:nickname/followers", ActivityPubController, :followers)
740 get("/users/:nickname/following", ActivityPubController, :following)
741 get("/users/:nickname/collections/featured", ActivityPubController, :pinned)
744 scope "/", Pleroma.Web.ActivityPub do
745 pipe_through(:activitypub)
746 post("/inbox", ActivityPubController, :inbox)
747 post("/users/:nickname/inbox", ActivityPubController, :inbox)
750 scope "/relay", Pleroma.Web.ActivityPub do
751 pipe_through(:ap_service_actor)
753 get("/", ActivityPubController, :relay)
756 pipe_through(:http_signature)
757 post("/inbox", ActivityPubController, :inbox)
760 get("/following", ActivityPubController, :relay_following)
761 get("/followers", ActivityPubController, :relay_followers)
764 scope "/internal/fetch", Pleroma.Web.ActivityPub do
765 pipe_through(:ap_service_actor)
767 get("/", ActivityPubController, :internal_fetch)
768 post("/inbox", ActivityPubController, :inbox)
771 scope "/.well-known", Pleroma.Web do
772 pipe_through(:well_known)
774 get("/host-meta", WebFinger.WebFingerController, :host_meta)
775 get("/webfinger", WebFinger.WebFingerController, :webfinger)
776 get("/nodeinfo", Nodeinfo.NodeinfoController, :schemas)
779 scope "/nodeinfo", Pleroma.Web do
780 get("/:version", Nodeinfo.NodeinfoController, :nodeinfo)
783 scope "/", Pleroma.Web do
786 get("/manifest.json", ManifestController, :show)
787 get("/web/manifest.json", MastoFEController, :manifest)
790 scope "/", Pleroma.Web do
791 pipe_through(:mastodon_html)
793 get("/web/login", MastodonAPI.AuthController, :login)
794 delete("/auth/sign_out", MastodonAPI.AuthController, :logout)
795 get("/web/*path", MastoFEController, :index)
796 post("/auth/password", MastodonAPI.AuthController, :password_reset)
798 get("/embed/:id", EmbedController, :show)
801 scope "/proxy/", Pleroma.Web do
802 get("/preview/:sig/:url", MediaProxy.MediaProxyController, :preview)
803 get("/preview/:sig/:url/:filename", MediaProxy.MediaProxyController, :preview)
804 get("/:sig/:url", MediaProxy.MediaProxyController, :remote)
805 get("/:sig/:url/:filename", MediaProxy.MediaProxyController, :remote)
808 if Pleroma.Config.get(:env) == :dev do
810 pipe_through([:mailbox_preview])
812 forward("/mailbox", Plug.Swoosh.MailboxPreview, base_path: "/dev/mailbox")
817 pipe_through([:pleroma_html, :authenticate, :require_admin])
818 live_dashboard("/phoenix/live_dashboard")
821 # Test-only routes needed to test action dispatching and plug chain execution
822 if Pleroma.Config.get(:env) == :test do
825 :fallback_oauth_check,
827 :fallback_oauth_skip_publicity_check,
828 :skip_oauth_skip_publicity_check,
829 :missing_oauth_check_definition
832 scope "/test/api", Pleroma.Tests do
835 for action <- @test_actions do
836 get("/#{action}", AuthTestController, action)
840 scope "/test/authenticated_api", Pleroma.Tests do
841 pipe_through(:authenticated_api)
843 for action <- @test_actions do
844 get("/#{action}", AuthTestController, action)
849 scope "/", Pleroma.Web.MongooseIM do
850 get("/user_exists", MongooseIMController, :user_exists)
851 get("/check_password", MongooseIMController, :check_password)
854 scope "/", Pleroma.Web.Fallback do
855 get("/registration/:token", RedirectController, :registration_page)
856 get("/:maybe_nickname_or_id", RedirectController, :redirector_with_meta)
857 match(:*, "/api/pleroma*path", LegacyPleromaApiRerouterPlug, [])
858 get("/api*path", RedirectController, :api_not_implemented)
859 get("/*path", RedirectController, :redirector_with_preload)
861 options("/*path", RedirectController, :empty)
864 # TODO: Change to Phoenix.Router.routes/1 for Phoenix 1.6.0+
865 def get_api_routes do
866 __MODULE__.__routes__()
867 |> Enum.reject(fn r -> r.plug == Pleroma.Web.Fallback.RedirectController end)
870 |> String.split("/", trim: true)