initial commit

include/comm/packet/client_pool.hpp

@@ -0,0 +1,89 @@
+/*
+  Copyright <2018-2022> <scott.e.graves@protonmail.com>
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+  associated documentation files (the "Software"), to deal in the Software without restriction,
+  including without limitation the rights to use, copy, modify, merge, publish, distribute,
+  sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all copies or
+  substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+  NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+  DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
+  OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+#ifndef INCLUDE_COMM_PACKET_CLIENT_POOL_HPP_
+#define INCLUDE_COMM_PACKET_CLIENT_POOL_HPP_
+
+#include "common.hpp"
+#include "comm/packet/packet.hpp"
+#include "types/repertory.hpp"
+
+namespace repertory {
+class client_pool final {
+public:
+  typedef std::function<packet::error_type()> worker_callback;
+  typedef std::function<void(const packet::error_type &result)> worker_complete_callback;
+
+private:
+  class pool final {
+  private:
+    struct work_item final {
+      work_item(const worker_callback &worker, const worker_complete_callback &worker_complete)
+          : work(worker), work_complete(worker_complete) {}
+
+      worker_callback work;
+      worker_complete_callback work_complete;
+    };
+
+    struct work_queue final {
+      std::mutex mutex;
+      std::condition_variable notify;
+      std::deque<std::shared_ptr<work_item>> queue;
+    };
+
+  public:
+    explicit pool(const std::uint8_t &pool_size);
+
+    ~pool() { shutdown(); }
+
+  private:
+    std::vector<std::unique_ptr<work_queue>> pool_queues_;
+    std::vector<std::thread> pool_threads_;
+    bool shutdown_ = false;
+    std::atomic<std::uint8_t> thread_index_;
+
+  public:
+    void execute(const std::uint64_t &thread_id, const worker_callback &worker,
+                 const worker_complete_callback &worker_complete);
+
+    void shutdown();
+  };
+
+public:
+  explicit client_pool(const std::uint8_t &pool_size = 10u)
+      : pool_size_(pool_size ? pool_size : 10u) {}
+
+  ~client_pool() { shutdown(); }
+
+private:
+  const std::uint8_t pool_size_;
+  std::unordered_map<std::string, std::shared_ptr<pool>> pool_lookup_;
+  std::mutex pool_mutex_;
+  bool shutdown_ = false;
+
+public:
+  void execute(const std::string &client_id, const std::uint64_t &thread_id,
+               const worker_callback &worker, const worker_complete_callback &worker_complete);
+
+  void remove_client(const std::string &client_id);
+
+  void shutdown();
+};
+} // namespace repertory
+
+#endif // INCLUDE_COMM_PACKET_CLIENT_POOL_HPP_

include/comm/packet/packet.hpp

@@ -0,0 +1,213 @@
+/*
+  Copyright <2018-2022> <scott.e.graves@protonmail.com>
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+  associated documentation files (the "Software"), to deal in the Software without restriction,
+  including without limitation the rights to use, copy, modify, merge, publish, distribute,
+  sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all copies or
+  substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+  NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+  DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
+  OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+#ifndef INCLUDE_COMM_PACKET_PACKET_HPP_
+#define INCLUDE_COMM_PACKET_PACKET_HPP_
+
+#include "common.hpp"
+#include "types/remote.hpp"
+#include "types/repertory.hpp"
+
+namespace repertory {
+#define DECODE_OR_RETURN(p, value)                                                                 \
+  if ((ret = (p)->decode(value)) != 0)                                                             \
+  return ret
+#define DECODE_OR_IGNORE(p, value)                                                                 \
+  if (ret == 0)                                                                                    \
+  ret = (p)->decode(value)
+
+class packet final {
+public:
+  typedef std::int32_t error_type;
+
+public:
+  packet() = default;
+
+  explicit packet(std::vector<char> buffer) : buffer_(std::move(buffer)) {}
+
+  explicit packet(std::vector<char> &&buffer) : buffer_(std::move(buffer)) {}
+
+  packet(const packet &p) noexcept : buffer_(p.buffer_), decode_offset_(p.decode_offset_) {}
+
+  packet(packet &&p) noexcept : buffer_(std::move(p.buffer_)), decode_offset_(p.decode_offset_) {}
+
+private:
+  std::vector<char> buffer_;
+  std::size_t decode_offset_ = 0u;
+
+public:
+  static int decode_json(packet &response, json &json_data);
+
+public:
+  void clear();
+
+  char *current_pointer() {
+    return (decode_offset_ < buffer_.size()) ? &buffer_[decode_offset_] : nullptr;
+  }
+
+  const char *current_pointer() const {
+    return (decode_offset_ < buffer_.size()) ? &buffer_[decode_offset_] : nullptr;
+  }
+
+  error_type decode(std::string &data);
+
+  error_type decode(std::wstring &data);
+
+  error_type decode(void *buffer, const size_t &size);
+
+  error_type decode(void *&ptr);
+
+  error_type decode(std::int8_t &i);
+
+  error_type decode(std::uint8_t &i);
+
+  error_type decode(std::int16_t &i);
+
+  error_type decode(std::uint16_t &i);
+
+  error_type decode(std::int32_t &i);
+
+  error_type decode(std::uint32_t &i);
+
+  error_type decode(std::int64_t &i);
+
+  error_type decode(std::uint64_t &i);
+
+  error_type decode(remote::open_flags &i) {
+    return decode(reinterpret_cast<std::uint32_t &>(i));
+  }
+
+  error_type decode(remote::setattr_x &i);
+
+  error_type decode(remote::stat &i);
+
+  error_type decode(remote::statfs &i);
+
+  error_type decode(remote::statfs_x &i);
+
+  error_type decode(remote::file_info &i);
+
+  error_type decrypt(const std::string &token);
+
+  void encode(const void *buffer, const std::size_t &size, bool should_reserve = true);
+
+  void encode(char *str) { encode(std::string(str ? str : "")); }
+
+  void encode(const char *str) { encode(std::string(str ? str : "")); }
+
+  void encode(const std::string &str);
+
+  void encode(wchar_t *str);
+
+  void encode(const wchar_t *str);
+
+  void encode(const std::wstring &str);
+
+  void encode(void *ptr) {
+    encode(static_cast<std::uint64_t>(reinterpret_cast<std::uintptr_t>(ptr)));
+  }
+
+  void encode(std::int8_t i);
+
+  void encode(std::uint8_t i);
+
+  void encode(std::int16_t i);
+
+  void encode(std::uint16_t i);
+
+  void encode(std::int32_t i);
+
+  void encode(std::uint32_t i);
+
+  void encode(std::int64_t i);
+
+  void encode(std::uint64_t i);
+
+  void encode(remote::open_flags i) { encode(static_cast<std::uint32_t>(i)); }
+
+  void encode(remote::setattr_x i);
+
+  void encode(remote::stat i);
+
+  void encode(remote::statfs i, bool should_reserve = true);
+
+  void encode(remote::statfs_x i);
+
+  void encode(remote::file_info i);
+
+  void encode_top(const void *buffer, const std::size_t &size, bool should_reserve = true);
+
+  void encode_top(const std::string &str);
+
+  void encode_top(const std::wstring &str);
+
+  void encode_top(void *ptr) {
+    encode_top(static_cast<std::uint64_t>(reinterpret_cast<std::uintptr_t>(ptr)));
+  }
+
+  void encode_top(std::int8_t i);
+
+  void encode_top(std::uint8_t i);
+
+  void encode_top(std::int16_t i);
+
+  void encode_top(std::uint16_t i);
+
+  void encode_top(std::int32_t i);
+
+  void encode_top(std::uint32_t i);
+
+  void encode_top(std::int64_t i);
+
+  void encode_top(std::uint64_t i);
+
+  void encode_top(remote::open_flags i) { encode_top(static_cast<std::uint32_t>(i)); }
+
+  void encode_top(remote::setattr_x i);
+
+  void encode_top(remote::stat i);
+
+  void encode_top(remote::statfs i, bool should_reserve = true);
+
+  void encode_top(remote::statfs_x i);
+
+  void encode_top(remote::file_info i);
+
+  void encrypt(const std::string &token);
+
+  std::uint32_t get_size() const { return static_cast<std::uint32_t>(buffer_.size()); }
+
+  void transfer_into(std::vector<char> &buffer);
+
+public:
+  packet &operator=(const std::vector<char> &buffer) noexcept;
+
+  packet &operator=(std::vector<char> &&buffer) noexcept;
+
+  packet &operator=(const packet &p) noexcept;
+
+  packet &operator=(packet &&p) noexcept;
+
+  char &operator[](const size_t &index) { return buffer_[index]; }
+
+  const char &operator[](const size_t &index) const { return buffer_.at(index); }
+};
+typedef packet packet;
+} // namespace repertory
+
+#endif // INCLUDE_COMM_PACKET_PACKET_HPP_

include/comm/packet/packet_client.hpp

@@ -0,0 +1,84 @@
+/*
+  Copyright <2018-2022> <scott.e.graves@protonmail.com>
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+  associated documentation files (the "Software"), to deal in the Software without restriction,
+  including without limitation the rights to use, copy, modify, merge, publish, distribute,
+  sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all copies or
+  substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+  NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+  DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
+  OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+#ifndef INCLUDE_COMM_PACKET_PACKET_CLIENT_HPP_
+#define INCLUDE_COMM_PACKET_PACKET_CLIENT_HPP_
+
+#include "common.hpp"
+#include "comm/packet/packet.hpp"
+
+using boost::asio::ip::tcp;
+
+namespace repertory {
+class packet_client final {
+private:
+  struct client {
+    client(boost::asio::io_context &ctx) : nonce(""), socket(ctx) {}
+
+    std::string nonce;
+    tcp::socket socket;
+  };
+
+public:
+  packet_client(std::string host_name_or_ip, const std::uint8_t &max_connections,
+                const std::uint16_t &port, const std::uint16_t &receive_timeout,
+                const std::uint16_t &send_timeout, std::string encryption_token);
+
+  ~packet_client();
+
+private:
+  boost::asio::io_context io_context_;
+  const std::string host_name_or_ip_;
+  const std::uint8_t max_connections_;
+  const std::uint16_t port_;
+  const std::uint16_t receive_timeout_;
+  const std::uint16_t send_timeout_;
+  const std::string encryption_token_;
+  std::string unique_id_;
+
+  bool allow_connections_ = true;
+  boost::asio::ip::basic_resolver<boost::asio::ip::tcp>::results_type resolve_results_;
+  std::mutex clients_mutex_;
+  std::vector<std::shared_ptr<client>> clients_;
+
+private:
+  void close(client &c) const;
+
+  void close_all();
+
+  bool connect(client &c);
+
+  std::shared_ptr<client> get_client();
+
+  void put_client(std::shared_ptr<client> &c);
+
+  packet::error_type read_packet(client &c, packet &response);
+
+  void resolve();
+
+public:
+  packet::error_type send(const std::string &method, std::uint32_t &service_flags);
+
+  packet::error_type send(const std::string &method, packet &request, std::uint32_t &service_flags);
+
+  packet::error_type send(const std::string &method, packet &request, packet &response,
+                          std::uint32_t &service_flags);
+};
+} // namespace repertory
+
+#endif // INCLUDE_COMM_PACKET_PACKET_CLIENT_HPP_

include/comm/packet/packet_server.hpp

@@ -0,0 +1,90 @@
+/*
+  Copyright <2018-2022> <scott.e.graves@protonmail.com>
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+  associated documentation files (the "Software"), to deal in the Software without restriction,
+  including without limitation the rights to use, copy, modify, merge, publish, distribute,
+  sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all copies or
+  substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+  NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+  DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
+  OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+#ifndef INCLUDE_COMM_PACKET_PACKET_SERVER_HPP_
+#define INCLUDE_COMM_PACKET_PACKET_SERVER_HPP_
+
+#include "common.hpp"
+#include "comm/packet/client_pool.hpp"
+#include "utils/utils.hpp"
+
+using namespace boost::asio;
+using boost::asio::ip::tcp;
+
+namespace repertory {
+class packet_server final {
+public:
+  typedef std::function<void(const std::string &clientId)> closed_callback;
+  typedef client_pool::worker_complete_callback message_complete_callback;
+  typedef std::function<void(const std::uint32_t &service_flags, const std::string &client_id,
+                             const std::uint64_t &thread_id, const std::string &method,
+                             packet *request, packet &response,
+                             message_complete_callback message_complete)>
+      message_handler_callback;
+
+public:
+  packet_server(const std::uint16_t &port, std::string token, std::uint8_t pool_size,
+                closed_callback closed, message_handler_callback message_handler);
+
+  ~packet_server();
+
+private:
+  struct connection {
+    connection(boost::asio::io_service &io_service, tcp::acceptor &acceptor)
+        : socket(io_service), acceptor(acceptor) {}
+
+    tcp::socket socket;
+    tcp::acceptor &acceptor;
+    std::vector<char> buffer;
+    std::string client_id;
+    std::string nonce;
+
+    void generate_nonce() { nonce = utils::generate_random_string(256u); }
+  };
+
+private:
+  const std::string encryption_token_;
+  closed_callback closed_;
+  message_handler_callback message_handler_;
+  boost::asio::io_context io_context_;
+  std::unique_ptr<std::thread> server_thread_;
+  std::vector<std::thread> service_threads_;
+  std::recursive_mutex connection_mutex_;
+  std::unordered_map<std::string, std::uint32_t> connection_lookup_;
+
+private:
+  void add_client(connection &c, const std::string &client_id);
+
+  void initialize(const uint16_t &port, uint8_t pool_size);
+
+  void listen_for_connection(tcp::acceptor &acceptor);
+
+  void on_accept(std::shared_ptr<connection> c, boost::system::error_code ec);
+
+  void read_header(std::shared_ptr<connection> c);
+
+  void read_packet(std::shared_ptr<connection> c, const std::uint32_t &data_size);
+
+  void remove_client(connection &c);
+
+  void send_response(std::shared_ptr<connection> c, const packet::error_type &result,
+                     packet &response);
+};
+} // namespace repertory
+
+#endif // INCLUDE_COMM_PACKET_PACKET_SERVER_HPP_