Improve child process reaping (bug #278)
[asterisk/asterisk.git] / res / res_musiconhold.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Routines implementing call parking
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #include <asterisk/lock.h>
15 #include <asterisk/file.h>
16 #include <asterisk/logger.h>
17 #include <asterisk/channel.h>
18 #include <asterisk/pbx.h>
19 #include <asterisk/options.h>
20 #include <asterisk/module.h>
21 #include <asterisk/translate.h>
22 #include <asterisk/say.h>
23 #include <asterisk/channel_pvt.h>
24 #include <asterisk/musiconhold.h>
25 #include <asterisk/config.h>
26 #include <stdlib.h>
27 #include <errno.h>
28 #include <unistd.h>
29 #include <string.h>
30 #include <signal.h>
31 #include <stdlib.h>
32 #include <stdio.h>
33 #include <sys/time.h>
34 #include <sys/signal.h>
35 #include <netinet/in.h>
36 #include <sys/stat.h>
37 #include <dirent.h>
38 #ifdef ZAPATA_MOH
39 #include <linux/zaptel.h>
40 #endif
41 #include <unistd.h>
42 #include <sys/ioctl.h>
43 #include <sys/wait.h>
44
45 #include <pthread.h>
46
47 static char *app0 = "MusicOnHold";
48 static char *app1 = "WaitMusicOnHold";
49 static char *app2 = "SetMusicOnHold";
50
51 static char *synopsis0 = "Play Music On Hold indefinitely";
52 static char *synopsis1 = "Wait, playing Music On Hold";
53 static char *synopsis2 = "Set default Music On Hold class";
54
55 static char *descrip0 = "MusicOnHold(class): "
56 "Plays hold music specified by class.  If omitted, the default\n"
57 "music source for the channel will be used.  Returns -1 on hangup.\n"
58 "Never returns otherwise.\n";
59
60 static char *descrip1 = "WaitMusicOnHold(delay): "
61 "Plays hold music specified number of seconds.  Returns 0 when\n"
62 "done, or -1 on hangup.  If no hold music is available, the delay will\n"
63 "still occur with no sound.\n";
64
65 static char *descrip2 = "SetMusicOnHold(class): "
66 "Sets the default class for music on hold for a given channel.  When\n"
67 "music on hold is activated, this class will be used to select which\n"
68 "music is played.\n";
69
70 struct mohclass {
71         char class[80];
72         char dir[256];
73         char miscargs[256];
74         int destroyme;
75         int pid;                /* PID of mpg123 */
76         int quiet;
77         pthread_t thread;
78         struct mohdata *members;
79         /* Source of audio */
80         int srcfd;
81         /* FD for timing source */
82         int pseudofd;
83         struct mohclass *next;
84 };
85
86 struct mohdata {
87         int pipe[2];
88         int origwfmt;
89         struct mohclass *parent;
90         struct mohdata *next;
91 };
92
93 static struct mohclass *mohclasses;
94
95 static ast_mutex_t moh_lock = AST_MUTEX_INITIALIZER;
96
97 #define LOCAL_MPG_123 "/usr/local/bin/mpg123"
98 #define MPG_123 "/usr/bin/mpg123"
99 #define MAX_MP3S 256
100
101 static int spawn_mp3(struct mohclass *class)
102 {
103         int fds[2];
104         int files;
105         char fns[MAX_MP3S][80];
106         char *argv[MAX_MP3S + 50];
107         char xargs[256];
108         char *argptr;
109         int argc;
110         DIR *dir;
111         struct dirent *de;
112         dir = opendir(class->dir);
113         if (!dir) {
114                 ast_log(LOG_WARNING, "%s is not a valid directory\n", class->dir);
115                 return -1;
116         }
117         argv[0] = "mpg123";
118         argv[1] = "-q";
119         argv[2] = "-s";
120         argv[3] = "--mono";
121         argv[4] = "-r";
122         argv[5] = "8000";
123         argv[6] = "-b";
124         argv[7] = "2048";
125         argc = 8;
126         if (class->quiet) {
127                 argv[argc++] = "-f";
128                 argv[argc++] = "8192";
129         }
130
131         /* Look for extra arguments and add them to the list */
132         strncpy(xargs, class->miscargs, sizeof(xargs) - 1);
133         argptr = xargs;
134         while(argptr && strlen(argptr)) {
135                 argv[argc++] = argptr;
136                 argptr = strchr(argptr, ',');
137                 if (argptr) {
138                         *argptr = '\0';
139                         argptr++;
140                 }
141         }
142
143         files = 0;
144         while((de = readdir(dir)) && (files < MAX_MP3S)) {
145                 if ((strlen(de->d_name) > 3) && !strcasecmp(de->d_name + strlen(de->d_name) - 4, ".mp3")) {
146                         strncpy(fns[files], de->d_name, sizeof(fns[files]));
147                         argv[argc++] = fns[files];
148                         files++;
149                 }
150         }
151         argv[argc] = NULL;
152         closedir(dir);
153         if (pipe(fds)) {        
154                 ast_log(LOG_WARNING, "Pipe failed\n");
155                 return -1;
156         }
157 #if 0
158         printf("%d files total, %d args total\n", files, argc);
159         {
160                 int x;
161                 for (x=0;argv[x];x++)
162                         printf("arg%d: %s\n", x, argv[x]);
163         }
164 #endif  
165         if (!files) {
166                 ast_log(LOG_WARNING, "Found no files in '%s'\n", class->dir);
167                 return -1;
168         }
169         class->pid = fork();
170         if (class->pid < 0) {
171                 close(fds[0]);
172                 close(fds[1]);
173                 ast_log(LOG_WARNING, "Fork failed: %s\n", strerror(errno));
174                 return -1;
175         }
176         if (!class->pid) {
177                 int x;
178                 close(fds[0]);
179                 /* Stdout goes to pipe */
180                 dup2(fds[1], STDOUT_FILENO);
181                 /* Close unused file descriptors */
182                 for (x=3;x<8192;x++)
183                         close(x);
184                 /* Child */
185                 chdir(class->dir);
186                 /* Default install is /usr/local/bin */
187                 execv(LOCAL_MPG_123, argv);
188                 /* Many places have it in /usr/bin */
189                 execv(MPG_123, argv);
190                 /* Check PATH as a last-ditch effort */
191                 execvp("mpg123", argv);
192                 ast_log(LOG_WARNING, "Exec failed: %s\n", strerror(errno));
193                 exit(1);
194         } else {
195                 /* Parent */
196                 close(fds[1]);
197         }
198         return fds[0];
199 }
200
201 static void *monmp3thread(void *data)
202 {
203 #define MOH_MS_INTERVAL         100
204
205         struct mohclass *class = data;
206         struct mohdata *moh;
207         char buf[8192];
208         short sbuf[8192];
209         int res, res2;
210         struct timeval tv;
211         struct timeval tv_tmp;
212         long error_sec, error_usec;
213         long delay;
214
215         tv_tmp.tv_sec = 0;
216         tv_tmp.tv_usec = 0;
217         tv.tv_sec = 0;
218         tv.tv_usec = 0;
219         error_sec = 0;
220         error_usec = 0;
221         for(;/* ever */;) {
222                 /* Spawn mp3 player if it's not there */
223                 if (class->srcfd < 0)  {
224                         if ((class->srcfd = spawn_mp3(class)) < 0) {
225                                 ast_log(LOG_WARNING, "unable to spawn mp3player\n");
226                                 /* Try again later */
227                                 sleep(500);
228                         }
229                 }
230                 if (class->pseudofd > -1) {
231                         /* Pause some amount of time */
232                         res = read(class->pseudofd, buf, sizeof(buf));
233                 } else {
234                         /* Reliable sleep */
235                         if (gettimeofday(&tv_tmp, NULL) < 0) {
236                                 ast_log(LOG_NOTICE, "gettimeofday() failed!\n");
237                                 return NULL;
238                         }
239                         if (((unsigned long)(tv.tv_sec) > 0)&&((unsigned long)(tv.tv_usec) > 0)) {
240                                 if ((unsigned long)(tv_tmp.tv_usec) < (unsigned long)(tv.tv_usec)) {
241                                         tv_tmp.tv_usec += 1000000;
242                                         tv_tmp.tv_sec -= 1;
243                                 }
244                                 error_sec = (unsigned long)(tv_tmp.tv_sec) - (unsigned long)(tv.tv_sec);
245                                 error_usec = (unsigned long)(tv_tmp.tv_usec) - (unsigned long)(tv.tv_usec);
246                         } else {
247                                 error_sec = 0;
248                                 error_usec = 0;
249                         }
250                         if (error_sec * 1000 + error_usec / 1000 < MOH_MS_INTERVAL) {
251                                 tv.tv_sec = tv_tmp.tv_sec + (MOH_MS_INTERVAL/1000 - error_sec);
252                                 tv.tv_usec = tv_tmp.tv_usec + ((MOH_MS_INTERVAL % 1000) * 1000 - error_usec);
253                                 delay = (MOH_MS_INTERVAL/1000 - error_sec) * 1000 +
254                                                         ((MOH_MS_INTERVAL % 1000) * 1000 - error_usec) / 1000;
255                         } else {
256                                 ast_log(LOG_NOTICE, "Request to schedule in the past?!?!\n");
257                                 tv.tv_sec = tv_tmp.tv_sec;
258                                 tv.tv_usec = tv_tmp.tv_usec;
259                                 delay = 0;
260                         }
261                         if (tv.tv_usec > 1000000) {
262                                 tv.tv_sec++;
263                                 tv.tv_usec-= 1000000;
264                         }
265                         if (delay > 0)
266                                 usleep(delay * 1000);
267                         res = 800;              /* 800 samples */
268                 }
269                 if (!class->members)
270                         continue;
271                 /* Read mp3 audio */
272                 if ((res2 = read(class->srcfd, sbuf, res * 2)) != res * 2) {
273                         if (!res2) {
274                                 close(class->srcfd);
275                                 class->srcfd = -1;
276                                 if (class->pid) {
277                                         kill(class->pid, SIGKILL);
278                                         class->pid = 0;
279                                 }
280                         } else
281                                 ast_log(LOG_DEBUG, "Read %d bytes of audio while expecting %d\n", res2, res * 2);
282                         continue;
283                 }
284                 ast_mutex_lock(&moh_lock);
285                 moh = class->members;
286                 while(moh) {
287                         /* Write data */
288                         if ((res = write(moh->pipe[1], sbuf, res2)) != res2) 
289                                 if (option_debug)
290                                     ast_log(LOG_DEBUG, "Only wrote %d of %d bytes to pipe\n", res, res2);
291                         moh = moh->next;
292                 }
293                 ast_mutex_unlock(&moh_lock);
294         }
295         return NULL;
296 }
297
298 static int moh0_exec(struct ast_channel *chan, void *data)
299 {
300         if (ast_moh_start(chan, data)) {
301                 ast_log(LOG_WARNING, "Unable to start music on hold (class '%s') on channel %s\n", (char *)data, chan->name);
302                 return -1;
303         }
304         while(!ast_safe_sleep(chan, 10000));
305         return -1;
306 }
307
308 static int moh1_exec(struct ast_channel *chan, void *data)
309 {
310         int res;
311         if (!data || !atoi(data)) {
312                 ast_log(LOG_WARNING, "WaitMusicOnHold requires an argument (number of seconds to wait)\n");
313                 return -1;
314         }
315         if (ast_moh_start(chan, NULL)) {
316                 ast_log(LOG_WARNING, "Unable to start music on hold (class '%s') on channel %s\n", (char *)data, chan->name);
317                 return -1;
318         }
319         res = ast_safe_sleep(chan, atoi(data) * 1000);
320         ast_moh_stop(chan);
321         return res;
322 }
323
324 static int moh2_exec(struct ast_channel *chan, void *data)
325 {
326         if (!data || !strlen(data)) {
327                 ast_log(LOG_WARNING, "SetMusicOnHold requires an argument (class)\n");
328                 return -1;
329         }
330         strncpy(chan->musicclass, data, sizeof(chan->musicclass));
331         return 0;
332 }
333
334 static struct mohclass *get_mohbyname(char *name)
335 {
336         struct mohclass *moh;
337         moh = mohclasses;
338         while(moh) {
339                 if (!strcasecmp(name, moh->class))
340                         return moh;
341                 moh = moh->next;
342         }
343         return NULL;
344 }
345
346 static struct mohdata *mohalloc(struct mohclass *cl)
347 {
348         struct mohdata *moh;
349         long flags;
350         moh = malloc(sizeof(struct mohdata));
351         if (!moh)
352                 return NULL;
353         memset(moh, 0, sizeof(struct mohdata));
354         if (pipe(moh->pipe)) {
355                 ast_log(LOG_WARNING, "Failed to create pipe: %s\n", strerror(errno));
356                 free(moh);
357                 return NULL;
358         }
359         /* Make entirely non-blocking */
360         flags = fcntl(moh->pipe[0], F_GETFL);
361         fcntl(moh->pipe[0], F_SETFL, flags | O_NONBLOCK);
362         flags = fcntl(moh->pipe[1], F_GETFL);
363         fcntl(moh->pipe[1], F_SETFL, flags | O_NONBLOCK);
364         moh->parent = cl;
365         moh->next = cl->members;
366         cl->members = moh;
367         return moh;
368 }
369
370 static void moh_release(struct ast_channel *chan, void *data)
371 {
372         struct mohdata *moh = data, *prev, *cur;
373         int oldwfmt;
374         ast_mutex_lock(&moh_lock);
375         /* Unlink */
376         prev = NULL;
377         cur = moh->parent->members;
378         while(cur) {
379                 if (cur == moh) {
380                         if (prev)
381                                 prev->next = cur->next;
382                         else
383                                 moh->parent->members = cur->next;
384                         break;
385                 }
386                 prev = cur;
387                 cur = cur->next;
388         }
389         ast_mutex_unlock(&moh_lock);
390         close(moh->pipe[0]);
391         close(moh->pipe[1]);
392         oldwfmt = moh->origwfmt;
393         free(moh);
394         if (chan) {
395                 if (oldwfmt && ast_set_write_format(chan, oldwfmt)) 
396                         ast_log(LOG_WARNING, "Unable to restore channel '%s' to format %s\n", chan->name, ast_getformatname(oldwfmt));
397                 if (option_verbose > 2)
398                         ast_verbose(VERBOSE_PREFIX_3 "Stopped music on hold on %s\n", chan->name);
399         }
400 }
401
402 static void *moh_alloc(struct ast_channel *chan, void *params)
403 {
404         struct mohdata *res;
405         struct mohclass *class;
406         ast_mutex_lock(&moh_lock);
407         class = get_mohbyname(params);
408         if (class)
409                 res = mohalloc(class);
410         else {
411                 if (strcasecmp(params, "default"))
412                         ast_log(LOG_WARNING, "No class: %s\n", (char *)params);
413                 res = NULL;
414         }
415         ast_mutex_unlock(&moh_lock);
416         if (res) {
417                 res->origwfmt = chan->writeformat;
418                 if (ast_set_write_format(chan, AST_FORMAT_SLINEAR)) {
419                         ast_log(LOG_WARNING, "Unable to set '%s' to signed linear format\n", chan->name);
420                         moh_release(NULL, res);
421                         res = NULL;
422                 }
423 #if 0
424                 /* Allow writes to interrupt */
425                 chan->writeinterrupt = 1;
426 #endif          
427                 if (option_verbose > 2)
428                         ast_verbose(VERBOSE_PREFIX_3 "Started music on hold, class '%s', on %s\n", (char *)params, chan->name);
429         }
430         return res;
431 }
432
433 static int moh_generate(struct ast_channel *chan, void *data, int len, int samples)
434 {
435         struct ast_frame f;
436         struct mohdata *moh = data;
437         short buf[1280 + AST_FRIENDLY_OFFSET / 2];
438         int res;
439
440         len = samples * 2;
441         if (len > sizeof(buf) - AST_FRIENDLY_OFFSET) {
442                 ast_log(LOG_WARNING, "Only doing %d of %d requested bytes on %s\n", sizeof(buf), len, chan->name);
443                 len = sizeof(buf) - AST_FRIENDLY_OFFSET;
444         }
445         res = read(moh->pipe[0], buf + AST_FRIENDLY_OFFSET/2, len);
446 #if 0
447         if (res != len) {
448                 ast_log(LOG_WARNING, "Read only %d of %d bytes: %s\n", res, len, strerror(errno));
449         }
450 #endif
451         if (res > 0) {
452                 memset(&f, 0, sizeof(f));
453                 f.frametype = AST_FRAME_VOICE;
454                 f.subclass = AST_FORMAT_SLINEAR;
455                 f.mallocd = 0;
456                 f.datalen = res;
457                 f.samples = res / 2;
458                 f.data = buf + AST_FRIENDLY_OFFSET / 2;
459                 f.offset = AST_FRIENDLY_OFFSET;
460                 if (ast_write(chan, &f)< 0) {
461                         ast_log(LOG_WARNING, "Failed to write frame to '%s': %s\n", chan->name, strerror(errno));
462                         return -1;
463                 }
464         }
465         return 0;
466 }
467
468 static struct ast_generator mohgen = 
469 {
470         alloc: moh_alloc,
471         release: moh_release,
472         generate: moh_generate,
473 };
474
475 static int moh_register(char *classname, char *mode, char *param, char *miscargs)
476 {
477         struct mohclass *moh;
478 #ifdef ZAPATA_MOH
479         int x;
480 #endif
481         ast_mutex_lock(&moh_lock);
482         moh = get_mohbyname(classname);
483         ast_mutex_unlock(&moh_lock);
484         if (moh) {
485                 ast_log(LOG_WARNING, "Music on Hold '%s' already exists\n", classname);
486                 return -1;
487         }
488         moh = malloc(sizeof(struct mohclass));
489         if (!moh)
490                 return -1;
491         memset(moh, 0, sizeof(struct mohclass));
492
493         strncpy(moh->class, classname, sizeof(moh->class) - 1);
494         if (miscargs)
495                 strncpy(moh->miscargs, miscargs, sizeof(moh->miscargs) - 1);
496         if (!strcasecmp(mode, "mp3") || !strcasecmp(mode, "quietmp3") || !strcasecmp(mode, "httpmp3")) {
497                 if (!strcasecmp(mode, "quietmp3"))
498                         moh->quiet = 1;
499                 strncpy(moh->dir, param, sizeof(moh->dir) - 1);
500                 moh->srcfd = -1;
501 #ifdef ZAPATA_MOH
502                 /* It's an MP3 Moh -- Open /dev/zap/pseudo for timing...  Is
503                    there a better, yet reliable way to do this? */
504                 moh->pseudofd = open("/dev/zap/pseudo", O_RDONLY);
505                 if (moh->pseudofd < 0) {
506                         ast_log(LOG_WARNING, "Unable to open pseudo channel for timing...  Sound may be choppy.\n");
507                 } else {
508                         x = 320;
509                         ioctl(moh->pseudofd, ZT_SET_BLOCKSIZE, &x);
510                 }
511 #else
512                 moh->pseudofd = -1;
513 #endif
514                 if (pthread_create(&moh->thread, NULL, monmp3thread, moh)) {
515                         ast_log(LOG_WARNING, "Unable to create moh...\n");
516                         if (moh->pseudofd > -1)
517                                 close(moh->pseudofd);
518                         free(moh);
519                         return -1;
520                 }
521         } else {
522                 ast_log(LOG_WARNING, "Don't know how to do a mode '%s' music on hold\n", mode);
523                 free(moh);
524                 return -1;
525         }
526         ast_mutex_lock(&moh_lock);
527         moh->next = mohclasses;
528         mohclasses = moh;
529         ast_mutex_unlock(&moh_lock);
530         return 0;
531 }
532
533 int ast_moh_start(struct ast_channel *chan, char *class)
534 {
535         if (!class || !strlen(class))
536                 class = chan->musicclass;
537         if (!class || !strlen(class))
538                 class = "default";
539         return ast_activate_generator(chan, &mohgen, class);
540 }
541
542 void ast_moh_stop(struct ast_channel *chan)
543 {
544         ast_deactivate_generator(chan);
545 }
546
547 static void load_moh_classes(void)
548 {
549         struct ast_config *cfg;
550         struct ast_variable *var;
551         char *data;
552         char *args;
553         cfg = ast_load("musiconhold.conf");
554         if (cfg) {
555                 var = ast_variable_browse(cfg, "classes");
556                 while(var) {
557                         data = strchr(var->value, ':');
558                         if (data) {
559                                 *data = '\0';
560                                 data++;
561                                 args = strchr(data, ',');
562                                 if (args) {
563                                         *args = '\0';
564                                         args++;
565                                 }
566                                 moh_register(var->name, var->value, data,args);
567                         }
568                         var = var->next;
569                 }
570                 ast_destroy(cfg);
571         }
572 }
573
574 static void ast_moh_destroy(void)
575 {
576         struct mohclass *moh;
577         char buff[8192];
578         int bytes, tbytes=0, stime = 0;
579         if (option_verbose > 1)
580                 ast_verbose(VERBOSE_PREFIX_2 "Destroying any remaining musiconhold processes\n");
581         ast_mutex_lock(&moh_lock);
582         moh = mohclasses;
583         while(moh) {
584                 if (moh->pid) {
585                         ast_log(LOG_DEBUG, "killing %d!\n", moh->pid);
586                         stime = time(NULL);
587                         kill(moh->pid, SIGABRT);
588                         while ((bytes = read(moh->srcfd, buff, 8192)) && time(NULL) < stime + 5) {
589                                 tbytes = tbytes + bytes;
590                         }
591                         ast_log(LOG_DEBUG, "mpg123 pid %d and child died after %d bytes read\n", moh->pid, tbytes);
592                         close(moh->srcfd);
593                         moh->pid = 0;
594                         }
595                 moh = moh->next;
596         }
597         ast_mutex_unlock(&moh_lock);
598 }
599
600 int load_module(void)
601 {
602         int res;
603         load_moh_classes();
604         res = ast_register_application(app0, moh0_exec, synopsis0, descrip0);
605         ast_register_atexit(ast_moh_destroy);
606         if (!res)
607                 res = ast_register_application(app1, moh1_exec, synopsis1, descrip1);
608         if (!res)
609                 res = ast_register_application(app2, moh2_exec, synopsis2, descrip2);
610         return res;
611 }
612
613 int unload_module(void)
614 {
615         return -1;
616 }
617
618 char *description(void)
619 {
620         return "Music On Hold Resource";
621 }
622
623 int usecount(void)
624 {
625         /* Never allow Music On Hold to be unloaded
626            unresolve needed symbols in the dialer */
627 #if 0
628         int res;
629         STANDARD_USECOUNT(res);
630         return res;
631 #else
632         return 1;
633 #endif
634 }
635
636 char *key()
637 {
638         return ASTERISK_GPL_KEY;
639 }