ConfiguratorTemplate.h

/*
 * ConfiguratorTemplate.h
 *
 *  Created on: 13.01.2018
 *      Author: Micha Mueller
 */

#ifndef SRC_CONFIGURATORTEMPLATE_H_
#define SRC_CONFIGURATORTEMPLATE_H_

#include "ConfiguratorInterface.h"

#include "SensorBase.h"
#include "SensorGroupTemplate.h"

#include <map>

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

#define STRCMP(node,str) boost::iequals(node.first,str)

//TODO how to set mqttsuffix? (_mqttprefix + (mqttpart) + suffix)
#define LOOP_HEADER				BOOST_FOREACH(boost::property_tree::iptree::value_type &val, config) { \
									if (false) {}

#define S_BASE_ATTRIBUTES	bool sensorBase(S_BASE& obj, boost::property_tree::iptree& config) override { \
								LOOP_HEADER
#define S_GROUP_ATTRIBUTES	bool sensorGroup(S_GROUP& obj, boost::property_tree::iptree& config) override { \
								LOOP_HEADER
#define S_ENTITY_ATTRIBUTES	bool sensorEntity(S_ENTITY& obj, boost::property_tree::iptree& config) override { \
								LOOP_HEADER
#define ADD(name,setter)			else if (boost::iequals(val.first, name)) { obj.setter(val.second.data()); }
#define END_ATTRIBUTES			} return true; \
							}


/*
#define CONFIG		boost::property_tree::iptree& config
#define ATTRIBUTES	BOOST_FOREACH(boost::property_tree::iptree::value_type &val, config) { \
						if (false) {}
#define ADD(name,setter)	else if (boost::iequals(val.first, name)) { sBase.setter(val.second.data()); }
#define END			} return true;
*/

/**
 * Non-virtual interface template for the configurators.
 */
template <class SBase, class SGroup, class SEntity = void>
class ConfiguratorTemplate : public ConfiguratorInterface {
	//the template shall only be instantiated for classes which derive from SensorBase/SensorGroup
	static_assert(std::is_base_of<SensorBase, SBase>::value, "SBase must derive from SensorBase!");
	static_assert(std::is_base_of<SensorGroupTemplate, SGroup>::value, "SGroup must derive from SensorGroupTemplate!");

protected:
	typedef std::map<std::string, SGroup*> sGroupMap_t;
	typedef std::map<std::string, SEntity*> sEntityMap_t;

public:
	ConfiguratorTemplate() :
		_entityName("entity"),
		_groupName("group"),
		_baseName("sensor"),
		_cfgPath(""),
		_mqttPrefix(""),
		_cacheInterval(900000) {}

	ConfiguratorTemplate(const ConfiguratorTemplate&) = delete;

	virtual ~ConfiguratorTemplate() {
		for (auto g : _sensorGroups) {
			delete g;
		}
		for (auto tg : _templateSensorGroups) {
			delete tg;
		}
		for (auto te : _templateSensorEntitys) {
			delete te;
		}
		_templateSensorGroups.clear();
		_templateSensorEntitys.clear();
	}

	ConfiguratorTemplate& operator=(const ConfiguratorTemplate&) = delete;

