move config files to player profile dir (#304)

Author: hyperblast

ChangeLog.md

@@ -7,6 +7,8 @@
 - Allow to limit client operations (e.g. playlist modification)
 - Fix various issues in API documentation
 - Fix view height initialization on mobile browsers
+- BREAKING CHANGE: no longer use .dll/.so directory or "beefweb" directory in user profile for configuration files,
+use "beefweb" directory in player profile instead. Existing config files will be copied to new location.
 ### foobar2000
 - Add support for custom volume controls (e.g. for foo_out_upnp)
 

cpp/server/browser_controller.cpp

@@ -71,11 +71,10 @@ ResponsePtr BrowserController::getRoots()
 
     for (auto& dir : settings_->musicDirs)
     {
-        auto path = pathFromUtf8(dir);
-        auto info = file_io::tryQueryInfo(path);
+        auto info = file_io::tryQueryInfo(dir);
 
         if (info && info->type == FileType::DIRECTORY)
-            roots.emplace_back(makeFsEntry(path, path, *info));
+            roots.emplace_back(makeFsEntry(dir, dir, *info));
     }
 
     return Response::json({ {"roots", roots}, {"pathSeparator", pathSeparator()} });
@@ -87,15 +86,14 @@ ResponsePtr BrowserController::getEntries()
     auto normalizedPath = pathFromUtf8(requestedPath).lexically_normal().make_preferred();
 
     if (!settings_->isAllowedPath(normalizedPath))
-        return Response::error(HttpStatus::S_403_FORBIDDEN);
+        return Response::error(HttpStatus::S_403_FORBIDDEN, "listing directory is not allowed");
 
     std::vector<FileSystemEntry> entries;
+    boost::system::error_code ec;
 
-    for (auto iter = fs::directory_iterator(normalizedPath);
-         iter != fs::directory_iterator();
-         ++iter)
+    for (auto& entry : fs::directory_iterator(normalizedPath, ec))
     {
-        auto& path = iter->path();
+        auto& path = entry.path();
         auto info = file_io::tryQueryInfo(path);
 
         if (info && info->type != FileType::UNKNOWN)

cpp/server/client_config_controller.cpp

@@ -5,8 +5,8 @@
 
 namespace msrv {
 
-ClientConfigController::ClientConfigController(Request* request, SettingsDataPtr settings, const char* appName)
-    : ControllerBase(request), settings_(std::move(settings)), appName_(appName)
+ClientConfigController::ClientConfigController(Request* request, SettingsDataPtr settings)
+    : ControllerBase(request), settings_(std::move(settings))
 {
 }
 
@@ -49,25 +49,19 @@ Path ClientConfigController::getFilePath()
     auto id = param<std::string>("id");
 
     if (!std::regex_match(id, idPattern))
-    {
         throw InvalidRequestException("invalid configuration id: " + id);
-    }
 
-    auto configDir = SettingsData::getConfigDir(appName_);
-    if (configDir.empty())
-    {
-        throw std::runtime_error("No config dir is available");
-    }
+    if (settings_->clientConfigDir.empty())
+        throw OperationForbiddenException();
 
-    return configDir / MSRV_PATH_LITERAL("clientconfig") / pathFromUtf8(id + ".json");
+    return settings_->clientConfigDir / pathFromUtf8(id + ".json");
 }
 
-void ClientConfigController::defineRoutes(
-    Router* router, WorkQueue* workQueue, SettingsDataPtr settings, const char* appName)
+void ClientConfigController::defineRoutes(Router* router, WorkQueue* workQueue, SettingsDataPtr settings)
 {
     auto routes = router->defineRoutes<ClientConfigController>();
 
-    routes.createWith([=](Request* r) { return new ClientConfigController(r, settings, appName); });
+    routes.createWith([=](Request* r) { return new ClientConfigController(r, settings); });
     routes.useWorkQueue(workQueue);
     routes.setPrefix("api/clientconfig");
 

cpp/server/client_config_controller.hpp

@@ -11,14 +11,14 @@ class Router;
 class ClientConfigController : public ControllerBase
 {
 public:
-    ClientConfigController(Request* request, SettingsDataPtr settings, const char* appName);
+    ClientConfigController(Request* request, SettingsDataPtr settings);
     ~ClientConfigController() = default;
 
     ResponsePtr getConfig();
     void setConfig();
     void removeConfig();
 
-    static void defineRoutes(Router* router, WorkQueue* workQueue, SettingsDataPtr settings, const char* appName);
+    static void defineRoutes(Router* router, WorkQueue* workQueue, SettingsDataPtr settings);
 
 private:
     Path getFilePath();
@@ -29,7 +29,6 @@ class ClientConfigController : public ControllerBase
     }
 
     SettingsDataPtr settings_;
-    const char* appName_;
 };
 
 }

cpp/server/deadbeef/plugin.cpp

@@ -46,6 +46,9 @@ void Plugin::handleConfigChanged()
 void Plugin::handlePluginsLoaded()
 {
     pluginsLoaded_ = true;
+
+    SettingsData::migrate(MSRV_PLAYER_DEADBEEF, getProfileDir());
+
     refreshSettings();
     reconfigure();
 }
@@ -56,13 +59,13 @@ void Plugin::reconfigure()
 
     settings->port = port_;
     settings->allowRemote = allowRemote_;
-    settings->musicDirs = parseValueList<std::string>(musicDirs_, ';');
+    settings->musicDirsStr = parseValueList<std::string>(musicDirs_, ';');
     settings->authRequired = authRequired_;
     settings->authUser = authUser_;
     settings->authPassword = authPassword_;
     settings->permissions = permissions_;
 
-    settings->loadAll(MSRV_PLAYER_DEADBEEF);
+    settings->initialize(getProfileDir());
 
     host_.reconfigure(std::move(settings));
 }

