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