parking_bridge.c File Reference

Parking Bridge Class. More...

#include "asterisk.h"
#include "res_parking.h"
#include "asterisk/astobj2.h"
#include "asterisk/logger.h"
#include "asterisk/say.h"
#include "asterisk/term.h"
#include "asterisk/features.h"
#include "asterisk/bridge_internal.h"

Include dependency graph for parking_bridge.c:

Go to the source code of this file.

Data Structures
struct	ast_bridge_parking

Functions
static struct ast_bridge *	ast_bridge_parking_init (struct ast_bridge_parking *self, struct parking_lot *bridge_lot)
static void	bridge_parking_destroy (struct ast_bridge_parking *self)
static void	bridge_parking_dissolving (struct ast_bridge_parking *self)
static void	bridge_parking_get_merge_priority (struct ast_bridge_parking *self)
struct ast_bridge *	bridge_parking_new (struct parking_lot *bridge_lot)
	Create a new parking bridge. More...
static void	bridge_parking_notify_masquerade (struct ast_bridge_parking *self, struct ast_bridge_channel *bridge_channel)
static void	bridge_parking_pull (struct ast_bridge_parking *self, struct ast_bridge_channel *bridge_channel)
static int	bridge_parking_push (struct ast_bridge_parking *self, struct ast_bridge_channel *bridge_channel, struct ast_bridge_channel *swap)
static void	destroy_parked_user (void *obj)
static struct parked_user *	generate_parked_user (struct parking_lot *lot, struct ast_channel *chan, const char *parker_channel_name, const char *parker_dial_string, int use_random_space, int time_limit)
static int	parked_user_set_parker_dial_string (struct parked_user *pu, const char *parker_channel_name)

Variables
struct ast_bridge_methods	ast_bridge_parking_v_table

Detailed Description

Parking Bridge Class.

Author

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

Definition in file parking_bridge.c.

Function Documentation

ast_bridge_parking_init()

static struct ast_bridge* ast_bridge_parking_init ( struct ast_bridge_parking *  self, struct parking_lot *  bridge_lot  )

static

Definition at line 438 of file parking_bridge.c.

References ao2_ref, and NULL.

Referenced by bridge_parking_new().

{
   if (!self) {
      return NULL;
   }

   /* If no lot is defined for the bridge, then we aren't allowing the bridge to be initialized. */
   if (!bridge_lot) {
      ao2_ref(self, -1);
      return NULL;
   }

   /* It doesn't need to be a reference since the bridge only lives as long as the parking lot lives. */
   self->lot = bridge_lot;

   return &self->base;
}

bridge_parking_destroy()

static void bridge_parking_destroy ( struct ast_bridge_parking *  self )

static

Definition at line 54 of file parking_bridge.c.

References ast_bridge_base_v_table, and ast_bridge_methods::destroy.

{
   ast_bridge_base_v_table.destroy(&self->base);
}

bridge_parking_dissolving()

static void bridge_parking_dissolving ( struct ast_bridge_parking *  self )

static

Definition at line 59 of file parking_bridge.c.

References ast_bridge_base_v_table, ast_bridge_methods::dissolving, and NULL.

{
   self->lot = NULL;
   ast_bridge_base_v_table.dissolving(&self->base);
}

bridge_parking_get_merge_priority()

static void bridge_parking_get_merge_priority ( struct ast_bridge_parking *  self )

static

Definition at line 423 of file parking_bridge.c.

References ast_bridge_base_v_table, and ast_bridge_methods::get_merge_priority.

{
   ast_bridge_base_v_table.get_merge_priority(&self->base);
}

bridge_parking_new()

struct ast_bridge* bridge_parking_new

(

struct parking_lot *

bridge_lot

)

Create a new parking bridge.

Since

12.0.0

Parameters

bridge_lot

Parking lot which the new bridge should be based on

Return values

NULL	if the bridge can not be created
Newly	created parking bridge

Definition at line 456 of file parking_bridge.c.

References AST_BRIDGE_CAPABILITY_HOLDING, AST_BRIDGE_FLAG_MERGE_INHIBIT_FROM, AST_BRIDGE_FLAG_MERGE_INHIBIT_TO, AST_BRIDGE_FLAG_SWAP_INHIBIT_FROM, ast_bridge_parking_init(), bridge_alloc(), bridge_base_init(), bridge_register(), parking_lot::name, and NULL.

