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