GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2026-03-15 02:35:27
Exec Total Coverage
Lines: 198 207 95.7%
Branches: 120 172 69.8%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #include "pathspec.h"
6
7 #include <cassert>
8
9 #include "util/logging.h"
10 #include "util/smalloc.h"
11
12 1310 Pathspec::Pathspec(const std::string &spec)
13 1310 : regex_(NULL)
14 1310 , relaxed_regex_(NULL)
15 1310 , prefix_regex_(NULL)
16 1310 , regex_compiled_(false)
17 1310 , relaxed_regex_compiled_(false)
18 1310 , prefix_regex_compiled_(false)
19 1310 , glob_string_compiled_(false)
20 1310 , glob_string_sequence_compiled_(false)
21 1310 , valid_(true)
22 1310 , absolute_(false) {
23
1/2
✓ Branch 1 taken 1310 times.
✗ Branch 2 not taken.
 1310 Parse(spec);
24
2/2
✓ Branch 1 taken 2 times.
✓ Branch 2 taken 1308 times.
 1310 if (patterns_.size() == 0) {
25 2 valid_ = false;
26 }
27
28 1310 ElementPatterns::const_iterator i = patterns_.begin();
29 1310 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 2932 times.
✓ Branch 3 taken 1310 times.
 4242 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 2 times.
✓ Branch 3 taken 2930 times.
 2932 if (!i->IsValid()) {
32 2 valid_ = false;
33 }
34 }
35 1310 }
36
37 // Compiled regex structure cannot be duplicated and needs to be re-compiled
38 // Note: the copy-constructed object will perform a lazy evaluation again
39 3241 Pathspec::Pathspec(const Pathspec &other)
40 3241 : patterns_(other.patterns_)
41 3241 , regex_(NULL)
42 3241 , relaxed_regex_(NULL)
43 3241 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 3241 times.
✗ Branch 2 not taken.
 3241 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 3241 times.
✗ Branch 2 not taken.
 3241 , glob_string_sequence_(other.glob_string_sequence_)
46 3241 , regex_compiled_(false)
47 3241 , relaxed_regex_compiled_(false)
48 3241 , prefix_regex_compiled_(false)
49 3241 , glob_string_compiled_(other.glob_string_compiled_)
50 3241 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 3241 , valid_(other.valid_)
52 3241 , absolute_(other.absolute_) { }
53
54 4548 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 6 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 6 times.
✗ Branch 1 not taken.
 6 if (this != &other) {
58 6 DestroyRegularExpressions(); // see: copy c'tor for details
59 6 patterns_ = other.patterns_;
60
61 6 glob_string_compiled_ = other.glob_string_compiled_;
62 6 glob_string_ = other.glob_string_;
63
64 6 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 6 glob_string_sequence_ = other.glob_string_sequence_;
66
67 6 valid_ = other.valid_;
68 6 absolute_ = other.absolute_;
69 }
70
71 6 return *this;
72 }
73
74
75 1310 void Pathspec::Parse(const std::string &spec) {
76 // parsing is done using std::string iterators to walk through the entire
77 // pathspec parameter. Thus, all parsing methods receive references to these
78 // iterators and increment itr as they pass along.
79 1310 std::string::const_iterator itr = spec.begin();
80 1310 const std::string::const_iterator end = spec.end();
81
82 1310 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 5946 times.
✓ Branch 2 taken 1310 times.
 7256 while (itr != end) {
84
2/2
✓ Branch 1 taken 3014 times.
✓ Branch 2 taken 2932 times.
 5946 if (*itr == kSeparator) {
85 3014 ++itr;
86 3014 continue;
87 }
88
1/2
✓ Branch 1 taken 2932 times.
✗ Branch 2 not taken.
 2932 ParsePathElement(end, &itr);
89 }
90 1310 }
91
92 2932 void Pathspec::ParsePathElement(const std::string::const_iterator &end,
93 std::string::const_iterator *itr) {
94 // find the end of the current pattern element (next directory boundary)
95 2932 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 14765 times.
✓ Branch 2 taken 1096 times.
✓ Branch 4 taken 12929 times.
✓ Branch 5 taken 1836 times.
✓ Branch 6 taken 12929 times.
✓ Branch 7 taken 2932 times.
 15861 while (*itr != end && **itr != kSeparator) {
97 12929 ++(*itr);
98 }
99 2932 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 2932 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 2932 times.
✗ Branch 5 not taken.
 2932 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 2932 }
