Merge branch 'add-nodeinfo-doc' into 'develop'
[akkoma] / lib / pleroma / web / router.ex
1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
4
5 defmodule Pleroma.Web.Router do
6 use Pleroma.Web, :router
7 import Phoenix.LiveDashboard.Router
8
9 pipeline :accepts_html do
10 plug(:accepts, ["html"])
11 end
12
13 pipeline :accepts_html_xml do
14 plug(:accepts, ["html", "xml", "rss", "atom"])
15 end
16
17 pipeline :accepts_html_json do
18 plug(:accepts, ["html", "activity+json", "json"])
19 end
20
21 pipeline :accepts_html_xml_json do
22 plug(:accepts, ["html", "xml", "rss", "atom", "activity+json", "json"])
23 end
24
25 pipeline :accepts_xml_rss_atom do
26 plug(:accepts, ["xml", "rss", "atom"])
27 end
28
29 pipeline :browser do
30 plug(:accepts, ["html"])
31 plug(:fetch_session)
32 end
33
34 pipeline :oauth do
35 plug(:fetch_session)
36 plug(Pleroma.Web.Plugs.OAuthPlug)
37 plug(Pleroma.Web.Plugs.UserEnabledPlug)
38 plug(Pleroma.Web.Plugs.EnsureUserTokenAssignsPlug)
39 end
40
41 # Note: expects _user_ authentication (user-unbound app-bound tokens don't qualify)
42 pipeline :expect_user_authentication do
43 plug(Pleroma.Web.Plugs.ExpectAuthenticatedCheckPlug)
44 end
45
46 # Note: expects public instance or _user_ authentication (user-unbound tokens don't qualify)
47 pipeline :expect_public_instance_or_user_authentication do
48 plug(Pleroma.Web.Plugs.ExpectPublicOrAuthenticatedCheckPlug)
49 end
50
51 pipeline :authenticate do
52 plug(Pleroma.Web.Plugs.OAuthPlug)
53 plug(Pleroma.Web.Plugs.BasicAuthDecoderPlug)
54 plug(Pleroma.Web.Plugs.UserFetcherPlug)
55 plug(Pleroma.Web.Plugs.AuthenticationPlug)
56 end
57
58 pipeline :after_auth do
59 plug(Pleroma.Web.Plugs.UserEnabledPlug)
60 plug(Pleroma.Web.Plugs.SetUserSessionIdPlug)
61 plug(Pleroma.Web.Plugs.EnsureUserTokenAssignsPlug)
62 plug(Pleroma.Web.Plugs.UserTrackingPlug)
63 end
64
65 pipeline :base_api do
66 plug(:accepts, ["json"])
67 plug(:fetch_session)
68 plug(:authenticate)
69 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
70 end
71
72 pipeline :no_auth_or_privacy_expectations_api do
73 plug(:base_api)
74 plug(:after_auth)
75 plug(Pleroma.Web.Plugs.IdempotencyPlug)
76 end
77
78 # Pipeline for app-related endpoints (no user auth checks — app-bound tokens must be supported)
79 pipeline :app_api do
80 plug(:no_auth_or_privacy_expectations_api)
81 end
82
83 pipeline :api do
84 plug(:expect_public_instance_or_user_authentication)
85 plug(:no_auth_or_privacy_expectations_api)
86 end
87
88 pipeline :authenticated_api do
89 plug(:expect_user_authentication)
90 plug(:no_auth_or_privacy_expectations_api)
91 plug(Pleroma.Web.Plugs.EnsureAuthenticatedPlug)
92 end
93
94 pipeline :admin_api do
95 plug(:expect_user_authentication)
96 plug(:base_api)
97 plug(Pleroma.Web.Plugs.AdminSecretAuthenticationPlug)
98 plug(:after_auth)
99 plug(Pleroma.Web.Plugs.EnsureAuthenticatedPlug)
100 plug(Pleroma.Web.Plugs.UserIsStaffPlug)
101 plug(Pleroma.Web.Plugs.IdempotencyPlug)
102 end
103
104 pipeline :require_admin do
105 plug(Pleroma.Web.Plugs.UserIsAdminPlug)
106 end
107
108 pipeline :pleroma_html do
109 plug(:browser)
110 plug(:authenticate)
111 plug(Pleroma.Web.Plugs.EnsureUserTokenAssignsPlug)
112 end
113
114 pipeline :well_known do
115 plug(:accepts, ["json", "jrd+json", "xml", "xrd+xml"])
116 end
117
118 pipeline :config do
119 plug(:accepts, ["json", "xml"])
120 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
121 end
122
123 pipeline :pleroma_api do
124 plug(:accepts, ["html", "json"])
125 plug(OpenApiSpex.Plug.PutApiSpec, module: Pleroma.Web.ApiSpec)
126 end
127
128 pipeline :mailbox_preview do
129 plug(:accepts, ["html"])
130
131 plug(:put_secure_browser_headers, %{
132 "content-security-policy" =>
133 "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline' 'unsafe-eval'"
134 })
135 end
136
137 pipeline :http_signature do
138 plug(Pleroma.Web.Plugs.HTTPSignaturePlug)
139 plug(Pleroma.Web.Plugs.MappedSignatureToIdentityPlug)
140 end
141
142 pipeline :static_fe do
143 plug(Pleroma.Web.Plugs.StaticFEPlug)
144 end
145
146 scope "/api/v1/pleroma", Pleroma.Web.TwitterAPI do
147 pipe_through(:pleroma_api)
148
149 get("/password_reset/:token", PasswordController, :reset, as: :reset_password)
150 post("/password_reset", PasswordController, :do_reset, as: :reset_password)
151 get("/emoji", UtilController, :emoji)
152 get("/captcha", UtilController, :captcha)
153 get("/healthcheck", UtilController, :healthcheck)
154 end
155
156 scope "/api/v1/pleroma", Pleroma.Web do
157 pipe_through(:pleroma_api)
158 post("/uploader_callback/:upload_path", UploaderController, :callback)
159 end
160
161 # AdminAPI: only admins can perform these actions
162 scope "/api/v1/pleroma/admin", Pleroma.Web.AdminAPI do
163 pipe_through([:admin_api, :require_admin])
164
165 put("/users/disable_mfa", AdminAPIController, :disable_mfa)
166
167 get("/users/:nickname/permission_group", AdminAPIController, :right_get)
168 get("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_get)
169
170 post("/users/:nickname/permission_group/:permission_group", AdminAPIController, :right_add)
171
172 delete(
173 "/users/:nickname/permission_group/:permission_group",
174 AdminAPIController,
175 :right_delete
176 )
177
178 post("/users/permission_group/:permission_group", AdminAPIController, :right_add_multiple)
179
180 delete(
181 "/users/permission_group/:permission_group",
182 AdminAPIController,
183 :right_delete_multiple
184 )
185
186 post("/users/follow", UserController, :follow)
187 post("/users/unfollow", UserController, :unfollow)
188 post("/users", UserController, :create)
189
190 patch("/users/suggest", UserController, :suggest)
191 patch("/users/unsuggest", UserController, :unsuggest)
192
193 get("/relay", RelayController, :index)
194 post("/relay", RelayController, :follow)
195 delete("/relay", RelayController, :unfollow)
196
197 get("/users/:nickname/password_reset", AdminAPIController, :get_password_reset)
198 patch("/users/force_password_reset", AdminAPIController, :force_password_reset)
199 get("/users/:nickname/credentials", AdminAPIController, :show_user_credentials)
200 patch("/users/:nickname/credentials", AdminAPIController, :update_user_credentials)
201
202 get("/instance_document/:name", InstanceDocumentController, :show)
203 patch("/instance_document/:name", InstanceDocumentController, :update)
204 delete("/instance_document/:name", InstanceDocumentController, :delete)
205
206 patch("/users/confirm_email", AdminAPIController, :confirm_email)
207 patch("/users/resend_confirmation_email", AdminAPIController, :resend_confirmation_email)
208
209 get("/config", ConfigController, :show)
210 post("/config", ConfigController, :update)
211 get("/config/descriptions", ConfigController, :descriptions)
212 get("/need_reboot", AdminAPIController, :need_reboot)
213 get("/restart", AdminAPIController, :restart)
214
215 get("/oauth_app", OAuthAppController, :index)
216 post("/oauth_app", OAuthAppController, :create)
217 patch("/oauth_app/:id", OAuthAppController, :update)
218 delete("/oauth_app/:id", OAuthAppController, :delete)
219
220 get("/media_proxy_caches", MediaProxyCacheController, :index)
221 post("/media_proxy_caches/delete", MediaProxyCacheController, :delete)
222 post("/media_proxy_caches/purge", MediaProxyCacheController, :purge)
223
224 get("/frontends", FrontendController, :index)
225 post("/frontends/install", FrontendController, :install)
226
227 post("/backups", AdminAPIController, :create_backup)
228 end
229
230 # AdminAPI: admins and mods (staff) can perform these actions
231 scope "/api/v1/pleroma/admin", Pleroma.Web.AdminAPI do
232 pipe_through(:admin_api)
233
234 put("/users/tag", AdminAPIController, :tag_users)
235 delete("/users/tag", AdminAPIController, :untag_users)
236
237 patch("/users/:nickname/toggle_activation", UserController, :toggle_activation)
238 patch("/users/activate", UserController, :activate)
239 patch("/users/deactivate", UserController, :deactivate)
240 patch("/users/approve", UserController, :approve)
241
242 delete("/users", UserController, :delete)
243
244 post("/users/invite_token", InviteController, :create)
245 get("/users/invites", InviteController, :index)
246 post("/users/revoke_invite", InviteController, :revoke)
247 post("/users/email_invite", InviteController, :email)
248
249 get("/users/:nickname/password_reset", AdminAPIController, :get_password_reset)
250 patch("/users/force_password_reset", AdminAPIController, :force_password_reset)
251 get("/users/:nickname/credentials", AdminAPIController, :show_user_credentials)
252 patch("/users/:nickname/credentials", AdminAPIController, :update_user_credentials)
253
254 get("/users", UserController, :index)
255 get("/users/:nickname", UserController, :show)
256 get("/users/:nickname/statuses", AdminAPIController, :list_user_statuses)
257 get("/users/:nickname/chats", AdminAPIController, :list_user_chats)
258
259 get("/instances/:instance/statuses", InstanceController, :list_statuses)
260 delete("/instances/:instance", InstanceController, :delete)
261
262 get("/reports", ReportController, :index)
263 get("/reports/:id", ReportController, :show)
264 patch("/reports", ReportController, :update)
265 post("/reports/:id/notes", ReportController, :notes_create)
266 delete("/reports/:report_id/notes/:id", ReportController, :notes_delete)
267
268 get("/statuses/:id", StatusController, :show)
269 put("/statuses/:id", StatusController, :update)
270 delete("/statuses/:id", StatusController, :delete)
271 get("/statuses", StatusController, :index)
272
273 get("/moderation_log", AdminAPIController, :list_log)
274
275 post("/reload_emoji", AdminAPIController, :reload_emoji)
276 get("/stats", AdminAPIController, :stats)
277
278 get("/chats/:id", ChatController, :show)
279 get("/chats/:id/messages", ChatController, :messages)
280 delete("/chats/:id/messages/:message_id", ChatController, :delete_message)
281 end
282
283 scope "/api/v1/pleroma/emoji", Pleroma.Web.PleromaAPI do
284 scope "/pack" do
285 pipe_through(:admin_api)
286
287 post("/", EmojiPackController, :create)
288 patch("/", EmojiPackController, :update)
289 delete("/", EmojiPackController, :delete)
290 end
291
292 scope "/pack" do
293 pipe_through(:api)
294
295 get("/", EmojiPackController, :show)
296 end
297
298 # Modifying packs
299 scope "/packs" do
300 pipe_through(:admin_api)
301
302 get("/import", EmojiPackController, :import_from_filesystem)
303 get("/remote", EmojiPackController, :remote)
304 post("/download", EmojiPackController, :download)
305
306 post("/files", EmojiFileController, :create)
307 patch("/files", EmojiFileController, :update)
308 delete("/files", EmojiFileController, :delete)
309 end
310
311 # Pack info / downloading
312 scope "/packs" do
313 pipe_through(:api)
314
315 get("/", EmojiPackController, :index)
316 get("/archive", EmojiPackController, :archive)
317 end
318 end
319
320 scope "/", Pleroma.Web.TwitterAPI do
321 pipe_through(:pleroma_html)
322
323 post("/main/ostatus", UtilController, :remote_subscribe)
324 get("/ostatus_subscribe", RemoteFollowController, :follow)
325 post("/ostatus_subscribe", RemoteFollowController, :do_follow)
326 end
327
328 scope "/api/pleroma", Pleroma.Web.TwitterAPI do
329 pipe_through(:authenticated_api)
330
331 post("/change_email", UtilController, :change_email)
332 post("/change_password", UtilController, :change_password)
333 post("/delete_account", UtilController, :delete_account)
334 put("/notification_settings", UtilController, :update_notificaton_settings)
335 post("/disable_account", UtilController, :disable_account)
336 end
337
338 scope "/api/pleroma", Pleroma.Web.PleromaAPI do
339 pipe_through(:authenticated_api)
340
341 post("/mutes_import", UserImportController, :mutes)
342 post("/blocks_import", UserImportController, :blocks)
343 post("/follow_import", UserImportController, :follow)
344
345 get("/accounts/mfa", TwoFactorAuthenticationController, :settings)
346 get("/accounts/mfa/backup_codes", TwoFactorAuthenticationController, :backup_codes)
347 get("/accounts/mfa/setup/:method", TwoFactorAuthenticationController, :setup)
348 post("/accounts/mfa/confirm/:method", TwoFactorAuthenticationController, :confirm)
349 delete("/accounts/mfa/:method", TwoFactorAuthenticationController, :disable)
350 end
351
352 scope "/oauth", Pleroma.Web.OAuth do
353 # Note: use /api/v1/accounts/verify_credentials for userinfo of signed-in user
354
355 get("/registration_details", OAuthController, :registration_details)
356
357 post("/mfa/verify", MFAController, :verify, as: :mfa_verify)
358 get("/mfa", MFAController, :show)
359
360 scope [] do
361 pipe_through(:oauth)
362
363 get("/authorize", OAuthController, :authorize)
364 post("/authorize", OAuthController, :create_authorization)
365 end
366
367 scope [] do
368 pipe_through(:fetch_session)
369
370 post("/token", OAuthController, :token_exchange)
371 post("/revoke", OAuthController, :token_revoke)
372 post("/mfa/challenge", MFAController, :challenge)
373 end
374
375 scope [] do
376 pipe_through(:browser)
377
378 get("/prepare_request", OAuthController, :prepare_request)
379 get("/:provider", OAuthController, :request)
380 get("/:provider/callback", OAuthController, :callback)
381 post("/register", OAuthController, :register)
382 end
383 end
384
385 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
386 pipe_through(:api)
387
388 get("/statuses/:id/reactions/:emoji", EmojiReactionController, :index)
389 get("/statuses/:id/reactions", EmojiReactionController, :index)
390 end
391
392 scope "/api/v0/pleroma", Pleroma.Web.PleromaAPI do
393 pipe_through(:authenticated_api)
394 get("/reports", ReportController, :index)
395 get("/reports/:id", ReportController, :show)
396 end
397
398 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
399 scope [] do
400 pipe_through(:authenticated_api)
401
402 post("/chats/by-account-id/:id", ChatController, :create)
403 get("/chats", ChatController, :index)
404 get("/chats/:id", ChatController, :show)
405 get("/chats/:id/messages", ChatController, :messages)
406 post("/chats/:id/messages", ChatController, :post_chat_message)
407 delete("/chats/:id/messages/:message_id", ChatController, :delete_message)
408 post("/chats/:id/read", ChatController, :mark_as_read)
409 post("/chats/:id/messages/:message_id/read", ChatController, :mark_message_as_read)
410
411 get("/conversations/:id/statuses", ConversationController, :statuses)
412 get("/conversations/:id", ConversationController, :show)
413 post("/conversations/read", ConversationController, :mark_as_read)
414 patch("/conversations/:id", ConversationController, :update)
415
416 put("/statuses/:id/reactions/:emoji", EmojiReactionController, :create)
417 delete("/statuses/:id/reactions/:emoji", EmojiReactionController, :delete)
418 post("/notifications/read", NotificationController, :mark_as_read)
419
420 get("/mascot", MascotController, :show)
421 put("/mascot", MascotController, :update)
422
423 post("/scrobble", ScrobbleController, :create)
424
425 get("/backups", BackupController, :index)
426 post("/backups", BackupController, :create)
427 end
428
429 scope [] do
430 pipe_through(:api)
431 get("/accounts/:id/favourites", AccountController, :favourites)
432 end
433
434 scope [] do
435 pipe_through(:authenticated_api)
436
437 post("/accounts/:id/subscribe", AccountController, :subscribe)
438 post("/accounts/:id/unsubscribe", AccountController, :unsubscribe)
439 end
440
441 post("/accounts/confirmation_resend", AccountController, :confirmation_resend)
442 end
443
444 scope "/api/v1/pleroma", Pleroma.Web.PleromaAPI do
445 pipe_through(:api)
446 get("/accounts/:id/scrobbles", ScrobbleController, :index)
447 get("/federation_status", InstancesController, :show)
448 end
449
450 scope "/api/v2/pleroma", Pleroma.Web.PleromaAPI do
451 scope [] do
452 pipe_through(:authenticated_api)
453 get("/chats", ChatController, :index2)
454 end
455 end
456
457 scope "/api/v1", Pleroma.Web.MastodonAPI do
458 pipe_through(:authenticated_api)
459
460 get("/accounts/verify_credentials", AccountController, :verify_credentials)
461 patch("/accounts/update_credentials", AccountController, :update_credentials)
462
463 get("/accounts/relationships", AccountController, :relationships)
464 get("/accounts/:id/lists", AccountController, :lists)
465 get("/accounts/:id/identity_proofs", AccountController, :identity_proofs)
466 get("/endorsements", AccountController, :endorsements)
467 get("/blocks", AccountController, :blocks)
468 get("/mutes", AccountController, :mutes)
469
470 post("/follows", AccountController, :follow_by_uri)
471 post("/accounts/:id/follow", AccountController, :follow)
472 post("/accounts/:id/unfollow", AccountController, :unfollow)
473 post("/accounts/:id/block", AccountController, :block)
474 post("/accounts/:id/unblock", AccountController, :unblock)
475 post("/accounts/:id/mute", AccountController, :mute)
476 post("/accounts/:id/unmute", AccountController, :unmute)
477
478 get("/conversations", ConversationController, :index)
479 post("/conversations/:id/read", ConversationController, :mark_as_read)
480 delete("/conversations/:id", ConversationController, :delete)
481
482 get("/domain_blocks", DomainBlockController, :index)
483 post("/domain_blocks", DomainBlockController, :create)
484 delete("/domain_blocks", DomainBlockController, :delete)
485
486 get("/filters", FilterController, :index)
487
488 post("/filters", FilterController, :create)
489 get("/filters/:id", FilterController, :show)
490 put("/filters/:id", FilterController, :update)
491 delete("/filters/:id", FilterController, :delete)
492
493 get("/follow_requests", FollowRequestController, :index)
494 post("/follow_requests/:id/authorize", FollowRequestController, :authorize)
495 post("/follow_requests/:id/reject", FollowRequestController, :reject)
496
497 get("/lists", ListController, :index)
498 get("/lists/:id", ListController, :show)
499 get("/lists/:id/accounts", ListController, :list_accounts)
500
501 delete("/lists/:id", ListController, :delete)
502 post("/lists", ListController, :create)
503 put("/lists/:id", ListController, :update)
504 post("/lists/:id/accounts", ListController, :add_to_list)
505 delete("/lists/:id/accounts", ListController, :remove_from_list)
506
507 get("/markers", MarkerController, :index)
508 post("/markers", MarkerController, :upsert)
509
510 post("/media", MediaController, :create)
511 get("/media/:id", MediaController, :show)
512 put("/media/:id", MediaController, :update)
513
514 get("/notifications", NotificationController, :index)
515 get("/notifications/:id", NotificationController, :show)
516
517 post("/notifications/:id/dismiss", NotificationController, :dismiss)
518 post("/notifications/clear", NotificationController, :clear)
519 delete("/notifications/destroy_multiple", NotificationController, :destroy_multiple)
520 # Deprecated: was removed in Mastodon v3, use `/notifications/:id/dismiss` instead
521 post("/notifications/dismiss", NotificationController, :dismiss_via_body)
522
523 post("/polls/:id/votes", PollController, :vote)
524
525 post("/reports", ReportController, :create)
526
527 get("/scheduled_statuses", ScheduledActivityController, :index)
528 get("/scheduled_statuses/:id", ScheduledActivityController, :show)
529
530 put("/scheduled_statuses/:id", ScheduledActivityController, :update)
531 delete("/scheduled_statuses/:id", ScheduledActivityController, :delete)
532
533 # Unlike `GET /api/v1/accounts/:id/favourites`, demands authentication
534 get("/favourites", StatusController, :favourites)
535 get("/bookmarks", StatusController, :bookmarks)
536
537 post("/statuses", StatusController, :create)
538 delete("/statuses/:id", StatusController, :delete)
539 post("/statuses/:id/reblog", StatusController, :reblog)
540 post("/statuses/:id/unreblog", StatusController, :unreblog)
541 post("/statuses/:id/favourite", StatusController, :favourite)
542 post("/statuses/:id/unfavourite", StatusController, :unfavourite)
543 post("/statuses/:id/pin", StatusController, :pin)
544 post("/statuses/:id/unpin", StatusController, :unpin)
545 post("/statuses/:id/bookmark", StatusController, :bookmark)
546 post("/statuses/:id/unbookmark", StatusController, :unbookmark)
547 post("/statuses/:id/mute", StatusController, :mute_conversation)
548 post("/statuses/:id/unmute", StatusController, :unmute_conversation)
549
550 post("/push/subscription", SubscriptionController, :create)
551 get("/push/subscription", SubscriptionController, :show)
552 put("/push/subscription", SubscriptionController, :update)
553 delete("/push/subscription", SubscriptionController, :delete)
554
555 get("/suggestions", SuggestionController, :index)
556 delete("/suggestions/:account_id", SuggestionController, :dismiss)
557
558 get("/timelines/home", TimelineController, :home)
559 get("/timelines/direct", TimelineController, :direct)
560 get("/timelines/list/:list_id", TimelineController, :list)
561 end
562
563 scope "/api/v1", Pleroma.Web.MastodonAPI do
564 pipe_through(:app_api)
565
566 post("/apps", AppController, :create)
567 get("/apps/verify_credentials", AppController, :verify_credentials)
568 end
569
570 scope "/api/v1", Pleroma.Web.MastodonAPI do
571 pipe_through(:api)
572
573 get("/accounts/search", SearchController, :account_search)
574 get("/search", SearchController, :search)
575
576 get("/accounts/:id/statuses", AccountController, :statuses)
577 get("/accounts/:id/followers", AccountController, :followers)
578 get("/accounts/:id/following", AccountController, :following)
579 get("/accounts/:id", AccountController, :show)
580
581 post("/accounts", AccountController, :create)
582
583 get("/instance", InstanceController, :show)
584 get("/instance/peers", InstanceController, :peers)
585
586 get("/statuses", StatusController, :index)
587 get("/statuses/:id", StatusController, :show)
588 get("/statuses/:id/context", StatusController, :context)
589 get("/statuses/:id/card", StatusController, :card)
590 get("/statuses/:id/favourited_by", StatusController, :favourited_by)
591 get("/statuses/:id/reblogged_by", StatusController, :reblogged_by)
592
593 get("/custom_emojis", CustomEmojiController, :index)
594
595 get("/trends", MastodonAPIController, :empty_array)
596
597 get("/timelines/public", TimelineController, :public)
598 get("/timelines/tag/:tag", TimelineController, :hashtag)
599
600 get("/polls/:id", PollController, :show)
601 end
602
603 scope "/api/v2", Pleroma.Web.MastodonAPI do
604 pipe_through(:api)
605 get("/search", SearchController, :search2)
606
607 post("/media", MediaController, :create2)
608
609 get("/suggestions", SuggestionController, :index2)
610 end
611
612 scope "/api", Pleroma.Web do
613 pipe_through(:config)
614
615 get("/pleroma/frontend_configurations", TwitterAPI.UtilController, :frontend_configurations)
616 end
617
618 scope "/api", Pleroma.Web do
619 pipe_through(:api)
620
621 get(
622 "/account/confirm_email/:user_id/:token",
623 TwitterAPI.Controller,
624 :confirm_email,
625 as: :confirm_email
626 )
627 end
628
629 scope "/api" do
630 pipe_through(:base_api)
631
632 get("/openapi", OpenApiSpex.Plug.RenderSpec, [])
633 end
634
635 scope "/api", Pleroma.Web, as: :authenticated_twitter_api do
636 pipe_through(:authenticated_api)
637
638 get("/oauth_tokens", TwitterAPI.Controller, :oauth_tokens)
639 delete("/oauth_tokens/:id", TwitterAPI.Controller, :revoke_token)
640 end
641
642 scope "/", Pleroma.Web do
643 # Note: html format is supported only if static FE is enabled
644 # Note: http signature is only considered for json requests (no auth for non-json requests)
645 pipe_through([:accepts_html_json, :http_signature, :static_fe])
646
647 get("/objects/:uuid", OStatus.OStatusController, :object)
648 get("/activities/:uuid", OStatus.OStatusController, :activity)
649 get("/notice/:id", OStatus.OStatusController, :notice)
650
651 # Mastodon compatibility routes
652 get("/users/:nickname/statuses/:id", OStatus.OStatusController, :object)
653 get("/users/:nickname/statuses/:id/activity", OStatus.OStatusController, :activity)
654 end
655
656 scope "/", Pleroma.Web do
657 # Note: html format is supported only if static FE is enabled
658 # Note: http signature is only considered for json requests (no auth for non-json requests)
659 pipe_through([:accepts_html_xml_json, :http_signature, :static_fe])
660
661 # Note: returns user _profile_ for json requests, redirects to user _feed_ for non-json ones
662 get("/users/:nickname", Feed.UserController, :feed_redirect, as: :user_feed)
663 end
664
665 scope "/", Pleroma.Web do
666 # Note: html format is supported only if static FE is enabled
667 pipe_through([:accepts_html_xml, :static_fe])
668
669 get("/users/:nickname/feed", Feed.UserController, :feed, as: :user_feed)
670 end
671
672 scope "/", Pleroma.Web do
673 pipe_through(:accepts_html)
674 get("/notice/:id/embed_player", OStatus.OStatusController, :notice_player)
675 end
676
677 scope "/", Pleroma.Web do
678 pipe_through(:accepts_xml_rss_atom)
679 get("/tags/:tag", Feed.TagController, :feed, as: :tag_feed)
680 end
681
682 scope "/", Pleroma.Web do
683 pipe_through(:browser)
684 get("/mailer/unsubscribe/:token", Mailer.SubscriptionController, :unsubscribe)
685 end
686
687 pipeline :ap_service_actor do
688 plug(:accepts, ["activity+json", "json"])
689 end
690
691 # Server to Server (S2S) AP interactions
692 pipeline :activitypub do
693 plug(:ap_service_actor)
694 plug(:http_signature)
695 end
696
697 # Client to Server (C2S) AP interactions
698 pipeline :activitypub_client do
699 plug(:ap_service_actor)
700 plug(:fetch_session)
701 plug(:authenticate)
702 plug(:after_auth)
703 end
704
705 scope "/", Pleroma.Web.ActivityPub do
706 pipe_through([:activitypub_client])
707
708 get("/api/ap/whoami", ActivityPubController, :whoami)
709 get("/users/:nickname/inbox", ActivityPubController, :read_inbox)
710
711 get("/users/:nickname/outbox", ActivityPubController, :outbox)
712 post("/users/:nickname/outbox", ActivityPubController, :update_outbox)
713 post("/api/ap/upload_media", ActivityPubController, :upload_media)
714
715 # The following two are S2S as well, see `ActivityPub.fetch_follow_information_for_user/1`:
716 get("/users/:nickname/followers", ActivityPubController, :followers)
717 get("/users/:nickname/following", ActivityPubController, :following)
718 get("/users/:nickname/collections/featured", ActivityPubController, :pinned)
719 end
720
721 scope "/", Pleroma.Web.ActivityPub do
722 pipe_through(:activitypub)
723 post("/inbox", ActivityPubController, :inbox)
724 post("/users/:nickname/inbox", ActivityPubController, :inbox)
725 end
726
727 scope "/relay", Pleroma.Web.ActivityPub do
728 pipe_through(:ap_service_actor)
729
730 get("/", ActivityPubController, :relay)
731
732 scope [] do
733 pipe_through(:http_signature)
734 post("/inbox", ActivityPubController, :inbox)
735 end
736
737 get("/following", ActivityPubController, :relay_following)
738 get("/followers", ActivityPubController, :relay_followers)
739 end
740
741 scope "/internal/fetch", Pleroma.Web.ActivityPub do
742 pipe_through(:ap_service_actor)
743
744 get("/", ActivityPubController, :internal_fetch)
745 post("/inbox", ActivityPubController, :inbox)
746 end
747
748 scope "/.well-known", Pleroma.Web do
749 pipe_through(:well_known)
750
751 get("/host-meta", WebFinger.WebFingerController, :host_meta)
752 get("/webfinger", WebFinger.WebFingerController, :webfinger)
753 get("/nodeinfo", Nodeinfo.NodeinfoController, :schemas)
754 end
755
756 scope "/nodeinfo", Pleroma.Web do
757 get("/:version", Nodeinfo.NodeinfoController, :nodeinfo)
758 end
759
760 scope "/", Pleroma.Web do
761 pipe_through(:api)
762
763 get("/manifest.json", ManifestController, :show)
764 end
765
766 scope "/", Pleroma.Web do
767 pipe_through(:pleroma_html)
768
769 post("/auth/password", TwitterAPI.PasswordController, :request)
770 end
771
772 scope "/proxy/", Pleroma.Web do
773 get("/preview/:sig/:url", MediaProxy.MediaProxyController, :preview)
774 get("/preview/:sig/:url/:filename", MediaProxy.MediaProxyController, :preview)
775 get("/:sig/:url", MediaProxy.MediaProxyController, :remote)
776 get("/:sig/:url/:filename", MediaProxy.MediaProxyController, :remote)
777 end
778
779 if Pleroma.Config.get(:env) == :dev do
780 scope "/dev" do
781 pipe_through([:mailbox_preview])
782
783 forward("/mailbox", Plug.Swoosh.MailboxPreview, base_path: "/dev/mailbox")
784 end
785 end
786
787 scope "/" do
788 pipe_through([:pleroma_html, :authenticate, :require_admin])
789 live_dashboard("/phoenix/live_dashboard")
790 end
791
792 # Test-only routes needed to test action dispatching and plug chain execution
793 if Pleroma.Config.get(:env) == :test do
794 @test_actions [
795 :do_oauth_check,
796 :fallback_oauth_check,
797 :skip_oauth_check,
798 :fallback_oauth_skip_publicity_check,
799 :skip_oauth_skip_publicity_check,
800 :missing_oauth_check_definition
801 ]
802
803 scope "/test/api", Pleroma.Tests do
804 pipe_through(:api)
805
806 for action <- @test_actions do
807 get("/#{action}", AuthTestController, action)
808 end
809 end
810
811 scope "/test/authenticated_api", Pleroma.Tests do
812 pipe_through(:authenticated_api)
813
814 for action <- @test_actions do
815 get("/#{action}", AuthTestController, action)
816 end
817 end
818 end
819
820 scope "/", Pleroma.Web.MongooseIM do
821 get("/user_exists", MongooseIMController, :user_exists)
822 get("/check_password", MongooseIMController, :check_password)
823 end
824
825 scope "/", Pleroma.Web.Fallback do
826 get("/registration/:token", RedirectController, :registration_page)
827 get("/:maybe_nickname_or_id", RedirectController, :redirector_with_meta)
828 match(:*, "/api/pleroma*path", LegacyPleromaApiRerouterPlug, [])
829 get("/api*path", RedirectController, :api_not_implemented)
830 get("/*path", RedirectController, :redirector_with_preload)
831
832 options("/*path", RedirectController, :empty)
833 end
834
835 # TODO: Change to Phoenix.Router.routes/1 for Phoenix 1.6.0+
836 def get_api_routes do
837 __MODULE__.__routes__()
838 |> Enum.reject(fn r -> r.plug == Pleroma.Web.Fallback.RedirectController end)
839 |> Enum.map(fn r ->
840 r.path
841 |> String.split("/", trim: true)
842 |> List.first()
843 end)
844 |> Enum.uniq()
845 end
846 end