run_script.h

Go to the documentation of this file.

// Copyright (C) 2021-2025 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 RUN_SCRIPT_H
#define RUN_SCRIPT_H
 
#include <asiolink/process_spawn.h>
#include <dhcp/dhcp4.h>
#include <dhcp/dhcp6.h>
#include <dhcp/duid.h>
#include <dhcp/hwaddr.h>
#include <dhcp/option6_ia.h>
#include <dhcp/pkt4.h>
#include <dhcp/pkt6.h>
#include <dhcpsrv/lease.h>
#include <dhcpsrv/subnet.h>
#include <hooks/library_handle.h>
#include <hooks/hooks_parser.h>
#include <string>
 
namespace isc {
namespace run_script {

class RunScriptImpl {
public:
    RunScriptImpl();

    ~RunScriptImpl() = default;

    static void extractBoolean(isc::asiolink::ProcessEnvVars& vars,
                               const bool value,
                               const std::string& prefix = "",
                               const std::string& suffix = "");

    static void extractInteger(isc::asiolink::ProcessEnvVars& vars,
                               const uint64_t value,
                               const std::string& prefix = "",
                               const std::string& suffix = "");

    static void extractString(isc::asiolink::ProcessEnvVars& vars,
                              const std::string& value,
                              const std::string& prefix = "",
                              const std::string& suffix = "");

    static void extractHWAddr(isc::asiolink::ProcessEnvVars& vars,
                              const isc::dhcp::HWAddrPtr& hwaddr,
                              const std::string& prefix = "",
                              const std::string& suffix = "");

    static void extractClientId(isc::asiolink::ProcessEnvVars& vars,
                                const isc::dhcp::ClientIdPtr client_id,
                                const std::string& prefix = "",
                                const std::string& suffix = "");

    static void extractDUID(isc::asiolink::ProcessEnvVars& vars,
                            const isc::dhcp::DuidPtr duid,
                            const std::string& prefix = "",
                            const std::string& suffix = "");

    static void extractOption(isc::asiolink::ProcessEnvVars& vars,
                              const isc::dhcp::OptionPtr option,
                              const std::string& prefix = "",
                              const std::string& suffix = "");

    static void extractSubOption(isc::asiolink::ProcessEnvVars& vars,
                                 const isc::dhcp::OptionPtr option,
                                 uint16_t code,
                                 const std::string& prefix = "",
                                 const std::string& suffix = "");

    static void extractOptionIA(isc::asiolink::ProcessEnvVars& vars,
                                const isc::dhcp::Option6IAPtr option6IA,
                                const std::string& prefix = "",
                                const std::string& suffix = "");

    static void extractSubnet4(isc::asiolink::ProcessEnvVars& vars,
                               const isc::dhcp::ConstSubnet4Ptr subnet4,
                               const std::string& prefix = "",
                               const std::string& suffix = "");

    static void extractSubnet6(isc::asiolink::ProcessEnvVars& vars,
                               const isc::dhcp::ConstSubnet6Ptr subnet6,
                               const std::string& prefix = "",
                               const std::string& suffix = "");

    static void extractLease4(isc::asiolink::ProcessEnvVars& vars,
                              const isc::dhcp::Lease4Ptr& lease4,
                              const std::string& prefix = "",
                              const std::string& suffix = "");

    static void extractLease6(isc::asiolink::ProcessEnvVars& vars,
                              const isc::dhcp::Lease6Ptr& lease6,
                              const std::string& prefix = "",
                              const std::string& suffix = "");

    static void extractLeases4(isc::asiolink::ProcessEnvVars& vars,
                               const isc::dhcp::Lease4CollectionPtr& leases4,
                               const std::string& prefix = "",
                               const std::string& suffix = "");

    static void extractLeases6(isc::asiolink::ProcessEnvVars& vars,
                               const isc::dhcp::Lease6CollectionPtr& leases6,
                               const std::string& prefix = "",
                               const std::string& suffix = "");

    static void extractPkt4(isc::asiolink::ProcessEnvVars& vars,
                            const isc::dhcp::Pkt4Ptr& pkt4,
                            const std::string& prefix = "",
                            const std::string& suffix = "");

    static void extractPkt6(isc::asiolink::ProcessEnvVars& vars,
                            const isc::dhcp::Pkt6Ptr& pkt6,
                            const std::string& prefix = "",
                            const std::string& suffix = "");

    void runScript(const isc::asiolink::ProcessArgs& args,
                   const isc::asiolink::ProcessEnvVars& vars);

    void setName(const std::string& name) {
        isc::hooks::HookLibraryScriptsChecker::validatePath(name);
        name_ = name;
    }

    std::string getName() const {
        return (name_);
    }

    void setSync(const bool sync) {
        sync_ = sync;
    }

    bool getSync() const {
        return (sync_);
    }

    void configure(isc::hooks::LibraryHandle& handle);
 
private:

    isc::asiolink::IOServicePtr io_context_;

    std::string name_;

    bool sync_;
};

typedef boost::shared_ptr<RunScriptImpl> RunScriptImplPtr;
 
} // namespace run_script
} // namespace isc
#endif