Asterisk - The Open Source Telephony Project  GIT-master-a24979a
Data Structures | Typedefs | Enumerations | Functions
cdr.h File Reference

Call Detail Record API. More...

#include "asterisk/channel.h"
Include dependency graph for cdr.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ast_cdr
 Responsible for call detail data. More...
 
struct  ast_cdr_config
 The global options available for CDRs. More...
 
struct  ast_cdr_config::batch_settings
 

Typedefs

typedef int(* ast_cdrbe) (struct ast_cdr *cdr)
 CDR backend callback. More...
 

Enumerations

enum  ast_cdr_batch_mode_settings { BATCH_MODE_SCHEDULER_ONLY = 1 << 0 , BATCH_MODE_SAFE_SHUTDOWN = 1 << 1 }
 CDR Batch Mode settings. More...
 
enum  ast_cdr_disposition {
  AST_CDR_NOANSWER = 0 , AST_CDR_NULL = (1 << 0) , AST_CDR_FAILED = (1 << 1) , AST_CDR_BUSY = (1 << 2) ,
  AST_CDR_ANSWERED = (1 << 3) , AST_CDR_CONGESTION = (1 << 4)
}
 CDR Flags - Disposition. More...
 
enum  ast_cdr_options {
  AST_CDR_FLAG_KEEP_VARS = (1 << 0) , AST_CDR_FLAG_DISABLE = (1 << 1) , AST_CDR_FLAG_DISABLE_ALL = (3 << 1) , AST_CDR_FLAG_PARTY_A = (1 << 3) ,
  AST_CDR_FLAG_FINALIZE = (1 << 4) , AST_CDR_FLAG_SET_ANSWER = (1 << 5) , AST_CDR_FLAG_RESET = (1 << 6) , AST_CDR_LOCK_APP = (1 << 7)
}
 CDR manipulation options. Certain function calls will manipulate the state of a CDR object based on these flags. More...
 
enum  ast_cdr_settings {
  CDR_ENABLED = 1 << 0 , CDR_BATCHMODE = 1 << 1 , CDR_UNANSWERED = 1 << 2 , CDR_CONGESTION = 1 << 3 ,
  CDR_END_BEFORE_H_EXTEN = 1 << 4 , CDR_INITIATED_SECONDS = 1 << 5 , CDR_DEBUG = 1 << 6 , CDR_CHANNEL_DEFAULT_ENABLED = 1 << 7
}
 CDR engine settings. More...
 

Functions

struct ast_cdrast_cdr_alloc (void)
 Allocate a CDR record. More...
 
int ast_cdr_backend_suspend (const char *name)
 Suspend a CDR backend temporarily. More...
 
int ast_cdr_backend_unsuspend (const char *name)
 Unsuspend a CDR backend. More...
 
int ast_cdr_clear_property (const char *channel_name, enum ast_cdr_options option)
 Clear a property on a CDR for a channel. More...
 
const char * ast_cdr_disp2str (int disposition)
 Disposition to a string. More...
 
struct ast_cdrast_cdr_dup (struct ast_cdr *cdr)
 Duplicate a public CDR. More...
 
void ast_cdr_engine_term (void)
 
int ast_cdr_fork (const char *channel_name, struct ast_flags *options)
 Fork a CDR. More...
 
void ast_cdr_format_var (struct ast_cdr *cdr, const char *name, char **ret, char *workspace, int workspacelen, int raw)
 Format a CDR variable from an already posted CDR. More...
 
void ast_cdr_free (struct ast_cdr *cdr)
 Free a CDR record. More...
 
struct ast_cdr_configast_cdr_get_config (void)
 Obtain the current CDR configuration. More...
 
int ast_cdr_getvar (const char *channel_name, const char *name, char *value, size_t length)
 Retrieve a CDR variable from a channel's current CDR. More...
 
int ast_cdr_is_enabled (void)
 Return TRUE if CDR subsystem is enabled. More...
 
struct stasis_message_routerast_cdr_message_router (void)
 Return the message router for the CDR engine. More...
 
int ast_cdr_modifier_register (const char *name, const char *desc, ast_cdrbe be)
 Register a CDR modifier. More...
 
int ast_cdr_modifier_unregister (const char *name)
 Unregister a CDR modifier. More...
 
int ast_cdr_register (const char *name, const char *desc, ast_cdrbe be)
 Register a CDR handling engine. More...
 
int ast_cdr_reset (const char *channel_name, int keep_variables)
 Reset the detail record. More...
 
int ast_cdr_serialize_variables (const char *channel_name, struct ast_str **buf, char delim, char sep)
 Serializes all the data and variables for a current CDR record. More...
 
void ast_cdr_set_config (struct ast_cdr_config *config)
 Set the current CDR configuration. More...
 
int ast_cdr_set_property (const char *channel_name, enum ast_cdr_options option)
 Set a property on a CDR for a channel. More...
 
void ast_cdr_setuserfield (const char *channel_name, const char *userfield)
 Set CDR user field for channel (stored in CDR) More...
 
int ast_cdr_setvar (const char *channel_name, const char *name, const char *value)
 Set a variable on a CDR. More...
 
int ast_cdr_unregister (const char *name)
 Unregister a CDR handling engine. More...
 

Detailed Description

Call Detail Record API.

Call Detail Record Engine.

Author
Mark Spencer marks.nosp@m.ter@.nosp@m.digiu.nosp@m.m.co.nosp@m.m
Since
12

Definition in file cdr.h.

Typedef Documentation

◆ ast_cdrbe

typedef int(* ast_cdrbe) (struct ast_cdr *cdr)

CDR backend callback.

Warning
CDR backends should NOT attempt to access the channel associated with a CDR record. This channel is not guaranteed to exist when the CDR backend is invoked.

Definition at line 459 of file cdr.h.

Enumeration Type Documentation

◆ ast_cdr_batch_mode_settings

CDR Batch Mode settings.

Enumerator
BATCH_MODE_SCHEDULER_ONLY 

Don't spawn a thread to handle the batches - do it on the scheduler

BATCH_MODE_SAFE_SHUTDOWN 

During safe shutdown, submit the batched CDRs

Definition at line 231 of file cdr.h.

231  {
232  BATCH_MODE_SCHEDULER_ONLY = 1 << 0, /*!< Don't spawn a thread to handle the batches - do it on the scheduler */
233  BATCH_MODE_SAFE_SHUTDOWN = 1 << 1, /*!< During safe shutdown, submit the batched CDRs */
234 };
@ BATCH_MODE_SAFE_SHUTDOWN
Definition: cdr.h:233
@ BATCH_MODE_SCHEDULER_ONLY
Definition: cdr.h:232

◆ ast_cdr_disposition

CDR Flags - Disposition.

Enumerator
AST_CDR_NOANSWER 
AST_CDR_NULL 
AST_CDR_FAILED 
AST_CDR_BUSY 
AST_CDR_ANSWERED 
AST_CDR_CONGESTION 

Definition at line 254 of file cdr.h.

254  {
255  AST_CDR_NOANSWER = 0,
256  AST_CDR_NULL = (1 << 0),
257  AST_CDR_FAILED = (1 << 1),
258  AST_CDR_BUSY = (1 << 2),
259  AST_CDR_ANSWERED = (1 << 3),
260  AST_CDR_CONGESTION = (1 << 4),
261 };
@ AST_CDR_CONGESTION
Definition: cdr.h:260
@ AST_CDR_NULL
Definition: cdr.h:256
@ AST_CDR_NOANSWER
Definition: cdr.h:255
@ AST_CDR_ANSWERED
Definition: cdr.h:259
@ AST_CDR_BUSY
Definition: cdr.h:258
@ AST_CDR_FAILED
Definition: cdr.h:257

