ConfiguratorTemplate.h 30.2 KB
Newer Older
1
/*
2
 * ConfiguratorTemplate.h
3
4
 *
 *  Created on: 13.01.2018
5
 *      Author: Micha Mueller, Carla Guillen
6
7
 */

8
9
#ifndef SRC_CONFIGURATORTEMPLATE_H_
#define SRC_CONFIGURATORTEMPLATE_H_
10

11
#include <map>
Alessio Netti's avatar
Alessio Netti committed
12
#include <set>
13
14
15
16
17

#include <boost/foreach.hpp>
#include <boost/algorithm/string.hpp>
#include <boost/property_tree/ptree.hpp>
#include <boost/property_tree/info_parser.hpp>
Alessio Netti's avatar
Alessio Netti committed
18
#include <boost/regex.hpp>
19
20
21
#include "ConfiguratorInterface.h"
#include "SensorBase.h"
#include "SensorGroupTemplate.h"
22
#include "version.h"
23

Alessio Netti's avatar
Alessio Netti committed
24
25
26
27
#include <iostream>
#include <sstream>
#include <iomanip>

28
//#define STRCMP(node,str) boost::iequals(node.first,str) //DEPRECATED
Micha Mueller's avatar
Micha Mueller committed
29
#define CFG_VAL	boost::property_tree::iptree&
30

31
#define ADD						BOOST_FOREACH(boost::property_tree::iptree::value_type &val, config)
32
#define ATTRIBUTE(name,setter)		do { if (boost::iequals(val.first, name)) { s.setter(val.second.data()); } } while(0)
Micha Mueller's avatar
Micha Mueller committed
33
#define SETTING(name)				if (boost::iequals(val.first, name))
34

35
36
#define DEFAULT_CACHE_INTERVAL 900000

Micha Mueller's avatar
Micha Mueller committed
37
/**
38
 * Non-virtual interface template for the configurators.
Micha Mueller's avatar
Micha Mueller committed
39
 */
