use std::collections::BTreeMap; use std::fmt; use std::path::PathBuf; use std::str; use anyhow::{bail, Error, Result}; use num_traits::FromPrimitive; use serde::{Deserialize, Serialize}; use crate::blob::BlobObject; use crate::context::Context; use crate::mimeparser::SystemMessage; /// Available param keys. #[derive( PartialEq, Eq, Debug, Clone, Copy, Hash, PartialOrd, Ord, FromPrimitive, Serialize, Deserialize, )] #[repr(u8)] pub enum Param { /// For messages File = b'f', /// For messages: original filename (as shown in chat) Filename = b'v', /// For messages: This name should be shown instead of contact.get_display_name() /// (used if this is a mailinglist /// or explicitly set using set_override_sender_name(), eg. by bots) OverrideSenderDisplayname = b'O', /// For Messages Width = b'w', /// For Messages Height = b'h', /// For Messages Duration = b'd', /// For Messages MimeType = b'm', /// For Messages: HTML to be written to the database and to be send. /// `SendHtml` param is not used for received messages. /// Use `MsgId::get_html()` to get HTML of received messages. SendHtml = b'T', /// For Messages: message is encrypted, outgoing: guarantee E2EE or the message is not send GuaranteeE2ee = b'c', /// For Messages: quoted message is encrypted. /// /// If this message is sent unencrypted, quote text should be replaced. ProtectQuote = b'0', /// For Messages: decrypted with validation errors or without mutual set, if neither /// 'c' nor 'e' are preset, the messages is only transport encrypted. ErroneousE2ee = b'e', /// For Messages: force unencrypted message, a value from `ForcePlaintext` enum. ForcePlaintext = b'u', /// For Messages: do not include Autocrypt header. SkipAutocrypt = b'o', /// For Messages WantsMdn = b'r', /// For Messages: the message is a reaction. Reaction = b'x', /// For Chats: the timestamp of the last reaction. LastReactionTimestamp = b'y', /// For Chats: Message ID of the last reaction. LastReactionMsgId = b'Y', /// For Chats: Contact ID of the last reaction. LastReactionContactId = b'1', /// For Messages: a message with "Auto-Submitted: auto-generated" header ("bot"). Bot = b'b', /// For Messages: unset or 0=not forwarded, /// 1=forwarded from unknown msg_id, >9 forwarded from msg_id Forwarded = b'a', /// For Messages: quoted text. Quote = b'q', /// For Messages Cmd = b'S', /// For Messages Arg = b'E', /// For Messages Arg2 = b'F', /// `Secure-Join-Fingerprint` header for `{vc,vg}-request-with-auth` messages. Arg3 = b'G', /// Deprecated `Secure-Join-Group` header for messages. Arg4 = b'H', /// For Messages AttachGroupImage = b'A', /// For Messages WebrtcRoom = b'V', /// For Messages: space-separated list of messaged IDs of forwarded copies. /// /// This is used when a [crate::message::Message] is in the /// [crate::message::MessageState::OutPending] state but is already forwarded. /// In this case the forwarded messages are written to the /// database and their message IDs are added to this parameter of /// the original message, which is also saved in the database. /// When the original message is then finally sent this parameter /// is used to also send all the forwarded messages. PrepForwards = b'P', /// For Messages SetLatitude = b'l', /// For Messages SetLongitude = b'n', /// For Groups /// /// An unpromoted group has not had any messages sent to it and thus only exists on the /// creator's device. Any changes made to an unpromoted group do not need to send /// system messages to the group members to update them of the changes. Once a message /// has been sent to a group it is promoted and group changes require sending system /// messages to all members. Unpromoted = b'U', /// For Groups and Contacts ProfileImage = b'i', /// For Chats /// Signals whether the chat is the `saved messages` chat Selftalk = b'K', /// For Chats: On sending a new message we set the subject to `Re: `. /// Usually we just use the subject of the parent message, but if the parent message /// is deleted, we use the LastSubject of the chat. LastSubject = b't', /// For Chats Devicetalk = b'D', /// For Chats: If this is a mailing list chat, contains the List-Post address. /// None if there simply is no `List-Post` header in the mailing list. /// Some("") if the mailing list is using multiple different List-Post headers. /// /// The List-Post address is the email address where the user can write to in order to /// post something to the mailing list. ListPost = b'p', /// For Contacts: If this is the List-Post address of a mailing list, contains /// the List-Id of the mailing list (which is also used as the group id of the chat). ListId = b's', /// For Contacts: timestamp of status (aka signature or footer) update. StatusTimestamp = b'j', /// For Contacts and Chats: timestamp of avatar update. AvatarTimestamp = b'J', /// For Chats: timestamp of status/signature/footer update. EphemeralSettingsTimestamp = b'B', /// For Chats: timestamp of subject update. SubjectTimestamp = b'C', /// For Chats: timestamp of group name update. GroupNameTimestamp = b'g', /// For Chats: timestamp of member list update. MemberListTimestamp = b'k', /// For Webxdc Message Instances: Current document name WebxdcDocument = b'R', /// For Webxdc Message Instances: timestamp of document name update. WebxdcDocumentTimestamp = b'W', /// For Webxdc Message Instances: Current summary WebxdcSummary = b'N', /// For Webxdc Message Instances: timestamp of summary update. WebxdcSummaryTimestamp = b'Q', /// For Webxdc Message Instances: Webxdc is an integration, see init_webxdc_integration() WebxdcIntegration = b'3', /// For Webxdc Message Instances: Chat to integrate the Webxdc for. WebxdcIntegrateFor = b'2', /// For messages: Whether [crate::message::Viewtype::Sticker] should be forced. ForceSticker = b'X', // 'L' was defined as ProtectionSettingsTimestamp for Chats, however, never used in production. } /// An object for handling key=value parameter lists. /// /// The structure is serialized by calling `to_string()` on it. /// /// Only for library-internal use. #[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)] pub struct Params { inner: BTreeMap, } impl fmt::Display for Params { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { for (i, (key, value)) in self.inner.iter().enumerate() { if i > 0 { writeln!(f)?; } write!( f, "{}={}", *key as u8 as char, value.split('\n').collect::>().join("\n\n") )?; } Ok(()) } } impl str::FromStr for Params { type Err = Error; /// Parse a raw string to Param. /// /// Silently ignore unknown keys: /// they may come from a downgrade (when a shortly new version adds a key) /// or from an upgrade (when a key is dropped but was used in the past) fn from_str(s: &str) -> std::result::Result { let mut inner = BTreeMap::new(); let mut lines = s.lines().peekable(); while let Some(line) = lines.next() { if let [key, value] = line.splitn(2, '=').collect::>()[..] { let key = key.to_string(); let mut value = value.to_string(); while let Some(s) = lines.peek() { if !s.is_empty() { break; } lines.next(); value.push('\n'); value += lines.next().unwrap_or_default(); } if let Some(key) = key.as_bytes().first().and_then(|key| Param::from_u8(*key)) { inner.insert(key, value); } } else { bail!("Not a key-value pair: {:?}", line); } } Ok(Params { inner }) } } impl Params { /// Create new empty params. pub fn new() -> Self { Default::default() } /// Get the value of the given key, return `None` if no value is set. pub fn get(&self, key: Param) -> Option<&str> { self.inner.get(&key).map(|s| s.as_str()) } /// Check if the given key is set. pub fn exists(&self, key: Param) -> bool { self.inner.contains_key(&key) } /// Set the given key to the passed in value. pub fn set(&mut self, key: Param, value: impl ToString) -> &mut Self { self.inner.insert(key, value.to_string()); self } /// Removes the given key, if it exists. pub fn remove(&mut self, key: Param) -> &mut Self { self.inner.remove(&key); self } /// Sets the given key from an optional value. /// Removes the key if the value is `None`. pub fn set_optional(&mut self, key: Param, value: Option) -> &mut Self { if let Some(value) = value { self.set(key, value) } else { self.remove(key) } } /// Check if there are any values in this. pub fn is_empty(&self) -> bool { self.inner.is_empty() } /// Returns how many key-value pairs are set. pub fn len(&self) -> usize { self.inner.len() } /// Get the given parameter and parse as `i32`. pub fn get_int(&self, key: Param) -> Option { self.get(key).and_then(|s| s.parse().ok()) } /// Get the given parameter and parse as `i64`. pub fn get_i64(&self, key: Param) -> Option { self.get(key).and_then(|s| s.parse().ok()) } /// Get the given parameter and parse as `bool`. pub fn get_bool(&self, key: Param) -> Option { self.get_int(key).map(|v| v != 0) } /// Get the parameter behind `Param::Cmd` interpreted as `SystemMessage`. pub fn get_cmd(&self) -> SystemMessage { self.get_int(Param::Cmd) .and_then(SystemMessage::from_i32) .unwrap_or_default() } /// Set the parameter behind `Param::Cmd`. pub fn set_cmd(&mut self, value: SystemMessage) { self.set_int(Param::Cmd, value as i32); } /// Get the given parameter and parse as `f64`. pub fn get_float(&self, key: Param) -> Option { self.get(key).and_then(|s| s.parse().ok()) } /// Gets the given parameter and parse as [ParamsFile]. /// /// See also [Params::get_blob] and [Params::get_path] which may /// be more convenient. pub fn get_file<'a>(&self, key: Param, context: &'a Context) -> Result>> { let val = match self.get(key) { Some(val) => val, None => return Ok(None), }; ParamsFile::from_param(context, val).map(Some) } /// Gets the parameter and returns a [BlobObject] for it. /// /// This parses the parameter value as a [ParamsFile] and than /// tries to return a [BlobObject] for that file. If the file is /// not yet a valid blob, one will be created by copying the file /// only if `create` is set to `true`, otherwise an error is /// returned. /// /// Note that in the [ParamsFile::FsPath] case the blob can be /// created without copying if the path already refers to a valid /// blob. If so a [BlobObject] will be returned regardless of the /// `create` argument. #[allow(clippy::needless_lifetimes)] pub async fn get_blob<'a>( &self, key: Param, context: &'a Context, create: bool, ) -> Result>> { let val = match self.get(key) { Some(val) => val, None => return Ok(None), }; let file = ParamsFile::from_param(context, val)?; let blob = match file { ParamsFile::FsPath(path) => match create { true => BlobObject::new_from_path(context, &path).await?, false => BlobObject::from_path(context, &path)?, }, ParamsFile::Blob(blob) => blob, }; Ok(Some(blob)) } /// Gets the parameter and returns a [PathBuf] for it. /// /// This parses the parameter value as a [ParamsFile] and returns /// a [PathBuf] to the file. pub fn get_path(&self, key: Param, context: &Context) -> Result> { let val = match self.get(key) { Some(val) => val, None => return Ok(None), }; let file = ParamsFile::from_param(context, val)?; let path = match file { ParamsFile::FsPath(path) => path, ParamsFile::Blob(blob) => blob.to_abs_path(), }; Ok(Some(path)) } /// Set the given parameter to the passed in `i32`. pub fn set_int(&mut self, key: Param, value: i32) -> &mut Self { self.set(key, format!("{value}")); self } /// Set the given parameter to the passed in `i64`. pub fn set_i64(&mut self, key: Param, value: i64) -> &mut Self { self.set(key, value.to_string()); self } /// Set the given parameter to the passed in `f64` . pub fn set_float(&mut self, key: Param, value: f64) -> &mut Self { self.set(key, format!("{value}")); self } } /// The value contained in [Param::File]. /// /// Because the only way to construct this object is from a valid /// UTF-8 string it is always safe to convert the value contained /// within the [ParamsFile::FsPath] back to a [String] or [&str]. /// Despite the type itself does not guarantee this. #[derive(Debug, Clone, PartialEq, Eq)] pub enum ParamsFile<'a> { FsPath(PathBuf), Blob(BlobObject<'a>), } impl<'a> ParamsFile<'a> { /// Parse the [Param::File] value into an object. /// /// If the value was stored into the [Params] correctly this /// should not fail. pub fn from_param(context: &'a Context, src: &str) -> Result> { let param = match src.starts_with("$BLOBDIR/") { true => ParamsFile::Blob(BlobObject::from_name(context, src.to_string())?), false => ParamsFile::FsPath(PathBuf::from(src)), }; Ok(param) } } #[cfg(test)] mod tests { use std::path::Path; use std::str::FromStr; use tokio::fs; use super::*; use crate::test_utils::TestContext; #[test] fn test_dc_param() { let mut p1: Params = "a=1\nf=2\nc=3".parse().unwrap(); assert_eq!(p1.get_int(Param::Forwarded), Some(1)); assert_eq!(p1.get_int(Param::File), Some(2)); assert_eq!(p1.get_int(Param::Height), None); assert!(!p1.exists(Param::Height)); p1.set_int(Param::Duration, 4); assert_eq!(p1.get_int(Param::Duration), Some(4)); let mut p1 = Params::new(); p1.set(Param::Forwarded, "foo") .set_int(Param::File, 2) .remove(Param::GuaranteeE2ee) .set_int(Param::Duration, 4); assert_eq!(p1.to_string(), "a=foo\nd=4\nf=2"); p1.remove(Param::File); assert_eq!(p1.to_string(), "a=foo\nd=4",); assert_eq!(p1.len(), 2); p1.remove(Param::Forwarded); p1.remove(Param::Duration); assert_eq!(p1.to_string(), "",); assert!(p1.is_empty()); assert_eq!(p1.len(), 0) } #[test] fn test_roundtrip() { let mut params = Params::new(); params.set(Param::Height, "foo\nbar=baz\nquux"); params.set(Param::Width, "\n\n\na=\n="); assert_eq!(params.to_string().parse::().unwrap(), params); } #[tokio::test(flavor = "multi_thread", worker_threads = 2)] async fn test_params_file_fs_path() { let t = TestContext::new().await; if let ParamsFile::FsPath(p) = ParamsFile::from_param(&t, "/foo/bar/baz").unwrap() { assert_eq!(p, Path::new("/foo/bar/baz")); } else { panic!("Wrong enum variant"); } } #[tokio::test(flavor = "multi_thread", worker_threads = 2)] async fn test_params_file_blob() { let t = TestContext::new().await; if let ParamsFile::Blob(b) = ParamsFile::from_param(&t, "$BLOBDIR/foo").unwrap() { assert_eq!(b.as_name(), "$BLOBDIR/foo"); } else { panic!("Wrong enum variant"); } } // Tests for Params::get_file(), Params::get_path() and Params::get_blob(). #[tokio::test(flavor = "multi_thread", worker_threads = 2)] async fn test_params_get_fileparam() { let t = TestContext::new().await; let fname = t.dir.path().join("foo"); let mut p = Params::new(); p.set(Param::File, fname.to_str().unwrap()); let file = p.get_file(Param::File, &t).unwrap().unwrap(); assert_eq!(file, ParamsFile::FsPath(fname.clone())); let path: PathBuf = p.get_path(Param::File, &t).unwrap().unwrap(); assert_eq!(path, fname); // Blob does not exist yet, expect error. assert!(p.get_blob(Param::File, &t, false).await.is_err()); fs::write(fname, b"boo").await.unwrap(); let blob = p.get_blob(Param::File, &t, true).await.unwrap().unwrap(); assert!(blob.as_file_name().starts_with("foo")); // Blob in blobdir, expect blob. let bar_path = t.get_blobdir().join("bar"); p.set(Param::File, bar_path.to_str().unwrap()); let blob = p.get_blob(Param::File, &t, false).await.unwrap().unwrap(); assert_eq!(blob, BlobObject::from_name(&t, "bar".to_string()).unwrap()); p.remove(Param::File); assert!(p.get_file(Param::File, &t).unwrap().is_none()); assert!(p.get_path(Param::File, &t).unwrap().is_none()); assert!(p.get_blob(Param::File, &t, false).await.unwrap().is_none()); } #[tokio::test(flavor = "multi_thread", worker_threads = 2)] async fn test_params_unknown_key() -> Result<()> { // 'Z' is used as a key that is known to be unused; these keys should be ignored silently by definition. let p = Params::from_str("w=12\nZ=13\nh=14")?; assert_eq!(p.len(), 2); assert_eq!(p.get(Param::Width), Some("12")); assert_eq!(p.get(Param::Height), Some("14")); Ok(()) } }