Parser.cpp 28 KB

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