40
template <class SBase, class SGroup, class SEntity = nullptr_t>
41
class ConfiguratorTemplate : public ConfiguratorInterface {
42
	//the template shall only be instantiated for classes which derive from SensorBase/SensorGroup
43
	static_assert(std::is_base_of<SensorBase, SBase>::value, "SBase must derive from SensorBase!");
44
	static_assert(std::is_base_of<SensorGroupInterface, SGroup>::value, "SGroup must derive from SensorGroupInterface!");
45

46
protected:
Michael Ott's avatar
Michael Ott committed
47
	typedef std::map<std::string, SBase*> sBaseMap_t;
48
49
	typedef std::map<std::string, SGroup*> sGroupMap_t;
	typedef std::map<std::string, SEntity*> sEntityMap_t;
50

51
52
53
	using SB_Ptr = std::shared_ptr<SBase>;
	using SG_Ptr = std::shared_ptr<SGroup>;

54
55
56
57
58
	const char COMMA = ',';
	const char OPEN_SQBRKET = '[';
	const char CLOSE_SQBRKET = ']';
	const char DASH = '-';

Alessio Netti's avatar
Alessio Netti committed
59
60
61
	const std::string SENSOR_PATTERN = "<sensor>";
	const std::string GROUP_PATTERN = "<group>";

62
public:
63
	ConfiguratorTemplate() :
64
65
66
		_entityName("INVALID"),
		_groupName("INVALID"),
		_baseName("INVALID"),
67
68
		_cfgPath(""),
		_mqttPrefix(""),
Alessio Netti's avatar
Alessio Netti committed
69
		_sensorPattern(""),
70
		_cacheInterval(DEFAULT_CACHE_INTERVAL) {}
71

72
73
	ConfiguratorTemplate(const ConfiguratorTemplate&) = delete;

74
	virtual ~ConfiguratorTemplate() {
75
76
77
		for (auto e : _sensorEntitys) {
			delete e;
		}
Michael Ott's avatar
Michael Ott committed
78
79
80
		for (auto tb : _templateSensorBases) {
			delete tb.second;
		}
81
		for (auto tg : _templateSensorGroups) {
82
			delete tg.second;
83
84
		}
		for (auto te : _templateSensorEntitys) {
85
			delete te.second;
86
		}
87
		_sensorGroupInterfaces.clear();
88
89
		_sensorGroups.clear();
		_sensorEntitys.clear();
Michael Ott's avatar
Michael Ott committed
90
		_templateSensorBases.clear();
91
		_templateSensorGroups.clear();
92
		_templateSensorEntitys.clear();
93
	}
94

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

97
98
99
	std::string getVersion() {
		return std::string(VERSION);
	}
Micha Mueller's avatar
Micha Mueller committed
100
101
	/**
	 * Read in the given configuration
102
	 *
103
104
	 * Overwriting this method is only required if a custom logic is really necessary!
	 *
Micha Mueller's avatar
Micha Mueller committed
105
	 * @param	cfgPath Path to the config-file
106
107
	 *
	 * @return	True on success, false otherwise
Micha Mueller's avatar
Micha Mueller committed
108
	 */
109
	bool readConfig(std::string cfgPath) {
110
		_cfgPath = cfgPath;
111
112
113
114
115

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

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

118
119
120
121
122
123
		//read groups and templates for groups. If present also entity/-template stuff
		BOOST_FOREACH(boost::property_tree::iptree::value_type &val, cfg) {
			//template entity
			if (boost::iequals(val.first, "template_" + _entityName)) {
				LOG(debug) << "Template " << _entityName << " \"" << val.second.data() << "\"";
				if (!val.second.empty()) {
Micha Mueller's avatar
Micha Mueller committed
124
125
126
					//name of an entity is only used to identify templates and is not stored otherwise
					SEntity* entity = new SEntity();
					if (readSensorEntity(*entity, val.second, true)) {
127
						auto ret = _templateSensorEntitys.insert(std::pair<std::string, SEntity*>(val.second.data(), entity));
128
						if(!ret.second) {
129
							LOG(warning) << "Template " << _entityName << " " << val.second.data() << " already exists! Omitting...";
Micha Mueller's avatar
Micha Mueller committed
130
							delete entity;
131
132
133
						}
					} else {
						LOG(warning) << "Template " << _entityName << " \"" << val.second.data() << "\" has bad values! Ignoring...";
Micha Mueller's avatar
Micha Mueller committed
134
						delete entity;
135
136
137
138
139
140
141
					}
				}
			//template group
			} else if (boost::iequals(val.first, "template_" + _groupName)) {
				LOG(debug) << "Template " << _groupName << " \"" << val.second.data() << "\"";
				if (!val.second.empty()) {
					SGroup* group = new SGroup(val.second.data());
142
					if (readSensorGroup(*group, val.second, true)) {
143
						auto ret = _templateSensorGroups.insert(std::pair<std::string, SGroup*>(val.second.data(), group));
144
						if(!ret.second) {
145
							LOG(warning) << "Template " << _groupName << " " << val.second.data() << " already exists! Omitting...";
Micha Mueller's avatar
Micha Mueller committed
146
							delete group;
147
						}
148
149
					} else {
						LOG(warning) << "Template " << _groupName << " \"" << val.second.data() << "\" has bad values! Ignoring...";
Micha Mueller's avatar
Micha Mueller committed
150
						delete group;
151
152
					}
				}
Michael Ott's avatar
Michael Ott committed
153
154
155
156
157
			//template base
			} else if (boost::iequals(val.first, "template_" + _baseName)) {
				LOG(debug) << "Template " << _baseName << " \"" << val.second.data() << "\"";
				if (!val.second.empty()) {
					SBase* base = new SBase(val.second.data());
158
					if (readSensorBase(*base, val.second, true)) {
Michael Ott's avatar
Michael Ott committed
159
160
161
162
163
164
165
166
167
168
						auto ret = _templateSensorBases.insert(std::pair<std::string, SBase*>(val.second.data(), base));
						if(!ret.second) {
							LOG(warning) << "Template " << _baseName << " " << val.second.data() << " already exists! Omitting...";
							delete base;
						}
					} else {
						LOG(warning) << "Template " << _baseName << " \"" << val.second.data() << "\" has bad values! Ignoring...";
						delete base;
					}
				}
169
170
171
172
173
			//template single sensor
			} else if (boost::iequals(val.first, "template_single_" + _baseName)) {
				LOG(debug) << "Template single " << _baseName << " \"" << val.second.data() << "\"";
				if (!val.second.empty()) {
					SGroup* group = new SGroup(val.second.data());
174
					if (readSensorGroup(*group, val.second, true)) {
175
						//group which consists of only one sensor
176
						SB_Ptr sensor = std::make_shared<SBase>(val.second.data());
177
						if (readSensorBase(*sensor, val.second, true)) {
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
							group->pushBackSensor(sensor);
							auto ret = _templateSensorGroups.insert(std::pair<std::string, SGroup*>(val.second.data(), group));
							if(!ret.second) {
								LOG(warning) << "Template single " << _baseName << " " << val.second.data() << " already exists! Omitting...";
								delete group;
							}
						} else {
							LOG(warning) << "Template single " << _baseName << " " << val.second.data() << " could not be read! Omitting";
							delete group;
						}
					} else {
						LOG(warning) << "Template single " << _baseName << " \"" << val.second.data() << "\" has bad values! Ignoring...";
						delete group;
					}
				}
193
194
195
196
			//entity
			} else if (boost::iequals(val.first, _entityName)) {
				LOG(debug) << _entityName << " \"" << val.second.data() << "\"";
				if (!val.second.empty()) {
Micha Mueller's avatar
Micha Mueller committed
197
198
					SEntity* entity = new SEntity();
					if (readSensorEntity(*entity, val.second, false)) {
199
200
201
						_sensorEntitys.push_back(entity);
					} else {
						LOG(warning) << _entityName << " \"" << val.second.data() << "\" has bad values! Ignoring...";
Micha Mueller's avatar
Micha Mueller committed
202
						delete entity;
203
					}
204
205
206
207
208
				}
			//group
			} else if (boost::iequals(val.first, _groupName)) {
				LOG(debug) << _groupName << " \"" << val.second.data() << "\"";
				if (!val.second.empty()) {
209
					SG_Ptr group = std::make_shared<SGroup>(val.second.data());
210
					if (readSensorGroup(*group, val.second)) {
211
						storeSensorGroup(group);
212
213
214
215
					} else {
						LOG(warning) << _groupName << " \"" << val.second.data() << "\" has bad values! Ignoring...";
					}
				}
216
217
218
219
			//single sensor
			} else if (boost::iequals(val.first, "single_" + _baseName)) {
				LOG(debug) << "Single " << _baseName << " \"" << val.second.data() << "\"";
				if (!val.second.empty()) {
220
					SG_Ptr group = std::make_shared<SGroup>(val.second.data());
221
222
					if (readSensorGroup(*group, val.second)) {
						//group which consists of only one sensor
223
						SB_Ptr sensor;
224
225
						//perhaps one sensor is already present because it was copied from the template group
						if (group->getSensors().size() != 0) {
226
227
228
229
230
231
232
233
234
							sensor = std::dynamic_pointer_cast<SBase>(group->getSensors()[0]);
							//check if cast was successful (sensor != nullptr)
							if (sensor) {
								sensor->setName(val.second.data());
								if (readSensorBase(*sensor, val.second)) {
									storeSensorGroup(group);
								} else {
									LOG(warning) << "Single " << _baseName << " " << val.second.data() << " could not be read! Omitting";
								}
235
							} else {
236
								LOG(warning) << "Single " << _baseName << " " << val.second.data() << " had a type mismatch when casting! Omitting";
237
238
							}
						} else {
239
							sensor = std::make_shared<SBase>(val.second.data());
240
241
242
243
244
245
246
247
248
249
250
							if (readSensorBase(*sensor, val.second)) {
								group->pushBackSensor(sensor);
								storeSensorGroup(group);
							} else {
								LOG(warning) << "Single " << _baseName << " " << val.second.data() << " could not be read! Omitting";
							}
						}
					} else {
						LOG(warning) << "Single " << _baseName << " \"" << val.second.data() << "\" has bad values! Ignoring...";
					}
				}
Alessio Netti's avatar
Alessio Netti committed
251
			} else if( !boost::iequals(val.first, "global") ) {
252
253
			    LOG(error) << "\"" << val.first << "\": unknown construct!";
			    return false;
254
255
			}
		}
256
		//read of config finished. Now we build the mqtt-topic for every sensor
Alessio Netti's avatar
Alessio Netti committed
257
		constructSensorNames();
258
259
		for(const auto& g : _sensorGroups) {
			for(const auto& s : g->getSensors()) {
260
261
262
				s->setMqtt(_mqttPrefix + g->getMqttPart() + s->getMqtt());
			}
		}
263
		return true;
264
265
266
267
	}

