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 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)
145 post("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_add)
148 "/users/:nickname/permission_group/:permission_group",
153 put("/users/:nickname/activation_status", AdminAPIController, :set_activation_status)
155 get("/relay", AdminAPIController, :relay_list)
156 post("/relay", AdminAPIController, :relay_follow)
157 delete("/relay", AdminAPIController, :relay_unfollow)
159 post("/users/invite_token", AdminAPIController, :create_invite_token)
160 get("/users/invites", AdminAPIController, :invites)
161 post("/users/revoke_invite", AdminAPIController, :revoke_invite)
162 post("/users/email_invite", AdminAPIController, :email_invite)
164 get("/users/:nickname/password_reset", AdminAPIController, :get_password_reset)
165 patch("/users/:nickname/force_password_reset", AdminAPIController, :force_password_reset)
167 get("/users", AdminAPIController, :list_users)
168 get("/users/:nickname", AdminAPIController, :user_show)
169 get("/users/:nickname/statuses", AdminAPIController, :list_user_statuses)
171 get("/reports", AdminAPIController, :list_reports)
172 get("/reports/:id", AdminAPIController, :report_show)
173 put("/reports/:id", AdminAPIController, :report_update_state)
174 post("/reports/:id/respond", AdminAPIController, :report_respond)
176 put("/statuses/:id", AdminAPIController, :status_update)
177 delete("/statuses/:id", AdminAPIController, :status_delete)
179 get("/config", AdminAPIController, :config_show)
180 post("/config", AdminAPIController, :config_update)
181 get("/config/migrate_to_db", AdminAPIController, :migrate_to_db)
182 get("/config/migrate_from_db", AdminAPIController, :migrate_from_db)
184 get("/moderation_log", AdminAPIController, :list_log)
186 post("/reload_emoji", AdminAPIController, :reload_emoji)
189 scope "/api/pleroma/emoji", Pleroma.Web.PleromaAPI do
192 pipe_through(:admin_api)
194 post("/import_from_fs", EmojiAPIController, :import_from_fs)
196 post("/:pack_name/update_file", EmojiAPIController, :update_file)
197 post("/:pack_name/update_metadata", EmojiAPIController, :update_metadata)
198 put("/:name", EmojiAPIController, :create)
199 delete("/:name", EmojiAPIController, :delete)
200 post("/download_from", EmojiAPIController, :download_from)
201 post("/list_from", EmojiAPIController, :list_from)
205 # Pack info / downloading
206 get("/", EmojiAPIController, :list_packs)
207 get("/:name/download_shared/", EmojiAPIController, :download_shared)
211 scope "/", Pleroma.Web.TwitterAPI do
212 pipe_through(:pleroma_html)
214 post("/main/ostatus", UtilController, :remote_subscribe)
215 get("/ostatus_subscribe", UtilController, :remote_follow)
217 post("/ostatus_subscribe", UtilController, :do_remote_follow)
220 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
221 pipe_through(:authenticated_api)
223 post("/change_email", UtilController, :change_email)
224 post("/change_password", UtilController, :change_password)
225 post("/delete_account", UtilController, :delete_account)
226 put("/notification_settings", UtilController, :update_notificaton_settings)
227 post("/disable_account", UtilController, :disable_account)
229 post("/blocks_import", UtilController, :blocks_import)
230 post("/follow_import", UtilController, :follow_import)
233 scope "/oauth", Pleroma.Web.OAuth do
236 get("/authorize", OAuthController, :authorize)
239 post("/authorize", OAuthController, :create_authorization)
240 post("/token", OAuthController, :token_exchange)
241 post("/revoke", OAuthController, :token_revoke)
242 get("/registration_details", OAuthController, :registration_details)
245 pipe_through(:browser)
247 get("/prepare_request", OAuthController, :prepare_request)
248 get("/:provider", OAuthController, :request)
249 get("/:provider/callback", OAuthController, :callback)
250 post("/register", OAuthController, :register)
254 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
256 pipe_through(:authenticated_api)
258 get("/conversations/:id/statuses", PleromaAPIController, :conversation_statuses)
259 get("/conversations/:id", PleromaAPIController, :conversation)
263 pipe_through(:authenticated_api)
265 patch("/conversations/:id", PleromaAPIController, :update_conversation)
266 post("/notifications/read", PleromaAPIController, :read_notification)
268 patch("/accounts/update_avatar", AccountController, :update_avatar)
269 patch("/accounts/update_banner", AccountController, :update_banner)
270 patch("/accounts/update_background", AccountController, :update_background)
272 get("/mascot", MascotController, :show)
273 put("/mascot", MascotController, :update)
275 post("/scrobble", ScrobbleController, :new_scrobble)
280 get("/accounts/:id/favourites", AccountController, :favourites)
284 pipe_through(:authenticated_api)
286 post("/accounts/:id/subscribe", AccountController, :subscribe)
287 post("/accounts/:id/unsubscribe", AccountController, :unsubscribe)
290 post("/accounts/confirmation_resend", AccountController, :confirmation_resend)
293 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
295 get("/accounts/:id/scrobbles", ScrobbleController, :user_scrobbles)
298 scope "/api/v1", Pleroma.Web.MastodonAPI do
299 pipe_through(:authenticated_api)
301 get("/accounts/verify_credentials", AccountController, :verify_credentials)
303 get("/accounts/relationships", AccountController, :relationships)
305 get("/accounts/:id/lists", AccountController, :lists)
306 get("/accounts/:id/identity_proofs", MastodonAPIController, :empty_array)
308 get("/follow_requests", FollowRequestController, :index)
309 get("/blocks", AccountController, :blocks)
310 get("/mutes", AccountController, :mutes)
312 get("/timelines/home", TimelineController, :home)
313 get("/timelines/direct", TimelineController, :direct)
315 get("/favourites", StatusController, :favourites)
316 get("/bookmarks", StatusController, :bookmarks)
318 get("/notifications", NotificationController, :index)
319 get("/notifications/:id", NotificationController, :show)
320 post("/notifications/clear", NotificationController, :clear)
321 post("/notifications/dismiss", NotificationController, :dismiss)
322 delete("/notifications/destroy_multiple", NotificationController, :destroy_multiple)
324 get("/scheduled_statuses", ScheduledActivityController, :index)
325 get("/scheduled_statuses/:id", ScheduledActivityController, :show)
327 get("/lists", ListController, :index)
328 get("/lists/:id", ListController, :show)
329 get("/lists/:id/accounts", ListController, :list_accounts)
331 get("/domain_blocks", DomainBlockController, :index)
333 get("/filters", FilterController, :index)
335 get("/suggestions", SuggestionController, :index)
337 get("/conversations", ConversationController, :index)
338 post("/conversations/:id/read", ConversationController, :read)
340 get("/endorsements", AccountController, :endorsements)
342 patch("/accounts/update_credentials", AccountController, :update_credentials)
344 post("/statuses", StatusController, :create)
345 delete("/statuses/:id", StatusController, :delete)
347 post("/statuses/:id/reblog", StatusController, :reblog)
348 post("/statuses/:id/unreblog", StatusController, :unreblog)
349 post("/statuses/:id/favourite", StatusController, :favourite)
350 post("/statuses/:id/unfavourite", StatusController, :unfavourite)
351 post("/statuses/:id/pin", StatusController, :pin)
352 post("/statuses/:id/unpin", StatusController, :unpin)
353 post("/statuses/:id/bookmark", StatusController, :bookmark)
354 post("/statuses/:id/unbookmark", StatusController, :unbookmark)
355 post("/statuses/:id/mute", StatusController, :mute_conversation)
356 post("/statuses/:id/unmute", StatusController, :unmute_conversation)
358 put("/scheduled_statuses/:id", ScheduledActivityController, :update)
359 delete("/scheduled_statuses/:id", ScheduledActivityController, :delete)
361 post("/polls/:id/votes", PollController, :vote)
363 post("/media", MediaController, :create)
364 put("/media/:id", MediaController, :update)
366 delete("/lists/:id", ListController, :delete)
367 post("/lists", ListController, :create)
368 put("/lists/:id", ListController, :update)
370 post("/lists/:id/accounts", ListController, :add_to_list)
371 delete("/lists/:id/accounts", ListController, :remove_from_list)
373 post("/filters", FilterController, :create)
374 get("/filters/:id", FilterController, :show)
375 put("/filters/:id", FilterController, :update)
376 delete("/filters/:id", FilterController, :delete)
378 post("/reports", ReportController, :create)
380 post("/follows", AccountController, :follows)
381 post("/accounts/:id/follow", AccountController, :follow)
382 post("/accounts/:id/unfollow", AccountController, :unfollow)
383 post("/accounts/:id/block", AccountController, :block)
384 post("/accounts/:id/unblock", AccountController, :unblock)
385 post("/accounts/:id/mute", AccountController, :mute)
386 post("/accounts/:id/unmute", AccountController, :unmute)
388 post("/follow_requests/:id/authorize", FollowRequestController, :authorize)
389 post("/follow_requests/:id/reject", FollowRequestController, :reject)
391 post("/domain_blocks", DomainBlockController, :create)
392 delete("/domain_blocks", DomainBlockController, :delete)
394 post("/push/subscription", SubscriptionController, :create)
395 get("/push/subscription", SubscriptionController, :get)
396 put("/push/subscription", SubscriptionController, :update)
397 delete("/push/subscription", SubscriptionController, :delete)
400 scope "/api/web", Pleroma.Web do
401 pipe_through(:authenticated_api)
403 put("/settings", MastoFEController, :put_settings)
406 scope "/api/v1", Pleroma.Web.MastodonAPI do
409 post("/accounts", AccountController, :create)
410 get("/accounts/search", SearchController, :account_search)
412 get("/instance", InstanceController, :show)
413 get("/instance/peers", InstanceController, :peers)
415 post("/apps", AppController, :create)
416 get("/apps/verify_credentials", AppController, :verify_credentials)
418 get("/statuses/:id/card", StatusController, :card)
419 get("/statuses/:id/favourited_by", StatusController, :favourited_by)
420 get("/statuses/:id/reblogged_by", StatusController, :reblogged_by)
422 get("/custom_emojis", CustomEmojiController, :index)
424 get("/trends", MastodonAPIController, :empty_array)
426 get("/timelines/public", TimelineController, :public)
427 get("/timelines/tag/:tag", TimelineController, :hashtag)
428 get("/timelines/list/:list_id", TimelineController, :list)
430 get("/statuses", StatusController, :index)
431 get("/statuses/:id", StatusController, :show)
432 get("/statuses/:id/context", StatusController, :context)
434 get("/polls/:id", PollController, :show)
436 get("/accounts/:id/statuses", AccountController, :statuses)
437 get("/accounts/:id/followers", AccountController, :followers)
438 get("/accounts/:id/following", AccountController, :following)
439 get("/accounts/:id", AccountController, :show)
441 get("/search", SearchController, :search)
444 scope "/api/v2", Pleroma.Web.MastodonAPI do
446 get("/search", SearchController, :search2)
449 scope "/api", Pleroma.Web do
450 pipe_through(:config)
452 get("/help/test", TwitterAPI.UtilController, :help_test)
453 post("/help/test", TwitterAPI.UtilController, :help_test)
454 get("/statusnet/config", TwitterAPI.UtilController, :config)
455 get("/statusnet/version", TwitterAPI.UtilController, :version)
456 get("/pleroma/frontend_configurations", TwitterAPI.UtilController, :frontend_configurations)
459 scope "/api", Pleroma.Web do
463 "/account/confirm_email/:user_id/:token",
464 TwitterAPI.Controller,
470 scope "/api", Pleroma.Web, as: :authenticated_twitter_api do
471 pipe_through(:authenticated_api)
473 get("/oauth_tokens", TwitterAPI.Controller, :oauth_tokens)
474 delete("/oauth_tokens/:id", TwitterAPI.Controller, :revoke_token)
476 post("/qvitter/statuses/notifications/read", TwitterAPI.Controller, :notifications_read)
479 pipeline :ap_service_actor do
480 plug(:accepts, ["activity+json", "json"])
484 plug(:accepts, ["html", "xml", "atom", "activity+json", "json"])
488 plug(:accepts, ["json", "xml"])
491 scope "/", Pleroma.Web do
492 pipe_through(:ostatus)
493 pipe_through(:http_signature)
495 get("/objects/:uuid", OStatus.OStatusController, :object)
496 get("/activities/:uuid", OStatus.OStatusController, :activity)
497 get("/notice/:id", OStatus.OStatusController, :notice)
498 get("/notice/:id/embed_player", OStatus.OStatusController, :notice_player)
500 get("/users/:nickname/feed", Feed.FeedController, :feed)
501 get("/users/:nickname", Feed.FeedController, :feed_redirect)
503 post("/users/:nickname/salmon", OStatus.OStatusController, :salmon_incoming)
504 post("/push/hub/:nickname", Websub.WebsubController, :websub_subscription_request)
505 get("/push/subscriptions/:id", Websub.WebsubController, :websub_subscription_confirmation)
506 post("/push/subscriptions/:id", Websub.WebsubController, :websub_incoming)
508 get("/mailer/unsubscribe/:token", Mailer.SubscriptionController, :unsubscribe)
511 pipeline :activitypub do
512 plug(:accepts, ["activity+json", "json"])
513 plug(Pleroma.Web.Plugs.HTTPSignaturePlug)
514 plug(Pleroma.Web.Plugs.MappedSignatureToIdentityPlug)
517 scope "/", Pleroma.Web.ActivityPub do
518 # XXX: not really ostatus
519 pipe_through(:ostatus)
521 get("/users/:nickname/outbox", ActivityPubController, :outbox)
524 pipeline :activitypub_client do
525 plug(:accepts, ["activity+json", "json"])
527 plug(Pleroma.Plugs.OAuthPlug)
528 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
529 plug(Pleroma.Plugs.UserFetcherPlug)
530 plug(Pleroma.Plugs.SessionAuthenticationPlug)
531 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
532 plug(Pleroma.Plugs.AuthenticationPlug)
533 plug(Pleroma.Plugs.UserEnabledPlug)
534 plug(Pleroma.Plugs.SetUserSessionIdPlug)
535 plug(Pleroma.Plugs.EnsureUserKeyPlug)
538 scope "/", Pleroma.Web.ActivityPub do
539 pipe_through([:activitypub_client])
541 get("/api/ap/whoami", ActivityPubController, :whoami)
542 get("/users/:nickname/inbox", ActivityPubController, :read_inbox)
544 post("/users/:nickname/outbox", ActivityPubController, :update_outbox)
545 post("/api/ap/upload_media", ActivityPubController, :upload_media)
547 get("/users/:nickname/followers", ActivityPubController, :followers)
548 get("/users/:nickname/following", ActivityPubController, :following)
551 scope "/", Pleroma.Web.ActivityPub do
552 pipe_through(:activitypub)
553 post("/inbox", ActivityPubController, :inbox)
554 post("/users/:nickname/inbox", ActivityPubController, :inbox)
557 scope "/relay", Pleroma.Web.ActivityPub do
558 pipe_through(:ap_service_actor)
560 get("/", ActivityPubController, :relay)
563 pipe_through(:http_signature)
564 post("/inbox", ActivityPubController, :inbox)
567 get("/following", ActivityPubController, :following, assigns: %{relay: true})
568 get("/followers", ActivityPubController, :followers, assigns: %{relay: true})
571 scope "/internal/fetch", Pleroma.Web.ActivityPub do
572 pipe_through(:ap_service_actor)
574 get("/", ActivityPubController, :internal_fetch)
575 post("/inbox", ActivityPubController, :inbox)
578 scope "/.well-known", Pleroma.Web do
579 pipe_through(:well_known)
581 get("/host-meta", WebFinger.WebFingerController, :host_meta)
582 get("/webfinger", WebFinger.WebFingerController, :webfinger)
583 get("/nodeinfo", Nodeinfo.NodeinfoController, :schemas)
586 scope "/nodeinfo", Pleroma.Web do
587 get("/:version", Nodeinfo.NodeinfoController, :nodeinfo)
590 scope "/", Pleroma.Web do
591 pipe_through(:mastodon_html)
593 get("/web/login", MastodonAPI.AuthController, :login)
594 delete("/auth/sign_out", MastodonAPI.AuthController, :logout)
596 post("/auth/password", MastodonAPI.AuthController, :password_reset)
598 get("/web/*path", MastoFEController, :index)
601 pipeline :remote_media do
604 scope "/proxy/", Pleroma.Web.MediaProxy do
605 pipe_through(:remote_media)
607 get("/:sig/:url", MediaProxyController, :remote)
608 get("/:sig/:url/:filename", MediaProxyController, :remote)
611 if Pleroma.Config.get(:env) == :dev do
613 pipe_through([:mailbox_preview])
615 forward("/mailbox", Plug.Swoosh.MailboxPreview, base_path: "/dev/mailbox")
619 scope "/", Pleroma.Web.MongooseIM do
620 get("/user_exists", MongooseIMController, :user_exists)
621 get("/check_password", MongooseIMController, :check_password)
624 scope "/", Fallback do
625 get("/registration/:token", RedirectController, :registration_page)
626 get("/:maybe_nickname_or_id", RedirectController, :redirector_with_meta)
627 get("/api*path", RedirectController, :api_not_implemented)
628 get("/*path", RedirectController, :redirector)
630 options("/*path", RedirectController, :empty)