mirror of
https://github.com/nushell/nushell.git
synced 2024-11-26 18:33:50 +01:00
f7647584a3
Fix lints that are coming with rust 1.64 Passes with the earlier toolchain from `rust-toolchain.toml` as well.
1230 lines
42 KiB
Rust
1230 lines
42 KiB
Rust
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
|
|
// file at the top-level directory of this distribution and at
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
//
|
|
// Copyright 2022 The Nushell Project Developers.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
// option. This file may not be copied, modified, or distributed
|
|
// except according to those terms.
|
|
|
|
//! Support for matching file paths against Unix shell style patterns.
|
|
//!
|
|
//! The `glob` and `glob_with` functions allow querying the filesystem for all
|
|
//! files that match a particular pattern (similar to the libc `glob` function).
|
|
//! The methods on the `Pattern` type provide functionality for checking if
|
|
//! individual paths match a particular pattern (similar to the libc `fnmatch`
|
|
//! function).
|
|
//!
|
|
//! For consistency across platforms, and for Windows support, this module
|
|
//! is implemented entirely in Rust rather than deferring to the libc
|
|
//! `glob`/`fnmatch` functions.
|
|
//!
|
|
//! # Examples
|
|
//!
|
|
//! To print all jpg files in `/media/` and all of its subdirectories.
|
|
//!
|
|
//! ```rust,no_run
|
|
//! use nu_glob::glob;
|
|
//!
|
|
//! for entry in glob("/media/**/*.jpg").expect("Failed to read glob pattern") {
|
|
//! match entry {
|
|
//! Ok(path) => println!("{:?}", path.display()),
|
|
//! Err(e) => println!("{:?}", e),
|
|
//! }
|
|
//! }
|
|
//! ```
|
|
//!
|
|
//! To print all files containing the letter "a", case insensitive, in a `local`
|
|
//! directory relative to the current working directory. This ignores errors
|
|
//! instead of printing them.
|
|
//!
|
|
//! ```rust,no_run
|
|
//! use nu_glob::glob_with;
|
|
//! use nu_glob::MatchOptions;
|
|
//!
|
|
//! let options = MatchOptions {
|
|
//! case_sensitive: false,
|
|
//! require_literal_separator: false,
|
|
//! require_literal_leading_dot: false,
|
|
//! recursive_match_hidden_dir: true,
|
|
//! };
|
|
//! for entry in glob_with("local/*a*", options).unwrap() {
|
|
//! if let Ok(path) = entry {
|
|
//! println!("{:?}", path.display())
|
|
//! }
|
|
//! }
|
|
//! ```
|
|
|
|
#![doc(
|
|
html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
|
|
html_favicon_url = "https://www.rust-lang.org/favicon.ico",
|
|
html_root_url = "https://docs.rs/glob/0.3.0"
|
|
)]
|
|
#![deny(missing_docs)]
|
|
|
|
#[cfg(test)]
|
|
#[macro_use]
|
|
extern crate doc_comment;
|
|
|
|
#[cfg(test)]
|
|
doctest!("../README.md");
|
|
|
|
use std::cmp;
|
|
use std::error::Error;
|
|
use std::fmt;
|
|
use std::fs;
|
|
use std::io;
|
|
use std::path::{self, Component, Path, PathBuf};
|
|
use std::str::FromStr;
|
|
|
|
use MatchResult::{EntirePatternDoesntMatch, Match, SubPatternDoesntMatch};
|
|
use PatternToken::{AnyChar, AnyRecursiveSequence, AnySequence, Char};
|
|
|
|
/// An iterator that yields `Path`s from the filesystem that match a particular
|
|
/// pattern.
|
|
///
|
|
/// Note that it yields `GlobResult` in order to report any `IoErrors` that may
|
|
/// arise during iteration. If a directory matches but is unreadable,
|
|
/// thereby preventing its contents from being checked for matches, a
|
|
/// `GlobError` is returned to express this.
|
|
///
|
|
/// See the `glob` function for more details.
|
|
#[derive(Debug)]
|
|
pub struct Paths {
|
|
dir_patterns: Vec<Pattern>,
|
|
require_dir: bool,
|
|
options: MatchOptions,
|
|
todo: Vec<Result<(PathBuf, usize), GlobError>>,
|
|
scope: Option<PathBuf>,
|
|
}
|
|
|
|
/// Return an iterator that produces all the `Path`s that match the given
|
|
/// pattern using default match options, which may be absolute or relative to
|
|
/// the current working directory.
|
|
///
|
|
/// This may return an error if the pattern is invalid.
|
|
///
|
|
/// This method uses the default match options and is equivalent to calling
|
|
/// `glob_with(pattern, MatchOptions::new())`. Use `glob_with` directly if you
|
|
/// want to use non-default match options.
|
|
///
|
|
/// When iterating, each result is a `GlobResult` which expresses the
|
|
/// possibility that there was an `IoError` when attempting to read the contents
|
|
/// of the matched path. In other words, each item returned by the iterator
|
|
/// will either be an `Ok(Path)` if the path matched, or an `Err(GlobError)` if
|
|
/// the path (partially) matched _but_ its contents could not be read in order
|
|
/// to determine if its contents matched.
|
|
///
|
|
/// See the `Paths` documentation for more information.
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// Consider a directory `/media/pictures` containing only the files
|
|
/// `kittens.jpg`, `puppies.jpg` and `hamsters.gif`:
|
|
///
|
|
/// ```rust,no_run
|
|
/// use nu_glob::glob;
|
|
///
|
|
/// for entry in glob("/media/pictures/*.jpg").unwrap() {
|
|
/// match entry {
|
|
/// Ok(path) => println!("{:?}", path.display()),
|
|
///
|
|
/// // if the path matched but was unreadable,
|
|
/// // thereby preventing its contents from matching
|
|
/// Err(e) => println!("{:?}", e),
|
|
/// }
|
|
/// }
|
|
/// ```
|
|
///
|
|
/// The above code will print:
|
|
///
|
|
/// ```ignore
|
|
/// /media/pictures/kittens.jpg
|
|
/// /media/pictures/puppies.jpg
|
|
/// ```
|
|
///
|
|
/// If you want to ignore unreadable paths, you can use something like
|
|
/// `filter_map`:
|
|
///
|
|
/// ```rust
|
|
/// use nu_glob::glob;
|
|
/// use std::result::Result;
|
|
///
|
|
/// for path in glob("/media/pictures/*.jpg").unwrap().filter_map(Result::ok) {
|
|
/// println!("{}", path.display());
|
|
/// }
|
|
/// ```
|
|
/// Paths are yielded in alphabetical order.
|
|
pub fn glob(pattern: &str) -> Result<Paths, PatternError> {
|
|
glob_with(pattern, MatchOptions::new())
|
|
}
|
|
|
|
/// Return an iterator that produces all the `Path`s that match the given
|
|
/// pattern using the specified match options, which may be absolute or relative
|
|
/// to the current working directory.
|
|
///
|
|
/// This may return an error if the pattern is invalid.
|
|
///
|
|
/// This function accepts Unix shell style patterns as described by
|
|
/// `Pattern::new(..)`. The options given are passed through unchanged to
|
|
/// `Pattern::matches_with(..)` with the exception that
|
|
/// `require_literal_separator` is always set to `true` regardless of the value
|
|
/// passed to this function.
|
|
///
|
|
/// Paths are yielded in alphabetical order.
|
|
pub fn glob_with(pattern: &str, options: MatchOptions) -> Result<Paths, PatternError> {
|
|
#[cfg(windows)]
|
|
fn check_windows_verbatim(p: &Path) -> bool {
|
|
match p.components().next() {
|
|
Some(Component::Prefix(ref p)) => p.kind().is_verbatim(),
|
|
_ => false,
|
|
}
|
|
}
|
|
#[cfg(not(windows))]
|
|
fn check_windows_verbatim(_: &Path) -> bool {
|
|
false
|
|
}
|
|
|
|
#[cfg(windows)]
|
|
fn to_scope(p: &Path) -> PathBuf {
|
|
// FIXME handle volume relative paths here
|
|
p.to_path_buf()
|
|
}
|
|
#[cfg(not(windows))]
|
|
fn to_scope(p: &Path) -> PathBuf {
|
|
p.to_path_buf()
|
|
}
|
|
|
|
// make sure that the pattern is valid first, else early return with error
|
|
Pattern::new(pattern)?;
|
|
|
|
let mut components = Path::new(pattern).components().peekable();
|
|
while let Some(&Component::Prefix(..)) | Some(&Component::RootDir) = components.peek() {
|
|
components.next();
|
|
}
|
|
|
|
let rest = components.map(|s| s.as_os_str()).collect::<PathBuf>();
|
|
let normalized_pattern = Path::new(pattern).iter().collect::<PathBuf>();
|
|
let root_len = normalized_pattern
|
|
.to_str()
|
|
.expect("internal error: expected string")
|
|
.len()
|
|
- rest
|
|
.to_str()
|
|
.expect("internal error: expected string")
|
|
.len();
|
|
let root = if root_len > 0 {
|
|
Some(Path::new(&pattern[..root_len]))
|
|
} else {
|
|
None
|
|
};
|
|
|
|
if root_len > 0
|
|
&& check_windows_verbatim(root.expect("internal error: already checked for len > 0"))
|
|
{
|
|
// FIXME: How do we want to handle verbatim paths? I'm inclined to
|
|
// return nothing, since we can't very well find all UNC shares with a
|
|
// 1-letter server name.
|
|
return Ok(Paths {
|
|
dir_patterns: Vec::new(),
|
|
require_dir: false,
|
|
options,
|
|
todo: Vec::new(),
|
|
scope: None,
|
|
});
|
|
}
|
|
|
|
let scope = root.map_or_else(|| PathBuf::from("."), to_scope);
|
|
|
|
let mut dir_patterns = Vec::new();
|
|
let components =
|
|
pattern[cmp::min(root_len, pattern.len())..].split_terminator(path::is_separator);
|
|
|
|
for component in components {
|
|
dir_patterns.push(Pattern::new(component)?);
|
|
}
|
|
|
|
if root_len == pattern.len() {
|
|
dir_patterns.push(Pattern {
|
|
original: "".to_string(),
|
|
tokens: Vec::new(),
|
|
is_recursive: false,
|
|
});
|
|
}
|
|
|
|
let last_is_separator = pattern.chars().next_back().map(path::is_separator);
|
|
let require_dir = last_is_separator == Some(true);
|
|
let todo = Vec::new();
|
|
|
|
Ok(Paths {
|
|
dir_patterns,
|
|
require_dir,
|
|
options,
|
|
todo,
|
|
scope: Some(scope),
|
|
})
|
|
}
|
|
|
|
/// A glob iteration error.
|
|
///
|
|
/// This is typically returned when a particular path cannot be read
|
|
/// to determine if its contents match the glob pattern. This is possible
|
|
/// if the program lacks the appropriate permissions, for example.
|
|
#[derive(Debug)]
|
|
pub struct GlobError {
|
|
path: PathBuf,
|
|
error: io::Error,
|
|
}
|
|
|
|
impl GlobError {
|
|
/// The Path that the error corresponds to.
|
|
pub fn path(&self) -> &Path {
|
|
&self.path
|
|
}
|
|
|
|
/// The error in question.
|
|
pub fn error(&self) -> &io::Error {
|
|
&self.error
|
|
}
|
|
|
|
/// Consumes self, returning the _raw_ underlying `io::Error`
|
|
pub fn into_error(self) -> io::Error {
|
|
self.error
|
|
}
|
|
}
|
|
|
|
impl Error for GlobError {
|
|
#[allow(unknown_lints, bare_trait_objects)]
|
|
fn cause(&self) -> Option<&dyn Error> {
|
|
Some(&self.error)
|
|
}
|
|
}
|
|
|
|
impl fmt::Display for GlobError {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
write!(
|
|
f,
|
|
"attempting to read `{}` resulted in an error: {}",
|
|
self.path.display(),
|
|
self.error
|
|
)
|
|
}
|
|
}
|
|
|
|
fn is_dir(p: &Path) -> bool {
|
|
fs::metadata(p).map(|m| m.is_dir()).unwrap_or(false)
|
|
}
|
|
|
|
/// An alias for a glob iteration result.
|
|
///
|
|
/// This represents either a matched path or a glob iteration error,
|
|
/// such as failing to read a particular directory's contents.
|
|
pub type GlobResult = Result<PathBuf, GlobError>;
|
|
|
|
impl Iterator for Paths {
|
|
type Item = GlobResult;
|
|
|
|
fn next(&mut self) -> Option<GlobResult> {
|
|
// the todo buffer hasn't been initialized yet, so it's done at this
|
|
// point rather than in glob() so that the errors are unified that is,
|
|
// failing to fill the buffer is an iteration error construction of the
|
|
// iterator (i.e. glob()) only fails if it fails to compile the Pattern
|
|
if let Some(scope) = self.scope.take() {
|
|
if !self.dir_patterns.is_empty() {
|
|
// Shouldn't happen, but we're using -1 as a special index.
|
|
assert!(self.dir_patterns.len() < !0 as usize);
|
|
|
|
fill_todo(&mut self.todo, &self.dir_patterns, 0, &scope, self.options);
|
|
}
|
|
}
|
|
|
|
loop {
|
|
if self.dir_patterns.is_empty() || self.todo.is_empty() {
|
|
return None;
|
|
}
|
|
|
|
let (path, mut idx) = match self
|
|
.todo
|
|
.pop()
|
|
.expect("internal error: already checked for non-empty")
|
|
{
|
|
Ok(pair) => pair,
|
|
Err(e) => return Some(Err(e)),
|
|
};
|
|
|
|
// idx -1: was already checked by fill_todo, maybe path was '.' or
|
|
// '..' that we can't match here because of normalization.
|
|
if idx == !0 as usize {
|
|
if self.require_dir && !is_dir(&path) {
|
|
continue;
|
|
}
|
|
return Some(Ok(path));
|
|
}
|
|
|
|
if self.dir_patterns[idx].is_recursive {
|
|
let mut next = idx;
|
|
|
|
// collapse consecutive recursive patterns
|
|
while (next + 1) < self.dir_patterns.len()
|
|
&& self.dir_patterns[next + 1].is_recursive
|
|
{
|
|
next += 1;
|
|
}
|
|
|
|
if is_dir(&path) {
|
|
// the path is a directory, check if matched according
|
|
// to `hidden_dir_recursive` option.
|
|
if !self.options.recursive_match_hidden_dir
|
|
&& path
|
|
.file_name()
|
|
.map(|name| name.to_string_lossy().starts_with('.'))
|
|
.unwrap_or(false)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
// push this directory's contents
|
|
fill_todo(
|
|
&mut self.todo,
|
|
&self.dir_patterns,
|
|
next,
|
|
&path,
|
|
self.options,
|
|
);
|
|
|
|
if next == self.dir_patterns.len() - 1 {
|
|
// pattern ends in recursive pattern, so return this
|
|
// directory as a result
|
|
return Some(Ok(path));
|
|
} else {
|
|
// advanced to the next pattern for this path
|
|
idx = next + 1;
|
|
}
|
|
} else if next == self.dir_patterns.len() - 1 {
|
|
// not a directory and it's the last pattern, meaning no
|
|
// match
|
|
continue;
|
|
} else {
|
|
// advanced to the next pattern for this path
|
|
idx = next + 1;
|
|
}
|
|
}
|
|
|
|
// not recursive, so match normally
|
|
if self.dir_patterns[idx].matches_with(
|
|
{
|
|
match path.file_name().and_then(|s| s.to_str()) {
|
|
// FIXME (#9639): How do we handle non-utf8 filenames?
|
|
// Ignore them for now; ideally we'd still match them
|
|
// against a *
|
|
None => {
|
|
println!("warning: get non-utf8 filename {path:?}, ignored.");
|
|
continue;
|
|
}
|
|
Some(x) => x,
|
|
}
|
|
},
|
|
self.options,
|
|
) {
|
|
if idx == self.dir_patterns.len() - 1 {
|
|
// it is not possible for a pattern to match a directory
|
|
// *AND* its children so we don't need to check the
|
|
// children
|
|
|
|
if !self.require_dir || is_dir(&path) {
|
|
return Some(Ok(path));
|
|
}
|
|
} else {
|
|
fill_todo(
|
|
&mut self.todo,
|
|
&self.dir_patterns,
|
|
idx + 1,
|
|
&path,
|
|
self.options,
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// A pattern parsing error.
|
|
#[derive(Debug)]
|
|
#[allow(missing_copy_implementations)]
|
|
pub struct PatternError {
|
|
/// The approximate character index of where the error occurred.
|
|
pub pos: usize,
|
|
|
|
/// A message describing the error.
|
|
pub msg: &'static str,
|
|
}
|
|
|
|
impl Error for PatternError {
|
|
fn description(&self) -> &str {
|
|
self.msg
|
|
}
|
|
}
|
|
|
|
impl fmt::Display for PatternError {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
write!(
|
|
f,
|
|
"Pattern syntax error near position {}: {}",
|
|
self.pos, self.msg
|
|
)
|
|
}
|
|
}
|
|
|
|
/// A compiled Unix shell style pattern.
|
|
///
|
|
/// - `?` matches any single character.
|
|
///
|
|
/// - `*` matches any (possibly empty) sequence of characters.
|
|
///
|
|
/// - `**` matches the current directory and arbitrary subdirectories. This
|
|
/// sequence **must** form a single path component, so both `**a` and `b**`
|
|
/// are invalid and will result in an error. A sequence of more than two
|
|
/// consecutive `*` characters is also invalid.
|
|
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Default, Debug)]
|
|
pub struct Pattern {
|
|
original: String,
|
|
tokens: Vec<PatternToken>,
|
|
is_recursive: bool,
|
|
}
|
|
|
|
/// Show the original glob pattern.
|
|
impl fmt::Display for Pattern {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
self.original.fmt(f)
|
|
}
|
|
}
|
|
|
|
impl FromStr for Pattern {
|
|
type Err = PatternError;
|
|
|
|
fn from_str(s: &str) -> Result<Self, PatternError> {
|
|
Self::new(s)
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
|
|
enum PatternToken {
|
|
Char(char),
|
|
AnyChar,
|
|
AnySequence,
|
|
AnyRecursiveSequence,
|
|
}
|
|
|
|
#[allow(clippy::enum_variant_names)]
|
|
#[derive(Copy, Clone, PartialEq, Eq)]
|
|
enum MatchResult {
|
|
Match,
|
|
SubPatternDoesntMatch,
|
|
EntirePatternDoesntMatch,
|
|
}
|
|
|
|
const ERROR_WILDCARDS: &str = "wildcards are either regular `*` or recursive `**`";
|
|
const ERROR_RECURSIVE_WILDCARDS: &str = "recursive wildcards must form a single path \
|
|
component";
|
|
|
|
impl Pattern {
|
|
/// This function compiles Unix shell style patterns.
|
|
///
|
|
/// An invalid glob pattern will yield a `PatternError`.
|
|
pub fn new(pattern: &str) -> Result<Self, PatternError> {
|
|
let chars = pattern.chars().collect::<Vec<_>>();
|
|
let mut tokens = Vec::new();
|
|
let mut is_recursive = false;
|
|
let mut i = 0;
|
|
|
|
while i < chars.len() {
|
|
match chars[i] {
|
|
'?' => {
|
|
tokens.push(AnyChar);
|
|
i += 1;
|
|
}
|
|
'*' => {
|
|
let old = i;
|
|
|
|
while i < chars.len() && chars[i] == '*' {
|
|
i += 1;
|
|
}
|
|
|
|
let count = i - old;
|
|
|
|
#[allow(clippy::comparison_chain)]
|
|
if count > 2 {
|
|
return Err(PatternError {
|
|
pos: old + 2,
|
|
msg: ERROR_WILDCARDS,
|
|
});
|
|
} else if count == 2 {
|
|
// ** can only be an entire path component
|
|
// i.e. a/**/b is valid, but a**/b or a/**b is not
|
|
// invalid matches are treated literally
|
|
let is_valid = if i == 2 || path::is_separator(chars[i - count - 1]) {
|
|
// it ends in a '/'
|
|
if i < chars.len() && path::is_separator(chars[i]) {
|
|
i += 1;
|
|
true
|
|
// or the pattern ends here
|
|
// this enables the existing globbing mechanism
|
|
} else if i == chars.len() {
|
|
true
|
|
// `**` ends in non-separator
|
|
} else {
|
|
return Err(PatternError {
|
|
pos: i,
|
|
msg: ERROR_RECURSIVE_WILDCARDS,
|
|
});
|
|
}
|
|
// `**` begins with non-separator
|
|
} else {
|
|
return Err(PatternError {
|
|
pos: old - 1,
|
|
msg: ERROR_RECURSIVE_WILDCARDS,
|
|
});
|
|
};
|
|
|
|
if is_valid {
|
|
// collapse consecutive AnyRecursiveSequence to a
|
|
// single one
|
|
|
|
let tokens_len = tokens.len();
|
|
|
|
if !(tokens_len > 1 && tokens[tokens_len - 1] == AnyRecursiveSequence) {
|
|
is_recursive = true;
|
|
tokens.push(AnyRecursiveSequence);
|
|
}
|
|
}
|
|
} else {
|
|
tokens.push(AnySequence);
|
|
}
|
|
}
|
|
c => {
|
|
tokens.push(Char(c));
|
|
i += 1;
|
|
}
|
|
}
|
|
}
|
|
|
|
Ok(Self {
|
|
tokens,
|
|
original: pattern.to_string(),
|
|
is_recursive,
|
|
})
|
|
}
|
|
|
|
/// Return if the given `str` matches this `Pattern` using the default
|
|
/// match options (i.e. `MatchOptions::new()`).
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// ```rust
|
|
/// use nu_glob::Pattern;
|
|
///
|
|
/// assert!(Pattern::new("c?t").unwrap().matches("cat"));
|
|
/// assert!(Pattern::new("d*g").unwrap().matches("doog"));
|
|
/// ```
|
|
pub fn matches(&self, str: &str) -> bool {
|
|
self.matches_with(str, MatchOptions::new())
|
|
}
|
|
|
|
/// Return if the given `Path`, when converted to a `str`, matches this
|
|
/// `Pattern` using the default match options (i.e. `MatchOptions::new()`).
|
|
pub fn matches_path(&self, path: &Path) -> bool {
|
|
// FIXME (#9639): This needs to handle non-utf8 paths
|
|
path.to_str().map_or(false, |s| self.matches(s))
|
|
}
|
|
|
|
/// Return if the given `str` matches this `Pattern` using the specified
|
|
/// match options.
|
|
pub fn matches_with(&self, str: &str, options: MatchOptions) -> bool {
|
|
self.matches_from(true, str.chars(), 0, options) == Match
|
|
}
|
|
|
|
/// Return if the given `Path`, when converted to a `str`, matches this
|
|
/// `Pattern` using the specified match options.
|
|
pub fn matches_path_with(&self, path: &Path, options: MatchOptions) -> bool {
|
|
// FIXME (#9639): This needs to handle non-utf8 paths
|
|
path.to_str()
|
|
.map_or(false, |s| self.matches_with(s, options))
|
|
}
|
|
|
|
/// Access the original glob pattern.
|
|
pub fn as_str(&self) -> &str {
|
|
&self.original
|
|
}
|
|
|
|
fn matches_from(
|
|
&self,
|
|
mut follows_separator: bool,
|
|
mut file: std::str::Chars,
|
|
i: usize,
|
|
options: MatchOptions,
|
|
) -> MatchResult {
|
|
for (ti, token) in self.tokens[i..].iter().enumerate() {
|
|
match *token {
|
|
AnySequence | AnyRecursiveSequence => {
|
|
// ** must be at the start.
|
|
debug_assert!(match *token {
|
|
AnyRecursiveSequence => follows_separator,
|
|
_ => true,
|
|
});
|
|
|
|
// Empty match
|
|
match self.matches_from(follows_separator, file.clone(), i + ti + 1, options) {
|
|
SubPatternDoesntMatch => (), // keep trying
|
|
m => return m,
|
|
};
|
|
|
|
while let Some(c) = file.next() {
|
|
if follows_separator && options.require_literal_leading_dot && c == '.' {
|
|
return SubPatternDoesntMatch;
|
|
}
|
|
follows_separator = path::is_separator(c);
|
|
match *token {
|
|
AnyRecursiveSequence if !follows_separator => continue,
|
|
AnySequence
|
|
if options.require_literal_separator && follows_separator =>
|
|
{
|
|
return SubPatternDoesntMatch
|
|
}
|
|
_ => (),
|
|
}
|
|
match self.matches_from(
|
|
follows_separator,
|
|
file.clone(),
|
|
i + ti + 1,
|
|
options,
|
|
) {
|
|
SubPatternDoesntMatch => (), // keep trying
|
|
m => return m,
|
|
}
|
|
}
|
|
}
|
|
_ => {
|
|
let c = match file.next() {
|
|
Some(c) => c,
|
|
None => return EntirePatternDoesntMatch,
|
|
};
|
|
|
|
let is_sep = path::is_separator(c);
|
|
|
|
if !match *token {
|
|
AnyChar
|
|
if (options.require_literal_separator && is_sep)
|
|
|| (follows_separator
|
|
&& options.require_literal_leading_dot
|
|
&& c == '.') =>
|
|
{
|
|
false
|
|
}
|
|
AnyChar => true,
|
|
Char(c2) => chars_eq(c, c2, options.case_sensitive),
|
|
AnySequence | AnyRecursiveSequence => unreachable!(),
|
|
} {
|
|
return SubPatternDoesntMatch;
|
|
}
|
|
follows_separator = is_sep;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Iter is fused.
|
|
if file.next().is_none() {
|
|
Match
|
|
} else {
|
|
SubPatternDoesntMatch
|
|
}
|
|
}
|
|
}
|
|
|
|
// Fills `todo` with paths under `path` to be matched by `patterns[idx]`,
|
|
// special-casing patterns to match `.` and `..`, and avoiding `readdir()`
|
|
// calls when there are no metacharacters in the pattern.
|
|
fn fill_todo(
|
|
todo: &mut Vec<Result<(PathBuf, usize), GlobError>>,
|
|
patterns: &[Pattern],
|
|
idx: usize,
|
|
path: &Path,
|
|
options: MatchOptions,
|
|
) {
|
|
// convert a pattern that's just many Char(_) to a string
|
|
fn pattern_as_str(pattern: &Pattern) -> Option<String> {
|
|
let mut s = String::new();
|
|
for token in &pattern.tokens {
|
|
match *token {
|
|
Char(c) => s.push(c),
|
|
_ => return None,
|
|
}
|
|
}
|
|
|
|
Some(s)
|
|
}
|
|
|
|
let add = |todo: &mut Vec<_>, next_path: PathBuf| {
|
|
if idx + 1 == patterns.len() {
|
|
// We know it's good, so don't make the iterator match this path
|
|
// against the pattern again. In particular, it can't match
|
|
// . or .. globs since these never show up as path components.
|
|
todo.push(Ok((next_path, !0 as usize)));
|
|
} else {
|
|
fill_todo(todo, patterns, idx + 1, &next_path, options);
|
|
}
|
|
};
|
|
|
|
let pattern = &patterns[idx];
|
|
let is_dir = is_dir(path);
|
|
let curdir = path == Path::new(".");
|
|
match pattern_as_str(pattern) {
|
|
Some(s) => {
|
|
// This pattern component doesn't have any metacharacters, so we
|
|
// don't need to read the current directory to know where to
|
|
// continue. So instead of passing control back to the iterator,
|
|
// we can just check for that one entry and potentially recurse
|
|
// right away.
|
|
let special = "." == s || ".." == s;
|
|
let next_path = if curdir {
|
|
PathBuf::from(s)
|
|
} else {
|
|
path.join(&s)
|
|
};
|
|
if (special && is_dir)
|
|
|| (!special
|
|
&& (fs::metadata(&next_path).is_ok()
|
|
|| fs::symlink_metadata(&next_path).is_ok()))
|
|
{
|
|
add(todo, next_path);
|
|
}
|
|
}
|
|
None if is_dir => {
|
|
let dirs = fs::read_dir(path).and_then(|d| {
|
|
d.map(|e| {
|
|
e.map(|e| {
|
|
if curdir {
|
|
PathBuf::from(
|
|
e.path()
|
|
.file_name()
|
|
.expect("internal error: missing filename"),
|
|
)
|
|
} else {
|
|
e.path()
|
|
}
|
|
})
|
|
})
|
|
.collect::<Result<Vec<_>, _>>()
|
|
});
|
|
match dirs {
|
|
Ok(mut children) => {
|
|
children.sort_by(|p1, p2| p2.file_name().cmp(&p1.file_name()));
|
|
todo.extend(children.into_iter().map(|x| Ok((x, idx))));
|
|
|
|
// Matching the special directory entries . and .. that
|
|
// refer to the current and parent directory respectively
|
|
// requires that the pattern has a leading dot, even if the
|
|
// `MatchOptions` field `require_literal_leading_dot` is not
|
|
// set.
|
|
if !pattern.tokens.is_empty() && pattern.tokens[0] == Char('.') {
|
|
for &special in &[".", ".."] {
|
|
if pattern.matches_with(special, options) {
|
|
add(todo, path.join(special));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
Err(e) => {
|
|
todo.push(Err(GlobError {
|
|
path: path.to_path_buf(),
|
|
error: e,
|
|
}));
|
|
}
|
|
}
|
|
}
|
|
None => {
|
|
// not a directory, nothing more to find
|
|
}
|
|
}
|
|
}
|
|
|
|
/// A helper function to determine if two chars are (possibly case-insensitively) equal.
|
|
fn chars_eq(a: char, b: char, case_sensitive: bool) -> bool {
|
|
if cfg!(windows) && path::is_separator(a) && path::is_separator(b) {
|
|
true
|
|
} else if !case_sensitive && a.is_ascii() && b.is_ascii() {
|
|
// FIXME: work with non-ascii chars properly (issue #9084)
|
|
a.to_ascii_lowercase() == b.to_ascii_lowercase()
|
|
} else {
|
|
a == b
|
|
}
|
|
}
|
|
|
|
/// Configuration options to modify the behaviour of `Pattern::matches_with(..)`.
|
|
#[allow(missing_copy_implementations)]
|
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
|
|
pub struct MatchOptions {
|
|
/// Whether or not patterns should be matched in a case-sensitive manner.
|
|
/// This currently only considers upper/lower case relationships between
|
|
/// ASCII characters, but in future this might be extended to work with
|
|
/// Unicode.
|
|
pub case_sensitive: bool,
|
|
|
|
/// Whether or not path-component separator characters (e.g. `/` on
|
|
/// Posix) must be matched by a literal `/`, rather than by `*` or `?` or
|
|
/// `[...]`.
|
|
pub require_literal_separator: bool,
|
|
|
|
/// Whether or not paths that contain components that start with a `.`
|
|
/// will require that `.` appears literally in the pattern; `*`, `?`, `**`,
|
|
/// or `[...]` will not match. This is useful because such files are
|
|
/// conventionally considered hidden on Unix systems and it might be
|
|
/// desirable to skip them when listing files.
|
|
pub require_literal_leading_dot: bool,
|
|
|
|
/// if given pattern contains `**`, this flag check if `**` matches hidden directory.
|
|
/// For example: if true, `**` will match `.abcdef/ghi`.
|
|
pub recursive_match_hidden_dir: bool,
|
|
}
|
|
|
|
impl MatchOptions {
|
|
/// Constructs a new `MatchOptions` with default field values. This is used
|
|
/// when calling functions that do not take an explicit `MatchOptions`
|
|
/// parameter.
|
|
///
|
|
/// This function always returns this value:
|
|
///
|
|
/// ```rust,ignore
|
|
/// MatchOptions {
|
|
/// case_sensitive: true,
|
|
/// require_literal_separator: false,
|
|
/// require_literal_leading_dot: false
|
|
/// recursive_match_hidden_dir: true,
|
|
/// }
|
|
/// ```
|
|
pub fn new() -> Self {
|
|
Self {
|
|
case_sensitive: true,
|
|
require_literal_separator: false,
|
|
require_literal_leading_dot: false,
|
|
recursive_match_hidden_dir: true,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::{glob, MatchOptions, Pattern};
|
|
use std::path::Path;
|
|
|
|
#[test]
|
|
fn test_pattern_from_str() {
|
|
assert!("a*b".parse::<Pattern>().unwrap().matches("a_b"));
|
|
assert!("a/**b".parse::<Pattern>().unwrap_err().pos == 4);
|
|
}
|
|
|
|
#[test]
|
|
fn test_wildcard_errors() {
|
|
assert!(Pattern::new("a/**b").unwrap_err().pos == 4);
|
|
assert!(Pattern::new("a/bc**").unwrap_err().pos == 3);
|
|
assert!(Pattern::new("a/*****").unwrap_err().pos == 4);
|
|
assert!(Pattern::new("a/b**c**d").unwrap_err().pos == 2);
|
|
assert!(Pattern::new("a**b").unwrap_err().pos == 0);
|
|
}
|
|
|
|
#[test]
|
|
fn test_glob_errors() {
|
|
assert!(glob("a/**b").err().unwrap().pos == 4);
|
|
}
|
|
|
|
// this test assumes that there is a /root directory and that
|
|
// the user running this test is not root or otherwise doesn't
|
|
// have permission to read its contents
|
|
#[cfg(all(
|
|
unix,
|
|
not(target_os = "macos"),
|
|
not(target_os = "android"),
|
|
not(target_os = "ios")
|
|
))]
|
|
#[test]
|
|
fn test_iteration_errors() {
|
|
use std::io;
|
|
let mut iter = glob("/root/*").unwrap();
|
|
|
|
// Skip test if running with permissions to read /root
|
|
if std::fs::read_dir("/root/").is_err() {
|
|
// GlobErrors shouldn't halt iteration
|
|
let next = iter.next();
|
|
assert!(next.is_some());
|
|
|
|
let err = next.unwrap();
|
|
assert!(err.is_err());
|
|
|
|
let err = err.err().unwrap();
|
|
assert!(err.path() == Path::new("/root"));
|
|
assert!(err.error().kind() == io::ErrorKind::PermissionDenied);
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_absolute_pattern() {
|
|
assert!(glob("/").unwrap().next().is_some());
|
|
assert!(glob("//").unwrap().next().is_some());
|
|
|
|
// assume that the filesystem is not empty!
|
|
assert!(glob("/*").unwrap().next().is_some());
|
|
|
|
#[cfg(not(windows))]
|
|
fn win() {}
|
|
|
|
#[cfg(windows)]
|
|
fn win() {
|
|
use std::env::current_dir;
|
|
use std::path::Component;
|
|
|
|
// check windows absolute paths with host/device components
|
|
let root_with_device = current_dir()
|
|
.ok()
|
|
.and_then(|p| match p.components().next().unwrap() {
|
|
Component::Prefix(prefix_component) => {
|
|
let path = Path::new(prefix_component.as_os_str()).join("*");
|
|
Some(path)
|
|
}
|
|
_ => panic!("no prefix in this path"),
|
|
})
|
|
.unwrap();
|
|
// FIXME (#9639): This needs to handle non-utf8 paths
|
|
assert!(glob(root_with_device.as_os_str().to_str().unwrap())
|
|
.unwrap()
|
|
.next()
|
|
.is_some());
|
|
}
|
|
win()
|
|
}
|
|
|
|
#[test]
|
|
fn test_wildcards() {
|
|
assert!(Pattern::new("a*b").unwrap().matches("a_b"));
|
|
assert!(Pattern::new("a*b*c").unwrap().matches("abc"));
|
|
assert!(!Pattern::new("a*b*c").unwrap().matches("abcd"));
|
|
assert!(Pattern::new("a*b*c").unwrap().matches("a_b_c"));
|
|
assert!(Pattern::new("a*b*c").unwrap().matches("a___b___c"));
|
|
assert!(Pattern::new("abc*abc*abc")
|
|
.unwrap()
|
|
.matches("abcabcabcabcabcabcabc"));
|
|
assert!(!Pattern::new("abc*abc*abc")
|
|
.unwrap()
|
|
.matches("abcabcabcabcabcabcabca"));
|
|
assert!(Pattern::new("a*a*a*a*a*a*a*a*a")
|
|
.unwrap()
|
|
.matches("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"));
|
|
}
|
|
|
|
#[test]
|
|
fn test_recursive_wildcards() {
|
|
let pat = Pattern::new("some/**/needle.txt").unwrap();
|
|
assert!(pat.matches("some/needle.txt"));
|
|
assert!(pat.matches("some/one/needle.txt"));
|
|
assert!(pat.matches("some/one/two/needle.txt"));
|
|
assert!(pat.matches("some/other/needle.txt"));
|
|
assert!(!pat.matches("some/other/notthis.txt"));
|
|
|
|
// a single ** should be valid, for globs
|
|
// Should accept anything
|
|
let pat = Pattern::new("**").unwrap();
|
|
assert!(pat.is_recursive);
|
|
assert!(pat.matches("abcde"));
|
|
assert!(pat.matches(""));
|
|
assert!(pat.matches(".asdf"));
|
|
assert!(pat.matches("/x/.asdf"));
|
|
|
|
// collapse consecutive wildcards
|
|
let pat = Pattern::new("some/**/**/needle.txt").unwrap();
|
|
assert!(pat.matches("some/needle.txt"));
|
|
assert!(pat.matches("some/one/needle.txt"));
|
|
assert!(pat.matches("some/one/two/needle.txt"));
|
|
assert!(pat.matches("some/other/needle.txt"));
|
|
assert!(!pat.matches("some/other/notthis.txt"));
|
|
|
|
// ** can begin the pattern
|
|
let pat = Pattern::new("**/test").unwrap();
|
|
assert!(pat.matches("one/two/test"));
|
|
assert!(pat.matches("one/test"));
|
|
assert!(pat.matches("test"));
|
|
|
|
// /** can begin the pattern
|
|
let pat = Pattern::new("/**/test").unwrap();
|
|
assert!(pat.matches("/one/two/test"));
|
|
assert!(pat.matches("/one/test"));
|
|
assert!(pat.matches("/test"));
|
|
assert!(!pat.matches("/one/notthis"));
|
|
assert!(!pat.matches("/notthis"));
|
|
|
|
// Only start sub-patterns on start of path segment.
|
|
let pat = Pattern::new("**/.*").unwrap();
|
|
assert!(pat.matches(".abc"));
|
|
assert!(pat.matches("abc/.abc"));
|
|
assert!(!pat.matches("ab.c"));
|
|
assert!(!pat.matches("abc/ab.c"));
|
|
}
|
|
|
|
#[test]
|
|
fn test_lots_of_files() {
|
|
// this is a good test because it touches lots of differently named files
|
|
glob("/*/*/*/*").unwrap().nth(10000);
|
|
}
|
|
|
|
#[test]
|
|
fn test_pattern_matches() {
|
|
let txt_pat = Pattern::new("*hello.txt").unwrap();
|
|
assert!(txt_pat.matches("hello.txt"));
|
|
assert!(txt_pat.matches("gareth_says_hello.txt"));
|
|
assert!(txt_pat.matches("some/path/to/hello.txt"));
|
|
assert!(txt_pat.matches("some\\path\\to\\hello.txt"));
|
|
assert!(txt_pat.matches("/an/absolute/path/to/hello.txt"));
|
|
assert!(!txt_pat.matches("hello.txt-and-then-some"));
|
|
assert!(!txt_pat.matches("goodbye.txt"));
|
|
|
|
let dir_pat = Pattern::new("*some/path/to/hello.txt").unwrap();
|
|
assert!(dir_pat.matches("some/path/to/hello.txt"));
|
|
assert!(dir_pat.matches("a/bigger/some/path/to/hello.txt"));
|
|
assert!(!dir_pat.matches("some/path/to/hello.txt-and-then-some"));
|
|
assert!(!dir_pat.matches("some/other/path/to/hello.txt"));
|
|
}
|
|
|
|
#[test]
|
|
fn test_pattern_matches_case_insensitive() {
|
|
let pat = Pattern::new("aBcDeFg").unwrap();
|
|
let options = MatchOptions {
|
|
case_sensitive: false,
|
|
require_literal_separator: false,
|
|
require_literal_leading_dot: false,
|
|
recursive_match_hidden_dir: true,
|
|
};
|
|
|
|
assert!(pat.matches_with("aBcDeFg", options));
|
|
assert!(pat.matches_with("abcdefg", options));
|
|
assert!(pat.matches_with("ABCDEFG", options));
|
|
assert!(pat.matches_with("AbCdEfG", options));
|
|
}
|
|
|
|
#[test]
|
|
fn test_pattern_matches_require_literal_separator() {
|
|
let options_require_literal = MatchOptions {
|
|
case_sensitive: true,
|
|
require_literal_separator: true,
|
|
require_literal_leading_dot: false,
|
|
recursive_match_hidden_dir: true,
|
|
};
|
|
let options_not_require_literal = MatchOptions {
|
|
case_sensitive: true,
|
|
require_literal_separator: false,
|
|
require_literal_leading_dot: false,
|
|
recursive_match_hidden_dir: true,
|
|
};
|
|
|
|
assert!(Pattern::new("abc/def")
|
|
.unwrap()
|
|
.matches_with("abc/def", options_require_literal));
|
|
assert!(!Pattern::new("abc?def")
|
|
.unwrap()
|
|
.matches_with("abc/def", options_require_literal));
|
|
assert!(!Pattern::new("abc*def")
|
|
.unwrap()
|
|
.matches_with("abc/def", options_require_literal));
|
|
|
|
assert!(Pattern::new("abc/def")
|
|
.unwrap()
|
|
.matches_with("abc/def", options_not_require_literal));
|
|
assert!(Pattern::new("abc?def")
|
|
.unwrap()
|
|
.matches_with("abc/def", options_not_require_literal));
|
|
assert!(Pattern::new("abc*def")
|
|
.unwrap()
|
|
.matches_with("abc/def", options_not_require_literal));
|
|
}
|
|
|
|
#[test]
|
|
fn test_pattern_matches_require_literal_leading_dot() {
|
|
let options_require_literal_leading_dot = MatchOptions {
|
|
case_sensitive: true,
|
|
require_literal_separator: false,
|
|
require_literal_leading_dot: true,
|
|
recursive_match_hidden_dir: true,
|
|
};
|
|
let options_not_require_literal_leading_dot = MatchOptions {
|
|
case_sensitive: true,
|
|
require_literal_separator: false,
|
|
require_literal_leading_dot: false,
|
|
recursive_match_hidden_dir: true,
|
|
};
|
|
|
|
let f = |options| {
|
|
Pattern::new("*.txt")
|
|
.unwrap()
|
|
.matches_with(".hello.txt", options)
|
|
};
|
|
assert!(f(options_not_require_literal_leading_dot));
|
|
assert!(!f(options_require_literal_leading_dot));
|
|
|
|
let f = |options| {
|
|
Pattern::new(".*.*")
|
|
.unwrap()
|
|
.matches_with(".hello.txt", options)
|
|
};
|
|
assert!(f(options_not_require_literal_leading_dot));
|
|
assert!(f(options_require_literal_leading_dot));
|
|
|
|
let f = |options| {
|
|
Pattern::new("aaa/bbb/*")
|
|
.unwrap()
|
|
.matches_with("aaa/bbb/.ccc", options)
|
|
};
|
|
assert!(f(options_not_require_literal_leading_dot));
|
|
assert!(!f(options_require_literal_leading_dot));
|
|
|
|
let f = |options| {
|
|
Pattern::new("aaa/bbb/*")
|
|
.unwrap()
|
|
.matches_with("aaa/bbb/c.c.c.", options)
|
|
};
|
|
assert!(f(options_not_require_literal_leading_dot));
|
|
assert!(f(options_require_literal_leading_dot));
|
|
|
|
let f = |options| {
|
|
Pattern::new("aaa/bbb/.*")
|
|
.unwrap()
|
|
.matches_with("aaa/bbb/.ccc", options)
|
|
};
|
|
assert!(f(options_not_require_literal_leading_dot));
|
|
assert!(f(options_require_literal_leading_dot));
|
|
|
|
let f = |options| {
|
|
Pattern::new("aaa/?bbb")
|
|
.unwrap()
|
|
.matches_with("aaa/.bbb", options)
|
|
};
|
|
assert!(f(options_not_require_literal_leading_dot));
|
|
assert!(!f(options_require_literal_leading_dot));
|
|
|
|
let f = |options| Pattern::new("**/*").unwrap().matches_with(".bbb", options);
|
|
assert!(f(options_not_require_literal_leading_dot));
|
|
assert!(!f(options_require_literal_leading_dot));
|
|
}
|
|
|
|
#[test]
|
|
fn test_matches_path() {
|
|
// on windows, (Path::new("a/b").as_str().unwrap() == "a\\b"), so this
|
|
// tests that / and \ are considered equivalent on windows
|
|
assert!(Pattern::new("a/b").unwrap().matches_path(Path::new("a/b")));
|
|
}
|
|
|
|
#[test]
|
|
fn test_path_join() {
|
|
let pattern = Path::new("one").join(&Path::new("**/*.rs"));
|
|
assert!(Pattern::new(pattern.to_str().unwrap()).is_ok());
|
|
}
|
|
}
|