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