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

include/providers/base_provider.hpp

@@ -1,30 +1,34 @@
 /*
-  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_BASE_PROVIDER_HPP_
 #define INCLUDE_PROVIDERS_BASE_PROVIDER_HPP_
 
-#include "common.hpp"
 #include "db/meta_db.hpp"
 #include "providers/i_provider.hpp"
 
 namespace repertory {
 class app_config;
+class i_file_manager;
+
 class base_provider : public i_provider {
 public:
   explicit base_provider(app_config &config);
@@ -33,90 +37,168 @@ public:
 
 private:
   app_config &config_;
+  std::atomic<std::uint64_t> used_space_{0U};
 
 protected:
   api_item_added_callback api_item_added_;
-  meta_db meta_db_;
+  std::unique_ptr<meta_db> meta_db_;
   mutable std::recursive_mutex notify_added_mutex_;
-  i_open_file_table *oft_ = nullptr;
+  i_file_manager *fm_ = nullptr;
+  stop_type stop_requested_ = false;
 
 protected:
-  app_config &get_config() { return config_; }
+  void calculate_used_drive_space(bool add_missing);
 
-  app_config &get_config() const { return config_; }
+  [[nodiscard]] virtual auto
+  check_file_exists(const std::string &api_path) const -> api_error = 0;
 
-  virtual std::string format_api_path(std::string api_path) const { return api_path; }
+  void cleanup();
 
-  virtual std::string &restore_api_path(std::string &api_path) const { return api_path; }
+  [[nodiscard]] auto get_config() -> app_config & { return config_; }
 
-  void notify_directory_added(const std::string &api_path, const std::string &api_parent) const {
-    const_cast<base_provider *>(this)->notify_directory_added(api_path, api_parent);
+  [[nodiscard]] auto get_config() const -> app_config & { return config_; }
+
+  [[nodiscard]] virtual auto
+  handle_rename_file(const std::string &from_api_path,
+                     const std::string &to_api_path,
+                     const std::string &source_path) -> api_error = 0;
+
+  [[nodiscard]] auto notify_directory_added(const std::string &api_path,
+                                            const std::string &api_parent) const
+      -> api_error {
+    return const_cast<base_provider *>(this)->notify_directory_added(
+        api_path, api_parent);
   }
 
-  virtual void notify_directory_added(const std::string &api_path, const std::string &api_parent);
+  [[nodiscard]] virtual auto
+  notify_directory_added(const std::string &api_path,
+                         const std::string &api_parent) -> api_error;
 
-  api_error notify_file_added(const std::string &api_path, const std::string &api_parent,
-                              const std::uint64_t &size) const {
-    return const_cast<base_provider *>(this)->notify_file_added(api_path, api_parent, size);
+  [[nodiscard]] auto notify_file_added(const std::string &api_path,
+                                       const std::string &api_parent,
+                                       std::uint64_t size) const -> api_error {
+    return const_cast<base_provider *>(this)->notify_file_added(
+        api_path, api_parent, size);
   }
 
-  virtual api_error notify_file_added(const std::string &api_path, const std::string &api_parent,
-                                      const std::uint64_t &size) = 0;
+  [[nodiscard]] virtual auto notify_file_added(const std::string &api_path,
+                                               const std::string &api_parent,
+                                               std::uint64_t size)
+      -> api_error = 0;
 
-  void remove_item_meta(const std::string &api_path) {
-    return meta_db_.remove_item_meta(format_api_path(api_path));
+  [[nodiscard]] virtual auto
+  populate_directory_items(const std::string &api_path,
+                           directory_item_list &list) const -> api_error = 0;
+
+  [[nodiscard]] virtual auto populate_file(const std::string &api_path,
+                                           api_file &file) const
+      -> api_error = 0;
+
+  auto processed_orphaned_file(const std::string &source_path,
+                               const std::string &api_path = "") const -> bool;
+
+  void remove_deleted_files();
+
+  void remove_expired_orphaned_files();
+
+  void remove_unknown_source_files();
+
+  [[nodiscard]] auto remove_item_meta(const std::string &api_path)
+      -> api_error {
+    return meta_db_->remove_item_meta(api_path);
   }
 
-  void update_filesystem_item(const bool &directory, const api_error &error,
-                              const std::string &api_path, filesystem_item &fsi) const;
+  void update_filesystem_item(bool directory, const api_error &error,
+                              const std::string &api_path,
+                              filesystem_item &fsi) const;
 
 public:
-  api_error create_directory_clone_source_meta(const std::string &source_api_path,
-                                               const std::string &api_path) override;
+  [[nodiscard]] auto
+  create_directory_clone_source_meta(const std::string &source_api_path,
+                                     const std::string &api_path)
+      -> api_error override;
 
-  api_error create_file(const std::string &api_path, api_meta_map &meta) override;
+  [[nodiscard]] auto create_file(const std::string &api_path,
+                                 api_meta_map &meta) -> api_error override;
 
-  api_error get_api_path_from_source(const std::string &source_path,
-                                     std::string &api_path) 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_filesystem_item(const std::string &api_path, const bool &directory,
-                                filesystem_item &fsi) 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_and_file(const std::string &api_path, api_file &file,
-                                         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_from_source_path(const std::string &source_path,
-                                                 filesystem_item &fsi) const override;
+  [[nodiscard]] auto get_file_size(const std::string &api_path,
+                                   std::uint64_t &file_size) const
+      -> api_error override;
 
-  api_error get_item_meta(const std::string &api_path, api_meta_map &meta) const override;
+  [[nodiscard]] auto get_filesystem_item(const std::string &api_path,
+                                         bool directory,
+                                         filesystem_item &fsi) const
+      -> api_error override;
 
-  api_error get_item_meta(const std::string &api_path, const std::string &key,
-                          std::string &value) const override;
+  [[nodiscard]] auto get_filesystem_item_and_file(const std::string &api_path,
+                                                  api_file &file,
+                                                  filesystem_item &fsi) const
+      -> api_error override;
 
-  std::vector<std::string> get_pinned_files() const override { return meta_db_.get_pinned_files(); }
+  [[nodiscard]] auto
+  get_filesystem_item_from_source_path(const std::string &source_path,
+                                       filesystem_item &fsi) const
+      -> api_error override;
 
-  std::uint64_t get_used_drive_space() const override;
+  [[nodiscard]] auto get_item_meta(const std::string &api_path,
+                                   api_meta_map &meta) const
+      -> api_error override;
 
-  bool is_file_writeable(const std::string &) const override { return true; }
+  [[nodiscard]] auto get_item_meta(const std::string &api_path,
+                                   const std::string &key,
+                                   std::string &value) const
+      -> api_error override;
 
-  api_error remove_item_meta(const std::string &api_path, const std::string &key) override {
-    return meta_db_.remove_item_meta(format_api_path(api_path), key);
+  [[nodiscard]] auto get_pinned_files() const
+      -> std::vector<std::string> override {
+    return meta_db_->get_pinned_files();
   }
 
-  api_error set_item_meta(const std::string &api_path, const std::string &key,
-                          const std::string &value) override {
-    return meta_db_.set_item_meta(format_api_path(api_path), key, value);
+  [[nodiscard]] auto get_used_drive_space() const -> std::uint64_t override;
+
+  [[nodiscard]] auto is_file_writeable(const std::string &) const
+      -> bool override {
+    return true;
   }
 
-  api_error set_item_meta(const std::string &api_path, const api_meta_map &meta) override {
-    return meta_db_.set_item_meta(format_api_path(api_path), meta);
+  [[nodiscard]] auto remove_item_meta(const std::string &api_path,
+                                      const std::string &key)
+      -> api_error override {
+    return meta_db_->remove_item_meta(api_path, key);
   }
 
-  api_error set_source_path(const std::string &api_path, const std::string &source_path) override {
-    return meta_db_.set_source_path(format_api_path(api_path), source_path);
+  [[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 {
+    return meta_db_->set_item_meta(api_path, key, value);
   }
 
-  bool start(api_item_added_callback api_item_added, i_open_file_table *oft) override;
+  [[nodiscard]] auto set_item_meta(const std::string &api_path,
+                                   const api_meta_map &meta)
+      -> api_error override {
+    return meta_db_->set_item_meta(api_path, meta);
+  }
+
+  [[nodiscard]] auto start(api_item_added_callback api_item_added,
+                           i_file_manager *fm) -> bool override;
+
+  void stop() override;
 };
 } // namespace repertory