	/**
	 * Clear internal storage and read in the configuration again.
268
269
	 *
	 * @return	True on success, false otherwise
270
	 */
271
	bool reReadConfig() final {
Micha Mueller's avatar
Micha Mueller committed
272
273
		//bring everything to a halt
		for(auto g : _sensorGroups) {
274
			g->stop();
Micha Mueller's avatar
Micha Mueller committed
275
276
277
278
279
280
		}

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

282
283
284
285
		//clean up sensors/groups/entitys and templates
		for(auto e : _sensorEntitys) {
			delete e;
		}
Michael Ott's avatar
Michael Ott committed
286
287
288
		for (auto tb : _templateSensorBases) {
			delete tb.second;
		}
289
		for (auto tg : _templateSensorGroups) {
290
			delete tg.second;
291
292
		}
		for (auto te : _templateSensorEntitys) {
293
			delete te.second;
294
		}
295
		_sensorGroupInterfaces.clear();
Micha Mueller's avatar
Micha Mueller committed
296
		_sensorGroups.clear();
297
		_sensorEntitys.clear();
Michael Ott's avatar
Michael Ott committed
298
		_templateSensorBases.clear();
299
		_templateSensorGroups.clear();
300
		_templateSensorEntitys.clear();
301

Micha Mueller's avatar
Micha Mueller committed
302
		//back to the very beginning
303
		return readConfig(_cfgPath);
304
	}
305

306
307
308
309
310
	/**
	 * Print configuration as read in.
	 *
	 * @param ll    Logging level to log with
	 */
311
312
313
314
315
316
317
318
319
320
321
	void printConfig(LOG_LEVEL ll) final {
	  LOG_VAR(ll) << " General: ";
	  if (_mqttPrefix != "") {
	    LOG_VAR(ll) << "  MQTT-Prefix: " << _mqttPrefix;
	  } else {
	    LOG_VAR(ll) << "  MQTT-Prefix: DEFAULT";
	  }
	  if (_sensorPattern != "") {
	    LOG_VAR(ll) << "  Sensor Pattern: " << _sensorPattern;
	  }
	  if (_cacheInterval != DEFAULT_CACHE_INTERVAL) {
322
	    LOG_VAR(ll) << "  Cache interval: " << _cacheInterval << " ms";
323
324
325
326
	  } else {
	    LOG_VAR(ll) << "  Cache interval: DEFAULT";
	  }

327
	  //prints plugin specific configurator attributes and entities if present
328
329
330
331
	  printConfiguratorConfig(ll);

	  LOG_VAR(ll) << " Groups:";
	  for(auto g : _sensorGroups) {
332
333
334
	    g->SensorGroupInterface::printConfig(ll);
	    g->printConfig(ll);
	    g->SensorGroupTemplate<SBase>::printConfig(ll);
335
336
337
	  }
	}

338
339
340
341
342
343
344
	/**
	 * 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.
	 */
345
	void setGlobalSettings(const pluginSettings_t& pluginSettings) final {
346
		_mqttPrefix = pluginSettings.mqttPrefix;
Alessio Netti's avatar
Alessio Netti committed
347
		_sensorPattern = pluginSettings.sensorPattern;
348
		_cacheInterval = pluginSettings.cacheInterval;
349
350

		derivedSetGlobalSettings(pluginSettings);
351
352
	}

Micha Mueller's avatar
Micha Mueller committed
353
354
355
356
357
	/**
	 * Get all sensor groups
	 *
	 * @return	Vector containing pointers to all sensor groups of this plugin
	 */
358
	std::vector<SGroupPtr>& getSensorGroups() final {
359
360
361
		return _sensorGroupInterfaces;
	}

362
protected:
363
	void storeSensorGroup(SG_Ptr sGroup) {
364
365
		_sensorGroups.push_back(sGroup);
		_sensorGroupInterfaces.push_back(sGroup);
Micha Mueller's avatar
Micha Mueller committed
366
367
	}

368
369
	/**
	 * Non-virtual interface method for class-internal use only.
370
	 * Reads and sets the common base values of a sensor base (currently none),
371
372
	 * then calls the corresponding derived function to read plugin specific
	 * values.
373
	 *
374
	 * @param sBase		The sensor base for which to set the values
375
	 * @param config	A boost property (sub-)tree containing the sensor values
376
	 * @param isTemplate	Are we parsing a template or a regular sensor?
377
378
379
	 *
	 * @return	True on success, false otherwise
	 */
380
	bool readSensorBase(SBase& sBase, CFG_VAL config, bool isTemplate=false) {
381
		sBase.setCacheInterval(_cacheInterval);
382
383
384
		if (!isTemplate) {
			boost::optional<boost::property_tree::iptree&> def = config.get_child_optional("default");
			if(def) {
385
				//we copy all values from default
386
387
388
389
390
391
392
393
				LOG(debug) << "  Using \"" << def.get().data() << "\" as default.";
				auto it = _templateSensorBases.find(def.get().data());
				if(it != _templateSensorBases.end()) {
					sBase = *(it->second);
					sBase.setName(config.data());
				} else {
					LOG(warning) << "Template " << _baseName << "\" " << def.get().data() << "\" not found! Using standard values.";
				}
Michael Ott's avatar
Michael Ott committed
394
395
396
			}
		}
		
397
398
399
		BOOST_FOREACH(boost::property_tree::iptree::value_type &val, config) {
			if (boost::iequals(val.first, "mqttsuffix")) {
				sBase.setMqtt(val.second.data());
400
			} else if (boost::iequals(val.first, "skipConstVal")) {
401
402
403
404
405
				if (val.second.data() == "on") {
					sBase.setSkipConstVal(true);
				} else {
					sBase.setSkipConstVal(false);
				}
406
			} else if (boost::iequals(val.first, "delta")) {
407
				sBase.setDelta( val.second.data() == "on" );
408
409
410
411
			} else if (boost::iequals(val.first, "sink")) {
				sBase.setSinkPath( val.second.data() );
			} else if (boost::iequals(val.first, "subSampling")) {
				sBase.setSubsampling( std::stoul(val.second.data()) );
412
			}
413
414
415
		}
		sensorBase(sBase, config);
		return true;
416
417
418
419
	}

