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