include "logger.h" and errno.h from asterisk.h - usage shows that they
[asterisk/asterisk.git] / apps / app_directed_pickup.c
old mode 100755 (executable)
new mode 100644 (file)
index e9282d2..b823f58
@@ -3,7 +3,7 @@
  *
  * Copyright (C) 2005, Joshua Colp
  *
- * Joshua Colp <jcolp@asterlink.com>
+ * Joshua Colp <jcolp@digium.com>
  *
  * See http://www.asterisk.org for more information about
  * the Asterisk project. Please do not directly contact
  * at the top of the source tree.
  */
 
-/*
+/*! \file
+ *
+ * \brief Directed Call Pickup Support
  *
- * Directed Call Pickup Support
+ * \author Joshua Colp <jcolp@digium.com>
  *
+ * \ingroup applications
  */
 
-#include <stdlib.h>
-#include <unistd.h>
-#include <string.h>
-
 #include "asterisk.h"
 
 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
 #include "asterisk/file.h"
-#include "asterisk/logger.h"
 #include "asterisk/channel.h"
 #include "asterisk/pbx.h"
 #include "asterisk/module.h"
 #include "asterisk/lock.h"
 #include "asterisk/app.h"
+#include "asterisk/options.h"
+#include "asterisk/features.h"
+
+#define PICKUPMARK "PICKUPMARK"
 
-static const char *tdesc = "Directed Call Pickup Application";
 static const char *app = "Pickup";
-static const char *synopsis = "Directed Call Pickup application.";
+static const char *synopsis = "Directed Call Pickup";
 static const char *descrip =