	/**
	 * Non-virtual interface method for class-internal use only.
420
421
	 * Reads and sets the common base values of a sensor group, then calls
	 * the corresponding derived function to read in plugin specific values.
422
	 *
423
	 * @param sGroup	The sensor group for which to set the values
424
	 * @param config	A boost property (sub-)tree containing the sensor values
425
	 * @param isTemplate	Is this a template or a regular group?
426
427
428
	 *
	 * @return	True on success, false otherwise
	 */
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
	bool readSensorGroup(SGroup& sGroup, CFG_VAL config, bool isTemplate=false) {
		//first check if default group is given, unless we are reading a template already
		if (!isTemplate) {
			boost::optional<boost::property_tree::iptree&> def = config.get_child_optional("default");
			if(def) {
				//we copy all values from default (including copy constructing its sensors)
				//if own sensors are specified they are appended
				LOG(debug) << "  Using \"" << def.get().data() << "\" as default.";
				auto it = _templateSensorGroups.find(def.get().data());
				if(it != _templateSensorGroups.end()) {
					sGroup = *(it->second);
					sGroup.setGroupName(config.data());
				} else {
					LOG(warning) << "Template " << _groupName << "\" " << def.get().data() << "\" not found! Using standard values.";
				}
444
445
446
			}
		}

447
		//read in values inherited from SensorGroupInterface
448
		BOOST_FOREACH(boost::property_tree::iptree::value_type &val, config) {
449
			if (boost::iequals(val.first, "interval")) {
450
				sGroup.setInterval(stoull(val.second.data()));
451
			} else if (boost::iequals(val.first, "minValues")) {
452
				sGroup.setMinValues(stoull(val.second.data()));
453
454
			} else if (boost::iequals(val.first, "mqttPart")) {
				sGroup.setMqttPart(val.second.data());
455
456
457
458
459
460
			} else if (boost::iequals(val.first, "sync")) {
				if (val.second.data() == "off") {
					sGroup.setSync(false);
				} else {
					sGroup.setSync(true);
				}
461
			} else if (boost::iequals(val.first, _baseName)) {
462
463
464
				if (!isTemplate) {
					LOG(debug) << "  " << _baseName << " " << val.second.data();
				}
465
				SB_Ptr sensor = std::make_shared<SBase>(val.second.data());
466
				if (readSensorBase(*sensor, val.second, isTemplate)) {
467
					sGroup.pushBackSensor(sensor);
468
				} else if (!isTemplate) {
469
					LOG(warning) << _baseName << " " << sGroup.getGroupName() << "::" << sensor->getName() << " could not be read! Omitting";
470
				}
471
472
473
			}
		}

474
475
476
		//TODO keep debug logging for config?
//		LOG(debug) << "  Interval : " << sGroup.getInterval();
//		LOG(debug) << "  minValues: " << sGroup.getMinValues();
477

478
479
		sensorGroup(sGroup, config);
		return true;
480
481
	}

482
483
484
485
486
487
488
	/**
	 * Non-virtual interface method for class-internal use only.
	 * Reads and sets the common base values of a sensor entity, then calls
	 * the corresponding derived function to read in plugin specific values.
	 *
	 * @param sEntity	The aggregating entity for which to set the values
	 * @param config	A boost property (sub-)tree containing the sensor values
Micha Mueller's avatar
Micha Mueller committed
489
490
	 * @param isTemplate	Indicate if sEntity is a template. If so, also store
	 * 						the corresponding sGroups in the template map
491
492
493
	 *
	 * @return	True on success, false otherwise
	 */
Micha Mueller's avatar
Micha Mueller committed
494
	bool readSensorEntity(SEntity& sEntity, CFG_VAL config, bool isTemplate) {
495
496
497
498
499
500
501
		//first check if default entity is given
		boost::optional<boost::property_tree::iptree&> def = config.get_child_optional("default");
		if(def) {
			//we copy all values from default
			LOG(debug) << "  Using \"" << def.get().data() << "\" as default.";
			auto it = _templateSensorEntitys.find(def.get().data());
			if(it != _templateSensorEntitys.end()) {
502
				sEntity = *(it->second);
Micha Mueller's avatar
Micha Mueller committed
503
504
				for(auto g : _templateSensorGroups) {
					if (isEntityOfGroup(*(it->second), *(g.second))) {
505
						SG_Ptr group = std::make_shared<SGroup>(*(g.second));
Micha Mueller's avatar
Micha Mueller committed
506
						setEntityForGroup(sEntity, *group);
507
						storeSensorGroup(group);
Micha Mueller's avatar
Micha Mueller committed
508
509
					}
				}
510
511
512
513
			} else {
				LOG(warning) << "Template " << _entityName << "\"" << def.get().data() << "\" not found! Using standard values.";
			}
		}
Micha Mueller's avatar
Micha Mueller committed
514

515
		sensorEntity(sEntity, config);
Micha Mueller's avatar
Micha Mueller committed
516
517
518
519

		BOOST_FOREACH(boost::property_tree::iptree::value_type &val, config) {
			if (boost::iequals(val.first, _groupName)) {
				LOG(debug) << "  " << _groupName << " " << val.second.data();
520
				if (!val.second.empty()) {
521
522
523
524
					if (isTemplate) {
						SGroup* group = new SGroup(val.second.data());
						if(readSensorGroup(*group, val.second)) {
							setEntityForGroup(sEntity, *group);
525
526
527
528
529
530
							auto ret = _templateSensorGroups.insert(std::pair<std::string, SGroup*>(val.second.data(), group));
							if(!ret.second) {
								LOG(warning) << "Template " << _groupName << " " << val.second.data() << " already exists! Omitting...";
								delete group;
							}
						} else {
531
532
							LOG(warning) << _groupName << " " << group->getGroupName() << " could not be read! Omitting";
							delete group;
Micha Mueller's avatar
Micha Mueller committed
533
534
						}
					} else {
535
536
537
538
539
540
541
						SG_Ptr group = std::make_shared<SGroup>(val.second.data());
						if(readSensorGroup(*group, val.second)) {
							setEntityForGroup(sEntity, *group);
							storeSensorGroup(group);
						} else {
							LOG(warning) << _groupName << " " << group->getGroupName() << " could not be read! Omitting";
						}
542
543
544
545
546
					}
				}
			} else if (boost::iequals(val.first, "single_" + _baseName)) {
				LOG(debug) << "Single " << _baseName << " \"" << val.second.data() << "\"";
				if (!val.second.empty()) {
547
548
549
550
551
552
					if (isTemplate) {
						SGroup* group = new SGroup(val.second.data());
						//group which consists of only one sensor
						if (readSensorGroup(*group, val.second)) {
							setEntityForGroup(sEntity, *group);
							SB_Ptr sensor = std::make_shared<SBase>(val.second.data());
553
554
555
556
557
558
559
560
561
562
563
564
							if (readSensorBase(*sensor, val.second)) {
								group->pushBackSensor(sensor);
								auto ret = _templateSensorGroups.insert(std::pair<std::string, SGroup*>(val.second.data(), group));
								if(!ret.second) {
									LOG(warning) << "Template single " << _baseName << " " << val.second.data() << " already exists! Omitting...";
									delete group;
								}
							} else {
								LOG(warning) << "Template single " << _baseName << " " << val.second.data() << " could not be read! Omitting";
								delete group;
							}
						} else {
565
566
567
568
569
570
571
572
573
							LOG(warning) << "Single " << _baseName << " \"" << val.second.data() << "\" has bad values! Ignoring...";
							delete group;
						}
					} else {
						SG_Ptr group = std::make_shared<SGroup>(val.second.data());
						//group which consists of only one sensor
						if (readSensorGroup(*group, val.second)) {
							setEntityForGroup(sEntity, *group);
							SB_Ptr sensor;
574
575
							//perhaps one sensor is already present because it was copied from the template group
							if (group->getSensors().size() != 0) {
576
577
578
579
580
581
582
583
584
								sensor = std::dynamic_pointer_cast<SBase>(group->getSensors()[0]);
								//check if cast was successful (sensor != nullptr)
								if (sensor) {
									sensor->setName(val.second.data());
									if (readSensorBase(*sensor, val.second)) {
										storeSensorGroup(group);
									} else {
										LOG(warning) << "Single " << _baseName << " " << val.second.data() << " could not be read! Omitting";
									}
585
								} else {
586
									LOG(warning) << "Single " << _baseName << " " << val.second.data() << " had a type mismatch when casting! Omitting";
587
588
								}
							} else {
589
								sensor = std::make_shared<SBase>(val.second.data());
590
591
592
593
594
595
596
								if (readSensorBase(*sensor, val.second)) {
									group->pushBackSensor(sensor);
									storeSensorGroup(group);
								} else {
									LOG(warning) << "Single " << _baseName << " " << val.second.data() << " could not be read! Omitting";
								}
							}
597
598
						} else {
							LOG(warning) << "Single " << _baseName << " \"" << val.second.data() << "\" has bad values! Ignoring...";
599
						}
Micha Mueller's avatar
Micha Mueller committed
600
601
602
603
604
					}
				}
			}
		}

605
		if(!isTemplate) {
606
			for(const auto& g : _sensorGroups) {
607
608
609
				if(isEntityOfGroup(sEntity, *g)) {
					finalizeGroup(*g);
				}
Micha Mueller's avatar
Micha Mueller committed
610
611
			}
		}
612
		return true;
613
614
	}

Micha Mueller's avatar
Micha Mueller committed
615
	bool readGlobal(CFG_VAL config) {
616
617
618
619
620
621
622
623
624
625
626
		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("/");
					}
				} else if (boost::iequals(global.first, "cacheInterval")) {
					_cacheInterval = stoul(global.second.data());
					_cacheInterval *= 1000;
Alessio Netti's avatar
Alessio Netti committed
627
628
				} else if (boost::iequals(global.first, "sensorpattern")) {
					_sensorPattern = global.second.data();
629
630
				}
			}
