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 get("/instances/:instance/statuses", AdminAPIController, :list_instance_statuses)
183 patch("/users/confirm_email", AdminAPIController, :confirm_email)
184 patch("/users/resend_confirmation_email", AdminAPIController, :resend_confirmation_email)
186 get("/reports", AdminAPIController, :list_reports)
187 get("/grouped_reports", AdminAPIController, :list_grouped_reports)
188 get("/reports/:id", AdminAPIController, :report_show)
189 patch("/reports", AdminAPIController, :reports_update)
190 post("/reports/:id/notes", AdminAPIController, :report_notes_create)
191 delete("/reports/:report_id/notes/:id", AdminAPIController, :report_notes_delete)
193 put("/statuses/:id", AdminAPIController, :status_update)
194 delete("/statuses/:id", AdminAPIController, :status_delete)
196 get("/config", AdminAPIController, :config_show)
197 post("/config", AdminAPIController, :config_update)
198 get("/config/migrate_to_db", AdminAPIController, :migrate_to_db)
199 get("/config/migrate_from_db", AdminAPIController, :migrate_from_db)
201 get("/moderation_log", AdminAPIController, :list_log)
203 post("/reload_emoji", AdminAPIController, :reload_emoji)
206 scope "/api/pleroma/emoji", Pleroma.Web.PleromaAPI do
209 pipe_through(:admin_api)
211 post("/import_from_fs", EmojiAPIController, :import_from_fs)
213 post("/:pack_name/update_file", EmojiAPIController, :update_file)
214 post("/:pack_name/update_metadata", EmojiAPIController, :update_metadata)
215 put("/:name", EmojiAPIController, :create)
216 delete("/:name", EmojiAPIController, :delete)
217 post("/download_from", EmojiAPIController, :download_from)
218 post("/list_from", EmojiAPIController, :list_from)
222 # Pack info / downloading
223 get("/", EmojiAPIController, :list_packs)
224 get("/:name/download_shared/", EmojiAPIController, :download_shared)
228 scope "/", Pleroma.Web.TwitterAPI do
229 pipe_through(:pleroma_html)
231 post("/main/ostatus", UtilController, :remote_subscribe)
232 get("/ostatus_subscribe", UtilController, :remote_follow)
234 post("/ostatus_subscribe", UtilController, :do_remote_follow)
237 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
238 pipe_through(:authenticated_api)
240 post("/change_email", UtilController, :change_email)
241 post("/change_password", UtilController, :change_password)
242 post("/delete_account", UtilController, :delete_account)
243 put("/notification_settings", UtilController, :update_notificaton_settings)
244 post("/disable_account", UtilController, :disable_account)
246 post("/blocks_import", UtilController, :blocks_import)
247 post("/follow_import", UtilController, :follow_import)
250 scope "/oauth", Pleroma.Web.OAuth do
253 get("/authorize", OAuthController, :authorize)
256 post("/authorize", OAuthController, :create_authorization)
257 post("/token", OAuthController, :token_exchange)
258 post("/revoke", OAuthController, :token_revoke)
259 get("/registration_details", OAuthController, :registration_details)
262 pipe_through(:browser)
264 get("/prepare_request", OAuthController, :prepare_request)
265 get("/:provider", OAuthController, :request)
266 get("/:provider/callback", OAuthController, :callback)
267 post("/register", OAuthController, :register)
271 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
274 get("/statuses/:id/emoji_reactions_by", PleromaAPIController, :emoji_reactions_by)
277 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
279 pipe_through(:authenticated_api)
281 get("/conversations/:id/statuses", PleromaAPIController, :conversation_statuses)
282 get("/conversations/:id", PleromaAPIController, :conversation)
283 post("/conversations/read", PleromaAPIController, :read_conversations)
287 pipe_through(:authenticated_api)
289 patch("/conversations/:id", PleromaAPIController, :update_conversation)
290 post("/statuses/:id/react_with_emoji", PleromaAPIController, :react_with_emoji)
291 post("/statuses/:id/unreact_with_emoji", PleromaAPIController, :unreact_with_emoji)
292 post("/notifications/read", PleromaAPIController, :read_notification)
294 patch("/accounts/update_avatar", AccountController, :update_avatar)
295 patch("/accounts/update_banner", AccountController, :update_banner)
296 patch("/accounts/update_background", AccountController, :update_background)
298 get("/mascot", MascotController, :show)
299 put("/mascot", MascotController, :update)
301 post("/scrobble", ScrobbleController, :new_scrobble)
306 get("/accounts/:id/favourites", AccountController, :favourites)
310 pipe_through(:authenticated_api)
312 post("/accounts/:id/subscribe", AccountController, :subscribe)
313 post("/accounts/:id/unsubscribe", AccountController, :unsubscribe)
316 post("/accounts/confirmation_resend", AccountController, :confirmation_resend)
319 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
321 get("/accounts/:id/scrobbles", ScrobbleController, :user_scrobbles)
324 scope "/api/v1", Pleroma.Web.MastodonAPI do
325 pipe_through(:authenticated_api)
327 get("/accounts/verify_credentials", AccountController, :verify_credentials)
329 get("/accounts/relationships", AccountController, :relationships)
331 get("/accounts/:id/lists", AccountController, :lists)
332 get("/accounts/:id/identity_proofs", MastodonAPIController, :empty_array)
334 get("/follow_requests", FollowRequestController, :index)
335 get("/blocks", AccountController, :blocks)
336 get("/mutes", AccountController, :mutes)
338 get("/timelines/home", TimelineController, :home)
339 get("/timelines/direct", TimelineController, :direct)
341 get("/favourites", StatusController, :favourites)
342 get("/bookmarks", StatusController, :bookmarks)
344 get("/notifications", NotificationController, :index)
345 get("/notifications/:id", NotificationController, :show)
346 post("/notifications/clear", NotificationController, :clear)
347 post("/notifications/dismiss", NotificationController, :dismiss)
348 delete("/notifications/destroy_multiple", NotificationController, :destroy_multiple)
350 get("/scheduled_statuses", ScheduledActivityController, :index)
351 get("/scheduled_statuses/:id", ScheduledActivityController, :show)
353 get("/lists", ListController, :index)
354 get("/lists/:id", ListController, :show)
355 get("/lists/:id/accounts", ListController, :list_accounts)
357 get("/domain_blocks", DomainBlockController, :index)
359 get("/filters", FilterController, :index)
361 get("/suggestions", SuggestionController, :index)
363 get("/conversations", ConversationController, :index)
364 post("/conversations/:id/read", ConversationController, :read)
366 get("/endorsements", AccountController, :endorsements)
368 patch("/accounts/update_credentials", AccountController, :update_credentials)
370 post("/statuses", StatusController, :create)
371 delete("/statuses/:id", StatusController, :delete)
373 post("/statuses/:id/reblog", StatusController, :reblog)
374 post("/statuses/:id/unreblog", StatusController, :unreblog)
375 post("/statuses/:id/favourite", StatusController, :favourite)
376 post("/statuses/:id/unfavourite", StatusController, :unfavourite)
377 post("/statuses/:id/pin", StatusController, :pin)
378 post("/statuses/:id/unpin", StatusController, :unpin)
379 post("/statuses/:id/bookmark", StatusController, :bookmark)
380 post("/statuses/:id/unbookmark", StatusController, :unbookmark)
381 post("/statuses/:id/mute", StatusController, :mute_conversation)
382 post("/statuses/:id/unmute", StatusController, :unmute_conversation)
384 put("/scheduled_statuses/:id", ScheduledActivityController, :update)
385 delete("/scheduled_statuses/:id", ScheduledActivityController, :delete)
387 post("/polls/:id/votes", PollController, :vote)
389 post("/media", MediaController, :create)
390 put("/media/:id", MediaController, :update)
392 delete("/lists/:id", ListController, :delete)
393 post("/lists", ListController, :create)
394 put("/lists/:id", ListController, :update)
396 post("/lists/:id/accounts", ListController, :add_to_list)
397 delete("/lists/:id/accounts", ListController, :remove_from_list)
399 post("/filters", FilterController, :create)
400 get("/filters/:id", FilterController, :show)
401 put("/filters/:id", FilterController, :update)
402 delete("/filters/:id", FilterController, :delete)
404 post("/reports", ReportController, :create)
406 post("/follows", AccountController, :follows)
407 post("/accounts/:id/follow", AccountController, :follow)
408 post("/accounts/:id/unfollow", AccountController, :unfollow)
409 post("/accounts/:id/block", AccountController, :block)
410 post("/accounts/:id/unblock", AccountController, :unblock)
411 post("/accounts/:id/mute", AccountController, :mute)
412 post("/accounts/:id/unmute", AccountController, :unmute)
414 post("/follow_requests/:id/authorize", FollowRequestController, :authorize)
415 post("/follow_requests/:id/reject", FollowRequestController, :reject)
417 post("/domain_blocks", DomainBlockController, :create)
418 delete("/domain_blocks", DomainBlockController, :delete)
420 post("/push/subscription", SubscriptionController, :create)
421 get("/push/subscription", SubscriptionController, :get)
422 put("/push/subscription", SubscriptionController, :update)
423 delete("/push/subscription", SubscriptionController, :delete)
425 get("/markers", MarkerController, :index)
426 post("/markers", MarkerController, :upsert)
429 scope "/api/web", Pleroma.Web do
430 pipe_through(:authenticated_api)
432 put("/settings", MastoFEController, :put_settings)
435 scope "/api/v1", Pleroma.Web.MastodonAPI do
438 post("/accounts", AccountController, :create)
439 get("/accounts/search", SearchController, :account_search)
441 get("/instance", InstanceController, :show)
442 get("/instance/peers", InstanceController, :peers)
444 post("/apps", AppController, :create)
445 get("/apps/verify_credentials", AppController, :verify_credentials)
447 get("/statuses/:id/card", StatusController, :card)
448 get("/statuses/:id/favourited_by", StatusController, :favourited_by)
449 get("/statuses/:id/reblogged_by", StatusController, :reblogged_by)
451 get("/custom_emojis", CustomEmojiController, :index)
453 get("/trends", MastodonAPIController, :empty_array)
455 get("/timelines/public", TimelineController, :public)
456 get("/timelines/tag/:tag", TimelineController, :hashtag)
457 get("/timelines/list/:list_id", TimelineController, :list)
459 get("/statuses", StatusController, :index)
460 get("/statuses/:id", StatusController, :show)
461 get("/statuses/:id/context", StatusController, :context)
463 get("/polls/:id", PollController, :show)
465 get("/accounts/:id/statuses", AccountController, :statuses)
466 get("/accounts/:id/followers", AccountController, :followers)
467 get("/accounts/:id/following", AccountController, :following)
468 get("/accounts/:id", AccountController, :show)
470 get("/search", SearchController, :search)
473 scope "/api/v2", Pleroma.Web.MastodonAPI do
475 get("/search", SearchController, :search2)
478 scope "/api", Pleroma.Web do
479 pipe_through(:config)
481 get("/help/test", TwitterAPI.UtilController, :help_test)
482 post("/help/test", TwitterAPI.UtilController, :help_test)
483 get("/statusnet/config", TwitterAPI.UtilController, :config)
484 get("/statusnet/version", TwitterAPI.UtilController, :version)
485 get("/pleroma/frontend_configurations", TwitterAPI.UtilController, :frontend_configurations)
488 scope "/api", Pleroma.Web do
492 "/account/confirm_email/:user_id/:token",
493 TwitterAPI.Controller,
499 scope "/api", Pleroma.Web, as: :authenticated_twitter_api do
500 pipe_through(:authenticated_api)
502 get("/oauth_tokens", TwitterAPI.Controller, :oauth_tokens)
503 delete("/oauth_tokens/:id", TwitterAPI.Controller, :revoke_token)
505 post("/qvitter/statuses/notifications/read", TwitterAPI.Controller, :notifications_read)
508 pipeline :ap_service_actor do
509 plug(:accepts, ["activity+json", "json"])
513 plug(:accepts, ["html", "xml", "atom", "activity+json", "json"])
514 plug(Pleroma.Plugs.StaticFEPlug)
518 plug(:accepts, ["json", "xml"])
521 scope "/", Pleroma.Web do
522 pipe_through(:ostatus)
523 pipe_through(:http_signature)
525 get("/objects/:uuid", OStatus.OStatusController, :object)
526 get("/activities/:uuid", OStatus.OStatusController, :activity)
527 get("/notice/:id", OStatus.OStatusController, :notice)
528 get("/notice/:id/embed_player", OStatus.OStatusController, :notice_player)
530 get("/users/:nickname/feed", Feed.FeedController, :feed)
531 get("/users/:nickname", Feed.FeedController, :feed_redirect)
534 scope "/", Pleroma.Web do
535 pipe_through(:browser)
536 get("/mailer/unsubscribe/:token", Mailer.SubscriptionController, :unsubscribe)
539 pipeline :activitypub do
540 plug(:accepts, ["activity+json", "json"])
541 plug(Pleroma.Web.Plugs.HTTPSignaturePlug)
542 plug(Pleroma.Web.Plugs.MappedSignatureToIdentityPlug)
545 scope "/", Pleroma.Web.ActivityPub do
546 # XXX: not really ostatus
547 pipe_through(:ostatus)
549 get("/users/:nickname/outbox", ActivityPubController, :outbox)
552 pipeline :activitypub_client do
553 plug(:accepts, ["activity+json", "json"])
555 plug(Pleroma.Plugs.OAuthPlug)
556 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
557 plug(Pleroma.Plugs.UserFetcherPlug)
558 plug(Pleroma.Plugs.SessionAuthenticationPlug)
559 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
560 plug(Pleroma.Plugs.AuthenticationPlug)
561 plug(Pleroma.Plugs.UserEnabledPlug)
562 plug(Pleroma.Plugs.SetUserSessionIdPlug)
563 plug(Pleroma.Plugs.EnsureUserKeyPlug)
566 scope "/", Pleroma.Web.ActivityPub do
567 pipe_through([:activitypub_client])
569 get("/api/ap/whoami", ActivityPubController, :whoami)
570 get("/users/:nickname/inbox", ActivityPubController, :read_inbox)
572 post("/users/:nickname/outbox", ActivityPubController, :update_outbox)
573 post("/api/ap/upload_media", ActivityPubController, :upload_media)
575 get("/users/:nickname/followers", ActivityPubController, :followers)
576 get("/users/:nickname/following", ActivityPubController, :following)
579 scope "/", Pleroma.Web.ActivityPub do
580 pipe_through(:activitypub)
581 post("/inbox", ActivityPubController, :inbox)
582 post("/users/:nickname/inbox", ActivityPubController, :inbox)
585 scope "/relay", Pleroma.Web.ActivityPub do
586 pipe_through(:ap_service_actor)
588 get("/", ActivityPubController, :relay)
591 pipe_through(:http_signature)
592 post("/inbox", ActivityPubController, :inbox)
595 get("/following", ActivityPubController, :following, assigns: %{relay: true})
596 get("/followers", ActivityPubController, :followers, assigns: %{relay: true})
599 scope "/internal/fetch", Pleroma.Web.ActivityPub do
600 pipe_through(:ap_service_actor)
602 get("/", ActivityPubController, :internal_fetch)
603 post("/inbox", ActivityPubController, :inbox)
606 scope "/.well-known", Pleroma.Web do
607 pipe_through(:well_known)
609 get("/host-meta", WebFinger.WebFingerController, :host_meta)
610 get("/webfinger", WebFinger.WebFingerController, :webfinger)
611 get("/nodeinfo", Nodeinfo.NodeinfoController, :schemas)
614 scope "/nodeinfo", Pleroma.Web do
615 get("/:version", Nodeinfo.NodeinfoController, :nodeinfo)
618 scope "/", Pleroma.Web do
621 get("/web/manifest.json", MastoFEController, :manifest)
624 scope "/", Pleroma.Web do
625 pipe_through(:mastodon_html)
627 get("/web/login", MastodonAPI.AuthController, :login)
628 delete("/auth/sign_out", MastodonAPI.AuthController, :logout)
630 post("/auth/password", MastodonAPI.AuthController, :password_reset)
632 get("/web/*path", MastoFEController, :index)
635 pipeline :remote_media do
638 scope "/proxy/", Pleroma.Web.MediaProxy do
639 pipe_through(:remote_media)
641 get("/:sig/:url", MediaProxyController, :remote)
642 get("/:sig/:url/:filename", MediaProxyController, :remote)
645 if Pleroma.Config.get(:env) == :dev do
647 pipe_through([:mailbox_preview])
649 forward("/mailbox", Plug.Swoosh.MailboxPreview, base_path: "/dev/mailbox")
653 scope "/", Pleroma.Web.MongooseIM do
654 get("/user_exists", MongooseIMController, :user_exists)
655 get("/check_password", MongooseIMController, :check_password)
658 scope "/", Fallback do
659 get("/registration/:token", RedirectController, :registration_page)
660 get("/:maybe_nickname_or_id", RedirectController, :redirector_with_meta)
661 get("/api*path", RedirectController, :api_not_implemented)
662 get("/*path", RedirectController, :redirector)
664 options("/*path", RedirectController, :empty)