ConfiguratorTemplate.h 42.3 KB
Newer Older
1
2
//================================================================================
// Name        : ConfiguratorTemplate.h
3
// Author      : Micha Mueller, Carla Guillen
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// Copyright   : Leibniz Supercomputing Centre
// Description : Interface template for plugin configurators.
//================================================================================

//================================================================================
// This file is part of DCDB (DataCenter DataBase)
// Copyright (C) 2018-2019 Leibniz Supercomputing Centre
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//================================================================================
26

27
28
#ifndef SRC_CONFIGURATORTEMPLATE_H_
#define SRC_CONFIGURATORTEMPLATE_H_
29

30
#include <map>
Alessio Netti's avatar
Alessio Netti committed
31
#include <set>
32
33
34
35
36

#include <boost/foreach.hpp>
#include <boost/algorithm/string.hpp>
#include <boost/property_tree/ptree.hpp>
#include <boost/property_tree/info_parser.hpp>
37
#include "ConfiguratorInterface.h"
38
#include "sensorbase.h"
39
#include "SensorGroupTemplate.h"
40
#include "EntityInterface.h"
41

42
#include <algorithm>
Alessio Netti's avatar
Alessio Netti committed
43
44
45
46
#include <iostream>
#include <sstream>
#include <iomanip>

Micha Mueller's avatar
Micha Mueller committed
47
/**
48
49
 * @brief Interface template for plugin configurator implementations with
 *        entities.
50
 *
51
 * @details There is a partial template specialization for SEntity = nullptr_t,
52
53
54
55
56
57
58
 *          i.e. for plugins without entities, see
 *          ConfiguratorTemplate<SBase, SGroup, nullptr_t>. Common code is moved
 *          to ConfiguratorInterface if possible. If not, common code has to be
 *          duplicated and maintained twice here and in
 *          ConfiguratorTemplate<SBase, SGroup, nullptr_t>. However, having two
 *          templates for cases with and without entities allows for simplified
 *          derived plugin configurators.
59
 *
60
 * @ingroup pusherplugins
Micha Mueller's avatar
Micha Mueller committed
61
 */
