50d96f52ff744c27f00b94868fee14b61d4761df
[asterisk/asterisk.git] / apps / app_waitforring.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 Wait for Ring Application
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 <stdlib.h>
33 #include <stdio.h>
34 #include <string.h>
35 #include <unistd.h>
36 #include <sys/types.h>
37
38 #include "asterisk/file.h"
39 #include "asterisk/logger.h"
40 #include "asterisk/channel.h"
41 #include "asterisk/pbx.h"
42 #include "asterisk/module.h"
43 #include "asterisk/options.h"
44 #include "asterisk/lock.h"
45
46 static char *synopsis = "Wait for Ring Application";
47
48 static char *desc = "  WaitForRing(timeout)\n"
49 "Returns 0 after waiting at least timeout seconds. and\n"
50 "only after the next ring has completed.  Returns 0 on\n"
51 "success or -1 on hangup\n";
52
53 static char *app = "WaitForRing";
54
55
56 static int waitforring_exec(struct ast_channel *chan, void *data)
57 {
58         struct ast_module_user *u;
59         struct ast_frame *f;
60         int res = 0;
61         double s;
62         int ms;
63
64         if (!data || (sscanf(data, "%lg", &s) != 1)) {
65                 ast_log(LOG_WARNING, "WaitForRing requires an argument (minimum seconds)\n");
66                 return 0;
67         }
68
69         u = ast_module_user_add(chan);
70
71         ms = s*1000.0;
72         while(ms > 0) {
73                 ms = ast_waitfor(chan, ms);
74                 if (ms < 0) {
75                         res = ms;
76                         break;
77                 }
78                 if (ms > 0) {
79                         f = ast_read(chan);
80                         if (!f) {
81                                 res = -1;
82                                 break;
83                         }
84                         if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_RING)) {
85                                 if (option_verbose > 2)
86                                         ast_verbose(VERBOSE_PREFIX_3 "Got a ring but still waiting for timeout\n");
87                         }
88                         ast_frfree(f);
89                 }
90         }
91         /* Now we're really ready for the ring */
92         if (!res) {
93                 ms = 99999999;
94                 while(ms > 0) {
95                         ms = ast_waitfor(chan, ms);
96                         if (ms < 0) {
97                                 res = ms;
98                                 break;
99                         }
100                         if (ms > 0) {
101                                 f = ast_read(chan);
102                                 if (!f) {
103                                         res = -1;
104                                         break;
105                                 }
106                                 if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_RING)) {
107                                         if (option_verbose > 2)
108                                                 ast_verbose(VERBOSE_PREFIX_3 "Got a ring after the timeout\n");
109                                         ast_frfree(f);
110                                         break;
111                                 }
112                                 ast_frfree(f);
113                         }
114                 }
115         }
116         ast_module_user_remove(u);
117
118         return res;
119 }
120
121 static int unload_module(void)
122 {
123         return ast_unregister_application(app);
124 }
125
126 static int load_module(void)
127 {
128         return ast_register_application(app, waitforring_exec, synopsis, desc);
129 }
130
131 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Waits until first ring after time");