cdr.h: Fix doxygen comments.
[asterisk/asterisk.git] / main / cdr.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Call Detail Record API
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * \note Includes code and algorithms from the Zapata library.
26  *
27  * \note We do a lot of checking here in the CDR code to try to be sure we don't ever let a CDR slip
28  * through our fingers somehow.  If someone allocates a CDR, it must be completely handled normally
29  * or a WARNING shall be logged, so that we can best keep track of any escape condition where the CDR
30  * isn't properly generated and posted.
31  */
32
33 /*! \li \ref cdr.c uses the configuration file \ref cdr.conf
34  * \addtogroup configuration_file Configuration Files
35  */
36
37 /*!
38  * \page cdr.conf cdr.conf
39  * \verbinclude cdr.conf.sample
40  */
41
42 /*** MODULEINFO
43         <support_level>core</support_level>
44  ***/
45
46 #include "asterisk.h"
47
48 #include <signal.h>
49 #include <inttypes.h>
50
51 #include "asterisk/lock.h"
52 #include "asterisk/channel.h"
53 #include "asterisk/cdr.h"
54 #include "asterisk/callerid.h"
55 #include "asterisk/manager.h"
56 #include "asterisk/causes.h"
57 #include "asterisk/linkedlists.h"
58 #include "asterisk/utils.h"
59 #include "asterisk/sched.h"
60 #include "asterisk/config.h"
61 #include "asterisk/cli.h"
62 #include "asterisk/stringfields.h"
63 #include "asterisk/config_options.h"
64 #include "asterisk/json.h"
65 #include "asterisk/parking.h"
66 #include "asterisk/stasis.h"
67 #include "asterisk/stasis_channels.h"
68 #include "asterisk/stasis_bridges.h"
69 #include "asterisk/stasis_message_router.h"
70 #include "asterisk/astobj2.h"
71 #include "asterisk/taskprocessor.h"
72
73 /*** DOCUMENTATION
74         <configInfo name="cdr" language="en_US">
75                 <synopsis>Call Detail Record configuration</synopsis>
76                 <description>
77                         <para>CDR is Call Detail Record, which provides logging services via a variety of
78                         pluggable backend modules. Detailed call information can be recorded to
79                         databases, files, etc. Useful for billing, fraud prevention, compliance with
80                         Sarbanes-Oxley aka The Enron Act, QOS evaluations, and more.</para>
81                 </description>
82                 <configFile name="cdr.conf">
83                         <configObject name="general">
84                                 <synopsis>Global settings applied to the CDR engine.</synopsis>
85                                 <configOption name="debug">
86                                         <synopsis>Enable/disable verbose CDR debugging.</synopsis>
87                                         <description><para>When set to <literal>True</literal>, verbose updates
88                                         of changes in CDR information will be logged. Note that this is only
89                                         of use when debugging CDR behavior.</para>
90                                         </description>
91                                 </configOption>
92                                 <configOption name="enable">
93                                         <synopsis>Enable/disable CDR logging.</synopsis>
94                                         <description><para>Define whether or not to use CDR logging. Setting this to "no" will override
95                                         any loading of backend CDR modules.  Default is "yes".</para>
96                                         </description>
97                                 </configOption>
98                                 <configOption name="unanswered">
99                                         <synopsis>Log calls that are never answered and don't set an outgoing party.</synopsis>
100                                         <description><para>
101                                         Define whether or not to log unanswered calls that don't involve an outgoing party. Setting
102                                         this to "yes" will make calls to extensions that don't answer and don't set a side B channel
103                                         (such as by using the Dial application) receive CDR log entries. If this option is set to
104                                         "no", then those log entries will not be created. Unanswered calls which get offered to an
105                                         outgoing line will always receive log entries regardless of this option, and that is the
106                                         intended behavior.
107                                         </para>
108                                         </description>
109                                 </configOption>
110                                 <configOption name="congestion">
111                                         <synopsis>Log congested calls.</synopsis>
112                                         <description><para>Define whether or not to log congested calls. Setting this to "yes" will
113                                         report each call that fails to complete due to congestion conditions.</para>
114                                         </description>
115                                 </configOption>
116                                 <configOption name="endbeforehexten">
117                                         <synopsis>Don't produce CDRs while executing hangup logic</synopsis>
118                                         <description>
119                                                 <para>As each CDR for a channel is finished, its end time is updated
120                                                 and the CDR is finalized. When a channel is hung up and hangup
121                                                 logic is present (in the form of a hangup handler or the
122                                                 <literal>h</literal> extension), a new CDR is generated for the
123                                                 channel. Any statistics are gathered from this new CDR. By enabling
124                                                 this option, no new CDR is created for the dialplan logic that is
125                                                 executed in <literal>h</literal> extensions or attached hangup handler
126                                                 subroutines. The default value is <literal>yes</literal>, indicating
127                                                 that a CDR will be generated during hangup logic.</para>
128                                         </description>
129                                 </configOption>
130                                 <configOption name="initiatedseconds">
131                                         <synopsis>Count microseconds for billsec purposes</synopsis>
132                                         <description><para>Normally, the <literal>billsec</literal> field logged to the CDR backends
133                                         is simply the end time (hangup time) minus the answer time in seconds. Internally,
134                                         asterisk stores the time in terms of microseconds and seconds. By setting
135                                         initiatedseconds to <literal>yes</literal>, you can force asterisk to report any seconds
136                                         that were initiated (a sort of round up method). Technically, this is
137                                         when the microsecond part of the end time is greater than the microsecond
138                                         part of the answer time, then the billsec time is incremented one second.</para>
139                                         </description>
140                                 </configOption>
141                                 <configOption name="batch">
142                                         <synopsis>Submit CDRs to the backends for processing in batches</synopsis>
143                                         <description><para>Define the CDR batch mode, where instead of posting the CDR at the end of
144                                         every call, the data will be stored in a buffer to help alleviate load on the
145                                         asterisk server.</para>
146                                         <warning><para>Use of batch mode may result in data loss after unsafe asterisk termination,
147                                         i.e., software crash, power failure, kill -9, etc.</para>
148                                         </warning>
149                                         </description>
150                                 </configOption>
151                                 <configOption name="size">
152                                         <synopsis>The maximum number of CDRs to accumulate before triggering a batch</synopsis>
153                                         <description><para>Define the maximum number of CDRs to accumulate in the buffer before posting
154                                         them to the backend engines. batch must be set to <literal>yes</literal>.</para>
155                                         </description>
156                                 </configOption>
157                                 <configOption name="time">
158                                         <synopsis>The maximum time to accumulate CDRs before triggering a batch</synopsis>
159                                         <description><para>Define the maximum time to accumulate CDRs before posting them in a batch to the
160                                         backend engines. If this time limit is reached, then it will post the records, regardless of the value
161                                         defined for size. batch must be set to <literal>yes</literal>.</para>
162                                         <note><para>Time is expressed in seconds.</para></note>
163                                         </description>
164                                 </configOption>
165                                 <configOption name="scheduleronly">
166                                         <synopsis>Post batched CDRs on their own thread instead of the scheduler</synopsis>
167                                         <description><para>The CDR engine uses the internal asterisk scheduler to determine when to post
168                                         records.  Posting can either occur inside the scheduler thread, or a new
169                                         thread can be spawned for the submission of every batch.  For small batches,
170                                         it might be acceptable to just use the scheduler thread, so set this to <literal>yes</literal>.
171                                         For large batches, say anything over size=10, a new thread is recommended, so
172                                         set this to <literal>no</literal>.</para>
173                                         </description>
174                                 </configOption>
175                                 <configOption name="safeshutdown">
176                                         <synopsis>Block shutdown of Asterisk until CDRs are submitted</synopsis>
177                                         <description><para>When shutting down asterisk, you can block until the CDRs are submitted.  If
178                                         you don't, then data will likely be lost.  You can always check the size of
179                                         the CDR batch buffer with the CLI <astcli>cdr status</astcli> command.  To enable blocking on
180                                         submission of CDR data during asterisk shutdown, set this to <literal>yes</literal>.</para>
181                                         </description>
182                                 </configOption>
183                         </configObject>
184                 </configFile>
185         </configInfo>
186  ***/
187
188
189 /* The prime here should be similar in size to the channel container. */
190 #ifdef LOW_MEMORY
191 #define NUM_CDR_BUCKETS 61
192 #else
193 #define NUM_CDR_BUCKETS 769
194 #endif
195
196 #define DEFAULT_ENABLED "1"
197 #define DEFAULT_BATCHMODE "0"
198 #define DEFAULT_UNANSWERED "0"
199 #define DEFAULT_CONGESTION "0"
200 #define DEFAULT_END_BEFORE_H_EXTEN "1"
201 #define DEFAULT_INITIATED_SECONDS "0"
202
203 #define DEFAULT_BATCH_SIZE "100"
204 #define MAX_BATCH_SIZE 1000
205 #define DEFAULT_BATCH_TIME "300"
206 #define MAX_BATCH_TIME 86400
207 #define DEFAULT_BATCH_SCHEDULER_ONLY "0"
208 #define DEFAULT_BATCH_SAFE_SHUTDOWN "1"
209
210 #define CDR_DEBUG(mod_cfg, fmt, ...) \
211         do { \
212                 if (ast_test_flag(&(mod_cfg)->general->settings, CDR_DEBUG)) { \
213                         ast_verbose((fmt), ##__VA_ARGS__); \
214                 } \
215         } while (0)
216
217 static void cdr_detach(struct ast_cdr *cdr);
218 static void cdr_submit_batch(int shutdown);
219 static int cdr_toggle_runtime_options(void);
220
221 /*! \brief The configuration settings for this module */
222 struct module_config {
223         struct ast_cdr_config *general;         /*!< CDR global settings */
224 };
225
226 /*! \brief The container for the module configuration */
227 static AO2_GLOBAL_OBJ_STATIC(module_configs);
228
229 /*! \brief The type definition for general options */
230 static struct aco_type general_option = {
231         .type = ACO_GLOBAL,
232         .name = "general",
233         .item_offset = offsetof(struct module_config, general),
234         .category = "^general$",
235         .category_match = ACO_WHITELIST,
236 };
237
238 static void *module_config_alloc(void);
239 static void module_config_destructor(void *obj);
240
241 /*! \brief The file definition */
242 static struct aco_file module_file_conf = {
243         .filename = "cdr.conf",
244         .skip_category = "(^csv$|^custom$|^manager$|^odbc$|^pgsql$|^radius$|^sqlite$|^tds$|^mysql$)",
245         .types = ACO_TYPES(&general_option),
246 };
247
248 CONFIG_INFO_CORE("cdr", cfg_info, module_configs, module_config_alloc,
249         .files = ACO_FILES(&module_file_conf),
250 );
251
252 static struct aco_type *general_options[] = ACO_TYPES(&general_option);
253
254 /*! \brief Dispose of a module config object */
255 static void module_config_destructor(void *obj)
256 {
257         struct module_config *cfg = obj;
258
259         if (!cfg) {
260                 return;
261         }
262         ao2_ref(cfg->general, -1);
263 }
264
265 /*! \brief Create a new module config object */
266 static void *module_config_alloc(void)
267 {
268         struct module_config *mod_cfg;
269         struct ast_cdr_config *cdr_config;
270
271         mod_cfg = ao2_alloc(sizeof(*mod_cfg), module_config_destructor);
272         if (!mod_cfg) {
273                 return NULL;
274         }
275
276         cdr_config = ao2_alloc(sizeof(*cdr_config), NULL);
277         if (!cdr_config) {
278                 ao2_ref(cdr_config, -1);
279                 return NULL;
280         }
281         mod_cfg->general = cdr_config;
282
283         return mod_cfg;
284 }
285
286 /*! \brief Registration object for CDR backends */
287 struct cdr_beitem {
288         char name[20];
289         char desc[80];
290         ast_cdrbe be;
291         AST_RWLIST_ENTRY(cdr_beitem) list;
292         int suspended:1;
293 };
294
295 /*! \brief List of registered backends */
296 static AST_RWLIST_HEAD_STATIC(be_list, cdr_beitem);
297
298 /*! \brief List of registered modifiers */
299 static AST_RWLIST_HEAD_STATIC(mo_list, cdr_beitem);
300
301 /*! \brief Queued CDR waiting to be batched */
302 struct cdr_batch_item {
303         struct ast_cdr *cdr;
304         struct cdr_batch_item *next;
305 };
306
307 /*! \brief The actual batch queue */
308 static struct cdr_batch {
309         int size;
310         struct cdr_batch_item *head;
311         struct cdr_batch_item *tail;
312 } *batch = NULL;
313
314 /*! \brief The global sequence counter used for CDRs */
315 static int global_cdr_sequence =  0;
316
317 /*! \brief Scheduler items */
318 static struct ast_sched_context *sched;
319 static int cdr_sched = -1;
320 AST_MUTEX_DEFINE_STATIC(cdr_sched_lock);
321 static pthread_t cdr_thread = AST_PTHREADT_NULL;
322
323 /*! \brief Lock protecting modifications to the batch queue */
324 AST_MUTEX_DEFINE_STATIC(cdr_batch_lock);
325
326 /*! \brief These are used to wake up the CDR thread when there's work to do */
327 AST_MUTEX_DEFINE_STATIC(cdr_pending_lock);
328 static ast_cond_t cdr_pending_cond;
329
330 /*! \brief A container of the active CDRs indexed by Party A channel id */
331 static struct ao2_container *active_cdrs_by_channel;
332
333 /*! \brief Message router for stasis messages regarding channel state */
334 static struct stasis_message_router *stasis_router;
335
336 /*! \brief Our subscription for bridges */
337 static struct stasis_forward *bridge_subscription;
338
339 /*! \brief Our subscription for channels */
340 static struct stasis_forward *channel_subscription;
341
342 /*! \brief Our subscription for parking */
343 static struct stasis_forward *parking_subscription;
344
345 /*! \brief The parent topic for all topics we want to aggregate for CDRs */
346 static struct stasis_topic *cdr_topic;
347
348 /*! \brief A message type used to synchronize with the CDR topic */
349 STASIS_MESSAGE_TYPE_DEFN_LOCAL(cdr_sync_message_type);
350
351 struct cdr_object;
352
353 /*! \brief Return types for \ref process_bridge_enter functions */
354 enum process_bridge_enter_results {
355         /*!
356          * The CDR was the only party in the bridge.
357          */
358         BRIDGE_ENTER_ONLY_PARTY,
359         /*!
360          * The CDR was able to obtain a Party B from some other party already in the bridge
361          */
362         BRIDGE_ENTER_OBTAINED_PARTY_B,
363         /*!
364          * The CDR was not able to obtain a Party B
365          */
366         BRIDGE_ENTER_NO_PARTY_B,
367         /*!
368          * This CDR can't handle a bridge enter message and a new CDR needs to be created
369          */
370         BRIDGE_ENTER_NEED_CDR,
371 };
372
373 /*!
374  * \brief A virtual table used for \ref cdr_object.
375  *
376  * Note that all functions are optional - if a subclass does not need an
377  * implementation, it is safe to leave it NULL.
378  */
379 struct cdr_object_fn_table {
380         /*! \brief Name of the subclass */
381         const char *name;
382
383         /*!
384          * \brief An initialization function. This will be called automatically
385          * when a \ref cdr_object is switched to this type in
386          * \ref cdr_object_transition_state
387          *
388          * \param cdr The \ref cdr_object that was just transitioned
389          */
390         void (* const init_function)(struct cdr_object *cdr);
391
392         /*!
393          * \brief Process a Party A update for the \ref cdr_object
394          *
395          * \param cdr The \ref cdr_object to process the update
396          * \param snapshot The snapshot for the CDR's Party A
397          * \retval 0 the CDR handled the update or ignored it
398          * \retval 1 the CDR is finalized and a new one should be made to handle it
399          */
400         int (* const process_party_a)(struct cdr_object *cdr,
401                         struct ast_channel_snapshot *snapshot);
402
403         /*!
404          * \brief Process a Party B update for the \ref cdr_object
405          *
406          * \param cdr The \ref cdr_object to process the update
407          * \param snapshot The snapshot for the CDR's Party B
408          */
409         void (* const process_party_b)(struct cdr_object *cdr,
410                         struct ast_channel_snapshot *snapshot);
411
412         /*!
413          * \brief Process the beginning of a dial. A dial message implies one of two
414          * things:
415          * The \ref cdr_object's Party A has been originated
416          * The \ref cdr_object's Party A is dialing its Party B
417          *
418          * \param cdr The \ref cdr_object
419          * \param caller The originator of the dial attempt
420          * \param peer The destination of the dial attempt
421          *
422          * \retval 0 if the parties in the dial were handled by this CDR
423          * \retval 1 if the parties could not be handled by this CDR
424          */
425         int (* const process_dial_begin)(struct cdr_object *cdr,
426                         struct ast_channel_snapshot *caller,
427                         struct ast_channel_snapshot *peer);
428
429         /*!
430          * \brief Process the end of a dial. At the end of a dial, a CDR can be
431          * transitioned into one of two states - DialedPending
432          * (\ref dialed_pending_state_fn_table) or Finalized
433          * (\ref finalized_state_fn_table).
434          *
435          * \param cdr The \ref cdr_object
436          * \param caller The originator of the dial attempt
437          * \param peer the Destination of the dial attempt
438          * \param dial_status What happened
439          *
440          * \retval 0 if the parties in the dial were handled by this CDR
441          * \retval 1 if the parties could not be handled by this CDR
442          */
443         int (* const process_dial_end)(struct cdr_object *cdr,
444                         struct ast_channel_snapshot *caller,
445                         struct ast_channel_snapshot *peer,
446                         const char *dial_status);
447
448         /*!
449          * \brief Process the entering of a bridge by this CDR. The purpose of this
450          * callback is to have the CDR prepare itself for the bridge and attempt to
451          * find a valid Party B. The act of creating new CDRs based on the entering
452          * of this channel into the bridge is handled by the higher level message
453          * handler.
454          *
455          * Note that this handler is for when a channel enters into a "normal"
456          * bridge, where people actually talk to each other. Parking is its own
457          * thing.
458          *
459          * \param cdr The \ref cdr_object
460          * \param bridge The bridge that the Party A just entered into
461          * \param channel The \ref ast_channel_snapshot for this CDR's Party A
462          *
463          * \retval process_bridge_enter_results Defines whether or not this CDR was able
464          * to fully handle the bridge enter message.
465          */
466         enum process_bridge_enter_results (* const process_bridge_enter)(
467                         struct cdr_object *cdr,
468                         struct ast_bridge_snapshot *bridge,
469                         struct ast_channel_snapshot *channel);
470
471         /*!
472          * \brief Process entering into a parking bridge.
473          *
474          * \param cdr The \ref cdr_object
475          * \param bridge The parking bridge that Party A just entered into
476          * \param channel The \ref ast_channel_snapshot for this CDR's Party A
477          *
478          * \retval 0 This CDR successfully transitioned itself into the parked state
479          * \retval 1 This CDR couldn't handle the parking transition and we need a
480          *  new CDR.
481          */
482         int (* const process_parking_bridge_enter)(struct cdr_object *cdr,
483                         struct ast_bridge_snapshot *bridge,
484                         struct ast_channel_snapshot *channel);
485
486         /*!
487          * \brief Process the leaving of a bridge by this CDR.
488          *
489          * \param cdr The \ref cdr_object
490          * \param bridge The bridge that the Party A just left
491          * \param channel The \ref ast_channel_snapshot for this CDR's Party A
492          *
493          * \retval 0 This CDR left successfully
494          * \retval 1 Error
495          */
496         int (* const process_bridge_leave)(struct cdr_object *cdr,
497                         struct ast_bridge_snapshot *bridge,
498                         struct ast_channel_snapshot *channel);
499
500         /*!
501          * \brief Process an update informing us that the channel got itself parked
502          *
503          * \param cdr The \ref cdr_object
504          * \param channel The parking information for this CDR's party A
505          *
506          * \retval 0 This CDR successfully parked itself
507          * \retval 1 This CDR couldn't handle the park
508          */
509         int (* const process_parked_channel)(struct cdr_object *cdr,
510                         struct ast_parked_call_payload *parking_info);
511 };
512
513 static int base_process_party_a(struct cdr_object *cdr, struct ast_channel_snapshot *snapshot);
514 static enum process_bridge_enter_results base_process_bridge_enter(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel);
515 static int base_process_bridge_leave(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel);
516 static int base_process_dial_end(struct cdr_object *cdr, struct ast_channel_snapshot *caller, struct ast_channel_snapshot *peer, const char *dial_status);
517 static int base_process_parked_channel(struct cdr_object *cdr, struct ast_parked_call_payload *parking_info);
518
519 static void single_state_init_function(struct cdr_object *cdr);
520 static void single_state_process_party_b(struct cdr_object *cdr, struct ast_channel_snapshot *snapshot);
521 static int single_state_process_dial_begin(struct cdr_object *cdr, struct ast_channel_snapshot *caller, struct ast_channel_snapshot *peer);
522 static enum process_bridge_enter_results single_state_process_bridge_enter(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel);
523 static int single_state_process_parking_bridge_enter(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel);
524
525 /*!
526  * \brief The virtual table for the Single state.
527  *
528  * A \ref cdr_object starts off in this state. This represents a channel that
529  * has no Party B information itself.
530  *
531  * A \ref cdr_object from this state can go into any of the following states:
532  * * \ref dial_state_fn_table
533  * * \ref bridge_state_fn_table
534  * * \ref finalized_state_fn_table
535  */
536 struct cdr_object_fn_table single_state_fn_table = {
537         .name = "Single",
538         .init_function = single_state_init_function,
539         .process_party_a = base_process_party_a,
540         .process_party_b = single_state_process_party_b,
541         .process_dial_begin = single_state_process_dial_begin,
542         .process_dial_end = base_process_dial_end,
543         .process_bridge_enter = single_state_process_bridge_enter,
544         .process_parking_bridge_enter = single_state_process_parking_bridge_enter,
545         .process_bridge_leave = base_process_bridge_leave,
546         .process_parked_channel = base_process_parked_channel,
547 };
548
549 static void dial_state_process_party_b(struct cdr_object *cdr, struct ast_channel_snapshot *snapshot);
550 static int dial_state_process_dial_begin(struct cdr_object *cdr, struct ast_channel_snapshot *caller, struct ast_channel_snapshot *peer);
551 static int dial_state_process_dial_end(struct cdr_object *cdr, struct ast_channel_snapshot *caller, struct ast_channel_snapshot *peer, const char *dial_status);
552 static enum process_bridge_enter_results dial_state_process_bridge_enter(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel);
553
554 /*!
555  * \brief The virtual table for the Dial state.
556  *
557  * A \ref cdr_object that has begun a dial operation. This state is entered when
558  * the Party A for a CDR is determined to be dialing out to a Party B or when
559  * a CDR is for an originated channel (in which case the Party A information is
560  * the originated channel, and there is no Party B).
561  *
562  * A \ref cdr_object from this state can go in any of the following states:
563  * * \ref dialed_pending_state_fn_table
564  * * \ref bridge_state_fn_table
565  * * \ref finalized_state_fn_table
566  */
567 struct cdr_object_fn_table dial_state_fn_table = {
568         .name = "Dial",
569         .process_party_a = base_process_party_a,
570         .process_party_b = dial_state_process_party_b,
571         .process_dial_begin = dial_state_process_dial_begin,
572         .process_dial_end = dial_state_process_dial_end,
573         .process_bridge_enter = dial_state_process_bridge_enter,
574         .process_bridge_leave = base_process_bridge_leave,
575 };
576
577 static int dialed_pending_state_process_party_a(struct cdr_object *cdr, struct ast_channel_snapshot *snapshot);
578 static int dialed_pending_state_process_dial_begin(struct cdr_object *cdr, struct ast_channel_snapshot *caller, struct ast_channel_snapshot *peer);
579 static enum process_bridge_enter_results dialed_pending_state_process_bridge_enter(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel);
580 static int dialed_pending_state_process_parking_bridge_enter(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel);
581
582 /*!
583  * \brief The virtual table for the Dialed Pending state.
584  *
585  * A \ref cdr_object that has successfully finished a dial operation, but we
586  * don't know what they're going to do yet. It's theoretically possible to dial
587  * a party and then have that party not be bridged with the caller; likewise,
588  * an origination can complete and the channel go off and execute dialplan. The
589  * pending state acts as a bridge between either:
590  * * Entering a bridge
591  * * Getting a new CDR for new dialplan execution
592  * * Switching from being originated to executing dialplan
593  *
594  * A \ref cdr_object from this state can go in any of the following states:
595  * * \ref single_state_fn_table
596  * * \ref dialed_pending_state_fn_table
597  * * \ref bridge_state_fn_table
598  * * \ref finalized_state_fn_table
599  */
600 struct cdr_object_fn_table dialed_pending_state_fn_table = {
601         .name = "DialedPending",
602         .process_party_a = dialed_pending_state_process_party_a,
603         .process_dial_begin = dialed_pending_state_process_dial_begin,
604         .process_bridge_enter = dialed_pending_state_process_bridge_enter,
605         .process_parking_bridge_enter = dialed_pending_state_process_parking_bridge_enter,
606         .process_bridge_leave = base_process_bridge_leave,
607         .process_parked_channel = base_process_parked_channel,
608 };
609
610 static void bridge_state_process_party_b(struct cdr_object *cdr, struct ast_channel_snapshot *snapshot);
611 static int bridge_state_process_bridge_leave(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel);
612
613 /*!
614  * \brief The virtual table for the Bridged state
615  *
616  * A \ref cdr_object enters this state when it receives notification that the
617  * channel has entered a bridge.
618  *
619  * A \ref cdr_object from this state can go to:
620  * * \ref finalized_state_fn_table
621  */
622 struct cdr_object_fn_table bridge_state_fn_table = {
623         .name = "Bridged",
624         .process_party_a = base_process_party_a,
625         .process_party_b = bridge_state_process_party_b,
626         .process_bridge_leave = bridge_state_process_bridge_leave,
627         .process_parked_channel = base_process_parked_channel,
628 };
629
630 static int parked_state_process_bridge_leave(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel);
631
632 /*!
633  * \brief The virtual table for the Parked state
634  *
635  * Parking is weird. Unlike typical bridges, it has to be treated somewhat
636  * uniquely - a channel in a parking bridge (which is a subclass of a holding
637  * bridge) has to be handled as if the channel went into an application.
638  * However, when the channel comes out, we need a new CDR - unlike the Single
639  * state.
640  */
641 struct cdr_object_fn_table parked_state_fn_table = {
642         .name = "Parked",
643         .process_party_a = base_process_party_a,
644         .process_bridge_leave = parked_state_process_bridge_leave,
645         .process_parked_channel = base_process_parked_channel,
646 };
647
648 static void finalized_state_init_function(struct cdr_object *cdr);
649 static int finalized_state_process_party_a(struct cdr_object *cdr, struct ast_channel_snapshot *snapshot);
650
651 /*!
652  * \brief The virtual table for the finalized state.
653  *
654  * Once in the finalized state, the CDR is done. No modifications can be made
655  * to the CDR.
656  */
657 struct cdr_object_fn_table finalized_state_fn_table = {
658         .name = "Finalized",
659         .init_function = finalized_state_init_function,
660         .process_party_a = finalized_state_process_party_a,
661         .process_bridge_enter = base_process_bridge_enter,
662 };
663
664 /*! \brief A wrapper object around a snapshot.
665  * Fields that are mutable by the CDR engine are replicated here.
666  */
667 struct cdr_object_snapshot {
668         struct ast_channel_snapshot *snapshot;  /*!< The channel snapshot */
669         char userfield[AST_MAX_USER_FIELD];     /*!< Userfield for the channel */
670         unsigned int flags;                     /*!< Specific flags for this party */
671         struct varshead variables;              /*!< CDR variables for the channel */
672 };
673
674 /*! \brief An in-memory representation of an active CDR */
675 struct cdr_object {
676         struct cdr_object_snapshot party_a;     /*!< The Party A information */
677         struct cdr_object_snapshot party_b;     /*!< The Party B information */
678         struct cdr_object_fn_table *fn_table;   /*!< The current virtual table */
679
680         enum ast_cdr_disposition disposition;   /*!< The disposition of the CDR */
681         struct timeval start;                   /*!< When this CDR was created */
682         struct timeval answer;                  /*!< Either when the channel was answered, or when the path between channels was established */
683         struct timeval end;                     /*!< When this CDR was finalized */
684         unsigned int sequence;                  /*!< A monotonically increasing number for each CDR */
685         struct ast_flags flags;                 /*!< Flags on the CDR */
686         AST_DECLARE_STRING_FIELDS(
687                 AST_STRING_FIELD(linkedid);         /*!< Linked ID. Cached here as it may change out from party A, which must be immutable */
688                 AST_STRING_FIELD(uniqueid);                     /*!< Unique id of party A. Cached here as it is the primary key of this CDR */
689                 AST_STRING_FIELD(name);             /*!< Channel name of party A. Cached here as the party A address may change */
690                 AST_STRING_FIELD(bridge);           /*!< The bridge the party A happens to be in. */
691                 AST_STRING_FIELD(appl);             /*!< The last accepted application party A was in */
692                 AST_STRING_FIELD(data);             /*!< The data for the last accepted application party A was in */
693                 AST_STRING_FIELD(context);          /*!< The accepted context for Party A */
694                 AST_STRING_FIELD(exten);            /*!< The accepted extension for Party A */
695         );
696         struct cdr_object *next;                /*!< The next CDR object in the chain */
697         struct cdr_object *last;                /*!< The last CDR object in the chain */
698         int is_root;                            /*!< True if this is the first CDR in the chain */
699 };
700
701 /*!
702  * \brief Copy variables from one list to another
703  * \param to_list destination
704  * \param from_list source
705  * \retval The number of copied variables
706  */
707 static int copy_variables(struct varshead *to_list, struct varshead *from_list)
708 {
709         struct ast_var_t *variables;
710         struct ast_var_t *newvariable;
711         const char *var;
712         const char *val;
713         int x = 0;
714
715         AST_LIST_TRAVERSE(from_list, variables, entries) {
716                 var = ast_var_name(variables);
717                 if (ast_strlen_zero(var)) {
718                         continue;
719                 }
720                 val = ast_var_value(variables);
721                 if (ast_strlen_zero(val)) {
722                         continue;
723                 }
724                 newvariable = ast_var_assign(var, val);
725                 if (newvariable) {
726                         AST_LIST_INSERT_HEAD(to_list, newvariable, entries);
727                         ++x;
728                 }
729         }
730
731         return x;
732 }
733
734 /*!
735  * \brief Delete all variables from a variable list
736  * \param headp The head pointer to the variable list to delete
737  */
738 static void free_variables(struct varshead *headp)
739 {
740         struct ast_var_t *vardata;
741
742         while ((vardata = AST_LIST_REMOVE_HEAD(headp, entries))) {
743                 ast_var_delete(vardata);
744         }
745 }
746
747 /*!
748  * \brief Copy a snapshot and its details
749  * \param dst The destination
750  * \param src The source
751  */
752 static void cdr_object_snapshot_copy(struct cdr_object_snapshot *dst, struct cdr_object_snapshot *src)
753 {
754         if (dst->snapshot) {
755                 ao2_t_ref(dst->snapshot, -1, "release old snapshot during copy");
756         }
757         dst->snapshot = src->snapshot;
758         ao2_t_ref(dst->snapshot, +1, "bump new snapshot during copy");
759         strcpy(dst->userfield, src->userfield);
760         dst->flags = src->flags;
761         copy_variables(&dst->variables, &src->variables);
762 }
763
764 /*!
765  * \brief Transition a \ref cdr_object to a new state
766  * \param cdr The \ref cdr_object to transition
767  * \param fn_table The \ref cdr_object_fn_table state to go to
768  */
769 static void cdr_object_transition_state(struct cdr_object *cdr, struct cdr_object_fn_table *fn_table)
770 {
771         RAII_VAR(struct module_config *, mod_cfg, ao2_global_obj_ref(module_configs), ao2_cleanup);
772
773         CDR_DEBUG(mod_cfg, "%p - Transitioning CDR for %s from state %s to %s\n",
774                 cdr, cdr->party_a.snapshot->name,
775                 cdr->fn_table ? cdr->fn_table->name : "NONE", fn_table->name);
776         cdr->fn_table = fn_table;
777         if (cdr->fn_table->init_function) {
778                 cdr->fn_table->init_function(cdr);
779         }
780 }
781 /*! \internal
782  * \brief Hash function for containers of CDRs indexing by Party A uniqueid */
783 static int cdr_object_channel_hash_fn(const void *obj, const int flags)
784 {
785         const struct cdr_object *cdr;
786         const char *key;
787
788         switch (flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY)) {
789         case OBJ_KEY:
790                 key = obj;
791                 break;
792         case OBJ_POINTER:
793                 cdr = obj;
794                 key = cdr->uniqueid;
795                 break;
796         default:
797                 ast_assert(0);
798                 return 0;
799         }
800         return ast_str_case_hash(key);
801 }
802
803 /*! \internal
804  * \brief Comparison function for containers of CDRs indexing by Party A uniqueid
805  */
806 static int cdr_object_channel_cmp_fn(void *obj, void *arg, int flags)
807 {
808     struct cdr_object *left = obj;
809     struct cdr_object *right = arg;
810     const char *right_key = arg;
811     int cmp;
812
813     switch (flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY)) {
814     case OBJ_POINTER:
815         right_key = right->uniqueid;
816         /* Fall through */
817     case OBJ_KEY:
818         cmp = strcmp(left->uniqueid, right_key);
819         break;
820     case OBJ_PARTIAL_KEY:
821         /*
822          * We could also use a partial key struct containing a length
823          * so strlen() does not get called for every comparison instead.
824          */
825         cmp = strncmp(left->uniqueid, right_key, strlen(right_key));
826         break;
827     default:
828         /* Sort can only work on something with a full or partial key. */
829         ast_assert(0);
830         cmp = 0;
831         break;
832     }
833     return cmp ? 0 : CMP_MATCH;
834 }
835
836 /*!
837  * \brief \ref cdr_object Destructor
838  */
839 static void cdr_object_dtor(void *obj)
840 {
841         struct cdr_object *cdr = obj;
842         struct ast_var_t *it_var;
843
844         ao2_cleanup(cdr->party_a.snapshot);
845         ao2_cleanup(cdr->party_b.snapshot);
846         while ((it_var = AST_LIST_REMOVE_HEAD(&cdr->party_a.variables, entries))) {
847                 ast_var_delete(it_var);
848         }
849         while ((it_var = AST_LIST_REMOVE_HEAD(&cdr->party_b.variables, entries))) {
850                 ast_var_delete(it_var);
851         }
852         ast_string_field_free_memory(cdr);
853
854         /* CDR destruction used to work by calling ao2_cleanup(next) and
855          * allowing the chain to destroy itself neatly. Unfortunately, for
856          * really long chains, this can result in a stack overflow. So now
857          * when the root CDR is destroyed, it is responsible for unreffing
858          * all CDRs in the chain
859          */
860         if (cdr->is_root) {
861                 struct cdr_object *curr = cdr->next;
862                 struct cdr_object *next;
863
864                 while (curr) {
865                         next = curr->next;
866                         ao2_cleanup(curr);
867                         curr = next;
868                 }
869         }
870 }
871
872 /*!
873  * \brief \ref cdr_object constructor
874  * \param chan The \ref ast_channel_snapshot that is the CDR's Party A
875  *
876  * This implicitly sets the state of the newly created CDR to the Single state
877  * (\ref single_state_fn_table)
878  */
879 static struct cdr_object *cdr_object_alloc(struct ast_channel_snapshot *chan)
880 {
881         RAII_VAR(struct module_config *, mod_cfg, ao2_global_obj_ref(module_configs), ao2_cleanup);
882         struct cdr_object *cdr;
883
884         ast_assert(chan != NULL);
885
886         cdr = ao2_alloc(sizeof(*cdr), cdr_object_dtor);
887         if (!cdr) {
888                 return NULL;
889         }
890         cdr->last = cdr;
891         if (ast_string_field_init(cdr, 64)) {
892                 ao2_cleanup(cdr);
893                 return NULL;
894         }
895         ast_string_field_set(cdr, uniqueid, chan->uniqueid);
896         ast_string_field_set(cdr, name, chan->name);
897         ast_string_field_set(cdr, linkedid, chan->linkedid);
898         cdr->disposition = AST_CDR_NULL;
899         cdr->sequence = ast_atomic_fetchadd_int(&global_cdr_sequence, +1);
900
901         cdr->party_a.snapshot = chan;
902         ao2_t_ref(cdr->party_a.snapshot, +1, "bump snapshot during CDR creation");
903
904         CDR_DEBUG(mod_cfg, "%p - Created CDR for channel %s\n", cdr, chan->name);
905
906         cdr_object_transition_state(cdr, &single_state_fn_table);
907
908         return cdr;
909 }
910
911 /*!
912  * \brief Create a new \ref cdr_object and append it to an existing chain
913  * \param cdr The \ref cdr_object to append to
914  */
915 static struct cdr_object *cdr_object_create_and_append(struct cdr_object *cdr)
916 {
917         struct cdr_object *new_cdr;
918         struct cdr_object *it_cdr;
919         struct cdr_object *cdr_last;
920
921         cdr_last = cdr->last;
922         new_cdr = cdr_object_alloc(cdr_last->party_a.snapshot);
923         if (!new_cdr) {
924                 return NULL;
925         }
926         new_cdr->disposition = AST_CDR_NULL;
927
928         /* Copy over the linkedid, as it may have changed */
929         ast_string_field_set(new_cdr, linkedid, cdr_last->linkedid);
930         ast_string_field_set(new_cdr, appl, cdr_last->appl);
931         ast_string_field_set(new_cdr, data, cdr_last->data);
932         ast_string_field_set(new_cdr, context, cdr_last->context);
933         ast_string_field_set(new_cdr, exten, cdr_last->exten);
934
935         /*
936          * If the current CDR says to disable all future ones,
937          * keep the disable chain going
938          */
939         if (ast_test_flag(&cdr_last->flags, AST_CDR_FLAG_DISABLE_ALL)) {
940                 ast_set_flag(&new_cdr->flags, AST_CDR_FLAG_DISABLE_ALL);
941         }
942
943         /* Copy over other Party A information */
944         cdr_object_snapshot_copy(&new_cdr->party_a, &cdr_last->party_a);
945
946         /* Append the CDR to the end of the list */
947         for (it_cdr = cdr; it_cdr->next; it_cdr = it_cdr->next) {
948                 it_cdr->last = new_cdr;
949         }
950         it_cdr->last = new_cdr;
951         it_cdr->next = new_cdr;
952
953         return new_cdr;
954 }
955
956 /*!
957  * \brief Return whether or not a channel has changed its state in the dialplan, subject
958  * to endbeforehexten logic
959  *
960  * \param old_snapshot The previous state
961  * \param new_snapshot The new state
962  *
963  * \retval 0 if the state has not changed
964  * \retval 1 if the state changed
965  */
966 static int snapshot_cep_changed(struct ast_channel_snapshot *old_snapshot,
967         struct ast_channel_snapshot *new_snapshot)
968 {
969         RAII_VAR(struct module_config *, mod_cfg,
970                 ao2_global_obj_ref(module_configs), ao2_cleanup);
971
972         /* If we ignore hangup logic, don't indicate that we're executing anything new */
973         if (ast_test_flag(&mod_cfg->general->settings, CDR_END_BEFORE_H_EXTEN)
974                 && ast_test_flag(&new_snapshot->softhangup_flags, AST_SOFTHANGUP_HANGUP_EXEC)) {
975                 return 0;
976         }
977
978         /* When Party A is originated to an application and the application exits, the stack
979          * will attempt to clear the application and restore the dummy originate application
980          * of "AppDialX". Ignore application changes to AppDialX as a result.
981          */
982         if (strcmp(new_snapshot->appl, old_snapshot->appl) && strncasecmp(new_snapshot->appl, "appdial", 7)
983                 && (strcmp(new_snapshot->context, old_snapshot->context)
984                 || strcmp(new_snapshot->exten, old_snapshot->exten)
985                 || new_snapshot->priority != old_snapshot->priority)) {
986                 return 1;
987         }
988
989         return 0;
990 }
991
992 /*!
993  * \brief Return whether or not a \ref ast_channel_snapshot is for a channel
994  * that was created as the result of a dial operation
995  *
996  * \retval 0 the channel was not created as the result of a dial
997  * \retval 1 the channel was created as the result of a dial
998  */
999 static int snapshot_is_dialed(struct ast_channel_snapshot *snapshot)
1000 {
1001         return (ast_test_flag(&snapshot->flags, AST_FLAG_OUTGOING)
1002                         && !(ast_test_flag(&snapshot->flags, AST_FLAG_ORIGINATED)));
1003 }
1004
1005 /*!
1006  * \brief Given two CDR snapshots, figure out who should be Party A for the
1007  * resulting CDR
1008  * \param left One of the snapshots
1009  * \param right The other snapshot
1010  * \retval The snapshot that won
1011  */
1012 static struct cdr_object_snapshot *cdr_object_pick_party_a(struct cdr_object_snapshot *left, struct cdr_object_snapshot *right)
1013 {
1014         /* Check whether or not the party is dialed. A dialed party is never the
1015          * Party A with a party that was not dialed.
1016          */
1017         if (!snapshot_is_dialed(left->snapshot) && snapshot_is_dialed(right->snapshot)) {
1018                 return left;
1019         } else if (snapshot_is_dialed(left->snapshot) && !snapshot_is_dialed(right->snapshot)) {
1020                 return right;
1021         }
1022
1023         /* Try the Party A flag */
1024         if (ast_test_flag(left, AST_CDR_FLAG_PARTY_A) && !ast_test_flag(right, AST_CDR_FLAG_PARTY_A)) {
1025                 return left;
1026         } else if (!ast_test_flag(right, AST_CDR_FLAG_PARTY_A) && ast_test_flag(right, AST_CDR_FLAG_PARTY_A)) {
1027                 return right;
1028         }
1029
1030         /* Neither party is dialed and neither has the Party A flag - defer to
1031          * creation time */
1032         if (left->snapshot->creationtime.tv_sec < right->snapshot->creationtime.tv_sec) {
1033                 return left;
1034         } else if (left->snapshot->creationtime.tv_sec > right->snapshot->creationtime.tv_sec) {
1035                 return right;
1036         } else if (left->snapshot->creationtime.tv_usec > right->snapshot->creationtime.tv_usec) {
1037                 return right;
1038         } else {
1039                 /* Okay, fine, take the left one */
1040                 return left;
1041         }
1042 }
1043
1044 /*!
1045  * Compute the duration for a \ref cdr_object
1046  */
1047 static long cdr_object_get_duration(struct cdr_object *cdr)
1048 {
1049         return (long)(ast_tvdiff_ms(ast_tvzero(cdr->end) ? ast_tvnow() : cdr->end, cdr->start) / 1000);
1050 }
1051
1052 /*!
1053  * \brief Compute the billsec for a \ref cdr_object
1054  */
1055 static long cdr_object_get_billsec(struct cdr_object *cdr)
1056 {
1057         RAII_VAR(struct module_config *, mod_cfg, ao2_global_obj_ref(module_configs), ao2_cleanup);
1058         long int ms;
1059
1060         if (ast_tvzero(cdr->answer)) {
1061                 return 0;
1062         }
1063         ms = ast_tvdiff_ms(ast_tvzero(cdr->end) ? ast_tvnow() : cdr->end, cdr->answer);
1064         if (ast_test_flag(&mod_cfg->general->settings, CDR_INITIATED_SECONDS)
1065                 && (ms % 1000 >= 500)) {
1066                 ms = (ms / 1000) + 1;
1067         } else {
1068                 ms = ms / 1000;
1069         }
1070
1071         return ms;
1072 }
1073
1074 /*!
1075  * \internal
1076  * \brief Set a variable on a CDR object
1077  *
1078  * \param headp The header pointer to the variable to set
1079  * \param name The name of the variable
1080  * \param value The value of the variable
1081  */
1082 static void set_variable(struct varshead *headp, const char *name, const char *value)
1083 {
1084         struct ast_var_t *newvariable;
1085
1086         AST_LIST_TRAVERSE_SAFE_BEGIN(headp, newvariable, entries) {
1087                 if (!strcasecmp(ast_var_name(newvariable), name)) {
1088                         AST_LIST_REMOVE_CURRENT(entries);
1089                         ast_var_delete(newvariable);
1090                         break;
1091                 }
1092         }
1093         AST_LIST_TRAVERSE_SAFE_END;
1094
1095         if (value && (newvariable = ast_var_assign(name, value))) {
1096                 AST_LIST_INSERT_HEAD(headp, newvariable, entries);
1097         }
1098 }
1099
1100 /*!
1101  * \brief Create a chain of \ref ast_cdr objects from a chain of \ref cdr_object
1102  * suitable for consumption by the registered CDR backends
1103  * \param cdr The \ref cdr_object to convert to a public record
1104  * \retval A chain of \ref ast_cdr objects on success
1105  * \retval NULL on failure
1106  */
1107 static struct ast_cdr *cdr_object_create_public_records(struct cdr_object *cdr)
1108 {
1109         struct ast_cdr *pub_cdr = NULL, *cdr_prev = NULL;
1110         struct cdr_object *it_cdr;
1111         struct ast_var_t *it_var, *it_copy_var;
1112         struct ast_channel_snapshot *party_a;
1113         struct ast_channel_snapshot *party_b;
1114
1115         for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
1116                 struct ast_cdr *cdr_copy;
1117
1118                 /* Don't create records for CDRs where the party A was a dialed channel */
1119                 if (snapshot_is_dialed(it_cdr->party_a.snapshot) && !it_cdr->party_b.snapshot) {
1120                         ast_debug(1, "CDR for %s is dialed and has no Party B; discarding\n",
1121                                 it_cdr->party_a.snapshot->name);
1122                         continue;
1123                 }
1124
1125                 cdr_copy = ast_calloc(1, sizeof(*cdr_copy));
1126                 if (!cdr_copy) {
1127                         ast_free(pub_cdr);
1128                         return NULL;
1129                 }
1130
1131                 party_a = it_cdr->party_a.snapshot;
1132                 party_b = it_cdr->party_b.snapshot;
1133
1134                 /* Party A */
1135                 ast_assert(party_a != NULL);
1136                 ast_copy_string(cdr_copy->accountcode, party_a->accountcode, sizeof(cdr_copy->accountcode));
1137                 cdr_copy->amaflags = party_a->amaflags;
1138                 ast_copy_string(cdr_copy->channel, party_a->name, sizeof(cdr_copy->channel));
1139                 ast_callerid_merge(cdr_copy->clid, sizeof(cdr_copy->clid), party_a->caller_name, party_a->caller_number, "");
1140                 ast_copy_string(cdr_copy->src, party_a->caller_number, sizeof(cdr_copy->src));
1141                 ast_copy_string(cdr_copy->uniqueid, party_a->uniqueid, sizeof(cdr_copy->uniqueid));
1142                 ast_copy_string(cdr_copy->lastapp, it_cdr->appl, sizeof(cdr_copy->lastapp));
1143                 ast_copy_string(cdr_copy->lastdata, it_cdr->data, sizeof(cdr_copy->lastdata));
1144                 ast_copy_string(cdr_copy->dst, it_cdr->exten, sizeof(cdr_copy->dst));
1145                 ast_copy_string(cdr_copy->dcontext, it_cdr->context, sizeof(cdr_copy->dcontext));
1146
1147                 /* Party B */
1148                 if (party_b) {
1149                         ast_copy_string(cdr_copy->dstchannel, party_b->name, sizeof(cdr_copy->dstchannel));
1150                         ast_copy_string(cdr_copy->peeraccount, party_b->accountcode, sizeof(cdr_copy->peeraccount));
1151                         if (!ast_strlen_zero(it_cdr->party_b.userfield)) {
1152                                 snprintf(cdr_copy->userfield, sizeof(cdr_copy->userfield), "%s;%s", it_cdr->party_a.userfield, it_cdr->party_b.userfield);
1153                         }
1154                 }
1155                 if (ast_strlen_zero(cdr_copy->userfield) && !ast_strlen_zero(it_cdr->party_a.userfield)) {
1156                         ast_copy_string(cdr_copy->userfield, it_cdr->party_a.userfield, sizeof(cdr_copy->userfield));
1157                 }
1158
1159                 /* Timestamps/durations */
1160                 cdr_copy->start = it_cdr->start;
1161                 cdr_copy->answer = it_cdr->answer;
1162                 cdr_copy->end = it_cdr->end;
1163                 cdr_copy->billsec = cdr_object_get_billsec(it_cdr);
1164                 cdr_copy->duration = cdr_object_get_duration(it_cdr);
1165
1166                 /* Flags and IDs */
1167                 ast_copy_flags(cdr_copy, &it_cdr->flags, AST_FLAGS_ALL);
1168                 ast_copy_string(cdr_copy->linkedid, it_cdr->linkedid, sizeof(cdr_copy->linkedid));
1169                 cdr_copy->disposition = it_cdr->disposition;
1170                 cdr_copy->sequence = it_cdr->sequence;
1171
1172                 /* Variables */
1173                 copy_variables(&cdr_copy->varshead, &it_cdr->party_a.variables);
1174                 AST_LIST_TRAVERSE(&it_cdr->party_b.variables, it_var, entries) {
1175                         int found = 0;
1176                         struct ast_var_t *newvariable;
1177                         AST_LIST_TRAVERSE(&cdr_copy->varshead, it_copy_var, entries) {
1178                                 if (!strcasecmp(ast_var_name(it_var), ast_var_name(it_copy_var))) {
1179                                         found = 1;
1180                                         break;
1181                                 }
1182                         }
1183                         if (!found && (newvariable = ast_var_assign(ast_var_name(it_var), ast_var_value(it_var)))) {
1184                                 AST_LIST_INSERT_TAIL(&cdr_copy->varshead, newvariable, entries);
1185                         }
1186                 }
1187
1188                 if (!pub_cdr) {
1189                         pub_cdr = cdr_copy;
1190                         cdr_prev = pub_cdr;
1191                 } else {
1192                         cdr_prev->next = cdr_copy;
1193                         cdr_prev = cdr_copy;
1194                 }
1195         }
1196
1197         return pub_cdr;
1198 }
1199
1200 /*!
1201  * \brief Dispatch a CDR.
1202  * \param cdr The \ref cdr_object to dispatch
1203  *
1204  * This will create a \ref ast_cdr object and publish it to the various backends
1205  */
1206 static void cdr_object_dispatch(struct cdr_object *cdr)
1207 {
1208         RAII_VAR(struct module_config *, mod_cfg,
1209                         ao2_global_obj_ref(module_configs), ao2_cleanup);
1210         struct ast_cdr *pub_cdr;
1211
1212         CDR_DEBUG(mod_cfg, "%p - Dispatching CDR for Party A %s, Party B %s\n", cdr,
1213                         cdr->party_a.snapshot->name,
1214                         cdr->party_b.snapshot ? cdr->party_b.snapshot->name : "<none>");
1215         pub_cdr = cdr_object_create_public_records(cdr);
1216         cdr_detach(pub_cdr);
1217 }
1218
1219 /*!
1220  * \brief Set the disposition on a \ref cdr_object based on a hangupcause code
1221  * \param cdr The \ref cdr_object
1222  * \param hangupcause The Asterisk hangup cause code
1223  */
1224 static void cdr_object_set_disposition(struct cdr_object *cdr, int hangupcause)
1225 {
1226         RAII_VAR(struct module_config *, mod_cfg,
1227                         ao2_global_obj_ref(module_configs), ao2_cleanup);
1228
1229         /* Change the disposition based on the hang up cause */
1230         switch (hangupcause) {
1231         case AST_CAUSE_BUSY:
1232                 cdr->disposition = AST_CDR_BUSY;
1233                 break;
1234         case AST_CAUSE_CONGESTION:
1235                 if (!ast_test_flag(&mod_cfg->general->settings, CDR_CONGESTION)) {
1236                         cdr->disposition = AST_CDR_FAILED;
1237                 } else {
1238                         cdr->disposition = AST_CDR_CONGESTION;
1239                 }
1240                 break;
1241         case AST_CAUSE_NO_ROUTE_DESTINATION:
1242         case AST_CAUSE_UNREGISTERED:
1243                 cdr->disposition = AST_CDR_FAILED;
1244                 break;
1245         case AST_CAUSE_NORMAL_CLEARING:
1246         case AST_CAUSE_NO_ANSWER:
1247                 cdr->disposition = AST_CDR_NOANSWER;
1248                 break;
1249         default:
1250                 break;
1251         }
1252 }
1253
1254 /*!
1255  * \brief Finalize a CDR.
1256  *
1257  * This function is safe to call multiple times. Note that you can call this
1258  * explicitly before going to the finalized state if there's a chance the CDR
1259  * will be re-activated, in which case the \ref cdr_object's end time should be
1260  * cleared. This function is implicitly called when a CDR transitions to the
1261  * finalized state and right before it is dispatched
1262  *
1263  * \param cdr_object The CDR to finalize
1264  */
1265 static void cdr_object_finalize(struct cdr_object *cdr)
1266 {
1267         if (!ast_tvzero(cdr->end)) {
1268                 return;
1269         }
1270         cdr->end = ast_tvnow();
1271
1272         if (cdr->disposition == AST_CDR_NULL) {
1273                 if (!ast_tvzero(cdr->answer)) {
1274                         cdr->disposition = AST_CDR_ANSWERED;
1275                 } else if (cdr->party_a.snapshot->hangupcause) {
1276                         cdr_object_set_disposition(cdr, cdr->party_a.snapshot->hangupcause);
1277                 } else if (cdr->party_b.snapshot && cdr->party_b.snapshot->hangupcause) {
1278                         cdr_object_set_disposition(cdr, cdr->party_b.snapshot->hangupcause);
1279                 } else {
1280                         cdr->disposition = AST_CDR_FAILED;
1281                 }
1282         }
1283
1284         /* tv_usec is suseconds_t, which could be int or long */
1285         ast_debug(1, "Finalized CDR for %s - start %ld.%06ld answer %ld.%06ld end %ld.%06ld dispo %s\n",
1286                         cdr->party_a.snapshot->name,
1287                         (long)cdr->start.tv_sec,
1288                         (long)cdr->start.tv_usec,
1289                         (long)cdr->answer.tv_sec,
1290                         (long)cdr->answer.tv_usec,
1291                         (long)cdr->end.tv_sec,
1292                         (long)cdr->end.tv_usec,
1293                         ast_cdr_disp2str(cdr->disposition));
1294 }
1295
1296 /*!
1297  * \brief Check to see if a CDR needs to move to the finalized state because
1298  * its Party A hungup.
1299  */
1300 static void cdr_object_check_party_a_hangup(struct cdr_object *cdr)
1301 {
1302         RAII_VAR(struct module_config *, mod_cfg, ao2_global_obj_ref(module_configs), ao2_cleanup);
1303
1304         if (ast_test_flag(&mod_cfg->general->settings, CDR_END_BEFORE_H_EXTEN)
1305                 && ast_test_flag(&cdr->party_a.snapshot->softhangup_flags, AST_SOFTHANGUP_HANGUP_EXEC)) {
1306                 cdr_object_finalize(cdr);
1307         }
1308
1309         if (ast_test_flag(&cdr->party_a.snapshot->flags, AST_FLAG_DEAD)
1310                 && cdr->fn_table != &finalized_state_fn_table) {
1311                 cdr_object_transition_state(cdr, &finalized_state_fn_table);
1312         }
1313 }
1314
1315 /*!
1316  * \brief Check to see if a CDR needs to be answered based on its Party A.
1317  * Note that this is safe to call as much as you want - we won't answer twice
1318  */
1319 static void cdr_object_check_party_a_answer(struct cdr_object *cdr) {
1320         RAII_VAR(struct module_config *, mod_cfg, ao2_global_obj_ref(module_configs), ao2_cleanup);
1321
1322         if (cdr->party_a.snapshot->state == AST_STATE_UP && ast_tvzero(cdr->answer)) {
1323                 cdr->answer = ast_tvnow();
1324                 /* tv_usec is suseconds_t, which could be int or long */
1325                 CDR_DEBUG(mod_cfg, "%p - Set answered time to %ld.%06ld\n", cdr,
1326                         (long)cdr->answer.tv_sec,
1327                         (long)cdr->answer.tv_usec);
1328         }
1329 }
1330
1331 /* \brief Set Caller ID information on a CDR */
1332 static void cdr_object_update_cid(struct cdr_object_snapshot *old_snapshot, struct ast_channel_snapshot *new_snapshot)
1333 {
1334         if (!old_snapshot->snapshot) {
1335                 set_variable(&old_snapshot->variables, "dnid", new_snapshot->caller_dnid);
1336                 set_variable(&old_snapshot->variables, "callingsubaddr", new_snapshot->caller_subaddr);
1337                 set_variable(&old_snapshot->variables, "calledsubaddr", new_snapshot->dialed_subaddr);
1338                 return;
1339         }
1340         if (!strcmp(old_snapshot->snapshot->caller_dnid, new_snapshot->caller_dnid)) {
1341                 set_variable(&old_snapshot->variables, "dnid", new_snapshot->caller_dnid);
1342         }
1343         if (!strcmp(old_snapshot->snapshot->caller_subaddr, new_snapshot->caller_subaddr)) {
1344                 set_variable(&old_snapshot->variables, "callingsubaddr", new_snapshot->caller_subaddr);
1345         }
1346         if (!strcmp(old_snapshot->snapshot->dialed_subaddr, new_snapshot->dialed_subaddr)) {
1347                 set_variable(&old_snapshot->variables, "calledsubaddr", new_snapshot->dialed_subaddr);
1348         }
1349 }
1350
1351 /*!
1352  * \brief Swap an old \ref cdr_object_snapshot's \ref ast_channel_snapshot for
1353  * a new \ref ast_channel_snapshot
1354  * \param old_snapshot The old \ref cdr_object_snapshot
1355  * \param new_snapshot The new \ref ast_channel_snapshot for old_snapshot
1356  */
1357 static void cdr_object_swap_snapshot(struct cdr_object_snapshot *old_snapshot,
1358                 struct ast_channel_snapshot *new_snapshot)
1359 {
1360         cdr_object_update_cid(old_snapshot, new_snapshot);
1361         if (old_snapshot->snapshot) {
1362                 ao2_t_ref(old_snapshot->snapshot, -1, "Drop ref for swap");
1363         }
1364         ao2_t_ref(new_snapshot, +1, "Bump ref for swap");
1365         old_snapshot->snapshot = new_snapshot;
1366 }
1367
1368 /* BASE METHOD IMPLEMENTATIONS */
1369
1370 static int base_process_party_a(struct cdr_object *cdr, struct ast_channel_snapshot *snapshot)
1371 {
1372         RAII_VAR(struct module_config *, mod_cfg, ao2_global_obj_ref(module_configs), ao2_cleanup);
1373
1374         ast_assert(strcasecmp(snapshot->name, cdr->party_a.snapshot->name) == 0);
1375
1376         /* Finalize the CDR if we're in hangup logic and we're set to do so */
1377         if (ast_test_flag(&snapshot->softhangup_flags, AST_SOFTHANGUP_HANGUP_EXEC)
1378                 && ast_test_flag(&mod_cfg->general->settings, CDR_END_BEFORE_H_EXTEN)) {
1379                 cdr_object_finalize(cdr);
1380                 return 0;
1381         }
1382
1383         /*
1384          * Only record the context and extension if we aren't in a subroutine, or if
1385          * we are executing hangup logic.
1386          */
1387         if (!ast_test_flag(&snapshot->flags, AST_FLAG_SUBROUTINE_EXEC)
1388                 || ast_test_flag(&snapshot->softhangup_flags, AST_SOFTHANGUP_HANGUP_EXEC)) {
1389                 ast_string_field_set(cdr, context, snapshot->context);
1390                 ast_string_field_set(cdr, exten, snapshot->exten);
1391         }
1392
1393         cdr_object_swap_snapshot(&cdr->party_a, snapshot);
1394
1395         /* When Party A is originated to an application and the application exits, the stack
1396          * will attempt to clear the application and restore the dummy originate application
1397          * of "AppDialX". Prevent that, and any other application changes we might not want
1398          * here.
1399          */
1400         if (!ast_strlen_zero(snapshot->appl)
1401                         && (strncasecmp(snapshot->appl, "appdial", 7) || ast_strlen_zero(cdr->appl))
1402                         && !ast_test_flag(&cdr->flags, AST_CDR_LOCK_APP)) {
1403                 ast_string_field_set(cdr, appl, snapshot->appl);
1404                 ast_string_field_set(cdr, data, snapshot->data);
1405
1406                 /* Dial (app_dial) is a special case. Because pre-dial handlers, which
1407                  * execute before the dial begins, will alter the application/data to
1408                  * something people typically don't want to see, if we see a channel enter
1409                  * into Dial here, we set the appl/data accordingly and lock it.
1410                  */
1411                 if (!strcmp(snapshot->appl, "Dial")) {
1412                         ast_set_flag(&cdr->flags, AST_CDR_LOCK_APP);
1413                 }
1414         }
1415
1416         ast_string_field_set(cdr, linkedid, snapshot->linkedid);
1417         cdr_object_check_party_a_answer(cdr);
1418         cdr_object_check_party_a_hangup(cdr);
1419
1420         return 0;
1421 }
1422
1423 static int base_process_bridge_leave(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel)
1424 {
1425         return 0;
1426 }
1427
1428 static int base_process_dial_end(struct cdr_object *cdr, struct ast_channel_snapshot *caller, struct ast_channel_snapshot *peer, const char *dial_status)
1429 {
1430         return 0;
1431 }
1432
1433 static enum process_bridge_enter_results base_process_bridge_enter(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel)
1434 {
1435         /* Base process bridge enter simply indicates that we can't handle it */
1436         return BRIDGE_ENTER_NEED_CDR;
1437 }
1438
1439 static int base_process_parked_channel(struct cdr_object *cdr, struct ast_parked_call_payload *parking_info)
1440 {
1441         char park_info[128];
1442
1443         ast_assert(!strcasecmp(parking_info->parkee->name, cdr->party_a.snapshot->name));
1444
1445         /* Update Party A information regardless */
1446         cdr->fn_table->process_party_a(cdr, parking_info->parkee);
1447
1448         /* Fake out where we're parked */
1449         ast_string_field_set(cdr, appl, "Park");
1450         snprintf(park_info, sizeof(park_info), "%s:%u", parking_info->parkinglot, parking_info->parkingspace);
1451         ast_string_field_set(cdr, data, park_info);
1452
1453         /* Prevent any further changes to the App/Data fields for this record */
1454         ast_set_flag(&cdr->flags, AST_CDR_LOCK_APP);
1455
1456         return 0;
1457 }
1458
1459 /* SINGLE STATE */
1460
1461 static void single_state_init_function(struct cdr_object *cdr)
1462 {
1463         cdr->start = ast_tvnow();
1464         cdr_object_check_party_a_answer(cdr);
1465 }
1466
1467 static void single_state_process_party_b(struct cdr_object *cdr, struct ast_channel_snapshot *snapshot)
1468 {
1469         /* This should never happen! */
1470         ast_assert(cdr->party_b.snapshot == NULL);
1471         ast_assert(0);
1472         return;
1473 }
1474
1475 static int single_state_process_dial_begin(struct cdr_object *cdr, struct ast_channel_snapshot *caller, struct ast_channel_snapshot *peer)
1476 {
1477         RAII_VAR(struct module_config *, mod_cfg, ao2_global_obj_ref(module_configs), ao2_cleanup);
1478
1479         if (caller && !strcasecmp(cdr->party_a.snapshot->name, caller->name)) {
1480                 base_process_party_a(cdr, caller);
1481                 CDR_DEBUG(mod_cfg, "%p - Updated Party A %s snapshot\n", cdr,
1482                                 cdr->party_a.snapshot->name);
1483                 cdr_object_swap_snapshot(&cdr->party_b, peer);
1484                 CDR_DEBUG(mod_cfg, "%p - Updated Party B %s snapshot\n", cdr,
1485                                 cdr->party_b.snapshot->name);
1486
1487                 /* If we have two parties, lock the application that caused the
1488                  * two parties to be associated. This prevents mid-call event
1489                  * macros/gosubs from perturbing the CDR application/data
1490                  */
1491                 ast_set_flag(&cdr->flags, AST_CDR_LOCK_APP);
1492         } else if (!strcasecmp(cdr->party_a.snapshot->name, peer->name)) {
1493                 /* We're the entity being dialed, i.e., outbound origination */
1494                 base_process_party_a(cdr, peer);
1495                 CDR_DEBUG(mod_cfg, "%p - Updated Party A %s snapshot\n", cdr,
1496                                 cdr->party_a.snapshot->name);
1497         }
1498
1499         cdr_object_transition_state(cdr, &dial_state_fn_table);
1500         return 0;
1501 }
1502
1503 /*!
1504  * \brief Handle a comparison between our \ref cdr_object and a \ref cdr_object
1505  * already in the bridge while in the Single state. The goal of this is to find
1506  * a Party B for our CDR.
1507  *
1508  * \param cdr Our \ref cdr_object in the Single state
1509  * \param cand_cdr The \ref cdr_object already in the Bridge state
1510  *
1511  * \retval 0 The cand_cdr had a Party A or Party B that we could use as our
1512  * Party B
1513  * \retval 1 No party in the cand_cdr could be used as our Party B
1514  */
1515 static int single_state_bridge_enter_comparison(struct cdr_object *cdr,
1516                 struct cdr_object *cand_cdr)
1517 {
1518         RAII_VAR(struct module_config *, mod_cfg, ao2_global_obj_ref(module_configs), ao2_cleanup);
1519         struct cdr_object_snapshot *party_a;
1520
1521         /* Don't match on ourselves */
1522         if (!strcasecmp(cdr->party_a.snapshot->name, cand_cdr->party_a.snapshot->name)) {
1523                 return 1;
1524         }
1525
1526         /* Try the candidate CDR's Party A first */
1527         party_a = cdr_object_pick_party_a(&cdr->party_a, &cand_cdr->party_a);
1528         if (!strcasecmp(party_a->snapshot->name, cdr->party_a.snapshot->name)) {
1529                 CDR_DEBUG(mod_cfg, "%p - Party A %s has new Party B %s\n",
1530                         cdr, cdr->party_a.snapshot->name, cand_cdr->party_a.snapshot->name);
1531                 cdr_object_snapshot_copy(&cdr->party_b, &cand_cdr->party_a);
1532                 if (!cand_cdr->party_b.snapshot) {
1533                         /* We just stole them - finalize their CDR. Note that this won't
1534                          * transition their state, it just sets the end time and the
1535                          * disposition - if we need to re-activate them later, we can.
1536                          */
1537                         cdr_object_finalize(cand_cdr);
1538                 }
1539                 return 0;
1540         }
1541
1542         /* Try their Party B, unless it's us */
1543         if (!cand_cdr->party_b.snapshot
1544                 || !strcasecmp(cdr->party_a.snapshot->name, cand_cdr->party_b.snapshot->name)) {
1545                 return 1;
1546         }
1547         party_a = cdr_object_pick_party_a(&cdr->party_a, &cand_cdr->party_b);
1548         if (!strcasecmp(party_a->snapshot->name, cdr->party_a.snapshot->name)) {
1549                 CDR_DEBUG(mod_cfg, "%p - Party A %s has new Party B %s\n",
1550                         cdr, cdr->party_a.snapshot->name, cand_cdr->party_b.snapshot->name);
1551                 cdr_object_snapshot_copy(&cdr->party_b, &cand_cdr->party_b);
1552                 return 0;
1553         }
1554
1555         return 1;
1556 }
1557
1558 static enum process_bridge_enter_results single_state_process_bridge_enter(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel)
1559 {
1560         struct ao2_iterator it_cdrs;
1561         char *channel_id;
1562         int success = 0;
1563
1564         ast_string_field_set(cdr, bridge, bridge->uniqueid);
1565
1566         if (ao2_container_count(bridge->channels) == 1) {
1567                 /* No one in the bridge yet but us! */
1568                 cdr_object_transition_state(cdr, &bridge_state_fn_table);
1569                 return BRIDGE_ENTER_ONLY_PARTY;
1570         }
1571
1572         for (it_cdrs = ao2_iterator_init(bridge->channels, 0);
1573                 !success && (channel_id = ao2_iterator_next(&it_cdrs));
1574                 ao2_ref(channel_id, -1)) {
1575                 RAII_VAR(struct cdr_object *, cand_cdr_master,
1576                         ao2_find(active_cdrs_by_channel, channel_id, OBJ_KEY),
1577                         ao2_cleanup);
1578                 struct cdr_object *cand_cdr;
1579
1580                 if (!cand_cdr_master) {
1581                         continue;
1582                 }
1583
1584                 ao2_lock(cand_cdr_master);
1585                 for (cand_cdr = cand_cdr_master; cand_cdr; cand_cdr = cand_cdr->next) {
1586                         /* Skip any records that are not in a bridge or in this bridge.
1587                          * I'm not sure how that would happen, but it pays to be careful. */
1588                         if (cand_cdr->fn_table != &bridge_state_fn_table ||
1589                                         strcmp(cdr->bridge, cand_cdr->bridge)) {
1590                                 continue;
1591                         }
1592
1593                         if (single_state_bridge_enter_comparison(cdr, cand_cdr)) {
1594                                 continue;
1595                         }
1596                         /* We successfully got a party B - break out */
1597                         success = 1;
1598                         break;
1599                 }
1600                 ao2_unlock(cand_cdr_master);
1601         }
1602         ao2_iterator_destroy(&it_cdrs);
1603
1604         /* We always transition state, even if we didn't get a peer */
1605         cdr_object_transition_state(cdr, &bridge_state_fn_table);
1606
1607         /* Success implies that we have a Party B */
1608         if (success) {
1609                 return BRIDGE_ENTER_OBTAINED_PARTY_B;
1610         }
1611
1612         return BRIDGE_ENTER_NO_PARTY_B;
1613 }
1614
1615 static int single_state_process_parking_bridge_enter(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel)
1616 {
1617         cdr_object_transition_state(cdr, &parked_state_fn_table);
1618         return 0;
1619 }
1620
1621
1622 /* DIAL STATE */
1623
1624 static void dial_state_process_party_b(struct cdr_object *cdr, struct ast_channel_snapshot *snapshot)
1625 {
1626         ast_assert(snapshot != NULL);
1627
1628         if (!cdr->party_b.snapshot
1629                 || strcasecmp(cdr->party_b.snapshot->name, snapshot->name)) {
1630                 return;
1631         }
1632         cdr_object_swap_snapshot(&cdr->party_b, snapshot);
1633
1634         /* If party B hangs up, finalize this CDR */
1635         if (ast_test_flag(&cdr->party_b.snapshot->flags, AST_FLAG_DEAD)) {
1636                 cdr_object_transition_state(cdr, &finalized_state_fn_table);
1637         }
1638 }
1639
1640 static int dial_state_process_dial_begin(struct cdr_object *cdr, struct ast_channel_snapshot *caller, struct ast_channel_snapshot *peer)
1641 {
1642         /* Don't process a begin dial here. A party A already in the dial state will
1643          * who receives a dial begin for something else will be handled by the
1644          * message router callback and will add a new CDR for the party A */
1645         return 1;
1646 }
1647
1648 /*!
1649  * \internal
1650  * \brief Convert a dial status to a CDR disposition
1651  */
1652 static enum ast_cdr_disposition dial_status_to_disposition(const char *dial_status)
1653 {
1654         RAII_VAR(struct module_config *, mod_cfg,
1655                 ao2_global_obj_ref(module_configs), ao2_cleanup);
1656
1657         if (!strcmp(dial_status, "ANSWER")) {
1658                 return AST_CDR_ANSWERED;
1659         } else if (!strcmp(dial_status, "BUSY")) {
1660                 return AST_CDR_BUSY;
1661         } else if (!strcmp(dial_status, "CANCEL") || !strcmp(dial_status, "NOANSWER")) {
1662                 return AST_CDR_NOANSWER;
1663         } else if (!strcmp(dial_status, "CONGESTION")) {
1664                 if (!ast_test_flag(&mod_cfg->general->settings, CDR_CONGESTION)) {
1665                         return AST_CDR_FAILED;
1666                 } else {
1667                         return AST_CDR_CONGESTION;
1668                 }
1669         } else if (!strcmp(dial_status, "FAILED")) {
1670                 return AST_CDR_FAILED;
1671         }
1672         return AST_CDR_FAILED;
1673 }
1674
1675 static int dial_state_process_dial_end(struct cdr_object *cdr, struct ast_channel_snapshot *caller, struct ast_channel_snapshot *peer, const char *dial_status)
1676 {
1677         struct ast_channel_snapshot *party_a;
1678
1679         if (caller) {
1680                 party_a = caller;
1681         } else {
1682                 party_a = peer;
1683         }
1684         ast_assert(!strcasecmp(cdr->party_a.snapshot->name, party_a->name));
1685         cdr_object_swap_snapshot(&cdr->party_a, party_a);
1686
1687         if (cdr->party_b.snapshot) {
1688                 if (strcasecmp(cdr->party_b.snapshot->name, peer->name)) {
1689                         /* Not the status for this CDR - defer back to the message router */
1690                         return 1;
1691                 }
1692                 cdr_object_swap_snapshot(&cdr->party_b, peer);
1693         }
1694
1695         /* Set the disposition based on the dial string. */
1696         cdr->disposition = dial_status_to_disposition(dial_status);
1697         if (cdr->disposition == AST_CDR_ANSWERED) {
1698                 /* Switch to dial pending to wait and see what the caller does */
1699                 cdr_object_transition_state(cdr, &dialed_pending_state_fn_table);
1700         } else {
1701                 cdr_object_transition_state(cdr, &finalized_state_fn_table);
1702         }
1703
1704         return 0;
1705 }
1706
1707 static enum process_bridge_enter_results dial_state_process_bridge_enter(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel)
1708 {
1709         struct ao2_iterator it_cdrs;
1710         char *channel_id;
1711         int success = 0;
1712
1713         ast_string_field_set(cdr, bridge, bridge->uniqueid);
1714
1715         /* Get parties in the bridge */
1716         if (ao2_container_count(bridge->channels) == 1) {
1717                 /* No one in the bridge yet but us! */
1718                 cdr_object_transition_state(cdr, &bridge_state_fn_table);
1719                 return BRIDGE_ENTER_ONLY_PARTY;
1720         }
1721
1722         for (it_cdrs = ao2_iterator_init(bridge->channels, 0);
1723                 !success && (channel_id = ao2_iterator_next(&it_cdrs));
1724                 ao2_ref(channel_id, -1)) {
1725                 RAII_VAR(struct cdr_object *, cand_cdr_master,
1726                         ao2_find(active_cdrs_by_channel, channel_id, OBJ_KEY),
1727                         ao2_cleanup);
1728                 struct cdr_object *cand_cdr;
1729
1730                 if (!cand_cdr_master) {
1731                         continue;
1732                 }
1733
1734                 ao2_lock(cand_cdr_master);
1735                 for (cand_cdr = cand_cdr_master; cand_cdr; cand_cdr = cand_cdr->next) {
1736                         /* Skip any records that are not in a bridge or in this bridge.
1737                          * I'm not sure how that would happen, but it pays to be careful. */
1738                         if (cand_cdr->fn_table != &bridge_state_fn_table ||
1739                                         strcmp(cdr->bridge, cand_cdr->bridge)) {
1740                                 continue;
1741                         }
1742
1743                         /* If we don't have a Party B (originated channel), skip it */
1744                         if (!cdr->party_b.snapshot) {
1745                                 continue;
1746                         }
1747
1748                         /* Skip any records that aren't our Party B */
1749                         if (strcasecmp(cdr->party_b.snapshot->name, cand_cdr->party_a.snapshot->name)) {
1750                                 continue;
1751                         }
1752                         cdr_object_snapshot_copy(&cdr->party_b, &cand_cdr->party_a);
1753                         /* If they have a Party B, they joined up with someone else as their
1754                          * Party A. Don't finalize them as they're active. Otherwise, we
1755                          * have stolen them so they need to be finalized.
1756                          */
1757                         if (!cand_cdr->party_b.snapshot) {
1758                                 cdr_object_finalize(cand_cdr);
1759                         }
1760                         success = 1;
1761                         break;
1762                 }
1763                 ao2_unlock(cand_cdr_master);
1764         }
1765         ao2_iterator_destroy(&it_cdrs);
1766
1767         /* We always transition state, even if we didn't get a peer */
1768         cdr_object_transition_state(cdr, &bridge_state_fn_table);
1769
1770         /* Success implies that we have a Party B */
1771         if (success) {
1772                 return BRIDGE_ENTER_OBTAINED_PARTY_B;
1773         }
1774         return BRIDGE_ENTER_NO_PARTY_B;
1775 }
1776
1777 /* DIALED PENDING STATE */
1778
1779 static int dialed_pending_state_process_party_a(struct cdr_object *cdr, struct ast_channel_snapshot *snapshot)
1780 {
1781         /* If we get a CEP change, we're executing dialplan. If we have a Party B
1782          * that means we need a new CDR; otherwise, switch us over to single.
1783          */
1784         if (snapshot_cep_changed(cdr->party_a.snapshot, snapshot)) {
1785                 if (cdr->party_b.snapshot) {
1786                         cdr_object_transition_state(cdr, &finalized_state_fn_table);
1787                         cdr->fn_table->process_party_a(cdr, snapshot);
1788                         return 1;
1789                 } else {
1790                         cdr_object_transition_state(cdr, &single_state_fn_table);
1791                         cdr->fn_table->process_party_a(cdr, snapshot);
1792                         return 0;
1793                 }
1794         }
1795         base_process_party_a(cdr, snapshot);
1796         return 0;
1797 }
1798
1799 static enum process_bridge_enter_results dialed_pending_state_process_bridge_enter(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel)
1800 {
1801         cdr_object_transition_state(cdr, &dial_state_fn_table);
1802         return cdr->fn_table->process_bridge_enter(cdr, bridge, channel);
1803 }
1804
1805 static int dialed_pending_state_process_parking_bridge_enter(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel)
1806 {
1807         if (cdr->party_b.snapshot) {
1808                 /* We can't handle this as we have a Party B - ask for a new one */
1809                 return 1;
1810         }
1811         cdr_object_transition_state(cdr, &parked_state_fn_table);
1812         return 0;
1813 }
1814
1815 static int dialed_pending_state_process_dial_begin(struct cdr_object *cdr, struct ast_channel_snapshot *caller, struct ast_channel_snapshot *peer)
1816 {
1817         cdr_object_transition_state(cdr, &finalized_state_fn_table);
1818
1819         /* Ask for a new CDR */
1820         return 1;
1821 }
1822
1823 /* BRIDGE STATE */
1824
1825 static void bridge_state_process_party_b(struct cdr_object *cdr, struct ast_channel_snapshot *snapshot)
1826 {
1827         if (!cdr->party_b.snapshot
1828                 || strcasecmp(cdr->party_b.snapshot->name, snapshot->name)) {
1829                 return;
1830         }
1831         cdr_object_swap_snapshot(&cdr->party_b, snapshot);
1832
1833         /* If party B hangs up, finalize this CDR */
1834         if (ast_test_flag(&cdr->party_b.snapshot->flags, AST_FLAG_DEAD)) {
1835                 cdr_object_transition_state(cdr, &finalized_state_fn_table);
1836         }
1837 }
1838
1839 static int bridge_state_process_bridge_leave(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel)
1840 {
1841         if (strcmp(cdr->bridge, bridge->uniqueid)) {
1842                 return 1;
1843         }
1844         if (strcasecmp(cdr->party_a.snapshot->name, channel->name)
1845                 && cdr->party_b.snapshot
1846                 && strcasecmp(cdr->party_b.snapshot->name, channel->name)) {
1847                 return 1;
1848         }
1849         cdr_object_transition_state(cdr, &finalized_state_fn_table);
1850
1851         return 0;
1852 }
1853
1854 /* PARKED STATE */
1855
1856 static int parked_state_process_bridge_leave(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *channel)
1857 {
1858         if (strcasecmp(cdr->party_a.snapshot->name, channel->name)) {
1859                 return 1;
1860         }
1861         cdr_object_transition_state(cdr, &finalized_state_fn_table);
1862
1863         return 0;
1864 }
1865
1866 /* FINALIZED STATE */
1867
1868 static void finalized_state_init_function(struct cdr_object *cdr)
1869 {
1870         cdr_object_finalize(cdr);
1871 }
1872
1873 static int finalized_state_process_party_a(struct cdr_object *cdr, struct ast_channel_snapshot *snapshot)
1874 {
1875         RAII_VAR(struct module_config *, mod_cfg,
1876                 ao2_global_obj_ref(module_configs), ao2_cleanup);
1877
1878         if (ast_test_flag(&snapshot->softhangup_flags, AST_SOFTHANGUP_HANGUP_EXEC)
1879                         && ast_test_flag(&mod_cfg->general->settings, CDR_END_BEFORE_H_EXTEN)) {
1880                 return 0;
1881         }
1882
1883         /* Indicate that, if possible, we should get a new CDR */
1884         return 1;
1885 }
1886
1887 /*!
1888  * \internal
1889  * \brief Filter channel snapshots by technology
1890  */
1891 static int filter_channel_snapshot(struct ast_channel_snapshot *snapshot)
1892 {
1893         return snapshot->tech_properties & AST_CHAN_TP_INTERNAL;
1894 }
1895
1896 /*!
1897  * \internal
1898  * \brief Filter a channel cache update
1899  */
1900 static int filter_channel_cache_message(struct ast_channel_snapshot *old_snapshot,
1901                 struct ast_channel_snapshot *new_snapshot)
1902 {
1903         int ret = 0;
1904
1905         /* Drop cache updates from certain channel technologies */
1906         if (old_snapshot) {
1907                 ret |= filter_channel_snapshot(old_snapshot);
1908         }
1909         if (new_snapshot) {
1910                 ret |= filter_channel_snapshot(new_snapshot);
1911         }
1912
1913         return ret;
1914 }
1915
1916 static int dial_status_end(const char *dialstatus)
1917 {
1918         return (strcmp(dialstatus, "RINGING") &&
1919                         strcmp(dialstatus, "PROCEEDING") &&
1920                         strcmp(dialstatus, "PROGRESS"));
1921 }
1922
1923 /* TOPIC ROUTER CALLBACKS */
1924
1925 /*!
1926  * \brief Handler for Stasis-Core dial messages
1927  * \param data Passed on
1928  * \param sub The stasis subscription for this message callback
1929  * \param topic The topic this message was published for
1930  * \param message The message
1931  */
1932 static void handle_dial_message(void *data, struct stasis_subscription *sub, struct stasis_message *message)
1933 {
1934         RAII_VAR(struct module_config *, mod_cfg, ao2_global_obj_ref(module_configs), ao2_cleanup);
1935         RAII_VAR(struct cdr_object *, cdr, NULL, ao2_cleanup);
1936         struct ast_multi_channel_blob *payload = stasis_message_data(message);
1937         struct ast_channel_snapshot *caller;
1938         struct ast_channel_snapshot *peer;
1939         struct cdr_object *it_cdr;
1940         struct ast_json *dial_status_blob;
1941         const char *dial_status = NULL;
1942         int res = 1;
1943
1944         caller = ast_multi_channel_blob_get_channel(payload, "caller");
1945         peer = ast_multi_channel_blob_get_channel(payload, "peer");
1946         if (!peer && !caller) {
1947                 return;
1948         }
1949         dial_status_blob = ast_json_object_get(ast_multi_channel_blob_get_json(payload), "dialstatus");
1950         if (dial_status_blob) {
1951                 dial_status = ast_json_string_get(dial_status_blob);
1952         }
1953
1954         CDR_DEBUG(mod_cfg, "Dial %s message for %s, %s: %u.%08u\n",
1955                         ast_strlen_zero(dial_status) ? "Begin" : "End",
1956                         caller ? caller->name : "(none)",
1957                         peer ? peer->name : "(none)",
1958                         (unsigned int)stasis_message_timestamp(message)->tv_sec,
1959                         (unsigned int)stasis_message_timestamp(message)->tv_usec);
1960
1961         if (filter_channel_snapshot(peer) || (caller && filter_channel_snapshot(caller))) {
1962                 return;
1963         }
1964
1965         /* Figure out who is running this show */
1966         if (caller) {
1967                 cdr = ao2_find(active_cdrs_by_channel, caller->uniqueid, OBJ_KEY);
1968         } else {
1969                 cdr = ao2_find(active_cdrs_by_channel, peer->uniqueid, OBJ_KEY);
1970         }
1971
1972         if (!cdr) {
1973                 ast_log(AST_LOG_WARNING, "No CDR for channel %s\n", caller ? caller->name : peer->name);
1974                 ast_assert(0);
1975                 return;
1976         }
1977
1978         ao2_lock(cdr);
1979         for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
1980                 if (ast_strlen_zero(dial_status)) {
1981                         if (!it_cdr->fn_table->process_dial_begin) {
1982                                 continue;
1983                         }
1984                         CDR_DEBUG(mod_cfg, "%p - Processing Dial Begin message for channel %s, peer %s\n",
1985                                         it_cdr,
1986                                         caller ? caller->name : "(none)",
1987                                         peer ? peer->name : "(none)");
1988                         res &= it_cdr->fn_table->process_dial_begin(it_cdr,
1989                                         caller,
1990                                         peer);
1991                 } else if (dial_status_end(dial_status)) {
1992                         if (!it_cdr->fn_table->process_dial_end) {
1993                                 continue;
1994                         }
1995                         CDR_DEBUG(mod_cfg, "%p - Processing Dial End message for channel %s, peer %s\n",
1996                                         it_cdr,
1997                                         caller ? caller->name : "(none)",
1998                                         peer ? peer->name : "(none)");
1999                         it_cdr->fn_table->process_dial_end(it_cdr,
2000                                         caller,
2001                                         peer,
2002                                         dial_status);
2003                 }
2004         }
2005
2006         /* If no CDR handled a dial begin message, make a new one */
2007         if (res && ast_strlen_zero(dial_status)) {
2008                 struct cdr_object *new_cdr;
2009
2010                 new_cdr = cdr_object_create_and_append(cdr);
2011                 if (!new_cdr) {
2012                         ao2_unlock(cdr);
2013                         return;
2014                 }
2015                 new_cdr->fn_table->process_dial_begin(new_cdr,
2016                                 caller,
2017                                 peer);
2018         }
2019         ao2_unlock(cdr);
2020 }
2021
2022 static int cdr_object_finalize_party_b(void *obj, void *arg, int flags)
2023 {
2024         struct cdr_object *cdr = obj;
2025         struct ast_channel_snapshot *party_b = arg;
2026         struct cdr_object *it_cdr;
2027
2028         for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
2029                 if (it_cdr->party_b.snapshot
2030                         && !strcasecmp(it_cdr->party_b.snapshot->name, party_b->name)) {
2031                         /* Don't transition to the finalized state - let the Party A do
2032                          * that when its ready
2033                          */
2034                         cdr_object_finalize(it_cdr);
2035                 }
2036         }
2037         return 0;
2038 }
2039
2040 static int cdr_object_update_party_b(void *obj, void *arg, int flags)
2041 {
2042         struct cdr_object *cdr = obj;
2043         struct ast_channel_snapshot *party_b = arg;
2044         struct cdr_object *it_cdr;
2045
2046         for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
2047                 if (!it_cdr->fn_table->process_party_b) {
2048                         continue;
2049                 }
2050                 if (it_cdr->party_b.snapshot
2051                         && !strcasecmp(it_cdr->party_b.snapshot->name, party_b->name)) {
2052                         it_cdr->fn_table->process_party_b(it_cdr, party_b);
2053                 }
2054         }
2055         return 0;
2056 }
2057
2058 /*! \brief Determine if we need to add a new CDR based on snapshots */
2059 static int check_new_cdr_needed(struct ast_channel_snapshot *old_snapshot,
2060                 struct ast_channel_snapshot *new_snapshot)
2061 {
2062         RAII_VAR(struct module_config *, mod_cfg,
2063                         ao2_global_obj_ref(module_configs), ao2_cleanup);
2064
2065         /* If we're dead, we don't need a new CDR */
2066         if (!new_snapshot
2067                 || (ast_test_flag(&new_snapshot->softhangup_flags, AST_SOFTHANGUP_HANGUP_EXEC)
2068                         && ast_test_flag(&mod_cfg->general->settings, CDR_END_BEFORE_H_EXTEN))) {
2069                 return 0;
2070         }
2071
2072         /* Auto-fall through will increment the priority but have no application */
2073         if (ast_strlen_zero(new_snapshot->appl)) {
2074                 return 0;
2075         }
2076
2077         if (old_snapshot && !snapshot_cep_changed(old_snapshot, new_snapshot)) {
2078                 return 0;
2079         }
2080
2081         return 1;
2082 }
2083
2084 /*!
2085  * \brief Handler for Stasis-Core channel cache update messages
2086  * \param data Passed on
2087  * \param sub The stasis subscription for this message callback
2088  * \param topic The topic this message was published for
2089  * \param message The message
2090  */
2091 static void handle_channel_cache_message(void *data, struct stasis_subscription *sub, struct stasis_message *message)
2092 {
2093         RAII_VAR(struct cdr_object *, cdr, NULL, ao2_cleanup);
2094         RAII_VAR(struct module_config *, mod_cfg, ao2_global_obj_ref(module_configs), ao2_cleanup);
2095         struct stasis_cache_update *update = stasis_message_data(message);
2096         struct ast_channel_snapshot *old_snapshot;
2097         struct ast_channel_snapshot *new_snapshot;
2098         const char *uniqueid;
2099         const char *name;
2100         struct cdr_object *it_cdr;
2101
2102         ast_assert(update != NULL);
2103         ast_assert(ast_channel_snapshot_type() == update->type);
2104
2105         old_snapshot = stasis_message_data(update->old_snapshot);
2106         new_snapshot = stasis_message_data(update->new_snapshot);
2107         uniqueid = new_snapshot ? new_snapshot->uniqueid : old_snapshot->uniqueid;
2108         name = new_snapshot ? new_snapshot->name : old_snapshot->name;
2109
2110         if (filter_channel_cache_message(old_snapshot, new_snapshot)) {
2111                 return;
2112         }
2113
2114         if (new_snapshot && !old_snapshot) {
2115                 cdr = cdr_object_alloc(new_snapshot);
2116                 if (!cdr) {
2117                         return;
2118                 }
2119                 cdr->is_root = 1;
2120                 ao2_link(active_cdrs_by_channel, cdr);
2121         }
2122
2123         /* Handle Party A */
2124         if (!cdr) {
2125                 cdr = ao2_find(active_cdrs_by_channel, uniqueid, OBJ_KEY);
2126         }
2127         if (!cdr) {
2128                 ast_log(AST_LOG_WARNING, "No CDR for channel %s\n", name);
2129                 ast_assert(0);
2130         } else {
2131                 ao2_lock(cdr);
2132                 if (new_snapshot) {
2133                         int all_reject = 1;
2134                         for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
2135                                 if (!it_cdr->fn_table->process_party_a) {
2136                                         continue;
2137                                 }
2138                                 all_reject &= it_cdr->fn_table->process_party_a(it_cdr, new_snapshot);
2139                         }
2140                         if (all_reject && check_new_cdr_needed(old_snapshot, new_snapshot)) {
2141                                 /* We're not hung up and we have a new snapshot - we need a new CDR */
2142                                 struct cdr_object *new_cdr;
2143                                 new_cdr = cdr_object_create_and_append(cdr);
2144                                 if (new_cdr) {
2145                                         new_cdr->fn_table->process_party_a(new_cdr, new_snapshot);
2146                                 }
2147                         }
2148                 } else {
2149                         CDR_DEBUG(mod_cfg, "%p - Beginning finalize/dispatch for %s\n", cdr, old_snapshot->name);
2150                         for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
2151                                 cdr_object_finalize(it_cdr);
2152                         }
2153                         cdr_object_dispatch(cdr);
2154                         ao2_unlink(active_cdrs_by_channel, cdr);
2155                 }
2156                 ao2_unlock(cdr);
2157         }
2158
2159         /* Handle Party B */
2160         if (new_snapshot) {
2161                 ao2_callback(active_cdrs_by_channel, OBJ_NODATA, cdr_object_update_party_b,
2162                         new_snapshot);
2163         } else {
2164                 ao2_callback(active_cdrs_by_channel, OBJ_NODATA, cdr_object_finalize_party_b,
2165                         old_snapshot);
2166         }
2167
2168 }
2169
2170 struct bridge_leave_data {
2171         struct ast_bridge_snapshot *bridge;
2172         struct ast_channel_snapshot *channel;
2173 };
2174
2175 /*! \brief Callback used to notify CDRs of a Party B leaving the bridge */
2176 static int cdr_object_party_b_left_bridge_cb(void *obj, void *arg, int flags)
2177 {
2178         struct cdr_object *cdr = obj;
2179         struct bridge_leave_data *leave_data = arg;
2180         struct cdr_object *it_cdr;
2181
2182         if (strcmp(cdr->bridge, leave_data->bridge->uniqueid)) {
2183                 return 0;
2184         }
2185         for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
2186                 if (it_cdr->fn_table != &bridge_state_fn_table) {
2187                         continue;
2188                 }
2189                 if (!it_cdr->party_b.snapshot) {
2190                         continue;
2191                 }
2192                 if (strcasecmp(it_cdr->party_b.snapshot->name, leave_data->channel->name)) {
2193                         continue;
2194                 }
2195                 /* It is our Party B, in our bridge. Set the end time and let the handler
2196                  * transition our CDR appropriately when we leave the bridge.
2197                  */
2198                 cdr_object_finalize(it_cdr);
2199         }
2200         return 0;
2201 }
2202
2203 /*! \brief Filter bridge messages based on bridge technology */
2204 static int filter_bridge_messages(struct ast_bridge_snapshot *bridge)
2205 {
2206         /* Ignore holding bridge technology messages. We treat this simply as an application
2207          * that a channel enters into.
2208          */
2209         if (!strcmp(bridge->technology, "holding_bridge") && strcmp(bridge->subclass, "parking")) {
2210                 return 1;
2211         }
2212         return 0;
2213 }
2214
2215 /*!
2216  * \brief Handler for when a channel leaves a bridge
2217  * \param data Passed on
2218  * \param sub The stasis subscription for this message callback
2219  * \param topic The topic this message was published for
2220  * \param message The message - hopefully a bridge one!
2221  */
2222 static void handle_bridge_leave_message(void *data, struct stasis_subscription *sub,
2223                 struct stasis_message *message)
2224 {
2225         struct ast_bridge_blob *update = stasis_message_data(message);
2226         struct ast_bridge_snapshot *bridge = update->bridge;
2227         struct ast_channel_snapshot *channel = update->channel;
2228         RAII_VAR(struct module_config *, mod_cfg,
2229                         ao2_global_obj_ref(module_configs), ao2_cleanup);
2230         RAII_VAR(struct cdr_object *, cdr,
2231                         ao2_find(active_cdrs_by_channel, channel->uniqueid, OBJ_KEY),
2232                         ao2_cleanup);
2233         struct cdr_object *it_cdr;
2234         struct bridge_leave_data leave_data = {
2235                 .bridge = bridge,
2236                 .channel = channel,
2237         };
2238         int left_bridge = 0;
2239
2240         if (filter_bridge_messages(bridge)) {
2241                 return;
2242         }
2243
2244         if (filter_channel_snapshot(channel)) {
2245                 return;
2246         }
2247
2248         CDR_DEBUG(mod_cfg, "Bridge Leave message for %s: %u.%08u\n",
2249                         channel->name,
2250                         (unsigned int)stasis_message_timestamp(message)->tv_sec,
2251                         (unsigned int)stasis_message_timestamp(message)->tv_usec);
2252
2253         if (!cdr) {
2254                 ast_log(AST_LOG_WARNING, "No CDR for channel %s\n", channel->name);
2255                 ast_assert(0);
2256                 return;
2257         }
2258
2259         /* Party A */
2260         ao2_lock(cdr);
2261         for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
2262                 if (!it_cdr->fn_table->process_bridge_leave) {
2263                         continue;
2264                 }
2265                 CDR_DEBUG(mod_cfg, "%p - Processing Bridge Leave for %s\n",
2266                                 it_cdr, channel->name);
2267                 if (!it_cdr->fn_table->process_bridge_leave(it_cdr, bridge, channel)) {
2268                         ast_string_field_set(it_cdr, bridge, "");
2269                         left_bridge = 1;
2270                 }
2271         }
2272         ao2_unlock(cdr);
2273         if (!left_bridge) {
2274                 return;
2275         }
2276
2277         if (strcmp(bridge->subclass, "parking")) {
2278                 /* Party B */
2279                 ao2_callback(active_cdrs_by_channel, OBJ_NODATA,
2280                                 cdr_object_party_b_left_bridge_cb,
2281                                 &leave_data);
2282         }
2283 }
2284
2285 /*!
2286  * \internal
2287  * \brief Create a new CDR, append it to an existing CDR, and update its snapshots
2288  *
2289  * \note The new CDR will be automatically transitioned to the bridge state
2290  */
2291 static void bridge_candidate_add_to_cdr(struct cdr_object *cdr,
2292                 struct cdr_object_snapshot *party_b)
2293 {
2294         RAII_VAR(struct module_config *,  mod_cfg,
2295                 ao2_global_obj_ref(module_configs), ao2_cleanup);
2296         struct cdr_object *new_cdr;
2297
2298         new_cdr = cdr_object_create_and_append(cdr);
2299         if (!new_cdr) {
2300                 return;
2301         }
2302         cdr_object_snapshot_copy(&new_cdr->party_b, party_b);
2303         cdr_object_check_party_a_answer(new_cdr);
2304         ast_string_field_set(new_cdr, bridge, cdr->bridge);
2305         cdr_object_transition_state(new_cdr, &bridge_state_fn_table);
2306         CDR_DEBUG(mod_cfg, "%p - Party A %s has new Party B %s\n",
2307                 new_cdr, new_cdr->party_a.snapshot->name,
2308                 party_b->snapshot->name);
2309 }
2310
2311 /*!
2312  * \brief Process a single \ref bridge_candidate
2313  *
2314  * When a CDR enters a bridge, it needs to make pairings with everyone else
2315  * that it is not currently paired with. This function determines, for the
2316  * CDR for the channel that entered the bridge and the CDR for every other
2317  * channel currently in the bridge, who is Party A and makes new CDRs.
2318  *
2319  * \param cdr The \ref cdr_obj being processed
2320  * \param cand_cdr The \ref cdr_object that is a candidate
2321  *
2322  */
2323 static int bridge_candidate_process(struct cdr_object *cdr, struct cdr_object *base_cand_cdr)
2324 {
2325         RAII_VAR(struct module_config *, mod_cfg,
2326                 ao2_global_obj_ref(module_configs), ao2_cleanup);
2327         struct cdr_object_snapshot *party_a;
2328         struct cdr_object *cand_cdr;
2329
2330         SCOPED_AO2LOCK(lock, base_cand_cdr);
2331
2332         for (cand_cdr = base_cand_cdr; cand_cdr; cand_cdr = cand_cdr->next) {
2333                 /* Skip any records that are not in this bridge */
2334                 if (strcmp(cand_cdr->bridge, cdr->bridge)) {
2335                         continue;
2336                 }
2337
2338                 /* If the candidate is us or someone we've taken on, pass on by */
2339                 if (!strcasecmp(cdr->party_a.snapshot->name, cand_cdr->party_a.snapshot->name)
2340                         || (cdr->party_b.snapshot
2341                                 && !strcasecmp(cdr->party_b.snapshot->name, cand_cdr->party_a.snapshot->name))) {
2342                         return 0;
2343                 }
2344
2345                 party_a = cdr_object_pick_party_a(&cdr->party_a, &cand_cdr->party_a);
2346                 /* We're party A - make a new CDR, append it to us, and set the candidate as
2347                  * Party B */
2348                 if (!strcasecmp(party_a->snapshot->name, cdr->party_a.snapshot->name)) {
2349                         bridge_candidate_add_to_cdr(cdr, &cand_cdr->party_a);
2350                         return 0;
2351                 }
2352
2353                 /* We're Party B. Check if we can add ourselves immediately or if we need
2354                  * a new CDR for them (they already have a Party B) */
2355                 if (cand_cdr->party_b.snapshot
2356                         && strcasecmp(cand_cdr->party_b.snapshot->name, cdr->party_a.snapshot->name)) {
2357                         bridge_candidate_add_to_cdr(cand_cdr, &cdr->party_a);
2358                 } else {
2359                         CDR_DEBUG(mod_cfg, "%p - Party A %s has new Party B %s\n",
2360                                 cand_cdr, cand_cdr->party_a.snapshot->name,
2361                                 cdr->party_a.snapshot->name);
2362                         cdr_object_snapshot_copy(&cand_cdr->party_b, &cdr->party_a);
2363                         /* It's possible that this joined at one point and was never chosen
2364                          * as party A. Clear their end time, as it would be set in such a
2365                          * case.
2366                          */
2367                         memset(&cand_cdr->end, 0, sizeof(cand_cdr->end));
2368                 }
2369                 return 0;
2370         }
2371         return 0;
2372 }
2373
2374 /*!
2375  * \brief Handle creating bridge pairings for the \ref cdr_object that just
2376  * entered a bridge
2377  * \param cdr The \ref cdr_object that just entered the bridge
2378  * \param bridge The \ref ast_bridge_snapshot representing the bridge it just entered
2379  */
2380 static void handle_bridge_pairings(struct cdr_object *cdr, struct ast_bridge_snapshot *bridge)
2381 {
2382         struct ao2_iterator it_channels;
2383         char *channel_id;
2384
2385         it_channels = ao2_iterator_init(bridge->channels, 0);
2386         while ((channel_id = ao2_iterator_next(&it_channels))) {
2387                 RAII_VAR(struct cdr_object *, cand_cdr,
2388                         ao2_find(active_cdrs_by_channel, channel_id, OBJ_KEY),
2389                         ao2_cleanup);
2390
2391                 if (!cand_cdr) {
2392                         ao2_ref(channel_id, -1);
2393                         continue;
2394                 }
2395
2396                 bridge_candidate_process(cdr, cand_cdr);
2397
2398                 ao2_ref(channel_id, -1);
2399         }
2400         ao2_iterator_destroy(&it_channels);
2401 }
2402
2403 /*! \brief Handle entering into a parking bridge
2404  * \param cdr The CDR to operate on
2405  * \param bridge The bridge the channel just entered
2406  * \param channel The channel snapshot
2407  */
2408 static void handle_parking_bridge_enter_message(struct cdr_object *cdr,
2409                 struct ast_bridge_snapshot *bridge,
2410                 struct ast_channel_snapshot *channel)
2411 {
2412         RAII_VAR(struct module_config *, mod_cfg,
2413                         ao2_global_obj_ref(module_configs), ao2_cleanup);
2414         int res = 1;
2415         struct cdr_object *it_cdr;
2416         struct cdr_object *new_cdr;
2417
2418         ao2_lock(cdr);
2419
2420         for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
2421                 if (it_cdr->fn_table->process_parking_bridge_enter) {
2422                         res &= it_cdr->fn_table->process_parking_bridge_enter(it_cdr, bridge, channel);
2423                 }
2424                 if (it_cdr->fn_table->process_party_a) {
2425                         CDR_DEBUG(mod_cfg, "%p - Updating Party A %s snapshot\n", it_cdr,
2426                                         channel->name);
2427                         it_cdr->fn_table->process_party_a(it_cdr, channel);
2428                 }
2429         }
2430
2431         if (res) {
2432                 /* No one handled it - we need a new one! */
2433                 new_cdr = cdr_object_create_and_append(cdr);
2434                 if (new_cdr) {
2435                         /* Let the single state transition us to Parked */
2436                         cdr_object_transition_state(new_cdr, &single_state_fn_table);
2437                         new_cdr->fn_table->process_parking_bridge_enter(new_cdr, bridge, channel);
2438                 }
2439         }
2440         ao2_unlock(cdr);
2441 }
2442
2443 /*! \brief Handle a bridge enter message for a 'normal' bridge
2444  * \param cdr The CDR to operate on
2445  * \param bridge The bridge the channel just entered
2446  * \param channel The channel snapshot
2447  */
2448 static void handle_standard_bridge_enter_message(struct cdr_object *cdr,
2449                 struct ast_bridge_snapshot *bridge,
2450                 struct ast_channel_snapshot *channel)
2451 {
2452         RAII_VAR(struct module_config *, mod_cfg,
2453                         ao2_global_obj_ref(module_configs), ao2_cleanup);
2454         enum process_bridge_enter_results result;
2455         struct cdr_object *it_cdr;
2456         struct cdr_object *new_cdr;
2457         struct cdr_object *handled_cdr = NULL;
2458
2459         ao2_lock(cdr);
2460
2461         for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
2462                 if (it_cdr->fn_table->process_party_a) {
2463                         CDR_DEBUG(mod_cfg, "%p - Updating Party A %s snapshot\n", it_cdr,
2464                                         channel->name);
2465                         it_cdr->fn_table->process_party_a(it_cdr, channel);
2466                 }
2467
2468                 /* Notify all states that they have entered a bridge */
2469                 if (it_cdr->fn_table->process_bridge_enter) {
2470                         CDR_DEBUG(mod_cfg, "%p - Processing bridge enter for %s\n", it_cdr,
2471                                         channel->name);
2472                         result = it_cdr->fn_table->process_bridge_enter(it_cdr, bridge, channel);
2473                         switch (result) {
2474                         case BRIDGE_ENTER_ONLY_PARTY:
2475                                 /* Fall through */
2476                         case BRIDGE_ENTER_OBTAINED_PARTY_B:
2477                                 if (!handled_cdr) {
2478                                         handled_cdr = it_cdr;
2479                                 }
2480                                 break;
2481                         case BRIDGE_ENTER_NEED_CDR:
2482                                 /* Pass */
2483                                 break;
2484                         case BRIDGE_ENTER_NO_PARTY_B:
2485                                 /* We didn't win on any - end this CDR. If someone else comes in later
2486                                  * that is Party B to this CDR, it can re-activate this CDR.
2487                                  */
2488                                 if (!handled_cdr) {
2489                                         handled_cdr = it_cdr;
2490                                 }
2491                                 cdr_object_finalize(cdr);
2492                                 break;
2493                         }
2494                 }
2495         }
2496
2497         /* Create the new matchings, but only for either:
2498          *  * The first CDR in the chain that handled it. This avoids issues with
2499          *    forked CDRs.
2500          *  * If no one handled it, the last CDR in the chain. This would occur if
2501          *    a CDR joined a bridge and it wasn't Party A for anyone. We still need
2502          *    to make pairings with everyone in the bridge.
2503          */
2504         if (handled_cdr) {
2505                 handle_bridge_pairings(handled_cdr, bridge);
2506         } else {
2507                 /* Nothing handled it - we need a new one! */
2508                 new_cdr = cdr_object_create_and_append(cdr);
2509                 if (new_cdr) {
2510                         /* This is guaranteed to succeed: the new CDR is created in the single state
2511                          * and will be able to handle the bridge enter message
2512                          */
2513                         handle_standard_bridge_enter_message(cdr, bridge, channel);
2514                 }
2515         }
2516         ao2_unlock(cdr);
2517 }
2518
2519 /*!
2520  * \internal
2521  * \brief Handler for Stasis-Core bridge enter messages
2522  * \param data Passed on
2523  * \param sub The stasis subscription for this message callback
2524  * \param topic The topic this message was published for
2525  * \param message The message - hopefully a bridge one!
2526  */
2527 static void handle_bridge_enter_message(void *data, struct stasis_subscription *sub,
2528                 struct stasis_message *message)
2529 {
2530         struct ast_bridge_blob *update = stasis_message_data(message);
2531         struct ast_bridge_snapshot *bridge = update->bridge;
2532         struct ast_channel_snapshot *channel = update->channel;
2533         RAII_VAR(struct cdr_object *, cdr,
2534                         ao2_find(active_cdrs_by_channel, channel->uniqueid, OBJ_KEY),
2535                         ao2_cleanup);
2536         RAII_VAR(struct module_config *, mod_cfg,
2537                         ao2_global_obj_ref(module_configs), ao2_cleanup);
2538
2539         if (filter_bridge_messages(bridge)) {
2540                 return;
2541         }
2542
2543         if (filter_channel_snapshot(channel)) {
2544                 return;
2545         }
2546
2547         CDR_DEBUG(mod_cfg, "Bridge Enter message for channel %s: %u.%08u\n",
2548                         channel->name,
2549                         (unsigned int)stasis_message_timestamp(message)->tv_sec,
2550                         (unsigned int)stasis_message_timestamp(message)->tv_usec);
2551
2552         if (!cdr) {
2553                 ast_log(AST_LOG_WARNING, "No CDR for channel %s\n", channel->name);
2554                 ast_assert(0);
2555                 return;
2556         }
2557
2558         if (!strcmp(bridge->subclass, "parking")) {
2559                 handle_parking_bridge_enter_message(cdr, bridge, channel);
2560         } else {
2561                 handle_standard_bridge_enter_message(cdr, bridge, channel);
2562         }
2563 }
2564
2565 /*!
2566  * \brief Handler for when a channel is parked
2567  * \param data Passed on
2568  * \param sub The stasis subscription for this message callback
2569  * \param topic The topic this message was published for
2570  * \param message The message about who got parked
2571  * */
2572 static void handle_parked_call_message(void *data, struct stasis_subscription *sub,
2573                 struct stasis_message *message)
2574 {
2575         struct ast_parked_call_payload *payload = stasis_message_data(message);
2576         struct ast_channel_snapshot *channel = payload->parkee;
2577         RAII_VAR(struct cdr_object *, cdr, NULL, ao2_cleanup);
2578         RAII_VAR(struct module_config *, mod_cfg,
2579                         ao2_global_obj_ref(module_configs), ao2_cleanup);
2580         int unhandled = 1;
2581         struct cdr_object *it_cdr;
2582
2583         /* Anything other than getting parked will be handled by other updates */
2584         if (payload->event_type != PARKED_CALL) {
2585                 return;
2586         }
2587
2588         /* No one got parked? */
2589         if (!channel) {
2590                 return;
2591         }
2592
2593         if (filter_channel_snapshot(channel)) {
2594                 return;
2595         }
2596
2597         CDR_DEBUG(mod_cfg, "Parked Call message for channel %s: %u.%08u\n",
2598                         channel->name,
2599                         (unsigned int)stasis_message_timestamp(message)->tv_sec,
2600                         (unsigned int)stasis_message_timestamp(message)->tv_usec);
2601
2602         cdr = ao2_find(active_cdrs_by_channel, channel->uniqueid, OBJ_KEY);
2603         if (!cdr) {
2604                 ast_log(AST_LOG_WARNING, "No CDR for channel %s\n", channel->name);
2605                 ast_assert(0);
2606                 return;
2607         }
2608
2609         ao2_lock(cdr);
2610
2611         for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
2612                 if (it_cdr->fn_table->process_parked_channel) {
2613                         unhandled &= it_cdr->fn_table->process_parked_channel(it_cdr, payload);
2614                 }
2615         }
2616
2617         if (unhandled) {
2618                 /* Nothing handled the messgae - we need a new one! */
2619                 struct cdr_object *new_cdr = cdr_object_create_and_append(cdr);
2620                 if (new_cdr) {
2621                         /* As the new CDR is created in the single state, it is guaranteed
2622                          * to have a function for the parked call message and will handle
2623                          * the message */
2624                         new_cdr->fn_table->process_parked_channel(new_cdr, payload);
2625                 }
2626         }
2627
2628         ao2_unlock(cdr);
2629
2630 }
2631
2632 /*!
2633  * \brief Handler for a synchronization message
2634  * \param data Passed on
2635  * \param sub The stasis subscription for this message callback
2636  * \param topic The topic this message was published for
2637  * \param message A blank ao2 object
2638  * */
2639 static void handle_cdr_sync_message(void *data, struct stasis_subscription *sub,
2640                 struct stasis_message *message)
2641 {
2642         return;
2643 }
2644
2645 struct ast_cdr_config *ast_cdr_get_config(void)
2646 {
2647         RAII_VAR(struct module_config *, mod_cfg, ao2_global_obj_ref(module_configs), ao2_cleanup);
2648         ao2_ref(mod_cfg->general, +1);
2649         return mod_cfg->general;
2650 }
2651
2652 void ast_cdr_set_config(struct ast_cdr_config *config)
2653 {
2654         RAII_VAR(struct module_config *, mod_cfg, ao2_global_obj_ref(module_configs), ao2_cleanup);
2655
2656         ao2_cleanup(mod_cfg->general);
2657         mod_cfg->general = config;
2658         ao2_ref(mod_cfg->general, +1);
2659
2660         cdr_toggle_runtime_options();
2661 }
2662
2663 int ast_cdr_is_enabled(void)
2664 {
2665         RAII_VAR(struct module_config *, mod_cfg, ao2_global_obj_ref(module_configs), ao2_cleanup);
2666         return ast_test_flag(&mod_cfg->general->settings, CDR_ENABLED);
2667 }
2668
2669 int ast_cdr_backend_suspend(const char *name)
2670 {
2671         int success = -1;
2672         struct cdr_beitem *i = NULL;
2673
2674         AST_RWLIST_WRLOCK(&be_list);
2675         AST_RWLIST_TRAVERSE(&be_list, i, list) {
2676                 if (!strcasecmp(name, i->name)) {
2677                         ast_debug(3, "Suspending CDR backend %s\n", i->name);
2678                         i->suspended = 1;
2679                         success = 0;
2680                 }
2681         }
2682         AST_RWLIST_UNLOCK(&be_list);
2683
2684         return success;
2685 }
2686
2687 int ast_cdr_backend_unsuspend(const char *name)
2688 {
2689         int success = -1;
2690         struct cdr_beitem *i = NULL;
2691
2692         AST_RWLIST_WRLOCK(&be_list);
2693         AST_RWLIST_TRAVERSE(&be_list, i, list) {
2694                 if (!strcasecmp(name, i->name)) {
2695                         ast_debug(3, "Unsuspending CDR backend %s\n", i->name);
2696                         i->suspended = 0;
2697                         success = 0;
2698                 }
2699         }
2700         AST_RWLIST_UNLOCK(&be_list);
2701
2702         return success;
2703 }
2704
2705 static int cdr_generic_register(struct be_list *generic_list, const char *name, const char *desc, ast_cdrbe be)
2706 {
2707         struct cdr_beitem *i = NULL;
2708
2709         if (!name)
2710                 return -1;
2711
2712         if (!be) {
2713                 ast_log(LOG_WARNING, "CDR engine '%s' lacks backend\n", name);
2714                 return -1;
2715         }
2716
2717         AST_RWLIST_WRLOCK(generic_list);
2718         AST_RWLIST_TRAVERSE(generic_list, i, list) {
2719                 if (!strcasecmp(name, i->name)) {
2720                         ast_log(LOG_WARNING, "Already have a CDR backend called '%s'\n", name);
2721                         AST_RWLIST_UNLOCK(generic_list);
2722                         return -1;
2723                 }
2724         }
2725
2726         if (!(i = ast_calloc(1, sizeof(*i))))
2727                 return -1;
2728
2729         i->be = be;
2730         ast_copy_string(i->name, name, sizeof(i->name));
2731         ast_copy_string(i->desc, desc, sizeof(i->desc));
2732
2733         AST_RWLIST_INSERT_HEAD(generic_list, i, list);
2734         AST_RWLIST_UNLOCK(generic_list);
2735
2736         return 0;
2737 }
2738
2739 int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be)
2740 {
2741         return cdr_generic_register(&be_list, name, desc, be);
2742 }
2743
2744 int ast_cdr_modifier_register(const char *name, const char *desc, ast_cdrbe be)
2745 {
2746         return cdr_generic_register((struct be_list *)&mo_list, name, desc, be);
2747 }
2748
2749 static int ast_cdr_generic_unregister(struct be_list *generic_list, const char *name)
2750 {
2751         struct cdr_beitem *match = NULL;
2752         int active_count;
2753
2754         AST_RWLIST_WRLOCK(generic_list);
2755         AST_RWLIST_TRAVERSE(generic_list, match, list) {
2756                 if (!strcasecmp(name, match->name)) {
2757                         break;
2758                 }
2759         }
2760
2761         if (!match) {
2762                 AST_RWLIST_UNLOCK(generic_list);
2763                 return 0;
2764         }
2765
2766         active_count = ao2_container_count(active_cdrs_by_channel);
2767
2768         if (!match->suspended && active_count != 0) {
2769                 AST_RWLIST_UNLOCK(generic_list);
2770                 ast_log(AST_LOG_WARNING, "Unable to unregister CDR backend %s; %d CDRs are still active\n",
2771                         name, active_count);
2772                 return -1;
2773         }
2774
2775         AST_RWLIST_REMOVE(generic_list, match, list);
2776         AST_RWLIST_UNLOCK(generic_list);
2777
2778         ast_verb(2, "Unregistered '%s' CDR backend\n", name);
2779         ast_free(match);
2780
2781         return 0;
2782 }
2783
2784 int ast_cdr_unregister(const char *name)
2785 {
2786         return ast_cdr_generic_unregister(&be_list, name);
2787 }
2788
2789 int ast_cdr_modifier_unregister(const char *name)
2790 {
2791         return ast_cdr_generic_unregister((struct be_list *)&mo_list, name);
2792 }
2793
2794 struct ast_cdr *ast_cdr_dup(struct ast_cdr *cdr)
2795 {
2796         struct ast_cdr *newcdr;
2797
2798         if (!cdr) {
2799                 return NULL;
2800         }
2801         newcdr = ast_cdr_alloc();
2802         if (!newcdr) {
2803                 return NULL;
2804         }
2805
2806         *newcdr = *cdr;
2807         AST_LIST_HEAD_INIT_NOLOCK(&newcdr->varshead);
2808         copy_variables(&newcdr->varshead, &cdr->varshead);
2809         newcdr->next = NULL;
2810
2811         return newcdr;
2812 }
2813
2814 static const char *cdr_format_var_internal(struct ast_cdr *cdr, const char *name)
2815 {
2816         struct ast_var_t *variables;
2817
2818         if (ast_strlen_zero(name)) {
2819                 return NULL;
2820         }
2821
2822         AST_LIST_TRAVERSE(&cdr->varshead, variables, entries) {
2823                 if (!strcasecmp(name, ast_var_name(variables))) {
2824                         return ast_var_value(variables);
2825                 }
2826         }
2827
2828         return NULL;
2829 }
2830
2831 static void cdr_get_tv(struct timeval when, const char *fmt, char *buf, int bufsize)
2832 {
2833         if (fmt == NULL) {      /* raw mode */
2834                 snprintf(buf, bufsize, "%ld.%06ld", (long)when.tv_sec, (long)when.tv_usec);
2835         } else {
2836                 buf[0] = '\0';/* Ensure the buffer is initialized. */
2837                 if (when.tv_sec) {
2838                         struct ast_tm tm;
2839
2840                         ast_localtime(&when, &tm, NULL);
2841                         ast_strftime(buf, bufsize, fmt, &tm);
2842                 }
2843         }
2844 }
2845
2846 void ast_cdr_format_var(struct ast_cdr *cdr, const char *name, char **ret, char *workspace, int workspacelen, int raw)
2847 {
2848         const char *fmt = "%Y-%m-%d %T";
2849         const char *varbuf;
2850
2851         if (!cdr) {
2852                 return;
2853         }
2854
2855         *ret = NULL;
2856
2857         if (!strcasecmp(name, "clid")) {
2858                 ast_copy_string(workspace, cdr->clid, workspacelen);
2859         } else if (!strcasecmp(name, "src")) {
2860                 ast_copy_string(workspace, cdr->src, workspacelen);
2861         } else if (!strcasecmp(name, "dst")) {
2862                 ast_copy_string(workspace, cdr->dst, workspacelen);
2863         } else if (!strcasecmp(name, "dcontext")) {
2864                 ast_copy_string(workspace, cdr->dcontext, workspacelen);
2865         } else if (!strcasecmp(name, "channel")) {
2866                 ast_copy_string(workspace, cdr->channel, workspacelen);
2867         } else if (!strcasecmp(name, "dstchannel")) {
2868                 ast_copy_string(workspace, cdr->dstchannel, workspacelen);
2869         } else if (!strcasecmp(name, "lastapp")) {
2870                 ast_copy_string(workspace, cdr->lastapp, workspacelen);
2871         } else if (!strcasecmp(name, "lastdata")) {
2872                 ast_copy_string(workspace, cdr->lastdata, workspacelen);
2873         } else if (!strcasecmp(name, "start")) {
2874                 cdr_get_tv(cdr->start, raw ? NULL : fmt, workspace, workspacelen);
2875         } else if (!strcasecmp(name, "answer")) {
2876                 cdr_get_tv(cdr->answer, raw ? NULL : fmt, workspace, workspacelen);
2877         } else if (!strcasecmp(name, "end")) {
2878                 cdr_get_tv(cdr->end, raw ? NULL : fmt, workspace, workspacelen);
2879         } else if (!strcasecmp(name, "duration")) {
2880                 snprintf(workspace, workspacelen, "%ld", cdr->end.tv_sec != 0 ? cdr->duration : (long)ast_tvdiff_ms(ast_tvnow(), cdr->start) / 1000);
2881         } else if (!strcasecmp(name, "billsec")) {
2882                 snprintf(workspace, workspacelen, "%ld", (cdr->billsec || !ast_tvzero(cdr->end) || ast_tvzero(cdr->answer)) ? cdr->billsec : (long)ast_tvdiff_ms(ast_tvnow(), cdr->answer) / 1000);
2883         } else if (!strcasecmp(name, "disposition")) {
2884                 if (raw) {
2885                         snprintf(workspace, workspacelen, "%ld", cdr->disposition);
2886                 } else {
2887                         ast_copy_string(workspace, ast_cdr_disp2str(cdr->disposition), workspacelen);
2888                 }
2889         } else if (!strcasecmp(name, "amaflags")) {
2890                 if (raw) {
2891                         snprintf(workspace, workspacelen, "%ld", cdr->amaflags);
2892                 } else {
2893                         ast_copy_string(workspace, ast_channel_amaflags2string(cdr->amaflags), workspacelen);
2894                 }
2895         } else if (!strcasecmp(name, "accountcode")) {
2896                 ast_copy_string(workspace, cdr->accountcode, workspacelen);
2897         } else if (!strcasecmp(name, "peeraccount")) {
2898                 ast_copy_string(workspace, cdr->peeraccount, workspacelen);
2899         } else if (!strcasecmp(name, "uniqueid")) {
2900                 ast_copy_string(workspace, cdr->uniqueid, workspacelen);
2901         } else if (!strcasecmp(name, "linkedid")) {
2902                 ast_copy_string(workspace, cdr->linkedid, workspacelen);
2903         } else if (!strcasecmp(name, "userfield")) {
2904                 ast_copy_string(workspace, cdr->userfield, workspacelen);
2905         } else if (!strcasecmp(name, "sequence")) {
2906                 snprintf(workspace, workspacelen, "%d", cdr->sequence);
2907         } else if ((varbuf = cdr_format_var_internal(cdr, name))) {
2908                 ast_copy_string(workspace, varbuf, workspacelen);
2909         } else {
2910                 workspace[0] = '\0';
2911         }
2912
2913         if (!ast_strlen_zero(workspace)) {
2914                 *ret = workspace;
2915         }
2916 }
2917
2918 /*!
2919  * \internal
2920  * \brief Callback that finds all CDRs that reference a particular channel by name
2921  */
2922 static int cdr_object_select_all_by_name_cb(void *obj, void *arg, int flags)
2923 {
2924         struct cdr_object *cdr = obj;
2925         const char *name = arg;
2926
2927         if (!strcasecmp(cdr->party_a.snapshot->name, name) ||
2928                         (cdr->party_b.snapshot && !strcasecmp(cdr->party_b.snapshot->name, name))) {
2929                 return CMP_MATCH;
2930         }
2931         return 0;
2932 }
2933
2934 /*!
2935  * \internal
2936  * \brief Callback that finds a CDR by channel name
2937  */
2938 static int cdr_object_get_by_name_cb(void *obj, void *arg, int flags)
2939 {
2940         struct cdr_object *cdr = obj;
2941         const char *name = arg;
2942
2943         if (!strcasecmp(cdr->party_a.snapshot->name, name)) {
2944                 return CMP_MATCH;
2945         }
2946         return 0;
2947 }
2948
2949 /* Read Only CDR variables */
2950 static const char * const cdr_readonly_vars[] = {
2951         "clid",
2952         "src",
2953         "dst",
2954         "dcontext",
2955         "channel",
2956         "dstchannel",
2957         "lastapp",
2958         "lastdata",
2959         "start",
2960         "answer",
2961         "end",
2962         "duration",
2963         "billsec",
2964         "disposition",
2965         "amaflags",
2966         "accountcode",
2967         "uniqueid",
2968         "linkedid",
2969         "userfield",
2970         "sequence",
2971         NULL
2972 };
2973
2974 int ast_cdr_setvar(const char *channel_name, const char *name, const char *value)
2975 {
2976         struct cdr_object *cdr;
2977         struct cdr_object *it_cdr;
2978         struct ao2_iterator *it_cdrs;
2979         char *arg = ast_strdupa(channel_name);
2980         int x;
2981
2982         for (x = 0; cdr_readonly_vars[x]; x++) {
2983                 if (!strcasecmp(name, cdr_readonly_vars[x])) {
2984                         ast_log(LOG_ERROR, "Attempt to set the '%s' read-only variable!\n", name);
2985                         return -1;
2986                 }
2987         }
2988
2989         it_cdrs = ao2_callback(active_cdrs_by_channel, OBJ_MULTIPLE, cdr_object_select_all_by_name_cb, arg);
2990         if (!it_cdrs) {
2991                 ast_log(AST_LOG_ERROR, "Unable to find CDR for channel %s\n", channel_name);
2992                 return -1;
2993         }
2994
2995         for (; (cdr = ao2_iterator_next(it_cdrs)); ao2_unlock(cdr), ao2_cleanup(cdr)) {
2996                 ao2_lock(cdr);
2997                 for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
2998                         struct varshead *headp = NULL;
2999
3000                         if (it_cdr->fn_table == &finalized_state_fn_table && it_cdr->next != NULL) {
3001                                 continue;
3002                         }
3003                         if (!strcasecmp(channel_name, it_cdr->party_a.snapshot->name)) {
3004                                 headp = &it_cdr->party_a.variables;
3005                         } else if (it_cdr->party_b.snapshot
3006                                 && !strcasecmp(channel_name, it_cdr->party_b.snapshot->name)) {
3007                                 headp = &it_cdr->party_b.variables;
3008                         }
3009                         if (headp) {
3010                                 set_variable(headp, name, value);
3011                         }
3012                 }
3013         }
3014         ao2_iterator_destroy(it_cdrs);
3015
3016         return 0;
3017 }
3018
3019 /*!
3020  * \brief Format a variable on a \ref cdr_object
3021  */
3022 static void cdr_object_format_var_internal(struct cdr_object *cdr, const char *name, char *value, size_t length)
3023 {
3024         struct ast_var_t *variable;
3025
3026         AST_LIST_TRAVERSE(&cdr->party_a.variables, variable, entries) {
3027                 if (!strcasecmp(name, ast_var_name(variable))) {
3028                         ast_copy_string(value, ast_var_value(variable), length);
3029                         return;
3030                 }
3031         }
3032
3033         *value = '\0';
3034 }
3035
3036 /*!
3037  * \brief Format one of the standard properties on a \ref cdr_object
3038  */
3039 static int cdr_object_format_property(struct cdr_object *cdr_obj, const char *name, char *value, size_t length)
3040 {
3041         struct ast_channel_snapshot *party_a = cdr_obj->party_a.snapshot;
3042         struct ast_channel_snapshot *party_b = cdr_obj->party_b.snapshot;
3043
3044         if (!strcasecmp(name, "clid")) {
3045                 ast_callerid_merge(value, length, party_a->caller_name, party_a->caller_number, "");
3046         } else if (!strcasecmp(name, "src")) {
3047                 ast_copy_string(value, party_a->caller_number, length);
3048         } else if (!strcasecmp(name, "dst")) {
3049                 ast_copy_string(value, party_a->exten, length);
3050         } else if (!strcasecmp(name, "dcontext")) {
3051                 ast_copy_string(value, party_a->context, length);
3052         } else if (!strcasecmp(name, "channel")) {
3053                 ast_copy_string(value, party_a->name, length);
3054         } else if (!strcasecmp(name, "dstchannel")) {
3055                 if (party_b) {
3056                         ast_copy_string(value, party_b->name, length);
3057                 } else {
3058                         ast_copy_string(value, "", length);
3059                 }
3060         } else if (!strcasecmp(name, "lastapp")) {
3061                 ast_copy_string(value, party_a->appl, length);
3062         } else if (!strcasecmp(name, "lastdata")) {
3063                 ast_copy_string(value, party_a->data, length);
3064         } else if (!strcasecmp(name, "start")) {
3065                 cdr_get_tv(cdr_obj->start, NULL, value, length);
3066         } else if (!strcasecmp(name, "answer")) {
3067                 cdr_get_tv(cdr_obj->answer, NULL, value, length);
3068         } else if (!strcasecmp(name, "end")) {
3069                 cdr_get_tv(cdr_obj->end, NULL, value, length);
3070         } else if (!strcasecmp(name, "duration")) {
3071                 snprintf(value, length, "%ld", cdr_object_get_duration(cdr_obj));
3072         } else if (!strcasecmp(name, "billsec")) {
3073                 snprintf(value, length, "%ld", cdr_object_get_billsec(cdr_obj));
3074         } else if (!strcasecmp(name, "disposition")) {
3075                 snprintf(value, length, "%u", cdr_obj->disposition);
3076         } else if (!strcasecmp(name, "amaflags")) {
3077                 snprintf(value, length, "%d", party_a->amaflags);
3078         } else if (!strcasecmp(name, "accountcode")) {
3079                 ast_copy_string(value, party_a->accountcode, length);
3080         } else if (!strcasecmp(name, "peeraccount")) {
3081                 if (party_b) {
3082                         ast_copy_string(value, party_b->accountcode, length);
3083                 } else {
3084                         ast_copy_string(value, "", length);
3085                 }
3086         } else if (!strcasecmp(name, "uniqueid")) {
3087                 ast_copy_string(value, party_a->uniqueid, length);
3088         } else if (!strcasecmp(name, "linkedid")) {
3089                 ast_copy_string(value, cdr_obj->linkedid, length);
3090         } else if (!strcasecmp(name, "userfield")) {
3091                 ast_copy_string(value, cdr_obj->party_a.userfield, length);
3092         } else if (!strcasecmp(name, "sequence")) {
3093                 snprintf(value, length, "%u", cdr_obj->sequence);
3094         } else {
3095                 return 1;
3096         }
3097
3098         return 0;
3099 }
3100
3101 /*! \internal
3102  * \brief Look up and retrieve a CDR object by channel name
3103  * \param name The name of the channel
3104  * \retval NULL on error
3105  * \retval The \ref cdr_object for the channel on success, with the reference
3106  *      count bumped by one.
3107  */
3108 static struct cdr_object *cdr_object_get_by_name(const char *name)
3109 {
3110         char *param;
3111
3112         if (ast_strlen_zero(name)) {
3113                 return NULL;
3114         }
3115
3116         param = ast_strdupa(name);
3117         return ao2_callback(active_cdrs_by_channel, 0, cdr_object_get_by_name_cb, param);
3118 }
3119
3120 int ast_cdr_getvar(const char *channel_name, const char *name, char *value, size_t length)
3121 {
3122         RAII_VAR(struct cdr_object *, cdr, cdr_object_get_by_name(channel_name), ao2_cleanup);
3123         struct cdr_object *cdr_obj;
3124
3125         if (!cdr) {
3126                 ast_log(AST_LOG_ERROR, "Unable to find CDR for channel %s\n", channel_name);
3127                 return 1;
3128         }
3129
3130         if (ast_strlen_zero(name)) {
3131                 return 1;
3132         }
3133
3134         ao2_lock(cdr);
3135
3136         cdr_obj = cdr->last;
3137         if (cdr_object_format_property(cdr_obj, name, value, length)) {
3138                 /* Property failed; attempt variable */
3139                 cdr_object_format_var_internal(cdr_obj, name, value, length);
3140         }
3141
3142         ao2_unlock(cdr);
3143
3144         return 0;
3145 }
3146
3147 int ast_cdr_serialize_variables(const char *channel_name, struct ast_str **buf, char delim, char sep)
3148 {
3149         RAII_VAR(struct cdr_object *, cdr, cdr_object_get_by_name(channel_name), ao2_cleanup);
3150         struct cdr_object *it_cdr;
3151         struct ast_var_t *variable;
3152         const char *var;
3153         char workspace[256];
3154         int total = 0, x = 0, i;
3155
3156         if (!cdr) {
3157                 RAII_VAR(struct module_config *, mod_cfg,
3158                          ao2_global_obj_ref(module_configs), ao2_cleanup);
3159
3160                 if (ast_test_flag(&mod_cfg->general->settings, CDR_ENABLED)) {
3161                         ast_log(AST_LOG_ERROR, "Unable to find CDR for channel %s\n", channel_name);
3162                 }
3163
3164                 return 0;
3165         }
3166
3167         ast_str_reset(*buf);
3168
3169         ao2_lock(cdr);
3170         for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
3171                 if (++x > 1) {
3172                         ast_str_append(buf, 0, "\n");
3173                 }
3174
3175                 AST_LIST_TRAVERSE(&it_cdr->party_a.variables, variable, entries) {
3176                         if (!(var = ast_var_name(variable))) {
3177                                 continue;
3178                         }
3179
3180                         if (ast_str_append(buf, 0, "level %d: %s%c%s%c", x, var, delim, S_OR(ast_var_value(variable), ""), sep) < 0) {
3181                                 ast_log(LOG_ERROR, "Data Buffer Size Exceeded!\n");
3182                                 break;
3183                         }
3184
3185                         total++;
3186                 }
3187
3188                 for (i = 0; cdr_readonly_vars[i]; i++) {
3189                         if (cdr_object_format_property(it_cdr, cdr_readonly_vars[i], workspace, sizeof(workspace))) {
3190                                 /* Unhandled read-only CDR variable. */
3191                                 ast_assert(0);
3192                                 continue;
3193                         }
3194
3195                         if (!ast_strlen_zero(workspace)
3196                                 && ast_str_append(buf, 0, "level %d: %s%c%s%c", x, cdr_readonly_vars[i], delim, workspace, sep) < 0) {
3197                                 ast_log(LOG_ERROR, "Data Buffer Size Exceeded!\n");
3198                                 break;
3199                         }
3200                         total++;
3201                 }
3202         }
3203         ao2_unlock(cdr);
3204         return total;
3205 }
3206
3207 void ast_cdr_free(struct ast_cdr *cdr)
3208 {
3209         while (cdr) {
3210                 struct ast_cdr *next = cdr->next;
3211
3212                 free_variables(&cdr->varshead);
3213                 ast_free(cdr);
3214                 cdr = next;
3215         }
3216 }
3217
3218 struct ast_cdr *ast_cdr_alloc(void)
3219 {
3220         struct ast_cdr *x;
3221
3222         x = ast_calloc(1, sizeof(*x));
3223         return x;
3224 }
3225
3226 const char *ast_cdr_disp2str(int disposition)
3227 {
3228         switch (disposition) {
3229         case AST_CDR_NULL:
3230                 return "NO ANSWER"; /* by default, for backward compatibility */
3231         case AST_CDR_NOANSWER:
3232                 return "NO ANSWER";
3233         case AST_CDR_FAILED:
3234                 return "FAILED";
3235         case AST_CDR_BUSY:
3236                 return "BUSY";
3237         case AST_CDR_ANSWERED:
3238                 return "ANSWERED";
3239         case AST_CDR_CONGESTION:
3240                 return "CONGESTION";
3241         }
3242         return "UNKNOWN";
3243 }
3244
3245 struct party_b_userfield_update {
3246         const char *channel_name;
3247         const char *userfield;
3248 };
3249
3250 /*! \brief Callback used to update the userfield on Party B on all CDRs */
3251 static int cdr_object_update_party_b_userfield_cb(void *obj, void *arg, int flags)
3252 {
3253         struct cdr_object *cdr = obj;
3254         struct party_b_userfield_update *info = arg;
3255         struct cdr_object *it_cdr;
3256
3257         for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
3258                 if (it_cdr->fn_table == &finalized_state_fn_table && it_cdr->next != NULL) {
3259                         continue;
3260                 }
3261                 if (it_cdr->party_b.snapshot
3262                         && !strcasecmp(it_cdr->party_b.snapshot->name, info->channel_name)) {
3263                         strcpy(it_cdr->party_b.userfield, info->userfield);
3264                 }
3265         }
3266         return 0;
3267 }
3268
3269 void ast_cdr_setuserfield(const char *channel_name, const char *userfield)
3270 {
3271         RAII_VAR(struct cdr_object *, cdr, cdr_object_get_by_name(channel_name), ao2_cleanup);
3272         struct party_b_userfield_update party_b_info = {
3273                         .channel_name = channel_name,
3274                         .userfield = userfield,
3275         };
3276         struct cdr_object *it_cdr;
3277
3278         /* Handle Party A */
3279         if (cdr) {
3280                 ao2_lock(cdr);
3281                 for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
3282                         if (it_cdr->fn_table == &finalized_state_fn_table && it_cdr->next != NULL) {
3283                                 continue;
3284                         }