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