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 (!chan)
  50                 return -1;
  51
  52         if (!data) {
  53                 ast_log(LOG_ERROR, "Must specify type of timeout to get.\n");
  54                 return -1;
  55         }
  56
  57         switch (*data) {
  58         case 'a':
  59         case 'A':
  60                 if (chan->whentohangup == 0) {
  61                         ast_copy_string(buf, "0", len);
  62                 } else {
  63                         time(&myt);
  64                         snprintf(buf, len, "%d", (int) (chan->whentohangup - myt));
  65                 }
  66                 break;
  67
  68         case 'r':
  69         case 'R':
  70                 if (chan->pbx) {
  71                         snprintf(buf, len, "%d", chan->pbx->rtimeout);
  72                 }
  73                 break;
  74
  75         case 'd':
  76         case 'D':
  77                 if (chan->pbx) {
  78                         snprintf(buf, len, "%d", chan->pbx->dtimeout);
  79                 }
  80                 break;
  81
  82         default:
  83                 ast_log(LOG_ERROR, "Unknown timeout type specified.\n");
  84                 break;
  85         }
  86
  87         return 0;
  88 }
  89
  90 static int timeout_write(struct ast_channel *chan, const char *cmd, char *data,
  91                          const char *value)
  92 {
  93         int x;
  94         char timestr[64];
  95         struct ast_tm myt;
  96
  97         if (!chan)
  98                 return -1;
  99
 100         if (!data) {
 101                 ast_log(LOG_ERROR, "Must specify type of timeout to set.\n");
 102                 return -1;
 103         }
 104
 105         if (!value)
 106                 return -1;
 107
 108         x = atoi(value);
 109
 110         switch (*data) {
 111         case 'a':
 112         case 'A':
 113                 ast_channel_setwhentohangup(chan, x);
 114                         if (chan->whentohangup) {
 115                                 struct timeval tv = { chan->whentohangup, 0 };
 116                                 ast_strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S.%3q %Z",
 117                                         ast_localtime(&tv, &myt, NULL));
 118                         ast_verb(3, "Channel will hangup at %s.\n", timestr);
 119                         } else {
 120                         ast_verb(3, "Channel hangup cancelled.\n");
 121                         }
 122                 break;
 123
 124         case 'r':
 125         case 'R':
 126                 if (chan->pbx) {
 127                         chan->pbx->rtimeout = x;
 128                         ast_verb(3, "Response timeout set to %d\n", chan->pbx->rtimeout);
 129                 }
 130                 break;
 131
 132         case 'd':
 133         case 'D':
 134                 if (chan->pbx) {
 135                         chan->pbx->dtimeout = x;
 136                         ast_verb(3, "Digit timeout set to %d\n", 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");