use std::{cmp, io::Cursor, num::Saturating as Sat}; use conduit::{checked, err, Result}; use image::{imageops::FilterType, DynamicImage}; use ruma::{http_headers::ContentDisposition, media::Method, Mxc, UInt, UserId}; use tokio::{ fs, io::{AsyncReadExt, AsyncWriteExt}, }; use super::{data::Metadata, FileMeta}; /// Dimension specification for a thumbnail. #[derive(Debug)] pub struct Dim { pub width: u32, pub height: u32, pub method: Method, } impl super::Service { /// Uploads or replaces a file thumbnail. #[allow(clippy::too_many_arguments)] pub async fn upload_thumbnail( &self, mxc: &Mxc<'_>, user: Option<&UserId>, content_disposition: Option<&ContentDisposition>, content_type: Option<&str>, dim: &Dim, file: &[u8], ) -> Result<()> { let key = self .db .create_file_metadata(mxc, user, dim, content_disposition, content_type)?; //TODO: Dangling metadata in database if creation fails let mut f = self.create_media_file(&key).await?; f.write_all(file).await?; Ok(()) } /// Downloads a file's thumbnail. /// /// Here's an example on how it works: /// /// - Client requests an image with width=567, height=567 /// - Server rounds that up to (800, 600), so it doesn't have to save too /// many thumbnails /// - Server rounds that up again to (958, 600) to fix the aspect ratio /// (only for width,height>96) /// - Server creates the thumbnail and sends it to the user /// /// For width,height <= 96 the server uses another thumbnailing algorithm /// which crops the image afterwards. #[tracing::instrument(skip(self), name = "thumbnail", level = "debug")] pub async fn get_thumbnail(&self, mxc: &Mxc<'_>, dim: &Dim) -> Result> { // 0, 0 because that's the original file let dim = dim.normalized(); if let Ok(metadata) = self.db.search_file_metadata(mxc, &dim).await { self.get_thumbnail_saved(metadata).await } else if let Ok(metadata) = self.db.search_file_metadata(mxc, &Dim::default()).await { self.get_thumbnail_generate(mxc, &dim, metadata).await } else { Ok(None) } } /// Using saved thumbnail #[tracing::instrument(skip(self), name = "saved", level = "debug")] async fn get_thumbnail_saved(&self, data: Metadata) -> Result> { let mut content = Vec::new(); let path = self.get_media_file(&data.key); fs::File::open(path) .await? .read_to_end(&mut content) .await?; Ok(Some(into_filemeta(data, content))) } /// Generate a thumbnail #[tracing::instrument(skip(self), name = "generate", level = "debug")] async fn get_thumbnail_generate(&self, mxc: &Mxc<'_>, dim: &Dim, data: Metadata) -> Result> { let mut content = Vec::new(); let path = self.get_media_file(&data.key); fs::File::open(path) .await? .read_to_end(&mut content) .await?; let Ok(image) = image::load_from_memory(&content) else { // Couldn't parse file to generate thumbnail, send original return Ok(Some(into_filemeta(data, content))); }; if dim.width > image.width() || dim.height > image.height() { return Ok(Some(into_filemeta(data, content))); } let mut thumbnail_bytes = Vec::new(); let thumbnail = thumbnail_generate(&image, dim)?; thumbnail.write_to(&mut Cursor::new(&mut thumbnail_bytes), image::ImageFormat::Png)?; // Save thumbnail in database so we don't have to generate it again next time let thumbnail_key = self.db.create_file_metadata( mxc, None, dim, data.content_disposition.as_ref(), data.content_type.as_deref(), )?; let mut f = self.create_media_file(&thumbnail_key).await?; f.write_all(&thumbnail_bytes).await?; Ok(Some(into_filemeta(data, thumbnail_bytes))) } } fn thumbnail_generate(image: &DynamicImage, requested: &Dim) -> Result { let thumbnail = if !requested.crop() { let Dim { width, height, .. } = requested.scaled(&Dim { width: image.width(), height: image.height(), ..Dim::default() })?; image.thumbnail_exact(width, height) } else { image.resize_to_fill(requested.width, requested.height, FilterType::CatmullRom) }; Ok(thumbnail) } fn into_filemeta(data: Metadata, content: Vec) -> FileMeta { FileMeta { content: Some(content), content_type: data.content_type, content_disposition: data.content_disposition, } } impl Dim { /// Instantiate a Dim from Ruma integers with optional method. pub fn from_ruma(width: UInt, height: UInt, method: Option) -> Result { let width = width .try_into() .map_err(|e| err!(Request(InvalidParam("Width is invalid: {e:?}"))))?; let height = height .try_into() .map_err(|e| err!(Request(InvalidParam("Height is invalid: {e:?}"))))?; Ok(Self::new(width, height, method)) } /// Instantiate a Dim with optional method #[inline] #[must_use] pub fn new(width: u32, height: u32, method: Option) -> Self { Self { width, height, method: method.unwrap_or(Method::Scale), } } pub fn scaled(&self, image: &Self) -> Result { let image_width = image.width; let image_height = image.height; let width = cmp::min(self.width, image_width); let height = cmp::min(self.height, image_height); let use_width = Sat(width) * Sat(image_height) < Sat(height) * Sat(image_width); let x = if use_width { let dividend = (Sat(height) * Sat(image_width)).0; checked!(dividend / image_height)? } else { width }; let y = if !use_width { let dividend = (Sat(width) * Sat(image_height)).0; checked!(dividend / image_width)? } else { height }; Ok(Self { width: x, height: y, method: Method::Scale, }) } /// Returns width, height of the thumbnail and whether it should be cropped. /// Returns None when the server should send the original file. /// Ignores the input Method. #[must_use] pub fn normalized(&self) -> Self { match (self.width, self.height) { (0..=32, 0..=32) => Self::new(32, 32, Some(Method::Crop)), (0..=96, 0..=96) => Self::new(96, 96, Some(Method::Crop)), (0..=320, 0..=240) => Self::new(320, 240, Some(Method::Scale)), (0..=640, 0..=480) => Self::new(640, 480, Some(Method::Scale)), (0..=800, 0..=600) => Self::new(800, 600, Some(Method::Scale)), _ => Self::default(), } } /// Returns true if the method is Crop. #[inline] #[must_use] pub fn crop(&self) -> bool { self.method == Method::Crop } } impl Default for Dim { #[inline] fn default() -> Self { Self { width: 0, height: 0, method: Method::Scale, } } }