GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2026-02-15 02:35:50
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 5352 Pathspec::Pathspec(const std::string &spec)
13 5352 : regex_(NULL)
14 5352 , relaxed_regex_(NULL)
15 5352 , prefix_regex_(NULL)
16 5352 , regex_compiled_(false)
17 5352 , relaxed_regex_compiled_(false)
18 5352 , prefix_regex_compiled_(false)
19 5352 , glob_string_compiled_(false)
20 5352 , glob_string_sequence_compiled_(false)
21 5352 , valid_(true)
22 5352 , absolute_(false) {
23
1/2
✓ Branch 1 taken 5352 times.
✗ Branch 2 not taken.
 5352 Parse(spec);
24
2/2
✓ Branch 1 taken 46 times.
✓ Branch 2 taken 5306 times.
 5352 if (patterns_.size() == 0) {
25 46 valid_ = false;
26 }
27
28 5352 ElementPatterns::const_iterator i = patterns_.begin();
29 5352 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 11324 times.
✓ Branch 3 taken 5352 times.
 16676 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 53 times.
✓ Branch 3 taken 11271 times.
 11324 if (!i->IsValid()) {
32 53 valid_ = false;
33 }
34 }
35 5352 }
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 2639 Pathspec::Pathspec(const Pathspec &other)
40 2639 : patterns_(other.patterns_)
41 2639 , regex_(NULL)
42 2639 , relaxed_regex_(NULL)
43 2639 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 2639 times.
✗ Branch 2 not taken.
 2639 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 2639 times.
✗ Branch 2 not taken.
 2639 , glob_string_sequence_(other.glob_string_sequence_)
46 2639 , regex_compiled_(false)
47 2639 , relaxed_regex_compiled_(false)
48 2639 , prefix_regex_compiled_(false)
49 2639 , glob_string_compiled_(other.glob_string_compiled_)
50 2639 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 2639 , valid_(other.valid_)
52 2639 , absolute_(other.absolute_) { }
53
54 7988 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 138 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 138 times.
✗ Branch 1 not taken.
 138 if (this != &other) {
58 138 DestroyRegularExpressions(); // see: copy c'tor for details
59 138 patterns_ = other.patterns_;
60
61 138 glob_string_compiled_ = other.glob_string_compiled_;
62 138 glob_string_ = other.glob_string_;
63
64 138 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 138 glob_string_sequence_ = other.glob_string_sequence_;
66
67 138 valid_ = other.valid_;
68 138 absolute_ = other.absolute_;
69 }
70
71 138 return *this;
72 }
73
74
75 5352 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 5352 std::string::const_iterator itr = spec.begin();
80 5352 const std::string::const_iterator end = spec.end();
81
82 5352 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 21027 times.
✓ Branch 2 taken 5352 times.
 26379 while (itr != end) {
84
2/2
✓ Branch 1 taken 9703 times.
✓ Branch 2 taken 11324 times.
 21027 if (*itr == kSeparator) {
85 9703 ++itr;
86 9703 continue;
87 }
88
1/2
✓ Branch 1 taken 11324 times.
✗ Branch 2 not taken.
 11324 ParsePathElement(end, &itr);
89 }
90 5352 }
91
92 11324 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 11324 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 57312 times.
✓ Branch 2 taken 5141 times.
✓ Branch 4 taken 51129 times.
✓ Branch 5 taken 6183 times.
✓ Branch 6 taken 51129 times.
✓ Branch 7 taken 11324 times.
 62453 while (*itr != end && **itr != kSeparator) {
97 51129 ++(*itr);
98 }
99 11324 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 11324 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 11324 times.
✗ Branch 5 not taken.
 11324 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 11324 }
