GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2026-08-23 02:40:52
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 6528 Pathspec::Pathspec(const std::string &spec)
13 6528 : regex_(NULL)
14 6528 , relaxed_regex_(NULL)
15 6528 , prefix_regex_(NULL)
16 6528 , regex_compiled_(false)
17 6528 , relaxed_regex_compiled_(false)
18 6528 , prefix_regex_compiled_(false)
19 6528 , glob_string_compiled_(false)
20 6528 , glob_string_sequence_compiled_(false)
21 6528 , valid_(true)
22 6528 , absolute_(false) {
23
1/2
✓ Branch 1 taken 6528 times.
✗ Branch 2 not taken.
 6528 Parse(spec);
24
2/2
✓ Branch 1 taken 23 times.
✓ Branch 2 taken 6505 times.
 6528 if (patterns_.size() == 0) {
25 23 valid_ = false;
26 }
27
28 6528 ElementPatterns::const_iterator i = patterns_.begin();
29 6528 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 14673 times.
✓ Branch 3 taken 6528 times.
 21201 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 73 times.
✓ Branch 3 taken 14600 times.
 14673 if (!i->IsValid()) {
32 73 valid_ = false;
33 }
34 }
35 6528 }
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 11109 Pathspec::Pathspec(const Pathspec &other)
40 11109 : patterns_(other.patterns_)
41 11109 , regex_(NULL)
42 11109 , relaxed_regex_(NULL)
43 11109 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 11109 times.
✗ Branch 2 not taken.
 11109 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 11109 times.
✗ Branch 2 not taken.
 11109 , glob_string_sequence_(other.glob_string_sequence_)
46 11109 , regex_compiled_(false)
47 11109 , relaxed_regex_compiled_(false)
48 11109 , prefix_regex_compiled_(false)
49 11109 , glob_string_compiled_(other.glob_string_compiled_)
50 11109 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 11109 , valid_(other.valid_)
52 11109 , absolute_(other.absolute_) { }
53
54 17634 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 69 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 69 times.
✗ Branch 1 not taken.
 69 if (this != &other) {
58 69 DestroyRegularExpressions(); // see: copy c'tor for details
59 69 patterns_ = other.patterns_;
60
61 69 glob_string_compiled_ = other.glob_string_compiled_;
62 69 glob_string_ = other.glob_string_;
63
64 69 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 69 glob_string_sequence_ = other.glob_string_sequence_;
66
67 69 valid_ = other.valid_;
68 69 absolute_ = other.absolute_;
69 }
70
71 69 return *this;
72 }
73
74
75 6528 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 6528 std::string::const_iterator itr = spec.begin();
80 6528 const std::string::const_iterator end = spec.end();
81
82 6528 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 28465 times.
✓ Branch 2 taken 6528 times.
 34993 while (itr != end) {
84
2/2
✓ Branch 1 taken 13792 times.
✓ Branch 2 taken 14673 times.
 28465 if (*itr == kSeparator) {
85 13792 ++itr;
86 13792 continue;
87 }
88
1/2
✓ Branch 1 taken 14673 times.
✗ Branch 2 not taken.
 14673 ParsePathElement(end, &itr);
89 }
90 6528 }
91
92 14673 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 14673 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 72932 times.
✓ Branch 2 taken 6246 times.
✓ Branch 4 taken 64505 times.
✓ Branch 5 taken 8427 times.
✓ Branch 6 taken 64505 times.
✓ Branch 7 taken 14673 times.
 79178 while (*itr != end && **itr != kSeparator) {
97 64505 ++(*itr);
98 }
99 14673 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 14673 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 14673 times.
✗ Branch 5 not taken.
 14673 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 14673 }
