major dialplan functions update

deprecate LANGUAGE() and MUSICCLASS(), in favor of CHANNEL()


git-svn-id: http://svn.digium.com/svn/asterisk/trunk@9674 f38db490-d61c-443f-a65b-d21fe96a405b

1 files changed, 152 insertions, 0 deletions

diff --git a/funcs/func_channel.c b/funcs/func_channel.c
new file mode 100644
index 000000000..82fbd639b
--- /dev/null
+++ b/funcs/func_channel.c
@@ -0,0 +1,152 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 2006, Digium, Inc.
+ *
+ * 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 Channel info dialplan function
+ *
+ * \author Kevin P. Fleming <kpfleming@digium.com>
+ * 
+ */
+
+#include <stdlib.h>
+#include <string.h>
+#include <sys/types.h>
+
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision:  $")
+#include "asterisk/module.h"
+#include "asterisk/channel.h"
+#include "asterisk/pbx.h"
+#include "asterisk/logger.h"
+#include "asterisk/utils.h"
+#include "asterisk/app.h"
+#include "asterisk/indications.h"
+#include "asterisk/stringfields.h"
+#define locked_copy_string(chan, dest, source, len) \
+	do { \
+		ast_mutex_lock(&chan->lock); \
+		ast_copy_string(dest, source, len); \
+		ast_mutex_unlock(&chan->lock); \
+	} while (0)
+#define locked_string_field_set(chan, field, source) \
+	do { \
+		ast_mutex_lock(&chan->lock); \
+		ast_string_field_set(chan, field, source); \
+		ast_mutex_unlock(&chan->lock); \
+	} while (0)
+
+static int func_channel_read(struct ast_channel *chan, char *function,
+			     char *data, char *buf, size_t len)
+{
+	int ret = 0;
+
+	if (!strcasecmp(data, "audionativeformat"))
+		/* use the _multiple version when chan->nativeformats holds multiple formats */
+		/* ast_getformatname_multiple(buf, len, chan->nativeformats & AST_FORMAT_AUDIO_MASK); */
+		ast_copy_string(buf, ast_getformatname(chan->nativeformats & AST_FORMAT_AUDIO_MASK), len);
+	else if (!strcasecmp(data, "videonativeformat"))
+		/* use the _multiple version when chan->nativeformats holds multiple formats */
+		/* ast_getformatname_multiple(buf, len, chan->nativeformats & AST_FORMAT_VIDEO_MASK); */
+		ast_copy_string(buf, ast_getformatname(chan->nativeformats & AST_FORMAT_VIDEO_MASK), len);
+	else if (!strcasecmp(data, "audioreadformat"))
+		ast_copy_string(buf, ast_getformatname(chan->readformat), len);
+	else if (!strcasecmp(data, "audiowriteformat"))
+		ast_copy_string(buf, ast_getformatname(chan->writeformat), len);
+	else if (!strcasecmp(data, "tonezone") && chan->zone)
+		locked_copy_string(chan, buf, chan->zone->country, len);
+	else if (!strcasecmp(data, "language"))
+		locked_copy_string(chan, buf, chan->language, len);
+	else if (!strcasecmp(data, "musicclass"))
+		locked_copy_string(chan, buf, chan->musicclass, len);
+	else if (!chan->tech->func_channel_read
+		 || chan->tech->func_channel_read(chan, function, data, buf, len)) {
+		ast_log(LOG_WARNING, "Unknown or unavailable item requested: '%s'\n", data);
+		ret = -1;
+	}
+
+	return ret;
+}
+
+static int func_channel_write(struct ast_channel *chan, char *function,
+			      char *data, const char *value)
+{
+	int ret = 0;
+
+	if (!strcasecmp(data, "language"))
+		locked_string_field_set(chan, language, value);
+	else if (!strcasecmp(data, "musicclass"))
+		locked_string_field_set(chan, musicclass, value);
+	else if (!chan->tech->func_channel_write
+		 || chan->tech->func_channel_write(chan, function, data, value)) {
+		ast_log(LOG_WARNING, "Unknown or unavailable item requested: '%s'\n",
+				data);
+		ret = -1;
+	}
+
+	return ret;
+}
+
+static struct ast_custom_function channel_function = {
+	.name = "CHANNEL",
+	.synopsis = "Gets/sets various pieces of information about the channel.",
+	.syntax = "CHANNEL(item)",
+	.desc = "Gets/set various pieces of information about the channel.\n"
+		"Standard items (provided by all channel technologies) are:\n"
+		"R/O	audioreadformat		format currently being read\n"
+		"R/O	audionativeformat 	format used natively for audio\n"
+		"R/O	audiowriteformat 	format currently being written\n"
+		"R/W	language 		language for sounds played\n"
+		"R/W	musicclass 		class (from musiconhold.conf) for hold music\n"
+		"R/O	tonezone 		zone for indications played\n"
+		"R/O	videonativeformat 	format used natively for video\n"
+		"\n"
+		"Additional items may be available from the channel driver providing\n"
+		"the channel; see its documentation for details.\n"
+		"\n"
+		"Any item requested that is not available on the current channel will\n"
+		"return an empty string.\n",
+	.read = func_channel_read,
+	.write = func_channel_write,
+};
+
+static char *tdesc = "Channel information dialplan function";
+
+int unload_module(void)
+{
+	return ast_custom_function_unregister(&channel_function);
+}
+
+int load_module(void)
+{
+	return ast_custom_function_register(&channel_function);
+}
+
+char *description(void)
+{
+	return tdesc;
+}
+
+int usecount(void)
+{
+	return 0;
+}
+
+char *key()
+{
+	return ASTERISK_GPL_KEY;
+}