104
105 4862 bool Pathspec::IsMatching(const std::string &query_path) const {
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4862 times.
 4862 assert(IsValid());
107
108
2/2
✓ Branch 1 taken 459 times.
✓ Branch 2 taken 4403 times.
 4862 if (query_path.empty()) {
109 459 return false;
110 }
111
112 4403 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 4233 times.
✓ Branch 2 taken 20 times.
 4253 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 4253 times.
✓ Branch 1 taken 150 times.
✓ Branch 3 taken 907 times.
✓ Branch 4 taken 3476 times.
 8656 && IsPathspecMatching(query_path);
115 }
116
117 24 bool Pathspec::IsPrefixMatching(const std::string &query_path) const {
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 24 times.
 24 assert(IsValid());
119
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 24 times.
 24 assert(IsAbsolute());
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 24 times.
 24 if (query_path.empty()) {
122 ✗ return false;
123 }
124
125 24 const bool query_is_absolute = (query_path[0] == kSeparator);
126
4/4
✓ Branch 0 taken 22 times.
✓ Branch 1 taken 2 times.
✓ Branch 3 taken 14 times.
✓ Branch 4 taken 8 times.
 24 return (query_is_absolute && IsPathspecPrefixMatching(query_path));
127 }
128
129 5359 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 5359 times.
 5359 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 1260 times.
✓ Branch 2 taken 4099 times.
 5359 if (query_path.empty()) {
133 1260 return false;
134 }
135
136 4099 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 4383 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 4383 return ApplyRegularExpression(query_path, GetRegularExpression());
141 }
142
143 22 bool Pathspec::IsPathspecPrefixMatching(const std::string &query_path) const {
144 22 return ApplyRegularExpression(query_path, GetPrefixRegularExpression());
145 }
146
147 4099 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 4099 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 8504 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 8504 const char *path = query_path.c_str();
154 8504 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 7306 times.
✓ Branch 1 taken 1198 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 7306 times.
 8504 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 8504 return (retval == 0);
161 }
162
163 4383 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 857 times.
✓ Branch 1 taken 3526 times.
 4383 if (!regex_compiled_) {
165 857 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 857 times.
✗ Branch 2 not taken.
 857 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 857 times.
✗ Branch 3 not taken.
 857 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 857 times.
✗ Branch 2 not taken.
 857 regex_ = CompileRegularExpression(regex);
170 857 regex_compiled_ = true;
171 857 }
172
173 4383 return regex_;
174 }
175
176 22 regex_t *Pathspec::GetPrefixRegularExpression() const {
177
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 18 times.
 22 if (!prefix_regex_compiled_) {
178 4 const bool is_relaxed = false;
179 4 const bool is_prefix = true;
180
1/2
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
 4 const std::string regex = GenerateRegularExpression(is_relaxed, is_prefix);
181
1/2
✓ Branch 2 taken 4 times.
✗ Branch 3 not taken.
 4 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
182
183
1/2
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
 4 prefix_regex_ = CompileRegularExpression(regex);
184 4 prefix_regex_compiled_ = true;
185 4 }
186
187 22 return prefix_regex_;
188 }
189
190 4099 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 342 times.
✓ Branch 1 taken 3757 times.
 4099 if (!relaxed_regex_compiled_) {
192 342 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 342 times.
✗ Branch 2 not taken.
 342 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 342 times.
✗ Branch 3 not taken.
 342 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 342 times.
✗ Branch 2 not taken.
 342 relaxed_regex_ = CompileRegularExpression(regex);
198 342 relaxed_regex_compiled_ = true;
199 342 }
200
201 4099 return relaxed_regex_;
202 }
203
204 1203 std::string Pathspec::GenerateRegularExpression(const bool is_relaxed,
205 const bool is_prefix) const {
206 // start matching at the first character
207
1/2
✓ Branch 2 taken 1203 times.
✗ Branch 3 not taken.
 1203 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 1104 times.
✓ Branch 2 taken 99 times.
 1203 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 1104 times.
✗ Branch 2 not taken.
 1104 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 1203 ElementPatterns::const_iterator i = patterns_.begin();
216 1203 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 2630 times.
✓ Branch 3 taken 1203 times.
 3833 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 2630 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 2630 times.
✗ Branch 6 not taken.
 2630 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 1427 times.
✓ Branch 3 taken 1203 times.
 2630 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 1427 times.
✗ Branch 2 not taken.
 1427 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 1199 times.
 1203 if (is_prefix) {
225
1/2
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
 4 regex += "($|";
226
1/2
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
 4 regex += kSeparator;
227
1/2
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
 4 regex += ".*$)";
228 } else {
229 // a path might end with a trailing slash
230 // (pathspec does not distinguish files and directories)
231
1/2
✓ Branch 1 taken 1199 times.
✗ Branch 2 not taken.
 1199 regex += kSeparator;
232
1/2
✓ Branch 1 taken 1199 times.
✗ Branch 2 not taken.
 1199 regex += "?$";
233 }
234
235 2406 return regex;
236 }
237
238 1203 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 1203 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 1203 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 1203 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1203 times.
 1203 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 1203 return result;
