2.0.0-rc (#9)

### Issues * \#1 \[bug\] Unable to mount S3 due to 'item_not_found' exception * \#2 Require bucket name for S3 mounts * \#3 \[bug\] File size is not being updated in S3 mount * \#4 Upgrade to libfuse-3.x.x * \#5 Switch to renterd for Sia support * \#6 Switch to cpp-httplib to further reduce dependencies * \#7 Remove global_data and calculate used disk space per provider * \#8 Switch to libcurl for S3 mount support ### Changes from v1.x.x * Added read-only encrypt provider * Pass-through mount point that transparently encrypts source data using `XChaCha20-Poly1305` * Added S3 encryption support via `XChaCha20-Poly1305` * Added replay protection to remote mounts * Added support base64 writes in remote FUSE * Created static linked Linux binaries for `amd64` and `aarch64` using `musl-libc` * Removed legacy Sia renter support * Removed Skynet support * Fixed multiple remote mount WinFSP API issues on \*NIX servers * Implemented chunked read and write * Writes for non-cached files are performed in chunks of 8Mib * Removed `repertory-ui` support * Removed `FreeBSD` support * Switched to `libsodium` over `CryptoPP` * Switched to `XChaCha20-Poly1305` for remote mounts * Updated `GoogleTest` to v1.14.0 * Updated `JSON for Modern C++` to v3.11.2 * Updated `OpenSSL` to v1.1.1w * Updated `RocksDB` to v8.5.3 * Updated `WinFSP` to 2023 * Updated `boost` to v1.78.0 * Updated `cURL` to v8.3.0 * Updated `zlib` to v1.3 * Use `upload_manager` for all providers * Adds a delay to uploads to prevent excessive API calls * Supports re-upload after mount restart for incomplete uploads * NOTE: Uploads for all providers are full file (no resume support) * Multipart upload support is planned for S3 Reviewed-on: #9
2023-10-29 06:55:59 +00:00
parent 3ff46723b8
commit f43c41f88a
839 changed files with 98214 additions and 92959 deletions
--- a/include/providers/sia/sia_provider.hpp
+++ b/include/providers/sia/sia_provider.hpp
@ -1,136 +1,194 @@
 /*
-  Copyright <2018-2022> <scott.e.graves@protonmail.com>
+  Copyright <2018-2023> <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
+  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 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.
+  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_PROVIDERS_SIA_SIAPROVIDER_HPP_
-#define INCLUDE_PROVIDERS_SIA_SIAPROVIDER_HPP_
+#ifndef INCLUDE_PROVIDERS_SIA_SIA_PROVIDER_HPP_
+#define INCLUDE_PROVIDERS_SIA_SIA_PROVIDER_HPP_

-#include "common.hpp"
-#include "providers/base_provider.hpp"
+#include "providers/i_provider.hpp"
+#include "types/repertory.hpp"

 namespace repertory {
 class app_config;
-class i_comm;
-class sia_provider : public base_provider {
+class i_file_manager;
+class i_http_comm;
+
+class sia_provider : public i_provider {
 public:
-  sia_provider(app_config &config, i_comm &comm);
+  sia_provider(app_config &config, i_http_comm &comm);

  ~sia_provider() override = default;

 private:
-  i_comm &comm_;
-  std::uint64_t total_drive_space_ = 0u;
-  bool stop_requested_ = false;
-  std::mutex start_stop_mutex_;
-  std::condition_variable start_stop_notify_;
-  std::unique_ptr<std::thread> drive_space_thread_;
+  app_config &config_;
+  i_http_comm &comm_;

 private:
-  api_item_added_callback &get_api_item_added() { return api_item_added_; }
-
-  i_comm &get_comm() { return comm_; }
-
-  i_comm &get_comm() const { return comm_; } // TODO Fix non-const reference return
+  const std::string DB_NAME = "meta_db";
+  api_item_added_callback api_item_added_;
+  std::unique_ptr<rocksdb::DB> db_;
+  i_file_manager *fm_ = nullptr;

 private:
-  void calculate_total_drive_space();
+  [[nodiscard]] static auto create_api_file(std::string path,
+                                            std::uint64_t size) -> api_file;

-  api_error calculate_used_drive_space(std::uint64_t &used_space);
+  [[nodiscard]] static auto create_api_file(std::string path,
+                                            std::uint64_t size,
+                                            api_meta_map &meta) -> api_file;

-  void drive_space_thread();
+  [[nodiscard]] auto get_object_info(const std::string &api_path,
+                                     json &object_info) const -> api_error;

-  bool processed_orphaned_file(const std::string &source_path,
-                               const std::string &api_path = "") const;
+  [[nodiscard]] auto get_object_list(const std::string api_path,
+                                     nlohmann::json &object_list) const -> bool;

  void remove_deleted_files();

-  void remove_expired_orphaned_files();
-
-  void remove_unknown_source_files();
-
-protected:
-  api_error check_file_exists(const std::string &api_path) const;
-
-  bool check_directory_found(const json &error) const;
-
-  bool check_not_found(const json &error) const;
-
-  virtual void cleanup();
-
-  void create_api_file(const json &json_file, const std::string &path_name, api_file &file) const;
-
-  api_error get_directory(const std::string &api_path, json &result, json &error) const;
-
-  api_error notify_file_added(const std::string &api_path, const std::string &api_parent,
-                              const std::uint64_t &size) override;
-
-  void set_api_file_dates(const json &file, api_file &apiFile) const;
-
 public:
-  api_error create_directory(const std::string &api_path, const api_meta_map &meta) override;
+  [[nodiscard]] auto create_directory(const std::string &api_path,
+                                      api_meta_map &meta) -> api_error override;

-  std::uint64_t get_directory_item_count(const std::string &api_path) const override;
+  [[nodiscard]] auto
+  create_directory_clone_source_meta(const std::string &source_api_path,
+                                     const std::string &api_path)
+      -> api_error override;

-  api_error get_directory_items(const std::string &api_path,
-                                directory_item_list &list) const override;
+  [[nodiscard]] auto get_directory_item_count(const std::string &api_path) const
+      -> std::uint64_t override;

-  api_error get_file(const std::string &api_path, api_file &file) const override;
+  [[nodiscard]] auto create_file(const std::string &api_path,
+                                 api_meta_map &meta) -> api_error override;

-  api_error get_file_list(api_file_list &list) const override;
+  [[nodiscard]] auto get_api_path_from_source(const std::string &source_path,
+                                              std::string &api_path) const
+      -> api_error override;

-  api_error get_file_size(const std::string &api_path, std::uint64_t &file_size) const override;
+  [[nodiscard]] auto get_directory_items(const std::string &api_path,
+                                         directory_item_list &list) const
+      -> api_error override;

-  api_error get_filesystem_item(const std::string &api_path, const bool &directory,
-                                filesystem_item &fsi) const override;
+  [[nodiscard]] auto get_file(const std::string &api_path, api_file &file) const
+      -> api_error override;

-  api_error get_filesystem_item_and_file(const std::string &api_path, api_file &apiFile,
-                                         filesystem_item &fsi) const override;
+  [[nodiscard]] auto get_file_list(api_file_list &list) const
+      -> api_error override;

-  provider_type get_provider_type() const override { return provider_type::sia; }
+  [[nodiscard]] auto get_file_size(const std::string &api_path,
+                                   std::uint64_t &file_size) const
+      -> api_error override;

-  std::uint64_t get_total_drive_space() const override { return total_drive_space_; }
+  [[nodiscard]] auto get_filesystem_item(const std::string &api_path,
+                                         bool directory,
+                                         filesystem_item &fsi) const
+      -> api_error override;

-  std::uint64_t get_total_item_count() const override;
+  [[nodiscard]] auto get_filesystem_item_and_file(const std::string &api_path,
+                                                  api_file &f,
+                                                  filesystem_item &fsi) const
+      -> api_error override;

-  bool is_directory(const std::string &api_path) const override;
+  [[nodiscard]] auto
+  get_filesystem_item_from_source_path(const std::string &source_path,
+                                       filesystem_item &fsi) const
+      -> api_error override;

-  bool is_file(const std::string &api_path) const override;
+  [[nodiscard]] auto get_item_meta(const std::string &api_path,
+                                   api_meta_map &meta) const
+      -> api_error override;

-  bool is_online() const override;
+  [[nodiscard]] auto get_item_meta(const std::string &api_path,
+                                   const std::string &key,
+                                   std::string &value) const
+      -> api_error override;

-  bool is_rename_supported() const override { return true; }
+  [[nodiscard]] auto get_pinned_files() const
+      -> std::vector<std::string> override;

-  api_error read_file_bytes(const std::string &api_path, const std::size_t &size,
-                            const std::uint64_t &offset, std::vector<char> &buffer,
-                            const bool &stop_requested) override;
+  [[nodiscard]] auto get_provider_type() const -> provider_type override {
+    return provider_type::sia;
+  }

-  api_error remove_directory(const std::string &api_path) override;
+  [[nodiscard]] auto get_total_drive_space() const -> std::uint64_t override;

-  api_error remove_file(const std::string &api_path) override;
+  [[nodiscard]] auto get_total_item_count() const -> std::uint64_t override;

-  api_error rename_file(const std::string &from_api_path, const std::string &to_api_path) override;
+  [[nodiscard]] auto get_used_drive_space() const -> std::uint64_t override;

-  bool start(api_item_added_callback api_item_added, i_open_file_table *oft) override;
+  [[nodiscard]] auto is_direct_only() const -> bool override { return false; }
+
+  [[nodiscard]] auto is_directory(const std::string &api_path,
+                                  bool &exists) const -> api_error override;
+
+  [[nodiscard]] auto is_file(const std::string &api_path, bool &exists) const
+      -> api_error override;
+
+  [[nodiscard]] auto is_file_writeable(const std::string &api_path) const
+      -> bool override;
+
+  [[nodiscard]] auto is_online() const -> bool override;
+
+  [[nodiscard]] auto is_rename_supported() const -> bool override {
+    return false;
+  }
+
+  [[nodiscard]] auto read_file_bytes(const std::string &api_path,
+                                     std::size_t size, std::uint64_t offset,
+                                     data_buffer &buffer,
+                                     stop_type &stop_requested)
+      -> api_error override;
+
+  [[nodiscard]] auto remove_directory(const std::string &api_path)
+      -> api_error override;
+
+  [[nodiscard]] auto remove_file(const std::string &api_path)
+      -> api_error override;
+
+  [[nodiscard]] auto remove_item_meta(const std::string &api_path,
+                                      const std::string &key)
+      -> api_error override;
+
+  [[nodiscard]] auto rename_file(const std::string &from_api_path,
+                                 const std::string &to_api_path)
+      -> api_error override;
+
+  [[nodiscard]] auto set_item_meta(const std::string &api_path,
+                                   const std::string &key,
+                                   const std::string &value)
+      -> api_error override;
+
+  [[nodiscard]] auto set_item_meta(const std::string &api_path,
+                                   const api_meta_map &meta)
+      -> api_error override;
+
+  [[nodiscard]] auto start(api_item_added_callback api_item_added,
+                           i_file_manager *fm) -> bool override;

  void stop() override;

-  api_error upload_file(const std::string &api_path, const std::string &source_path,
-                        const std::string &) override;
+  [[nodiscard]] auto upload_file(const std::string &api_path,
+                                 const std::string &source_path,
+                                 const std::string & /* encryption_token */,
+                                 stop_type &stop_requested)
+      -> api_error override;
 };
 } // namespace repertory

-#endif // INCLUDE_PROVIDERS_SIA_SIAPROVIDER_HPP_
+#endif // INCLUDE_PROVIDERS_SIA_SIA_PROVIDER_HPP_