b6ba16faadcb2d877315441bebf89424da2cb498
[asterisk/asterisk.git] / apps / app_transfer.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 Transfer a caller
22  * 
23  * Requires transfer support from channel driver
24  *
25  * \ingroup applications
26  */
27
28 #include <stdlib.h>
29 #include <unistd.h>
30 #include <string.h>
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include "asterisk/lock.h"
37 #include "asterisk/file.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/module.h"
42 #include "asterisk/options.h"
43
44 STANDARD_LOCAL_USER;
45
46 LOCAL_USER_DECL;
47
48 static const char *tdesc = "Transfer";
49
50 static const char *app = "Transfer";
51
52 static const char *synopsis = "Transfer caller to remote extension";
53
54 static const char *descrip = 
55 "  Transfer([Tech/]dest):  Requests the remote caller be transfered\n"
56 "to a given extension. If TECH (SIP, IAX2, LOCAL etc) is used, only\n"
57 "an incoming call with the same channel technology will be transfered.\n"
58 "Note that for SIP, if you transfer before call is setup, a 302 redirect\n"
59 "SIP message will be returned to the caller.\n"
60 "\nThe result of the application will be reported in the TRANSFERSTATUS\n"
61 "channel variable:\n"
62 "       SUCCESS       Transfer succeeded\n"
63 "       FAILURE      Transfer failed\n"
64 "       UNSUPPORTED  Transfer unsupported by channel driver\n"
65 "Returns -1 on hangup, or 0 on completion regardless of whether the\n"
66 "transfer was successful.\n\n"
67 "Old depraciated behaviour: If the transfer was *not* supported or\n"
68 "successful and there exists a priority n + 101,\n"
69 "then that priority will be taken next.\n" ;
70
71 static int transfer_exec(struct ast_channel *chan, void *data)
72 {
73         int res;
74         int len;
75         struct localuser *u;
76         char *slash;
77         char *tech = NULL;
78         char *dest = data;
79         char *status;
80
81         if (ast_strlen_zero(dest)) {
82                 ast_log(LOG_WARNING, "Transfer requires an argument ([Tech/]destination)\n");
83                 pbx_builtin_setvar_helper(chan, "TRANSFERSTATUS", "FAILURE");
84                 return 0;
85         }
86
87         LOCAL_USER_ADD(u);
88
89         if ((slash = strchr(dest, '/')) && (len = (slash - dest))) {
90                 tech = dest;
91                 dest = slash + 1;
92                 /* Allow execution only if the Tech/destination agrees with the type of the channel */
93                 if (strncasecmp(chan->type, tech, len)) {
94                         pbx_builtin_setvar_helper(chan, "TRANSFERSTATUS", "FAILURE");
95                         LOCAL_USER_REMOVE(u);
96                         return 0;
97                 }
98         }
99
100         /* Check if the channel supports transfer before we try it */
101         if (!chan->tech->transfer) {
102                 pbx_builtin_setvar_helper(chan, "TRANSFERSTATUS", "UNSUPPORTED");
103                 LOCAL_USER_REMOVE(u);
104                 return 0;
105         }
106
107         res = ast_transfer(chan, dest);
108
109         if (res < 0) {
110                 status = "FAILURE";
111                 if (option_priority_jumping)
112                         ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
113                 res = 0;
114         } else {
115                 status = "SUCCESS";
116                 res = 0;
117         }
118
119         pbx_builtin_setvar_helper(chan, "TRANSFERSTATUS", status);
120
121         LOCAL_USER_REMOVE(u);
122
123         return res;
124 }
125
126 int unload_module(void)
127 {
128         int res;
129
130         res = ast_unregister_application(app);
131
132         STANDARD_HANGUP_LOCALUSERS;
133
134         return res;     
135 }
136
137 int load_module(void)
138 {
139         return ast_register_application(app, transfer_exec, synopsis, descrip);
140 }
141
142 char *description(void)
143 {
144         return (char *) tdesc;
145 }
146
147 int usecount(void)
148 {
149         int res;
150
151         STANDARD_USECOUNT(res);
152
153         return res;
154 }
155
156 char *key()
157 {
158         return ASTERISK_GPL_KEY;
159 }