Janitor, use ARRAY_LEN() when possible.
[asterisk/asterisk.git] / apps / app_playback.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Trivial application to playback a sound file
22  *
23  * \author Mark Spencer <markster@digium.com>
24  * 
25  * \ingroup applications
26  */
27  
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include "asterisk/file.h"
33 #include "asterisk/pbx.h"
34 #include "asterisk/module.h"
35 #include "asterisk/app.h"
36 /* This file provides config-file based 'say' functions, and implenents
37  * some CLI commands.
38  */
39 #include "asterisk/say.h"       /* provides config-file based 'say' functions */
40 #include "asterisk/cli.h"
41
42 /*** DOCUMENTATION
43         <application name="Playback" language="en_US">
44                 <synopsis>
45                         Play a file.
46                 </synopsis>
47                 <syntax>
48                         <parameter name="filenames" required="true" argsep="&amp;">
49                                 <argument name="filename" required="true" />
50                                 <argument name="filename2" multiple="true" />
51                         </parameter>
52                         <parameter name="options">
53                                 <para>Comma separated list of options</para>
54                                 <optionlist>
55                                         <option name="skip">
56                                                 <para>Do not play if not answered</para>
57                                         </option>
58                                         <option name="noanswer">
59                                                 <para>Playback without answering, otherwise the channel will
60                                                 be answered before the sound is played.</para>
61                                                 <note><para>Not all channel types support playing messages while still on hook.</para></note>
62                                         </option>
63                                 </optionlist>
64                         </parameter>
65                 </syntax>
66                 <description>
67                         <para>Plays back given filenames (do not put extension of wav/alaw etc).
68                         The playback command answer the channel if no options are specified.
69                         If the file is non-existant it will fail</para>
70                         <para>This application sets the following channel variable upon completion:</para>
71                         <variablelist>
72                                 <variable name="PLAYBACKSTATUS">
73                                         <para>The status of the playback attempt as a text string.</para>
74                                         <value name="SUCCESS"/>
75                                         <value name="FAILED"/>
76                                 </variable>
77                         </variablelist>
78                         <para>See Also: Background (application) -- for playing sound files that are interruptible</para>
79                         <para>WaitExten (application) -- wait for digits from caller, optionally play music on hold</para>
80                 </description>
81         </application>
82  ***/
83
84 static char *app = "Playback";
85
86 static struct ast_config *say_cfg = NULL;
87 /* save the say' api calls.
88  * The first entry is NULL if we have the standard source,
89  * otherwise we are sourcing from here.
90  * 'say load [new|old]' will enable the new or old method, or report status
91  */
92 static const void *say_api_buf[40];
93 static const char *say_old = "old";
94 static const char *say_new = "new";
95
96 static void save_say_mode(const void *arg)
97 {
98         int i = 0;
99         say_api_buf[i++] = arg;
100
101         say_api_buf[i++] = ast_say_number_full;
102         say_api_buf[i++] = ast_say_enumeration_full;
103         say_api_buf[i++] = ast_say_digit_str_full;
104         say_api_buf[i++] = ast_say_character_str_full;
105         say_api_buf[i++] = ast_say_phonetic_str_full;
106         say_api_buf[i++] = ast_say_datetime;
107         say_api_buf[i++] = ast_say_time;
108         say_api_buf[i++] = ast_say_date;
109         say_api_buf[i++] = ast_say_datetime_from_now;
110         say_api_buf[i++] = ast_say_date_with_format;
111 }
112
113 static void restore_say_mode(void *arg)
114 {
115         int i = 0;
116         say_api_buf[i++] = arg;
117
118         ast_say_number_full = say_api_buf[i++];
119         ast_say_enumeration_full = say_api_buf[i++];
120         ast_say_digit_str_full = say_api_buf[i++];
121         ast_say_character_str_full = say_api_buf[i++];
122         ast_say_phonetic_str_full = say_api_buf[i++];
123         ast_say_datetime = say_api_buf[i++];
124         ast_say_time = say_api_buf[i++];
125         ast_say_date = say_api_buf[i++];
126         ast_say_datetime_from_now = say_api_buf[i++];
127         ast_say_date_with_format = say_api_buf[i++];
128 }
129
130 /* 
131  * Typical 'say' arguments in addition to the date or number or string
132  * to say. We do not include 'options' because they may be different
133  * in recursive calls, and so they are better left as an external
134  * parameter.
135  */
136 typedef struct {
137         struct ast_channel *chan;
138         const char *ints;
139         const char *language;
140         int audiofd;
141         int ctrlfd;
142 } say_args_t;
143
144 static int s_streamwait3(const say_args_t *a, const char *fn)
145 {
146         int res = ast_streamfile(a->chan, fn, a->language);
147         if (res) {
148                 ast_log(LOG_WARNING, "Unable to play message %s\n", fn);
149                 return res;
150         }
151         res = (a->audiofd  > -1 && a->ctrlfd > -1) ?
152         ast_waitstream_full(a->chan, a->ints, a->audiofd, a->ctrlfd) :
153         ast_waitstream(a->chan, a->ints);
154         ast_stopstream(a->chan);
155         return res;  
156 }
157
158 /*
159  * the string is 'prefix:data' or prefix:fmt:data'
160  * with ':' being invalid in strings.
161  */
162 static int do_say(say_args_t *a, const char *s, const char *options, int depth)
163 {
164         struct ast_variable *v;
165         char *lang, *x, *rule = NULL;
166         int ret = 0;   
167         struct varshead head = { .first = NULL, .last = NULL };
168         struct ast_var_t *n;
169
170         ast_debug(2, "string <%s> depth <%d>\n", s, depth);
171         if (depth++ > 10) {
172                 ast_log(LOG_WARNING, "recursion too deep, exiting\n");
173                 return -1;
174         } else if (!say_cfg) {
175                 ast_log(LOG_WARNING, "no say.conf, cannot spell '%s'\n", s);
176                 return -1;
177         }
178
179         /* scan languages same as in file.c */
180         if (a->language == NULL)
181                 a->language = "en";     /* default */
182         ast_debug(2, "try <%s> in <%s>\n", s, a->language);
183         lang = ast_strdupa(a->language);
184         for (;;) {
185                 for (v = ast_variable_browse(say_cfg, lang); v ; v = v->next) {
186                         if (ast_extension_match(v->name, s)) {
187                                 rule = ast_strdupa(v->value);
188                                 break;
189                         }
190                 }
191                 if (rule)
192                         break;
193                 if ( (x = strchr(lang, '_')) )
194                         *x = '\0';      /* try without suffix */
195                 else if (strcmp(lang, "en"))
196                         lang = "en";    /* last resort, try 'en' if not done yet */
197                 else
198                         break;
199         }
200         if (!rule)
201                 return 0;
202
203         /* skip up to two prefixes to get the value */
204         if ( (x = strchr(s, ':')) )
205                 s = x + 1;
206         if ( (x = strchr(s, ':')) )
207                 s = x + 1;
208         ast_debug(2, "value is <%s>\n", s);
209         n = ast_var_assign("SAY", s);
210         AST_LIST_INSERT_HEAD(&head, n, entries);
211
212         /* scan the body, one piece at a time */
213         while ( !ret && (x = strsep(&rule, ",")) ) { /* exit on key */
214                 char fn[128];
215                 const char *p, *fmt, *data; /* format and data pointers */
216
217                 /* prepare a decent file name */
218                 x = ast_skip_blanks(x);
219                 ast_trim_blanks(x);
220
221                 /* replace variables */
222                 pbx_substitute_variables_varshead(&head, x, fn, sizeof(fn));
223                 ast_debug(2, "doing [%s]\n", fn);
224
225                 /* locate prefix and data, if any */
226                 fmt = strchr(fn, ':');
227                 if (!fmt || fmt == fn)  {       /* regular filename */
228                         ret = s_streamwait3(a, fn);
229                         continue;
230                 }
231                 fmt++;
232                 data = strchr(fmt, ':');        /* colon before data */
233                 if (!data || data == fmt) {     /* simple prefix-fmt */
234                         ret = do_say(a, fn, options, depth);
235                         continue;
236                 }
237                 /* prefix:fmt:data */
238                 for (p = fmt; p < data && ret <= 0; p++) {
239                         char fn2[sizeof(fn)];
240                         if (*p == ' ' || *p == '\t')    /* skip blanks */
241                                 continue;
242                         if (*p == '\'') {/* file name - we trim them */
243                                 char *y;
244                                 strcpy(fn2, ast_skip_blanks(p+1));      /* make a full copy */
245                                 y = strchr(fn2, '\'');
246                                 if (!y) {
247                                         p = data;       /* invalid. prepare to end */
248                                         break;
249                                 }
250                                 *y = '\0';
251                                 ast_trim_blanks(fn2);
252                                 p = strchr(p+1, '\'');
253                                 ret = s_streamwait3(a, fn2);
254                         } else {
255                                 int l = fmt-fn;
256                                 strcpy(fn2, fn); /* copy everything */
257                                 /* after prefix, append the format */
258                                 fn2[l++] = *p;
259                                 strcpy(fn2 + l, data);
260                                 ret = do_say(a, fn2, options, depth);
261                         }
262                         
263                         if (ret) {
264                                 break;
265                         }
266                 }
267         }
268         ast_var_delete(n);
269         return ret;
270 }
271
272 static int say_full(struct ast_channel *chan, const char *string,
273         const char *ints, const char *lang, const char *options,
274         int audiofd, int ctrlfd)
275 {
276         say_args_t a = { chan, ints, lang, audiofd, ctrlfd };
277         return do_say(&a, string, options, 0);
278 }
279
280 static int say_number_full(struct ast_channel *chan, int num,
281         const char *ints, const char *lang, const char *options,
282         int audiofd, int ctrlfd)
283 {
284         char buf[64];
285         say_args_t a = { chan, ints, lang, audiofd, ctrlfd };
286         snprintf(buf, sizeof(buf), "num:%d", num);
287         return do_say(&a, buf, options, 0);
288 }
289
290 static int say_enumeration_full(struct ast_channel *chan, int num,
291         const char *ints, const char *lang, const char *options,
292         int audiofd, int ctrlfd)
293 {
294         char buf[64];
295         say_args_t a = { chan, ints, lang, audiofd, ctrlfd };
296         snprintf(buf, sizeof(buf), "enum:%d", num);
297         return do_say(&a, buf, options, 0);
298 }
299
300 static int say_date_generic(struct ast_channel *chan, time_t t,
301         const char *ints, const char *lang, const char *format, const char *timezonename, const char *prefix)
302 {
303         char buf[128];
304         struct ast_tm tm;
305         struct timeval when = { t, 0 };
306         say_args_t a = { chan, ints, lang, -1, -1 };
307         if (format == NULL)
308                 format = "";
309
310         ast_localtime(&when, &tm, NULL);
311         snprintf(buf, sizeof(buf), "%s:%s:%04d%02d%02d%02d%02d.%02d-%d-%3d",
312                 prefix,
313                 format,
314                 tm.tm_year+1900,
315                 tm.tm_mon+1,
316                 tm.tm_mday,
317                 tm.tm_hour,
318                 tm.tm_min,
319                 tm.tm_sec,
320                 tm.tm_wday,
321                 tm.tm_yday);
322         return do_say(&a, buf, NULL, 0);
323 }
324
325 static int say_date_with_format(struct ast_channel *chan, time_t t,
326         const char *ints, const char *lang, const char *format, const char *timezonename)
327 {
328         return say_date_generic(chan, t, ints, lang, format, timezonename, "datetime");
329 }
330
331 static int say_date(struct ast_channel *chan, time_t t, const char *ints, const char *lang)
332 {
333         return say_date_generic(chan, t, ints, lang, "", NULL, "date");
334 }
335
336 static int say_time(struct ast_channel *chan, time_t t, const char *ints, const char *lang)
337 {
338         return say_date_generic(chan, t, ints, lang, "", NULL, "time");
339 }
340
341 static int say_datetime(struct ast_channel *chan, time_t t, const char *ints, const char *lang)
342 {
343         return say_date_generic(chan, t, ints, lang, "", NULL, "datetime");
344 }
345
346 /*
347  * remap the 'say' functions to use those in this file
348  */
349 static int say_init_mode(const char *mode) {
350         if (!strcmp(mode, say_new)) {
351                 if (say_cfg == NULL) {
352                         ast_log(LOG_ERROR, "There is no say.conf file to use new mode\n");
353                         return -1;
354                 }
355                 save_say_mode(say_new);
356                 ast_say_number_full = say_number_full;
357
358                 ast_say_enumeration_full = say_enumeration_full;
359 #if 0
360                 ast_say_digits_full = say_digits_full;
361                 ast_say_digit_str_full = say_digit_str_full;
362                 ast_say_character_str_full = say_character_str_full;
363                 ast_say_phonetic_str_full = say_phonetic_str_full;
364                 ast_say_datetime_from_now = say_datetime_from_now;
365 #endif
366                 ast_say_datetime = say_datetime;
367                 ast_say_time = say_time;
368                 ast_say_date = say_date;
369                 ast_say_date_with_format = say_date_with_format;
370         } else if (!strcmp(mode, say_old) && say_api_buf[0] == say_new) {
371                 restore_say_mode(NULL);
372         } else if (strcmp(mode, say_old)) {
373                 ast_log(LOG_WARNING, "unrecognized mode %s\n", mode);
374                 return -1;
375         }
376         
377         return 0;
378 }
379
380 static char *__say_cli_init(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
381 {
382         const char *old_mode = say_api_buf[0] ? say_new : say_old;
383         char *mode;
384         switch (cmd) {
385         case CLI_INIT:
386                 e->command = "say load [new|old]";
387                 e->usage = 
388                         "Usage: say load [new|old]\n"
389                         "       say load\n"
390                         "           Report status of current say mode\n"
391                         "       say load new\n"
392                         "           Set say method, configured in say.conf\n"
393                         "       say load old\n"
394                         "           Set old say method, coded in asterisk core\n";
395                 return NULL;
396         case CLI_GENERATE:
397                 return NULL;
398         }
399         if (a->argc == 2) {
400                 ast_cli(a->fd, "say mode is [%s]\n", old_mode);
401                 return CLI_SUCCESS;
402         } else if (a->argc != e->args)
403                 return CLI_SHOWUSAGE;
404         mode = a->argv[2];
405         if (!strcmp(mode, old_mode))
406                 ast_cli(a->fd, "say mode is %s already\n", mode);
407         else
408                 if (say_init_mode(mode) == 0)
409                         ast_cli(a->fd, "setting say mode from %s to %s\n", old_mode, mode);
410
411         return CLI_SUCCESS;
412 }
413
414 static struct ast_cli_entry cli_playback[] = {
415         AST_CLI_DEFINE(__say_cli_init, "Set or show the say mode"),
416 };
417
418 static int playback_exec(struct ast_channel *chan, void *data)
419 {
420         int res = 0;
421         int mres = 0;
422         char *tmp;
423         int option_skip=0;
424         int option_say=0;
425         int option_noanswer = 0;
426
427         AST_DECLARE_APP_ARGS(args,
428                 AST_APP_ARG(filenames);
429                 AST_APP_ARG(options);
430         );
431         
432         if (ast_strlen_zero(data)) {
433                 ast_log(LOG_WARNING, "Playback requires an argument (filename)\n");
434                 return -1;
435         }
436
437         tmp = ast_strdupa(data);
438         AST_STANDARD_APP_ARGS(args, tmp);
439
440         if (args.options) {
441                 if (strcasestr(args.options, "skip"))
442                         option_skip = 1;
443                 if (strcasestr(args.options, "say"))
444                         option_say = 1;
445                 if (strcasestr(args.options, "noanswer"))
446                         option_noanswer = 1;
447         } 
448         if (chan->_state != AST_STATE_UP) {
449                 if (option_skip) {
450                         /* At the user's option, skip if the line is not up */
451                         goto done;
452                 } else if (!option_noanswer)
453                         /* Otherwise answer unless we're supposed to send this while on-hook */
454                         res = ast_answer(chan);
455         }
456         if (!res) {
457                 char *back = args.filenames;
458                 char *front;
459
460                 ast_stopstream(chan);
461                 while (!res && (front = strsep(&back, "&"))) {
462                         if (option_say)
463                                 res = say_full(chan, front, "", chan->language, NULL, -1, -1);
464                         else
465                                 res = ast_streamfile(chan, front, chan->language);
466                         if (!res) { 
467                                 res = ast_waitstream(chan, ""); 
468                                 ast_stopstream(chan);
469                         } else {
470                                 ast_log(LOG_WARNING, "ast_streamfile failed on %s for %s\n", chan->name, (char *)data);
471                                 res = 0;
472                                 mres = 1;
473                         }
474                 }
475         }
476 done:
477         pbx_builtin_setvar_helper(chan, "PLAYBACKSTATUS", mres ? "FAILED" : "SUCCESS");
478         return res;
479 }
480
481 static int reload(void)
482 {
483         struct ast_variable *v;
484         struct ast_flags config_flags = { CONFIG_FLAG_FILEUNCHANGED };
485         struct ast_config *newcfg;
486
487         if ((newcfg = ast_config_load("say.conf", config_flags)) == CONFIG_STATUS_FILEUNCHANGED) {
488                 return 0;
489         } else if (newcfg == CONFIG_STATUS_FILEINVALID) {
490                 ast_log(LOG_ERROR, "Config file say.conf is in an invalid format.  Aborting.\n");
491                 return 0;
492         }
493
494         if (say_cfg) {
495                 ast_config_destroy(say_cfg);
496                 ast_log(LOG_NOTICE, "Reloading say.conf\n");
497                 say_cfg = newcfg;
498         }
499
500         if (say_cfg) {
501                 for (v = ast_variable_browse(say_cfg, "general"); v ; v = v->next) {
502                         if (ast_extension_match(v->name, "mode")) {
503                                 say_init_mode(v->value);
504                                 break;
505                         }
506                 }
507         }
508         
509         /*
510          * XXX here we should sort rules according to the same order
511          * we have in pbx.c so we have the same matching behaviour.
512          */
513         return 0;
514 }
515
516 static int unload_module(void)
517 {
518         int res;
519
520         res = ast_unregister_application(app);
521
522         ast_cli_unregister_multiple(cli_playback, ARRAY_LEN(cli_playback));
523
524         if (say_cfg)
525                 ast_config_destroy(say_cfg);
526
527         return res;     
528 }
529
530 static int load_module(void)
531 {
532         struct ast_variable *v;
533         struct ast_flags config_flags = { 0 };
534
535         say_cfg = ast_config_load("say.conf", config_flags);
536         if (say_cfg && say_cfg != CONFIG_STATUS_FILEINVALID) {
537                 for (v = ast_variable_browse(say_cfg, "general"); v ; v = v->next) {
538                         if (ast_extension_match(v->name, "mode")) {
539                                 say_init_mode(v->value);
540                                 break;
541                         }
542                 }
543         }
544
545         ast_cli_register_multiple(cli_playback, ARRAY_LEN(cli_playback));
546         return ast_register_application_xml(app, playback_exec);
547 }
548
549 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Sound File Playback Application",
550                 .load = load_module,
551                 .unload = unload_module,
552                 .reload = reload,
553                );