Add Masquerade manager event which trips when a masquerade happens (issue #7840 repor...
[asterisk/asterisk.git] / funcs / func_groupcount.c
old mode 100755 (executable)
new mode 100644 (file)
index 66a7367..ed96e34
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
- * Channel group related dialplan functions
- * 
- * Copyright (C) 2005, Digium, Inc.
+ * Copyright (C) 1999 - 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
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
  */
 
-#include <stdlib.h>
-#include <string.h>
-#include <sys/types.h>
+/*! \file
+ *
+ * \brief Channel group related dialplan functions
+ * 
+ */
 
 #include "asterisk.h"
 
-/* ASTERISK_FILE_VERSION(__FILE__, "$Revision$") */
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <sys/types.h>
 
+#include "asterisk/module.h"
 #include "asterisk/channel.h"
 #include "asterisk/pbx.h"
 #include "asterisk/logger.h"
 #include "asterisk/utils.h"
 #include "asterisk/app.h"
 
-static char *group_count_function_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
+static int group_count_function_read(struct ast_channel *chan, char *cmd,
+                                    char *data, char *buf, size_t len)
 {
        int count;
        char group[80] = "";
        char category[80] = "";
-       char *grp;
+       const char *grp;
 
-       ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category));
+       ast_app_group_split_group(data, group, sizeof(group), category,
+                                 sizeof(category));
 
        if (ast_strlen_zero(group)) {
                if ((grp = pbx_builtin_getvar_helper(chan, category)))
                        ast_copy_string(group, grp, sizeof(group));
                else
-                       return buf;
+                       ast_log(LOG_NOTICE, "No group could be found for channel '%s'\n",
+                               chan->name);
        }
 
        count = ast_app_group_get_count(group, category);
        snprintf(buf, len, "%d", count);
 
-       return buf;
+       return 0;
 }
 
-#ifndef BUILTIN_FUNC
-static
-#endif
-struct ast_custom_function group_count_function = {
+static struct ast_custom_function group_count_function = {
        .name = "GROUP_COUNT",
        .syntax = "GROUP_COUNT([groupname][@category])",
        .synopsis = "Counts the number of channels in the specified group",
-       .desc = "Calculates the group count for the specified group, or uses the\n"
-       "channel's current group if not specifed (and non-empty).\n",
+       .desc =
+               "Calculates the group count for the specified group, or uses the\n"
+               "channel's current group if not specifed (and non-empty).\n",
        .read = group_count_function_read,
 };
 
-static char *group_match_count_function_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
+static int group_match_count_function_read(struct ast_channel *chan,
+                                          char *cmd, char *data, char *buf,
+                                          size_t len)
 {
        int count;
        char group[80] = "";
        char category[80] = "";
 
-       ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category));
+       ast_app_group_split_group(data, group, sizeof(group), category,
+                                 sizeof(category));
 
        if (!ast_strlen_zero(group)) {
                count = ast_app_group_match_get_count(group, category);
                snprintf(buf, len, "%d", count);
        }
 
-       return buf;
+       return 0;
 }
 