◆ ast_cdr_options

CDR manipulation options. Certain function calls will manipulate the state of a CDR object based on these flags.

Enumerator
AST_CDR_FLAG_KEEP_VARS 

Copy variables during the operation

AST_CDR_FLAG_DISABLE 

Disable the current CDR

AST_CDR_FLAG_DISABLE_ALL 

Disable the CDR and all future CDRs

AST_CDR_FLAG_PARTY_A 

Set the channel as party A

AST_CDR_FLAG_FINALIZE 

Finalize the current CDRs

AST_CDR_FLAG_SET_ANSWER 

If the channel is answered, set the answer time to now

AST_CDR_FLAG_RESET 

If set, set the start and answer time to now

AST_CDR_LOCK_APP 

Prevent any further changes to the application field/data field for this CDR

Definition at line 240 of file cdr.h.

240  {
241  AST_CDR_FLAG_KEEP_VARS = (1 << 0), /*!< Copy variables during the operation */
242  AST_CDR_FLAG_DISABLE = (1 << 1), /*!< Disable the current CDR */
243  AST_CDR_FLAG_DISABLE_ALL = (3 << 1), /*!< Disable the CDR and all future CDRs */
244  AST_CDR_FLAG_PARTY_A = (1 << 3), /*!< Set the channel as party A */
245  AST_CDR_FLAG_FINALIZE = (1 << 4), /*!< Finalize the current CDRs */
246  AST_CDR_FLAG_SET_ANSWER = (1 << 5), /*!< If the channel is answered, set the answer time to now */
247  AST_CDR_FLAG_RESET = (1 << 6), /*!< If set, set the start and answer time to now */
248  AST_CDR_LOCK_APP = (1 << 7), /*!< Prevent any further changes to the application field/data field for this CDR */
249 };
@ AST_CDR_FLAG_DISABLE_ALL
Definition: cdr.h:243
@ AST_CDR_LOCK_APP
Definition: cdr.h:248
@ AST_CDR_FLAG_FINALIZE
Definition: cdr.h:245
@ AST_CDR_FLAG_DISABLE
Definition: cdr.h:242
@ AST_CDR_FLAG_PARTY_A
Definition: cdr.h:244
@ AST_CDR_FLAG_KEEP_VARS
Definition: cdr.h:241
@ AST_CDR_FLAG_RESET
Definition: cdr.h:247
@ AST_CDR_FLAG_SET_ANSWER
Definition: cdr.h:246

◆ ast_cdr_settings

CDR engine settings.

Enumerator
CDR_ENABLED 

Enable CDRs

CDR_BATCHMODE 

Whether or not we should dispatch CDRs in batches

CDR_UNANSWERED 

Log unanswered CDRs

CDR_CONGESTION 

Treat congestion as if it were a failed call

CDR_END_BEFORE_H_EXTEN 

End the CDR before the 'h' extension runs

CDR_INITIATED_SECONDS 

Include microseconds into the billing time

CDR_DEBUG 

Enables extra debug statements

CDR_CHANNEL_DEFAULT_ENABLED 

Whether CDR is enabled for each channel by default

Definition at line 219 of file cdr.h.

219  {
220  CDR_ENABLED = 1 << 0, /*!< Enable CDRs */
221  CDR_BATCHMODE = 1 << 1, /*!< Whether or not we should dispatch CDRs in batches */
222  CDR_UNANSWERED = 1 << 2, /*!< Log unanswered CDRs */
223  CDR_CONGESTION = 1 << 3, /*!< Treat congestion as if it were a failed call */
224  CDR_END_BEFORE_H_EXTEN = 1 << 4, /*!< End the CDR before the 'h' extension runs */
225  CDR_INITIATED_SECONDS = 1 << 5, /*!< Include microseconds into the billing time */
226  CDR_DEBUG = 1 << 6, /*!< Enables extra debug statements */
227  CDR_CHANNEL_DEFAULT_ENABLED = 1 << 7, /*!< Whether CDR is enabled for each channel by default */
228 };
@ CDR_UNANSWERED
Definition: cdr.h:222
@ CDR_INITIATED_SECONDS
Definition: cdr.h:225
@ CDR_ENABLED
Definition: cdr.h:220
@ CDR_CHANNEL_DEFAULT_ENABLED
Definition: cdr.h:227
@ CDR_END_BEFORE_H_EXTEN
Definition: cdr.h:224
@ CDR_BATCHMODE
Definition: cdr.h:221
@ CDR_CONGESTION
Definition: cdr.h:223
@ CDR_DEBUG
Definition: cdr.h:226

Function Documentation

◆ ast_cdr_alloc()

struct ast_cdr* ast_cdr_alloc ( void  )

Allocate a CDR record.

Returns
a malloc'd ast_cdr structure
Return values
NULLon error (malloc failure)

Definition at line 3444 of file cdr.c.

3445 {
3446  struct ast_cdr *x;
3447 
3448  x = ast_calloc(1, sizeof(*x));
3449  return x;
3450 }
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
Responsible for call detail data.
Definition: cdr.h:277

References ast_calloc.

Referenced by ast_cdr_dup().

◆ ast_cdr_backend_suspend()

int ast_cdr_backend_suspend ( const char *  name)

Suspend a CDR backend temporarily.

Return values
0The backend is suspended
-1The backend could not be suspended

Definition at line 2888 of file cdr.c.

2889 {
2890  int success = -1;
2891  struct cdr_beitem *i = NULL;
2892 
2894  AST_RWLIST_TRAVERSE(&be_list, i, list) {
2895  if (!strcasecmp(name, i->name)) {
2896  ast_debug(3, "Suspending CDR backend %s\n", i->name);
2897  i->suspended = 1;
2898  success = 0;
2899  }
2900  }
2902 
2903  return success;
2904 }
static const char name[]
Definition: format_mp3.c:68
#define ast_debug(level,...)
Log a DEBUG message.
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:52
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:151
#define AST_RWLIST_TRAVERSE
Definition: linkedlists.h:494
#define NULL
Definition: resample.c:96
List of registered backends.
Definition: cdr.c:346
Registration object for CDR backends.
Definition: cdr.c:337
char name[20]
Definition: cdr.c:338

References ast_debug, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, cdr_beitem::name, name, and NULL.

Referenced by load_config(), and odbc_load_module().

◆ ast_cdr_backend_unsuspend()

int ast_cdr_backend_unsuspend ( const char *  name)

Unsuspend a CDR backend.

Return values
0The backend was unsuspended
-1The back could not be unsuspended

Definition at line 2906 of file cdr.c.

2907 {
2908  int success = -1;
2909  struct cdr_beitem *i = NULL;
2910 
2912  AST_RWLIST_TRAVERSE(&be_list, i, list) {
2913  if (!strcasecmp(name, i->name)) {
2914  ast_debug(3, "Unsuspending CDR backend %s\n", i->name);
2915  i->suspended = 0;
2916  success = 0;
2917  }
2918  }
2920 
2921  return success;
2922 }

References ast_debug, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, cdr_beitem::name, name, and NULL.

Referenced by load_config(), and odbc_load_module().

◆ ast_cdr_clear_property()

int ast_cdr_clear_property ( const char *  channel_name,
enum ast_cdr_options  option 
)

Clear a property on a CDR for a channel.

Since
12

Clears a flag previously set by ast_cdr_set_property

Parameters
channel_nameThe CDR's channel
optionOption to clear from the CDR
Return values
0on success
1on error

Definition at line 3597 of file cdr.c.

