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)
16 plug(Pleroma.Plugs.UserEnabledPlug)
20 plug(:accepts, ["json"])
22 plug(Pleroma.Plugs.OAuthPlug)
23 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
24 plug(Pleroma.Plugs.UserFetcherPlug)
25 plug(Pleroma.Plugs.SessionAuthenticationPlug)
26 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
27 plug(Pleroma.Plugs.AuthenticationPlug)
28 plug(Pleroma.Plugs.UserEnabledPlug)
29 plug(Pleroma.Plugs.SetUserSessionIdPlug)
30 plug(Pleroma.Plugs.EnsureUserKeyPlug)
31 plug(Pleroma.Plugs.IdempotencyPlug)
34 pipeline :authenticated_api do
35 plug(:accepts, ["json"])
37 plug(Pleroma.Plugs.OAuthPlug)
38 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
39 plug(Pleroma.Plugs.UserFetcherPlug)
40 plug(Pleroma.Plugs.SessionAuthenticationPlug)
41 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
42 plug(Pleroma.Plugs.AuthenticationPlug)
43 plug(Pleroma.Plugs.UserEnabledPlug)
44 plug(Pleroma.Plugs.SetUserSessionIdPlug)
45 plug(Pleroma.Plugs.EnsureAuthenticatedPlug)
46 plug(Pleroma.Plugs.IdempotencyPlug)
49 pipeline :admin_api do
50 plug(:accepts, ["json"])
52 plug(Pleroma.Plugs.OAuthPlug)
53 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
54 plug(Pleroma.Plugs.UserFetcherPlug)
55 plug(Pleroma.Plugs.SessionAuthenticationPlug)
56 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
57 plug(Pleroma.Plugs.AuthenticationPlug)
58 plug(Pleroma.Plugs.AdminSecretAuthenticationPlug)
59 plug(Pleroma.Plugs.UserEnabledPlug)
60 plug(Pleroma.Plugs.SetUserSessionIdPlug)
61 plug(Pleroma.Plugs.EnsureAuthenticatedPlug)
62 plug(Pleroma.Plugs.UserIsAdminPlug)
63 plug(Pleroma.Plugs.IdempotencyPlug)
66 pipeline :mastodon_html do
67 plug(:accepts, ["html"])
69 plug(Pleroma.Plugs.OAuthPlug)
70 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
71 plug(Pleroma.Plugs.UserFetcherPlug)
72 plug(Pleroma.Plugs.SessionAuthenticationPlug)
73 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
74 plug(Pleroma.Plugs.AuthenticationPlug)
75 plug(Pleroma.Plugs.UserEnabledPlug)
76 plug(Pleroma.Plugs.SetUserSessionIdPlug)
77 plug(Pleroma.Plugs.EnsureUserKeyPlug)
80 pipeline :pleroma_html do
81 plug(:accepts, ["html"])
83 plug(Pleroma.Plugs.OAuthPlug)
84 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
85 plug(Pleroma.Plugs.UserFetcherPlug)
86 plug(Pleroma.Plugs.SessionAuthenticationPlug)
87 plug(Pleroma.Plugs.AuthenticationPlug)
88 plug(Pleroma.Plugs.EnsureUserKeyPlug)
91 pipeline :well_known do
92 plug(:accepts, ["json", "jrd+json", "xml", "xrd+xml"])
96 plug(:accepts, ["json", "xml"])
99 pipeline :pleroma_api do
100 plug(:accepts, ["html", "json"])
103 pipeline :mailbox_preview do
104 plug(:accepts, ["html"])
106 plug(:put_secure_browser_headers, %{
107 "content-security-policy" =>
108 "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' 'unsafe-eval'"
112 pipeline :http_signature do
113 plug(Pleroma.Web.Plugs.HTTPSignaturePlug)
114 plug(Pleroma.Web.Plugs.MappedSignatureToIdentityPlug)
117 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
118 pipe_through(:pleroma_api)
120 get("/password_reset/:token", PasswordController, :reset, as: :reset_password)
121 post("/password_reset", PasswordController, :do_reset, as: :reset_password)
122 get("/emoji", UtilController, :emoji)
123 get("/captcha", UtilController, :captcha)
124 get("/healthcheck", UtilController, :healthcheck)
127 scope "/api/pleroma", Pleroma.Web do
128 pipe_through(:pleroma_api)
129 post("/uploader_callback/:upload_path", UploaderController, :callback)
132 scope "/api/pleroma/admin", Pleroma.Web.AdminAPI do
133 pipe_through(:admin_api)
135 post("/users/follow", AdminAPIController, :user_follow)
136 post("/users/unfollow", AdminAPIController, :user_unfollow)
138 delete("/users", AdminAPIController, :user_delete)
139 post("/users", AdminAPIController, :users_create)
140 patch("/users/:nickname/toggle_activation", AdminAPIController, :user_toggle_activation)
141 patch("/users/activate", AdminAPIController, :user_activate)
142 patch("/users/deactivate", AdminAPIController, :user_deactivate)
143 put("/users/tag", AdminAPIController, :tag_users)
144 delete("/users/tag", AdminAPIController, :untag_users)
146 get("/users/:nickname/permission_group", AdminAPIController, :right_get)
147 get("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_get)
149 post("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_add)
152 "/users/:nickname/permission_group/:permission_group",
157 post("/users/permission_group/:permission_group", AdminAPIController, :right_add_multiple)
160 "/users/permission_group/:permission_group",
162 :right_delete_multiple
165 get("/relay", AdminAPIController, :relay_list)
166 post("/relay", AdminAPIController, :relay_follow)
167 delete("/relay", AdminAPIController, :relay_unfollow)
169 post("/users/invite_token", AdminAPIController, :create_invite_token)
170 get("/users/invites", AdminAPIController, :invites)
171 post("/users/revoke_invite", AdminAPIController, :revoke_invite)
172 post("/users/email_invite", AdminAPIController, :email_invite)
174 get("/users/:nickname/password_reset", AdminAPIController, :get_password_reset)
175 patch("/users/force_password_reset", AdminAPIController, :force_password_reset)
177 get("/users", AdminAPIController, :list_users)
178 get("/users/:nickname", AdminAPIController, :user_show)
179 get("/users/:nickname/statuses", AdminAPIController, :list_user_statuses)
181 patch("/users/confirm_email", AdminAPIController, :confirm_email)
182 patch("/users/resend_confirmation_email", AdminAPIController, :resend_confirmation_email)
184 get("/reports", AdminAPIController, :list_reports)
185 get("/grouped_reports", AdminAPIController, :list_grouped_reports)
186 get("/reports/:id", AdminAPIController, :report_show)
187 patch("/reports", AdminAPIController, :reports_update)
188 post("/reports/:id/respond", AdminAPIController, :report_respond)
190 put("/statuses/:id", AdminAPIController, :status_update)
191 delete("/statuses/:id", AdminAPIController, :status_delete)
193 get("/config", AdminAPIController, :config_show)
194 post("/config", AdminAPIController, :config_update)
195 get("/config/migrate_to_db", AdminAPIController, :migrate_to_db)
196 get("/config/migrate_from_db", AdminAPIController, :migrate_from_db)
198 get("/moderation_log", AdminAPIController, :list_log)
200 post("/reload_emoji", AdminAPIController, :reload_emoji)
203 scope "/api/pleroma/emoji", Pleroma.Web.PleromaAPI do
206 pipe_through(:admin_api)
208 post("/import_from_fs", EmojiAPIController, :import_from_fs)
210 post("/:pack_name/update_file", EmojiAPIController, :update_file)
211 post("/:pack_name/update_metadata", EmojiAPIController, :update_metadata)
212 put("/:name", EmojiAPIController, :create)
213 delete("/:name", EmojiAPIController, :delete)
214 post("/download_from", EmojiAPIController, :download_from)
215 post("/list_from", EmojiAPIController, :list_from)
219 # Pack info / downloading
220 get("/", EmojiAPIController, :list_packs)
221 get("/:name/download_shared/", EmojiAPIController, :download_shared)
225 scope "/", Pleroma.Web.TwitterAPI do
226 pipe_through(:pleroma_html)
228 post("/main/ostatus", UtilController, :remote_subscribe)
229 get("/ostatus_subscribe", UtilController, :remote_follow)
231 post("/ostatus_subscribe", UtilController, :do_remote_follow)
234 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
235 pipe_through(:authenticated_api)
237 post("/change_email", UtilController, :change_email)
238 post("/change_password", UtilController, :change_password)
239 post("/delete_account", UtilController, :delete_account)
240 put("/notification_settings", UtilController, :update_notificaton_settings)
241 post("/disable_account", UtilController, :disable_account)
243 post("/blocks_import", UtilController, :blocks_import)
244 post("/follow_import", UtilController, :follow_import)
247 scope "/oauth", Pleroma.Web.OAuth do
250 get("/authorize", OAuthController, :authorize)
253 post("/authorize", OAuthController, :create_authorization)
254 post("/token", OAuthController, :token_exchange)
255 post("/revoke", OAuthController, :token_revoke)
256 get("/registration_details", OAuthController, :registration_details)
259 pipe_through(:browser)
261 get("/prepare_request", OAuthController, :prepare_request)
262 get("/:provider", OAuthController, :request)
263 get("/:provider/callback", OAuthController, :callback)
264 post("/register", OAuthController, :register)
268 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
271 get("/statuses/:id/emoji_reactions_by", PleromaAPIController, :emoji_reactions_by)
274 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
276 pipe_through(:authenticated_api)
278 get("/conversations/:id/statuses", PleromaAPIController, :conversation_statuses)
279 get("/conversations/:id", PleromaAPIController, :conversation)
280 post("/conversations/read", PleromaAPIController, :read_conversations)
284 pipe_through(:authenticated_api)
286 patch("/conversations/:id", PleromaAPIController, :update_conversation)
287 post("/statuses/:id/react_with_emoji", PleromaAPIController, :react_with_emoji)
288 post("/statuses/:id/unreact_with_emoji", PleromaAPIController, :unreact_with_emoji)
289 post("/notifications/read", PleromaAPIController, :read_notification)
291 patch("/accounts/update_avatar", AccountController, :update_avatar)
292 patch("/accounts/update_banner", AccountController, :update_banner)
293 patch("/accounts/update_background", AccountController, :update_background)
295 get("/mascot", MascotController, :show)
296 put("/mascot", MascotController, :update)
298 post("/scrobble", ScrobbleController, :new_scrobble)
303 get("/accounts/:id/favourites", AccountController, :favourites)
307 pipe_through(:authenticated_api)
309 post("/accounts/:id/subscribe", AccountController, :subscribe)
310 post("/accounts/:id/unsubscribe", AccountController, :unsubscribe)
313 post("/accounts/confirmation_resend", AccountController, :confirmation_resend)
316 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
318 get("/accounts/:id/scrobbles", ScrobbleController, :user_scrobbles)
321 scope "/api/v1", Pleroma.Web.MastodonAPI do
322 pipe_through(:authenticated_api)
324 get("/accounts/verify_credentials", AccountController, :verify_credentials)
326 get("/accounts/relationships", AccountController, :relationships)
328 get("/accounts/:id/lists", AccountController, :lists)
329 get("/accounts/:id/identity_proofs", MastodonAPIController, :empty_array)
331 get("/follow_requests", FollowRequestController, :index)
332 get("/blocks", AccountController, :blocks)
333 get("/mutes", AccountController, :mutes)
335 get("/timelines/home", TimelineController, :home)
336 get("/timelines/direct", TimelineController, :direct)
338 get("/favourites", StatusController, :favourites)
339 get("/bookmarks", StatusController, :bookmarks)
341 get("/notifications", NotificationController, :index)
342 get("/notifications/:id", NotificationController, :show)
343 post("/notifications/clear", NotificationController, :clear)
344 post("/notifications/dismiss", NotificationController, :dismiss)
345 delete("/notifications/destroy_multiple", NotificationController, :destroy_multiple)
347 get("/scheduled_statuses", ScheduledActivityController, :index)
348 get("/scheduled_statuses/:id", ScheduledActivityController, :show)
350 get("/lists", ListController, :index)
351 get("/lists/:id", ListController, :show)
352 get("/lists/:id/accounts", ListController, :list_accounts)
354 get("/domain_blocks", DomainBlockController, :index)
356 get("/filters", FilterController, :index)
358 get("/suggestions", SuggestionController, :index)
360 get("/conversations", ConversationController, :index)
361 post("/conversations/:id/read", ConversationController, :read)
363 get("/endorsements", AccountController, :endorsements)
365 patch("/accounts/update_credentials", AccountController, :update_credentials)
367 post("/statuses", StatusController, :create)
368 delete("/statuses/:id", StatusController, :delete)
370 post("/statuses/:id/reblog", StatusController, :reblog)
371 post("/statuses/:id/unreblog", StatusController, :unreblog)
372 post("/statuses/:id/favourite", StatusController, :favourite)
373 post("/statuses/:id/unfavourite", StatusController, :unfavourite)
374 post("/statuses/:id/pin", StatusController, :pin)
375 post("/statuses/:id/unpin", StatusController, :unpin)
376 post("/statuses/:id/bookmark", StatusController, :bookmark)
377 post("/statuses/:id/unbookmark", StatusController, :unbookmark)
378 post("/statuses/:id/mute", StatusController, :mute_conversation)
379 post("/statuses/:id/unmute", StatusController, :unmute_conversation)
381 put("/scheduled_statuses/:id", ScheduledActivityController, :update)
382 delete("/scheduled_statuses/:id", ScheduledActivityController, :delete)
384 post("/polls/:id/votes", PollController, :vote)
386 post("/media", MediaController, :create)
387 put("/media/:id", MediaController, :update)
389 delete("/lists/:id", ListController, :delete)
390 post("/lists", ListController, :create)
391 put("/lists/:id", ListController, :update)
393 post("/lists/:id/accounts", ListController, :add_to_list)
394 delete("/lists/:id/accounts", ListController, :remove_from_list)
396 post("/filters", FilterController, :create)
397 get("/filters/:id", FilterController, :show)
398 put("/filters/:id", FilterController, :update)
399 delete("/filters/:id", FilterController, :delete)
401 post("/reports", ReportController, :create)
403 post("/follows", AccountController, :follows)
404 post("/accounts/:id/follow", AccountController, :follow)
405 post("/accounts/:id/unfollow", AccountController, :unfollow)
406 post("/accounts/:id/block", AccountController, :block)
407 post("/accounts/:id/unblock", AccountController, :unblock)
408 post("/accounts/:id/mute", AccountController, :mute)
409 post("/accounts/:id/unmute", AccountController, :unmute)
411 post("/follow_requests/:id/authorize", FollowRequestController, :authorize)
412 post("/follow_requests/:id/reject", FollowRequestController, :reject)
414 post("/domain_blocks", DomainBlockController, :create)
415 delete("/domain_blocks", DomainBlockController, :delete)
417 post("/push/subscription", SubscriptionController, :create)
418 get("/push/subscription", SubscriptionController, :get)
419 put("/push/subscription", SubscriptionController, :update)
420 delete("/push/subscription", SubscriptionController, :delete)
422 get("/markers", MarkerController, :index)
423 post("/markers", MarkerController, :upsert)
426 scope "/api/web", Pleroma.Web do
427 pipe_through(:authenticated_api)
429 put("/settings", MastoFEController, :put_settings)
432 scope "/api/v1", Pleroma.Web.MastodonAPI do
435 post("/accounts", AccountController, :create)
436 get("/accounts/search", SearchController, :account_search)
438 get("/instance", InstanceController, :show)
439 get("/instance/peers", InstanceController, :peers)
441 post("/apps", AppController, :create)
442 get("/apps/verify_credentials", AppController, :verify_credentials)
444 get("/statuses/:id/card", StatusController, :card)
445 get("/statuses/:id/favourited_by", StatusController, :favourited_by)
446 get("/statuses/:id/reblogged_by", StatusController, :reblogged_by)
448 get("/custom_emojis", CustomEmojiController, :index)
450 get("/trends", MastodonAPIController, :empty_array)
452 get("/timelines/public", TimelineController, :public)
453 get("/timelines/tag/:tag", TimelineController, :hashtag)
454 get("/timelines/list/:list_id", TimelineController, :list)
456 get("/statuses", StatusController, :index)
457 get("/statuses/:id", StatusController, :show)
458 get("/statuses/:id/context", StatusController, :context)
460 get("/polls/:id", PollController, :show)
462 get("/accounts/:id/statuses", AccountController, :statuses)
463 get("/accounts/:id/followers", AccountController, :followers)
464 get("/accounts/:id/following", AccountController, :following)
465 get("/accounts/:id", AccountController, :show)
467 get("/search", SearchController, :search)
470 scope "/api/v2", Pleroma.Web.MastodonAPI do
472 get("/search", SearchController, :search2)
475 scope "/api", Pleroma.Web do
476 pipe_through(:config)
478 get("/help/test", TwitterAPI.UtilController, :help_test)
479 post("/help/test", TwitterAPI.UtilController, :help_test)
480 get("/statusnet/config", TwitterAPI.UtilController, :config)
481 get("/statusnet/version", TwitterAPI.UtilController, :version)
482 get("/pleroma/frontend_configurations", TwitterAPI.UtilController, :frontend_configurations)
485 scope "/api", Pleroma.Web do
489 "/account/confirm_email/:user_id/:token",
490 TwitterAPI.Controller,
496 scope "/api", Pleroma.Web, as: :authenticated_twitter_api do
497 pipe_through(:authenticated_api)
499 get("/oauth_tokens", TwitterAPI.Controller, :oauth_tokens)
500 delete("/oauth_tokens/:id", TwitterAPI.Controller, :revoke_token)
502 post("/qvitter/statuses/notifications/read", TwitterAPI.Controller, :notifications_read)
505 pipeline :ap_service_actor do
506 plug(:accepts, ["activity+json", "json"])
510 plug(:accepts, ["html", "xml", "atom", "activity+json", "json"])
511 plug(Pleroma.Plugs.StaticFEPlug)
515 plug(:accepts, ["json", "xml"])
518 scope "/", Pleroma.Web do
519 pipe_through(:ostatus)
520 pipe_through(:http_signature)
522 get("/objects/:uuid", OStatus.OStatusController, :object)
523 get("/activities/:uuid", OStatus.OStatusController, :activity)
524 get("/notice/:id", OStatus.OStatusController, :notice)
525 get("/notice/:id/embed_player", OStatus.OStatusController, :notice_player)
527 get("/users/:nickname/feed", Feed.FeedController, :feed)
528 get("/users/:nickname", Feed.FeedController, :feed_redirect)
530 get("/mailer/unsubscribe/:token", Mailer.SubscriptionController, :unsubscribe)
533 pipeline :activitypub do
534 plug(:accepts, ["activity+json", "json"])
535 plug(Pleroma.Web.Plugs.HTTPSignaturePlug)
536 plug(Pleroma.Web.Plugs.MappedSignatureToIdentityPlug)
539 scope "/", Pleroma.Web.ActivityPub do
540 # XXX: not really ostatus
541 pipe_through(:ostatus)
543 get("/users/:nickname/outbox", ActivityPubController, :outbox)
546 pipeline :activitypub_client do
547 plug(:accepts, ["activity+json", "json"])
549 plug(Pleroma.Plugs.OAuthPlug)
550 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
551 plug(Pleroma.Plugs.UserFetcherPlug)
552 plug(Pleroma.Plugs.SessionAuthenticationPlug)
553 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
554 plug(Pleroma.Plugs.AuthenticationPlug)
555 plug(Pleroma.Plugs.UserEnabledPlug)
556 plug(Pleroma.Plugs.SetUserSessionIdPlug)
557 plug(Pleroma.Plugs.EnsureUserKeyPlug)
560 scope "/", Pleroma.Web.ActivityPub do
561 pipe_through([:activitypub_client])
563 get("/api/ap/whoami", ActivityPubController, :whoami)
564 get("/users/:nickname/inbox", ActivityPubController, :read_inbox)
566 post("/users/:nickname/outbox", ActivityPubController, :update_outbox)
567 post("/api/ap/upload_media", ActivityPubController, :upload_media)
569 get("/users/:nickname/followers", ActivityPubController, :followers)
570 get("/users/:nickname/following", ActivityPubController, :following)
573 scope "/", Pleroma.Web.ActivityPub do
574 pipe_through(:activitypub)
575 post("/inbox", ActivityPubController, :inbox)
576 post("/users/:nickname/inbox", ActivityPubController, :inbox)
579 scope "/relay", Pleroma.Web.ActivityPub do
580 pipe_through(:ap_service_actor)
582 get("/", ActivityPubController, :relay)
585 pipe_through(:http_signature)
586 post("/inbox", ActivityPubController, :inbox)
589 get("/following", ActivityPubController, :following, assigns: %{relay: true})
590 get("/followers", ActivityPubController, :followers, assigns: %{relay: true})
593 scope "/internal/fetch", Pleroma.Web.ActivityPub do
594 pipe_through(:ap_service_actor)
596 get("/", ActivityPubController, :internal_fetch)
597 post("/inbox", ActivityPubController, :inbox)
600 scope "/.well-known", Pleroma.Web do
601 pipe_through(:well_known)
603 get("/host-meta", WebFinger.WebFingerController, :host_meta)
604 get("/webfinger", WebFinger.WebFingerController, :webfinger)
605 get("/nodeinfo", Nodeinfo.NodeinfoController, :schemas)
608 scope "/nodeinfo", Pleroma.Web do
609 get("/:version", Nodeinfo.NodeinfoController, :nodeinfo)
612 scope "/", Pleroma.Web do
615 get("/web/manifest.json", MastoFEController, :manifest)
618 scope "/", Pleroma.Web do
619 pipe_through(:mastodon_html)
621 get("/web/login", MastodonAPI.AuthController, :login)
622 delete("/auth/sign_out", MastodonAPI.AuthController, :logout)
624 post("/auth/password", MastodonAPI.AuthController, :password_reset)
626 get("/web/*path", MastoFEController, :index)
629 pipeline :remote_media do
632 scope "/proxy/", Pleroma.Web.MediaProxy do
633 pipe_through(:remote_media)
635 get("/:sig/:url", MediaProxyController, :remote)
636 get("/:sig/:url/:filename", MediaProxyController, :remote)
639 if Pleroma.Config.get(:env) == :dev do
641 pipe_through([:mailbox_preview])
643 forward("/mailbox", Plug.Swoosh.MailboxPreview, base_path: "/dev/mailbox")
647 scope "/", Pleroma.Web.MongooseIM do
648 get("/user_exists", MongooseIMController, :user_exists)
649 get("/check_password", MongooseIMController, :check_password)
652 scope "/", Fallback do
653 get("/registration/:token", RedirectController, :registration_page)
654 get("/:maybe_nickname_or_id", RedirectController, :redirector_with_meta)
655 get("/api*path", RedirectController, :api_not_implemented)
656 get("/*path", RedirectController, :redirector)
658 options("/*path", RedirectController, :empty)