62
template <class SBase, class SGroup, class SEntity = nullptr_t>
63
class ConfiguratorTemplate : public ConfiguratorInterface {
64
	//the template shall only be instantiated for classes which derive from SensorBase/SensorGroup
65
	static_assert(std::is_base_of<SensorBase, SBase>::value, "SBase must derive from SensorBase!");
66
	static_assert(std::is_base_of<SensorGroupInterface, SGroup>::value, "SGroup must derive from SensorGroupInterface!");
67
	static_assert(std::is_base_of<EntityInterface, SEntity>::value, "SEntity must derive from EntityInterface!");
68

69
protected:
70
	//TODO use smart pointers
Michael Ott's avatar
Michael Ott committed
71
	typedef std::map<std::string, SBase*> sBaseMap_t;
72
73
	typedef std::map<std::string, SGroup*> sGroupMap_t;
	typedef std::map<std::string, SEntity*> sEntityMap_t;
74

75
76
	using SB_Ptr = std::shared_ptr<SBase>;
	using SG_Ptr = std::shared_ptr<SGroup>;
77
	
78
public:
79
	ConfiguratorTemplate() :
80
	    ConfiguratorInterface(),
81
82
		_entityName("INVALID"),
		_groupName("INVALID"),
83
		_baseName("INVALID"){}
84

85
	virtual ~ConfiguratorTemplate() {
86
87
88
		for (auto e : _sensorEntitys) {
			delete e;
		}
Michael Ott's avatar
Michael Ott committed
89
90
91
		for (auto tb : _templateSensorBases) {
			delete tb.second;
		}
92
		for (auto tg : _templateSensorGroups) {
93
			delete tg.second;
94
95
		}
		for (auto te : _templateSensorEntitys) {
96
			delete te.second;
97
		}
98
99
		_sensorGroups.clear();
		_sensorEntitys.clear();
Michael Ott's avatar
Michael Ott committed
100
		_templateSensorBases.clear();
101
		_templateSensorGroups.clear();
102
		_templateSensorEntitys.clear();
103
	}
104

Micha Mueller's avatar
Micha Mueller committed
105
	/**
106
	 * @brief Read in the given configuration
107
	 *
108
	 * @details Overwriting this method is only required if a custom logic is really necessary!
109
	 *
Micha Mueller's avatar
Micha Mueller committed
110
	 * @param	cfgPath Path to the config-file
111
112
	 *
	 * @return	True on success, false otherwise
Micha Mueller's avatar
Micha Mueller committed
113
	 */
114
	bool readConfig(std::string cfgPath) {
115
		_cfgPath = cfgPath;
116
117
118
119
120

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

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

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

	/**
284
	 * @brief Clear internal storage and return plugin in unconfigured state.
285
	 */
Alessio Netti's avatar
Alessio Netti committed
286
	void clearConfig() final {
287
	    ConfiguratorInterface::clearConfig();
Micha Mueller's avatar
Micha Mueller committed
288
289
		//bring everything to a halt
		for(auto g : _sensorGroups) {
290
			g->stop();
Micha Mueller's avatar
Micha Mueller committed
291
292
		}

293
294
295
296
		//clean up sensors/groups/entitys and templates
		for(auto e : _sensorEntitys) {
			delete e;
		}
Michael Ott's avatar
Michael Ott committed
297
298
299
		for (auto tb : _templateSensorBases) {
			delete tb.second;
		}
300
		for (auto tg : _templateSensorGroups) {
301
			delete tg.second;
302
303
		}
		for (auto te : _templateSensorEntitys) {
304
			delete te.second;
305
		}
Micha Mueller's avatar
Micha Mueller committed
306
		_sensorGroups.clear();
307
		_sensorEntitys.clear();
Michael Ott's avatar
Michael Ott committed
308
		_templateSensorBases.clear();
309
		_templateSensorGroups.clear();
310
		_templateSensorEntitys.clear();
Alessio Netti's avatar
Alessio Netti committed
311
312
313
	}

	/**
314
315
316
317
     * @brief Print configuration.
     *
     * @param ll Log severity level to be used from logger.
     */
318
	void printConfig(LOG_LEVEL ll) final {
319
        ConfiguratorInterface::printConfig(ll);
320

321
322
        //prints plugin specific configurator attributes and entities if present
        printConfiguratorConfig(ll);
323

324
325
326
327
328
329
330
331
332
333
334
335
336
        LOG_VAR(ll) << " " << _entityName << "s:";
        if (_sensorEntitys.size() != 0) {
            for(auto e : _sensorEntitys) {
                e->printConfig(ll);
            }
        } else {
            LOG_VAR(ll) << "  No " << _entityName << "s present!";
        }

        LOG_VAR(ll) << "    " << _groupName << "s:";
        for(auto g : _sensorGroups) {
            g->printConfig(ll);
        }
337
338
	}

339
protected:
Micha Mueller's avatar
Micha Mueller committed
340

341
342
	///@name Template-internal use only
	///@{
343
	/**
344
	 * @brief Read common values of a sensorbase.
345
	 *
346
347
348
349
350
351
352
	 * @details Reads and sets the common base values of a sensor base
	 *          (currently none), then calls sensorBase() 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 values.
	 * @param isTemplate Are we parsing a template or a regular sensor?
353
354
355
	 *
	 * @return	True on success, false otherwise
	 */
356
	bool readSensorBase(SBase& sBase, CFG_VAL config, bool isTemplate=false) {
357
		sBase.setCacheInterval(_cacheInterval);
358
359
360
		if (!isTemplate) {
			boost::optional<boost::property_tree::iptree&> def = config.get_child_optional("default");
			if(def) {
361
				//we copy all values from default
362
363
364
365
366
367
				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 {
368
369
					LOG(warning) << "Template " << _baseName << "\" "
					             << def.get().data() << "\" not found! Using standard values.";
370
				}
Michael Ott's avatar
Michael Ott committed
371
372
373
			}
		}
		
374
375
376
		BOOST_FOREACH(boost::property_tree::iptree::value_type &val, config) {
			if (boost::iequals(val.first, "mqttsuffix")) {
				sBase.setMqtt(val.second.data());
377
			} else if (boost::iequals(val.first, "skipConstVal")) {
Alessio Netti's avatar
Alessio Netti committed
378
				sBase.setSkipConstVal(to_bool(val.second.data()));
379
			} else if (boost::iequals(val.first, "delta")) {
Alessio Netti's avatar
Alessio Netti committed
380
				sBase.setDelta(to_bool(val.second.data()));
381
382
383
			} 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
384
				sBase.setSubsampling(std::stoul(val.second.data()));
385
			}
386
387
388
		}
		sensorBase(sBase, config);
		return true;
389
390
391
	}

