Create management portal in Flutter (#40)

Reviewed-on: #40

repertory/librepertory/include/app_config.hpp

@@ -52,6 +52,8 @@ public:
   [[nodiscard]] static auto get_provider_name(const provider_type &prov)
       -> std::string;
 
+  [[nodiscard]] static auto get_root_data_directory() -> std::string;
+
 public:
   [[nodiscard]] static auto get_stop_requested() -> bool;
 

repertory/librepertory/include/rpc/common.hpp

@@ -0,0 +1,82 @@
+/*
+  Copyright <2018-2025> <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 REPERTORY_INCLUDE_RPC_COMMON_HPP_
+#define REPERTORY_INCLUDE_RPC_COMMON_HPP_
+
+#include "utils/base64.hpp"
+#include "utils/error_utils.hpp"
+#include "utils/string.hpp"
+
+namespace repertory::rpc {
+[[nodiscard]] auto check_authorization(const auto &cfg,
+                                       const httplib::Request &req) -> bool {
+  REPERTORY_USES_FUNCTION_NAME();
+
+  if (cfg.get_api_auth().empty() || cfg.get_api_user().empty()) {
+    utils::error::raise_error(function_name,
+                              "authorization user or password is not set");
+    return false;
+  }
+
+  auto authorization = req.get_header_value("Authorization");
+  if (authorization.empty()) {
+    utils::error::raise_error(function_name,
+                              "'Authorization' header is not set");
+    return false;
+  }
+
+  auto auth_parts = utils::string::split(authorization, ' ', true);
+  if (auth_parts.empty()) {
+    utils::error::raise_error(function_name, "'Authorization' header is empty");
+    return false;
+  }
+
+  auto auth_type = auth_parts[0U];
+  if (auth_type != "Basic") {
+    utils::error::raise_error(function_name,
+                              "authorization type is not 'Basic'");
+    return false;
+  }
+
+  auto data = macaron::Base64::Decode(authorization.substr(6U));
+  auto auth_str = std::string(data.begin(), data.end());
+
+  auto auth = utils::string::split(auth_str, ':', false);
+  if (auth.size() < 2U) {
+    utils::error::raise_error(function_name, "authorization data is not valid");
+    return false;
+  }
+
+  auto user = auth.at(0U);
+  auth.erase(auth.begin());
+
+  auto pwd = utils::string::join(auth, ':');
+  if ((user != cfg.get_api_user()) || (pwd != cfg.get_api_auth())) {
+    utils::error::raise_error(function_name, "authorization failed");
+    return false;
+  }
+
+  return true;
+}
+} // namespace repertory::rpc
+
+#endif // REPERTORY_INCLUDE_RPC_COMMON_HPP_

repertory/librepertory/include/rpc/server/server.hpp

@@ -40,8 +40,6 @@ private:
   std::mutex start_stop_mutex_;
 
 private:
-  [[nodiscard]] auto check_authorization(const httplib::Request &req) -> bool;
-
   void handle_get_config(const httplib::Request &req, httplib::Response &res);
 
   void handle_get_config_value_by_name(const httplib::Request &req,

repertory/librepertory/include/types/repertory.hpp

@@ -38,6 +38,7 @@ constexpr const auto default_retry_read_count{6U};
 constexpr const auto default_ring_buffer_file_size{512U};
 constexpr const auto default_task_wait_ms{100U};
 constexpr const auto default_timeout_ms{60000U};
+constexpr const auto default_ui_mgmt_port{std::uint16_t{30000U}};
 constexpr const auto max_ring_buffer_file_size{std::uint16_t(1024U)};
 constexpr const auto max_s3_object_name_length{1024U};
 constexpr const auto min_cache_size_bytes{
@@ -280,6 +281,8 @@ enum class exit_code : std::int32_t {
   pin_failed = -16,
   unpin_failed = -17,
   init_failed = -18,
+  ui_mount_failed = -19,
+  exception = -20,
 };
 
 enum http_error_codes : std::int32_t {
@@ -304,6 +307,13 @@ enum class provider_type : std::size_t {
   unknown,
 };
 
+[[nodiscard]] auto
+provider_type_from_string(std::string_view type,
+                          provider_type default_type = provider_type::unknown)
+    -> provider_type;
+
+[[nodiscard]] auto provider_type_to_string(provider_type type) -> std::string;
+
 #if defined(_WIN32)
 struct open_file_data final {
   PVOID directory_buffer{nullptr};
@@ -487,6 +497,7 @@ inline constexpr const auto JSON_MAX_UPLOAD_COUNT{"MaxUploadCount"};
 inline constexpr const auto JSON_MED_FREQ_INTERVAL_SECS{
     "MedFreqIntervalSeconds"};
 inline constexpr const auto JSON_META{"Meta"};
+inline constexpr const auto JSON_MOUNT_LOCATIONS{"MountLocations"};
 inline constexpr const auto JSON_ONLINE_CHECK_RETRY_SECS{
     "OnlineCheckRetrySeconds"};
 inline constexpr const auto JSON_PATH{"Path"};

repertory/librepertory/include/utils/cli_utils.hpp

@@ -49,6 +49,8 @@ static const option password_option = {"-pw", "--password"};
 static const option remote_mount_option = {"-rm", "--remote_mount"};
 static const option set_option = {"-set", "--set"};
 static const option status_option = {"-status", "--status"};
+static const option ui_option = {"-ui", "--ui"};
+static const option ui_port_option = {"-up", "--ui_port"};
 static const option unmount_option = {"-unmount", "--unmount"};
 static const option unpin_file_option = {"-uf", "--unpin_file"};
 static const option user_option = {"-us", "--user"};
@@ -75,6 +77,8 @@ static const std::vector<option> option_list = {
     remote_mount_option,
     set_option,
     status_option,
+    ui_option,
+    ui_port_option,
     unmount_option,
     unpin_file_option,
     user_option,
@@ -87,26 +91,27 @@ void get_api_authentication_data(std::string &user, std::string &password,
                                  std::uint16_t &port, const provider_type &prov,
                                  const std::string &data_directory);
 
-[[nodiscard]] auto
-get_provider_type_from_args(std::vector<const char *> args) -> provider_type;
+[[nodiscard]] auto get_provider_type_from_args(std::vector<const char *> args)
+    -> provider_type;
 
 [[nodiscard]] auto has_option(std::vector<const char *> args,
                               const std::string &option_name) -> bool;
 
-[[nodiscard]] auto has_option(std::vector<const char *> args,
-                              const option &opt) -> bool;
+[[nodiscard]] auto has_option(std::vector<const char *> args, const option &opt)
+    -> bool;
 
 [[nodiscard]] auto parse_option(std::vector<const char *> args,
                                 const std::string &option_name,
                                 std::uint8_t count) -> std::vector<std::string>;
 
 [[nodiscard]] auto parse_string_option(std::vector<const char *> args,
-                                       const option &opt,
-                                       std::string &value) -> exit_code;
+                                       const option &opt, std::string &value)
+    -> exit_code;
 
-[[nodiscard]] auto
-parse_drive_options(std::vector<const char *> args, provider_type &prov,
-                    std::string &data_directory) -> std::vector<std::string>;
+[[nodiscard]] auto parse_drive_options(std::vector<const char *> args,
+                                       provider_type &prov,
+                                       std::string &data_directory)
+    -> std::vector<std::string>;
 } // namespace repertory::utils::cli
 
 #endif // REPERTORY_INCLUDE_UTILS_CLI_UTILS_HPP_

repertory/librepertory/src/app_config.cpp

@@ -699,36 +699,37 @@ auto app_config::default_api_port(const provider_type &prov) -> std::uint16_t {
   return PROVIDER_API_PORTS.at(static_cast<std::size_t>(prov));
 }
 
-auto app_config::default_data_directory(const provider_type &prov)
-    -> std::string {
+auto app_config::get_root_data_directory() -> std::string {
 #if defined(_WIN32)
-  auto data_directory =
-      utils::path::combine(utils::get_local_app_data_directory(),
-                           {
-                               REPERTORY_DATA_NAME,
-                               app_config::get_provider_name(prov),
-                           });
+  auto data_directory = utils::path::combine(
+      utils::get_local_app_data_directory(), {
+                                                 REPERTORY_DATA_NAME,
+                                             });
 #else // !defined(_WIN32)
 #if defined(__APPLE__)
-  auto data_directory =
-      utils::path::combine("~", {
-                                    "Library",
-                                    "Application Support",
-                                    REPERTORY_DATA_NAME,
-                                    app_config::get_provider_name(prov),
-                                });
+  auto data_directory = utils::path::combine("~", {
+                                                      "Library",
+                                                      "Application Support",
+                                                      REPERTORY_DATA_NAME,
+                                                  });
 #else  // !defined(__APPLE__)
-  auto data_directory =
-      utils::path::combine("~", {
-                                    ".local",
-                                    REPERTORY_DATA_NAME,
-                                    app_config::get_provider_name(prov),
-                                });
+  auto data_directory = utils::path::combine("~", {
+                                                      ".local",
+                                                      REPERTORY_DATA_NAME,
+                                                  });
 #endif // defined(__APPLE__)
 #endif // defined(_WIN32)
   return data_directory;
 }
 
+auto app_config::default_data_directory(const provider_type &prov)
+    -> std::string {
+  return utils::path::combine(app_config::get_root_data_directory(),
+                              {
+                                  app_config::get_provider_name(prov),
+                              });
+}
+
 auto app_config::default_remote_api_port(const provider_type &prov)
     -> std::uint16_t {
   static const std::array<std::uint16_t,
@@ -741,6 +742,7 @@ auto app_config::default_remote_api_port(const provider_type &prov)
       };
   return PROVIDER_REMOTE_PORTS.at(static_cast<std::size_t>(prov));
 }
+
 auto app_config::default_rpc_port(const provider_type &prov) -> std::uint16_t {
   static const std::array<std::uint16_t,
                           static_cast<std::size_t>(provider_type::unknown)>

repertory/librepertory/src/rpc/server/server.cpp

@@ -28,6 +28,7 @@
 #include "events/types/service_stop_begin.hpp"
 #include "events/types/service_stop_end.hpp"
 #include "events/types/unmount_requested.hpp"
+#include "rpc/common.hpp"
 #include "utils/base64.hpp"
 #include "utils/error_utils.hpp"
 #include "utils/string.hpp"
@@ -35,54 +36,6 @@
 namespace repertory {
 server::server(app_config &config) : config_(config) {}
 
-auto server::check_authorization(const httplib::Request &req) -> bool {
-  REPERTORY_USES_FUNCTION_NAME();
-
-  if (config_.get_api_auth().empty() || config_.get_api_user().empty()) {
-    utils::error::raise_error(function_name,
-                              "authorization user or password is not set");
-    return false;
-  }
-
-  auto authorization = req.get_header_value("Authorization");
-  if (authorization.empty()) {
-    utils::error::raise_error(function_name, "Authorization header is not set");
-    return false;
-  }
-
-  auto auth_parts = utils::string::split(authorization, ' ', true);
-  if (auth_parts.empty()) {
-    utils::error::raise_error(function_name, "Authorization header is empty");
-    return false;
-  }
-
-  auto auth_type = auth_parts[0U];
-  if (auth_type != "Basic") {
-    utils::error::raise_error(function_name, "Authorization is not Basic");
-    return false;
-  }
-
-  auto data = macaron::Base64::Decode(authorization.substr(6U));
-  auto auth_str = std::string(data.begin(), data.end());
-
-  auto auth = utils::string::split(auth_str, ':', false);
-  if (auth.size() < 2U) {
-    utils::error::raise_error(function_name, "Authorization is not valid");
-    return false;
-  }
-
-  auto user = auth.at(0U);
-  auth.erase(auth.begin());
-
-  auto pwd = utils::string::join(auth, ':');
-  if ((user != config_.get_api_user()) || (pwd != config_.get_api_auth())) {
-    utils::error::raise_error(function_name, "Authorization failed");
-    return false;
-  }
-
-  return true;
-}
-
 void server::handle_get_config(const httplib::Request & /*req*/,
                                httplib::Response &res) {
   auto data = config_.get_json();
@@ -173,7 +126,7 @@ void server::start() {
 
   server_->set_pre_routing_handler(
       [this](auto &&req, auto &&res) -> httplib::Server::HandlerResponse {
-        if (check_authorization(req)) {
+        if (rpc::check_authorization(config_, req)) {
           return httplib::Server::HandlerResponse::Unhandled;
         }
 

repertory/librepertory/src/types/repertory.cpp

@@ -21,6 +21,7 @@
 */
 #include "types/repertory.hpp"
 
+#include "app_config.hpp"
 #include "types/startup_exception.hpp"
 #include "utils/string.hpp"
 
@@ -191,4 +192,34 @@ auto api_error_to_string(const api_error &error) -> const std::string & {
 
   return LOOKUP.at(error);
 }
+
+auto provider_type_from_string(std::string_view type,
+                               provider_type default_type) -> provider_type {
+  auto type_lower = utils::string::to_lower(std::string{type});
+  if (type_lower == "encrypt") {
+    return provider_type::encrypt;
+  }
+
+  if (type_lower == "remote") {
+    return provider_type::remote;
+  }
+
+  if (type_lower == "s3") {
+    return provider_type::s3;
+  }
+
+  if (type_lower == "sia") {
+    return provider_type::sia;
+  }
+
+  if (type_lower == "unknown") {
+    return provider_type::unknown;
+  }
+
+  return default_type;
+}
+
+auto provider_type_to_string(provider_type type) -> std::string {
+  return app_config::get_provider_name(type);
+}
 } // namespace repertory