issue #5646
[asterisk/asterisk.git] / apps / app_transfer.c
index 61f2b9d..4443a78 100755 (executable)
@@ -1,14 +1,28 @@
 /*
- * 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.
+ */
+
+/*! \file
+ *
+ * \brief Transfer a caller
+ * 
+ * Requires transfer support from channel driver
+ *
+ * \ingroup applications
  */
 
 #include <stdlib.h>
@@ -26,6 +40,11 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/pbx.h"
 #include "asterisk/module.h"
 #include "asterisk/options.h"
+#include "asterisk/app.h"
+
+STANDARD_LOCAL_USER;
+
+LOCAL_USER_DECL;
 
 static const char *tdesc = "Transfer";
 
@@ -34,25 +53,19 @@ static const char *app = "Transfer";
 static const char *synopsis = "Transfer caller to remote extension";
 
 static const 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"
+"  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"
 "\nThe result of the application will be reported in the TRANSFERSTATUS\n"
 "channel variable:\n"
-"       SUCCESS       Transfer succeeded\n"
+"       SUCCESS      Transfer succeeded\n"
 "       FAILURE      Transfer failed\n"
 "       UNSUPPORTED  Transfer unsupported by channel driver\n"
-"Returns -1 on hangup, or 0 on completion regardless of whether the\n"
-"transfer was successful.\n\n"
-"Old depraciated behaviour: 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;
+"The option string many contain the following character:\n"
+"'j' -- jump to n+101 priority if the channel transfer attempt\n"
+"       fails\n";
 
 static int transfer_exec(struct ast_channel *chan, void *data)
 {
@@ -61,21 +74,47 @@ static int transfer_exec(struct ast_channel *chan, void *data)
        struct localuser *u;
        char *slash;
        char *tech = NULL;
-       char *dest = data;
+       char *dest = NULL;
        char *status;
+       char *parse;
+       int priority_jump = 0;
+       AST_DECLARE_APP_ARGS(args,
+               AST_APP_ARG(dest);
+               AST_APP_ARG(options);
+       );
+
+       LOCAL_USER_ADD(u);
 
-       if (!dest || ast_strlen_zero(dest)) {
-               ast_log(LOG_WARNING, "Transfer requires an argument ([Tech/]destination)\n");
+       if (ast_strlen_zero((char *)data)) {
+               ast_log(LOG_WARNING, "Transfer requires an argument ([Tech/]destination[|options])\n");
+               LOCAL_USER_REMOVE(u);
                pbx_builtin_setvar_helper(chan, "TRANSFERSTATUS", "FAILURE");
                return 0;
+       } else {
+               parse = ast_strdupa(data);
+               if (!parse) {
+                       ast_log(LOG_ERROR, "Out of memory!\n");
+                       LOCAL_USER_REMOVE(u);
+                       return -1;
+               }
+       }
+
+       AST_STANDARD_APP_ARGS(args, parse);
+
+       if (args.options) {
+               if (strchr(args.options, 'j'))
+                       priority_jump = 1;
        }
 
+       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, tech, len)) {
                        pbx_builtin_setvar_helper(chan, "TRANSFERSTATUS", "FAILURE");
+                       LOCAL_USER_REMOVE(u);
                        return 0;
                }
        }
@@ -83,16 +122,15 @@ static int transfer_exec(struct ast_channel *chan, void *data)
        /* Check if the channel supports transfer before we try it */
        if (!chan->tech->transfer) {
                pbx_builtin_setvar_helper(chan, "TRANSFERSTATUS", "UNSUPPORTED");
+               LOCAL_USER_REMOVE(u);
                return 0;
        }
 
-       LOCAL_USER_ADD(u);
-
        res = ast_transfer(chan, dest);
 
        if (res < 0) {
                status = "FAILURE";
-               if (option_priority_jumping)
+               if (priority_jump || option_priority_jumping)
                        ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
                res = 0;
        } else {
@@ -109,9 +147,13 @@ static int transfer_exec(struct ast_channel *chan, void *data)
 
 int unload_module(void)
 {
+       int res;
+
+       res = ast_unregister_application(app);
+
        STANDARD_HANGUP_LOCALUSERS;
 
-       return ast_unregister_application(app);
+       return res;     
 }
 
 int load_module(void)