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