-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: store attachments under a shorter path (#259)
* Attachments are now stored under `<data_dir>/gurk/files/year-month-day/`. It is easier to open a shorter path from terminal. Also they are nicely grouped under the `files` folder. * If attachment has a file name, it is used when saving it, otherwise the first 8 chars of its hex digest are used. * All mimes are based on the content type field are supported now. In particular, extensions are resolved for all content types. Also upgrade presage which now verifies the digest of downloaded attachments.
- Loading branch information
Showing
5 changed files
with
253 additions
and
59 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,204 @@ | ||
| use std::path::{Path, PathBuf}; | ||
|
|
||
| use anyhow::Context; | ||
| use chrono::Local; | ||
| use mime_guess::mime::{APPLICATION_OCTET_STREAM, IMAGE_JPEG}; | ||
| use mime_guess::{get_mime_extensions, Mime}; | ||
| use presage::proto::AttachmentPointer; | ||
| use tracing::info; | ||
|
|
||
| use crate::signal::Attachment; | ||
| use crate::util::utc_timestamp_msec_to_local; | ||
|
|
||
| const DIGEST_BYTES_LEN: usize = 4; | ||
|
|
||
| pub(super) fn save( | ||
| data_dir: impl AsRef<Path>, | ||
| pointer: AttachmentPointer, | ||
| data: Vec<u8>, | ||
| ) -> anyhow::Result<Attachment> { | ||
| let base_dir = data_dir.as_ref().join("files"); | ||
|
|
||
| let digest = pointer | ||
| .digest | ||
| .as_deref() | ||
| .context("dropping attachment without digest")?; | ||
| let digest_hex = hex::encode(digest); | ||
|
|
||
| let mime: Mime = pointer | ||
| .content_type() | ||
| .parse() | ||
| .unwrap_or(APPLICATION_OCTET_STREAM); | ||
|
|
||
| let name = derive_name(&pointer, digest, &mime); | ||
|
|
||
| let date = pointer | ||
| .upload_timestamp | ||
| .map(utc_timestamp_msec_to_local) | ||
| .unwrap_or_else(Local::now) | ||
| .date_naive(); | ||
| let filedir = base_dir.join(date.to_string()); | ||
| let filepath = conflict_free_filename(&filedir, name); | ||
|
|
||
| std::fs::create_dir_all(&filedir) | ||
| .with_context(|| format!("failed to create dir: {}", filedir.display()))?; | ||
| std::fs::write(&filepath, data) | ||
| .with_context(|| format!("failed to save attachment at: {}", filepath.display()))?; | ||
|
|
||
| info!(dest =% filepath.display(), "saved attachment"); | ||
|
|
||
| Ok(Attachment { | ||
| id: digest_hex, | ||
| content_type: mime.to_string(), | ||
| filename: filepath, | ||
| size: pointer.size.unwrap_or_default(), | ||
| }) | ||
| } | ||
|
|
||
| fn conflict_free_filename(filedir: &Path, name: String) -> PathBuf { | ||
| let mut filepath = filedir.join(&name); | ||
|
|
||
| // resolve conflicts | ||
| let mut idx = 0; | ||
| while filepath.exists() { | ||
| let name_path = Path::new(&name); | ||
| match name_path.file_stem().zip(name_path.extension()) { | ||
| Some((stem, extension)) => { | ||
| idx += 1; | ||
| let stem = stem.to_string_lossy(); | ||
| let extension = extension.to_string_lossy(); | ||
| filepath = filedir.join(format!("{stem}.{idx}.{extension}")); | ||
| } | ||
| None => { | ||
| idx += 1; | ||
| filepath = filedir.join(format!("{name}.{idx}")); | ||
| } | ||
| } | ||
| } | ||
| filepath | ||
| } | ||
|
|
||
| fn derive_name(pointer: &AttachmentPointer, digest: &[u8], mime: &Mime) -> String { | ||
| pointer.file_name.clone().unwrap_or_else(|| { | ||
| let mut name = hex::encode(&digest[..DIGEST_BYTES_LEN]); | ||
| let extension = if mime == &IMAGE_JPEG { | ||
| // special case due to: <https://github.com/abonander/mime_guess/issues/59> | ||
| Some("jpeg") | ||
| } else if mime == &APPLICATION_OCTET_STREAM { | ||
| None | ||
| } else { | ||
| get_mime_extensions(mime).and_then(|extensions| extensions.first().copied()) | ||
| }; | ||
| if let Some(extension) = extension { | ||
| name.push('.'); | ||
| name.push_str(extension); | ||
| }; | ||
| name | ||
| }) | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use hex_literal::hex; | ||
|
|
||
| use super::*; | ||
|
|
||
| fn attachment_pointer( | ||
| content_type: &str, | ||
| digest: &[u8], | ||
| file_name: Option<&str>, | ||
| upload_timestamp: u64, | ||
| ) -> AttachmentPointer { | ||
| AttachmentPointer { | ||
| content_type: Some(content_type.into()), | ||
| digest: Some(digest.into()), | ||
| file_name: file_name.map(|s| s.to_owned()), | ||
| upload_timestamp: Some(upload_timestamp), | ||
| key: None, | ||
| size: Some(42), | ||
| thumbnail: None, | ||
| incremental_digest: None, | ||
| incremental_mac_chunk_size: None, | ||
| flags: None, | ||
| width: None, | ||
| height: None, | ||
| caption: None, | ||
| blur_hash: None, | ||
| cdn_number: None, | ||
| attachment_identifier: None, | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_save() { | ||
| let tempdir = tempfile::tempdir().unwrap(); | ||
|
|
||
| let digest = hex!("d51e9a355d4351ae5fbf2846d18bb384471555aa0ea6ee9075eb63f99ecddf77"); | ||
| let upload_timestamp = 1703160458 * 1000; | ||
|
|
||
| let attachment = save( | ||
| tempdir.path(), | ||
| attachment_pointer("image/jpeg", &digest, Some("image.jpeg"), upload_timestamp), | ||
| vec![42], | ||
| ) | ||
| .unwrap(); | ||
|
|
||
| assert_eq!(attachment.id, hex::encode(digest)); | ||
| assert_eq!(attachment.content_type, "image/jpeg"); | ||
| assert_eq!(attachment.size, 42); | ||
| assert_eq!( | ||
| attachment.filename, | ||
| tempdir.path().join("files/2023-12-21/image.jpeg") | ||
| ); | ||
|
|
||
| assert_eq!(std::fs::read(attachment.filename).unwrap(), &[42]); | ||
|
|
||
| // duplicate | ||
| let attachment = save( | ||
| tempdir.path(), | ||
| attachment_pointer("image/jpeg", &digest, Some("image.jpeg"), upload_timestamp), | ||
| vec![42], | ||
| ) | ||
| .unwrap(); | ||
| assert_eq!( | ||
| attachment.filename, | ||
| tempdir.path().join("files/2023-12-21/image.1.jpeg") | ||
| ); | ||
|
|
||
| // without name | ||
| let attachment = save( | ||
| tempdir.path(), | ||
| attachment_pointer("image/jpeg", &digest, None, upload_timestamp), | ||
| vec![42], | ||
| ) | ||
| .unwrap(); | ||
| assert_eq!( | ||
| attachment.filename, | ||
| tempdir.path().join("files/2023-12-21/d51e9a35.jpeg") | ||
| ); | ||
|
|
||
| // without name and mime octet-stream | ||
| let attachment = save( | ||
| tempdir.path(), | ||
| attachment_pointer("application/octet-stream", &digest, None, upload_timestamp), | ||
| vec![42], | ||
| ) | ||
| .unwrap(); | ||
| assert_eq!( | ||
| attachment.filename, | ||
| tempdir.path().join("files/2023-12-21/d51e9a35") | ||
| ); | ||
|
|
||
| // without name and mime pdf | ||
| let attachment = save( | ||
| tempdir.path(), | ||
| attachment_pointer("application/pdf", &digest, None, upload_timestamp), | ||
| vec![42], | ||
| ) | ||
| .unwrap(); | ||
| assert_eq!( | ||
| attachment.filename, | ||
| tempdir.path().join("files/2023-12-21/d51e9a35.pdf") | ||
| ); | ||
| } | ||
| } |
Oops, something went wrong.