[asterisk-commits] russell: trunk r81813 - in /trunk: CHANGES funcs/func_extstate.c

[SVN commits to the Asterisk project]

Author: russell
Date: Thu Sep  6 15:54:07 2007
New Revision: 81813

URL: http://svn.digium.com/view/asterisk?view=rev&rev=81813
Log:
Add EXTENSION_STATE() function that can retrieve the state of an extension that
has a hint.

(closes issue #10635, adamgundy)

Added:
    trunk/funcs/func_extstate.c   (with props)
Modified:
    trunk/CHANGES

Modified: trunk/CHANGES
URL: http://svn.digium.com/view/asterisk/trunk/CHANGES?view=diff&rev=81813&r1=81812&r2=81813
==============================================================================
--- trunk/CHANGES (original)
+++ trunk/CHANGES Thu Sep  6 15:54:07 2007
@@ -42,6 +42,8 @@
     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
 -----------

Added: trunk/funcs/func_extstate.c
URL: http://svn.digium.com/view/asterisk/trunk/funcs/func_extstate.c?view=auto&rev=81813
==============================================================================
--- trunk/funcs/func_extstate.c (added)
+++ trunk/funcs/func_extstate.c Thu Sep  6 15:54:07 2007
@@ -1,0 +1,135 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 2007, Digium, Inc.
+ *
+ * Modified from func_devstate.c by Russell Bryant <russell at digium.com> 
+ * Adam Gundy <adam at 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 at 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 at default has state ${EXTENSION_STATE(1234)})\n"
+	"   NoOp(4567 at home has state ${EXTENSION_STATE(4567 at 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");

Propchange: trunk/funcs/func_extstate.c
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: trunk/funcs/func_extstate.c
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Propchange: trunk/funcs/func_extstate.c
------------------------------------------------------------------------------
    svn:mime-type = text/plain