2 * collectd - src/freeswitch.c
3 * Copyright (C) 2009 Leon de Rooij
4 * Copyright (C) 2005-2007 Florian octo Forster
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; only version 2 of the License is applicable.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * Florian octo Forster <octo at verplant.org>
21 * Leon de Rooij <leon at scarlet-internet.nl>
27 #include "utils_match.h"
30 #define FS_DEF_HOST "127.0.0.1"
31 #define FS_DEF_PORT "8021"
32 #define FS_DEF_PASS "ClueCon"
39 * <Command "api sofia status profile res-public">
40 * Instance "profile-sofia-res-public"
43 * Regex "CALLS-IN\\s+([0-9]+)"
55 typedef struct fs_match_s fs_match_t;
67 typedef struct fs_command_s fs_command_t;
70 char *line; // "api sofia status profile res-public"
71 char *instance; // "profile-sofia-res-public"
72 char *buffer; // <output from esl command as a char*>
73 size_t buffer_size; // strlen(*buffer)+3
74 size_t buffer_fill; // 0 or 1
79 static fs_command_t *fs_commands_g = NULL;
81 static char *fs_host = NULL;
82 static char *fs_port = NULL;
83 static char *fs_pass = NULL;
85 static esl_handle_t esl_handle = {{0}};
86 // static int thread_running = 0; // for when subscribing to esl events
92 static int fs_config_add_string (const char *name, char **dest, oconfig_item_t *ci)
94 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
96 WARNING ("freeswitch plugin: '%s' needs exactly one string argument.", name);
101 *dest = strdup (ci->values[0].value.string);
106 } /* int fs_config_add_string */
108 static void fs_match_free (fs_match_t *fm)
115 sfree (fm->instance);
116 match_destroy (fm->match);
117 fs_match_free (fm->next);
119 } /* void fs_match_free */
121 static void fs_command_free (fs_command_t *fc)
127 sfree (fc->instance);
129 fs_match_free (fc->matches);
130 fs_command_free (fc->next);
132 } /* void fs_command_free */
134 static int fs_config_add_match_dstype (int *dstype_ret, oconfig_item_t *ci)
138 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
140 WARNING ("freeswitch plugin: 'DSType' needs exactly one string argument.");
144 if (strncasecmp ("Gauge", ci->values[0].value.string, strlen ("Gauge")) == 0)
146 dstype = UTILS_MATCH_DS_TYPE_GAUGE;
147 if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
148 dstype |= UTILS_MATCH_CF_GAUGE_AVERAGE;
149 else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
150 dstype |= UTILS_MATCH_CF_GAUGE_MIN;
151 else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
152 dstype |= UTILS_MATCH_CF_GAUGE_MAX;
153 else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
154 dstype |= UTILS_MATCH_CF_GAUGE_LAST;
158 else if (strncasecmp ("Counter", ci->values[0].value.string, strlen ("Counter")) == 0)
160 dstype = UTILS_MATCH_DS_TYPE_COUNTER;
161 if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
162 dstype |= UTILS_MATCH_CF_COUNTER_SET;
163 else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
164 dstype |= UTILS_MATCH_CF_COUNTER_ADD;
165 else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
166 dstype |= UTILS_MATCH_CF_COUNTER_INC;
177 WARNING ("freeswitch plugin: `%s' is not a valid argument to `DSType'.",
178 ci->values[0].value.string);
182 *dstype_ret = dstype;
184 } /* int fs_config_add_match_dstype */
186 static int fs_config_add_match (fs_command_t *fs_command, oconfig_item_t *ci)
188 fs_match_t *fs_match;
192 if (ci->values_num != 0)
194 WARNING ("freeswitch plugin: Ignoring arguments for the 'Match' block.");
197 fs_match = (fs_match_t *) malloc (sizeof (*fs_match));
198 if (fs_match == NULL)
200 ERROR ("freeswitch plugin: malloc failed.");
203 memset (fs_match, 0, sizeof (*fs_match));
206 for (i = 0; i < ci->children_num; i++)
208 oconfig_item_t *child = ci->children + i;
210 if (strcasecmp ("Regex", child->key) == 0)
211 status = fs_config_add_string ("Regex", &fs_match->regex, child);
212 else if (strcasecmp ("DSType", child->key) == 0)
213 status = fs_config_add_match_dstype (&fs_match->dstype, child);
214 else if (strcasecmp ("Type", child->key) == 0)
215 status = fs_config_add_string ("Type", &fs_match->type, child);
216 else if (strcasecmp ("Instance", child->key) == 0)
217 status = fs_config_add_string ("Instance", &fs_match->instance, child);
220 WARNING ("freeswitch plugin: Option `%s' not allowed here.", child->key);
226 } /* for (i = 0; i < ci->children_num; i++) */
230 if (fs_match->regex == NULL)
232 WARNING ("freeswitch plugin: `Regex' missing in `Match' block.");
236 if (fs_match->type == NULL)
238 WARNING ("freeswitch plugin: `Type' missing in `Match' block.");
242 if (fs_match->dstype == 0)
244 WARNING ("freeswitch plugin: `DSType' missing in `Match' block.");
249 } /* while (status == 0) */
254 fs_match->match = match_create_simple (fs_match->regex, fs_match->dstype);
255 if (fs_match->match == NULL)
257 ERROR ("freeswitch plugin: tail_match_add_match_simple failed.");
258 fs_match_free (fs_match);
265 prev = fs_command->matches;
266 while ((prev != NULL) && (prev->next != NULL))
270 fs_command->matches = fs_match;
272 prev->next = fs_match;
276 } /* int fs_config_add_match */
278 static int fs_config_add_command (oconfig_item_t *ci)
280 fs_command_t *command;
284 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
286 WARNING ("freeswitch plugin: 'Command' blocks need exactly one string argument.");
290 command = (fs_command_t *) malloc (sizeof (*command));
293 ERROR ("freeswitch plugin: malloc failed.");
296 memset (command, 0, sizeof (*command));
298 command->line = NULL;
299 command->line = strdup (ci->values[0].value.string);
301 if (command->line == NULL)
303 ERROR ("freeswitch plugin: strdup failed.");
308 /* Process all children */
310 for (i = 0; i < ci->children_num; i++)
312 oconfig_item_t *child = ci->children + i;
314 if (strcasecmp ("Instance", child->key) == 0)
315 status = fs_config_add_string ("Instance", &command->instance, child);
316 else if (strcasecmp ("Match", child->key) == 0)
317 fs_config_add_match (command, child);
320 WARNING ("freeswitch plugin: Option '%s' not allowed here.", child->key);
330 fs_command_free (command);
334 /* Add the new command to the linked list */
335 if (fs_commands_g == NULL)
336 fs_commands_g = command;
341 prev = fs_commands_g;
342 while ((prev != NULL) && (prev->next != NULL))
344 prev->next = command;
348 } /* int fs_config_add_command */
350 static int fs_complex_config (oconfig_item_t *ci)
360 for (i = 0; i < ci->children_num; i++)
362 oconfig_item_t *child = ci->children + i;
364 if (strcasecmp ("Host", child->key) == 0)
366 if (fs_host != NULL) free (fs_host);
367 fs_host = strdup(child->values[0].value.string);
369 else if (strcasecmp ("Port", child->key) == 0)
371 if (fs_port != NULL) free (fs_port);
372 fs_port = strdup(child->values[0].value.string);
374 else if (strcasecmp ("Pass", child->key) == 0)
376 if (fs_pass != NULL) free (fs_pass);
377 fs_pass = strdup(child->values[0].value.string);
379 else if (strcasecmp ("Command", child->key) == 0)
381 status = fs_config_add_command(child);
389 WARNING ("freeswitch plugin: Option '%s' not allowed here.", child->key);
394 if ((success == 0) && (errors > 0))
396 ERROR ("freeswitch plugin: All statements failed.");
401 } /* int fs_complex_config */
403 static void fs_submit (const fs_command_t *fc,
404 const fs_match_t *fm, const cu_match_value_t *mv)
407 value_list_t vl = VALUE_LIST_INIT;
409 values[0] = mv->value;
413 vl.time = time (NULL);
415 strncpy (vl.host, hostname_g, sizeof (vl.host));
416 strncpy (vl.plugin, "freeswitch", sizeof (vl.plugin));
417 strncpy (vl.plugin_instance, fc->instance, sizeof (vl.plugin_instance));
418 strncpy (vl.type, fm->type, sizeof (vl.type));
419 strncpy (vl.type_instance, fm->instance, sizeof (vl.type_instance));
421 plugin_dispatch_values (&vl);
422 } /* void fs_submit */
424 static int fs_read_command (fs_command_t *fc)
429 /* can't the following be done nicer ? */
431 line = (char *) malloc (strlen(fc->line)+3);
432 snprintf(line, strlen(fc->line)+3, "%s\n\n", fc->line);
433 esl_send_recv(&esl_handle, line);
437 if (esl_handle.last_sr_event && esl_handle.last_sr_event->body)
440 fc->buffer = strdup(esl_handle.last_sr_event->body);
441 fc->buffer_size = strlen(fc->buffer);
445 for (fm = fc->matches; fm != NULL; fm = fm->next)
447 cu_match_value_t *mv;
449 status = match_apply (fm->match, fc->buffer);
452 WARNING ("freeswitch plugin: match_apply failed.");
456 mv = match_get_user_data (fm->match);
459 WARNING ("freeswitch plugin: match_get_user_data returned NULL.");
463 fs_submit (fc, fm, mv);
464 } /* for (fm = fc->matches; fm != NULL; fm = fm->next) */
467 } /* int fs_read_command */
469 static int fs_read (void)
473 for (fc = fs_commands_g; fc != NULL; fc = fc->next)
474 fs_read_command (fc);
480 static void *msg_thread_run(esl_thread_t *me, void *obj)
482 esl_handle_t *esl_handle = (esl_handle_t *) obj;
485 // Maybe do some more in this loop later, like receive subscribed events,
486 // and create statistics of them
487 // see fs_cli.c function static void *msg_thread_run(), around line 198
488 while (thread_running && esl_handle->connected)
490 esl_status_t status = esl_recv_event_timed(esl_handle, 10, 1, NULL);
491 if (status == ESL_FAIL)
493 //DEBUG ("Disconnected [%s]\n", ESL_LOG_WARNING); // todo fixit
494 DEBUG ("Disconnected [%s]\n", "ESL_LOG_WARNING");
502 } */ /* void *msg_thread_run */
504 static int fs_init (void)
506 /* Set some default configuration variables */
507 if (fs_host == NULL) fs_host = FS_DEF_HOST;
508 if (fs_port == NULL) fs_port = FS_DEF_PORT;
509 if (fs_pass == NULL) fs_pass = FS_DEF_PASS;
511 /* Connect to FreeSWITCH over ESL */
512 DEBUG ("freeswitch plugin: making ESL connection to %s %s %s\n", fs_host, fs_port, fs_pass);
513 if (esl_connect(&esl_handle, fs_host, atoi(fs_port), fs_pass))
515 ERROR ("freeswitch plugin: connection failed [%s]", esl_handle.err);
519 /* Start a seperate thread for incoming events here */
520 //esl_thread_create_detached(msg_thread_run, &esl_handle);
525 static int fs_shutdown (void)
527 DEBUG ("freeswitch plugin: disconnecting");
528 if (esl_handle.connected) esl_disconnect(&esl_handle);
529 fs_command_free (fs_commands_g);
530 fs_commands_g = NULL;
532 } /* int fs_shutdown */
534 void module_register (void)
536 plugin_register_complex_config ("freeswitch", fs_complex_config);
537 plugin_register_init ("freeswitch", fs_init);
538 plugin_register_read ("freeswitch", fs_read);
539 plugin_register_shutdown ("freeswitch", fs_shutdown);
540 } /* void module_register */