104
105 13424 bool Pathspec::IsMatching(const std::string &query_path) const {
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 13424 times.
 13424 assert(IsValid());
107
108
2/2
✓ Branch 1 taken 440 times.
✓ Branch 2 taken 12984 times.
 13424 if (query_path.empty()) {
109 440 return false;
110 }
111
112 12984 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 8529 times.
✓ Branch 2 taken 586 times.
 9115 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 9115 times.
✓ Branch 1 taken 3869 times.
✓ Branch 3 taken 5375 times.
✓ Branch 4 taken 7023 times.
 22099 && IsPathspecMatching(query_path);
115 }
116
117 552 bool Pathspec::IsPrefixMatching(const std::string &query_path) const {
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 552 times.
 552 assert(IsValid());
119
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 552 times.
 552 assert(IsAbsolute());
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 552 times.
 552 if (query_path.empty()) {
122 ✗ return false;
123 }
124
125 552 const bool query_is_absolute = (query_path[0] == kSeparator);
126
4/4
✓ Branch 0 taken 506 times.
✓ Branch 1 taken 46 times.
✓ Branch 3 taken 322 times.
✓ Branch 4 taken 184 times.
 552 return (query_is_absolute && IsPathspecPrefixMatching(query_path));
127 }
128
129 6177 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 6177 times.
 6177 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 720 times.
✓ Branch 2 taken 5457 times.
 6177 if (query_path.empty()) {
133 720 return false;
134 }
135
136 5457 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 12398 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 12398 return ApplyRegularExpression(query_path, GetRegularExpression());
141 }
142
143 506 bool Pathspec::IsPathspecPrefixMatching(const std::string &query_path) const {
144 506 return ApplyRegularExpression(query_path, GetPrefixRegularExpression());
145 }
146
147 5457 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 5457 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 18361 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 18361 const char *path = query_path.c_str();
154 18361 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 11285 times.
✓ Branch 1 taken 7076 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 11285 times.
 18361 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 18361 return (retval == 0);
161 }
162
163 12398 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 2614 times.
✓ Branch 1 taken 9784 times.
 12398 if (!regex_compiled_) {
165 2614 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 2614 times.
✗ Branch 2 not taken.
 2614 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 2614 times.
✗ Branch 3 not taken.
 2614 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 2614 times.
✗ Branch 2 not taken.
 2614 regex_ = CompileRegularExpression(regex);
170 2614 regex_compiled_ = true;
171 2614 }
172
173 12398 return regex_;
174 }
175
176 506 regex_t *Pathspec::GetPrefixRegularExpression() const {
177
2/2
✓ Branch 0 taken 92 times.
✓ Branch 1 taken 414 times.
 506 if (!prefix_regex_compiled_) {
178 92 const bool is_relaxed = false;
179 92 const bool is_prefix = true;
180
1/2
✓ Branch 1 taken 92 times.
✗ Branch 2 not taken.
 92 const std::string regex = GenerateRegularExpression(is_relaxed, is_prefix);
181
1/2
✓ Branch 2 taken 92 times.
✗ Branch 3 not taken.
 92 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
182
183
1/2
✓ Branch 1 taken 92 times.
✗ Branch 2 not taken.
 92 prefix_regex_ = CompileRegularExpression(regex);
184 92 prefix_regex_compiled_ = true;
185 92 }
186
187 506 return prefix_regex_;
188 }
189
190 5457 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 705 times.
✓ Branch 1 taken 4752 times.
 5457 if (!relaxed_regex_compiled_) {
192 705 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 705 times.
✗ Branch 2 not taken.
 705 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 705 times.
✗ Branch 3 not taken.
 705 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 705 times.
✗ Branch 2 not taken.
 705 relaxed_regex_ = CompileRegularExpression(regex);
198 705 relaxed_regex_compiled_ = true;
199 705 }
200
201 5457 return relaxed_regex_;
202 }
203
204 3411 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 3411 times.
✗ Branch 3 not taken.
 3411 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 2677 times.
✓ Branch 2 taken 734 times.
 3411 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 2677 times.
✗ Branch 2 not taken.
 2677 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 3411 ElementPatterns::const_iterator i = patterns_.begin();
216 3411 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 7184 times.
✓ Branch 3 taken 3411 times.
 10595 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 7184 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 7184 times.
✗ Branch 6 not taken.
 7184 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 3773 times.
✓ Branch 3 taken 3411 times.
 7184 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 3773 times.
✗ Branch 2 not taken.
 3773 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 92 times.
