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