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