	/**
	 * Read in the given configuration
	 *
	 * @param	cfgPath Path to the config-file
	 *
	 * @return	True on success, false otherwise
	 */
	bool readConfig(std::string cfgPath) final {
		_cfgPath = cfgPath;

		boost::property_tree::iptree cfg;
		boost::property_tree::read_info(cfgPath, cfg);

		//read global variables (if present overwrite those from global.conf)
		readGlobal(cfg);

		//read template stuff
		boost::optional<boost::property_tree::iptree&> templates = cfg.get_child_optional("templates");
		if (templates) {
			BOOST_FOREACH(boost::property_tree::iptree::value_type &tempVal, cfg.get_child("templates")) {
				if (boost::iequals(tempVal.first, _entityName)) {
					//TODO
				} else if (boost::iequals(tempVal.first, _groupName)) {
					LOG(debug) << "Template " << _groupName << " \"" << tempVal.second.data() << "\"";
					if (!tempVal.second.empty()) {
						SGroup* group = new SGroup(tempVal.second.data());
						if (readSensorGroup(*group, tempVal.second)) {
							auto ret = _templateSensorGroups.insert(std::pair<std::string, SGroup*>(group->getName(), group));
							if(!ret.second) {
								LOG(warning) << "Template " << _groupName << " " << group->getName() << " already exists! Omitting...";
							}
						} else {
							LOG(warning) << "Template " << _groupName << " \"" << tempVal.second.data() << "\" has bad values! Ignoring...";
						}
					}
				} //else if (boost::iequals(tempVal.first, _baseName)) {//TODO allow for template sensors? even useful?}
			}
		}

		//TODO read actual entitys/groups/bases. How to handle defaults?

//		//read template groups
//		boost::optional<boost::property_tree::iptree&> tempSens = cfg.get_child_optional("groupTemplates");
//		if (tempSens) {
//			BOOST_FOREACH(boost::property_tree::iptree::value_type &groupVal, cfg.get_child("groupTemplates")) {
//				if (STRCMP(groupVal, "group")) {
//					LOG(debug) << "Template " << _groupName << " \"" << groupVal.second.data() << "\"";
//					if (!groupVal.second.empty()) {
//						//TODO
//						SGroup group(groupVal.second.data());
//						if(readSensorGroup(group, groupVal.second)) {
//							_templateSensorGroups.insert(std::pair<std::string, SGroup>(group.getName(), group));
//						} else {
//							LOG(warning) << "Template " << _groupName << " \"" << groupVal.second.data() << "\" has bad values! Ignoring...";
//						}
//					}
//				}
//			}
//		}

		//read in plugin specific stuff (including actual sensors)
		return derivedReadConfig(cfg);
	}

	/**
	 * Clear internal storage and read in the configuration again.
	 *
	 * @return	True on success, false otherwise
	 */
	bool reReadConfig() final {
		//bring everything to a halt
		for(auto g : _sensorGroups) {
			g->stop();
		}

		//wait until everything is halted
		for(auto g : _sensorGroups) {
			g->wait();
		}

		//clean up plugin specific stuff
		derivedReReadConfig();

		//clean up sensors/groups and templates
		for(auto g : _sensorGroups) {
			delete g;
		}
		for (auto tg : _templateSensorGroups) {
			delete tg;
		}
		for (auto te : _templateSensorEntitys) {
			delete te;
		}
		_sensorGroups.clear();
		_templateSensorGroups.clear();
		_templateSensorEntitys.clear();

		//back to the very beginning
		return readConfig(_cfgPath);
	}

	/**
	 * Sets internal variables with the ones provided by pluginSettings.
	 * This method should be called once after constructing a configurator
	 * to provide him with the global default values.
	 *
	 * @param pluginSettings	Struct with global default settings for the plugins.
	 */
	void setGlobalSettings(const pluginSettings_t& pluginSettings) final {
		_mqttPrefix = pluginSettings.mqttPrefix;
		_cacheInterval = pluginSettings.cacheInterval;

		derivedSetGlobalSettings(pluginSettings);
	}

	/**
	 * Get all sensor groups
	 *
	 * @return	Vector containing pointers to all sensor groups of this plugin
	 */
	std::vector<SensorGroupInterface*>& getSensorGroups() {
		return _sensorGroups;
	}

protected:
	/**
	 * Non-virtual interface method for class-internal use only.
	 * Reads and sets the common base values of a sensor (currently none),
	 * then calls the corresponding derived function to read plugin specific
	 * values.
	 *
	 * @param sBase		The sensor base for which to set the values
	 * @param config	A boost property (sub-)tree containing the sensor values
	 *
	 * @return	True on success, false otherwise
	 */
	bool readSensorBase(SBase& sBase, boost::property_tree::iptree& config) {
		return sensorBase(sBase, config);
	}

