AMI: Make AMI actions that generate event lists consistent.

* Made the following AMI actions use list API calls for consistency:
Agents
BridgeInfo
BridgeList
BridgeTechnologyList
ConfbridgeLIst
ConfbridgeLIstRooms
CoreShowChannels
DAHDIShowChannels
DBGet
DeviceStateList
ExtensionStateList
FAXSessions
Hangup
IAXpeerlist
IAXpeers
IAXregistry
MeetmeList
MeetmeListRooms
MWIGet
ParkedCalls
Parkinglots
PJSIPShowEndpoint
PJSIPShowEndpoints
PJSIPShowRegistrationsInbound
PJSIPShowRegistrationsOutbound
PJSIPShowResourceLists
PJSIPShowSubscriptionsInbound
PJSIPShowSubscriptionsOutbound
PresenceStateList
PRIShowSpans
QueueStatus
QueueSummary
ShowDialPlan
SIPpeers
SIPpeerstatus
SIPshowregistry
SKINNYdevices
SKINNYlines
Status
VoicemailUsersList

* Incremented the AMI version to 2.7.0.

* Changed astman_send_listack() to not use the listflag parameter and
always set the value to "Start" so the start capitalization is consistent.
i.e., The FAXSessions used "Start" while the rest of the system used
"start".  The corresponding complete event always used "Complete".

* Fixed ami_show_resource_lists() "PJSIPShowResourceLists" to output the
AMI ActionID for all of its list events.

* Fixed off-nominal AMI protocol error in manager_bridge_info(),
manager_parking_status_single_lot(), and
manager_parking_status_all_lots().  Use of astman_send_error() after
responding to the original AMI action request violates the action response
pattern by sending two responses.

* Fixed minor protocol error in action_getconfig() when no requested
categories are found.  Each line needs to be formatted as "Header: text".

* Fixed off-nominal memory leak in manager_build_parked_call_string().

* Eliminated unnecessary use of RAII_VAR() in ami_subscription_detail().

ASTERISK-24049 #close
Reported by: Jonathan Rose

Review: https://reviewboard.asterisk.org/r/4315/


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/13@430434 65c4cc65-6c06-0410-ace0-fbb531ad65f3

5 files changed, 90 insertions, 71 deletions

diff --git a/main/bridge.c b/main/bridge.c
index 1e746a0f0..6b4778f5d 100644
--- a/main/bridge.c
+++ b/main/bridge.c
@@ -5198,6 +5198,7 @@ static int manager_bridge_tech_list(struct mansession *s, const struct message *
 	const char *id = astman_get_header(m, "ActionID");
 	RAII_VAR(struct ast_str *, id_text, ast_str_create(128), ast_free);
 	struct ast_bridge_technology *cur;
+	int num_items = 0;
 
 	if (!id_text) {
 		astman_send_error(s, m, "Internal error");
@@ -5208,7 +5209,7 @@ static int manager_bridge_tech_list(struct mansession *s, const struct message *
 		ast_str_set(&id_text, 0, "ActionID: %s\r\n", id);
 	}
 
-	astman_send_ack(s, m, "Bridge technology listing will follow");
+	astman_send_listack(s, m, "Bridge technology listing will follow", "start");
 
 	AST_RWLIST_RDLOCK(&bridge_technologies);
 	AST_RWLIST_TRAVERSE(&bridge_technologies, cur, entry) {
@@ -5226,14 +5227,12 @@ static int manager_bridge_tech_list(struct mansession *s, const struct message *
 			"\r\n",
 			cur->name, type, cur->preference, AST_YESNO(cur->suspended),
 			ast_str_buffer(id_text));
+		++num_items;
 	}
 	AST_RWLIST_UNLOCK(&bridge_technologies);
 
-	astman_append(s,
-		"Event: BridgeTechnologyListComplete\r\n"
-		"%s"
-		"\r\n",
-		ast_str_buffer(id_text));
+	astman_send_list_complete_start(s, m, "BridgeTechnologyListComplete", num_items);
+	astman_send_list_complete_end(s);
 
 	return 0;
 }
diff --git a/main/db.c b/main/db.c
index 5a0f17434..4bb9355c6 100644
--- a/main/db.c
+++ b/main/db.c
@@ -841,7 +841,7 @@ static int manager_dbput(struct mansession *s, const struct message *m)
 static int manager_dbget(struct mansession *s, const struct message *m)
 {
 	const char *id = astman_get_header(m,"ActionID");
-	char idText[256] = "";
+	char idText[256];
 	const char *family = astman_get_header(m, "Family");
 	const char *key = astman_get_header(m, "Key");
 	char tmp[MAX_DB_FIELD];
@@ -856,6 +856,7 @@ static int manager_dbget(struct mansession *s, const struct message *m)
 		return 0;
 	}
 
+	idText[0] = '\0';
 	if (!ast_strlen_zero(id))
 		snprintf(idText, sizeof(idText) ,"ActionID: %s\r\n", id);
 
@@ -863,7 +864,8 @@ static int manager_dbget(struct mansession *s, const struct message *m)
 	if (res) {
 		astman_send_error(s, m, "Database entry not found");
 	} else {
-		astman_send_ack(s, m, "Result will follow");
+		astman_send_listack(s, m, "Result will follow", "start");
+
 		astman_append(s, "Event: DBGetResponse\r\n"
 				"Family: %s\r\n"
 				"Key: %s\r\n"
@@ -871,10 +873,9 @@ static int manager_dbget(struct mansession *s, const struct message *m)
 				"%s"
 				"\r\n",
 				family, key, tmp, idText);
-		astman_append(s, "Event: DBGetComplete\r\n"
-				"%s"
-				"\r\n",
-				idText);
+
+		astman_send_list_complete_start(s, m, "DBGetComplete", 1);
+		astman_send_list_complete_end(s);
 	}
 	return 0;
 }
