Source

quechua / src / modules.cc

Full commit
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
/* 
 * Quechua - the lightweight data mining framework
 *
 * Copyright (C) 2012 Marek Denis <quechua@octogan.net>
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */

#include <libconfig.h++>

#include "../include/modules.h"
#include "../include/quechua.h"

Module::Module(const string_t& name,const string_t& path,
                   g_module* module) {
    this->name = name;
    this->path = path;
    this->module=module;
}

Module::~Module() {
    LOG(INFO) << "Unloading module " << name << " from " << path;
    delete module;
}

const string_t& Module::get_name() const {
    return name;
}

const string_t& Module::get_path() const {
    return path;
}

g_module* Module::get_module() const {
    return module;
}

bool Module::get_symbol(const string_t& symbol_name, void*& symbol)
{
    return module->get_symbol(symbol_name,symbol);
}
bool Modules::load_modules(const configuration_t& config) {
    int length;
    if(!config.exists("quechua.libraries")) {
        LOG(ERROR) << "quechua.libraries entry not found in the configuration file";
        return false;
    }

    setting_t& libraries = config.lookup("quechua.libraries");
    
    if(!libraries.exists("load")) {
        LOG(ERROR) << "quechua.libraries.load entry not found in the configuration file";
        return false;
    }

    length = libraries["load"].getLength();
    for(int i=0;i<length;++i) {
        string_t libfile;
        Module *module = NULL;
        try {
            const string_t libname = libraries["load"][i];
            bool loaded = libraries["files"].lookupValue(libname, libfile);
            if(!loaded){
                LOG(WARN) << "Module name " << libname
                          << " not presented in 'files' dictionary in the configuration "
                          << " skipping...";
                continue;
            }
            if(module_loaded(libname)){
                LOG(WARN) << "Module " << libname 
                          << " already loaded, skipping";
                continue;
            }
            
            string_t path = path_prefix + libfile;

            LOG(INFO) << "Loading module " << path << " ...";
            g_module* shared_module = NULL;
            shared_module = new g_module(path);
            
            if(!shared_module || !(*(shared_module))) {
                LOG(ERROR) << "Error loading module " << libname
                           << " from " << path << ". "
                           << shared_module->get_last_error();
                continue;
            }

            module = new Module(libname,path,shared_module);
                
            if(!modules.insert(std::pair<string_t,Module*>(module->get_name(),module)).second) {
                LOG(ERROR) << "Error when inserting module " << module->get_name();
                delete module;
                continue;
            }
            
        } catch(setting_ex& ex) {
            LOG(ERROR) << "Setting not found";
            if(module)
                delete module;
            continue;
        } catch(parse_ex& ex) {
            LOG(ERROR) << "Error while parsing configuration file:" << ex.what();
            if(module)
                delete module;
            continue;
        }
    }
    return true;
}
bool Modules::load_components(const configuration_t& config) {
    if(!config.exists("quechua.channels")) {
        LOG(WARN) << "No channels configured, how do you want to get your input?";
    }
    else {
        setting_t& channels = config.lookup("quechua.channels");
        load_channels(channels);
    }

    if(!config.exists("quechua.loggers")) {
        LOG(WARN) << "No loggers configured, how do you want to log your data?";
    }
    else {
        setting_t& loggers = config.lookup("quechua.loggers");
        load_loggers(loggers);
    }
    
    if(!config.exists("quechua.flows")) {
        LOG(WARN) << "No flows configures.";
    }
    else {
        setting_t& flows = config.lookup("quechua.flows");
        LOG(INFO) << "Loading workflows";
        load_workflows(flows);
    }
};

bool Modules::load_channels(const setting_t& channel_settings) {
    
    load_channel_ptr create_channel = NULL;
    if(!channel_settings.exists("load")) {
        LOG(WARN) << "quechua.channels.load entry not found";
        return false;
    }
    int length = channel_settings["load"].getLength();

    for(int i=0;i<length;++i) {
        string_t channel_name = channel_settings["load"][i];
        LOG(INFO) << "Loading channel " << channel_name;

        Module* module = load_module_s(channel_name);

        if(!module) {
            LOG(ERROR) << "Error while loading module " << channel_name
                       << " skipping";
            continue;
        }

        if(!(module->get_symbol("create_channel",(void*&)create_channel))) {
            LOG(ERROR) << "Cannot find function create_channel in module "
                       << module->get_path() << ", skipping";
            continue;
        }
        
        if(create_channel==NULL) {
            LOG(ERROR) << "load_channel pointer is NULL, skipping!";
            continue;
        }
        
        Channel* channel = NULL;  
        channel = create_channel();
        if(channel == NULL) {
            LOG(ERROR) << "Cannot create channel " << channel_name << " from module "
                       << module->get_path();
            continue;
        }
        
        channel->internal->name = channel_name;
        
        try {
            channel->load_misc_conf(channel_settings[channel_name]);
        } catch(setting_ex& ex) {
            LOG(WARN) << "Channel " << channel_name 
                      << ": Some settings were not found, check your config and/or channel implementation.";
        } catch(parse_ex& ex) {
            LOG(WARN) << "Channel " << channel_name 
                      << ": Options parsing error, check your config and/or channel implementation.";
        }


        if( (g_quechua->components->channels.insert(std::pair<string_t,Channel*>(channel_name,channel))).second) {
            LOG(INFO) << "Channel " << channel_name <<" loaded sucessfuly!";
        } else {
            LOG(WARN) << "Channel named " << channel_name << " already loaded";
            delete channel;
        }
    }
    return true;
};