249 }
250
251 4554 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 857 times.
✓ Branch 1 taken 3697 times.
 4554 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 857 times.
 857 assert(regex_ != NULL);
254 857 regfree(regex_);
255 857 regex_ = NULL;
256 857 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 342 times.
✓ Branch 1 taken 4212 times.
 4554 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 342 times.
 342 assert(relaxed_regex_ != NULL);
261 342 regfree(relaxed_regex_);
262 342 relaxed_regex_ = NULL;
263 342 relaxed_regex_compiled_ = false;
264 }
265 4554 }
266
267 1111 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 291 times.
✗ Branch 5 not taken.
 1402 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 291 times.
✓ Branch 1 taken 820 times.
✓ Branch 4 taken 40 times.
✓ Branch 5 taken 251 times.
✓ Branch 6 taken 860 times.
✓ Branch 7 taken 251 times.
 1402 || IsAbsolute() != other.IsAbsolute()) {
270 860 return false;
271 }
272
273 251 ElementPatterns::const_iterator i = patterns_.begin();
274 251 const ElementPatterns::const_iterator iend = patterns_.end();
275 251 ElementPatterns::const_iterator j = other.patterns_.begin();
276 251 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 442 times.
✓ Branch 4 taken 31 times.
✓ Branch 6 taken 442 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 442 times.
✓ Branch 9 taken 31 times.
 473 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 442 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 220 times.
✓ Branch 6 taken 222 times.
 442 if (*i != *j) {
280 220 return false;
281 }
282 }
283
284 31 return true;
285 }
286
287 ✗ void Pathspec::PrintRegularExpressionError(const int error_code) const {
288 ✗ assert(regex_compiled_);
289 ✗ const size_t errbuf_size = 1024;
290 char error[errbuf_size];
291 ✗ regerror(error_code, regex_, error, errbuf_size);
292 ✗ LogCvmfs(kLogPathspec, kLogStderr, "RegEx Error: %d - %s", error_code, error);
293 }
294
295 21 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 21 times.
✗ Branch 1 not taken.
 21 if (!glob_string_sequence_compiled_) {
297 21 GenerateGlobStringSequence();
298 21 glob_string_sequence_compiled_ = true;
299 }
300 21 return glob_string_sequence_;
301 }
302
303
304 21 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 21 times.
 21 assert(glob_string_sequence_.empty());
306 21 ElementPatterns::const_iterator i = patterns_.begin();
307 21 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 42 times.
✓ Branch 3 taken 21 times.
 63 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 42 times.
✗ Branch 3 not taken.
 42 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 42 times.
✗ Branch 2 not taken.
 42 glob_string_sequence_.push_back(glob_string);
311 42 }
312 21 }
313
314
315 30 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 21 times.
✓ Branch 1 taken 9 times.
 30 if (!glob_string_compiled_) {
317 21 GenerateGlobString();
318 21 glob_string_compiled_ = true;
319 }
320 30 return glob_string_;
321 }
322
323
324 21 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 21 times.
 21 assert(glob_string_.empty());
326
327 21 bool is_first = true;
328
1/2
✓ Branch 1 taken 21 times.
✗ Branch 2 not taken.
 21 const GlobStringSequence &seq = GetGlobStringSequence();
329 21 GlobStringSequence::const_iterator i = seq.begin();
330 21 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 42 times.
✓ Branch 2 taken 21 times.
 63 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 21 times.
✓ Branch 1 taken 21 times.
✓ Branch 3 taken 15 times.
✓ Branch 4 taken 6 times.
✓ Branch 5 taken 36 times.
✓ Branch 6 taken 6 times.
 42 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 36 times.
✗ Branch 2 not taken.
 36 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 42 times.
✗ Branch 3 not taken.
 42 glob_string_ += *i;
336 42 is_first = false;
337 }
338 21 }
339