1use core::cmp::max;
4use std::io::{Cursor, Seek};
5use std::iter::FusedIterator;
6use std::mem;
7use std::path::{Path, PathBuf};
8
9use anyhow::{ensure, format_err, Context as _, Result};
10use base64::Engine as _;
11use futures::StreamExt;
12use image::codecs::jpeg::JpegEncoder;
13use image::ImageReader;
14use image::{DynamicImage, GenericImage, GenericImageView, ImageFormat, Pixel, Rgba};
15use num_traits::FromPrimitive;
16use tokio::{fs, task};
17use tokio_stream::wrappers::ReadDirStream;
18
19use crate::config::Config;
20use crate::constants::{self, MediaQuality};
21use crate::context::Context;
22use crate::events::EventType;
23use crate::log::LogExt;
24use crate::tools::sanitize_filename;
25
26#[derive(Debug, Clone, PartialEq, Eq)]
33pub struct BlobObject<'a> {
34 blobdir: &'a Path,
35
36 name: String,
40}
41
42#[derive(Debug, Clone)]
43enum ImageOutputFormat {
44 Png,
45 Jpeg { quality: u8 },
46}
47
48impl<'a> BlobObject<'a> {
49 pub fn create_and_deduplicate(
60 context: &'a Context,
61 src: &Path,
62 original_name: &Path,
63 ) -> Result<BlobObject<'a>> {
64 task::block_in_place(|| {
69 let temp_path;
70 let src_in_blobdir: &Path;
71 let blobdir = context.get_blobdir();
72
73 if src.starts_with(blobdir) {
74 src_in_blobdir = src;
75 } else {
76 info!(
77 context,
78 "Source file not in blobdir. Copying instead of moving in order to prevent moving a file that was still needed."
79 );
80 temp_path = blobdir.join(format!("tmp-{}", rand::random::<u64>()));
81 if std::fs::copy(src, &temp_path).is_err() {
82 std::fs::create_dir_all(blobdir).log_err(context).ok();
84 std::fs::copy(src, &temp_path).context("Copying new blobfile failed")?;
85 };
86 src_in_blobdir = &temp_path;
87 }
88
89 let hash = file_hash(src_in_blobdir)?.to_hex();
90 let hash = hash.as_str();
91 let hash = hash.get(0..31).unwrap_or(hash);
92 let new_file =
93 if let Some(extension) = original_name.extension().filter(|e| e.len() <= 32) {
94 let extension = extension.to_string_lossy().to_lowercase();
95 let extension = sanitize_filename(&extension);
96 format!("$BLOBDIR/{hash}.{}", extension)
97 } else {
98 format!("$BLOBDIR/{hash}")
99 };
100
101 let blob = BlobObject {
102 blobdir,
103 name: new_file,
104 };
105 let new_path = blob.to_abs_path();
106
107 std::fs::rename(src_in_blobdir, &new_path)?;
110
111 context.emit_event(EventType::NewBlobFile(blob.as_name().to_string()));
112 Ok(blob)
113 })
114 }
115
116 pub fn create_and_deduplicate_from_bytes(
126 context: &'a Context,
127 data: &[u8],
128 original_name: &str,
129 ) -> Result<BlobObject<'a>> {
130 task::block_in_place(|| {
131 let blobdir = context.get_blobdir();
132 let temp_path = blobdir.join(format!("tmp-{}", rand::random::<u64>()));
133 if std::fs::write(&temp_path, data).is_err() {
134 std::fs::create_dir_all(blobdir).log_err(context).ok();
136 std::fs::write(&temp_path, data).context("writing new blobfile failed")?;
137 };
138
139 BlobObject::create_and_deduplicate(context, &temp_path, Path::new(original_name))
140 })
141 }
142
143 pub fn from_path(context: &'a Context, path: &Path) -> Result<BlobObject<'a>> {
150 let rel_path = path
151 .strip_prefix(context.get_blobdir())
152 .with_context(|| format!("wrong blobdir: {}", path.display()))?;
153 let name = rel_path.to_str().context("wrong name")?;
154 if !BlobObject::is_acceptible_blob_name(name) {
155 return Err(format_err!("bad blob name: {}", rel_path.display()));
156 }
157 BlobObject::from_name(context, name)
158 }
159
160 pub fn from_name(context: &'a Context, name: &str) -> Result<BlobObject<'a>> {
167 let name = match name.starts_with("$BLOBDIR/") {
168 true => name.splitn(2, '/').last().unwrap(),
169 false => name,
170 };
171 if !BlobObject::is_acceptible_blob_name(name) {
172 return Err(format_err!("not an acceptable blob name: {}", name));
173 }
174 Ok(BlobObject {
175 blobdir: context.get_blobdir(),
176 name: format!("$BLOBDIR/{name}"),
177 })
178 }
179
180 pub fn to_abs_path(&self) -> PathBuf {
182 let fname = Path::new(&self.name).strip_prefix("$BLOBDIR/").unwrap();
183 self.blobdir.join(fname)
184 }
185
186 #[allow(rustdoc::private_intra_doc_links)]
197 pub fn as_name(&self) -> &str {
199 &self.name
200 }
201
202 pub fn suffix(&self) -> Option<&str> {
207 let ext = self.name.rsplit('.').next();
208 if ext == Some(&self.name) {
209 None
210 } else {
211 ext
212 }
213 }
214
215 fn is_acceptible_blob_name(name: &str) -> bool {
223 if name.find('/').is_some() {
224 return false;
225 }
226 if name.find('\\').is_some() {
227 return false;
228 }
229 if name.find('\0').is_some() {
230 return false;
231 }
232 true
233 }
234
235 pub(crate) fn store_from_base64(context: &Context, data: &str) -> Result<String> {
241 let buf = base64::engine::general_purpose::STANDARD.decode(data)?;
242 let name = if let Ok(format) = image::guess_format(&buf) {
243 if let Some(ext) = format.extensions_str().first() {
244 format!("file.{ext}")
245 } else {
246 String::new()
247 }
248 } else {
249 String::new()
250 };
251 let blob = BlobObject::create_and_deduplicate_from_bytes(context, &buf, &name)?;
252 Ok(blob.as_name().to_string())
253 }
254
255 pub async fn recode_to_avatar_size(&mut self, context: &Context) -> Result<()> {
257 let (img_wh, max_bytes) =
258 match MediaQuality::from_i32(context.get_config_int(Config::MediaQuality).await?)
259 .unwrap_or_default()
260 {
261 MediaQuality::Balanced => (
262 constants::BALANCED_AVATAR_SIZE,
263 constants::BALANCED_AVATAR_BYTES,
264 ),
265 MediaQuality::Worse => {
266 (constants::WORSE_AVATAR_SIZE, constants::WORSE_AVATAR_BYTES)
267 }
268 };
269
270 let maybe_sticker = &mut false;
271 let is_avatar = true;
272 self.recode_to_size(
273 context,
274 None, maybe_sticker,
276 img_wh,
277 max_bytes,
278 is_avatar,
279 )?;
280
281 Ok(())
282 }
283
284 pub async fn recode_to_image_size(
292 &mut self,
293 context: &Context,
294 name: Option<String>,
295 maybe_sticker: &mut bool,
296 ) -> Result<String> {
297 let (img_wh, max_bytes) =
298 match MediaQuality::from_i32(context.get_config_int(Config::MediaQuality).await?)
299 .unwrap_or_default()
300 {
301 MediaQuality::Balanced => (
302 constants::BALANCED_IMAGE_SIZE,
303 constants::BALANCED_IMAGE_BYTES,
304 ),
305 MediaQuality::Worse => (constants::WORSE_IMAGE_SIZE, constants::WORSE_IMAGE_BYTES),
306 };
307 let is_avatar = false;
308 let new_name =
309 self.recode_to_size(context, name, maybe_sticker, img_wh, max_bytes, is_avatar)?;
310
311 Ok(new_name)
312 }
313
314 fn recode_to_size(
326 &mut self,
327 context: &Context,
328 name: Option<String>,
329 maybe_sticker: &mut bool,
330 mut img_wh: u32,
331 max_bytes: usize,
332 is_avatar: bool,
333 ) -> Result<String> {
334 let mut add_white_bg = is_avatar;
336 let mut no_exif = false;
337 let no_exif_ref = &mut no_exif;
338 let mut name = name.unwrap_or_else(|| self.name.clone());
339 let original_name = name.clone();
340 let res: Result<String> = tokio::task::block_in_place(move || {
341 let mut file = std::fs::File::open(self.to_abs_path())?;
342 let (nr_bytes, exif) = image_metadata(&file)?;
343 *no_exif_ref = exif.is_none();
344 file.rewind()?;
347 let imgreader = ImageReader::new(std::io::BufReader::new(&file)).with_guessed_format();
348 let imgreader = match imgreader {
349 Ok(ir) => ir,
350 _ => {
351 file.rewind()?;
352 ImageReader::with_format(
353 std::io::BufReader::new(&file),
354 ImageFormat::from_path(self.to_abs_path())?,
355 )
356 }
357 };
358 let fmt = imgreader.format().context("No format??")?;
359 let mut img = imgreader.decode().context("image decode failure")?;
360 let orientation = exif.as_ref().map(|exif| exif_orientation(exif, context));
361 let mut encoded = Vec::new();
362
363 if *maybe_sticker {
364 let x_max = img.width().saturating_sub(1);
365 let y_max = img.height().saturating_sub(1);
366 *maybe_sticker = img.in_bounds(x_max, y_max)
367 && (img.get_pixel(0, 0).0[3] == 0
368 || img.get_pixel(x_max, 0).0[3] == 0
369 || img.get_pixel(0, y_max).0[3] == 0
370 || img.get_pixel(x_max, y_max).0[3] == 0);
371 }
372 if *maybe_sticker && exif.is_none() {
373 return Ok(name);
374 }
375
376 img = match orientation {
377 Some(90) => img.rotate90(),
378 Some(180) => img.rotate180(),
379 Some(270) => img.rotate270(),
380 _ => img,
381 };
382
383 let exceeds_wh = img.width() > img_wh || img.height() > img_wh;
384 let exceeds_max_bytes = nr_bytes > max_bytes as u64;
385
386 let jpeg_quality = 75;
387 let ofmt = match fmt {
388 ImageFormat::Png if !exceeds_max_bytes => ImageOutputFormat::Png,
389 ImageFormat::Jpeg => {
390 add_white_bg = false;
391 ImageOutputFormat::Jpeg {
392 quality: jpeg_quality,
393 }
394 }
395 _ => ImageOutputFormat::Jpeg {
396 quality: jpeg_quality,
397 },
398 };
399 let do_scale = exceeds_max_bytes
406 || is_avatar
407 && (exceeds_wh
408 || exif.is_some() && {
409 if mem::take(&mut add_white_bg) {
410 self::add_white_bg(&mut img);
411 }
412 encoded_img_exceeds_bytes(
413 context,
414 &img,
415 ofmt.clone(),
416 max_bytes,
417 &mut encoded,
418 )?
419 });
420
421 if do_scale {
422 if !exceeds_wh {
423 img_wh = max(img.width(), img.height());
424 if matches!(fmt, ImageFormat::Jpeg) || !encoded.is_empty() {
427 img_wh = img_wh * 2 / 3;
428 }
429 }
430
431 loop {
432 if mem::take(&mut add_white_bg) {
433 self::add_white_bg(&mut img);
434 }
435
436 let new_img = if is_avatar {
445 img.resize(img_wh, img_wh, image::imageops::FilterType::Triangle)
446 } else {
447 img.thumbnail(img_wh, img_wh)
448 };
449
450 if encoded_img_exceeds_bytes(
451 context,
452 &new_img,
453 ofmt.clone(),
454 max_bytes,
455 &mut encoded,
456 )? && is_avatar
457 {
458 if img_wh < 20 {
459 return Err(format_err!(
460 "Failed to scale image to below {}B.",
461 max_bytes,
462 ));
463 }
464
465 img_wh = img_wh * 2 / 3;
466 } else {
467 info!(
468 context,
469 "Final scaled-down image size: {}B ({}px).",
470 encoded.len(),
471 img_wh
472 );
473 break;
474 }
475 }
476 }
477
478 if do_scale || exif.is_some() {
479 if !matches!(fmt, ImageFormat::Jpeg)
481 && matches!(ofmt, ImageOutputFormat::Jpeg { .. })
482 {
483 name = Path::new(&name)
484 .with_extension("jpg")
485 .to_string_lossy()
486 .into_owned();
487 }
488
489 if encoded.is_empty() {
490 if mem::take(&mut add_white_bg) {
491 self::add_white_bg(&mut img);
492 }
493 encode_img(&img, ofmt, &mut encoded)?;
494 }
495
496 self.name = BlobObject::create_and_deduplicate_from_bytes(context, &encoded, &name)
497 .context("failed to write recoded blob to file")?
498 .name;
499 }
500
501 Ok(name)
502 });
503 match res {
504 Ok(_) => res,
505 Err(err) => {
506 if !is_avatar && no_exif {
507 warn!(
508 context,
509 "Cannot recode image, using original data: {err:#}.",
510 );
511 Ok(original_name)
512 } else {
513 Err(err)
514 }
515 }
516 }
517 }
518}
519
520fn file_hash(src: &Path) -> Result<blake3::Hash> {
521 ensure!(
522 !src.starts_with("$BLOBDIR/"),
523 "Use `get_abs_path()` to get the absolute path of the blobfile"
524 );
525 let mut hasher = blake3::Hasher::new();
526 let mut src_file = std::fs::File::open(src)
527 .with_context(|| format!("Failed to open file {}", src.display()))?;
528 hasher
529 .update_reader(&mut src_file)
530 .context("update_reader")?;
531 let hash = hasher.finalize();
532 Ok(hash)
533}
534
535fn image_metadata(file: &std::fs::File) -> Result<(u64, Option<exif::Exif>)> {
537 let len = file.metadata()?.len();
538 let mut bufreader = std::io::BufReader::new(file);
539 let exif = exif::Reader::new().read_from_container(&mut bufreader).ok();
540 Ok((len, exif))
541}
542
543fn exif_orientation(exif: &exif::Exif, context: &Context) -> i32 {
544 if let Some(orientation) = exif.get_field(exif::Tag::Orientation, exif::In::PRIMARY) {
545 match orientation.value.get_uint(0) {
548 Some(3) => return 180,
549 Some(6) => return 90,
550 Some(8) => return 270,
551 other => warn!(context, "Exif orientation value ignored: {other:?}."),
552 }
553 }
554 0
555}
556
557pub(crate) struct BlobDirContents<'a> {
564 inner: Vec<PathBuf>,
565 context: &'a Context,
566}
567
568impl<'a> BlobDirContents<'a> {
569 pub(crate) async fn new(context: &'a Context) -> Result<BlobDirContents<'a>> {
570 let readdir = fs::read_dir(context.get_blobdir()).await?;
571 let inner = ReadDirStream::new(readdir)
572 .filter_map(|entry| async move {
573 match entry {
574 Ok(entry) => Some(entry),
575 Err(err) => {
576 error!(context, "Failed to read blob file: {err}.");
577 None
578 }
579 }
580 })
581 .filter_map(|entry| async move {
582 match entry.file_type().await.ok()?.is_file() {
583 true => Some(entry.path()),
584 false => {
585 warn!(
586 context,
587 "Export: Found blob dir entry {} that is not a file, ignoring.",
588 entry.path().display()
589 );
590 None
591 }
592 }
593 })
594 .collect()
595 .await;
596 Ok(Self { inner, context })
597 }
598
599 pub(crate) fn iter(&self) -> BlobDirIter<'_> {
600 BlobDirIter::new(self.context, self.inner.iter())
601 }
602}
603
604pub(crate) struct BlobDirIter<'a> {
606 iter: std::slice::Iter<'a, PathBuf>,
607 context: &'a Context,
608}
609
610impl<'a> BlobDirIter<'a> {
611 fn new(context: &'a Context, iter: std::slice::Iter<'a, PathBuf>) -> BlobDirIter<'a> {
612 Self { iter, context }
613 }
614}
615
616impl<'a> Iterator for BlobDirIter<'a> {
617 type Item = BlobObject<'a>;
618
619 fn next(&mut self) -> Option<Self::Item> {
620 for path in self.iter.by_ref() {
621 match BlobObject::from_path(self.context, path) {
624 Ok(blob) => return Some(blob),
625 Err(err) => warn!(self.context, "{err}"),
626 }
627 }
628 None
629 }
630}
631
632impl FusedIterator for BlobDirIter<'_> {}
633
634fn encode_img(
635 img: &DynamicImage,
636 fmt: ImageOutputFormat,
637 encoded: &mut Vec<u8>,
638) -> anyhow::Result<()> {
639 encoded.clear();
640 let mut buf = Cursor::new(encoded);
641 match fmt {
642 ImageOutputFormat::Png => img.write_to(&mut buf, ImageFormat::Png)?,
643 ImageOutputFormat::Jpeg { quality } => {
644 let encoder = JpegEncoder::new_with_quality(&mut buf, quality);
645 img.clone().into_rgb8().write_with_encoder(encoder)?;
649 }
650 }
651 Ok(())
652}
653
654fn encoded_img_exceeds_bytes(
655 context: &Context,
656 img: &DynamicImage,
657 fmt: ImageOutputFormat,
658 max_bytes: usize,
659 encoded: &mut Vec<u8>,
660) -> anyhow::Result<bool> {
661 encode_img(img, fmt, encoded)?;
662 if encoded.len() > max_bytes {
663 info!(
664 context,
665 "Image size {}B ({}x{}px) exceeds {}B, need to scale down.",
666 encoded.len(),
667 img.width(),
668 img.height(),
669 max_bytes,
670 );
671 return Ok(true);
672 }
673 Ok(false)
674}
675
676fn add_white_bg(img: &mut DynamicImage) {
678 for y in 0..img.height() {
679 for x in 0..img.width() {
680 let mut p = Rgba([255u8, 255, 255, 255]);
681 p.blend(&img.get_pixel(x, y));
682 img.put_pixel(x, y, p);
683 }
684 }
685}
686
687#[cfg(test)]
688mod blob_tests;