src/multipart.rs

   1 // Copyright 2021 Ian Jackson and contributors to Hippotat
   2 // SPDX-License-Identifier: GPL-3.0-or-later
   3 // There is NO WARRANTY.
   4
   5 use crate::prelude::*;
   6
   7 #[derive(Debug)]
   8 pub struct Component<'b> {
   9   pub name: PartName,
  10   pub payload: &'b [u8],
  11 }
  12
  13 #[derive(Debug)]
  14 #[derive(Eq,PartialEq,Ord,PartialOrd,Hash)]
  15 #[allow(non_camel_case_types)]
  16 pub enum PartName { m, d, Other }
  17
  18 pub type BoundaryFinder = memchr::memmem::Finder<'static>;
  19
  20 #[throws(AE)]
  21 /// Processes the start of a component (or terminating boundary).
  22 ///
  23 /// Returned payload is only the start of the payload; the next
  24 /// boundary has not been identified.
  25 pub fn process_boundary<'b>(warnings: &mut Warnings,
  26                             after_leader: &'b [u8], expected: PartName)
  27                             -> Option<Component<'b>> {
  28   let rhs = after_leader;
  29   let mut rhs =
  30        if let Some(rhs) = rhs.strip_prefix(b"\r\n") { rhs         }
  31   else if let Some(_  ) = rhs.strip_prefix(b"--"  ) { return None }
  32   else if let Some(rhs) = rhs.strip_prefix(b"\n"  ) { rhs         }
  33   else { throw!(anyhow!("invalid multipart delimiter")) };
  34
  35   let mut part_name = None;
  36
  37   loop {
  38     // RHS points to the start of a header line
  39     let nl = memchr::memchr(b'\n', rhs)
  40       .ok_or_else(|| anyhow!("part headers truncated"))?;
  41     let l = &rhs[0..nl]; rhs = &rhs[nl+1..];
  42     if l == b"\r" || l == b"" { break } // end of headers
  43     if l.starts_with(b"--") { throw!(anyhow!("boundary in part headers")) }
  44
  45     match (||{
  46       let l = str::from_utf8(l).context("interpret part headers as utf-8")?;
  47
  48       let (_, disposition) = if let Some(y) =
  49         regex_captures!(r#"^Content-Disposition[ \t]*:[ \t]*(.*)$"#i, l) { y }
  50         else { return Ok(()) };
  51
  52       let disposition = disposition.trim_end();
  53       if disposition.len() >= 100 { throw!(anyhow!(
  54         "Content-Disposition value implausibly long"
  55       )) }
  56
  57       // todo: replace with mailparse?
  58       // (not in side, dep on charset not in sid)
  59       // also seems to box for all the bits
  60
  61       // This let's us pretend it's a mime type, so we can use mime::Mime
  62       let disposition = format!("dummy/{}", disposition);
  63
  64       let disposition: mime::Mime = disposition.parse()
  65         .context("parse Content-Disposition")?;
  66       let name = disposition.get_param("name")
  67         .ok_or_else(|| anyhow!(r#"find "name" in Content-Disposition"#))?;
  68
  69       let name = match name.as_ref() {
  70         "m" => PartName::m,
  71         "d" => PartName::d,
  72         _   => PartName::Other,
  73       };
  74
  75       if let Some(_) = mem::replace(&mut part_name, Some(name)) {
  76         throw!(anyhow!(r#"multiple "name"s in Content-Disposition(s)"#))
  77       }
  78       Ok::<_,AE>(())
  79     })() {
  80       Err(e) => warnings.add(&e)?,
  81       Ok(()) => { },
  82     };
  83   }
  84
  85   Some(Component { name: part_name.unwrap_or(expected), payload: rhs })
  86 }
  87
  88 pub struct ComponentIterator<'b> {
  89   at_boundary: &'b [u8],
  90   boundary_finder: BoundaryFinder,
  91 }
  92
  93 #[derive(Error,Debug)]
  94 #[error("missing mime multipart boundary")]
  95 pub struct MissingBoundary;
  96
  97 impl<'b> ComponentIterator<'b> {
  98   #[throws(MissingBoundary)]
  99   pub fn resume_mid_component(buf: &'b [u8], boundary_finder: BoundaryFinder)
 100                               -> (&'b [u8], Self) {
 101     let next_boundary = boundary_finder.find(buf).ok_or(MissingBoundary)?;
 102     let part = &buf[0..next_boundary];
 103     let part = Self::payload_trim(part);
 104     (part, ComponentIterator {
 105       at_boundary: &buf[next_boundary..],
 106       boundary_finder,
 107     })
 108   }
 109
 110   fn payload_trim(payload: &[u8]) -> &[u8] {
 111     payload.strip_suffix(b"\r").unwrap_or(payload)
 112   }
 113
 114   #[throws(AE)]
 115   pub fn next(&mut self, warnings: &mut Warnings, expected: PartName)
 116               -> Option<Component<'b>> {
 117     if self.at_boundary.is_empty() { return None }
 118
 119     let mut comp = match {
 120       let boundary_len = self.boundary_finder.needle().len();
 121       process_boundary(warnings,
 122                        &self.at_boundary[boundary_len..],
 123                        expected)?
 124     } {
 125       None => {
 126         self.at_boundary = &self.at_boundary[0..0];
 127         return None;
 128       },
 129       Some(c) => c,
 130     };
 131
 132     let next_boundary = self.boundary_finder.find(&comp.payload)
 133       .ok_or(MissingBoundary)?;
 134
 135     comp.payload = Self::payload_trim(&comp.payload[0..next_boundary]);
 136     self.at_boundary = &self.at_boundary[next_boundary..];
 137     Some(comp)
 138   }
 139 }
 140
 141 pub struct MetadataFieldIterator<'b> {
 142   buf: &'b [u8],
 143   last: Option<usize>,
 144   iter: memchr::Memchr<'b>,
 145 }
 146
 147 impl<'b> MetadataFieldIterator<'b> {
 148   pub fn new(buf: &'b [u8]) -> Self { Self {
 149     buf,
 150     last: Some(0),
 151     iter: memchr::Memchr::new(b'\n', buf),
 152   } }
 153
 154   #[throws(AE)]
 155   pub fn need_next(&mut self) -> &'b str
 156   {
 157     self.next().ok_or_else(|| anyhow!("missing"))??
 158   }
 159
 160   #[throws(AE)]
 161   pub fn need_parse<T>(&mut self) -> T
 162   where T: FromStr,
 163         AE: From<T::Err>,
 164   {
 165     self.parse()?.ok_or_else(|| anyhow!("missing"))?
 166   }
 167
 168   #[throws(AE)]
 169   pub fn parse<T>(&mut self) -> Option<T>
 170   where T: FromStr,
 171         AE: From<T::Err>,
 172   {
 173     let s = if let Some(r) = self.next() { r? } else { return None };
 174     Some(s.parse()?)
 175   }
 176
 177   pub fn remaining_bytes_len(&self) -> usize {
 178     if let Some(last) = self.last {
 179       self.buf.len() - last
 180     } else {
 181       0
 182     }
 183   }
 184 }
 185
 186 impl<'b> Iterator for MetadataFieldIterator<'b> {
 187   type Item = Result<&'b str, std::str::Utf8Error>;
 188   fn next(&mut self) -> Option<Result<&'b str, std::str::Utf8Error>> {
 189     let last = self.last?;
 190     let (s, last) = match self.iter.next() {
 191       Some(nl) => (&self.buf[last..nl], Some(nl+1)),
 192       None     => (&self.buf[last..],   None),
 193     };
 194     self.last = last;
 195     let s = str::from_utf8(s).map(|s| s.trim());
 196     Some(s)
 197   }
 198 }
 199 impl<'b> std::iter::FusedIterator for MetadataFieldIterator<'b> { }