Referenced by parking_lot_get_bridge().

{
   void *bridge;

   bridge = bridge_alloc(sizeof(struct ast_bridge_parking), &ast_bridge_parking_v_table);
   bridge = bridge_base_init(bridge, AST_BRIDGE_CAPABILITY_HOLDING,
      AST_BRIDGE_FLAG_MERGE_INHIBIT_TO | AST_BRIDGE_FLAG_MERGE_INHIBIT_FROM
      | AST_BRIDGE_FLAG_SWAP_INHIBIT_FROM,  "Parking", bridge_lot->name, NULL);
   bridge = ast_bridge_parking_init(bridge, bridge_lot);
   bridge = bridge_register(bridge);
   return bridge;
}

bridge_parking_notify_masquerade()

static void bridge_parking_notify_masquerade ( struct ast_bridge_parking *  self, struct ast_bridge_channel *  bridge_channel  )

static

Definition at line 418 of file parking_bridge.c.

References ast_bridge_base_v_table, and ast_bridge_methods::notify_masquerade.

{
   ast_bridge_base_v_table.notify_masquerade(&self->base, bridge_channel);
}

bridge_parking_pull()

static void bridge_parking_pull ( struct ast_bridge_parking *  self, struct ast_bridge_channel *  bridge_channel  )

static

Definition at line 342 of file parking_bridge.c.

References ao2_cleanup, ao2_lock, ao2_unlock, ast_bridge_base_v_table, ast_bridge_channel_queue_playfile(), AST_DEVICE_NOT_INUSE, AST_FEATURE_FLAG_BYCALLEE, ast_bridge_channel::bridge_pvt, ast_bridge_channel::chan, NULL, PARK_ABANDON, PARK_ANSWERED, PARK_FORCED, PARK_TIMEOUT, PARK_UNSET, PARKED_CALL_GIVEUP, parked_call_retrieve_enable_features(), PARKED_CALL_TIMEOUT, PARKED_CALL_UNPARKED, parking_notify_metermaids(), publish_parked_call(), ast_bridge_methods::pull, RAII_VAR, and unpark_parked_user().

{
   RAII_VAR(struct parked_user *, pu, NULL, ao2_cleanup);

   ast_bridge_base_v_table.pull(&self->base, bridge_channel);

   /* Take over the bridge channel's pu reference. It will be released when we are done. */
   pu = bridge_channel->bridge_pvt;
   bridge_channel->bridge_pvt = NULL;

   /* This should only happen if the exiting channel was swapped out */
   if (!pu) {
      return;
   }

   /* If we got here without the resolution being set, that's because the call was hung up for some reason without
    * timing out or being picked up. There may be some forcible park removals later, but the resolution should be
    * handled in those cases */
   ao2_lock(pu);
   if (pu->resolution == PARK_UNSET) {
      pu->resolution = PARK_ABANDON;
   }
   ao2_unlock(pu);

   /* Pull can still happen after the bridge starts dissolving, so make sure we still have a lot before trying to notify metermaids. */
   if (self->lot) {
      parking_notify_metermaids(pu->parking_space, self->lot->cfg->parking_con, AST_DEVICE_NOT_INUSE);
   }

   switch (pu->resolution) {
   case PARK_UNSET:
      /* This should be impossible now since the resolution is forcibly set to abandon if it was unset at this point. Resolution
         isn't allowed to be changed when it isn't currently PARK_UNSET. */
      break;
   case PARK_ABANDON:
      /* Since the call was abandoned without additional handling, we need to issue the give up event and unpark the user. */
      publish_parked_call(pu, PARKED_CALL_GIVEUP);
      unpark_parked_user(pu);
      break;
   case PARK_FORCED:
      /* PARK_FORCED is currently unused, but it is expected that it would be handled similar to PARK_ANSWERED.
       * There is currently no event related to forced parked calls either */
      break;
   case PARK_ANSWERED:
      /* If answered or forced, the channel should be pulled from the bridge as part of that process and unlinked from
       * the parking lot afterwards. We do need to apply bridge features though and play the courtesy tone if set. */
      publish_parked_call(pu, PARKED_CALL_UNPARKED);
      parked_call_retrieve_enable_features(bridge_channel->chan, pu->lot, AST_FEATURE_FLAG_BYCALLEE);

      if (pu->lot->cfg->parkedplay & AST_FEATURE_FLAG_BYCALLEE) {
         ast_bridge_channel_queue_playfile(bridge_channel, NULL, pu->lot->cfg->courtesytone, NULL);
      }
      break;
   case PARK_TIMEOUT:
      /* Timeout is similar to abandon because it simply sets the bridge state to end and doesn't
       * actually pull the channel. Because of that, unpark should happen in here. */
      publish_parked_call(pu, PARKED_CALL_TIMEOUT);
      parked_call_retrieve_enable_features(bridge_channel->chan, pu->lot, AST_FEATURE_FLAG_BYCALLEE);
      unpark_parked_user(pu);
      break;
   }
}

