src/api_routes_http.rs

   1 use crate::api_routes_websocket::websocket;
   2 use actix_web::{guard, web, Error, HttpResponse, Result};
   3 use lemmy_api::Perform;
   4 use lemmy_api_common::{
   5   comment::{
   6     CreateComment,
   7     CreateCommentLike,
   8     CreateCommentReport,
   9     DeleteComment,
  10     DistinguishComment,
  11     EditComment,
  12     GetComment,
  13     GetComments,
  14     ListCommentReports,
  15     RemoveComment,
  16     ResolveCommentReport,
  17     SaveComment,
  18   },
  19   community::{
  20     AddModToCommunity,
  21     BanFromCommunity,
  22     BlockCommunity,
  23     CreateCommunity,
  24     DeleteCommunity,
  25     EditCommunity,
  26     FollowCommunity,
  27     GetCommunity,
  28     HideCommunity,
  29     ListCommunities,
  30     RemoveCommunity,
  31     TransferCommunity,
  32   },
  33   context::LemmyContext,
  34   custom_emoji::{CreateCustomEmoji, DeleteCustomEmoji, EditCustomEmoji},
  35   person::{
  36     AddAdmin,
  37     BanPerson,
  38     BlockPerson,
  39     ChangePassword,
  40     DeleteAccount,
  41     GetBannedPersons,
  42     GetCaptcha,
  43     GetPersonDetails,
  44     GetPersonMentions,
  45     GetReplies,
  46     GetReportCount,
  47     GetUnreadCount,
  48     Login,
  49     MarkAllAsRead,
  50     MarkCommentReplyAsRead,
  51     MarkPersonMentionAsRead,
  52     PasswordChangeAfterReset,
  53     PasswordReset,
  54     Register,
  55     SaveUserSettings,
  56     VerifyEmail,
  57   },
  58   post::{
  59     CreatePost,
  60     CreatePostLike,
  61     CreatePostReport,
  62     DeletePost,
  63     EditPost,
  64     FeaturePost,
  65     GetPost,
  66     GetPosts,
  67     GetSiteMetadata,
  68     ListPostReports,
  69     LockPost,
  70     MarkPostAsRead,
  71     RemovePost,
  72     ResolvePostReport,
  73     SavePost,
  74   },
  75   private_message::{
  76     CreatePrivateMessage,
  77     CreatePrivateMessageReport,
  78     DeletePrivateMessage,
  79     EditPrivateMessage,
  80     GetPrivateMessages,
  81     ListPrivateMessageReports,
  82     MarkPrivateMessageAsRead,
  83     ResolvePrivateMessageReport,
  84   },
  85   site::{
  86     ApproveRegistrationApplication,
  87     CreateSite,
  88     EditSite,
  89     GetFederatedInstances,
  90     GetModlog,
  91     GetSite,
  92     GetUnreadRegistrationApplicationCount,
  93     LeaveAdmin,
  94     ListRegistrationApplications,
  95     PurgeComment,
  96     PurgeCommunity,
  97     PurgePerson,
  98     PurgePost,
  99     ResolveObject,
 100     Search,
 101   },
 102   websocket::structs::{CommunityJoin, ModJoin, PostJoin, UserJoin},
 103 };
 104 use lemmy_api_crud::PerformCrud;
 105 use lemmy_apub::{api::PerformApub, SendActivity};
 106 use lemmy_utils::rate_limit::RateLimitCell;
 107 use serde::Deserialize;
 108
 109 pub fn config(cfg: &mut web::ServiceConfig, rate_limit: &RateLimitCell) {
 110   cfg.service(
 111     web::scope("/api/v3")
 112       // Websocket
 113       .service(web::resource("/ws").to(websocket))
 114       // Site
 115       .service(
 116         web::scope("/site")
 117           .wrap(rate_limit.message())
 118           .route("", web::get().to(route_get_crud::<GetSite>))
 119           // Admin Actions
 120           .route("", web::post().to(route_post_crud::<CreateSite>))
 121           .route("", web::put().to(route_post_crud::<EditSite>)),
 122       )
 123       .service(
 124         web::resource("/modlog")
 125           .wrap(rate_limit.message())
 126           .route(web::get().to(route_get::<GetModlog>)),
 127       )
 128       .service(
 129         web::resource("/search")
 130           .wrap(rate_limit.search())
 131           .route(web::get().to(route_get_apub::<Search>)),
 132       )
 133       .service(
 134         web::resource("/resolve_object")
 135           .wrap(rate_limit.message())
 136           .route(web::get().to(route_get_apub::<ResolveObject>)),
 137       )
 138       // Community
 139       .service(
 140         web::resource("/community")
 141           .guard(guard::Post())
 142           .wrap(rate_limit.register())
 143           .route(web::post().to(route_post_crud::<CreateCommunity>)),
 144       )
 145       .service(
 146         web::scope("/community")
 147           .wrap(rate_limit.message())
 148           .route("", web::get().to(route_get_apub::<GetCommunity>))
 149           .route("", web::put().to(route_post_crud::<EditCommunity>))
 150           .route("/hide", web::put().to(route_post::<HideCommunity>))
 151           .route("/list", web::get().to(route_get_crud::<ListCommunities>))
 152           .route("/follow", web::post().to(route_post::<FollowCommunity>))
 153           .route("/block", web::post().to(route_post::<BlockCommunity>))
 154           .route(
 155             "/delete",
 156             web::post().to(route_post_crud::<DeleteCommunity>),
 157           )
 158           // Mod Actions
 159           .route(
 160             "/remove",
 161             web::post().to(route_post_crud::<RemoveCommunity>),
 162           )
 163           .route("/transfer", web::post().to(route_post::<TransferCommunity>))
 164           .route("/ban_user", web::post().to(route_post::<BanFromCommunity>))
 165           .route("/mod", web::post().to(route_post::<AddModToCommunity>))
 166           .route("/join", web::post().to(route_post::<CommunityJoin>))
 167           .route("/mod/join", web::post().to(route_post::<ModJoin>)),
 168       )
 169       .service(
 170         web::scope("/federated_instances")
 171           .wrap(rate_limit.message())
 172           .route("", web::get().to(route_get::<GetFederatedInstances>)),
 173       )
 174       // Post
 175       .service(
 176         // Handle POST to /post separately to add the post() rate limitter
 177         web::resource("/post")
 178           .guard(guard::Post())
 179           .wrap(rate_limit.post())
 180           .route(web::post().to(route_post_crud::<CreatePost>)),
 181       )
 182       .service(
 183         web::scope("/post")
 184           .wrap(rate_limit.message())
 185           .route("", web::get().to(route_get_crud::<GetPost>))
 186           .route("", web::put().to(route_post_crud::<EditPost>))
 187           .route("/delete", web::post().to(route_post_crud::<DeletePost>))
 188           .route("/remove", web::post().to(route_post_crud::<RemovePost>))
 189           .route(
 190             "/mark_as_read",
 191             web::post().to(route_post::<MarkPostAsRead>),
 192           )
 193           .route("/lock", web::post().to(route_post::<LockPost>))
 194           .route("/feature", web::post().to(route_post::<FeaturePost>))
 195           .route("/list", web::get().to(route_get_apub::<GetPosts>))
 196           .route("/like", web::post().to(route_post::<CreatePostLike>))
 197           .route("/save", web::put().to(route_post::<SavePost>))
 198           .route("/join", web::post().to(route_post::<PostJoin>))
 199           .route("/report", web::post().to(route_post::<CreatePostReport>))
 200           .route(
 201             "/report/resolve",
 202             web::put().to(route_post::<ResolvePostReport>),
 203           )
 204           .route("/report/list", web::get().to(route_get::<ListPostReports>))
 205           .route(
 206             "/site_metadata",
 207             web::get().to(route_get::<GetSiteMetadata>),
 208           ),
 209       )
 210       // Comment
 211       .service(
 212         // Handle POST to /comment separately to add the comment() rate limitter
 213         web::resource("/comment")
 214           .guard(guard::Post())
 215           .wrap(rate_limit.comment())
 216           .route(web::post().to(route_post_crud::<CreateComment>)),
 217       )
 218       .service(
 219         web::scope("/comment")
 220           .wrap(rate_limit.message())
 221           .route("", web::get().to(route_get_crud::<GetComment>))
 222           .route("", web::put().to(route_post_crud::<EditComment>))
 223           .route("/delete", web::post().to(route_post_crud::<DeleteComment>))
 224           .route("/remove", web::post().to(route_post_crud::<RemoveComment>))
 225           .route(
 226             "/mark_as_read",
 227             web::post().to(route_post::<MarkCommentReplyAsRead>),
 228           )
 229           .route(
 230             "/distinguish",
 231             web::post().to(route_post::<DistinguishComment>),
 232           )
 233           .route("/like", web::post().to(route_post::<CreateCommentLike>))
 234           .route("/save", web::put().to(route_post::<SaveComment>))
 235           .route("/list", web::get().to(route_get_apub::<GetComments>))
 236           .route("/report", web::post().to(route_post::<CreateCommentReport>))
 237           .route(
 238             "/report/resolve",
 239             web::put().to(route_post::<ResolveCommentReport>),
 240           )
 241           .route(
 242             "/report/list",
 243             web::get().to(route_get::<ListCommentReports>),
 244           ),
 245       )
 246       // Private Message
 247       .service(
 248         web::scope("/private_message")
 249           .wrap(rate_limit.message())
 250           .route("/list", web::get().to(route_get_crud::<GetPrivateMessages>))
 251           .route("", web::post().to(route_post_crud::<CreatePrivateMessage>))
 252           .route("", web::put().to(route_post_crud::<EditPrivateMessage>))
 253           .route(
 254             "/delete",
 255             web::post().to(route_post_crud::<DeletePrivateMessage>),
 256           )
 257           .route(
 258             "/mark_as_read",
 259             web::post().to(route_post::<MarkPrivateMessageAsRead>),
 260           )
 261           .route(
 262             "/report",
 263             web::post().to(route_post::<CreatePrivateMessageReport>),
 264           )
 265           .route(
 266             "/report/resolve",
 267             web::put().to(route_post::<ResolvePrivateMessageReport>),
 268           )
 269           .route(
 270             "/report/list",
 271             web::get().to(route_get::<ListPrivateMessageReports>),
 272           ),
 273       )
 274       // User
 275       .service(
 276         // Account action, I don't like that it's in /user maybe /accounts
 277         // Handle /user/register separately to add the register() rate limitter
 278         web::resource("/user/register")
 279           .guard(guard::Post())
 280           .wrap(rate_limit.register())
 281           .route(web::post().to(route_post_crud::<Register>)),
 282       )
 283       .service(
 284         // Handle captcha separately
 285         web::resource("/user/get_captcha")
 286           .wrap(rate_limit.post())
 287           .route(web::get().to(route_get::<GetCaptcha>)),
 288       )
 289       // User actions
 290       .service(
 291         web::scope("/user")
 292           .wrap(rate_limit.message())
 293           .route("", web::get().to(route_get_apub::<GetPersonDetails>))
 294           .route("/mention", web::get().to(route_get::<GetPersonMentions>))
 295           .route(
 296             "/mention/mark_as_read",
 297             web::post().to(route_post::<MarkPersonMentionAsRead>),
 298           )
 299           .route("/replies", web::get().to(route_get::<GetReplies>))
 300           .route("/join", web::post().to(route_post::<UserJoin>))
 301           // Admin action. I don't like that it's in /user
 302           .route("/ban", web::post().to(route_post::<BanPerson>))
 303           .route("/banned", web::get().to(route_get::<GetBannedPersons>))
 304           .route("/block", web::post().to(route_post::<BlockPerson>))
 305           // Account actions. I don't like that they're in /user maybe /accounts
 306           .route("/login", web::post().to(route_post::<Login>))
 307           .route(
 308             "/delete_account",
 309             web::post().to(route_post_crud::<DeleteAccount>),
 310           )
 311           .route(
 312             "/password_reset",
 313             web::post().to(route_post::<PasswordReset>),
 314           )
 315           .route(
 316             "/password_change",
 317             web::post().to(route_post::<PasswordChangeAfterReset>),
 318           )
 319           // mark_all_as_read feels off being in this section as well
 320           .route(
 321             "/mark_all_as_read",
 322             web::post().to(route_post::<MarkAllAsRead>),
 323           )
 324           .route(
 325             "/save_user_settings",
 326             web::put().to(route_post::<SaveUserSettings>),
 327           )
 328           .route(
 329             "/change_password",
 330             web::put().to(route_post::<ChangePassword>),
 331           )
 332           .route("/report_count", web::get().to(route_get::<GetReportCount>))
 333           .route("/unread_count", web::get().to(route_get::<GetUnreadCount>))
 334           .route("/verify_email", web::post().to(route_post::<VerifyEmail>))
 335           .route("/leave_admin", web::post().to(route_post::<LeaveAdmin>)),
 336       )
 337       // Admin Actions
 338       .service(
 339         web::scope("/admin")
 340           .wrap(rate_limit.message())
 341           .route("/add", web::post().to(route_post::<AddAdmin>))
 342           .route(
 343             "/registration_application/count",
 344             web::get().to(route_get::<GetUnreadRegistrationApplicationCount>),
 345           )
 346           .route(
 347             "/registration_application/list",
 348             web::get().to(route_get::<ListRegistrationApplications>),
 349           )
 350           .route(
 351             "/registration_application/approve",
 352             web::put().to(route_post::<ApproveRegistrationApplication>),
 353           ),
 354       )
 355       .service(
 356         web::scope("/admin/purge")
 357           .wrap(rate_limit.message())
 358           .route("/person", web::post().to(route_post::<PurgePerson>))
 359           .route("/community", web::post().to(route_post::<PurgeCommunity>))
 360           .route("/post", web::post().to(route_post::<PurgePost>))
 361           .route("/comment", web::post().to(route_post::<PurgeComment>)),
 362       )
 363       .service(
 364         web::scope("/custom_emoji")
 365           .wrap(rate_limit.message())
 366           .route("", web::post().to(route_post_crud::<CreateCustomEmoji>))
 367           .route("", web::put().to(route_post_crud::<EditCustomEmoji>))
 368           .route(
 369             "/delete",
 370             web::post().to(route_post_crud::<DeleteCustomEmoji>),
 371           ),
 372       ),
 373   );
 374 }
 375
 376 async fn perform<'a, Data>(
 377   data: Data,
 378   context: web::Data<LemmyContext>,
 379   apub_data: activitypub_federation::config::Data<LemmyContext>,
 380 ) -> Result<HttpResponse, Error>
 381 where
 382   Data: Perform
 383     + SendActivity<Response = <Data as Perform>::Response>
 384     + Clone
 385     + Deserialize<'a>
 386     + Send
 387     + 'static,
 388 {
 389   let res = data.perform(&context, None).await?;
 390   SendActivity::send_activity(&data, &res, &apub_data).await?;
 391   Ok(HttpResponse::Ok().json(res))
 392 }
 393
 394 async fn route_get<'a, Data>(
 395   data: web::Query<Data>,
 396   context: web::Data<LemmyContext>,
 397   apub_data: activitypub_federation::config::Data<LemmyContext>,
 398 ) -> Result<HttpResponse, Error>
 399 where
 400   Data: Perform
 401     + SendActivity<Response = <Data as Perform>::Response>
 402     + Clone
 403     + Deserialize<'a>
 404     + Send
 405     + 'static,
 406 {
 407   perform::<Data>(data.0, context, apub_data).await
 408 }
 409
 410 async fn route_get_apub<'a, Data>(
 411   data: web::Query<Data>,
 412   context: activitypub_federation::config::Data<LemmyContext>,
 413 ) -> Result<HttpResponse, Error>
 414 where
 415   Data: PerformApub
 416     + SendActivity<Response = <Data as PerformApub>::Response>
 417     + Clone
 418     + Deserialize<'a>
 419     + Send
 420     + 'static,
 421 {
 422   let res = data.perform(&context, None).await?;
 423   SendActivity::send_activity(&data.0, &res, &context).await?;
 424   Ok(HttpResponse::Ok().json(res))
 425 }
 426
 427 async fn route_post<'a, Data>(
 428   data: web::Json<Data>,
 429   context: web::Data<LemmyContext>,
 430   apub_data: activitypub_federation::config::Data<LemmyContext>,
 431 ) -> Result<HttpResponse, Error>
 432 where
 433   Data: Perform
 434     + SendActivity<Response = <Data as Perform>::Response>
 435     + Clone
 436     + Deserialize<'a>
 437     + Send
 438     + 'static,
 439 {
 440   perform::<Data>(data.0, context, apub_data).await
 441 }
 442
 443 async fn perform_crud<'a, Data>(
 444   data: Data,
 445   context: web::Data<LemmyContext>,
 446   apub_data: activitypub_federation::config::Data<LemmyContext>,
 447 ) -> Result<HttpResponse, Error>
 448 where
 449   Data: PerformCrud
 450     + SendActivity<Response = <Data as PerformCrud>::Response>
 451     + Clone
 452     + Deserialize<'a>
 453     + Send
 454     + 'static,
 455 {
 456   let res = data.perform(&context, None).await?;
 457   SendActivity::send_activity(&data, &res, &apub_data).await?;
 458   Ok(HttpResponse::Ok().json(res))
 459 }
 460
 461 async fn route_get_crud<'a, Data>(
 462   data: web::Query<Data>,
 463   context: web::Data<LemmyContext>,
 464   apub_data: activitypub_federation::config::Data<LemmyContext>,
 465 ) -> Result<HttpResponse, Error>
 466 where
 467   Data: PerformCrud
 468     + SendActivity<Response = <Data as PerformCrud>::Response>
 469     + Clone
 470     + Deserialize<'a>
 471     + Send
 472     + 'static,
 473 {
 474   perform_crud::<Data>(data.0, context, apub_data).await
 475 }
 476
 477 async fn route_post_crud<'a, Data>(
 478   data: web::Json<Data>,
 479   context: web::Data<LemmyContext>,
 480   apub_data: activitypub_federation::config::Data<LemmyContext>,
 481 ) -> Result<HttpResponse, Error>
 482 where
 483   Data: PerformCrud
 484     + SendActivity<Response = <Data as PerformCrud>::Response>
 485     + Clone
 486     + Deserialize<'a>
 487     + Send
 488     + 'static,
 489 {
 490   perform_crud::<Data>(data.0, context, apub_data).await
 491 }