chatmail-core/src/context.rs

use std::collections::HashMap;
use std::ffi::OsString;
use std::path::{Path, PathBuf};
use std::sync::{Arc, Condvar, Mutex, RwLock};

use libc::uintptr_t;

use crate::chat::*;
use crate::constants::*;
use crate::contact::*;
use crate::error::*;
use crate::events::Event;
use crate::imap::*;
use crate::job::*;
use crate::job_thread::JobThread;
use crate::key::*;
use crate::login_param::LoginParam;
use crate::lot::Lot;
use crate::message::*;
use crate::param::Params;
use crate::smtp::*;
use crate::sql::Sql;

/// Callback function type for [Context]
///
/// # Parameters
///
/// * `context` - The context object as returned by [Context::new].
/// * `event` - One of the [Event] items.
/// * `data1` - Depends on the event parameter, see [Event].
/// * `data2` - Depends on the event parameter, see [Event].
///
/// # Returns
///
/// This callback must return 0 unless stated otherwise in the event
/// description at [Event].
pub type ContextCallback = dyn Fn(&Context, Event) -> uintptr_t + Send + Sync;

#[derive(DebugStub)]
pub struct Context {
    dbfile: PathBuf,
    blobdir: PathBuf,
    pub sql: Sql,
    pub inbox: Arc<RwLock<Imap>>,
    pub perform_inbox_jobs_needed: Arc<RwLock<bool>>,
    pub probe_imap_network: Arc<RwLock<bool>>,
    pub sentbox_thread: Arc<RwLock<JobThread>>,
    pub mvbox_thread: Arc<RwLock<JobThread>>,
    pub smtp: Arc<Mutex<Smtp>>,
    pub smtp_state: Arc<(Mutex<SmtpState>, Condvar)>,
    pub oauth2_critical: Arc<Mutex<()>>,
    #[debug_stub = "Callback"]
    cb: Box<ContextCallback>,
    pub os_name: Option<String>,
    pub cmdline_sel_chat_id: Arc<RwLock<u32>>,
    pub bob: Arc<RwLock<BobStatus>>,
    pub last_smeared_timestamp: Arc<RwLock<i64>>,
    pub running_state: Arc<RwLock<RunningState>>,
    /// Mutex to avoid generating the key for the user more than once.
    pub generating_key_mutex: Mutex<()>,
}

#[derive(Debug, PartialEq, Eq)]
pub struct RunningState {
    pub ongoing_running: bool,
    pub shall_stop_ongoing: bool,
}

impl Context {
    pub fn new(cb: Box<ContextCallback>, os_name: String, dbfile: PathBuf) -> Result<Context> {
        let mut blob_fname = OsString::new();
        blob_fname.push(dbfile.file_name().unwrap_or_default());
        blob_fname.push("-blobs");
        let blobdir = dbfile.with_file_name(blob_fname);
        if !blobdir.exists() {
            std::fs::create_dir_all(&blobdir)?;
        }
        Context::with_blobdir(cb, os_name, dbfile, blobdir)
    }

    pub fn with_blobdir(
        cb: Box<ContextCallback>,
        os_name: String,
        dbfile: PathBuf,
        blobdir: PathBuf,
    ) -> Result<Context> {
        ensure!(
            blobdir.is_dir(),
            "Blobdir does not exist: {}",
            blobdir.display()
        );
        let ctx = Context {
            blobdir,
            dbfile,
            inbox: Arc::new(RwLock::new(Imap::new())),
            cb,
            os_name: Some(os_name),
            running_state: Arc::new(RwLock::new(Default::default())),
            sql: Sql::new(),
            smtp: Arc::new(Mutex::new(Smtp::new())),
            smtp_state: Arc::new((Mutex::new(Default::default()), Condvar::new())),
            oauth2_critical: Arc::new(Mutex::new(())),
            bob: Arc::new(RwLock::new(Default::default())),
            last_smeared_timestamp: Arc::new(RwLock::new(0)),
            cmdline_sel_chat_id: Arc::new(RwLock::new(0)),
            sentbox_thread: Arc::new(RwLock::new(JobThread::new(
                "SENTBOX",
                "configured_sentbox_folder",
                Imap::new(),
            ))),
            mvbox_thread: Arc::new(RwLock::new(JobThread::new(
                "MVBOX",
                "configured_mvbox_folder",
                Imap::new(),
            ))),
            probe_imap_network: Arc::new(RwLock::new(false)),
            perform_inbox_jobs_needed: Arc::new(RwLock::new(false)),
            generating_key_mutex: Mutex::new(()),
        };

        ensure!(
            ctx.sql.open(&ctx, &ctx.dbfile, 0),
            "Failed opening sqlite database"
        );

        Ok(ctx)
    }

