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