631
			global(config.get_child("global"));
632
		}
633
		return true;
634
635
	}

636
	/**
637
	 * Virtual interface method, responsible for setting global values specifically
638
639
640
641
	 * for its plugin.
	 *
	 * @param pluginSettings	The struct with global default plugin settings
	 */
642
643
644
	virtual void derivedSetGlobalSettings(const pluginSettings_t& pluginSettings) {
		//Overwrite if necessary
	}
645
646
647

	/**
	 * Pure virtual interface method, responsible for reading plugin-specific sensor
648
	 * base values.
649
	 *
Micha Mueller's avatar
Micha Mueller committed
650
	 * @param s			The sensor base for which to set the values
651
652
	 * @param config	A boost property (sub-)tree containing the sensor values
	 */
Micha Mueller's avatar
Micha Mueller committed
653
	virtual void sensorBase(SBase& s, CFG_VAL config) = 0;
654
655
656
657
658

	/**
	 * Pure virtual interface method, responsible for reading plugin-specific sensor
	 * group values.
	 *
Micha Mueller's avatar
Micha Mueller committed
659
	 * @param s			The sensor group for which to set the values
660
	 * @param config	A boost property (sub-)tree containing the group values
661
	 */
Micha Mueller's avatar
Micha Mueller committed
662
	virtual void sensorGroup(SGroup& s, CFG_VAL config) = 0;
