1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
//! Please refer to [`imap_types::flag`].
use abnf_core::streaming::sp;
/// Re-export everything from imap-types.
pub use imap_types::flag::*;
use nom::{
branch::alt,
bytes::streaming::tag,
character::streaming::char,
combinator::{map, recognize, value},
multi::{separated_list0, separated_list1},
sequence::{delimited, preceded, tuple},
};
use crate::{codec::IMAPResult, core::atom};
/// ```abnf
/// flag = "\Answered" /
/// "\Flagged" /
/// "\Deleted" /
/// "\Seen" /
/// "\Draft" /
/// flag-keyword /
/// flag-extension
/// ```
///
/// Note: Does not include "\Recent"
pub(crate) fn flag(input: &[u8]) -> IMAPResult<&[u8], Flag> {
alt((
map(preceded(char('\\'), atom), Flag::system_or_extension),
map(atom, Flag::Keyword),
))(input)
}
// Note(duesee): This was inlined into [`flag`].
// #[inline]
// /// `flag-keyword = atom`
// pub(crate) fn flag_keyword(input: &[u8]) -> IMAPResult<&[u8], Flag> {
// map(atom, Flag::Keyword)(input)
// }
// Note: This was inlined into `mbx_list_flags`.
// /// ```abnf
// /// flag-extension = "\" atom
// /// ```
// ///
// /// Future expansion.
// ///
// /// Client implementations MUST accept flag-extension flags.
// /// Server implementations MUST NOT generate flag-extension flags
// /// except as defined by future standard or standards-track revisions of this specification.
// pub(crate) fn flag_extension(input: &[u8]) -> IMAPResult<&[u8], Atom> {
// preceded(tag(b"\\"), atom)(input)
// }
/// `flag-list = "(" [flag *(SP flag)] ")"`
pub(crate) fn flag_list(input: &[u8]) -> IMAPResult<&[u8], Vec<Flag>> {
delimited(tag(b"("), separated_list0(sp, flag), tag(b")"))(input)
}
/// `flag-fetch = flag / "\Recent"`
pub(crate) fn flag_fetch(input: &[u8]) -> IMAPResult<&[u8], FlagFetch> {
if let Ok((rem, peek)) = recognize(tuple((char('\\'), atom)))(input) {
if peek.to_ascii_lowercase() == b"\\recent" {
return Ok((rem, FlagFetch::Recent));
}
}
map(flag, FlagFetch::Flag)(input)
}
/// `flag-perm = flag / "\*"`
pub(crate) fn flag_perm(input: &[u8]) -> IMAPResult<&[u8], FlagPerm> {
alt((
value(FlagPerm::AllowNewKeywords, tag("\\*")),
map(flag, FlagPerm::Flag),
))(input)
}
/// ```abnf
/// mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag *(SP mbx-list-oflag) /
/// mbx-list-oflag *(SP mbx-list-oflag)
/// ```
///
/// TODO(#155): ABNF enforces that sflag is not used more than once.
/// We could parse any flag and check for multiple occurrences of sflag later.
pub(crate) fn mbx_list_flags(input: &[u8]) -> IMAPResult<&[u8], Vec<FlagNameAttribute>> {
let (remaining, flags) =
separated_list1(sp, map(preceded(char('\\'), atom), FlagNameAttribute::from))(input)?;
// TODO(#155): Do we really want to enforce this?
// let sflag_count = flags
// .iter()
// .filter(|&flag| FlagNameAttribute::is_selectability(flag))
// .count();
//
// if sflag_count > 1 {
// return Err(nom::Err::Failure(nom::error::make_error(
// input,
// nom::error::ErrorKind::Verify,
// )));
// }
Ok((remaining, flags))
}
// Note: This was inlined into `mbx_list_flags`.
// /// ```abnf
// /// mbx-list-oflag = "\Noinferiors" / flag-extension
// /// ```
// ///
// /// Other flags; multiple possible per LIST response
// pub(crate) fn mbx_list_oflag(input: &[u8]) -> IMAPResult<&[u8], FlagNameAttribute> {
// alt((
// value(
// FlagNameAttribute::Noinferiors,
// tag_no_case(b"\\Noinferiors"),
// ),
// map(flag_extension, FlagNameAttribute::Extension),
// ))(input)
// }
// Note: This was inlined into `mbx_list_flags`.
// /// ```abnf
// /// mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
// /// ```
// ///
// /// Selectability flags; only one per LIST response
// pub(crate) fn mbx_list_sflag(input: &[u8]) -> IMAPResult<&[u8], FlagNameAttribute> {
// alt((
// value(FlagNameAttribute::Noselect, tag_no_case(b"\\Noselect")),
// value(FlagNameAttribute::Marked, tag_no_case(b"\\Marked")),
// value(FlagNameAttribute::Unmarked, tag_no_case(b"\\Unmarked")),
// ))(input)
// }
#[cfg(test)]
mod tests {
use super::*;
use crate::core::Atom;
#[test]
fn test_parse_flag_fetch() {
let tests = [(
"iS)",
FlagFetch::Flag(Flag::Keyword(Atom::try_from("iS").unwrap())),
)];
for (test, expected) in tests {
let (rem, got) = flag_fetch(test.as_bytes()).unwrap();
assert_eq!(rem.len(), 1);
assert_eq!(expected, got);
}
}
#[test]
fn test_parse_flag_perm() {
let tests = [
("\\Deleted)", FlagPerm::Flag(Flag::Deleted)),
(
"\\Deletedx)",
FlagPerm::Flag(Flag::Extension(
FlagExtension::try_from(Atom::try_from("Deletedx").unwrap()).unwrap(),
)),
),
("\\Seen ", FlagPerm::Flag(Flag::Seen)),
("\\*)", FlagPerm::AllowNewKeywords),
];
for (test, expected) in tests {
let (rem, got) = flag_perm(test.as_bytes()).unwrap();
assert_eq!(rem.len(), 1);
assert_eq!(expected, got);
}
}
#[test]
fn test_parse_mbx_list_flags() {
let tests = [
(
"\\Markedm)",
vec![FlagNameAttribute::Extension(
Atom::try_from("Markedm").unwrap(),
)],
),
("\\Marked)", vec![FlagNameAttribute::Marked]),
];
for (test, expected) in tests {
let (rem, got) = mbx_list_flags(test.as_bytes()).unwrap();
assert_eq!(expected, got);
assert_eq!(rem.len(), 1);
}
}
}