Merge a large set of updates to the Asterisk indications API.
[asterisk/asterisk.git] / main / indications.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2002, Pauline Middelink
5  * Copyright (C) 2009, Digium, Inc.
6  *
7  * See http://www.asterisk.org for more information about
8  * the Asterisk project. Please do not directly contact
9  * any of the maintainers of this project for assistance;
10  * the project provides a web site, mailing lists and IRC
11  * channels for your use.
12  *
13  * This program is free software, distributed under the terms of
14  * the GNU General Public License Version 2. See the LICENSE file
15  * at the top of the source tree.
16  */
17
18 /*!
19  * \file
20  * \brief Indication Tone Handling
21  *
22  * \author Pauline Middelink <middelink@polyware.nl>
23  * \author Russell Bryant <russell@digium.com>
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <math.h>
31
32 #include "asterisk/lock.h"
33 #include "asterisk/linkedlists.h"
34 #include "asterisk/indications.h"
35 #include "asterisk/frame.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/utils.h"
38 #include "asterisk/cli.h"
39 #include "asterisk/module.h"
40 #include "asterisk/astobj2.h"
41
42 #include "asterisk/_private.h" /* _init(), _reload() */
43
44 /* Globals */
45 static const char config[] = "indications.conf";
46
47 static const int midi_tohz[128] = {
48         8,     8,     9,     9,     10,    10,    11,    12,    12,    13,
49         14,    15,    16,    17,    18,    19,    20,    21,    23,    24,
50         25,    27,    29,    30,    32,    34,    36,    38,    41,    43,
51         46,    48,    51,    55,    58,    61,    65,    69,    73,    77,
52         82,    87,    92,    97,    103,   110,   116,   123,   130,   138,
53         146,   155,   164,   174,   184,   195,   207,   220,   233,   246,
54         261,   277,   293,   311,   329,   349,   369,   391,   415,   440,
55         466,   493,   523,   554,   587,   622,   659,   698,   739,   783,
56         830,   880,   932,   987,   1046,  1108,  1174,  1244,  1318,  1396,
57         1479,  1567,  1661,  1760,  1864,  1975,  2093,  2217,  2349,  2489,
58         2637,  2793,  2959,  3135,  3322,  3520,  3729,  3951,  4186,  4434,
59         4698,  4978,  5274,  5587,  5919,  6271,  6644,  7040,  7458,  7902,
60         8372,  8869,  9397,  9956,  10548, 11175, 11839, 12543
61 };
62
63 static struct ao2_container *ast_tone_zones;
64
65 #define NUM_TONE_ZONE_BUCKETS 53
66
67 /*!
68  * \note Access to this is protected by locking the ast_tone_zones container
69  */
70 static struct ast_tone_zone *default_tone_zone;
71
72 struct playtones_item {
73         int fac1;
74         int init_v2_1;
75         int init_v3_1;
76         int fac2;
77         int init_v2_2;
78         int init_v3_2;
79         int modulate;
80         int duration;
81 };
82
83 struct playtones_def {
84         int vol;
85         int reppos;
86         int nitems;
87         int interruptible;
88         struct playtones_item *items;
89 };
90
91 struct playtones_state {
92         int vol;
93         int v1_1;
94         int v2_1;
95         int v3_1;
96         int v1_2;
97         int v2_2;
98         int v3_2;
99         int reppos;
100         int nitems;
101         struct playtones_item *items;
102         int npos;
103         int oldnpos;
104         int pos;
105         int origwfmt;
106         struct ast_frame f;
107         unsigned char offset[AST_FRIENDLY_OFFSET];
108         short data[4000];
109 };
110
111 static void playtones_release(struct ast_channel *chan, void *params)
112 {
113         struct playtones_state *ps = params;
114
115         if (chan) {
116                 ast_set_write_format(chan, ps->origwfmt);
117         }
118
119         if (ps->items) {
120                 ast_free(ps->items);
121                 ps->items = NULL;
122         }
123
124         ast_free(ps);
125 }
126
127 static void *playtones_alloc(struct ast_channel *chan, void *params)
128 {
129         struct playtones_def *pd = params;
130         struct playtones_state *ps = NULL;
131
132         if (!(ps = ast_calloc(1, sizeof(*ps)))) {
133                 return NULL;
134         }
135
136         ps->origwfmt = chan->writeformat;
137
138         if (ast_set_write_format(chan, AST_FORMAT_SLINEAR)) {
139                 ast_log(LOG_WARNING, "Unable to set '%s' to signed linear format (write)\n", chan->name);
140                 playtones_release(NULL, ps);
141                 ps = NULL;
142         } else {
143                 ps->vol = pd->vol;
144                 ps->reppos = pd->reppos;
145                 ps->nitems = pd->nitems;
146                 ps->items = pd->items;
147                 ps->oldnpos = -1;
148         }
149
150         /* Let interrupts interrupt :) */
151         if (pd->interruptible) {
152                 ast_set_flag(chan, AST_FLAG_WRITE_INT);
153         } else {
154                 ast_clear_flag(chan, AST_FLAG_WRITE_INT);
155         }
156
157         return ps;
158 }
159
160 static int playtones_generator(struct ast_channel *chan, void *data, int len, int samples)
161 {
162         struct playtones_state *ps = data;
163         struct playtones_item *pi;
164         int x;
165
166         /* we need to prepare a frame with 16 * timelen samples as we're
167          * generating SLIN audio */
168
169         len = samples * 2;
170         if (len > sizeof(ps->data) / 2 - 1) {
171                 ast_log(LOG_WARNING, "Can't generate that much data!\n");
172                 return -1;
173         }
174
175         memset(&ps->f, 0, sizeof(ps->f));
176
177         pi = &ps->items[ps->npos];
178
179         if (ps->oldnpos != ps->npos) {
180                 /* Load new parameters */
181                 ps->v1_1 = 0;
182                 ps->v2_1 = pi->init_v2_1;
183                 ps->v3_1 = pi->init_v3_1;
184                 ps->v1_2 = 0;
185                 ps->v2_2 = pi->init_v2_2;
186                 ps->v3_2 = pi->init_v3_2;
187                 ps->oldnpos = ps->npos;
188         }
189
190         for (x = 0; x < samples; x++) {
191                 ps->v1_1 = ps->v2_1;
192                 ps->v2_1 = ps->v3_1;
193                 ps->v3_1 = (pi->fac1 * ps->v2_1 >> 15) - ps->v1_1;
194
195                 ps->v1_2 = ps->v2_2;
196                 ps->v2_2 = ps->v3_2;
197                 ps->v3_2 = (pi->fac2 * ps->v2_2 >> 15) - ps->v1_2;
198                 if (pi->modulate) {
199                         int p;
200                         p = ps->v3_2 - 32768;
201                         if (p < 0) {
202                                 p = -p;
203                         }
204                         p = ((p * 9) / 10) + 1;
205                         ps->data[x] = (ps->v3_1 * p) >> 15;
206                 } else {
207                         ps->data[x] = ps->v3_1 + ps->v3_2;
208                 }
209         }
210
211         ps->f.frametype = AST_FRAME_VOICE;
212         ps->f.subclass = AST_FORMAT_SLINEAR;
213         ps->f.datalen = len;
214         ps->f.samples = samples;
215         ps->f.offset = AST_FRIENDLY_OFFSET;
216         ps->f.data.ptr = ps->data;
217
218         if (ast_write(chan, &ps->f)) {
219                 return -1;
220         }
221
222         ps->pos += x;
223
224         if (pi->duration && ps->pos >= pi->duration * 8) {      /* item finished? */
225                 ps->pos = 0;                                    /* start new item */
226                 ps->npos++;
227                 if (ps->npos >= ps->nitems) {                   /* last item? */
228                         if (ps->reppos == -1) {                 /* repeat set? */
229                                 return -1;
230                         }
231                         ps->npos = ps->reppos;                  /* redo from top */
232                 }
233         }
234
235         return 0;
236 }
237
238 static struct ast_generator playtones = {
239         .alloc     = playtones_alloc,
240         .release   = playtones_release,
241         .generate  = playtones_generator,
242 };
243
244 int ast_tone_zone_part_parse(const char *s, struct ast_tone_zone_part *tone_data)
245 {
246         if (sscanf(s, "%u+%u/%u", &tone_data->freq1, &tone_data->freq2, 
247                         &tone_data->time) == 3) {
248                 /* f1+f2/time format */
249         } else if (sscanf(s, "%u+%u", &tone_data->freq1, &tone_data->freq2) == 2) {
250                 /* f1+f2 format */
251                 tone_data->time = 0;
252         } else if (sscanf(s, "%u*%u/%u", &tone_data->freq1, &tone_data->freq2, 
253                         &tone_data->time) == 3) {
254                 /* f1*f2/time format */
255                 tone_data->modulate = 1;
256         } else if (sscanf(s, "%u*%u", &tone_data->freq1, &tone_data->freq2) == 2) {
257                 /* f1*f2 format */
258                 tone_data->time = 0;
259                 tone_data->modulate = 1;
260         } else if (sscanf(s, "%u/%u", &tone_data->freq1, &tone_data->time) == 2) {
261                 /* f1/time format */
262                 tone_data->freq2 = 0;
263         } else if (sscanf(s, "%u", &tone_data->freq1) == 1) {
264                 /* f1 format */
265                 tone_data->freq2 = 0;
266                 tone_data->time = 0;
267         } else if (sscanf(s, "M%u+M%u/%u", &tone_data->freq1, &tone_data->freq2, 
268                         &tone_data->time) == 3) {
269                 /* Mf1+Mf2/time format */
270                 tone_data->midinote = 1;
271         } else if (sscanf(s, "M%u+M%u", &tone_data->freq1, &tone_data->freq2) == 2) {
272                 /* Mf1+Mf2 format */
273                 tone_data->time = 0;
274                 tone_data->midinote = 1;
275         } else if (sscanf(s, "M%u*M%u/%u", &tone_data->freq1, &tone_data->freq2, 
276                         &tone_data->time) == 3) {
277                 /* Mf1*Mf2/time format */
278                 tone_data->modulate = 1;
279                 tone_data->midinote = 1;
280         } else if (sscanf(s, "M%u*M%u", &tone_data->freq1, &tone_data->freq2) == 2) {
281                 /* Mf1*Mf2 format */
282                 tone_data->time = 0;
283                 tone_data->modulate = 1;
284                 tone_data->midinote = 1;
285         } else if (sscanf(s, "M%u/%u", &tone_data->freq1, &tone_data->time) == 2) {
286                 /* Mf1/time format */
287                 tone_data->freq2 = -1;
288                 tone_data->midinote = 1;
289         } else if (sscanf(s, "M%u", &tone_data->freq1) == 1) {
290                 /* Mf1 format */
291                 tone_data->freq2 = -1;
292                 tone_data->time = 0;
293                 tone_data->midinote = 1;
294         } else {
295                 return -1;
296         }
297
298         return 0;
299 }
300
301 int ast_playtones_start(struct ast_channel *chan, int vol, const char *playlst, int interruptible)
302 {
303         char *s, *data = ast_strdupa(playlst);
304         struct playtones_def d = { vol, -1, 0, 1, NULL };
305         char *stringp;
306         char *separator;
307         static const float sample_rate = 8000.0;
308         static const float max_sample_val = 32768.0;
309
310         if (vol < 1) {
311                 d.vol = 7219; /* Default to -8db */
312         }
313
314         d.interruptible = interruptible;
315
316         stringp = data;
317
318         /* check if the data is separated with '|' or with ',' by default */
319         if (strchr(stringp,'|')) {
320                 separator = "|";
321         } else {
322                 separator = ",";
323         }
324
325         while ((s = strsep(&stringp, separator)) && !ast_strlen_zero(s)) {
326                 struct ast_tone_zone_part tone_data = {
327                         .time = 0,
328                 };
329
330                 s = ast_strip(s);
331
332                 if (s[0]=='!') {
333                         s++;
334                 } else if (d.reppos == -1) {
335                         d.reppos = d.nitems;
336                 }
337
338                 if (ast_tone_zone_part_parse(s, &tone_data)) {
339                         ast_log(LOG_ERROR, "Failed to parse tone part '%s'\n", s);
340                         continue;
341                 }
342
343                 if (tone_data.midinote) {
344                         /* midi notes must be between 0 and 127 */
345
346                         if (tone_data.freq1 >= 0 && tone_data.freq1 <= 127) {
347                                 tone_data.freq1 = midi_tohz[tone_data.freq1];
348                         } else {
349                                 tone_data.freq1 = 0;
350                         }
351
352                         if (tone_data.freq2 >= 0 && tone_data.freq2 <= 127) {
353                                 tone_data.freq2 = midi_tohz[tone_data.freq2];
354                         } else {
355                                 tone_data.freq2 = 0;
356                         }
357                 }
358
359                 if (!(d.items = ast_realloc(d.items, (d.nitems + 1) * sizeof(*d.items)))) {
360                         return -1;
361                 }
362
363                 d.items[d.nitems].fac1 = 2.0 * cos(2.0 * M_PI * (tone_data.freq1 / sample_rate)) * max_sample_val;
364                 d.items[d.nitems].init_v2_1 = sin(-4.0 * M_PI * (tone_data.freq1 / sample_rate)) * d.vol;
365                 d.items[d.nitems].init_v3_1 = sin(-2.0 * M_PI * (tone_data.freq1 / sample_rate)) * d.vol;
366
367                 d.items[d.nitems].fac2 = 2.0 * cos(2.0 * M_PI * (tone_data.freq2 / sample_rate)) * max_sample_val;
368                 d.items[d.nitems].init_v2_2 = sin(-4.0 * M_PI * (tone_data.freq2 / sample_rate)) * d.vol;
369                 d.items[d.nitems].init_v3_2 = sin(-2.0 * M_PI * (tone_data.freq2 / sample_rate)) * d.vol;
370
371                 d.items[d.nitems].duration = tone_data.time;
372                 d.items[d.nitems].modulate = tone_data.modulate;
373
374                 d.nitems++;
375         }
376
377         if (ast_activate_generator(chan, &playtones, &d)) {
378                 ast_free(d.items);
379                 return -1;
380         }
381
382         return 0;
383 }
384
385 void ast_playtones_stop(struct ast_channel *chan)
386 {
387         ast_deactivate_generator(chan);
388 }
389
390 int ast_tone_zone_count(void)
391 {
392         return ao2_container_count(ast_tone_zones);
393 }
394
395 struct ao2_iterator ast_tone_zone_iterator_init(void)
396 {
397         return ao2_iterator_init(ast_tone_zones, 0);
398 }
399
400 /* Set global indication country */
401 static int ast_set_indication_country(const char *country)
402 {
403         struct ast_tone_zone *zone = NULL;
404
405         /* If no country is specified or we are unable to find the zone, then return not found */
406         if (ast_strlen_zero(country) || !(zone = ast_get_indication_zone(country))) {
407                 return -1;
408         }
409
410         ast_verb(3, "Setting default indication country to '%s'\n", country);
411
412         ao2_lock(ast_tone_zones);
413         if (default_tone_zone) {
414                 default_tone_zone = ast_tone_zone_unref(default_tone_zone);
415         }
416         default_tone_zone = ast_tone_zone_ref(zone);
417         ao2_unlock(ast_tone_zones);
418
419         zone = ast_tone_zone_unref(zone);
420
421         return 0;
422 }
423
424 /* locate ast_tone_zone, given the country. if country == NULL, use the default country */
425 struct ast_tone_zone *ast_get_indication_zone(const char *country)
426 {
427         struct ast_tone_zone *tz = NULL;
428         struct ast_tone_zone zone_arg = {
429                 .nrringcadence = 0,
430         };
431
432         if (ast_strlen_zero(country)) {
433                 ao2_lock(ast_tone_zones);
434                 if (default_tone_zone) {
435                         tz = ast_tone_zone_ref(default_tone_zone);
436                 }
437                 ao2_unlock(ast_tone_zones);
438
439                 return tz;
440         }
441
442         ast_copy_string(zone_arg.country, country, sizeof(zone_arg.country));
443
444         return ao2_find(ast_tone_zones, &zone_arg, OBJ_POINTER);
445 }
446
447 struct ast_tone_zone_sound *ast_get_indication_tone(const struct ast_tone_zone *_zone, const char *indication)
448 {
449         struct ast_tone_zone_sound *ts = NULL;
450         /* _zone is const to the users of the API */
451         struct ast_tone_zone *zone = (struct ast_tone_zone *) _zone;
452
453         /* If no zone is specified, use the default */
454         if (!zone) {
455                 ao2_lock(ast_tone_zones);
456                 if (default_tone_zone) {
457                         zone = ast_tone_zone_ref(default_tone_zone);
458                 }
459                 ao2_unlock(ast_tone_zones);
460
461                 if (!zone) {
462                         return NULL;
463                 }
464         }
465
466         ast_tone_zone_lock(zone);
467
468         /* Look through list of tones in the zone searching for the right one */
469         AST_LIST_TRAVERSE(&zone->tones, ts, entry) {
470                 if (!strcasecmp(ts->name, indication)) {
471                         /* Increase ref count for the reference we will return */
472                         ts = ast_tone_zone_sound_ref(ts);
473                         break;
474                 }
475         }
476
477         ast_tone_zone_unlock(zone);
478
479         return ts;
480 }
481
482 static void ast_tone_zone_sound_destructor(void *obj)
483 {
484         struct ast_tone_zone_sound *ts = obj;
485
486         /* Deconstify the 'const char *'s so the compiler doesn't complain. (but it's safe) */
487         if (ts->name) {
488                 ast_free((char *) ts->name);
489                 ts->name = NULL;
490         }
491
492         if (ts->data) {
493                 ast_free((char *) ts->data);
494                 ts->data = NULL;
495         }
496 }
497
498 /*! \brief deallocate the passed tone zone */
499 static void ast_tone_zone_destructor(void *obj)
500 {
501         struct ast_tone_zone *zone = obj;
502         struct ast_tone_zone_sound *current;
503
504         while ((current = AST_LIST_REMOVE_HEAD(&zone->tones, entry))) {
505                 current = ast_tone_zone_sound_unref(current);
506         }
507
508         if (zone->ringcadence) {
509                 ast_free(zone->ringcadence);
510                 zone->ringcadence = NULL;
511         }
512 }
513
514 /* add a new country, if country exists, it will be replaced. */
515 static int ast_register_indication_country(struct ast_tone_zone *zone)
516 {
517         ao2_lock(ast_tone_zones);
518         if (!default_tone_zone) {
519                 default_tone_zone = ast_tone_zone_ref(zone);
520         }
521         ao2_unlock(ast_tone_zones);
522
523         ao2_link(ast_tone_zones, zone);
524
525         ast_verb(3, "Registered indication country '%s'\n", zone->country);
526
527         return 0;
528 }
529
530 /* remove an existing country and all its indications, country must exist. */
531 static int ast_unregister_indication_country(const char *country)
532 {
533         struct ast_tone_zone *tz = NULL;
534         struct ast_tone_zone zone_arg = {
535                 .nrringcadence = 0,
536         };
537
538         ast_copy_string(zone_arg.country, country, sizeof(zone_arg.country));
539
540         if (!(tz = ao2_find(ast_tone_zones, &zone_arg, OBJ_POINTER))) {
541                 return -1;
542         }
543
544         ao2_lock(ast_tone_zones);
545         if (default_tone_zone == tz) {
546                 ast_tone_zone_unref(default_tone_zone);
547                 /* Get a new default, punt to the first one we find */
548                 default_tone_zone = ao2_callback(ast_tone_zones, 0, NULL, NULL);
549         }
550         ao2_unlock(ast_tone_zones);
551
552         ao2_unlink(ast_tone_zones, tz);
553
554         tz = ast_tone_zone_unref(tz);
555
556         return 0;
557 }
558
559 /*!
560  * \note called with the tone zone locked
561  */
562 static int ast_register_indication(struct ast_tone_zone *zone, const char *indication,
563                 const char *tonelist)
564 {
565         struct ast_tone_zone_sound *ts;
566
567         if (ast_strlen_zero(indication) || ast_strlen_zero(tonelist)) {
568                 return -1;
569         }
570
571         AST_LIST_TRAVERSE_SAFE_BEGIN(&zone->tones, ts, entry) {
572                 if (!strcasecmp(indication, ts->name)) {
573                         AST_LIST_REMOVE_CURRENT(entry);
574                         ts = ast_tone_zone_sound_unref(ts);
575                         break;
576                 }
577         }
578         AST_LIST_TRAVERSE_SAFE_END;
579
580         if (!(ts = ao2_alloc(sizeof(*ts), ast_tone_zone_sound_destructor))) {
581                 return -1;
582         }
583
584         if (!(ts->name = ast_strdup(indication)) || !(ts->data = ast_strdup(tonelist))) {
585                 ts = ast_tone_zone_sound_unref(ts);
586                 return -1;
587         }
588
589         AST_LIST_INSERT_TAIL(&zone->tones, ts, entry); /* Inherit reference */
590
591         return 0;
592 }
593
594 /* remove an existing country's indication. Both country and indication must exist */
595 static int ast_unregister_indication(struct ast_tone_zone *zone, const char *indication)
596 {
597         struct ast_tone_zone_sound *ts;
598         int res = -1;
599
600         ast_tone_zone_lock(zone);
601
602         AST_LIST_TRAVERSE_SAFE_BEGIN(&zone->tones, ts, entry) {
603                 if (!strcasecmp(indication, ts->name)) {
604                         AST_LIST_REMOVE_CURRENT(entry);
605                         ts = ast_tone_zone_sound_unref(ts);
606                         res = 0;
607                         break;
608                 }
609         }
610         AST_LIST_TRAVERSE_SAFE_END;
611
612         ast_tone_zone_unlock(zone);
613
614         return res;
615 }
616
617 static struct ast_tone_zone *ast_tone_zone_alloc(void)
618 {
619         return ao2_alloc(sizeof(struct ast_tone_zone), ast_tone_zone_destructor);
620 }
621
622 static char *complete_country(struct ast_cli_args *a)
623 {
624         char *res = NULL;
625         struct ao2_iterator i;
626         int which = 0;
627         size_t wordlen;
628         struct ast_tone_zone *tz;
629
630         wordlen = strlen(a->word);
631
632         i = ao2_iterator_init(ast_tone_zones, 0);
633         while ((tz = ao2_iterator_next(&i))) {
634                 if (!strncasecmp(a->word, tz->country, wordlen) && ++which > a->n) {
635                         res = ast_strdup(tz->country);
636                 }
637                 tz = ast_tone_zone_unref(tz);
638                 if (res) {
639                         break;
640                 }
641         }
642
643         return res;
644 }
645
646 static char *handle_cli_indication_add(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
647 {
648         struct ast_tone_zone *tz;
649         int created_country = 0;
650         char *res = CLI_SUCCESS;
651
652         switch (cmd) {
653         case CLI_INIT:
654                 e->command = "indication add";
655                 e->usage =
656                         "Usage: indication add <country> <indication> \"<tonelist>\"\n"
657                         "       Add the given indication to the country.\n";
658                 return NULL;
659         case CLI_GENERATE:
660                 if (a->pos == 2) {
661                         return complete_country(a);
662                 } else {
663                         return NULL;
664                 }
665         }
666
667         if (a->argc != 5) {
668                 return CLI_SHOWUSAGE;
669         }
670
671         if (!(tz = ast_get_indication_zone(a->argv[2]))) {
672                 /* country does not exist, create it */
673                 ast_log(LOG_NOTICE, "Country '%s' does not exist, creating it.\n", a->argv[2]);
674
675                 if (!(tz = ast_tone_zone_alloc())) {
676                         return CLI_FAILURE;
677                 }
678
679                 ast_copy_string(tz->country, a->argv[2], sizeof(tz->country));
680
681                 if (ast_register_indication_country(tz)) {
682                         ast_log(LOG_WARNING, "Unable to register new country\n");
683                         tz = ast_tone_zone_unref(tz);
684                         return CLI_FAILURE;
685                 }
686
687                 created_country = 1;
688         }
689
690         ast_tone_zone_lock(tz);
691
692         if (ast_register_indication(tz, a->argv[3], a->argv[4])) {
693                 ast_log(LOG_WARNING, "Unable to register indication %s/%s\n", a->argv[2], a->argv[3]);
694                 if (created_country) {
695                         ast_unregister_indication_country(a->argv[2]);
696                 }
697                 res = CLI_FAILURE;
698         }
699
700         ast_tone_zone_unlock(tz);
701
702         tz = ast_tone_zone_unref(tz);
703
704         return res;
705 }
706
707 static char *complete_indications(struct ast_cli_args *a)
708 {
709         char *res = NULL;
710         int which = 0;
711         size_t wordlen;
712         struct ast_tone_zone_sound *ts;
713         struct ast_tone_zone *tz, tmp_tz = {
714                 .nrringcadence = 0,
715         };
716
717         ast_copy_string(tmp_tz.country, a->argv[a->pos - 1], sizeof(tmp_tz.country));
718
719         if (!(tz = ao2_find(ast_tone_zones, &tmp_tz, OBJ_POINTER))) {
720                 return NULL;
721         }
722
723         wordlen = strlen(a->word);
724
725         ast_tone_zone_lock(tz);
726         AST_LIST_TRAVERSE(&tz->tones, ts, entry) {
727                 if (!strncasecmp(a->word, ts->name, wordlen) && ++which > a->n) {
728                         res = ast_strdup(ts->name);
729                         break;
730                 }
731         }
732         ast_tone_zone_unlock(tz);
733
734         tz = ast_tone_zone_unref(tz);
735
736         return res;
737 }
738
739 static char *handle_cli_indication_remove(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
740 {
741         struct ast_tone_zone *tz;
742         char *res = CLI_SUCCESS;
743
744         switch (cmd) {
745         case CLI_INIT:
746                 e->command = "indication remove";
747                 e->usage =
748                         "Usage: indication remove <country> [indication]\n"
749                         "       Remove the given indication from the country.\n";
750                 return NULL;
751         case CLI_GENERATE:
752                 if (a->pos == 2) {
753                         return complete_country(a);
754                 } else if (a->pos == 3) {
755                         return complete_indications(a);
756                 }
757         }
758
759         if (a->argc != 3 && a->argc != 4) {
760                 return CLI_SHOWUSAGE;
761         }
762
763         if (a->argc == 3) {
764                 /* remove entire country */
765                 if (ast_unregister_indication_country(a->argv[2])) {
766                         ast_log(LOG_WARNING, "Unable to unregister indication country %s\n", a->argv[2]);
767                         return CLI_FAILURE;
768                 }
769
770                 return CLI_SUCCESS;
771         }
772
773         if (!(tz = ast_get_indication_zone(a->argv[2]))) {
774                 ast_log(LOG_WARNING, "Unable to unregister indication %s/%s, country does not exists\n", a->argv[2], a->argv[3]);
775                 return CLI_FAILURE;
776         }
777
778         if (ast_unregister_indication(tz, a->argv[3])) {
779                 ast_log(LOG_WARNING, "Unable to unregister indication %s/%s\n", a->argv[2], a->argv[3]);
780                 res = CLI_FAILURE;
781         }
782
783         tz = ast_tone_zone_unref(tz);
784
785         return res;
786 }
787
788 static char *handle_cli_indication_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
789 {
790         struct ast_tone_zone *tz = NULL;
791         struct ast_str *buf;
792         int found_country = 0;
793         int i;
794
795         switch (cmd) {
796         case CLI_INIT:
797                 e->command = "indication show";
798                 e->usage =
799                         "Usage: indication show [<country> ...]\n"
800                         "       Display either a condensed summary of all countries and indications, or a\n"
801                         "       more verbose list of indications for the specified countries.\n";
802                 return NULL;
803         case CLI_GENERATE:
804                 return complete_country(a);
805         }
806
807         if (a->argc == 2) {
808                 struct ao2_iterator iter;
809                 /* no arguments, show a list of countries */
810                 ast_cli(a->fd, "Country   Description\n");
811                 ast_cli(a->fd, "===========================\n");
812                 iter = ast_tone_zone_iterator_init();
813                 while ((tz = ao2_iterator_next(&iter))) {
814                         ast_tone_zone_lock(tz);
815                         ast_cli(a->fd, "%-7.7s  %s\n", tz->country, tz->description);
816                         ast_tone_zone_unlock(tz);
817                         tz = ast_tone_zone_unref(tz);
818                 }
819                 return CLI_SUCCESS;
820         }
821
822         buf = ast_str_alloca(256);
823
824         for (i = 2; i < a->argc; i++) {
825                 struct ast_tone_zone zone_arg = {
826                         .nrringcadence = 0,
827                 };
828                 struct ast_tone_zone_sound *ts;
829                 int j;
830
831                 ast_copy_string(zone_arg.country, a->argv[i], sizeof(zone_arg.country));
832
833                 if (!(tz = ao2_find(ast_tone_zones, &zone_arg, OBJ_POINTER))) {
834                         continue;
835                 }
836
837                 if (!found_country) {
838                         found_country = 1;
839                         ast_cli(a->fd, "Country Indication      PlayList\n");
840                         ast_cli(a->fd, "=====================================\n");
841                 }
842
843                 ast_tone_zone_lock(tz);
844
845                 ast_str_set(&buf, 0, "%-7.7s %-15.15s ", tz->country, "<ringcadence>");
846                 for (j = 0; j < tz->nrringcadence; j++) {
847                         ast_str_append(&buf, 0, "%d%s", tz->ringcadence[j],
848                                         (j == tz->nrringcadence - 1) ? "" : ",");
849                 }
850                 ast_str_append(&buf, 0, "\n");
851                 ast_cli(a->fd, "%s", buf->str);
852
853                 AST_LIST_TRAVERSE(&tz->tones, ts, entry) {
854                         ast_cli(a->fd, "%-7.7s %-15.15s %s\n", tz->country, ts->name, ts->data);
855                 }
856
857                 ast_tone_zone_unlock(tz);
858                 tz = ast_tone_zone_unref(tz);
859         }
860
861         if (!found_country) {
862                 ast_cli(a->fd, "No countries matched your criteria.\n");
863         }
864
865         return CLI_SUCCESS;
866 }
867
868 static int is_valid_tone_zone(struct ast_tone_zone *zone)
869 {
870         int res;
871
872         ast_tone_zone_lock(zone);
873         res = (!ast_strlen_zero(zone->description) && !AST_LIST_EMPTY(&zone->tones));
874         ast_tone_zone_unlock(zone);
875
876         return res;
877 }
878
879 /*!
880  * \note This is called with the tone zone locked.
881  */
882 static void store_tone_zone_ring_cadence(struct ast_tone_zone *zone, const char *val)
883 {
884         char buf[1024];
885         char *ring, *c = buf;
886
887         ast_copy_string(buf, val, sizeof(buf));
888
889         while ((ring = strsep(&c, ","))) {
890                 int *tmp, val;
891
892                 ring = ast_strip(ring);
893
894                 if (!isdigit(ring[0]) || (val = atoi(ring)) == -1) {
895                         ast_log(LOG_WARNING, "Invalid ringcadence given '%s'.\n", ring);
896                         continue;
897                 }
898
899                 if (!(tmp = ast_realloc(zone->ringcadence, (zone->nrringcadence + 1) * sizeof(int)))) {
900                         return;
901                 }
902
903                 zone->ringcadence = tmp;
904                 tmp[zone->nrringcadence] = val;
905                 zone->nrringcadence++;
906         }
907 }
908
909 static void store_config_tone_zone(struct ast_tone_zone *zone, const char *var,
910                 const char *value)
911 {
912         CV_START(var, value);
913
914         CV_STR("description", zone->description);
915         CV_F("ringcadence", store_tone_zone_ring_cadence(zone, value));
916         CV_F("ringcadance", store_tone_zone_ring_cadence(zone, value));
917
918         ast_register_indication(zone, var, value);
919
920         CV_END;
921 }
922
923 static void reset_tone_zone(struct ast_tone_zone *zone)
924 {
925         ast_tone_zone_lock(zone);
926
927         zone->killme = 0;
928
929         if (zone->nrringcadence) {
930                 zone->nrringcadence = 0;
931                 ast_free(zone->ringcadence);
932                 zone->ringcadence = NULL;
933         }
934
935         ast_tone_zone_unlock(zone);
936 }
937
938 static int parse_tone_zone(struct ast_config *cfg, const char *country)
939 {
940         struct ast_variable *v;
941         struct ast_tone_zone *zone;
942         struct ast_tone_zone tmp_zone = {
943                 .nrringcadence = 0,
944         };
945         int allocd = 0;
946
947         ast_copy_string(tmp_zone.country, country, sizeof(tmp_zone.country));
948
949         if ((zone = ao2_find(ast_tone_zones, &tmp_zone, OBJ_POINTER))) {
950                 reset_tone_zone(zone);
951         } else if ((zone = ast_tone_zone_alloc())) {
952                 allocd = 1;
953                 ast_copy_string(zone->country, country, sizeof(zone->country));
954         } else {
955                 return -1;
956         }
957
958         ast_tone_zone_lock(zone);
959         for (v = ast_variable_browse(cfg, country); v; v = v->next) {
960                 store_config_tone_zone(zone, v->name, v->value);
961         }
962         ast_tone_zone_unlock(zone);
963
964         if (allocd) {
965                 if (!is_valid_tone_zone(zone)) {
966                         ast_log(LOG_WARNING, "Indication country '%s' is invalid\n", country);
967                 } else if (ast_register_indication_country(zone)) {
968                         ast_log(LOG_WARNING, "Unable to register indication country '%s'.\n",
969                                         country);
970                 }
971         }
972
973         zone = ast_tone_zone_unref(zone);
974
975         return 0;
976 }
977
978 /*!
979  * Mark the zone and its tones before parsing configuration.  We will use this
980  * to know what to remove after configuration is parsed.
981  */
982 static int tone_zone_mark(void *obj, void *arg, int flags)
983 {
984         struct ast_tone_zone *zone = obj;
985         struct ast_tone_zone_sound *s;
986
987         ast_tone_zone_lock(zone);
988
989         zone->killme = 1;
990
991         AST_LIST_TRAVERSE(&zone->tones, s, entry) {
992                 s->killme = 1;
993         }
994
995         ast_tone_zone_unlock(zone);
996
997         return 0;
998 }
999
1000 /*!
1001  * Prune tones no longer in the configuration, and have the tone zone unlinked
1002  * if it is no longer in the configuration at all.
1003  */
1004 static int prune_tone_zone(void *obj, void *arg, int flags)
1005 {
1006         struct ast_tone_zone *zone = obj;
1007         struct ast_tone_zone_sound *s;
1008
1009         ast_tone_zone_lock(zone);
1010
1011         AST_LIST_TRAVERSE_SAFE_BEGIN(&zone->tones, s, entry) {
1012                 if (s->killme) {
1013                         AST_LIST_REMOVE_CURRENT(entry);
1014                         s = ast_tone_zone_sound_unref(s);
1015                 }
1016         }
1017         AST_LIST_TRAVERSE_SAFE_END;
1018
1019         ast_tone_zone_unlock(zone);
1020
1021         return zone->killme ? CMP_MATCH : 0;
1022 }
1023
1024 /*! \brief load indications module */
1025 static int load_indications(int reload)
1026 {
1027         struct ast_config *cfg;
1028         const char *cxt = NULL;
1029         const char *country = NULL;
1030         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
1031         int res = -1;
1032
1033         cfg = ast_config_load2(config, "indications", config_flags);
1034
1035         if (cfg == CONFIG_STATUS_FILEMISSING || cfg == CONFIG_STATUS_FILEINVALID) {
1036                 return -1;
1037         } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
1038                 return 0;
1039         }
1040
1041         /* Lock the container to prevent multiple simultaneous reloads */
1042         ao2_lock(ast_tone_zones);
1043
1044         ao2_callback(ast_tone_zones, OBJ_NODATA, tone_zone_mark, NULL);
1045
1046         /* Use existing config to populate the Indication table */
1047         while ((cxt = ast_category_browse(cfg, cxt))) {
1048                 /* All categories but "general" are considered countries */
1049                 if (!strcasecmp(cxt, "general")) {
1050                         continue;
1051                 }
1052
1053                 if (parse_tone_zone(cfg, cxt)) {
1054                         goto return_cleanup;
1055                 }
1056         }
1057
1058         ao2_callback(ast_tone_zones, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK,
1059                         prune_tone_zone, NULL);
1060
1061         /* determine which country is the default */
1062         country = ast_variable_retrieve(cfg, "general", "country");
1063         if (ast_strlen_zero(country) || ast_set_indication_country(country)) {
1064                 ast_log(LOG_WARNING, "Unable to set the default country (for indication tones)\n");
1065         }
1066
1067         res = 0;
1068
1069 return_cleanup:
1070         ao2_unlock(ast_tone_zones);
1071         ast_config_destroy(cfg);
1072
1073         return res;
1074 }
1075
1076 /*! \brief CLI entries for commands provided by this module */
1077 static struct ast_cli_entry cli_indications[] = {
1078         AST_CLI_DEFINE(handle_cli_indication_add,    "Add the given indication to the country"),
1079         AST_CLI_DEFINE(handle_cli_indication_remove, "Remove the given indication from the country"),
1080         AST_CLI_DEFINE(handle_cli_indication_show,   "Display a list of all countries/indications")
1081 };
1082
1083 static int ast_tone_zone_hash(const void *obj, const int flags)
1084 {
1085         const struct ast_tone_zone *zone = obj;
1086
1087         return ast_str_case_hash(zone->country);
1088 }
1089
1090 static int ast_tone_zone_cmp(void *obj, void *arg, int flags)
1091 {
1092         struct ast_tone_zone *zone = obj;
1093         struct ast_tone_zone *zone_arg = arg;
1094
1095         return (!strcasecmp(zone->country, zone_arg->country)) ?
1096                         CMP_MATCH | CMP_STOP : 0;
1097 }
1098
1099 /*! \brief Load indications module */
1100 int ast_indications_init(void)
1101 {
1102         if (!(ast_tone_zones = ao2_container_alloc(NUM_TONE_ZONE_BUCKETS,
1103                         ast_tone_zone_hash, ast_tone_zone_cmp))) {
1104                 return -1;
1105         }
1106
1107         if (load_indications(0)) {
1108                 return -1;
1109         }
1110
1111         ast_cli_register_multiple(cli_indications, ARRAY_LEN(cli_indications));
1112
1113         return 0;
1114 }
1115
1116 /*! \brief Reload indications module */
1117 int ast_indications_reload(void)
1118 {
1119         return load_indications(1);
1120 }
1121