-" Pickup(extension@context):\n"
-"Steals any calls to a specified extension that are in a ringing state and bridges them to the current channel. Context is an optional argument.\n";
+"  Pickup([extension[@context][&extension2@[context]...]]):  This application can\n"
+"pickup any ringing channel that is calling the specified extension.  If no\n"
+"context is specified, the current context will be used. If you use the special\n"
+"string \"PICKUPMARK\" for the context parameter, for example 10@PICKUPMARK,\n"
+"this application tries to find a channel which has defined a ${PICKUPMARK}\n"
+"channel variable with the same value as \"extension\" (in this example, \"10\").\n"
+"When no parameter is specified, the application will pickup a channel matching\n"
+"the pickup group of the active channel.";
+
+/* Perform actual pickup between two channels */
+static int pickup_do(struct ast_channel *chan, struct ast_channel *target)
+{
+       int res = 0;
 
-STANDARD_LOCAL_USER;
+       ast_debug(1, "Call pickup on '%s' by '%s'\n", target->name, chan->name);
 
-LOCAL_USER_DECL;
+       if ((res = ast_answer(chan))) {
+               ast_log(LOG_WARNING, "Unable to answer '%s'\n", chan->name);
+               return -1;
+       }
 
-static int pickup_exec(struct ast_channel *chan, void *data)
-{
-       int res = 0;
-       struct localuser *u = NULL;
-       struct ast_channel *origin = NULL, *target = NULL;
-       char *tmp = NULL, *exten = NULL, *context = NULL;
-       char workspace[256] = "";
-
-       /* Get the extension and context if present */
-       exten = data;
-       context = strchr(data, '@');
-       if (context) {
-               *context = '\0';
-               context++;
+       if ((res = ast_queue_control(chan, AST_CONTROL_ANSWER))) {
+               ast_log(LOG_WARNING, "Unable to queue answer on '%s'\n", chan->name);
+               return -1;
        }
 
-       /* Make sure we atleast have an extension to work with */
-       if (!exten) {
-               ast_log(LOG_WARNING, "%s requires atleast one argument (extension)\n", app);
+       if ((res = ast_channel_masquerade(target, chan))) {
+               ast_log(LOG_WARNING, "Unable to masquerade '%s' into '%s'\n", chan->name, target->name);
                return -1;
        }
 
-       LOCAL_USER_ADD(u);
+       return res;
+}
 
-       /* Find a channel to pickup */
-       origin = ast_get_channel_by_exten_locked(exten, context);
-       if (origin) {
-               ast_cdr_getvar(origin->cdr, "dstchannel", &tmp, workspace,
-                              sizeof(workspace), 0);
-               if (tmp) {
-                       /* We have a possible channel... now we need to find it! */
-                       target = ast_get_channel_by_name_locked(tmp);
-               } else {
-                       ast_log(LOG_DEBUG, "No target channel found.\n");
-                       res = -1;
-               }
-               ast_mutex_unlock(&origin->lock);
-       } else {
-               ast_log(LOG_DEBUG, "No originating channel found.\n");
-       }
-       
-       if (res)
-               goto out;
-
-       if (target && (!target->pbx) && ((target->_state == AST_STATE_RINGING) || (target->_state == AST_STATE_RING))) {
-               ast_log(LOG_DEBUG, "Call pickup on chan '%s' by '%s'\n", target->name,
-                       chan->name);
-               res = ast_answer(chan);
-               if (res) {
-                       ast_log(LOG_WARNING, "Unable to answer '%s'\n", chan->name);
-                       res = -1;
-                       ast_mutex_unlock(&target->lock);
-                       goto out;
-               }
-               res = ast_queue_control(chan, AST_CONTROL_ANSWER);
-               if (res) {
-                       ast_log(LOG_WARNING, "Unable to queue answer on '%s'\n",
-                               chan->name);
-                       res = -1;
-                       ast_mutex_unlock(&target->lock);
-                       goto out;
-               }
-               res = ast_channel_masquerade(target, chan);
-               if (res) {
-                       ast_log(LOG_WARNING, "Unable to masquerade '%s' into '%s'\n", chan->name, target->name);
-                       res = -1;
-                       ast_mutex_unlock(&target->lock);
-                       goto out;
+/* Helper function that determines whether a channel is capable of being picked up */
+static int can_pickup(struct ast_channel *chan)
+{
+       if (!chan->pbx && (chan->_state == AST_STATE_RINGING || chan->_state == AST_STATE_RING))
+               return 1;
+       else
+               return 0;
+}
+
+/* Attempt to pick up specified extension with context */
+static int pickup_by_exten(struct ast_channel *chan, const char *exten, const char *context)
+{
+       int res = -1;
+       struct ast_channel *target = NULL;
+
+       while ((target = ast_channel_walk_locked(target))) {
+               if ((!strcasecmp(target->macroexten, exten) || !strcasecmp(target->exten, exten)) &&
+                   !strcasecmp(target->dialcontext, context) &&
+                   can_pickup(target)) {
+                       res = pickup_do(chan, target);
+                       ast_channel_unlock(target);
+                       break;
                }
-               /* Done */
-               ast_mutex_unlock(&target->lock);
-       } else {
-               ast_log(LOG_DEBUG, "No call pickup possible...\n");
-               res = -1;
+               ast_channel_unlock(target);
        }
-       
- out:
-       LOCAL_USER_REMOVE(u);
 
        return res;
 }
 
-int unload_module(void)
+/* Attempt to pick up specified mark */
+static int pickup_by_mark(struct ast_channel *chan, const char *mark)
 {
-       STANDARD_HANGUP_LOCALUSERS;
+       int res = -1;
+       const char *tmp = NULL;
+       struct ast_channel *target = NULL;
+
+       while ((target = ast_channel_walk_locked(target))) {
+               if ((tmp = pbx_builtin_getvar_helper(target, PICKUPMARK)) &&
+                   !strcasecmp(tmp, mark) &&
+                   can_pickup(target)) {
+                       res = pickup_do(chan, target);
+                       ast_channel_unlock(target);
+                       break;
+               }
+               ast_channel_unlock(target);
+       }
 
-       return ast_unregister_application(app);
+       return res;
 }
 
-int load_module(void)
+/* Main application entry point */
+static int pickup_exec(struct ast_channel *chan, void *data)
 {
-       return ast_register_application(app, pickup_exec, synopsis, descrip);
-}
+       int res = 0;
+       char *tmp = ast_strdupa(data);
+       char *exten = NULL, *context = NULL;
 
-char *description(void)
-{
-       return (char *) tdesc;
+       if (ast_strlen_zero(data)) {
+               res = ast_pickup_call(chan);
+               return res;
+       }
+       
+       /* Parse extension (and context if there) */
+       while (!ast_strlen_zero(tmp) && (exten = strsep(&tmp, "&"))) {
+               if ((context = strchr(exten, '@')))
+                       *context++ = '\0';
+               if (!ast_strlen_zero(context) && !strcasecmp(context, PICKUPMARK)) {
+                       if (!pickup_by_mark(chan, exten))
+                               break;
+               } else {
+                       if (!pickup_by_exten(chan, exten, !ast_strlen_zero(context) ? context : chan->context))
+                               break;
+               }
+               ast_log(LOG_NOTICE, "No target channel found for %s.\n", exten);
+       }
+
+       return res;
 }
 
-int usecount(void)
+static int unload_module(void)
 {
        int res;
 
-       STANDARD_USECOUNT(res);
-
+       res = ast_unregister_application(app);
+       
        return res;
 }
 
-char *key()
+static int load_module(void)
 {
-       return ASTERISK_GPL_KEY;
+       return ast_register_application(app, pickup_exec, synopsis, descrip);
 }
+
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Directed Call Pickup Application");