//! # Key-value configuration management. use std::env; use std::path::Path; use std::str::FromStr; use anyhow::{ensure, Context as _, Result}; use base64::Engine as _; use deltachat_contact_tools::addr_cmp; use serde::{Deserialize, Serialize}; use strum::{EnumProperty, IntoEnumIterator}; use strum_macros::{AsRefStr, Display, EnumIter, EnumString}; use tokio::fs; use crate::blob::BlobObject; use crate::constants::{self, DC_VERSION_STR}; use crate::context::Context; use crate::events::EventType; use crate::log::LogExt; use crate::mimefactory::RECOMMENDED_FILE_SIZE; use crate::provider::{get_provider_by_id, Provider}; use crate::sync::{self, Sync::*, SyncData}; use crate::tools::{get_abs_path, improve_single_line_input}; /// The available configuration keys. #[derive( Debug, Clone, Copy, PartialEq, Eq, Display, EnumString, AsRefStr, EnumIter, EnumProperty, PartialOrd, Ord, Serialize, Deserialize, )] #[strum(serialize_all = "snake_case")] pub enum Config { /// Email address, used in the `From:` field. Addr, /// IMAP server hostname. MailServer, /// IMAP server username. MailUser, /// IMAP server password. MailPw, /// IMAP server port. MailPort, /// IMAP server security (e.g. TLS, STARTTLS). MailSecurity, /// How to check IMAP server TLS certificates. ImapCertificateChecks, /// SMTP server hostname. SendServer, /// SMTP server username. SendUser, /// SMTP server password. SendPw, /// SMTP server port. SendPort, /// SMTP server security (e.g. TLS, STARTTLS). SendSecurity, /// How to check SMTP server TLS certificates. SmtpCertificateChecks, /// Whether to use OAuth 2. /// /// Historically contained other bitflags, which are now deprecated. /// Should not be extended in the future, create new config keys instead. ServerFlags, /// True if SOCKS5 is enabled. /// /// Can be used to disable SOCKS5 without erasing SOCKS5 configuration. Socks5Enabled, /// SOCKS5 proxy server hostname or address. Socks5Host, /// SOCKS5 proxy server port. Socks5Port, /// SOCKS5 proxy server username. Socks5User, /// SOCKS5 proxy server password. Socks5Password, /// Own name to use in the `From:` field when sending messages. Displayname, /// Own status to display, sent in message footer. Selfstatus, /// Own avatar filename. Selfavatar, /// Send BCC copy to self. /// /// Should be enabled for multidevice setups. #[strum(props(default = "1"))] BccSelf, /// True if encryption is preferred according to Autocrypt standard. #[strum(props(default = "1"))] E2eeEnabled, /// True if Message Delivery Notifications (read receipts) should /// be sent and requested. #[strum(props(default = "1"))] MdnsEnabled, /// True if "Sent" folder should be watched for changes. #[strum(props(default = "0"))] SentboxWatch, /// True if chat messages should be moved to a separate folder. #[strum(props(default = "1"))] MvboxMove, /// Watch for new messages in the "Mvbox" (aka DeltaChat folder) only. /// /// This will not entirely disable other folders, e.g. the spam folder will also still /// be watched for new messages. #[strum(props(default = "0"))] OnlyFetchMvbox, /// Whether to show classic emails or only chat messages. #[strum(props(default = "2"))] // also change ShowEmails.default() on changes ShowEmails, /// Quality of the media files to send. #[strum(props(default = "0"))] // also change MediaQuality.default() on changes MediaQuality, /// If set to "1", on the first time `start_io()` is called after configuring, /// the newest existing messages are fetched. /// Existing recipients are added to the contact database regardless of this setting. #[strum(props(default = "0"))] FetchExistingMsgs, /// If set to "1", then existing messages are considered to be already fetched. /// This flag is reset after successful configuration. #[strum(props(default = "1"))] FetchedExistingMsgs, /// Type of the OpenPGP key to generate. #[strum(props(default = "0"))] KeyGenType, /// Timer in seconds after which the message is deleted from the /// server. /// /// Equals to 0 by default, which means the message is never /// deleted. /// /// Value 1 is treated as "delete at once": messages are deleted /// immediately, without moving to DeltaChat folder. #[strum(props(default = "0"))] DeleteServerAfter, /// Timer in seconds after which the message is deleted from the /// device. /// /// Equals to 0 by default, which means the message is never /// deleted. #[strum(props(default = "0"))] DeleteDeviceAfter, /// Move messages to the Trash folder instead of marking them "\Deleted". Overrides /// `ProviderOptions::delete_to_trash`. DeleteToTrash, /// Save raw MIME messages with headers in the database if true. SaveMimeHeaders, /// The primary email address. Also see `SecondaryAddrs`. ConfiguredAddr, /// Configured IMAP server hostname. ConfiguredMailServer, /// Configured IMAP server username. ConfiguredMailUser, /// Configured IMAP server password. ConfiguredMailPw, /// Configured IMAP server port. ConfiguredMailPort, /// Configured IMAP server security (e.g. TLS, STARTTLS). ConfiguredMailSecurity, /// How to check IMAP server TLS certificates. ConfiguredImapCertificateChecks, /// Configured SMTP server hostname. ConfiguredSendServer, /// Configured SMTP server username. ConfiguredSendUser, /// Configured SMTP server password. ConfiguredSendPw, /// Configured SMTP server port. ConfiguredSendPort, /// How to check SMTP server TLS certificates. ConfiguredSmtpCertificateChecks, /// Whether OAuth 2 is used with configured provider. ConfiguredServerFlags, /// Configured SMTP server security (e.g. TLS, STARTTLS). ConfiguredSendSecurity, /// Configured folder for incoming messages. ConfiguredInboxFolder, /// Configured folder for chat messages. ConfiguredMvboxFolder, /// Configured "Sent" folder. ConfiguredSentboxFolder, /// Configured "Trash" folder. ConfiguredTrashFolder, /// Unix timestamp of the last successful configuration. ConfiguredTimestamp, /// ID of the configured provider from the provider database. ConfiguredProvider, /// True if account is configured. Configured, /// True if account is a chatmail account. IsChatmail, /// All secondary self addresses separated by spaces /// (`addr1@example.org addr2@example.org addr3@example.org`) SecondaryAddrs, /// Read-only core version string. #[strum(serialize = "sys.version")] SysVersion, /// Maximal recommended attachment size in bytes. #[strum(serialize = "sys.msgsize_max_recommended")] SysMsgsizeMaxRecommended, /// Space separated list of all config keys available. #[strum(serialize = "sys.config_keys")] SysConfigKeys, /// True if it is a bot account. Bot, /// True when to skip initial start messages in groups. #[strum(props(default = "0"))] SkipStartMessages, /// Whether we send a warning if the password is wrong (set to false when we send a warning /// because we do not want to send a second warning) #[strum(props(default = "0"))] NotifyAboutWrongPw, /// If a warning about exceeding quota was shown recently, /// this is the percentage of quota at the time the warning was given. /// Unset, when quota falls below minimal warning threshold again. QuotaExceeding, /// address to webrtc instance to use for videochats WebrtcInstance, /// Timestamp of the last time housekeeping was run LastHousekeeping, /// Timestamp of the last `CantDecryptOutgoingMsgs` notification. LastCantDecryptOutgoingMsgs, /// To how many seconds to debounce scan_all_folders. Used mainly in tests, to disable debouncing completely. #[strum(props(default = "60"))] ScanAllFoldersDebounceSecs, /// Whether to avoid using IMAP IDLE even if the server supports it. /// /// This is a developer option for testing "fake idle". #[strum(props(default = "0"))] DisableIdle, /// Defines the max. size (in bytes) of messages downloaded automatically. /// 0 = no limit. #[strum(props(default = "0"))] DownloadLimit, /// Enable sending and executing (applying) sync messages. Sending requires `BccSelf` to be set. #[strum(props(default = "1"))] SyncMsgs, /// Space-separated list of all the authserv-ids which we believe /// may be the one of our email server. /// /// See `crate::authres::update_authservid_candidates`. AuthservIdCandidates, /// Make all outgoing messages with Autocrypt header "multipart/signed". SignUnencrypted, /// Let the core save all events to the database. /// This value is used internally to remember the MsgId of the logging xdc #[strum(props(default = "0"))] DebugLogging, /// Last message processed by the bot. LastMsgId, /// How often to gossip Autocrypt keys in chats with multiple recipients, in seconds. 2 days by /// default. /// /// This is not supposed to be changed by UIs and only used for testing. #[strum(props(default = "172800"))] GossipPeriod, /// Feature flag for verified 1:1 chats; the UI should set it /// to 1 if it supports verified 1:1 chats. /// Regardless of this setting, `chat.is_protected()` returns true while the key is verified, /// and when the key changes, an info message is posted into the chat. /// 0=Nothing else happens when the key changes. /// 1=After the key changed, `can_send()` returns false and `is_protection_broken()` returns true /// until `chat_id.accept()` is called. #[strum(props(default = "0"))] VerifiedOneOnOneChats, /// Row ID of the key in the `keypairs` table /// used for signatures, encryption to self and included in `Autocrypt` header. KeyId, /// This key is sent to the self_reporting bot so that the bot can recognize the user /// without storing the email address SelfReportingId, /// MsgId of webxdc map integration. WebxdcIntegration, /// Iroh secret key. IrohSecretKey, } impl Config { /// Whether the config option is synced across devices. /// /// This must be checked on both sides so that if there are different client versions, the /// synchronisation of a particular option is either done or not done in both directions. /// Moreover, receivers of a config value need to check if a key can be synced because if it is /// a file path, it could otherwise lead to exfiltration of files from a receiver's /// device if we assume an attacker to have control of a device in a multi-device setting or if /// multiple users are sharing an account. Another example is `Self::SyncMsgs` itself which /// mustn't be controlled by other devices. pub(crate) fn is_synced(&self) -> bool { // We don't restart IO from the synchronisation code, so this is to be on the safe side. if self.needs_io_restart() { return false; } matches!( self, Self::Displayname | Self::MdnsEnabled | Self::ShowEmails | Self::Selfavatar | Self::Selfstatus, ) } /// Whether the config option needs an IO scheduler restart to take effect. pub(crate) fn needs_io_restart(&self) -> bool { matches!( self, Config::MvboxMove | Config::OnlyFetchMvbox | Config::SentboxWatch ) } } impl Context { /// Returns true if configuration value is set for the given key. pub async fn config_exists(&self, key: Config) -> Result { Ok(self.sql.get_raw_config(key.as_ref()).await?.is_some()) } /// Get a configuration key. Returns `None` if no value is set, and no default value found. pub async fn get_config(&self, key: Config) -> Result> { let env_key = format!("DELTACHAT_{}", key.as_ref().to_uppercase()); if let Ok(value) = env::var(env_key) { return Ok(Some(value)); } let value = match key { Config::Selfavatar => { let rel_path = self.sql.get_raw_config(key.as_ref()).await?; rel_path.map(|p| { get_abs_path(self, Path::new(&p)) .to_string_lossy() .into_owned() }) } Config::SysVersion => Some((*DC_VERSION_STR).clone()), Config::SysMsgsizeMaxRecommended => Some(format!("{RECOMMENDED_FILE_SIZE}")), Config::SysConfigKeys => Some(get_config_keys_string()), _ => self.sql.get_raw_config(key.as_ref()).await?, }; if value.is_some() { return Ok(value); } // Default values match key { Config::ConfiguredInboxFolder => Ok(Some("INBOX".to_owned())), _ => Ok(key.get_str("default").map(|s| s.to_string())), } } /// Returns Some(T) if a value for the given key exists and was successfully parsed. /// Returns None if could not parse. pub async fn get_config_parsed(&self, key: Config) -> Result> { self.get_config(key) .await .map(|s: Option| s.and_then(|s| s.parse().ok())) } /// Returns 32-bit signed integer configuration value for the given key. pub async fn get_config_int(&self, key: Config) -> Result { Ok(self.get_config_parsed(key).await?.unwrap_or_default()) } /// Returns 32-bit unsigned integer configuration value for the given key. pub async fn get_config_u32(&self, key: Config) -> Result { Ok(self.get_config_parsed(key).await?.unwrap_or_default()) } /// Returns 64-bit signed integer configuration value for the given key. pub async fn get_config_i64(&self, key: Config) -> Result { Ok(self.get_config_parsed(key).await?.unwrap_or_default()) } /// Returns 64-bit unsigned integer configuration value for the given key. pub async fn get_config_u64(&self, key: Config) -> Result { Ok(self.get_config_parsed(key).await?.unwrap_or_default()) } /// Returns boolean configuration value (if any) for the given key. pub async fn get_config_bool_opt(&self, key: Config) -> Result> { Ok(self.get_config_parsed::(key).await?.map(|x| x != 0)) } /// Returns boolean configuration value for the given key. pub async fn get_config_bool(&self, key: Config) -> Result { Ok(self.get_config_bool_opt(key).await?.unwrap_or_default()) } /// Returns true if movebox ("DeltaChat" folder) should be watched. pub(crate) async fn should_watch_mvbox(&self) -> Result { Ok(self.get_config_bool(Config::MvboxMove).await? || self.get_config_bool(Config::OnlyFetchMvbox).await?) } /// Returns true if sentbox ("Sent" folder) should be watched. pub(crate) async fn should_watch_sentbox(&self) -> Result { Ok(self.get_config_bool(Config::SentboxWatch).await? && self .get_config(Config::ConfiguredSentboxFolder) .await? .is_some()) } /// Gets configured "delete_server_after" value. /// /// `None` means never delete the message, `Some(0)` means delete /// at once, `Some(x)` means delete after `x` seconds. pub async fn get_config_delete_server_after(&self) -> Result> { match self.get_config_int(Config::DeleteServerAfter).await? { 0 => Ok(None), 1 => Ok(Some(0)), x => Ok(Some(i64::from(x))), } } /// Gets the configured provider, as saved in the `configured_provider` value. /// /// The provider is determined by `get_provider_info()` during configuration and then saved /// to the db in `param.save_to_database()`, together with all the other `configured_*` values. pub async fn get_configured_provider(&self) -> Result> { if let Some(cfg) = self.get_config(Config::ConfiguredProvider).await? { return Ok(get_provider_by_id(&cfg)); } Ok(None) } /// Gets configured "delete_device_after" value. /// /// `None` means never delete the message, `Some(x)` means delete /// after `x` seconds. pub async fn get_config_delete_device_after(&self) -> Result> { match self.get_config_int(Config::DeleteDeviceAfter).await? { 0 => Ok(None), x => Ok(Some(i64::from(x))), } } /// Executes [`SyncData::Config`] item sent by other device. pub(crate) async fn sync_config(&self, key: &Config, value: &str) -> Result<()> { let config_value; let value = match key { Config::Selfavatar if value.is_empty() => None, Config::Selfavatar => { config_value = BlobObject::store_from_base64(self, value, "avatar").await?; Some(config_value.as_str()) } _ => Some(value), }; match key.is_synced() { true => self.set_config_ex(Nosync, *key, value).await, false => Ok(()), } } fn check_config(key: Config, value: Option<&str>) -> Result<()> { match key { Config::Socks5Enabled | Config::BccSelf | Config::E2eeEnabled | Config::MdnsEnabled | Config::SentboxWatch | Config::MvboxMove | Config::OnlyFetchMvbox | Config::FetchExistingMsgs | Config::DeleteToTrash | Config::SaveMimeHeaders | Config::Configured | Config::Bot | Config::NotifyAboutWrongPw | Config::SyncMsgs | Config::SignUnencrypted | Config::DisableIdle => { ensure!( matches!(value, None | Some("0") | Some("1")), "Boolean value must be either 0 or 1" ); } _ => (), } Ok(()) } /// Set the given config key and make it effective. /// This may restart the IO scheduler. If `None` is passed as a value the value is cleared and /// set to the default if there is one. pub async fn set_config(&self, key: Config, value: Option<&str>) -> Result<()> { Self::check_config(key, value)?; let _pause = match key.needs_io_restart() { true => self.scheduler.pause(self.clone()).await?, _ => Default::default(), }; self.set_config_internal(key, value).await?; if key == Config::SentboxWatch { self.last_full_folder_scan.lock().await.take(); } Ok(()) } pub(crate) async fn set_config_internal(&self, key: Config, value: Option<&str>) -> Result<()> { self.set_config_ex(Sync, key, value).await } pub(crate) async fn set_config_ex( &self, sync: sync::Sync, key: Config, mut value: Option<&str>, ) -> Result<()> { Self::check_config(key, value)?; let sync = sync == Sync && key.is_synced(); let better_value; match key { Config::Selfavatar => { self.sql .execute("UPDATE contacts SET selfavatar_sent=0;", ()) .await?; match value { Some(path) => { let mut blob = BlobObject::new_from_path(self, path.as_ref()).await?; blob.recode_to_avatar_size(self).await?; self.sql .set_raw_config(key.as_ref(), Some(blob.as_name())) .await?; if sync { let buf = fs::read(blob.to_abs_path()).await?; better_value = base64::engine::general_purpose::STANDARD.encode(buf); value = Some(&better_value); } } None => { self.sql.set_raw_config(key.as_ref(), None).await?; if sync { better_value = String::new(); value = Some(&better_value); } } } self.emit_event(EventType::SelfavatarChanged); } Config::DeleteDeviceAfter => { let ret = self.sql.set_raw_config(key.as_ref(), value).await; // Interrupt ephemeral loop to delete old messages immediately. self.scheduler.interrupt_ephemeral_task().await; ret? } Config::Displayname => { if let Some(v) = value { better_value = improve_single_line_input(v); value = Some(&better_value); } self.sql.set_raw_config(key.as_ref(), value).await?; } Config::Addr => { self.sql .set_raw_config(key.as_ref(), value.map(|s| s.to_lowercase()).as_deref()) .await?; } Config::MvboxMove => { self.sql.set_raw_config(key.as_ref(), value).await?; self.sql .set_raw_config(constants::DC_FOLDERS_CONFIGURED_KEY, None) .await?; } _ => { self.sql.set_raw_config(key.as_ref(), value).await?; } } if key.is_synced() { self.emit_event(EventType::ConfigSynced { key }); } if !sync { return Ok(()); } let Some(val) = value else { return Ok(()); }; let val = val.to_string(); if self .add_sync_item(SyncData::Config { key, val }) .await .log_err(self) .is_err() { return Ok(()); } Box::pin(self.send_sync_msg()).await.log_err(self).ok(); Ok(()) } /// Set the given config to an unsigned 32-bit integer value. pub async fn set_config_u32(&self, key: Config, value: u32) -> Result<()> { self.set_config(key, Some(&value.to_string())).await?; Ok(()) } /// Set the given config to a boolean value. pub async fn set_config_bool(&self, key: Config, value: bool) -> Result<()> { self.set_config(key, from_bool(value)).await?; Ok(()) } /// Sets an ui-specific key-value pair. /// Keys must be prefixed by `ui.` /// and should be followed by the name of the system and maybe subsystem, /// eg. `ui.desktop.linux.foo`, `ui.desktop.macos.bar`, `ui.ios.foobar`. pub async fn set_ui_config(&self, key: &str, value: Option<&str>) -> Result<()> { ensure!(key.starts_with("ui."), "set_ui_config(): prefix missing."); self.sql.set_raw_config(key, value).await } /// Gets an ui-specific value set by set_ui_config(). pub async fn get_ui_config(&self, key: &str) -> Result> { ensure!(key.starts_with("ui."), "get_ui_config(): prefix missing."); self.sql.get_raw_config(key).await } } /// Returns a value for use in `Context::set_config_*()` for the given `bool`. pub(crate) fn from_bool(val: bool) -> Option<&'static str> { Some(if val { "1" } else { "0" }) } // Separate impl block for self address handling impl Context { /// Determine whether the specified addr maps to the/a self addr. /// Returns `false` if no addresses are configured. pub(crate) async fn is_self_addr(&self, addr: &str) -> Result { Ok(self .get_config(Config::ConfiguredAddr) .await? .iter() .any(|a| addr_cmp(addr, a)) || self .get_secondary_self_addrs() .await? .iter() .any(|a| addr_cmp(addr, a))) } /// Sets `primary_new` as the new primary self address and saves the old /// primary address (if exists) as a secondary address. /// /// This should only be used by test code and during configure. pub(crate) async fn set_primary_self_addr(&self, primary_new: &str) -> Result<()> { // add old primary address (if exists) to secondary addresses let mut secondary_addrs = self.get_all_self_addrs().await?; // never store a primary address also as a secondary secondary_addrs.retain(|a| !addr_cmp(a, primary_new)); self.set_config_internal( Config::SecondaryAddrs, Some(secondary_addrs.join(" ").as_str()), ) .await?; self.set_config_internal(Config::ConfiguredAddr, Some(primary_new)) .await?; Ok(()) } /// Returns all primary and secondary self addresses. pub(crate) async fn get_all_self_addrs(&self) -> Result> { let primary_addrs = self.get_config(Config::ConfiguredAddr).await?.into_iter(); let secondary_addrs = self.get_secondary_self_addrs().await?.into_iter(); Ok(primary_addrs.chain(secondary_addrs).collect()) } /// Returns all secondary self addresses. pub(crate) async fn get_secondary_self_addrs(&self) -> Result> { let secondary_addrs = self .get_config(Config::SecondaryAddrs) .await? .unwrap_or_default(); Ok(secondary_addrs .split_ascii_whitespace() .map(|s| s.to_string()) .collect()) } /// Returns the primary self address. /// Returns an error if no self addr is configured. pub async fn get_primary_self_addr(&self) -> Result { self.get_config(Config::ConfiguredAddr) .await? .context("No self addr configured") } } /// Returns all available configuration keys concated together. fn get_config_keys_string() -> String { let keys = Config::iter().fold(String::new(), |mut acc, key| { acc += key.as_ref(); acc += " "; acc }); format!(" {keys} ") } #[cfg(test)] mod tests { use num_traits::FromPrimitive; use super::*; use crate::test_utils::{sync, TestContext, TestContextManager}; #[test] fn test_to_string() { assert_eq!(Config::MailServer.to_string(), "mail_server"); assert_eq!(Config::from_str("mail_server"), Ok(Config::MailServer)); assert_eq!(Config::SysConfigKeys.to_string(), "sys.config_keys"); assert_eq!( Config::from_str("sys.config_keys"), Ok(Config::SysConfigKeys) ); } #[tokio::test(flavor = "multi_thread", worker_threads = 2)] async fn test_set_config_addr() { let t = TestContext::new().await; // Test that uppercase address get lowercased. assert!(t .set_config(Config::Addr, Some("Foobar@eXample.oRg")) .await .is_ok()); assert_eq!( t.get_config(Config::Addr).await.unwrap().unwrap(), "foobar@example.org" ); } /// Tests that "bot" config can only be set to "0" or "1". #[tokio::test(flavor = "multi_thread", worker_threads = 2)] async fn test_set_config_bot() { let t = TestContext::new().await; assert!(t.set_config(Config::Bot, None).await.is_ok()); assert!(t.set_config(Config::Bot, Some("0")).await.is_ok()); assert!(t.set_config(Config::Bot, Some("1")).await.is_ok()); assert!(t.set_config(Config::Bot, Some("2")).await.is_err()); assert!(t.set_config(Config::Bot, Some("Foobar")).await.is_err()); } #[tokio::test(flavor = "multi_thread", worker_threads = 2)] async fn test_media_quality_config_option() { let t = TestContext::new().await; let media_quality = t.get_config_int(Config::MediaQuality).await.unwrap(); assert_eq!(media_quality, 0); let media_quality = constants::MediaQuality::from_i32(media_quality).unwrap_or_default(); assert_eq!(media_quality, constants::MediaQuality::Balanced); t.set_config(Config::MediaQuality, Some("1")).await.unwrap(); let media_quality = t.get_config_int(Config::MediaQuality).await.unwrap(); assert_eq!(media_quality, 1); assert_eq!(constants::MediaQuality::Worse as i32, 1); let media_quality = constants::MediaQuality::from_i32(media_quality).unwrap_or_default(); assert_eq!(media_quality, constants::MediaQuality::Worse); } #[tokio::test(flavor = "multi_thread", worker_threads = 2)] async fn test_ui_config() -> Result<()> { let t = TestContext::new().await; assert_eq!(t.get_ui_config("ui.desktop.linux.systray").await?, None); t.set_ui_config("ui.android.screen_security", Some("safe")) .await?; assert_eq!( t.get_ui_config("ui.android.screen_security").await?, Some("safe".to_string()) ); t.set_ui_config("ui.android.screen_security", None).await?; assert_eq!(t.get_ui_config("ui.android.screen_security").await?, None); assert!(t.set_ui_config("configured", Some("bar")).await.is_err()); Ok(()) } /// Regression test for https://github.com/deltachat/deltachat-core-rust/issues/3012 #[tokio::test(flavor = "multi_thread", worker_threads = 2)] async fn test_set_config_bool() -> Result<()> { let t = TestContext::new().await; // We need some config that defaults to true let c = Config::E2eeEnabled; assert_eq!(t.get_config_bool(c).await?, true); t.set_config_bool(c, false).await?; assert_eq!(t.get_config_bool(c).await?, false); Ok(()) } #[tokio::test(flavor = "multi_thread", worker_threads = 2)] async fn test_self_addrs() -> Result<()> { let alice = TestContext::new_alice().await; assert!(alice.is_self_addr("alice@example.org").await?); assert_eq!(alice.get_all_self_addrs().await?, vec!["alice@example.org"]); assert!(!alice.is_self_addr("alice@alice.com").await?); // Test adding the same primary address alice.set_primary_self_addr("alice@example.org").await?; alice.set_primary_self_addr("Alice@Example.Org").await?; assert_eq!(alice.get_all_self_addrs().await?, vec!["Alice@Example.Org"]); // Test adding a new (primary) self address // The address is trimmed during configure by `LoginParam::from_database()`, // so `set_primary_self_addr()` doesn't have to trim it. alice.set_primary_self_addr("Alice@alice.com").await?; assert!(alice.is_self_addr("aliCe@example.org").await?); assert!(alice.is_self_addr("alice@alice.com").await?); assert_eq!( alice.get_all_self_addrs().await?, vec!["Alice@alice.com", "Alice@Example.Org"] ); // Check that the entry is not duplicated alice.set_primary_self_addr("alice@alice.com").await?; alice.set_primary_self_addr("alice@alice.com").await?; assert_eq!( alice.get_all_self_addrs().await?, vec!["alice@alice.com", "Alice@Example.Org"] ); // Test switching back alice.set_primary_self_addr("alice@example.org").await?; assert_eq!( alice.get_all_self_addrs().await?, vec!["alice@example.org", "alice@alice.com"] ); // Test setting a new primary self address, the previous self address // should be kept as a secondary self address alice.set_primary_self_addr("alice@alice.xyz").await?; assert_eq!( alice.get_all_self_addrs().await?, vec!["alice@alice.xyz", "alice@example.org", "alice@alice.com"] ); assert!(alice.is_self_addr("alice@example.org").await?); assert!(alice.is_self_addr("alice@alice.com").await?); assert!(alice.is_self_addr("Alice@alice.xyz").await?); Ok(()) } #[tokio::test(flavor = "multi_thread", worker_threads = 2)] async fn test_sync() -> Result<()> { let alice0 = TestContext::new_alice().await; let alice1 = TestContext::new_alice().await; for a in [&alice0, &alice1] { a.set_config_bool(Config::SyncMsgs, true).await?; } let mdns_enabled = alice0.get_config_bool(Config::MdnsEnabled).await?; // Alice1 has a different config value. alice1 .set_config_bool(Config::MdnsEnabled, !mdns_enabled) .await?; // This changes nothing, but still sends a sync message. alice0 .set_config_bool(Config::MdnsEnabled, mdns_enabled) .await?; sync(&alice0, &alice1).await; assert_eq!( alice1.get_config_bool(Config::MdnsEnabled).await?, mdns_enabled ); // Reset to default. Test that it's not synced because defaults may differ across client // versions. alice0.set_config(Config::MdnsEnabled, None).await?; assert_eq!(alice0.get_config_bool(Config::MdnsEnabled).await?, true); alice0.set_config_bool(Config::MdnsEnabled, false).await?; sync(&alice0, &alice1).await; assert_eq!(alice1.get_config_bool(Config::MdnsEnabled).await?, false); let show_emails = alice0.get_config_bool(Config::ShowEmails).await?; alice0 .set_config_bool(Config::ShowEmails, !show_emails) .await?; sync(&alice0, &alice1).await; assert_eq!( alice1.get_config_bool(Config::ShowEmails).await?, !show_emails ); // `Config::SyncMsgs` mustn't be synced. alice0.set_config_bool(Config::SyncMsgs, false).await?; alice0.set_config_bool(Config::SyncMsgs, true).await?; alice0.set_config_bool(Config::MdnsEnabled, true).await?; sync(&alice0, &alice1).await; assert!(alice1.get_config_bool(Config::MdnsEnabled).await?); // Usual sync scenario. async fn test_config_str( alice0: &TestContext, alice1: &TestContext, key: Config, val: &str, ) -> Result<()> { alice0.set_config(key, Some(val)).await?; sync(alice0, alice1).await; assert_eq!(alice1.get_config(key).await?, Some(val.to_string())); Ok(()) } test_config_str(&alice0, &alice1, Config::Displayname, "Alice Sync").await?; test_config_str(&alice0, &alice1, Config::Selfstatus, "My status").await?; assert!(alice0.get_config(Config::Selfavatar).await?.is_none()); let file = alice0.dir.path().join("avatar.png"); let bytes = include_bytes!("../test-data/image/avatar64x64.png"); tokio::fs::write(&file, bytes).await?; alice0 .set_config(Config::Selfavatar, Some(file.to_str().unwrap())) .await?; sync(&alice0, &alice1).await; // There was a bug that a sync message creates the self-chat with the user avatar instead of // the special icon and that remains so when the self-chat becomes user-visible. Let's check // this. let self_chat = alice0.get_self_chat().await; let self_chat_avatar_path = self_chat.get_profile_image(&alice0).await?.unwrap(); assert_eq!( self_chat_avatar_path, alice0.get_blobdir().join("icon-saved-messages.png") ); assert!(alice1 .get_config(Config::Selfavatar) .await? .filter(|path| path.ends_with(".png")) .is_some()); alice0.set_config(Config::Selfavatar, None).await?; sync(&alice0, &alice1).await; assert!(alice1.get_config(Config::Selfavatar).await?.is_none()); Ok(()) } /// Sync message mustn't be sent if self-{status,avatar} is changed by a self-sent message. #[tokio::test(flavor = "multi_thread", worker_threads = 2)] async fn test_no_sync_on_self_sent_msg() -> Result<()> { let mut tcm = TestContextManager::new(); let alice0 = &tcm.alice().await; let alice1 = &tcm.alice().await; for a in [alice0, alice1] { a.set_config_bool(Config::SyncMsgs, true).await?; } let status = "Synced via usual message"; alice0.set_config(Config::Selfstatus, Some(status)).await?; alice0.pop_sent_msg().await; // Sync message let status1 = "Synced via sync message"; alice1.set_config(Config::Selfstatus, Some(status1)).await?; tcm.send_recv(alice0, alice1, "hi Alice!").await; assert_eq!( alice1.get_config(Config::Selfstatus).await?, Some(status.to_string()) ); sync(alice1, alice0).await; assert_eq!( alice0.get_config(Config::Selfstatus).await?, Some(status1.to_string()) ); // Need a chat with another contact to send self-avatar. let bob = &tcm.bob().await; let a0b_chat_id = tcm.send_recv_accept(bob, alice0, "hi").await.chat_id; let file = alice0.dir.path().join("avatar.png"); let bytes = include_bytes!("../test-data/image/avatar64x64.png"); tokio::fs::write(&file, bytes).await?; alice0 .set_config(Config::Selfavatar, Some(file.to_str().unwrap())) .await?; alice0.pop_sent_msg().await; // Sync message let file = alice1.dir.path().join("avatar.jpg"); let bytes = include_bytes!("../test-data/image/avatar1000x1000.jpg"); tokio::fs::write(&file, bytes).await?; alice1 .set_config(Config::Selfavatar, Some(file.to_str().unwrap())) .await?; let sent_msg = alice0.send_text(a0b_chat_id, "hi").await; alice1.recv_msg(&sent_msg).await; assert!(alice1 .get_config(Config::Selfavatar) .await? .filter(|path| path.ends_with(".png")) .is_some()); sync(alice1, alice0).await; assert!(alice0 .get_config(Config::Selfavatar) .await? .filter(|path| path.ends_with(".jpg")) .is_some()); Ok(()) } #[tokio::test(flavor = "multi_thread", worker_threads = 2)] async fn test_event_config_synced() -> Result<()> { let alice0 = TestContext::new_alice().await; let alice1 = TestContext::new_alice().await; for a in [&alice0, &alice1] { a.set_config_bool(Config::SyncMsgs, true).await?; } alice0 .set_config(Config::Displayname, Some("Alice Sync")) .await?; alice0 .evtracker .get_matching(|e| { matches!( e, EventType::ConfigSynced { key: Config::Displayname } ) }) .await; sync(&alice0, &alice1).await; assert_eq!( alice1.get_config(Config::Displayname).await?, Some("Alice Sync".to_string()) ); alice1 .evtracker .get_matching(|e| { matches!( e, EventType::ConfigSynced { key: Config::Displayname } ) }) .await; alice0.set_config(Config::Displayname, None).await?; alice0 .evtracker .get_matching(|e| { matches!( e, EventType::ConfigSynced { key: Config::Displayname } ) }) .await; Ok(()) } }