grapevine/src/service/media.rs

use std::{fmt, io::Cursor};

use image::imageops::FilterType;
use ruma::{
    api::client::error::ErrorKind, http_headers::ContentDisposition, MxcUri,
    MxcUriError, OwnedMxcUri,
};
use tokio::{
    fs::File,
    io::{AsyncReadExt, AsyncWriteExt},
};
use tracing::{debug, warn};

use crate::{services, Error, Result};

mod data;

pub(crate) use data::Data;

pub(crate) struct FileMeta {
    // This gets written to the database but we no longer read it
    //
    // TODO: Write a database migration to get rid of this and instead store
    // only the filename instead of the entire `Content-Disposition` header.
    #[allow(dead_code)]
    pub(crate) content_disposition: Option<String>,
    pub(crate) content_type: Option<String>,
}

#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub(crate) struct MediaFileKey(Vec<u8>);

impl MediaFileKey {
    pub(crate) fn new(key: Vec<u8>) -> Self {
        Self(key)
    }

    pub(crate) fn as_bytes(&self) -> &[u8] {
        &self.0
    }
}

/// Data that makes up an `mxc://` URL.
#[derive(Debug, Clone, Copy)]
pub(crate) struct MxcData<'a> {
    pub(crate) server_name: &'a ruma::ServerName,
    pub(crate) media_id: &'a str,
}

impl<'a> MxcData<'a> {
    pub(crate) fn new(
        server_name: &'a ruma::ServerName,
        media_id: &'a str,
    ) -> Result<Self> {
        if !media_id.bytes().all(|b| {
            matches!(b,
                b'0'..=b'9' | b'a'..=b'z' | b'A'..=b'Z' | b'-' | b'_'
            )
        }) {
            return Err(Error::BadRequest(
                ErrorKind::InvalidParam,
                "Invalid MXC media id",
            ));
        }

        Ok(Self {
            server_name,
            media_id,
        })
    }
}

impl fmt::Display for MxcData<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "mxc://{}/{}", self.server_name, self.media_id)
    }
}

impl From<MxcData<'_>> for OwnedMxcUri {
    fn from(value: MxcData<'_>) -> Self {
        value.to_string().into()
    }
}

impl<'a> TryFrom<&'a MxcUri> for MxcData<'a> {
    type Error = MxcUriError;

    fn try_from(value: &'a MxcUri) -> Result<Self, Self::Error> {
        Ok(Self::new(value.server_name()?, value.media_id()?)
            .expect("validated MxcUri should always be valid MxcData"))
    }
}

pub(crate) struct Service {
    pub(crate) db: &'static dyn Data,
}

impl Service {
    /// Uploads a file.
    #[tracing::instrument(skip(self, file))]
    pub(crate) async fn create(
        &self,
        mxc: MxcData<'_>,
        content_disposition: Option<&ContentDisposition>,
        content_type: Option<String>,
        file: &[u8],
    ) -> Result<FileMeta> {
        let meta = FileMeta {
            content_disposition: content_disposition
                .map(ContentDisposition::to_string),
            content_type,
        };
        // Width, Height = 0 if it's not a thumbnail
        let key = self.db.create_file_metadata(mxc, 0, 0, &meta)?;

        let path = services().globals.get_media_file(&key);
        let mut f = File::create(path).await?;
        f.write_all(file).await?;
        Ok(meta)
    }

    /// Uploads or replaces a file thumbnail.
    #[tracing::instrument(skip(self, file))]
    pub(crate) async fn upload_thumbnail(
        &self,
        mxc: MxcData<'_>,
        content_disposition: Option<String>,
        content_type: Option<String>,
        width: u32,
        height: u32,
        file: &[u8],
    ) -> Result<FileMeta> {
        let meta = FileMeta {
            content_disposition,
            content_type,
        };
        let key = self.db.create_file_metadata(mxc, width, height, &meta)?;

        let path = services().globals.get_media_file(&key);
        let mut f = File::create(path).await?;
        f.write_all(file).await?;

        Ok(meta)
    }

    /// Downloads a file.
    #[tracing::instrument(skip(self))]
    pub(crate) async fn get(
        &self,
        mxc: MxcData<'_>,
    ) -> Result<Option<(FileMeta, Vec<u8>)>> {
        if let Ok((meta, key)) = self.db.search_file_metadata(mxc, 0, 0) {
            let path = services().globals.get_media_file(&key);
            let mut file_data = Vec::new();
            let Ok(mut file) = File::open(path).await else {
                return Ok(None);
            };

            file.read_to_end(&mut file_data).await?;

            Ok(Some((meta, file_data)))
        } else {
            Ok(None)
        }
    }

