/* * meli - accounts module. * * Copyright 2017 Manos Pitsidianakis * * This file is part of meli. * * meli is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * meli is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with meli. If not, see . */ /*! * Account management from user configuration. */ use super::{AccountConf, FolderConf}; use fnv::FnvHashMap; use melib::async_workers::{Async, AsyncBuilder, AsyncStatus}; use melib::backends::{ BackendOp, Backends, Folder, FolderHash, FolderOperation, MailBackend, NotifyFn, ReadOnlyOp, RefreshEvent, RefreshEventConsumer, RefreshEventKind, SpecialUseMailbox, }; use melib::error::{MeliError, Result}; use melib::mailbox::*; use melib::thread::{ThreadHash, ThreadNode, Threads}; use melib::AddressBook; use melib::StackVec; use crate::types::UIEvent::{self, EnvelopeRemove, EnvelopeRename, EnvelopeUpdate, Notification}; use crate::{workers::WorkController, StatusEvent, ThreadEvent}; use crossbeam::Sender; use std::collections::VecDeque; use std::fs; use std::io; use std::ops::{Index, IndexMut}; use std::result; use std::sync::Arc; pub type Worker = Option>>>; macro_rules! mailbox { ($idx:expr, $folders:expr) => { $folders.get_mut(&$idx).unwrap().unwrap_mut() }; } #[derive(Serialize, Debug)] pub enum MailboxEntry { Available(Mailbox), Failed(MeliError), /// first argument is done work, and second is total work Parsing(Mailbox, usize, usize), } impl Default for MailboxEntry { fn default() -> Self { MailboxEntry::Parsing(Mailbox::default(), 0, 0) } } impl std::fmt::Display for MailboxEntry { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { write!( f, "{}", match self { MailboxEntry::Available(ref m) => m.name().to_string(), MailboxEntry::Failed(ref e) => e.to_string(), MailboxEntry::Parsing(_, done, total) => { format!("Parsing messages. [{}/{}]", done, total) } } ) } } impl MailboxEntry { pub fn is_available(&self) -> bool { if let MailboxEntry::Available(_) = self { true } else { false } } pub fn is_parsing(&self) -> bool { if let MailboxEntry::Parsing(_, _, _) = self { true } else { false } } pub fn unwrap_mut(&mut self) -> &mut Mailbox { match self { MailboxEntry::Available(ref mut m) => m, MailboxEntry::Parsing(ref mut m, _, _) => m, e => panic!(format!("mailbox is not available! {:#}", e)), } } pub fn unwrap(&self) -> &Mailbox { match self { MailboxEntry::Available(ref m) => m, MailboxEntry::Parsing(ref m, _, _) => m, e => panic!(format!("mailbox is not available! {:#}", e)), } } } #[derive(Debug)] pub struct Account { pub index: usize, name: String, pub(crate) folders: FnvHashMap, pub(crate) folder_confs: FnvHashMap, pub(crate) folders_order: Vec, pub(crate) folder_names: FnvHashMap, tree: Vec, sent_folder: Option, pub(crate) collection: Collection, pub(crate) address_book: AddressBook, pub(crate) workers: FnvHashMap, pub(crate) settings: AccountConf, pub(crate) runtime_settings: AccountConf, pub(crate) backend: Box, event_queue: VecDeque<(FolderHash, RefreshEvent)>, notify_fn: Arc, } impl Drop for Account { fn drop(&mut self) { //TODO: Avoid panics let data_dir = xdg::BaseDirectories::with_profile("meli", &self.name).unwrap(); if let Ok(data) = data_dir.place_data_file("addressbook") { /* place result in cache directory */ let f = match fs::File::create(data) { Ok(f) => f, Err(e) => { panic!("{}", e); } }; let writer = io::BufWriter::new(f); serde_json::to_writer(writer, &self.address_book).unwrap(); }; if let Ok(data) = data_dir.place_data_file("mailbox") { /* place result in cache directory */ let f = match fs::File::create(data) { Ok(f) => f, Err(e) => { panic!("{}", e); } }; let writer = io::BufWriter::new(f); bincode::serialize_into(writer, &self.folders).unwrap(); }; } } pub struct MailboxIterator<'a> { folders_order: &'a [FolderHash], folders: &'a FnvHashMap, pos: usize, } impl<'a> Iterator for MailboxIterator<'a> { type Item = &'a MailboxEntry; fn next(&mut self) -> Option<&'a MailboxEntry> { if self.pos == self.folders.len() { return None; } let fh = &self.folders_order[self.pos]; self.pos += 1; Some(&self.folders[&fh]) } } #[derive(Serialize, Debug, Default)] struct FolderNode { hash: FolderHash, kids: Vec, } impl Account { pub fn new( index: usize, name: String, settings: AccountConf, map: &Backends, notify_fn: NotifyFn, ) -> Self { let s = settings.clone(); let mut backend = map.get(settings.account().format())( settings.account(), Box::new(move |path: &str| { s.folder_confs.contains_key(path) && s.folder_confs[path].subscribe.is_true() }), ); let mut ref_folders: FnvHashMap = backend.folders(); let mut folders: FnvHashMap = FnvHashMap::with_capacity_and_hasher(ref_folders.len(), Default::default()); let mut folders_order: Vec = Vec::with_capacity(ref_folders.len()); let mut workers: FnvHashMap = FnvHashMap::default(); let notify_fn = Arc::new(notify_fn); let mut folder_names = FnvHashMap::default(); let mut folder_confs = FnvHashMap::default(); let mut sent_folder = None; for f in ref_folders.values_mut() { if !settings.folder_confs.contains_key(f.path()) || settings.folder_confs[f.path()].subscribe.is_false() { /* Skip unsubscribed folder */ continue; } match settings.folder_confs[f.path()].usage { Some(SpecialUseMailbox::Sent) => { sent_folder = Some(f.hash()); } _ => {} } folder_confs.insert(f.hash(), settings.folder_confs[f.path()].clone()); folder_names.insert(f.hash(), f.path().to_string()); } let mut stack: StackVec = StackVec::new(); let mut tree: Vec = Vec::new(); let mut collection: Collection = Collection::new(Default::default()); for (h, f) in ref_folders.iter() { if !settings.folder_confs.contains_key(f.path()) || settings.folder_confs[f.path()].subscribe.is_false() { /* Skip unsubscribed folder */ continue; } if f.parent().is_none() { fn rec(h: FolderHash, ref_folders: &FnvHashMap) -> FolderNode { let mut node = FolderNode { hash: h, kids: Vec::new(), }; for &c in ref_folders[&h].children() { node.kids.push(rec(c, ref_folders)); } node }; tree.push(rec(*h, &ref_folders)); for &c in f.children() { stack.push(c); } while let Some(next) = stack.pop() { for c in ref_folders[&next].children() { stack.push(*c); } } } folders.insert( *h, MailboxEntry::Parsing(Mailbox::new(f.clone(), &FnvHashMap::default()), 0, 0), ); workers.insert( *h, Account::new_worker(&settings, f.clone(), &mut backend, notify_fn.clone()), ); collection.threads.insert(*h, Threads::default()); } tree.sort_unstable_by_key(|f| ref_folders[&f.hash].path()); let mut stack: StackVec> = StackVec::new(); for n in tree.iter_mut() { folders_order.push(n.hash); n.kids.sort_unstable_by_key(|f| ref_folders[&f.hash].path()); stack.extend(n.kids.iter().rev().map(Some)); while let Some(Some(next)) = stack.pop() { folders_order.push(next.hash); stack.extend(next.kids.iter().rev().map(Some)); } } let data_dir = xdg::BaseDirectories::with_profile("meli", &name).unwrap(); let address_book = if let Ok(data) = data_dir.place_data_file("addressbook") { if data.exists() { let reader = io::BufReader::new(fs::File::open(data).unwrap()); let result: result::Result = serde_json::from_reader(reader); if let Ok(data_t) = result { data_t } else { AddressBook::new(name.clone()) } } else { AddressBook::new(name.clone()) } } else { AddressBook::new(name.clone()) }; Account { index, name, folders, folder_confs, folders_order, folder_names, tree, address_book, sent_folder, collection, workers, settings: settings.clone(), runtime_settings: settings, backend, notify_fn, event_queue: VecDeque::with_capacity(8), } } fn new_worker( settings: &AccountConf, folder: Folder, backend: &mut Box, notify_fn: Arc, ) -> Worker { let mailbox_handle = backend.get(&folder); let mut builder = AsyncBuilder::new(); let our_tx = builder.tx(); let folder_hash = folder.hash(); let priority = match settings.folder_confs[folder.path()].usage { Some(SpecialUseMailbox::Inbox) => 0, Some(SpecialUseMailbox::Sent) => 1, Some(SpecialUseMailbox::Drafts) | Some(SpecialUseMailbox::Trash) => 2, Some(_) | None => { 3 * folder .path() .split(if folder.path().contains('/') { '/' } else { '.' }) .count() as u64 } }; /* This polling closure needs to be 'static', that is to spawn its own thread instead of * being assigned to a worker thread. Otherwise the polling closures could fill up the * workers causing no actual parsing to be done. If we could yield from within the worker * threads' closures this could be avoided, but it requires green threads. */ builder.set_priority(priority).set_is_static(true); let w = builder.build(Box::new(move |work_context| { let name = format!("Parsing {}", folder.path()); let mut mailbox_handle = mailbox_handle.clone(); let work = mailbox_handle.work().unwrap(); work_context.new_work.send(work).unwrap(); let thread_id = std::thread::current().id(); work_context.set_name.send((thread_id, name)).unwrap(); work_context .set_status .send((thread_id, "Waiting for subworkers..".to_string())) .unwrap(); loop { match debug!(mailbox_handle.poll_block()) { Ok(s @ AsyncStatus::Payload(_)) => { our_tx.send(s).unwrap(); debug!("notifying for {}", folder_hash); notify_fn.notify(folder_hash); } Ok(s @ AsyncStatus::Finished) => { our_tx.send(s).unwrap(); notify_fn.notify(folder_hash); debug!("exiting"); work_context.finished.send(thread_id).unwrap(); return; } Ok(s) => { our_tx.send(s).unwrap(); } Err(_) => { debug!("poll error"); return; } } } })); Some(w) } pub fn reload( &mut self, event: RefreshEvent, folder_hash: FolderHash, context: ( &mut WorkController, &Sender, &mut VecDeque, ), ) -> Option { if !self.folders[&folder_hash].is_available() { self.event_queue.push_back((folder_hash, event)); return None; } let kind = event.kind(); { //let mailbox: &mut Mailbox = self.folders[idx].as_mut().unwrap().as_mut().unwrap(); match kind { RefreshEventKind::Update(old_hash, envelope) => { mailbox!(&folder_hash, self.folders).rename(old_hash, envelope.hash()); self.collection.update(old_hash, *envelope, folder_hash); return Some(EnvelopeUpdate(old_hash)); } RefreshEventKind::Rename(old_hash, new_hash) => { debug!("rename {} to {}", old_hash, new_hash); mailbox!(&folder_hash, self.folders).rename(old_hash, new_hash); self.collection.rename(old_hash, new_hash, folder_hash); return Some(EnvelopeRename(old_hash, new_hash)); } RefreshEventKind::Create(envelope) => { let env_hash = envelope.hash(); if self.collection.envelopes.contains_key(&env_hash) && mailbox!(&folder_hash, self.folders) .envelopes .contains(&env_hash) { return None; } mailbox!(&folder_hash, self.folders).insert(env_hash); self.collection.insert(*envelope, folder_hash); if self .sent_folder .as_ref() .map(|h| *h == folder_hash) .unwrap_or(false) { self.collection.insert_reply(env_hash); } let ref_folders: FnvHashMap = self.backend.folders(); let folder_conf = &self.settings.folder_confs[&self.folder_names[&folder_hash]]; if folder_conf.ignore.is_true() { return Some(UIEvent::MailboxUpdate((self.index, folder_hash))); } let (_, thread_node) = self.mail_and_thread(env_hash, folder_hash); if thread_node.snoozed() { return Some(UIEvent::MailboxUpdate((self.index, folder_hash))); } let env = self.get_env(&env_hash); return Some(Notification( Some("new e-mail".into()), format!( "{} {:.15}:\n\nFrom: {:.15}\nSubject: {:.15}", self.name, ref_folders[&folder_hash].name(), env.subject(), env.field_from_to_string(), ), Some(crate::types::NotificationType::NewMail), )); } RefreshEventKind::Remove(envelope_hash) => { mailbox!(&folder_hash, self.folders).remove(envelope_hash); self.collection.remove(envelope_hash, folder_hash); return Some(EnvelopeRemove(envelope_hash)); } RefreshEventKind::Rescan => { let ref_folders: FnvHashMap = self.backend.folders(); let handle = Account::new_worker( &self.settings, ref_folders[&folder_hash].clone(), &mut self.backend, self.notify_fn.clone(), ); self.workers.insert(folder_hash, handle); } RefreshEventKind::Failure(e) => { debug!("RefreshEvent Failure: {}", e.to_string()); self.watch(context); } } } None } pub fn watch( &self, context: ( &mut WorkController, &Sender, &mut VecDeque, ), ) { let (work_controller, sender, replies) = context; let sender = sender.clone(); let r = RefreshEventConsumer::new(Box::new(move |r| { sender.send(ThreadEvent::from(r)).unwrap(); })); match self.backend.watch(r, work_controller.get_context()) { Ok(id) => { work_controller .static_threads .lock() .unwrap() .insert(id, format!("watching {}", self.name()).into()); } Err(e) => { replies.push_back(UIEvent::StatusEvent(StatusEvent::DisplayMessage( e.to_string(), ))); } } } pub fn len(&self) -> usize { self.folders.len() } pub fn is_empty(&self) -> bool { self.folders.is_empty() } pub fn list_folders(&self) -> Vec { let mut folders = self.backend.folders(); if let Some(folder_confs) = self.settings.conf().folders() { //debug!("folder renames: {:?}", folder_renames); for f in folders.values_mut() { if let Some(r) = folder_confs.get(f.path()) { if let Some(rename) = r.rename() { f.change_name(rename); } } } } /* if let Some(pos) = folders .iter() .position(|f| f.name().eq_ignore_ascii_case("INBOX")) { folders.swap(pos, 0); } */ let order: FnvHashMap = self .folders_order .iter() .enumerate() .map(|(i, &fh)| (fh, i)) .collect(); let mut folders: Vec = folders .drain() .map(|(_, f)| f) .filter(|f| self.folders.contains_key(&f.hash())) .collect(); folders.sort_unstable_by(|a, b| order[&a.hash()].partial_cmp(&order[&b.hash()]).unwrap()); folders } pub fn folders_order(&self) -> &Vec { &self.folders_order } pub fn name(&self) -> &str { &self.name } pub fn workers(&mut self) -> &mut FnvHashMap { &mut self.workers } fn load_mailbox(&mut self, folder_hash: FolderHash, payload: Result>) { if payload.is_err() { self.folders .insert(folder_hash, MailboxEntry::Failed(payload.unwrap_err())); return; } let envelopes = payload .unwrap() .into_iter() .map(|e| (e.hash(), e)) .collect::>(); match self.folders.entry(folder_hash).or_default() { MailboxEntry::Failed(_) => {} MailboxEntry::Parsing(ref mut m, _, _) | MailboxEntry::Available(ref mut m) => { m.merge(&envelopes); if let Some(updated_folders) = self.collection .merge(envelopes, folder_hash, m, self.sent_folder) { for f in updated_folders { self.notify_fn.notify(f); } } } } self.notify_fn.notify(folder_hash); } pub fn status(&mut self, folder_hash: FolderHash) -> result::Result<(), usize> { match self.workers.get_mut(&folder_hash).unwrap() { None => { return Ok(()); } Some(ref mut w) => match w.poll() { Ok(AsyncStatus::NoUpdate) => { //return Err(0); } Ok(AsyncStatus::Payload(envs)) => { debug!("got payload in status for {}", folder_hash); self.load_mailbox(folder_hash, envs); } Ok(AsyncStatus::Finished) => { debug!("got finished in status for {}", folder_hash); self.folders.entry(folder_hash).and_modify(|f| { let m = if let MailboxEntry::Parsing(m, _, _) = f { std::mem::replace(m, Mailbox::default()) } else { return; }; *f = MailboxEntry::Available(m); }); self.workers.insert(folder_hash, None); } Ok(AsyncStatus::ProgressReport(n)) => { self.folders.entry(folder_hash).and_modify(|f| { if let MailboxEntry::Parsing(_, ref mut d, _) = f { *d += n; } }); //return Err(n); } _ => { //return Err(0); } }, }; if self.folders[&folder_hash].is_available() || (self.folders[&folder_hash].is_parsing() && self.collection.threads.contains_key(&folder_hash)) { Ok(()) } else { Err(0) } } pub fn save(&self, bytes: &[u8], folder: &str, flags: Option) -> Result<()> { if self.settings.account.read_only() { return Err(MeliError::new(format!( "Account {} is read-only.", self.name.as_str() ))); } self.backend.save(bytes, folder, flags) } pub fn iter_mailboxes(&self) -> MailboxIterator { MailboxIterator { folders_order: &self.folders_order, folders: &self.folders, pos: 0, } } pub fn get_env(&self, h: &EnvelopeHash) -> &Envelope { &self.collection[h] } pub fn get_env_mut(&mut self, h: &EnvelopeHash) -> &mut Envelope { self.collection.entry(*h).or_default() } pub fn contains_key(&self, h: EnvelopeHash) -> bool { self.collection.contains_key(&h) } pub fn operation(&self, h: EnvelopeHash) -> Box { for mailbox in self.folders.values() { match mailbox { MailboxEntry::Available(ref m) | MailboxEntry::Parsing(ref m, _, _) => { if m.envelopes.contains(&h) { let operation = self.backend.operation(h, m.folder.hash()); if self.settings.account.read_only() { return ReadOnlyOp::new(operation); } else { return operation; } } } _ => {} } } debug!("didn't find {}", h); debug!(&self.folders); debug!(&self.collection.envelopes); unreachable!() } pub fn thread_to_mail_mut(&mut self, h: ThreadHash, f: FolderHash) -> &mut Envelope { self.collection .envelopes .entry(self.collection.threads[&f].thread_to_mail(h)) .or_default() } pub fn thread_to_mail(&self, h: ThreadHash, f: FolderHash) -> &Envelope { &self.collection.envelopes[&self.collection.threads[&f].thread_to_mail(h)] } pub fn threaded_mail(&self, h: ThreadHash, f: FolderHash) -> EnvelopeHash { self.collection.threads[&f].thread_to_mail(h) } pub fn mail_and_thread( &mut self, i: EnvelopeHash, f: FolderHash, ) -> (&mut Envelope, &ThreadNode) { let thread; { let x = &mut self.collection.envelopes.entry(i).or_default(); thread = &self.collection.threads[&f][&x.thread()]; } (self.collection.envelopes.entry(i).or_default(), thread) } pub fn thread(&self, h: ThreadHash, f: FolderHash) -> &ThreadNode { &self.collection.threads[&f].thread_nodes()[&h] } pub fn folder_operation(&mut self, path: &str, op: FolderOperation) -> Result<()> { self.backend.folder_operation(path, op) } pub fn folder_confs(&self, folder_hash: FolderHash) -> &FolderConf { &self.folder_confs[&folder_hash] } pub fn sent_folder(&self) -> &str { let sent_folder = self .settings .folder_confs .iter() .find(|(_, f)| f.usage == Some(SpecialUseMailbox::Sent)); if let Some(sent_folder) = sent_folder.as_ref() { sent_folder.0 } else { "" } } pub fn special_use_folder(&self, special_use: SpecialUseMailbox) -> Option<&str> { let ret = self .settings .folder_confs .iter() .find(|(_, f)| f.usage == Some(special_use)); ret.as_ref().map(|r| r.0.as_str()) } } impl Index for Account { type Output = MailboxEntry; fn index(&self, index: FolderHash) -> &MailboxEntry { &self.folders[&index] } } impl IndexMut for Account { fn index_mut(&mut self, index: FolderHash) -> &mut MailboxEntry { self.folders.get_mut(&index).unwrap() } } impl Index for Account { type Output = MailboxEntry; fn index(&self, index: usize) -> &MailboxEntry { &self.folders[&self.folders_order[index]] } } /// Will panic if mailbox hasn't loaded, ask `status()` first. impl IndexMut for Account { fn index_mut(&mut self, index: usize) -> &mut MailboxEntry { self.folders.get_mut(&self.folders_order[index]).unwrap() } }