3598 {
3599  struct cdr_object *cdr;
3600  struct cdr_object *it_cdr;
3601 
3602  cdr = cdr_object_get_by_name(channel_name);
3603  if (!cdr) {
3604  return -1;
3605  }
3606 
3607  ao2_lock(cdr);
3608  for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
3609  if (it_cdr->fn_table == &finalized_state_fn_table) {
3610  continue;
3611  }
3612  ast_clear_flag(&it_cdr->flags, option);
3613  }
3614  ao2_unlock(cdr);
3615 
3616  ao2_cleanup(cdr);
3617  return 0;
3618 }
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
#define ao2_unlock(a)
Definition: astobj2.h:729
#define ao2_lock(a)
Definition: astobj2.h:717
struct cdr_object_fn_table finalized_state_fn_table
The virtual table for the finalized state.
Definition: cdr.c:710
static struct cdr_object * cdr_object_get_by_name(const char *name)
Definition: cdr.c:3334
An in-memory representation of an active CDR.
Definition: cdr.c:728
struct cdr_object_fn_table * fn_table
Definition: cdr.c:731
struct cdr_object * next
Definition: cdr.c:751
struct ast_flags flags
Definition: cdr.c:739
#define ast_clear_flag(p, flag)
Definition: utils.h:77

References ao2_cleanup, ao2_lock, ao2_unlock, ast_clear_flag, cdr_object_get_by_name(), finalized_state_fn_table, cdr_object::flags, cdr_object::fn_table, and cdr_object::next.

Referenced by appcdr_callback(), AST_TEST_DEFINE(), and cdr_prop_write_callback().

◆ ast_cdr_disp2str()

const char* ast_cdr_disp2str ( int  disposition)

Disposition to a string.

Parameters
dispositioninput binary form Converts the binary form of a disposition to string form.
Returns
a pointer to the string form

Definition at line 3452 of file cdr.c.

3453 {
3454  switch (disposition) {
3455  case AST_CDR_NULL:
3456  return "NO ANSWER"; /* by default, for backward compatibility */
3457  case AST_CDR_NOANSWER:
3458  return "NO ANSWER";
3459  case AST_CDR_FAILED:
3460  return "FAILED";
3461  case AST_CDR_BUSY:
3462  return "BUSY";
3463  case AST_CDR_ANSWERED:
3464  return "ANSWERED";
3465  case AST_CDR_CONGESTION:
3466  return "CONGESTION";
3467  }
3468  return "UNKNOWN";
3469 }

References AST_CDR_ANSWERED, AST_CDR_BUSY, AST_CDR_CONGESTION, AST_CDR_FAILED, AST_CDR_NOANSWER, AST_CDR_NULL, and ast_cdr::disposition.

Referenced by ast_cdr_format_var(), beanstalk_put(), build_csv_record(), build_radius_record(), cdr_object_finalize(), cdr_read_callback(), execute_cb(), manager_log(), and tds_log().

◆ ast_cdr_dup()

struct ast_cdr* ast_cdr_dup ( struct ast_cdr cdr)

Duplicate a public CDR.

Parameters
cdrthe record to duplicate
Returns
a malloc'd ast_cdr structure,
Return values
NULLon error (malloc failure)

Definition at line 3020 of file cdr.c.

3021 {
3022  struct ast_cdr *newcdr;
3023 
3024  if (!cdr) {
3025  return NULL;
3026  }
3027  newcdr = ast_cdr_alloc();
3028  if (!newcdr) {
3029  return NULL;
3030  }
3031 
3032  *newcdr = *cdr;
3034  copy_variables(&newcdr->varshead, &cdr->varshead);
3035  newcdr->next = NULL;
3036 
3037  return newcdr;
3038 }
struct ast_cdr * ast_cdr_alloc(void)
Allocate a CDR record.
Definition: cdr.c:3444
static int copy_variables(struct varshead *to_list, struct varshead *from_list)
Copy variables from one list to another.
Definition: cdr.c:762
#define AST_LIST_HEAD_INIT_NOLOCK(head)
Initializes a list head structure.
Definition: linkedlists.h:681
struct ast_cdr * next
Definition: cdr.h:326
struct varshead varshead
Definition: cdr.h:324

References ast_cdr_alloc(), AST_LIST_HEAD_INIT_NOLOCK, copy_variables(), ast_cdr::next, NULL, and ast_cdr::varshead.

Referenced by custom_log(), manager_log(), and write_cdr().

◆ ast_cdr_engine_term()

void ast_cdr_engine_term ( void  )

Submit any remaining CDRs and prepare for shutdown

Definition at line 4597 of file cdr.c.

4598 {
4599  RAII_VAR(struct module_config *, mod_cfg, ao2_global_obj_ref(module_configs), ao2_cleanup);
4600 
4601  /* Since this is called explicitly during process shutdown, we might not have ever
4602  * been initialized. If so, the config object will be NULL.
4603  */
4604  if (!mod_cfg) {
4605  return;
4606  }
4607 
4608  if (cdr_sync_message_type()) {
4609  void *payload;
4610  struct stasis_message *message;
4611 
4612  if (!stasis_router) {
4613  return;
4614  }
4615 
4616  /* Make sure we have the needed items */
4617  payload = ao2_alloc(sizeof(*payload), NULL);
4618  if (!payload) {
4619  return;
4620  }
4621 
4622  ast_debug(1, "CDR Engine termination request received; waiting on messages...\n");
4623 
4624  message = stasis_message_create(cdr_sync_message_type(), payload);
4625  if (message) {
4627  }
4629  ao2_cleanup(payload);
4630  }
4631 
4632  if (ast_test_flag(&mod_cfg->general->settings, CDR_BATCHMODE)) {
4633  cdr_submit_batch(ast_test_flag(&mod_cfg->general->batch_settings.settings, BATCH_MODE_SAFE_SHUTDOWN));
4634  }
4635 }
#define ao2_global_obj_ref(holder)
Get a reference to the object stored in the global holder.
Definition: astobj2.h:918
#define ao2_alloc(data_size, destructor_fn)
Definition: astobj2.h:409
static struct stasis_message_router * stasis_router
Message router for stasis messages regarding channel state.
Definition: cdr.c:387
static void cdr_submit_batch(int shutdown)
Definition: cdr.c:3788
struct stasis_message * stasis_message_create(struct stasis_message_type *type, void *data)
Create a new message.
void stasis_message_router_publish_sync(struct stasis_message_router *router, struct stasis_message *message)
Publish a message to a message router's subscription synchronously.
The configuration settings for this module.
Definition: cdr.c:238
#define ast_test_flag(p, flag)
Definition: utils.h:63
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:936

References ao2_alloc, ao2_cleanup, ao2_global_obj_ref, ast_debug, ast_test_flag, BATCH_MODE_SAFE_SHUTDOWN, CDR_BATCHMODE, cdr_submit_batch(), NULL, RAII_VAR, stasis_message_create(), stasis_message_router_publish_sync(), and stasis_router.

Referenced by can_safely_quit(), and finalize_batch_mode().

◆ ast_cdr_fork()

int ast_cdr_fork ( const char *  channel_name,
struct ast_flags options 
)

Fork a CDR.

Since
12
Parameters
channel_nameThe name of the channel whose CDR should be forked
optionsOptions to control how the fork occurs.
Return values
0on success
-1on failure

Definition at line 3659 of file cdr.c.

