diff --git a/include/transport/Config.h b/include/transport/Config.h new file mode 100644 index 0000000000000000000000000000000000000000..97044a1d66ec0a0b0d858e529662e33b02a9f0f7 --- /dev/null +++ b/include/transport/Config.h @@ -0,0 +1,144 @@ +/** + * libtransport -- C++ library for easy XMPP Transports development + * + * Copyright (C) 2011, Jan Kaluza + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA + */ + +#pragma once + +#include +#include +#include +#include +#include +#include +#include + +namespace Transport { + +template +const myType &safeAs(const boost::program_options::variable_value &var, const myType &def) { + try { + return var.as(); + } + catch(...) { + return def; + } +} + +} + +#define CONFIG_HAS_KEY(PTR, KEY) (*PTR).hasKey(KEY) +#define CONFIG_STRING(PTR, KEY) (*PTR)[KEY].as() +#define CONFIG_INT(PTR, KEY) (*PTR)[KEY].as() +#define CONFIG_BOOL(PTR, KEY) (*PTR)[KEY].as() +#define CONFIG_LIST(PTR, KEY) (*PTR)[KEY].as >() +#define CONFIG_VECTOR(PTR, KEY) ((*PTR).hasKey(KEY) ? (*PTR)[KEY].as >() : std::vector()) + +#define CONFIG_STRING_DEFAULTED(PTR, KEY, DEF) ((*PTR).hasKey(KEY) ? Transport::safeAs((*PTR)[KEY], DEF) : DEF) +#define CONFIG_BOOL_DEFAULTED(PTR, KEY, DEF) ((*PTR).hasKey(KEY) ? Transport::safeAs((*PTR)[KEY], DEF) : DEF) +#define CONFIG_LIST_DEFAULTED(PTR, KEY, DEF) ((*PTR).hasKey(KEY) ? Transport::safeAs >((*PTR)[KEY], DEF) : DEF) +#define CONFIG_INT_DEFAULTED(PTR, KEY, DEF) ((*PTR).hasKey(KEY) ? Transport::safeAs((*PTR)[KEY], DEF) : DEF) + +namespace Transport { + +/// Represents variable:value pairs. +typedef boost::program_options::variables_map Variables; + +/// Represents config file. + +/// It's used to load config file and allows others parts of libtransport to be configured +/// properly. Config files are text files which use "ini" format. Variables are divided into multiple +/// sections. Every class is configurable with some variables which change its behavior. Check particular +/// class documentation to get a list of all relevant variables for that class. +class Config { + public: + typedef std::map SectionValuesCont; + typedef std::map UnregisteredCont; + + /// Constructor. + Config(int argc = 0, char **argv = NULL) : m_argc(argc), m_argv(argv) {} + + /// Destructor + virtual ~Config() {} + + /// Loads data from config file. + + /// You can pass your extra options which will be recognized by + /// the parser using opts parameter. + /// \param configfile path to config file + /// \param opts extra options which will be recognized by a parser + bool load(const std::string &configfile, boost::program_options::options_description &opts, const std::string &jid = ""); + + bool load(std::istream &ifs, boost::program_options::options_description &opts, const std::string &jid = ""); + + bool load(std::istream &ifs); + + /// Loads data from config file. + + /// This function loads only config variables needed by libtransport. + /// \see load(const std::string &, boost::program_options::options_description &) + /// \param configfile path to config file + bool load(const std::string &configfile, const std::string &jid = ""); + + bool reload(); + + bool hasKey(const std::string &key) { + return (m_variables.find(key) != m_variables.end() || m_unregistered.find(key) != m_unregistered.end() + || m_backendConfig.find(key) != m_backendConfig.end()); + } + + /// Returns value of variable defined by key. + + /// For variables in sections you can use "section.variable" key format. + /// \param key config variable name + const boost::program_options::variable_value &operator[] (const std::string &key) { + if (m_variables.find(key) != m_variables.end()) { + return m_variables[key]; + } + if (m_backendConfig.find(key) != m_backendConfig.end()) { + return m_backendConfig[key]; + } + return m_unregistered[key]; + } + + SectionValuesCont getSectionValues(const std::string& sectionName); + + std::string getCommandLineArgs() const; + + /// Returns path to config file from which data were loaded. + const std::string &getConfigFile() { return m_file; } + + /// This signal is emitted when config is loaded/reloaded. + boost::signal onConfigReloaded; + + void updateBackendConfig(const std::string &backendConfig); + boost::signal onBackendConfigUpdated; + + static Config *createFromArgs(int argc, char **argv, std::string &error, std::string &host, int &port); + + private: + int m_argc; + char **m_argv; + Variables m_variables; + Variables m_backendConfig; + std::map m_unregistered; + std::string m_file; + std::string m_jid; +}; + +}