Configuration.cpp

/*
 * Configuration.cpp
 *
 *  Created on: 13.12.2017
 *      Author: Michael Ott (original), Micha Mueller
 */

#include "Configuration.h"
#include <string>
#include <unistd.h>
#include <dlfcn.h>

#include <boost/foreach.hpp>
#include <boost/property_tree/info_parser.hpp>
#include <boost/algorithm/string.hpp>

using namespace std;

Configuration::Configuration(const std::string& cfgFilePath) :
		_cfgFilePath(cfgFilePath) {

	if (_cfgFilePath[_cfgFilePath.length()-1] != '/') {
		_cfgFilePath.append("/");
	}

	//set default values for global variables
	_global.validateConfig = false;
	_global.qosLevel = 1;
	_global.daemonize = false;
	_global.hierarchy = "";
	_global.brokerHost = "";
	_global.brokerPort = 1883;
	_global.threads	   = 1;
	_global.maxMsgNum  = 0;
	_global.maxInflightMsgNum = 20;
	_global.maxQueuedMsgNum = 0;
	_global.logLevelFile = boost::log::trivial::trace;
	_global.logLevelCmd  = boost::log::trivial::info;

	_global.pluginSettings.sensorPattern = "";
	_global.pluginSettings.mqttPrefix	= "";
	_global.pluginSettings.tempdir		= "./";
	_global.pluginSettings.cacheInterval = 900000;

	_global.restAPISettings.restHost	= "";
	_global.restAPISettings.restPort	= "8000";
}

Configuration::~Configuration() {
	//close plugins
	for (auto p : _plugins) {
		if (p.configurator) {
			p.destroy(p.configurator);
		}
		if (p.DL) {
			dlclose(p.DL);
		}
	}
}

bool Configuration::readGlobal() {
	//open file
	std::string globalConfig = _cfgFilePath;
	globalConfig.append("dcdbpusher.conf");

	boost::property_tree::iptree cfg;
	//parse to property_tree
	try {
		boost::property_tree::read_info(globalConfig, cfg);
	} catch (boost::property_tree::info_parser_error& e) {
		LOG(error) << "Error when reading dcdbpusher.conf: " << e.what();
		return false;
	}

	//read global struct
	BOOST_FOREACH(boost::property_tree::iptree::value_type &global, cfg.get_child("global")) {
		if (boost::iequals(global.first, "mqttBroker")) {
			_global.brokerHost = global.second.data();
			size_t pos = _global.brokerHost.find(":");
			if (pos != string::npos) {
				_global.brokerPort = stoi(_global.brokerHost.substr(pos+1));
				_global.brokerHost.erase(pos);
			}
		} else if (boost::iequals(global.first, "mqttprefix")) {
			_global.pluginSettings.mqttPrefix = global.second.data();
			if (_global.pluginSettings.mqttPrefix[_global.pluginSettings.mqttPrefix.length()-1] != '/') {
				_global.pluginSettings.mqttPrefix.append("/");
			}
		} else if (boost::iequals(global.first, "sensorpattern")) {
			_global.pluginSettings.sensorPattern = global.second.data();
		} else if (boost::iequals(global.first, "hierarchy")) {
			_global.hierarchy = global.second.data();
		} else if (boost::iequals(global.first, "tempdir")) {
			_global.pluginSettings.tempdir = global.second.data();
			if (_global.pluginSettings.tempdir[_global.pluginSettings.tempdir.length()-1] != '/') {
				_global.pluginSettings.tempdir.append("/");
			}
		} else if (boost::iequals(global.first, "qosLevel")) {
			_global.qosLevel = stoi(global.second.data());
			if(_global.qosLevel < 0 || _global.qosLevel > 2)
				_global.qosLevel = 1;
		} else if (boost::iequals(global.first, "maxInflightMsgNum")) {
			_global.maxInflightMsgNum = stoull(global.second.data());
		}else if (boost::iequals(global.first, "maxQueuedMsgNum")) {
			_global.maxQueuedMsgNum = stoull(global.second.data());
		}else if (boost::iequals(global.first, "threads")) {
			_global.threads = stoi(global.second.data());
		} else if (boost::iequals(global.first, "maxMsgNum")) {
			_global.maxMsgNum = stoi(global.second.data());
		} else if (boost::iequals(global.first, "daemonize")) {
		    _global.daemonize = to_bool(global.second.data());
		} else if (boost::iequals(global.first, "validateConfig")) {
            _global.validateConfig = to_bool(global.second.data());
		} else if (boost::iequals(global.first, "verbosity")) {
			_global.logLevelFile = translateLogLevel(stoi(global.second.data()));
		} else if (boost::iequals(global.first, "cacheInterval")) {
			_global.pluginSettings.cacheInterval = stoul(global.second.data());
			_global.pluginSettings.cacheInterval *= 1000;
		} else {
			LOG(warning) << "  Value \"" << global.first << "\" not recognized. Omitting";
		}
	}

	//read restAPI struct
	BOOST_FOREACH(boost::property_tree::iptree::value_type &global, cfg.get_child("restAPI")) {
		if (boost::iequals(global.first, "address")) {
			_global.restAPISettings.restHost = global.second.data();
			size_t pos = _global.restAPISettings.restHost.find(":");
			if (pos != string::npos) {
				_global.restAPISettings.restPort = _global.restAPISettings.restHost.substr(pos+1);
				_global.restAPISettings.restHost.erase(pos);
			}
		} else if (boost::iequals(global.first, "certificate")) {
			_global.restAPISettings.certificate = global.second.data();
		} else if (boost::iequals(global.first, "privateKey")) {
			_global.restAPISettings.privateKey = global.second.data();
		} else if (boost::iequals(global.first, "dhFile")) {
			_global.restAPISettings.dhFile = global.second.data();
		} else if (boost::iequals(global.first, "authkey")) {
			//Avoid unnecessary "Value not recognized" message
		} else {
			LOG(warning) << "  Value \"" << global.first << "\" not recognized. Omitting";
		}
	}

	return true;
}

