holm/nushell
1
1
Fork 0
forked from extern/nushell
Code Issues Pull Requests Packages Projects Releases Wiki Activity

remove old mv command in favor of umv (renamed to mv) (#12022)

Browse Source 
# Description

This PR removes our old nushell `mv` command in favor of the
uutils/coreutils `uu_mv` crate's `mv` command which we integrated in
0.90.1.

# User-Facing Changes

# Tests + Formatting

# After Submitting
This commit is contained in:
Darren Schroeder
2024-02-29 19:37:23 -06:00
committed by GitHub
parent 4c4609d646
commit 262914cf92
8 changed files with 39 additions and 890 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
crates/nu-command/src/default_context.rs
View File

@ -207,7 +207,6 @@ pub fn add_shell_command_context(mut engine_state: EngineState) -> EngineState {
Ls,
UMkdir,
Mktemp,
Mv,
UMv,
UCp,
Open,

2
crates/nu-command/src/filesystem/mod.rs
View File

@ -3,7 +3,6 @@ mod du;
mod glob;
mod ls;
mod mktemp;
mod mv;
mod open;
mod rm;
mod save;
@ -21,7 +20,6 @@ pub use du::Du;
pub use glob::Glob;
pub use ls::Ls;
pub use mktemp::Mktemp;
pub use mv::Mv;
pub use rm::Rm;
pub use save::Save;
pub use start::Start;

355
crates/nu-command/src/filesystem/mv.rs
View File

@ -1,355 +0,0 @@
use std::path::{Path, PathBuf};
use super::util::try_interaction;
use nu_engine::env::current_dir;
use nu_engine::CallExt;
use nu_protocol::ast::Call;
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{
Category, Example, IntoInterruptiblePipelineData, NuGlob, PipelineData, ShellError, Signature,
Span, Spanned, SyntaxShape, Type, Value,
};
#[derive(Clone)]
pub struct Mv;
impl Command for Mv {
fn name(&self) -> &str {
"mv"
}
fn usage(&self) -> &str {
"Move files or directories."
}
fn search_terms(&self) -> Vec<&str> {
vec!["move"]
}
fn signature(&self) -> nu_protocol::Signature {
Signature::build("mv")
.input_output_types(vec![(Type::Nothing, Type::Nothing)])
.required(
"source",
SyntaxShape::GlobPattern,
"The location to move files/directories from.",
)
.required(
"destination",
SyntaxShape::Filepath,
"The location to move files/directories to.",
)
.switch(
"verbose",
"make mv to be verbose, showing files been moved.",
Some('v'),
)
.switch("force", "overwrite the destination.", Some('f'))
.switch("interactive", "ask user to confirm action", Some('i'))
.switch("update",
"move only when the SOURCE file is newer than the destination file(with -f) or when the destination file is missing",
Some('u')
)
// TODO: add back in additional features
.category(Category::FileSystem)
}
fn run(
&self,
engine_state: &EngineState,
stack: &mut Stack,
call: &Call,
_input: PipelineData,
) -> Result<PipelineData, ShellError> {
// TODO: handle invalid directory or insufficient permissions when moving
let mut spanned_source: Spanned<NuGlob> = call.req(engine_state, stack, 0)?;
spanned_source.item = spanned_source.item.strip_ansi_string_unlikely();
let spanned_destination: Spanned<String> = call.req(engine_state, stack, 1)?;
let verbose = call.has_flag(engine_state, stack, "verbose")?;
let interactive = call.has_flag(engine_state, stack, "interactive")?;
let force = call.has_flag(engine_state, stack, "force")?;
let update_mode = call.has_flag(engine_state, stack, "update")?;
let ctrlc = engine_state.ctrlc.clone();
let path = current_dir(engine_state, stack)?;
let destination = path.join(spanned_destination.item.as_str());
let mut sources = nu_engine::glob_from(&spanned_source, &path, call.head, None)
.map(|p| p.1)
.map_or_else(|_| Vec::new(), Iterator::collect);
if sources.is_empty() {
return Err(ShellError::FileNotFound {
file: spanned_source.item.to_string(),
span: spanned_source.span,
});
}
// We have two possibilities.
//
// First, the destination exists.
// - If a directory, move everything into that directory, otherwise
// - if only a single source, and --force (or -f) is provided overwrite the file,
// - otherwise error.
//
// Second, the destination doesn't exist, so we can only rename a single source. Otherwise
// it's an error.
let source = path.join(spanned_source.item.as_ref());
if destination.exists() && !force && !destination.is_dir() && !source.is_dir() {
return Err(ShellError::GenericError {
error: "Destination file already exists".into(),
// These messages all use to_string_lossy() because
// showing the full path reduces misinterpretation of the message.
// Also, this is preferable to {:?} because that renders Windows paths incorrectly.
msg: format!(
"Destination file '{}' already exists",
destination.to_string_lossy()
),
span: Some(spanned_destination.span),
help: Some("you can use -f, --force to force overwriting the destination".into()),
inner: vec![],
});
}
if (destination.exists() && !destination.is_dir() && sources.len() > 1)
|| (!destination.exists() && sources.len() > 1)
{
return Err(ShellError::GenericError {
error: "Can only move multiple sources if destination is a directory".into(),
msg: "destination must be a directory when moving multiple sources".into(),
span: Some(spanned_destination.span),
help: None,
inner: vec![],
});
}
// This is the case where you move a directory A to the interior of directory B, but directory B
// already has a non-empty directory named A.
if source.is_dir() && destination.is_dir() {
if let Some(name) = source.file_name() {
let dst = destination.join(name);
if dst.is_dir() {
return Err(ShellError::GenericError {
error: format!(
"Can't move '{}' to '{}'",
source.to_string_lossy(),
dst.to_string_lossy()
),
msg: format!("Directory '{}' is not empty", destination.to_string_lossy()),
span: Some(spanned_destination.span),
help: None,
inner: vec![],
});
}
}
}
let some_if_source_is_destination = sources
.iter()
.find(|f| matches!(f, Ok(f) if destination.starts_with(f)));
if destination.exists() && destination.is_dir() && sources.len() == 1 {
if let Some(Ok(filename)) = some_if_source_is_destination {
return Err(ShellError::GenericError {
error: format!(
"Not possible to move '{}' to itself",
filename.to_string_lossy()
),
msg: "cannot move to itself".into(),
span: Some(spanned_destination.span),
help: None,
inner: vec![],
});
}
}
if let Some(Ok(_filename)) = some_if_source_is_destination {
sources.retain(|f| matches!(f, Ok(f) if !destination.starts_with(f)));
}
let span = call.head;
sources
.into_iter()
.flatten()
.filter_map(move |entry| {
let result = move_file(
Spanned {
item: entry.clone(),
span: spanned_source.span,
},
Spanned {
item: destination.clone(),
span: spanned_destination.span,
},
interactive,
update_mode,
);
if let Err(error) = result {
Some(Value::error(error, spanned_source.span))
} else if verbose {
let val = match result {
Ok(true) => format!(
"moved {:} to {:}",
entry.to_string_lossy(),
destination.to_string_lossy()
),
_ => format!(
"{:} not moved to {:}",
entry.to_string_lossy(),
destination.to_string_lossy()
),
};
Some(Value::string(val, span))
} else {
None
}
})
.into_pipeline_data(ctrlc)
.print_not_formatted(engine_state, false, true)?;
Ok(PipelineData::empty())
}
fn examples(&self) -> Vec<Example> {
vec![
Example {
description: "Rename a file",
example: "mv before.txt after.txt",
result: None,
},
Example {
description: "Move a file into a directory",
example: "mv test.txt my/subdirectory",
result: None,
},
Example {
description: "Move many files into a directory",
example: "mv *.txt my/subdirectory",
result: None,
},
]
}
}
fn move_file(
spanned_from: Spanned<PathBuf>,
spanned_to: Spanned<PathBuf>,
interactive: bool,
update_mode: bool,
) -> Result<bool, ShellError> {
let Spanned {
item: from,
span: from_span,
} = spanned_from;
let Spanned {
item: to,
span: to_span,
} = spanned_to;
if to.exists() && from.is_dir() && to.is_file() {
return Err(ShellError::MoveNotPossible {
source_message: "Can't move a directory".to_string(),
source_span: spanned_from.span,
destination_message: "to a file".to_string(),
destination_span: spanned_to.span,
});
}
let destination_dir_exists = if to.is_dir() {
true
} else {
to.parent().map(Path::exists).unwrap_or(true)
};
if !destination_dir_exists {
return Err(ShellError::DirectoryNotFound {
dir: to.to_string_lossy().to_string(),
span: to_span,
});
}
// This can happen when changing case on a case-insensitive filesystem (ex: changing foo to Foo on Windows)
// When it does, we want to do a plain rename instead of moving `from` into `to`
let from_to_are_same_file = same_file::is_same_file(&from, &to).unwrap_or(false);
let mut to = to;
if !from_to_are_same_file && to.is_dir() {
let from_file_name = match from.file_name() {
Some(name) => name,
None => {
return Err(ShellError::DirectoryNotFound {
dir: from.to_string_lossy().to_string(),
span: to_span,
})
}
};
to.push(from_file_name);
}
if interactive && to.exists() {
let (interaction, confirmed) = try_interaction(
interactive,
format!("mv: overwrite '{}'? ", to.to_string_lossy()),
);
if let Err(e) = interaction {
return Err(ShellError::GenericError {
error: format!("Error during interaction: {e:}"),
msg: "could not move".into(),
span: None,
help: None,
inner: vec![],
});
} else if !confirmed {
return Ok(false);
}
}
if update_mode && super::util::is_older(&from, &to).unwrap_or(false) {
Ok(false)
} else {
match move_item(&from, from_span, &to) {
Ok(()) => Ok(true),
Err(e) => Err(e),
}
}
}
fn move_item(from: &Path, from_span: Span, to: &Path) -> Result<(), ShellError> {
// We first try a rename, which is a quick operation. If that doesn't work, we'll try a copy
// and remove the old file/folder. This is necessary if we're moving across filesystems or devices.
std::fs::rename(from, to).or_else(|_| {
match if from.is_file() {
let mut options = fs_extra::file::CopyOptions::new();
options.overwrite = true;
fs_extra::file::move_file(from, to, &options)
} else {
let mut options = fs_extra::dir::CopyOptions::new();
options.overwrite = true;
options.copy_inside = true;
fs_extra::dir::move_dir(from, to, &options)
} {
Ok(_) => Ok(()),
Err(e) => {
let error_kind = match e.kind {
fs_extra::error::ErrorKind::Io(io) => {
format!("I/O error: {io}")
}
fs_extra::error::ErrorKind::StripPrefix(sp) => {
format!("Strip prefix error: {sp}")
}
fs_extra::error::ErrorKind::OsString(os) => {
format!("OsString error: {:?}", os.to_str())
}
_ => e.to_string(),
};
Err(ShellError::GenericError {
error: format!("Could not move {from:?} to {to:?}. Error Kind: {error_kind}"),
msg: "could not move".into(),
span: Some(from_span),
help: None,
inner: vec![],
})
}
}
})
}

12
crates/nu-command/src/filesystem/umv.rs
View File

@ -14,28 +14,28 @@ pub struct UMv;
impl Command for UMv {
fn name(&self) -> &str {
"umv"
"mv"
}
fn usage(&self) -> &str {
"Move files or directories."
"Move files or directories using uutils/coreutils mv."
}
fn examples(&self) -> Vec<Example> {
vec![
Example {
description: "Rename a file",
example: "umv before.txt after.txt",
example: "mv before.txt after.txt",
result: None,
},
Example {
description: "Move a file into a directory",
example: "umv test.txt my/subdirectory",
example: "mv test.txt my/subdirectory",
result: None,
},
Example {
description: "Move many files into a directory",
example: "umv *.txt my/subdirectory",
example: "mv *.txt my/subdirectory",
result: None,
},
]
@ -46,7 +46,7 @@ impl Command for UMv {
}
fn signature(&self) -> nu_protocol::Signature {
Signature::build("umv")
Signature::build("mv")
.input_output_types(vec![(Type::Nothing, Type::Nothing)])
.switch("force", "do not prompt before overwriting", Some('f'))
.switch("verbose", "explain what is being done.", Some('v'))

1
crates/nu-command/src/filesystem/util.rs
View File

@ -66,6 +66,7 @@ fn get_interactive_confirmation(prompt: String) -> Result<bool, Box<dyn Error>>
/// Return `Some(true)` if the last change time of the `src` old than the `dst`,
/// otherwisie return `Some(false)`. Return `None` if the `src` or `dst` doesn't exist.
#[allow(dead_code)]
pub fn is_older(src: &Path, dst: &Path) -> Option<bool> {
if !dst.exists() || !src.exists() {
return None;