1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2018 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/admin", Pleroma.Web.AdminAPI do
111 pipe_through(:admin_api)
112 delete("/user", AdminAPIController, :user_delete)
113 post("/user", AdminAPIController, :user_create)
114 put("/users/tag", AdminAPIController, :tag_users)
115 delete("/users/tag", AdminAPIController, :untag_users)
117 get("/permission_group/:nickname", AdminAPIController, :right_get)
118 get("/permission_group/:nickname/:permission_group", AdminAPIController, :right_get)
119 post("/permission_group/:nickname/:permission_group", AdminAPIController, :right_add)
120 delete("/permission_group/:nickname/:permission_group", AdminAPIController, :right_delete)
122 post("/relay", AdminAPIController, :relay_follow)
123 delete("/relay", AdminAPIController, :relay_unfollow)
125 get("/invite_token", AdminAPIController, :get_invite_token)
126 post("/email_invite", AdminAPIController, :email_invite)
128 get("/password_reset", AdminAPIController, :get_password_reset)
131 scope "/", Pleroma.Web.TwitterAPI do
132 pipe_through(:pleroma_html)
133 get("/ostatus_subscribe", UtilController, :remote_follow)
134 post("/ostatus_subscribe", UtilController, :do_remote_follow)
135 post("/main/ostatus", UtilController, :remote_subscribe)
138 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
139 pipe_through(:authenticated_api)
140 post("/follow_import", UtilController, :follow_import)
141 post("/change_password", UtilController, :change_password)
142 post("/delete_account", UtilController, :delete_account)
145 scope "/oauth", Pleroma.Web.OAuth do
146 get("/authorize", OAuthController, :authorize)
147 post("/authorize", OAuthController, :create_authorization)
148 post("/token", OAuthController, :token_exchange)
149 post("/revoke", OAuthController, :token_revoke)
152 scope "/api/v1", Pleroma.Web.MastodonAPI do
153 pipe_through(:authenticated_api)
155 patch("/accounts/update_credentials", MastodonAPIController, :update_credentials)
156 get("/accounts/verify_credentials", MastodonAPIController, :verify_credentials)
157 get("/accounts/relationships", MastodonAPIController, :relationships)
158 get("/accounts/search", MastodonAPIController, :account_search)
159 post("/accounts/:id/follow", MastodonAPIController, :follow)
160 post("/accounts/:id/unfollow", MastodonAPIController, :unfollow)
161 post("/accounts/:id/block", MastodonAPIController, :block)
162 post("/accounts/:id/unblock", MastodonAPIController, :unblock)
163 post("/accounts/:id/mute", MastodonAPIController, :relationship_noop)
164 post("/accounts/:id/unmute", MastodonAPIController, :relationship_noop)
165 get("/accounts/:id/lists", MastodonAPIController, :account_lists)
167 get("/follow_requests", MastodonAPIController, :follow_requests)
168 post("/follow_requests/:id/authorize", MastodonAPIController, :authorize_follow_request)
169 post("/follow_requests/:id/reject", MastodonAPIController, :reject_follow_request)
171 post("/follows", MastodonAPIController, :follow)
173 get("/blocks", MastodonAPIController, :blocks)
175 get("/mutes", MastodonAPIController, :empty_array)
177 get("/timelines/home", MastodonAPIController, :home_timeline)
179 get("/timelines/direct", MastodonAPIController, :dm_timeline)
181 get("/favourites", MastodonAPIController, :favourites)
183 post("/statuses", MastodonAPIController, :post_status)
184 delete("/statuses/:id", MastodonAPIController, :delete_status)
186 post("/statuses/:id/reblog", MastodonAPIController, :reblog_status)
187 post("/statuses/:id/unreblog", MastodonAPIController, :unreblog_status)
188 post("/statuses/:id/favourite", MastodonAPIController, :fav_status)
189 post("/statuses/:id/unfavourite", MastodonAPIController, :unfav_status)
191 post("/notifications/clear", MastodonAPIController, :clear_notifications)
192 post("/notifications/dismiss", MastodonAPIController, :dismiss_notification)
193 get("/notifications", MastodonAPIController, :notifications)
194 get("/notifications/:id", MastodonAPIController, :get_notification)
196 post("/media", MastodonAPIController, :upload)
197 put("/media/:id", MastodonAPIController, :update_media)
199 get("/lists", MastodonAPIController, :get_lists)
200 get("/lists/:id", MastodonAPIController, :get_list)
201 delete("/lists/:id", MastodonAPIController, :delete_list)
202 post("/lists", MastodonAPIController, :create_list)
203 put("/lists/:id", MastodonAPIController, :rename_list)
204 get("/lists/:id/accounts", MastodonAPIController, :list_accounts)
205 post("/lists/:id/accounts", MastodonAPIController, :add_to_list)
206 delete("/lists/:id/accounts", MastodonAPIController, :remove_from_list)
208 get("/domain_blocks", MastodonAPIController, :domain_blocks)
209 post("/domain_blocks", MastodonAPIController, :block_domain)
210 delete("/domain_blocks", MastodonAPIController, :unblock_domain)
212 get("/filters", MastodonAPIController, :get_filters)
213 post("/filters", MastodonAPIController, :create_filter)
214 get("/filters/:id", MastodonAPIController, :get_filter)
215 put("/filters/:id", MastodonAPIController, :update_filter)
216 delete("/filters/:id", MastodonAPIController, :delete_filter)
218 post("/push/subscription", MastodonAPIController, :create_push_subscription)
219 get("/push/subscription", MastodonAPIController, :get_push_subscription)
220 put("/push/subscription", MastodonAPIController, :update_push_subscription)
221 delete("/push/subscription", MastodonAPIController, :delete_push_subscription)
223 get("/suggestions", MastodonAPIController, :suggestions)
225 get("/endorsements", MastodonAPIController, :empty_array)
228 scope "/api/web", Pleroma.Web.MastodonAPI do
229 pipe_through(:authenticated_api)
231 put("/settings", MastodonAPIController, :put_settings)
234 scope "/api/v1", Pleroma.Web.MastodonAPI do
236 get("/instance", MastodonAPIController, :masto_instance)
237 get("/instance/peers", MastodonAPIController, :peers)
238 post("/apps", MastodonAPIController, :create_app)
239 get("/custom_emojis", MastodonAPIController, :custom_emojis)
241 get("/timelines/public", MastodonAPIController, :public_timeline)
242 get("/timelines/tag/:tag", MastodonAPIController, :hashtag_timeline)
243 get("/timelines/list/:list_id", MastodonAPIController, :list_timeline)
245 get("/statuses/:id", MastodonAPIController, :get_status)
246 get("/statuses/:id/context", MastodonAPIController, :get_context)
247 get("/statuses/:id/card", MastodonAPIController, :empty_object)
248 get("/statuses/:id/favourited_by", MastodonAPIController, :favourited_by)
249 get("/statuses/:id/reblogged_by", MastodonAPIController, :reblogged_by)
251 get("/accounts/:id/statuses", MastodonAPIController, :user_statuses)
252 get("/accounts/:id/followers", MastodonAPIController, :followers)
253 get("/accounts/:id/following", MastodonAPIController, :following)
254 get("/accounts/:id", MastodonAPIController, :user)
256 get("/trends", MastodonAPIController, :empty_array)
258 get("/search", MastodonAPIController, :search)
261 scope "/api/v2", Pleroma.Web.MastodonAPI do
263 get("/search", MastodonAPIController, :search2)
266 scope "/api", Pleroma.Web do
267 pipe_through(:config)
269 get("/help/test", TwitterAPI.UtilController, :help_test)
270 post("/help/test", TwitterAPI.UtilController, :help_test)
271 get("/statusnet/config", TwitterAPI.UtilController, :config)
272 get("/statusnet/version", TwitterAPI.UtilController, :version)
275 scope "/api", Pleroma.Web do
278 get("/statuses/user_timeline", TwitterAPI.Controller, :user_timeline)
279 get("/qvitter/statuses/user_timeline", TwitterAPI.Controller, :user_timeline)
280 get("/users/show", TwitterAPI.Controller, :show_user)
282 get("/statuses/followers", TwitterAPI.Controller, :followers)
283 get("/statuses/friends", TwitterAPI.Controller, :friends)
284 get("/statuses/show/:id", TwitterAPI.Controller, :fetch_status)
285 get("/statusnet/conversation/:id", TwitterAPI.Controller, :fetch_conversation)
287 post("/account/register", TwitterAPI.Controller, :register)
288 post("/account/password_reset", TwitterAPI.Controller, :password_reset)
291 "/account/confirm_email/:user_id/:token",
292 TwitterAPI.Controller,
297 post("/account/resend_confirmation_email", TwitterAPI.Controller, :resend_confirmation_email)
299 get("/search", TwitterAPI.Controller, :search)
300 get("/statusnet/tags/timeline/:tag", TwitterAPI.Controller, :public_and_external_timeline)
303 scope "/api", Pleroma.Web do
306 get("/statuses/public_timeline", TwitterAPI.Controller, :public_timeline)
309 "/statuses/public_and_external_timeline",
310 TwitterAPI.Controller,
311 :public_and_external_timeline
314 get("/statuses/networkpublic_timeline", TwitterAPI.Controller, :public_and_external_timeline)
317 scope "/api", Pleroma.Web, as: :twitter_api_search do
319 get("/pleroma/search_user", TwitterAPI.Controller, :search_user)
322 scope "/api", Pleroma.Web, as: :authenticated_twitter_api do
323 pipe_through(:authenticated_api)
325 get("/account/verify_credentials", TwitterAPI.Controller, :verify_credentials)
326 post("/account/verify_credentials", TwitterAPI.Controller, :verify_credentials)
328 post("/account/update_profile", TwitterAPI.Controller, :update_profile)
329 post("/account/update_profile_banner", TwitterAPI.Controller, :update_banner)
330 post("/qvitter/update_background_image", TwitterAPI.Controller, :update_background)
332 get("/statuses/home_timeline", TwitterAPI.Controller, :friends_timeline)
333 get("/statuses/friends_timeline", TwitterAPI.Controller, :friends_timeline)
334 get("/statuses/mentions", TwitterAPI.Controller, :mentions_timeline)
335 get("/statuses/mentions_timeline", TwitterAPI.Controller, :mentions_timeline)
336 get("/statuses/dm_timeline", TwitterAPI.Controller, :dm_timeline)
337 get("/qvitter/statuses/notifications", TwitterAPI.Controller, :notifications)
339 # XXX: this is really a pleroma API, but we want to keep the pleroma namespace clean
341 post("/qvitter/statuses/notifications/read", TwitterAPI.Controller, :notifications_read)
343 post("/statuses/update", TwitterAPI.Controller, :status_update)
344 post("/statuses/retweet/:id", TwitterAPI.Controller, :retweet)
345 post("/statuses/unretweet/:id", TwitterAPI.Controller, :unretweet)
346 post("/statuses/destroy/:id", TwitterAPI.Controller, :delete_post)
348 get("/pleroma/friend_requests", TwitterAPI.Controller, :friend_requests)
349 post("/pleroma/friendships/approve", TwitterAPI.Controller, :approve_friend_request)
350 post("/pleroma/friendships/deny", TwitterAPI.Controller, :deny_friend_request)
352 post("/friendships/create", TwitterAPI.Controller, :follow)
353 post("/friendships/destroy", TwitterAPI.Controller, :unfollow)
354 post("/blocks/create", TwitterAPI.Controller, :block)
355 post("/blocks/destroy", TwitterAPI.Controller, :unblock)
357 post("/statusnet/media/upload", TwitterAPI.Controller, :upload)
358 post("/media/upload", TwitterAPI.Controller, :upload_json)
359 post("/media/metadata/create", TwitterAPI.Controller, :update_media)
361 post("/favorites/create/:id", TwitterAPI.Controller, :favorite)
362 post("/favorites/create", TwitterAPI.Controller, :favorite)
363 post("/favorites/destroy/:id", TwitterAPI.Controller, :unfavorite)
365 post("/qvitter/update_avatar", TwitterAPI.Controller, :update_avatar)
367 get("/friends/ids", TwitterAPI.Controller, :friends_ids)
368 get("/friendships/no_retweets/ids", TwitterAPI.Controller, :empty_array)
370 get("/mutes/users/ids", TwitterAPI.Controller, :empty_array)
371 get("/qvitter/mutes", TwitterAPI.Controller, :raw_empty_array)
373 get("/externalprofile/show", TwitterAPI.Controller, :external_profile)
376 pipeline :ap_relay do
377 plug(:accepts, ["activity+json"])
381 plug(:accepts, ["xml", "atom", "html", "activity+json"])
384 scope "/", Pleroma.Web do
385 pipe_through(:ostatus)
387 get("/objects/:uuid", OStatus.OStatusController, :object)
388 get("/activities/:uuid", OStatus.OStatusController, :activity)
389 get("/notice/:id", OStatus.OStatusController, :notice)
390 get("/users/:nickname/feed", OStatus.OStatusController, :feed)
391 get("/users/:nickname", OStatus.OStatusController, :feed_redirect)
393 post("/users/:nickname/salmon", OStatus.OStatusController, :salmon_incoming)
394 post("/push/hub/:nickname", Websub.WebsubController, :websub_subscription_request)
395 get("/push/subscriptions/:id", Websub.WebsubController, :websub_subscription_confirmation)
396 post("/push/subscriptions/:id", Websub.WebsubController, :websub_incoming)
399 pipeline :activitypub do
400 plug(:accepts, ["activity+json"])
401 plug(Pleroma.Web.Plugs.HTTPSignaturePlug)
404 scope "/", Pleroma.Web.ActivityPub do
405 # XXX: not really ostatus
406 pipe_through(:ostatus)
408 get("/users/:nickname/followers", ActivityPubController, :followers)
409 get("/users/:nickname/following", ActivityPubController, :following)
410 get("/users/:nickname/outbox", ActivityPubController, :outbox)
413 scope "/relay", Pleroma.Web.ActivityPub do
414 pipe_through(:ap_relay)
415 get("/", ActivityPubController, :relay)
418 scope "/", Pleroma.Web.ActivityPub do
419 pipe_through(:activitypub)
420 post("/users/:nickname/inbox", ActivityPubController, :inbox)
421 post("/inbox", ActivityPubController, :inbox)
424 scope "/.well-known", Pleroma.Web do
425 pipe_through(:well_known)
427 get("/host-meta", WebFinger.WebFingerController, :host_meta)
428 get("/webfinger", WebFinger.WebFingerController, :webfinger)
429 get("/nodeinfo", Nodeinfo.NodeinfoController, :schemas)
432 scope "/nodeinfo", Pleroma.Web do
433 get("/:version", Nodeinfo.NodeinfoController, :nodeinfo)
436 scope "/", Pleroma.Web.MastodonAPI do
437 pipe_through(:mastodon_html)
439 get("/web/login", MastodonAPIController, :login)
440 post("/web/login", MastodonAPIController, :login_post)
441 get("/web/*path", MastodonAPIController, :index)
442 delete("/auth/sign_out", MastodonAPIController, :logout)
445 pipeline :remote_media do
448 scope "/proxy/", Pleroma.Web.MediaProxy do
449 pipe_through(:remote_media)
450 get("/:sig/:url", MediaProxyController, :remote)
451 get("/:sig/:url/:filename", MediaProxyController, :remote)
454 if Mix.env() == :dev do
456 pipe_through([:mailbox_preview])
458 forward("/mailbox", Plug.Swoosh.MailboxPreview, base_path: "/dev/mailbox")
462 scope "/", Fallback do
463 get("/registration/:token", RedirectController, :registration_page)
464 get("/*path", RedirectController, :redirector)
466 options("/*path", RedirectController, :empty)
470 defmodule Fallback.RedirectController do
471 use Pleroma.Web, :controller
473 def redirector(conn, _params) do
475 |> put_resp_content_type("text/html")
476 |> send_file(200, Pleroma.Plugs.InstanceStatic.file_path("index.html"))
479 def registration_page(conn, params) do
480 redirector(conn, params)
483 def empty(conn, _params) do