/* * meli - backends 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 . */ pub mod maildir; use mailbox::email::{Envelope, Flag}; use error::{MeliError, Result}; use std::fmt; extern crate fnv; use self::fnv::FnvHashMap; use std; pub struct Backends { map: FnvHashMap Box>>, } impl Backends { pub fn new() -> Self { Backends { map: FnvHashMap::with_capacity_and_hasher(1, Default::default()) } } pub fn get(&self, key: &str) -> Result> { if !self.map.contains_key(key) { return Err(MeliError::new( format!("{} is not a valid mail backend", key), )); } Ok(self.map[key]()) } pub fn register(&mut self, key: String, backend: Box Box>) -> Result<()> { if self.map.contains_key(&key) { return Err(MeliError::new( format!("{} is an already registered backend", key), )); } self.map.insert(key, backend); Ok(()) } } pub struct RefreshEvent { pub folder: String, } /// A `RefreshEventConsumer` is a boxed closure that must be used to consume a `RefreshEvent` and /// send it to a UI provided channel. We need this level of abstraction to provide an interface for /// all users of mailbox refresh events. pub struct RefreshEventConsumer(Box ()>); unsafe impl Send for RefreshEventConsumer {} unsafe impl Sync for RefreshEventConsumer {} impl RefreshEventConsumer { pub fn new(b: Box ()>) -> Self { RefreshEventConsumer(b) } pub fn send(&self, r: RefreshEvent) -> () { self.0(r); } } pub trait MailBackend: ::std::fmt::Debug { fn get(&self, path: &str) -> Result>; fn watch(&self, sender:RefreshEventConsumer, folders: &[String]) -> (); //fn new(folders: &Vec) -> Box; //login function } /// A `BackendOp` manages common operations for the various mail backends. They only live for the /// duration of the operation. They are generated by `BackendOpGenerator` on demand. /// /// # Motivation /// /// We need a way to do various operations on individual mails regardless of what backend they come /// from (eg local or imap). /// /// # Example /// ``` /// use melib::mailbox::backends::{BackendOp, BackendOpGenerator}; /// use melib::error::Result; /// /// #[derive(Debug)] /// struct FooOp {} /// /// impl BackendOp for FooOp { /// fn description(&self) -> String { /// "Foobar".to_string() /// } /// fn as_bytes(&mut self) -> Result<&[u8]> { /// unimplemented!() /// } /// fn fetch_headers(&mut self) -> Result<&[u8]> { /// unimplemented!() /// } /// fn fetch_body(&mut self) -> Result<&[u8]> { /// unimplemented!() /// } /// fn fetch_flags((&self) -> Flag { /// unimplemented!() /// } /// } /// /// let foogen = BackendOpGenerator::new(Box::new(|| Box::new(FooOp {}))); /// let operation = foogen.generate(); /// assert_eq!("Foobar", &operation.description()); /// /// ``` pub trait BackendOp: ::std::fmt::Debug + ::std::marker::Send { fn description(&self) -> String; fn as_bytes(&mut self) -> Result<&[u8]>; //fn delete(&self) -> (); //fn copy(&self fn fetch_headers(&mut self) -> Result<&[u8]>; fn fetch_body(&mut self) -> Result<&[u8]>; fn fetch_flags(&self) -> Flag; } /// `BackendOpGenerator` is a wrapper for a closure that returns a `BackendOp` object /// See `BackendOp` for details. /* * I know this sucks, but that's the best way I found that rustc deems safe. * */ pub struct BackendOpGenerator(Box Box>); impl BackendOpGenerator { pub fn new(b: Box Box>) -> Self { BackendOpGenerator(b) } pub fn generate(&self) -> Box { self.0() } } unsafe impl Send for BackendOpGenerator {} unsafe impl Sync for BackendOpGenerator {} impl fmt::Debug for BackendOpGenerator { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let op = self.generate(); write!(f, "BackendOpGenerator: {}", op.description()) } }