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, ["json"])
11 plug(Pleroma.Plugs.OAuthPlug)
12 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
13 plug(Pleroma.Plugs.UserFetcherPlug)
14 plug(Pleroma.Plugs.SessionAuthenticationPlug)
15 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
16 plug(Pleroma.Plugs.AuthenticationPlug)
17 plug(Pleroma.Plugs.UserEnabledPlug)
18 plug(Pleroma.Plugs.SetUserSessionIdPlug)
19 plug(Pleroma.Plugs.EnsureUserKeyPlug)
22 pipeline :authenticated_api do
23 plug(:accepts, ["json"])
25 plug(Pleroma.Plugs.OAuthPlug)
26 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
27 plug(Pleroma.Plugs.UserFetcherPlug)
28 plug(Pleroma.Plugs.SessionAuthenticationPlug)
29 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
30 plug(Pleroma.Plugs.AuthenticationPlug)
31 plug(Pleroma.Plugs.UserEnabledPlug)
32 plug(Pleroma.Plugs.SetUserSessionIdPlug)
33 plug(Pleroma.Plugs.EnsureAuthenticatedPlug)
36 pipeline :admin_api do
37 plug(:accepts, ["json"])
39 plug(Pleroma.Plugs.OAuthPlug)
40 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
41 plug(Pleroma.Plugs.UserFetcherPlug)
42 plug(Pleroma.Plugs.SessionAuthenticationPlug)
43 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
44 plug(Pleroma.Plugs.AuthenticationPlug)
45 plug(Pleroma.Plugs.AdminSecretAuthenticationPlug)
46 plug(Pleroma.Plugs.UserEnabledPlug)
47 plug(Pleroma.Plugs.SetUserSessionIdPlug)
48 plug(Pleroma.Plugs.EnsureAuthenticatedPlug)
49 plug(Pleroma.Plugs.UserIsAdminPlug)
52 pipeline :mastodon_html do
53 plug(:accepts, ["html"])
55 plug(Pleroma.Plugs.OAuthPlug)
56 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
57 plug(Pleroma.Plugs.UserFetcherPlug)
58 plug(Pleroma.Plugs.SessionAuthenticationPlug)
59 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
60 plug(Pleroma.Plugs.AuthenticationPlug)
61 plug(Pleroma.Plugs.UserEnabledPlug)
62 plug(Pleroma.Plugs.SetUserSessionIdPlug)
63 plug(Pleroma.Plugs.EnsureUserKeyPlug)
66 pipeline :pleroma_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.AuthenticationPlug)
74 plug(Pleroma.Plugs.EnsureUserKeyPlug)
77 pipeline :well_known do
78 plug(:accepts, ["json", "jrd+json", "xml", "xrd+xml"])
82 plug(:accepts, ["json", "xml"])
86 plug(:accepts, ["html", "json"])
89 pipeline :pleroma_api do
90 plug(:accepts, ["html", "json"])
93 pipeline :mailbox_preview do
94 plug(:accepts, ["html"])
96 plug(:put_secure_browser_headers, %{
97 "content-security-policy" =>
98 "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' 'unsafe-eval'"
102 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
103 pipe_through(:pleroma_api)
104 get("/password_reset/:token", UtilController, :show_password_reset)
105 post("/password_reset", UtilController, :password_reset)
106 get("/emoji", UtilController, :emoji)
107 get("/captcha", UtilController, :captcha)
110 scope "/api/pleroma", Pleroma.Web do
111 pipe_through(:pleroma_api)
112 post("/uploader_callback/:upload_path", UploaderController, :callback)
115 scope "/api/pleroma/admin", Pleroma.Web.AdminAPI do
116 pipe_through(:admin_api)
117 delete("/user", AdminAPIController, :user_delete)
118 post("/user", AdminAPIController, :user_create)
119 put("/users/tag", AdminAPIController, :tag_users)
120 delete("/users/tag", AdminAPIController, :untag_users)
122 get("/permission_group/:nickname", AdminAPIController, :right_get)
123 get("/permission_group/:nickname/:permission_group", AdminAPIController, :right_get)
124 post("/permission_group/:nickname/:permission_group", AdminAPIController, :right_add)
125 delete("/permission_group/:nickname/:permission_group", AdminAPIController, :right_delete)
127 post("/relay", AdminAPIController, :relay_follow)
128 delete("/relay", AdminAPIController, :relay_unfollow)
130 get("/invite_token", AdminAPIController, :get_invite_token)
131 post("/email_invite", AdminAPIController, :email_invite)
133 get("/password_reset", AdminAPIController, :get_password_reset)
136 scope "/", Pleroma.Web.TwitterAPI do
137 pipe_through(:pleroma_html)
138 get("/ostatus_subscribe", UtilController, :remote_follow)
139 post("/ostatus_subscribe", UtilController, :do_remote_follow)
140 post("/main/ostatus", UtilController, :remote_subscribe)
143 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
144 pipe_through(:authenticated_api)
145 post("/blocks_import", UtilController, :blocks_import)
146 post("/follow_import", UtilController, :follow_import)
147 post("/change_password", UtilController, :change_password)
148 post("/delete_account", UtilController, :delete_account)
151 scope "/oauth", Pleroma.Web.OAuth do
152 get("/authorize", OAuthController, :authorize)
153 post("/authorize", OAuthController, :create_authorization)
154 post("/token", OAuthController, :token_exchange)
155 post("/revoke", OAuthController, :token_revoke)
158 scope "/api/v1", Pleroma.Web.MastodonAPI do
159 pipe_through(:authenticated_api)
161 patch("/accounts/update_credentials", MastodonAPIController, :update_credentials)
162 get("/accounts/verify_credentials", MastodonAPIController, :verify_credentials)
163 get("/accounts/relationships", MastodonAPIController, :relationships)
164 get("/accounts/search", MastodonAPIController, :account_search)
165 post("/accounts/:id/follow", MastodonAPIController, :follow)
166 post("/accounts/:id/unfollow", MastodonAPIController, :unfollow)
167 post("/accounts/:id/block", MastodonAPIController, :block)
168 post("/accounts/:id/unblock", MastodonAPIController, :unblock)
169 post("/accounts/:id/mute", MastodonAPIController, :relationship_noop)
170 post("/accounts/:id/unmute", MastodonAPIController, :relationship_noop)
171 get("/accounts/:id/lists", MastodonAPIController, :account_lists)
173 get("/follow_requests", MastodonAPIController, :follow_requests)
174 post("/follow_requests/:id/authorize", MastodonAPIController, :authorize_follow_request)
175 post("/follow_requests/:id/reject", MastodonAPIController, :reject_follow_request)
177 post("/follows", MastodonAPIController, :follow)
179 get("/blocks", MastodonAPIController, :blocks)
181 get("/mutes", MastodonAPIController, :empty_array)
183 get("/timelines/home", MastodonAPIController, :home_timeline)
185 get("/timelines/direct", MastodonAPIController, :dm_timeline)
187 get("/favourites", MastodonAPIController, :favourites)
188 get("/bookmarks", MastodonAPIController, :bookmarks)
190 post("/statuses", MastodonAPIController, :post_status)
191 delete("/statuses/:id", MastodonAPIController, :delete_status)
193 post("/statuses/:id/reblog", MastodonAPIController, :reblog_status)
194 post("/statuses/:id/unreblog", MastodonAPIController, :unreblog_status)
195 post("/statuses/:id/favourite", MastodonAPIController, :fav_status)
196 post("/statuses/:id/unfavourite", MastodonAPIController, :unfav_status)
197 post("/statuses/:id/pin", MastodonAPIController, :pin_status)
198 post("/statuses/:id/unpin", MastodonAPIController, :unpin_status)
199 post("/statuses/:id/bookmark", MastodonAPIController, :bookmark_status)
200 post("/statuses/:id/unbookmark", MastodonAPIController, :unbookmark_status)
202 post("/notifications/clear", MastodonAPIController, :clear_notifications)
203 post("/notifications/dismiss", MastodonAPIController, :dismiss_notification)
204 get("/notifications", MastodonAPIController, :notifications)
205 get("/notifications/:id", MastodonAPIController, :get_notification)
207 post("/media", MastodonAPIController, :upload)
208 put("/media/:id", MastodonAPIController, :update_media)
210 get("/lists", MastodonAPIController, :get_lists)
211 get("/lists/:id", MastodonAPIController, :get_list)
212 delete("/lists/:id", MastodonAPIController, :delete_list)
213 post("/lists", MastodonAPIController, :create_list)
214 put("/lists/:id", MastodonAPIController, :rename_list)
215 get("/lists/:id/accounts", MastodonAPIController, :list_accounts)
216 post("/lists/:id/accounts", MastodonAPIController, :add_to_list)
217 delete("/lists/:id/accounts", MastodonAPIController, :remove_from_list)
219 get("/domain_blocks", MastodonAPIController, :domain_blocks)
220 post("/domain_blocks", MastodonAPIController, :block_domain)
221 delete("/domain_blocks", MastodonAPIController, :unblock_domain)
223 get("/filters", MastodonAPIController, :get_filters)
224 post("/filters", MastodonAPIController, :create_filter)
225 get("/filters/:id", MastodonAPIController, :get_filter)
226 put("/filters/:id", MastodonAPIController, :update_filter)
227 delete("/filters/:id", MastodonAPIController, :delete_filter)
229 post("/push/subscription", MastodonAPIController, :create_push_subscription)
230 get("/push/subscription", MastodonAPIController, :get_push_subscription)
231 put("/push/subscription", MastodonAPIController, :update_push_subscription)
232 delete("/push/subscription", MastodonAPIController, :delete_push_subscription)
234 get("/suggestions", MastodonAPIController, :suggestions)
236 get("/endorsements", MastodonAPIController, :empty_array)
239 scope "/api/web", Pleroma.Web.MastodonAPI do
240 pipe_through(:authenticated_api)
242 put("/settings", MastodonAPIController, :put_settings)
245 scope "/api/v1", Pleroma.Web.MastodonAPI do
247 get("/instance", MastodonAPIController, :masto_instance)
248 get("/instance/peers", MastodonAPIController, :peers)
249 post("/apps", MastodonAPIController, :create_app)
250 get("/custom_emojis", MastodonAPIController, :custom_emojis)
252 get("/timelines/public", MastodonAPIController, :public_timeline)
253 get("/timelines/tag/:tag", MastodonAPIController, :hashtag_timeline)
254 get("/timelines/list/:list_id", MastodonAPIController, :list_timeline)
256 get("/statuses/:id", MastodonAPIController, :get_status)
257 get("/statuses/:id/context", MastodonAPIController, :get_context)
258 get("/statuses/:id/card", MastodonAPIController, :status_card)
259 get("/statuses/:id/favourited_by", MastodonAPIController, :favourited_by)
260 get("/statuses/:id/reblogged_by", MastodonAPIController, :reblogged_by)
262 get("/accounts/:id/statuses", MastodonAPIController, :user_statuses)
263 get("/accounts/:id/followers", MastodonAPIController, :followers)
264 get("/accounts/:id/following", MastodonAPIController, :following)
265 get("/accounts/:id", MastodonAPIController, :user)
267 get("/trends", MastodonAPIController, :empty_array)
269 get("/search", MastodonAPIController, :search)
272 scope "/api/v2", Pleroma.Web.MastodonAPI do
274 get("/search", MastodonAPIController, :search2)
277 scope "/api", Pleroma.Web do
278 pipe_through(:config)
280 get("/help/test", TwitterAPI.UtilController, :help_test)
281 post("/help/test", TwitterAPI.UtilController, :help_test)
282 get("/statusnet/config", TwitterAPI.UtilController, :config)
283 get("/statusnet/version", TwitterAPI.UtilController, :version)
284 get("/pleroma/frontend_configurations", TwitterAPI.UtilController, :frontend_configurations)
287 scope "/api", Pleroma.Web do
290 get("/statuses/user_timeline", TwitterAPI.Controller, :user_timeline)
291 get("/qvitter/statuses/user_timeline", TwitterAPI.Controller, :user_timeline)
292 get("/users/show", TwitterAPI.Controller, :show_user)
294 get("/statuses/followers", TwitterAPI.Controller, :followers)
295 get("/statuses/friends", TwitterAPI.Controller, :friends)
296 get("/statuses/blocks", TwitterAPI.Controller, :blocks)
297 get("/statuses/show/:id", TwitterAPI.Controller, :fetch_status)
298 get("/statusnet/conversation/:id", TwitterAPI.Controller, :fetch_conversation)
300 post("/account/register", TwitterAPI.Controller, :register)
301 post("/account/password_reset", TwitterAPI.Controller, :password_reset)
304 "/account/confirm_email/:user_id/:token",
305 TwitterAPI.Controller,
310 post("/account/resend_confirmation_email", TwitterAPI.Controller, :resend_confirmation_email)
312 get("/search", TwitterAPI.Controller, :search)
313 get("/statusnet/tags/timeline/:tag", TwitterAPI.Controller, :public_and_external_timeline)
316 scope "/api", Pleroma.Web do
319 get("/statuses/public_timeline", TwitterAPI.Controller, :public_timeline)
322 "/statuses/public_and_external_timeline",
323 TwitterAPI.Controller,
324 :public_and_external_timeline
327 get("/statuses/networkpublic_timeline", TwitterAPI.Controller, :public_and_external_timeline)
330 scope "/api", Pleroma.Web, as: :twitter_api_search do
332 get("/pleroma/search_user", TwitterAPI.Controller, :search_user)
335 scope "/api", Pleroma.Web, as: :authenticated_twitter_api do
336 pipe_through(:authenticated_api)
338 get("/account/verify_credentials", TwitterAPI.Controller, :verify_credentials)
339 post("/account/verify_credentials", TwitterAPI.Controller, :verify_credentials)
341 post("/account/update_profile", TwitterAPI.Controller, :update_profile)
342 post("/account/update_profile_banner", TwitterAPI.Controller, :update_banner)
343 post("/qvitter/update_background_image", TwitterAPI.Controller, :update_background)
345 get("/statuses/home_timeline", TwitterAPI.Controller, :friends_timeline)
346 get("/statuses/friends_timeline", TwitterAPI.Controller, :friends_timeline)
347 get("/statuses/mentions", TwitterAPI.Controller, :mentions_timeline)
348 get("/statuses/mentions_timeline", TwitterAPI.Controller, :mentions_timeline)
349 get("/statuses/dm_timeline", TwitterAPI.Controller, :dm_timeline)
350 get("/qvitter/statuses/notifications", TwitterAPI.Controller, :notifications)
352 # XXX: this is really a pleroma API, but we want to keep the pleroma namespace clean
354 post("/qvitter/statuses/notifications/read", TwitterAPI.Controller, :notifications_read)
356 post("/statuses/update", TwitterAPI.Controller, :status_update)
357 post("/statuses/retweet/:id", TwitterAPI.Controller, :retweet)
358 post("/statuses/unretweet/:id", TwitterAPI.Controller, :unretweet)
359 post("/statuses/destroy/:id", TwitterAPI.Controller, :delete_post)
361 post("/statuses/pin/:id", TwitterAPI.Controller, :pin)
362 post("/statuses/unpin/:id", TwitterAPI.Controller, :unpin)
364 get("/pleroma/friend_requests", TwitterAPI.Controller, :friend_requests)
365 post("/pleroma/friendships/approve", TwitterAPI.Controller, :approve_friend_request)
366 post("/pleroma/friendships/deny", TwitterAPI.Controller, :deny_friend_request)
368 post("/friendships/create", TwitterAPI.Controller, :follow)
369 post("/friendships/destroy", TwitterAPI.Controller, :unfollow)
370 post("/blocks/create", TwitterAPI.Controller, :block)
371 post("/blocks/destroy", TwitterAPI.Controller, :unblock)
373 post("/statusnet/media/upload", TwitterAPI.Controller, :upload)
374 post("/media/upload", TwitterAPI.Controller, :upload_json)
375 post("/media/metadata/create", TwitterAPI.Controller, :update_media)
377 post("/favorites/create/:id", TwitterAPI.Controller, :favorite)
378 post("/favorites/create", TwitterAPI.Controller, :favorite)
379 post("/favorites/destroy/:id", TwitterAPI.Controller, :unfavorite)
381 post("/qvitter/update_avatar", TwitterAPI.Controller, :update_avatar)
383 get("/friends/ids", TwitterAPI.Controller, :friends_ids)
384 get("/friendships/no_retweets/ids", TwitterAPI.Controller, :empty_array)
386 get("/mutes/users/ids", TwitterAPI.Controller, :empty_array)
387 get("/qvitter/mutes", TwitterAPI.Controller, :raw_empty_array)
389 get("/externalprofile/show", TwitterAPI.Controller, :external_profile)
392 pipeline :ap_relay do
393 plug(:accepts, ["activity+json"])
397 plug(:accepts, ["html", "xml", "atom", "activity+json"])
401 plug(:accepts, ["json", "xml"])
404 scope "/", Pleroma.Web do
405 pipe_through(:ostatus)
407 get("/objects/:uuid", OStatus.OStatusController, :object)
408 get("/activities/:uuid", OStatus.OStatusController, :activity)
409 get("/notice/:id", OStatus.OStatusController, :notice)
410 get("/users/:nickname/feed", OStatus.OStatusController, :feed)
411 get("/users/:nickname", OStatus.OStatusController, :feed_redirect)
413 post("/users/:nickname/salmon", OStatus.OStatusController, :salmon_incoming)
414 post("/push/hub/:nickname", Websub.WebsubController, :websub_subscription_request)
415 get("/push/subscriptions/:id", Websub.WebsubController, :websub_subscription_confirmation)
416 post("/push/subscriptions/:id", Websub.WebsubController, :websub_incoming)
419 scope "/", Pleroma.Web do
420 pipe_through(:oembed)
422 get("/oembed", OEmbed.OEmbedController, :url)
425 pipeline :activitypub do
426 plug(:accepts, ["activity+json"])
427 plug(Pleroma.Web.Plugs.HTTPSignaturePlug)
430 scope "/", Pleroma.Web.ActivityPub do
431 # XXX: not really ostatus
432 pipe_through(:ostatus)
434 get("/users/:nickname/followers", ActivityPubController, :followers)
435 get("/users/:nickname/following", ActivityPubController, :following)
436 get("/users/:nickname/outbox", ActivityPubController, :outbox)
437 get("/objects/:uuid/likes", ActivityPubController, :object_likes)
440 pipeline :activitypub_client do
441 plug(:accepts, ["activity+json"])
443 plug(Pleroma.Plugs.OAuthPlug)
444 plug(Pleroma.Plugs.BasicAuthDecoderPlug)
445 plug(Pleroma.Plugs.UserFetcherPlug)
446 plug(Pleroma.Plugs.SessionAuthenticationPlug)
447 plug(Pleroma.Plugs.LegacyAuthenticationPlug)
448 plug(Pleroma.Plugs.AuthenticationPlug)
449 plug(Pleroma.Plugs.UserEnabledPlug)
450 plug(Pleroma.Plugs.SetUserSessionIdPlug)
451 plug(Pleroma.Plugs.EnsureUserKeyPlug)
454 scope "/", Pleroma.Web.ActivityPub do
455 pipe_through([:activitypub_client])
457 get("/users/:nickname/inbox", ActivityPubController, :read_inbox)
458 post("/users/:nickname/outbox", ActivityPubController, :update_outbox)
461 scope "/relay", Pleroma.Web.ActivityPub do
462 pipe_through(:ap_relay)
463 get("/", ActivityPubController, :relay)
466 scope "/", Pleroma.Web.ActivityPub do
467 pipe_through(:activitypub)
468 post("/users/:nickname/inbox", ActivityPubController, :inbox)
469 post("/inbox", ActivityPubController, :inbox)
472 scope "/.well-known", Pleroma.Web do
473 pipe_through(:well_known)
475 get("/host-meta", WebFinger.WebFingerController, :host_meta)
476 get("/webfinger", WebFinger.WebFingerController, :webfinger)
477 get("/nodeinfo", Nodeinfo.NodeinfoController, :schemas)
480 scope "/nodeinfo", Pleroma.Web do
481 get("/:version", Nodeinfo.NodeinfoController, :nodeinfo)
484 scope "/", Pleroma.Web.MastodonAPI do
485 pipe_through(:mastodon_html)
487 get("/web/login", MastodonAPIController, :login)
488 post("/web/login", MastodonAPIController, :login_post)
489 get("/web/*path", MastodonAPIController, :index)
490 delete("/auth/sign_out", MastodonAPIController, :logout)
493 pipeline :remote_media do
496 scope "/proxy/", Pleroma.Web.MediaProxy do
497 pipe_through(:remote_media)
498 get("/:sig/:url", MediaProxyController, :remote)
499 get("/:sig/:url/:filename", MediaProxyController, :remote)
502 if Mix.env() == :dev do
504 pipe_through([:mailbox_preview])
506 forward("/mailbox", Plug.Swoosh.MailboxPreview, base_path: "/dev/mailbox")
510 scope "/", Fallback do
511 get("/registration/:token", RedirectController, :registration_page)
512 get("/:maybe_nickname_or_id", RedirectController, :redirector_with_meta)
513 get("/*path", RedirectController, :redirector)
515 options("/*path", RedirectController, :empty)
519 defmodule Fallback.RedirectController do
520 use Pleroma.Web, :controller
521 alias Pleroma.Web.Metadata
524 def redirector(conn, _params, code \\ 200) do
526 |> put_resp_content_type("text/html")
527 |> send_file(code, index_file_path())
530 def redirector_with_meta(conn, %{"maybe_nickname_or_id" => maybe_nickname_or_id} = params) do
531 with %User{} = user <- User.get_cached_by_nickname_or_id(maybe_nickname_or_id) do
532 redirector_with_meta(conn, %{user: user})
535 redirector(conn, params)
539 def redirector_with_meta(conn, params) do
540 {:ok, index_content} = File.read(index_file_path())
541 tags = Metadata.build_tags(params)
542 response = String.replace(index_content, "<!--server-generated-meta-->", tags)
545 |> put_resp_content_type("text/html")
546 |> send_resp(200, response)
549 def index_file_path do
550 Pleroma.Plugs.InstanceStatic.file_path("index.html")
553 def registration_page(conn, params) do
554 redirector(conn, params)
557 def empty(conn, _params) do