3660 {
3661  RAII_VAR(struct cdr_object *, cdr, cdr_object_get_by_name(channel_name), ao2_cleanup);
3662  struct cdr_object *new_cdr;
3663  struct cdr_object *it_cdr;
3664  struct cdr_object *cdr_obj;
3665 
3666  if (!cdr) {
3667  return -1;
3668  }
3669 
3670  {
3671  SCOPED_AO2LOCK(lock, cdr);
3672  struct timeval now = ast_tvnow();
3673 
3674  cdr_obj = cdr->last;
3675  if (cdr_obj->fn_table == &finalized_state_fn_table) {
3676  /* If the last CDR in the chain is finalized, don't allow a fork -
3677  * things are already dying at this point
3678  */
3679  return -1;
3680  }
3681 
3682  /* Copy over the basic CDR information. The Party A information is
3683  * copied over automatically as part of the append
3684  */
3685  ast_debug(1, "Forking CDR for channel %s\n", cdr->party_a.snapshot->base->name);
3686  new_cdr = cdr_object_create_and_append(cdr, &now);
3687  if (!new_cdr) {
3688  return -1;
3689  }
3690  new_cdr->fn_table = cdr_obj->fn_table;
3691  ast_string_field_set(new_cdr, bridge, cdr->bridge);
3692  ast_string_field_set(new_cdr, appl, cdr->appl);
3693  ast_string_field_set(new_cdr, data, cdr->data);
3694  ast_string_field_set(new_cdr, context, cdr->context);
3695  ast_string_field_set(new_cdr, exten, cdr->exten);
3696  new_cdr->flags = cdr->flags;
3697  /* Explicitly clear the AST_CDR_LOCK_APP flag - we want
3698  * the application to be changed on the new CDR if the
3699  * dialplan demands it
3700  */
3702 
3703  /* If there's a Party B, copy it over as well */
3704  if (cdr_obj->party_b.snapshot) {
3705  new_cdr->party_b.snapshot = cdr_obj->party_b.snapshot;
3706  ao2_ref(new_cdr->party_b.snapshot, +1);
3707  cdr_all_relink(new_cdr);
3708  strcpy(new_cdr->party_b.userfield, cdr_obj->party_b.userfield);
3709  new_cdr->party_b.flags = cdr_obj->party_b.flags;
3711  copy_variables(&new_cdr->party_b.variables, &cdr_obj->party_b.variables);
3712  }
3713  }
3714  new_cdr->start = cdr_obj->start;
3715  new_cdr->answer = cdr_obj->answer;
3716  new_cdr->lastevent = ast_tvnow();
3717 
3718  /* Modify the times based on the flags passed in */
3720  && new_cdr->party_a.snapshot->state == AST_STATE_UP) {
3721  new_cdr->answer = ast_tvnow();
3722  }
3724  new_cdr->answer = ast_tvnow();
3725  new_cdr->start = ast_tvnow();
3726  }
3727 
3728  /* Create and append, by default, copies over the variables */
3730  free_variables(&new_cdr->party_a.variables);
3731  }
3732 
3733  /* Finalize any current CDRs */
3735  for (it_cdr = cdr; it_cdr != new_cdr; it_cdr = it_cdr->next) {
3736  if (it_cdr->fn_table == &finalized_state_fn_table) {
3737  continue;
3738  }
3739  /* Force finalization on the CDR. This will bypass any checks for
3740  * end before 'h' extension.
3741  */
3742  cdr_object_finalize(it_cdr);
3744  }
3745  }
3746  }
3747 
3748  return 0;
3749 }
ast_mutex_t lock
Definition: app_meetme.c:1093
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
static void cdr_object_finalize(struct cdr_object *cdr)
Finalize a CDR.
Definition: cdr.c:1453
static void cdr_all_relink(struct cdr_object *cdr)
Definition: cdr.c:964
static void free_variables(struct varshead *headp)
Delete all variables from a variable list.
Definition: cdr.c:793
static void cdr_object_transition_state(struct cdr_object *cdr, struct cdr_object_fn_table *fn_table)
Transition a cdr_object to a new state.
Definition: cdr.c:838
static struct cdr_object * cdr_object_create_and_append(struct cdr_object *cdr, const struct timeval *event_time)
Create a new cdr_object and append it to an existing chain.
Definition: cdr.c:1090
static char exten[AST_MAX_EXTENSION]
Definition: chan_alsa.c:122
static char context[AST_MAX_CONTEXT]
Definition: chan_alsa.c:120
@ AST_STATE_UP
Definition: channelstate.h:42
#define SCOPED_AO2LOCK(varname, obj)
scoped lock specialization for ao2 mutexes.
Definition: lock.h:602
#define ast_string_field_set(x, field, data)
Set a field to a simple string value.
Definition: stringfields.h:521
enum ast_channel_state state
unsigned int flags
Definition: utils.h:200
char userfield[AST_MAX_USER_FIELD]
Definition: cdr.c:722
struct varshead variables
Definition: cdr.c:724
struct ast_channel_snapshot * snapshot
Definition: cdr.c:721
unsigned int flags
Definition: cdr.c:723
struct timeval answer
Definition: cdr.c:735
struct cdr_object_snapshot party_a
Definition: cdr.c:729
struct timeval lastevent
Definition: cdr.c:737
struct cdr_object * last
Definition: cdr.c:752
struct timeval start
Definition: cdr.c:734
struct cdr_object_snapshot party_b
Definition: cdr.c:730
static struct test_options options
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition: time.h:157

References cdr_object::answer, ao2_cleanup, ao2_ref, cdr_object::appl, AST_CDR_FLAG_FINALIZE, AST_CDR_FLAG_KEEP_VARS, AST_CDR_FLAG_RESET, AST_CDR_FLAG_SET_ANSWER, AST_CDR_LOCK_APP, ast_clear_flag, ast_debug, AST_STATE_UP, ast_string_field_set, ast_test_flag, ast_tvnow(), ast_channel_snapshot::base, cdr_object::bridge, cdr_all_relink(), cdr_object_create_and_append(), cdr_object_finalize(), cdr_object_get_by_name(), cdr_object_transition_state(), context, cdr_object::context, copy_variables(), cdr_object::data, exten, cdr_object::exten, finalized_state_fn_table, cdr_object_snapshot::flags, cdr_object::flags, cdr_object::fn_table, free_variables(), cdr_object::last, cdr_object::lastevent, lock, ast_channel_snapshot_base::name, cdr_object::next, options, cdr_object::party_a, cdr_object::party_b, RAII_VAR, SCOPED_AO2LOCK, cdr_object_snapshot::snapshot, cdr_object::start, ast_channel_snapshot::state, cdr_object_snapshot::userfield, and cdr_object_snapshot::variables.

Referenced by AST_TEST_DEFINE(), and forkcdr_callback().

◆ ast_cdr_format_var()

void ast_cdr_format_var ( struct ast_cdr cdr,
const char *  name,
char **  ret,
char *  workspace,
int  workspacelen,
int  raw 
)

Format a CDR variable from an already posted CDR.

Since
12
Parameters
cdrThe dispatched CDR to process
nameThe name of the variable
retPointer to the formatted buffer
workspaceA pointer to the buffer to use to format the variable
workspacelenThe size of workspace
rawIf non-zero and a date/time is extracted, provide epoch seconds. Otherwise format as a date/time stamp

Definition at line 3072 of file cdr.c.

