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