aerogramme/src/imap/command/authenticated.rs

320 lines
11 KiB
Rust
Raw Normal View History

2022-07-12 11:19:27 +00:00
use std::collections::BTreeMap;
2022-06-30 12:02:57 +00:00
use std::sync::Arc;
2022-07-12 11:19:27 +00:00
use anyhow::{anyhow, Result};
2022-07-12 13:59:13 +00:00
use boitalettres::proto::res::body::Data as Body;
2022-06-29 14:05:34 +00:00
use boitalettres::proto::{Request, Response};
use imap_codec::types::command::{CommandBody, StatusAttribute};
2022-07-12 11:19:27 +00:00
use imap_codec::types::flag::FlagNameAttribute;
2022-06-20 16:09:20 +00:00
use imap_codec::types::mailbox::{ListMailbox, Mailbox as MailboxCodec};
2022-07-12 13:59:13 +00:00
use imap_codec::types::response::{Code, Data, StatusAttributeValue};
2022-06-20 16:09:20 +00:00
use crate::imap::command::anonymous;
2022-06-22 14:52:38 +00:00
use crate::imap::flow;
use crate::imap::mailbox_view::MailboxView;
2022-06-29 10:52:58 +00:00
2022-07-12 11:19:27 +00:00
use crate::mail::user::{User, INBOX, MAILBOX_HIERARCHY_DELIMITER};
2022-06-20 16:09:20 +00:00
2022-06-29 10:50:44 +00:00
pub struct AuthenticatedContext<'a> {
pub req: &'a Request,
2022-06-30 12:02:57 +00:00
pub user: &'a Arc<User>,
2022-06-29 10:50:44 +00:00
}
2022-06-20 16:09:20 +00:00
2022-06-29 10:50:44 +00:00
pub async fn dispatch<'a>(ctx: AuthenticatedContext<'a>) -> Result<(Response, flow::Transition)> {
match &ctx.req.command.body {
CommandBody::Create { mailbox } => ctx.create(mailbox).await,
CommandBody::Delete { mailbox } => ctx.delete(mailbox).await,
2022-06-30 11:36:21 +00:00
CommandBody::Rename {
mailbox,
new_mailbox,
} => ctx.rename(mailbox, new_mailbox).await,
2022-06-22 15:26:52 +00:00
CommandBody::Lsub {
reference,
mailbox_wildcard,
2022-07-12 11:19:27 +00:00
} => ctx.list(reference, mailbox_wildcard, true).await,
2022-06-22 15:26:52 +00:00
CommandBody::List {
reference,
mailbox_wildcard,
2022-07-12 11:19:27 +00:00
} => ctx.list(reference, mailbox_wildcard, false).await,
2022-06-30 11:36:21 +00:00
CommandBody::Status {
mailbox,
attributes,
} => ctx.status(mailbox, attributes).await,
2022-07-12 11:19:27 +00:00
CommandBody::Subscribe { mailbox } => ctx.subscribe(mailbox).await,
CommandBody::Unsubscribe { mailbox } => ctx.unsubscribe(mailbox).await,
2022-06-22 15:25:04 +00:00
CommandBody::Select { mailbox } => ctx.select(mailbox).await,
CommandBody::Examine { mailbox } => ctx.examine(mailbox).await,
2022-06-29 10:50:44 +00:00
_ => {
let ctx = anonymous::AnonymousContext {
req: ctx.req,
login_provider: None,
};
anonymous::dispatch(ctx).await
}
2022-06-20 16:09:20 +00:00
}
2022-06-22 14:52:38 +00:00
}
2022-06-20 16:09:20 +00:00
// --- PRIVATE ---
2022-06-29 10:50:44 +00:00
impl<'a> AuthenticatedContext<'a> {
async fn create(self, mailbox: &MailboxCodec) -> Result<(Response, flow::Transition)> {
2022-07-12 11:19:27 +00:00
let name = String::try_from(mailbox.clone())?;
if name == INBOX {
return Ok((
Response::bad("Cannot create INBOX")?,
flow::Transition::None,
));
}
match self.user.create_mailbox(&name).await {
Ok(()) => Ok((Response::ok("CREATE complete")?, flow::Transition::None)),
Err(e) => Ok((Response::no(&e.to_string())?, flow::Transition::None)),
}
}
async fn delete(self, mailbox: &MailboxCodec) -> Result<(Response, flow::Transition)> {
2022-07-12 11:19:27 +00:00
let name = String::try_from(mailbox.clone())?;
match self.user.delete_mailbox(&name).await {
Ok(()) => Ok((Response::ok("DELETE complete")?, flow::Transition::None)),
Err(e) => Ok((Response::no(&e.to_string())?, flow::Transition::None)),
}
}
2022-06-30 11:36:21 +00:00
async fn rename(
self,
mailbox: &MailboxCodec,
new_mailbox: &MailboxCodec,
) -> Result<(Response, flow::Transition)> {
2022-07-12 11:19:27 +00:00
let name = String::try_from(mailbox.clone())?;
let new_name = String::try_from(new_mailbox.clone())?;
2022-07-12 11:19:27 +00:00
match self.user.rename_mailbox(&name, &new_name).await {
Ok(()) => Ok((Response::ok("RENAME complete")?, flow::Transition::None)),
Err(e) => Ok((Response::no(&e.to_string())?, flow::Transition::None)),
}
2022-06-17 16:39:36 +00:00
}
2022-06-20 16:09:20 +00:00
async fn list(
2022-06-29 10:50:44 +00:00
self,
2022-07-12 11:19:27 +00:00
reference: &MailboxCodec,
mailbox_wildcard: &ListMailbox,
is_lsub: bool,
2022-06-22 15:26:52 +00:00
) -> Result<(Response, flow::Transition)> {
2022-07-12 11:19:27 +00:00
let reference = String::try_from(reference.clone())?;
if !reference.is_empty() {
return Ok((
Response::bad("References not supported")?,
flow::Transition::None,
));
}
let mailboxes = self.user.list_mailboxes().await?;
let mut vmailboxes = BTreeMap::new();
for mb in mailboxes.iter() {
for (i, _) in mb.match_indices(MAILBOX_HIERARCHY_DELIMITER) {
if i > 0 {
let smb = &mb[..i];
if !vmailboxes.contains_key(&smb) {
vmailboxes.insert(smb, false);
}
}
}
vmailboxes.insert(mb, true);
}
let wildcard = String::try_from(mailbox_wildcard.clone())?;
let wildcard_pat = globset::Glob::new(&wildcard)?.compile_matcher();
let mut ret = vec![];
for (mb, is_real) in vmailboxes.iter() {
if wildcard_pat.is_match(mb) {
let mailbox = mb
.to_string()
.try_into()
.map_err(|_| anyhow!("invalid mailbox name"))?;
2022-07-12 14:02:13 +00:00
let mut items = vec![FlagNameAttribute::Extension(
"Subscribed".try_into().unwrap(),
)];
2022-07-12 11:19:27 +00:00
if !*is_real {
items.push(FlagNameAttribute::Noselect);
}
if is_lsub {
ret.push(Data::Lsub {
items,
delimiter: Some(MAILBOX_HIERARCHY_DELIMITER),
mailbox,
});
} else {
ret.push(Data::List {
items,
delimiter: Some(MAILBOX_HIERARCHY_DELIMITER),
mailbox,
});
}
}
}
Ok((
Response::ok("LIST completed")?.with_body(ret),
flow::Transition::None,
))
2022-06-17 16:39:36 +00:00
}
async fn status(
self,
mailbox: &MailboxCodec,
2022-07-12 13:59:13 +00:00
attributes: &[StatusAttribute],
) -> Result<(Response, flow::Transition)> {
2022-07-12 13:59:13 +00:00
let name = String::try_from(mailbox.clone())?;
let mb_opt = self.user.open_mailbox(&name).await?;
let mb = match mb_opt {
Some(mb) => mb,
None => {
return Ok((
Response::no("Mailbox does not exist")?,
flow::Transition::None,
))
}
};
let (view, _data) = MailboxView::new(mb).await?;
2022-07-12 11:19:27 +00:00
2022-07-12 13:59:13 +00:00
let mut ret_attrs = vec![];
for attr in attributes.iter() {
ret_attrs.push(match attr {
StatusAttribute::Messages => StatusAttributeValue::Messages(view.exists()?),
StatusAttribute::Unseen => {
StatusAttributeValue::Unseen(view.unseen().map(|x| x.get()).unwrap_or(0))
}
StatusAttribute::Recent => StatusAttributeValue::Recent(view.recent()?),
StatusAttribute::UidNext => StatusAttributeValue::UidNext(view.uidnext()),
StatusAttribute::UidValidity => {
StatusAttributeValue::UidValidity(view.uidvalidity())
}
});
}
let data = vec![Body::Data(Data::Status {
mailbox: mailbox.clone(),
attributes: ret_attrs,
})];
Ok((
Response::ok("STATUS completed")?.with_body(data),
flow::Transition::None,
))
}
2022-07-12 11:19:27 +00:00
async fn subscribe(self, mailbox: &MailboxCodec) -> Result<(Response, flow::Transition)> {
2022-07-12 13:59:13 +00:00
let name = String::try_from(mailbox.clone())?;
2022-07-12 11:19:27 +00:00
2022-07-12 13:59:13 +00:00
if self.user.has_mailbox(&name).await? {
Ok((Response::ok("SUBSCRIBE complete")?, flow::Transition::None))
} else {
Ok((
Response::bad(&format!("Mailbox {} does not exist", name))?,
flow::Transition::None,
))
}
2022-07-12 11:19:27 +00:00
}
async fn unsubscribe(self, mailbox: &MailboxCodec) -> Result<(Response, flow::Transition)> {
2022-07-12 13:59:13 +00:00
let name = String::try_from(mailbox.clone())?;
2022-07-12 11:19:27 +00:00
2022-07-12 13:59:13 +00:00
if self.user.has_mailbox(&name).await? {
Ok((
Response::bad(&format!(
"Cannot unsubscribe from mailbox {}: not supported by Aerogramme",
name
))?,
flow::Transition::None,
))
} else {
Ok((
Response::bad(&format!("Mailbox {} does not exist", name))?,
flow::Transition::None,
))
}
2022-07-12 11:19:27 +00:00
}
2022-06-17 16:39:36 +00:00
/*
2022-06-22 15:26:52 +00:00
* TRACE BEGIN ---
2022-06-20 16:09:20 +00:00
2022-06-22 15:26:52 +00:00
Example: C: A142 SELECT INBOX
S: * 172 EXISTS
S: * 1 RECENT
S: * OK [UNSEEN 12] Message 12 is first unseen
S: * OK [UIDVALIDITY 3857529045] UIDs valid
S: * OK [UIDNEXT 4392] Predicted next UID
S: * FLAGS (\Answered \Flagged \Deleted \Seen \Draft)
S: * OK [PERMANENTFLAGS (\Deleted \Seen \*)] Limited
S: A142 OK [READ-WRITE] SELECT completed
2022-06-20 16:09:20 +00:00
2022-06-23 12:41:10 +00:00
--- a mailbox with no unseen message -> no unseen entry
20 select "INBOX.achats"
* FLAGS (\Answered \Flagged \Deleted \Seen \Draft $Forwarded JUNK $label1)
* OK [PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft $Forwarded JUNK $label1 \*)] Flags permitted.
* 88 EXISTS
* 0 RECENT
* OK [UIDVALIDITY 1347986788] UIDs valid
* OK [UIDNEXT 91] Predicted next UID
* OK [HIGHESTMODSEQ 72] Highest
20 OK [READ-WRITE] Select completed (0.001 + 0.000 secs).
2022-06-22 15:26:52 +00:00
* TRACE END ---
*/
2022-06-29 10:50:44 +00:00
async fn select(self, mailbox: &MailboxCodec) -> Result<(Response, flow::Transition)> {
2022-06-22 15:25:04 +00:00
let name = String::try_from(mailbox.clone())?;
2022-06-17 16:39:36 +00:00
let mb_opt = self.user.open_mailbox(&name).await?;
let mb = match mb_opt {
Some(mb) => mb,
None => {
return Ok((
Response::no("Mailbox does not exist")?,
flow::Transition::None,
))
}
};
2022-06-29 11:16:58 +00:00
tracing::info!(username=%self.user.username, mailbox=%name, "mailbox.selected");
2022-06-17 16:39:36 +00:00
let (mb, data) = MailboxView::new(mb).await?;
2022-06-24 08:27:26 +00:00
2022-06-28 07:34:24 +00:00
Ok((
2022-06-28 13:38:06 +00:00
Response::ok("Select completed")?
.with_extra_code(Code::ReadWrite)
.with_body(data),
2022-06-28 07:34:24 +00:00
flow::Transition::Select(mb),
))
2022-06-17 16:39:36 +00:00
}
async fn examine(self, mailbox: &MailboxCodec) -> Result<(Response, flow::Transition)> {
let name = String::try_from(mailbox.clone())?;
let mb_opt = self.user.open_mailbox(&name).await?;
let mb = match mb_opt {
Some(mb) => mb,
None => {
return Ok((
Response::no("Mailbox does not exist")?,
flow::Transition::None,
))
}
};
tracing::info!(username=%self.user.username, mailbox=%name, "mailbox.examined");
let (mb, data) = MailboxView::new(mb).await?;
Ok((
Response::ok("Examine completed")?
.with_extra_code(Code::ReadOnly)
.with_body(data),
flow::Transition::Examine(mb),
))
}
2022-06-20 16:09:20 +00:00
}