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