Parking Bridge DTMF and Interval features. More...

#include "asterisk.h"
#include "res_parking.h"
#include "asterisk/utils.h"
#include "asterisk/astobj2.h"
#include "asterisk/logger.h"
#include "asterisk/pbx.h"
#include "asterisk/app.h"
#include "asterisk/bridge.h"
#include "asterisk/bridge_internal.h"
#include "asterisk/bridge_channel.h"
#include "asterisk/bridge_features.h"
#include "asterisk/conversions.h"
#include "asterisk/features.h"
#include "asterisk/say.h"
#include "asterisk/datastore.h"
#include "asterisk/stasis.h"
#include "asterisk/module.h"
#include "asterisk/core_local.h"
#include "asterisk/causes.h"

Include dependency graph for parking_bridge_features.c:

Go to the source code of this file.

Data Structures
struct	parked_subscription_data

struct	parked_subscription_datastore

Functions
int	create_parked_subscription (struct ast_channel chan, const char parkee_uuid, int hangup_after)
	Create a parking announcement subscription. More...

static int	create_parked_subscription_full (struct ast_channel chan, const char parkee_uuid, int hangup_after, struct transfer_channel_data *parked_channel_data)

static int	feature_park_call (struct ast_bridge_channel bridge_channel, void hook_pvt)

static int	func_get_parkingslot_channel (struct ast_channel chan, const char function, char data, char buf, size_t len)
	Dial plan function to get the parking lot channel of an occupied parking lot. More...

int	load_parking_bridge_features (void)
	Register bridge features for parking. More...

static struct ast_channel *	park_local_transfer (struct ast_channel parker, const char context, const char exten, struct transfer_channel_data parked_channel_data)

static void	parked_subscription_datastore_destroy (void *data)

static void	parker_parked_call_message_response (struct ast_parked_call_payload message, struct parked_subscription_data data, struct stasis_subscription *sub)

static void	parker_update_cb (void data, struct stasis_subscription sub, struct stasis_message *message)

static int	parking_blind_transfer_park (struct ast_bridge_channel bridge_channel, const char context, const char exten, transfer_channel_cb parked_channel_cb, struct transfer_channel_data parked_channel_data)

static int	parking_duration_callback (struct ast_bridge_channel bridge_channel, void hook_pvt)

static int	parking_is_exten_park (const char context, const char exten)

static int	parking_park_bridge_channel (struct ast_bridge_channel bridge_channel, const char uuid_parkee, const char uuid_parker, const char app_data)

static int	parking_park_call (struct ast_bridge_channel parker, char exten, size_t length)

void	parking_set_duration (struct ast_bridge_features features, struct parked_user user)
	Setup timeout interval feature on an ast_bridge_features for parking. More...

static void	parking_timeout_set_caller_features (struct ast_channel chan, struct parking_lot_cfg cfg)

void	say_parking_space (struct ast_bridge_channel bridge_channel, const char payload)
	custom callback function for ast_bridge_channel_queue_playfile which plays a parking space and optionally hangs up the call afterwards based on the payload in playfile. More...

void	unload_parking_bridge_features (void)
	Unregister features registered by load_parking_bridge_features. More...

static void	wipe_subscription_datastore (struct ast_channel *chan)

Variables
static struct ast_custom_function	getparkingslotchannel_function

static const struct ast_datastore_info	parked_subscription_info

struct ast_parking_bridge_feature_fn_table	parking_provider

Detailed Description

Parking Bridge DTMF and Interval features.

Author: Jonathan Rose jrose.nosp@m.@dig.nosp@m.ium.c.nosp@m.om

Definition in file parking_bridge_features.c.

Function Documentation

◆ create_parked_subscription()

int create_parked_subscription	(	struct ast_channel *	chan,
		const char *	parkee_uuid,
		int	hangup_after
	)

Create a parking announcement subscription.

Since: 12.3.0

Parameters

chan	Channel that will receive the announcement
parkee_uuid	Unique ID of the channel being parked
hangup_after	if non-zero, have the channel hangup after hearing the announcement

Return values

0	on success
-1	on failure

Definition at line 233 of file parking_bridge_features.c.

References create_parked_subscription_full(), and NULL.

Referenced by manager_park(), and manager_park_bridged().

 {
    return create_parked_subscription_full(chan, parkee_uuid, hangup_after, NULL);
 }

◆ create_parked_subscription_full()

static int create_parked_subscription_full	(	struct ast_channel *	chan,
		const char *	parkee_uuid,
		int	hangup_after,
		struct transfer_channel_data *	parked_channel_data
	)

static

Definition at line 174 of file parking_bridge_features.c.

References ao2_ref, ast_calloc, ast_channel_datastore_add(), ast_channel_lock, ast_channel_uniqueid(), ast_channel_unlock, ast_copy_string(), ast_datastore_alloc, ast_datastore_free(), ast_free, ast_parked_call_type(), ast_parking_topic(), ast_strdupa, ast_datastore::data, parked_subscription_data::hangup_after, NULL, parked_subscription_datastore::parked_subscription, parked_subscription_data::parkee_uuid, parker_update_cb(), parked_subscription_data::parker_uuid, stasis_subscribe_pool, stasis_subscription_accept_message_type(), stasis_subscription_change_type(), STASIS_SUBSCRIPTION_FILTER_SELECTIVE, stasis_subscription_set_filter(), parked_subscription_data::transfer_data, and wipe_subscription_datastore().