bridge_parking_push()

static int bridge_parking_push ( struct ast_bridge_parking *  self, struct ast_bridge_channel *  bridge_channel, struct ast_bridge_channel *  swap  )

static

Definition at line 206 of file parking_bridge.c.

References ao2_cleanup, ast_answer(), ast_assert, ast_bridge_base_v_table, ast_bridge_channel_get_role_option(), ast_bridge_channel_has_role(), ast_bridge_channel_lock, ast_bridge_channel_queue_playfile(), ast_bridge_channel_unlock, ast_channel_lock, ast_channel_name(), ast_channel_snapshot_get_latest(), ast_channel_unlock, ast_copy_string(), AST_DEVICE_INUSE, ast_log, AST_STATE_UP, ast_strdupa, ast_strlen_zero, ast_verb, ast_channel_snapshot::base, ast_bridge_channel::bridge_pvt, ast_bridge_channel::chan, parked_user::chan, COLOR_BRMAGENTA, COLORIZE, COLORIZE_FMT, parked_user::comeback, ast_bridge_channel::features, generate_parked_user(), get_park_common_datastore_copy(), LOG_WARNING, ast_channel_snapshot_base::name, NULL, park_common_datastore_free(), PARKED_CALL, PARKED_CALL_SWAP, parking_channel_set_roles(), parking_notify_metermaids(), parking_set_duration(), parked_user::parking_space, pbx_builtin_getvar_helper(), publish_parked_call(), publish_parked_call_failure(), ast_bridge_methods::push, RAII_VAR, S_OR, and say_parking_space().

