Start untangling header inclusion in a way that does not affect
[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/logger.h"
35 #include "asterisk/utils.h"
36 #include "asterisk/app.h"
37 #include "asterisk/options.h"
38
39 static int timeout_read(struct ast_channel *chan, const char *cmd, char *data,
40                         char *buf, size_t len)
41 {
42         time_t myt;
43
44         if (!chan)
45                 return -1;
46
47         if (!data) {
48                 ast_log(LOG_ERROR, "Must specify type of timeout to get.\n");
49                 return -1;
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.\n");
79                 break;
80         }
81
82         return 0;
83 }
84
85 static int timeout_write(struct ast_channel *chan, const char *cmd, char *data,
86                          const char *value)
87 {
88         int x;
89         char timestr[64];
90         struct ast_tm myt;
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         x = atoi(value);
104         if (x < 0)
105                 x = 0;
106
107         switch (*data) {
108         case 'a':
109         case 'A':
110                 ast_channel_setwhentohangup(chan, x);
111                         if (chan->whentohangup) {
112                                 struct timeval tv = { chan->whentohangup, 0 };
113                                 ast_strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S.%3q %Z",
114                                         ast_localtime(&tv, &myt, NULL));
115                         ast_verb(3, "Channel will hangup at %s.\n", timestr);
116                         } else {
117                         ast_verb(3, "Channel hangup cancelled.\n");
118                         }
119                 break;
120
121         case 'r':
122         case 'R':
123                 if (chan->pbx) {
124                         chan->pbx->rtimeout = x;
125                         ast_verb(3, "Response timeout set to %d\n", chan->pbx->rtimeout);
126                 }
127                 break;
128
129         case 'd':
130         case 'D':
131                 if (chan->pbx) {
132                         chan->pbx->dtimeout = x;
133                         ast_verb(3, "Digit timeout set to %d\n", chan->pbx->dtimeout);
134                 }
135                 break;
136
137         default:
138                 ast_log(LOG_ERROR, "Unknown timeout type specified.\n");
139                 break;
140         }
141
142         return 0;
143 }
144
145 static struct ast_custom_function timeout_function = {
146         .name = "TIMEOUT",
147         .synopsis = "Gets or sets timeouts on the channel. Timeout values are in seconds.",
148         .syntax = "TIMEOUT(timeouttype)",
149         .desc =
150                 "Gets or sets various channel timeouts. The timeouts that can be\n"
151                 "manipulated are:\n" "\n"
152                 "absolute: The absolute maximum amount of time permitted for a call.  A\n"
153                 "          setting of 0 disables the timeout.\n" "\n"
154                 "digit:    The maximum amount of time permitted between digits when the\n"
155                 "          user is typing in an extension.  When this timeout expires,\n"
156                 "          after the user has started to type in an extension, the\n"
157                 "          extension will be considered complete, and will be\n"
158                 "          interpreted.  Note that if an extension typed in is valid,\n"
159                 "          it will not have to timeout to be tested, so typically at\n"
160                 "          the expiry of this timeout, the extension will be considered\n"
161                 "          invalid (and thus control would be passed to the 'i'\n"
162                 "          extension, or if it doesn't exist the call would be\n"
163                 "          terminated).  The default timeout is 5 seconds.\n" "\n"
164                 "response: The maximum amount of time permitted after falling through a\n"
165                 "          series of priorities for a channel in which the user may\n"
166                 "          begin typing an extension.  If the user does not type an\n"
167                 "          extension in this amount of time, control will pass to the\n"
168                 "          't' extension if it exists, and if not the call would be\n"
169                 "          terminated.  The default timeout is 10 seconds.\n",
170         .read = timeout_read,
171         .write = timeout_write,
172 };
173
174 static int unload_module(void)
175 {
176         return ast_custom_function_unregister(&timeout_function);
177 }
178
179 static int load_module(void)
180 {
181         return ast_custom_function_register(&timeout_function);
182 }
183
184 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Channel timeout dialplan functions");