src/routes/api.rs

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