1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
//! Implements parsing and applying .gitignore files.
use {
git2,
glob,
id_arena::{Arena, Id},
std::{
fs::File,
io::{BufRead, BufReader, Result},
path::Path,
},
};
pub fn is_repo(root: &Path) -> bool {
root.join(".git").exists()
}
/// a simple rule of a gitignore file
#[derive(Clone)]
struct GitIgnoreRule {
ok: bool, // does this rule when matched means the file is good? (usually false)
directory: bool, // whether this rule only applies to directories
filename: bool, // does this rule apply to just the filename
pattern: glob::Pattern,
pattern_options: glob::MatchOptions,
}
impl GitIgnoreRule {
fn from(line: &str, dir: &Path) -> Option<GitIgnoreRule> {
if line.starts_with('#') {
return None; // comment line
}
let r = regex!(
r"(?x)
^\s*
(!)? # 1 : negation
(.+?) # 2 : pattern
(/)? # 3 : directory
\s*$
"
);
if let Some(c) = r.captures(line) {
if let Some(p) = c.get(2) {
let mut p = p.as_str().to_string();
let has_separator = p.contains('/');
if has_separator && p.starts_with('/') {
p = dir.to_string_lossy().to_string() + &p;
}
if let Ok(pattern) = glob::Pattern::new(&p) {
let pattern_options = glob::MatchOptions {
case_sensitive: true, // not really sure about this one
require_literal_leading_dot: false,
require_literal_separator: has_separator,
};
return Some(GitIgnoreRule {
ok: c.get(1).is_some(), // if negation
pattern,
directory: c.get(3).is_some(),
filename: !has_separator,
pattern_options,
});
}
}
}
None
}
}
/// The rules of a gitignore file
#[derive(Clone)]
pub struct GitIgnoreFile {
rules: Vec<GitIgnoreRule>,
}
impl GitIgnoreFile {
pub fn new(path: &Path) -> Result<GitIgnoreFile> {
let f = File::open(path)?;
let parent = path.parent().unwrap();
let mut rules: Vec<GitIgnoreRule> = Vec::new();
for line in BufReader::new(f).lines() {
if let Some(rule) = GitIgnoreRule::from(&line?, &parent) {
rules.push(rule);
}
}
// the last rule applicable to a path is the right one. So
// we reverse the list to easily iterate from the last one to the first one
rules.reverse();
Ok(GitIgnoreFile { rules })
}
}
pub fn find_global_ignore() -> Option<GitIgnoreFile> {
git2::Config::open_default()
.and_then(|global_config| global_config.get_path("core.excludesfile"))
.ok()
.or_else(|| {
directories::BaseDirs::new().map(|base_dirs| base_dirs.config_dir().join("git/ignore"))
})
.or_else(|| {
directories::UserDirs::new()
.map(|user_dirs| user_dirs.home_dir().join(".config/git/ignore"))
})
.as_ref()
.and_then(|path| time!(Debug, "GitIgnoreFile::new", GitIgnoreFile::new(path)).ok())
}
#[derive(Debug, Clone, Default)]
pub struct GitIgnoreChain {
in_repo: bool,
file_ids: Vec<Id<GitIgnoreFile>>,
}
impl GitIgnoreChain {
pub fn push(&mut self, id: Id<GitIgnoreFile>) {
self.file_ids.push(id);
}
}
pub struct GitIgnorer {
files: Arena<GitIgnoreFile>,
global_chain: GitIgnoreChain,
}
impl Default for GitIgnorer {
fn default() -> Self {
let mut files = Arena::new();
let mut global_chain = GitIgnoreChain::default();
lazy_static! {
static ref GLOBAL_GI: Option<GitIgnoreFile> = find_global_ignore();
}
if let Some(gif) = &*GLOBAL_GI {
global_chain.push(files.alloc(gif.clone()));
}
Self {
files,
global_chain,
}
}
}
impl GitIgnorer {
pub fn root_chain(&mut self, mut dir: &Path) -> GitIgnoreChain {
let mut chain = self.global_chain.clone();
loop {
let ignore_file = dir.join(".gitignore");
if let Ok(gif) = GitIgnoreFile::new(&ignore_file) {
chain.push(self.files.alloc(gif));
}
if is_repo(dir) {
chain.in_repo = true;
break;
}
if let Some(parent) = dir.parent() {
dir = parent;
} else {
break;
}
}
chain
}
pub fn deeper_chain(&mut self, parent_chain: &GitIgnoreChain, dir: &Path) -> GitIgnoreChain {
// if the current folder is a repository, then
// we reset the chain to the root one:
// we don't want the .gitignore files of super repositories
// (see https://github.com/Canop/broot/issues/160)
let mut chain = if is_repo(dir) {
let mut chain = self.global_chain.clone();
chain.in_repo = true;
chain
} else {
parent_chain.clone()
};
if chain.in_repo {
let ignore_file = dir.join(".gitignore");
if let Ok(gif) = GitIgnoreFile::new(&ignore_file) {
chain.push(self.files.alloc(gif));
}
}
chain
}
/// return true if the given path should not be ignored
pub fn accepts(
&self,
chain: &GitIgnoreChain,
path: &Path,
filename: &str,
directory: bool,
) -> bool {
if !chain.in_repo {
// if we're not in a git repository, then .gitignore files, including
// the global ones, are irrelevant
return true;
}
// we start with deeper files: deeper rules have a bigger priority
for id in chain.file_ids.iter().rev() {
let file = &self.files[*id];
for rule in &file.rules {
if rule.directory && !directory {
continue;
}
let ok = if rule.filename {
rule.pattern.matches_with(filename, rule.pattern_options)
} else {
rule.pattern.matches_path_with(path, rule.pattern_options)
};
if ok {
return rule.ok;
}
}
}
true
}
}
|
