Persist DIALGROUP() values in astdb
[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 <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 #include "asterisk/astdb.h"
41
42 static struct ao2_container *group_container = NULL;
43
44 struct group_entry {
45         char name[AST_CHANNEL_NAME];
46 };
47
48 struct group {
49         char name[AST_MAX_EXTENSION];
50         struct ao2_container *entries;
51 };
52
53 static void group_destroy(void *vgroup)
54 {
55         struct group *group = vgroup;
56         ao2_ref(group->entries, -1);
57 }
58
59 static int group_hash_fn(const void *obj, const int flags)
60 {
61         const struct group *g = obj;
62         return ast_str_hash(g->name);
63 }
64
65 static int group_cmp_fn(void *obj1, void *name2, int flags)
66 {
67         struct group *g1 = obj1, *g2 = name2;
68         char *name = name2;
69         if (flags & OBJ_POINTER)
70                 return strcmp(g1->name, g2->name) ? 0 : CMP_MATCH;
71         else
72                 return strcmp(g1->name, name) ? 0 : CMP_MATCH;
73 }
74
75 static int entry_hash_fn(const void *obj, const int flags)
76 {
77         const struct group_entry *e = obj;
78         return ast_str_hash(e->name);
79 }
80
81 static int entry_cmp_fn(void *obj1, void *name2, int flags)
82 {
83         struct group_entry *e1 = obj1, *e2 = name2;
84         char *name = name2;
85         if (flags & OBJ_POINTER)
86                 return strcmp(e1->name, e2->name) ? 0 : CMP_MATCH;
87         else
88                 return strcmp(e1->name, name) ? 0 : CMP_MATCH;
89 }
90
91 static int dialgroup_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
92 {
93         struct ao2_iterator i;
94         struct group *grhead = ao2_find(group_container, data, 0);
95         struct group_entry *entry;
96         size_t bufused = 0;
97         int trunc_warning = 0;
98         int res = 0;
99
100         if (!grhead) {
101                 if (!ast_strlen_zero(cmd)) {
102                         ast_log(LOG_WARNING, "No such dialgroup '%s'\n", data);
103                 }
104                 return -1;
105         }
106
107         buf[0] = '\0';
108
109         i = ao2_iterator_init(grhead->entries, OBJ_POINTER);
110         while ((entry = ao2_iterator_next(&i))) {
111                 int tmp = strlen(entry->name);
112                 /* Ensure that we copy only complete names, not partials */
113                 if (len - bufused > tmp + 2) {
114                         if (bufused != 0)
115                                 buf[bufused++] = '&';
116                         ast_copy_string(buf + bufused, entry->name, len - bufused);
117                         bufused += tmp;
118                 } else if (trunc_warning++ == 0) {
119                         if (!ast_strlen_zero(cmd)) {
120                                 ast_log(LOG_WARNING, "Dialgroup '%s' is too large.  Truncating list.\n", data);
121                         } else {
122                                 res = 1;
123                                 ao2_ref(entry, -1);
124                                 break;
125                         }
126                 }
127                 ao2_ref(entry, -1);
128         }
129
130         return res;
131 }
132
133 static int dialgroup_refreshdb(struct ast_channel *chan, const char *cdialgroup)
134 {
135         int len = 500, res = 0;
136         char *buf = NULL;
137         char *dialgroup = ast_strdupa(cdialgroup);
138
139         do {
140                 len *= 2;
141                 buf = ast_realloc(buf, len);
142
143                 if ((res = dialgroup_read(chan, "", dialgroup, buf, len)) < 0) {
144                         ast_free(buf);
145                         return -1;
146                 }
147         } while (res == 1);
148
149         if (ast_strlen_zero(buf)) {
150                 ast_db_del("dialgroup", cdialgroup);
151         } else {
152                 ast_db_put("dialgroup", cdialgroup, buf);
153         }
154         ast_free(buf);
155         return 0;
156 }
157
158 static int dialgroup_write(struct ast_channel *chan, const char *cmd, char *data, const char *cvalue)
159 {
160         struct group *grhead;
161         struct group_entry *entry;
162         int j, needrefresh = 1;
163         AST_DECLARE_APP_ARGS(args,
164                 AST_APP_ARG(group);
165                 AST_APP_ARG(op);
166         );
167         AST_DECLARE_APP_ARGS(inter,
168                 AST_APP_ARG(faces)[100];
169         );
170         char *value = ast_strdupa(cvalue);
171
172         AST_STANDARD_APP_ARGS(args, data);
173         AST_NONSTANDARD_APP_ARGS(inter, value, '&');
174
175         if (!(grhead = ao2_find(group_container, args.group, 0))) {
176                 /* Create group */
177                 grhead = ao2_alloc(sizeof(*grhead), group_destroy);
178                 if (!grhead)
179                         return -1;
180                 grhead->entries = ao2_container_alloc(37, entry_hash_fn, entry_cmp_fn);
181                 if (!grhead->entries) {
182                         ao2_ref(grhead, -1);
183                         return -1;
184                 }
185                 ast_copy_string(grhead->name, args.group, sizeof(grhead->name));
186                 ao2_link(group_container, grhead);
187         }
188
189         if (ast_strlen_zero(args.op)) {
190                 /* Wholesale replacement of the group */
191                 args.op = "add";
192
193                 /* Remove all existing */
194                 ao2_ref(grhead->entries, -1);
195                 if (!(grhead->entries = ao2_container_alloc(37, entry_hash_fn, entry_cmp_fn))) {
196                         ao2_unlink(group_container, grhead);
197                         ao2_ref(grhead, -1);
198                         return -1;
199                 }
200         }
201
202         if (strcasecmp(args.op, "add") == 0) {
203                 for (j = 0; j < inter.argc; j++) {
204                         if ((entry = ao2_alloc(sizeof(*entry), NULL))) {
205                                 ast_copy_string(entry->name, inter.faces[j], sizeof(entry->name));
206                                 ao2_link(grhead->entries, entry);
207                                 ao2_ref(entry, -1);
208                         } else {
209                                 ast_log(LOG_WARNING, "Unable to add '%s' to dialgroup '%s'\n", inter.faces[j], grhead->name);
210                         }
211                 }
212         } else if (strncasecmp(args.op, "del", 3) == 0) {
213                 for (j = 0; j < inter.argc; j++) {
214                         if ((entry = ao2_find(grhead->entries, inter.faces[j], OBJ_UNLINK))) {
215                                 ao2_ref(entry, -1);
216                         } else {
217                                 ast_log(LOG_WARNING, "Interface '%s' not found in dialgroup '%s'\n", inter.faces[j], grhead->name);
218                         }
219                 }
220         } else {
221                 ast_log(LOG_ERROR, "Unrecognized operation: %s\n", args.op);
222                 needrefresh = 0;
223         }
224         ao2_ref(grhead, -1);
225
226         if (needrefresh) {
227                 dialgroup_refreshdb(chan, args.group);
228         }
229
230         return 0;
231 }
232
233 static struct ast_custom_function dialgroup_function = {
234         .name = "DIALGROUP",
235         .synopsis = "Manages a group of users for dialing",
236         .syntax = "DIALGROUP(<group>[,op])",
237         .desc =
238 "  DIALGROUP presents an interface meant to be used in concert with the Dial\n"
239 "application, by presenting a list of channels which should be dialled when\n"
240 "referenced.\n"
241 "  When DIALGROUP is read from, the argument is interpreted as the particular\n"
242 "group for which a dial should be attempted.  When DIALGROUP is written to\n"
243 "with no arguments, the entire list is replaced with the argument specified.\n"
244 "Other operations are as follows:\n"
245 "  add - add a channel name or interface (write-only)\n"
246 "  del - remove a channel name or interface (write-only)\n\n"
247 "Functionality is similar to a queue, except that when no interfaces are\n"
248 "available, execution may continue in the dialplan.  This is useful when\n"
249 "you want certain people to be the first to answer any calls, with immediate\n"
250 "fallback to a queue when the front line people are busy or unavailable, but\n"
251 "you still want front line people to log in and out of that group, just like\n"
252 "a queue.\n",
253         .read = dialgroup_read,
254         .write = dialgroup_write,
255 };
256
257 static int unload_module(void)
258 {
259         int res = ast_custom_function_unregister(&dialgroup_function);
260         ao2_ref(group_container, -1);
261         return res;
262 }
263
264 static int load_module(void)
265 {
266         struct ast_db_entry *dbtree, *tmp;
267         char groupname[AST_MAX_EXTENSION], *ptr;
268
269         if ((group_container = ao2_container_alloc(37, group_hash_fn, group_cmp_fn))) {
270                 /* Refresh groups from astdb */
271                 if ((dbtree = ast_db_gettree("dialgroup", NULL))) {
272                         for (tmp = dbtree; tmp; tmp = tmp->next) {
273                                 ast_copy_string(groupname, tmp->key, sizeof(groupname));
274                                 if ((ptr = strrchr(groupname, '/'))) {
275                                         ptr++;
276                                         dialgroup_write(NULL, "", ptr, tmp->data);
277                                 }
278                         }
279                         ast_db_freetree(dbtree);
280                 }
281                 return ast_custom_function_register(&dialgroup_function);
282         } else {
283                 return AST_MODULE_LOAD_DECLINE;
284         }
285 }
286
287 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Dialgroup dialplan function");