1 files changed, 101 insertions, 0 deletions
diff --git a/src/lib/dhcpsrv/cb_ctl_dhcp.h b/src/lib/dhcpsrv/cb_ctl_dhcp.h
new file mode 100644
index 0000000..fb686ad
--- /dev/null
+++ b/src/lib/dhcpsrv/cb_ctl_dhcp.h
@@ -0,0 +1,101 @@
+// Copyright (C) 2019-2024 Internet Systems Consortium, Inc. ("ISC")
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+#ifndef CB_CTL_DHCP_H
+#define CB_CTL_DHCP_H
+
+#include <cc/stamped_value.h>
+#include <process/cb_ctl_base.h>
+#include <dhcpsrv/srv_config.h>
+
+namespace isc {
+namespace dhcp {
+
+/// @brief Base class for implementing mechanisms to control the use
+/// of the Configuration Backends by DHCPv4 and DHCPv6 servers.
+///
+/// It includes common methods used by the DHCPv4 and DHCPv6 specific
+/// derivations.
+///
+/// @tparam ConfigBackendMgrType Type of the Config Backend Manager used
+/// by the server implementing this class. For example, for the DHCPv4
+/// server it will be @c ConfigBackendDHCPv4Mgr.
+template<typename ConfigBackendMgrType>
+class CBControlDHCP : public process::CBControlBase<ConfigBackendMgrType> {
+public:
+
+    /// @brief Constructor.
+    CBControlDHCP()
+        : process::CBControlBase<ConfigBackendMgrType>() {
+    }
+
+    /// @brief It translates the top level map parameters from flat naming
+    /// format (e.g. param-name.sub-param-name) to the respective param-name and
+    /// sub-param-name. If the name does not contain '.', the param-name will
+    /// contain the initial name.
+    ///
+    /// @param name The name in flat format (e.g. map-name.element-name).
+    /// @param[out] param_name The resulting top level param name.
+    /// @param[out] sub_param_name The resulting sub param name inside the map.
+    ///
+    /// @return The function returns true if any conversion is done, false
+    /// otherwise.
+    static bool translateName(std::string const& name, std::string& param_name,
+                              std::string& sub_param_name) {
+        param_name = name;
+        sub_param_name = std::string();
+        auto pos = param_name.find('.');
+        if (pos != std::string::npos) {
+            sub_param_name = param_name.substr(pos + 1);
+            param_name = param_name.substr(0, pos);
+            return (true);
+        }
+        return (false);
+    }
+
+protected:
+
+    /// @brief It translates the top level map parameters from flat naming
+    /// format (e.g. param-name.sub-param-name) to proper ElementMap objects and
+    /// adds all globals fetched from config backend(s) to a SrvConfig instance
+    ///
+    /// Iterates over the given collection of global parameters and adds them to
+    /// the given configuration's list of configured globals.
+    ///
+    ///
+    /// @param external_cfg SrvConfig instance to update
+    /// @param cb_globals collection of global parameters supplied by configuration
+    /// backend
+    void translateAndAddGlobalsToConfig(SrvConfigPtr external_cfg,
+                                        data::StampedValueCollection& cb_globals) const {
+        auto const& index = cb_globals.get<data::StampedValueNameIndexTag>();
+        for (auto const& cb_global : index) {
+
+            if (cb_global->amNull()) {
+                continue;
+            }
+
+            std::string param_name;
+            std::string sub_param_name;
+            if (translateName(cb_global->getName(), param_name, sub_param_name)) {
+                data::ElementPtr sub_param = boost::const_pointer_cast<data::Element>(external_cfg->getConfiguredGlobal(param_name));
+                if (!sub_param) {
+                    sub_param = data::Element::createMap();
+                }
+                sub_param->set(sub_param_name, cb_global->getElementValue());
+                external_cfg->addConfiguredGlobal(param_name, sub_param);
+            } else {
+                // Reuse name and value.
+                external_cfg->addConfiguredGlobal(param_name, cb_global->getElementValue());
+            }
+        }
+    }
+};
+
+} // end of namespace isc::dhcp
+} // end of namespace isc
+
+#endif // CB_CTL_DHCP_H