3073 {
3074  const char *fmt = "%Y-%m-%d %T";
3075  const char *varbuf;
3076 
3077  if (!cdr) {
3078  return;
3079  }
3080 
3081  *ret = NULL;
3082 
3083  if (!strcasecmp(name, "clid")) {
3084  ast_copy_string(workspace, cdr->clid, workspacelen);
3085  } else if (!strcasecmp(name, "src")) {
3086  ast_copy_string(workspace, cdr->src, workspacelen);
3087  } else if (!strcasecmp(name, "dst")) {
3088  ast_copy_string(workspace, cdr->dst, workspacelen);
3089  } else if (!strcasecmp(name, "dcontext")) {
3090  ast_copy_string(workspace, cdr->dcontext, workspacelen);
3091  } else if (!strcasecmp(name, "channel")) {
3092  ast_copy_string(workspace, cdr->channel, workspacelen);
3093  } else if (!strcasecmp(name, "dstchannel")) {
3094  ast_copy_string(workspace, cdr->dstchannel, workspacelen);
3095  } else if (!strcasecmp(name, "lastapp")) {
3096  ast_copy_string(workspace, cdr->lastapp, workspacelen);
3097  } else if (!strcasecmp(name, "lastdata")) {
3098  ast_copy_string(workspace, cdr->lastdata, workspacelen);
3099  } else if (!strcasecmp(name, "start")) {
3100  cdr_get_tv(cdr->start, raw ? NULL : fmt, workspace, workspacelen);
3101  } else if (!strcasecmp(name, "answer")) {
3102  cdr_get_tv(cdr->answer, raw ? NULL : fmt, workspace, workspacelen);
3103  } else if (!strcasecmp(name, "end")) {
3104  cdr_get_tv(cdr->end, raw ? NULL : fmt, workspace, workspacelen);
3105  } else if (!strcasecmp(name, "duration")) {
3106  snprintf(workspace, workspacelen, "%ld", cdr->end.tv_sec != 0 ? cdr->duration : (long)ast_tvdiff_ms(ast_tvnow(), cdr->start) / 1000);
3107  } else if (!strcasecmp(name, "billsec")) {
3108  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);
3109  } else if (!strcasecmp(name, "disposition")) {
3110  if (raw) {
3111  snprintf(workspace, workspacelen, "%ld", cdr->disposition);
3112  } else {
3113  ast_copy_string(workspace, ast_cdr_disp2str(cdr->disposition), workspacelen);
3114  }
3115  } else if (!strcasecmp(name, "amaflags")) {
3116  if (raw) {
3117  snprintf(workspace, workspacelen, "%ld", cdr->amaflags);
3118  } else {
3119  ast_copy_string(workspace, ast_channel_amaflags2string(cdr->amaflags), workspacelen);
3120  }
3121  } else if (!strcasecmp(name, "accountcode")) {
3122  ast_copy_string(workspace, cdr->accountcode, workspacelen);
3123  } else if (!strcasecmp(name, "peeraccount")) {
3124  ast_copy_string(workspace, cdr->peeraccount, workspacelen);
3125  } else if (!strcasecmp(name, "uniqueid")) {
3126  ast_copy_string(workspace, cdr->uniqueid, workspacelen);
3127  } else if (!strcasecmp(name, "linkedid")) {
3128  ast_copy_string(workspace, cdr->linkedid, workspacelen);
3129  } else if (!strcasecmp(name, "userfield")) {
3130  ast_copy_string(workspace, cdr->userfield, workspacelen);
3131  } else if (!strcasecmp(name, "sequence")) {
3132  snprintf(workspace, workspacelen, "%d", cdr->sequence);
3133  } else if ((varbuf = cdr_format_var_internal(cdr, name))) {
3134  ast_copy_string(workspace, varbuf, workspacelen);
3135  } else {
3136  workspace[0] = '\0';
3137  }
3138 
3139  if (!ast_strlen_zero(workspace)) {
3140  *ret = workspace;
3141  }
3142 }
const char * ast_cdr_disp2str(int disposition)
Disposition to a string.
Definition: cdr.c:3452
static void cdr_get_tv(struct timeval when, const char *fmt, char *buf, int bufsize)
Definition: cdr.c:3057
static const char * cdr_format_var_internal(struct ast_cdr *cdr, const char *name)
Definition: cdr.c:3040
const char * ast_channel_amaflags2string(enum ama_flags flags)
Convert the enum representation of an AMA flag to a string representation.
Definition: channel.c:4408
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:406
char dstchannel[AST_MAX_EXTENSION]
Definition: cdr.h:289
long int disposition
Definition: cdr.h:305
char lastdata[AST_MAX_EXTENSION]
Definition: cdr.h:293
char linkedid[AST_MAX_UNIQUEID]
Definition: cdr.h:317
char userfield[AST_MAX_USER_FIELD]
Definition: cdr.h:319
long int billsec
Definition: cdr.h:303
struct timeval answer
Definition: cdr.h:297
char channel[AST_MAX_EXTENSION]
Definition: cdr.h:287
char peeraccount[AST_MAX_ACCOUNT_CODE]
Definition: cdr.h:311
long int duration
Definition: cdr.h:301
long int amaflags
Definition: cdr.h:307
char src[AST_MAX_EXTENSION]
Definition: cdr.h:281
char dst[AST_MAX_EXTENSION]
Definition: cdr.h:283
char clid[AST_MAX_EXTENSION]
Definition: cdr.h:279
char uniqueid[AST_MAX_UNIQUEID]
Definition: cdr.h:315
int sequence
Definition: cdr.h:321
struct timeval start
Definition: cdr.h:295
char accountcode[AST_MAX_ACCOUNT_CODE]
Definition: cdr.h:309
char lastapp[AST_MAX_EXTENSION]
Definition: cdr.h:291
char dcontext[AST_MAX_EXTENSION]
Definition: cdr.h:285
struct timeval end
Definition: cdr.h:299
int ast_tvzero(const struct timeval t)
Returns true if the argument is 0,0.
Definition: time.h:115
int64_t ast_tvdiff_ms(struct timeval end, struct timeval start)
Computes the difference (in milliseconds) between two struct timeval instances.
Definition: time.h:105

References ast_cdr::accountcode, ast_cdr::amaflags, ast_cdr::answer, ast_cdr_disp2str(), ast_channel_amaflags2string(), ast_copy_string(), ast_strlen_zero(), ast_tvdiff_ms(), ast_tvnow(), ast_tvzero(), ast_cdr::billsec, cdr_format_var_internal(), cdr_get_tv(), ast_cdr::channel, ast_cdr::clid, ast_cdr::dcontext, ast_cdr::disposition, ast_cdr::dst, ast_cdr::dstchannel, ast_cdr::duration, ast_cdr::end, ast_cdr::lastapp, ast_cdr::lastdata, ast_cdr::linkedid, name, NULL, ast_cdr::peeraccount, ast_cdr::sequence, ast_cdr::src, ast_cdr::start, ast_cdr::uniqueid, and ast_cdr::userfield.

Referenced by cdr_read_callback(), odbc_log(), and pgsql_log().

◆ ast_cdr_free()

void ast_cdr_free ( struct ast_cdr cdr)

Free a CDR record.

Parameters
cdrast_cdr structure to free

Definition at line 3433 of file cdr.c.

3434 {
3435  while (cdr) {
3436  struct ast_cdr *next = cdr->next;
3437 
3438  free_variables(&cdr->varshead);
3439  ast_free(cdr);
3440  cdr = next;
3441  }
3442 }
#define ast_free(a)
Definition: astmm.h:180

References ast_free, free_variables(), ast_cdr::next, and ast_cdr::varshead.

Referenced by ast_channel_destructor(), ast_dummy_channel_destructor(), cdr_detach(), clear_mock_cdr_backend(), and do_batch_backend_process().

◆ ast_cdr_get_config()

struct ast_cdr_config* ast_cdr_get_config ( void  )

Obtain the current CDR configuration.

Since
12

The configuration is a ref counted object. The caller of this function must decrement the ref count when finished with the configuration.

Return values
NULLon error
Returns
The current CDR configuration