Referenced by create_parked_subscription(), park_local_transfer(), and parking_blind_transfer_park().

 {
    struct ast_datastore *datastore;
    struct parked_subscription_datastore *parked_datastore;
    struct parked_subscription_data *subscription_data;
 
    char *parker_uuid = ast_strdupa(ast_channel_uniqueid(chan));
    size_t parker_uuid_size;
    size_t parkee_uuid_size;
 
    /* If there is already a subscription, get rid of it. */
    wipe_subscription_datastore(chan);
 
    if (!(datastore = ast_datastore_alloc(&parked_subscription_info, NULL))) {
       return -1;
    }
 
    if (!(parked_datastore = ast_calloc(1, sizeof(*parked_datastore)))) {
       ast_datastore_free(datastore);
       return -1;
    }
 
    parker_uuid_size = strlen(parker_uuid) + 1;
    parkee_uuid_size = strlen(parkee_uuid) + 1;
 
    if (!(subscription_data = ast_calloc(1, sizeof(*subscription_data) + parker_uuid_size +
          parkee_uuid_size))) {
       ast_datastore_free(datastore);
       ast_free(parked_datastore);
       return -1;
    }
 
    if (parked_channel_data) {
       subscription_data->transfer_data = parked_channel_data;
       ao2_ref(parked_channel_data, +1);
    }
 
    subscription_data->hangup_after = hangup_after;
    subscription_data->parkee_uuid = subscription_data->parker_uuid + parker_uuid_size;
    ast_copy_string(subscription_data->parkee_uuid, parkee_uuid, parkee_uuid_size);
    ast_copy_string(subscription_data->parker_uuid, parker_uuid, parker_uuid_size);
 
    if (!(parked_datastore->parked_subscription = stasis_subscribe_pool(ast_parking_topic(), parker_update_cb, subscription_data))) {
       return -1;
    }
    stasis_subscription_accept_message_type(parked_datastore->parked_subscription, ast_parked_call_type());
    stasis_subscription_accept_message_type(parked_datastore->parked_subscription, stasis_subscription_change_type());
    stasis_subscription_set_filter(parked_datastore->parked_subscription, STASIS_SUBSCRIPTION_FILTER_SELECTIVE);
 
    datastore->data = parked_datastore;
 
    ast_channel_lock(chan);
    ast_channel_datastore_add(chan, datastore);
    ast_channel_unlock(chan);
 
    return 0;
 }

◆ feature_park_call()

static int feature_park_call	(	struct ast_bridge_channel *	bridge_channel,
		void *	hook_pvt
	)

static

Definition at line 524 of file parking_bridge_features.c.

References NULL, parking_park_call(), and SCOPED_MODULE_USE.

Referenced by load_parking_bridge_features().

 {
    SCOPED_MODULE_USE(AST_MODULE_SELF);
 
    parking_park_call(bridge_channel, NULL, 0);
    return 0;
 }

◆ func_get_parkingslot_channel()

static int func_get_parkingslot_channel	(	struct ast_channel *	chan,
		const char *	function,
		char *	data,
		char *	buf,
		size_t	len
	)

static

Dial plan function to get the parking lot channel of an occupied parking lot.

Definition at line 733 of file parking_bridge_features.c.

References ao2_cleanup, args, AST_APP_ARG, ast_channel_name(), ast_copy_string(), AST_DECLARE_APP_ARGS, ast_log, AST_STANDARD_APP_ARGS, ast_str_to_uint(), ast_strlen_zero, LOG_ERROR, NULL, parking_lot_find_by_name(), parking_lot_inspect_parked_user(), and RAII_VAR.

 {
    RAII_VAR(struct parked_user *, pu, NULL, ao2_cleanup);
    RAII_VAR(struct parking_lot *, lot, NULL, ao2_cleanup);
    unsigned int space = 0;
    const char *content = NULL;
 
    AST_DECLARE_APP_ARGS(args,
       AST_APP_ARG(parking_space);
       AST_APP_ARG(parking_lot);
       AST_APP_ARG(other);
    );
 
    /* Parse the arguments. */
    AST_STANDARD_APP_ARGS(args, data);
 
    if (args.argc < 2) {
       /* Didn't receive enough arguments to do anything */
       ast_log(LOG_ERROR, "Usage: %s(<parking_space>,<parking_lot>)\n",
          function);
       return -1;
    }
 
    lot = parking_lot_find_by_name(args.parking_lot);
    if (!lot) {
       ast_log(LOG_ERROR, "Could not find parking lot: '%s'\n", args.parking_lot);
       return -1;
    }
 
    if (!ast_strlen_zero(args.parking_space)) {
       if (ast_str_to_uint(args.parking_space, &space) != 0) {
          ast_log(LOG_ERROR, "value '%s' for parking_space argument is invalid. Must be an integer greater than 0.\n",
             args.parking_space);
          return -1;
       }
    }
 
    pu = parking_lot_inspect_parked_user(lot, space);
    if (!pu) {
       return -1;
    }
 
    content = ast_channel_name(pu->chan);
    ast_copy_string(buf, content, len);
 
    return 0;
 }

◆ load_parking_bridge_features()

int load_parking_bridge_features ( void )

Register bridge features for parking.

Since: 12.0.0

Return values

0	on success
-1	on failure

Definition at line 802 of file parking_bridge_features.c.

