2.12.2021, 9:00 - 11:00: Due to updates GitLab may be unavailable for some minutes between 09:00 and 11:00.

ConfiguratorTemplate.h 30.3 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
#include "ConfiguratorInterface.h"
20
#include "sensorbase.h"
21
#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
	}

	/**
Alessio Netti's avatar
Alessio Netti committed
267
	 * Clear internal storage and returns the plugin to the uninitialized state.
268
	 */
Alessio Netti's avatar
Alessio Netti committed
269
	void clearConfig() final {
Micha Mueller's avatar
Micha Mueller committed
270
271
		//bring everything to a halt
		for(auto g : _sensorGroups) {
272
			g->stop();
Micha Mueller's avatar
Micha Mueller committed
273
274
275
276
277
278
		}

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

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

	/**
	 * Clear internal storage and read in the configuration again.
	 *
	 * @return	True on success, false otherwise
	 */
	bool reReadConfig() final {
		clearConfig();
308

Micha Mueller's avatar
Micha Mueller committed
309
		//back to the very beginning
310
		return readConfig(_cfgPath);
311
	}
312

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

334
	  //prints plugin specific configurator attributes and entities if present
335
336
	  printConfiguratorConfig(ll);

337
	  LOG_VAR(ll) << "    Groups:";
338
	  for(auto g : _sensorGroups) {
339
340
341
	    g->SensorGroupInterface::printConfig(ll);
	    g->printConfig(ll);
	    g->SensorGroupTemplate<SBase>::printConfig(ll);
342
343
344
	  }
	}

345
346
347
348
349
350
351
	/**
	 * 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.
	 */
352
	void setGlobalSettings(const pluginSettings_t& pluginSettings) final {
353
		_mqttPrefix = pluginSettings.mqttPrefix;
Alessio Netti's avatar
Alessio Netti committed
354
		_sensorPattern = pluginSettings.sensorPattern;
355
		_cacheInterval = pluginSettings.cacheInterval;
356
357

		derivedSetGlobalSettings(pluginSettings);
358
359
	}

Micha Mueller's avatar
Micha Mueller committed
360
361
362
363
364
	/**
	 * Get all sensor groups
	 *
	 * @return	Vector containing pointers to all sensor groups of this plugin
	 */
365
	std::vector<SGroupPtr>& getSensorGroups() final {
366
367
368
		return _sensorGroupInterfaces;
	}

369
protected:
370
	void storeSensorGroup(SG_Ptr sGroup) {
371
372
		_sensorGroups.push_back(sGroup);
		_sensorGroupInterfaces.push_back(sGroup);
Micha Mueller's avatar
Micha Mueller committed
373
374
	}

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

	/**
	 * Non-virtual interface method for class-internal use only.
423
424
	 * Reads and sets the common base values of a sensor group, then calls
	 * the corresponding derived function to read in plugin specific values.
425
	 *
426
	 * @param sGroup	The sensor group for which to set the values
427
	 * @param config	A boost property (sub-)tree containing the sensor values
428
	 * @param isTemplate	Is this a template or a regular group?
429
430
431
	 *
	 * @return	True on success, false otherwise
	 */
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
	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.";
				}
447
448
449
			}
		}

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

477
478
479
		//TODO keep debug logging for config?
//		LOG(debug) << "  Interval : " << sGroup.getInterval();
//		LOG(debug) << "  minValues: " << sGroup.getMinValues();
480

481
482
		sensorGroup(sGroup, config);
		return true;
483
484
	}

485
486
487
488
489
490
491
	/**
	 * 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
492
493
	 * @param isTemplate	Indicate if sEntity is a template. If so, also store
	 * 						the corresponding sGroups in the template map
494
495
496
	 *
	 * @return	True on success, false otherwise
	 */
Micha Mueller's avatar
Micha Mueller committed
497
	bool readSensorEntity(SEntity& sEntity, CFG_VAL config, bool isTemplate) {
498
499
500
501
502
503
504
		//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()) {
505
				sEntity = *(it->second);
Micha Mueller's avatar
Micha Mueller committed
506
507
				for(auto g : _templateSensorGroups) {
					if (isEntityOfGroup(*(it->second), *(g.second))) {
508
						SG_Ptr group = std::make_shared<SGroup>(*(g.second));
Micha Mueller's avatar
Micha Mueller committed
509
						setEntityForGroup(sEntity, *group);
510
						storeSensorGroup(group);
Micha Mueller's avatar
Micha Mueller committed
511
512
					}
				}
513
514
515
516
			} else {
				LOG(warning) << "Template " << _entityName << "\"" << def.get().data() << "\" not found! Using standard values.";
			}
		}
Micha Mueller's avatar
Micha Mueller committed
517

518
		sensorEntity(sEntity, config);
Micha Mueller's avatar
Micha Mueller committed
519
520
521
522

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

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

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

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

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

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

667
668
669
670
	/**
	 * Virtual interface method, responsible for reading plugin-specific sensor
	 * entity values.
	 *
Micha Mueller's avatar
Micha Mueller committed
671
	 * @param s			The sensor entity for which to set the values
672
673
	 * @param config	A boost property (sub-)tree containing the entity values
	 */
Micha Mueller's avatar
Micha Mueller committed
674
	virtual void sensorEntity(SEntity& s, CFG_VAL config) {
675
676
677
		//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";
	}
678

Micha Mueller's avatar
Micha Mueller committed
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
714
715
716
	/**
	 * 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";
	}

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

728
729
730
731
732
	/**
	 * 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
733
	virtual void global(CFG_VAL config) {}
734

Alessio Netti's avatar
Alessio Netti committed
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
835
836
837
	/**
	 * 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
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
	/**
	 * 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;
	}

865
866
	std::string		_entityName;
	std::string		_groupName;
867
	std::string		_baseName;
868
869
870

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

881
#endif /* SRC_CONFIGURATORTEMPLATE_H_ */