Continue merging in changes from resolve-shadow-warnings. funcs/ this time.
[asterisk/asterisk.git] / funcs / func_timeout.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, 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  *
21  * \brief Channel timeout related dialplan functions
22  *
23  * \author Mark Spencer <markster@digium.com> 
24  * \ingroup functions
25  */
26
27 #include "asterisk.h"
28
29 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
30
31 #include "asterisk/module.h"
32 #include "asterisk/channel.h"
33 #include "asterisk/pbx.h"
34 #include "asterisk/utils.h"
35 #include "asterisk/app.h"
36
37 static int timeout_read(struct ast_channel *chan, const char *cmd, char *data,
38                         char *buf, size_t len)
39 {
40         struct timeval myt;
41
42         if (!chan)
43                 return -1;
44
45         if (!data) {
46                 ast_log(LOG_ERROR, "Must specify type of timeout to get.\n");
47                 return -1;
48         }
49
50         switch (*data) {
51         case 'a':
52         case 'A':
53                 if (ast_tvzero(chan->whentohangup)) {
54                         ast_copy_string(buf, "0", len);
55                 } else {
56                         myt = ast_tvnow();
57                         snprintf(buf, len, "%.3f", ast_tvdiff_ms(myt, chan->whentohangup) / 1000.0);
58                 }
59                 break;
60
61         case 'r':
62         case 'R':
63                 if (chan->pbx) {
64                         snprintf(buf, len, "%.3f", chan->pbx->rtimeoutms / 1000.0);
65                 }
66                 break;
67
68         case 'd':
69         case 'D':
70                 if (chan->pbx) {
71                         snprintf(buf, len, "%.3f", chan->pbx->dtimeoutms / 1000.0);
72                 }
73                 break;
74
75         default:
76                 ast_log(LOG_ERROR, "Unknown timeout type specified.\n");
77                 break;
78         }
79
80         return 0;
81 }
82
83 static int timeout_write(struct ast_channel *chan, const char *cmd, char *data,
84                          const char *value)
85 {
86         double x;
87         long sec;
88         char timestr[64];
89         struct ast_tm myt;
90         struct timeval when;
91
92         if (!chan)
93                 return -1;
94
95         if (!data) {
96                 ast_log(LOG_ERROR, "Must specify type of timeout to set.\n");
97                 return -1;
98         }
99
100         if (!value)
101                 return -1;
102
103         if ((sscanf(value, "%ld%lf", &sec, &x) == 0) || sec < 0)
104                 when.tv_sec = 0;
105         else {
106                 when.tv_sec = sec;
107                 when.tv_usec = x * 1000000;
108         }
109
110         switch (*data) {
111         case 'a':
112         case 'A':
113                 ast_channel_setwhentohangup_tv(chan, when);
114                 if (VERBOSITY_ATLEAST(3)) {
115                         if (!ast_tvzero(chan->whentohangup)) {
116                                 when = ast_tvadd(when, ast_tvnow());
117                                 ast_strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S.%3q %Z",
118                                         ast_localtime(&when, &myt, NULL));
119                                 ast_verbose("Channel will hangup at %s.\n", timestr);
120                         } else {
121                                 ast_verbose("Channel hangup cancelled.\n");
122                         }
123                 }
124                 break;
125
126         case 'r':
127         case 'R':
128                 if (chan->pbx) {
129                         chan->pbx->rtimeoutms = when.tv_sec * 1000 + when.tv_usec / 1000.0;
130                         ast_verb(3, "Response timeout set to %.3f\n", chan->pbx->rtimeoutms / 1000.0);
131                 }
132                 break;
133
134         case 'd':
135         case 'D':
136                 if (chan->pbx) {
137                         chan->pbx->dtimeoutms = when.tv_sec * 1000 + when.tv_usec / 1000.0;
138                         ast_verb(3, "Digit timeout set to %.3f\n", chan->pbx->dtimeoutms / 1000.0);
139                 }
140                 break;
141
142         default:
143                 ast_log(LOG_ERROR, "Unknown timeout type specified.\n");
144                 break;
145         }
146
147         return 0;
148 }
149
150 static struct ast_custom_function timeout_function = {
151         .name = "TIMEOUT",
152         .synopsis = "Gets or sets timeouts on the channel. Timeout values are in seconds.",
153         .syntax = "TIMEOUT(timeouttype)",
154         .desc =
155                 "Gets or sets various channel timeouts. The timeouts that can be\n"
156                 "manipulated are:\n" "\n"
157                 "absolute: The absolute maximum amount of time permitted for a call.  A\n"
158                 "          setting of 0 disables the timeout.\n" "\n"
159                 "digit:    The maximum amount of time permitted between digits when the\n"
160                 "          user is typing in an extension.  When this timeout expires,\n"
161                 "          after the user has started to type in an extension, the\n"
162                 "          extension will be considered complete, and will be\n"
163                 "          interpreted.  Note that if an extension typed in is valid,\n"
164                 "          it will not have to timeout to be tested, so typically at\n"
165                 "          the expiry of this timeout, the extension will be considered\n"
166                 "          invalid (and thus control would be passed to the 'i'\n"
167                 "          extension, or if it doesn't exist the call would be\n"
168                 "          terminated).  The default timeout is 5 seconds.\n" "\n"
169                 "response: The maximum amount of time permitted after falling through a\n"
170                 "          series of priorities for a channel in which the user may\n"
171                 "          begin typing an extension.  If the user does not type an\n"
172                 "          extension in this amount of time, control will pass to the\n"
173                 "          't' extension if it exists, and if not the call would be\n"
174                 "          terminated.  The default timeout is 10 seconds.\n",
175         .read = timeout_read,
176         .write = timeout_write,
177 };
178
179 static int unload_module(void)
180 {
181         return ast_custom_function_unregister(&timeout_function);
182 }
183
184 static int load_module(void)
185 {
186         return ast_custom_function_register(&timeout_function);
187 }
188
189 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Channel timeout dialplan functions");