Merge changes from team/group/appdocsxml
[asterisk/asterisk.git] / apps / app_dahdiras.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 Execute an ISDN RAS
22  *
23  * \author Mark Spencer <markster@digium.com>
24  * 
25  * \ingroup applications
26  */
27
28 /*** MODULEINFO
29         <depend>dahdi</depend>
30  ***/
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include <sys/ioctl.h>
37 #include <sys/wait.h>
38 #ifdef __linux__
39 #include <sys/signal.h>
40 #else
41 #include <signal.h>
42 #endif /* __linux__ */
43
44 #include <fcntl.h>
45
46 #include <dahdi/user.h>
47
48 #include "asterisk/lock.h"
49 #include "asterisk/file.h"
50 #include "asterisk/channel.h"
51 #include "asterisk/pbx.h"
52 #include "asterisk/module.h"
53 #include "asterisk/app.h"
54
55 /*** DOCUMENTATION
56         <application name="DAHDIRAS" language="en_US">
57                 <synopsis>
58                         Executes DAHDI ISDN RAS application.
59                 </synopsis>
60                 <syntax>
61                         <parameter name="args" required="true">
62                                 <para>A list of parameters to pass to the pppd daemon,
63                                 separeted by <literal>,</literal> characters.</para>
64                         </parameter>
65                 </syntax>
66                 <description>
67                         <para>Executes a RAS server using pppd on the given channel.
68                         The channel must be a clear channel (i.e. PRI source) and a DAHDI
69                         channel to be able to use this function (No modem emulation is included).</para>
70                         <para>Your pppd must be patched to be DAHDI aware.</para>
71                 </description>
72         </application>
73
74  ***/
75
76 static char *app = "DAHDIRAS";
77
78 #define PPP_MAX_ARGS    32
79 #define PPP_EXEC        "/usr/sbin/pppd"
80
81 static pid_t spawn_ras(struct ast_channel *chan, char *args)
82 {
83         pid_t pid;
84         char *c;
85
86         char *argv[PPP_MAX_ARGS];
87         int argc = 0;
88         char *stringp=NULL;
89
90         /* Start by forking */
91         pid = ast_safe_fork(1);
92         if (pid) {
93                 return pid;
94         }
95
96         /* Execute RAS on File handles */
97         dup2(chan->fds[0], STDIN_FILENO);
98
99         /* Drop high priority */
100         if (ast_opt_high_priority)
101                 ast_set_priority(0);
102
103         /* Close other file descriptors */
104         ast_close_fds_above_n(STDERR_FILENO);
105
106         /* Reset all arguments */
107         memset(argv, 0, sizeof(argv));
108
109         /* First argument is executable, followed by standard
110            arguments for DAHDI PPP */
111         argv[argc++] = PPP_EXEC;
112         argv[argc++] = "nodetach";
113
114         /* And all the other arguments */
115         stringp=args;
116         c = strsep(&stringp, ",");
117         while(c && strlen(c) && (argc < (PPP_MAX_ARGS - 4))) {
118                 argv[argc++] = c;
119                 c = strsep(&stringp, ",");
120         }
121
122         argv[argc++] = "plugin";
123         argv[argc++] = "dahdi.so";
124         argv[argc++] = "stdin";
125
126         /* Finally launch PPP */
127         execv(PPP_EXEC, argv);
128         fprintf(stderr, "Failed to exec PPPD!\n");
129         exit(1);
130 }
131
132 static void run_ras(struct ast_channel *chan, char *args)
133 {
134         pid_t pid;
135         int status;
136         int res;
137         int signalled = 0;
138         struct dahdi_bufferinfo savebi;
139         int x;
140         
141         res = ioctl(chan->fds[0], DAHDI_GET_BUFINFO, &savebi);
142         if(res) {
143                 ast_log(LOG_WARNING, "Unable to check buffer policy on channel %s\n", chan->name);
144                 return;
145         }
146
147         pid = spawn_ras(chan, args);
148         if (pid < 0) {
149                 ast_log(LOG_WARNING, "Failed to spawn RAS\n");
150         } else {
151                 for (;;) {
152                         res = wait4(pid, &status, WNOHANG, NULL);
153                         if (!res) {
154                                 /* Check for hangup */
155                                 if (ast_check_hangup(chan) && !signalled) {
156                                         ast_debug(1, "Channel '%s' hungup.  Signalling RAS at %d to die...\n", chan->name, pid);
157                                         kill(pid, SIGTERM);
158                                         signalled=1;
159                                 }
160                                 /* Try again */
161                                 sleep(1);
162                                 continue;
163                         }
164                         if (res < 0) {
165                                 ast_log(LOG_WARNING, "wait4 returned %d: %s\n", res, strerror(errno));
166                         }
167                         if (WIFEXITED(status)) {
168                                 ast_verb(3, "RAS on %s terminated with status %d\n", chan->name, WEXITSTATUS(status));
169                         } else if (WIFSIGNALED(status)) {
170                                 ast_verb(3, "RAS on %s terminated with signal %d\n", 
171                                          chan->name, WTERMSIG(status));
172                         } else {
173                                 ast_verb(3, "RAS on %s terminated weirdly.\n", chan->name);
174                         }
175                         /* Throw back into audio mode */
176                         x = 1;
177                         ioctl(chan->fds[0], DAHDI_AUDIOMODE, &x);
178
179                         /* Restore saved values */
180                         res = ioctl(chan->fds[0], DAHDI_SET_BUFINFO, &savebi);
181                         if (res < 0) {
182                                 ast_log(LOG_WARNING, "Unable to set buffer policy on channel %s\n", chan->name);
183                         }
184                         break;
185                 }
186         }
187         ast_safe_fork_cleanup();
188 }
189
190 static int dahdiras_exec(struct ast_channel *chan, void *data)
191 {
192         int res=-1;
193         char *args;
194         struct dahdi_params dahdip;
195
196         if (!data) 
197                 data = "";
198
199         args = ast_strdupa(data);
200         
201         /* Answer the channel if it's not up */
202         if (chan->_state != AST_STATE_UP)
203                 ast_answer(chan);
204         if (strcasecmp(chan->tech->type, "DAHDI")) {
205                 /* If it's not a DAHDI channel, we're done.  Wait a couple of
206                    seconds and then hangup... */
207                 ast_verb(2, "Channel %s is not a DAHDI channel\n", chan->name);
208                 sleep(2);
209         } else {
210                 memset(&dahdip, 0, sizeof(dahdip));
211                 if (ioctl(chan->fds[0], DAHDI_GET_PARAMS, &dahdip)) {
212                         ast_log(LOG_WARNING, "Unable to get DAHDI parameters\n");
213                 } else if (dahdip.sigtype != DAHDI_SIG_CLEAR) {
214                         ast_verb(2, "Channel %s is not a clear channel\n", chan->name);
215                 } else {
216                         /* Everything should be okay.  Run PPP. */
217                         ast_verb(3, "Starting RAS on %s\n", chan->name);
218                         /* Execute RAS */
219                         run_ras(chan, args);
220                 }
221         }
222         return res;
223 }
224
225 static int unload_module(void) 
226 {
227         return ast_unregister_application(app);
228 }
229
230 static int load_module(void)
231 {
232         return ((ast_register_application_xml(app, dahdiras_exec)) ? AST_MODULE_LOAD_FAILURE : AST_MODULE_LOAD_SUCCESS);
233 }
234
235 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "DAHDI ISDN Remote Access Server");
236