nmcli: improve connection autocompletion (2/2)

Complete the property as we parse the list of properties. This makes it
possible to actually complete an unfinished property.  E.g:

  $ nmcli --complete c modify enp0s25 +ipv6.addr
  +ipv6.addresses +ipv6.addr-gen-mode
This commit is contained in:
Lubomir Rintel 2016-06-15 13:12:39 +02:00 committed by Francesco Giudici
parent 5aec1a3928
commit 3aff650e22
3 changed files with 158 additions and 91 deletions

View file

@ -1590,6 +1590,10 @@ do_connections_show (NmCli *nmc, gboolean active_only, gboolean show_secrets,
char *profile_flds = NULL, *active_flds = NULL;
GPtrArray *invisibles, *sorted_cons;
/* Not (yet?) supported */
if (nmc->complete)
goto finish;
if (argc == 0) {
char *fields_str;
char *fields_all = NMC_FIELDS_CON_SHOW_ALL;
@ -2358,6 +2362,9 @@ do_connection_up (NmCli *nmc, int argc, char **argv)
const char *name = NULL;
char *line = NULL;
/* Not (yet?) supported */
if (nmc->complete)
return nmc->return_value;
/*
* Set default timeout for connection activation.
* Activation can take quite a long time, use 90 seconds.
@ -2547,6 +2554,10 @@ do_connection_down (NmCli *nmc, int argc, char **argv)
int arg_num = argc;
int idx = 0;
/* Not (yet?) supported */
if (nmc->complete)
return nmc->return_value;
if (nmc->timeout == -1)
nmc->timeout = 10;
@ -2901,7 +2912,7 @@ get_valid_settings_array (const char *con_type)
}
static char *
get_valid_autocompletion_string (const NameItem *array, const NameItem *array_slv, char modifier, const char *prefix)
get_valid_properties_string (const NameItem *array, const NameItem *array_slv, char modifier, const char *prefix)
{
const NameItem *iter = array;
const NmcOutputField *field_iter;
@ -2923,7 +2934,7 @@ get_valid_autocompletion_string (const NameItem *array, const NameItem *array_sl
while (field_iter[j].name) {
gchar *new;
new = g_strdup_printf ("%s.%s ", iter->name, field_iter[j].name);
new = g_strdup_printf ("%s.%s\n", iter->name, field_iter[j].name);
if (g_str_has_prefix (new, prefix)) {
if (modifier)
g_string_append_c (str, modifier);
@ -2932,7 +2943,7 @@ get_valid_autocompletion_string (const NameItem *array, const NameItem *array_sl
g_free (new);
if (iter->alias) {
new = g_strdup_printf ("%s.%s ", iter->alias, field_iter[j].name);
new = g_strdup_printf ("%s.%s\n", iter->alias, field_iter[j].name);
if (g_str_has_prefix (new, prefix)) {
if (modifier)
g_string_append_c (str, modifier);
@ -4650,8 +4661,33 @@ do_questionnaire_ip_tunnel (char **local, char **parent)
}
}
static void
complete_property_name (NmCli *nmc, NMConnection *connection, char modifier, const gchar *prefix)
{
NMSettingConnection *s_con;
const NameItem *valid_settings_main = NULL;
const NameItem *valid_settings_slave = NULL;
const char *connection_type = NULL;
const char *slave_type = NULL;
gs_free char *slv_type = NULL;
gs_free char *word_list = NULL;
connection_type = nm_connection_get_connection_type (connection);
s_con = nm_connection_get_setting_connection (connection);
if (s_con)
slave_type = nm_setting_connection_get_slave_type (s_con);
slv_type = g_strdup_printf ("%s-slave", slave_type ? slave_type : "no");
valid_settings_main = get_valid_settings_array (connection_type);
valid_settings_slave = get_valid_settings_array (slv_type);
word_list = get_valid_properties_string (valid_settings_main, valid_settings_slave, modifier, prefix);
if (word_list)
g_print ("%s", word_list);
}
static gboolean
read_connection_properties (NMConnection *connection,
read_connection_properties (NmCli *nmc,
NMConnection *connection,
int argc,
char **argv,
GError **error)
@ -4659,13 +4695,12 @@ read_connection_properties (NMConnection *connection,
NMSetting *setting;
NMSettingConnection *s_con;
const char *con_type;
const char *s_dot_p;
const char *s_dot_p = NULL;
const char *value;
char **strv = NULL;
char *slv_type = NULL;
const char *setting_name;
gboolean append = FALSE;
gboolean remove = FALSE;
char modifier = '\0';
gboolean success = FALSE;
GError *local = NULL;
@ -4693,31 +4728,21 @@ read_connection_properties (NMConnection *connection,
next_arg (&argc, &argv);
if (!s_dot_p) {
/* XXX: can not happen? */
g_set_error_literal (error, NMCLI_ERROR, NMC_RESULT_ERROR_USER_INPUT,
_("Error: <setting>.<property> argument is missing."));
goto finish;
}
if (!value) {
g_set_error (error, NMCLI_ERROR, NMC_RESULT_ERROR_USER_INPUT,
_("Error: value for '%s' is missing."), s_dot_p);
goto finish;
}
/* Empty string will reset the value to default */
if (value[0] == '\0')
value = NULL;
if (s_dot_p[0] == '+') {
s_dot_p++;
append = TRUE;
} else if (s_dot_p[0] == '-') {
s_dot_p++;
remove = TRUE;
}
if (s_dot_p[0] == '+' || s_dot_p[0] == '-')
modifier = *s_dot_p++;
strv = g_strsplit (s_dot_p, ".", 2);
if (g_strv_length (strv) != 2) {
g_set_error (error, NMCLI_ERROR, NMC_RESULT_ERROR_USER_INPUT,
_("Error: invalid <setting>.<property> '%s'."), s_dot_p);
if (nmc->complete)
complete_property_name (nmc, connection, modifier, s_dot_p);
else
g_set_error (error, NMCLI_ERROR, NMC_RESULT_ERROR_USER_INPUT,
_("Error: invalid <setting>.<property> '%s'."), s_dot_p);
goto finish;
}
@ -4752,9 +4777,18 @@ read_connection_properties (NMConnection *connection,
goto finish;
}
if (!remove) {
if (!value) {
g_set_error (error, NMCLI_ERROR, NMC_RESULT_ERROR_USER_INPUT,
_("Error: value for '%s' is missing."), s_dot_p);
goto finish;
}
/* Empty string will reset the value to default */
if (value[0] == '\0')
value = NULL;
if (modifier != '-') {
/* Set/add value */
if (!append)
if (modifier != '+')
nmc_setting_reset_property (setting, property_name, NULL);
if (!nmc_setting_set_property (setting, property_name, value, &local)) {
g_set_error (error, NMCLI_ERROR, NMC_RESULT_ERROR_USER_INPUT,
@ -4792,6 +4826,10 @@ read_connection_properties (NMConnection *connection,
success = TRUE;
finish:
if (!success && nmc->complete) {
complete_property_name (nmc, connection, modifier, s_dot_p);
success = TRUE;
}
if (strv)
g_strfreev (strv);
g_free (slv_type);
@ -6676,7 +6714,7 @@ cleanup_vxlan:
if (!nmc_parse_args (exp_args, FALSE, &argc, &argv, error))
return FALSE;
if (!read_connection_properties (connection, argc, argv, error))
if (!read_connection_properties (nmc, connection, argc, argv, error))
return FALSE;
}
@ -6969,7 +7007,10 @@ do_connection_add (NmCli *nmc, int argc, char **argv)
rl_attempted_completion_function = (rl_completion_func_t *) nmcli_con_add_tab_completion;
nmc->return_value = NMC_RESULT_SUCCESS;
if (nmc->complete) {
/* Add support to properties and arg completion */
return nmc->return_value;
}
if (!nmc_parse_args (exp_args, FALSE, &argc, &argv, &error)) {
g_string_assign (nmc->return_text, error->message);
@ -10174,9 +10215,13 @@ do_connection_modify (NmCli *nmc,
const char *selector = NULL;
GError *error = NULL;
nmc->return_value = NMC_RESULT_SUCCESS;
if (argc == 0) {
/*
* TODO(?) complete "uuid", "path", "id" or connection name.
* (if we ever will move this here from shell completion script)
if (nmc->complete) {
quit ();
*/
g_string_printf (nmc->return_text, _("Error: No arguments provided."));
nmc->return_value = NMC_RESULT_ERROR_USER_INPUT;
goto finish;
@ -10187,6 +10232,12 @@ do_connection_modify (NmCli *nmc,
selector = *argv;
if (next_arg (&argc, &argv) != 0) {
/*
* TODO(?): complete uuid, path or id
if (nmc->complete) {
quit ();
}
*/
g_string_printf (nmc->return_text, _("Error: %s argument is missing."),
selector);
nmc->return_value = NMC_RESULT_ERROR_USER_INPUT;
@ -10195,11 +10246,7 @@ do_connection_modify (NmCli *nmc,
name = *argv;
}
name = *argv;
if (!name) {
g_string_printf (nmc->return_text, _("Error: connection ID is missing."));
nmc->return_value = NMC_RESULT_ERROR_USER_INPUT;
goto finish;
}
connection = nmc_find_connection (nmc->connections, selector, name, NULL);
if (!connection) {
g_string_printf (nmc->return_text, _("Error: Unknown connection '%s'."), name);
@ -10214,47 +10261,32 @@ do_connection_modify (NmCli *nmc,
goto finish;
}
/* Query comes from shell autocomplete function */
if (nmc->complete) {
NMSettingConnection *s_con;
const NameItem *valid_settings_main = NULL;
const NameItem *valid_settings_slave = NULL;
const char *connection_type = NULL;
const char *slave_type = NULL;
gs_free char *slv_type = NULL;
gs_free char *word_list = NULL;
connection_type = nm_connection_get_connection_type (connection);
s_con = nm_connection_get_setting_connection (connection);
if (s_con)
slave_type = nm_setting_connection_get_slave_type (s_con);
slv_type = g_strdup_printf ("%s-slave", slave_type ? slave_type : "no");
valid_settings_main = get_valid_settings_array (connection_type);
valid_settings_slave = get_valid_settings_array (slv_type);
word_list = get_valid_autocompletion_string (valid_settings_main, valid_settings_slave, '\0', "");
if (word_list)
g_print ("%s", word_list);
goto finish;
}
if (next_arg (&argc, &argv) != 0) {
if (nmc->complete) {
complete_property_name (nmc, NM_CONNECTION (rc), '\0', "");
goto finish;
}
g_string_printf (nmc->return_text, _("Error: <setting>.<property> argument is missing."));
nmc->return_value = NMC_RESULT_ERROR_USER_INPUT;
goto finish;
}
if (!read_connection_properties (NM_CONNECTION (rc), argc, argv, &error)) {
if (!read_connection_properties (nmc, NM_CONNECTION (rc), argc, argv, &error)) {
g_string_assign (nmc->return_text, error->message);
nmc->return_value = error->code;
g_clear_error (&error);
goto finish;
}
update_connection (!temporary, rc, modify_connection_cb, nmc);
if (!nmc->complete) {
update_connection (!temporary, rc, modify_connection_cb, nmc);
nmc->should_wait++;
}
nmc->should_wait++;
finish:
/* shell completion - be sure to exit with success without printing errors */
if (nmc->complete)
nmc->return_value = NMC_RESULT_SUCCESS;
return nmc->return_value;
}
@ -10312,6 +10344,10 @@ do_connection_clone (NmCli *nmc, gboolean temporary, int argc, char **argv)
const char *selector = NULL;
char *uuid;
/* Not (yet?) supported */
if (nmc->complete)
return nmc->return_value;
if (argc == 0) {
if (nmc->ask) {
name = name_ask = nmc_readline (PROMPT_CONNECTION);
@ -10435,6 +10471,10 @@ do_connection_delete (NmCli *nmc, int argc, char **argv)
GString *invalid_cons = NULL;
int pos = 0;
/* Not (yet?) supported */
if (nmc->complete)
return nmc->return_value;
if (nmc->timeout == -1)
nmc->timeout = 10;
@ -10567,6 +10607,11 @@ connection_removed (NMClient *client, NMRemoteConnection *con, NmCli *nmc)
static NMCResultCode
do_connection_monitor (NmCli *nmc, int argc, char **argv)
{
/* Not (yet?) supported */
if (nmc->complete)
return nmc->return_value;
if (argc == 0) {
/* No connections specified. Monitor all. */
int i;
@ -10623,7 +10668,9 @@ do_connection_reload (NmCli *nmc, int argc, char **argv)
{
GError *error = NULL;
nmc->return_value = NMC_RESULT_SUCCESS;
/* Not (yet?) supported */
if (nmc->complete)
return nmc->return_value;
if (!nm_client_reload_connections (nmc->client, NULL, &error)) {
g_string_printf (nmc->return_text, _("Error: failed to reload connections: %s."),
@ -10642,7 +10689,9 @@ do_connection_load (NmCli *nmc, int argc, char **argv)
char **filenames, **failures = NULL;
int i;
nmc->return_value = NMC_RESULT_SUCCESS;
/* Not (yet?) supported */
if (nmc->complete)
return nmc->return_value;
if (argc == 0) {
g_string_printf (nmc->return_text, _("Error: No connection specified."));
@ -10688,6 +10737,10 @@ do_connection_import (NmCli *nmc, gboolean temporary, int argc, char **argv)
NMVpnEditorPlugin *plugin;
gs_free char *service_type = NULL;
/* Not (yet?) supported */
if (nmc->complete)
return nmc->return_value;
if (argc == 0) {
if (nmc->ask) {
type_ask = nmc_readline (PROMPT_IMPORT_TYPE);
@ -10804,6 +10857,10 @@ do_connection_export (NmCli *nmc, int argc, char **argv)
GError *error = NULL;
char tmpfile[] = "/tmp/nmcli-export-temp-XXXXXX";
/* Not (yet?) supported */
if (nmc->complete)
return nmc->return_value;
if (argc == 0) {
if (nmc->ask) {
name_ask = nmc_readline (PROMPT_VPN_CONNECTION);
@ -11113,8 +11170,10 @@ do_connections (NmCli *nmc, int argc, char **argv)
/* Check whether NetworkManager is running */
if (!nm_client_get_nm_running (nmc->client)) {
g_string_printf (nmc->return_text, _("Error: NetworkManager is not running."));
nmc->return_value = NMC_RESULT_ERROR_NM_NOT_RUNNING;
if (!nmc->complete) {
g_string_printf (nmc->return_text, _("Error: NetworkManager is not running."));
nmc->return_value = NMC_RESULT_ERROR_NM_NOT_RUNNING;
}
return nmc->return_value;
}
@ -11169,6 +11228,9 @@ do_connections (NmCli *nmc, int argc, char **argv)
} else if (matches(*argv, "add") == 0) {
nmc->return_value = do_connection_add (nmc, argc-1, argv+1);
} else if (matches(*argv, "edit") == 0) {
/* edit with --complete? Should not happen */
if (nmc->complete)
goto opt_error;
nmc->should_wait++;
editor_thread_data.nmc = nmc;
editor_thread_data.argc = argc - 1;
@ -11186,6 +11248,8 @@ do_connections (NmCli *nmc, int argc, char **argv)
next_arg (&argc, &argv);
if (nmc_arg_is_option (*argv, "temporary")) {
if (nmc->complete)
goto opt_error;
temporary = TRUE;
next_arg (&argc, &argv);
}
@ -11195,6 +11259,8 @@ do_connections (NmCli *nmc, int argc, char **argv)
next_arg (&argc, &argv);
if (nmc_arg_is_option (*argv, "temporary")) {
if (nmc->complete)
goto opt_error;
temporary = TRUE;
next_arg (&argc, &argv);
}
@ -11204,6 +11270,8 @@ do_connections (NmCli *nmc, int argc, char **argv)
next_arg (&argc, &argv);
if (nmc_arg_is_option (*argv, "temporary")) {
if (nmc->complete)
goto opt_error;
temporary = TRUE;
next_arg (&argc, &argv);
}
@ -11213,6 +11281,8 @@ do_connections (NmCli *nmc, int argc, char **argv)
} else if (matches(*argv, "monitor") == 0) {
nmc->return_value = do_connection_monitor (nmc, argc-1, argv+1);
} else {
if (nmc->complete)
goto opt_error;
usage ();
g_string_printf (nmc->return_text, _("Error: '%s' is not valid 'connection' command."), *argv);
nmc->return_value = NMC_RESULT_ERROR_USER_INPUT;
@ -11222,8 +11292,10 @@ do_connections (NmCli *nmc, int argc, char **argv)
return nmc->return_value;
opt_error:
g_string_printf (nmc->return_text, _("Error: %s."), error->message);
nmc->return_value = NMC_RESULT_ERROR_USER_INPUT;
if (!nmc->complete) {
g_string_printf (nmc->return_text, _("Error: %s."), error->message);
nmc->return_value = NMC_RESULT_ERROR_USER_INPUT;
}
g_error_free (error);
return nmc->return_value;
}

View file

@ -761,26 +761,14 @@ _nmcli_compl_COMMAND_nl() {
_nmcli_compl_PROPERTIES()
{
while [[ "${#words[@]}" -gt 0 ]]; do
if [[ ${#words[@]} -le 1 ]]; then
local PREFIX="" item list=""
if [[ "${words[0]:0:1}" == [+-] ]]; then
PREFIX="${words[0]:0:1}"
fi
item="$(nmcli c modify --complete "$@" 2>/dev/null)"
### add prefix to each element
for item in $item; do
list="${list}${PREFIX}${item} "
done
_nmcli_list "$list"
return 0
elif [[ ${#words[@]} -le 2 ]]; then
while [[ ${#words[@]} -gt 0 ]]; do
if [[ ${#words[@]} -eq 1 ]]; then
_nmcli_list_nl "$(nmcli --complete-args connection modify "$@" "${words[@]}" 2>/dev/null)"
return 0
fi
_nmcli_array_delete_at words 0 1
done
_nmcli_list "$(nmcli c modify --complete "$@" 2>/dev/null)"
return 0
}
_nmcli()

View file

@ -154,7 +154,18 @@ parse_command_line (NmCli *nmc, int argc, char **argv)
base = argv[0];
else
base++;
if (argc > 1 && nm_streq (argv[1], "--complete-args")) {
/* We (currently?) support --complete-args for "connection" command only:
* ignore any other command when this option is enabled as means we are in
* autocompletion mode (so we should just quit and don't print anything).
* This would help us to ensure shell autocompletion after NM package downgrade
* if we ever will enable --complete-args for other commands */
if ((argc == 2) || !nm_streq0 (argv[2], "connection"))
return nmc->return_value;
nmc->complete = TRUE;
argv[1] = argv[0];
argc--; argv++;
}
/* parse options */
while (argc > 1) {
char *opt = argv[1];
@ -256,8 +267,6 @@ parse_command_line (NmCli *nmc, int argc, char **argv)
/* ignore for backward compatibility */
} else if (matches (opt, "-ask") == 0) {
nmc->ask = TRUE;
} else if (matches (opt, "-complete") == 0) {
nmc->complete = TRUE;
} else if (matches (opt, "-show-secrets") == 0) {
nmc->show_secrets = TRUE;
} else if (matches (opt, "-wait") == 0) {
@ -547,6 +556,7 @@ nmc_init (NmCli *nmc)
nmc->output_data = g_ptr_array_new_full (20, g_free);
memset (&nmc->print_fields, '\0', sizeof (NmcPrintFields));
nmc->ask = FALSE;
nmc->complete = FALSE;
nmc->show_secrets = FALSE;
nmc->use_colors = NMC_USE_COLOR_AUTO;
nmc->in_editor = FALSE;
@ -630,9 +640,6 @@ main (int argc, char *argv[])
loop = g_main_loop_new (NULL, FALSE); /* create main loop */
g_main_loop_run (loop); /* run main loop */
if (nm_cli.complete)
nm_cli.return_value = NMC_RESULT_SUCCESS;
/* Print result descripting text */
if (nm_cli.return_value != NMC_RESULT_SUCCESS) {
g_printerr ("%s\n", nm_cli.return_text->str);