Definition at line 2848 of file cdr.c.

2849 {
2850  struct ast_cdr_config *general;
2851  struct module_config *mod_cfg;
2852 
2853  mod_cfg = ao2_global_obj_ref(module_configs);
2854  if (!mod_cfg) {
2855  return NULL;
2856  }
2857  general = ao2_bump(mod_cfg->general);
2858  ao2_cleanup(mod_cfg);
2859  return general;
2860 }
#define ao2_bump(obj)
Bump refcount on an AO2 object by one, returning the object.
Definition: astobj2.h:480
The global options available for CDRs.
Definition: cdr.h:265
struct ast_cdr_config * general
Definition: cdr.c:239

References ao2_bump, ao2_cleanup, ao2_global_obj_ref, module_config::general, and NULL.

Referenced by test_cdr_init_cb().

◆ ast_cdr_getvar()

int ast_cdr_getvar ( const char *  channel_name,
const char *  name,
char *  value,
size_t  length 
)

Retrieve a CDR variable from a channel's current CDR.

Since
12
Parameters
channel_nameThe name of the party A channel that the CDR is associated with
nameThe name of the variable to retrieve
valueBuffer to hold the value
lengthThe size of the buffer
Return values
0on success
non-zeroon failure

Definition at line 3346 of file cdr.c.

3347 {
3348  struct cdr_object *cdr;
3349  struct cdr_object *cdr_obj;
3350 
3351  if (ast_strlen_zero(name)) {
3352  return 1;
3353  }
3354 
3355  cdr = cdr_object_get_by_name(channel_name);
3356  if (!cdr) {
3357  ast_log(AST_LOG_ERROR, "Unable to find CDR for channel %s\n", channel_name);
3358  return 1;
3359  }
3360 
3361  ao2_lock(cdr);
3362 
3363  cdr_obj = cdr->last;
3364  if (cdr_object_format_property(cdr_obj, name, value, length)) {
3365  /* Property failed; attempt variable */
3366  cdr_object_format_var_internal(cdr_obj, name, value, length);
3367  }
3368 
3369  ao2_unlock(cdr);
3370 
3371  ao2_cleanup(cdr);
3372  return 0;
3373 }
#define ast_log
Definition: astobj2.c:42
static int cdr_object_format_property(struct cdr_object *cdr_obj, const char *name, char *value, size_t length)
Format one of the standard properties on a cdr_object.
Definition: cdr.c:3265
static void cdr_object_format_var_internal(struct cdr_object *cdr, const char *name, char *value, size_t length)
Format a variable on a cdr_object.
Definition: cdr.c:3248
#define AST_LOG_ERROR
int value
Definition: syslog.c:37

References ao2_cleanup, ao2_lock, ao2_unlock, ast_log, AST_LOG_ERROR, ast_strlen_zero(), cdr_object_format_property(), cdr_object_format_var_internal(), cdr_object_get_by_name(), cdr_object::last, name, and value.

Referenced by AST_TEST_DEFINE(), and cdr_read_callback().

◆ ast_cdr_is_enabled()

int ast_cdr_is_enabled ( void  )

Return TRUE if CDR subsystem is enabled.

Definition at line 2883 of file cdr.c.

2884 {
2885  return is_cdr_flag_set(CDR_ENABLED);
2886 }
static int is_cdr_flag_set(unsigned int cdr_flag)
Definition: cdr.c:1140

References CDR_ENABLED, and is_cdr_flag_set().

Referenced by action_coresettings(), and handle_show_settings().

◆ ast_cdr_message_router()

struct stasis_message_router* ast_cdr_message_router ( void  )

Return the message router for the CDR engine.

This returns the stasis_message_router that the CDR engine uses for dispatching Stasis Message Bus API messages. The reference on the message router is bumped and must be released by the caller of this function.

Return values
NULLif the CDR engine is disabled or unavailable
Returns
the stasis_message_router otherwise

Definition at line 4314 of file cdr.c.

4315 {
4316  if (!stasis_router) {
4317  return NULL;
4318  }
4319 
4321  return stasis_router;
4322 }

References ao2_bump, NULL, and stasis_router.

Referenced by cdr_read(), cdr_write(), forkcdr_exec(), publish_app_cdr_message(), and unload_module().

◆ ast_cdr_modifier_register()

int ast_cdr_modifier_register ( const char *  name,
const char *  desc,
ast_cdrbe  be 
)

Register a CDR modifier.

Parameters
namename associated with the particular CDR modifier
descdescription of the CDR modifier
befunction pointer to a CDR modifier

Used to register a Call Detail Record modifier.

This gives modules a chance to modify CDR fields before they are dispatched to registered backends (odbc, syslog, etc).

Note
The modified CDR will be passed to all registered backends for logging. For instance, if cdr_manager changes the CDR data, cdr_adaptive_odbc will also get the modified CDR.
Return values
0on success.
-1on error

Definition at line 2970 of file cdr.c.

2971 {
2972  return cdr_generic_register((struct be_list *)&mo_list, name, desc, be);
2973 }
static int cdr_generic_register(struct be_list *generic_list, const char *name, const char *desc, ast_cdrbe be)
Definition: cdr.c:2924
static const char desc[]
Definition: cdr_radius.c:84
char * be
Definition: eagi_proxy.c:73
List of registered modifiers.
Definition: cdr.c:349

References be, cdr_generic_register(), desc, and name.

◆ ast_cdr_modifier_unregister()

int ast_cdr_modifier_unregister ( const char *  name)

Unregister a CDR modifier.

Parameters
namename of CDR modifier to unregister Unregisters a CDR modifier by its name
Return values
0The modifier unregistered successfully
-1The modifier could not be unregistered at this time

Definition at line 3015 of file cdr.c.

3016 {
3017  return ast_cdr_generic_unregister((struct be_list *)&mo_list, name);
3018 }
static int ast_cdr_generic_unregister(struct be_list *generic_list, const char *name)
Definition: cdr.c:2975

References ast_cdr_generic_unregister(), and name.

◆ ast_cdr_register()

int ast_cdr_register ( const char *  name,
const char *  desc,
ast_cdrbe  be 
)

Register a CDR handling engine.

Parameters
namename associated with the particular CDR handler
descdescription of the CDR handler
befunction pointer to a CDR handler Used to register a Call Detail Record handler.
Return values
0on success.
-1on error

Definition at line 2965 of file cdr.c.

2966 {
2967  return cdr_generic_register(&be_list, name, desc, be);
2968 }

References be, cdr_generic_register(), desc, and name.

Referenced by load_module(), odbc_load_module(), and unload_module().

◆ ast_cdr_reset()

int ast_cdr_reset ( const char *  channel_name,
int  keep_variables 
)

Reset the detail record.

Parameters
channel_nameThe channel that the CDR is associated with
keep_variablesKeep the variables during the reset. If zero, variables are discarded during the reset.
Return values
0on success
-1on failure

Definition at line 3620 of file cdr.c.