    pub fn get_dbfile(&self) -> &Path {
        self.dbfile.as_path()
    }

    pub fn get_blobdir(&self) -> &Path {
        self.blobdir.as_path()
    }

    pub fn call_cb(&self, event: Event) -> uintptr_t {
        (*self.cb)(self, event)
    }

    pub fn get_info(&self) -> HashMap<&'static str, String> {
        let unset = "0";
        let l = LoginParam::from_database(self, "");
        let l2 = LoginParam::from_database(self, "configured_");
        let displayname = self.sql.get_config(self, "displayname");
        let chats = get_chat_cnt(self) as usize;
        let real_msgs = dc_get_real_msg_cnt(self) as usize;
        let deaddrop_msgs = dc_get_deaddrop_msg_cnt(self) as usize;
        let contacts = Contact::get_real_cnt(self) as usize;
        let is_configured = self
            .sql
            .get_config_int(self, "configured")
            .unwrap_or_default();
        let dbversion = self
            .sql
            .get_config_int(self, "dbversion")
            .unwrap_or_default();
        let e2ee_enabled = self
            .sql
            .get_config_int(self, "e2ee_enabled")
            .unwrap_or_else(|| 1);
        let mdns_enabled = self
            .sql
            .get_config_int(self, "mdns_enabled")
            .unwrap_or_else(|| 1);

        let prv_key_cnt: Option<isize> =
            self.sql
                .query_get_value(self, "SELECT COUNT(*) FROM keypairs;", rusqlite::NO_PARAMS);

        let pub_key_cnt: Option<isize> = self.sql.query_get_value(
            self,
            "SELECT COUNT(*) FROM acpeerstates;",
            rusqlite::NO_PARAMS,
        );

        let fingerprint_str = if let Some(key) = Key::from_self_public(self, &l2.addr, &self.sql) {
            key.fingerprint()
        } else {
            "<Not yet calculated>".into()
        };

        let inbox_watch = self
            .sql
            .get_config_int(self, "inbox_watch")
            .unwrap_or_else(|| 1);
        let sentbox_watch = self
            .sql
            .get_config_int(self, "sentbox_watch")
            .unwrap_or_else(|| 1);
        let mvbox_watch = self
            .sql
            .get_config_int(self, "mvbox_watch")
            .unwrap_or_else(|| 1);
        let mvbox_move = self
            .sql
            .get_config_int(self, "mvbox_move")
            .unwrap_or_else(|| 1);
        let folders_configured = self
            .sql
            .get_config_int(self, "folders_configured")
            .unwrap_or_default();
        let configured_sentbox_folder = self
            .sql
            .get_config(self, "configured_sentbox_folder")
            .unwrap_or_else(|| "<unset>".to_string());
        let configured_mvbox_folder = self
            .sql
            .get_config(self, "configured_mvbox_folder")
            .unwrap_or_else(|| "<unset>".to_string());

        let mut res = HashMap::new();
        res.insert("deltachat_core_version", format!("v{}", &*DC_VERSION_STR));
        res.insert("sqlite_version", rusqlite::version().to_string());
        res.insert(
            "sqlite_thread_safe",
            unsafe { rusqlite::ffi::sqlite3_threadsafe() }.to_string(),
        );
        res.insert(
            "arch",
            (::std::mem::size_of::<*mut libc::c_void>())
                .wrapping_mul(8)
                .to_string(),
        );
        res.insert("number_of_chats", chats.to_string());
        res.insert("number_of_chat_messages", real_msgs.to_string());
        res.insert("messages_in_contact_requests", deaddrop_msgs.to_string());
        res.insert("number_of_contacts", contacts.to_string());
        res.insert("database_dir", self.get_dbfile().display().to_string());
        res.insert("database_version", dbversion.to_string());
        res.insert("blobdir", self.get_blobdir().display().to_string());
        res.insert("display_name", displayname.unwrap_or_else(|| unset.into()));
        res.insert("is_configured", is_configured.to_string());
        res.insert("entered_account_settings", l.to_string());
        res.insert("used_account_settings", l2.to_string());
        res.insert("inbox_watch", inbox_watch.to_string());
        res.insert("sentbox_watch", sentbox_watch.to_string());
        res.insert("mvbox_watch", mvbox_watch.to_string());
        res.insert("mvbox_move", mvbox_move.to_string());
        res.insert("folders_configured", folders_configured.to_string());
        res.insert("configured_sentbox_folder", configured_sentbox_folder);
        res.insert("configured_mvbox_folder", configured_mvbox_folder);
        res.insert("mdns_enabled", mdns_enabled.to_string());
        res.insert("e2ee_enabled", e2ee_enabled.to_string());
        res.insert(
            "private_key_count",
            prv_key_cnt.unwrap_or_default().to_string(),
        );
        res.insert(
            "public_key_count",
            pub_key_cnt.unwrap_or_default().to_string(),
        );
        res.insert("fingerprint", fingerprint_str);
        res.insert("level", "awesome".into());