References AST_BRIDGE_BUILTIN_PARKCALL, ast_bridge_features_register(), ast_custom_function_register, ast_parking_register_bridge_features(), feature_park_call(), ast_parking_bridge_feature_fn_table::module, and NULL.

Referenced by load_module().

 {
    parking_provider.module = AST_MODULE_SELF;
 
    ast_custom_function_register(&getparkingslotchannel_function);
 
    if (ast_parking_register_bridge_features(&parking_provider)) {
       return -1;
    }
 
    if (ast_bridge_features_register(AST_BRIDGE_BUILTIN_PARKCALL, feature_park_call, NULL)) {
       return -1;
    }
 
    return 0;
 }

◆ park_local_transfer()

static struct ast_channel* park_local_transfer	(	struct ast_channel *	parker,
		const char *	context,
		const char *	exten,
		struct transfer_channel_data *	parked_channel_data
	)

static

Definition at line 244 of file parking_bridge_features.c.

References ast_assert, ast_bridge_set_transfer_variables(), ast_call(), ast_channel_caller(), ast_channel_connected(), ast_channel_datastore_inherit(), ast_channel_inherit_variables(), ast_channel_lock_both, ast_channel_name(), ast_channel_nativeformats(), ast_channel_parkinglot(), ast_channel_req_accountcodes(), AST_CHANNEL_REQUESTOR_REPLACEMENT, ast_channel_uniqueid(), ast_channel_unlock, ast_channel_unref, ast_connected_line_copy_from_caller(), ast_hangup(), ast_local_get_peer(), AST_MAX_CONTEXT, AST_MAX_EXTENSION, ast_request(), create_parked_subscription_full(), and NULL.

Referenced by parking_blind_transfer_park().

 {
    char destination[AST_MAX_EXTENSION + AST_MAX_CONTEXT + 1];
    struct ast_channel *parkee;
    struct ast_channel *parkee_side_2;
    int cause;
 
    /* Fill the variable with the extension and context we want to call */
    snprintf(destination, sizeof(destination), "%s@%s", exten, context);
 
    /* Now we request that chan_local prepare to call the destination */
    parkee = ast_request("Local", ast_channel_nativeformats(parker), NULL, parker, destination,
       &cause);
    if (!parkee) {
       return NULL;
    }
 
    /* Before we actually dial out let's inherit appropriate information. */
    ast_channel_lock_both(parker, parkee);
    ast_channel_req_accountcodes(parkee, parker, AST_CHANNEL_REQUESTOR_REPLACEMENT);
    ast_channel_parkinglot_set(parkee, ast_channel_parkinglot(parker));
    ast_connected_line_copy_from_caller(ast_channel_connected(parkee), ast_channel_caller(parker));
    ast_channel_inherit_variables(parker, parkee);
    ast_bridge_set_transfer_variables(parkee, ast_channel_name(parker), 0);
    ast_channel_datastore_inherit(parker, parkee);
    ast_channel_unlock(parker);
 
    parkee_side_2 = ast_local_get_peer(parkee);
    ast_assert(parkee_side_2 != NULL);
    ast_channel_unlock(parkee);
 
    /* We need to have the parker subscribe to the new local channel before hand. */
    if (create_parked_subscription_full(parker, ast_channel_uniqueid(parkee_side_2), 1, parked_channel_data)) {
       ast_channel_unref(parkee_side_2);
       ast_hangup(parkee);
       return NULL;
    }
 
    ast_channel_unref(parkee_side_2);
 
    /* Since the above worked fine now we actually call it and return the channel */
    if (ast_call(parkee, destination, 0)) {
       ast_hangup(parkee);
       return NULL;
    }
 
    return parkee;
 }

◆ parked_subscription_datastore_destroy()

static void parked_subscription_datastore_destroy ( void * data )

static

Definition at line 76 of file parking_bridge_features.c.

References ast_free, NULL, parked_subscription_datastore::parked_subscription, and stasis_unsubscribe().

 {
    struct parked_subscription_datastore *subscription_datastore = data;
 
    stasis_unsubscribe(subscription_datastore->parked_subscription);
    subscription_datastore->parked_subscription = NULL;
 
    ast_free(subscription_datastore);
 }

◆ parker_parked_call_message_response()

static void parker_parked_call_message_response	(	struct ast_parked_call_payload *	message,
		struct parked_subscription_data *	data,
		struct stasis_subscription *	sub
	)

static

Definition at line 105 of file parking_bridge_features.c.

References ao2_cleanup, ast_bridge_channel_queue_playfile(), ast_bridge_channel_queue_playfile_sync(), ast_channel_cleanup, ast_channel_get_bridge_channel(), ast_channel_get_by_name(), ast_channel_lock, ast_channel_unlock, ast_channel_snapshot::base, transfer_channel_data::completed, ast_parked_call_payload::event_type, parked_subscription_data::hangup_after, NULL, PARKED_CALL, PARKED_CALL_FAILED, ast_parked_call_payload::parkee, parked_subscription_data::parkee_uuid, parked_subscription_data::parker_uuid, ast_parked_call_payload::parkingspace, RAII_VAR, say_parking_space(), parked_subscription_data::transfer_data, ast_channel_snapshot_base::uniqueid, and wipe_subscription_datastore().

