3301e81e7fc1881d03cfaaf50229222f3cd6c95c
[asterisk/asterisk.git] / main / cel.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007 - 2009, Digium, Inc.
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*!
18  * \file
19  *
20  * \brief Channel Event Logging API
21  *
22  * \author Steve Murphy <murf@digium.com>
23  * \author Russell Bryant <russell@digium.com>
24  *
25  * \todo Do thorough testing of all transfer methods to ensure that BLINDTRANSFER,
26  *       ATTENDEDTRANSFER, BRIDGE_START, and BRIDGE_END events are all reported
27  *       as expected.
28  */
29
30 /*** MODULEINFO
31         <support_level>core</support_level>
32  ***/
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include "asterisk/_private.h"
39
40 #include "asterisk/channel.h"
41 #include "asterisk/pbx.h"
42 #include "asterisk/cel.h"
43 #include "asterisk/logger.h"
44 #include "asterisk/linkedlists.h"
45 #include "asterisk/utils.h"
46 #include "asterisk/config.h"
47 #include "asterisk/cli.h"
48 #include "asterisk/astobj2.h"
49
50 /*! Is the CEL subsystem enabled ? */
51 static unsigned char cel_enabled;
52
53 /*! \brief CEL is off by default */
54 #define CEL_ENABLED_DEFAULT             0
55
56 /*!
57  * \brief which events we want to track
58  *
59  * \note bit field, up to 64 events
60  */
61 static int64_t eventset;
62
63 /*!
64  * \brief Maximum possible CEL event IDs
65  * \note This limit is currently imposed by the eventset definition
66  */
67 #define CEL_MAX_EVENT_IDS 64
68
69 /*!
70  * \brief Track no events by default.
71  */
72 #define CEL_DEFAULT_EVENTS      0
73
74 /*!
75  * \brief Number of buckets for the appset container
76  */
77 #define NUM_APP_BUCKETS         97
78
79 /*!
80  * \brief Container of Asterisk application names
81  *
82  * The apps in this container are the applications that were specified
83  * in the configuration as applications that CEL events should be generated
84  * for when they start and end on a channel.
85  */
86 static struct ao2_container *appset;
87 static struct ao2_container *linkedids;
88
89 /*!
90  * \brief Configured date format for event timestamps
91  */
92 static char cel_dateformat[256];
93
94 /*!
95  * \brief Map of ast_cel_event_type to strings
96  */
97 static const char * const cel_event_types[CEL_MAX_EVENT_IDS] = {
98         [0]                        = "ALL",
99         [AST_CEL_CHANNEL_START]    = "CHAN_START",
100         [AST_CEL_CHANNEL_END]      = "CHAN_END",
101         [AST_CEL_ANSWER]           = "ANSWER",
102         [AST_CEL_HANGUP]           = "HANGUP",
103         [AST_CEL_APP_START]        = "APP_START",
104         [AST_CEL_APP_END]          = "APP_END",
105         [AST_CEL_BRIDGE_START]     = "BRIDGE_START",
106         [AST_CEL_BRIDGE_END]       = "BRIDGE_END",
107         [AST_CEL_BRIDGE_UPDATE]    = "BRIDGE_UPDATE",
108         [AST_CEL_CONF_START]       = "CONF_START",
109         [AST_CEL_CONF_END]         = "CONF_END",
110         [AST_CEL_PARK_START]       = "PARK_START",
111         [AST_CEL_PARK_END]         = "PARK_END",
112         [AST_CEL_TRANSFER]         = "TRANSFER",
113         [AST_CEL_USER_DEFINED]     = "USER_DEFINED",
114         [AST_CEL_CONF_ENTER]       = "CONF_ENTER",
115         [AST_CEL_CONF_EXIT]        = "CONF_EXIT",
116         [AST_CEL_BLINDTRANSFER]    = "BLINDTRANSFER",
117         [AST_CEL_ATTENDEDTRANSFER] = "ATTENDEDTRANSFER",
118         [AST_CEL_PICKUP]           = "PICKUP",
119         [AST_CEL_FORWARD]          = "FORWARD",
120         [AST_CEL_3WAY_START]       = "3WAY_START",
121         [AST_CEL_3WAY_END]         = "3WAY_END",
122         [AST_CEL_HOOKFLASH]        = "HOOKFLASH",
123         [AST_CEL_LINKEDID_END]     = "LINKEDID_END",
124 };
125
126 /*!
127  * \brief Map of ast_cel_ama_flags to strings
128  */
129 static const char * const cel_ama_flags[AST_CEL_AMA_FLAG_TOTAL] = {
130         [AST_CEL_AMA_FLAG_NONE]          = "NONE",
131         [AST_CEL_AMA_FLAG_OMIT]          = "OMIT",
132         [AST_CEL_AMA_FLAG_BILLING]       = "BILLING",
133         [AST_CEL_AMA_FLAG_DOCUMENTATION] = "DOCUMENTATION",
134 };
135
136 unsigned int ast_cel_check_enabled(void)
137 {
138         return cel_enabled;
139 }
140
141 static int print_app(void *obj, void *arg, int flags)
142 {
143         struct ast_cli_args *a = arg;
144
145         ast_cli(a->fd, "CEL Tracking Application: %s\n", (const char *) obj);
146
147         return 0;
148 }
149
150 static void print_cel_sub(const struct ast_event *event, void *data)
151 {
152         struct ast_cli_args *a = data;
153
154         ast_cli(a->fd, "CEL Event Subscriber: %s\n",
155                         ast_event_get_ie_str(event, AST_EVENT_IE_DESCRIPTION));
156 }
157
158 static char *handle_cli_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
159 {
160         unsigned int i;
161         struct ast_event_sub *sub;
162
163         switch (cmd) {
164         case CLI_INIT:
165                 e->command = "cel show status";
166                 e->usage =
167                         "Usage: cel show status\n"
168                         "       Displays the Channel Event Logging system status.\n";
169                 return NULL;
170         case CLI_GENERATE:
171                 return NULL;
172         case CLI_HANDLER:
173                 break;
174         }
175
176         if (a->argc > 3) {
177                 return CLI_SHOWUSAGE;
178         }
179
180         ast_cli(a->fd, "CEL Logging: %s\n", cel_enabled ? "Enabled" : "Disabled");
181
182         if (!cel_enabled) {
183                 return CLI_SUCCESS;
184         }
185
186         for (i = 0; i < (sizeof(eventset) * 8); i++) {
187                 const char *name;
188
189                 if (!(eventset & ((int64_t) 1 << i))) {
190                         continue;
191                 }
192
193                 name = ast_cel_get_type_name(i);
194                 if (strcasecmp(name, "Unknown")) {
195                         ast_cli(a->fd, "CEL Tracking Event: %s\n", name);
196                 }
197         }
198
199         ao2_callback(appset, OBJ_NODATA, print_app, a);
200
201         if (!(sub = ast_event_subscribe_new(AST_EVENT_SUB, print_cel_sub, a))) {
202                 return CLI_FAILURE;
203         }
204         ast_event_sub_append_ie_uint(sub, AST_EVENT_IE_EVENTTYPE, AST_EVENT_CEL);
205         ast_event_report_subs(sub);
206         ast_event_sub_destroy(sub);
207         sub = NULL;
208
209         return CLI_SUCCESS;
210 }
211
212 static struct ast_cli_entry cli_status = AST_CLI_DEFINE(handle_cli_status, "Display the CEL status");
213
214 enum ast_cel_event_type ast_cel_str_to_event_type(const char *name)
215 {
216         unsigned int i;
217
218         for (i = 0; i < ARRAY_LEN(cel_event_types); i++) {
219                 if (!cel_event_types[i]) {
220                         continue;
221                 }
222
223                 if (!strcasecmp(name, cel_event_types[i])) {
224                         return i;
225                 }
226         }
227
228         return -1;
229 }
230
231 static int ast_cel_track_event(enum ast_cel_event_type et)
232 {
233         return (eventset & ((int64_t) 1 << et));
234 }
235
236 static void parse_events(const char *val)
237 {
238         char *events = ast_strdupa(val);
239         char *cur_event;
240
241         while ((cur_event = strsep(&events, ","))) {
242                 enum ast_cel_event_type event_type;
243
244                 cur_event = ast_strip(cur_event);
245                 if (ast_strlen_zero(cur_event)) {
246                         continue;
247                 }
248
249                 event_type = ast_cel_str_to_event_type(cur_event);
250
251                 if (event_type == 0) {
252                         /* All events */
253                         eventset = (int64_t) -1;
254                 } else if (event_type == -1) {
255                         ast_log(LOG_WARNING, "Unknown event name '%s'\n",
256                                         cur_event);
257                 } else {
258                         eventset |= ((int64_t) 1 << event_type);
259                 }
260         }
261 }
262
263 static void parse_apps(const char *val)
264 {
265         char *apps = ast_strdupa(val);
266         char *cur_app;
267
268         if (!ast_cel_track_event(AST_CEL_APP_START) && !ast_cel_track_event(AST_CEL_APP_END)) {
269                 ast_log(LOG_WARNING, "An apps= config line, but not tracking APP events\n");
270                 return;
271         }
272
273         while ((cur_app = strsep(&apps, ","))) {
274                 char *app;
275
276                 cur_app = ast_strip(cur_app);
277                 if (ast_strlen_zero(cur_app)) {
278                         continue;
279                 }
280
281                 if (!(app = ao2_alloc(strlen(cur_app) + 1, NULL))) {
282                         continue;
283                 }
284                 strcpy(app, cur_app);
285
286                 ao2_link(appset, app);
287                 ao2_ref(app, -1);
288                 app = NULL;
289         }
290 }
291
292 AST_MUTEX_DEFINE_STATIC(reload_lock);
293
294 static int do_reload(void)
295 {
296         struct ast_config *config;
297         const char *enabled_value;
298         const char *val;
299         int res = 0;
300         struct ast_flags config_flags = { 0, };
301         const char *s;
302
303         ast_mutex_lock(&reload_lock);
304
305         /* Reset all settings before reloading configuration */
306         cel_enabled = CEL_ENABLED_DEFAULT;
307         eventset = CEL_DEFAULT_EVENTS;
308         *cel_dateformat = '\0';
309         ao2_callback(appset, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL);
310
311         config = ast_config_load2("cel.conf", "cel", config_flags);
312
313         if (config == CONFIG_STATUS_FILEMISSING) {
314                 config = NULL;
315                 goto return_cleanup;
316         }
317
318         if ((enabled_value = ast_variable_retrieve(config, "general", "enable"))) {
319                 cel_enabled = ast_true(enabled_value);
320         }
321
322         if (!cel_enabled) {
323                 goto return_cleanup;
324         }
325
326         /* get the date format for logging */
327         if ((s = ast_variable_retrieve(config, "general", "dateformat"))) {
328                 ast_copy_string(cel_dateformat, s, sizeof(cel_dateformat));
329         }
330
331         if ((val = ast_variable_retrieve(config, "general", "events"))) {
332                 parse_events(val);
333         }
334
335         if ((val = ast_variable_retrieve(config, "general", "apps"))) {
336                 parse_apps(val);
337         }
338
339 return_cleanup:
340         ast_verb(3, "CEL logging %sabled.\n", cel_enabled ? "en" : "dis");
341
342         ast_mutex_unlock(&reload_lock);
343
344         if (config) {
345                 ast_config_destroy(config);
346         }
347
348         return res;
349 }
350
351 const char *ast_cel_get_type_name(enum ast_cel_event_type type)
352 {
353         return S_OR(cel_event_types[type], "Unknown");
354 }
355
356 const char *ast_cel_get_ama_flag_name(enum ast_cel_ama_flag flag)
357 {
358         if (flag < 0 || flag >= ARRAY_LEN(cel_ama_flags)) {
359                 ast_log(LOG_WARNING, "Invalid AMA flag: %d\n", flag);
360                 return "Unknown";
361         }
362
363         return S_OR(cel_ama_flags[flag], "Unknown");
364 }
365
366 /* called whenever a channel is destroyed or a linkedid is changed to
367  * potentially emit a CEL_LINKEDID_END event */
368 void ast_cel_check_retire_linkedid(struct ast_channel *chan)
369 {
370         const char *linkedid = ast_channel_linkedid(chan);
371         char *lid;
372
373         /* make sure we need to do all this work */
374
375         if (ast_strlen_zero(linkedid) || !ast_cel_track_event(AST_CEL_LINKEDID_END)) {
376                 return;
377         }
378
379         if (!(lid = ao2_find(linkedids, (void *) linkedid, OBJ_POINTER))) {
380                 ast_log(LOG_ERROR, "Something weird happened, couldn't find linkedid %s\n", linkedid);
381                 return;
382         }
383
384         /* We have a ref for each channel with this linkedid, the link and the above find, so if
385          * before unreffing the channel we have a refcount of 3, we're done. Unlink and report. */
386         if (ao2_ref(lid, -1) == 3) {
387                 ao2_unlink(linkedids, lid);
388                 ast_cel_report_event(chan, AST_CEL_LINKEDID_END, NULL, NULL, NULL);
389         }
390         ao2_ref(lid, -1);
391 }
392
393 /* Note that no 'chan_fixup' function is provided for this datastore type,
394  * because the channels that will use it will never be involved in masquerades.
395  */
396 static const struct ast_datastore_info fabricated_channel_datastore = {
397         .type = "CEL fabricated channel",
398         .destroy = ast_free_ptr,
399 };
400
401 struct ast_channel *ast_cel_fabricate_channel_from_event(const struct ast_event *event)
402 {
403         struct varshead *headp;
404         struct ast_var_t *newvariable;
405         const char *mixed_name;
406         char timebuf[30];
407         struct ast_channel *tchan;
408         struct ast_cel_event_record record = {
409                 .version = AST_CEL_EVENT_RECORD_VERSION,
410         };
411         struct ast_datastore *datastore;
412         char *app_data;
413
414         /* do not call ast_channel_alloc because this is not really a real channel */
415         if (!(tchan = ast_dummy_channel_alloc())) {
416                 return NULL;
417         }
418
419         headp = ast_channel_varshead(tchan);
420
421         /* first, get the variables from the event */
422         if (ast_cel_fill_record(event, &record)) {
423                 ast_channel_unref(tchan);
424                 return NULL;
425         }
426
427         /* next, fill the channel with their data */
428         mixed_name = (record.event_type == AST_CEL_USER_DEFINED)
429                 ? record.user_defined_name : record.event_name;
430         if ((newvariable = ast_var_assign("eventtype", mixed_name))) {
431                 AST_LIST_INSERT_HEAD(headp, newvariable, entries);
432         }
433
434         if (ast_strlen_zero(cel_dateformat)) {
435                 snprintf(timebuf, sizeof(timebuf), "%ld.%06ld", (long) record.event_time.tv_sec,
436                                 (long) record.event_time.tv_usec);
437         } else {
438                 struct ast_tm tm;
439                 ast_localtime(&record.event_time, &tm, NULL);
440                 ast_strftime(timebuf, sizeof(timebuf), cel_dateformat, &tm);
441         }
442
443         if ((newvariable = ast_var_assign("eventtime", timebuf))) {
444                 AST_LIST_INSERT_HEAD(headp, newvariable, entries);
445         }
446
447         if ((newvariable = ast_var_assign("eventenum", record.event_name))) {
448                 AST_LIST_INSERT_HEAD(headp, newvariable, entries);
449         }
450         if ((newvariable = ast_var_assign("userdeftype", record.user_defined_name))) {
451                 AST_LIST_INSERT_HEAD(headp, newvariable, entries);
452         }
453         if ((newvariable = ast_var_assign("eventextra", record.extra))) {
454                 AST_LIST_INSERT_HEAD(headp, newvariable, entries);
455         }
456
457         ast_channel_caller(tchan)->id.name.valid = 1;
458         ast_channel_caller(tchan)->id.name.str = ast_strdup(record.caller_id_name);
459         ast_channel_caller(tchan)->id.number.valid = 1;
460         ast_channel_caller(tchan)->id.number.str = ast_strdup(record.caller_id_num);
461         ast_channel_caller(tchan)->ani.number.valid = 1;
462         ast_channel_caller(tchan)->ani.number.str = ast_strdup(record.caller_id_ani);
463         ast_channel_redirecting(tchan)->from.number.valid = 1;
464         ast_channel_redirecting(tchan)->from.number.str = ast_strdup(record.caller_id_rdnis);
465         ast_channel_dialed(tchan)->number.str = ast_strdup(record.caller_id_dnid);
466
467         ast_channel_exten_set(tchan, record.extension);
468         ast_channel_context_set(tchan, record.context);
469         ast_channel_name_set(tchan, record.channel_name);
470         ast_channel_uniqueid_set(tchan, record.unique_id);
471         ast_channel_linkedid_set(tchan, record.linked_id);
472         ast_channel_accountcode_set(tchan, record.account_code);
473         ast_channel_peeraccount_set(tchan, record.peer_account);
474         ast_channel_userfield_set(tchan, record.user_field);
475
476         if ((newvariable = ast_var_assign("BRIDGEPEER", record.peer))) {
477                 AST_LIST_INSERT_HEAD(headp, newvariable, entries);
478         }
479
480         ast_channel_amaflags_set(tchan, record.amaflag);
481
482         /* We need to store an 'application name' and 'application
483          * data' on the channel for logging purposes, but the channel
484          * structure only provides a place to store pointers, and it
485          * expects these pointers to be pointing to data that does not
486          * need to be freed. This means that the channel's destructor
487          * does not attempt to free any storage that these pointers
488          * point to. However, we can't provide data in that form directly for
489          * these structure members. In order to ensure that these data
490          * elements have a lifetime that matches the channel's
491          * lifetime, we'll put them in a datastore attached to the
492          * channel, and set's the channel's pointers to point into the
493          * datastore.  The datastore will then be automatically destroyed
494          * when the channel is destroyed.
495          */
496
497         if (!(datastore = ast_datastore_alloc(&fabricated_channel_datastore, NULL))) {
498                 ast_channel_unref(tchan);
499                 return NULL;
500         }
501
502         if (!(app_data = ast_malloc(strlen(record.application_name) + strlen(record.application_data) + 2))) {
503                 ast_datastore_free(datastore);
504                 ast_channel_unref(tchan);
505                 return NULL;
506         }
507
508         ast_channel_appl_set(tchan, strcpy(app_data, record.application_name));
509         ast_channel_data_set(tchan, strcpy(app_data + strlen(record.application_name) + 1,
510                 record.application_data));
511
512         datastore->data = app_data;
513         ast_channel_datastore_add(tchan, datastore);
514
515         return tchan;
516 }
517
518 int ast_cel_linkedid_ref(const char *linkedid)
519 {
520         char *lid;
521
522         if (ast_strlen_zero(linkedid)) {
523                 ast_log(LOG_ERROR, "The linkedid should never be empty\n");
524                 return -1;
525         }
526
527         if (!(lid = ao2_find(linkedids, (void *) linkedid, OBJ_POINTER))) {
528                 if (!(lid = ao2_alloc(strlen(linkedid) + 1, NULL))) {
529                         return -1;
530                 }
531                 strcpy(lid, linkedid);
532                 if (!ao2_link(linkedids, lid)) {
533                         ao2_ref(lid, -1);
534                         return -1;
535                 }
536                 /* Leave both the link and the alloc refs to show a count of 1 + the link */
537         }
538         /* If we've found, go ahead and keep the ref to increment count of how many channels
539          * have this linkedid. We'll clean it up in check_retire */
540         return 0;
541 }
542
543 int ast_cel_report_event(struct ast_channel *chan, enum ast_cel_event_type event_type,
544                 const char *userdefevname, const char *extra, struct ast_channel *peer2)
545 {
546         struct timeval eventtime;
547         struct ast_event *ev;
548         const char *peername = "";
549         struct ast_channel *peer;
550         char *linkedid = ast_strdupa(ast_channel_linkedid(chan));
551
552         /* Make sure a reload is not occurring while we're checking to see if this
553          * is an event that we care about.  We could lose an important event in this
554          * process otherwise. */
555         ast_mutex_lock(&reload_lock);
556
557         /* Record the linkedid of new channels if we are tracking LINKEDID_END even if we aren't
558          * reporting on CHANNEL_START so we can track when to send LINKEDID_END */
559         if (cel_enabled && ast_cel_track_event(AST_CEL_LINKEDID_END) && event_type == AST_CEL_CHANNEL_START && linkedid) {
560                 if (ast_cel_linkedid_ref(linkedid)) {
561                         ast_mutex_unlock(&reload_lock);
562                         return -1;
563                 }
564         }
565
566         if (!cel_enabled || !ast_cel_track_event(event_type)) {
567                 ast_mutex_unlock(&reload_lock);
568                 return 0;
569         }
570
571         if (event_type == AST_CEL_APP_START || event_type == AST_CEL_APP_END) {
572                 char *app;
573                 if (!(app = ao2_find(appset, (char *) ast_channel_appl(chan), OBJ_POINTER))) {
574                         ast_mutex_unlock(&reload_lock);
575                         return 0;
576                 }
577                 ao2_ref(app, -1);
578         }
579
580         ast_mutex_unlock(&reload_lock);
581
582         ast_channel_lock(chan);
583         peer = ast_bridged_channel(chan);
584         if (peer) {
585                 ast_channel_ref(peer);
586         }
587         ast_channel_unlock(chan);
588
589         if (peer) {
590                 ast_channel_lock(peer);
591                 peername = ast_strdupa(ast_channel_name(peer));
592                 ast_channel_unlock(peer);
593         } else if (peer2) {
594                 ast_channel_lock(peer2);
595                 peername = ast_strdupa(ast_channel_name(peer2));
596                 ast_channel_unlock(peer2);
597         }
598
599         if (!userdefevname) {
600                 userdefevname = "";
601         }
602
603         if (!extra) {
604                 extra = "";
605         }
606
607         eventtime = ast_tvnow();
608
609         ast_channel_lock(chan);
610
611         ev = ast_event_new(AST_EVENT_CEL,
612                 AST_EVENT_IE_CEL_EVENT_TYPE, AST_EVENT_IE_PLTYPE_UINT, event_type,
613                 AST_EVENT_IE_CEL_EVENT_TIME, AST_EVENT_IE_PLTYPE_UINT, eventtime.tv_sec,
614                 AST_EVENT_IE_CEL_EVENT_TIME_USEC, AST_EVENT_IE_PLTYPE_UINT, eventtime.tv_usec,
615                 AST_EVENT_IE_CEL_USEREVENT_NAME, AST_EVENT_IE_PLTYPE_STR, userdefevname,
616                 AST_EVENT_IE_CEL_CIDNAME, AST_EVENT_IE_PLTYPE_STR,
617                         S_COR(ast_channel_caller(chan)->id.name.valid, ast_channel_caller(chan)->id.name.str, ""),
618                 AST_EVENT_IE_CEL_CIDNUM, AST_EVENT_IE_PLTYPE_STR,
619                         S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, ""),
620                 AST_EVENT_IE_CEL_CIDANI, AST_EVENT_IE_PLTYPE_STR,
621                         S_COR(ast_channel_caller(chan)->ani.number.valid, ast_channel_caller(chan)->ani.number.str, ""),
622                 AST_EVENT_IE_CEL_CIDRDNIS, AST_EVENT_IE_PLTYPE_STR,
623                         S_COR(ast_channel_redirecting(chan)->from.number.valid, ast_channel_redirecting(chan)->from.number.str, ""),
624                 AST_EVENT_IE_CEL_CIDDNID, AST_EVENT_IE_PLTYPE_STR,
625                         S_OR(ast_channel_dialed(chan)->number.str, ""),
626                 AST_EVENT_IE_CEL_EXTEN, AST_EVENT_IE_PLTYPE_STR, ast_channel_exten(chan),
627                 AST_EVENT_IE_CEL_CONTEXT, AST_EVENT_IE_PLTYPE_STR, ast_channel_context(chan),
628                 AST_EVENT_IE_CEL_CHANNAME, AST_EVENT_IE_PLTYPE_STR, ast_channel_name(chan),
629                 AST_EVENT_IE_CEL_APPNAME, AST_EVENT_IE_PLTYPE_STR, S_OR(ast_channel_appl(chan), ""),
630                 AST_EVENT_IE_CEL_APPDATA, AST_EVENT_IE_PLTYPE_STR, S_OR(ast_channel_data(chan), ""),
631                 AST_EVENT_IE_CEL_AMAFLAGS, AST_EVENT_IE_PLTYPE_UINT, ast_channel_amaflags(chan),
632                 AST_EVENT_IE_CEL_ACCTCODE, AST_EVENT_IE_PLTYPE_STR, ast_channel_accountcode(chan),
633                 AST_EVENT_IE_CEL_PEERACCT, AST_EVENT_IE_PLTYPE_STR, ast_channel_peeraccount(chan),
634                 AST_EVENT_IE_CEL_UNIQUEID, AST_EVENT_IE_PLTYPE_STR, ast_channel_uniqueid(chan),
635                 AST_EVENT_IE_CEL_LINKEDID, AST_EVENT_IE_PLTYPE_STR, ast_channel_linkedid(chan),
636                 AST_EVENT_IE_CEL_USERFIELD, AST_EVENT_IE_PLTYPE_STR, ast_channel_userfield(chan),
637                 AST_EVENT_IE_CEL_EXTRA, AST_EVENT_IE_PLTYPE_STR, extra,
638                 AST_EVENT_IE_CEL_PEER, AST_EVENT_IE_PLTYPE_STR, peername,
639                 AST_EVENT_IE_END);
640
641         ast_channel_unlock(chan);
642
643         if (peer) {
644                 peer = ast_channel_unref(peer);
645         }
646
647         if (ev && ast_event_queue(ev)) {
648                 ast_event_destroy(ev);
649                 return -1;
650         }
651
652         return 0;
653 }
654
655 int ast_cel_fill_record(const struct ast_event *e, struct ast_cel_event_record *r)
656 {
657         if (r->version != AST_CEL_EVENT_RECORD_VERSION) {
658                 ast_log(LOG_ERROR, "Module ABI mismatch for ast_cel_event_record.  "
659                                 "Please ensure all modules were compiled for "
660                                 "this version of Asterisk.\n");
661                 return -1;
662         }
663
664         r->event_type = ast_event_get_ie_uint(e, AST_EVENT_IE_CEL_EVENT_TYPE);
665
666         r->event_time.tv_sec = ast_event_get_ie_uint(e, AST_EVENT_IE_CEL_EVENT_TIME);
667         r->event_time.tv_usec = ast_event_get_ie_uint(e, AST_EVENT_IE_CEL_EVENT_TIME_USEC);
668
669         r->event_name = ast_cel_get_type_name(r->event_type);
670         if (r->event_type == AST_CEL_USER_DEFINED) {
671                 r->user_defined_name = ast_event_get_ie_str(e, AST_EVENT_IE_CEL_USEREVENT_NAME);
672         } else {
673                 r->user_defined_name = "";
674         }
675
676         r->caller_id_name   = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_CIDNAME), "");
677         r->caller_id_num    = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_CIDNUM), "");
678         r->caller_id_ani    = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_CIDANI), "");
679         r->caller_id_rdnis  = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_CIDRDNIS), "");
680         r->caller_id_dnid   = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_CIDDNID), "");
681         r->extension        = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_EXTEN), "");
682         r->context          = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_CONTEXT), "");
683         r->channel_name     = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_CHANNAME), "");
684         r->application_name = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_APPNAME), "");
685         r->application_data = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_APPDATA), "");
686         r->account_code     = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_ACCTCODE), "");
687         r->peer_account     = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_ACCTCODE), "");
688         r->unique_id        = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_UNIQUEID), "");
689         r->linked_id        = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_LINKEDID), "");
690         r->amaflag          = ast_event_get_ie_uint(e, AST_EVENT_IE_CEL_AMAFLAGS);
691         r->user_field       = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_USERFIELD), "");
692         r->peer             = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_PEER), "");
693         r->extra            = S_OR(ast_event_get_ie_str(e, AST_EVENT_IE_CEL_EXTRA), "");
694
695         return 0;
696 }
697
698 static int app_hash(const void *obj, const int flags)
699 {
700         return ast_str_case_hash((const char *) obj);
701 }
702
703 static int app_cmp(void *obj, void *arg, int flags)
704 {
705         const char *app1 = obj, *app2 = arg;
706
707         return !strcasecmp(app1, app2) ? CMP_MATCH | CMP_STOP : 0;
708 }
709
710 #define lid_hash app_hash
711 #define lid_cmp app_cmp
712
713 static void ast_cel_engine_term(void)
714 {
715         if (appset) {
716                 ao2_ref(appset, -1);
717                 appset = NULL;
718         }
719         if (linkedids) {
720                 ao2_ref(linkedids, -1);
721                 linkedids = NULL;
722         }
723 }
724
725 int ast_cel_engine_init(void)
726 {
727         if (!(appset = ao2_container_alloc(NUM_APP_BUCKETS, app_hash, app_cmp))) {
728                 return -1;
729         }
730         if (!(linkedids = ao2_container_alloc(NUM_APP_BUCKETS, lid_hash, lid_cmp))) {
731                 ao2_ref(appset, -1);
732                 return -1;
733         }
734
735         if (do_reload() || ast_cli_register(&cli_status)) {
736                 ao2_ref(appset, -1);
737                 appset = NULL;
738                 ao2_ref(linkedids, -1);
739                 linkedids = NULL;
740                 return -1;
741         }
742
743         ast_register_atexit(ast_cel_engine_term);
744
745         return 0;
746 }
747
748 int ast_cel_engine_reload(void)
749 {
750         return do_reload();
751 }
752