	/**
392
393
394
395
396
397
398
399
400
401
402
403
     * @brief Read common values of a sensorGroup.
     *
     * @details Reads and sets the common base values of a sensor group
     *          (currently none), then calls sensorGroup() to read plugin
     *          specific values.
     *
     * @param sGroup     The sensor group for which to set the values.
     * @param config     A boost property (sub-)tree containing the values.
     * @param isTemplate Are we parsing a template or a regular group?
     *
     * @return  True on success, false otherwise
     */
404
405
406
407
408
409
410
411
412
413
414
415
416
	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 {
417
418
					LOG(warning) << "Template " << _groupName << "\" "
					             << def.get().data() << "\" not found! Using standard values.";
419
				}
420
421
422
			}
		}

423
		//read in values inherited from SensorGroupInterface
424
		BOOST_FOREACH(boost::property_tree::iptree::value_type &val, config) {
425
			if (boost::iequals(val.first, "interval")) {
426
				sGroup.setInterval(stoull(val.second.data()));
427
			} else if (boost::iequals(val.first, "minValues")) {
428
				sGroup.setMinValues(stoull(val.second.data()));
429
430
			} else if (boost::iequals(val.first, "mqttPart")) {
				sGroup.setMqttPart(val.second.data());
431
432
433
434
435
436
			} else if (boost::iequals(val.first, "sync")) {
				if (val.second.data() == "off") {
					sGroup.setSync(false);
				} else {
					sGroup.setSync(true);
				}
437
			} else if (boost::iequals(val.first, _baseName)) {
438
439
440
				if (!isTemplate) {
					LOG(debug) << "  " << _baseName << " " << val.second.data();
				}
441
				SB_Ptr sensor = std::make_shared<SBase>(val.second.data());
442
				if (readSensorBase(*sensor, val.second, isTemplate)) {
443
					sGroup.pushBackSensor(sensor);
444
				} else if (!isTemplate) {
445
446
					LOG(warning) << _baseName << " " << sGroup.getGroupName() << "::"
					             << sensor->getName() << " could not be read! Omitting";
447
				}
448
449
450
			}
		}

451
452
		sensorGroup(sGroup, config);
		return true;
453
454
	}

455
	/**
456
457
458
459
460
461
462
463
464
465
466
467
468
469
     * @brief Read common values of a sensor entity.
     *
     * @details Reads and sets the common base values of a sensor entity
     *          (currently none), then calls sensorEntity() to read plugin
     *          specific values.
     *
     * @param sEntity    The aggregating entity for which to set the values.
     * @param config     A boost property (sub-)tree containing the values.
     * @param isTemplate Indicate if sEntity is a template. If so, also store
     *                   the corresponding sGroups in the template map.
     *
     * @return  True on success, false otherwise
     */
	bool readSensorEntity(SEntity& sEntity, CFG_VAL config, bool isTemplate=false) {
470
471
472
473
474
475
476
		//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()) {
477
				sEntity = *(it->second);
Micha Mueller's avatar
Micha Mueller committed
478
				for(auto g : _templateSensorGroups) {
479
					if (it->second == g.second->getEntity()) {
480
						SG_Ptr group = std::make_shared<SGroup>(*(g.second));
481
						group->setEntity(&sEntity);
482
						storeSensorGroup(group);
Micha Mueller's avatar
Micha Mueller committed
483
484
					}
				}
485
			} else {
486
487
				LOG(warning) << "Template " << _entityName << "\""
				             << def.get().data() << "\" not found! Using standard values.";
488
489
			}
		}
Micha Mueller's avatar
Micha Mueller committed
490

Micha Müller's avatar
Micha Müller committed
491
492
493
494
495
496
497
        //read in values inherited from EntityInterface
        BOOST_FOREACH(boost::property_tree::iptree::value_type &val, config) {
            if (boost::iequals(val.first, "mqttPart")) {
                sEntity.setMqttPart(val.second.data());
            }
        }

498
		sensorEntity(sEntity, config);
Micha Mueller's avatar
Micha Mueller committed
499
500
501
502

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

600
		return true;
601
	}
602
	///@}
603

604
605
	///@name Overwrite in plugin
	///@{
606
	/**
607
	 * Method responsible for reading plugin-specific sensor base values.
608
	 *
Micha Mueller's avatar
Micha Mueller committed
609
	 * @param s			The sensor base for which to set the values
610
611
	 * @param config	A boost property (sub-)tree containing the sensor values
	 */
Micha Mueller's avatar
Micha Mueller committed
612
	virtual void sensorBase(SBase& s, CFG_VAL config) = 0;
