use std::collections::HashMap; use proxmox_schema::*; use super::help_command_def; use super::{shellword_split_unclosed, CliCommand, CommandLineInterface, CompletionFunction}; fn record_done_argument( done: &mut HashMap, parameters: ParameterSchema, key: &str, value: &str, ) { if let Some((_, schema)) = parameters.lookup(key) { match schema { Schema::Array(_) => { /* do nothing ?? */ } _ => { done.insert(key.to_owned(), value.to_owned()); } } } } fn get_property_completion( schema: &Schema, name: &str, completion_functions: &HashMap, arg: &str, param: &HashMap, ) -> Vec { if let Some(callback) = completion_functions.get(name) { let list = (callback)(arg, param); let mut completions = Vec::new(); for value in list { if value.starts_with(arg) { completions.push(value); } } return completions; } match schema { Schema::String(StringSchema { format: Some(ApiStringFormat::Enum(variants)), .. }) => { let mut completions = Vec::new(); for variant in variants.iter() { if variant.value.starts_with(arg) { completions.push(variant.value.to_string()); } } return completions; } Schema::Boolean(BooleanSchema { .. }) => { let mut completions = Vec::new(); let mut lowercase_arg = arg.to_string(); lowercase_arg.make_ascii_lowercase(); for value in ["0", "1", "yes", "no", "true", "false", "on", "off"].iter() { if value.starts_with(&lowercase_arg) { completions.push((*value).to_string()); } } return completions; } Schema::Array(ArraySchema { items, .. }) => { if let Schema::String(_) = items { return get_property_completion(items, name, completion_functions, arg, param); } } _ => {} } Vec::new() } fn get_simple_completion( cli_cmd: &CliCommand, done: &mut HashMap, arg_param: &[&str], // we remove done arguments args: &[String], ) -> Vec { //eprintln!("COMPL: {:?} {:?} {}", arg_param, args, args.len()); if !arg_param.is_empty() { let prop_name = arg_param[0]; if let Some((optional, schema)) = cli_cmd.info.parameters.lookup(prop_name) { let is_array_param = matches!(schema, Schema::Array(_)); if (optional || is_array_param) && args[0].starts_with('-') { // argument parameter is optional (or array) , and arg // looks like an option, so assume its empty and // complete the rest } else { record_done_argument(done, cli_cmd.info.parameters, prop_name, &args[0]); if args.len() > 1 { if is_array_param { return get_simple_completion(cli_cmd, done, arg_param, &args[1..]); } else { return get_simple_completion(cli_cmd, done, &arg_param[1..], &args[1..]); } } if args.len() == 1 { return get_property_completion( schema, prop_name, &cli_cmd.completion_functions, &args[0], done, ); } return Vec::new(); } } else { // unknown arg_param - should never happen return Vec::new(); } } if args.is_empty() { return Vec::new(); } // Try to parse all argumnets but last, record args already done if args.len() > 1 { let mut errors = ParameterError::new(); // we simply ignore any parsing errors here let (data, _remaining) = super::getopts::parse_argument_list( &args[0..args.len() - 1], cli_cmd.info.parameters, &mut errors, ); for (key, value) in &data { record_done_argument(done, cli_cmd.info.parameters, key, value); } } let prefix = &args[args.len() - 1]; // match on last arg // complete option-name or option-value ? if !prefix.starts_with('-') && args.len() > 1 { let last = &args[args.len() - 2]; if last.starts_with("--") && last.len() > 2 { let prop_name = &last[2..]; if let Some((_, schema)) = cli_cmd.info.parameters.lookup(prop_name) { return get_property_completion( schema, prop_name, &cli_cmd.completion_functions, prefix, done, ); } return Vec::new(); } } let mut completions = Vec::new(); for (name, _optional, _schema) in cli_cmd.info.parameters.properties() { if done.contains_key(*name) { continue; } if cli_cmd.arg_param.contains(name) { continue; } let option = String::from("--") + name; if option.starts_with(prefix) { completions.push(option); } } completions } impl CommandLineInterface { fn get_help_completion(&self, help_cmd: &CliCommand, args: &[String]) -> Vec { let mut done = HashMap::new(); match self { CommandLineInterface::Simple(_) => { get_simple_completion(help_cmd, &mut done, &[], args) } CommandLineInterface::Nested(map) => { if args.is_empty() { let mut completions = Vec::new(); for cmd in map.commands.keys() { completions.push(cmd.to_string()); } return completions; } let first = &args[0]; if args.len() > 1 { if let Some(sub_cmd) = map.commands.get(first) { // do exact match here return sub_cmd.get_help_completion(help_cmd, &args[1..]); } return Vec::new(); } if first.starts_with('-') { return get_simple_completion(help_cmd, &mut done, &[], args); } let mut completions = Vec::new(); for cmd in map.commands.keys() { if cmd.starts_with(first) { completions.push(cmd.to_string()); } } completions } } } fn get_nested_completion(&self, args: &[String]) -> Vec { match self { CommandLineInterface::Simple(cli_cmd) => { let mut done: HashMap = HashMap::new(); cli_cmd.fixed_param.iter().for_each(|(key, value)| { record_done_argument(&mut done, cli_cmd.info.parameters, key, value); }); get_simple_completion(cli_cmd, &mut done, cli_cmd.arg_param, args) } CommandLineInterface::Nested(map) => { if args.is_empty() { let mut completions = Vec::new(); for cmd in map.commands.keys() { completions.push(cmd.to_string()); } return completions; } let first = &args[0]; if args.len() > 1 { if let Some((_, sub_cmd)) = map.find_command(first) { return sub_cmd.get_nested_completion(&args[1..]); } return Vec::new(); } let mut completions = Vec::new(); for cmd in map.commands.keys() { if cmd.starts_with(first) { completions.push(cmd.to_string()); } } completions } } } /// Helper to generate bash completions. /// /// This helper extracts the command line from environment variable /// set by ``bash``, namely ``COMP_LINE`` and ``COMP_POINT``. This is /// passed to ``get_completions()``. Returned values are printed to /// ``stdout``. pub fn print_bash_completion(&self) { let comp_point: usize = match std::env::var("COMP_POINT") { Ok(val) => match val.parse::() { Ok(i) => i, Err(_) => return, }, Err(_) => return, }; let cmdline = match std::env::var("COMP_LINE") { Ok(mut val) => { if let Some((byte_pos, _)) = val.char_indices().nth(comp_point) { val.truncate(byte_pos); } val } Err(_) => return, }; let (_start, completions) = self.get_completions(&cmdline, true); for item in completions { println!("{}", item); } } /// Compute possible completions for a partial command pub fn get_completions(&self, line: &str, skip_first: bool) -> (usize, Vec) { let (mut args, start) = match shellword_split_unclosed(line, false) { (mut args, None) => { args.push("".into()); (args, line.len()) } (mut args, Some((start, arg, _quote))) => { args.push(arg); (args, start) } }; if skip_first { if args.is_empty() { return (0, Vec::new()); } args.remove(0); // no need for program name } let completions = if !args.is_empty() && args[0] == "help" { self.get_help_completion(&help_command_def(), &args[1..]) } else { self.get_nested_completion(&args) }; (start, completions) } } #[cfg(test)] mod test { use anyhow::Error; use serde_json::Value; use proxmox_schema::{BooleanSchema, ObjectSchema, StringSchema}; use crate::cli::{CliCommand, CliCommandMap, CommandLineInterface}; use crate::{ApiHandler, ApiMethod, RpcEnvironment}; fn dummy_method( _param: Value, _info: &ApiMethod, _rpcenv: &mut dyn RpcEnvironment, ) -> Result { Ok(Value::Null) } const API_METHOD_SIMPLE1: ApiMethod = ApiMethod::new( &ApiHandler::Sync(&dummy_method), &ObjectSchema::new( "Simple API method with one required and one optionl argument.", &[ ( "optional-arg", true, &BooleanSchema::new("Optional boolean argument.") .default(false) .schema(), ), ( "required-arg", false, &StringSchema::new("Required string argument.").schema(), ), ], ), ); fn get_complex_test_cmddef() -> CommandLineInterface { let sub_def = CliCommandMap::new() .insert("l1c1", CliCommand::new(&API_METHOD_SIMPLE1)) .insert("l1c2", CliCommand::new(&API_METHOD_SIMPLE1)); let cmd_def = CliCommandMap::new() .insert_help() .insert("l0sub", CommandLineInterface::Nested(sub_def)) .insert("l0c1", CliCommand::new(&API_METHOD_SIMPLE1)) .insert( "l0c2", CliCommand::new(&API_METHOD_SIMPLE1).arg_param(&["required-arg"]), ) .insert( "l0c3", CliCommand::new(&API_METHOD_SIMPLE1).arg_param(&["required-arg", "optional-arg"]), ); cmd_def.into() } fn test_completions(cmd_def: &CommandLineInterface, line: &str, start: usize, expect: &[&str]) { let mut expect: Vec = expect.iter().map(|s| s.to_string()).collect(); expect.sort(); let (completion_start, mut completions) = cmd_def.get_completions(line, false); completions.sort(); assert_eq!((start, expect), (completion_start, completions)); } #[test] fn test_nested_completion() { let cmd_def = get_complex_test_cmddef(); test_completions(&cmd_def, "", 0, &["help", "l0c1", "l0c2", "l0c3", "l0sub"]); test_completions(&cmd_def, "l0c1 ", 5, &["--optional-arg", "--required-arg"]); test_completions(&cmd_def, "l0c1 -", 5, &["--optional-arg", "--required-arg"]); test_completions( &cmd_def, "l0c1 --", 5, &["--optional-arg", "--required-arg"], ); test_completions(&cmd_def, "l0c1 ---", 5, &[]); test_completions(&cmd_def, "l0c1 x", 5, &[]); test_completions(&cmd_def, "l0c1 --r", 5, &["--required-arg"]); test_completions(&cmd_def, "l0c1 --required-arg", 5, &["--required-arg"]); test_completions( &cmd_def, "l0c1 --required-arg -", 20, // Note: --required-arg is not finished, so it still pops up &["--required-arg", "--optional-arg"], ); test_completions( &cmd_def, "l0c1 --required-arg test -", 25, &["--optional-arg"], ); test_completions( &cmd_def, "l0c1 --required-arg test --optional-arg ", 40, &["0", "1", "false", "no", "true", "yes", "on", "off"], ); test_completions( &cmd_def, "l0c1 --required-arg test --optional-arg f", 40, &["false"], ); test_completions( &cmd_def, "l0c1 --required-arg test --optional-arg F", 40, &["false"], ); test_completions( &cmd_def, "l0c1 --required-arg test --optional-arg Yes", 40, &["yes"], ); } #[test] fn test_help_completion() { let cmd_def = get_complex_test_cmddef(); test_completions(&cmd_def, "h", 0, &["help"]); test_completions( &cmd_def, "help ", 5, &["help", "l0sub", "l0c1", "l0c3", "l0c2"], ); test_completions(&cmd_def, "help l0", 5, &["l0sub", "l0c1", "l0c3", "l0c2"]); test_completions(&cmd_def, "help -", 5, &["--verbose"]); test_completions(&cmd_def, "help l0c2", 5, &["l0c2"]); test_completions(&cmd_def, "help l0c2 ", 10, &["--verbose"]); test_completions(&cmd_def, "help l0c2 --verbose -", 20, &[]); test_completions(&cmd_def, "help l0s", 5, &["l0sub"]); test_completions(&cmd_def, "help l0sub ", 11, &["l1c1", "l1c2"]); test_completions(&cmd_def, "help l0sub l1c2 -", 16, &["--verbose"]); test_completions(&cmd_def, "help l0sub l1c2 --verbose -", 26, &[]); test_completions(&cmd_def, "help l0sub l1c3", 11, &[]); } }