{
   struct parked_user *pu;
   const char *blind_transfer;
   struct ast_channel_snapshot *parker = NULL;
   const char *parker_channel_name = NULL;
   RAII_VAR(struct park_common_datastore *, park_datastore, NULL, park_common_datastore_free);

   ast_bridge_base_v_table.push(&self->base, bridge_channel, swap);

   ast_assert(self->lot != NULL);

   /* Answer the channel if needed */
   if (ast_channel_state(bridge_channel->chan) != AST_STATE_UP) {
      ast_answer(bridge_channel->chan);
   }

   if (swap) {
      int use_ringing = 0;

      ast_bridge_channel_lock(swap);
      pu = swap->bridge_pvt;
      if (!pu) {
         /* This should be impossible since the only way a channel can enter in the first place
          * is if it has a parked user associated with it */
         publish_parked_call_failure(bridge_channel->chan);
         ast_bridge_channel_unlock(swap);
         return -1;
      }

      /* Give the swap channel's parked user reference to the incoming channel */
      pu->chan = bridge_channel->chan;
      bridge_channel->bridge_pvt = pu;
      swap->bridge_pvt = NULL;

      if (ast_bridge_channel_has_role(swap, "holding_participant")) {
         const char *idle_mode = ast_bridge_channel_get_role_option(swap, "holding_participant", "idle_mode");

         if (!ast_strlen_zero(idle_mode) && !strcmp(idle_mode, "ringing")) {
            use_ringing = 1;
         }
      }

      ast_bridge_channel_unlock(swap);

      parking_set_duration(bridge_channel->features, pu);

      if (parking_channel_set_roles(bridge_channel->chan, self->lot, use_ringing)) {
         ast_log(LOG_WARNING, "Failed to apply holding bridge roles to %s while joining the parking lot.\n",
            ast_channel_name(bridge_channel->chan));
      }

      publish_parked_call(pu, PARKED_CALL_SWAP);

      return 0;
   }

   if (!(park_datastore = get_park_common_datastore_copy(bridge_channel->chan))) {
      /* There was either a failure to apply the datastore when performing park common setup or else we had alloc failures while cloning. Abort. */
      return -1;
   }
   parker = ast_channel_snapshot_get_latest(park_datastore->parker_uuid);

   /* If the parker and the parkee are the same channel pointer, then the channel entered using
    * the park application. It's possible that the channel that transferred it is still alive (particularly
    * when a multichannel bridge is parked), so try to get the real parker if possible. */
   ast_channel_lock(bridge_channel->chan);
   blind_transfer = pbx_builtin_getvar_helper(bridge_channel->chan, "BLINDTRANSFER");
   blind_transfer = ast_strdupa(S_OR(blind_transfer, ""));
   ast_channel_unlock(bridge_channel->chan);
   if (!parker || !strcmp(parker->base->name, ast_channel_name(bridge_channel->chan))) {
      if (ast_strlen_zero(blind_transfer) && parker) {
         /* If no BLINDTRANSFER exists but the parker does then use their channel name */
         parker_channel_name = parker->base->name;
      } else {
         /* Even if there is no BLINDTRANSFER dialplan variable then blind_transfer will
          * be an empty string.
          */
         parker_channel_name = blind_transfer;
      }
   } else {
      parker_channel_name = parker->base->name;
   }

   pu = generate_parked_user(self->lot, bridge_channel->chan, parker_channel_name,
      park_datastore->parker_dial_string, park_datastore->randomize, park_datastore->time_limit);
   ao2_cleanup(parker);
   if (!pu) {
      publish_parked_call_failure(bridge_channel->chan);
      return -1;
   }

   /* If a comeback_override was provided, set it for the parked user's comeback string. */
   if (park_datastore->comeback_override) {
      ast_copy_string(pu->comeback, park_datastore->comeback_override, sizeof(pu->comeback));
   }

   /* Generate ParkedCall Stasis Message */
   publish_parked_call(pu, PARKED_CALL);

   /* If not a blind transfer and silence_announce isn't set, play the announcement to the parkee */
   if (ast_strlen_zero(blind_transfer) && !park_datastore->silence_announce) {
      char saynum_buf[16];

      snprintf(saynum_buf, sizeof(saynum_buf), "%d %d", 0, pu->parking_space);
      ast_bridge_channel_queue_playfile(bridge_channel, say_parking_space, saynum_buf, NULL);
   }

   /* Apply parking duration limits */
   parking_set_duration(bridge_channel->features, pu);

   /* Set this to the bridge pvt so that we don't have to refind the parked user associated with this bridge channel again. */
   bridge_channel->bridge_pvt = pu;

   ast_verb(3, "Parking '" COLORIZE_FMT "' in '" COLORIZE_FMT "' at space %d\n",
      COLORIZE(COLOR_BRMAGENTA, 0, ast_channel_name(bridge_channel->chan)),
      COLORIZE(COLOR_BRMAGENTA, 0, self->lot->name),
      pu->parking_space);

   parking_notify_metermaids(pu->parking_space, self->lot->cfg->parking_con, AST_DEVICE_INUSE);

   return 0;
}

destroy_parked_user()

static void destroy_parked_user ( void *  obj )

static

Definition at line 65 of file parking_bridge.c.

References ao2_cleanup, ast_free, parked_user::lot, parked_user::parker_dial_string, and parked_user::retriever.

Referenced by generate_parked_user().

{
   struct parked_user *pu = obj;

   ao2_cleanup(pu->lot);
   ao2_cleanup(pu->retriever);
   ast_free(pu->parker_dial_string);
}

generate_parked_user()

static struct parked_user* generate_parked_user ( struct parking_lot *  lot, struct ast_channel *  chan, const char *  parker_channel_name, const char *  parker_dial_string, int  use_random_space, int  time_limit  )

static

Definition at line 109 of file parking_bridge.c.

References ao2_alloc, ao2_link, ao2_lock, ao2_ref, ao2_unlock, ast_channel_lock, ast_channel_unlock, ast_log, ast_random(), ast_strdup, ast_strdupa, ast_strlen_zero, ast_tvnow(), parking_lot::cfg, parked_user::chan, destroy_parked_user(), if(), LOG_NOTICE, LOG_WARNING, parked_user::lot, parking_lot::mode, parking_lot::name, parking_lot::next_space, NULL, parked_user_set_parker_dial_string(), parking_lot::parked_users, parked_user::parker_dial_string, parking_lot_get_space(), parked_user::parking_space, parking_lot_cfg::parking_start, parking_lot_cfg::parking_stop, PARKINGLOT_DISABLED, parking_lot_cfg::parkingtime, pbx_builtin_getvar_helper(), parked_user::start, and parked_user::time_limit.