613
614

	/**
615
	 * Method responsible for reading plugin-specific sensor group values.
616
	 *
Micha Mueller's avatar
Micha Mueller committed
617
	 * @param s			The sensor group for which to set the values
618
	 * @param config	A boost property (sub-)tree containing the group values
619
	 */
Micha Mueller's avatar
Micha Mueller committed
620
	virtual void sensorGroup(SGroup& s, CFG_VAL config) = 0;
621

622
	/**
623
	 * Method responsible for reading plugin-specific sensor entity values.
624
	 *
Micha Mueller's avatar
Micha Mueller committed
625
	 * @param s			The sensor entity for which to set the values
626
627
	 * @param config	A boost property (sub-)tree containing the entity values
	 */
628
629
	virtual void sensorEntity(SEntity& s, CFG_VAL config) = 0;
	///@}
630

631
632
633
634
635
636
637
638
639
640
641
	///@name Utility
	///@{
    /**
     * @brief Store a sensor group internally.
     *
     * @param sGroup Group to store.
     */
    void storeSensorGroup(SG_Ptr sGroup) {
        _sensorGroups.push_back(sGroup);
        _sensorGroupInterfaces.push_back(sGroup);
    }
Micha Mueller's avatar
Micha Mueller committed
642
643

	/**
644
	 * @brief Adjusts the names of the sensors in generated groups.
Micha Mueller's avatar
Micha Mueller committed
645
	 *
646
	 * @return True if successful, false otherwise.
Alessio Netti's avatar
Alessio Netti committed
647
	 */
648
649
	bool constructSensorTopics() {
		// Sensor names are adjusted according to the respective MQTT topics
650
651
		for(auto& g: _sensorGroups) {
			for(auto& s: g->acquireSensors()) {
652
653
654
655
				s->setMqtt(MQTTChecker::formatTopic(_mqttPrefix) +
				           MQTTChecker::formatTopic(g->getEntity()->getMqttPart()) +
				           MQTTChecker::formatTopic(g->getMqttPart()) +
				           MQTTChecker::formatTopic(s->getMqtt()));
656
				s->setName(s->getMqtt());
657
658
				if(s->getSinkPath()!="")
					s->setSinkPath(MQTTChecker::topicToFile(s->getMqtt(), s->getSinkPath()));
659
			}
660
661
			g->releaseSensors();
		}
Alessio Netti's avatar
Alessio Netti committed
662
		return true;
Alessio Netti's avatar
Alessio Netti committed
663
	}
664
	///@}
Alessio Netti's avatar
Alessio Netti committed
665

666
667
	std::string		_entityName;
	std::string		_groupName;
668
	std::string		_baseName;
669

670
	std::vector<SG_Ptr>		_sensorGroups;
671
	std::vector<SEntity*>	_sensorEntitys;
Michael Ott's avatar
Michael Ott committed
672
	sBaseMap_t		_templateSensorBases;
673
674
	sGroupMap_t		_templateSensorGroups;
	sEntityMap_t	_templateSensorEntitys;
675
676
};

677
678
679
680
681
682
683
684

////////////////////////////////////////////////////////////////////////////////
// Partial template specialization for SEntity = nullptr_t
////////////////////////////////////////////////////////////////////////////////


/**
 * @brief Partial interface template specialization for plugin configurator
685
 *        implementations without entities.
686
 *
687
688
689
690
691
692
 * @details There is a general template for plugins with entities, see
 *          ConfiguratorTemplate. Common code is moved to ConfiguratorInterface
 *          if possible. If not, common code has to be duplicated and maintained
 *          twice here and in ConfiguratorTemplate. However, having two
 *          templates for cases with and without entities allows for simplified
 *          derived plugin configurators.
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
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
 *
 * @ingroup pusherplugins
 */
template <class SBase, class SGroup>
class ConfiguratorTemplate<SBase, SGroup, nullptr_t> : 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<SensorGroupInterface, SGroup>::value, "SGroup must derive from SensorGroupInterface!");

protected:
    //TODO use smart pointers
    typedef std::map<std::string, SBase*> sBaseMap_t;
    typedef std::map<std::string, SGroup*> sGroupMap_t;

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

