deltachat/scheduler/
connectivity.rs

1use core::fmt;
2use std::cmp::min;
3use std::{iter::once, ops::Deref, sync::Arc};
4
5use anyhow::Result;
6use humansize::{format_size, BINARY};
7use tokio::sync::Mutex;
8
9use crate::events::EventType;
10use crate::imap::{scan_folders::get_watched_folder_configs, FolderMeaning};
11use crate::log::info;
12use crate::quota::{QUOTA_ERROR_THRESHOLD_PERCENTAGE, QUOTA_WARN_THRESHOLD_PERCENTAGE};
13use crate::stock_str;
14use crate::{context::Context, log::LogExt};
15
16use super::InnerSchedulerState;
17
18/// Rough connectivity status for display in the status bar in the UI.
19#[derive(Debug, Clone, Copy, PartialEq, Eq, EnumProperty, PartialOrd, Ord)]
20pub enum Connectivity {
21    /// Not connected.
22    ///
23    /// This may be because we just started,
24    /// because we lost connection and
25    /// were not able to connect and log in yet
26    /// or because I/O is not started.
27    NotConnected = 1000,
28
29    /// Attempting to connect and log in.
30    Connecting = 2000,
31
32    /// Fetching or sending messages.
33    Working = 3000,
34
35    /// We are connected but not doing anything.
36    ///
37    /// This is the most common state,
38    /// so mobile UIs display the profile name
39    /// instead of connectivity status in this state.
40    /// Desktop UI displays "Connected" in the tooltip,
41    /// which signals that no more messages
42    /// are coming in.
43    Connected = 4000,
44}
45
46// The order of the connectivities is important: worse connectivities (i.e. those at
47// the top) take priority. This means that e.g. if any folder has an error - usually
48// because there is no internet connection - the connectivity for the whole
49// account will be `Notconnected`.
50#[derive(Debug, Default, Clone, PartialEq, Eq, EnumProperty, PartialOrd)]
51enum DetailedConnectivity {
52    Error(String),
53    #[default]
54    Uninitialized,
55
56    /// Attempting to connect,
57    /// until we successfully log in.
58    Connecting,
59
60    /// Connection is just established,
61    /// there may be work to do.
62    Preparing,
63
64    /// There is actual work to do, e.g. there are messages in SMTP queue
65    /// or we detected a message on IMAP server that should be downloaded.
66    Working,
67
68    InterruptingIdle,
69
70    /// Connection is established and is idle.
71    Idle,
72
73    /// The folder was configured not to be watched or configured_*_folder is not set
74    NotConfigured,
75}
76
77impl DetailedConnectivity {
78    fn to_basic(&self) -> Option<Connectivity> {
79        match self {
80            DetailedConnectivity::Error(_) => Some(Connectivity::NotConnected),
81            DetailedConnectivity::Uninitialized => Some(Connectivity::NotConnected),
82            DetailedConnectivity::Connecting => Some(Connectivity::Connecting),
83            DetailedConnectivity::Working => Some(Connectivity::Working),
84            DetailedConnectivity::InterruptingIdle => Some(Connectivity::Working),
85
86            // At this point IMAP has just connected,
87            // but does not know yet if there are messages to download.
88            // We still convert this to Working state
89            // so user can see "Updating..." and not "Connected"
90            // which is reserved for idle state.
91            DetailedConnectivity::Preparing => Some(Connectivity::Working),
92
93            // Just don't return a connectivity, probably the folder is configured not to be
94            // watched or there is e.g. no "Sent" folder, so we are not interested in it
95            DetailedConnectivity::NotConfigured => None,
96
97            DetailedConnectivity::Idle => Some(Connectivity::Connected),
98        }
99    }
100
101    fn to_icon(&self) -> String {
102        match self {
103            DetailedConnectivity::Error(_)
104            | DetailedConnectivity::Uninitialized
105            | DetailedConnectivity::NotConfigured => "<span class=\"red dot\"></span>".to_string(),
106            DetailedConnectivity::Connecting => "<span class=\"yellow dot\"></span>".to_string(),
107            DetailedConnectivity::Preparing
108            | DetailedConnectivity::Working
109            | DetailedConnectivity::InterruptingIdle
110            | DetailedConnectivity::Idle => "<span class=\"green dot\"></span>".to_string(),
111        }
112    }
113
114    async fn to_string_imap(&self, context: &Context) -> String {
115        match self {
116            DetailedConnectivity::Error(e) => stock_str::error(context, e).await,
117            DetailedConnectivity::Uninitialized => "Not started".to_string(),
118            DetailedConnectivity::Connecting => stock_str::connecting(context).await,
119            DetailedConnectivity::Preparing | DetailedConnectivity::Working => {
120                stock_str::updating(context).await
121            }
122            DetailedConnectivity::InterruptingIdle | DetailedConnectivity::Idle => {
123                stock_str::connected(context).await
124            }
125            DetailedConnectivity::NotConfigured => "Not configured".to_string(),
126        }
127    }
128
129    async fn to_string_smtp(&self, context: &Context) -> String {
130        match self {
131            DetailedConnectivity::Error(e) => stock_str::error(context, e).await,
132            DetailedConnectivity::Uninitialized => {
133                "You did not try to send a message recently.".to_string()
134            }
135            DetailedConnectivity::Connecting => stock_str::connecting(context).await,
136            DetailedConnectivity::Working => stock_str::sending(context).await,
137
138            // We don't know any more than that the last message was sent successfully;
139            // since sending the last message, connectivity could have changed, which we don't notice
140            // until another message is sent
141            DetailedConnectivity::InterruptingIdle
142            | DetailedConnectivity::Preparing
143            | DetailedConnectivity::Idle => stock_str::last_msg_sent_successfully(context).await,
144            DetailedConnectivity::NotConfigured => "Not configured".to_string(),
145        }
146    }
147
148    fn all_work_done(&self) -> bool {
149        match self {
150            DetailedConnectivity::Error(_) => true,
151            DetailedConnectivity::Uninitialized => false,
152            DetailedConnectivity::Connecting => false,
153            DetailedConnectivity::Working => false,
154            DetailedConnectivity::InterruptingIdle => false,
155            DetailedConnectivity::Preparing => false, // Just connected, there may still be work to do.
156            DetailedConnectivity::NotConfigured => true,
157            DetailedConnectivity::Idle => true,
158        }
159    }
160}
161
162#[derive(Clone, Default)]
163pub(crate) struct ConnectivityStore(Arc<Mutex<DetailedConnectivity>>);
164
165impl ConnectivityStore {
166    async fn set(&self, context: &Context, v: DetailedConnectivity) {
167        {
168            *self.0.lock().await = v;
169        }
170        context.emit_event(EventType::ConnectivityChanged);
171    }
172
173    pub(crate) async fn set_err(&self, context: &Context, e: impl ToString) {
174        self.set(context, DetailedConnectivity::Error(e.to_string()))
175            .await;
176    }
177    pub(crate) async fn set_connecting(&self, context: &Context) {
178        self.set(context, DetailedConnectivity::Connecting).await;
179    }
180    pub(crate) async fn set_working(&self, context: &Context) {
181        self.set(context, DetailedConnectivity::Working).await;
182    }
183    pub(crate) async fn set_preparing(&self, context: &Context) {
184        self.set(context, DetailedConnectivity::Preparing).await;
185    }
186    pub(crate) async fn set_not_configured(&self, context: &Context) {
187        self.set(context, DetailedConnectivity::NotConfigured).await;
188    }
189    pub(crate) async fn set_idle(&self, context: &Context) {
190        self.set(context, DetailedConnectivity::Idle).await;
191    }
192
193    async fn get_detailed(&self) -> DetailedConnectivity {
194        self.0.lock().await.deref().clone()
195    }
196    async fn get_basic(&self) -> Option<Connectivity> {
197        self.0.lock().await.to_basic()
198    }
199    async fn get_all_work_done(&self) -> bool {
200        self.0.lock().await.all_work_done()
201    }
202}
203
204/// Set all folder states to InterruptingIdle in case they were `Idle` before.
205/// Called during `dc_maybe_network()` to make sure that `all_work_done()`
206/// returns false immediately after `dc_maybe_network()`.
207pub(crate) async fn idle_interrupted(inbox: ConnectivityStore, oboxes: Vec<ConnectivityStore>) {
208    let mut connectivity_lock = inbox.0.lock().await;
209    // For the inbox, we also have to set the connectivity to InterruptingIdle if it was
210    // NotConfigured before: If all folders are NotConfigured, dc_get_connectivity()
211    // returns Connected. But after dc_maybe_network(), dc_get_connectivity() must not
212    // return Connected until DC is completely done with fetching folders; this also
213    // includes scan_folders() which happens on the inbox thread.
214    if *connectivity_lock == DetailedConnectivity::Idle
215        || *connectivity_lock == DetailedConnectivity::NotConfigured
216    {
217        *connectivity_lock = DetailedConnectivity::InterruptingIdle;
218    }
219    drop(connectivity_lock);
220
221    for state in oboxes {
222        let mut connectivity_lock = state.0.lock().await;
223        if *connectivity_lock == DetailedConnectivity::Idle {
224            *connectivity_lock = DetailedConnectivity::InterruptingIdle;
225        }
226    }
227    // No need to send ConnectivityChanged, the user-facing connectivity doesn't change because
228    // of what we do here.
229}
230
231/// Set the connectivity to "Not connected" after a call to dc_maybe_network_lost().
232/// If we did not do this, the connectivity would stay "Connected" for quite a long time
233/// after `maybe_network_lost()` was called.
234pub(crate) async fn maybe_network_lost(context: &Context, stores: Vec<ConnectivityStore>) {
235    for store in &stores {
236        let mut connectivity_lock = store.0.lock().await;
237        if !matches!(
238            *connectivity_lock,
239            DetailedConnectivity::Uninitialized
240                | DetailedConnectivity::Error(_)
241                | DetailedConnectivity::NotConfigured,
242        ) {
243            *connectivity_lock = DetailedConnectivity::Error("Connection lost".to_string());
244        }
245    }
246    context.emit_event(EventType::ConnectivityChanged);
247}
248
249impl fmt::Debug for ConnectivityStore {
250    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
251        if let Ok(guard) = self.0.try_lock() {
252            write!(f, "ConnectivityStore {:?}", &*guard)
253        } else {
254            write!(f, "ConnectivityStore [LOCKED]")
255        }
256    }
257}
258
259impl Context {
260    /// Get the current connectivity, i.e. whether the device is connected to the IMAP server.
261    /// One of:
262    /// - DC_CONNECTIVITY_NOT_CONNECTED (1000-1999): Show e.g. the string "Not connected" or a red dot
263    /// - DC_CONNECTIVITY_CONNECTING (2000-2999): Show e.g. the string "Connecting…" or a yellow dot
264    /// - DC_CONNECTIVITY_WORKING (3000-3999): Show e.g. the string "Updating…" or a spinning wheel
265    /// - DC_CONNECTIVITY_CONNECTED (>=4000): Show e.g. the string "Connected" or a green dot
266    ///
267    /// We don't use exact values but ranges here so that we can split up
268    /// states into multiple states in the future.
269    ///
270    /// Meant as a rough overview that can be shown
271    /// e.g. in the title of the main screen.
272    ///
273    /// If the connectivity changes, a DC_EVENT_CONNECTIVITY_CHANGED will be emitted.
274    pub async fn get_connectivity(&self) -> Connectivity {
275        let lock = self.scheduler.inner.read().await;
276        let stores: Vec<_> = match *lock {
277            InnerSchedulerState::Started(ref sched) => sched
278                .boxes()
279                .map(|b| b.conn_state.state.connectivity.clone())
280                .collect(),
281            _ => return Connectivity::NotConnected,
282        };
283        drop(lock);
284
285        let mut connectivities = Vec::new();
286        for s in stores {
287            if let Some(connectivity) = s.get_basic().await {
288                connectivities.push(connectivity);
289            }
290        }
291        connectivities
292            .into_iter()
293            .min()
294            .unwrap_or(Connectivity::Connected)
295    }
296
297    /// Get an overview of the current connectivity, and possibly more statistics.
298    /// Meant to give the user more insight about the current status than
299    /// the basic connectivity info returned by dc_get_connectivity(); show this
300    /// e.g., if the user taps on said basic connectivity info.
301    ///
302    /// If this page changes, a DC_EVENT_CONNECTIVITY_CHANGED will be emitted.
303    ///
304    /// This comes as an HTML from the core so that we can easily improve it
305    /// and the improvement instantly reaches all UIs.
306    pub async fn get_connectivity_html(&self) -> Result<String> {
307        let mut ret = r#"<!DOCTYPE html>
308            <html>
309            <head>
310                <meta charset="UTF-8" />
311                <meta name="viewport" content="initial-scale=1.0; user-scalable=no" />
312                <style>
313                    ul {
314                        list-style-type: none;
315                        padding-left: 1em;
316                    }
317                    .dot {
318                        height: 0.9em; width: 0.9em;
319                        border: 1px solid #888;
320                        border-radius: 50%;
321                        display: inline-block;
322                        position: relative; left: -0.1em; top: 0.1em;
323                    }
324                    .bar {
325                        width: 90%;
326                        border: 1px solid #888;
327                        border-radius: .5em;
328                        margin-top: .2em;
329                        margin-bottom: 1em;
330                        position: relative; left: -0.2em;
331                    }
332                    .progress {
333                        min-width:1.8em;
334                        height: 1em;
335                        border-radius: .45em;
336                        color: white;
337                        text-align: center;
338                        padding-bottom: 2px;
339                    }
340                    .red {
341                        background-color: #f33b2d;
342                    }
343                    .green {
344                        background-color: #34c759;
345                    }
346                    .yellow {
347                        background-color: #fdc625;
348                    }
349                </style>
350            </head>
351            <body>"#
352            .to_string();
353
354        // =============================================================================================
355        //                              Get the states from the RwLock
356        // =============================================================================================
357
358        let lock = self.scheduler.inner.read().await;
359        let (folders_states, smtp) = match *lock {
360            InnerSchedulerState::Started(ref sched) => (
361                sched
362                    .boxes()
363                    .map(|b| (b.meaning, b.conn_state.state.connectivity.clone()))
364                    .collect::<Vec<_>>(),
365                sched.smtp.state.connectivity.clone(),
366            ),
367            _ => {
368                ret += &format!(
369                    "<h3>{}</h3>\n</body></html>\n",
370                    stock_str::not_connected(self).await
371                );
372                return Ok(ret);
373            }
374        };
375        drop(lock);
376
377        // =============================================================================================
378        // Add e.g.
379        //                              Incoming messages
380        //                               - "Inbox": Connected
381        //                               - "Sent": Connected
382        // =============================================================================================
383
384        let watched_folders = get_watched_folder_configs(self).await?;
385        let incoming_messages = stock_str::incoming_messages(self).await;
386        ret += &format!("<h3>{incoming_messages}</h3><ul>");
387        for (folder, state) in &folders_states {
388            let mut folder_added = false;
389
390            if let Some(config) = folder.to_config().filter(|c| watched_folders.contains(c)) {
391                let f = self.get_config(config).await.log_err(self).ok().flatten();
392
393                if let Some(foldername) = f {
394                    let detailed = &state.get_detailed().await;
395                    ret += "<li>";
396                    ret += &*detailed.to_icon();
397                    ret += " <b>";
398                    ret += &*escaper::encode_minimal(&foldername);
399                    ret += ":</b> ";
400                    ret += &*escaper::encode_minimal(&detailed.to_string_imap(self).await);
401                    ret += "</li>";
402
403                    folder_added = true;
404                }
405            }
406
407            if !folder_added && folder == &FolderMeaning::Inbox {
408                let detailed = &state.get_detailed().await;
409                if let DetailedConnectivity::Error(_) = detailed {
410                    // On the inbox thread, we also do some other things like scan_folders and run jobs
411                    // so, maybe, the inbox is not watched, but something else went wrong
412                    ret += "<li>";
413                    ret += &*detailed.to_icon();
414                    ret += " ";
415                    ret += &*escaper::encode_minimal(&detailed.to_string_imap(self).await);
416                    ret += "</li>";
417                }
418            }
419        }
420        ret += "</ul>";
421
422        // =============================================================================================
423        // Add e.g.
424        //                              Outgoing messages
425        //                                Your last message was sent successfully
426        // =============================================================================================
427
428        let outgoing_messages = stock_str::outgoing_messages(self).await;
429        ret += &format!("<h3>{outgoing_messages}</h3><ul><li>");
430        let detailed = smtp.get_detailed().await;
431        ret += &*detailed.to_icon();
432        ret += " ";
433        ret += &*escaper::encode_minimal(&detailed.to_string_smtp(self).await);
434        ret += "</li></ul>";
435
436        // =============================================================================================
437        // Add e.g.
438        //                              Storage on testrun.org
439        //                                1.34 GiB of 2 GiB used
440        //                                [======67%=====       ]
441        // =============================================================================================
442
443        let domain =
444            &deltachat_contact_tools::EmailAddress::new(&self.get_primary_self_addr().await?)?
445                .domain;
446        let storage_on_domain = stock_str::storage_on_domain(self, domain).await;
447        ret += &format!("<h3>{storage_on_domain}</h3><ul>");
448        let quota = self.quota.read().await;
449        if let Some(quota) = &*quota {
450            match &quota.recent {
451                Ok(quota) => {
452                    if !quota.is_empty() {
453                        for (root_name, resources) in quota {
454                            use async_imap::types::QuotaResourceName::*;
455                            for resource in resources {
456                                ret += "<li>";
457
458                                // root name is empty eg. for gmail and redundant eg. for riseup.
459                                // therefore, use it only if there are really several roots.
460                                if quota.len() > 1 && !root_name.is_empty() {
461                                    ret += &format!(
462                                        "<b>{}:</b> ",
463                                        &*escaper::encode_minimal(root_name)
464                                    );
465                                } else {
466                                    info!(
467                                        self,
468                                        "connectivity: root name hidden: \"{}\"", root_name
469                                    );
470                                }
471
472                                let messages = stock_str::messages(self).await;
473                                let part_of_total_used = stock_str::part_of_total_used(
474                                    self,
475                                    &resource.usage.to_string(),
476                                    &resource.limit.to_string(),
477                                )
478                                .await;
479                                ret += &match &resource.name {
480                                    Atom(resource_name) => {
481                                        format!(
482                                            "<b>{}:</b> {}",
483                                            &*escaper::encode_minimal(resource_name),
484                                            part_of_total_used
485                                        )
486                                    }
487                                    Message => {
488                                        format!("<b>{part_of_total_used}:</b> {messages}")
489                                    }
490                                    Storage => {
491                                        // do not use a special title needed for "Storage":
492                                        // - it is usually shown directly under the "Storage" headline
493                                        // - by the units "1 MB of 10 MB used" there is some difference to eg. "Messages: 1 of 10 used"
494                                        // - the string is not longer than the other strings that way (minus title, plus units) -
495                                        //   additional linebreaks on small displays are unlikely therefore
496                                        // - most times, this is the only item anyway
497                                        let usage = &format_size(resource.usage * 1024, BINARY);
498                                        let limit = &format_size(resource.limit * 1024, BINARY);
499                                        stock_str::part_of_total_used(self, usage, limit).await
500                                    }
501                                };
502
503                                let percent = resource.get_usage_percentage();
504                                let color = if percent >= QUOTA_ERROR_THRESHOLD_PERCENTAGE {
505                                    "red"
506                                } else if percent >= QUOTA_WARN_THRESHOLD_PERCENTAGE {
507                                    "yellow"
508                                } else {
509                                    "green"
510                                };
511                                let div_width_percent = min(100, percent);
512                                ret += &format!("<div class=\"bar\"><div class=\"progress {color}\" style=\"width: {div_width_percent}%\">{percent}%</div></div>");
513
514                                ret += "</li>";
515                            }
516                        }
517                    } else {
518                        ret += format!("<li>Warning: {domain} claims to support quota but gives no information</li>").as_str();
519                    }
520                }
521                Err(e) => {
522                    ret += format!("<li>{e}</li>").as_str();
523                }
524            }
525        } else {
526            let not_connected = stock_str::not_connected(self).await;
527            ret += &format!("<li>{not_connected}</li>");
528        }
529        ret += "</ul>";
530
531        // =============================================================================================
532
533        ret += "</body></html>\n";
534        Ok(ret)
535    }
536
537    /// Returns true if all background work is done.
538    async fn all_work_done(&self) -> bool {
539        let lock = self.scheduler.inner.read().await;
540        let stores: Vec<_> = match *lock {
541            InnerSchedulerState::Started(ref sched) => sched
542                .boxes()
543                .map(|b| &b.conn_state.state)
544                .chain(once(&sched.smtp.state))
545                .map(|state| state.connectivity.clone())
546                .collect(),
547            _ => return false,
548        };
549        drop(lock);
550
551        for s in &stores {
552            if !s.get_all_work_done().await {
553                return false;
554            }
555        }
556        true
557    }
558
559    /// Waits until background work is finished.
560    pub async fn wait_for_all_work_done(&self) {
561        // Ideally we could wait for connectivity change events,
562        // but sleep loop is good enough.
563
564        // First 100 ms sleep in chunks of 10 ms.
565        for _ in 0..10 {
566            if self.all_work_done().await {
567                break;
568            }
569            tokio::time::sleep(std::time::Duration::from_millis(10)).await;
570        }
571
572        // If we are not finished in 100 ms, keep waking up every 100 ms.
573        while !self.all_work_done().await {
574            tokio::time::sleep(std::time::Duration::from_millis(100)).await;
575        }
576    }
577}
deltachat/scheduler/connectivity.rs

deltachat/scheduler/
connectivity.rs
