feat: plugins config

src/slic3r/plugin/PluginConfig.hpp

@@ -0,0 +1,117 @@
+#pragma once
+
+#include <libslic3r/Utils.hpp>
+#include <boost/filesystem.hpp>
+#include <nlohmann/json.hpp>
+#include <slic3r/plugin/PluginFsUtils.hpp>
+#include <map>
+#include <mutex>
+#include <string>
+#include <utility>
+
+#define PLUGIN_CONFIG_DIR "config.json"
+
+namespace pybind11 {
+    class module_;
+}
+
+namespace Slic3r {
+
+/*
+Example config.json shape
+{
+    "config": [
+        {
+            "plugin_key": "some_name",
+            "capability": "capability_name",
+            "plugin_version": "1.0.0",
+            "cap_config": {
+                "some": "plugin",
+                "capability": "specific",
+                "stuff": "here"
+            }
+        },
+        {
+            "plugin_key": "some_name",
+            "capability": "capability_name",
+            "plugin_version": "1.0.0",
+            "cap_config": {
+                "some": "plugin",
+                "capability": "specific",
+                "stuff": "here"
+            }
+        },
+        {
+            "plugin_key": "some_name",
+            "capability": "capability_name",
+            "plugin_version": "1.0.0",
+            "cap_config": {
+                "some": "plugin",
+                "capability": "specific",
+                "stuff": "here"
+            }
+        },
+    ]
+}
+*/
+
+struct BaseConfig {
+    std::string plugin_key;
+    std::string capability_name;
+    std::string plugin_version;
+
+    nlohmann::json config;
+
+    // True for the default-constructed instance returned by get_config() on a miss.
+    bool empty() const { return plugin_key.empty() || capability_name.empty(); }
+};
+
+// Consolidated store for every plugin capability's configuration, persisted as a single
+// config.json alongside the installed plugins. The shape of `cap_config` belongs to the
+// plugin; this class only round-trips it.
+//
+// A capability is identified by (plugin_key, capability_name). `plugin_version` is metadata
+// recording which version last wrote the entry, letting an upgraded plugin spot a stale
+// config and migrate it. Version is deliberately not part of the identity, so upgrading a
+// plugin does not silently reset the user's settings.
+//
+// Plugin code runs on worker threads, so every entry point is mutex-guarded.
+class PluginConfig
+{
+public:
+    static const std::string plugin_config_file() { return (boost::filesystem::path(get_orca_plugins_dir()) / PLUGIN_CONFIG_DIR).string(); }
+
+    // Replaces the in-memory store with what is on disk. A missing or malformed file leaves
+    // the store empty rather than throwing: a bad plugin config must not block startup.
+    void load();
+
+    // Rewrites config.json atomically. Clears the dirty flag only once the file is in place.
+    void save();
+
+    void save_config(const std::string& plugin_key, const std::string& capability_name, const std::string& version, const nlohmann::json& config);
+    void save_config(const BaseConfig& config);
+
+    // Parses `config` as a JSON document, storing nothing and returning false if it is
+    // malformed. Spelled differently from save_config() on purpose: nlohmann::json converts
+    // implicitly from const char*, so a `save_config(..., "{}")` overload pair would be
+    // ambiguous, and a raw string would silently store as a JSON string rather than an object.
+    bool save_config_text(const std::string& plugin_key, const std::string& capability_name, const std::string& version, const std::string& config);
+
+    // Returns a default-constructed BaseConfig (see BaseConfig::empty) when the capability has
+    // no stored config.
+    BaseConfig get_config(const std::string& plugin_key, const std::string& capability_name) const;
+    bool has_config(const std::string& plugin_key, const std::string& capability_name) const;
+
+    bool dirty() const;
+
+    static void RegisterBindings(pybind11::module_& module);
+
+private:
+    // (plugin_key, capability_name) -> entry. Ordered, so config.json serializes stably.
+    using CapabilityId = std::pair<std::string, std::string>;
+
+    mutable std::mutex m_mutex;
+    std::map<CapabilityId, BaseConfig> m_storage;
+    bool m_dirty = false;
+};
+} // namespace Slic3r