Referenced by parker_update_cb().

 {
    const char *parkee_to_act_on = data->parkee_uuid;
    char saynum_buf[16];
    struct ast_channel_snapshot *parkee_snapshot = message->parkee;
    RAII_VAR(struct ast_channel *, parker, NULL, ast_channel_cleanup);
    RAII_VAR(struct ast_bridge_channel *, bridge_channel, NULL, ao2_cleanup);
 
    if (strcmp(parkee_to_act_on, parkee_snapshot->base->uniqueid)) {
       return;
    }
 
    if (message->event_type != PARKED_CALL && message->event_type != PARKED_CALL_FAILED) {
       /* We only care about these two event types */
       return;
    }
 
    parker = ast_channel_get_by_name(data->parker_uuid);
    if (!parker) {
       return;
    }
 
    ast_channel_lock(parker);
    bridge_channel = ast_channel_get_bridge_channel(parker);
    ast_channel_unlock(parker);
    if (!bridge_channel) {
       return;
    }
 
    /* This subscription callback will block for the duration of the announcement if
     * parked_subscription_data is tracking a transfer_channel_data struct. */
    if (message->event_type == PARKED_CALL) {
       /* queue the saynum on the bridge channel and hangup */
       snprintf(saynum_buf, sizeof(saynum_buf), "%d %u", data->hangup_after, message->parkingspace);
       if (!data->transfer_data) {
          ast_bridge_channel_queue_playfile(bridge_channel, say_parking_space, saynum_buf, NULL);
       } else {
          ast_bridge_channel_queue_playfile_sync(bridge_channel, say_parking_space, saynum_buf, NULL);
          data->transfer_data->completed = 1;
       }
       wipe_subscription_datastore(parker);
    } else if (message->event_type == PARKED_CALL_FAILED) {
       if (!data->transfer_data) {
          ast_bridge_channel_queue_playfile(bridge_channel, NULL, "pbx-parkingfailed", NULL);
       } else {
          ast_bridge_channel_queue_playfile_sync(bridge_channel, NULL, "pbx-parkingfailed", NULL);
          data->transfer_data->completed = 1;
       }
       wipe_subscription_datastore(parker);
    }
 }

◆ parker_update_cb()

static void parker_update_cb	(	void *	data,
		struct stasis_subscription *	sub,
		struct stasis_message *	message
	)

static

Definition at line 158 of file parking_bridge_features.c.

References ao2_cleanup, ast_free, ast_parked_call_type(), NULL, parker_parked_call_message_response(), stasis_message_data(), stasis_message_type(), stasis_subscription_final_message(), and parked_subscription_data::transfer_data.

Referenced by create_parked_subscription_full().

 {
    if (stasis_subscription_final_message(sub, message)) {
       struct parked_subscription_data *ps_data = data;
       ao2_cleanup(ps_data->transfer_data);
       ps_data->transfer_data = NULL;
       ast_free(data);
       return;
    }
 
    if (stasis_message_type(message) == ast_parked_call_type()) {
       struct ast_parked_call_payload *parked_call_message = stasis_message_data(message);
       parker_parked_call_message_response(parked_call_message, data, sub);
    }
 }

◆ parking_blind_transfer_park()

static int parking_blind_transfer_park	(	struct ast_bridge_channel *	bridge_channel,
		const char *	context,
		const char *	exten,
		transfer_channel_cb	parked_channel_cb,
		struct transfer_channel_data *	parked_channel_data
	)

static

Definition at line 336 of file parking_bridge_features.c.

References ao2_cleanup, ao2_ref, ast_bridge_channel_lock_bridge(), ast_bridge_channel_peer(), ast_bridge_channel_write_park(), ast_bridge_impart(), AST_BRIDGE_IMPART_CHAN_INDEPENDENT, AST_BRIDGE_TRANSFER_MULTI_PARTY, AST_BRIDGE_TRANSFER_SINGLE_PARTY, ast_bridge_unlock, ast_channel_cleanup, ast_channel_ref, ast_channel_uniqueid(), ast_channel_unref, ast_get_extension_app_data(), ast_hangup(), ast_strlen_zero, ast_bridge_channel::bridge, ast_bridge_channel::chan, create_parked_subscription_full(), E_MATCH, ast_bridge_channel::in_bridge, NULL, ast_bridge::num_channels, park_local_transfer(), parking_is_exten_park(), pbx_find_extension(), RAII_VAR, and pbx_find_info::stacklen.

