Merged revisions 73316 via svnmerge from
[asterisk/asterisk.git] / apps / app_transfer.c
old mode 100755 (executable)
new mode 100644 (file)
index 846e4fc..4d918f6
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
- * Transfer a caller
- * 
  * Copyright (C) 1999 - 2005, Digium, Inc.
  *
  * Mark Spencer <markster@digium.com>
  *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
  * This program is free software, distributed under the terms of
- * the GNU General Public License
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
  */
 
-#include <asterisk/lock.h>
-#include <asterisk/file.h>
-#include <asterisk/logger.h>
-#include <asterisk/channel.h>
-#include <asterisk/pbx.h>
-#include <asterisk/module.h>
+/*! \file
+ *
+ * \brief Transfer a caller
+ *
+ * \author Mark Spencer <markster@digium.com>
+ * 
+ * Requires transfer support from channel driver
+ *
+ * \ingroup applications
+ */
+
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
 #include <stdlib.h>
-#include <unistd.h>
+#include <stdio.h>
 #include <string.h>
-#include <stdlib.h>
+#include <unistd.h>
+
+#include "asterisk/lock.h"
+#include "asterisk/file.h"
+#include "asterisk/logger.h"
+#include "asterisk/channel.h"
+#include "asterisk/pbx.h"
+#include "asterisk/module.h"
+#include "asterisk/options.h"
+#include "asterisk/app.h"
 
-static char *tdesc = "Transfer";
 
-static char *app = "Transfer";
+static const char *app = "Transfer";
 
-static char *synopsis = "Transfer caller to remote extension";
+static const char *synopsis = "Transfer caller to remote extension";
 
-static char *descrip = 
-"  Transfer([Tech/]dest):  Requests the remote caller be transfered\n"
-"to a given extension. If TECH (SIP, IAX2, LOCAL etc) is used, only\n"
+static const char *descrip = 
+"  Transfer([Tech/]dest[|options]):  Requests the remote caller be transferred\n"
+"to a given destination. If TECH (SIP, IAX2, LOCAL etc) is used, only\n"
 "an incoming call with the same channel technology will be transfered.\n"
 "Note that for SIP, if you transfer before call is setup, a 302 redirect\n"
 "SIP message will be returned to the caller.\n"
-"Returns -1 on hangup, or 0 on completion regardless of whether the\n"
-"transfer was successful.  If the transfer was *not* supported or\n"
-"successful and there exists a priority n + 101,\n"
-"then that priority will be taken next.\n" ;
-
-STANDARD_LOCAL_USER;
-
-LOCAL_USER_DECL;
+"\nThe result of the application will be reported in the TRANSFERSTATUS\n"
+"channel variable:\n"
+"       SUCCESS      Transfer succeeded\n"
+"       FAILURE      Transfer failed\n"
+"       UNSUPPORTED  Transfer unsupported by channel driver\n";
 
 static int transfer_exec(struct ast_channel *chan, void *data)
 {
-       int res=0;
+       int res;
        int len;
-       struct localuser *u;
+       struct ast_module_user *u;
        char *slash;
-       if (!data || !strlen(data)) {
-               ast_log(LOG_WARNING, "Transfer requires an argument ([Tech/]destination)\n");
-               res = 1;
+       char *tech = NULL;
+       char *dest = NULL;
+       char *status;
+       char *parse;
+       AST_DECLARE_APP_ARGS(args,
+               AST_APP_ARG(dest);
+               AST_APP_ARG(options);
+       );
+
+       u = ast_module_user_add(chan);
+
+       if (ast_strlen_zero((char *)data)) {
+               ast_log(LOG_WARNING, "Transfer requires an argument ([Tech/]destination[|options])\n");
+               ast_module_user_remove(u);
+               pbx_builtin_setvar_helper(chan, "TRANSFERSTATUS", "FAILURE");
+               return 0;
+       } else
+               parse = ast_strdupa(data);
+
+       AST_STANDARD_APP_ARGS(args, parse);
+
+       if (args.options) {
        }
-       if ((slash = strchr((char *)data, '/')) && (len = (slash - (char *)data))) {
+
+       dest = args.dest;
+
+       if ((slash = strchr(dest, '/')) && (len = (slash - dest))) {
+               tech = dest;
+               dest = slash + 1;
                /* Allow execution only if the Tech/destination agrees with the type of the channel */
-               if (strncasecmp(chan->type, (char *)data, len))
+               if (strncasecmp(chan->tech->type, tech, len)) {
+                       pbx_builtin_setvar_helper(chan, "TRANSFERSTATUS", "FAILURE");
+                       ast_module_user_remove(u);
                        return 0;
+               }
        }
-       LOCAL_USER_ADD(u);
-       if (!res) {
-               res = ast_transfer(chan, data + strlen(chan->type) + 1);
-       }
-       if (!res) {
-               /* Look for a "busy" place */
-               if (ast_exists_extension(chan, chan->context, chan->exten, chan->priority + 101, chan->cid.cid_num))
-                       chan->priority += 100;
+
+       /* Check if the channel supports transfer before we try it */
+       if (!chan->tech->transfer) {
+               pbx_builtin_setvar_helper(chan, "TRANSFERSTATUS", "UNSUPPORTED");
+               ast_module_user_remove(u);
+               return 0;
        }
-       if (res > 0)
+
+       res = ast_transfer(chan, dest);
+
+       if (res < 0) {
+               status = "FAILURE";
                res = 0;
-       LOCAL_USER_REMOVE(u);
-       return res;
-}
+       } else {
+               status = "SUCCESS";
+               res = 0;
+       }
 
-int unload_module(void)
-{
-       STANDARD_HANGUP_LOCALUSERS;
-       return ast_unregister_application(app);
-}
+       pbx_builtin_setvar_helper(chan, "TRANSFERSTATUS", status);
 
-int load_module(void)
-{
-       return ast_register_application(app, transfer_exec, synopsis, descrip);
-}
+       ast_module_user_remove(u);
 
-char *description(void)
-{
-       return tdesc;
+       return res;
 }
 
-int usecount(void)
+static int unload_module(void)
 {
        int res;
-       STANDARD_USECOUNT(res);
-       return res;
+
+       res = ast_unregister_application(app);
+
+       ast_module_user_hangup_all();
+
+       return res;     
 }
 
-char *key()
+static int load_module(void)
 {
-       return ASTERISK_GPL_KEY;
+       return ast_register_application(app, transfer_exec, synopsis, descrip);
 }
+
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Transfers a caller to another extension");