mi: add which_aliases command

Author: razvancrainea

docs/manual/Interface-CoreMI.md

@@ -348,6 +348,38 @@ Examples of usage:
 
 ```
 
+### which_aliases
+
+Lists all registered MI command aliases and the canonical command each alias
+resolves to.
+
+**Arguments**:
+* *alias* (optional) - an MI alias to resolve to its canonical command
+
+**Output**: without an argument, an array of objects containing `alias` and
+`command`; with an *alias*, the canonical command name as a string.
+
+Example of usage:
+```bash
+
+    $ opensips-mi which_aliases
+    [
+        {
+            "alias": "ul_dump",
+            "command": "usrloc:ul_dump"
+        }
+    ]
+
+```
+
+Resolve one alias:
+```bash
+
+    $ opensips-mi which_aliases ps
+    "core:ps"
+
+```
+
 ### xlog_level [level]
 Get or set the global xlogging level in OpenSIPS processes. If no argument is passed to the **xlog_level** command, it will print the current **xlog_level**. If a logging **level** is given, it will be globally set for all OpenSIPS processes.
 

mi/mi.c

@@ -60,12 +60,6 @@ struct mi_mod_group {
 	int end;
 };
 
-struct mi_cmd_alias {
-	int id;
-	str name;
-	int cmd_idx;
-};
-
 static struct mi_mod_group *mi_mod_groups = 0;
 static int mi_mod_groups_no = 0;
 static struct mi_cmd_alias *mi_cmd_aliases = 0;
@@ -647,6 +641,12 @@ void get_mi_cmds( struct mi_cmd** cmds, int *size)
 	*size = mi_cmds_no;
 }
 
+void get_mi_cmd_aliases(struct mi_cmd_alias **aliases, int *size)
+{
+	*aliases = mi_cmd_aliases;
+	*size = mi_cmd_aliases_no;
+}
+
 int parse_mi_request(const char *req, const char **end_ptr, mi_request_t *parsed)
 {
 	mi_item_t *req_jsonrpc;

mi/mi.h

@@ -100,6 +100,12 @@ struct mi_cmd {
 	volatile unsigned char* trace_mask;
 };
 
+struct mi_cmd_alias {
+	int id;
+	str name;
+	int cmd_idx;
+};
+
 typedef struct mi_export_ {
 	char *name;
 	char *help;
@@ -143,6 +149,7 @@ mi_response_t *w_mi_help_1(const mi_params_t *params,
 					struct mi_handler *async_hdl);
 
 void get_mi_cmds(struct mi_cmd **cmds, int *size);
+void get_mi_cmd_aliases(struct mi_cmd_alias **aliases, int *size);
 
 void _init_mi_shm_mem_hooks(void);
 void _init_mi_pkg_mem_hooks(void);

mi/mi_core.c

@@ -302,6 +302,78 @@ static mi_response_t *mi_which(const mi_params_t *params, struct mi_handler *asy
 	return resp;
 }
 
+static mi_response_t *mi_which_aliases(const mi_params_t *params,
+		struct mi_handler *async_hdl)
+{
+	mi_response_t *resp;
+	mi_item_t *resp_arr, *alias_obj;
+	struct mi_cmd *cmds;
+	struct mi_cmd_alias *aliases;
+	int cmds_no, aliases_no;
+	int i;
+
+	resp = init_mi_result_array(&resp_arr);
+	if (!resp)
+		return 0;
+
+	get_mi_cmds(&cmds, &cmds_no);
+	get_mi_cmd_aliases(&aliases, &aliases_no);
+	for (i = 0; i < aliases_no; i++) {
+		if (aliases[i].cmd_idx < 0 || aliases[i].cmd_idx >= cmds_no) {
+			LM_ERR("invalid MI alias command index %d\n",
+					aliases[i].cmd_idx);
+			free_mi_response(resp);
+			return 0;
+		}
+
+		alias_obj = add_mi_object(resp_arr, NULL, 0);
+		if (!alias_obj ||
+				add_mi_string(alias_obj, MI_SSTR("alias"),
+					aliases[i].name.s, aliases[i].name.len) < 0 ||
+				add_mi_string(alias_obj, MI_SSTR("command"),
+					cmds[aliases[i].cmd_idx].name.s,
+					cmds[aliases[i].cmd_idx].name.len) < 0) {
+			LM_ERR("failed to add MI alias item\n");
+			free_mi_response(resp);
+			return 0;
+		}
+	}
+
+	return resp;
+}
+
+static mi_response_t *mi_which_alias(const mi_params_t *params,
+		struct mi_handler *async_hdl)
+{
+	struct mi_cmd *cmds;
+	struct mi_cmd_alias *aliases;
+	str alias;
+	int cmds_no, aliases_no;
+	int cmd_idx = -1;
+	int i;
+
+	if (get_mi_string_param(params, "alias", &alias.s, &alias.len) < 0)
+		return init_mi_param_error();
+
+	get_mi_cmds(&cmds, &cmds_no);
+	get_mi_cmd_aliases(&aliases, &aliases_no);
+	for (i = 0; i < aliases_no; i++) {
+		if (aliases[i].name.len != alias.len ||
+				memcmp(aliases[i].name.s, alias.s, alias.len) != 0)
+			continue;
+		if (cmd_idx >= 0 && cmd_idx != aliases[i].cmd_idx)
+			return init_mi_error(JSONRPC_AMBIG_METHOD_CODE,
+					MI_SSTR(JSONRPC_AMBIG_METHOD_MSG));
+		cmd_idx = aliases[i].cmd_idx;
+	}
+
+	if (cmd_idx < 0 || cmd_idx >= cmds_no)
+		return init_mi_error(404, MI_SSTR("unknown MI alias"));
+
+	return init_mi_result_string(cmds[cmd_idx].name.s,
+			cmds[cmd_idx].name.len);
+}
+
 
 static mi_response_t *mi_ps(const mi_params_t *params,
 						struct mi_handler *async_hdl)
@@ -1014,6 +1086,11 @@ static const mi_export_t mi_core_cmds[] = {
 		{mi_which_cmd, {"command", 0}},
 		{EMPTY_MI_RECIPE}}, {0}
 	},
+	{ "which_aliases", "lists all MI command aliases and their canonical commands", 0, 0, {
+		{mi_which_aliases, {0}},
+		{mi_which_alias, {"alias", 0}},
+		{EMPTY_MI_RECIPE}}, {0}
+	},
 	{ "ps", "lists all processes used by OpenSIPS", 0, 0, {
 		{mi_ps, {0}},
 		{EMPTY_MI_RECIPE}}, {0}