663

664
665
666
667
	/**
	 * Virtual interface method, responsible for reading plugin-specific sensor
	 * entity values.
	 *
Micha Mueller's avatar
Micha Mueller committed
668
	 * @param s			The sensor entity for which to set the values
669
670
	 * @param config	A boost property (sub-)tree containing the entity values
	 */
Micha Mueller's avatar
Micha Mueller committed
671
	virtual void sensorEntity(SEntity& s, CFG_VAL config) {
672
673
674
		//Overwrite if necessary
		LOG(warning) << "Method sensorEntity called, but was not overwritten! Either you have unwanted entitys in your config file or forgot to overwrite this method";
	}
675

Micha Mueller's avatar
Micha Mueller committed
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
	/**
	 * Check if e is the corresponding entity of g
	 *
	 * @param e
	 * @param g
	 *
	 * @return	True if (g.entity == &e)
	 */
	//TODO not very convenient for writing plugins. Are there better solutions?
	virtual bool isEntityOfGroup(SEntity& e, SGroup& g) {
		//Overwrite if necessary
		LOG(warning) << "Method isEntityOfGroup called, but was not overwritten! Either you have unwanted entitys in your config file or forgot to overwrite this method";
		return false;
	}

	/**
	 * Sets e as entity for group g
	 *
	 * @param e
	 * @param g
	 */
	//TODO not very convenient for writing plugins. Are there better solutions?
	virtual void setEntityForGroup(SEntity& e, SGroup& g) {
		//Overwrite if necessary
		LOG(warning) << "Method setEntityForGroup called, but was not overwritten! Either you have unwanted entitys in your config file or forgot to overwrite this method";
	}

	/**
	 * Finalize the group g with everything it needs from its entity (set e.g. the mqttPart for entity)
	 *
	 * @param g
	 */
	//TODO not very convenient for writing plugins. Are there better solutions?
	virtual void finalizeGroup(SGroup& g) {
		//Overwrite if necessary
		LOG(warning) << "Method finalizeEntityGroup called, but was not overwritten! Either you have unwanted entitys in your config file or forgot to overwrite this method";
	}