        res
    }

    pub fn get_fresh_msgs(&self) -> Vec<u32> {
        let show_deaddrop = 0;

        self.sql
            .query_map(
                "SELECT m.id FROM msgs m LEFT JOIN contacts ct \
                 ON m.from_id=ct.id LEFT JOIN chats c ON m.chat_id=c.id WHERE m.state=?   \
                 AND m.hidden=0   \
                 AND m.chat_id>?   \
                 AND ct.blocked=0   \
                 AND (c.blocked=0 OR c.blocked=?) ORDER BY m.timestamp DESC,m.id DESC;",
                &[10, 9, if 0 != show_deaddrop { 2 } else { 0 }],
                |row| row.get(0),
                |rows| {
                    let mut ret = Vec::new();
                    for row in rows {
                        let id: u32 = row?;
                        ret.push(id);
                    }
                    Ok(ret)
                },
            )
            .unwrap()
    }

    #[allow(non_snake_case)]
    pub fn search_msgs(&self, chat_id: u32, query: impl AsRef<str>) -> Vec<u32> {
        let real_query = query.as_ref().trim();
        if real_query.is_empty() {
            return Vec::new();
        }
        let strLikeInText = format!("%{}%", real_query);
        let strLikeBeg = format!("{}%", real_query);

        let query = if 0 != chat_id {
            "SELECT m.id, m.timestamp FROM msgs m LEFT JOIN contacts ct ON m.from_id=ct.id WHERE m.chat_id=?  \
         AND m.hidden=0  \
         AND ct.blocked=0 AND (txt LIKE ? OR ct.name LIKE ?) ORDER BY m.timestamp,m.id;"
        } else {
            "SELECT m.id, m.timestamp FROM msgs m LEFT JOIN contacts ct ON m.from_id=ct.id \
         LEFT JOIN chats c ON m.chat_id=c.id WHERE m.chat_id>9 AND m.hidden=0  \
         AND (c.blocked=0 OR c.blocked=?) \
         AND ct.blocked=0 AND (m.txt LIKE ? OR ct.name LIKE ?) ORDER BY m.timestamp DESC,m.id DESC;"
        };

        self.sql
            .query_map(
                query,
                params![chat_id as i32, &strLikeInText, &strLikeBeg],
                |row| row.get::<_, i32>(0),
                |rows| {
                    let mut ret = Vec::new();
                    for id in rows {
                        ret.push(id? as u32);
                    }
                    Ok(ret)
                },
            )
            .unwrap_or_default()
    }

    pub fn is_inbox(&self, folder_name: impl AsRef<str>) -> bool {
        folder_name.as_ref() == "INBOX"
    }

    pub fn is_sentbox(&self, folder_name: impl AsRef<str>) -> bool {
        let sentbox_name = self.sql.get_config(self, "configured_sentbox_folder");
        if let Some(name) = sentbox_name {
            name == folder_name.as_ref()
        } else {
            false
        }
    }

    pub fn is_mvbox(&self, folder_name: impl AsRef<str>) -> bool {
        let mvbox_name = self.sql.get_config(self, "configured_mvbox_folder");

        if let Some(name) = mvbox_name {
            name == folder_name.as_ref()
        } else {
            false
        }
    }

    pub fn do_heuristics_moves(&self, folder: &str, msg_id: u32) {
        if self
            .sql
            .get_config_int(self, "mvbox_move")
            .unwrap_or_else(|| 1)
            == 0
        {
            return;
        }

        if !self.is_inbox(folder) && !self.is_sentbox(folder) {
            return;
        }

        if let Ok(msg) = dc_msg_new_load(self, msg_id) {
            if dc_msg_is_setupmessage(&msg) {
                // do not move setup messages;
                // there may be a non-delta device that wants to handle it
                return;
            }

            if self.is_mvbox(folder) {
                dc_update_msg_move_state(self, msg.rfc724_mid, MoveState::Stay);
            }

            // 1 = dc message, 2 = reply to dc message
            if 0 != msg.is_dc_message {
                job_add(
                    self,
                    Action::MoveMsg,
                    msg.id as libc::c_int,
                    Params::new(),
                    0,
                );
                dc_update_msg_move_state(self, msg.rfc724_mid, MoveState::Moving);
            }
        }
    }
}

