d7d5cf4efd08b4249f10ef941ea0fb09ba62d579
[asterisk/asterisk.git] / funcs / func_timeout.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, 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  */
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/options.h"
39
40 static char *builtin_function_timeout_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
41 {
42         time_t myt;
43
44         if (!data) {
45                 ast_log(LOG_ERROR, "Must specify type of timeout to get.");
46                 return NULL;
47         }
48         
49         switch(*data) {
50         case 'a':
51         case 'A':
52                 if (chan->whentohangup == 0) {
53                         ast_copy_string(buf, "0", len);
54                 } else {
55                         time(&myt);
56                         snprintf(buf, len, "%d", (int) (chan->whentohangup - myt));
57                 }
58                 break;
59
60         case 'r':
61         case 'R':
62                 if (chan->pbx) {
63                         snprintf(buf, len, "%d", chan->pbx->rtimeout);
64                 }
65                 break;
66
67         case 'd':
68         case 'D':
69                 if (chan->pbx) {
70                         snprintf(buf, len, "%d", chan->pbx->dtimeout);
71                 }
72                 break;
73
74         default:
75                 ast_log(LOG_ERROR, "Unknown timeout type specified.");
76                 break;
77         }
78
79         return buf;
80 }
81
82 static void builtin_function_timeout_write(struct ast_channel *chan, char *cmd, char *data, const char *value) 
83 {
84         int x;
85         char timestr[64];
86         struct tm myt;
87
88         if (!data) {
89                 ast_log(LOG_ERROR, "Must specify type of timeout to set.");
90                 return;
91         }
92         
93         if (!value)
94                 return;
95
96         x = atoi(value);
97
98         switch(*data) {
99         case 'a':
100         case 'A':
101                 ast_channel_setwhentohangup(chan, x);
102                 if (option_verbose > 2) {
103                         if (chan->whentohangup) {
104                                 strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S UTC", gmtime_r(&chan->whentohangup, &myt));
105                                 ast_verbose( VERBOSE_PREFIX_3 "Channel will hangup at %s.\n", timestr);
106                         } else {
107                                 ast_verbose( VERBOSE_PREFIX_3 "Channel hangup cancelled.\n");
108                         } 
109                 }
110                 break;
111
112         case 'r':
113         case 'R':
114                 if (chan->pbx) {
115                         chan->pbx->rtimeout = x;
116                         if (option_verbose > 2)
117                                 ast_verbose( VERBOSE_PREFIX_3 "Response timeout set to %d\n", chan->pbx->rtimeout);
118                 }
119                 break;
120
121         case 'd':
122         case 'D':
123                 if (chan->pbx) {
124                         chan->pbx->dtimeout = x;
125                         if (option_verbose > 2)
126                                 ast_verbose( VERBOSE_PREFIX_3 "Digit timeout set to %d\n", chan->pbx->dtimeout);
127                 }
128                 break;
129
130         default:
131                 ast_log(LOG_ERROR, "Unknown timeout type specified.");
132                 break;
133         }
134 }
135
136 #ifndef BUILTIN_FUNC
137 static
138 #endif
139 struct ast_custom_function timeout_function = {
140         .name = "TIMEOUT",
141         .synopsis = "Gets or sets timeouts on the channel.",
142         .syntax = "TIMEOUT(timeouttype)",
143         .desc = "Gets or sets various channel timeouts. The timeouts that can be\n"
144         "manipulated are:\n"
145         "\n"
146         "absolute: The absolute maximum amount of time permitted for a call.  A\n"
147         "          setting of 0 disables the timeout.\n"
148         "\n"
149         "digit:    The maximum amount of time permitted between digits when the\n"
150         "          user is typing in an extension.  When this timeout expires,\n"
151         "          after the user has started to type in an extension, the\n"
152         "          extension will be considered complete, and will be\n"
153         "          interpreted.  Note that if an extension typed in is valid,\n"
154         "          it will not have to timeout to be tested, so typically at\n"
155         "          the expiry of this timeout, the extension will be considered\n"
156         "          invalid (and thus control would be passed to the 'i'\n"
157         "          extension, or if it doesn't exist the call would be\n"
158         "          terminated).  The default timeout is 5 seconds.\n"
159         "\n"
160         "response: The maximum amount of time permitted after falling through a\n"
161         "          series of priorities for a channel in which the user may\n"
162         "          begin typing an extension.  If the user does not type an\n"
163         "          extension in this amount of time, control will pass to the\n"
164         "          't' extension if it exists, and if not the call would be\n"
165         "          terminated.  The default timeout is 10 seconds.\n",
166         .read = builtin_function_timeout_read,
167         .write = builtin_function_timeout_write,
168 };
169
170 /*
171 Local Variables:
172 mode: C
173 c-file-style: "linux"
174 indent-tabs-mode: nil
175 End:
176 */