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