2019-08-30 19:29:04 +02:00
|
|
|
use crate::commands::{UnevaluatedCallInfo, WholeStreamCommand};
|
2019-08-02 21:15:07 +02:00
|
|
|
use crate::prelude::*;
|
Extract core stuff into own crates
This commit extracts five new crates:
- nu-source, which contains the core source-code handling logic in Nu,
including Text, Span, and also the pretty.rs-based debug logic
- nu-parser, which is the parser and expander logic
- nu-protocol, which is the bulk of the types and basic conveniences
used by plugins
- nu-errors, which contains ShellError, ParseError and error handling
conveniences
- nu-textview, which is the textview plugin extracted into a crate
One of the major consequences of this refactor is that it's no longer
possible to `impl X for Spanned<Y>` outside of the `nu-source` crate, so
a lot of types became more concrete (Value became a concrete type
instead of Spanned<Value>, for example).
This also turned a number of inherent methods in the main nu crate into
plain functions (impl Value {} became a bunch of functions in the
`value` namespace in `crate::data::value`).
2019-11-26 03:30:48 +01:00
|
|
|
use nu_errors::ShellError;
|
2020-05-06 05:56:31 +02:00
|
|
|
use nu_protocol::{Primitive, ReturnSuccess, Signature, SyntaxShape, UntaggedValue, Value};
|
2019-11-21 15:33:14 +01:00
|
|
|
use nu_source::Tagged;
|
2019-08-09 07:36:43 +02:00
|
|
|
use std::path::{Path, PathBuf};
|
2019-06-07 19:13:38 +02:00
|
|
|
|
2019-08-02 21:15:07 +02:00
|
|
|
pub struct Save;
|
|
|
|
|
2020-03-07 19:33:29 +01:00
|
|
|
macro_rules! process_unknown {
|
|
|
|
($scope:tt, $input:ident, $name_tag:ident) => {{
|
|
|
|
if $input.len() > 0 {
|
|
|
|
match $input[0] {
|
|
|
|
Value {
|
|
|
|
value: UntaggedValue::Primitive(Primitive::Binary(_)),
|
|
|
|
..
|
|
|
|
} => process_binary!($scope, $input, $name_tag),
|
|
|
|
_ => process_string!($scope, $input, $name_tag),
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
process_string!($scope, $input, $name_tag)
|
|
|
|
}
|
|
|
|
}};
|
|
|
|
}
|
|
|
|
|
2019-09-04 04:21:37 +02:00
|
|
|
macro_rules! process_string {
|
2019-09-28 02:05:18 +02:00
|
|
|
($scope:tt, $input:ident, $name_tag:ident) => {{
|
2019-09-04 04:21:37 +02:00
|
|
|
let mut result_string = String::new();
|
|
|
|
for res in $input {
|
|
|
|
match res {
|
2019-11-21 15:33:14 +01:00
|
|
|
Value {
|
|
|
|
value: UntaggedValue::Primitive(Primitive::String(s)),
|
2019-09-04 04:21:37 +02:00
|
|
|
..
|
|
|
|
} => {
|
|
|
|
result_string.push_str(&s);
|
|
|
|
}
|
|
|
|
_ => {
|
2019-09-28 02:05:18 +02:00
|
|
|
break $scope Err(ShellError::labeled_error(
|
2019-11-17 02:13:52 +01:00
|
|
|
"Save requires string data",
|
|
|
|
"consider converting data to string (see `help commands`)",
|
2019-09-14 18:30:24 +02:00
|
|
|
$name_tag,
|
2019-09-28 02:05:18 +02:00
|
|
|
));
|
2019-09-04 04:21:37 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
Ok(result_string.into_bytes())
|
|
|
|
}};
|
|
|
|
}
|
|
|
|
|
2020-03-07 19:33:29 +01:00
|
|
|
macro_rules! process_binary {
|
|
|
|
($scope:tt, $input:ident, $name_tag:ident) => {{
|
|
|
|
let mut result_binary: Vec<u8> = Vec::new();
|
|
|
|
for res in $input {
|
|
|
|
match res {
|
|
|
|
Value {
|
|
|
|
value: UntaggedValue::Primitive(Primitive::Binary(b)),
|
|
|
|
..
|
|
|
|
} => {
|
|
|
|
for u in b.into_iter() {
|
|
|
|
result_binary.push(u);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
_ => {
|
|
|
|
break $scope Err(ShellError::labeled_error(
|
|
|
|
"Save could not successfully save",
|
|
|
|
"unexpected data during binary save",
|
|
|
|
$name_tag,
|
|
|
|
));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
Ok(result_binary)
|
|
|
|
}};
|
|
|
|
}
|
|
|
|
|
2019-09-04 04:21:37 +02:00
|
|
|
macro_rules! process_string_return_success {
|
2019-09-28 02:05:18 +02:00
|
|
|
($scope:tt, $result_vec:ident, $name_tag:ident) => {{
|
2019-09-04 04:21:37 +02:00
|
|
|
let mut result_string = String::new();
|
|
|
|
for res in $result_vec {
|
|
|
|
match res {
|
2019-11-21 15:33:14 +01:00
|
|
|
Ok(ReturnSuccess::Value(Value {
|
|
|
|
value: UntaggedValue::Primitive(Primitive::String(s)),
|
2019-09-04 04:21:37 +02:00
|
|
|
..
|
|
|
|
})) => {
|
|
|
|
result_string.push_str(&s);
|
|
|
|
}
|
|
|
|
_ => {
|
2019-09-28 02:05:18 +02:00
|
|
|
break $scope Err(ShellError::labeled_error(
|
2019-09-04 04:21:37 +02:00
|
|
|
"Save could not successfully save",
|
|
|
|
"unexpected data during text save",
|
2019-09-14 18:30:24 +02:00
|
|
|
$name_tag,
|
2019-09-28 02:05:18 +02:00
|
|
|
));
|
2019-09-04 04:21:37 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
Ok(result_string.into_bytes())
|
|
|
|
}};
|
|
|
|
}
|
|
|
|
|
|
|
|
macro_rules! process_binary_return_success {
|
2019-09-28 02:05:18 +02:00
|
|
|
($scope:tt, $result_vec:ident, $name_tag:ident) => {{
|
2019-09-04 04:21:37 +02:00
|
|
|
let mut result_binary: Vec<u8> = Vec::new();
|
|
|
|
for res in $result_vec {
|
|
|
|
match res {
|
2019-11-21 15:33:14 +01:00
|
|
|
Ok(ReturnSuccess::Value(Value {
|
|
|
|
value: UntaggedValue::Primitive(Primitive::Binary(b)),
|
2019-09-04 04:21:37 +02:00
|
|
|
..
|
|
|
|
})) => {
|
|
|
|
for u in b.into_iter() {
|
|
|
|
result_binary.push(u);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
_ => {
|
2019-09-28 02:05:18 +02:00
|
|
|
break $scope Err(ShellError::labeled_error(
|
2019-09-04 04:21:37 +02:00
|
|
|
"Save could not successfully save",
|
|
|
|
"unexpected data during binary save",
|
2019-09-14 18:30:24 +02:00
|
|
|
$name_tag,
|
2019-09-28 02:05:18 +02:00
|
|
|
));
|
2019-09-04 04:21:37 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
Ok(result_binary)
|
|
|
|
}};
|
|
|
|
}
|
|
|
|
|
2019-08-02 21:15:07 +02:00
|
|
|
#[derive(Deserialize)]
|
2019-08-03 04:17:28 +02:00
|
|
|
pub struct SaveArgs {
|
2019-08-09 07:36:43 +02:00
|
|
|
path: Option<Tagged<PathBuf>>,
|
2019-08-02 21:15:07 +02:00
|
|
|
raw: bool,
|
|
|
|
}
|
|
|
|
|
2020-05-29 10:22:52 +02:00
|
|
|
#[async_trait]
|
2019-08-15 07:02:02 +02:00
|
|
|
impl WholeStreamCommand for Save {
|
2019-08-02 21:15:07 +02:00
|
|
|
fn name(&self) -> &str {
|
|
|
|
"save"
|
2019-06-07 19:13:38 +02:00
|
|
|
}
|
|
|
|
|
2019-08-02 21:15:07 +02:00
|
|
|
fn signature(&self) -> Signature {
|
|
|
|
Signature::build("save")
|
2019-10-28 06:15:35 +01:00
|
|
|
.optional("path", SyntaxShape::Path, "the path to save contents to")
|
|
|
|
.switch(
|
|
|
|
"raw",
|
|
|
|
"treat values as-is rather than auto-converting based on file extension",
|
2020-02-12 03:24:31 +01:00
|
|
|
Some('r'),
|
2019-10-28 06:15:35 +01:00
|
|
|
)
|
2019-08-02 21:15:07 +02:00
|
|
|
}
|
2019-06-22 05:43:37 +02:00
|
|
|
|
2019-08-30 00:52:32 +02:00
|
|
|
fn usage(&self) -> &str {
|
|
|
|
"Save the contents of the pipeline to a file."
|
|
|
|
}
|
|
|
|
|
2020-05-29 10:22:52 +02:00
|
|
|
async fn run(
|
2019-08-02 21:15:07 +02:00
|
|
|
&self,
|
|
|
|
args: CommandArgs,
|
|
|
|
registry: &CommandRegistry,
|
|
|
|
) -> Result<OutputStream, ShellError> {
|
2020-06-13 10:03:13 +02:00
|
|
|
save(args, registry).await
|
2019-06-07 19:13:38 +02:00
|
|
|
}
|
2019-08-02 21:15:07 +02:00
|
|
|
}
|
2019-06-07 19:13:38 +02:00
|
|
|
|
2020-06-13 10:03:13 +02:00
|
|
|
async fn save(
|
|
|
|
raw_args: CommandArgs,
|
|
|
|
registry: &CommandRegistry,
|
|
|
|
) -> Result<OutputStream, ShellError> {
|
2020-05-16 05:18:24 +02:00
|
|
|
let mut full_path = PathBuf::from(raw_args.shell_manager.path());
|
|
|
|
let name_tag = raw_args.call_info.name_tag.clone();
|
|
|
|
let name = raw_args.call_info.name_tag.clone();
|
2020-05-06 05:56:31 +02:00
|
|
|
let scope = raw_args.call_info.scope.clone();
|
2020-05-16 05:18:24 +02:00
|
|
|
let registry = registry.clone();
|
|
|
|
let host = raw_args.host.clone();
|
|
|
|
let ctrl_c = raw_args.ctrl_c.clone();
|
2020-05-30 20:31:50 +02:00
|
|
|
let current_errors = raw_args.current_errors.clone();
|
2020-05-16 05:18:24 +02:00
|
|
|
let shell_manager = raw_args.shell_manager.clone();
|
2019-08-02 21:15:07 +02:00
|
|
|
|
2020-06-13 10:03:13 +02:00
|
|
|
let head = raw_args.call_info.args.head.clone();
|
|
|
|
let (
|
|
|
|
SaveArgs {
|
|
|
|
path,
|
|
|
|
raw: save_raw,
|
|
|
|
},
|
|
|
|
input,
|
|
|
|
) = raw_args.process(®istry).await?;
|
|
|
|
let input: Vec<Value> = input.collect().await;
|
|
|
|
if path.is_none() {
|
|
|
|
let mut should_return_file_path_error = true;
|
|
|
|
|
|
|
|
// If there is no filename, check the metadata for the anchor filename
|
|
|
|
if !input.is_empty() {
|
|
|
|
let anchor = input[0].tag.anchor();
|
|
|
|
|
|
|
|
if let Some(path) = anchor {
|
|
|
|
if let AnchorLocation::File(file) = path {
|
|
|
|
should_return_file_path_error = false;
|
|
|
|
full_path.push(Path::new(&file));
|
2019-08-02 21:15:07 +02:00
|
|
|
}
|
2019-08-21 14:08:23 +02:00
|
|
|
}
|
|
|
|
}
|
2019-08-09 07:36:43 +02:00
|
|
|
|
2020-06-13 10:03:13 +02:00
|
|
|
if should_return_file_path_error {
|
|
|
|
return Err(ShellError::labeled_error(
|
|
|
|
"Save requires a filepath",
|
|
|
|
"needs path",
|
|
|
|
name_tag.clone(),
|
|
|
|
));
|
|
|
|
}
|
|
|
|
} else if let Some(file) = path {
|
|
|
|
full_path.push(file.item());
|
|
|
|
}
|
|
|
|
|
|
|
|
// TODO use label_break_value once it is stable:
|
|
|
|
// https://github.com/rust-lang/rust/issues/48594
|
|
|
|
#[allow(clippy::never_loop)]
|
|
|
|
let content: Result<Vec<u8>, ShellError> = 'scope: loop {
|
|
|
|
break if !save_raw {
|
|
|
|
if let Some(extension) = full_path.extension() {
|
|
|
|
let command_name = format!("to {}", extension.to_string_lossy());
|
|
|
|
if let Some(converter) = registry.get_command(&command_name) {
|
|
|
|
let new_args = RawCommandArgs {
|
|
|
|
host,
|
|
|
|
ctrl_c,
|
|
|
|
current_errors,
|
|
|
|
shell_manager,
|
|
|
|
call_info: UnevaluatedCallInfo {
|
|
|
|
args: nu_protocol::hir::Call {
|
|
|
|
head,
|
|
|
|
positional: None,
|
|
|
|
named: None,
|
|
|
|
span: Span::unknown(),
|
|
|
|
is_last: false,
|
|
|
|
},
|
|
|
|
name_tag: name_tag.clone(),
|
|
|
|
scope,
|
|
|
|
},
|
|
|
|
};
|
|
|
|
let mut result = converter.run(new_args.with_input(input), ®istry).await;
|
|
|
|
let result_vec: Vec<Result<ReturnSuccess, ShellError>> =
|
|
|
|
result.drain_vec().await;
|
|
|
|
if converter.is_binary() {
|
|
|
|
process_binary_return_success!('scope, result_vec, name_tag)
|
2019-09-04 03:50:23 +02:00
|
|
|
} else {
|
2020-06-13 10:03:13 +02:00
|
|
|
process_string_return_success!('scope, result_vec, name_tag)
|
2019-08-31 02:59:21 +02:00
|
|
|
}
|
|
|
|
} else {
|
2020-03-07 19:33:29 +01:00
|
|
|
process_unknown!('scope, input, name_tag)
|
2019-08-31 02:59:21 +02:00
|
|
|
}
|
2019-08-21 14:08:23 +02:00
|
|
|
} else {
|
2020-06-13 10:03:13 +02:00
|
|
|
process_unknown!('scope, input, name_tag)
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
Ok(string_from(&input).into_bytes())
|
2019-08-31 02:59:21 +02:00
|
|
|
};
|
|
|
|
};
|
2019-08-09 07:36:43 +02:00
|
|
|
|
2020-06-13 10:03:13 +02:00
|
|
|
match content {
|
|
|
|
Ok(save_data) => match std::fs::write(full_path, save_data) {
|
|
|
|
Ok(_) => Ok(OutputStream::empty()),
|
|
|
|
Err(e) => Err(ShellError::labeled_error(
|
|
|
|
e.to_string(),
|
|
|
|
"IO error while saving",
|
|
|
|
name,
|
|
|
|
)),
|
|
|
|
},
|
|
|
|
Err(e) => Err(e),
|
|
|
|
}
|
2019-06-07 19:13:38 +02:00
|
|
|
}
|
2019-08-21 14:08:23 +02:00
|
|
|
|
2019-12-06 16:28:26 +01:00
|
|
|
fn string_from(input: &[Value]) -> String {
|
2019-08-21 14:08:23 +02:00
|
|
|
let mut save_data = String::new();
|
|
|
|
|
2019-12-06 16:28:26 +01:00
|
|
|
if !input.is_empty() {
|
2019-08-21 14:08:23 +02:00
|
|
|
let mut first = true;
|
|
|
|
for i in input.iter() {
|
|
|
|
if !first {
|
|
|
|
save_data.push_str("\n");
|
|
|
|
} else {
|
|
|
|
first = false;
|
|
|
|
}
|
|
|
|
if let Ok(data) = &i.as_string() {
|
|
|
|
save_data.push_str(data);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-09-04 03:50:23 +02:00
|
|
|
save_data
|
2019-08-21 14:08:23 +02:00
|
|
|
}
|
2020-05-18 14:56:01 +02:00
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
|
|
|
use super::Save;
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn examples_work_as_expected() {
|
|
|
|
use crate::examples::test as test_examples;
|
|
|
|
|
|
|
|
test_examples(Save {})
|
|
|
|
}
|
|
|
|
}
|