Merged revisions 328247 via svnmerge from
[asterisk/asterisk.git] / bridges / bridge_builtin_features.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@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 Built in bridging features
22  *
23  * \author Joshua Colp <jcolp@digium.com>
24  *
25  * \ingroup bridges
26  */
27
28 /*** MODULEINFO
29         <support_level>core</support_level>
30  ***/
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include <stdio.h>
37 #include <stdlib.h>
38 #include <string.h>
39 #include <sys/types.h>
40 #include <sys/stat.h>
41
42 #include "asterisk/module.h"
43 #include "asterisk/channel.h"
44 #include "asterisk/bridging.h"
45 #include "asterisk/bridging_technology.h"
46 #include "asterisk/frame.h"
47 #include "asterisk/file.h"
48 #include "asterisk/app.h"
49 #include "asterisk/astobj2.h"
50
51 /*! \brief Helper function that presents dialtone and grabs extension */
52 static int grab_transfer(struct ast_channel *chan, char *exten, size_t exten_len, const char *context)
53 {
54         int res;
55
56         /* Play the simple "transfer" prompt out and wait */
57         res = ast_stream_and_wait(chan, "pbx-transfer", AST_DIGIT_ANY);
58         ast_stopstream(chan);
59
60         /* If the person hit a DTMF digit while the above played back stick it into the buffer */
61         if (res) {
62                 exten[0] = (char)res;
63         }
64
65         /* Drop to dialtone so they can enter the extension they want to transfer to */
66         res = ast_app_dtget(chan, context, exten, exten_len, 100, 1000);
67
68         return res;
69 }
70
71 /*! \brief Helper function that creates an outgoing channel and returns it immediately */
72 static struct ast_channel *dial_transfer(const struct ast_channel *caller, const char *exten, const char *context)
73 {
74         char destination[AST_MAX_EXTENSION+AST_MAX_CONTEXT+1] = "";
75         struct ast_channel *chan = NULL;
76         int cause;
77
78         /* Fill the variable with the extension and context we want to call */
79         snprintf(destination, sizeof(destination), "%s@%s", exten, context);
80
81         /* Now we request that chan_local prepare to call the destination */
82         if (!(chan = ast_request("Local", caller->nativeformats, caller, destination, &cause))) {
83                 return NULL;
84         }
85
86         /* Before we actually dial out let's inherit the appropriate dialplan variables */
87         ast_channel_inherit_variables(caller, chan);
88
89         /* Since the above worked fine now we actually call it and return the channel */
90         if (ast_call(chan, destination, 0)) {
91                 ast_hangup(chan);
92                 return NULL;
93         }
94
95         return chan;
96 }
97
98 /*! \brief Internal built in feature for blind transfers */
99 static int feature_blind_transfer(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, void *hook_pvt)
100 {
101         char exten[AST_MAX_EXTENSION] = "";
102         struct ast_channel *chan = NULL;
103         struct ast_bridge_features_blind_transfer *blind_transfer = hook_pvt;
104         const char *context = (blind_transfer && !ast_strlen_zero(blind_transfer->context) ? blind_transfer->context : bridge_channel->chan->context);
105
106         /* Grab the extension to transfer to */
107         if (!grab_transfer(bridge_channel->chan, exten, sizeof(exten), context)) {
108                 ast_stream_and_wait(bridge_channel->chan, "pbx-invalid", AST_DIGIT_ANY);
109                 ast_bridge_change_state(bridge_channel, AST_BRIDGE_CHANNEL_STATE_WAIT);
110                 return 0;
111         }
112
113         /* Get a channel that is the destination we wish to call */
114         if (!(chan = dial_transfer(bridge_channel->chan, exten, context))) {
115                 ast_stream_and_wait(bridge_channel->chan, "beeperr", AST_DIGIT_ANY);
116                 ast_bridge_change_state(bridge_channel, AST_BRIDGE_CHANNEL_STATE_WAIT);
117                 return 0;
118         }
119
120         /* This is sort of the fun part. We impart the above channel onto the bridge, and have it take our place. */
121         ast_bridge_impart(bridge, chan, bridge_channel->chan, NULL);
122
123         return 0;
124 }
125
126 /*! \brief Attended transfer feature to turn it into a threeway call */
127 static int attended_threeway_transfer(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, void *hook_pvt)
128 {
129         /* This is sort of abusing the depart state but in this instance it is only going to be handled in the below function so it is okay */
130         ast_bridge_change_state(bridge_channel, AST_BRIDGE_CHANNEL_STATE_DEPART);
131         return 0;
132 }
133
134 /*! \brief Attended transfer abort feature */
135 static int attended_abort_transfer(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, void *hook_pvt)
136 {
137         struct ast_bridge_channel *called_bridge_channel = NULL;
138
139         /* It is possible (albeit unlikely) that the bridge channels list may change, so we have to ensure we do all of our magic while locked */
140         ao2_lock(bridge);
141
142         if (AST_LIST_FIRST(&bridge->channels) != bridge_channel) {
143                 called_bridge_channel = AST_LIST_FIRST(&bridge->channels);
144         } else {
145                 called_bridge_channel = AST_LIST_LAST(&bridge->channels);
146         }
147
148         /* Now we basically eject the other channel from the bridge. This will cause their thread to hang them up, and our own code to consider the transfer failed. */
149         if (called_bridge_channel) {
150                 ast_bridge_change_state(called_bridge_channel, AST_BRIDGE_CHANNEL_STATE_HANGUP);
151         }
152
153         ast_bridge_change_state(bridge_channel, AST_BRIDGE_CHANNEL_STATE_END);
154
155         ao2_unlock(bridge);
156
157         return 0;
158 }
159
160 /*! \brief Internal built in feature for attended transfers */
161 static int feature_attended_transfer(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, void *hook_pvt)
162 {
163         char exten[AST_MAX_EXTENSION] = "";
164         struct ast_channel *chan = NULL;
165         struct ast_bridge *attended_bridge = NULL;
166         struct ast_bridge_features caller_features, called_features;
167         enum ast_bridge_channel_state attended_bridge_result;
168         struct ast_bridge_features_attended_transfer *attended_transfer = hook_pvt;
169         const char *context = (attended_transfer && !ast_strlen_zero(attended_transfer->context) ? attended_transfer->context : bridge_channel->chan->context);
170
171         /* Grab the extension to transfer to */
172         if (!grab_transfer(bridge_channel->chan, exten, sizeof(exten), context)) {
173                 ast_stream_and_wait(bridge_channel->chan, "pbx-invalid", AST_DIGIT_ANY);
174                 ast_bridge_change_state(bridge_channel, AST_BRIDGE_CHANNEL_STATE_WAIT);
175                 return 0;
176         }
177
178         /* Get a channel that is the destination we wish to call */
179         if (!(chan = dial_transfer(bridge_channel->chan, exten, context))) {
180                 ast_stream_and_wait(bridge_channel->chan, "beeperr", AST_DIGIT_ANY);
181                 ast_bridge_change_state(bridge_channel, AST_BRIDGE_CHANNEL_STATE_WAIT);
182                 return 0;
183         }
184
185         /* Create a bridge to use to talk to the person we are calling */
186         if (!(attended_bridge = ast_bridge_new(AST_BRIDGE_CAPABILITY_1TO1MIX, 0))) {
187                 ast_hangup(chan);
188                 ast_stream_and_wait(bridge_channel->chan, "beeperr", AST_DIGIT_ANY);
189                 ast_bridge_change_state(bridge_channel, AST_BRIDGE_CHANNEL_STATE_WAIT);
190                 return 0;
191         }
192
193         /* Setup our called features structure so that if they hang up we immediately get thrown out of the bridge */
194         ast_bridge_features_init(&called_features);
195         ast_bridge_features_set_flag(&called_features, AST_BRIDGE_FLAG_DISSOLVE);
196
197         /* This is how this is going down, we are imparting the channel we called above into this bridge first */
198         ast_bridge_impart(attended_bridge, chan, NULL, &called_features);
199
200         /* Before we join setup a features structure with the hangup option, just in case they want to use DTMF */
201         ast_bridge_features_init(&caller_features);
202         ast_bridge_features_enable(&caller_features, AST_BRIDGE_BUILTIN_HANGUP,
203                                    (attended_transfer && !ast_strlen_zero(attended_transfer->complete) ? attended_transfer->complete : "*1"), NULL);
204         ast_bridge_features_hook(&caller_features, (attended_transfer && !ast_strlen_zero(attended_transfer->threeway) ? attended_transfer->threeway : "*2"),
205                                  attended_threeway_transfer, NULL, NULL);
206         ast_bridge_features_hook(&caller_features, (attended_transfer && !ast_strlen_zero(attended_transfer->abort) ? attended_transfer->abort : "*3"),
207                                  attended_abort_transfer, NULL, NULL);
208
209         /* But for the caller we want to join the bridge in a blocking fashion so we don't spin around in this function doing nothing while waiting */
210         attended_bridge_result = ast_bridge_join(attended_bridge, bridge_channel->chan, NULL, &caller_features, NULL);
211
212         /* Since the above returned the caller features structure is of no more use */
213         ast_bridge_features_cleanup(&caller_features);
214
215         /* Drop the channel we are transferring to out of the above bridge since it has ended */
216         if ((attended_bridge_result != AST_BRIDGE_CHANNEL_STATE_HANGUP) && !ast_bridge_depart(attended_bridge, chan)) {
217                 /* If the user wants to turn this into a threeway transfer then do so, otherwise they take our place */
218                 if (attended_bridge_result == AST_BRIDGE_CHANNEL_STATE_DEPART) {
219                         /* We want to impart them upon the bridge and just have us return to it as normal */
220                         ast_bridge_impart(bridge, chan, NULL, NULL);
221                 } else {
222                         ast_bridge_impart(bridge, chan, bridge_channel->chan, NULL);
223                 }
224         } else {
225                 ast_stream_and_wait(bridge_channel->chan, "beeperr", AST_DIGIT_ANY);
226                 ast_bridge_change_state(bridge_channel, AST_BRIDGE_CHANNEL_STATE_WAIT);
227         }
228
229         /* Now that all channels are out of it we can destroy the bridge and the called features structure */
230         ast_bridge_features_cleanup(&called_features);
231         ast_bridge_destroy(attended_bridge);
232
233         return 0;
234 }
235
236 /*! \brief Internal built in feature for hangup */
237 static int feature_hangup(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, void *hook_pvt)
238 {
239         /* This is very simple, we basically change the state on the bridge channel to end and the core takes care of the rest */
240         ast_bridge_change_state(bridge_channel, AST_BRIDGE_CHANNEL_STATE_END);
241         return 0;
242 }
243
244 static int unload_module(void)
245 {
246         return 0;
247 }
248
249 static int load_module(void)
250 {
251         ast_bridge_features_register(AST_BRIDGE_BUILTIN_BLINDTRANSFER, feature_blind_transfer, NULL);
252         ast_bridge_features_register(AST_BRIDGE_BUILTIN_ATTENDEDTRANSFER, feature_attended_transfer, NULL);
253         ast_bridge_features_register(AST_BRIDGE_BUILTIN_HANGUP, feature_hangup, NULL);
254
255         /* Bump up our reference count so we can't be unloaded */
256         ast_module_ref(ast_module_info->self);
257
258         return AST_MODULE_LOAD_SUCCESS;
259 }
260
261 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Built in bridging features");