public:
    ConfiguratorTemplate() :
        ConfiguratorInterface(),
        _groupName("INVALID"),
        _baseName("INVALID"){}

    virtual ~ConfiguratorTemplate() {
        for (auto tb : _templateSensorBases) {
            delete tb.second;
        }
        for (auto tg : _templateSensorGroups) {
            delete tg.second;
        }
        _sensorGroups.clear();
        _templateSensorBases.clear();
        _templateSensorGroups.clear();
    }

    /**
     * @brief Read in the given configuration
     *
     * @details Overwriting this method is only required if a custom logic is really necessary!
     *
     * @param   cfgPath Path to the config-file
     *
     * @return  True on success, false otherwise
     */
    bool readConfig(std::string cfgPath) {
        _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 groups and templates for groups. If present also entity/-template stuff
        BOOST_FOREACH(boost::property_tree::iptree::value_type &val, cfg) {
            //template group
            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());
                    if (readSensorGroup(*group, val.second, true)) {
                        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 {
                        LOG(warning) << "Template " << _groupName << " \""
                                     << val.second.data() << "\" has bad values! Ignoring...";
                        delete group;
                    }
                }
            //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());
                    if (readSensorBase(*base, val.second, true)) {
                        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;
                    }
                }
            //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());
                    if (readSensorGroup(*group, val.second, true)) {
                        //group which consists of only one sensor
                        SB_Ptr sensor = std::make_shared<SBase>(val.second.data());
                        if (readSensorBase(*sensor, val.second, true)) {
                            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;
                    }
                }
            //group
            } else if (boost::iequals(val.first, _groupName)) {
                LOG(debug) << _groupName << " \"" << val.second.data() << "\"";
                if (!val.second.empty()) {
                    SG_Ptr group = std::make_shared<SGroup>(val.second.data());
                    if (readSensorGroup(*group, val.second)) {
                        storeSensorGroup(group);
                    } else {
                        LOG(warning) << _groupName << " \""
                                     << val.second.data() << "\" has bad values! Ignoring...";
                    }
                }
            //single sensor
            } else if (boost::iequals(val.first, "single_" + _baseName)) {
                LOG(debug) << "Single " << _baseName << " \"" << val.second.data() << "\"";
                if (!val.second.empty()) {
                    SG_Ptr group = std::make_shared<SGroup>(val.second.data());
                    if (readSensorGroup(*group, val.second)) {
                        //group which consists of only one sensor
                        SB_Ptr sensor;
                        //perhaps one sensor is already present because it was copied from the template group
832
833
834
835
                        if (group->acquireSensors().size() != 0) {
                            group->releaseSensors();
                            sensor = std::dynamic_pointer_cast<SBase>(group->acquireSensors()[0]);
                            group->releaseSensors();
836
837
838
839
840
841
842
843
844
845
846
847
848
849
                            //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";
                                }
                            } else {
                                LOG(warning) << "Single " << _baseName << " "
                                             << val.second.data() << " had a type mismatch when casting! Omitting";
                            }
                        } else {
850
                            group->releaseSensors();
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
                            sensor = std::make_shared<SBase>(val.second.data());
                            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...";
                    }
                }
            } else if( !boost::iequals(val.first, "global") ) {
                LOG(error) << "\"" << val.first << "\": unknown construct!";
                return false;
            }
        }
        //read of config finished. Now we build the mqtt-topic for every sensor
        return constructSensorTopics();
    }

    /**
     * @brief Clear internal storage and return plugin in unconfigured state.
     */
    void clearConfig() final {
        ConfiguratorInterface::clearConfig();
        //bring everything to a halt
        for(auto g : _sensorGroups) {
            g->stop();
        }

        //clean up sensors/groups and templates
        for (auto tb : _templateSensorBases) {
            delete tb.second;
        }
        for (auto tg : _templateSensorGroups) {
            delete tg.second;
        }
        _sensorGroups.clear();
        _templateSensorBases.clear();
        _templateSensorGroups.clear();
    }

    /**
     * @brief Print configuration.
     *
     * @param ll Log severity level to be used from logger.
     */
    void printConfig(LOG_LEVEL ll) final {
        ConfiguratorInterface::printConfig(ll);

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

        LOG_VAR(ll) << "    " << _groupName << "s:";
        for(auto g : _sensorGroups) {
            g->printConfig(ll);
        }
    }

