funcs/func_dialgroup.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 2007, Tilghman Lesher
   5  *
   6  * Tilghman Lesher <func_dialgroup__200709@the-tilghman.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 Dial group dialplan function
  22  *
  23  * \author Tilghman Lesher <func_dialgroup__200709@the-tilghman.com>
  24  *
  25  * \ingroup functions
  26  */
  27
  28 #include "asterisk.h"
  29
  30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  31
  32 #include <sys/stat.h>
  33
  34 #include "asterisk/module.h"
  35 #include "asterisk/channel.h"
  36 #include "asterisk/pbx.h"
  37 #include "asterisk/utils.h"
  38 #include "asterisk/app.h"
  39 #include "asterisk/astobj2.h"
  40
  41 static struct ao2_container *group_container = NULL;
  42
  43 struct group_entry {
  44         char name[AST_CHANNEL_NAME];
  45 };
  46
  47 struct group {
  48         char name[AST_MAX_EXTENSION];
  49         struct ao2_container *entries;
  50 };
  51
  52 static void group_destroy(void *vgroup)
  53 {
  54         struct group *group = vgroup;
  55         ao2_ref(group->entries, -1);
  56 }
  57
  58 static int group_hash_fn(const void *obj, const int flags)
  59 {
  60         const struct group *g = obj;
  61         return ast_str_hash(g->name);
  62 }
  63
  64 static int group_cmp_fn(void *obj1, void *name2, int flags)
  65 {
  66         struct group *g1 = obj1, *g2 = name2;
  67         char *name = name2;
  68         if (flags & OBJ_POINTER)
  69                 return strcmp(g1->name, g2->name) ? 0 : CMP_MATCH;
  70         else
  71                 return strcmp(g1->name, name) ? 0 : CMP_MATCH;
  72 }
  73
  74 static int entry_hash_fn(const void *obj, const int flags)
  75 {
  76         const struct group_entry *e = obj;
  77         return ast_str_hash(e->name);
  78 }
  79
  80 static int entry_cmp_fn(void *obj1, void *name2, int flags)
  81 {
  82         struct group_entry *e1 = obj1, *e2 = name2;
  83         char *name = name2;
  84         if (flags & OBJ_POINTER)
  85                 return strcmp(e1->name, e2->name) ? 0 : CMP_MATCH;
  86         else
  87                 return strcmp(e1->name, name) ? 0 : CMP_MATCH;
  88 }
  89
  90 static int dialgroup_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
  91 {
  92         struct ao2_iterator i;
  93         struct group *grhead = ao2_find(group_container, data, 0);
  94         struct group_entry *entry;
  95         size_t bufused = 0;
  96         int trunc_warning = 0;
  97
  98         if (!grhead) {
  99                 ast_log(LOG_WARNING, "No such dialgroup '%s'\n", data);
 100                 return -1;
 101         }
 102
 103         i = ao2_iterator_init(grhead->entries, 0);
 104         while ((entry = ao2_iterator_next(&i))) {
 105                 int tmp = strlen(entry->name);
 106                 /* Ensure that we copy only complete names, not partials */
 107                 if (len - bufused > tmp + 2) {
 108                         if (bufused != 0)
 109                                 buf[bufused++] = '&';
 110                         ast_copy_string(buf + bufused, entry->name, len - bufused);
 111                         bufused += tmp;
 112                 } else if (trunc_warning++ == 0)
 113                         ast_log(LOG_WARNING, "Dialgroup '%s' is too large.  Truncating list.\n", data);
 114         }
 115
 116         return 0;
 117 }
 118
 119 static int dialgroup_write(struct ast_channel *chan, const char *cmd, char *data, const char *cvalue)
 120 {
 121         struct group *grhead;
 122         struct group_entry *entry;
 123         int j;
 124         AST_DECLARE_APP_ARGS(args,
 125                 AST_APP_ARG(group);
 126                 AST_APP_ARG(op);
 127         );
 128         AST_DECLARE_APP_ARGS(inter,
 129                 AST_APP_ARG(faces)[100];
 130         );
 131         char *value = ast_strdupa(cvalue);
 132
 133         AST_STANDARD_APP_ARGS(args, data);
 134         AST_NONSTANDARD_APP_ARGS(inter, value, '&');
 135
 136         if (!(grhead = ao2_find(group_container, data, 0))) {
 137                 /* Create group */
 138                 grhead = ao2_alloc(sizeof(*grhead), group_destroy);
 139                 if (!grhead)
 140                         return -1;
 141                 grhead->entries = ao2_container_alloc(37, entry_hash_fn, entry_cmp_fn);
 142                 if (!grhead->entries) {
 143                         ao2_ref(grhead, -1);
 144                         return -1;
 145                 }
 146                 ast_copy_string(grhead->name, args.group, sizeof(grhead->name));
 147                 ao2_link(group_container, grhead);
 148         }
 149
 150         if (ast_strlen_zero(args.op)) {
 151                 /* Wholesale replacement of the group */
 152                 args.op = "add";
 153
 154                 /* Remove all existing */
 155                 ao2_ref(grhead->entries, -1);
 156                 if (!(grhead->entries = ao2_container_alloc(37, entry_hash_fn, entry_cmp_fn)))
 157                         return -1;
 158         }
 159
 160         if (strcasecmp(args.op, "add") == 0) {
 161                 for (j = 0; j < inter.argc; j++) {
 162                         if ((entry = ao2_alloc(sizeof(*entry), NULL))) {
 163                                 ast_copy_string(entry->name, inter.faces[j], sizeof(entry->name));
 164                                 ao2_link(grhead->entries, entry);
 165                         } else
 166                                 ast_log(LOG_WARNING, "Unable to add '%s' to dialgroup '%s'\n", inter.faces[j], grhead->name);
 167                 }
 168         } else if (strncasecmp(args.op, "del", 3) == 0) {
 169                 for (j = 0; j < inter.argc; j++) {
 170                         if ((entry = ao2_find(grhead->entries, inter.faces[j], OBJ_UNLINK)))
 171                                 ao2_ref(entry, -1);
 172                         else
 173                                 ast_log(LOG_WARNING, "Interface '%s' not found in dialgroup '%s'\n", inter.faces[j], grhead->name);
 174                 }
 175         } else
 176                 ast_log(LOG_ERROR, "Unrecognized operation: %s\n", args.op);
 177
 178         return 0;
 179 }
 180
 181 static struct ast_custom_function dialgroup_function = {
 182         .name = "DIALGROUP",
 183         .synopsis = "Manages a group of users for dialing",
 184         .syntax = "DIALGROUP(<group>[,op])",
 185         .desc =
 186 "  DIALGROUP presents an interface meant to be used in concert with the Dial\n"
 187 "application, by presenting a list of channels which should be dialled when\n"
 188 "referenced.\n"
 189 "  When DIALGROUP is read from, the argument is interpreted as the particular\n"
 190 "group for which a dial should be attempted.  When DIALGROUP is written to\n"
 191 "with no arguments, the entire list is replaced with the argument specified.\n"
 192 "Other operations are as follows:\n"
 193 "  add - add a channel name or interface (write-only)\n"
 194 "  del - remove a channel name or interface (write-only)\n\n"
 195 "Functionality is similar to a queue, except that when no interfaces are\n"
 196 "available, execution may continue in the dialplan.  This is useful when\n"
 197 "you want certain people to be the first to answer any calls, with immediate\n"
 198 "fallback to a queue when the front line people are busy or unavailable, but\n"
 199 "you still want front line people to log in and out of that group, just like\n"
 200 "a queue.\n",
 201         .read = dialgroup_read,
 202         .write = dialgroup_write,
 203 };
 204
 205 static int unload_module(void)
 206 {
 207         int res = ast_custom_function_unregister(&dialgroup_function);
 208         ao2_ref(group_container, -1);
 209         return res;
 210 }
 211
 212 static int load_module(void)
 213 {
 214         if ((group_container = ao2_container_alloc(37, group_hash_fn, group_cmp_fn)))
 215                 return ast_custom_function_register(&dialgroup_function);
 216         else
 217                 return AST_MODULE_LOAD_DECLINE;
 218 }
 219
 220 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Dialgroup dialplan function");