use std::borrow::Borrow; use std::num::NonZeroU32; use std::sync::Arc; use anyhow::{anyhow, bail, Error, Result}; use boitalettres::proto::res::body::Data as Body; use chrono::{Offset, TimeZone, Utc}; use futures::stream::{FuturesOrdered, StreamExt}; use imap_codec::types::address::Address; use imap_codec::types::body::{BasicFields, Body as FetchBody, BodyStructure, SpecificFields}; use imap_codec::types::core::{Atom, IString, NString, NonZeroBytes}; use imap_codec::types::datetime::MyDateTime; use imap_codec::types::envelope::Envelope; use imap_codec::types::fetch_attributes::{FetchAttribute, MacroOrFetchAttributes}; use imap_codec::types::flag::Flag; use imap_codec::types::response::{Code, Data, MessageAttribute, Status}; use imap_codec::types::sequence::{self, SequenceSet}; use mail_parser::*; use crate::mail::mailbox::Mailbox; use crate::mail::uidindex::UidIndex; const DEFAULT_FLAGS: [Flag; 5] = [ Flag::Seen, Flag::Answered, Flag::Flagged, Flag::Deleted, Flag::Draft, ]; /// A MailboxView is responsible for giving the client the information /// it needs about a mailbox, such as an initial summary of the mailbox's /// content and continuous updates indicating when the content /// of the mailbox has been changed. /// To do this, it keeps a variable `known_state` that corresponds to /// what the client knows, and produces IMAP messages to be sent to the /// client that go along updates to `known_state`. pub struct MailboxView { mailbox: Arc, known_state: UidIndex, } impl MailboxView { /// Creates a new IMAP view into a mailbox. /// Generates the necessary IMAP messages so that the client /// has a satisfactory summary of the current mailbox's state. /// These are the messages that are sent in response to a SELECT command. pub async fn new(mailbox: Arc) -> Result<(Self, Vec)> { // TODO THIS IS JUST A TEST REMOVE LATER mailbox.test().await?; let state = mailbox.current_uid_index().await; let new_view = Self { mailbox, known_state: state, }; let mut data = Vec::::new(); data.push(new_view.exists()?); data.push(new_view.recent()?); data.extend(new_view.flags()?.into_iter()); data.push(new_view.uidvalidity()?); data.push(new_view.uidnext()?); if let Some(unseen) = new_view.unseen()? { data.push(unseen); } Ok((new_view, data)) } /// Looks up state changes in the mailbox and produces a set of IMAP /// responses describing the changes. pub async fn sync_update(&mut self) -> Result> { self.mailbox.sync().await?; // TODO THIS IS JUST A TEST REMOVE LATER self.mailbox.test().await?; self.update().await } /// Produces a set of IMAP responses describing the change between /// what the client knows and what is actually in the mailbox. pub async fn update(&mut self) -> Result> { let new_view = MailboxView { mailbox: self.mailbox.clone(), known_state: self.mailbox.current_uid_index().await, }; let mut data = Vec::::new(); if new_view.known_state.uidvalidity != self.known_state.uidvalidity { // TODO: do we want to push less/more info than this? data.push(new_view.uidvalidity()?); data.push(new_view.exists()?); data.push(new_view.uidnext()?); } else { // Calculate diff between two mailbox states // See example in IMAP RFC in section on NOOP command: // we want to produce something like this: // C: a047 NOOP // S: * 22 EXPUNGE // S: * 23 EXISTS // S: * 14 FETCH (UID 1305 FLAGS (\Seen \Deleted)) // S: a047 OK Noop completed // In other words: // - notify client of expunged mails // - if new mails arrived, notify client of number of existing mails // - if flags changed for existing mails, tell client // - notify client of expunged mails let mut n_expunge = 0; for (i, (_uid, uuid)) in self.known_state.idx_by_uid.iter().enumerate() { if !new_view.known_state.table.contains_key(uuid) { data.push(Body::Data(Data::Expunge( NonZeroU32::try_from((i + 1 - n_expunge) as u32).unwrap(), ))); n_expunge += 1; } } // - if new mails arrived, notify client of number of existing mails if new_view.known_state.table.len() != self.known_state.table.len() - n_expunge { data.push(new_view.exists()?); } // - if flags changed for existing mails, tell client for (i, (_uid, uuid)) in new_view.known_state.idx_by_uid.iter().enumerate() { let old_mail = self.known_state.table.get(uuid); let new_mail = new_view.known_state.table.get(uuid); if old_mail.is_some() && old_mail != new_mail { if let Some((uid, flags)) = new_mail { data.push(Body::Data(Data::Fetch { seq_or_uid: NonZeroU32::try_from((i + 1) as u32).unwrap(), attributes: vec![ MessageAttribute::Uid((*uid).try_into().unwrap()), MessageAttribute::Flags( flags.iter().filter_map(|f| string_to_flag(f)).collect(), ), ], })); } } } } *self = new_view; Ok(data) } /// Looks up state changes in the mailbox and produces a set of IMAP /// responses describing the new state. pub async fn fetch( &self, sequence_set: &SequenceSet, attributes: &MacroOrFetchAttributes, uid: &bool, ) -> Result> { if *uid { bail!("UID FETCH not implemented"); } let mail_vec = self .known_state .idx_by_uid .iter() .map(|(uid, uuid)| (*uid, *uuid)) .collect::>(); let mut mails = vec![]; let iter_strat = sequence::Strategy::Naive { largest: NonZeroU32::try_from((self.known_state.idx_by_uid.len() + 1) as u32).unwrap(), }; for i in sequence_set.iter(iter_strat) { if let Some(mail) = mail_vec.get(i.get() as usize - 1) { mails.push((i, *mail)); } else { bail!("No such mail: {}", i); } } let mails_uuid = mails .iter() .map(|(_i, (_uid, uuid))| *uuid) .collect::>(); let mails_meta = self.mailbox.fetch_meta(&mails_uuid).await?; let fetch_attrs = match attributes { MacroOrFetchAttributes::Macro(m) => m.expand(), MacroOrFetchAttributes::FetchAttributes(a) => a.clone(), }; let need_body = fetch_attrs.iter().any(|x| { matches!( x, FetchAttribute::Body | FetchAttribute::BodyExt { .. } | FetchAttribute::Rfc822 | FetchAttribute::Rfc822Text | FetchAttribute::BodyStructure ) }); let mails = if need_body { let mut iter = mails .into_iter() .zip(mails_meta.into_iter()) .map(|((i, (uid, uuid)), meta)| async move { let body = self.mailbox.fetch_full(uuid, &meta.message_key).await?; Ok::<_, anyhow::Error>((i, uid, uuid, meta, Some(body))) }) .collect::>(); let mut mails = vec![]; while let Some(m) = iter.next().await { mails.push(m?); } mails } else { mails .into_iter() .zip(mails_meta.into_iter()) .map(|((i, (uid, uuid)), meta)| (i, uid, uuid, meta, None)) .collect::>() }; let mut ret = vec![]; for (i, uid, uuid, meta, body) in mails { let mut attributes = vec![MessageAttribute::Uid(uid)]; let (_uid2, flags) = self .known_state .table .get(&uuid) .ok_or_else(|| anyhow!("Mail not in uidindex table: {}", uuid))?; let parsed = match &body { Some(m) => { mail_parser::Message::parse(m).ok_or_else(|| anyhow!("Invalid mail body"))? } None => mail_parser::Message::parse(&meta.headers) .ok_or_else(|| anyhow!("Invalid mail headers"))?, }; for attr in fetch_attrs.iter() { match attr { FetchAttribute::Uid => (), FetchAttribute::Flags => { attributes.push(MessageAttribute::Flags( flags.iter().filter_map(|f| string_to_flag(f)).collect(), )); } FetchAttribute::Rfc822Size => { attributes.push(MessageAttribute::Rfc822Size(meta.rfc822_size as u32)) } FetchAttribute::Rfc822Header => attributes.push( MessageAttribute::Rfc822Header(NString(Some(IString::Literal( meta.headers .clone() .try_into() .or(Err(Error::msg("IString conversion error")))?, )))), ), FetchAttribute::Rfc822Text => { let r = parsed .raw_message.get(parsed.offset_body..parsed.offset_end) .ok_or(Error::msg("Unable to extract email body, cursors out of bound. This is a bug."))? .try_into() .or(Err(Error::msg("IString conversion error")))?; attributes.push(MessageAttribute::Rfc822Text(NString(Some( IString::Literal(r), )))) } FetchAttribute::Rfc822 => { attributes.push(MessageAttribute::Rfc822(NString(Some(IString::Literal( body.as_ref().unwrap().clone().try_into().unwrap(), ))))) } FetchAttribute::Envelope => { attributes.push(MessageAttribute::Envelope(message_envelope(&parsed))) } FetchAttribute::Body => { /* * CAPTURE: b fetch 29878:29879 (BODY) * 29878 FETCH (BODY (("text" "plain" ("charset" "utf-8") NIL NIL "quoted-printable" 3264 82)("text" "html" ("charset" "utf-8") NIL NIL "quoted-printable" 31834 643) "alternative")) * 29879 FETCH (BODY ("text" "html" ("charset" "us-ascii") NIL NIL "7bit" 4107 131)) ^^^^^^^^^^^^^^^^^^^^^^ ^^^ ^^^ ^^^^^^ ^^^^ ^^^ | | | | | | number of lines | | | | | size | | | | content transfer encoding | | | description | | id | parameter list b OK Fetch completed (0.001 + 0.000 secs). * */ /*match parsed.structure { Part(part_id) => { match parsed.parts.get(part_id)? { Text( let fb = FetchBody { parameter_list: vec![], id: NString(None), descritpion: NString(None), // Default value is 7bit" // https://datatracker.ietf.org/doc/html/rfc2045#section-6.1 content_transfer_encoding: IString::try_from("7bit").unwrap(), }; } } List(part_list) => todo!(), MultiPart((first, rest)) => todo!(), }*/ // @TODO This is a stub let is = IString::try_from("test").unwrap(); let b = BodyStructure::Single { body: FetchBody { basic: BasicFields { parameter_list: vec![], id: NString(Some(is.clone())), description: NString(Some(is.clone())), content_transfer_encoding: is.clone(), size: 1, }, specific: SpecificFields::Text { // @FIXME I do not understand yet how this part works subtype: is, number_of_lines: 1, }, }, // Always None for Body, can be populated for BodyStructure extension: None, }; attributes.push(MessageAttribute::Body(b)); } FetchAttribute::BodyExt { section, partial, peek, } => { // @TODO This is a stub let is = IString::try_from("test").unwrap(); attributes.push(MessageAttribute::BodyExt { section: None, origin: None, data: NString(Some(is)), }) } FetchAttribute::BodyStructure => { // @TODO This is a stub let is = IString::try_from("test").unwrap(); let b = BodyStructure::Single { body: FetchBody { basic: BasicFields { parameter_list: vec![], id: NString(Some(is.clone())), description: NString(Some(is.clone())), content_transfer_encoding: is.clone(), size: 1, }, specific: SpecificFields::Text { // @FIXME I do not understand yet how this part works subtype: is, number_of_lines: 1, }, }, // Always None for Body, can be populated for BodyStructure extension: None, }; attributes.push(MessageAttribute::BodyStructure(b)); } FetchAttribute::InternalDate => { attributes.push(MessageAttribute::InternalDate(MyDateTime( Utc.fix() .timestamp(i64::try_from(meta.internaldate / 1000)?, 0), ))); } } } ret.push(Body::Data(Data::Fetch { seq_or_uid: i, attributes, })); } Ok(ret) } // ---- /// Produce an OK [UIDVALIDITY _] message corresponding to `known_state` fn uidvalidity(&self) -> Result { let uid_validity = Status::ok( None, Some(Code::UidValidity(self.known_state.uidvalidity)), "UIDs valid", ) .map_err(Error::msg)?; Ok(Body::Status(uid_validity)) } /// Produce an OK [UIDNEXT _] message corresponding to `known_state` fn uidnext(&self) -> Result { let next_uid = Status::ok( None, Some(Code::UidNext(self.known_state.uidnext)), "Predict next UID", ) .map_err(Error::msg)?; Ok(Body::Status(next_uid)) } /// Produces an UNSEEN message (if relevant) corresponding to the /// first unseen message id in `known_state` fn unseen(&self) -> Result> { let unseen = self .known_state .idx_by_flag .get(&"$unseen".to_string()) .and_then(|os| os.get_min()) .cloned(); if let Some(unseen) = unseen { let status_unseen = Status::ok(None, Some(Code::Unseen(unseen.clone())), "First unseen UID") .map_err(Error::msg)?; Ok(Some(Body::Status(status_unseen))) } else { Ok(None) } } /// Produce an EXISTS message corresponding to the number of mails /// in `known_state` fn exists(&self) -> Result { let exists = u32::try_from(self.known_state.idx_by_uid.len())?; Ok(Body::Data(Data::Exists(exists))) } /// Produce a RECENT message corresponding to the number of /// recent mails in `known_state` fn recent(&self) -> Result { let recent = self .known_state .idx_by_flag .get(&"\\Recent".to_string()) .map(|os| os.len()) .unwrap_or(0); let recent = u32::try_from(recent)?; Ok(Body::Data(Data::Recent(recent))) } /// Produce a FLAGS and a PERMANENTFLAGS message that indicates /// the flags that are in `known_state` + default flags fn flags(&self) -> Result> { let mut flags: Vec = self .known_state .idx_by_flag .flags() .map(|f| string_to_flag(f)) .flatten() .collect(); for f in DEFAULT_FLAGS.iter() { if !flags.contains(f) { flags.push(f.clone()); } } let mut ret = vec![Body::Data(Data::Flags(flags.clone()))]; flags.push(Flag::Permanent); let permanent_flags = Status::ok(None, Some(Code::PermanentFlags(flags)), "Flags permitted") .map_err(Error::msg)?; ret.push(Body::Status(permanent_flags)); Ok(ret) } } fn string_to_flag(f: &str) -> Option { match f.chars().next() { Some('\\') => None, Some('$') if f == "$unseen" => None, Some(_) => match Atom::try_from(f.clone()) { Err(_) => { tracing::error!(flag=%f, "Unable to encode flag as IMAP atom"); None } Ok(a) => Some(Flag::Keyword(a)), }, None => None, } } fn message_envelope(msg: &mail_parser::Message<'_>) -> Envelope { Envelope { date: NString( msg.get_date() .map(|d| IString::try_from(d.to_iso8601()).unwrap()), ), subject: NString( msg.get_subject() .map(|d| IString::try_from(d.to_string()).unwrap()), ), from: convert_addresses(msg.get_from()), sender: convert_addresses(msg.get_sender()), reply_to: convert_addresses(msg.get_reply_to()), to: convert_addresses(msg.get_to()), cc: convert_addresses(msg.get_cc()), bcc: convert_addresses(msg.get_bcc()), in_reply_to: NString(None), // TODO message_id: NString( msg.get_message_id() .map(|d| IString::try_from(d.to_string()).unwrap()), ), } } fn convert_addresses(a: &mail_parser::HeaderValue<'_>) -> Vec
{ match a { mail_parser::HeaderValue::Address(a) => vec![convert_address(a)], mail_parser::HeaderValue::AddressList(a) => { let mut ret = vec![]; for aa in a { ret.push(convert_address(aa)); } ret } mail_parser::HeaderValue::Empty => vec![], mail_parser::HeaderValue::Collection(c) => { let mut ret = vec![]; for cc in c.iter() { ret.extend(convert_addresses(cc).into_iter()); } ret } _ => panic!("Invalid address header"), } } fn convert_address(a: &mail_parser::Addr<'_>) -> Address { let (user, host) = match &a.address { None => (None, None), Some(x) => match x.split_once('@') { Some((u, h)) => (Some(u.to_string()), Some(h.to_string())), None => (Some(x.to_string()), None), }, }; Address::new( NString( a.name .as_ref() .map(|x| IString::try_from(x.to_string()).unwrap()), ), NString(None), NString(user.map(|x| IString::try_from(x).unwrap())), NString(host.map(|x| IString::try_from(x).unwrap())), ) } fn build_imap_email_struct<'a>( msg: &Message<'a>, node: &MessageStructure, ) -> Result { match node { MessageStructure::Part(id) => { let part = msg.parts.get(*id).ok_or(anyhow!( "Email part referenced in email structure is missing" ))?; match part { MessagePart::Text(bp) => Ok(BodyStructure::Single { body: FetchBody { basic: BasicFields { parameter_list: vec![], //@TODO id: match bp.headers_rfc.get(&RfcHeader::ContentId) { Some(HeaderValue::Text(v)) => { NString(IString::try_from(v.clone().into_owned()).ok()) } _ => NString(None), }, description: NString(None), //@TODO content_transfer_encoding: match bp .headers_rfc .get(&RfcHeader::ContentTransferEncoding) { Some(HeaderValue::Text(v)) => { IString::try_from(v.clone().into_owned()) .unwrap_or(unchecked_istring("7bit")) } _ => unchecked_istring("7bit"), }, size: u32::try_from(bp.len())?, }, specific: SpecificFields::Text { subtype: match bp.headers_rfc.get(&RfcHeader::ContentType) { Some(HeaderValue::ContentType(ContentType { c_subtype: Some(st), .. })) => IString::try_from(st.clone().into_owned()) .unwrap_or(unchecked_istring("plain")), _ => unchecked_istring("plain"), }, number_of_lines: u32::try_from(bp.get_text_contents().lines().count())?, }, }, extension: None, }), MessagePart::Multipart(_) => { unreachable!("A multipart entry can not be found here.") } _ => todo!(), } } MessageStructure::List(l) => todo!(), /*BodyStructure::Multi { bodies: l.map(|inner_node| build_email_struct(msg, inner_node)), subtype: "", extension_data: None, },*/ MessageStructure::MultiPart((id, l)) => { todo!() /*let part = msg.parts.get(id)?; let mp = match part { MessagePart::Multipart(mp) => mp, _ => unreachable!("Only a MessagePart part entry is allowed here."); } BodyStructure::Multi { bodies: l.map(|inner_node| build_email_struct(msg, inner_node)), subtype: "", extension_data: Some(MultipartExtensionData { parameter_list: vec![], disposition: None, language: None, location: None, extension: vec![], }) } */ } } } /// s is set to static to ensure that only compile time values /// checked by the developpers are passed. fn unchecked_istring(s: &'static str) -> IString { IString::try_from(s).expect("this value is expected to be a valid imap-codec::IString") } #[cfg(test)] mod tests { use super::*; #[test] fn rfc_to_imap() -> Result<()> { let txt = br#"From: Garage team Subject: Welcome to Aerogramme!! This is just a test email, feel free to ignore. "#; let message = Message::parse(txt).unwrap(); let bs = build_imap_email_struct(&message, &message.structure)?; print!("{:?}", bs); Ok(()) } }