bool Configuration::readAuthkeys(HttpsServer* server) {
	//open file
	std::string globalConfig = _cfgFilePath;
	globalConfig.append("dcdbpusher.conf");

	boost::property_tree::iptree cfg;
	//parse to property_tree
	try {
		boost::property_tree::read_info(globalConfig, cfg);
	} catch (boost::property_tree::info_parser_error& e) {
		LOG(error) << "Error when reading authkeys from dcdbpusher.conf: " << e.what();
		return false;
	}

	//read authkeys
	BOOST_FOREACH(boost::property_tree::iptree::value_type &global, cfg.get_child("restAPI")) {
		if (boost::iequals(global.first, "authkey")) {
#ifdef DEBUG
			LOG(info) << "Authentication token \"" << global.second.data() << "\"";
#endif
			std::bitset<NUM_PERMISSIONS> permissions;
			BOOST_FOREACH(boost::property_tree::iptree::value_type &perm, global.second) {
				if (boost::iequals(perm.first, "GETReq")) {
#ifdef DEBUG
					LOG(info) << "  Permission \"GETReq\"";
#endif
					permissions[GETReq] = true;
				} else if (boost::iequals(perm.first, "PUTReq")) {
#ifdef DEBUG
					LOG(info) << "  Permission \"PUTReq\"";
#endif
					permissions[PUTReq] = true;
				} else {
#ifdef DEBUG
					LOG(warning) << "Permission \"" << perm.first << "\" not recognized. Omitting";
#endif
				}
			}
			if (!server->addAuthkey(authkeyMap_t::value_type(global.second.data(), permissions))) {
#ifdef DEBUG
				LOG(warning) << "Authkey already present!";
#endif
			}
		} else {
			//
		}
	}
	return true;
}