714
715
	/**
	 * Print information about configurable configurator attributes (or nothing if no such attributes are required)
716
	 * and associated entities.
717
718
719
720
721
	 *
	 * @param ll    Severity level to log with
	 */
	virtual void printConfiguratorConfig(LOG_LEVEL ll) {
	  //Overwrite if necessary
722
	  LOG_VAR(ll) << "  No other plugin specific general parameters or entities defined";
723
724
	}

725
726
727
728
729
	/**
	 * Virtual interface method, responsible for reading plugin-specific global values.
	 *
	 * @param config	A boost property (sub-)tree containing the global values
	 */
Micha Mueller's avatar
Micha Mueller committed
730
	virtual void global(CFG_VAL config) {}
731

Alessio Netti's avatar
Alessio Netti committed
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
	/**
	 * Increases by a certain value the input MQTT hex topic.
	 *
	 * Example: a mqtt="AAB7" and val=5 produce "AAC2" as output.
	 *
	 * @param mqtt: the MQTT hex string whose value has to be increased
	 * @param val: the value by which mqtt has to be increased
	 *
	 * @return the increased MQTT string
	 *
	 */
	const std::string increaseMqtt(const std::string& mqtt, int val) {
		unsigned long mqttDigits = stoul(mqtt, 0, 16);
		mqttDigits += val;
		std::stringstream stream;
		stream << std::setfill ('0') << std::setw(mqtt.length()) << std::uppercase << std::hex << mqttDigits;
		return stream.str();
	}

	/**
	 * Formats a numerical CPU core ID into a hex string of specified length.
	 *
	 * Example: a mqttPart="xx" and val=11 produce "0B" as output.
	 *
	 * @param mqttPart: a template MQTT string, defines the length of the final string
	 * @param val: the value of the CPU core ID
	 *
	 * @return the hex string representation of the input CPU core ID
	 *
	 */
	const std::string formatMqttCPU(const std::string& mqttPart, unsigned int val) {
		std::stringstream stream;
		stream << std::setfill ('0') << std::setw(mqttPart.length()) << std::uppercase << std::hex << val;
		return stream.str();
	}

	/**
	 * Tries to parse the given cpuString as integer numbers. On success, the specified numbers will be inserted
	 * into a set, which will be returned. On failure, an empty set is returned. A set is used to maintain uniqueness
	 * and an ascending order among the numbers although this is not strictly required.
	 *
	 * @param cpuString	String which specifies a range and/or set of numbers (e.g. "1,2,3-5,7-9,10")
	 * @return	A set of integers as specified in the cpuString. If the string could not be parsed the set will be empty.
	 */
	std::set<int> parseCpuString(const std::string& cpuString) {
		std::set<int> cpus;
		int maxCpu = 512;

		std::vector<std::string> subStrings;

		std::stringstream ssComma(cpuString);
		std::string item;
		while (std::getline(ssComma, item, ',')) {
			subStrings.push_back(item);
		}

		for (auto s : subStrings) {
			if (s.find('-') != std::string::npos) { //range of values (e.g. 1-5) specified
				std::stringstream ssHyphen(s);
				std::string min, max;
				std::getline(ssHyphen, min, '-');
				std::getline(ssHyphen, max);

				try {
					int minVal = stoi(min);
					int maxVal = stoi(max);

					for (int i = minVal; i <= maxVal; i++) {
						if (i >= 0 && i < maxCpu) {
							cpus.insert((int)i);
						}
					}
				} catch (const std::exception& e) {
					LOG(debug) << "Could not parse values \"" << min << "-" << max << "\"";
				}
			} else { //single value
				try {
					int val = stoi(s);
					if (val >= 0 && val < maxCpu) {
						cpus.insert((int)val);
					}
				} catch (const std::exception& e) {
					LOG(debug) << "Could not parse value \"" << s << "\"";
				}
			}
		}

		if (cpus.empty()) {
			LOG(warning) << "  CPUs could not be parsed!";
		} else {
			std::stringstream sstream;
			sstream << "  CPUS: ";
			for (auto i : cpus) {
				sstream << i << ", ";
			}
			std::string msg = sstream.str();
			msg.pop_back();
			msg.pop_back();
			LOG(debug) << msg;
		}
		return cpus;
	}

