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