    /// Returns width, height of the thumbnail and whether it should be cropped.
    /// Returns None when the server should send the original file.
    fn thumbnail_properties(
        width: u32,
        height: u32,
    ) -> Option<(u32, u32, bool)> {
        match (width, height) {
            (0..=32, 0..=32) => Some((32, 32, true)),
            (0..=96, 0..=96) => Some((96, 96, true)),
            (0..=320, 0..=240) => Some((320, 240, false)),
            (0..=640, 0..=480) => Some((640, 480, false)),
            (0..=800, 0..=600) => Some((800, 600, false)),
            _ => None,
        }
    }

    /// Generates a thumbnail from the given image file contents. Returns
    /// `Ok(None)` if the input image should be used as-is.
    #[tracing::instrument(
        skip(file),
        fields(input_size = file.len(), original_width, original_height),
    )]
    fn generate_thumbnail(
        file: &[u8],
        width: u32,
        height: u32,
        crop: bool,
    ) -> Result<Option<Vec<u8>>> {
        let image = match image::load_from_memory(file) {
            Ok(image) => image,
            Err(error) => {
                warn!(%error, "Failed to parse source image");
                return Ok(None);
            }
        };

        let original_width = image.width();
        let original_height = image.height();
        tracing::Span::current().record("original_width", original_width);
        tracing::Span::current().record("original_height", original_height);

        if width > original_width || height > original_height {
            debug!("Requested thumbnail is larger than source image");
            return Ok(None);
        }

        let thumbnail = if crop {
            image.resize_to_fill(width, height, FilterType::CatmullRom)
        } else {
            let (exact_width, exact_height) = {
                // Copied from image::dynimage::resize_dimensions
                let use_width = (u64::from(width) * u64::from(original_height))
                    <= (u64::from(original_width) * u64::from(height));
                let intermediate = if use_width {
                    u64::from(original_height) * u64::from(width)
                        / u64::from(original_width)
                } else {
                    u64::from(original_width) * u64::from(height)
                        / u64::from(original_height)
                };
                if use_width {
                    if let Ok(intermediate) = u32::try_from(intermediate) {
                        (width, intermediate)
                    } else {
                        (
                            (u64::from(width) * u64::from(u32::MAX)
                                / intermediate)
                                .try_into()
                                .unwrap_or(u32::MAX),
                            u32::MAX,
                        )
                    }
                } else if let Ok(intermediate) = u32::try_from(intermediate) {
                    (intermediate, height)
                } else {
                    (
                        u32::MAX,
                        (u64::from(height) * u64::from(u32::MAX)
                            / intermediate)
                            .try_into()
                            .unwrap_or(u32::MAX),
                    )
                }
            };

            image.thumbnail_exact(exact_width, exact_height)
        };

        debug!("Serializing thumbnail as PNG");
        let mut thumbnail_bytes = Vec::new();
        thumbnail.write_to(
            &mut Cursor::new(&mut thumbnail_bytes),
            image::ImageFormat::Png,
        )?;

        Ok(Some(thumbnail_bytes))
    }

    /// 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))]
    pub(crate) async fn get_thumbnail(
        &self,
        mxc: MxcData<'_>,
        width: u32,
        height: u32,
    ) -> Result<Option<(FileMeta, Vec<u8>)>> {
        // 0, 0 because that's the original file
        let (width, height, crop) =
            Self::thumbnail_properties(width, height).unwrap_or((0, 0, false));

        if let Ok((meta, key)) =
            self.db.search_file_metadata(mxc, width, height)
        {
            debug!("Using saved thumbnail");
            let path = services().globals.get_media_file(&key);
            let mut file = Vec::new();
            File::open(path).await?.read_to_end(&mut file).await?;

            return Ok(Some((meta, file.clone())));
        }

        let Ok((meta, key)) = self.db.search_file_metadata(mxc, 0, 0) else {
            debug!("Original image not found, can't generate thumbnail");
            return Ok(None);
        };

        let path = services().globals.get_media_file(&key);
        let mut file = Vec::new();
        File::open(path).await?.read_to_end(&mut file).await?;

        debug!("Generating thumbnail");
        let thumbnail_result = {
            let file = file.clone();
            let outer_span = tracing::span::Span::current();

            tokio::task::spawn_blocking(move || {
                outer_span.in_scope(|| {
                    Self::generate_thumbnail(&file, width, height, crop)
                })
            })
            .await
            .expect("failed to join thumbnailer task")
        };

        let Some(thumbnail_bytes) = thumbnail_result? else {
            debug!("Returning source image as-is");
            return Ok(Some((meta, file)));
        };

        debug!("Saving created thumbnail");

        // Save thumbnail in database so we don't have to generate it
        // again next time
        let thumbnail_key =
            self.db.create_file_metadata(mxc, width, height, &meta)?;

        let path = services().globals.get_media_file(&thumbnail_key);
        let mut f = File::create(path).await?;
        f.write_all(&thumbnail_bytes).await?;

        Ok(Some((meta, thumbnail_bytes.clone())))
    }
}