Referenced by parking_park_call().

 {
    RAII_VAR(struct ast_bridge_channel *, other, NULL, ao2_cleanup);
    RAII_VAR(struct ast_channel *, other_chan, NULL, ast_channel_cleanup);
 
    struct ast_exten *e;
    struct pbx_find_info find_info = { .stacklen = 0 };
    int peer_count;
 
    if (ast_strlen_zero(context) || ast_strlen_zero(exten)) {
       return -1;
    }
 
    if (!bridge_channel->in_bridge) {
       return -1;
    }
 
    if (!parking_is_exten_park(context, exten)) {
       return -1;
    }
 
    ast_bridge_channel_lock_bridge(bridge_channel);
    peer_count = bridge_channel->bridge->num_channels;
    if (peer_count == 2) {
       other = ast_bridge_channel_peer(bridge_channel);
       ao2_ref(other, +1);
       other_chan = other->chan;
       ast_channel_ref(other_chan);
    }
    ast_bridge_unlock(bridge_channel->bridge);
 
    if (peer_count < 2) {
       /* There is nothing to do if there is no one to park. */
       return -1;
    }
 
    /* With a multiparty bridge, we need to do a regular blind transfer. We link the
     * existing bridge to the parking lot with a Local channel rather than
     * transferring others. */
    if (peer_count > 2) {
       struct ast_channel *transfer_chan = NULL;
 
       transfer_chan = park_local_transfer(bridge_channel->chan, context, exten, parked_channel_data);
       if (!transfer_chan) {
          return -1;
       }
       ast_channel_ref(transfer_chan);
 
       if (parked_channel_cb) {
          parked_channel_cb(transfer_chan, parked_channel_data, AST_BRIDGE_TRANSFER_MULTI_PARTY);
       }
 
       if (ast_bridge_impart(bridge_channel->bridge, transfer_chan, NULL, NULL,
          AST_BRIDGE_IMPART_CHAN_INDEPENDENT)) {
          ast_hangup(transfer_chan);
          ast_channel_unref(transfer_chan);
          return -1;
       }
 
       ast_channel_unref(transfer_chan);
 
       return 0;
    }
 
    /* Subscribe to park messages with the other channel entering */
    if (create_parked_subscription_full(bridge_channel->chan, ast_channel_uniqueid(other->chan), 1, parked_channel_data)) {
       return -1;
    }
 
    if (parked_channel_cb) {
       parked_channel_cb(other_chan, parked_channel_data, AST_BRIDGE_TRANSFER_SINGLE_PARTY);
    }
 
    e = pbx_find_extension(NULL, NULL, &find_info, context, exten, 1, NULL, NULL, E_MATCH);
 
    /* Write the park frame with the intended recipient and other data out to the bridge. */
    ast_bridge_channel_write_park(bridge_channel,
       ast_channel_uniqueid(other_chan),
       ast_channel_uniqueid(bridge_channel->chan),
       e ? ast_get_extension_app_data(e) : NULL);
 
    return 0;
 }

◆ parking_duration_callback()

static int parking_duration_callback	(	struct ast_bridge_channel *	bridge_channel,
		void *	hook_pvt
	)

static

Definition at line 575 of file parking_bridge_features.c.

References ao2_lock, ao2_unlock, ast_add_extension2_nolock(), ast_assert, ast_async_parseable_goto(), ast_bridge_channel_leave_bridge(), AST_CAUSE_NORMAL_CLEARING, ast_channel_lock, ast_channel_stage_snapshot(), ast_channel_stage_snapshot_done(), ast_channel_unlock, ast_context_find_or_create(), ast_debug, ast_free_ptr(), ast_get_extension_registrar(), ast_log, AST_MAX_EXTENSION, ast_strdup, ast_strdupa, ast_strlen_zero, ast_unlock_context(), ast_unlock_contexts(), ast_wrlock_context(), ast_wrlock_contexts(), BASE_REGISTRAR, BRIDGE_CHANNEL_STATE_END_NO_DISSOLVE, parking_lot::cfg, parked_user::chan, parked_user::comeback, comeback_goto(), parking_lot_cfg::comebackdialtime, E_MATCH, flatten_dial_string(), LOG_ERROR, parked_user::lot, parking_lot::name, NULL, PARK_DIAL_CONTEXT, PARK_TIMEOUT, PARK_UNSET, parked_user::parker_dial_string, parked_user::parking_space, parking_timeout_set_caller_features(), pbx_builtin_setvar_helper(), pbx_find_extension(), parked_user::resolution, and pbx_find_info::stacklen.

