Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add an option to not follow symlinks #63

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add an option to not follow symlinks #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 28 additions & 7 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
//! case_sensitive: false,
//! require_literal_separator: false,
//! require_literal_leading_dot: false,
//! follow_links: false,
//! };
//! for entry in glob_with("local/*a*", &options).unwrap() {
//! if let Ok(path) = entry {
Expand Down Expand Up @@ -299,8 +300,13 @@ impl fmt::Display for GlobError {
}
}

fn is_dir(p: &Path) -> bool {
fs::metadata(p).map(|m| m.is_dir()).unwrap_or(false)
fn is_dir(p: &Path, follow_links: bool) -> bool {
let metadata = if follow_links {
fs::metadata(p)
} else {
fs::symlink_metadata(p)
};
Comment on lines +304 to +308
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the fs::metadata() call in fill_todo() need the same treatment?

metadata.map(|m| m.is_dir()).unwrap_or(false)
}

/// An alias for a glob iteration result.
Expand Down Expand Up @@ -343,7 +349,8 @@ impl Iterator for Paths {
// 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) {
if self.require_dir && !is_dir(&path,
self.options.follow_links) {
continue;
}
return Some(Ok(path));
Expand All @@ -358,7 +365,7 @@ impl Iterator for Paths {
next += 1;
}

if is_dir(&path) {
if is_dir(&path, self.options.follow_links) {
// the path is a directory, so it's a match

// push this directory's contents
Expand Down Expand Up @@ -401,7 +408,8 @@ impl Iterator for Paths {
// *AND* its children so we don't need to check the
// children

if !self.require_dir || is_dir(&path) {
if !self.require_dir || is_dir(&path,
self.options.follow_links) {
return Some(Ok(path));
}
} else {
Expand Down Expand Up @@ -804,7 +812,7 @@ fn fill_todo(todo: &mut Vec<Result<(PathBuf, usize), GlobError>>,
};

let pattern = &patterns[idx];
let is_dir = is_dir(path);
let is_dir = is_dir(path, options.follow_links);
let curdir = path == Path::new(".");
match pattern_as_str(pattern) {
Some(s) => {
Expand Down Expand Up @@ -957,6 +965,10 @@ pub struct MatchOptions {
/// conventionally considered hidden on Unix systems and it might be
/// desirable to skip them when listing files.
pub require_literal_leading_dot: bool,

/// Whether ot not paths that are symbolic links are followed
/// during the walk.
pub follow_links: bool,
}

impl MatchOptions {
Expand All @@ -970,14 +982,16 @@ impl MatchOptions {
/// MatchOptions {
/// case_sensitive: true,
/// require_literal_separator: false,
/// require_literal_leading_dot: false
/// require_literal_leading_dot: false,
/// follow_links: false,
/// }
/// ```
pub fn new() -> MatchOptions {
MatchOptions {
case_sensitive: true,
require_literal_separator: false,
require_literal_leading_dot: false,
follow_links: false,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's the right call (it matches all shells I tried as well as Python's glob module) but a default of false would be a breaking change, right?

}
}
}
Expand Down Expand Up @@ -1219,6 +1233,7 @@ mod test {
case_sensitive: false,
require_literal_separator: false,
require_literal_leading_dot: false,
follow_links: false,
};

assert!(pat.matches_with("aBcDeFg", &options));
Expand All @@ -1237,11 +1252,13 @@ mod test {
case_sensitive: false,
require_literal_separator: false,
require_literal_leading_dot: false,
follow_links: false,
};
let options_case_sensitive = MatchOptions {
case_sensitive: true,
require_literal_separator: false,
require_literal_leading_dot: false,
follow_links: false,
};

assert!(pat_within.matches_with("a", &options_case_insensitive));
Expand All @@ -1260,11 +1277,13 @@ mod test {
case_sensitive: true,
require_literal_separator: true,
require_literal_leading_dot: false,
follow_links: false,
};
let options_not_require_literal = MatchOptions {
case_sensitive: true,
require_literal_separator: false,
require_literal_leading_dot: false,
follow_links: false,
};

assert!(Pattern::new("abc/def").unwrap().matches_with("abc/def", &options_require_literal));
Expand Down Expand Up @@ -1299,11 +1318,13 @@ mod test {
case_sensitive: true,
require_literal_separator: false,
require_literal_leading_dot: true,
follow_links: false,
};
let options_not_require_literal_leading_dot = MatchOptions {
case_sensitive: true,
require_literal_separator: false,
require_literal_leading_dot: false,
follow_links: false,
};

let f = |options| Pattern::new("*.txt").unwrap().matches_with(".hello.txt", options);
Expand Down