src/api_routes.rs

   1 use actix_web::{error::ErrorBadRequest, *};
   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           .route("/transfer", web::post().to(route_post::<TransferSite>))
  23           .route("/config", web::get().to(route_get::<GetSiteConfig>))
  24           .route("/config", web::put().to(route_post::<SaveSiteConfig>)),
  25       )
  26       .service(
  27         web::resource("/modlog")
  28           .wrap(rate_limit.message())
  29           .route(web::get().to(route_get::<GetModlog>)),
  30       )
  31       .service(
  32         web::resource("/search")
  33           .wrap(rate_limit.message())
  34           .route(web::get().to(route_get::<Search>)),
  35       )
  36       // Community
  37       .service(
  38         web::resource("/community")
  39           .guard(guard::Post())
  40           .wrap(rate_limit.register())
  41           .route(web::post().to(route_post_crud::<CreateCommunity>)),
  42       )
  43       .service(
  44         web::scope("/community")
  45           .wrap(rate_limit.message())
  46           .route("", web::get().to(route_get_crud::<GetCommunity>))
  47           .route("", web::put().to(route_post_crud::<EditCommunity>))
  48           .route("/list", web::get().to(route_get_crud::<ListCommunities>))
  49           .route("/follow", web::post().to(route_post::<FollowCommunity>))
  50           .route(
  51             "/delete",
  52             web::post().to(route_post_crud::<DeleteCommunity>),
  53           )
  54           // Mod Actions
  55           .route(
  56             "/remove",
  57             web::post().to(route_post_crud::<RemoveCommunity>),
  58           )
  59           .route("/transfer", web::post().to(route_post::<TransferCommunity>))
  60           .route("/ban_user", web::post().to(route_post::<BanFromCommunity>))
  61           .route("/mod", web::post().to(route_post::<AddModToCommunity>))
  62           .route("/join", web::post().to(route_post::<CommunityJoin>))
  63           .route("/mod/join", web::post().to(route_post::<ModJoin>)),
  64       )
  65       // Post
  66       .service(
  67         // Handle POST to /post separately to add the post() rate limitter
  68         web::resource("/post")
  69           .guard(guard::Post())
  70           .wrap(rate_limit.post())
  71           .route(web::post().to(route_post_crud::<CreatePost>)),
  72       )
  73       .service(
  74         web::scope("/post")
  75           .wrap(rate_limit.message())
  76           .route("", web::get().to(route_get_crud::<GetPost>))
  77           .route("", web::put().to(route_post_crud::<EditPost>))
  78           .route("/delete", web::post().to(route_post_crud::<DeletePost>))
  79           .route("/remove", web::post().to(route_post_crud::<RemovePost>))
  80           .route("/lock", web::post().to(route_post::<LockPost>))
  81           .route("/sticky", web::post().to(route_post::<StickyPost>))
  82           .route("/list", web::get().to(route_get_crud::<GetPosts>))
  83           .route("/like", web::post().to(route_post::<CreatePostLike>))
  84           .route("/save", web::put().to(route_post::<SavePost>))
  85           .route("/join", web::post().to(route_post::<PostJoin>))
  86           .route("/report", web::post().to(route_post::<CreatePostReport>))
  87           .route(
  88             "/report/resolve",
  89             web::put().to(route_post::<ResolvePostReport>),
  90           )
  91           .route("/report/list", web::get().to(route_get::<ListPostReports>)),
  92       )
  93       // Comment
  94       .service(
  95         web::scope("/comment")
  96           .wrap(rate_limit.message())
  97           .route("", web::post().to(route_post_crud::<CreateComment>))
  98           .route("", web::put().to(route_post_crud::<EditComment>))
  99           .route("/delete", web::post().to(route_post_crud::<DeleteComment>))
 100           .route("/remove", web::post().to(route_post_crud::<RemoveComment>))
 101           .route(
 102             "/mark_as_read",
 103             web::post().to(route_post::<MarkCommentAsRead>),
 104           )
 105           .route("/like", web::post().to(route_post::<CreateCommentLike>))
 106           .route("/save", web::put().to(route_post::<SaveComment>))
 107           .route("/list", web::get().to(route_get_crud::<GetComments>))
 108           .route("/report", web::post().to(route_post::<CreateCommentReport>))
 109           .route(
 110             "/report/resolve",
 111             web::put().to(route_post::<ResolveCommentReport>),
 112           )
 113           .route(
 114             "/report/list",
 115             web::get().to(route_get::<ListCommentReports>),
 116           ),
 117       )
 118       // Private Message
 119       .service(
 120         web::scope("/private_message")
 121           .wrap(rate_limit.message())
 122           .route("/list", web::get().to(route_get_crud::<GetPrivateMessages>))
 123           .route("", web::post().to(route_post_crud::<CreatePrivateMessage>))
 124           .route("", web::put().to(route_post_crud::<EditPrivateMessage>))
 125           .route(
 126             "/delete",
 127             web::post().to(route_post_crud::<DeletePrivateMessage>),
 128           )
 129           .route(
 130             "/mark_as_read",
 131             web::post().to(route_post::<MarkPrivateMessageAsRead>),
 132           ),
 133       )
 134       // User
 135       .service(
 136         // Account action, I don't like that it's in /user maybe /accounts
 137         // Handle /user/register separately to add the register() rate limitter
 138         web::resource("/user/register")
 139           .guard(guard::Post())
 140           .wrap(rate_limit.register())
 141           .route(web::post().to(route_post_crud::<Register>)),
 142       )
 143       // User actions
 144       .service(
 145         web::scope("/user")
 146           .wrap(rate_limit.message())
 147           .route("", web::get().to(route_get_crud::<GetPersonDetails>))
 148           .route("/mention", web::get().to(route_get::<GetPersonMentions>))
 149           .route(
 150             "/mention/mark_as_read",
 151             web::post().to(route_post::<MarkPersonMentionAsRead>),
 152           )
 153           .route("/replies", web::get().to(route_get::<GetReplies>))
 154           .route(
 155             "/followed_communities",
 156             web::get().to(route_get::<GetFollowedCommunities>),
 157           )
 158           .route("/join", web::post().to(route_post::<UserJoin>))
 159           // Admin action. I don't like that it's in /user
 160           .route("/ban", web::post().to(route_post::<BanPerson>))
 161           // Account actions. I don't like that they're in /user maybe /accounts
 162           .route("/login", web::post().to(route_post::<Login>))
 163           .route("/get_captcha", web::get().to(route_get::<GetCaptcha>))
 164           .route(
 165             "/delete_account",
 166             web::post().to(route_post_crud::<DeleteAccount>),
 167           )
 168           .route(
 169             "/password_reset",
 170             web::post().to(route_post::<PasswordReset>),
 171           )
 172           .route(
 173             "/password_change",
 174             web::post().to(route_post::<PasswordChange>),
 175           )
 176           // mark_all_as_read feels off being in this section as well
 177           .route(
 178             "/mark_all_as_read",
 179             web::post().to(route_post::<MarkAllAsRead>),
 180           )
 181           .route(
 182             "/save_user_settings",
 183             web::put().to(route_post::<SaveUserSettings>),
 184           )
 185           .route("/report_count", web::get().to(route_get::<GetReportCount>)),
 186       )
 187       // Admin Actions
 188       .service(
 189         web::resource("/admin/add")
 190           .wrap(rate_limit.message())
 191           .route(web::post().to(route_post::<AddAdmin>)),
 192       ),
 193   );
 194 }
 195
 196 async fn perform<Request>(
 197   data: Request,
 198   context: web::Data<LemmyContext>,
 199 ) -> Result<HttpResponse, Error>
 200 where
 201   Request: Perform,
 202   Request: Send + 'static,
 203 {
 204   let res = data
 205     .perform(&context, None)
 206     .await
 207     .map(|json| HttpResponse::Ok().json(json))
 208     .map_err(ErrorBadRequest)?;
 209   Ok(res)
 210 }
 211
 212 async fn route_get<'a, Data>(
 213   data: web::Query<Data>,
 214   context: web::Data<LemmyContext>,
 215 ) -> Result<HttpResponse, Error>
 216 where
 217   Data: Deserialize<'a> + Send + 'static + Perform,
 218 {
 219   perform::<Data>(data.0, context).await
 220 }
 221
 222 async fn route_post<'a, Data>(
 223   data: web::Json<Data>,
 224   context: web::Data<LemmyContext>,
 225 ) -> Result<HttpResponse, Error>
 226 where
 227   Data: Deserialize<'a> + Send + 'static + Perform,
 228 {
 229   perform::<Data>(data.0, context).await
 230 }
 231
 232 async fn perform_crud<Request>(
 233   data: Request,
 234   context: web::Data<LemmyContext>,
 235 ) -> Result<HttpResponse, Error>
 236 where
 237   Request: PerformCrud,
 238   Request: Send + 'static,
 239 {
 240   let res = data
 241     .perform(&context, None)
 242     .await
 243     .map(|json| HttpResponse::Ok().json(json))
 244     .map_err(ErrorBadRequest)?;
 245   Ok(res)
 246 }
 247
 248 async fn route_get_crud<'a, Data>(
 249   data: web::Query<Data>,
 250   context: web::Data<LemmyContext>,
 251 ) -> Result<HttpResponse, Error>
 252 where
 253   Data: Deserialize<'a> + Send + 'static + PerformCrud,
 254 {
 255   perform_crud::<Data>(data.0, context).await
 256 }
 257
 258 async fn route_post_crud<'a, Data>(
 259   data: web::Json<Data>,
 260   context: web::Data<LemmyContext>,
 261 ) -> Result<HttpResponse, Error>
 262 where
 263   Data: Deserialize<'a> + Send + 'static + PerformCrud,
 264 {
 265   perform_crud::<Data>(data.0, context).await
 266 }