Referenced by parking_set_duration().

 {
    struct parked_user *user = hook_pvt;
    struct ast_channel *chan = user->chan;
    struct ast_context *park_dial_context;
    const char *dial_string;
    char *dial_string_flat;
    char parking_space[AST_MAX_EXTENSION];
 
    char returnexten[AST_MAX_EXTENSION];
    char *duplicate_returnexten;
    struct ast_exten *existing_exten;
    struct pbx_find_info pbx_finder = { .stacklen = 0 }; /* The rest is reset in pbx_find_extension */
 
 
    /* We are still in the bridge, so it's possible for other stuff to mess with the parked call before we leave the bridge
       to deal with this, lock the parked user, check and set resolution. */
    ao2_lock(user);
    if (user->resolution != PARK_UNSET) {
       /* Abandon timeout since something else has resolved the parked user before we got to it. */
       ao2_unlock(user);
       return -1;
    }
    user->resolution = PARK_TIMEOUT;
    ao2_unlock(user);
 
    ast_bridge_channel_leave_bridge(bridge_channel, BRIDGE_CHANNEL_STATE_END_NO_DISSOLVE,
       AST_CAUSE_NORMAL_CLEARING);
 
    dial_string = user->parker_dial_string;
    dial_string_flat = ast_strdupa(dial_string);
    flatten_dial_string(dial_string_flat);
 
    /* Set parking timeout channel variables */
    snprintf(parking_space, sizeof(parking_space), "%d", user->parking_space);
    ast_channel_lock(chan);
    ast_channel_stage_snapshot(chan);
    pbx_builtin_setvar_helper(chan, "PARKING_SPACE", parking_space);
    pbx_builtin_setvar_helper(chan, "PARKEDLOT", user->lot->name);
    pbx_builtin_setvar_helper(chan, "PARKER", dial_string);
    pbx_builtin_setvar_helper(chan, "PARKER_FLAT", dial_string_flat);
    parking_timeout_set_caller_features(chan, user->lot->cfg);
    ast_channel_stage_snapshot_done(chan);
    ast_channel_unlock(chan);
 
    /* Dialplan generation for park-dial extensions */
 
    if (ast_wrlock_contexts()) {
       ast_log(LOG_ERROR, "Failed to lock the contexts list. Can't add the park-dial extension.\n");
       return -1;
    }
 
    if (!(park_dial_context = ast_context_find_or_create(NULL, NULL, PARK_DIAL_CONTEXT, BASE_REGISTRAR))) {
       ast_log(LOG_ERROR, "Parking dial context '%s' does not exist and unable to create\n", PARK_DIAL_CONTEXT);
       if (ast_unlock_contexts()) {
          ast_assert(0);
       }
       goto abandon_extension_creation;
    }
 
    if (ast_wrlock_context(park_dial_context)) {
       ast_log(LOG_ERROR, "failed to obtain write lock on context '%s'\n", PARK_DIAL_CONTEXT);
       if (ast_unlock_contexts()) {
          ast_assert(0);
       }
       goto abandon_extension_creation;
    }
 
    if (ast_unlock_contexts()) {
       ast_assert(0);
    }
 
    snprintf(returnexten, sizeof(returnexten), "%s,%u", dial_string,
       user->lot->cfg->comebackdialtime);
 
    duplicate_returnexten = ast_strdup(returnexten);
    if (!duplicate_returnexten) {
       ast_log(LOG_ERROR, "Failed to create parking redial parker extension %s@%s - Dial(%s)\n",
          dial_string_flat, PARK_DIAL_CONTEXT, returnexten);
    }
 
    /* If an extension already exists here because we registered it for another parked call timing out, then we may overwrite it. */
    if ((existing_exten = pbx_find_extension(NULL, NULL, &pbx_finder, PARK_DIAL_CONTEXT, dial_string_flat, 1, NULL, NULL, E_MATCH)) &&
        (strcmp(ast_get_extension_registrar(existing_exten), BASE_REGISTRAR))) {
       ast_debug(3, "An extension for '%s@%s' was already registered by another registrar '%s'\n",
          dial_string_flat, PARK_DIAL_CONTEXT, ast_get_extension_registrar(existing_exten));
    } else if (ast_add_extension2_nolock(park_dial_context, 1, dial_string_flat, 1, NULL, NULL,
          "Dial", duplicate_returnexten, ast_free_ptr, BASE_REGISTRAR, NULL, 0)) {
       ast_log(LOG_ERROR, "Failed to create parking redial parker extension %s@%s - Dial(%s)\n",
          dial_string_flat, PARK_DIAL_CONTEXT, returnexten);
    }
 
    if (ast_unlock_context(park_dial_context)) {
       ast_assert(0);
    }
 
 abandon_extension_creation:
 
    /* async_goto the proper PBX destination - this should happen when we come out of the bridge */
    if (!ast_strlen_zero(user->comeback)) {
       ast_async_parseable_goto(chan, user->comeback);
    } else {
       comeback_goto(user, user->lot);
    }
 
    return -1;
 }

◆ parking_is_exten_park()

static int parking_is_exten_park	(	const char *	context,
		const char *	exten
	)

static

Definition at line 297 of file parking_bridge_features.c.

References ast_debug, ast_get_extension_app(), E_MATCH, NULL, PARK_APPLICATION, pbx_find_extension(), and pbx_find_info::stacklen.

Referenced by parking_blind_transfer_park().

 {
    struct ast_exten *exten_obj;
    struct pbx_find_info info = { .stacklen = 0 }; /* the rest is reset in pbx_find_extension */
    const char *app_at_exten;
 
    ast_debug(4, "Checking if %s@%s is a parking exten\n", exten, context);
    exten_obj = pbx_find_extension(NULL, NULL, &info, context, exten, 1, NULL, NULL, E_MATCH);
    if (!exten_obj) {
       return 0;
    }
 
    app_at_exten = ast_get_extension_app(exten_obj);
    if (!app_at_exten || strcasecmp(PARK_APPLICATION, app_at_exten)) {
       return 0;
    }
 
    return 1;
 }

◆ parking_park_bridge_channel()

static int parking_park_bridge_channel	(	struct ast_bridge_channel *	bridge_channel,
		const char *	uuid_parkee,
		const char *	uuid_parker,
		const char *	app_data
	)

static

Definition at line 434 of file parking_bridge_features.c.

