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