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