diff --git a/main/manager.c b/main/manager.c
index ffa5a8088..3e4146146 100644
--- a/main/manager.c
+++ b/main/manager.c
@@ -2913,7 +2913,26 @@ static void astman_start_ack(struct mansession *s, const struct message *m)
 
 void astman_send_listack(struct mansession *s, const struct message *m, char *msg, char *listflag)
 {
-	astman_send_response_full(s, m, "Success", msg, listflag);
+	astman_send_response_full(s, m, "Success", msg, "Start");
+}
+
+void astman_send_list_complete_start(struct mansession *s, const struct message *m, const char *event_name, int count)
+{
+	const char *id = astman_get_header(m, "ActionID");
+
+	astman_append(s, "Event: %s\r\n", event_name);
+	if (!ast_strlen_zero(id)) {
+		astman_append(s, "ActionID: %s\r\n", id);
+	}
+	astman_append(s,
+		"EventList: Complete\r\n"
+		"ListItems: %d\r\n",
+		count);
+}
+
+void astman_send_list_complete_end(struct mansession *s)
+{
+	astman_append(s, "\r\n");
 }
 
 /*! \brief Lock the 'mansession' structure. */
@@ -3339,7 +3358,7 @@ static int action_getconfig(struct mansession *s, const struct message *m)
 	}
 
 	if (!ast_strlen_zero(category) && catcount == 0) { /* TODO: actually, a config with no categories doesn't even get loaded */
-		astman_append(s, "No categories found\r\n");
+		astman_append(s, "Error: No categories found\r\n");
 	}
 
 	ast_config_destroy(cfg);
@@ -3377,7 +3396,7 @@ static int action_listcategories(struct mansession *s, const struct message *m)
 	}
 
 	if (catcount == 0) { /* TODO: actually, a config with no categories doesn't even get loaded */
-		astman_append(s, "Error: no categories found\r\n");
+		astman_append(s, "Error: No categories found\r\n");
 	}
 
 	ast_config_destroy(cfg);
@@ -4206,12 +4225,8 @@ static int action_hangup(struct mansession *s, const struct message *m)
 	regfree(&regexbuf);
 	ast_free(regex_string);
 
-	astman_append(s,
-		"Event: ChannelsHungupListComplete\r\n"
-		"EventList: Complete\r\n"
-		"ListItems: %d\r\n"
-		"%s"
-		"\r\n", channels_matched, idText);
+	astman_send_list_complete_start(s, m, "ChannelsHungupListComplete", channels_matched);
+	astman_send_list_complete_end(s);
 
 	return 0;
 }
@@ -4349,7 +4364,7 @@ static int action_status(struct mansession *s, const struct message *m)
 		}
 	}
 
-	astman_send_ack(s, m, "Channel status will follow");
+	astman_send_listack(s, m, "Channel status will follow", "start");
 
 	if (!ast_strlen_zero(id)) {
 		snprintf(id_text, sizeof(id_text), "ActionID: %s\r\n", id);
@@ -4472,11 +4487,9 @@ static int action_status(struct mansession *s, const struct message *m)
 		ast_channel_iterator_destroy(it_chans);
 	}
 