✓ Branch 1 taken 3319 times.
 3411 if (is_prefix) {
225
1/2
✓ Branch 1 taken 92 times.
✗ Branch 2 not taken.
 92 regex += "($|";
226
1/2
✓ Branch 1 taken 92 times.
✗ Branch 2 not taken.
 92 regex += kSeparator;
227
1/2
✓ Branch 1 taken 92 times.
✗ Branch 2 not taken.
 92 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 3319 times.
✗ Branch 2 not taken.
 3319 regex += kSeparator;
232
1/2
✓ Branch 1 taken 3319 times.
✗ Branch 2 not taken.
 3319 regex += "?$";
233 }
234
235 6822 return regex;
236 }
237
238 3411 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 3411 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 3411 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 3411 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3411 times.
 3411 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 3411 return result;
249 }
250
251 8126 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 2614 times.
✓ Branch 1 taken 5512 times.
 8126 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2614 times.
 2614 assert(regex_ != NULL);
254 2614 regfree(regex_);
255 2614 regex_ = NULL;
256 2614 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 705 times.
✓ Branch 1 taken 7421 times.
 8126 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 705 times.
 705 assert(relaxed_regex_ != NULL);
261 705 regfree(relaxed_regex_);
262 705 relaxed_regex_ = NULL;
263 705 relaxed_regex_compiled_ = false;
264 }
265 8126 }
266
267 2363 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 1725 times.
✗ Branch 5 not taken.
 4088 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 1725 times.
✓ Branch 1 taken 638 times.
✓ Branch 4 taken 89 times.
✓ Branch 5 taken 1636 times.
✓ Branch 6 taken 727 times.
✓ Branch 7 taken 1636 times.
 4088 || IsAbsolute() != other.IsAbsolute()) {
270 727 return false;
271 }
272
273 1636 ElementPatterns::const_iterator i = patterns_.begin();
274 1636 const ElementPatterns::const_iterator iend = patterns_.end();
275 1636 ElementPatterns::const_iterator j = other.patterns_.begin();
276 1636 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 3428 times.
✓ Branch 4 taken 683 times.
✓ Branch 6 taken 3428 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 3428 times.
✓ Branch 9 taken 683 times.
 4111 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 3428 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 953 times.
✓ Branch 6 taken 2475 times.
 3428 if (*i != *j) {
280 953 return false;
281 }
282 }
283
284 683 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 769 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 769 times.
✗ Branch 1 not taken.
 769 if (!glob_string_sequence_compiled_) {
297 769 GenerateGlobStringSequence();
298 769 glob_string_sequence_compiled_ = true;
299 }
300 769 return glob_string_sequence_;
301 }
302
303
304 769 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 769 times.
 769 assert(glob_string_sequence_.empty());
306 769 ElementPatterns::const_iterator i = patterns_.begin();
307 769 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 1538 times.
✓ Branch 3 taken 769 times.
 2307 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 1538 times.
✗ Branch 3 not taken.
 1538 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 1538 times.
✗ Branch 2 not taken.
 1538 glob_string_sequence_.push_back(glob_string);
311 1538 }
312 769 }
313
314
315 1042 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 769 times.
✓ Branch 1 taken 273 times.
 1042 if (!glob_string_compiled_) {
317 769 GenerateGlobString();
318 769 glob_string_compiled_ = true;
319 }
320 1042 return glob_string_;
321 }
322
323
324 769 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 769 times.
 769 assert(glob_string_.empty());
326
327 769 bool is_first = true;
328
1/2
✓ Branch 1 taken 769 times.
✗ Branch 2 not taken.
 769 const GlobStringSequence &seq = GetGlobStringSequence();
329 769 GlobStringSequence::const_iterator i = seq.begin();
330 769 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 1538 times.
✓ Branch 2 taken 769 times.
 2307 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 769 times.
✓ Branch 1 taken 769 times.
✓ Branch 3 taken 499 times.
✓ Branch 4 taken 270 times.
✓ Branch 5 taken 1268 times.
✓ Branch 6 taken 270 times.
 1538 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 1268 times.
✗ Branch 2 not taken.
 1268 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 1538 times.
✗ Branch 3 not taken.
 1538 glob_string_ += *i;
336 1538 is_first = false;
337 }
338 769 }
339