src/api_routes.rs

   1 use actix_web::*;
   2 use lemmy_api::Perform;
   3 use lemmy_api_common::{comment::*, community::*, person::*, post::*, site::*, websocket::*};
   4 use lemmy_api_crud::PerformCrud;
   5 use lemmy_utils::rate_limit::RateLimit;
   6 use lemmy_websocket::{routes::chat_route, LemmyContext};
   7 use serde::Deserialize;
   8
   9 pub fn config(cfg: &mut web::ServiceConfig, rate_limit: &RateLimit) {
  10   cfg.service(
  11     web::scope("/api/v3")
  12       // Websocket
  13       .service(web::resource("/ws").to(chat_route))
  14       // Site
  15       .service(
  16         web::scope("/site")
  17           .wrap(rate_limit.message())
  18           .route("", web::get().to(route_get_crud::<GetSite>))
  19           // Admin Actions
  20           .route("", web::post().to(route_post_crud::<CreateSite>))
  21           .route("", web::put().to(route_post_crud::<EditSite>)),
  22       )
  23       .service(
  24         web::resource("/modlog")
  25           .wrap(rate_limit.message())
  26           .route(web::get().to(route_get::<GetModlog>)),
  27       )
  28       .service(
  29         web::resource("/search")
  30           .wrap(rate_limit.search())
  31           .route(web::get().to(route_get::<Search>)),
  32       )
  33       .service(
  34         web::resource("/resolve_object")
  35           .wrap(rate_limit.message())
  36           .route(web::get().to(route_get::<ResolveObject>)),
  37       )
  38       // Community
  39       .service(
  40         web::resource("/community")
  41           .guard(guard::Post())
  42           .wrap(rate_limit.register())
  43           .route(web::post().to(route_post_crud::<CreateCommunity>)),
  44       )
  45       .service(
  46         web::scope("/community")
  47           .wrap(rate_limit.message())
  48           .route("", web::get().to(route_get_crud::<GetCommunity>))
  49           .route("", web::put().to(route_post_crud::<EditCommunity>))
  50           .route("/hide", web::put().to(route_post::<HideCommunity>))
  51           .route("/list", web::get().to(route_get_crud::<ListCommunities>))
  52           .route("/follow", web::post().to(route_post::<FollowCommunity>))
  53           .route("/block", web::post().to(route_post::<BlockCommunity>))
  54           .route(
  55             "/delete",
  56             web::post().to(route_post_crud::<DeleteCommunity>),
  57           )
  58           // Mod Actions
  59           .route(
  60             "/remove",
  61             web::post().to(route_post_crud::<RemoveCommunity>),
  62           )
  63           .route("/transfer", web::post().to(route_post::<TransferCommunity>))
  64           .route("/ban_user", web::post().to(route_post::<BanFromCommunity>))
  65           .route("/mod", web::post().to(route_post::<AddModToCommunity>))
  66           .route("/join", web::post().to(route_post::<CommunityJoin>))
  67           .route("/mod/join", web::post().to(route_post::<ModJoin>)),
  68       )
  69       // Post
  70       .service(
  71         // Handle POST to /post separately to add the post() rate limitter
  72         web::resource("/post")
  73           .guard(guard::Post())
  74           .wrap(rate_limit.post())
  75           .route(web::post().to(route_post_crud::<CreatePost>)),
  76       )
  77       .service(
  78         web::scope("/post")
  79           .wrap(rate_limit.message())
  80           .route("", web::get().to(route_get_crud::<GetPost>))
  81           .route("", web::put().to(route_post_crud::<EditPost>))
  82           .route("/delete", web::post().to(route_post_crud::<DeletePost>))
  83           .route("/remove", web::post().to(route_post_crud::<RemovePost>))
  84           .route(
  85             "/mark_as_read",
  86             web::post().to(route_post::<MarkPostAsRead>),
  87           )
  88           .route("/lock", web::post().to(route_post::<LockPost>))
  89           .route("/sticky", web::post().to(route_post::<StickyPost>))
  90           .route("/list", web::get().to(route_get_crud::<GetPosts>))
  91           .route("/like", web::post().to(route_post::<CreatePostLike>))
  92           .route("/save", web::put().to(route_post::<SavePost>))
  93           .route("/join", web::post().to(route_post::<PostJoin>))
  94           .route("/report", web::post().to(route_post::<CreatePostReport>))
  95           .route(
  96             "/report/resolve",
  97             web::put().to(route_post::<ResolvePostReport>),
  98           )
  99           .route("/report/list", web::get().to(route_get::<ListPostReports>))
 100           .route(
 101             "/site_metadata",
 102             web::get().to(route_get::<GetSiteMetadata>),
 103           ),
 104       )
 105       // Comment
 106       .service(
 107         // Handle POST to /comment separately to add the comment() rate limitter
 108         web::resource("/comment")
 109           .guard(guard::Post())
 110           .wrap(rate_limit.comment())
 111           .route(web::post().to(route_post_crud::<CreateComment>)),
 112       )
 113       .service(
 114         web::scope("/comment")
 115           .wrap(rate_limit.message())
 116           .route("", web::get().to(route_get_crud::<GetComment>))
 117           .route("", web::put().to(route_post_crud::<EditComment>))
 118           .route("/delete", web::post().to(route_post_crud::<DeleteComment>))
 119           .route("/remove", web::post().to(route_post_crud::<RemoveComment>))
 120           .route(
 121             "/mark_as_read",
 122             web::post().to(route_post::<MarkCommentReplyAsRead>),
 123           )
 124           .route("/like", web::post().to(route_post::<CreateCommentLike>))
 125           .route("/save", web::put().to(route_post::<SaveComment>))
 126           .route("/list", web::get().to(route_get_crud::<GetComments>))
 127           .route("/report", web::post().to(route_post::<CreateCommentReport>))
 128           .route(
 129             "/report/resolve",
 130             web::put().to(route_post::<ResolveCommentReport>),
 131           )
 132           .route(
 133             "/report/list",
 134             web::get().to(route_get::<ListCommentReports>),
 135           ),
 136       )
 137       // Private Message
 138       .service(
 139         web::scope("/private_message")
 140           .wrap(rate_limit.message())
 141           .route("/list", web::get().to(route_get_crud::<GetPrivateMessages>))
 142           .route("", web::post().to(route_post_crud::<CreatePrivateMessage>))
 143           .route("", web::put().to(route_post_crud::<EditPrivateMessage>))
 144           .route(
 145             "/delete",
 146             web::post().to(route_post_crud::<DeletePrivateMessage>),
 147           )
 148           .route(
 149             "/mark_as_read",
 150             web::post().to(route_post::<MarkPrivateMessageAsRead>),
 151           ),
 152       )
 153       // User
 154       .service(
 155         // Account action, I don't like that it's in /user maybe /accounts
 156         // Handle /user/register separately to add the register() rate limitter
 157         web::resource("/user/register")
 158           .guard(guard::Post())
 159           .wrap(rate_limit.register())
 160           .route(web::post().to(route_post_crud::<Register>)),
 161       )
 162       .service(
 163         // Handle captcha separately
 164         web::resource("/user/get_captcha")
 165           .wrap(rate_limit.post())
 166           .route(web::get().to(route_get::<GetCaptcha>)),
 167       )
 168       // User actions
 169       .service(
 170         web::scope("/user")
 171           .wrap(rate_limit.message())
 172           .route("", web::get().to(route_get_crud::<GetPersonDetails>))
 173           .route("/mention", web::get().to(route_get::<GetPersonMentions>))
 174           .route(
 175             "/mention/mark_as_read",
 176             web::post().to(route_post::<MarkPersonMentionAsRead>),
 177           )
 178           .route("/replies", web::get().to(route_get::<GetReplies>))
 179           .route("/join", web::post().to(route_post::<UserJoin>))
 180           // Admin action. I don't like that it's in /user
 181           .route("/ban", web::post().to(route_post::<BanPerson>))
 182           .route("/banned", web::get().to(route_get::<GetBannedPersons>))
 183           .route("/block", web::post().to(route_post::<BlockPerson>))
 184           // Account actions. I don't like that they're in /user maybe /accounts
 185           .route("/login", web::post().to(route_post::<Login>))
 186           .route(
 187             "/delete_account",
 188             web::post().to(route_post_crud::<DeleteAccount>),
 189           )
 190           .route(
 191             "/password_reset",
 192             web::post().to(route_post::<PasswordReset>),
 193           )
 194           .route(
 195             "/password_change",
 196             web::post().to(route_post::<PasswordChangeAfterReset>),
 197           )
 198           // mark_all_as_read feels off being in this section as well
 199           .route(
 200             "/mark_all_as_read",
 201             web::post().to(route_post::<MarkAllAsRead>),
 202           )
 203           .route(
 204             "/save_user_settings",
 205             web::put().to(route_post::<SaveUserSettings>),
 206           )
 207           .route(
 208             "/change_password",
 209             web::put().to(route_post::<ChangePassword>),
 210           )
 211           .route("/report_count", web::get().to(route_get::<GetReportCount>))
 212           .route("/unread_count", web::get().to(route_get::<GetUnreadCount>))
 213           .route("/verify_email", web::post().to(route_post::<VerifyEmail>))
 214           .route("/leave_admin", web::post().to(route_post::<LeaveAdmin>)),
 215       )
 216       // Admin Actions
 217       .service(
 218         web::scope("/admin")
 219           .wrap(rate_limit.message())
 220           .route("/add", web::post().to(route_post::<AddAdmin>))
 221           .route(
 222             "/registration_application/count",
 223             web::get().to(route_get::<GetUnreadRegistrationApplicationCount>),
 224           )
 225           .route(
 226             "/registration_application/list",
 227             web::get().to(route_get::<ListRegistrationApplications>),
 228           )
 229           .route(
 230             "/registration_application/approve",
 231             web::put().to(route_post::<ApproveRegistrationApplication>),
 232           ),
 233       )
 234       .service(
 235         web::scope("/admin/purge")
 236           .wrap(rate_limit.message())
 237           .route("/person", web::post().to(route_post::<PurgePerson>))
 238           .route("/community", web::post().to(route_post::<PurgeCommunity>))
 239           .route("/post", web::post().to(route_post::<PurgePost>))
 240           .route("/comment", web::post().to(route_post::<PurgeComment>)),
 241       ),
 242   );
 243 }
 244
 245 async fn perform<Request>(
 246   data: Request,
 247   context: web::Data<LemmyContext>,
 248 ) -> Result<HttpResponse, Error>
 249 where
 250   Request: Perform,
 251   Request: Send + 'static,
 252 {
 253   let res = data
 254     .perform(&context, None)
 255     .await
 256     .map(|json| HttpResponse::Ok().json(json))?;
 257   Ok(res)
 258 }
 259
 260 async fn route_get<'a, Data>(
 261   data: web::Query<Data>,
 262   context: web::Data<LemmyContext>,
 263 ) -> Result<HttpResponse, Error>
 264 where
 265   Data: Deserialize<'a> + Send + 'static + Perform,
 266 {
 267   perform::<Data>(data.0, context).await
 268 }
 269
 270 async fn route_post<'a, Data>(
 271   data: web::Json<Data>,
 272   context: web::Data<LemmyContext>,
 273 ) -> Result<HttpResponse, Error>
 274 where
 275   Data: Deserialize<'a> + Send + 'static + Perform,
 276 {
 277   perform::<Data>(data.0, context).await
 278 }
 279
 280 async fn perform_crud<Request>(
 281   data: Request,
 282   context: web::Data<LemmyContext>,
 283 ) -> Result<HttpResponse, Error>
 284 where
 285   Request: PerformCrud,
 286   Request: Send + 'static,
 287 {
 288   let res = data
 289     .perform(&context, None)
 290     .await
 291     .map(|json| HttpResponse::Ok().json(json))?;
 292   Ok(res)
 293 }
 294
 295 async fn route_get_crud<'a, Data>(
 296   data: web::Query<Data>,
 297   context: web::Data<LemmyContext>,
 298 ) -> Result<HttpResponse, Error>
 299 where
 300   Data: Deserialize<'a> + Send + 'static + PerformCrud,
 301 {
 302   perform_crud::<Data>(data.0, context).await
 303 }
 304
 305 async fn route_post_crud<'a, Data>(
 306   data: web::Json<Data>,
 307   context: web::Data<LemmyContext>,
 308 ) -> Result<HttpResponse, Error>
 309 where
 310   Data: Deserialize<'a> + Send + 'static + PerformCrud,
 311 {
 312   perform_crud::<Data>(data.0, context).await
 313 }