Doxygen documentation update from oej (issue #5505)
[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  */
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 STANDARD_LOCAL_USER;
42
43 LOCAL_USER_DECL;
44
45 static const char *tdesc = "Transfer";
46
47 static const char *app = "Transfer";
48
49 static const char *synopsis = "Transfer caller to remote extension";
50
51 static const char *descrip = 
52 "  Transfer([Tech/]dest):  Requests the remote caller be transfered\n"
53 "to a given extension. If TECH (SIP, IAX2, LOCAL etc) is used, only\n"
54 "an incoming call with the same channel technology will be transfered.\n"
55 "Note that for SIP, if you transfer before call is setup, a 302 redirect\n"
56 "SIP message will be returned to the caller.\n"
57 "\nThe result of the application will be reported in the TRANSFERSTATUS\n"
58 "channel variable:\n"
59 "       SUCCESS       Transfer succeeded\n"
60 "       FAILURE      Transfer failed\n"
61 "       UNSUPPORTED  Transfer unsupported by channel driver\n"
62 "Returns -1 on hangup, or 0 on completion regardless of whether the\n"
63 "transfer was successful.\n\n"
64 "Old depraciated behaviour: If the transfer was *not* supported or\n"
65 "successful and there exists a priority n + 101,\n"
66 "then that priority will be taken next.\n" ;
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         LOCAL_USER_ADD(u);
85
86         if ((slash = strchr(dest, '/')) && (len = (slash - dest))) {
87                 tech = dest;
88                 dest = slash + 1;
89                 /* Allow execution only if the Tech/destination agrees with the type of the channel */
90                 if (strncasecmp(chan->type, tech, len)) {
91                         pbx_builtin_setvar_helper(chan, "TRANSFERSTATUS", "FAILURE");
92                         LOCAL_USER_REMOVE(u);
93                         return 0;
94                 }
95         }
96
97         /* Check if the channel supports transfer before we try it */
98         if (!chan->tech->transfer) {
99                 pbx_builtin_setvar_helper(chan, "TRANSFERSTATUS", "UNSUPPORTED");
100                 LOCAL_USER_REMOVE(u);
101                 return 0;
102         }
103
104         res = ast_transfer(chan, dest);
105
106         if (res < 0) {
107                 status = "FAILURE";
108                 if (option_priority_jumping)
109                         ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
110                 res = 0;
111         } else {
112                 status = "SUCCESS";
113                 res = 0;
114         }
115
116         pbx_builtin_setvar_helper(chan, "TRANSFERSTATUS", status);
117
118         LOCAL_USER_REMOVE(u);
119
120         return res;
121 }
122
123 int unload_module(void)
124 {
125         int res;
126
127         res = ast_unregister_application(app);
128
129         STANDARD_HANGUP_LOCALUSERS;
130
131         return res;     
132 }
133
134 int load_module(void)
135 {
136         return ast_register_application(app, transfer_exec, synopsis, descrip);
137 }
138
139 char *description(void)
140 {
141         return (char *) tdesc;
142 }
143
144 int usecount(void)
145 {
146         int res;
147
148         STANDARD_USECOUNT(res);
149
150         return res;
151 }
152
153 char *key()
154 {
155         return ASTERISK_GPL_KEY;
156 }