bool Modules::load_loggers(const setting_t& logger_settings) {
    load_logger_ptr create_logger = NULL;
    if(!logger_settings.exists("load")) {
        LOG(WARN) << "quechua.loggers.load entry not found";
        return false;
    }
    int length = logger_settings["load"].getLength();
    for(int i=0;i<length;++i) {
        const string_t logger_name = logger_settings["load"][i];
        LOG(INFO) << "Loading logger " << logger_name << " ";

        Module* module = load_module_s(logger_name);

        if(!module) {
            LOG(ERROR) << "Error while loading module " << logger_name
                       << " skipping";
            continue;
        }
        if(!(module->get_symbol("create_logger",(void*&)create_logger))) {
            LOG(ERROR) << "Cannot find function create_logger in module "
                       << module->get_path() << " skipping";
            continue;
        }
        
        if(create_logger==NULL) {
            LOG(ERROR) << " Symbol create_logger() wasn't found!";
            continue;
        }
        
        Logger* logger = NULL; 

        logger = create_logger();
        if(logger == NULL) {
            LOG(ERROR) << "Cannot create logger " << logger_name << " from module "
                       << module->get_path();
            continue;
        }
        
        logger->internal->name = logger_name;
        try {
            logger->load_misc_conf(logger_settings[logger_name]);
        } catch(setting_ex& ex) {
            LOG(WARN) << "Logger " << logger_name 
                      << ": Some settings were not found, check your config and/or channel implementation.";
        } catch(parse_ex& ex) {
            LOG(WARN) << "Logger " << logger_name 
                      << ": Options parsing error, check your config and/or channel implementation.";
        }
        
        if( (g_quechua->components->loggers.insert(std::pair<string_t,Logger*>(logger_name,logger))).second) {
            LOG(INFO) << "Logger " << logger_name << " loaded sucessfuly!";
        } else {
             LOG(WARN) << "Logger named" << logger_name << " already inserted";
            delete logger;
       }
    }
    return true;
};

/**
 * Here's how it works:
 * 1) Create Workflow object
 * 2) Read the channel name from config and register 
 * 3) Read the logger name from the config and register 
 * 4) Create processor and algorithm object 
 * 5) store itself in the g_quechua workflows list 
 */
bool Modules::load_workflows(const setting_t& flow_settings) {
    if(!flow_settings.exists("load")) {
        LOG(WARN) << "quechua.flows.load not found, no workflows created";
        return false;
    }
    
    ushort length = flow_settings["load"].getLength();
    for(ushort i=0;i<length;++i) {
        const string_t flow_name = flow_settings["load"][i];
        
        if(!flow_settings.exists(flow_name)) {
            LOG(WARN) << "Workflow " << flow_name
                      << " not found in the config file, skipping.";
            continue;
        }
        
        Workflow* flow = new Workflow(flow_name,g_quechua->loop);
        try {
            flow->init_internals(flow_settings[flow_name]);
        } catch(const setting_ex& ex) {
            LOG(ERROR) << "Cannot find " << flow_name << " section in configuration file";
            delete flow;
//            return false;
            continue;
        };

        Channel* channel = NULL;
        Logger*  logger  = NULL;

        if( (channel = register_flow_in_channels(flow_settings[flow_name],flow,&(g_quechua->components->channels)))!=NULL) {
            flow->add_channel(channel);
        } else {
            LOG(WARN) << "Workflow " << flow_name << ": Couldn't find appropriate channel, skipping...";
        }
    
        if((logger = register_flow_in_loggers(flow_settings[flow_name],flow,&(g_quechua->components->loggers)))!=NULL) {
            flow->add_logger(logger);
        } else {
            LOG(WARN) << "Workflow " << flow_name << ": Couldn't find appripriate logger, skipping...";
        }

        
        if(!g_quechua->components->workflows.insert(
                std::pair<string_t,workflow_t>(flow_name,flow)).second) {
            LOG(ERROR) << "Workflow " << flow_name << " was not inserted into Quechua database";
            unregister_flow_from_channels(flow,channel);
  //          unregister_flow_from_loggers(flow,logger);
            delete flow;
            continue;
        }

    }
    return true;
}

