Bug 6417 - Allow retrieval of raw CDR values
[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
26 #include <stdlib.h>
27 #include <string.h>
28 #include <sys/types.h>
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/module.h"
35 #include "asterisk/channel.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/logger.h"
38 #include "asterisk/utils.h"
39 #include "asterisk/app.h"
40 #include "asterisk/cdr.h"
41
42 enum {
43         OPT_RECURSIVE = (1 << 0),
44         OPT_UNPARSED = (1 << 1),
45 } cdr_option_flags;
46
47 AST_APP_OPTIONS(cdr_func_options, {
48         AST_APP_OPTION('r', OPT_RECURSIVE),
49         AST_APP_OPTION('u', OPT_UNPARSED),
50 });
51
52 static int cdr_read(struct ast_channel *chan, char *cmd, char *parse,
53                     char *buf, size_t len)
54 {
55         char *ret;
56         struct ast_flags flags = { 0 };
57         AST_DECLARE_APP_ARGS(args,
58                              AST_APP_ARG(variable);
59                              AST_APP_ARG(options);
60         );
61
62         if (ast_strlen_zero(parse))
63                 return -1;
64
65         if (!chan->cdr)
66                 return -1;
67
68         AST_STANDARD_APP_ARGS(args, parse);
69
70         if (!ast_strlen_zero(args.options))
71                 ast_app_parse_options(cdr_func_options, &flags, NULL, args.options);
72
73         ast_cdr_getvar(chan->cdr, args.variable, &ret, buf, len,
74                        ast_test_flag(&flags, OPT_RECURSIVE),
75                            ast_test_flag(&flags, OPT_UNPARSED));
76
77         return 0;
78 }
79
80 static int cdr_write(struct ast_channel *chan, char *cmd, char *parse,
81                      const char *value)
82 {
83         struct ast_flags flags = { 0 };
84         AST_DECLARE_APP_ARGS(args,
85                              AST_APP_ARG(variable);
86                              AST_APP_ARG(options);
87         );
88
89         if (ast_strlen_zero(parse) || !value)
90                 return -1;
91
92         AST_STANDARD_APP_ARGS(args, parse);
93
94         if (!ast_strlen_zero(args.options))
95                 ast_app_parse_options(cdr_func_options, &flags, NULL, args.options);
96
97         if (!strcasecmp(args.variable, "accountcode"))
98                 ast_cdr_setaccount(chan, value);
99         else if (!strcasecmp(args.variable, "userfield"))
100                 ast_cdr_setuserfield(chan, value);
101         else if (chan->cdr)
102                 ast_cdr_setvar(chan->cdr, args.variable, value, ast_test_flag(&flags, OPT_RECURSIVE));
103                 /* No need to worry about the u flag, as all fields for which setting
104                  * 'u' would do anything are marked as readonly. */
105
106         return 0;
107 }
108
109 static struct ast_custom_function cdr_function = {
110         .name = "CDR",
111         .synopsis = "Gets or sets a CDR variable",
112         .syntax = "CDR(<name>[|options])",
113         .read = cdr_read,
114         .write = cdr_write,
115         .desc =
116 "Options:\n"
117 "  'r' searches the entire stack of CDRs on the channel\n"
118 "  'u' retrieves the raw, unprocessed value\n"
119 "  For example, 'start', 'answer', and 'end' will be retrieved as epoch\n"
120 "  values, when the n option is passed, but formatted as YYYY-MM-DD HH:MM:SS\n"
121 "  otherwise.  Similarly, disposition and amaflags will return their raw\n"
122 "  integral values.\n",
123 };
124
125 static char *tdesc = "CDR dialplan function";
126
127 int unload_module(void)
128 {
129         return ast_custom_function_unregister(&cdr_function);
130 }
131
132 int load_module(void)
133 {
134         return ast_custom_function_register(&cdr_function);
135 }
136
137 char *description(void)
138 {
139         return tdesc;
140 }
141
142 int usecount(void)
143 {
144         return 0;
145 }
146
147 char *key()
148 {
149         return ASTERISK_GPL_KEY;
150 }