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