Algorithm* Modules::load_algorithm(const string_t& algorithm_name,
                                   const setting_t& algorithm_settings) {
    Module* module = load_module_s(algorithm_name);

    if(!module) {
        LOG(ERROR) << "Error while loading algorithm " << algorithm_name
                   << " skipping";
        return NULL;
    }

    load_algorithm_ptr create_algorithm = NULL;

    if(!(module->get_symbol("create_algorithm",(void*&)create_algorithm))) {
        LOG(ERROR) << "Symbol create_algorithm() was not found in module "
                   << module->get_path() << " skipping";
        return NULL;
    }
    
    if(create_algorithm==NULL) {
        LOG(ERROR) << "Symbol create_algorithm() is set to NULL";
        return NULL;
    }
    
    Algorithm* algorithm = NULL;  
    algorithm = create_algorithm();

    if(algorithm == NULL) {
        LOG(ERROR) << "Cannot create algorithm " << algorithm_name << " from module "
                   << module->get_path();
        return NULL;
    }
    algorithm->internal->name = algorithm_name;

    try {
        algorithm->load_misc_conf(algorithm_settings);
    } catch(setting_ex& ex) {
        LOG(WARN) << "Algorithm " << algorithm_name 
                  << ": Some settings were not found, check your config and/or algorithm implementation.";
    } catch(parse_ex& ex) {
        LOG(WARN) << "Algorithm " << algorithm_name
                  << ": Options parsing error, check your config and/or algorithm implementation.";
    }

    return algorithm;
};

Processor* Modules::load_processor(const string_t& processor_name,
                                   const setting_t& processor_settings) {

    Module* module = load_module_s(processor_name);

    if(!module) {
        LOG(ERROR) << "Error while loading module " << processor_name
                   << " skipping";
        return NULL;
    }

    load_processor_ptr create_processor = NULL;

    if(!(module->get_symbol("create_processor",(void*&)create_processor))) {
        LOG(ERROR) << "Cannot find function create_processor in module "
                   << module->get_path() << " skipping";
        return NULL;
    }
    
    if(create_processor==NULL) {
        LOG(ERROR) << "Symbol create_processor IS STILL NULL!";
        return NULL;
    }
    
    Processor* processor = NULL;  
    processor = create_processor();

    if(processor == NULL) {
        LOG(ERROR) << "Cannot create processor " << processor_name << " from module "
                   << module->get_path();
        return NULL;

    }


    processor->internal->name = processor_name;
    
    try {
        processor->load_misc_conf(processor_settings);
    } catch(setting_ex& ex) {
        LOG(WARN) << "Processor " << processor_name 
                  << ": Some settings were not found, check your config and/or processor implementation.";
    } catch(parse_ex& ex) {
        LOG(WARN) << "Processor " << processor_name
                  << ": Options parsing error, check your config and/or processor implementation.";
    }

    return processor;
};

size_t Modules::size() {
    return modules.size();
}

Module* Modules::load_module_s(const string_t& kName) {
    Module* module = NULL;
    
    map_module_it module_it;
    if( (module_it=modules.find(kName)) == modules.end() ){
        LOG(ERROR) << "Module " << kName << " not loaded";
        return NULL;
    }

    module = module_it->second;
    
    return module;
}

bool Modules::module_loaded(const string_t& modname) {
    if(modules.find(modname)!=modules.end())
        return true;
    return false;
}

Channel* const register_flow_in_channels(const setting_t& flow_settings,
                               Workflow* flow,
                               channels_map* channels) {
    string_t channel_name;
    flow_settings.lookupValue("channel",channel_name);
    channels_map_it map_it = channels->find(channel_name);
    if(map_it==channels->end()) {
        LOG(WARN) << "Channel " << channel_name <<  "was not loaded";
        return NULL;
    }
    Channel* channel = map_it->second;
    channel->record(flow);
    return channel;
}

void unregister_flow_from_channels(Workflow* flow, Channel* channel) {
  channel->unrecord(flow); 
}


/**
 * TODO(marek): Change the name to be more accurate
 **/ 

Logger* const register_flow_in_loggers(const setting_t& flow_settings,Workflow* flow, loggers_map* loggers) {
    string_t logger_name;
    flow_settings.lookupValue("logger",logger_name);
    loggers_map_it map_it = loggers->find(logger_name);
    if(map_it==loggers->end()) {
        LOG(WARN) << "Logger " << logger_name << " was not loaded";
        return NULL;
    }
    Logger* logger = map_it->second;
    return logger; 
}
void unregister_flow_from_loggers(Workflow* flow, Logger* logger) {

    LOG(WARN) << "ATTENTION: In this version function unregister_flow_from_loggers() does nothing!"
              << " Do not rely on it!";
//    logger->unrecord(flow);
}