104
105 16025 bool Pathspec::IsMatching(const std::string &query_path) const {
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 16025 times.
 16025 assert(IsValid());
107
108
2/2
✓ Branch 1 taken 836 times.
✓ Branch 2 taken 15189 times.
 16025 if (query_path.empty()) {
109 836 return false;
110 }
111
112 15189 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 12643 times.
✓ Branch 2 taken 312 times.
 12955 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 12955 times.
✓ Branch 1 taken 2234 times.
✓ Branch 3 taken 4956 times.
✓ Branch 4 taken 9921 times.
 28144 && IsPathspecMatching(query_path);
115 }
116
117 288 bool Pathspec::IsPrefixMatching(const std::string &query_path) const {
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 288 times.
 288 assert(IsValid());
119
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 288 times.
 288 assert(IsAbsolute());
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 288 times.
 288 if (query_path.empty()) {
122 ✗ return false;
123 }
124
125 288 const bool query_is_absolute = (query_path[0] == kSeparator);
126
4/4
✓ Branch 0 taken 264 times.
✓ Branch 1 taken 24 times.
✓ Branch 3 taken 168 times.
✓ Branch 4 taken 96 times.
 288 return (query_is_absolute && IsPathspecPrefixMatching(query_path));
127 }
128
129 11263 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 11263 times.
 11263 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 975 times.
✓ Branch 2 taken 10288 times.
 11263 if (query_path.empty()) {
133 975 return false;
134 }
135
136 10288 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 14877 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 14877 return ApplyRegularExpression(query_path, GetRegularExpression());
141 }
142
143 264 bool Pathspec::IsPathspecPrefixMatching(const std::string &query_path) const {
144 264 return ApplyRegularExpression(query_path, GetPrefixRegularExpression());
145 }
146
147 10288 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 10288 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 25429 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 25429 const char *path = query_path.c_str();
154 25429 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 18418 times.
✓ Branch 1 taken 7011 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 18418 times.
 25429 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 25429 return (retval == 0);
161 }
162
163 14877 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 3145 times.
✓ Branch 1 taken 11732 times.
 14877 if (!regex_compiled_) {
165 3145 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 3145 times.
✗ Branch 2 not taken.
 3145 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 3145 times.
✗ Branch 3 not taken.
 3145 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 3145 times.
✗ Branch 2 not taken.
 3145 regex_ = CompileRegularExpression(regex);
170 3145 regex_compiled_ = true;
171 3145 }
172
173 14877 return regex_;
174 }
175
176 264 regex_t *Pathspec::GetPrefixRegularExpression() const {
177
2/2
✓ Branch 0 taken 48 times.
✓ Branch 1 taken 216 times.
 264 if (!prefix_regex_compiled_) {
178 48 const bool is_relaxed = false;
179 48 const bool is_prefix = true;
180
1/2
✓ Branch 1 taken 48 times.
✗ Branch 2 not taken.
 48 const std::string regex = GenerateRegularExpression(is_relaxed, is_prefix);
181
1/2
✓ Branch 2 taken 48 times.
✗ Branch 3 not taken.
 48 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
182
183
1/2
✓ Branch 1 taken 48 times.
✗ Branch 2 not taken.
 48 prefix_regex_ = CompileRegularExpression(regex);
184 48 prefix_regex_compiled_ = true;
185 48 }
186
187 264 return prefix_regex_;
188 }
189
190 10288 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 983 times.
✓ Branch 1 taken 9305 times.
 10288 if (!relaxed_regex_compiled_) {
192 983 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 983 times.
✗ Branch 2 not taken.
 983 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 983 times.
✗ Branch 3 not taken.
 983 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 983 times.
✗ Branch 2 not taken.
 983 relaxed_regex_ = CompileRegularExpression(regex);
198 983 relaxed_regex_compiled_ = true;
199 983 }
200
201 10288 return relaxed_regex_;
202 }
203
204 4176 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 4176 times.
✗ Branch 3 not taken.
 4176 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 3674 times.
✓ Branch 2 taken 502 times.
 4176 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 3674 times.
✗ Branch 2 not taken.
 3674 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 4176 ElementPatterns::const_iterator i = patterns_.begin();
216 4176 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 9463 times.
✓ Branch 3 taken 4176 times.
 13639 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 9463 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 9463 times.
✗ Branch 6 not taken.
 9463 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 5287 times.
✓ Branch 3 taken 4176 times.
 9463 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 5287 times.
✗ Branch 2 not taken.
 5287 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 48 times.