3621 {
3622  struct cdr_object *cdr;
3623  struct ast_var_t *vardata;
3624  struct cdr_object *it_cdr;
3625 
3626  cdr = cdr_object_get_by_name(channel_name);
3627  if (!cdr) {
3628  return -1;
3629  }
3630 
3631  ao2_lock(cdr);
3632  for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
3633  /* clear variables */
3634  if (!keep_variables) {
3635  while ((vardata = AST_LIST_REMOVE_HEAD(&it_cdr->party_a.variables, entries))) {
3636  ast_var_delete(vardata);
3637  }
3638  if (cdr->party_b.snapshot) {
3639  while ((vardata = AST_LIST_REMOVE_HEAD(&it_cdr->party_b.variables, entries))) {
3640  ast_var_delete(vardata);
3641  }
3642  }
3643  }
3644 
3645  /* Reset to initial state */
3646  memset(&it_cdr->start, 0, sizeof(it_cdr->start));
3647  memset(&it_cdr->end, 0, sizeof(it_cdr->end));
3648  memset(&it_cdr->answer, 0, sizeof(it_cdr->answer));
3649  it_cdr->start = ast_tvnow();
3650  it_cdr->lastevent = it_cdr->start;
3652  }
3653  ao2_unlock(cdr);
3654 
3655  ao2_cleanup(cdr);
3656  return 0;
3657 }
static void cdr_object_check_party_a_answer(struct cdr_object *cdr)
Check to see if a CDR needs to be answered based on its Party A. Note that this is safe to call as mu...
Definition: cdr.c:1507
void ast_var_delete(struct ast_var_t *var)
Definition: extconf.c:2472
#define AST_LIST_REMOVE_HEAD(head, field)
Removes and returns the head entry from a list.
Definition: linkedlists.h:833
struct timeval end
Definition: cdr.c:736

References cdr_object::answer, ao2_cleanup, ao2_lock, ao2_unlock, AST_LIST_REMOVE_HEAD, ast_tvnow(), ast_var_delete(), cdr_object_check_party_a_answer(), cdr_object_get_by_name(), cdr_object::end, cdr_object::lastevent, cdr_object::next, cdr_object::party_a, cdr_object::party_b, cdr_object_snapshot::snapshot, cdr_object::start, and cdr_object_snapshot::variables.

Referenced by appcdr_callback(), and dial_exec_full().

◆ ast_cdr_serialize_variables()

int ast_cdr_serialize_variables ( const char *  channel_name,
struct ast_str **  buf,
char  delim,
char  sep 
)

Serializes all the data and variables for a current CDR record.

Parameters
channel_nameThe channel to get the CDR for
bufA buffer to use for formatting the data
delimA delimeter to use to separate variable keys/values
sepA separator to use between nestings
Returns
the total number of serialized variables

Definition at line 3375 of file cdr.c.

3376 {
3377  struct cdr_object *cdr;
3378  struct cdr_object *it_cdr;
3379  struct ast_var_t *variable;
3380  const char *var;
3381  char workspace[256];
3382  int total = 0, x = 0, i;
3383 
3384  cdr = cdr_object_get_by_name(channel_name);
3385  if (!cdr) {
3387  ast_log(AST_LOG_ERROR, "Unable to find CDR for channel %s\n", channel_name);
3388  }
3389  return 0;
3390  }
3391 
3392  ast_str_reset(*buf);
3393 
3394  ao2_lock(cdr);
3395  for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
3396  if (++x > 1) {
3397  ast_str_append(buf, 0, "\n");
3398  }
3399 
3400  AST_LIST_TRAVERSE(&it_cdr->party_a.variables, variable, entries) {
3401  if (!(var = ast_var_name(variable))) {
3402  continue;
3403  }
3404 
3405  if (ast_str_append(buf, 0, "level %d: %s%c%s%c", x, var, delim, S_OR(ast_var_value(variable), ""), sep) < 0) {
3406  ast_log(LOG_ERROR, "Data Buffer Size Exceeded!\n");
3407  break;
3408  }
3409 
3410  total++;
3411  }
3412 
3413  for (i = 0; cdr_readonly_vars[i]; i++) {
3414  if (cdr_object_format_property(it_cdr, cdr_readonly_vars[i], workspace, sizeof(workspace))) {
3415  /* Unhandled read-only CDR variable. */
3416  ast_assert(0);
3417  continue;
3418  }
3419 
3420  if (!ast_strlen_zero(workspace)
3421  && ast_str_append(buf, 0, "level %d: %s%c%s%c", x, cdr_readonly_vars[i], delim, workspace, sep) < 0) {
3422  ast_log(LOG_ERROR, "Data Buffer Size Exceeded!\n");
3423  break;
3424  }
3425  total++;
3426  }
3427  }
3428  ao2_unlock(cdr);
3429  ao2_cleanup(cdr);
3430  return total;
3431 }
#define var
Definition: ast_expr2f.c:614
static const char *const cdr_readonly_vars[]
Definition: cdr.c:3176
const char * ast_var_name(const struct ast_var_t *var)
Definition: chanvars.c:60
const char * ast_var_value(const struct ast_var_t *var)
Definition: chanvars.c:80
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
#define LOG_ERROR
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition: linkedlists.h:491
static int total
Definition: res_adsi.c:968
int ast_str_append(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Append to a thread local dynamic string.
Definition: strings.h:1117
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one.
Definition: strings.h:80
void ast_str_reset(struct ast_str *buf)
Reset the content of a dynamic string. Useful before a series of ast_str_append.
Definition: strings.h:674
struct ast_var_t::@239 entries
#define ast_assert(a)
Definition: utils.h:734

References ao2_cleanup, ao2_lock, ao2_unlock, ast_assert, AST_LIST_TRAVERSE, ast_log, AST_LOG_ERROR, ast_str_append(), ast_str_reset(), ast_strlen_zero(), ast_var_name(), ast_var_value(), buf, CDR_ENABLED, cdr_object_format_property(), cdr_object_get_by_name(), cdr_readonly_vars, ast_var_t::entries, is_cdr_flag_set(), LOG_ERROR, cdr_object::next, cdr_object::party_a, S_OR, total, var, and cdr_object_snapshot::variables.

Referenced by handle_showchan().

◆ ast_cdr_set_config()

void ast_cdr_set_config ( struct ast_cdr_config config)

Set the current CDR configuration.

Since
12
Parameters
configThe new CDR configuration

Definition at line 2862 of file cdr.c.

2863 {
2864  struct module_config *mod_cfg;
2865 
2866  if (!config) {
2867  return;
2868  }
2869 
2870  mod_cfg = ao2_global_obj_ref(module_configs);
2871  if (!mod_cfg) {
2872  return;
2873  }
2874 
2875  ao2_replace(mod_cfg->general, config);
2876 
2877  cdr_set_debug_mode(mod_cfg);
2879 
2880  ao2_cleanup(mod_cfg);
2881 }
#define ao2_replace(dst, src)
Replace one object reference with another cleaning up the original.
Definition: astobj2.h:501
#define cdr_set_debug_mode(mod_cfg)
Definition: cdr.c:219
static int cdr_toggle_runtime_options(void)
Checks if CDRs are enabled and enables/disables the necessary options.
Definition: cdr.c:4508
static const char config[]
Definition: chan_ooh323.c:111

References ao2_cleanup, ao2_global_obj_ref, ao2_replace, cdr_set_debug_mode, cdr_toggle_runtime_options(), config, and module_config::general.

Referenced by test_cdr_cleanup_cb().

◆ ast_cdr_set_property()

int ast_cdr_set_property ( const char *  channel_name,
enum ast_cdr_options  option 
)

Set a property on a CDR for a channel.

Since
12

This function sets specific administrative properties on a CDR for a channel. This includes properties like preventing a CDR from being dispatched, to setting the channel as the preferred Party A in future CDRs. See ast_cdr_options for more information.

Parameters
channel_nameThe CDR's channel
optionOption to apply to the CDR
Return values
0on success
1on error

Definition at line 3570 of file cdr.c.

3571 {
3572  struct cdr_object *cdr;
3573  struct cdr_object *it_cdr;
3574 
3575  cdr = cdr_object_get_by_name(channel_name);
3576  if (!cdr) {
3577  return -1;
3578  }
3579 
3580  ao2_lock(cdr);
3581  for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
3582  if (it_cdr->fn_table == &finalized_state_fn_table) {
3583  continue;
3584  }
3585  /* Note: in general, set the flags on both the CDR record as well as the
3586  * Party A. Sometimes all we have is the Party A to look at.
3587  */
3588  ast_set_flag(&it_cdr->flags, option);
3589  ast_set_flag(&it_cdr->party_a, option);
3590  }
3591  ao2_unlock(cdr);
3592 
3593  ao2_cleanup(cdr);
3594  return 0;
3595 }
#define ast_set_flag(p, flag)
Definition: utils.h:70