cpp/server/deadbeef/plugin.hpp

@@ -32,6 +32,11 @@ class Plugin
 private:
     static ApiPermissions getPermissionsFromConfig();
 
+    static Path getProfileDir()
+    {
+        return {ddbApi->get_system_dir(DDB_SYS_DIR_CONFIG)};
+    }
+
     void handleConfigChanged();
     void handlePluginsLoaded();
     bool refreshSettings();

cpp/server/foobar2000/plugin.cpp

@@ -5,8 +5,7 @@
 
 #include <memory>
 
-namespace msrv {
-namespace player_foobar2000 {
+namespace msrv::player_foobar2000 {
 
 Plugin::Plugin()
     : player_(),
@@ -22,19 +21,29 @@ Plugin::~Plugin()
     current_ = nullptr;
 }
 
+Path Plugin::getProfileDir()
+{
+    const char* path = core_api::get_profile_path();
+
+    if (strncmp(path, "file://", 7) == 0)
+        path = path + 7;
+
+    return pathFromUtf8(path);
+}
+
 void Plugin::reconfigure()
 {
     auto settings = std::make_shared<SettingsData>();
 
     settings->port = settings_store::port;
     settings->allowRemote = settings_store::allowRemote;
-    settings->musicDirs = settings_store::getMusicDirs();
+    settings->musicDirsStr = settings_store::getMusicDirs();
     settings->authRequired = settings_store::authRequired;
     settings->authUser = settings_store::authUser;
     settings->authPassword = settings_store::authPassword;
     settings->permissions = settings_store::getPermissions();
 
-    settings->loadAll(MSRV_PLAYER_FOOBAR2000);
+    settings->initialize(getProfileDir());
 
     host_.reconfigure(std::move(settings));
 }
@@ -49,12 +58,13 @@ class InitQuit : public initquit
     void on_init() override
     {
         Logger::setCurrent(&logger_);
+        SettingsData::migrate(MSRV_PLAYER_FOOBAR2000, Plugin::getProfileDir());
         tryCatchLog([this] { plugin_ = std::make_unique<Plugin>(); });
     }
 
     void on_quit() override
     {
-        tryCatchLog([this] { plugin_.reset(); });
+        plugin_.reset();
         Logger::setCurrent(nullptr);
     }
 
@@ -78,4 +88,3 @@ VALIDATE_COMPONENT_FILENAME(MSRV_FOOBAR2000_FILE);
 }
 
 }
-}

cpp/server/foobar2000/plugin.hpp

@@ -7,8 +7,7 @@
 #include "../settings.hpp"
 #include "../server_host.hpp"
 
-namespace msrv {
-namespace player_foobar2000 {
+namespace msrv::player_foobar2000 {
 
 class Plugin
 {
@@ -23,6 +22,8 @@ class Plugin
 
     void reconfigure();
 
+    static Path getProfileDir();
+
 private:
     static Plugin* current_;
 
@@ -33,4 +34,3 @@ class Plugin
 };
 
 }
-}

cpp/server/project_info.hpp

@@ -7,8 +7,10 @@
 #define MSRV_PROJECT_NAME       "Beefweb Remote Control"
 #define MSRV_WEB_ROOT           "beefweb.root"
 #define MSRV_3RD_PARTY_LICENSES "third-party-licenses.txt"
-#define MSRV_CONFIG_FILE        "beefweb.config.json"
+#define MSRV_CONFIG_FILE        "config.json"
+#define MSRV_CONFIG_FILE_OLD    "beefweb.config.json"
 #define MSRV_CONFIG_FILE_ENV    "BEEFWEB_CONFIG_FILE"
+#define MSRV_CLIENT_CONFIG_DIR  "clientconfig"
 #define MSRV_PROJECT_DESC       "Provides web UI and HTTP API for controlling player remotely"
 #define MSRV_PROJECT_URL        "https://github.com/hyperblast/beefweb/"
 #define MSRV_DONATE_URL         "https://hyperblast.org/donate/"

cpp/server/server_host.cpp

@@ -64,7 +64,7 @@ void ServerHost::reconfigure(SettingsDataPtr settings)
 
     BrowserController::defineRoutes(router, &utilityQueue_, settings);
     StaticController::defineRoutes(router, &utilityQueue_, settings, contentTypes_);
-    ClientConfigController::defineRoutes(router, &utilityQueue_, settings, player_->name());
+    ClientConfigController::defineRoutes(router, &utilityQueue_, settings);
 
     serverThread_->restart(std::move(config));
 }