source: vbox/trunk/src/VBox/NetworkServices/Dhcpd/Config.h@ 79514

/* $Id: Config.h 79514 2019-07-04 08:01:58Z vboxsync $ */
/** @file
 * DHCP server - server configuration
 */

/*
 * Copyright (C) 2017-2019 Oracle Corporation
 *
 * This file is part of VirtualBox Open Source Edition (OSE), as
 * available from http://www.virtualbox.org. This file is free software;
 * you can redistribute it and/or modify it under the terms of the GNU
 * General Public License (GPL) as published by the Free Software
 * Foundation, in version 2 as it comes in the "COPYING" file of the
 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 */

#ifndef VBOX_INCLUDED_SRC_Dhcpd_Config_h
#define VBOX_INCLUDED_SRC_Dhcpd_Config_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif

#include <iprt/types.h>
#include <iprt/net.h>
#include <iprt/cpp/xml.h>
#include <iprt/cpp/ministring.h>

#include <VBox/intnet.h>


#include "Defs.h"
#include "DhcpOptions.h"
#include "ClientId.h"


class Config
{
    /** XXX: TODO: also store fixed address assignments, etc? */
    typedef std::map<RTMAC, optmap_t> vmmap_t;

    RTCString m_strHome;   /* path of ~/.VirtualBox or equivalent */

    RTCString m_strNetwork;
    RTCString m_strBaseName; /* m_strNetwork sanitized to be usable in a path component */

    RTCString m_strTrunk;
    INTNETTRUNKTYPE m_enmTrunkType;

    RTMAC m_MacAddress;

    RTNETADDRIPV4 m_IPv4Address;
    RTNETADDRIPV4 m_IPv4Netmask;

    RTNETADDRIPV4 m_IPv4PoolFirst;
    RTNETADDRIPV4 m_IPv4PoolLast;

    optmap_t m_GlobalOptions;
    vmmap_t m_VMMap;

private:
    Config();

    int init();
    int homeInit();
    int logInit();
    int complete();

public: /* factory methods */
    static Config *hardcoded();                   /* for testing */
    static Config *create(int argc, char **argv); /* --config */
    static Config *compat(int argc, char **argv); /* old VBoxNetDHCP flags */

public: /* accessors */
    const RTCString &getHome() const { return m_strHome; }

    const RTCString &getNetwork() const { return m_strNetwork; }
    void setNetwork(const RTCString &aStrNetwork);

    const RTCString &getBaseName() const { return m_strBaseName; }
    const RTCString &getTrunk() const { return m_strTrunk; }
    INTNETTRUNKTYPE getTrunkType() const { return m_enmTrunkType; }

    const RTMAC &getMacAddress() const { return m_MacAddress; }

    RTNETADDRIPV4 getIPv4Address() const { return m_IPv4Address; }
    RTNETADDRIPV4 getIPv4Netmask() const { return m_IPv4Netmask; }

    RTNETADDRIPV4 getIPv4PoolFirst() const { return m_IPv4PoolFirst; }
    RTNETADDRIPV4 getIPv4PoolLast() const { return m_IPv4PoolLast; }

public:
    optmap_t getOptions(const OptParameterRequest &reqOpts, const ClientId &id,
                        const OptVendorClassId &vendor = OptVendorClassId()) const;

private:
    static Config *read(const char *pszFileName);
    void parseConfig(const xml::ElementNode *root);
    void parseServer(const xml::ElementNode *server);
    void parseGlobalOptions(const xml::ElementNode *options);
    void parseVMConfig(const xml::ElementNode *config);
    void parseOption(const xml::ElementNode *option, optmap_t &optmap);

    int parseMACAddress(RTMAC &aMac, const RTCString &aStr);
    int parseClientId(OptClientId &aId, const RTCString &aStr);

    void sanitizeBaseName();
};

#endif /* !VBOX_INCLUDED_SRC_Dhcpd_Config_h */