use super::util::get_rest_for_glob_pattern; #[allow(deprecated)] use nu_engine::{command_prelude::*, current_dir, get_eval_block}; use nu_protocol::{ast, ByteStream, DataSource, NuGlob, PipelineMetadata}; use std::path::Path; #[cfg(feature = "sqlite")] use crate::database::SQLiteDatabase; #[cfg(unix)] use std::os::unix::fs::PermissionsExt; #[derive(Clone)] pub struct Open; impl Command for Open { fn name(&self) -> &str { "open" } fn usage(&self) -> &str { "Load a file into a cell, converting to table if possible (avoid by appending '--raw')." } fn extra_usage(&self) -> &str { "Support to automatically parse files with an extension `.xyz` can be provided by a `from xyz` command in scope." } fn search_terms(&self) -> Vec<&str> { vec!["load", "read", "load_file", "read_file"] } fn signature(&self) -> nu_protocol::Signature { Signature::build("open") .input_output_types(vec![(Type::Nothing, Type::Any), (Type::String, Type::Any)]) .rest( "files", SyntaxShape::OneOf(vec![SyntaxShape::GlobPattern, SyntaxShape::String]), "The file(s) to open.", ) .switch("raw", "open file as raw binary", Some('r')) .category(Category::FileSystem) } fn run( &self, engine_state: &EngineState, stack: &mut Stack, call: &Call, input: PipelineData, ) -> Result { let raw = call.has_flag(engine_state, stack, "raw")?; let call_span = call.head; #[allow(deprecated)] let cwd = current_dir(engine_state, stack)?; let mut paths = get_rest_for_glob_pattern(engine_state, stack, call, 0)?; let eval_block = get_eval_block(engine_state); if paths.is_empty() && !call.has_positional_args(stack, 0) { // try to use path from pipeline input if there were no positional or spread args let (filename, span) = match input { PipelineData::Value(val, ..) => { let span = val.span(); (val.coerce_into_string()?, span) } _ => { return Err(ShellError::MissingParameter { param_name: "needs filename".to_string(), span: call.head, }); } }; paths.push(Spanned { item: NuGlob::Expand(filename), span, }); } let mut output = vec![]; for mut path in paths { //FIXME: `open` should not have to do this path.item = path.item.strip_ansi_string_unlikely(); let arg_span = path.span; // let path_no_whitespace = &path.item.trim_end_matches(|x| matches!(x, '\x09'..='\x0d')); for path in nu_engine::glob_from(&path, &cwd, call_span, None) .map_err(|err| match err { ShellError::DirectoryNotFound { span, .. } => ShellError::FileNotFound { file: path.item.to_string(), span, }, _ => err, })? .1 { let path = path?; let path = Path::new(&path); if permission_denied(path) { #[cfg(unix)] let error_msg = match path.metadata() { Ok(md) => format!( "The permissions of {:o} does not allow access for this user", md.permissions().mode() & 0o0777 ), Err(e) => e.to_string(), }; #[cfg(not(unix))] let error_msg = String::from("Permission denied"); return Err(ShellError::GenericError { error: "Permission denied".into(), msg: error_msg, span: Some(arg_span), help: None, inner: vec![], }); } else { #[cfg(feature = "sqlite")] if !raw { let res = SQLiteDatabase::try_from_path( path, arg_span, engine_state.signals().clone(), ) .map(|db| db.into_value(call.head).into_pipeline_data()); if res.is_ok() { return res; } } let file = match std::fs::File::open(path) { Ok(file) => file, Err(err) => { return Err(ShellError::GenericError { error: "Permission denied".into(), msg: err.to_string(), span: Some(arg_span), help: None, inner: vec![], }); } }; let content_type = if raw { path.extension() .map(|ext| ext.to_string_lossy().to_string()) .and_then(|ref s| detect_content_type(s)) } else { None }; let stream = PipelineData::ByteStream( ByteStream::file(file, call_span, engine_state.signals().clone()), Some(PipelineMetadata { data_source: DataSource::FilePath(path.to_path_buf()), content_type, }), ); let exts_opt: Option> = if raw { None } else { let path_str = path .file_name() .unwrap_or(std::ffi::OsStr::new(path)) .to_string_lossy() .to_lowercase(); Some(extract_extensions(path_str.as_str())) }; let converter = exts_opt.and_then(|exts| { exts.iter().find_map(|ext| { engine_state .find_decl(format!("from {}", ext).as_bytes(), &[]) .map(|id| (id, ext.to_string())) }) }); match converter { Some((converter_id, ext)) => { let decl = engine_state.get_decl(converter_id); let command_output = if let Some(block_id) = decl.block_id() { let block = engine_state.get_block(block_id); eval_block(engine_state, stack, block, stream) } else { let call = ast::Call::new(call_span); decl.run(engine_state, stack, &(&call).into(), stream) }; output.push(command_output.map_err(|inner| { ShellError::GenericError{ error: format!("Error while parsing as {ext}"), msg: format!("Could not parse '{}' with `from {}`", path.display(), ext), span: Some(arg_span), help: Some(format!("Check out `help from {}` or `help from` for more options or open raw data with `open --raw '{}'`", ext, path.display())), inner: vec![inner], } })?); } None => output.push(stream), } } } } if output.is_empty() { Ok(PipelineData::Empty) } else if output.len() == 1 { Ok(output.remove(0)) } else { Ok(output .into_iter() .flatten() .into_pipeline_data(call_span, engine_state.signals().clone())) } } fn examples(&self) -> Vec { vec![ Example { description: "Open a file, with structure (based on file extension or SQLite database header)", example: "open myfile.json", result: None, }, Example { description: "Open a file, as raw bytes", example: "open myfile.json --raw", result: None, }, Example { description: "Open a file, using the input to get filename", example: "'myfile.txt' | open", result: None, }, Example { description: "Open a file, and decode it by the specified encoding", example: "open myfile.txt --raw | decode utf-8", result: None, }, Example { description: "Create a custom `from` parser to open newline-delimited JSON files with `open`", example: r#"def "from ndjson" [] { from json -o }; open myfile.ndjson"#, result: None, }, ] } } fn permission_denied(dir: impl AsRef) -> bool { match dir.as_ref().read_dir() { Err(e) => matches!(e.kind(), std::io::ErrorKind::PermissionDenied), Ok(_) => false, } } fn extract_extensions(filename: &str) -> Vec { let parts: Vec<&str> = filename.split('.').collect(); let mut extensions: Vec = Vec::new(); let mut current_extension = String::new(); for part in parts.iter().rev() { if current_extension.is_empty() { current_extension.push_str(part); } else { current_extension = format!("{}.{}", part, current_extension); } extensions.push(current_extension.clone()); } extensions.pop(); extensions.reverse(); extensions } fn detect_content_type(extension: &str) -> Option { // This will allow the overriding of metadata to be consistent with // the content type match extension { // Per RFC-9512, application/yaml should be used "yaml" | "yml" => Some("application/yaml".to_string()), _ => mime_guess::from_ext(extension) .first() .map(|mime| mime.to_string()), } } #[cfg(test)] mod test { #[test] fn test_content_type() {} }