impl Drop for Context {
    fn drop(&mut self) {
        info!(self, "disconnecting INBOX-watch",);
        self.inbox.read().unwrap().disconnect(self);
        info!(self, "disconnecting sentbox-thread",);
        self.sentbox_thread.read().unwrap().imap.disconnect(self);
        info!(self, "disconnecting mvbox-thread",);
        self.mvbox_thread.read().unwrap().imap.disconnect(self);
        info!(self, "disconnecting SMTP");
        self.smtp.clone().lock().unwrap().disconnect();
        self.sql.close(self);
    }
}

impl Default for RunningState {
    fn default() -> Self {
        RunningState {
            ongoing_running: false,
            shall_stop_ongoing: true,
        }
    }
}

#[derive(Debug, Default)]
pub struct BobStatus {
    pub expects: i32,
    pub status: i32,
    pub qr_scan: Option<Lot>,
}

#[derive(Default, Debug)]
pub struct SmtpState {
    pub idle: bool,
    pub suspended: bool,
    pub doing_jobs: bool,
    pub perform_jobs_needed: i32,
    pub probe_network: bool,
}

pub fn get_version_str() -> &'static str {
    &DC_VERSION_STR
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::test_utils::*;

    #[test]
    fn test_wrong_db() {
        let tmp = tempfile::tempdir().unwrap();
        let dbfile = tmp.path().join("db.sqlite");
        std::fs::write(&dbfile, b"123").unwrap();
        let res = Context::new(Box::new(|_, _| 0), "FakeOs".into(), dbfile);
        assert!(res.is_err());
    }

    #[test]
    fn test_get_fresh_msgs() {
        let t = dummy_context();
        let fresh = t.ctx.get_fresh_msgs();
        assert!(fresh.is_empty())
    }

    #[test]
    fn test_blobdir_exists() {
        let tmp = tempfile::tempdir().unwrap();
        let dbfile = tmp.path().join("db.sqlite");
        Context::new(Box::new(|_, _| 0), "FakeOS".into(), dbfile).unwrap();
        let blobdir = tmp.path().join("db.sqlite-blobs");
        assert!(blobdir.is_dir());
    }

    #[test]
    fn test_wrong_blogdir() {
        let tmp = tempfile::tempdir().unwrap();
        let dbfile = tmp.path().join("db.sqlite");
        let blobdir = tmp.path().join("db.sqlite-blobs");
        std::fs::write(&blobdir, b"123").unwrap();
        let res = Context::new(Box::new(|_, _| 0), "FakeOS".into(), dbfile);
        assert!(res.is_err());
    }

    #[test]
    fn test_sqlite_parent_not_exists() {
        let tmp = tempfile::tempdir().unwrap();
        let subdir = tmp.path().join("subdir");
        let dbfile = subdir.join("db.sqlite");
        let dbfile2 = dbfile.clone();
        Context::new(Box::new(|_, _| 0), "FakeOS".into(), dbfile).unwrap();
        assert!(subdir.is_dir());
        assert!(dbfile2.is_file());
    }

    #[test]
    fn test_with_empty_blobdir() {
        let tmp = tempfile::tempdir().unwrap();
        let dbfile = tmp.path().join("db.sqlite");
        let blobdir = PathBuf::new();
        let res = Context::with_blobdir(Box::new(|_, _| 0), "FakeOS".into(), dbfile, blobdir);
        assert!(res.is_err());
    }

    #[test]
    fn test_with_blobdir_not_exists() {
        let tmp = tempfile::tempdir().unwrap();
        let dbfile = tmp.path().join("db.sqlite");
        let blobdir = tmp.path().join("blobs");
        let res = Context::with_blobdir(Box::new(|_, _| 0), "FakeOS".into(), dbfile, blobdir);
        assert!(res.is_err());
    }

    #[test]
    fn no_crashes_on_context_deref() {
        let t = dummy_context();
        std::mem::drop(t.ctx);
    }

    #[test]
    fn test_get_info() {
        let t = dummy_context();

        let info = t.ctx.get_info();
        assert_eq!(info.get("level").unwrap(), "awesome");
    }
}