References ao2_cleanup, ao2_lock, ao2_unlock, ast_set_flag, cdr_object_get_by_name(), finalized_state_fn_table, cdr_object::flags, cdr_object::fn_table, cdr_object::next, and cdr_object::party_a.

Referenced by appcdr_callback(), AST_TEST_DEFINE(), and cdr_prop_write_callback().

◆ ast_cdr_setuserfield()

void ast_cdr_setuserfield ( const char *  channel_name,
const char *  userfield 
)

Set CDR user field for channel (stored in CDR)

Parameters
channel_nameThe name of the channel that owns the CDR
userfieldThe user field to set

Definition at line 3499 of file cdr.c.

3500 {
3501  struct cdr_object *cdr;
3502  struct party_b_userfield_update party_b_info = {
3504  .userfield = userfield,
3505  };
3506  struct cdr_object *it_cdr;
3507 
3508  /* Handle Party A */
3509  cdr = cdr_object_get_by_name(channel_name);
3510  if (cdr) {
3511  ao2_lock(cdr);
3512  for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
3513  if (it_cdr->fn_table == &finalized_state_fn_table && it_cdr->next != NULL) {
3514  continue;
3515  }
3516  ast_copy_string(it_cdr->party_a.userfield, userfield,
3517  sizeof(it_cdr->party_a.userfield));
3518  }
3519  ao2_unlock(cdr);
3520  }
3521 
3522  /* Handle Party B */
3525  &party_b_info);
3526 
3527  ao2_cleanup(cdr);
3528 }
#define ao2_callback_data(container, flags, cb_fn, arg, data)
Definition: astobj2.h:1723
@ OBJ_NODATA
Definition: astobj2.h:1044
@ OBJ_MULTIPLE
Definition: astobj2.h:1049
@ OBJ_SEARCH_KEY
The arg parameter is a search key, but is not an object.
Definition: astobj2.h:1101
static int cdr_object_update_party_b_userfield_cb(void *obj, void *arg, void *data, int flags)
Callback used to update the userfield on Party B on all CDRs.
Definition: cdr.c:3477
static struct ao2_container * active_cdrs_all
A container of all active CDRs with a Party B indexed by Party B channel name.
Definition: cdr.c:384
const char * userfield
Definition: cdr.c:3473
const char * channel_name
Definition: cdr.c:3472

References active_cdrs_all, ao2_callback_data, ao2_cleanup, ao2_lock, ao2_unlock, ast_copy_string(), cdr_object_get_by_name(), cdr_object_update_party_b_userfield_cb(), party_b_userfield_update::channel_name, finalized_state_fn_table, cdr_object::fn_table, cdr_object::next, NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_SEARCH_KEY, cdr_object::party_a, cdr_object_snapshot::userfield, and party_b_userfield_update::userfield.

Referenced by AST_TEST_DEFINE(), cdr_write_callback(), handle_request_info(), and start_monitor_exec().

◆ ast_cdr_setvar()

int ast_cdr_setvar ( const char *  channel_name,
const char *  name,
const char *  value 
)

Set a variable on a CDR.

Since
12
Parameters
channel_nameThe channel to set the variable on
nameThe name of the variable to set
valueThe value of the variable to set
Return values
0on success
non-zeroon failure

Definition at line 3200 of file cdr.c.

3201 {
3202  struct cdr_object *cdr;
3203  struct cdr_object *it_cdr;
3204  struct ao2_iterator *it_cdrs;
3205  char *arg = ast_strdupa(channel_name);
3206  int x;
3207 
3208  for (x = 0; cdr_readonly_vars[x]; x++) {
3209  if (!strcasecmp(name, cdr_readonly_vars[x])) {
3210  ast_log(LOG_ERROR, "Attempt to set the '%s' read-only variable!\n", name);
3211  return -1;
3212  }
3213  }
3214 
3216  if (!it_cdrs) {
3217  ast_log(AST_LOG_ERROR, "Unable to find CDR for channel %s\n", channel_name);
3218  return -1;
3219  }
3220 
3221  for (; (cdr = ao2_iterator_next(it_cdrs)); ao2_unlock(cdr), ao2_cleanup(cdr)) {
3222  ao2_lock(cdr);
3223  for (it_cdr = cdr; it_cdr; it_cdr = it_cdr->next) {
3224  struct varshead *headp = NULL;
3225 
3226  if (it_cdr->fn_table == &finalized_state_fn_table && it_cdr->next != NULL) {
3227  continue;
3228  }
3229  if (!strcasecmp(channel_name, it_cdr->party_a.snapshot->base->name)) {
3230  headp = &it_cdr->party_a.variables;
3231  } else if (it_cdr->party_b.snapshot
3232  && !strcasecmp(channel_name, it_cdr->party_b.snapshot->base->name)) {
3233  headp = &it_cdr->party_b.variables;
3234  }
3235  if (headp) {
3236  set_variable(headp, name, value);
3237  }
3238  }
3239  }
3240  ao2_iterator_destroy(it_cdrs);
3241 
3242  return 0;
3243 }
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:298
#define ao2_iterator_next(iter)
Definition: astobj2.h:1911
#define ao2_callback(c, flags, cb_fn, arg)
ao2_callback() is a generic function that applies cb_fn() to all objects in a container,...
Definition: astobj2.h:1693
void ao2_iterator_destroy(struct ao2_iterator *iter)
Destroy a container iterator.
static int cdr_object_select_all_by_name_cb(void *obj, void *arg, int flags)
Definition: cdr.c:3148
static void set_variable(struct varshead *headp, const char *name, const char *value)
Definition: cdr.c:1275
static struct ao2_container * active_cdrs_master
A container of the active master CDRs indexed by Party A channel uniqueid.
Definition: cdr.c:381
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition: astobj2.h:1821
const ast_string_field name
struct ast_channel_snapshot_base * base

References active_cdrs_master, ao2_callback, ao2_cleanup, ao2_iterator_destroy(), ao2_iterator_next, ao2_lock, ao2_unlock, ast_log, AST_LOG_ERROR, ast_strdupa, ast_channel_snapshot::base, cdr_object_select_all_by_name_cb(), cdr_readonly_vars, finalized_state_fn_table, cdr_object::fn_table, LOG_ERROR, name, ast_channel_snapshot_base::name, cdr_object::next, NULL, OBJ_MULTIPLE, cdr_object::party_a, cdr_object::party_b, set_variable(), cdr_object_snapshot::snapshot, value, and cdr_object_snapshot::variables.

Referenced by AST_TEST_DEFINE(), and cdr_write_callback().

◆ ast_cdr_unregister()

int ast_cdr_unregister ( const char *  name)

Unregister a CDR handling engine.

Parameters
namename of CDR handler to unregister Unregisters a CDR by it's name
Return values
0The backend unregistered successfully
-1The backend could not be unregistered at this time

Definition at line 3010 of file cdr.c.

3011 {
3013 }

References ast_cdr_generic_unregister(), and name.

Referenced by load_module(), tds_unload_module(), and unload_module().