✓ Branch 1 taken 4128 times.
 4176 if (is_prefix) {
225
1/2
✓ Branch 1 taken 48 times.
✗ Branch 2 not taken.
 48 regex += "($|";
226
1/2
✓ Branch 1 taken 48 times.
✗ Branch 2 not taken.
 48 regex += kSeparator;
227
1/2
✓ Branch 1 taken 48 times.
✗ Branch 2 not taken.
 48 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 4128 times.
✗ Branch 2 not taken.
 4128 regex += kSeparator;
232
1/2
✓ Branch 1 taken 4128 times.
✗ Branch 2 not taken.
 4128 regex += "?$";
233 }
234
235 8352 return regex;
236 }
237
238 4176 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 4176 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 4176 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 4176 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4176 times.
 4176 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 4176 return result;
249 }
250
251 17703 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 3145 times.
✓ Branch 1 taken 14558 times.
 17703 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3145 times.
 3145 assert(regex_ != NULL);
254 3145 regfree(regex_);
255 3145 regex_ = NULL;
256 3145 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 983 times.
✓ Branch 1 taken 16720 times.
 17703 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 983 times.
 983 assert(relaxed_regex_ != NULL);
261 983 regfree(relaxed_regex_);
262 983 relaxed_regex_ = NULL;
263 983 relaxed_regex_compiled_ = false;
264 }
265 17703 }
266
267 2942 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 1632 times.
✗ Branch 5 not taken.
 4574 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 1632 times.
✓ Branch 1 taken 1310 times.
✓ Branch 4 taken 193 times.
✓ Branch 5 taken 1439 times.
✓ Branch 6 taken 1503 times.
✓ Branch 7 taken 1439 times.
 4574 || IsAbsolute() != other.IsAbsolute()) {
270 1503 return false;
271 }
272
273 1439 ElementPatterns::const_iterator i = patterns_.begin();
274 1439 const ElementPatterns::const_iterator iend = patterns_.end();
275 1439 ElementPatterns::const_iterator j = other.patterns_.begin();
276 1439 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 3022 times.
✓ Branch 4 taken 394 times.
✓ Branch 6 taken 3022 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 3022 times.
✓ Branch 9 taken 394 times.
 3416 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 3022 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 1045 times.
✓ Branch 6 taken 1977 times.
 3022 if (*i != *j) {
280 1045 return false;
281 }
282 }
283
284 394 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 393 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 393 times.
✗ Branch 1 not taken.
 393 if (!glob_string_sequence_compiled_) {
297 393 GenerateGlobStringSequence();
298 393 glob_string_sequence_compiled_ = true;
299 }
300 393 return glob_string_sequence_;
301 }
302
303
304 393 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 393 times.
 393 assert(glob_string_sequence_.empty());
306 393 ElementPatterns::const_iterator i = patterns_.begin();
307 393 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 786 times.
✓ Branch 3 taken 393 times.
 1179 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 786 times.
✗ Branch 3 not taken.
 786 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 786 times.
✗ Branch 2 not taken.
 786 glob_string_sequence_.push_back(glob_string);
311 786 }
312 393 }
313
314
315 534 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 393 times.
✓ Branch 1 taken 141 times.
 534 if (!glob_string_compiled_) {
317 393 GenerateGlobString();
318 393 glob_string_compiled_ = true;
319 }
320 534 return glob_string_;
321 }
322
323
324 393 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 393 times.
 393 assert(glob_string_.empty());
326
327 393 bool is_first = true;
328
1/2
✓ Branch 1 taken 393 times.
✗ Branch 2 not taken.
 393 const GlobStringSequence &seq = GetGlobStringSequence();
329 393 GlobStringSequence::const_iterator i = seq.begin();
330 393 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 786 times.
✓ Branch 2 taken 393 times.
 1179 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 393 times.
✓ Branch 1 taken 393 times.
✓ Branch 3 taken 255 times.
✓ Branch 4 taken 138 times.
✓ Branch 5 taken 648 times.
✓ Branch 6 taken 138 times.
 786 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 648 times.
✗ Branch 2 not taken.
 648 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 786 times.
✗ Branch 3 not taken.
 786 glob_string_ += *i;
336 786 is_first = false;
337 }
338 393 }
339