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