From: Moritz Fain Date: Mon, 25 Apr 2022 22:40:49 +0000 (+0200) Subject: ari: expose channel driver's unique id to ARI channel resource X-Git-Tag: 16.27.0-rc1~20 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4f2bd069a4deb23dae7c128587b7a08c86560eb4;p=thirdparty%2Fasterisk.git ari: expose channel driver's unique id to ARI channel resource This change exposes the channel driver's unique id (i.e. the Call-ID for chan_sip/chan_pjsip based channels) to ARI channel resources as `protocol_id`. ASTERISK-30027 Reported by: Moritz Fain Tested by: Moritz Fain Change-Id: I7cc6e7a9d29efe74bc27811d788dac20fe559b87 --- diff --git a/channels/chan_pjsip.c b/channels/chan_pjsip.c index 97ca12acb0..b71710413a 100644 --- a/channels/chan_pjsip.c +++ b/channels/chan_pjsip.c @@ -1258,7 +1258,7 @@ static const char *chan_pjsip_get_uniqueid(struct ast_channel *ast) struct ast_sip_channel_pvt *channel = ast_channel_tech_pvt(ast); char *uniqueid = ast_threadstorage_get(&uniqueid_threadbuf, UNIQUEID_BUFSIZE); - if (!uniqueid) { + if (!channel || !uniqueid) { return ""; } diff --git a/doc/CHANGES-staging/ari_add_pvt_id_to_channel_resource.txt b/doc/CHANGES-staging/ari_add_pvt_id_to_channel_resource.txt new file mode 100644 index 0000000000..a4f008f967 --- /dev/null +++ b/doc/CHANGES-staging/ari_add_pvt_id_to_channel_resource.txt @@ -0,0 +1,7 @@ +Subject: ari +Subject: stasis_channels + +Expose channel driver's unique id (which is the Call-ID for SIP/PJSIP) +to ARI channel resources as 'protocol_id'. + +ASTERISK-30027 diff --git a/include/asterisk/stasis_channels.h b/include/asterisk/stasis_channels.h index 0f28abcff8..8a6a1c06a1 100644 --- a/include/asterisk/stasis_channels.h +++ b/include/asterisk/stasis_channels.h @@ -73,6 +73,8 @@ struct ast_channel_snapshot { struct varshead *manager_vars; /*!< Variables to be appended to manager events */ int tech_properties; /*!< Properties of the channel's technology */ struct varshead *ari_vars; /*!< Variables to be appended to ARI events */ + + AST_STRING_FIELD_EXTENDED(protocol_id); /*!< Channel driver protocol id (i.e. Call-ID for chan_sip/chan_pjsip) */ }; /*! diff --git a/main/stasis_channels.c b/main/stasis_channels.c index 934de2becf..a70f4b60bb 100644 --- a/main/stasis_channels.c +++ b/main/stasis_channels.c @@ -240,7 +240,7 @@ struct ast_channel_snapshot *ast_channel_snapshot_create(struct ast_channel *cha snapshot = ao2_alloc_options(sizeof(*snapshot), channel_snapshot_dtor, AO2_ALLOC_OPT_LOCK_NOLOCK); - if (!snapshot || ast_string_field_init(snapshot, 1024)) { + if (!snapshot || ast_string_field_init(snapshot, 1024) || ast_string_field_init_extended(snapshot, protocol_id)) { ao2_cleanup(snapshot); return NULL; } @@ -306,6 +306,10 @@ struct ast_channel_snapshot *ast_channel_snapshot_create(struct ast_channel *cha snapshot->ari_vars = ast_channel_get_ari_vars(chan); snapshot->tech_properties = ast_channel_tech(chan)->properties; + if (ast_channel_tech(chan)->get_pvt_uniqueid) { + ast_string_field_set(snapshot, protocol_id, ast_channel_tech(chan)->get_pvt_uniqueid(chan)); + } + return snapshot; } @@ -975,14 +979,15 @@ struct ast_json *ast_channel_snapshot_to_json( } json_chan = ast_json_pack( - /* Broken up into groups of three for readability */ - "{ s: s, s: s, s: s," + /* Broken up into groups for readability */ + "{ s: s, s: s, s: s, s: s," " s: o, s: o, s: s," " s: o, s: o, s: s }", /* First line */ "id", snapshot->uniqueid, "name", snapshot->name, "state", ast_state2str(snapshot->state), + "protocol_id", snapshot->protocol_id, /* Second line */ "caller", ast_json_name_number( snapshot->caller_name, snapshot->caller_number), diff --git a/res/ari/ari_model_validators.c b/res/ari/ari_model_validators.c index 0bbbb195e2..fffb87a162 100644 --- a/res/ari/ari_model_validators.c +++ b/res/ari/ari_model_validators.c @@ -1043,6 +1043,7 @@ int ast_ari_validate_channel(struct ast_json *json) int has_id = 0; int has_language = 0; int has_name = 0; + int has_protocol_id = 0; int has_state = 0; for (iter = ast_json_object_iter(json); iter; iter = ast_json_object_iter_next(json, iter)) { @@ -1135,6 +1136,16 @@ int ast_ari_validate_channel(struct ast_json *json) res = 0; } } else + if (strcmp("protocol_id", ast_json_object_iter_key(iter)) == 0) { + int prop_is_valid; + has_protocol_id = 1; + prop_is_valid = ast_ari_validate_string( + ast_json_object_iter_value(iter)); + if (!prop_is_valid) { + ast_log(LOG_ERROR, "ARI Channel field protocol_id failed validation\n"); + res = 0; + } + } else if (strcmp("state", ast_json_object_iter_key(iter)) == 0) { int prop_is_valid; has_state = 1; @@ -1193,6 +1204,11 @@ int ast_ari_validate_channel(struct ast_json *json) res = 0; } + if (!has_protocol_id) { + ast_log(LOG_ERROR, "ARI Channel missing required field protocol_id\n"); + res = 0; + } + if (!has_state) { ast_log(LOG_ERROR, "ARI Channel missing required field state\n"); res = 0; diff --git a/res/ari/ari_model_validators.h b/res/ari/ari_model_validators.h index 583cba33a4..64f167c07c 100644 --- a/res/ari/ari_model_validators.h +++ b/res/ari/ari_model_validators.h @@ -1353,6 +1353,7 @@ ari_validator ast_ari_validate_application_fn(void); * - id: string (required) * - language: string (required) * - name: string (required) + * - protocol_id: string (required) * - state: string (required) * Dialed * DialplanCEP diff --git a/rest-api/api-docs/channels.json b/rest-api/api-docs/channels.json index 20dd4e9a88..fc8ba76118 100644 --- a/rest-api/api-docs/channels.json +++ b/rest-api/api-docs/channels.json @@ -2109,6 +2109,11 @@ "type": "string", "description": "Unique identifier of the channel.\n\nThis is the same as the Uniqueid field in AMI." }, + "protocol_id": { + "required": true, + "type": "string", + "description": "Protocol id from underlying channel driver (i.e. Call-ID for chan_sip/chan_pjsip; will be empty if not applicable or not implemented by driver)." + }, "name": { "required": true, "type": "string", diff --git a/tests/test_stasis_channels.c b/tests/test_stasis_channels.c index c483731ee6..0ba8ff4cce 100644 --- a/tests/test_stasis_channels.c +++ b/tests/test_stasis_channels.c @@ -273,7 +273,7 @@ AST_TEST_DEFINE(channel_snapshot_json) ast_test_validate(test, NULL != snapshot); actual = ast_channel_snapshot_to_json(snapshot, NULL); - expected = ast_json_pack("{ s: s, s: s, s: s, s: s," + expected = ast_json_pack("{ s: s, s: s, s: s, s: s, s: s," " s: { s: s, s: s, s: i, s: s, s: s }," " s: { s: s, s: s }," " s: { s: s, s: s }," @@ -284,6 +284,7 @@ AST_TEST_DEFINE(channel_snapshot_json) "state", "Down", "accountcode", "acctcode", "id", ast_channel_uniqueid(chan), + "protocol_id", "", "dialplan", "context", "context", "exten", "exten",