crates/routes/src/images.rs

   1 use actix_web::{
   2   body::BodyStream,
   3   error,
   4   http::{
   5     header::{HeaderName, ACCEPT_ENCODING, HOST},
   6     StatusCode,
   7   },
   8   web,
   9   Error,
  10   HttpRequest,
  11   HttpResponse,
  12 };
  13 use futures::stream::{Stream, StreamExt};
  14 use lemmy_api_common::utils::get_local_user_view_from_jwt;
  15 use lemmy_db_schema::source::local_site::LocalSite;
  16 use lemmy_utils::{claims::Claims, rate_limit::RateLimit, REQWEST_TIMEOUT};
  17 use lemmy_websocket::LemmyContext;
  18 use reqwest::Body;
  19 use reqwest_middleware::{ClientWithMiddleware, RequestBuilder};
  20 use serde::{Deserialize, Serialize};
  21
  22 pub fn config(cfg: &mut web::ServiceConfig, client: ClientWithMiddleware, rate_limit: &RateLimit) {
  23   cfg
  24     .app_data(web::Data::new(client))
  25     .service(
  26       web::resource("/pictrs/image")
  27         .wrap(rate_limit.image())
  28         .route(web::post().to(upload)),
  29     )
  30     // This has optional query params: /image/{filename}?format=jpg&thumbnail=256
  31     .service(web::resource("/pictrs/image/{filename}").route(web::get().to(full_res)))
  32     .service(web::resource("/pictrs/image/delete/{token}/{filename}").route(web::get().to(delete)));
  33 }
  34
  35 #[derive(Debug, Serialize, Deserialize)]
  36 struct Image {
  37   file: String,
  38   delete_token: String,
  39 }
  40
  41 #[derive(Debug, Serialize, Deserialize)]
  42 struct Images {
  43   msg: String,
  44   files: Option<Vec<Image>>,
  45 }
  46
  47 #[derive(Deserialize)]
  48 struct PictrsParams {
  49   format: Option<String>,
  50   thumbnail: Option<i32>,
  51 }
  52
  53 #[derive(Deserialize)]
  54 enum PictrsPurgeParams {
  55   #[serde(rename = "file")]
  56   File(String),
  57   #[serde(rename = "alias")]
  58   Alias(String),
  59 }
  60
  61 fn adapt_request(
  62   request: &HttpRequest,
  63   client: &ClientWithMiddleware,
  64   url: String,
  65 ) -> RequestBuilder {
  66   // remove accept-encoding header so that pictrs doesnt compress the response
  67   const INVALID_HEADERS: &[HeaderName] = &[ACCEPT_ENCODING, HOST];
  68
  69   let client_request = client
  70     .request(request.method().clone(), url)
  71     .timeout(REQWEST_TIMEOUT);
  72
  73   request
  74     .headers()
  75     .iter()
  76     .fold(client_request, |client_req, (key, value)| {
  77       if INVALID_HEADERS.contains(key) {
  78         client_req
  79       } else {
  80         client_req.header(key, value)
  81       }
  82     })
  83 }
  84
  85 async fn upload(
  86   req: HttpRequest,
  87   body: web::Payload,
  88   client: web::Data<ClientWithMiddleware>,
  89   context: web::Data<LemmyContext>,
  90 ) -> Result<HttpResponse, Error> {
  91   // TODO: check rate limit here
  92   let jwt = req
  93     .cookie("jwt")
  94     .expect("No auth header for picture upload");
  95
  96   if Claims::decode(jwt.value(), &context.secret().jwt_secret).is_err() {
  97     return Ok(HttpResponse::Unauthorized().finish());
  98   };
  99
 100   let pictrs_config = context.settings().pictrs_config()?;
 101   let image_url = format!("{}image", pictrs_config.url);
 102
 103   let mut client_req = adapt_request(&req, &client, image_url);
 104
 105   if let Some(addr) = req.head().peer_addr {
 106     client_req = client_req.header("X-Forwarded-For", addr.to_string())
 107   };
 108
 109   let res = client_req
 110     .body(Body::wrap_stream(make_send(body)))
 111     .send()
 112     .await
 113     .map_err(error::ErrorBadRequest)?;
 114
 115   let status = res.status();
 116   let images = res.json::<Images>().await.map_err(error::ErrorBadRequest)?;
 117
 118   Ok(HttpResponse::build(status).json(images))
 119 }
 120
 121 async fn full_res(
 122   filename: web::Path<String>,
 123   web::Query(params): web::Query<PictrsParams>,
 124   req: HttpRequest,
 125   client: web::Data<ClientWithMiddleware>,
 126   context: web::Data<LemmyContext>,
 127 ) -> Result<HttpResponse, Error> {
 128   // block access to images if instance is private and unauthorized, public
 129   let local_site = LocalSite::read(context.pool())
 130     .await
 131     .map_err(error::ErrorBadRequest)?;
 132   if local_site.private_instance {
 133     let jwt = req
 134       .cookie("jwt")
 135       .expect("No auth header for picture access");
 136     if get_local_user_view_from_jwt(jwt.value(), context.pool(), context.secret())
 137       .await
 138       .is_err()
 139     {
 140       return Ok(HttpResponse::Unauthorized().finish());
 141     };
 142   }
 143   let name = &filename.into_inner();
 144
 145   // If there are no query params, the URL is original
 146   let pictrs_config = context.settings().pictrs_config()?;
 147   let url = if params.format.is_none() && params.thumbnail.is_none() {
 148     format!("{}image/original/{}", pictrs_config.url, name,)
 149   } else {
 150     // Take file type from name, or jpg if nothing is given
 151     let format = params
 152       .format
 153       .unwrap_or_else(|| name.split('.').last().unwrap_or("jpg").to_string());
 154
 155     let mut url = format!("{}image/process.{}?src={}", pictrs_config.url, format, name,);
 156
 157     if let Some(size) = params.thumbnail {
 158       url = format!("{}&thumbnail={}", url, size,);
 159     }
 160     url
 161   };
 162
 163   image(url, req, client).await
 164 }
 165
 166 async fn image(
 167   url: String,
 168   req: HttpRequest,
 169   client: web::Data<ClientWithMiddleware>,
 170 ) -> Result<HttpResponse, Error> {
 171   let mut client_req = adapt_request(&req, &client, url);
 172
 173   if let Some(addr) = req.head().peer_addr {
 174     client_req = client_req.header("X-Forwarded-For", addr.to_string());
 175   }
 176
 177   if let Some(addr) = req.head().peer_addr {
 178     client_req = client_req.header("X-Forwarded-For", addr.to_string());
 179   }
 180
 181   let res = client_req.send().await.map_err(error::ErrorBadRequest)?;
 182
 183   if res.status() == StatusCode::NOT_FOUND {
 184     return Ok(HttpResponse::NotFound().finish());
 185   }
 186
 187   let mut client_res = HttpResponse::build(res.status());
 188
 189   for (name, value) in res.headers().iter().filter(|(h, _)| *h != "connection") {
 190     client_res.insert_header((name.clone(), value.clone()));
 191   }
 192
 193   Ok(client_res.body(BodyStream::new(res.bytes_stream())))
 194 }
 195
 196 async fn delete(
 197   components: web::Path<(String, String)>,
 198   req: HttpRequest,
 199   client: web::Data<ClientWithMiddleware>,
 200   context: web::Data<LemmyContext>,
 201 ) -> Result<HttpResponse, Error> {
 202   let (token, file) = components.into_inner();
 203
 204   let pictrs_config = context.settings().pictrs_config()?;
 205   let url = format!("{}image/delete/{}/{}", pictrs_config.url, &token, &file);
 206
 207   let mut client_req = adapt_request(&req, &client, url);
 208
 209   if let Some(addr) = req.head().peer_addr {
 210     client_req = client_req.header("X-Forwarded-For", addr.to_string());
 211   }
 212
 213   let res = client_req.send().await.map_err(error::ErrorBadRequest)?;
 214
 215   Ok(HttpResponse::build(res.status()).body(BodyStream::new(res.bytes_stream())))
 216 }
 217
 218 fn make_send<S>(mut stream: S) -> impl Stream<Item = S::Item> + Send + Unpin + 'static
 219 where
 220   S: Stream + Unpin + 'static,
 221   S::Item: Send,
 222 {
 223   // NOTE: the 8 here is arbitrary
 224   let (tx, rx) = tokio::sync::mpsc::channel(8);
 225
 226   // NOTE: spawning stream into a new task can potentially hit this bug:
 227   // - https://github.com/actix/actix-web/issues/1679
 228   //
 229   // Since 4.0.0-beta.2 this issue is incredibly less frequent. I have not personally reproduced it.
 230   // That said, it is still technically possible to encounter.
 231   actix_web::rt::spawn(async move {
 232     while let Some(res) = stream.next().await {
 233       if tx.send(res).await.is_err() {
 234         break;
 235       }
 236     }
 237   });
 238
 239   SendStream { rx }
 240 }
 241
 242 struct SendStream<T> {
 243   rx: tokio::sync::mpsc::Receiver<T>,
 244 }
 245
 246 impl<T> Stream for SendStream<T>
 247 where
 248   T: Send,
 249 {
 250   type Item = T;
 251
 252   fn poll_next(
 253     mut self: std::pin::Pin<&mut Self>,
 254     cx: &mut std::task::Context<'_>,
 255   ) -> std::task::Poll<Option<Self::Item>> {
 256     std::pin::Pin::new(&mut self.rx).poll_recv(cx)
 257   }
 258 }