repertory/include/providers/s3/s3_provider.hpp

/*
  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
  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_PROVIDERS_S3_S3_PROVIDER_HPP_
#define INCLUDE_PROVIDERS_S3_S3_PROVIDER_HPP_
#if defined(REPERTORY_ENABLE_S3)

#include "providers/base_provider.hpp"
#include "types/repertory.hpp"

namespace repertory {
class app_config;
class i_file_manager;
class i_http_comm;
struct head_object_result;

class s3_provider final : public base_provider {
public:
  s3_provider(app_config &config, i_http_comm &comm);

  ~s3_provider() override = default;

public:
  s3_provider(const s3_provider &) = delete;
  s3_provider(s3_provider &&) = delete;
  auto operator=(const s3_provider &) -> s3_provider & = delete;
  auto operator=(s3_provider &&) -> s3_provider & = delete;

private:
  [[nodiscard]] auto add_if_not_found(api_file &file,
                                      const std::string &object_name) const
      -> api_error;

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

  [[nodiscard]] auto create_path_directories(const std::string &api_path,
                                             const std::string &key) const
      -> api_error;

  [[nodiscard]] auto decrypt_object_name(std::string &object_name) const
      -> api_error;

  [[nodiscard]] auto
  get_object_info(bool directory, const std::string &api_path,
                  bool &is_encrypted, std::string &object_name,
                  head_object_result &result) const -> api_error;

  [[nodiscard]] auto
  get_object_list(std::string &response_data, long &response_code,
                  std::optional<std::string> delimiter = std::nullopt,
                  std::optional<std::string> prefix = std::nullopt) const
      -> bool;

protected:
  [[nodiscard]] auto create_directory_impl(const std::string &api_path,
                                           api_meta_map &meta)
      -> api_error override;

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

  [[nodiscard]] auto get_used_drive_space_impl() const
      -> std::uint64_t override;

  [[nodiscard]] auto remove_directory_impl(const std::string &api_path)
      -> api_error override;

  [[nodiscard]] auto remove_file_impl(const std::string &api_path)
      -> api_error override;

  [[nodiscard]] auto upload_file_impl(const std::string &api_path,
                                      const std::string &source_path,
                                      stop_type &stop_requested)
      -> api_error override;

public:
  [[nodiscard]] auto get_directory_item_count(const std::string &api_path) const
      -> std::uint64_t override;

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

  [[nodiscard]] auto get_file_list(api_file_list &list) const
      -> api_error override;

  [[nodiscard]] auto get_total_drive_space() const -> std::uint64_t override;

  [[nodiscard]] auto get_provider_type() const -> provider_type override {
    return provider_type::s3;
  }

  [[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_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 &data,
                                     stop_type &stop_requested)
      -> api_error override;

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

  [[nodiscard]] auto start(api_item_added_callback api_item_added,
                           i_file_manager *mgr) -> bool override;

  void stop() override;
};
} // namespace repertory

#endif // REPERTORY_ENABLE_S3
#endif // INCLUDE_PROVIDERS_S3_S3_PROVIDER_HPP_