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 8560c362a0
commit dc410bfe5b
839 changed files with 98214 additions and 92959 deletions
--- a/src/db/meta_db.cpp
+++ b/src/db/meta_db.cpp
@@ -1,24 +1,29 @@
 /*
-  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.
 */
 #include "db/meta_db.hpp"
+
 #include "types/repertory.hpp"
 #include "types/startup_exception.hpp"
+#include "utils/error_utils.hpp"
 #include "utils/file_utils.hpp"
 #include "utils/path_utils.hpp"
 #include "utils/utils.hpp"
@@ -27,84 +32,85 @@ namespace repertory {
 meta_db::meta_db(const app_config &config) {
  const auto create_resources = [this, &config](const std::string &name) {
    auto families = std::vector<rocksdb::ColumnFamilyDescriptor>();
-    families.emplace_back(rocksdb::ColumnFamilyDescriptor{rocksdb::kDefaultColumnFamilyName,
-                                                          rocksdb::ColumnFamilyOptions()});
-    families.emplace_back(
-        rocksdb::ColumnFamilyDescriptor{"source", rocksdb::ColumnFamilyOptions()});
-    families.emplace_back(rocksdb::ColumnFamilyDescriptor{"keys", rocksdb::ColumnFamilyOptions()});
+    families.emplace_back(rocksdb::kDefaultColumnFamilyName,
+                          rocksdb::ColumnFamilyOptions());
+    families.emplace_back("keys", rocksdb::ColumnFamilyOptions());
+    families.emplace_back("source", rocksdb::ColumnFamilyOptions());

    auto handles = std::vector<rocksdb::ColumnFamilyHandle *>();
    utils::db::create_rocksdb(config, name, families, handles, db_);
-    default_family_.reset(handles[0u]);
-    source_family_.reset(handles[1u]);
-    keys_family_.reset(handles[2u]);
+
+    std::size_t idx{};
+    default_family_ = handles[idx++];
+    keys_family_ = handles[idx++];
+    source_family_ = handles[idx++];
  };
+
  create_resources(METADB_NAME);
 }

-meta_db::~meta_db() { release_resources(); }
+meta_db::~meta_db() { db_.reset(); }

-void meta_db::release_resources() {
-  default_family_.reset();
-  source_family_.reset();
-  keys_family_.reset();
-  db_.reset();
+auto meta_db::create_iterator(bool source_family) const
+    -> std::shared_ptr<rocksdb::Iterator> {
+  return std::shared_ptr<rocksdb::Iterator>(
+      db_->NewIterator(rocksdb::ReadOptions(),
+                       source_family ? source_family_ : default_family_));
 }

-std::shared_ptr<rocksdb::Iterator> meta_db::create_iterator(const bool &source_family) {
-  return std::shared_ptr<rocksdb::Iterator>(db_->NewIterator(
-      rocksdb::ReadOptions(), source_family ? source_family_.get() : default_family_.get()));
-}
-
-api_error meta_db::get_api_path_from_key(const std::string &key, std::string &api_path) const {
-  auto ret = api_error::item_not_found;
-  if (not key.empty()) {
-    if (db_->Get(rocksdb::ReadOptions(), keys_family_.get(), key, &api_path).ok()) {
-      ret = api_error::success;
-    }
+auto meta_db::get_api_path_from_key(const std::string &key,
+                                    std::string &api_path) const -> api_error {
+  if (key.empty()) {
+    return api_error::item_not_found;
  }

-  return ret;
+  return perform_action(__FUNCTION__, [&]() -> rocksdb::Status {
+    return db_->Get(rocksdb::ReadOptions(), keys_family_, key, &api_path);
+  });
 }

-api_error meta_db::get_api_path_from_source(const std::string &source_path,
-                                            std::string &api_path) const {
-  auto ret = api_error::item_not_found;
-  if (not source_path.empty()) {
-    if (db_->Get(rocksdb::ReadOptions(), source_family_.get(), source_path, &api_path).ok()) {
-      ret = api_error::success;
-    }
+auto meta_db::get_api_path_from_source(const std::string &source_path,
+                                       std::string &api_path) const
+    -> api_error {
+  if (source_path.empty()) {
+    return api_error::item_not_found;
  }

-  return ret;
+  return perform_action(__FUNCTION__, [&]() -> rocksdb::Status {
+    return db_->Get(rocksdb::ReadOptions(), source_family_, source_path,
+                    &api_path);
+  });
 }

-api_error meta_db::get_item_meta_json(const std::string &api_path, json &json_data) const {
-  auto ret = api_error::item_not_found;
-
+auto meta_db::get_item_meta_json(const std::string &api_path,
+                                 json &json_data) const -> api_error {
  std::string value;
-  if (db_->Get(rocksdb::ReadOptions(), default_family_.get(), api_path, &value).ok()) {
-    json_data = json::parse(value);
-    ret = api_error::success;
+  const auto res = perform_action(__FUNCTION__, [&]() -> rocksdb::Status {
+    return db_->Get(rocksdb::ReadOptions(), default_family_, api_path, &value);
+  });
+  if (res != api_error::success) {
+    return res;
  }

-  return ret;
+  json_data = json::parse(value);
+  return api_error::success;
 }

-api_error meta_db::get_item_meta(const std::string &api_path, api_meta_map &meta) const {
+auto meta_db::get_item_meta(const std::string &api_path,
+                            api_meta_map &meta) const -> api_error {
  json json_data;
  const auto ret = get_item_meta_json(api_path, json_data);
  if (ret == api_error::success) {
    for (auto it = json_data.begin(); it != json_data.end(); it++) {
-      meta.insert({it.key(), it.value().get<std::string>()});
+      meta[it.key()] = it.value().get<std::string>();
    }
  }

  return ret;
 }

-api_error meta_db::get_item_meta(const std::string &api_path, const std::string &key,
-                                 std::string &value) const {
+auto meta_db::get_item_meta(const std::string &api_path, const std::string &key,
+                            std::string &value) const -> api_error {
  json json_data;
  const auto ret = get_item_meta_json(api_path, json_data);
  if (ret == api_error::success) {
@@ -116,20 +122,21 @@ api_error meta_db::get_item_meta(const std::string &api_path, const std::string
  return ret;
 }

-bool meta_db::get_item_meta_exists(const std::string &api_path) const {
+auto meta_db::get_item_meta_exists(const std::string &api_path) const -> bool {
  std::string value;
  return db_->Get(rocksdb::ReadOptions(), api_path, &value).ok();
 }

-std::vector<std::string> meta_db::get_pinned_files() const {
+auto meta_db::get_pinned_files() const -> std::vector<std::string> {
  std::vector<std::string> ret;

  auto iterator = const_cast<meta_db *>(this)->create_iterator(false);
  for (iterator->SeekToFirst(); iterator->Valid(); iterator->Next()) {
    auto api_path = iterator->key().ToString();
    std::string pinned;
-    get_item_meta(api_path, META_PINNED, pinned);
-    if (not pinned.empty() && utils::string::to_bool(pinned)) {
+    const auto res = get_item_meta(api_path, META_PINNED, pinned);
+    if ((res == api_error::success) && not pinned.empty() &&
+        utils::string::to_bool(pinned)) {
      ret.emplace_back(api_path);
    }
  }
@@ -137,96 +144,154 @@ std::vector<std::string> meta_db::get_pinned_files() const {
  return ret;
 }

-bool meta_db::get_source_path_exists(const std::string &sourceFilePath) const {
+auto meta_db::get_source_path_exists(const std::string &source_path) const
+    -> bool {
  std::string value;
-  return db_->Get(rocksdb::ReadOptions(), source_family_.get(), sourceFilePath, &value).ok();
+  return db_->Get(rocksdb::ReadOptions(), source_family_, source_path, &value)
+      .ok();
 }

-void meta_db::remove_item_meta(const std::string &api_path) {
-  std::string source;
-  get_item_meta(api_path, META_SOURCE, source);
+auto meta_db::perform_action(
+    const std::string &function_name,
+    const std::function<rocksdb::Status()> &action) const -> api_error {
+  const auto res = action();
+  if (res.ok()) {
+    return api_error::success;
+  }

-  std::string key;
-  get_item_meta(api_path, META_SOURCE, key);
+  if (not res.IsNotFound()) {
+    utils::error::raise_error(function_name, res.ToString());
+  }

-  db_->Delete(rocksdb::WriteOptions(), source_family_.get(), source);
-  db_->Delete(rocksdb::WriteOptions(), default_family_.get(), api_path);
-  db_->Delete(rocksdb::WriteOptions(), keys_family_.get(), key);
+  return res.IsNotFound() ? api_error::item_not_found : api_error::error;
 }

-api_error meta_db::remove_item_meta(const std::string &api_path, const std::string &key) {
+auto meta_db::get_total_item_count() const -> std::uint64_t {
+  std::uint64_t ret = 0u;
+  auto iter = create_iterator(false);
+  for (iter->SeekToFirst(); iter->Valid(); iter->Next()) {
+    ret++;
+  }
+
+  return ret;
+}
+
+auto meta_db::remove_item_meta(const std::string &api_path) -> api_error {
  json json_data;
-  auto ret = get_item_meta_json(api_path, json_data);
+  auto res = get_item_meta_json(api_path, json_data);
+  if (res != api_error::success) {
+    return res == api_error::item_not_found ? api_error::success : res;
+  }

-  if (ret == api_error::success) {
-    if ((key == META_KEY) && not json_data[META_KEY].empty()) {
-      db_->Delete(rocksdb::WriteOptions(), keys_family_.get(),
-                  json_data[META_KEY].get<std::string>());
+  if (not json_data[META_KEY].empty()) {
+    if ((res = perform_action(__FUNCTION__, [&]() -> rocksdb::Status {
+           return db_->Delete(rocksdb::WriteOptions(), keys_family_,
+                              json_data[META_KEY].get<std::string>());
+         })) != api_error::success) {
+      return res;
    }
-
-    json_data.erase(key);
-    ret = db_->Put(rocksdb::WriteOptions(), default_family_.get(), api_path, json_data.dump()).ok()
-              ? api_error::success
-              : api_error::error;
  }

-  return ret;
+  if (not json_data[META_SOURCE].empty()) {
+    if ((res = perform_action(__FUNCTION__, [&]() -> rocksdb::Status {
+           return db_->Delete(rocksdb::WriteOptions(), source_family_,
+                              json_data[META_SOURCE].get<std::string>());
+         })) != api_error::success) {
+      return res;
+    }
+  }
+
+  return perform_action(__FUNCTION__, [&]() -> rocksdb::Status {
+    return db_->Delete(rocksdb::WriteOptions(), default_family_, api_path);
+  });
 }

-api_error meta_db::rename_item_meta(const std::string &source_path,
-                                    const std::string &from_api_path,
-                                    const std::string &to_api_path) {
-  auto ret = api_error::success;
-
-  std::string key;
-  get_item_meta(from_api_path, META_KEY, key);
-
-  if (not key.empty()) {
-    remove_item_meta(from_api_path, META_KEY);
-  }
-
-  std::string value;
-  if (db_->Get(rocksdb::ReadOptions(), default_family_.get(), from_api_path, &value).ok()) {
-    db_->Delete(rocksdb::WriteOptions(), default_family_.get(), from_api_path);
-    db_->Put(rocksdb::WriteOptions(), default_family_.get(), to_api_path, value);
-  }
-
-  if (not key.empty()) {
-    set_item_meta(to_api_path, META_KEY, key);
-  }
-
-  db_->Put(rocksdb::WriteOptions(), source_family_.get(), source_path, to_api_path);
-  return ret;
-}
-
-api_error meta_db::set_item_meta(const std::string &api_path, const std::string &key,
-                                 const std::string &value) {
-  if (key == META_KEY) {
-    remove_item_meta(api_path, META_KEY);
-  }
-
+auto meta_db::remove_item_meta(const std::string &api_path,
+                               const std::string &key) -> api_error {
  json json_data;
-  get_item_meta_json(api_path, json_data);
-
-  json_data[key] = value;
-
-  auto ret =
-      db_->Put(rocksdb::WriteOptions(), default_family_.get(), api_path, json_data.dump()).ok()
-          ? api_error::success
-          : api_error::error;
-  if ((key == META_KEY) && (ret == api_error::success)) {
-    ret = db_->Put(rocksdb::WriteOptions(), keys_family_.get(), value, api_path).ok()
-              ? api_error::success
-              : api_error::error;
+  auto res = get_item_meta_json(api_path, json_data);
+  if (res != api_error::success) {
+    return res == api_error::item_not_found ? api_error::success : res;
  }

-  return ret;
+  if ((key == META_KEY) && not json_data[META_KEY].empty()) {
+    if ((res = perform_action(__FUNCTION__, [&]() -> rocksdb::Status {
+           return db_->Delete(rocksdb::WriteOptions(), keys_family_,
+                              json_data[META_KEY].get<std::string>());
+         })) != api_error::success) {
+      return res;
+    }
+  }
+
+  if ((key == META_SOURCE) && not json_data[META_SOURCE].empty()) {
+    if ((res = perform_action(__FUNCTION__, [&]() -> rocksdb::Status {
+           return db_->Delete(rocksdb::WriteOptions(), source_family_,
+                              json_data[META_SOURCE].get<std::string>());
+         })) != api_error::success) {
+      return res;
+    }
+  }
+
+  json_data.erase(key);
+  return perform_action(__FUNCTION__, [&]() -> rocksdb::Status {
+    return db_->Put(rocksdb::WriteOptions(), default_family_, api_path,
+                    json_data.dump());
+  });
 }

-api_error meta_db::set_item_meta(const std::string &api_path, const api_meta_map &meta) {
+auto meta_db::rename_item_meta(const std::string &source_path,
+                               const std::string &from_api_path,
+                               const std::string &to_api_path) -> api_error {
+  api_meta_map meta{};
+  auto res = get_item_meta(from_api_path, meta);
+  if (res != api_error::success) {
+    return res;
+  }
+
+  if ((res = remove_item_meta(from_api_path)) != api_error::success) {
+    return res;
+  }
+
+  if (not source_path.empty()) {
+    meta[META_SOURCE] = source_path;
+  }
+
+  return set_item_meta(to_api_path, meta);
+}
+
+auto meta_db::set_item_meta(const std::string &api_path, const std::string &key,
+                            const std::string &value) -> api_error {
+  if (key == META_SOURCE) {
+    return set_source_path(api_path, value);
+  }
+
+  if (key == META_KEY) {
+    const auto res = remove_item_meta(api_path, META_KEY);
+    if ((res != api_error::success) && (res != api_error::item_not_found)) {
+      return res;
+    }
+  }
+
+  auto res = store_item_meta(api_path, key, value);
+  if (res != api_error::success) {
+    return res;
+  }
+
+  if (key == META_KEY) {
+    return perform_action(__FUNCTION__, [&]() -> rocksdb::Status {
+      return db_->Put(rocksdb::WriteOptions(), keys_family_, value, api_path);
+    });
+  }
+
+  return api_error::success;
+}
+
+auto meta_db::set_item_meta(const std::string &api_path,
+                            const api_meta_map &meta) -> api_error {
  auto ret = api_error::success;
  auto it = meta.begin();
-  for (std::size_t i = 0u; (ret == api_error::success) && (i < meta.size()); i++) {
+  for (std::size_t i = 0u; (ret == api_error::success) && (i < meta.size());
+       i++) {
    ret = set_item_meta(api_path, it->first, it->second);
    it++;
  }
@@ -234,18 +299,49 @@ api_error meta_db::set_item_meta(const std::string &api_path, const api_meta_map
  return ret;
 }

-api_error meta_db::set_source_path(const std::string &api_path, const std::string &source_path) {
+auto meta_db::set_source_path(const std::string &api_path,
+                              const std::string &source_path) -> api_error {
  std::string current_source_path;
-  get_item_meta(api_path, META_SOURCE, current_source_path);
+  auto res = get_item_meta(api_path, META_SOURCE, current_source_path);
+  if ((res != api_error::success) && (res != api_error::item_not_found)) {
+    return res;
+  }
+
+  // TODO multiple db ops should be in transaction
  if (not current_source_path.empty()) {
-    db_->Delete(rocksdb::WriteOptions(), source_family_.get(), current_source_path);
+    if ((res = perform_action(__FUNCTION__, [&]() -> rocksdb::Status {
+           return db_->Delete(rocksdb::WriteOptions(), source_family_,
+                              current_source_path);
+         })) != api_error::success) {
+      return res;
+    }
  }

-  auto ret = set_item_meta(api_path, META_SOURCE, source_path);
-  if (ret == api_error::success) {
-    db_->Put(rocksdb::WriteOptions(), source_family_.get(), source_path, api_path);
+  if (not source_path.empty()) {
+    if ((res = perform_action(__FUNCTION__, [&]() -> rocksdb::Status {
+           return db_->Put(rocksdb::WriteOptions(), source_family_, source_path,
+                           api_path);
+         })) != api_error::success) {
+      return res;
+    }
  }

-  return ret;
+  return store_item_meta(api_path, META_SOURCE, source_path);
+}
+
+auto meta_db::store_item_meta(const std::string &api_path,
+                              const std::string &key, const std::string &value)
+    -> api_error {
+  json json_data;
+  auto res = get_item_meta_json(api_path, json_data);
+  if ((res != api_error::success) && (res != api_error::item_not_found)) {
+    return res;
+  }
+
+  json_data[key] = value;
+  return perform_action(__FUNCTION__, [&]() -> rocksdb::Status {
+    return db_->Put(rocksdb::WriteOptions(), default_family_, api_path,
+                    json_data.dump());
+  });
 }
 } // namespace repertory