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