Author: mmichelson Date: Mon Dec 8 09:49:24 2014 New Revision: 429064 URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=429064 Log: Add new AMI and ARI events for connected line changes on a channel.
The AMI event is called NewConnectedLine and the ARI event is called ChannelConnectedLine. ASTERISK-24554 #close Reported by Matt Jordan Review: https://reviewboard.asterisk.org/r/4231 Modified: branches/13/CHANGES branches/13/include/asterisk/stasis_channels.h branches/13/main/channel.c branches/13/main/manager_channels.c branches/13/main/stasis_channels.c branches/13/res/ari/ari_model_validators.c branches/13/res/ari/ari_model_validators.h branches/13/res/stasis/app.c branches/13/rest-api/api-docs/events.json Modified: branches/13/CHANGES URL: http://svnview.digium.com/svn/asterisk/branches/13/CHANGES?view=diff&rev=429064&r1=429063&r2=429064 ============================================================================== --- branches/13/CHANGES (original) +++ branches/13/CHANGES Mon Dec 8 09:49:24 2014 @@ -387,6 +387,16 @@ for Asterisk to Asterisk exchanges of information. Currently, this includes both mailbox state and device state information. + +AMI +------------------ + * Event NewConnectedLine is emitted when the connected line information on + a channel changes. + +ARI +------------------ + * Event ChannelConnectedLine is emitted when the connected line information + on a channel changes. ------------------------------------------------------------------------------ --- Functionality changes from Asterisk 12.4.0 to Asterisk 12.5.0 ------------ Modified: branches/13/include/asterisk/stasis_channels.h URL: http://svnview.digium.com/svn/asterisk/branches/13/include/asterisk/stasis_channels.h?view=diff&rev=429064&r1=429063&r2=429064 ============================================================================== --- branches/13/include/asterisk/stasis_channels.h (original) +++ branches/13/include/asterisk/stasis_channels.h Mon Dec 8 09:49:24 2014 @@ -611,6 +611,20 @@ const struct ast_channel_snapshot *new_snapshot); /*! + * \brief Compares the connected line info of two snapshots. + * \since 13.1.0 + * + * \param old_snapshot Old snapshot + * \param new_snapshot New snapshot + * + * \return True (non-zero) if callerid are identical. + * \return False (zero) if callerid changed. + */ +int ast_channel_snapshot_connected_line_equal( + const struct ast_channel_snapshot *old_snapshot, + const struct ast_channel_snapshot *new_snapshot); + +/*! * \brief Initialize the stasis channel topic and message types * \return 0 on success * \return Non-zero on error Modified: branches/13/main/channel.c URL: http://svnview.digium.com/svn/asterisk/branches/13/main/channel.c?view=diff&rev=429064&r1=429063&r2=429064 ============================================================================== --- branches/13/main/channel.c (original) +++ branches/13/main/channel.c Mon Dec 8 09:49:24 2014 @@ -7960,6 +7960,7 @@ ast_channel_lock(chan); ast_party_connected_line_set(ast_channel_connected(chan), connected, update); + ast_channel_publish_snapshot(chan); ast_channel_unlock(chan); } Modified: branches/13/main/manager_channels.c URL: http://svnview.digium.com/svn/asterisk/branches/13/main/manager_channels.c?view=diff&rev=429064&r1=429063&r2=429064 ============================================================================== --- branches/13/main/manager_channels.c (original) +++ branches/13/main/manager_channels.c Mon Dec 8 09:49:24 2014 @@ -570,6 +570,23 @@ ast_describe_caller_presentation(new_snapshot->caller_pres)); } +static struct ast_manager_event_blob *channel_new_connected_line( + struct ast_channel_snapshot *old_snapshot, + struct ast_channel_snapshot *new_snapshot) +{ + /* No NewConnectedLine event on cache clear or first event */ + if (!old_snapshot || !new_snapshot) { + return NULL; + } + + if (ast_channel_snapshot_connected_line_equal(old_snapshot, new_snapshot)) { + return NULL; + } + + return ast_manager_event_blob_create( + EVENT_FLAG_CALL, "NewConnectedLine", "%s", ""); +} + static struct ast_manager_event_blob *channel_new_accountcode( struct ast_channel_snapshot *old_snapshot, struct ast_channel_snapshot *new_snapshot) @@ -591,7 +608,8 @@ channel_state_change, channel_newexten, channel_new_callerid, - channel_new_accountcode + channel_new_accountcode, + channel_new_connected_line, }; static void channel_snapshot_update(void *data, struct stasis_subscription *sub, Modified: branches/13/main/stasis_channels.c URL: http://svnview.digium.com/svn/asterisk/branches/13/main/stasis_channels.c?view=diff&rev=429064&r1=429063&r2=429064 ============================================================================== --- branches/13/main/stasis_channels.c (original) +++ branches/13/main/stasis_channels.c Mon Dec 8 09:49:24 2014 @@ -938,6 +938,16 @@ strcmp(old_snapshot->caller_name, new_snapshot->caller_name) == 0; } +int ast_channel_snapshot_connected_line_equal( + const struct ast_channel_snapshot *old_snapshot, + const struct ast_channel_snapshot *new_snapshot) +{ + ast_assert(old_snapshot != NULL); + ast_assert(new_snapshot != NULL); + return strcmp(old_snapshot->connected_number, new_snapshot->connected_number) == 0 && + strcmp(old_snapshot->connected_name, new_snapshot->connected_name) == 0; +} + static struct ast_json *channel_blob_to_json( struct stasis_message *message, const char *type, Modified: branches/13/res/ari/ari_model_validators.c URL: http://svnview.digium.com/svn/asterisk/branches/13/res/ari/ari_model_validators.c?view=diff&rev=429064&r1=429063&r2=429064 ============================================================================== --- branches/13/res/ari/ari_model_validators.c (original) +++ branches/13/res/ari/ari_model_validators.c Mon Dec 8 09:49:24 2014 @@ -2505,6 +2505,85 @@ return ast_ari_validate_channel_caller_id; } +int ast_ari_validate_channel_connected_line(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 ChannelConnectedLine 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 ChannelConnectedLine 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 ChannelConnectedLine 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 ChannelConnectedLine field channel failed validation\n"); + res = 0; + } + } else + { + ast_log(LOG_ERROR, + "ARI ChannelConnectedLine has undocumented field %s\n", + ast_json_object_iter_key(iter)); + res = 0; + } + } + + if (!has_type) { + ast_log(LOG_ERROR, "ARI ChannelConnectedLine missing required field type\n"); + res = 0; + } + + if (!has_application) { + ast_log(LOG_ERROR, "ARI ChannelConnectedLine missing required field application\n"); + res = 0; + } + + if (!has_channel) { + ast_log(LOG_ERROR, "ARI ChannelConnectedLine missing required field channel\n"); + res = 0; + } + + return res; +} + +ari_validator ast_ari_validate_channel_connected_line_fn(void) +{ + return ast_ari_validate_channel_connected_line; +} + int ast_ari_validate_channel_created(struct ast_json *json) { int res = 1; @@ -4003,6 +4082,9 @@ if (strcmp("ChannelCallerId", discriminator) == 0) { return ast_ari_validate_channel_caller_id(json); } else + if (strcmp("ChannelConnectedLine", discriminator) == 0) { + return ast_ari_validate_channel_connected_line(json); + } else if (strcmp("ChannelCreated", discriminator) == 0) { return ast_ari_validate_channel_created(json); } else @@ -4170,6 +4252,9 @@ } else if (strcmp("ChannelCallerId", discriminator) == 0) { return ast_ari_validate_channel_caller_id(json); + } else + if (strcmp("ChannelConnectedLine", discriminator) == 0) { + return ast_ari_validate_channel_connected_line(json); } else if (strcmp("ChannelCreated", discriminator) == 0) { return ast_ari_validate_channel_created(json); Modified: branches/13/res/ari/ari_model_validators.h URL: http://svnview.digium.com/svn/asterisk/branches/13/res/ari/ari_model_validators.h?view=diff&rev=429064&r1=429063&r2=429064 ============================================================================== --- branches/13/res/ari/ari_model_validators.h (original) +++ branches/13/res/ari/ari_model_validators.h Mon Dec 8 09:49:24 2014 @@ -679,6 +679,24 @@ * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_caller_id_fn(void); + +/*! + * \brief Validator for ChannelConnectedLine. + * + * Channel changed Connected Line. + * + * \param json JSON object to validate. + * \returns True (non-zero) if valid. + * \returns False (zero) if invalid. + */ +int ast_ari_validate_channel_connected_line(struct ast_json *json); + +/*! + * \brief Function pointer to ast_ari_validate_channel_connected_line(). + * + * See \ref ast_ari_model_validators.h for more details. + */ +ari_validator ast_ari_validate_channel_connected_line_fn(void); /*! * \brief Validator for ChannelCreated. @@ -1330,6 +1348,11 @@ * - caller_presentation: int (required) * - caller_presentation_txt: string (required) * - channel: Channel (required) + * ChannelConnectedLine + * - type: string (required) + * - application: string (required) + * - timestamp: Date + * - channel: Channel (required) * ChannelCreated * - type: string (required) * - application: string (required) Modified: branches/13/res/stasis/app.c URL: http://svnview.digium.com/svn/asterisk/branches/13/res/stasis/app.c?view=diff&rev=429064&r1=429063&r2=429064 ============================================================================== --- branches/13/res/stasis/app.c (original) +++ branches/13/res/stasis/app.c Mon Dec 8 09:49:24 2014 @@ -450,10 +450,38 @@ "channel", json_channel); } +static struct ast_json *channel_connected_line( + struct ast_channel_snapshot *old_snapshot, + struct ast_channel_snapshot *new_snapshot, + const struct timeval *tv) +{ + struct ast_json *json_channel; + + /* No ChannelConnectedLine event on cache clear or first event */ + if (!old_snapshot || !new_snapshot) { + return NULL; + } + + if (ast_channel_snapshot_connected_line_equal(old_snapshot, new_snapshot)) { + return NULL; + } + + json_channel = ast_channel_snapshot_to_json(new_snapshot, stasis_app_get_sanitizer()); + if (!json_channel) { + return NULL; + } + + return ast_json_pack("{s: s, s: o, s: o}", + "type", "ChannelConnectedLine", + "timestamp", ast_json_timeval(*tv, NULL), + "channel", json_channel); +} + static channel_snapshot_monitor channel_monitors[] = { channel_state, channel_dialplan, channel_callerid, + channel_connected_line, }; static void sub_channel_update_handler(void *data, Modified: branches/13/rest-api/api-docs/events.json URL: http://svnview.digium.com/svn/asterisk/branches/13/rest-api/api-docs/events.json?view=diff&rev=429064&r1=429063&r2=429064 ============================================================================== --- branches/13/rest-api/api-docs/events.json (original) +++ branches/13/rest-api/api-docs/events.json Mon Dec 8 09:49:24 2014 @@ -165,7 +165,8 @@ "Dial", "StasisEnd", "StasisStart", - "TextMessageReceived" + "TextMessageReceived", + "ChannelConnectedLine" ] }, "DeviceStateChanged": { @@ -712,6 +713,17 @@ "type": "Endpoint" } } + }, + "ChannelConnectedLine": { + "id": "ChannelConnectedLine", + "description": "Channel changed Connected Line.", + "properties": { + "channel": { + "required": true, + "type": "Channel", + "description": "The channel whose connected line has changed." + } + } } } } -- _____________________________________________________________________ -- Bandwidth and Colocation Provided by http://www.api-digital.com -- svn-commits mailing list To UNSUBSCRIBE or update options visit: http://lists.digium.com/mailman/listinfo/svn-commits
