Parser.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836
  1. /*
  2. * Copyright (c) 2021, Kyle Pereira <hey@xylepereira.me>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/CharacterTypes.h>
  7. #include <AK/Debug.h>
  8. #include <LibIMAP/Parser.h>
  9. namespace IMAP {
  10. ParseStatus Parser::parse(ByteBuffer&& buffer, bool expecting_tag)
  11. {
  12. dbgln_if(IMAP_PARSER_DEBUG, "Parser received {} bytes:\n\"{}\"", buffer.size(), StringView(buffer.data(), buffer.size()));
  13. if (m_incomplete) {
  14. m_buffer += buffer;
  15. m_incomplete = false;
  16. } else {
  17. m_buffer = move(buffer);
  18. m_position = 0;
  19. m_response = SolidResponse();
  20. }
  21. if (try_consume("+"sv)) {
  22. consume(" "sv);
  23. auto data = consume_until_end_of_line();
  24. consume("\r\n"sv);
  25. return { true, { ContinueRequest { data } } };
  26. }
  27. while (try_consume("*"sv)) {
  28. parse_untagged();
  29. }
  30. if (expecting_tag) {
  31. if (at_end()) {
  32. m_incomplete = true;
  33. return { true, {} };
  34. }
  35. parse_response_done();
  36. }
  37. if (m_parsing_failed) {
  38. return { false, {} };
  39. } else {
  40. return { true, { { move(m_response) } } };
  41. }
  42. }
  43. bool Parser::try_consume(StringView x)
  44. {
  45. dbgln_if(IMAP_PARSER_DEBUG, "p: {}, consume({})", m_position, x);
  46. size_t i = 0;
  47. auto previous_position = m_position;
  48. while (i < x.length() && !at_end() && to_ascii_lowercase(x[i]) == to_ascii_lowercase(m_buffer[m_position])) {
  49. i++;
  50. m_position++;
  51. }
  52. if (i != x.length()) {
  53. // We didn't match the full string.
  54. m_position = previous_position;
  55. dbgln_if(IMAP_PARSER_DEBUG, "ret false");
  56. return false;
  57. }
  58. dbgln_if(IMAP_PARSER_DEBUG, "ret true");
  59. return true;
  60. }
  61. void Parser::parse_response_done()
  62. {
  63. consume("A"sv);
  64. auto tag = MUST(parse_number());
  65. consume(" "sv);
  66. ResponseStatus status = parse_status();
  67. consume(" "sv);
  68. m_response.m_tag = tag;
  69. m_response.m_status = status;
  70. StringBuilder response_data;
  71. while (!at_end() && m_buffer[m_position] != '\r') {
  72. response_data.append((char)m_buffer[m_position]);
  73. m_position += 1;
  74. }
  75. consume("\r\n"sv);
  76. m_response.m_response_text = response_data.to_deprecated_string();
  77. }
  78. void Parser::consume(StringView x)
  79. {
  80. if (!try_consume(x)) {
  81. dbgln("\"{}\" not matched at {}, (buffer length {})", x, m_position, m_buffer.size());
  82. m_parsing_failed = true;
  83. }
  84. }
  85. Optional<unsigned> Parser::try_parse_number()
  86. {
  87. dbgln_if(IMAP_PARSER_DEBUG, "p: {}, try_parse_number()", m_position);
  88. auto number_matched = 0;
  89. while (!at_end() && 0 <= m_buffer[m_position] - '0' && m_buffer[m_position] - '0' <= 9) {
  90. number_matched++;
  91. m_position++;
  92. }
  93. if (number_matched == 0) {
  94. dbgln_if(IMAP_PARSER_DEBUG, "p: {}, ret empty", m_position);
  95. return {};
  96. }
  97. auto number = StringView(m_buffer.data() + m_position - number_matched, number_matched);
  98. dbgln_if(IMAP_PARSER_DEBUG, "p: {}, ret \"{}\"", m_position, number.to_uint());
  99. return number.to_uint();
  100. }
  101. ErrorOr<unsigned> Parser::parse_number()
  102. {
  103. auto number = try_parse_number();
  104. if (!number.has_value()) {
  105. m_parsing_failed = true;
  106. return Error::from_string_view("Failed to parse expected number"sv);
  107. }
  108. return number.value();
  109. }
  110. void Parser::parse_untagged()
  111. {
  112. consume(" "sv);
  113. // Certain messages begin with a number like:
  114. // * 15 EXISTS
  115. auto number = try_parse_number();
  116. if (number.has_value()) {
  117. consume(" "sv);
  118. auto data_type = parse_atom();
  119. if (data_type == "EXISTS"sv) {
  120. m_response.data().set_exists(number.value());
  121. consume("\r\n"sv);
  122. } else if (data_type == "RECENT"sv) {
  123. m_response.data().set_recent(number.value());
  124. consume("\r\n"sv);
  125. } else if (data_type == "FETCH"sv) {
  126. auto fetch_response = parse_fetch_response();
  127. m_response.data().add_fetch_response(number.value(), move(fetch_response));
  128. } else if (data_type == "EXPUNGE"sv) {
  129. m_response.data().add_expunged(number.value());
  130. consume("\r\n"sv);
  131. }
  132. return;
  133. }
  134. if (try_consume("CAPABILITY"sv)) {
  135. parse_capability_response();
  136. } else if (try_consume("LIST"sv)) {
  137. auto item = parse_list_item();
  138. m_response.data().add_list_item(move(item));
  139. } else if (try_consume("LSUB"sv)) {
  140. auto item = parse_list_item();
  141. m_response.data().add_lsub_item(move(item));
  142. } else if (try_consume("FLAGS"sv)) {
  143. consume(" "sv);
  144. auto flags = parse_list(+[](StringView x) { return DeprecatedString(x); });
  145. m_response.data().set_flags(move(flags));
  146. consume("\r\n"sv);
  147. } else if (try_consume("OK"sv)) {
  148. consume(" "sv);
  149. if (try_consume("["sv)) {
  150. auto actual_type = parse_atom();
  151. if (actual_type == "CLOSED"sv) {
  152. // No-op.
  153. } else if (actual_type == "UIDNEXT"sv) {
  154. consume(" "sv);
  155. auto n = MUST(parse_number());
  156. m_response.data().set_uid_next(n);
  157. } else if (actual_type == "UIDVALIDITY"sv) {
  158. consume(" "sv);
  159. auto n = MUST(parse_number());
  160. m_response.data().set_uid_validity(n);
  161. } else if (actual_type == "UNSEEN"sv) {
  162. consume(" "sv);
  163. auto n = MUST(parse_number());
  164. m_response.data().set_unseen(n);
  165. } else if (actual_type == "PERMANENTFLAGS"sv) {
  166. consume(" "sv);
  167. auto flags = parse_list(+[](StringView x) { return DeprecatedString(x); });
  168. m_response.data().set_permanent_flags(move(flags));
  169. } else if (actual_type == "HIGHESTMODSEQ"sv) {
  170. consume(" "sv);
  171. MUST(parse_number());
  172. // No-op for now.
  173. } else {
  174. dbgln("Unknown: {}", actual_type);
  175. consume_while([](u8 x) { return x != ']'; });
  176. }
  177. consume("]"sv);
  178. }
  179. consume_until_end_of_line();
  180. consume("\r\n"sv);
  181. } else if (try_consume("SEARCH"sv)) {
  182. Vector<unsigned> ids;
  183. while (!try_consume("\r\n"sv)) {
  184. consume(" "sv);
  185. auto id = MUST(parse_number());
  186. ids.append(id);
  187. }
  188. m_response.data().set_search_results(move(ids));
  189. } else if (try_consume("BYE"sv)) {
  190. auto message = consume_until_end_of_line();
  191. consume("\r\n"sv);
  192. m_response.data().set_bye(message.is_empty() ? Optional<DeprecatedString>() : Optional<DeprecatedString>(message));
  193. } else if (try_consume("STATUS"sv)) {
  194. consume(" "sv);
  195. auto mailbox = parse_astring();
  196. consume(" ("sv);
  197. auto status_item = StatusItem();
  198. status_item.set_mailbox(mailbox);
  199. while (!try_consume(")"sv)) {
  200. auto status_att = parse_atom();
  201. consume(" "sv);
  202. auto value = MUST(parse_number());
  203. auto type = StatusItemType::Recent;
  204. if (status_att == "MESSAGES"sv) {
  205. type = StatusItemType::Messages;
  206. } else if (status_att == "UNSEEN"sv) {
  207. type = StatusItemType::Unseen;
  208. } else if (status_att == "UIDNEXT"sv) {
  209. type = StatusItemType::UIDNext;
  210. } else if (status_att == "UIDVALIDITY"sv) {
  211. type = StatusItemType::UIDValidity;
  212. } else if (status_att == "RECENT"sv) {
  213. type = StatusItemType::Recent;
  214. } else {
  215. dbgln("Unmatched status attribute: {}", status_att);
  216. m_parsing_failed = true;
  217. }
  218. status_item.set(type, value);
  219. if (!at_end() && m_buffer[m_position] != ')')
  220. consume(" "sv);
  221. }
  222. m_response.data().set_status(move(status_item));
  223. try_consume(" "sv); // Not in the spec but the Outlook server sends a space for some reason.
  224. consume("\r\n"sv);
  225. } else {
  226. auto x = consume_until_end_of_line();
  227. consume("\r\n"sv);
  228. dbgln("ignored {}", x);
  229. }
  230. }
  231. StringView Parser::parse_quoted_string()
  232. {
  233. dbgln_if(IMAP_PARSER_DEBUG, "p: {}, parse_quoted_string()", m_position);
  234. auto str = consume_while([](u8 x) { return x != '"'; });
  235. consume("\""sv);
  236. dbgln_if(IMAP_PARSER_DEBUG, "p: {}, ret \"{}\"", m_position, str);
  237. return str;
  238. }
  239. StringView Parser::parse_string()
  240. {
  241. if (try_consume("\""sv)) {
  242. return parse_quoted_string();
  243. } else {
  244. return parse_literal_string();
  245. }
  246. }
  247. Optional<StringView> Parser::parse_nstring()
  248. {
  249. dbgln_if(IMAP_PARSER_DEBUG, "p: {} parse_nstring()", m_position);
  250. if (try_consume("NIL"sv))
  251. return {};
  252. else
  253. return { parse_string() };
  254. }
  255. FetchResponseData Parser::parse_fetch_response()
  256. {
  257. consume(" ("sv);
  258. auto fetch_response = FetchResponseData();
  259. while (!try_consume(")"sv)) {
  260. auto data_item = parse_fetch_data_item();
  261. switch (data_item.type) {
  262. case FetchCommand::DataItemType::BodyStructure: {
  263. consume(" ("sv);
  264. auto structure = parse_body_structure();
  265. fetch_response.set_body_structure(move(structure));
  266. break;
  267. }
  268. case FetchCommand::DataItemType::Envelope: {
  269. fetch_response.set_envelope(parse_envelope());
  270. break;
  271. }
  272. case FetchCommand::DataItemType::Flags: {
  273. consume(" "sv);
  274. auto flags = parse_list(+[](StringView x) { return DeprecatedString(x); });
  275. fetch_response.set_flags(move(flags));
  276. break;
  277. }
  278. case FetchCommand::DataItemType::InternalDate: {
  279. consume(" \""sv);
  280. auto date_view = consume_while([](u8 x) { return x != '"'; });
  281. consume("\""sv);
  282. auto date = Core::DateTime::parse("%d-%b-%Y %H:%M:%S %z"sv, date_view).value();
  283. fetch_response.set_internal_date(date);
  284. break;
  285. }
  286. case FetchCommand::DataItemType::UID: {
  287. consume(" "sv);
  288. fetch_response.set_uid(MUST(parse_number()));
  289. break;
  290. }
  291. case FetchCommand::DataItemType::PeekBody:
  292. // Spec doesn't allow for this in a response.
  293. m_parsing_failed = true;
  294. break;
  295. case FetchCommand::DataItemType::BodySection: {
  296. auto body = parse_nstring();
  297. fetch_response.add_body_data(move(data_item), Optional<DeprecatedString>(move(body)));
  298. break;
  299. }
  300. }
  301. if (!at_end() && m_buffer[m_position] != ')')
  302. consume(" "sv);
  303. }
  304. consume("\r\n"sv);
  305. return fetch_response;
  306. }
  307. Envelope Parser::parse_envelope()
  308. {
  309. consume(" ("sv);
  310. auto date = parse_nstring();
  311. consume(" "sv);
  312. auto subject = parse_nstring();
  313. consume(" "sv);
  314. auto from = parse_address_list();
  315. consume(" "sv);
  316. auto sender = parse_address_list();
  317. consume(" "sv);
  318. auto reply_to = parse_address_list();
  319. consume(" "sv);
  320. auto to = parse_address_list();
  321. consume(" "sv);
  322. auto cc = parse_address_list();
  323. consume(" "sv);
  324. auto bcc = parse_address_list();
  325. consume(" "sv);
  326. auto in_reply_to = parse_nstring();
  327. consume(" "sv);
  328. auto message_id = parse_nstring();
  329. consume(")"sv);
  330. Envelope envelope = {
  331. date.has_value() ? AK::Optional<DeprecatedString>(date.value()) : AK::Optional<DeprecatedString>(),
  332. subject.has_value() ? AK::Optional<DeprecatedString>(subject.value()) : AK::Optional<DeprecatedString>(),
  333. from,
  334. sender,
  335. reply_to,
  336. to,
  337. cc,
  338. bcc,
  339. in_reply_to.has_value() ? AK::Optional<DeprecatedString>(in_reply_to.value()) : AK::Optional<DeprecatedString>(),
  340. message_id.has_value() ? AK::Optional<DeprecatedString>(message_id.value()) : AK::Optional<DeprecatedString>(),
  341. };
  342. return envelope;
  343. }
  344. BodyStructure Parser::parse_body_structure()
  345. {
  346. if (!at_end() && m_buffer[m_position] == '(') {
  347. auto data = MultiPartBodyStructureData();
  348. while (try_consume("("sv)) {
  349. auto child = parse_body_structure();
  350. data.bodies.append(make<BodyStructure>(move(child)));
  351. }
  352. consume(" "sv);
  353. data.media_type = parse_string();
  354. if (!try_consume(")"sv)) {
  355. consume(" "sv);
  356. data.params = try_consume("NIL"sv) ? Optional<HashMap<DeprecatedString, DeprecatedString>>() : parse_body_fields_params();
  357. if (!try_consume(")"sv)) {
  358. consume(" "sv);
  359. if (!try_consume("NIL"sv)) {
  360. data.disposition = { parse_disposition() };
  361. }
  362. if (!try_consume(")"sv)) {
  363. consume(" "sv);
  364. if (!try_consume("NIL"sv)) {
  365. data.langs = { parse_langs() };
  366. }
  367. if (!try_consume(")"sv)) {
  368. consume(" "sv);
  369. data.location = try_consume("NIL"sv) ? Optional<DeprecatedString>() : Optional<DeprecatedString>(parse_string());
  370. if (!try_consume(")"sv)) {
  371. consume(" "sv);
  372. Vector<BodyExtension> extensions;
  373. while (!try_consume(")"sv)) {
  374. extensions.append(parse_body_extension());
  375. try_consume(" "sv);
  376. }
  377. data.extensions = { move(extensions) };
  378. }
  379. }
  380. }
  381. }
  382. }
  383. return BodyStructure(move(data));
  384. } else {
  385. return parse_one_part_body();
  386. }
  387. }
  388. // body-type-1part
  389. BodyStructure Parser::parse_one_part_body()
  390. {
  391. // NOTE: We share common parts between body-type-basic, body-type-msg and body-type-text types for readability.
  392. BodyStructureData data;
  393. // media-basic / media-message / media-text
  394. data.type = parse_string();
  395. consume(" "sv);
  396. data.subtype = parse_string();
  397. consume(" "sv);
  398. // body-fields
  399. data.fields = parse_body_fields_params();
  400. consume(" "sv);
  401. data.id = Optional<DeprecatedString>(parse_nstring());
  402. consume(" "sv);
  403. data.desc = Optional<DeprecatedString>(parse_nstring());
  404. consume(" "sv);
  405. data.encoding = parse_string();
  406. consume(" "sv);
  407. data.bytes = MUST(parse_number());
  408. if (data.type.equals_ignoring_ascii_case("TEXT"sv)) {
  409. // body-type-text
  410. // NOTE: "media-text SP body-fields" part is already parsed.
  411. consume(" "sv);
  412. data.lines = MUST(parse_number());
  413. if (!try_consume(")"sv)) {
  414. consume(" "sv);
  415. auto md5 = parse_nstring();
  416. if (md5.has_value())
  417. data.md5 = { md5.value() };
  418. if (!try_consume(")"sv)) {
  419. consume(" "sv);
  420. if (!try_consume("NIL"sv)) {
  421. auto disposition = parse_disposition();
  422. data.disposition = { disposition };
  423. }
  424. if (!try_consume(")"sv)) {
  425. consume(" "sv);
  426. if (!try_consume("NIL"sv)) {
  427. data.langs = { parse_langs() };
  428. }
  429. if (!try_consume(")"sv)) {
  430. consume(" "sv);
  431. auto location = parse_nstring();
  432. if (location.has_value())
  433. data.location = { location.value() };
  434. Vector<BodyExtension> extensions;
  435. while (!try_consume(")"sv)) {
  436. extensions.append(parse_body_extension());
  437. try_consume(" "sv);
  438. }
  439. data.extensions = { move(extensions) };
  440. }
  441. }
  442. }
  443. }
  444. } else if (data.type.equals_ignoring_ascii_case("MESSAGE"sv) && data.subtype.equals_ignoring_ascii_case("RFC822"sv)) {
  445. // body-type-msg
  446. // NOTE: "media-message SP body-fields" part is already parsed.
  447. consume(" "sv);
  448. data.envelope = parse_envelope();
  449. } else {
  450. // body-type-basic
  451. // NOTE: "media-basic SP body-fields" is already parsed.
  452. }
  453. return BodyStructure(move(data));
  454. }
  455. Vector<DeprecatedString> Parser::parse_langs()
  456. {
  457. AK::Vector<DeprecatedString> langs;
  458. if (!try_consume("("sv)) {
  459. langs.append(parse_string());
  460. } else {
  461. while (!try_consume(")"sv)) {
  462. langs.append(parse_string());
  463. try_consume(" "sv);
  464. }
  465. }
  466. return langs;
  467. }
  468. Tuple<DeprecatedString, HashMap<DeprecatedString, DeprecatedString>> Parser::parse_disposition()
  469. {
  470. consume("("sv);
  471. auto disposition_type = parse_string();
  472. consume(" "sv);
  473. auto disposition_vals = parse_body_fields_params();
  474. consume(")"sv);
  475. return { move(disposition_type), move(disposition_vals) };
  476. }
  477. StringView Parser::parse_literal_string()
  478. {
  479. dbgln_if(IMAP_PARSER_DEBUG, "p: {}, parse_literal_string()", m_position);
  480. consume("{"sv);
  481. auto num_bytes = MUST(parse_number());
  482. consume("}\r\n"sv);
  483. if (m_buffer.size() < m_position + num_bytes) {
  484. m_parsing_failed = true;
  485. return ""sv;
  486. }
  487. m_position += num_bytes;
  488. auto s = StringView(m_buffer.data() + m_position - num_bytes, num_bytes);
  489. dbgln_if(IMAP_PARSER_DEBUG, "p: {}, ret \"{}\"", m_position, s);
  490. return s;
  491. }
  492. ListItem Parser::parse_list_item()
  493. {
  494. consume(" "sv);
  495. auto flags_vec = parse_list(parse_mailbox_flag);
  496. unsigned flags = 0;
  497. for (auto flag : flags_vec) {
  498. flags |= static_cast<unsigned>(flag);
  499. }
  500. consume(" \""sv);
  501. auto reference = consume_while([](u8 x) { return x != '"'; });
  502. consume("\" "sv);
  503. auto mailbox = parse_astring();
  504. consume("\r\n"sv);
  505. return ListItem { flags, DeprecatedString(reference), DeprecatedString(mailbox) };
  506. }
  507. void Parser::parse_capability_response()
  508. {
  509. auto capability = AK::Vector<DeprecatedString>();
  510. while (!try_consume("\r\n"sv)) {
  511. consume(" "sv);
  512. auto x = DeprecatedString(parse_atom());
  513. capability.append(x);
  514. }
  515. m_response.data().add_capabilities(move(capability));
  516. }
  517. StringView Parser::parse_atom()
  518. {
  519. dbgln_if(IMAP_PARSER_DEBUG, "p: {}, parse_atom()", m_position);
  520. auto is_non_atom_char = [](u8 x) {
  521. auto non_atom_chars = { '(', ')', '{', ' ', '%', '*', '"', '\\', ']' };
  522. return AK::find(non_atom_chars.begin(), non_atom_chars.end(), x) != non_atom_chars.end();
  523. };
  524. auto start = m_position;
  525. auto count = 0;
  526. while (!at_end() && !is_ascii_control(m_buffer[m_position]) && !is_non_atom_char(m_buffer[m_position])) {
  527. count++;
  528. m_position++;
  529. }
  530. StringView s = StringView(m_buffer.data() + start, count);
  531. dbgln_if(IMAP_PARSER_DEBUG, "p: {}, ret \"{}\"", m_position, s);
  532. return s;
  533. }
  534. ResponseStatus Parser::parse_status()
  535. {
  536. auto atom = parse_atom();
  537. if (atom == "OK"sv) {
  538. return ResponseStatus::OK;
  539. } else if (atom == "BAD"sv) {
  540. return ResponseStatus::Bad;
  541. } else if (atom == "NO"sv) {
  542. return ResponseStatus::No;
  543. }
  544. m_parsing_failed = true;
  545. return ResponseStatus::Bad;
  546. }
  547. template<typename T>
  548. Vector<T> Parser::parse_list(T converter(StringView))
  549. {
  550. consume("("sv);
  551. Vector<T> x;
  552. bool first = true;
  553. while (!try_consume(")"sv)) {
  554. if (!first)
  555. consume(" "sv);
  556. auto item = consume_while([](u8 x) {
  557. return x != ' ' && x != ')';
  558. });
  559. x.append(converter(item));
  560. first = false;
  561. }
  562. return x;
  563. }
  564. MailboxFlag Parser::parse_mailbox_flag(StringView s)
  565. {
  566. if (s == "\\All"sv)
  567. return MailboxFlag::All;
  568. if (s == "\\Drafts"sv)
  569. return MailboxFlag::Drafts;
  570. if (s == "\\Flagged"sv)
  571. return MailboxFlag::Flagged;
  572. if (s == "\\HasChildren"sv)
  573. return MailboxFlag::HasChildren;
  574. if (s == "\\HasNoChildren"sv)
  575. return MailboxFlag::HasNoChildren;
  576. if (s == "\\Important"sv)
  577. return MailboxFlag::Important;
  578. if (s == "\\Junk"sv)
  579. return MailboxFlag::Junk;
  580. if (s == "\\Marked"sv)
  581. return MailboxFlag::Marked;
  582. if (s == "\\Noinferiors"sv)
  583. return MailboxFlag::NoInferiors;
  584. if (s == "\\Noselect"sv)
  585. return MailboxFlag::NoSelect;
  586. if (s == "\\Sent"sv)
  587. return MailboxFlag::Sent;
  588. if (s == "\\Trash"sv)
  589. return MailboxFlag::Trash;
  590. if (s == "\\Unmarked"sv)
  591. return MailboxFlag::Unmarked;
  592. dbgln("Unrecognized mailbox flag {}", s);
  593. return MailboxFlag::Unknown;
  594. }
  595. StringView Parser::consume_while(Function<bool(u8)> should_consume)
  596. {
  597. dbgln_if(IMAP_PARSER_DEBUG, "p: {}, consume_while()", m_position);
  598. int chars = 0;
  599. while (!at_end() && should_consume(m_buffer[m_position])) {
  600. m_position++;
  601. chars++;
  602. }
  603. auto s = StringView(m_buffer.data() + m_position - chars, chars);
  604. dbgln_if(IMAP_PARSER_DEBUG, "p: {}, ret \"{}\"", m_position, s);
  605. return s;
  606. }
  607. StringView Parser::consume_until_end_of_line()
  608. {
  609. return consume_while([](u8 x) { return x != '\r'; });
  610. }
  611. FetchCommand::DataItem Parser::parse_fetch_data_item()
  612. {
  613. auto msg_attr = consume_while([](u8 x) { return is_ascii_alpha(x) != 0; });
  614. if (msg_attr.equals_ignoring_ascii_case("BODY"sv) && try_consume("["sv)) {
  615. auto data_item = FetchCommand::DataItem {
  616. .type = FetchCommand::DataItemType::BodySection,
  617. .section = { {} }
  618. };
  619. auto section_type = consume_while([](u8 x) { return x != ']' && x != ' '; });
  620. if (section_type.equals_ignoring_ascii_case("HEADER.FIELDS"sv)) {
  621. data_item.section->type = FetchCommand::DataItem::SectionType::HeaderFields;
  622. data_item.section->headers = Vector<DeprecatedString>();
  623. consume(" "sv);
  624. auto headers = parse_list(+[](StringView x) { return x; });
  625. for (auto& header : headers) {
  626. data_item.section->headers->append(header);
  627. }
  628. consume("]"sv);
  629. } else if (section_type.equals_ignoring_ascii_case("HEADER.FIELDS.NOT"sv)) {
  630. data_item.section->type = FetchCommand::DataItem::SectionType::HeaderFieldsNot;
  631. data_item.section->headers = Vector<DeprecatedString>();
  632. consume(" ("sv);
  633. auto headers = parse_list(+[](StringView x) { return x; });
  634. for (auto& header : headers) {
  635. data_item.section->headers->append(header);
  636. }
  637. consume("]"sv);
  638. } else if (is_ascii_digit(section_type[0])) {
  639. data_item.section->type = FetchCommand::DataItem::SectionType::Parts;
  640. data_item.section->parts = Vector<unsigned>();
  641. while (!try_consume("]"sv)) {
  642. auto num = try_parse_number();
  643. if (num.has_value()) {
  644. data_item.section->parts->append(num.value());
  645. continue;
  646. }
  647. auto atom = parse_atom();
  648. if (atom.equals_ignoring_ascii_case("MIME"sv)) {
  649. data_item.section->ends_with_mime = true;
  650. continue;
  651. }
  652. }
  653. } else if (section_type.equals_ignoring_ascii_case("TEXT"sv)) {
  654. data_item.section->type = FetchCommand::DataItem::SectionType::Text;
  655. } else if (section_type.equals_ignoring_ascii_case("HEADER"sv)) {
  656. data_item.section->type = FetchCommand::DataItem::SectionType::Header;
  657. } else {
  658. dbgln("Unmatched section type {}", section_type);
  659. m_parsing_failed = true;
  660. }
  661. if (try_consume("<"sv)) {
  662. auto start = MUST(parse_number());
  663. data_item.partial_fetch = true;
  664. data_item.start = (int)start;
  665. consume(">"sv);
  666. }
  667. try_consume(" "sv);
  668. return data_item;
  669. } else if (msg_attr.equals_ignoring_ascii_case("FLAGS"sv)) {
  670. return FetchCommand::DataItem {
  671. .type = FetchCommand::DataItemType::Flags
  672. };
  673. } else if (msg_attr.equals_ignoring_ascii_case("UID"sv)) {
  674. return FetchCommand::DataItem {
  675. .type = FetchCommand::DataItemType::UID
  676. };
  677. } else if (msg_attr.equals_ignoring_ascii_case("INTERNALDATE"sv)) {
  678. return FetchCommand::DataItem {
  679. .type = FetchCommand::DataItemType::InternalDate
  680. };
  681. } else if (msg_attr.equals_ignoring_ascii_case("ENVELOPE"sv)) {
  682. return FetchCommand::DataItem {
  683. .type = FetchCommand::DataItemType::Envelope
  684. };
  685. } else if (msg_attr.equals_ignoring_ascii_case("BODY"sv) || msg_attr.equals_ignoring_ascii_case("BODYSTRUCTURE"sv)) {
  686. return FetchCommand::DataItem {
  687. .type = FetchCommand::DataItemType::BodyStructure
  688. };
  689. } else {
  690. dbgln("msg_attr not matched: {}", msg_attr);
  691. m_parsing_failed = true;
  692. return FetchCommand::DataItem {};
  693. }
  694. }
  695. Optional<Vector<Address>> Parser::parse_address_list()
  696. {
  697. if (try_consume("NIL"sv))
  698. return {};
  699. auto addresses = Vector<Address>();
  700. consume("("sv);
  701. while (!try_consume(")"sv)) {
  702. addresses.append(parse_address());
  703. if (!at_end() && m_buffer[m_position] != ')')
  704. consume(" "sv);
  705. }
  706. return { addresses };
  707. }
  708. Address Parser::parse_address()
  709. {
  710. consume("("sv);
  711. auto address = Address();
  712. auto name = parse_nstring();
  713. address.name = Optional<DeprecatedString>(move(name));
  714. consume(" "sv);
  715. auto source_route = parse_nstring();
  716. address.source_route = Optional<DeprecatedString>(move(source_route));
  717. consume(" "sv);
  718. auto mailbox = parse_nstring();
  719. address.mailbox = Optional<DeprecatedString>(move(mailbox));
  720. consume(" "sv);
  721. auto host = parse_nstring();
  722. address.host = Optional<DeprecatedString>(move(host));
  723. consume(")"sv);
  724. return address;
  725. }
  726. StringView Parser::parse_astring()
  727. {
  728. if (!at_end() && (m_buffer[m_position] == '{' || m_buffer[m_position] == '"'))
  729. return parse_string();
  730. else
  731. return parse_atom();
  732. }
  733. HashMap<DeprecatedString, DeprecatedString> Parser::parse_body_fields_params()
  734. {
  735. if (try_consume("NIL"sv))
  736. return {};
  737. HashMap<DeprecatedString, DeprecatedString> fields;
  738. consume("("sv);
  739. while (!try_consume(")"sv)) {
  740. auto key = parse_string();
  741. consume(" "sv);
  742. auto value = parse_string();
  743. fields.set(key, value);
  744. try_consume(" "sv);
  745. }
  746. return fields;
  747. }
  748. BodyExtension Parser::parse_body_extension()
  749. {
  750. if (try_consume("NIL"sv)) {
  751. return BodyExtension { Optional<DeprecatedString> {} };
  752. } else if (try_consume("("sv)) {
  753. Vector<OwnPtr<BodyExtension>> extensions;
  754. while (!try_consume(")"sv)) {
  755. extensions.append(make<BodyExtension>(parse_body_extension()));
  756. try_consume(" "sv);
  757. }
  758. return BodyExtension { move(extensions) };
  759. } else if (!at_end() && (m_buffer[m_position] == '"' || m_buffer[m_position] == '{')) {
  760. return BodyExtension { { parse_string() } };
  761. } else {
  762. return BodyExtension { MUST(parse_number()) };
  763. }
  764. }
  765. }