deltachat/
context.rs

1//! Context module.
2
3use std::collections::{BTreeMap, HashMap};
4use std::ffi::OsString;
5use std::ops::Deref;
6use std::path::{Path, PathBuf};
7use std::sync::atomic::{AtomicBool, Ordering};
8use std::sync::{Arc, OnceLock};
9use std::time::Duration;
10
11use anyhow::{Context as _, Result, bail, ensure};
12use async_channel::{self as channel, Receiver, Sender};
13use pgp::types::PublicKeyTrait;
14use ratelimit::Ratelimit;
15use tokio::sync::{Mutex, Notify, RwLock};
16
17use crate::chat::{ChatId, ProtectionStatus, get_chat_cnt};
18use crate::chatlist_events;
19use crate::config::Config;
20use crate::constants::{
21    self, DC_BACKGROUND_FETCH_QUOTA_CHECK_RATELIMIT, DC_CHAT_ID_TRASH, DC_VERSION_STR,
22};
23use crate::contact::{Contact, ContactId, import_vcard, mark_contact_id_as_verified};
24use crate::debug_logging::DebugLogging;
25use crate::download::DownloadState;
26use crate::events::{Event, EventEmitter, EventType, Events};
27use crate::imap::{FolderMeaning, Imap, ServerMetadata};
28use crate::key::{load_self_secret_key, self_fingerprint};
29use crate::log::{info, warn};
30use crate::logged_debug_assert;
31use crate::login_param::{ConfiguredLoginParam, EnteredLoginParam};
32use crate::message::{self, Message, MessageState, MsgId};
33use crate::param::{Param, Params};
34use crate::peer_channels::Iroh;
35use crate::push::PushSubscriber;
36use crate::quota::QuotaInfo;
37use crate::scheduler::{ConnectivityStore, SchedulerState, convert_folder_meaning};
38use crate::sql::Sql;
39use crate::stock_str::StockStrings;
40use crate::timesmearing::SmearedTimestamp;
41use crate::tools::{self, create_id, duration_to_str, time, time_elapsed};
42
43/// Builder for the [`Context`].
44///
45/// Many arguments to the [`Context`] are kind of optional and only needed to handle
46/// multiple contexts, for which the [account manager](crate::accounts::Accounts) should be
47/// used.  This builder makes creating a new context simpler, especially for the
48/// standalone-context case.
49///
50/// # Examples
51///
52/// Creating a new unencrypted database:
53///
54/// ```
55/// # let rt = tokio::runtime::Runtime::new().unwrap();
56/// # rt.block_on(async move {
57/// use deltachat::context::ContextBuilder;
58///
59/// let dir = tempfile::tempdir().unwrap();
60/// let context = ContextBuilder::new(dir.path().join("db"))
61///      .open()
62///      .await
63///      .unwrap();
64/// drop(context);
65/// # });
66/// ```
67///
68/// To use an encrypted database provide a password.  If the database does not yet exist it
69/// will be created:
70///
71/// ```
72/// # let rt = tokio::runtime::Runtime::new().unwrap();
73/// # rt.block_on(async move {
74/// use deltachat::context::ContextBuilder;
75///
76/// let dir = tempfile::tempdir().unwrap();
77/// let context = ContextBuilder::new(dir.path().join("db"))
78///      .with_password("secret".into())
79///      .open()
80///      .await
81///      .unwrap();
82/// drop(context);
83/// # });
84/// ```
85#[derive(Clone, Debug)]
86pub struct ContextBuilder {
87    dbfile: PathBuf,
88    id: u32,
89    events: Events,
90    stock_strings: StockStrings,
91    password: Option<String>,
92
93    push_subscriber: Option<PushSubscriber>,
94}
95
96impl ContextBuilder {
97    /// Create the builder using the given database file.
98    ///
99    /// The *dbfile* should be in a dedicated directory and this directory must exist.  The
100    /// [`Context`] will create other files and folders in the same directory as the
101    /// database file used.
102    pub fn new(dbfile: PathBuf) -> Self {
103        ContextBuilder {
104            dbfile,
105            id: rand::random(),
106            events: Events::new(),
107            stock_strings: StockStrings::new(),
108            password: None,
109            push_subscriber: None,
110        }
111    }
112
113    /// Sets the context ID.
114    ///
115    /// This identifier is used e.g. in [`Event`]s to identify which [`Context`] an event
116    /// belongs to.  The only real limit on it is that it should not conflict with any other
117    /// [`Context`]s you currently have open.  So if you handle multiple [`Context`]s you
118    /// may want to use this.
119    ///
120    /// Note that the [account manager](crate::accounts::Accounts) is designed to handle the
121    /// common case for using multiple [`Context`] instances.
122    pub fn with_id(mut self, id: u32) -> Self {
123        self.id = id;
124        self
125    }
126
127    /// Sets the event channel for this [`Context`].
128    ///
129    /// Mostly useful when using multiple [`Context`]s, this allows creating one [`Events`]
130    /// channel and passing it to all [`Context`]s so all events are received on the same
131    /// channel.
132    ///
133    /// Note that the [account manager](crate::accounts::Accounts) is designed to handle the
134    /// common case for using multiple [`Context`] instances.
135    pub fn with_events(mut self, events: Events) -> Self {
136        self.events = events;
137        self
138    }
139
140    /// Sets the [`StockStrings`] map to use for this [`Context`].
141    ///
142    /// This is useful in order to share the same translation strings in all [`Context`]s.
143    /// The mapping may be empty when set, it will be populated by
144    /// [`Context::set_stock-translation`] or [`Accounts::set_stock_translation`] calls.
145    ///
146    /// Note that the [account manager](crate::accounts::Accounts) is designed to handle the
147    /// common case for using multiple [`Context`] instances.
148    ///
149    /// [`Accounts::set_stock_translation`]: crate::accounts::Accounts::set_stock_translation
150    pub fn with_stock_strings(mut self, stock_strings: StockStrings) -> Self {
151        self.stock_strings = stock_strings;
152        self
153    }
154
155    /// Sets the password to unlock the database.
156    ///
157    /// If an encrypted database is used it must be opened with a password.  Setting a
158    /// password on a new database will enable encryption.
159    pub fn with_password(mut self, password: String) -> Self {
160        self.password = Some(password);
161        self
162    }
163
164    /// Sets push subscriber.
165    pub(crate) fn with_push_subscriber(mut self, push_subscriber: PushSubscriber) -> Self {
166        self.push_subscriber = Some(push_subscriber);
167        self
168    }
169
170    /// Builds the [`Context`] without opening it.
171    pub async fn build(self) -> Result<Context> {
172        let push_subscriber = self.push_subscriber.unwrap_or_default();
173        let context = Context::new_closed(
174            &self.dbfile,
175            self.id,
176            self.events,
177            self.stock_strings,
178            push_subscriber,
179        )
180        .await?;
181        Ok(context)
182    }
183
184    /// Builds the [`Context`] and opens it.
185    ///
186    /// Returns error if context cannot be opened with the given passphrase.
187    pub async fn open(self) -> Result<Context> {
188        let password = self.password.clone().unwrap_or_default();
189        let context = self.build().await?;
190        match context.open(password).await? {
191            true => Ok(context),
192            false => bail!("database could not be decrypted, incorrect or missing password"),
193        }
194    }
195}
196
197/// The context for a single DeltaChat account.
198///
199/// This contains all the state for a single DeltaChat account, including background tasks
200/// running in Tokio to operate the account.  The [`Context`] can be cheaply cloned.
201///
202/// Each context, and thus each account, must be associated with an directory where all the
203/// state is kept.  This state is also preserved between restarts.
204///
205/// To use multiple accounts it is best to look at the [accounts
206/// manager][crate::accounts::Accounts] which handles storing multiple accounts in a single
207/// directory structure and handles loading them all concurrently.
208#[derive(Clone, Debug)]
209pub struct Context {
210    pub(crate) inner: Arc<InnerContext>,
211}
212
213impl Deref for Context {
214    type Target = InnerContext;
215
216    fn deref(&self) -> &Self::Target {
217        &self.inner
218    }
219}
220
221/// Actual context, expensive to clone.
222#[derive(Debug)]
223pub struct InnerContext {
224    /// Blob directory path
225    pub(crate) blobdir: PathBuf,
226    pub(crate) sql: Sql,
227    pub(crate) smeared_timestamp: SmearedTimestamp,
228    /// The global "ongoing" process state.
229    ///
230    /// This is a global mutex-like state for operations which should be modal in the
231    /// clients.
232    running_state: RwLock<RunningState>,
233    /// Mutex to avoid generating the key for the user more than once.
234    pub(crate) generating_key_mutex: Mutex<()>,
235    /// Mutex to enforce only a single running oauth2 is running.
236    pub(crate) oauth2_mutex: Mutex<()>,
237    /// Mutex to prevent a race condition when a "your pw is wrong" warning is sent, resulting in multiple messages being sent.
238    pub(crate) wrong_pw_warning_mutex: Mutex<()>,
239    pub(crate) translated_stockstrings: StockStrings,
240    pub(crate) events: Events,
241
242    pub(crate) scheduler: SchedulerState,
243    pub(crate) ratelimit: RwLock<Ratelimit>,
244
245    /// Recently loaded quota information, if any.
246    /// Set to `None` if quota was never tried to load.
247    pub(crate) quota: RwLock<Option<QuotaInfo>>,
248
249    /// IMAP UID resync request.
250    pub(crate) resync_request: AtomicBool,
251
252    /// Notify about new messages.
253    ///
254    /// This causes [`Context::wait_next_msgs`] to wake up.
255    pub(crate) new_msgs_notify: Notify,
256
257    /// Server ID response if ID capability is supported
258    /// and the server returned non-NIL on the inbox connection.
259    /// <https://datatracker.ietf.org/doc/html/rfc2971>
260    pub(crate) server_id: RwLock<Option<HashMap<String, String>>>,
261
262    /// IMAP METADATA.
263    pub(crate) metadata: RwLock<Option<ServerMetadata>>,
264
265    pub(crate) last_full_folder_scan: Mutex<Option<tools::Time>>,
266
267    /// ID for this `Context` in the current process.
268    ///
269    /// This allows for multiple `Context`s open in a single process where each context can
270    /// be identified by this ID.
271    pub(crate) id: u32,
272
273    creation_time: tools::Time,
274
275    /// The text of the last error logged and emitted as an event.
276    /// If the ui wants to display an error after a failure,
277    /// `last_error` should be used to avoid races with the event thread.
278    pub(crate) last_error: parking_lot::RwLock<String>,
279
280    /// It's not possible to emit migration errors as an event,
281    /// because at the time of the migration, there is no event emitter yet.
282    /// So, this holds the error that happened during migration, if any.
283    /// This is necessary for the possibly-failible PGP migration,
284    /// which happened 2025-05, and can be removed a few releases later.
285    pub(crate) migration_error: parking_lot::RwLock<Option<String>>,
286
287    /// If debug logging is enabled, this contains all necessary information
288    ///
289    /// Standard RwLock instead of [`tokio::sync::RwLock`] is used
290    /// because the lock is used from synchronous [`Context::emit_event`].
291    pub(crate) debug_logging: std::sync::RwLock<Option<DebugLogging>>,
292
293    /// Push subscriber to store device token
294    /// and register for heartbeat notifications.
295    pub(crate) push_subscriber: PushSubscriber,
296
297    /// True if account has subscribed to push notifications via IMAP.
298    pub(crate) push_subscribed: AtomicBool,
299
300    /// Iroh for realtime peer channels.
301    pub(crate) iroh: Arc<RwLock<Option<Iroh>>>,
302
303    /// The own fingerprint, if it was computed already.
304    /// tokio::sync::OnceCell would be possible to use, but overkill for our usecase;
305    /// the standard library's OnceLock is enough, and it's a lot smaller in memory.
306    pub(crate) self_fingerprint: OnceLock<String>,
307
308    /// `Connectivity` values for mailboxes, unordered. Used to compute the aggregate connectivity,
309    /// see [`Context::get_connectivity()`].
310    pub(crate) connectivities: parking_lot::Mutex<Vec<ConnectivityStore>>,
311}
312
313/// The state of ongoing process.
314#[derive(Debug)]
315enum RunningState {
316    /// Ongoing process is allocated.
317    Running { cancel_sender: Sender<()> },
318
319    /// Cancel signal has been sent, waiting for ongoing process to be freed.
320    ShallStop { request: tools::Time },
321
322    /// There is no ongoing process, a new one can be allocated.
323    Stopped,
324}
325
326impl Default for RunningState {
327    fn default() -> Self {
328        Self::Stopped
329    }
330}
331
332/// Return some info about deltachat-core
333///
334/// This contains information mostly about the library itself, the
335/// actual keys and their values which will be present are not
336/// guaranteed.  Calling [Context::get_info] also includes information
337/// about the context on top of the information here.
338pub fn get_info() -> BTreeMap<&'static str, String> {
339    let mut res = BTreeMap::new();
340
341    #[cfg(debug_assertions)]
342    res.insert(
343        "debug_assertions",
344        "On - DO NOT RELEASE THIS BUILD".to_string(),
345    );
346    #[cfg(not(debug_assertions))]
347    res.insert("debug_assertions", "Off".to_string());
348
349    res.insert("deltachat_core_version", format!("v{}", &*DC_VERSION_STR));
350    res.insert("sqlite_version", rusqlite::version().to_string());
351    res.insert("arch", (std::mem::size_of::<usize>() * 8).to_string());
352    res.insert("num_cpus", num_cpus::get().to_string());
353    res.insert("level", "awesome".into());
354    res
355}
356
357impl Context {
358    /// Creates new context and opens the database.
359    pub async fn new(
360        dbfile: &Path,
361        id: u32,
362        events: Events,
363        stock_strings: StockStrings,
364    ) -> Result<Context> {
365        let context =
366            Self::new_closed(dbfile, id, events, stock_strings, Default::default()).await?;
367
368        // Open the database if is not encrypted.
369        if context.check_passphrase("".to_string()).await? {
370            context.sql.open(&context, "".to_string()).await?;
371        }
372        Ok(context)
373    }
374
375    /// Creates new context without opening the database.
376    pub async fn new_closed(
377        dbfile: &Path,
378        id: u32,
379        events: Events,
380        stockstrings: StockStrings,
381        push_subscriber: PushSubscriber,
382    ) -> Result<Context> {
383        let mut blob_fname = OsString::new();
384        blob_fname.push(dbfile.file_name().unwrap_or_default());
385        blob_fname.push("-blobs");
386        let blobdir = dbfile.with_file_name(blob_fname);
387        if !blobdir.exists() {
388            tokio::fs::create_dir_all(&blobdir).await?;
389        }
390        let context = Context::with_blobdir(
391            dbfile.into(),
392            blobdir,
393            id,
394            events,
395            stockstrings,
396            push_subscriber,
397        )?;
398        Ok(context)
399    }
400
401    /// Opens the database with the given passphrase.
402    ///
403    /// Returns true if passphrase is correct, false is passphrase is not correct. Fails on other
404    /// errors.
405    pub async fn open(&self, passphrase: String) -> Result<bool> {
406        if self.sql.check_passphrase(passphrase.clone()).await? {
407            self.sql.open(self, passphrase).await?;
408            Ok(true)
409        } else {
410            Ok(false)
411        }
412    }
413
414    /// Changes encrypted database passphrase.
415    pub async fn change_passphrase(&self, passphrase: String) -> Result<()> {
416        self.sql.change_passphrase(passphrase).await?;
417        Ok(())
418    }
419
420    /// Returns true if database is open.
421    pub async fn is_open(&self) -> bool {
422        self.sql.is_open().await
423    }
424
425    /// Tests the database passphrase.
426    ///
427    /// Returns true if passphrase is correct.
428    ///
429    /// Fails if database is already open.
430    pub(crate) async fn check_passphrase(&self, passphrase: String) -> Result<bool> {
431        self.sql.check_passphrase(passphrase).await
432    }
433
434    pub(crate) fn with_blobdir(
435        dbfile: PathBuf,
436        blobdir: PathBuf,
437        id: u32,
438        events: Events,
439        stockstrings: StockStrings,
440        push_subscriber: PushSubscriber,
441    ) -> Result<Context> {
442        ensure!(
443            blobdir.is_dir(),
444            "Blobdir does not exist: {}",
445            blobdir.display()
446        );
447
448        let new_msgs_notify = Notify::new();
449        // Notify once immediately to allow processing old messages
450        // without starting I/O.
451        new_msgs_notify.notify_one();
452
453        let inner = InnerContext {
454            id,
455            blobdir,
456            running_state: RwLock::new(Default::default()),
457            sql: Sql::new(dbfile),
458            smeared_timestamp: SmearedTimestamp::new(),
459            generating_key_mutex: Mutex::new(()),
460            oauth2_mutex: Mutex::new(()),
461            wrong_pw_warning_mutex: Mutex::new(()),
462            translated_stockstrings: stockstrings,
463            events,
464            scheduler: SchedulerState::new(),
465            ratelimit: RwLock::new(Ratelimit::new(Duration::new(60, 0), 6.0)), // Allow at least 1 message every 10 seconds + a burst of 6.
466            quota: RwLock::new(None),
467            resync_request: AtomicBool::new(false),
468            new_msgs_notify,
469            server_id: RwLock::new(None),
470            metadata: RwLock::new(None),
471            creation_time: tools::Time::now(),
472            last_full_folder_scan: Mutex::new(None),
473            last_error: parking_lot::RwLock::new("".to_string()),
474            migration_error: parking_lot::RwLock::new(None),
475            debug_logging: std::sync::RwLock::new(None),
476            push_subscriber,
477            push_subscribed: AtomicBool::new(false),
478            iroh: Arc::new(RwLock::new(None)),
479            self_fingerprint: OnceLock::new(),
480            connectivities: parking_lot::Mutex::new(Vec::new()),
481        };
482
483        let ctx = Context {
484            inner: Arc::new(inner),
485        };
486
487        Ok(ctx)
488    }
489
490    /// Starts the IO scheduler.
491    pub async fn start_io(&self) {
492        if !self.is_configured().await.unwrap_or_default() {
493            warn!(self, "can not start io on a context that is not configured");
494            return;
495        }
496
497        if self.is_chatmail().await.unwrap_or_default() {
498            let mut lock = self.ratelimit.write().await;
499            // Allow at least 1 message every second + a burst of 3.
500            *lock = Ratelimit::new(Duration::new(3, 0), 3.0);
501        }
502
503        // The next line is mainly for iOS:
504        // iOS starts a separate process for receiving notifications and if the user concurrently
505        // starts the app, the UI process opens the database but waits with calling start_io()
506        // until the notifications process finishes.
507        // Now, some configs may have changed, so, we need to invalidate the cache.
508        self.sql.config_cache.write().await.clear();
509
510        self.scheduler.start(self).await;
511    }
512
513    /// Stops the IO scheduler.
514    pub async fn stop_io(&self) {
515        self.scheduler.stop(self).await;
516        if let Some(iroh) = self.iroh.write().await.take() {
517            // Close all QUIC connections.
518
519            // Spawn into a separate task,
520            // because Iroh calls `wait_idle()` internally
521            // and it may take time, especially if the network
522            // has become unavailable.
523            tokio::spawn(async move {
524                // We do not log the error because we do not want the task
525                // to hold the reference to Context.
526                let _ = tokio::time::timeout(Duration::from_secs(60), iroh.close()).await;
527            });
528        }
529    }
530
531    /// Restarts the IO scheduler if it was running before
532    /// when it is not running this is an no-op
533    pub async fn restart_io_if_running(&self) {
534        self.scheduler.restart(self).await;
535    }
536
537    /// Indicate that the network likely has come back.
538    pub async fn maybe_network(&self) {
539        if let Some(ref iroh) = *self.iroh.read().await {
540            iroh.network_change().await;
541        }
542        self.scheduler.maybe_network().await;
543    }
544
545    /// Returns true if an account is on a chatmail server.
546    pub async fn is_chatmail(&self) -> Result<bool> {
547        self.get_config_bool(Config::IsChatmail).await
548    }
549
550    /// Returns maximum number of recipients the provider allows to send a single email to.
551    pub(crate) async fn get_max_smtp_rcpt_to(&self) -> Result<usize> {
552        let is_chatmail = self.is_chatmail().await?;
553        let val = self
554            .get_configured_provider()
555            .await?
556            .and_then(|provider| provider.opt.max_smtp_rcpt_to)
557            .map_or_else(
558                || match is_chatmail {
559                    true => usize::MAX,
560                    false => constants::DEFAULT_MAX_SMTP_RCPT_TO,
561                },
562                usize::from,
563            );
564        Ok(val)
565    }
566
567    /// Does a single round of fetching from IMAP and returns.
568    ///
569    /// Can be used even if I/O is currently stopped.
570    /// If I/O is currently stopped, starts a new IMAP connection
571    /// and fetches from Inbox and DeltaChat folders.
572    pub async fn background_fetch(&self) -> Result<()> {
573        if !(self.is_configured().await?) {
574            return Ok(());
575        }
576
577        let address = self.get_primary_self_addr().await?;
578        let time_start = tools::Time::now();
579        info!(self, "background_fetch started fetching {address}.");
580
581        if self.scheduler.is_running().await {
582            self.scheduler.maybe_network().await;
583            self.wait_for_all_work_done().await;
584        } else {
585            // Pause the scheduler to ensure another connection does not start
586            // while we are fetching on a dedicated connection.
587            let _pause_guard = self.scheduler.pause(self).await?;
588
589            // Start a new dedicated connection.
590            let mut connection = Imap::new_configured(self, channel::bounded(1).1).await?;
591            let mut session = connection.prepare(self).await?;
592
593            // Fetch IMAP folders.
594            // Inbox is fetched before Mvbox because fetching from Inbox
595            // may result in moving some messages to Mvbox.
596            for folder_meaning in [FolderMeaning::Inbox, FolderMeaning::Mvbox] {
597                if let Some((_folder_config, watch_folder)) =
598                    convert_folder_meaning(self, folder_meaning).await?
599                {
600                    connection
601                        .fetch_move_delete(self, &mut session, &watch_folder, folder_meaning)
602                        .await?;
603                }
604            }
605
606            // Update quota (to send warning if full) - but only check it once in a while.
607            if self
608                .quota_needs_update(DC_BACKGROUND_FETCH_QUOTA_CHECK_RATELIMIT)
609                .await
610            {
611                if let Err(err) = self.update_recent_quota(&mut session).await {
612                    warn!(self, "Failed to update quota: {err:#}.");
613                }
614            }
615        }
616
617        info!(
618            self,
619            "background_fetch done for {address} took {:?}.",
620            time_elapsed(&time_start),
621        );
622
623        Ok(())
624    }
625
626    pub(crate) async fn schedule_resync(&self) -> Result<()> {
627        self.resync_request.store(true, Ordering::Relaxed);
628        self.scheduler.interrupt_inbox().await;
629        Ok(())
630    }
631
632    /// Returns a reference to the underlying SQL instance.
633    ///
634    /// Warning: this is only here for testing, not part of the public API.
635    #[cfg(feature = "internals")]
636    pub fn sql(&self) -> &Sql {
637        &self.inner.sql
638    }
639
640    /// Returns database file path.
641    pub fn get_dbfile(&self) -> &Path {
642        self.sql.dbfile.as_path()
643    }
644
645    /// Returns blob directory path.
646    pub fn get_blobdir(&self) -> &Path {
647        self.blobdir.as_path()
648    }
649
650    /// Emits a single event.
651    pub fn emit_event(&self, event: EventType) {
652        {
653            let lock = self.debug_logging.read().expect("RwLock is poisoned");
654            if let Some(debug_logging) = &*lock {
655                debug_logging.log_event(event.clone());
656            }
657        }
658        self.events.emit(Event {
659            id: self.id,
660            typ: event,
661        });
662    }
663
664    /// Emits a generic MsgsChanged event (without chat or message id)
665    pub fn emit_msgs_changed_without_ids(&self) {
666        self.emit_event(EventType::MsgsChanged {
667            chat_id: ChatId::new(0),
668            msg_id: MsgId::new(0),
669        });
670    }
671
672    /// Emits a MsgsChanged event with specified chat and message ids
673    ///
674    /// If IDs are unset, [`Self::emit_msgs_changed_without_ids`]
675    /// or [`Self::emit_msgs_changed_without_msg_id`] should be used
676    /// instead of this function.
677    pub fn emit_msgs_changed(&self, chat_id: ChatId, msg_id: MsgId) {
678        logged_debug_assert!(
679            self,
680            !chat_id.is_unset(),
681            "emit_msgs_changed: chat_id is unset."
682        );
683        logged_debug_assert!(
684            self,
685            !msg_id.is_unset(),
686            "emit_msgs_changed: msg_id is unset."
687        );
688
689        self.emit_event(EventType::MsgsChanged { chat_id, msg_id });
690        chatlist_events::emit_chatlist_changed(self);
691        chatlist_events::emit_chatlist_item_changed(self, chat_id);
692    }
693
694    /// Emits a MsgsChanged event with specified chat and without message id.
695    pub fn emit_msgs_changed_without_msg_id(&self, chat_id: ChatId) {
696        logged_debug_assert!(
697            self,
698            !chat_id.is_unset(),
699            "emit_msgs_changed_without_msg_id: chat_id is unset."
700        );
701
702        self.emit_event(EventType::MsgsChanged {
703            chat_id,
704            msg_id: MsgId::new(0),
705        });
706        chatlist_events::emit_chatlist_changed(self);
707        chatlist_events::emit_chatlist_item_changed(self, chat_id);
708    }
709
710    /// Emits an IncomingMsg event with specified chat and message ids
711    pub fn emit_incoming_msg(&self, chat_id: ChatId, msg_id: MsgId) {
712        debug_assert!(!chat_id.is_unset());
713        debug_assert!(!msg_id.is_unset());
714
715        self.emit_event(EventType::IncomingMsg { chat_id, msg_id });
716        chatlist_events::emit_chatlist_changed(self);
717        chatlist_events::emit_chatlist_item_changed(self, chat_id);
718    }
719
720    /// Emits an LocationChanged event and a WebxdcStatusUpdate in case there is a maps integration
721    pub async fn emit_location_changed(&self, contact_id: Option<ContactId>) -> Result<()> {
722        self.emit_event(EventType::LocationChanged(contact_id));
723
724        if let Some(msg_id) = self
725            .get_config_parsed::<u32>(Config::WebxdcIntegration)
726            .await?
727        {
728            self.emit_event(EventType::WebxdcStatusUpdate {
729                msg_id: MsgId::new(msg_id),
730                status_update_serial: Default::default(),
731            })
732        }
733
734        Ok(())
735    }
736
737    /// Returns a receiver for emitted events.
738    ///
739    /// Multiple emitters can be created, but note that in this case each emitted event will
740    /// only be received by one of the emitters, not by all of them.
741    pub fn get_event_emitter(&self) -> EventEmitter {
742        self.events.get_emitter()
743    }
744
745    /// Get the ID of this context.
746    pub fn get_id(&self) -> u32 {
747        self.id
748    }
749
750    // Ongoing process allocation/free/check
751
752    /// Tries to acquire the global UI "ongoing" mutex.
753    ///
754    /// This is for modal operations during which no other user actions are allowed.  Only
755    /// one such operation is allowed at any given time.
756    ///
757    /// The return value is a cancel token, which will release the ongoing mutex when
758    /// dropped.
759    pub(crate) async fn alloc_ongoing(&self) -> Result<Receiver<()>> {
760        let mut s = self.running_state.write().await;
761        ensure!(
762            matches!(*s, RunningState::Stopped),
763            "There is already another ongoing process running."
764        );
765
766        let (sender, receiver) = channel::bounded(1);
767        *s = RunningState::Running {
768            cancel_sender: sender,
769        };
770
771        Ok(receiver)
772    }
773
774    pub(crate) async fn free_ongoing(&self) {
775        let mut s = self.running_state.write().await;
776        if let RunningState::ShallStop { request } = *s {
777            info!(self, "Ongoing stopped in {:?}", time_elapsed(&request));
778        }
779        *s = RunningState::Stopped;
780    }
781
782    /// Signal an ongoing process to stop.
783    pub async fn stop_ongoing(&self) {
784        let mut s = self.running_state.write().await;
785        match &*s {
786            RunningState::Running { cancel_sender } => {
787                if let Err(err) = cancel_sender.send(()).await {
788                    warn!(self, "could not cancel ongoing: {:#}", err);
789                }
790                info!(self, "Signaling the ongoing process to stop ASAP.",);
791                *s = RunningState::ShallStop {
792                    request: tools::Time::now(),
793                };
794            }
795            RunningState::ShallStop { .. } | RunningState::Stopped => {
796                info!(self, "No ongoing process to stop.",);
797            }
798        }
799    }
800
801    #[allow(unused)]
802    pub(crate) async fn shall_stop_ongoing(&self) -> bool {
803        match &*self.running_state.read().await {
804            RunningState::Running { .. } => false,
805            RunningState::ShallStop { .. } | RunningState::Stopped => true,
806        }
807    }
808
809    /*******************************************************************************
810     * UI chat/message related API
811     ******************************************************************************/
812
813    /// Returns information about the context as key-value pairs.
814    pub async fn get_info(&self) -> Result<BTreeMap<&'static str, String>> {
815        let l = EnteredLoginParam::load(self).await?;
816        let l2 = ConfiguredLoginParam::load(self)
817            .await?
818            .map_or_else(|| "Not configured".to_string(), |param| param.to_string());
819        let secondary_addrs = self.get_secondary_self_addrs().await?.join(", ");
820        let chats = get_chat_cnt(self).await?;
821        let unblocked_msgs = message::get_unblocked_msg_cnt(self).await;
822        let request_msgs = message::get_request_msg_cnt(self).await;
823        let contacts = Contact::get_real_cnt(self).await?;
824        let is_configured = self.get_config_int(Config::Configured).await?;
825        let proxy_enabled = self.get_config_int(Config::ProxyEnabled).await?;
826        let dbversion = self
827            .sql
828            .get_raw_config_int("dbversion")
829            .await?
830            .unwrap_or_default();
831        let journal_mode = self
832            .sql
833            .query_get_value("PRAGMA journal_mode;", ())
834            .await?
835            .unwrap_or_else(|| "unknown".to_string());
836        let mdns_enabled = self.get_config_int(Config::MdnsEnabled).await?;
837        let bcc_self = self.get_config_int(Config::BccSelf).await?;
838        let sync_msgs = self.get_config_int(Config::SyncMsgs).await?;
839        let disable_idle = self.get_config_bool(Config::DisableIdle).await?;
840
841        let prv_key_cnt = self.sql.count("SELECT COUNT(*) FROM keypairs;", ()).await?;
842
843        let pub_key_cnt = self
844            .sql
845            .count("SELECT COUNT(*) FROM public_keys;", ())
846            .await?;
847        let fingerprint_str = match self_fingerprint(self).await {
848            Ok(fp) => fp.to_string(),
849            Err(err) => format!("<key failure: {err}>"),
850        };
851
852        let sentbox_watch = self.get_config_int(Config::SentboxWatch).await?;
853        let mvbox_move = self.get_config_int(Config::MvboxMove).await?;
854        let only_fetch_mvbox = self.get_config_int(Config::OnlyFetchMvbox).await?;
855        let folders_configured = self
856            .sql
857            .get_raw_config_int(constants::DC_FOLDERS_CONFIGURED_KEY)
858            .await?
859            .unwrap_or_default();
860
861        let configured_inbox_folder = self
862            .get_config(Config::ConfiguredInboxFolder)
863            .await?
864            .unwrap_or_else(|| "<unset>".to_string());
865        let configured_sentbox_folder = self
866            .get_config(Config::ConfiguredSentboxFolder)
867            .await?
868            .unwrap_or_else(|| "<unset>".to_string());
869        let configured_mvbox_folder = self
870            .get_config(Config::ConfiguredMvboxFolder)
871            .await?
872            .unwrap_or_else(|| "<unset>".to_string());
873        let configured_trash_folder = self
874            .get_config(Config::ConfiguredTrashFolder)
875            .await?
876            .unwrap_or_else(|| "<unset>".to_string());
877
878        let mut res = get_info();
879
880        // insert values
881        res.insert("bot", self.get_config_int(Config::Bot).await?.to_string());
882        res.insert("number_of_chats", chats.to_string());
883        res.insert("number_of_chat_messages", unblocked_msgs.to_string());
884        res.insert("messages_in_contact_requests", request_msgs.to_string());
885        res.insert("number_of_contacts", contacts.to_string());
886        res.insert("database_dir", self.get_dbfile().display().to_string());
887        res.insert("database_version", dbversion.to_string());
888        res.insert(
889            "database_encrypted",
890            self.sql
891                .is_encrypted()
892                .await
893                .map_or_else(|| "closed".to_string(), |b| b.to_string()),
894        );
895        res.insert("journal_mode", journal_mode);
896        res.insert("blobdir", self.get_blobdir().display().to_string());
897        res.insert(
898            "selfavatar",
899            self.get_config(Config::Selfavatar)
900                .await?
901                .unwrap_or_else(|| "<unset>".to_string()),
902        );
903        res.insert("is_configured", is_configured.to_string());
904        res.insert("proxy_enabled", proxy_enabled.to_string());
905        res.insert("entered_account_settings", l.to_string());
906        res.insert("used_account_settings", l2);
907
908        if let Some(server_id) = &*self.server_id.read().await {
909            res.insert("imap_server_id", format!("{server_id:?}"));
910        }
911
912        res.insert("is_chatmail", self.is_chatmail().await?.to_string());
913        res.insert(
914            "fix_is_chatmail",
915            self.get_config_bool(Config::FixIsChatmail)
916                .await?
917                .to_string(),
918        );
919        res.insert(
920            "is_muted",
921            self.get_config_bool(Config::IsMuted).await?.to_string(),
922        );
923        res.insert(
924            "private_tag",
925            self.get_config(Config::PrivateTag)
926                .await?
927                .unwrap_or_else(|| "<unset>".to_string()),
928        );
929
930        if let Some(metadata) = &*self.metadata.read().await {
931            if let Some(comment) = &metadata.comment {
932                res.insert("imap_server_comment", format!("{comment:?}"));
933            }
934
935            if let Some(admin) = &metadata.admin {
936                res.insert("imap_server_admin", format!("{admin:?}"));
937            }
938        }
939
940        res.insert("secondary_addrs", secondary_addrs);
941        res.insert(
942            "fetched_existing_msgs",
943            self.get_config_bool(Config::FetchedExistingMsgs)
944                .await?
945                .to_string(),
946        );
947        res.insert(
948            "show_emails",
949            self.get_config_int(Config::ShowEmails).await?.to_string(),
950        );
951        res.insert(
952            "download_limit",
953            self.get_config_int(Config::DownloadLimit)
954                .await?
955                .to_string(),
956        );
957        res.insert("sentbox_watch", sentbox_watch.to_string());
958        res.insert("mvbox_move", mvbox_move.to_string());
959        res.insert("only_fetch_mvbox", only_fetch_mvbox.to_string());
960        res.insert(
961            constants::DC_FOLDERS_CONFIGURED_KEY,
962            folders_configured.to_string(),
963        );
964        res.insert("configured_inbox_folder", configured_inbox_folder);
965        res.insert("configured_sentbox_folder", configured_sentbox_folder);
966        res.insert("configured_mvbox_folder", configured_mvbox_folder);
967        res.insert("configured_trash_folder", configured_trash_folder);
968        res.insert("mdns_enabled", mdns_enabled.to_string());
969        res.insert("bcc_self", bcc_self.to_string());
970        res.insert("sync_msgs", sync_msgs.to_string());
971        res.insert("disable_idle", disable_idle.to_string());
972        res.insert("private_key_count", prv_key_cnt.to_string());
973        res.insert("public_key_count", pub_key_cnt.to_string());
974        res.insert("fingerprint", fingerprint_str);
975        res.insert(
976            "media_quality",
977            self.get_config_int(Config::MediaQuality).await?.to_string(),
978        );
979        res.insert(
980            "delete_device_after",
981            self.get_config_int(Config::DeleteDeviceAfter)
982                .await?
983                .to_string(),
984        );
985        res.insert(
986            "delete_server_after",
987            self.get_config_int(Config::DeleteServerAfter)
988                .await?
989                .to_string(),
990        );
991        res.insert(
992            "delete_to_trash",
993            self.get_config(Config::DeleteToTrash)
994                .await?
995                .unwrap_or_else(|| "<unset>".to_string()),
996        );
997        res.insert(
998            "last_housekeeping",
999            self.get_config_int(Config::LastHousekeeping)
1000                .await?
1001                .to_string(),
1002        );
1003        res.insert(
1004            "last_cant_decrypt_outgoing_msgs",
1005            self.get_config_int(Config::LastCantDecryptOutgoingMsgs)
1006                .await?
1007                .to_string(),
1008        );
1009        res.insert(
1010            "scan_all_folders_debounce_secs",
1011            self.get_config_int(Config::ScanAllFoldersDebounceSecs)
1012                .await?
1013                .to_string(),
1014        );
1015        res.insert(
1016            "quota_exceeding",
1017            self.get_config_int(Config::QuotaExceeding)
1018                .await?
1019                .to_string(),
1020        );
1021        res.insert(
1022            "authserv_id_candidates",
1023            self.get_config(Config::AuthservIdCandidates)
1024                .await?
1025                .unwrap_or_default(),
1026        );
1027        res.insert(
1028            "sign_unencrypted",
1029            self.get_config_int(Config::SignUnencrypted)
1030                .await?
1031                .to_string(),
1032        );
1033        res.insert(
1034            "protect_autocrypt",
1035            self.get_config_int(Config::ProtectAutocrypt)
1036                .await?
1037                .to_string(),
1038        );
1039        res.insert(
1040            "debug_logging",
1041            self.get_config_int(Config::DebugLogging).await?.to_string(),
1042        );
1043        res.insert(
1044            "last_msg_id",
1045            self.get_config_int(Config::LastMsgId).await?.to_string(),
1046        );
1047        res.insert(
1048            "gossip_period",
1049            self.get_config_int(Config::GossipPeriod).await?.to_string(),
1050        );
1051        res.insert(
1052            "webxdc_realtime_enabled",
1053            self.get_config_bool(Config::WebxdcRealtimeEnabled)
1054                .await?
1055                .to_string(),
1056        );
1057        res.insert(
1058            "donation_request_next_check",
1059            self.get_config_i64(Config::DonationRequestNextCheck)
1060                .await?
1061                .to_string(),
1062        );
1063        res.insert(
1064            "first_key_contacts_msg_id",
1065            self.sql
1066                .get_raw_config("first_key_contacts_msg_id")
1067                .await?
1068                .unwrap_or_default(),
1069        );
1070        res.insert(
1071            "fail_on_receiving_full_msg",
1072            self.sql
1073                .get_raw_config("fail_on_receiving_full_msg")
1074                .await?
1075                .unwrap_or_default(),
1076        );
1077
1078        let elapsed = time_elapsed(&self.creation_time);
1079        res.insert("uptime", duration_to_str(elapsed));
1080
1081        Ok(res)
1082    }
1083
1084    async fn get_self_report(&self) -> Result<String> {
1085        #[derive(Default)]
1086        struct ChatNumbers {
1087            protected: u32,
1088            opportunistic_dc: u32,
1089            opportunistic_mua: u32,
1090            unencrypted_dc: u32,
1091            unencrypted_mua: u32,
1092        }
1093
1094        let mut res = String::new();
1095        res += &format!("core_version {}\n", get_version_str());
1096
1097        let num_msgs: u32 = self
1098            .sql
1099            .query_get_value(
1100                "SELECT COUNT(*) FROM msgs WHERE hidden=0 AND chat_id!=?",
1101                (DC_CHAT_ID_TRASH,),
1102            )
1103            .await?
1104            .unwrap_or_default();
1105        res += &format!("num_msgs {num_msgs}\n");
1106
1107        let num_chats: u32 = self
1108            .sql
1109            .query_get_value("SELECT COUNT(*) FROM chats WHERE id>9 AND blocked!=1", ())
1110            .await?
1111            .unwrap_or_default();
1112        res += &format!("num_chats {num_chats}\n");
1113
1114        let db_size = tokio::fs::metadata(&self.sql.dbfile).await?.len();
1115        res += &format!("db_size_bytes {db_size}\n");
1116
1117        let secret_key = &load_self_secret_key(self).await?.primary_key;
1118        let key_created = secret_key.public_key().created_at().timestamp();
1119        res += &format!("key_created {key_created}\n");
1120
1121        // how many of the chats active in the last months are:
1122        // - protected
1123        // - opportunistic-encrypted and the contact uses Delta Chat
1124        // - opportunistic-encrypted and the contact uses a classical MUA
1125        // - unencrypted and the contact uses Delta Chat
1126        // - unencrypted and the contact uses a classical MUA
1127        let three_months_ago = time().saturating_sub(3600 * 24 * 30 * 3);
1128        let chats = self
1129            .sql
1130            .query_map(
1131                "SELECT c.protected, m.param, m.msgrmsg
1132                    FROM chats c
1133                    JOIN msgs m
1134                        ON c.id=m.chat_id
1135                        AND m.id=(
1136                                SELECT id
1137                                FROM msgs
1138                                WHERE chat_id=c.id
1139                                AND hidden=0
1140                                AND download_state=?
1141                                AND to_id!=?
1142                                ORDER BY timestamp DESC, id DESC LIMIT 1)
1143                    WHERE c.id>9
1144                    AND (c.blocked=0 OR c.blocked=2)
1145                    AND IFNULL(m.timestamp,c.created_timestamp) > ?
1146                    GROUP BY c.id",
1147                (DownloadState::Done, ContactId::INFO, three_months_ago),
1148                |row| {
1149                    let protected: ProtectionStatus = row.get(0)?;
1150                    let message_param: Params =
1151                        row.get::<_, String>(1)?.parse().unwrap_or_default();
1152                    let is_dc_message: bool = row.get(2)?;
1153                    Ok((protected, message_param, is_dc_message))
1154                },
1155                |rows| {
1156                    let mut chats = ChatNumbers::default();
1157                    for row in rows {
1158                        let (protected, message_param, is_dc_message) = row?;
1159                        let encrypted = message_param
1160                            .get_bool(Param::GuaranteeE2ee)
1161                            .unwrap_or(false);
1162
1163                        if protected == ProtectionStatus::Protected {
1164                            chats.protected += 1;
1165                        } else if encrypted {
1166                            if is_dc_message {
1167                                chats.opportunistic_dc += 1;
1168                            } else {
1169                                chats.opportunistic_mua += 1;
1170                            }
1171                        } else if is_dc_message {
1172                            chats.unencrypted_dc += 1;
1173                        } else {
1174                            chats.unencrypted_mua += 1;
1175                        }
1176                    }
1177                    Ok(chats)
1178                },
1179            )
1180            .await?;
1181        res += &format!("chats_protected {}\n", chats.protected);
1182        res += &format!("chats_opportunistic_dc {}\n", chats.opportunistic_dc);
1183        res += &format!("chats_opportunistic_mua {}\n", chats.opportunistic_mua);
1184        res += &format!("chats_unencrypted_dc {}\n", chats.unencrypted_dc);
1185        res += &format!("chats_unencrypted_mua {}\n", chats.unencrypted_mua);
1186
1187        let self_reporting_id = match self.get_config(Config::SelfReportingId).await? {
1188            Some(id) => id,
1189            None => {
1190                let id = create_id();
1191                self.set_config(Config::SelfReportingId, Some(&id)).await?;
1192                id
1193            }
1194        };
1195        res += &format!("self_reporting_id {self_reporting_id}");
1196
1197        Ok(res)
1198    }
1199
1200    /// Drafts a message with statistics about the usage of Delta Chat.
1201    /// The user can inspect the message if they want, and then hit "Send".
1202    ///
1203    /// On the other end, a bot will receive the message and make it available
1204    /// to Delta Chat's developers.
1205    pub async fn draft_self_report(&self) -> Result<ChatId> {
1206        const SELF_REPORTING_BOT_VCARD: &str = include_str!("../assets/self-reporting-bot.vcf");
1207        let contact_id: ContactId = *import_vcard(self, SELF_REPORTING_BOT_VCARD)
1208            .await?
1209            .first()
1210            .context("Self reporting bot vCard does not contain a contact")?;
1211        mark_contact_id_as_verified(self, contact_id, Some(ContactId::SELF)).await?;
1212
1213        let chat_id = ChatId::create_for_contact(self, contact_id).await?;
1214        chat_id
1215            .set_protection(self, ProtectionStatus::Protected, time(), Some(contact_id))
1216            .await?;
1217
1218        let mut msg = Message::new_text(self.get_self_report().await?);
1219
1220        chat_id.set_draft(self, Some(&mut msg)).await?;
1221
1222        Ok(chat_id)
1223    }
1224
1225    /// Get a list of fresh, unmuted messages in unblocked chats.
1226    ///
1227    /// The list starts with the most recent message
1228    /// and is typically used to show notifications.
1229    /// Moreover, the number of returned messages
1230    /// can be used for a badge counter on the app icon.
1231    pub async fn get_fresh_msgs(&self) -> Result<Vec<MsgId>> {
1232        let list = self
1233            .sql
1234            .query_map(
1235                concat!(
1236                    "SELECT m.id",
1237                    " FROM msgs m",
1238                    " LEFT JOIN contacts ct",
1239                    "        ON m.from_id=ct.id",
1240                    " LEFT JOIN chats c",
1241                    "        ON m.chat_id=c.id",
1242                    " WHERE m.state=?",
1243                    "   AND m.hidden=0",
1244                    "   AND m.chat_id>9",
1245                    "   AND ct.blocked=0",
1246                    "   AND c.blocked=0",
1247                    "   AND NOT(c.muted_until=-1 OR c.muted_until>?)",
1248                    " ORDER BY m.timestamp DESC,m.id DESC;"
1249                ),
1250                (MessageState::InFresh, time()),
1251                |row| row.get::<_, MsgId>(0),
1252                |rows| {
1253                    let mut list = Vec::new();
1254                    for row in rows {
1255                        list.push(row?);
1256                    }
1257                    Ok(list)
1258                },
1259            )
1260            .await?;
1261        Ok(list)
1262    }
1263
1264    /// Returns a list of messages with database ID higher than requested.
1265    ///
1266    /// Blocked contacts and chats are excluded,
1267    /// but self-sent messages and contact requests are included in the results.
1268    pub async fn get_next_msgs(&self) -> Result<Vec<MsgId>> {
1269        let last_msg_id = match self.get_config(Config::LastMsgId).await? {
1270            Some(s) => MsgId::new(s.parse()?),
1271            None => {
1272                // If `last_msg_id` is not set yet,
1273                // subtract 1 from the last id,
1274                // so a single message is returned and can
1275                // be marked as seen.
1276                self.sql
1277                    .query_row(
1278                        "SELECT IFNULL((SELECT MAX(id) - 1 FROM msgs), 0)",
1279                        (),
1280                        |row| {
1281                            let msg_id: MsgId = row.get(0)?;
1282                            Ok(msg_id)
1283                        },
1284                    )
1285                    .await?
1286            }
1287        };
1288
1289        let list = self
1290            .sql
1291            .query_map(
1292                "SELECT m.id
1293                     FROM msgs m
1294                     LEFT JOIN contacts ct
1295                            ON m.from_id=ct.id
1296                     LEFT JOIN chats c
1297                            ON m.chat_id=c.id
1298                     WHERE m.id>?
1299                       AND m.hidden=0
1300                       AND m.chat_id>9
1301                       AND ct.blocked=0
1302                       AND c.blocked!=1
1303                     ORDER BY m.id ASC",
1304                (
1305                    last_msg_id.to_u32(), // Explicitly convert to u32 because 0 is allowed.
1306                ),
1307                |row| {
1308                    let msg_id: MsgId = row.get(0)?;
1309                    Ok(msg_id)
1310                },
1311                |rows| {
1312                    let mut list = Vec::new();
1313                    for row in rows {
1314                        list.push(row?);
1315                    }
1316                    Ok(list)
1317                },
1318            )
1319            .await?;
1320        Ok(list)
1321    }
1322
1323    /// Returns a list of messages with database ID higher than last marked as seen.
1324    ///
1325    /// This function is supposed to be used by bot to request messages
1326    /// that are not processed yet.
1327    ///
1328    /// Waits for notification and returns a result.
1329    /// Note that the result may be empty if the message is deleted
1330    /// shortly after notification or notification is manually triggered
1331    /// to interrupt waiting.
1332    /// Notification may be manually triggered by calling [`Self::stop_io`].
1333    pub async fn wait_next_msgs(&self) -> Result<Vec<MsgId>> {
1334        self.new_msgs_notify.notified().await;
1335        let list = self.get_next_msgs().await?;
1336        Ok(list)
1337    }
1338
1339    /// Searches for messages containing the query string case-insensitively.
1340    ///
1341    /// If `chat_id` is provided this searches only for messages in this chat, if `chat_id`
1342    /// is `None` this searches messages from all chats.
1343    ///
1344    /// NB: Wrt the search in long messages which are shown truncated with the "Show Full Message…"
1345    /// button, we only look at the first several kilobytes. Let's not fix this -- one can send a
1346    /// dictionary in the message that matches any reasonable search request, but the user won't see
1347    /// the match because they should tap on "Show Full Message…" for that. Probably such messages
1348    /// would only clutter search results.
1349    pub async fn search_msgs(&self, chat_id: Option<ChatId>, query: &str) -> Result<Vec<MsgId>> {
1350        let real_query = query.trim().to_lowercase();
1351        if real_query.is_empty() {
1352            return Ok(Vec::new());
1353        }
1354        let str_like_in_text = format!("%{real_query}%");
1355
1356        let list = if let Some(chat_id) = chat_id {
1357            self.sql
1358                .query_map(
1359                    "SELECT m.id AS id
1360                 FROM msgs m
1361                 LEFT JOIN contacts ct
1362                        ON m.from_id=ct.id
1363                 WHERE m.chat_id=?
1364                   AND m.hidden=0
1365                   AND ct.blocked=0
1366                   AND IFNULL(txt_normalized, txt) LIKE ?
1367                 ORDER BY m.timestamp,m.id;",
1368                    (chat_id, str_like_in_text),
1369                    |row| row.get::<_, MsgId>("id"),
1370                    |rows| {
1371                        let mut ret = Vec::new();
1372                        for id in rows {
1373                            ret.push(id?);
1374                        }
1375                        Ok(ret)
1376                    },
1377                )
1378                .await?
1379        } else {
1380            // For performance reasons results are sorted only by `id`, that is in the order of
1381            // message reception.
1382            //
1383            // Unlike chat view, sorting by `timestamp` is not necessary but slows down the query by
1384            // ~25% according to benchmarks.
1385            //
1386            // To speed up incremental search, where queries for few characters usually return lots
1387            // of unwanted results that are discarded moments later, we added `LIMIT 1000`.
1388            // According to some tests, this limit speeds up eg. 2 character searches by factor 10.
1389            // The limit is documented and UI may add a hint when getting 1000 results.
1390            self.sql
1391                .query_map(
1392                    "SELECT m.id AS id
1393                 FROM msgs m
1394                 LEFT JOIN contacts ct
1395                        ON m.from_id=ct.id
1396                 LEFT JOIN chats c
1397                        ON m.chat_id=c.id
1398                 WHERE m.chat_id>9
1399                   AND m.hidden=0
1400                   AND c.blocked!=1
1401                   AND ct.blocked=0
1402                   AND IFNULL(txt_normalized, txt) LIKE ?
1403                 ORDER BY m.id DESC LIMIT 1000",
1404                    (str_like_in_text,),
1405                    |row| row.get::<_, MsgId>("id"),
1406                    |rows| {
1407                        let mut ret = Vec::new();
1408                        for id in rows {
1409                            ret.push(id?);
1410                        }
1411                        Ok(ret)
1412                    },
1413                )
1414                .await?
1415        };
1416
1417        Ok(list)
1418    }
1419
1420    /// Returns true if given folder name is the name of the inbox.
1421    pub async fn is_inbox(&self, folder_name: &str) -> Result<bool> {
1422        let inbox = self.get_config(Config::ConfiguredInboxFolder).await?;
1423        Ok(inbox.as_deref() == Some(folder_name))
1424    }
1425
1426    /// Returns true if given folder name is the name of the "sent" folder.
1427    pub async fn is_sentbox(&self, folder_name: &str) -> Result<bool> {
1428        let sentbox = self.get_config(Config::ConfiguredSentboxFolder).await?;
1429        Ok(sentbox.as_deref() == Some(folder_name))
1430    }
1431
1432    /// Returns true if given folder name is the name of the "DeltaChat" folder.
1433    pub async fn is_mvbox(&self, folder_name: &str) -> Result<bool> {
1434        let mvbox = self.get_config(Config::ConfiguredMvboxFolder).await?;
1435        Ok(mvbox.as_deref() == Some(folder_name))
1436    }
1437
1438    /// Returns true if given folder name is the name of the trash folder.
1439    pub async fn is_trash(&self, folder_name: &str) -> Result<bool> {
1440        let trash = self.get_config(Config::ConfiguredTrashFolder).await?;
1441        Ok(trash.as_deref() == Some(folder_name))
1442    }
1443
1444    pub(crate) async fn should_delete_to_trash(&self) -> Result<bool> {
1445        if let Some(v) = self.get_config_bool_opt(Config::DeleteToTrash).await? {
1446            return Ok(v);
1447        }
1448        if let Some(provider) = self.get_configured_provider().await? {
1449            return Ok(provider.opt.delete_to_trash);
1450        }
1451        Ok(false)
1452    }
1453
1454    /// Returns `target` for deleted messages as per `imap` table. Empty string means "delete w/o
1455    /// moving to trash".
1456    pub(crate) async fn get_delete_msgs_target(&self) -> Result<String> {
1457        if !self.should_delete_to_trash().await? {
1458            return Ok("".into());
1459        }
1460        self.get_config(Config::ConfiguredTrashFolder)
1461            .await?
1462            .context("No configured trash folder")
1463    }
1464
1465    pub(crate) fn derive_blobdir(dbfile: &Path) -> PathBuf {
1466        let mut blob_fname = OsString::new();
1467        blob_fname.push(dbfile.file_name().unwrap_or_default());
1468        blob_fname.push("-blobs");
1469        dbfile.with_file_name(blob_fname)
1470    }
1471
1472    pub(crate) fn derive_walfile(dbfile: &Path) -> PathBuf {
1473        let mut wal_fname = OsString::new();
1474        wal_fname.push(dbfile.file_name().unwrap_or_default());
1475        wal_fname.push("-wal");
1476        dbfile.with_file_name(wal_fname)
1477    }
1478}
1479
1480/// Returns core version as a string.
1481pub fn get_version_str() -> &'static str {
1482    &DC_VERSION_STR
1483}
1484
1485#[cfg(test)]
1486mod context_tests;
deltachat/context.rs

deltachat/
context.rs
