The purpose of this patch is to eliminate struct ast_callerid since it has turned into a miscellaneous collection of various party information. Eliminate struct ast_callerid and replace it with the following struct organization: struct ast_party_name { char *str; int char_set; int presentation; unsigned char valid; }; struct ast_party_number { char *str; int plan; int presentation; unsigned char valid; }; struct ast_party_subaddress { char *str; int type; unsigned char odd_even_indicator; unsigned char valid; }; struct ast_party_id { struct ast_party_name name; struct ast_party_number number; struct ast_party_subaddress subaddress; char *tag; }; struct ast_party_dialed { struct { char *str; int plan; } number; struct ast_party_subaddress subaddress; int transit_network_select; }; struct ast_party_caller { struct ast_party_id id; char *ani; int ani2; }; The new organization adds some new information as well. * The party name and number now have their own presentation value that can be manipulated independently. ISDN supplies the presentation value for the name and number at different times with the possibility that they could be different. * The party name and number now have a valid flag. Before this change the name or number string could be empty if the presentation were restricted. Most channel drivers assume that the name or number is then simply not available instead of indicating that the name or number was restricted. * The party name now has a character set value. SIP and Q.SIG have the ability to indicate what character set a name string is using so it could be presented properly. * The dialed party now has a numbering plan value that could be useful to have available. The various channel drivers will need to be updated to support the new core features as needed. They have simply been converted to supply current functionality at this time. The following items of note were either corrected or enhanced: * The CONNECTEDLINE() and REDIRECTING() dialplan functions were consolidated into func_callerid.c to share party id handling code. * CALLERPRES() is now deprecated because the name and number have their own presentation values. * Fixed app_alarmreceiver.c write_metadata(). The workstring[] could contain garbage. It also can only contain the caller id number so using ast_callerid_parse() on it is silly. There was also a typo in the CALLERNAME if test. * Fixed app_rpt.c using ast_callerid_parse() on the channel's caller id number string. ast_callerid_parse() alters the given buffer which in this case is the channel's caller id number string. Then using ast_shrink_phone_number() could alter it even more. * Fixed caller ID name and number memory leak in chan_usbradio.c. * Fixed uninitialized char arrays cid_num[] and cid_name[] in sig_analog.c. * Protected access to a caller channel with lock in chan_sip.c. * Clarified intent of code in app_meetme.c sla_ring_station() and dial_trunk(). Also made save all caller ID data instead of just the name and number strings. * Simplified cdr.c set_one_cid(). It hand coded the ast_callerid_merge() function. * Corrected some weirdness with app_privacy.c's use of caller presentation. Review: https://reviewboard.asterisk.org/r/702/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@276347 65c4cc65-6c06-0410-ace0-fbb531ad65f3
408 lines
11 KiB
C
408 lines
11 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2005, Joshua Colp
|
|
*
|
|
* Joshua Colp <jcolp@digium.com>
|
|
*
|
|
* Portions merged from app_pickupchan, which was
|
|
* Copyright (C) 2008, Gary Cook
|
|
*
|
|
* 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 Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Directed Call Pickup Support
|
|
*
|
|
* \author Joshua Colp <jcolp@digium.com>
|
|
* \author Gary Cook
|
|
*
|
|
* \ingroup applications
|
|
*/
|
|
|
|
#include "asterisk.h"
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
#include "asterisk/file.h"
|
|
#include "asterisk/channel.h"
|
|
#include "asterisk/pbx.h"
|
|
#include "asterisk/module.h"
|
|
#include "asterisk/lock.h"
|
|
#include "asterisk/app.h"
|
|
#include "asterisk/features.h"
|
|
#include "asterisk/manager.h"
|
|
#include "asterisk/callerid.h"
|
|
#include "asterisk/cel.h"
|
|
|
|
#define PICKUPMARK "PICKUPMARK"
|
|
|
|
/*** DOCUMENTATION
|
|
<application name="Pickup" language="en_US">
|
|
<synopsis>
|
|
Directed extension call pickup.
|
|
</synopsis>
|
|
<syntax argsep="&">
|
|
<parameter name="ext" argsep="@" required="true">
|
|
<argument name="extension" required="true"/>
|
|
<argument name="context" />
|
|
</parameter>
|
|
<parameter name="ext2" argsep="@" multiple="true">
|
|
<argument name="extension2" required="true"/>
|
|
<argument name="context2"/>
|
|
</parameter>
|
|
</syntax>
|
|
<description>
|
|
<para>This application can pickup any ringing channel that is calling
|
|
the specified <replaceable>extension</replaceable>. If no <replaceable>context</replaceable>
|
|
is specified, the current context will be used. If you use the special string <literal>PICKUPMARK</literal>
|
|
for the context parameter, for example 10@PICKUPMARK, this application
|
|
tries to find a channel which has defined a <variable>PICKUPMARK</variable>
|
|
channel variable with the same value as <replaceable>extension</replaceable>
|
|
(in this example, <literal>10</literal>). When no parameter is specified, the application
|
|
will pickup a channel matching the pickup group of the active channel.</para>
|
|
</description>
|
|
</application>
|
|
<application name="PickupChan" language="en_US">
|
|
<synopsis>
|
|
Pickup a ringing channel.
|
|
</synopsis>
|
|
<syntax>
|
|
<parameter name="channel" required="true" />
|
|
<parameter name="channel2" multiple="true" />
|
|
<parameter name="options" required="false">
|
|
<optionlist>
|
|
<option name="p">
|
|
<para>Channel name specified partial name. Used when find channel by callid.</para>
|
|
</option>
|
|
</optionlist>
|
|
</parameter>
|
|
</syntax>
|
|
<description>
|
|
<para>This will pickup a specified <replaceable>channel</replaceable> if ringing.</para>
|
|
</description>
|
|
</application>
|
|
***/
|
|
|
|
static const char app[] = "Pickup";
|
|
static const char app2[] = "PickupChan";
|
|
/*! \todo This application should return a result code, like PICKUPRESULT */
|
|
|
|
/* Perform actual pickup between two channels */
|
|
static int pickup_do(struct ast_channel *chan, struct ast_channel *target)
|
|
{
|
|
int res = 0;
|
|
struct ast_party_connected_line connected_caller;
|
|
struct ast_channel *chans[2] = { chan, target };
|
|
|
|
ast_debug(1, "Call pickup on '%s' by '%s'\n", target->name, chan->name);
|
|
ast_cel_report_event(target, AST_CEL_PICKUP, NULL, NULL, chan);
|
|
|
|
ast_party_connected_line_init(&connected_caller);
|
|
ast_party_connected_line_copy(&connected_caller, &target->connected);
|
|
connected_caller.source = AST_CONNECTED_LINE_UPDATE_SOURCE_ANSWER;
|
|
if (ast_channel_connected_line_macro(NULL, chan, &connected_caller, 0, 0)) {
|
|
ast_channel_update_connected_line(chan, &connected_caller, NULL);
|
|
}
|
|
ast_party_connected_line_free(&connected_caller);
|
|
|
|
ast_channel_lock(chan);
|
|
ast_connected_line_copy_from_caller(&connected_caller, &chan->caller);
|
|
ast_channel_unlock(chan);
|
|
connected_caller.source = AST_CONNECTED_LINE_UPDATE_SOURCE_ANSWER;
|
|
ast_channel_queue_connected_line_update(chan, &connected_caller, NULL);
|
|
ast_party_connected_line_free(&connected_caller);
|
|
|
|
if ((res = ast_answer(chan))) {
|
|
ast_log(LOG_WARNING, "Unable to answer '%s'\n", chan->name);
|
|
return -1;
|
|
}
|
|
|
|
if ((res = ast_queue_control(chan, AST_CONTROL_ANSWER))) {
|
|
ast_log(LOG_WARNING, "Unable to queue answer on '%s'\n", chan->name);
|
|
return -1;
|
|
}
|
|
|
|
if ((res = ast_channel_masquerade(target, chan))) {
|
|
ast_log(LOG_WARNING, "Unable to masquerade '%s' into '%s'\n", chan->name, target->name);
|
|
return -1;
|
|
}
|
|
|
|
/* If you want UniqueIDs, set channelvars in manager.conf to CHANNEL(uniqueid) */
|
|
ast_manager_event_multichan(EVENT_FLAG_CALL, "Pickup", 2, chans,
|
|
"Channel: %s\r\nTargetChannel: %s\r\n", chan->name, target->name);
|
|
|
|
return res;
|
|
}
|
|
|
|
/* 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 || chan->_state == AST_STATE_DOWN))
|
|
return 1;
|
|
else
|
|
return 0;
|
|
}
|
|
|
|
struct pickup_by_name_args {
|
|
const char *name;
|
|
size_t len;
|
|
};
|
|
|
|
static int pickup_by_name_cb(void *obj, void *arg, void *data, int flags)
|
|
{
|
|
struct ast_channel *chan = obj;
|
|
struct pickup_by_name_args *args = data;
|
|
|
|
ast_channel_lock(chan);
|
|
if (!strncasecmp(chan->name, args->name, args->len) && can_pickup(chan)) {
|
|
/* Return with the channel still locked on purpose */
|
|
return CMP_MATCH | CMP_STOP;
|
|
}
|
|
ast_channel_unlock(chan);
|
|
|
|
return 0;
|
|
}
|
|
|
|
/*! \brief Helper Function to walk through ALL channels checking NAME and STATE */
|
|
static struct ast_channel *my_ast_get_channel_by_name_locked(const char *channame)
|
|
{
|
|
char *chkchan;
|
|
struct pickup_by_name_args pickup_args;
|
|
|
|
pickup_args.len = strlen(channame) + 1;
|
|
|
|
chkchan = alloca(pickup_args.len + 1);
|
|
|
|
/* need to append a '-' for the comparison so we check full channel name,
|
|
* i.e SIP/hgc- , use a temporary variable so original stays the same for
|
|
* debugging.
|
|
*/
|
|
strcpy(chkchan, channame);
|
|
strcat(chkchan, "-");
|
|
|
|
pickup_args.name = chkchan;
|
|
|
|
return ast_channel_callback(pickup_by_name_cb, NULL, &pickup_args, 0);
|
|
}
|
|
|
|
/*! \brief Attempt to pick up specified channel named , does not use context */
|
|
static int pickup_by_channel(struct ast_channel *chan, char *pickup)
|
|
{
|
|
int res = 0;
|
|
struct ast_channel *target;
|
|
|
|
if (!(target = my_ast_get_channel_by_name_locked(pickup))) {
|
|
return -1;
|
|
}
|
|
|
|
/* Just check that we are not picking up the SAME as target */
|
|
if (chan != target) {
|
|
res = pickup_do(chan, target);
|
|
}
|
|
|
|
ast_channel_unlock(target);
|
|
target = ast_channel_unref(target);
|
|
|
|
return res;
|
|
}
|
|
|
|
/* Attempt to pick up specified extension with context */
|
|
static int pickup_by_exten(struct ast_channel *chan, const char *exten, const char *context)
|
|
{
|
|
struct ast_channel *target = NULL;
|
|
struct ast_channel_iterator *iter;
|
|
int res = -1;
|
|
|
|
if (!(iter = ast_channel_iterator_by_exten_new(exten, context))) {
|
|
return -1;
|
|
}
|
|
|
|
while ((target = ast_channel_iterator_next(iter))) {
|
|
ast_channel_lock(target);
|
|
if ((chan != target) && can_pickup(target)) {
|
|
break;
|
|
}
|
|
ast_channel_unlock(target);
|
|
target = ast_channel_unref(target);
|
|
}
|
|
|
|
ast_channel_iterator_destroy(iter);
|
|
|
|
if (target) {
|
|
res = pickup_do(chan, target);
|
|
ast_channel_unlock(target);
|
|
target = ast_channel_unref(target);
|
|
}
|
|
|
|
return res;
|
|
}
|
|
|
|
static int find_by_mark(void *obj, void *arg, void *data, int flags)
|
|
{
|
|
struct ast_channel *c = obj;
|
|
const char *mark = data;
|
|
const char *tmp;
|
|
int res;
|
|
|
|
ast_channel_lock(c);
|
|
|
|
res = (tmp = pbx_builtin_getvar_helper(c, PICKUPMARK)) &&
|
|
!strcasecmp(tmp, mark) &&
|
|
can_pickup(c);
|
|
|
|
ast_channel_unlock(c);
|
|
|
|
return res ? CMP_MATCH | CMP_STOP : 0;
|
|
}
|
|
|
|
/* Attempt to pick up specified mark */
|
|
static int pickup_by_mark(struct ast_channel *chan, const char *mark)
|
|
{
|
|
struct ast_channel *target;
|
|
int res = -1;
|
|
|
|
if ((target = ast_channel_callback(find_by_mark, NULL, (char *) mark, 0))) {
|
|
ast_channel_lock(target);
|
|
res = pickup_do(chan, target);
|
|
ast_channel_unlock(target);
|
|
target = ast_channel_unref(target);
|
|
}
|
|
|
|
return res;
|
|
}
|
|
|
|
/* application entry point for Pickup() */
|
|
static int pickup_exec(struct ast_channel *chan, const char *data)
|
|
{
|
|
int res = 0;
|
|
char *tmp = ast_strdupa(data);
|
|
char *exten = NULL, *context = NULL;
|
|
|
|
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;
|
|
}
|
|
|
|
/* Find channel for pick up specified by partial channel name */
|
|
static int find_by_part(void *obj, void *arg, void *data, int flags)
|
|
{
|
|
struct ast_channel *c = obj;
|
|
const char *part = data;
|
|
int res = 0;
|
|
int len = strlen(part);
|
|
|
|
ast_channel_lock(c);
|
|
if (len <= strlen(c->name)) {
|
|
res = !(strncmp(c->name, part, len)) && (can_pickup(c));
|
|
}
|
|
ast_channel_unlock(c);
|
|
|
|
return res ? CMP_MATCH | CMP_STOP : 0;
|
|
}
|
|
|
|
/* Attempt to pick up specified by partial channel name */
|
|
static int pickup_by_part(struct ast_channel *chan, const char *part)
|
|
{
|
|
struct ast_channel *target;
|
|
int res = -1;
|
|
|
|
if ((target = ast_channel_callback(find_by_part, NULL, (char *) part, 0))) {
|
|
ast_channel_lock(target);
|
|
res = pickup_do(chan, target);
|
|
ast_channel_unlock(target);
|
|
target = ast_channel_unref(target);
|
|
}
|
|
|
|
return res;
|
|
}
|
|
|
|
/* application entry point for PickupChan() */
|
|
static int pickupchan_exec(struct ast_channel *chan, const char *data)
|
|
{
|
|
int res = 0;
|
|
int partial_pickup = 0;
|
|
char *pickup = NULL;
|
|
char *parse = ast_strdupa(data);
|
|
AST_DECLARE_APP_ARGS(args,
|
|
AST_APP_ARG(channel);
|
|
AST_APP_ARG(options);
|
|
);
|
|
AST_STANDARD_APP_ARGS(args, parse);
|
|
|
|
if (ast_strlen_zero(args.channel)) {
|
|
ast_log(LOG_WARNING, "PickupChan requires an argument (channel)!\n");
|
|
return -1;
|
|
}
|
|
|
|
if (!ast_strlen_zero(args.options) && strchr(args.options, 'p')) {
|
|
partial_pickup = 1;
|
|
}
|
|
|
|
/* Parse channel */
|
|
while (!ast_strlen_zero(args.channel) && (pickup = strsep(&args.channel, "&"))) {
|
|
if (!strncasecmp(chan->name, pickup, strlen(pickup))) {
|
|
ast_log(LOG_NOTICE, "Cannot pickup your own channel %s.\n", pickup);
|
|
} else {
|
|
if (partial_pickup) {
|
|
if (!pickup_by_part(chan, pickup)) {
|
|
break;
|
|
}
|
|
} else if (!pickup_by_channel(chan, pickup)) {
|
|
break;
|
|
}
|
|
ast_log(LOG_NOTICE, "No target channel found for %s.\n", pickup);
|
|
}
|
|
}
|
|
|
|
return res;
|
|
}
|
|
|
|
static int unload_module(void)
|
|
{
|
|
int res;
|
|
|
|
res = ast_unregister_application(app);
|
|
res |= ast_unregister_application(app2);
|
|
|
|
return res;
|
|
}
|
|
|
|
static int load_module(void)
|
|
{
|
|
int res;
|
|
|
|
res = ast_register_application_xml(app, pickup_exec);
|
|
res |= ast_register_application_xml(app2, pickupchan_exec);
|
|
|
|
return res;
|
|
}
|
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Directed Call Pickup Application");
|