Add EXTENSION_STATE() function that can retrieve the state of an extension that
authorRussell Bryant <russell@russellbryant.com>
Thu, 6 Sep 2007 20:54:07 +0000 (20:54 +0000)
committerRussell Bryant <russell@russellbryant.com>
Thu, 6 Sep 2007 20:54:07 +0000 (20:54 +0000)
has a hint.

(closes issue #10635, adamgundy)

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@81813 65c4cc65-6c06-0410-ace0-fbb531ad65f3

CHANGES
funcs/func_extstate.c [new file with mode: 0644]

diff --git a/CHANGES b/CHANGES
index 1c1d778..a724ac6 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -42,6 +42,8 @@ Dialplan functions
     Hints are mappings between extensions and devices for the sake of 
     determining the state of an extension.  This function can retrieve the list
     of devices or the name associated with a hint.
+  * Added EXTENSION_STATE() dialplan function which allows retrieving the state
+    of any extension.
 
 CLI Changes
 -----------
diff --git a/funcs/func_extstate.c b/funcs/func_extstate.c
new file mode 100644 (file)
index 0000000..69c2fe8
--- /dev/null
@@ -0,0 +1,135 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 2007, Digium, Inc.
+ *
+ * Modified from func_devstate.c by Russell Bryant <russell@digium.com> 
+ * Adam Gundy <adam@starsilk.net>
+
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
+ * This program is free software, distributed under the terms of
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*! \file
+ *
+ * \brief Get the state of a hinted extension for dialplan control
+ *
+ * \author Adam Gundy <adam@starsilk.net> 
+ *
+ * \ingroup functions
+ */
+
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
+#include <stdlib.h>
+
+#include "asterisk/module.h"
+#include "asterisk/channel.h"
+#include "asterisk/pbx.h"
+#include "asterisk/utils.h"
+#include "asterisk/devicestate.h"
+
+static const char *ast_extstate_str(int state)
+{
+       const char *res = "UNKNOWN";
+
+       switch (state) {
+       case AST_EXTENSION_NOT_INUSE:
+               res = "NOT_INUSE";
+               break;
+       case AST_EXTENSION_INUSE:
+               res = "INUSE";
+               break;
+       case AST_EXTENSION_BUSY:
+               res = "BUSY";
+               break;
+       case AST_EXTENSION_UNAVAILABLE:
+               res = "UNAVAILABLE";
+               break;
+       case AST_EXTENSION_RINGING:
+               res = "RINGING";
+               break;
+       case AST_EXTENSION_INUSE | AST_EXTENSION_RINGING:
+               res = "RINGINUSE";
+               break;
+       case AST_EXTENSION_INUSE | AST_EXTENSION_ONHOLD:
+               res = "HOLDINUSE";
+               break;
+       case AST_EXTENSION_ONHOLD:
+               res = "ONHOLD";
+               break;
+       }
+
+       return res;
+}
+
+static int extstate_read(struct ast_channel *chan, const char *cmd, char *data,
+       char *buf, size_t len)
+{
+       char *exten, *context;
+
+       if (ast_strlen_zero(data)) {
+               ast_log(LOG_WARNING, "EXTENSION_STATE requires an extension\n");
+               return -1;
+       }
+
+       context = exten = data;
+       strsep(&context, "@");
+       if (ast_strlen_zero(context))
+               context = "default";
+
+       if (ast_strlen_zero(exten)) {
+               ast_log(LOG_WARNING, "EXTENSION_STATE requires an extension\n");
+               return -1;
+       }
+
+       ast_copy_string(buf, 
+               ast_extstate_str(ast_extension_state(chan, context, exten)), len);
+
+       return 0;
+}
+
+static struct ast_custom_function extstate_function = {
+       .name = "EXTENSION_STATE",
+       .synopsis = "Get an extension's state",
+       .syntax = "EXTENSION_STATE(extension[@context])",
+       .desc =
+       "  The EXTENSION_STATE function can be used to retrieve the state from any\n"
+       "hinted extension.  For example:\n"
+       "   NoOp(1234@default has state ${EXTENSION_STATE(1234)})\n"
+       "   NoOp(4567@home has state ${EXTENSION_STATE(4567@home)})\n"
+       "\n"
+       "  The possible values returned by this function are:\n"
+       "UNKNOWN | NOT_INUSE | INUSE | BUSY | INVALID | UNAVAILABLE | RINGING\n"
+       "RINGINUSE | HOLDINUSE | ONHOLD\n",
+       .read = extstate_read,
+};
+
+static int unload_module(void)
+{
+       int res;
+
+       res = ast_custom_function_unregister(&extstate_function);
+
+       return res;
+}
+
+static int load_module(void)
+{
+       int res;
+
+       res = ast_custom_function_register(&extstate_function);
+
+       return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
+}
+
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Gets an extension's state in the dialplan");