Client.h 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. /*
  2. * Copyright (c) 2021, Kyle Pereira <hey@xylepereira.me>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #pragma once
  7. #include <AK/Function.h>
  8. #include <LibCore/Promise.h>
  9. #include <LibCore/Stream.h>
  10. #include <LibIMAP/Parser.h>
  11. #include <LibTLS/TLSv12.h>
  12. namespace IMAP {
  13. template<typename T>
  14. using Promise = Core::Promise<T>;
  15. class Client {
  16. AK_MAKE_NONCOPYABLE(Client);
  17. friend class Parser;
  18. public:
  19. static ErrorOr<NonnullOwnPtr<Client>> connect_tls(StringView host, u16 port);
  20. static ErrorOr<NonnullOwnPtr<Client>> connect_plaintext(StringView host, u16 port);
  21. Client(Client&&);
  22. RefPtr<Promise<Empty>> connection_promise()
  23. {
  24. return m_connect_pending;
  25. }
  26. RefPtr<Promise<Optional<Response>>> send_command(Command&&);
  27. RefPtr<Promise<Optional<Response>>> send_simple_command(CommandType);
  28. ErrorOr<void> send_raw(StringView data);
  29. RefPtr<Promise<Optional<SolidResponse>>> login(StringView username, StringView password);
  30. RefPtr<Promise<Optional<SolidResponse>>> list(StringView reference_name, StringView mailbox_name);
  31. RefPtr<Promise<Optional<SolidResponse>>> lsub(StringView reference_name, StringView mailbox_name);
  32. RefPtr<Promise<Optional<SolidResponse>>> select(StringView string);
  33. RefPtr<Promise<Optional<SolidResponse>>> examine(StringView string);
  34. RefPtr<Promise<Optional<SolidResponse>>> search(Optional<DeprecatedString> charset, Vector<SearchKey>&& search_keys, bool uid);
  35. RefPtr<Promise<Optional<SolidResponse>>> fetch(FetchCommand request, bool uid);
  36. RefPtr<Promise<Optional<SolidResponse>>> store(StoreMethod, Sequence, bool silent, Vector<DeprecatedString> const& flags, bool uid);
  37. RefPtr<Promise<Optional<SolidResponse>>> copy(Sequence sequence_set, StringView name, bool uid);
  38. RefPtr<Promise<Optional<SolidResponse>>> create_mailbox(StringView name);
  39. RefPtr<Promise<Optional<SolidResponse>>> delete_mailbox(StringView name);
  40. RefPtr<Promise<Optional<SolidResponse>>> subscribe(StringView mailbox);
  41. RefPtr<Promise<Optional<SolidResponse>>> unsubscribe(StringView mailbox);
  42. RefPtr<Promise<Optional<SolidResponse>>> rename(StringView from, StringView to);
  43. RefPtr<Promise<Optional<Response>>> authenticate(StringView method);
  44. RefPtr<Promise<Optional<ContinueRequest>>> idle();
  45. RefPtr<Promise<Optional<SolidResponse>>> finish_idle();
  46. RefPtr<Promise<Optional<SolidResponse>>> status(StringView mailbox, Vector<StatusItemType> const& types);
  47. RefPtr<Promise<Optional<SolidResponse>>> append(StringView mailbox, Message&& message, Optional<Vector<DeprecatedString>> flags = {}, Optional<Core::DateTime> date_time = {});
  48. bool is_open();
  49. void close();
  50. Function<void(ResponseData&&)> unrequested_response_callback;
  51. private:
  52. Client(StringView host, u16 port, NonnullOwnPtr<Core::Stream::Socket>);
  53. void setup_callbacks();
  54. ErrorOr<void> on_ready_to_receive();
  55. ErrorOr<void> handle_parsed_response(ParseStatus&& parse_status);
  56. ErrorOr<void> send_next_command();
  57. StringView m_host;
  58. u16 m_port;
  59. NonnullOwnPtr<Core::Stream::Socket> m_socket;
  60. RefPtr<Promise<Empty>> m_connect_pending {};
  61. int m_current_command = 1;
  62. // Sent but response not received
  63. Vector<RefPtr<Promise<Optional<Response>>>> m_pending_promises;
  64. // Not yet sent
  65. Vector<Command> m_command_queue {};
  66. ByteBuffer m_buffer;
  67. Parser m_parser {};
  68. bool m_expecting_response { false };
  69. };
  70. }