Alessio Netti's avatar
Alessio Netti committed
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
	/**
	 * Adjusts the names of the sensors in generated groups according to the sensorPattern specified in the global
	 * settings. Operates in tandem with the auto-publish feature.
	 */
	void constructSensorNames() {
		boost::regex sensorReg(SENSOR_PATTERN), groupReg(GROUP_PATTERN);
		boost::cmatch match;
		if(_sensorPattern == "")
			return;
		else if (!boost::regex_search(_sensorPattern.c_str(), match, sensorReg)) {
			LOG(error) << "Invalid sensor naming pattern " << _sensorPattern << ". You must at least include " << SENSOR_PATTERN << "!";
			return;
		}

		std::string name;
		// Performing auto-publish for sensors
		for(auto& g: _sensorGroups)
			for(auto& s: g->getSensors()) {
					name = _sensorPattern;
					name = boost::regex_replace(name, sensorReg, s->getName());
					name = boost::regex_replace(name, groupReg, g->getGroupName());
					// Setting the auto-publish name back to the sensor
					s->setName(name);
				}
		return;
	}

862
863
	std::string		_entityName;
	std::string		_groupName;
864
	std::string		_baseName;
865
866
867

	std::string 	_cfgPath;
	std::string		_mqttPrefix;
Alessio Netti's avatar
Alessio Netti committed
868
	std::string		_sensorPattern;
869
	unsigned int	_cacheInterval;
870
871
	std::vector<SGroupPtr> 	_sensorGroupInterfaces;
	std::vector<SG_Ptr>		_sensorGroups;
872
	std::vector<SEntity*>	_sensorEntitys;
Michael Ott's avatar
Michael Ott committed
873
	sBaseMap_t		_templateSensorBases;
874
875
	sGroupMap_t		_templateSensorGroups;
	sEntityMap_t	_templateSensorEntitys;
876
877
};

878
#endif /* SRC_CONFIGURATORTEMPLATE_H_ */