1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 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)
19 plug(:accepts, ["json"])
21 plug(Pleroma.Plugs.OAuthPlug)
22 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
23 plug(Pleroma.Plugs.UserFetcherPlug)
24 plug(Pleroma.Plugs.SessionAuthenticationPlug)
25 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
26 plug(Pleroma.Plugs.AuthenticationPlug)
27 plug(Pleroma.Plugs.UserEnabledPlug)
28 plug(Pleroma.Plugs.SetUserSessionIdPlug)
29 plug(Pleroma.Plugs.EnsureUserKeyPlug)
30 plug(Pleroma.Plugs.IdempotencyPlug)
33 pipeline :authenticated_api do
34 plug(:accepts, ["json"])
36 plug(Pleroma.Plugs.OAuthPlug)
37 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
38 plug(Pleroma.Plugs.UserFetcherPlug)
39 plug(Pleroma.Plugs.SessionAuthenticationPlug)
40 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
41 plug(Pleroma.Plugs.AuthenticationPlug)
42 plug(Pleroma.Plugs.UserEnabledPlug)
43 plug(Pleroma.Plugs.SetUserSessionIdPlug)
44 plug(Pleroma.Plugs.EnsureAuthenticatedPlug)
45 plug(Pleroma.Plugs.IdempotencyPlug)
48 pipeline :admin_api do
49 plug(:accepts, ["json"])
51 plug(Pleroma.Plugs.OAuthPlug)
52 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
53 plug(Pleroma.Plugs.UserFetcherPlug)
54 plug(Pleroma.Plugs.SessionAuthenticationPlug)
55 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
56 plug(Pleroma.Plugs.AuthenticationPlug)
57 plug(Pleroma.Plugs.AdminSecretAuthenticationPlug)
58 plug(Pleroma.Plugs.UserEnabledPlug)
59 plug(Pleroma.Plugs.SetUserSessionIdPlug)
60 plug(Pleroma.Plugs.EnsureAuthenticatedPlug)
61 plug(Pleroma.Plugs.UserIsAdminPlug)
62 plug(Pleroma.Plugs.IdempotencyPlug)
65 pipeline :mastodon_html do
66 plug(:accepts, ["html"])
68 plug(Pleroma.Plugs.OAuthPlug)
69 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
70 plug(Pleroma.Plugs.UserFetcherPlug)
71 plug(Pleroma.Plugs.SessionAuthenticationPlug)
72 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
73 plug(Pleroma.Plugs.AuthenticationPlug)
74 plug(Pleroma.Plugs.UserEnabledPlug)
75 plug(Pleroma.Plugs.SetUserSessionIdPlug)
76 plug(Pleroma.Plugs.EnsureUserKeyPlug)
79 pipeline :pleroma_html do
80 plug(:accepts, ["html"])
82 plug(Pleroma.Plugs.OAuthPlug)
83 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
84 plug(Pleroma.Plugs.UserFetcherPlug)
85 plug(Pleroma.Plugs.SessionAuthenticationPlug)
86 plug(Pleroma.Plugs.AuthenticationPlug)
87 plug(Pleroma.Plugs.EnsureUserKeyPlug)
90 pipeline :well_known do
91 plug(:accepts, ["json", "jrd+json", "xml", "xrd+xml"])
95 plug(:accepts, ["json", "xml"])
98 pipeline :pleroma_api do
99 plug(:accepts, ["html", "json"])
102 pipeline :mailbox_preview do
103 plug(:accepts, ["html"])
105 plug(:put_secure_browser_headers, %{
106 "content-security-policy" =>
107 "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' 'unsafe-eval'"
111 pipeline :http_signature do
112 plug(Pleroma.Web.Plugs.HTTPSignaturePlug)
113 plug(Pleroma.Web.Plugs.MappedSignatureToIdentityPlug)
116 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
117 pipe_through(:pleroma_api)
119 get("/password_reset/:token", PasswordController, :reset, as: :reset_password)
120 post("/password_reset", PasswordController, :do_reset, as: :reset_password)
121 get("/emoji", UtilController, :emoji)
122 get("/captcha", UtilController, :captcha)
123 get("/healthcheck", UtilController, :healthcheck)
126 scope "/api/pleroma", Pleroma.Web do
127 pipe_through(:pleroma_api)
128 post("/uploader_callback/:upload_path", UploaderController, :callback)
131 scope "/api/pleroma/admin", Pleroma.Web.AdminAPI do
132 pipe_through(:admin_api)
134 post("/users/follow", AdminAPIController, :user_follow)
135 post("/users/unfollow", AdminAPIController, :user_unfollow)
137 delete("/users", AdminAPIController, :user_delete)
138 post("/users", AdminAPIController, :users_create)
139 patch("/users/:nickname/toggle_activation", AdminAPIController, :user_toggle_activation)
140 patch("/users/activate", AdminAPIController, :user_activate)
141 patch("/users/deactivate", AdminAPIController, :user_deactivate)
142 put("/users/tag", AdminAPIController, :tag_users)
143 delete("/users/tag", AdminAPIController, :untag_users)
145 get("/users/:nickname/permission_group", AdminAPIController, :right_get)
146 get("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_get)
148 post("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_add)
151 "/users/:nickname/permission_group/:permission_group",
156 post("/users/permission_group/:permission_group", AdminAPIController, :right_add_multiple)
159 "/users/permission_group/:permission_group",
161 :right_delete_multiple
164 post("/relay", AdminAPIController, :relay_follow)
165 delete("/relay", AdminAPIController, :relay_unfollow)
167 post("/users/invite_token", AdminAPIController, :create_invite_token)
168 get("/users/invites", AdminAPIController, :invites)
169 post("/users/revoke_invite", AdminAPIController, :revoke_invite)
170 post("/users/email_invite", AdminAPIController, :email_invite)
172 get("/users/:nickname/password_reset", AdminAPIController, :get_password_reset)
173 patch("/users/:nickname/force_password_reset", AdminAPIController, :force_password_reset)
175 get("/users", AdminAPIController, :list_users)
176 get("/users/:nickname", AdminAPIController, :user_show)
177 get("/users/:nickname/statuses", AdminAPIController, :list_user_statuses)
179 get("/reports", AdminAPIController, :list_reports)
180 get("/reports/:id", AdminAPIController, :report_show)
181 put("/reports/:id", AdminAPIController, :report_update_state)
182 post("/reports/:id/respond", AdminAPIController, :report_respond)
184 put("/statuses/:id", AdminAPIController, :status_update)
185 delete("/statuses/:id", AdminAPIController, :status_delete)
187 get("/config", AdminAPIController, :config_show)
188 post("/config", AdminAPIController, :config_update)
189 get("/config/migrate_to_db", AdminAPIController, :migrate_to_db)
190 get("/config/migrate_from_db", AdminAPIController, :migrate_from_db)
192 get("/moderation_log", AdminAPIController, :list_log)
194 post("/reload_emoji", AdminAPIController, :reload_emoji)
197 scope "/api/pleroma/emoji", Pleroma.Web.PleromaAPI do
200 pipe_through(:admin_api)
202 post("/import_from_fs", EmojiAPIController, :import_from_fs)
204 post("/:pack_name/update_file", EmojiAPIController, :update_file)
205 post("/:pack_name/update_metadata", EmojiAPIController, :update_metadata)
206 put("/:name", EmojiAPIController, :create)
207 delete("/:name", EmojiAPIController, :delete)
208 post("/download_from", EmojiAPIController, :download_from)
209 post("/list_from", EmojiAPIController, :list_from)
213 # Pack info / downloading
214 get("/", EmojiAPIController, :list_packs)
215 get("/:name/download_shared/", EmojiAPIController, :download_shared)
219 scope "/", Pleroma.Web.TwitterAPI do
220 pipe_through(:pleroma_html)
222 post("/main/ostatus", UtilController, :remote_subscribe)
223 get("/ostatus_subscribe", UtilController, :remote_follow)
225 post("/ostatus_subscribe", UtilController, :do_remote_follow)
228 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
229 pipe_through(:authenticated_api)
231 post("/change_email", UtilController, :change_email)
232 post("/change_password", UtilController, :change_password)
233 post("/delete_account", UtilController, :delete_account)
234 put("/notification_settings", UtilController, :update_notificaton_settings)
235 post("/disable_account", UtilController, :disable_account)
237 post("/blocks_import", UtilController, :blocks_import)
238 post("/follow_import", UtilController, :follow_import)
241 scope "/oauth", Pleroma.Web.OAuth do
244 get("/authorize", OAuthController, :authorize)
247 post("/authorize", OAuthController, :create_authorization)
248 post("/token", OAuthController, :token_exchange)
249 post("/revoke", OAuthController, :token_revoke)
250 get("/registration_details", OAuthController, :registration_details)
253 pipe_through(:browser)
255 get("/prepare_request", OAuthController, :prepare_request)
256 get("/:provider", OAuthController, :request)
257 get("/:provider/callback", OAuthController, :callback)
258 post("/register", OAuthController, :register)
262 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
264 pipe_through(:authenticated_api)
266 get("/conversations/:id/statuses", PleromaAPIController, :conversation_statuses)
267 get("/conversations/:id", PleromaAPIController, :conversation)
271 pipe_through(:authenticated_api)
273 patch("/conversations/:id", PleromaAPIController, :update_conversation)
274 post("/notifications/read", PleromaAPIController, :read_notification)
276 patch("/accounts/update_avatar", AccountController, :update_avatar)
277 patch("/accounts/update_banner", AccountController, :update_banner)
278 patch("/accounts/update_background", AccountController, :update_background)
280 get("/mascot", MascotController, :show)
281 put("/mascot", MascotController, :update)
283 post("/scrobble", ScrobbleController, :new_scrobble)
288 get("/accounts/:id/favourites", AccountController, :favourites)
292 pipe_through(:authenticated_api)
294 post("/accounts/:id/subscribe", AccountController, :subscribe)
295 post("/accounts/:id/unsubscribe", AccountController, :unsubscribe)
298 post("/accounts/confirmation_resend", AccountController, :confirmation_resend)
301 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
303 get("/accounts/:id/scrobbles", ScrobbleController, :user_scrobbles)
306 scope "/api/v1", Pleroma.Web.MastodonAPI do
307 pipe_through(:authenticated_api)
309 get("/accounts/verify_credentials", AccountController, :verify_credentials)
311 get("/accounts/relationships", AccountController, :relationships)
313 get("/accounts/:id/lists", AccountController, :lists)
314 get("/accounts/:id/identity_proofs", MastodonAPIController, :empty_array)
316 get("/follow_requests", FollowRequestController, :index)
317 get("/blocks", AccountController, :blocks)
318 get("/mutes", AccountController, :mutes)
320 get("/timelines/home", TimelineController, :home)
321 get("/timelines/direct", TimelineController, :direct)
323 get("/favourites", StatusController, :favourites)
324 get("/bookmarks", StatusController, :bookmarks)
326 get("/notifications", NotificationController, :index)
327 get("/notifications/:id", NotificationController, :show)
328 post("/notifications/clear", NotificationController, :clear)
329 post("/notifications/dismiss", NotificationController, :dismiss)
330 delete("/notifications/destroy_multiple", NotificationController, :destroy_multiple)
332 get("/scheduled_statuses", ScheduledActivityController, :index)
333 get("/scheduled_statuses/:id", ScheduledActivityController, :show)
335 get("/lists", ListController, :index)
336 get("/lists/:id", ListController, :show)
337 get("/lists/:id/accounts", ListController, :list_accounts)
339 get("/domain_blocks", DomainBlockController, :index)
341 get("/filters", FilterController, :index)
343 get("/suggestions", SuggestionController, :index)
345 get("/conversations", ConversationController, :index)
346 post("/conversations/:id/read", ConversationController, :read)
348 get("/endorsements", AccountController, :endorsements)
350 patch("/accounts/update_credentials", AccountController, :update_credentials)
352 post("/statuses", StatusController, :create)
353 delete("/statuses/:id", StatusController, :delete)
355 post("/statuses/:id/reblog", StatusController, :reblog)
356 post("/statuses/:id/unreblog", StatusController, :unreblog)
357 post("/statuses/:id/favourite", StatusController, :favourite)
358 post("/statuses/:id/unfavourite", StatusController, :unfavourite)
359 post("/statuses/:id/pin", StatusController, :pin)
360 post("/statuses/:id/unpin", StatusController, :unpin)
361 post("/statuses/:id/bookmark", StatusController, :bookmark)
362 post("/statuses/:id/unbookmark", StatusController, :unbookmark)
363 post("/statuses/:id/mute", StatusController, :mute_conversation)
364 post("/statuses/:id/unmute", StatusController, :unmute_conversation)
366 put("/scheduled_statuses/:id", ScheduledActivityController, :update)
367 delete("/scheduled_statuses/:id", ScheduledActivityController, :delete)
369 post("/polls/:id/votes", PollController, :vote)
371 post("/media", MediaController, :create)
372 put("/media/:id", MediaController, :update)
374 delete("/lists/:id", ListController, :delete)
375 post("/lists", ListController, :create)
376 put("/lists/:id", ListController, :update)
378 post("/lists/:id/accounts", ListController, :add_to_list)
379 delete("/lists/:id/accounts", ListController, :remove_from_list)
381 post("/filters", FilterController, :create)
382 get("/filters/:id", FilterController, :show)
383 put("/filters/:id", FilterController, :update)
384 delete("/filters/:id", FilterController, :delete)
386 post("/reports", ReportController, :create)
388 post("/follows", AccountController, :follows)
389 post("/accounts/:id/follow", AccountController, :follow)
390 post("/accounts/:id/unfollow", AccountController, :unfollow)
391 post("/accounts/:id/block", AccountController, :block)
392 post("/accounts/:id/unblock", AccountController, :unblock)
393 post("/accounts/:id/mute", AccountController, :mute)
394 post("/accounts/:id/unmute", AccountController, :unmute)
396 post("/follow_requests/:id/authorize", FollowRequestController, :authorize)
397 post("/follow_requests/:id/reject", FollowRequestController, :reject)
399 post("/domain_blocks", DomainBlockController, :create)
400 delete("/domain_blocks", DomainBlockController, :delete)
402 post("/push/subscription", SubscriptionController, :create)
403 get("/push/subscription", SubscriptionController, :get)
404 put("/push/subscription", SubscriptionController, :update)
405 delete("/push/subscription", SubscriptionController, :delete)
408 scope "/api/web", Pleroma.Web do
409 pipe_through(:authenticated_api)
411 put("/settings", MastoFEController, :put_settings)
414 scope "/api/v1", Pleroma.Web.MastodonAPI do
417 post("/accounts", AccountController, :create)
418 get("/accounts/search", SearchController, :account_search)
420 get("/instance", InstanceController, :show)
421 get("/instance/peers", InstanceController, :peers)
423 post("/apps", AppController, :create)
424 get("/apps/verify_credentials", AppController, :verify_credentials)
426 get("/statuses/:id/card", StatusController, :card)
427 get("/statuses/:id/favourited_by", StatusController, :favourited_by)
428 get("/statuses/:id/reblogged_by", StatusController, :reblogged_by)
430 get("/custom_emojis", CustomEmojiController, :index)
432 get("/trends", MastodonAPIController, :empty_array)
434 get("/timelines/public", TimelineController, :public)
435 get("/timelines/tag/:tag", TimelineController, :hashtag)
436 get("/timelines/list/:list_id", TimelineController, :list)
438 get("/statuses", StatusController, :index)
439 get("/statuses/:id", StatusController, :show)
440 get("/statuses/:id/context", StatusController, :context)
442 get("/polls/:id", PollController, :show)
444 get("/accounts/:id/statuses", AccountController, :statuses)
445 get("/accounts/:id/followers", AccountController, :followers)
446 get("/accounts/:id/following", AccountController, :following)
447 get("/accounts/:id", AccountController, :show)
449 get("/search", SearchController, :search)
452 scope "/api/v2", Pleroma.Web.MastodonAPI do
454 get("/search", SearchController, :search2)
457 scope "/api", Pleroma.Web do
458 pipe_through(:config)
460 get("/help/test", TwitterAPI.UtilController, :help_test)
461 post("/help/test", TwitterAPI.UtilController, :help_test)
462 get("/statusnet/config", TwitterAPI.UtilController, :config)
463 get("/statusnet/version", TwitterAPI.UtilController, :version)
464 get("/pleroma/frontend_configurations", TwitterAPI.UtilController, :frontend_configurations)
467 scope "/api", Pleroma.Web do
471 "/account/confirm_email/:user_id/:token",
472 TwitterAPI.Controller,
478 scope "/api", Pleroma.Web, as: :authenticated_twitter_api do
479 pipe_through(:authenticated_api)
481 get("/oauth_tokens", TwitterAPI.Controller, :oauth_tokens)
482 delete("/oauth_tokens/:id", TwitterAPI.Controller, :revoke_token)
484 post("/qvitter/statuses/notifications/read", TwitterAPI.Controller, :notifications_read)
487 pipeline :ap_service_actor do
488 plug(:accepts, ["activity+json", "json"])
492 plug(:accepts, ["html", "xml", "atom", "activity+json", "json"])
496 plug(:accepts, ["json", "xml"])
499 scope "/", Pleroma.Web do
500 pipe_through(:ostatus)
501 pipe_through(:http_signature)
503 get("/objects/:uuid", OStatus.OStatusController, :object)
504 get("/activities/:uuid", OStatus.OStatusController, :activity)
505 get("/notice/:id", OStatus.OStatusController, :notice)
506 get("/notice/:id/embed_player", OStatus.OStatusController, :notice_player)
508 get("/users/:nickname/feed", Feed.FeedController, :feed)
509 get("/users/:nickname", Feed.FeedController, :feed_redirect)
511 post("/users/:nickname/salmon", OStatus.OStatusController, :salmon_incoming)
512 post("/push/hub/:nickname", Websub.WebsubController, :websub_subscription_request)
513 get("/push/subscriptions/:id", Websub.WebsubController, :websub_subscription_confirmation)
514 post("/push/subscriptions/:id", Websub.WebsubController, :websub_incoming)
516 get("/mailer/unsubscribe/:token", Mailer.SubscriptionController, :unsubscribe)
519 pipeline :activitypub do
520 plug(:accepts, ["activity+json", "json"])
521 plug(Pleroma.Web.Plugs.HTTPSignaturePlug)
522 plug(Pleroma.Web.Plugs.MappedSignatureToIdentityPlug)
525 scope "/", Pleroma.Web.ActivityPub do
526 # XXX: not really ostatus
527 pipe_through(:ostatus)
529 get("/users/:nickname/outbox", ActivityPubController, :outbox)
532 pipeline :activitypub_client do
533 plug(:accepts, ["activity+json", "json"])
535 plug(Pleroma.Plugs.OAuthPlug)
536 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
537 plug(Pleroma.Plugs.UserFetcherPlug)
538 plug(Pleroma.Plugs.SessionAuthenticationPlug)
539 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
540 plug(Pleroma.Plugs.AuthenticationPlug)
541 plug(Pleroma.Plugs.UserEnabledPlug)
542 plug(Pleroma.Plugs.SetUserSessionIdPlug)
543 plug(Pleroma.Plugs.EnsureUserKeyPlug)
546 scope "/", Pleroma.Web.ActivityPub do
547 pipe_through([:activitypub_client])
549 get("/api/ap/whoami", ActivityPubController, :whoami)
550 get("/users/:nickname/inbox", ActivityPubController, :read_inbox)
552 post("/users/:nickname/outbox", ActivityPubController, :update_outbox)
553 post("/api/ap/upload_media", ActivityPubController, :upload_media)
555 get("/users/:nickname/followers", ActivityPubController, :followers)
556 get("/users/:nickname/following", ActivityPubController, :following)
559 scope "/", Pleroma.Web.ActivityPub do
560 pipe_through(:activitypub)
561 post("/inbox", ActivityPubController, :inbox)
562 post("/users/:nickname/inbox", ActivityPubController, :inbox)
565 scope "/relay", Pleroma.Web.ActivityPub do
566 pipe_through(:ap_service_actor)
568 get("/", ActivityPubController, :relay)
571 pipe_through(:http_signature)
572 post("/inbox", ActivityPubController, :inbox)
575 get("/following", ActivityPubController, :following, assigns: %{relay: true})
576 get("/followers", ActivityPubController, :followers, assigns: %{relay: true})
579 scope "/internal/fetch", Pleroma.Web.ActivityPub do
580 pipe_through(:ap_service_actor)
582 get("/", ActivityPubController, :internal_fetch)
583 post("/inbox", ActivityPubController, :inbox)
586 scope "/.well-known", Pleroma.Web do
587 pipe_through(:well_known)
589 get("/host-meta", WebFinger.WebFingerController, :host_meta)
590 get("/webfinger", WebFinger.WebFingerController, :webfinger)
591 get("/nodeinfo", Nodeinfo.NodeinfoController, :schemas)
594 scope "/nodeinfo", Pleroma.Web do
595 get("/:version", Nodeinfo.NodeinfoController, :nodeinfo)
598 scope "/", Pleroma.Web do
599 pipe_through(:mastodon_html)
601 get("/web/login", MastodonAPI.AuthController, :login)
602 delete("/auth/sign_out", MastodonAPI.AuthController, :logout)
604 post("/auth/password", MastodonAPI.AuthController, :password_reset)
606 get("/web/*path", MastoFEController, :index)
609 pipeline :remote_media do
612 scope "/proxy/", Pleroma.Web.MediaProxy do
613 pipe_through(:remote_media)
615 get("/:sig/:url", MediaProxyController, :remote)
616 get("/:sig/:url/:filename", MediaProxyController, :remote)
619 if Pleroma.Config.get(:env) == :dev do
621 pipe_through([:mailbox_preview])
623 forward("/mailbox", Plug.Swoosh.MailboxPreview, base_path: "/dev/mailbox")
627 scope "/", Pleroma.Web.MongooseIM do
628 get("/user_exists", MongooseIMController, :user_exists)
629 get("/check_password", MongooseIMController, :check_password)
632 scope "/", Fallback do
633 get("/registration/:token", RedirectController, :registration_page)
634 get("/:maybe_nickname_or_id", RedirectController, :redirector_with_meta)
635 get("/api*path", RedirectController, :api_not_implemented)
636 get("/*path", RedirectController, :redirector)
638 options("/*path", RedirectController, :empty)