Doxygen documentation update from oej (issue #5505)
[asterisk/asterisk.git] / funcs / func_cdr.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Portions Copyright (C) 2005, Anthony Minessale II
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 related dialplan functions
22  * 
23  */
24
25 #include <stdlib.h>
26 #include <string.h>
27 #include <sys/types.h>
28
29 #include "asterisk.h"
30
31 /* ASTERISK_FILE_VERSION(__FILE__, "$Revision$") */
32
33 #include "asterisk/channel.h"
34 #include "asterisk/pbx.h"
35 #include "asterisk/logger.h"
36 #include "asterisk/utils.h"
37 #include "asterisk/app.h"
38 #include "asterisk/cdr.h"
39
40 static char *builtin_function_cdr_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
41 {
42         char *ret;
43         char *mydata;
44         int argc;
45         char *argv[2];
46         int recursive = 0;
47
48         if (!data || ast_strlen_zero(data))
49                 return NULL;
50         
51         if (!chan->cdr)
52                 return NULL;
53
54         mydata = ast_strdupa(data);
55         argc = ast_separate_app_args(mydata, '|', argv, sizeof(argv) / sizeof(argv[0]));
56
57         /* check for a trailing flags argument */
58         if (argc > 1) {
59                 argc--;
60                 if (strchr(argv[argc], 'r'))
61                         recursive = 1;
62         }
63
64         ast_cdr_getvar(chan->cdr, argv[0], &ret, buf, len, recursive);
65
66         return ret;
67 }
68
69 static void builtin_function_cdr_write(struct ast_channel *chan, char *cmd, char *data, const char *value) 
70 {
71         char *mydata;
72         int argc;
73         char *argv[2];
74         int recursive = 0;
75
76         if (!data || ast_strlen_zero(data) || !value)
77                 return;
78         
79         mydata = ast_strdupa(data);
80         argc = ast_separate_app_args(mydata, '|', argv, sizeof(argv) / sizeof(argv[0]));
81
82         /* check for a trailing flags argument */
83         if (argc > 1) {
84                 argc--;
85                 if (strchr(argv[argc], 'r'))
86                         recursive = 1;
87         }
88
89         if (!strcasecmp(argv[0], "accountcode"))
90                 ast_cdr_setaccount(chan, value);
91         else if (!strcasecmp(argv[0], "userfield"))
92                 ast_cdr_setuserfield(chan, value);
93         else if (chan->cdr)
94                 ast_cdr_setvar(chan->cdr, argv[0], value, recursive);
95 }
96
97 #ifndef BUILTIN_FUNC
98 static
99 #endif
100 struct ast_custom_function cdr_function = {
101         .name = "CDR",
102         .synopsis = "Gets or sets a CDR variable",
103         .desc= "Option 'r' searches the entire stack of CDRs on the channel\n",
104         .syntax = "CDR(<name>[|options])",
105         .read = builtin_function_cdr_read,
106         .write = builtin_function_cdr_write,
107 };
108