References ao2_cleanup, ao2_lock, ao2_ref, ao2_unlock, ast_bridge_move(), ast_bridge_set_transfer_variables(), ast_channel_get_by_name(), ast_channel_name(), ast_channel_uniqueid(), ast_log, ast_bridge_channel::bridge, ast_bridge_channel::chan, LOG_ERROR, LOG_NOTICE, NULL, park_application_setup(), publish_parked_call_failure(), and RAII_VAR.

 {
    RAII_VAR(struct ast_bridge *, parking_bridge, NULL, ao2_cleanup);
    RAII_VAR(struct ast_bridge *, original_bridge, NULL, ao2_cleanup);
    RAII_VAR(struct ast_channel *, parker, NULL, ao2_cleanup);
 
    if (strcmp(ast_channel_uniqueid(bridge_channel->chan), uuid_parkee)) {
       /* We aren't the parkee, so ignore this action. */
       return -1;
    }
 
    parker = ast_channel_get_by_name(uuid_parker);
 
    if (!parker) {
       ast_log(LOG_NOTICE, "Channel with uuid %s left before we could start parking the call. Parking canceled.\n", uuid_parker);
       publish_parked_call_failure(bridge_channel->chan);
       return -1;
    }
 
    if (!(parking_bridge = park_application_setup(bridge_channel->chan, parker, app_data, NULL))) {
       publish_parked_call_failure(bridge_channel->chan);
       return -1;
    }
 
    ast_bridge_set_transfer_variables(bridge_channel->chan, ast_channel_name(parker), 0);
 
    /* bridge_channel must be locked so we can get a reference to the bridge it is currently on */
    ao2_lock(bridge_channel);
 
    original_bridge = bridge_channel->bridge;
    if (!original_bridge) {
       ao2_unlock(bridge_channel);
       publish_parked_call_failure(bridge_channel->chan);
       return -1;
    }
 
    ao2_ref(original_bridge, +1); /* Cleaned by RAII_VAR */
 
    ao2_unlock(bridge_channel);
 
    if (ast_bridge_move(parking_bridge, original_bridge, bridge_channel->chan, NULL, 1)) {
       ast_log(LOG_ERROR, "Failed to move %s into the parking bridge.\n",
          ast_channel_name(bridge_channel->chan));
       return -1;
    }
 
    return 0;
 }

◆ parking_park_call()

static int parking_park_call	(	struct ast_bridge_channel *	parker,
		char *	exten,
		size_t	length
	)

static

Definition at line 499 of file parking_bridge_features.c.

References ao2_cleanup, ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_copy_string(), ast_log, AST_LOG_WARNING, ast_strdupa, ast_bridge_channel::chan, find_channel_parking_lot_name(), NULL, parking_blind_transfer_park(), parking_create_dynamic_lot(), parking_lot_find_by_name(), and RAII_VAR.

Referenced by feature_park_call().

 {
    RAII_VAR(struct parking_lot *, lot, NULL, ao2_cleanup);
    const char *lot_name;
 
    ast_channel_lock(parker->chan);
    lot_name = ast_strdupa(find_channel_parking_lot_name(parker->chan));
    ast_channel_unlock(parker->chan);
 
    lot = parking_lot_find_by_name(lot_name);
    if (!lot) {
       lot = parking_create_dynamic_lot(lot_name, parker->chan);
    }
    if (!lot) {
       ast_log(AST_LOG_WARNING, "Cannot Park %s: lot %s unknown\n",
          ast_channel_name(parker->chan), lot_name);
       return -1;
    }
 
    if (exten) {
       ast_copy_string(exten, lot->cfg->parkext, length);
    }
    return parking_blind_transfer_park(parker, lot->cfg->parking_con, lot->cfg->parkext, NULL, NULL);
 }

◆ parking_set_duration()

void parking_set_duration	(	struct ast_bridge_features *	features,
		struct parked_user *	user
	)

Setup timeout interval feature on an ast_bridge_features for parking.

Since: 12.0.0

Parameters

features	The ast_bridge_features we are establishing the interval hook on
user	The parked_user receiving the timeout duration limits

Definition at line 705 of file parking_bridge_features.c.

References __ao2_cleanup(), ao2_ref, AST_BRIDGE_HOOK_REMOVE_ON_PULL, ast_bridge_interval_hook(), ast_log, ast_remaining_ms(), LOG_ERROR, parking_duration_callback(), parked_user::start, and parked_user::time_limit.

Referenced by bridge_parking_push().

 {
    unsigned int time_limit;
 
    time_limit = user->time_limit * 1000;
 
    if (!time_limit) {
       /* There is no duration limit that we need to apply. */
       return;
    }
 
    /* If the time limit has already been passed, set a really low time limit so we can kick them out immediately. */
    time_limit = ast_remaining_ms(user->start, time_limit);
    if (time_limit <= 0) {
       time_limit = 1;
    }
 
    /* The interval hook is going to need a reference to the parked_user */
    ao2_ref(user, +1);
 
    if (ast_bridge_interval_hook(features, 0, time_limit,
       parking_duration_callback, user, __ao2_cleanup, AST_BRIDGE_HOOK_REMOVE_ON_PULL)) {
       ast_log(LOG_ERROR, "Failed to apply duration limit to the parked call.\n");
       ao2_ref(user, -1);
    }
 }

◆ parking_timeout_set_caller_features()

static void parking_timeout_set_caller_features	(	struct ast_channel *	chan,
		struct parking_lot_cfg *	cfg
	)

static

Definition at line 542 of file parking_bridge_features.c.

References AST_FEATURE_FLAG_BYCALLER, parking_lot_cfg::parkedcallhangup, parking_lot_cfg::parkedcallrecording, parking_lot_cfg::parkedcallreparking, parking_lot_cfg::parkedcalltransfers, and pbx_builtin_setvar_helper().

