diff --git a/CHANGES b/CHANGES
index 52e8f6681f8aac28519cdf3dc233331fa1217573..f3ab90d2afc65205b2ce3fe43258986a13323a60 100644
--- a/CHANGES
+++ b/CHANGES
@@ -118,6 +118,22 @@ chan_pjsip
more information. Defaults to 'no' as setting it to 'yes' can result in
many unnecessary messages being sent to the caller.
+res_ari_channels
+------------------
+ * Two new events, 'ChannelHold' and 'ChannelUnhold', have been added to the
+ events data model. These events are raised when a channel indicates a hold
+ or unhold, respectively.
+
+func_holdintercept
+------------------
+ * A new dialplan function, HOLD_INTERCEPT, has been added. This function, when
+ placed on a channel, intercepts hold/unhold indications signalled by the
+ channel and prevents them from moving on to other channels in a bridge with
+ the hold initiator. Instead, AMI or ARI events are raised indicating that
+ the channel wanted to place someone on hold. This allows external
+ applications to implement their own custom hold/unhold logic.
+
+
------------------------------------------------------------------------------
--- Functionality changes from Asterisk 13.2.0 to Asterisk 13.3.0 ------------
------------------------------------------------------------------------------
diff --git a/main/bridge_channel.c b/main/bridge_channel.c
index 29e7cf0f6751a37d88417b6182533bc12566c404..c25d827cb7606b9f35b3f4fcdee1c3b5e59c5004 100644
--- a/main/bridge_channel.c
+++ b/main/bridge_channel.c
@@ -979,7 +979,8 @@ int ast_bridge_channel_write_control_data(struct ast_bridge_channel *bridge_chan
int ast_bridge_channel_write_hold(struct ast_bridge_channel *bridge_channel, const char *moh_class)
{
- RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
+ struct ast_json *blob;
+ int res;
size_t datalen;
if (!ast_strlen_zero(moh_class)) {
@@ -990,12 +991,16 @@ int ast_bridge_channel_write_hold(struct ast_bridge_channel *bridge_channel, con
} else {
moh_class = NULL;
datalen = 0;
+ blob = NULL;
}
ast_channel_publish_cached_blob(bridge_channel->chan, ast_channel_hold_type(), blob);
- return ast_bridge_channel_write_control_data(bridge_channel, AST_CONTROL_HOLD,
+ res = ast_bridge_channel_write_control_data(bridge_channel, AST_CONTROL_HOLD,
moh_class, datalen);
+
+ ast_json_unref(blob);
+ return res;
}
int ast_bridge_channel_write_unhold(struct ast_bridge_channel *bridge_channel)
diff --git a/main/channel.c b/main/channel.c
index a9c3009fe398c55ff00f371dbf79b6547a62a52b..2d1b6ddd1ec8670b03e3b061dbf8d27a3de5598f 100644
--- a/main/channel.c
+++ b/main/channel.c
@@ -1196,8 +1196,8 @@ int ast_queue_hangup_with_cause(struct ast_channel *chan, int cause)
int ast_queue_hold(struct ast_channel *chan, const char *musicclass)
{
- RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_HOLD };
+ struct ast_json *blob = NULL;
int res;
if (!ast_strlen_zero(musicclass)) {
@@ -1212,6 +1212,8 @@ int ast_queue_hold(struct ast_channel *chan, const char *musicclass)
res = ast_queue_frame(chan, &f);
+ ast_json_unref(blob);
+
return res;
}
diff --git a/main/manager_channels.c b/main/manager_channels.c
index f6dc46cec4b33d98b71c19096fb0684f7c029221..3aaab92d058506b13a068ba9807d5ee5b2de2506 100644
--- a/main/manager_channels.c
+++ b/main/manager_channels.c
@@ -1061,20 +1061,22 @@ static void channel_hold_cb(void *data, struct stasis_subscription *sub,
struct stasis_message *message)
{
struct ast_channel_blob *obj = stasis_message_data(message);
- const char *musicclass;
- RAII_VAR(struct ast_str *, musicclass_string, NULL, ast_free);
- RAII_VAR(struct ast_str *, channel_event_string, NULL, ast_free);
+ struct ast_str *musicclass_string = ast_str_create(32);
+ struct ast_str *channel_event_string;
- if (!(musicclass_string = ast_str_create(32))) {
+ if (!musicclass_string) {
return;
}
channel_event_string = ast_manager_build_channel_state_string(obj->snapshot);
if (!channel_event_string) {
+ ast_free(musicclass_string);
return;
}
if (obj->blob) {
+ const char *musicclass;
+
musicclass = ast_json_string_get(ast_json_object_get(obj->blob, "musicclass"));
if (!ast_strlen_zero(musicclass)) {
@@ -1087,13 +1089,16 @@ static void channel_hold_cb(void *data, struct stasis_subscription *sub,
"%s",
ast_str_buffer(channel_event_string),
ast_str_buffer(musicclass_string));
+
+ ast_free(musicclass_string);
+ ast_free(channel_event_string);
}
static void channel_unhold_cb(void *data, struct stasis_subscription *sub,
struct stasis_message *message)
{
struct ast_channel_blob *obj = stasis_message_data(message);
- RAII_VAR(struct ast_str *, channel_event_string, NULL, ast_free);
+ struct ast_str *channel_event_string;
channel_event_string = ast_manager_build_channel_state_string(obj->snapshot);
if (!channel_event_string) {
@@ -1103,6 +1108,8 @@ static void channel_unhold_cb(void *data, struct stasis_subscription *sub,
manager_event(EVENT_FLAG_CALL, "Unhold",
"%s",
ast_str_buffer(channel_event_string));
+
+ ast_free(channel_event_string);
}
static void manager_channels_shutdown(void)
diff --git a/main/stasis_channels.c b/main/stasis_channels.c
index 85abe58bca7b1b20a658cf08d2d38c381c8c83c0..968afbd7d3021cf19adbafe1e5138360707bf993 100644
--- a/main/stasis_channels.c
+++ b/main/stasis_channels.c
@@ -1136,6 +1136,47 @@ static struct ast_json *talking_stop_to_json(struct stasis_message *message,
return channel_blob_to_json(message, "ChannelTalkingFinished", sanitize);
}
+static struct ast_json *hold_to_json(struct stasis_message *message,
+ const struct stasis_message_sanitizer *sanitize)
+{
+ struct ast_channel_blob *channel_blob = stasis_message_data(message);
+ struct ast_json *blob = channel_blob->blob;
+ struct ast_channel_snapshot *snapshot = channel_blob->snapshot;
+ const char *musicclass = ast_json_string_get(ast_json_object_get(blob, "musicclass"));
+ const struct timeval *tv = stasis_message_timestamp(message);
+ struct ast_json *json_channel;
+
+ json_channel = ast_channel_snapshot_to_json(snapshot, sanitize);
+ if (!json_channel) {
+ return NULL;
+ }
+
+ return ast_json_pack("{s: s, s: o, s: s, s: o}",
+ "type", "ChannelHold",
+ "timestamp", ast_json_timeval(*tv, NULL),
+ "musicclass", S_OR(musicclass, "N/A"),
+ "channel", json_channel);
+}
+
+static struct ast_json *unhold_to_json(struct stasis_message *message,
+ const struct stasis_message_sanitizer *sanitize)
+{
+ struct ast_channel_blob *channel_blob = stasis_message_data(message);
+ struct ast_channel_snapshot *snapshot = channel_blob->snapshot;
+ const struct timeval *tv = stasis_message_timestamp(message);
+ struct ast_json *json_channel;
+
+ json_channel = ast_channel_snapshot_to_json(snapshot, sanitize);
+ if (!json_channel) {
+ return NULL;
+ }
+
+ return ast_json_pack("{s: s, s: o, s: o}",
+ "type", "ChannelUnhold",
+ "timestamp", ast_json_timeval(*tv, NULL),
+ "channel", json_channel);
+}
+
/*!
* @{ \brief Define channel message types.
*/
@@ -1154,8 +1195,12 @@ STASIS_MESSAGE_TYPE_DEFN(ast_channel_dtmf_begin_type);
STASIS_MESSAGE_TYPE_DEFN(ast_channel_dtmf_end_type,
.to_json = dtmf_end_to_json,
);
-STASIS_MESSAGE_TYPE_DEFN(ast_channel_hold_type);
-STASIS_MESSAGE_TYPE_DEFN(ast_channel_unhold_type);
+STASIS_MESSAGE_TYPE_DEFN(ast_channel_hold_type,
+ .to_json = hold_to_json,
+ );
+STASIS_MESSAGE_TYPE_DEFN(ast_channel_unhold_type,
+ .to_json = unhold_to_json,
+ );
STASIS_MESSAGE_TYPE_DEFN(ast_channel_chanspy_start_type);
STASIS_MESSAGE_TYPE_DEFN(ast_channel_chanspy_stop_type);
STASIS_MESSAGE_TYPE_DEFN(ast_channel_fax_type);
diff --git a/res/ari/ari_model_validators.c b/res/ari/ari_model_validators.c
index 491a4cca197c203bc1651a3c2dfedf62095209d3..007d7657fdf74a1a4488e449e75735bfbde9069d 100644
--- a/res/ari/ari_model_validators.c
+++ b/res/ari/ari_model_validators.c
@@ -3197,6 +3197,85 @@ ari_validator ast_ari_validate_channel_hangup_request_fn(void)
return ast_ari_validate_channel_hangup_request;
}
+int ast_ari_validate_channel_hold(struct ast_json *json)
+{
+ int res = 1;
+ struct ast_json_iter *iter;
+ int has_type = 0;
+ int has_application = 0;
+ int has_channel = 0;
+
+ for (iter = ast_json_object_iter(json); iter; iter = ast_json_object_iter_next(json, iter)) {
+ if (strcmp("type", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_type = 1;
+ prop_is_valid = ast_ari_validate_string(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI ChannelHold field type failed validation\n");
+ res = 0;
+ }
+ } else
+ if (strcmp("application", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_application = 1;
+ prop_is_valid = ast_ari_validate_string(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI ChannelHold field application failed validation\n");
+ res = 0;
+ }
+ } else
+ if (strcmp("timestamp", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ prop_is_valid = ast_ari_validate_date(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI ChannelHold field timestamp failed validation\n");
+ res = 0;
+ }
+ } else
+ if (strcmp("channel", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_channel = 1;
+ prop_is_valid = ast_ari_validate_channel(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI ChannelHold field channel failed validation\n");
+ res = 0;
+ }
+ } else
+ {
+ ast_log(LOG_ERROR,
+ "ARI ChannelHold has undocumented field %s\n",
+ ast_json_object_iter_key(iter));
+ res = 0;
+ }
+ }
+
+ if (!has_type) {
+ ast_log(LOG_ERROR, "ARI ChannelHold missing required field type\n");
+ res = 0;
+ }
+
+ if (!has_application) {
+ ast_log(LOG_ERROR, "ARI ChannelHold missing required field application\n");
+ res = 0;
+ }
+
+ if (!has_channel) {
+ ast_log(LOG_ERROR, "ARI ChannelHold missing required field channel\n");
+ res = 0;
+ }
+
+ return res;
+}
+
+ari_validator ast_ari_validate_channel_hold_fn(void)
+{
+ return ast_ari_validate_channel_hold;
+}
+
int ast_ari_validate_channel_left_bridge(struct ast_json *json)
{
int res = 1;
@@ -3545,6 +3624,85 @@ ari_validator ast_ari_validate_channel_talking_started_fn(void)
return ast_ari_validate_channel_talking_started;
}
+int ast_ari_validate_channel_unhold(struct ast_json *json)
+{
+ int res = 1;
+ struct ast_json_iter *iter;
+ int has_type = 0;
+ int has_application = 0;
+ int has_channel = 0;
+
+ for (iter = ast_json_object_iter(json); iter; iter = ast_json_object_iter_next(json, iter)) {
+ if (strcmp("type", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_type = 1;
+ prop_is_valid = ast_ari_validate_string(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI ChannelUnhold field type failed validation\n");
+ res = 0;
+ }
+ } else
+ if (strcmp("application", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_application = 1;
+ prop_is_valid = ast_ari_validate_string(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI ChannelUnhold field application failed validation\n");
+ res = 0;
+ }
+ } else
+ if (strcmp("timestamp", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ prop_is_valid = ast_ari_validate_date(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI ChannelUnhold field timestamp failed validation\n");
+ res = 0;
+ }
+ } else
+ if (strcmp("channel", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_channel = 1;
+ prop_is_valid = ast_ari_validate_channel(
+ ast_json_object_iter_value(iter));
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI ChannelUnhold field channel failed validation\n");
+ res = 0;
+ }
+ } else
+ {
+ ast_log(LOG_ERROR,
+ "ARI ChannelUnhold has undocumented field %s\n",
+ ast_json_object_iter_key(iter));
+ res = 0;
+ }
+ }
+
+ if (!has_type) {
+ ast_log(LOG_ERROR, "ARI ChannelUnhold missing required field type\n");
+ res = 0;
+ }
+
+ if (!has_application) {
+ ast_log(LOG_ERROR, "ARI ChannelUnhold missing required field application\n");
+ res = 0;
+ }
+
+ if (!has_channel) {
+ ast_log(LOG_ERROR, "ARI ChannelUnhold missing required field channel\n");
+ res = 0;
+ }
+
+ return res;
+}
+
+ari_validator ast_ari_validate_channel_unhold_fn(void)
+{
+ return ast_ari_validate_channel_unhold;
+}
+
int ast_ari_validate_channel_userevent(struct ast_json *json)
{
int res = 1;
@@ -4119,6 +4277,9 @@ int ast_ari_validate_event(struct ast_json *json)
if (strcmp("ChannelHangupRequest", discriminator) == 0) {
return ast_ari_validate_channel_hangup_request(json);
} else
+ if (strcmp("ChannelHold", discriminator) == 0) {
+ return ast_ari_validate_channel_hold(json);
+ } else
if (strcmp("ChannelLeftBridge", discriminator) == 0) {
return ast_ari_validate_channel_left_bridge(json);
} else
@@ -4131,6 +4292,9 @@ int ast_ari_validate_event(struct ast_json *json)
if (strcmp("ChannelTalkingStarted", discriminator) == 0) {
return ast_ari_validate_channel_talking_started(json);
} else
+ if (strcmp("ChannelUnhold", discriminator) == 0) {
+ return ast_ari_validate_channel_unhold(json);
+ } else
if (strcmp("ChannelUserevent", discriminator) == 0) {
return ast_ari_validate_channel_userevent(json);
} else
@@ -4290,6 +4454,9 @@ int ast_ari_validate_message(struct ast_json *json)
if (strcmp("ChannelHangupRequest", discriminator) == 0) {
return ast_ari_validate_channel_hangup_request(json);
} else
+ if (strcmp("ChannelHold", discriminator) == 0) {
+ return ast_ari_validate_channel_hold(json);
+ } else
if (strcmp("ChannelLeftBridge", discriminator) == 0) {
return ast_ari_validate_channel_left_bridge(json);
} else
@@ -4302,6 +4469,9 @@ int ast_ari_validate_message(struct ast_json *json)
if (strcmp("ChannelTalkingStarted", discriminator) == 0) {
return ast_ari_validate_channel_talking_started(json);
} else
+ if (strcmp("ChannelUnhold", discriminator) == 0) {
+ return ast_ari_validate_channel_unhold(json);
+ } else
if (strcmp("ChannelUserevent", discriminator) == 0) {
return ast_ari_validate_channel_userevent(json);
} else
diff --git a/res/ari/ari_model_validators.h b/res/ari/ari_model_validators.h
index 947e28852db3f5715513893ee96db52286d3c03e..9cb1bc32cb39262501bef27792c753f207dd7dff 100644
--- a/res/ari/ari_model_validators.h
+++ b/res/ari/ari_model_validators.h
@@ -808,6 +808,24 @@ int ast_ari_validate_channel_hangup_request(struct ast_json *json);
*/
ari_validator ast_ari_validate_channel_hangup_request_fn(void);
+/*!
+ * \brief Validator for ChannelHold.
+ *
+ * A channel initiated a media hold.
+ *
+ * \param json JSON object to validate.
+ * \returns True (non-zero) if valid.
+ * \returns False (zero) if invalid.
+ */
+int ast_ari_validate_channel_hold(struct ast_json *json);
+
+/*!
+ * \brief Function pointer to ast_ari_validate_channel_hold().
+ *
+ * See \ref ast_ari_model_validators.h for more details.
+ */
+ari_validator ast_ari_validate_channel_hold_fn(void);
+
/*!
* \brief Validator for ChannelLeftBridge.
*
@@ -880,6 +898,24 @@ int ast_ari_validate_channel_talking_started(struct ast_json *json);
*/
ari_validator ast_ari_validate_channel_talking_started_fn(void);
+/*!
+ * \brief Validator for ChannelUnhold.
+ *
+ * A channel initiated a media unhold.
+ *
+ * \param json JSON object to validate.
+ * \returns True (non-zero) if valid.
+ * \returns False (zero) if invalid.
+ */
+int ast_ari_validate_channel_unhold(struct ast_json *json);
+
+/*!
+ * \brief Function pointer to ast_ari_validate_channel_unhold().
+ *
+ * See \ref ast_ari_model_validators.h for more details.
+ */
+ari_validator ast_ari_validate_channel_unhold_fn(void);
+
/*!
* \brief Validator for ChannelUserevent.
*
@@ -1393,6 +1429,11 @@ ari_validator ast_ari_validate_application_fn(void);
* - cause: int
* - channel: Channel (required)
* - soft: boolean
+ * ChannelHold
+ * - type: string (required)
+ * - application: string (required)
+ * - timestamp: Date
+ * - channel: Channel (required)
* ChannelLeftBridge
* - type: string (required)
* - application: string (required)
@@ -1415,6 +1456,11 @@ ari_validator ast_ari_validate_application_fn(void);
* - application: string (required)
* - timestamp: Date
* - channel: Channel (required)
+ * ChannelUnhold
+ * - type: string (required)
+ * - application: string (required)
+ * - timestamp: Date
+ * - channel: Channel (required)
* ChannelUserevent
* - type: string (required)
* - application: string (required)
diff --git a/rest-api/api-docs/events.json b/rest-api/api-docs/events.json
index 1aceb71edf53a277cd092cb4102a6b70f49b0e8d..f5e61f9ad9f3acb790e474189b2eff92b45373d8 100644
--- a/rest-api/api-docs/events.json
+++ b/rest-api/api-docs/events.json
@@ -161,6 +161,8 @@
"ChannelVarset",
"ChannelTalkingStarted",
"ChannelTalkingFinished",
+ "ChannelHold",
+ "ChannelUnhold",
"EndpointStateChange",
"Dial",
"StasisEnd",
@@ -598,6 +600,28 @@
}
}
},
+ "ChannelHold": {
+ "id": "ChannelHold",
+ "description": "A channel initiated a media hold.",
+ "properties": {
+ "channel": {
+ "required": true,
+ "type": "Channel",
+ "description": "The channel that initiated the hold event."
+ }
+ }
+ },
+ "ChannelUnhold": {
+ "id": "ChannelUnhold",
+ "description": "A channel initiated a media unhold.",
+ "properties": {
+ "channel": {
+ "required": true,
+ "type": "Channel",
+ "description": "The channel that initiated the unhold event."
+ }
+ }
+ },
"ChannelTalkingStarted": {
"id": "ChannelTalkingStarted",
"description": "Talking was detected on the channel.",