-	astman_append(s,
-		"Event: StatusComplete\r\n"
-		"%s"
-		"Items: %d\r\n"
-		"\r\n", id_text, channels);
+	astman_send_list_complete_start(s, m, "StatusComplete", channels);
+	astman_append(s, "Items: %d\r\n", channels);
+	astman_send_list_complete_end(s);
 
 	ast_free(variable_str);
 
@@ -5921,12 +5934,8 @@ static int action_coreshowchannels(struct mansession *s, const struct message *m
 	}
 	ao2_iterator_destroy(&it_chans);
 
-	astman_append(s,
-		"Event: CoreShowChannelsComplete\r\n"
-		"EventList: Complete\r\n"
-		"ListItems: %d\r\n"
-		"%s"
-		"\r\n", numchans, idText);
+	astman_send_list_complete_start(s, m, "CoreShowChannelsComplete", numchans);
+	astman_send_list_complete_end(s);
 
 	return 0;
 }
diff --git a/main/manager_bridges.c b/main/manager_bridges.c
index 26b0e7882..10a5046d9 100644
--- a/main/manager_bridges.c
+++ b/main/manager_bridges.c
@@ -364,12 +364,17 @@ static int filter_bridge_type_cb(void *obj, void *arg, int flags)
 	return strcmp(bridge_type, snapshot->technology) ? CMP_MATCH : 0;
 }
 
+struct bridge_list_data {
+	const char *id_text;
+	int count;
+};
+
 static int send_bridge_list_item_cb(void *obj, void *arg, void *data, int flags)
 {
 	struct ast_bridge_snapshot *snapshot = stasis_message_data(obj);
 	struct mansession *s = arg;
-	char *id_text = data;
-	RAII_VAR(struct ast_str *, bridge_info, ast_manager_build_bridge_state_string(snapshot), ast_free_ptr);
+	struct bridge_list_data *list_data = data;
+	RAII_VAR(struct ast_str *, bridge_info, ast_manager_build_bridge_state_string(snapshot), ast_free);
 
 	if (!bridge_info) {
 		return 0;
@@ -380,8 +385,9 @@ static int send_bridge_list_item_cb(void *obj, void *arg, void *data, int flags)
 		"%s"
 		"%s"
 		"\r\n",
-		ast_str_buffer(bridge_info),
-		id_text);
+		list_data->id_text,
+		ast_str_buffer(bridge_info));
+	++list_data->count;
 	return 0;
 }
 
@@ -391,6 +397,7 @@ static int manager_bridges_list(struct mansession *s, const struct message *m)
 	const char *type_filter = astman_get_header(m, "BridgeType");
 	RAII_VAR(struct ast_str *, id_text, ast_str_create(128), ast_free);
 	RAII_VAR(struct ao2_container *, bridges, NULL, ao2_cleanup);
+	struct bridge_list_data list_data;
 
 	if (!id_text) {
 		astman_send_error(s, m, "Internal error");
@@ -407,20 +414,21 @@ static int manager_bridges_list(struct mansession *s, const struct message *m)
 		return -1;
 	}
 
-	astman_send_ack(s, m, "Bridge listing will follow");
+	astman_send_listack(s, m, "Bridge listing will follow", "start");
 
 	if (!ast_strlen_zero(type_filter)) {
 		char *type_filter_dup = ast_strdupa(type_filter);
-		ao2_callback(bridges, OBJ_MULTIPLE | OBJ_NODATA | OBJ_UNLINK, filter_bridge_type_cb, type_filter_dup);
+
+		ao2_callback(bridges, OBJ_MULTIPLE | OBJ_NODATA | OBJ_UNLINK,
+			filter_bridge_type_cb, type_filter_dup);
 	}
 
-	ao2_callback_data(bridges, OBJ_NODATA, send_bridge_list_item_cb, s, ast_str_buffer(id_text));
+	list_data.id_text = ast_str_buffer(id_text);
+	list_data.count = 0;
+	ao2_callback_data(bridges, OBJ_NODATA, send_bridge_list_item_cb, s, &list_data);
 
-	astman_append(s,
-		"Event: BridgeListComplete\r\n"
-		"%s"
-		"\r\n",
-		ast_str_buffer(id_text));
+	astman_send_list_complete_start(s, m, "BridgeListComplete", list_data.count);
+	astman_send_list_complete_end(s);
 
 	return 0;
 }
