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