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