@@ -429,13 +437,13 @@ static int send_bridge_info_item_cb(void *obj, void *arg, void *data, int flags)
 {
 	char *uniqueid = obj;
 	struct mansession *s = arg;
-	char *id_text = data;
+	struct bridge_list_data *list_data = data;
 	RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
 	struct ast_channel_snapshot *snapshot;
 	RAII_VAR(struct ast_str *, channel_text, NULL, ast_free);
+
 	msg = stasis_cache_get(ast_channel_cache(),
 		ast_channel_snapshot_type(), uniqueid);
-
 	if (!msg) {
 		return 0;
 	}
@@ -455,8 +463,9 @@ static int send_bridge_info_item_cb(void *obj, void *arg, void *data, int flags)
 		"%s"
 		"%s"
 		"\r\n",
-		ast_str_buffer(channel_text),
-		id_text);
+		list_data->id_text,
+		ast_str_buffer(channel_text));
+	++list_data->count;
 	return 0;
 }
 
@@ -468,6 +477,7 @@ static int manager_bridge_info(struct mansession *s, const struct message *m)
 	RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
 	RAII_VAR(struct ast_str *, bridge_info, NULL, ast_free);
 	struct ast_bridge_snapshot *snapshot;
+	struct bridge_list_data list_data;
 
 	if (!id_text) {
 		astman_send_error(s, m, "Internal error");
@@ -489,20 +499,24 @@ static int manager_bridge_info(struct mansession *s, const struct message *m)
 		return 0;
 	}
 
-	astman_send_ack(s, m, "Bridge channel listing will follow");
-
 	snapshot = stasis_message_data(msg);
 	bridge_info = ast_manager_build_bridge_state_string(snapshot);
+	if (!bridge_info) {
+		astman_send_error(s, m, "Internal error");
+		return -1;
+	}
 
-	ao2_callback_data(snapshot->channels, OBJ_NODATA, send_bridge_info_item_cb, s, ast_str_buffer(id_text));
+	astman_send_listack(s, m, "Bridge channel listing will follow", "start");
 
-	astman_append(s,
-		"Event: BridgeInfoComplete\r\n"
-		"%s"
-		"%s"
-		"\r\n",
-		S_COR(bridge_info, ast_str_buffer(bridge_info), ""),
-		ast_str_buffer(id_text));
+	list_data.id_text = ast_str_buffer(id_text);
+	list_data.count = 0;
+	ao2_callback_data(snapshot->channels, OBJ_NODATA, send_bridge_info_item_cb, s, &list_data);
+
+	astman_send_list_complete_start(s, m, "BridgeInfoComplete", list_data.count);
+	if (!ast_strlen_zero(ast_str_buffer(bridge_info))) {
+		astman_append(s, "%s", ast_str_buffer(bridge_info));
+	}
+	astman_send_list_complete_end(s);
 
 	return 0;
 }
diff --git a/main/pbx.c b/main/pbx.c
index b605a9143..eb7517bda 100644
--- a/main/pbx.c
+++ b/main/pbx.c
@@ -8329,14 +8329,13 @@ static int manager_show_dialplan(struct mansession *s, const struct message *m)
 		manager_dpsendack(s, m);
 	}
 
-	astman_append(s, "Event: ShowDialPlanComplete\r\n"
-		"EventList: Complete\r\n"
-		"ListItems: %d\r\n"
+	astman_send_list_complete_start(s, m, "ShowDialPlanComplete", counters.total_items);
+	astman_append(s,
 		"ListExtensions: %d\r\n"
 		"ListPriorities: %d\r\n"
-		"ListContexts: %d\r\n"
-		"%s"
-		"\r\n", counters.total_items, counters.total_exten, counters.total_prio, counters.total_context, idtext);
+		"ListContexts: %d\r\n",
+		counters.total_exten, counters.total_prio, counters.total_context);
+	astman_send_list_complete_end(s);
 
 	/* everything ok */
 	return 0;
@@ -12032,16 +12031,13 @@ static int action_extensionstatelist(struct mansession *s, const struct message
 		   ast_extension_state2str(hint->laststate));
 		ao2_unlock(hint);
 	}
-	astman_append(s, "Event: ExtensionStateListComplete\r\n");
-	if (!ast_strlen_zero(action_id)) {
-		astman_append(s, "ActionID: %s\r\n", action_id);
-	}
-	astman_append(s, "EventList: Complete\r\n"
-		"ListItems: %d\r\n\r\n", hint_count);
 
 	ao2_iterator_destroy(&it_hints);
 	ao2_unlock(hints);
 
+	astman_send_list_complete_start(s, m, "ExtensionStateListComplete", hint_count);
+	astman_send_list_complete_end(s);
+
 	return 0;
 }