bool Configuration::readPlugins() {
	std::string globalConfig = _cfgFilePath;
	globalConfig.append("dcdbpusher.conf");

	boost::property_tree::iptree cfg;
	try {
		boost::property_tree::read_info(globalConfig, cfg);
	} catch (boost::property_tree::info_parser_error& e) {
		LOG(error) << "Error when reading plugins from dcdbpusher.conf: " << e.what();
		return false;
	}

	MQTTChecker& mqttCheck = MQTTChecker::getInstance();
	//read plugins
	BOOST_FOREACH(boost::property_tree::iptree::value_type &plugin, cfg.get_child("plugins")) {
		if (boost::iequals(plugin.first, "plugin")) {
			if (!plugin.second.empty()) {
				LOG(info) << "Loading plugin " << plugin.second.data() << "...";
				std::string pluginConfig; //path to config file for plugin
				std::string pluginLib = "libdcdbplugin_" + plugin.second.data(); //TODO add version information? //path to the plugin-lib
#if __APPLE__
				pluginLib+= ".dylib";
#else
				pluginLib+= ".so";
#endif

				BOOST_FOREACH(boost::property_tree::iptree::value_type &val, plugin.second) {
					if (boost::iequals(val.first, "path")) {
						std::string path = val.second.data();
						//if path not specified we will look up in the default lib-directories (usr/lib and friends)
						if (path != "") {
							if (path[path.length()-1] != '/') {
								path.append("/");
							}
							pluginLib = path + pluginLib;
						}
					} else if (boost::iequals(val.first, "config")) {
						pluginConfig = val.second.data();
						//if config-path not specified we will look for pluginName.conf in the dcdbpusher.conf directory
						if (pluginConfig == "") {
							pluginConfig = _cfgFilePath + plugin.second.data() + ".conf";
						}
					} else {
						LOG(warning) << "  Value \"" << val.first << "\" not recognized. Omitting";
					}
				}
				//open plugin
				//dl-code based on http://tldp.org/HOWTO/C++-dlopen/thesolution.html

				if (FILE *file = fopen(pluginConfig.c_str(), "r")) {
					fclose(file);
					dl_t dynLib;
					dynLib.id = plugin.second.data();
					dynLib.DL = NULL;
					dynLib.configurator = NULL;

					//plugin.conf exists --> open libdcdbplugin_pluginName.so and read config
					LOG(info) << pluginConfig << " found";
					dynLib.DL = dlopen(pluginLib.c_str(), RTLD_NOW);
					if(!dynLib.DL) {
						LOG(error) << "Cannot load " << dynLib.id << "-library: " << dlerror();
						return false;
					}
					//reset errors
					dlerror();

					//set dynLib-struct
					dynLib.create = (create_t*) dlsym(dynLib.DL, "create");
					const char* dlsym_error = dlerror();
					if (dlsym_error) {
						LOG(error) << "Cannot load symbol create for " << dynLib.id << ": " << dlsym_error;
						return false;
					}

					dynLib.destroy = (destroy_t*) dlsym(dynLib.DL, "destroy");
					dlsym_error = dlerror();
					if (dlsym_error) {
						LOG(error) << "Cannot load symbol destroy for " << dynLib.id << ": " << dlsym_error;
						return false;
					}

					dynLib.configurator = dynLib.create();
					//set prefix to global prefix (may be overwritten)
					dynLib.configurator->setGlobalSettings(_global.pluginSettings);
					//read in config
					if (!(dynLib.configurator->readConfig(pluginConfig))) {
						LOG(error) << "Plugin " << dynLib.id << " could not read configuration!";
						return false;
					}

					// returning an empty vector may indicate problems with the config file
					if(dynLib.configurator->getSensorGroups().size() == 0) {
						LOG(warning) << "Plugin " << dynLib.id << " created no sensors!";
					}

					//check if an MQTT-suffix was assigned twice
					bool validTopics=true;
					for(const auto& g : dynLib.configurator->getSensorGroups()) {
						if (!mqttCheck.checkGroup(g->getGroupName()))
							validTopics = false;
						for (const auto &s : g->getSensors())
                            if (!mqttCheck.checkTopic(s->getMqtt()) || !mqttCheck.checkName(s->getName()))
                                validTopics = false;
					}

					if(!validTopics) {
						LOG(error) << "Problematic MQTT topics or sensor names, please check your config files!";
						return false;
					}

					//save dl-struct
					_plugins.push_back(dynLib);
					LOG(info) << "Plugin " << dynLib.id << " " << dynLib.configurator->getVersion() << " loaded!";
				} else {
					LOG(info) << pluginConfig << " not found. Omitting";
				}
			}
		}
	}
	return true;
}

boost::log::trivial::severity_level Configuration::translateLogLevel(int logLevel) {
	switch (logLevel) {
		case 0:
			return boost::log::trivial::fatal;
			break;
		case 1:
			return boost::log::trivial::error;
			break;
		case 2:
			return boost::log::trivial::warning;
			break;
		case 3:
			return boost::log::trivial::info;
			break;
		case 4:
			return boost::log::trivial::debug;
			break;
		case 5:
			return boost::log::trivial::trace;
			break;
		default:
			return boost::log::trivial::info;
			break;
	}
}

global_t& Configuration::getGlobal() {
	return _global;
}

pluginVector_t& Configuration::getPlugins() {
	return _plugins;
}