protected:

    ///@name Template-internal use only
    ///@{
    /**
     * @brief Read common values of a sensorbase.
     *
     * @details Reads and sets the common base values of a sensor base
     *          (currently none), then calls sensorBase() 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 values.
     * @param isTemplate Are we parsing a template or a regular sensor?
     *
     * @return  True on success, false otherwise
     */
    bool readSensorBase(SBase& sBase, CFG_VAL config, bool isTemplate=false) {
        sBase.setCacheInterval(_cacheInterval);
        if (!isTemplate) {
            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 = _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.";
                }
            }
        }

        BOOST_FOREACH(boost::property_tree::iptree::value_type &val, config) {
            if (boost::iequals(val.first, "mqttsuffix")) {
                sBase.setMqtt(val.second.data());
            } else if (boost::iequals(val.first, "skipConstVal")) {
                sBase.setSkipConstVal(to_bool(val.second.data()));
            } else if (boost::iequals(val.first, "delta")) {
                sBase.setDelta(to_bool(val.second.data()));
            } 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()));
            }
        }
        sensorBase(sBase, config);
        return true;
    }

    /**
     * @brief Read common values of a sensorGroup.
     *
     * @details Reads and sets the common base values of a sensor group
     *          (currently none), then calls sensorGroup() to read plugin
     *          specific values.
     *
     * @param sGroup     The sensor group for which to set the values.
     * @param config     A boost property (sub-)tree containing the values.
     * @param isTemplate Are we parsing a template or a regular group?
     *
     * @return  True on success, false otherwise
     */
    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.";
                }
            }
        }

        //read in values inherited from SensorGroupInterface
        BOOST_FOREACH(boost::property_tree::iptree::value_type &val, config) {
            if (boost::iequals(val.first, "interval")) {
                sGroup.setInterval(stoull(val.second.data()));
            } else if (boost::iequals(val.first, "minValues")) {
                sGroup.setMinValues(stoull(val.second.data()));
            } else if (boost::iequals(val.first, "mqttPart")) {
                sGroup.setMqttPart(val.second.data());
            } else if (boost::iequals(val.first, "sync")) {
                if (val.second.data() == "off") {
                    sGroup.setSync(false);
                } else {
                    sGroup.setSync(true);
                }
            } else if (boost::iequals(val.first, _baseName)) {
                if (!isTemplate) {
                    LOG(debug) << "  " << _baseName << " " << val.second.data();
                }
                SB_Ptr sensor = std::make_shared<SBase>(val.second.data());
                if (readSensorBase(*sensor, val.second, isTemplate)) {
                    sGroup.pushBackSensor(sensor);
                } else if (!isTemplate) {
                    LOG(warning) << _baseName << " " << sGroup.getGroupName() << "::"
                                 << sensor->getName() << " could not be read! Omitting";
                }
            }
        }

        sensorGroup(sGroup, config);
        return true;
    }
    ///@}

    ///@name Overwrite in plugin
    ///@{
    /**
     * Method responsible for reading plugin-specific sensor base values.
     *
     * @param s         The sensor base for which to set the values
     * @param config    A boost property (sub-)tree containing the sensor values
     */
    virtual void sensorBase(SBase& s, CFG_VAL config) = 0;

    /**
     * Method responsible for reading plugin-specific sensor group values.
     *
     * @param s         The sensor group for which to set the values
     * @param config    A boost property (sub-)tree containing the group values
     */
    virtual void sensorGroup(SGroup& s, CFG_VAL config) = 0;
    ///@}

    ///@name Utility
    ///@{
    /**
     * @brief Store a sensor group internally.
     *
     * @param sGroup Group to store.
     */
    void storeSensorGroup(SG_Ptr sGroup) {
        _sensorGroups.push_back(sGroup);
        _sensorGroupInterfaces.push_back(sGroup);
    }

    /**
     * @brief Adjusts the names of the sensors in generated groups.
     *
     * @return True if successful, false otherwise.
     */
    bool constructSensorTopics() {
        // Sensor names are adjusted according to the respective MQTT topics
        for(auto& g: _sensorGroups)
1069
            for(auto& s: g->acquireSensors()) {
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
                s->setMqtt(MQTTChecker::formatTopic(_mqttPrefix) +
                           MQTTChecker::formatTopic(g->getMqttPart()) +
                           MQTTChecker::formatTopic(s->getMqtt()));
                s->setName(s->getMqtt());
                if(s->getSinkPath()!="")
                    s->setSinkPath(MQTTChecker::topicToFile(s->getMqtt(), s->getSinkPath()));
            }
        return true;
    }
    ///@}

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

    std::vector<SG_Ptr>     _sensorGroups;
    sBaseMap_t      _templateSensorBases;
    sGroupMap_t     _templateSensorGroups;
};

1089
#endif /* SRC_CONFIGURATORTEMPLATE_H_ */