include/asterisk/cdr.h

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 1999 - 2005, 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  * \brief Call Detail Record API
  21  */
  22
  23 #ifndef _ASTERISK_CDR_H
  24 #define _ASTERISK_CDR_H
  25
  26 #include <sys/time.h>
  27 #define AST_CDR_FLAG_KEEP_VARS                  (1 << 0)
  28 #define AST_CDR_FLAG_POSTED                     (1 << 1)
  29 #define AST_CDR_FLAG_LOCKED                     (1 << 2)
  30 #define AST_CDR_FLAG_CHILD                      (1 << 3)
  31 #define AST_CDR_FLAG_POST_DISABLED              (1 << 4)
  32
  33 /*! \name CDR Flags */
  34 /*@{ */
  35 #define AST_CDR_NULL                0
  36 #define AST_CDR_FAILED                          (1 << 0)
  37 #define AST_CDR_BUSY                            (1 << 1)
  38 #define AST_CDR_NOANSWER                        (1 << 2)
  39 #define AST_CDR_ANSWERED                        (1 << 3)
  40 /*@} */
  41
  42 /*! \name CDR AMA Flags */
  43 /*@{ */
  44 #define AST_CDR_OMIT                            (1)
  45 #define AST_CDR_BILLING                         (2)
  46 #define AST_CDR_DOCUMENTATION                   (3)
  47 /*@} */
  48
  49 #define AST_MAX_USER_FIELD                      256
  50 #define AST_MAX_ACCOUNT_CODE                    20
  51
  52 /* Include channel.h after relevant declarations it will need */
  53 #include "asterisk/channel.h"
  54 #include "asterisk/utils.h"
  55
  56 /*! \brief Responsible for call detail data */
  57 struct ast_cdr {
  58         /*! Caller*ID with text */
  59         char clid[AST_MAX_EXTENSION];
  60         /*! Caller*ID number */
  61         char src[AST_MAX_EXTENSION];
  62         /*! Destination extension */
  63         char dst[AST_MAX_EXTENSION];
  64         /*! Destination context */
  65         char dcontext[AST_MAX_EXTENSION];
  66
  67         char channel[AST_MAX_EXTENSION];
  68         /*! Destination channel if appropriate */
  69         char dstchannel[AST_MAX_EXTENSION];
  70         /*! Last application if appropriate */
  71         char lastapp[AST_MAX_EXTENSION];
  72         /*! Last application data */
  73         char lastdata[AST_MAX_EXTENSION];
  74
  75         struct timeval start;
  76
  77         struct timeval answer;
  78
  79         struct timeval end;
  80         /*! Total time in system, in seconds */
  81         long int duration;
  82         /*! Total time call is up, in seconds */
  83         long int billsec;
  84         /*! What happened to the call */
  85         long int disposition;
  86         /*! What flags to use */
  87         long int amaflags;
  88         /*! What account number to use */
  89         char accountcode[AST_MAX_ACCOUNT_CODE];
  90         /*! flags */
  91         unsigned int flags;
  92         /*! Unique Channel Identifier */
  93         char uniqueid[32];
  94         /*! User field */
  95         char userfield[AST_MAX_USER_FIELD];
  96
  97         /*! A linked list for variables */
  98         struct varshead varshead;
  99
 100         struct ast_cdr *next;
 101 };
 102
 103 void ast_cdr_getvar(struct ast_cdr *cdr, const char *name, char **ret, char *workspace, int workspacelen, int recur, int raw);
 104 int ast_cdr_setvar(struct ast_cdr *cdr, const char *name, const char *value, int recur);
 105 int ast_cdr_serialize_variables(struct ast_cdr *cdr, struct ast_str **buf, char delim, char sep, int recur);
 106 void ast_cdr_free_vars(struct ast_cdr *cdr, int recur);
 107 int ast_cdr_copy_vars(struct ast_cdr *to_cdr, struct ast_cdr *from_cdr);
 108 int ast_cdr_log_unanswered(void);
 109
 110 typedef int (*ast_cdrbe)(struct ast_cdr *cdr);
 111
 112 /*! \brief Return TRUE if CDR subsystem is enabled */
 113 int check_cdr_enabled(void);
 114
 115 /*!
 116  * \brief Allocate a CDR record
 117  * \retval a malloc'd ast_cdr structure
 118  * \retval NULL on error (malloc failure)
 119  */
 120 struct ast_cdr *ast_cdr_alloc(void);
 121
 122 /*!
 123  * \brief Duplicate a record
 124  * \retval a malloc'd ast_cdr structure,
 125  * \retval NULL on error (malloc failure)
 126  */
 127 struct ast_cdr *ast_cdr_dup(struct ast_cdr *cdr);
 128
 129 /*!
 130  * \brief Free a CDR record
 131  * \param cdr ast_cdr structure to free
 132  * Returns nothing
 133  */
 134 void ast_cdr_free(struct ast_cdr *cdr);
 135
 136 /*!
 137  * \brief Discard and free a CDR record
 138  * \param cdr ast_cdr structure to free
 139  * Returns nothing  -- same as free, but no checks or complaints
 140  */
 141 void ast_cdr_discard(struct ast_cdr *cdr);
 142
 143 /*!
 144  * \brief Initialize based on a channel
 145  * \param cdr Call Detail Record to use for channel
 146  * \param chan Channel to bind CDR with
 147  * Initializes a CDR and associates it with a particular channel
 148  * \return 0 by default
 149  */
 150 int ast_cdr_init(struct ast_cdr *cdr, struct ast_channel *chan);
 151
 152 /*!
 153  * \brief Initialize based on a channel
 154  * \param cdr Call Detail Record to use for channel
 155  * \param chan Channel to bind CDR with
 156  * Initializes a CDR and associates it with a particular channel
 157  * \return 0 by default
 158  */
 159 int ast_cdr_setcid(struct ast_cdr *cdr, struct ast_channel *chan);
 160
 161 /*!
 162  * \brief Register a CDR handling engine
 163  * \param name name associated with the particular CDR handler
 164  * \param desc description of the CDR handler
 165  * \param be function pointer to a CDR handler
 166  * Used to register a Call Detail Record handler.
 167  * \retval 0 on success.
 168  * \retval -1 on error
 169  */
 170 int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be);
 171
 172 /*!
 173  * \brief Unregister a CDR handling engine
 174  * \param name name of CDR handler to unregister
 175  * Unregisters a CDR by it's name
 176  */
 177 void ast_cdr_unregister(const char *name);
 178
 179 /*!
 180  * \brief Start a call
 181  * \param cdr the cdr you wish to associate with the call
 182  * Starts all CDR stuff necessary for monitoring a call
 183  * Returns nothing
 184  */
 185 void ast_cdr_start(struct ast_cdr *cdr);
 186
 187 /*! \brief Answer a call
 188  * \param cdr the cdr you wish to associate with the call
 189  * Starts all CDR stuff necessary for doing CDR when answering a call
 190  * \note NULL argument is just fine.
 191  */
 192 void ast_cdr_answer(struct ast_cdr *cdr);
 193
 194 /*!
 195  * \brief A call wasn't answered
 196  * \param cdr the cdr you wish to associate with the call
 197  * Marks the channel disposition as "NO ANSWER"
 198  */
 199 extern void ast_cdr_noanswer(struct ast_cdr *cdr);
 200
 201 /*!
 202  * \brief Busy a call
 203  * \param cdr the cdr you wish to associate with the call
 204  * Returns nothing
 205  */
 206 void ast_cdr_busy(struct ast_cdr *cdr);
 207
 208 /*!
 209  * \brief Fail a call
 210  * \param cdr the cdr you wish to associate with the call
 211  * Returns nothing
 212  */
 213 void ast_cdr_failed(struct ast_cdr *cdr);
 214
 215 /*!
 216  * \brief Save the result of the call based on the AST_CAUSE_*
 217  * \param cdr the cdr you wish to associate with the call
 218  * \param cause the AST_CAUSE_*
 219  * Returns nothing
 220  */
 221 int ast_cdr_disposition(struct ast_cdr *cdr, int cause);
 222
 223 /*!
 224  * \brief End a call
 225  * \param cdr the cdr you have associated the call with
 226  * Registers the end of call time in the cdr structure.
 227  * Returns nothing
 228  */
 229 void ast_cdr_end(struct ast_cdr *cdr);
 230
 231 /*!
 232  * \brief Detaches the detail record for posting (and freeing) either now or at a
 233  * later time in bulk with other records during batch mode operation.
 234  * \param cdr Which CDR to detach from the channel thread
 235  * Prevents the channel thread from blocking on the CDR handling
 236  * Returns nothing
 237  */
 238 void ast_cdr_detach(struct ast_cdr *cdr);
 239
 240 /*!
 241  * \brief Spawns (possibly) a new thread to submit a batch of CDRs to the backend engines
 242  * \param shutdown Whether or not we are shutting down
 243  * Blocks the asterisk shutdown procedures until the CDR data is submitted.
 244  * Returns nothing
 245  */
 246 void ast_cdr_submit_batch(int shutdown);
 247
 248 /*!
 249  * \brief Set the destination channel, if there was one
 250  * \param cdr Which cdr it's applied to
 251  * \param chan Channel to which dest will be
 252  * Sets the destination channel the CDR is applied to
 253  * Returns nothing
 254  */
 255 void ast_cdr_setdestchan(struct ast_cdr *cdr, const char *chan);
 256
 257 /*!
 258  * \brief Set the last executed application
 259  * \param cdr which cdr to act upon
 260  * \param app the name of the app you wish to change it to
 261  * \param data the data you want in the data field of app you set it to
 262  * Changes the value of the last executed app
 263  * Returns nothing
 264  */
 265 void ast_cdr_setapp(struct ast_cdr *cdr, char *app, char *data);
 266
 267 /*!
 268  * \brief Convert a string to a detail record AMA flag
 269  * \param flag string form of flag
 270  * Converts the string form of the flag to the binary form.
 271  * \return the binary form of the flag
 272  */
 273 int ast_cdr_amaflags2int(const char *flag);
 274
 275 /*!
 276  * \brief Disposition to a string
 277  * \param disposition input binary form
 278  * Converts the binary form of a disposition to string form.
 279  * \return a pointer to the string form
 280  */
 281 char *ast_cdr_disp2str(int disposition);
 282
 283 /*!
 284  * \brief Reset the detail record, optionally posting it first
 285  * \param cdr which cdr to act upon
 286  * \param flags |AST_CDR_FLAG_POSTED whether or not to post the cdr first before resetting it
 287  *              |AST_CDR_FLAG_LOCKED whether or not to reset locked CDR's
 288  */
 289 void ast_cdr_reset(struct ast_cdr *cdr, struct ast_flags *flags);
 290
 291 /*!
 292  * \brief Flags to a string
 293  * \param flags binary flag
 294  * Converts binary flags to string flags
 295  * Returns string with flag name
 296  */
 297 char *ast_cdr_flags2str(int flags);
 298
 299 /*!
 300  * \brief Move the non-null data from the "from" cdr to the "to" cdr
 301  * \param to the cdr to get the goodies
 302  * \param from the cdr to give the goodies
 303  */
 304 void ast_cdr_merge(struct ast_cdr *to, struct ast_cdr *from);
 305
 306 /*! \brief Set account code, will generate AMI event */
 307 int ast_cdr_setaccount(struct ast_channel *chan, const char *account);
 308
 309 /*! \brief Set AMA flags for channel */
 310 int ast_cdr_setamaflags(struct ast_channel *chan, const char *amaflags);
 311
 312 /*! \brief Set CDR user field for channel (stored in CDR) */
 313 int ast_cdr_setuserfield(struct ast_channel *chan, const char *userfield);
 314 /*! \brief Append to CDR user field for channel (stored in CDR) */
 315 int ast_cdr_appenduserfield(struct ast_channel *chan, const char *userfield);
 316
 317
 318 /*! Update CDR on a channel */
 319 int ast_cdr_update(struct ast_channel *chan);
 320
 321
 322 extern int ast_default_amaflags;
 323
 324 extern char ast_default_accountcode[AST_MAX_ACCOUNT_CODE];
 325
 326 struct ast_cdr *ast_cdr_append(struct ast_cdr *cdr, struct ast_cdr *newcdr);
 327
 328 /*! \brief Reload the configuration file cdr.conf and start/stop CDR scheduling thread */
 329 int ast_cdr_engine_reload(void);
 330
 331 /*! \brief Load the configuration file cdr.conf and possibly start the CDR scheduling thread */
 332 int ast_cdr_engine_init(void);
 333
 334 /*! Submit any remaining CDRs and prepare for shutdown */
 335 void ast_cdr_engine_term(void);
 336
 337 #endif /* _ASTERISK_CDR_H */