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