Merged revisions 80044 via svnmerge from
[asterisk/asterisk.git] / funcs / func_cdr.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999-2006, 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  * \author Anthony Minessale II 
24  *
25  * \ingroup functions
26  */
27
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include <sys/types.h>
36
37 #include "asterisk/module.h"
38 #include "asterisk/channel.h"
39 #include "asterisk/pbx.h"
40 #include "asterisk/logger.h"
41 #include "asterisk/utils.h"
42 #include "asterisk/app.h"
43 #include "asterisk/cdr.h"
44
45 enum {
46         OPT_RECURSIVE = (1 << 0),
47         OPT_UNPARSED = (1 << 1),
48         OPT_LAST = (1 << 2),
49 } cdr_option_flags;
50
51 AST_APP_OPTIONS(cdr_func_options, {
52         AST_APP_OPTION('l', OPT_LAST),
53         AST_APP_OPTION('r', OPT_RECURSIVE),
54         AST_APP_OPTION('u', OPT_UNPARSED),
55 });
56
57 static int cdr_read(struct ast_channel *chan, const char *cmd, char *parse,
58                     char *buf, size_t len)
59 {
60         char *ret;
61         struct ast_flags flags = { 0 };
62         struct ast_cdr *cdr = chan ? chan->cdr : NULL;
63         AST_DECLARE_APP_ARGS(args,
64                              AST_APP_ARG(variable);
65                              AST_APP_ARG(options);
66         );
67
68         if (ast_strlen_zero(parse))
69                 return -1;
70
71         if (!cdr)
72                 return -1;
73
74         AST_STANDARD_APP_ARGS(args, parse);
75
76         if (!ast_strlen_zero(args.options))
77                 ast_app_parse_options(cdr_func_options, &flags, NULL, args.options);
78
79         if (ast_test_flag(&flags, OPT_LAST))
80                 while (cdr->next)
81                         cdr = cdr->next;
82
83         ast_cdr_getvar(cdr, args.variable, &ret, buf, len,
84                        ast_test_flag(&flags, OPT_RECURSIVE),
85                            ast_test_flag(&flags, OPT_UNPARSED));
86
87         return 0;
88 }
89
90 static int cdr_write(struct ast_channel *chan, const char *cmd, char *parse,
91                      const char *value)
92 {
93         struct ast_flags flags = { 0 };
94         AST_DECLARE_APP_ARGS(args,
95                              AST_APP_ARG(variable);
96                              AST_APP_ARG(options);
97         );
98
99         if (ast_strlen_zero(parse) || !value || !chan)
100                 return -1;
101
102         AST_STANDARD_APP_ARGS(args, parse);
103
104         if (!ast_strlen_zero(args.options))
105                 ast_app_parse_options(cdr_func_options, &flags, NULL, args.options);
106
107         if (!strcasecmp(args.variable, "accountcode"))
108                 ast_cdr_setaccount(chan, value);
109         else if (!strcasecmp(args.variable, "userfield"))
110                 ast_cdr_setuserfield(chan, value);
111         else if (!strcasecmp(args.variable, "amaflags"))
112                 ast_cdr_setamaflags(chan, value);
113         else if (chan->cdr)
114                 ast_cdr_setvar(chan->cdr, args.variable, value, ast_test_flag(&flags, OPT_RECURSIVE));
115                 /* No need to worry about the u flag, as all fields for which setting
116                  * 'u' would do anything are marked as readonly. */
117
118         return 0;
119 }
120
121 static struct ast_custom_function cdr_function = {
122         .name = "CDR",
123         .synopsis = "Gets or sets a CDR variable",
124         .syntax = "CDR(<name>[,options])",
125         .read = cdr_read,
126         .write = cdr_write,
127         .desc =
128 "Options:\n"
129 "  'r' searches the entire stack of CDRs on the channel\n"
130 "  'u' retrieves the raw, unprocessed value\n"
131 "  For example, 'start', 'answer', and 'end' will be retrieved as epoch\n"
132 "  values, when the 'u' option is passed, but formatted as YYYY-MM-DD HH:MM:SS\n"
133 "  otherwise.  Similarly, disposition and amaflags will return their raw\n"
134 "  integral values.\n"
135 "  Here is a list of all the available cdr field names:\n"
136 "    clid          lastdata       disposition\n"
137 "    src           start          amaflags\n"
138 "    dst           answer         accountcode\n"
139 "    dcontext      end            uniqueid\n"
140 "    dstchannel    duration       userfield\n"
141 "    lastapp       billsec        channel\n"
142 "  All of the above variables are read-only, except for accountcode,\n"
143 "  userfield, and amaflags. You may, however,  supply\n"
144 "  a name not on the above list, and create your own\n"
145 "  variable, whose value can be changed with this function,\n"
146 "  and this variable will be stored on the cdr.\n"
147 "   raw values for disposition:\n"
148 "       1 = NO ANSWER\n"
149 "       2 = BUSY\n"
150 "       3 = FAILED\n"
151 "       4 = ANSWERED\n"
152 "    raw values for amaflags:\n"
153 "       1 = OMIT\n"
154 "       2 = BILLING\n"
155 "       3 = DOCUMENTATION\n",
156 };
157
158 static int unload_module(void)
159 {
160         return ast_custom_function_unregister(&cdr_function);
161 }
162
163 static int load_module(void)
164 {
165         return ast_custom_function_register(&cdr_function);
166 }
167
168 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Call Detail Record (CDR) dialplan function");