	/**
	 * Non-virtual interface method for class-internal use only.
	 * Reads and sets the common base values of a SensorInterface, then calls
	 * the corresponding derived function to read in plugin specific values
	 * (currently none).
	 *
	 * @param sensor	The sensor for which to set the values
	 * @param config	A boost property (sub-)tree containing the sensor values
	 *
	 * @return	True on success, false otherwise
	 */
	bool readSensorGroup(SGroup& sGroup, boost::property_tree::iptree& config) {
		sGroup.setCacheInterval(_cacheInterval);
		//read in values inherited from SensorGroupInterface
		BOOST_FOREACH(boost::property_tree::iptree::value_type &val, config) {
			//TODO handle default value here?
			if (STRCMP(val, "interval")) {
				sGroup.setInterval(stoull(val.second.data()));
			} else if (STRCMP(val, "minValues")) {
				sGroup.setMinValues(stoull(val.second.data()));
			} else if (STRCMP(val, "sensor")) {
				SBase* sensor = new SBase(val.second.data());
				if (readSensorBase(*sensor, val.second)) {
					auto ret = sGroup.pushBackSensor(sensor);
					if(!ret.second) {
						LOG(warning) << _baseName << " " << sensor->getName() << " already exists! Omitting...";
					}
				} else {
					LOG(warning) << _baseName << " " << sGroup.getGroupName() << "::" << sensor->getName() << " could not be read! Omitting";
				}
			}
		}

		LOG(debug) << "  Interval : " << sGroup.getInterval();
		LOG(debug) << "  minValues: " << sGroup.getMinValues();

		return sensorGroup(sGroup, config);
	}

	bool readSensorEntity(SEntity& sEntity, boost::property_tree::iptree& config) {
		return sensorEntity(sEntity, config);
	}

	bool readGlobal(boost::property_tree::iptree& config) {
		boost::optional<boost::property_tree::iptree&> globalVals = config.get_child_optional("global");
		if (globalVals) {
			BOOST_FOREACH(boost::property_tree::iptree::value_type &global, config.get_child("global")) {
				if (boost::iequals(global.first, "mqttprefix")) {
					_mqttPrefix = global.second.data();
					if (_mqttPrefix[_mqttPrefix.length()-1] != '/') {
						_mqttPrefix.append("/");
					}
					LOG(debug) << "  Using own MQTT-Prefix " << _mqttPrefix;
				} else if (boost::iequals(global.first, "cacheInterval")) {
					_cacheInterval = stoul(global.second.data());
					LOG(debug) << "  Using own caching interval " << _cacheInterval << " [s]";
					_cacheInterval *= 1000;
				}
			}
		}
		return global(config);
	}

	/**
	 * Pure virtual interface method, responsible for reading the plugin-specific
	 * configuration part.
	 *
	 * @param cfg	The (root) boost property tree from the plugins configuration file
	 *
	 * @return	True on success, false otherwise
	 */
	virtual bool derivedReadConfig(boost::property_tree::iptree& cfg) = 0;

	/**
	 * Pure virtual interface method, responsible for the plugin specific part if
	 * re-reading the config.
	 */
	virtual void derivedReReadConfig() = 0;

	/**
	 * Pure virtual interface method, responsible for setting global values specifically
	 * for its plugin.
	 *
	 * @param pluginSettings	The struct with global default plugin settings
	 */
	virtual void derivedSetGlobalSettings(const pluginSettings_t& pluginSettings) = 0;

	/**
	 * Pure virtual interface method, responsible for reading plugin-specific sensor
	 * base values.
	 *
	 * @param sBase		The sensor base for which to set the values
	 * @param config	A boost property (sub-)tree containing the sensor values
	 *
	 * @return	True on success, false otherwise
	 */
	virtual bool sensorBase(SBase& sBase, boost::property_tree::iptree& config) = 0;

	/**
	 * Pure virtual interface method, responsible for reading plugin-specific sensor
	 * group values.
	 *
	 * @param sGroup	The sensor group for which to set the values
	 * @param config	A boost property (sub-)tree containing the sensor values
	 *
	 * @return	True on success, false otherwise
	 */
	virtual bool sensorGroup(SGroup& sGroup, boost::property_tree::iptree& config) = 0;

	virtual bool sensorEntity(SEntity& sEntity, boost::property_tree::iptree& config) = 0;

	virtual bool global(boost::property_tree::iptree& config) = 0;

	std::string		_entityName;
	std::string		_groupName;
	std::string		_baseName;

	std::string 	_cfgPath;
	std::string		_mqttPrefix;
	unsigned int	_cacheInterval;
	std::vector<SensorGroupInterface*> _sensorGroups;
	sGroupMap_t		_templateSensorGroups;
	sEntityMap_t	_templateSensorEntitys;
};

#endif /* SRC_CONFIGURATORTEMPLATE_H_ */