build function modules independently (no more pbx_functions.so)
[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  * \author Mark Spencer <markster@digium.com> 
24  */
25
26 #include <stdlib.h>
27 #include <stdio.h>
28 #include <string.h>
29 #include <sys/types.h>
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/module.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/utils.h"
40 #include "asterisk/app.h"
41 #include "asterisk/options.h"
42
43 static char *timeout_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
44 {
45         time_t myt;
46
47         if (!data) {
48                 ast_log(LOG_ERROR, "Must specify type of timeout to get.");
49                 return NULL;
50         }
51         
52         switch(*data) {
53         case 'a':
54         case 'A':
55                 if (chan->whentohangup == 0) {
56                         ast_copy_string(buf, "0", len);
57                 } else {
58                         time(&myt);
59                         snprintf(buf, len, "%d", (int) (chan->whentohangup - myt));
60                 }
61                 break;
62
63         case 'r':
64         case 'R':
65                 if (chan->pbx) {
66                         snprintf(buf, len, "%d", chan->pbx->rtimeout);
67                 }
68                 break;
69
70         case 'd':
71         case 'D':
72                 if (chan->pbx) {
73                         snprintf(buf, len, "%d", chan->pbx->dtimeout);
74                 }
75                 break;
76
77         default:
78                 ast_log(LOG_ERROR, "Unknown timeout type specified.");
79                 break;
80         }
81
82         return buf;
83 }
84
85 static void timeout_write(struct ast_channel *chan, char *cmd, char *data, const char *value) 
86 {
87         int x;
88         char timestr[64];
89         struct tm myt;
90
91         if (!data) {
92                 ast_log(LOG_ERROR, "Must specify type of timeout to set.");
93                 return;
94         }
95         
96         if (!value)
97                 return;
98
99         x = atoi(value);
100
101         switch(*data) {
102         case 'a':
103         case 'A':
104                 ast_channel_setwhentohangup(chan, x);
105                 if (option_verbose > 2) {
106                         if (chan->whentohangup) {
107                                 strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S UTC", gmtime_r(&chan->whentohangup, &myt));
108                                 ast_verbose( VERBOSE_PREFIX_3 "Channel will hangup at %s.\n", timestr);
109                         } else {
110                                 ast_verbose( VERBOSE_PREFIX_3 "Channel hangup cancelled.\n");
111                         } 
112                 }
113                 break;
114
115         case 'r':
116         case 'R':
117                 if (chan->pbx) {
118                         chan->pbx->rtimeout = x;
119                         if (option_verbose > 2)
120                                 ast_verbose( VERBOSE_PREFIX_3 "Response timeout set to %d\n", chan->pbx->rtimeout);
121                 }
122                 break;
123
124         case 'd':
125         case 'D':
126                 if (chan->pbx) {
127                         chan->pbx->dtimeout = x;
128                         if (option_verbose > 2)
129                                 ast_verbose( VERBOSE_PREFIX_3 "Digit timeout set to %d\n", chan->pbx->dtimeout);
130                 }
131                 break;
132
133         default:
134                 ast_log(LOG_ERROR, "Unknown timeout type specified.");
135                 break;
136         }
137 }
138
139 static 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 = timeout_read,
167         .write = timeout_write,
168 };
169
170 static char *tdesc = "Channel timeout dialplan functions";
171
172 int unload_module(void)
173 {
174         return ast_custom_function_unregister(&timeout_function);
175 }
176
177 int load_module(void)
178 {
179         return ast_custom_function_register(&timeout_function);
180 }
181
182 char *description(void)
183 {
184         return tdesc;
185 }
186
187 int usecount(void)
188 {
189         return 0;
190 }
191
192 char *key()
193 {
194         return ASTERISK_GPL_KEY;
195 }
196
197 /*
198 Local Variables:
199 mode: C
200 c-file-style: "linux"
201 indent-tabs-mode: nil
202 End:
203 */