Referenced by bridge_parking_push().

{
   struct parked_user *new_parked_user;
   int preferred_space = -1; /* Initialize to use parking lot defaults */
   int parking_space;
   const char *parkingexten;

   if (lot->mode == PARKINGLOT_DISABLED) {
      ast_log(LOG_NOTICE, "Tried to park in a parking lot that is no longer able to be parked to.\n");
      return NULL;
   }

   new_parked_user = ao2_alloc(sizeof(*new_parked_user), destroy_parked_user);
   if (!new_parked_user) {
      return NULL;
   }

   if (use_random_space) {
      preferred_space = ast_random() % (lot->cfg->parking_stop - lot->cfg->parking_start + 1);
      preferred_space += lot->cfg->parking_start;
   } else {
      ast_channel_lock(chan);
      if ((parkingexten = pbx_builtin_getvar_helper(chan, "PARKINGEXTEN"))) {
         parkingexten = ast_strdupa(parkingexten);
      }
      ast_channel_unlock(chan);

      if (!ast_strlen_zero(parkingexten)) {
         if (sscanf(parkingexten, "%30d", &preferred_space) != 1 || preferred_space <= 0) {
            ast_log(LOG_WARNING, "PARKINGEXTEN='%s' is not a valid parking space.\n", parkingexten);
            ao2_ref(new_parked_user, -1);
            return NULL;
         }
      }
   }

   /* We need to keep the lot locked between parking_lot_get_space and actually placing it in the lot. Or until we decide not to. */
   ao2_lock(lot);

   parking_space = parking_lot_get_space(lot, preferred_space);
   if (parking_space == -1) {
      ast_log(LOG_NOTICE, "Failed to get parking space in lot '%s'. All full.\n", lot->name);
      ao2_ref(new_parked_user, -1);
      ao2_unlock(lot);
      return NULL;
   }

   lot->next_space = ((parking_space + 1) - lot->cfg->parking_start) % (lot->cfg->parking_stop - lot->cfg->parking_start + 1) + lot->cfg->parking_start;
   new_parked_user->chan = chan;
   new_parked_user->parking_space = parking_space;

   /* Have the parked user take a reference to the parking lot. This reference should be immutable and released at destruction */
   new_parked_user->lot = lot;
   ao2_ref(lot, +1);

   new_parked_user->start = ast_tvnow();
   new_parked_user->time_limit = (time_limit >= 0) ? time_limit : lot->cfg->parkingtime;

   if (parker_dial_string) {
      new_parked_user->parker_dial_string = ast_strdup(parker_dial_string);
   } else {
      if (ast_strlen_zero(parker_channel_name) || parked_user_set_parker_dial_string(new_parked_user, parker_channel_name)) {
         ao2_ref(new_parked_user, -1);
         ao2_unlock(lot);
         return NULL;
      }
   }

   if (!new_parked_user->parker_dial_string) {
      ao2_ref(new_parked_user, -1);
      ao2_unlock(lot);
      return NULL;
   }

   /* Insert into the parking lot's parked user list. We can unlock the lot now. */
   ao2_link(lot->parked_users, new_parked_user);
   ao2_unlock(lot);

   return new_parked_user;
}

parked_user_set_parker_dial_string()

static int parked_user_set_parker_dial_string ( struct parked_user *  pu, const char *  parker_channel_name  )

static

Definition at line 75 of file parking_bridge.c.

References ast_channel_name_to_dial_string(), ast_strdup, ast_strdupa, and parked_user::parker_dial_string.

Referenced by generate_parked_user().

{
   char *dial_string = ast_strdupa(parker_channel_name);

   ast_channel_name_to_dial_string(dial_string);
   pu->parker_dial_string = ast_strdup(dial_string);

   if (!pu->parker_dial_string) {
      return -1;
   }

   return 0;
}

Variable Documentation

ast_bridge_parking_v_table

struct ast_bridge_methods ast_bridge_parking_v_table

Definition at line 428 of file parking_bridge.c.