Massive cleanups to applications for LOCAL_USER handling and some other things.
[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 /*
20  *
21  * Wait for Ring Application
22  * 
23  */
24
25 #include <stdlib.h>
26 #include <unistd.h>
27 #include <string.h>
28 #include <stdlib.h>
29 #include <sys/types.h>
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/file.h"
36 #include "asterisk/logger.h"
37 #include "asterisk/channel.h"
38 #include "asterisk/pbx.h"
39 #include "asterisk/module.h"
40 #include "asterisk/options.h"
41 #include "asterisk/lock.h"
42
43 static char *synopsis = "Wait for Ring Application";
44
45 static char *tdesc = "Waits until first ring after time";
46
47 static char *desc = "  WaitForRing(timeout)\n"
48 "Returns 0 after waiting at least timeout seconds. and\n"
49 "only after the next ring has completed.  Returns 0 on\n"
50 "success or -1 on hangup\n";
51
52 static char *app = "WaitForRing";
53
54 STANDARD_LOCAL_USER;
55
56 LOCAL_USER_DECL;
57
58 static int waitforring_exec(struct ast_channel *chan, void *data)
59 {
60         struct localuser *u;
61         struct ast_frame *f;
62         int res = 0;
63         int ms;
64
65         if (!data || (sscanf(data, "%d", &ms) != 1)) {
66                 ast_log(LOG_WARNING, "WaitForRing requires an argument (minimum seconds)\n");
67                 return 0;
68         }
69
70         LOCAL_USER_ADD(u);
71
72         ms *= 1000;
73         while(ms > 0) {
74                 ms = ast_waitfor(chan, ms);
75                 if (ms < 0) {
76                         res = ms;
77                         break;
78                 }
79                 if (ms > 0) {
80                         f = ast_read(chan);
81                         if (!f) {
82                                 res = -1;
83                                 break;
84                         }
85                         if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_RING)) {
86                                 if (option_verbose > 2)
87                                         ast_verbose(VERBOSE_PREFIX_3 "Got a ring but still waiting for timeout\n");
88                         }
89                         ast_frfree(f);
90                 }
91         }
92         /* Now we're really ready for the ring */
93         if (!res) {
94                 ms = 99999999;
95                 while(ms > 0) {
96                         ms = ast_waitfor(chan, ms);
97                         if (ms < 0) {
98                                 res = ms;
99                                 break;
100                         }
101                         if (ms > 0) {
102                                 f = ast_read(chan);
103                                 if (!f) {
104                                         res = -1;
105                                         break;
106                                 }
107                                 if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_RING)) {
108                                         if (option_verbose > 2)
109                                                 ast_verbose(VERBOSE_PREFIX_3 "Got a ring after the timeout\n");
110                                         ast_frfree(f);
111                                         break;
112                                 }
113                                 ast_frfree(f);
114                         }
115                 }
116         }
117         LOCAL_USER_REMOVE(u);
118
119         return res;
120 }
121
122 int unload_module(void)
123 {
124         int res;
125
126         res = ast_unregister_application(app);
127
128         STANDARD_HANGUP_LOCALUSERS;
129
130         return res;     
131 }
132
133 int load_module(void)
134 {
135         return ast_register_application(app, waitforring_exec, synopsis, desc);
136 }
137
138 char *description(void)
139 {
140         return tdesc;
141 }
142
143 int usecount(void)
144 {
145         int res;
146         STANDARD_USECOUNT(res);
147         return res;
148 }
149
150 char *key()
151 {
152         return ASTERISK_GPL_KEY;
153 }