1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.Router do
6 use Pleroma.Web, :router
9 plug(:accepts, ["html"])
15 plug(Pleroma.Plugs.OAuthPlug)
16 plug(Pleroma.Plugs.UserEnabledPlug)
19 pipeline :expect_authentication do
20 plug(Pleroma.Plugs.ExpectAuthenticatedCheckPlug)
23 pipeline :expect_public_instance_or_authentication do
24 plug(Pleroma.Plugs.ExpectPublicOrAuthenticatedCheckPlug)
27 pipeline :authenticate do
28 plug(Pleroma.Plugs.OAuthPlug)
29 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
30 plug(Pleroma.Plugs.UserFetcherPlug)
31 plug(Pleroma.Plugs.SessionAuthenticationPlug)
32 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
33 plug(Pleroma.Plugs.AuthenticationPlug)
36 pipeline :after_auth do
37 plug(Pleroma.Plugs.UserEnabledPlug)
38 plug(Pleroma.Plugs.SetUserSessionIdPlug)
39 plug(Pleroma.Plugs.EnsureUserKeyPlug)
43 plug(:accepts, ["json"])
46 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
50 plug(:expect_public_instance_or_authentication)
53 plug(Pleroma.Plugs.IdempotencyPlug)
56 pipeline :authenticated_api do
57 plug(:expect_authentication)
60 plug(Pleroma.Plugs.EnsureAuthenticatedPlug)
61 plug(Pleroma.Plugs.IdempotencyPlug)
64 pipeline :admin_api do
65 plug(:expect_authentication)
67 plug(Pleroma.Plugs.AdminSecretAuthenticationPlug)
69 plug(Pleroma.Plugs.EnsureAuthenticatedPlug)
70 plug(Pleroma.Plugs.UserIsAdminPlug)
71 plug(Pleroma.Plugs.IdempotencyPlug)
74 pipeline :mastodon_html do
80 pipeline :pleroma_html do
83 plug(Pleroma.Plugs.EnsureUserKeyPlug)
86 pipeline :well_known do
87 plug(:accepts, ["json", "jrd+json", "xml", "xrd+xml"])
91 plug(:accepts, ["json", "xml"])
92 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
95 pipeline :pleroma_api do
96 plug(:accepts, ["html", "json"])
97 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
100 pipeline :mailbox_preview do
101 plug(:accepts, ["html"])
103 plug(:put_secure_browser_headers, %{
104 "content-security-policy" =>
105 "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' 'unsafe-eval'"
109 pipeline :http_signature do
110 plug(Pleroma.Web.Plugs.HTTPSignaturePlug)
111 plug(Pleroma.Web.Plugs.MappedSignatureToIdentityPlug)
114 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
115 pipe_through(:pleroma_api)
117 get("/password_reset/:token", PasswordController, :reset, as: :reset_password)
118 post("/password_reset", PasswordController, :do_reset, as: :reset_password)
119 get("/emoji", UtilController, :emoji)
120 get("/captcha", UtilController, :captcha)
121 get("/healthcheck", UtilController, :healthcheck)
124 scope "/api/pleroma", Pleroma.Web do
125 pipe_through(:pleroma_api)
126 post("/uploader_callback/:upload_path", UploaderController, :callback)
129 scope "/api/pleroma/admin", Pleroma.Web.AdminAPI do
130 pipe_through(:admin_api)
132 post("/users/follow", AdminAPIController, :user_follow)
133 post("/users/unfollow", AdminAPIController, :user_unfollow)
135 delete("/users", AdminAPIController, :user_delete)
136 post("/users", AdminAPIController, :users_create)
137 patch("/users/:nickname/toggle_activation", AdminAPIController, :user_toggle_activation)
138 patch("/users/activate", AdminAPIController, :user_activate)
139 patch("/users/deactivate", AdminAPIController, :user_deactivate)
140 put("/users/tag", AdminAPIController, :tag_users)
141 delete("/users/tag", AdminAPIController, :untag_users)
143 get("/users/:nickname/permission_group", AdminAPIController, :right_get)
144 get("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_get)
146 post("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_add)
149 "/users/:nickname/permission_group/:permission_group",
154 post("/users/permission_group/:permission_group", AdminAPIController, :right_add_multiple)
157 "/users/permission_group/:permission_group",
159 :right_delete_multiple
162 get("/relay", AdminAPIController, :relay_list)
163 post("/relay", AdminAPIController, :relay_follow)
164 delete("/relay", AdminAPIController, :relay_unfollow)
166 post("/users/invite_token", AdminAPIController, :create_invite_token)
167 get("/users/invites", AdminAPIController, :invites)
168 post("/users/revoke_invite", AdminAPIController, :revoke_invite)
169 post("/users/email_invite", AdminAPIController, :email_invite)
171 get("/users/:nickname/password_reset", AdminAPIController, :get_password_reset)
172 patch("/users/force_password_reset", AdminAPIController, :force_password_reset)
173 get("/users/:nickname/credentials", AdminAPIController, :show_user_credentials)
174 patch("/users/:nickname/credentials", AdminAPIController, :update_user_credentials)
176 get("/users", AdminAPIController, :list_users)
177 get("/users/:nickname", AdminAPIController, :user_show)
178 get("/users/:nickname/statuses", AdminAPIController, :list_user_statuses)
180 get("/instances/:instance/statuses", AdminAPIController, :list_instance_statuses)
182 patch("/users/confirm_email", AdminAPIController, :confirm_email)
183 patch("/users/resend_confirmation_email", AdminAPIController, :resend_confirmation_email)
185 get("/reports", AdminAPIController, :list_reports)
186 get("/reports/:id", AdminAPIController, :report_show)
187 patch("/reports", AdminAPIController, :reports_update)
188 post("/reports/:id/notes", AdminAPIController, :report_notes_create)
189 delete("/reports/:report_id/notes/:id", AdminAPIController, :report_notes_delete)
191 put("/statuses/:id", AdminAPIController, :status_update)
192 delete("/statuses/:id", AdminAPIController, :status_delete)
193 get("/statuses", AdminAPIController, :list_statuses)
195 get("/config", AdminAPIController, :config_show)
196 post("/config", AdminAPIController, :config_update)
197 get("/config/descriptions", AdminAPIController, :config_descriptions)
198 get("/need_reboot", AdminAPIController, :need_reboot)
199 get("/restart", AdminAPIController, :restart)
201 get("/moderation_log", AdminAPIController, :list_log)
203 post("/reload_emoji", AdminAPIController, :reload_emoji)
204 get("/stats", AdminAPIController, :stats)
206 get("/oauth_app", AdminAPIController, :oauth_app_list)
207 post("/oauth_app", AdminAPIController, :oauth_app_create)
208 patch("/oauth_app/:id", AdminAPIController, :oauth_app_update)
209 delete("/oauth_app/:id", AdminAPIController, :oauth_app_delete)
212 scope "/api/pleroma/emoji", Pleroma.Web.PleromaAPI do
215 pipe_through(:admin_api)
217 get("/import", EmojiAPIController, :import_from_filesystem)
218 get("/remote", EmojiAPIController, :remote)
219 post("/download", EmojiAPIController, :download)
221 post("/:name", EmojiAPIController, :create)
222 patch("/:name", EmojiAPIController, :update)
223 delete("/:name", EmojiAPIController, :delete)
225 post("/:name/files", EmojiAPIController, :add_file)
226 patch("/:name/files", EmojiAPIController, :update_file)
227 delete("/:name/files", EmojiAPIController, :delete_file)
230 # Pack info / downloading
232 get("/", EmojiAPIController, :list)
233 get("/:name", EmojiAPIController, :show)
234 get("/:name/archive", EmojiAPIController, :archive)
238 scope "/", Pleroma.Web.TwitterAPI do
239 pipe_through(:pleroma_html)
241 post("/main/ostatus", UtilController, :remote_subscribe)
242 get("/ostatus_subscribe", RemoteFollowController, :follow)
244 post("/ostatus_subscribe", RemoteFollowController, :do_follow)
247 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
248 pipe_through(:authenticated_api)
250 post("/change_email", UtilController, :change_email)
251 post("/change_password", UtilController, :change_password)
252 post("/delete_account", UtilController, :delete_account)
253 put("/notification_settings", UtilController, :update_notificaton_settings)
254 post("/disable_account", UtilController, :disable_account)
256 post("/blocks_import", UtilController, :blocks_import)
257 post("/follow_import", UtilController, :follow_import)
260 scope "/oauth", Pleroma.Web.OAuth do
263 get("/authorize", OAuthController, :authorize)
266 post("/authorize", OAuthController, :create_authorization)
267 post("/token", OAuthController, :token_exchange)
268 post("/revoke", OAuthController, :token_revoke)
269 get("/registration_details", OAuthController, :registration_details)
272 pipe_through(:browser)
274 get("/prepare_request", OAuthController, :prepare_request)
275 get("/:provider", OAuthController, :request)
276 get("/:provider/callback", OAuthController, :callback)
277 post("/register", OAuthController, :register)
281 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
284 get("/statuses/:id/reactions/:emoji", PleromaAPIController, :emoji_reactions_by)
285 get("/statuses/:id/reactions", PleromaAPIController, :emoji_reactions_by)
288 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
290 pipe_through(:authenticated_api)
292 get("/conversations/:id/statuses", PleromaAPIController, :conversation_statuses)
293 get("/conversations/:id", PleromaAPIController, :conversation)
294 post("/conversations/read", PleromaAPIController, :mark_conversations_as_read)
298 pipe_through(:authenticated_api)
300 patch("/conversations/:id", PleromaAPIController, :update_conversation)
301 put("/statuses/:id/reactions/:emoji", PleromaAPIController, :react_with_emoji)
302 delete("/statuses/:id/reactions/:emoji", PleromaAPIController, :unreact_with_emoji)
303 post("/notifications/read", PleromaAPIController, :mark_notifications_as_read)
305 patch("/accounts/update_avatar", AccountController, :update_avatar)
306 patch("/accounts/update_banner", AccountController, :update_banner)
307 patch("/accounts/update_background", AccountController, :update_background)
309 get("/mascot", MascotController, :show)
310 put("/mascot", MascotController, :update)
312 post("/scrobble", ScrobbleController, :new_scrobble)
317 get("/accounts/:id/favourites", AccountController, :favourites)
321 pipe_through(:authenticated_api)
323 post("/accounts/:id/subscribe", AccountController, :subscribe)
324 post("/accounts/:id/unsubscribe", AccountController, :unsubscribe)
327 post("/accounts/confirmation_resend", AccountController, :confirmation_resend)
330 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
332 get("/accounts/:id/scrobbles", ScrobbleController, :user_scrobbles)
335 scope "/api/v1", Pleroma.Web.MastodonAPI do
336 pipe_through(:authenticated_api)
338 get("/accounts/verify_credentials", AccountController, :verify_credentials)
339 patch("/accounts/update_credentials", AccountController, :update_credentials)
341 get("/accounts/relationships", AccountController, :relationships)
342 get("/accounts/:id/lists", AccountController, :lists)
343 get("/accounts/:id/identity_proofs", AccountController, :identity_proofs)
344 get("/endorsements", AccountController, :endorsements)
345 get("/blocks", AccountController, :blocks)
346 get("/mutes", AccountController, :mutes)
348 post("/follows", AccountController, :follow_by_uri)
349 post("/accounts/:id/follow", AccountController, :follow)
350 post("/accounts/:id/unfollow", AccountController, :unfollow)
351 post("/accounts/:id/block", AccountController, :block)
352 post("/accounts/:id/unblock", AccountController, :unblock)
353 post("/accounts/:id/mute", AccountController, :mute)
354 post("/accounts/:id/unmute", AccountController, :unmute)
356 get("/apps/verify_credentials", AppController, :verify_credentials)
358 get("/conversations", ConversationController, :index)
359 post("/conversations/:id/read", ConversationController, :mark_as_read)
361 get("/domain_blocks", DomainBlockController, :index)
362 post("/domain_blocks", DomainBlockController, :create)
363 delete("/domain_blocks", DomainBlockController, :delete)
365 get("/filters", FilterController, :index)
367 post("/filters", FilterController, :create)
368 get("/filters/:id", FilterController, :show)
369 put("/filters/:id", FilterController, :update)
370 delete("/filters/:id", FilterController, :delete)
372 get("/follow_requests", FollowRequestController, :index)
373 post("/follow_requests/:id/authorize", FollowRequestController, :authorize)
374 post("/follow_requests/:id/reject", FollowRequestController, :reject)
376 get("/lists", ListController, :index)
377 get("/lists/:id", ListController, :show)
378 get("/lists/:id/accounts", ListController, :list_accounts)
380 delete("/lists/:id", ListController, :delete)
381 post("/lists", ListController, :create)
382 put("/lists/:id", ListController, :update)
383 post("/lists/:id/accounts", ListController, :add_to_list)
384 delete("/lists/:id/accounts", ListController, :remove_from_list)
386 get("/markers", MarkerController, :index)
387 post("/markers", MarkerController, :upsert)
389 post("/media", MediaController, :create)
390 put("/media/:id", MediaController, :update)
392 get("/notifications", NotificationController, :index)
393 get("/notifications/:id", NotificationController, :show)
395 post("/notifications/:id/dismiss", NotificationController, :dismiss)
396 post("/notifications/clear", NotificationController, :clear)
397 delete("/notifications/destroy_multiple", NotificationController, :destroy_multiple)
398 # Deprecated: was removed in Mastodon v3, use `/notifications/:id/dismiss` instead
399 post("/notifications/dismiss", NotificationController, :dismiss_via_body)
401 post("/polls/:id/votes", PollController, :vote)
403 post("/reports", ReportController, :create)
405 get("/scheduled_statuses", ScheduledActivityController, :index)
406 get("/scheduled_statuses/:id", ScheduledActivityController, :show)
408 put("/scheduled_statuses/:id", ScheduledActivityController, :update)
409 delete("/scheduled_statuses/:id", ScheduledActivityController, :delete)
411 # Unlike `GET /api/v1/accounts/:id/favourites`, demands authentication
412 get("/favourites", StatusController, :favourites)
413 get("/bookmarks", StatusController, :bookmarks)
415 post("/statuses", StatusController, :create)
416 delete("/statuses/:id", StatusController, :delete)
417 post("/statuses/:id/reblog", StatusController, :reblog)
418 post("/statuses/:id/unreblog", StatusController, :unreblog)
419 post("/statuses/:id/favourite", StatusController, :favourite)
420 post("/statuses/:id/unfavourite", StatusController, :unfavourite)
421 post("/statuses/:id/pin", StatusController, :pin)
422 post("/statuses/:id/unpin", StatusController, :unpin)
423 post("/statuses/:id/bookmark", StatusController, :bookmark)
424 post("/statuses/:id/unbookmark", StatusController, :unbookmark)
425 post("/statuses/:id/mute", StatusController, :mute_conversation)
426 post("/statuses/:id/unmute", StatusController, :unmute_conversation)
428 post("/push/subscription", SubscriptionController, :create)
429 get("/push/subscription", SubscriptionController, :get)
430 put("/push/subscription", SubscriptionController, :update)
431 delete("/push/subscription", SubscriptionController, :delete)
433 get("/suggestions", SuggestionController, :index)
435 get("/timelines/home", TimelineController, :home)
436 get("/timelines/direct", TimelineController, :direct)
437 get("/timelines/list/:list_id", TimelineController, :list)
440 scope "/api/web", Pleroma.Web do
441 pipe_through(:authenticated_api)
443 put("/settings", MastoFEController, :put_settings)
446 scope "/api/v1", Pleroma.Web.MastodonAPI do
449 get("/accounts/search", SearchController, :account_search)
450 get("/search", SearchController, :search)
452 get("/accounts/:id/statuses", AccountController, :statuses)
453 get("/accounts/:id/followers", AccountController, :followers)
454 get("/accounts/:id/following", AccountController, :following)
455 get("/accounts/:id", AccountController, :show)
457 post("/accounts", AccountController, :create)
459 get("/instance", InstanceController, :show)
460 get("/instance/peers", InstanceController, :peers)
462 post("/apps", AppController, :create)
464 get("/statuses", StatusController, :index)
465 get("/statuses/:id", StatusController, :show)
466 get("/statuses/:id/context", StatusController, :context)
467 get("/statuses/:id/card", StatusController, :card)
468 get("/statuses/:id/favourited_by", StatusController, :favourited_by)
469 get("/statuses/:id/reblogged_by", StatusController, :reblogged_by)
471 get("/custom_emojis", CustomEmojiController, :index)
473 get("/trends", MastodonAPIController, :empty_array)
475 get("/timelines/public", TimelineController, :public)
476 get("/timelines/tag/:tag", TimelineController, :hashtag)
478 get("/polls/:id", PollController, :show)
481 scope "/api/v2", Pleroma.Web.MastodonAPI do
483 get("/search", SearchController, :search2)
486 scope "/api", Pleroma.Web do
487 pipe_through(:config)
489 get("/help/test", TwitterAPI.UtilController, :help_test)
490 post("/help/test", TwitterAPI.UtilController, :help_test)
491 get("/statusnet/config", TwitterAPI.UtilController, :config)
492 get("/statusnet/version", TwitterAPI.UtilController, :version)
493 get("/pleroma/frontend_configurations", TwitterAPI.UtilController, :frontend_configurations)
496 scope "/api", Pleroma.Web do
500 "/account/confirm_email/:user_id/:token",
501 TwitterAPI.Controller,
508 pipe_through(:base_api)
510 get("/openapi", OpenApiSpex.Plug.RenderSpec, [])
513 scope "/api", Pleroma.Web, as: :authenticated_twitter_api do
514 pipe_through(:authenticated_api)
516 get("/oauth_tokens", TwitterAPI.Controller, :oauth_tokens)
517 delete("/oauth_tokens/:id", TwitterAPI.Controller, :revoke_token)
520 "/qvitter/statuses/notifications/read",
521 TwitterAPI.Controller,
522 :mark_notifications_as_read
527 plug(:accepts, ["html", "xml", "rss", "atom", "activity+json", "json"])
528 plug(Pleroma.Plugs.StaticFEPlug)
532 plug(:accepts, ["json", "xml"])
535 scope "/", Pleroma.Web do
536 pipe_through([:ostatus, :http_signature])
538 get("/objects/:uuid", OStatus.OStatusController, :object)
539 get("/activities/:uuid", OStatus.OStatusController, :activity)
540 get("/notice/:id", OStatus.OStatusController, :notice)
541 get("/notice/:id/embed_player", OStatus.OStatusController, :notice_player)
543 get("/users/:nickname/feed", Feed.UserController, :feed, as: :user_feed)
544 get("/users/:nickname", Feed.UserController, :feed_redirect, as: :user_feed)
546 get("/tags/:tag", Feed.TagController, :feed, as: :tag_feed)
549 scope "/", Pleroma.Web do
550 pipe_through(:browser)
551 get("/mailer/unsubscribe/:token", Mailer.SubscriptionController, :unsubscribe)
554 scope "/", Pleroma.Web.ActivityPub do
555 # XXX: not really ostatus
556 pipe_through(:ostatus)
558 get("/users/:nickname/outbox", ActivityPubController, :outbox)
561 pipeline :ap_service_actor do
562 plug(:accepts, ["activity+json", "json"])
565 # Server to Server (S2S) AP interactions
566 pipeline :activitypub do
567 plug(:ap_service_actor)
568 plug(:http_signature)
571 # Client to Server (C2S) AP interactions
572 pipeline :activitypub_client do
573 plug(:ap_service_actor)
579 scope "/", Pleroma.Web.ActivityPub do
580 pipe_through([:activitypub_client])
582 get("/api/ap/whoami", ActivityPubController, :whoami)
583 get("/users/:nickname/inbox", ActivityPubController, :read_inbox)
585 post("/users/:nickname/outbox", ActivityPubController, :update_outbox)
586 post("/api/ap/upload_media", ActivityPubController, :upload_media)
588 # The following two are S2S as well, see `ActivityPub.fetch_follow_information_for_user/1`:
589 get("/users/:nickname/followers", ActivityPubController, :followers)
590 get("/users/:nickname/following", ActivityPubController, :following)
593 scope "/", Pleroma.Web.ActivityPub do
594 pipe_through(:activitypub)
595 post("/inbox", ActivityPubController, :inbox)
596 post("/users/:nickname/inbox", ActivityPubController, :inbox)
599 scope "/relay", Pleroma.Web.ActivityPub do
600 pipe_through(:ap_service_actor)
602 get("/", ActivityPubController, :relay)
605 pipe_through(:http_signature)
606 post("/inbox", ActivityPubController, :inbox)
609 get("/following", ActivityPubController, :relay_following)
610 get("/followers", ActivityPubController, :relay_followers)
613 scope "/internal/fetch", Pleroma.Web.ActivityPub do
614 pipe_through(:ap_service_actor)
616 get("/", ActivityPubController, :internal_fetch)
617 post("/inbox", ActivityPubController, :inbox)
620 scope "/.well-known", Pleroma.Web do
621 pipe_through(:well_known)
623 get("/host-meta", WebFinger.WebFingerController, :host_meta)
624 get("/webfinger", WebFinger.WebFingerController, :webfinger)
625 get("/nodeinfo", Nodeinfo.NodeinfoController, :schemas)
628 scope "/nodeinfo", Pleroma.Web do
629 get("/:version", Nodeinfo.NodeinfoController, :nodeinfo)
632 scope "/", Pleroma.Web do
635 get("/web/manifest.json", MastoFEController, :manifest)
638 scope "/", Pleroma.Web do
639 pipe_through(:mastodon_html)
641 get("/web/login", MastodonAPI.AuthController, :login)
642 delete("/auth/sign_out", MastodonAPI.AuthController, :logout)
644 post("/auth/password", MastodonAPI.AuthController, :password_reset)
646 get("/web/*path", MastoFEController, :index)
649 scope "/proxy/", Pleroma.Web.MediaProxy do
650 get("/:sig/:url", MediaProxyController, :remote)
651 get("/:sig/:url/:filename", MediaProxyController, :remote)
654 if Pleroma.Config.get(:env) == :dev do
656 pipe_through([:mailbox_preview])
658 forward("/mailbox", Plug.Swoosh.MailboxPreview, base_path: "/dev/mailbox")
662 # Test-only routes needed to test action dispatching and plug chain execution
663 if Pleroma.Config.get(:env) == :test do
666 :fallback_oauth_check,
668 :fallback_oauth_skip_publicity_check,
669 :skip_oauth_skip_publicity_check,
670 :missing_oauth_check_definition
673 scope "/test/api", Pleroma.Tests do
676 for action <- @test_actions do
677 get("/#{action}", AuthTestController, action)
681 scope "/test/authenticated_api", Pleroma.Tests do
682 pipe_through(:authenticated_api)
684 for action <- @test_actions do
685 get("/#{action}", AuthTestController, action)
690 scope "/", Pleroma.Web.MongooseIM do
691 get("/user_exists", MongooseIMController, :user_exists)
692 get("/check_password", MongooseIMController, :check_password)
695 scope "/", Fallback do
696 get("/registration/:token", RedirectController, :registration_page)
697 get("/:maybe_nickname_or_id", RedirectController, :redirector_with_meta)
698 get("/api*path", RedirectController, :api_not_implemented)
699 get("/*path", RedirectController, :redirector)
701 options("/*path", RedirectController, :empty)