Referenced by parking_duration_callback().

 {
    char features[5];
    char *pos;
 
    /*
     * We are setting the callee Dial flag values because in the
     * timeout case, the caller is who is being called back.
     */
    pos = features;
    if (cfg->parkedcalltransfers & AST_FEATURE_FLAG_BYCALLER) {
       *pos++ = 't';
    }
    if (cfg->parkedcallreparking & AST_FEATURE_FLAG_BYCALLER) {
       *pos++ = 'k';
    }
    if (cfg->parkedcallhangup & AST_FEATURE_FLAG_BYCALLER) {
       *pos++ = 'h';
    }
    if (cfg->parkedcallrecording & AST_FEATURE_FLAG_BYCALLER) {
       *pos++ = 'x';
    }
    *pos = '\0';
 
    pbx_builtin_setvar_helper(chan, "BRIDGE_FEATURES", features);
 }

◆ say_parking_space()

void say_parking_space	(	struct ast_bridge_channel *	bridge_channel,
		const char *	payload
	)

custom callback function for ast_bridge_channel_queue_playfile which plays a parking space and optionally hangs up the call afterwards based on the payload in playfile.

Since: 12.0.0

Definition at line 683 of file parking_bridge_features.c.

References ast_assert, ast_bridge_channel_leave_bridge(), AST_CAUSE_NORMAL_CLEARING, ast_channel_language(), ast_say_digits(), BRIDGE_CHANNEL_STATE_END_NO_DISSOLVE, and ast_bridge_channel::chan.

Referenced by bridge_parking_push(), and parker_parked_call_message_response().

 {
    unsigned int numeric_value;
    unsigned int hangup_after;
 
    if (sscanf(payload, "%u %u", &hangup_after, &numeric_value) != 2) {
       /* If say_parking_space is called with a non-numeric string, we have a problem. */
       ast_assert(0);
       ast_bridge_channel_leave_bridge(bridge_channel,
          BRIDGE_CHANNEL_STATE_END_NO_DISSOLVE, AST_CAUSE_NORMAL_CLEARING);
       return;
    }
 
    ast_say_digits(bridge_channel->chan, numeric_value, "",
       ast_channel_language(bridge_channel->chan));
 
    if (hangup_after) {
       ast_bridge_channel_leave_bridge(bridge_channel,
          BRIDGE_CHANNEL_STATE_END_NO_DISSOLVE, AST_CAUSE_NORMAL_CLEARING);
    }
 }

◆ unload_parking_bridge_features()

void unload_parking_bridge_features ( void )

Unregister features registered by load_parking_bridge_features.

Since: 12.0.0

Definition at line 795 of file parking_bridge_features.c.

References AST_BRIDGE_BUILTIN_PARKCALL, ast_bridge_features_unregister(), ast_custom_function_unregister(), ast_parking_unregister_bridge_features(), and ast_parking_bridge_feature_fn_table::module_name.

Referenced by unload_module().

 {
    ast_bridge_features_unregister(AST_BRIDGE_BUILTIN_PARKCALL);
    ast_parking_unregister_bridge_features(parking_provider.module_name);
    ast_custom_function_unregister(&getparkingslotchannel_function);
 }

◆ wipe_subscription_datastore()

static void wipe_subscription_datastore ( struct ast_channel * chan )

static

Definition at line 91 of file parking_bridge_features.c.

References ast_channel_datastore_find(), ast_channel_datastore_remove(), ast_channel_lock, ast_channel_unlock, ast_datastore_free(), and NULL.

Referenced by create_parked_subscription_full(), and parker_parked_call_message_response().

 {
    struct ast_datastore *datastore;
 
    ast_channel_lock(chan);
 
    datastore = ast_channel_datastore_find(chan, &parked_subscription_info, NULL);
    if (datastore) {
       ast_channel_datastore_remove(chan, datastore);
       ast_datastore_free(datastore);
    }
    ast_channel_unlock(chan);
 }

Variable Documentation

◆ getparkingslotchannel_function

struct ast_custom_function getparkingslotchannel_function

static

Initial value:

= {
   .name = "PARK_GET_CHANNEL",
   .read = func_get_parkingslot_channel,
}

Definition at line 781 of file parking_bridge_features.c.

◆ parked_subscription_info

const struct ast_datastore_info parked_subscription_info

static

Initial value:

= {
   .type = "park subscription",
   .destroy = parked_subscription_datastore_destroy,
}

Definition at line 86 of file parking_bridge_features.c.

◆ parking_provider

struct ast_parking_bridge_feature_fn_table parking_provider

Definition at line 786 of file parking_bridge_features.c.

Referenced by ast_parking_blind_transfer_park(), ast_parking_is_exten_park(), ast_parking_park_bridge_channel(), ast_parking_park_call(), ast_parking_provider_registered(), ast_parking_register_bridge_features(), and ast_parking_unregister_bridge_features().

Data Structures

Functions

Variables

Detailed Description

Function Documentation

◆ create_parked_subscription()

◆ create_parked_subscription_full()

◆ feature_park_call()

◆ func_get_parkingslot_channel()

◆ load_parking_bridge_features()

◆ park_local_transfer()

◆ parked_subscription_datastore_destroy()

◆ parker_parked_call_message_response()

◆ parker_update_cb()

◆ parking_blind_transfer_park()

◆ parking_duration_callback()

◆ parking_is_exten_park()

◆ parking_park_bridge_channel()

◆ parking_park_call()

◆ parking_set_duration()

◆ parking_timeout_set_caller_features()

◆ say_parking_space()

◆ unload_parking_bridge_features()

◆ wipe_subscription_datastore()

Variable Documentation

◆ getparkingslotchannel_function

◆ parked_subscription_info

◆ parking_provider