-#ifndef BUILTIN_FUNC
-static
-#endif
-struct ast_custom_function group_match_count_function = {
+static struct ast_custom_function group_match_count_function = {
        .name = "GROUP_MATCH_COUNT",
        .syntax = "GROUP_MATCH_COUNT(groupmatch[@category])",
-       .synopsis = "Counts the number of channels in the groups matching the specified pattern",
-       .desc = "Calculates the group count for all groups that match the specified pattern.\n"
-       "Uses standard regular expression matching (see regex(7)).\n",
+       .synopsis =
+               "Counts the number of channels in the groups matching the specified pattern",
+       .desc =
+               "Calculates the group count for all groups that match the specified pattern.\n"
+               "Uses standard regular expression matching (see regex(7)).\n",
        .read = group_match_count_function_read,
        .write = NULL,
 };
 
-static char *group_function_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
+static int group_function_read(struct ast_channel *chan, char *cmd,
+                              char *data, char *buf, size_t len)
 {
        char varname[256];
-       char *group;
+       const char *group;
 
-       if (data && !ast_strlen_zero(data)) {
-               snprintf(varname, sizeof(varname), "%s_%s", GROUP_CATEGORY_PREFIX, data);
+       if (!ast_strlen_zero(data)) {
+               snprintf(varname, sizeof(varname), "%s_%s", GROUP_CATEGORY_PREFIX,
+                        data);
        } else {
                ast_copy_string(varname, GROUP_CATEGORY_PREFIX, sizeof(varname));
        }
@@ -101,27 +119,28 @@ static char *group_function_read(struct ast_channel *chan, char *cmd, char *data
        if (group)
                ast_copy_string(buf, group, len);
 
-       return buf;
+       return 0;
 }
 
-static void group_function_write(struct ast_channel *chan, char *cmd, char *data, const char *value)
+static int group_function_write(struct ast_channel *chan, char *cmd,
+                               char *data, const char *value)
 {
        char grpcat[256];
 
-       if (data && !ast_strlen_zero(data)) {
-               snprintf(grpcat, sizeof(grpcat), "%s@%s", data, value);
+       if (!ast_strlen_zero(data)) {
+               snprintf(grpcat, sizeof(grpcat), "%s@%s", value, data);
        } else {
                ast_copy_string(grpcat, value, sizeof(grpcat));
        }
 
-        if (ast_app_group_set_channel(chan, grpcat))
-                ast_log(LOG_WARNING, "Setting a group requires an argument (group name)\n");
+       if (ast_app_group_set_channel(chan, grpcat))
+               ast_log(LOG_WARNING,
+                               "Setting a group requires an argument (group name)\n");
+
+       return 0;
 }
 
-#ifndef BUILTIN_FUNC
-static
-#endif
-struct ast_custom_function group_function = {
+static struct ast_custom_function group_function = {
        .name = "GROUP",
        .syntax = "GROUP([category])",
        .synopsis = "Gets or sets the channel group.",
@@ -130,39 +149,44 @@ struct ast_custom_function group_function = {
        .write = group_function_write,
 };
 
-static char *group_list_function_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
+static int group_list_function_read(struct ast_channel *chan, char *cmd,
+                                   char *data, char *buf, size_t len)
 {
        struct ast_var_t *current;
        struct varshead *headp;
        char tmp1[1024] = "";
        char tmp2[1024] = "";
 
-       headp=&chan->varshead;
-       AST_LIST_TRAVERSE(headp,current,entries) {
+       headp = &chan->varshead;
+       AST_LIST_TRAVERSE(headp, current, entries) {
                if (!strncmp(ast_var_name(current), GROUP_CATEGORY_PREFIX "_", strlen(GROUP_CATEGORY_PREFIX) + 1)) {
                        if (!ast_strlen_zero(tmp1)) {
                                ast_copy_string(tmp2, tmp1, sizeof(tmp2));
-                               snprintf(tmp1, sizeof(tmp1), "%s %s@%s", tmp2, ast_var_value(current), (ast_var_name(current) + strlen(GROUP_CATEGORY_PREFIX) + 1));
+                               snprintf(tmp1, sizeof(tmp1), "%s %s@%s", tmp2,
+                                        ast_var_value(current),
+                                        (ast_var_name(current) +
+                                         strlen(GROUP_CATEGORY_PREFIX) + 1));
                        } else {
-                               snprintf(tmp1, sizeof(tmp1), "%s@%s", ast_var_value(current), (ast_var_name(current) + strlen(GROUP_CATEGORY_PREFIX) + 1));
+                               snprintf(tmp1, sizeof(tmp1), "%s@%s", ast_var_value(current),
+                                        (ast_var_name(current) +
+                                         strlen(GROUP_CATEGORY_PREFIX) + 1));
                        }
                } else if (!strcmp(ast_var_name(current), GROUP_CATEGORY_PREFIX)) {
                        if (!ast_strlen_zero(tmp1)) {
                                ast_copy_string(tmp2, tmp1, sizeof(tmp2));
-                               snprintf(tmp1, sizeof(tmp1), "%s %s", tmp2, ast_var_value(current));
+                               snprintf(tmp1, sizeof(tmp1), "%s %s", tmp2,
+                                        ast_var_value(current));
                        } else {
                                snprintf(tmp1, sizeof(tmp1), "%s", ast_var_value(current));
                        }
                }
        }
        ast_copy_string(buf, tmp1, len);
-       return buf;
+
+       return 0;
 }
 
-#ifndef BUILTIN_FUNC
-static
-#endif
-struct ast_custom_function group_list_function = {
+static struct ast_custom_function group_list_function = {
        .name = "GROUP_LIST",
        .syntax = "GROUP_LIST()",
        .synopsis = "Gets a list of the groups set on a channel.",
@@ -171,10 +195,28 @@ struct ast_custom_function group_list_function = {
        .write = NULL,
 };
 
-/*
-Local Variables:
-mode: C
-c-file-style: "linux"
-indent-tabs-mode: nil
-End:
-*/
+static int unload_module(void)
+{
+       int res = 0;
+
+       res |= ast_custom_function_unregister(&group_count_function);
+       res |= ast_custom_function_unregister(&group_match_count_function);
+       res |= ast_custom_function_unregister(&group_list_function);
+       res |= ast_custom_function_unregister(&group_function);
+
+       return res;
+}
+
+static int load_module(void)
+{
+       int res = 0;
+
+       res |= ast_custom_function_register(&group_count_function);
+       res |= ast_custom_function_register(&group_match_count_function);
+       res |= ast_custom_function_register(&group_list_function);
+       res |= ast_custom_function_register(&group_function);
+
+       return res;
+}
+
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Channel group dialplan functions");