GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2026-05-24 02:35:55
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 3994 Pathspec::Pathspec(const std::string &spec)
13 3994 : regex_(NULL)
14 3994 , relaxed_regex_(NULL)
15 3994 , prefix_regex_(NULL)
16 3994 , regex_compiled_(false)
17 3994 , relaxed_regex_compiled_(false)
18 3994 , prefix_regex_compiled_(false)
19 3994 , glob_string_compiled_(false)
20 3994 , glob_string_sequence_compiled_(false)
21 3994 , valid_(true)
22 3994 , absolute_(false) {
23
1/2
✓ Branch 1 taken 3994 times.
✗ Branch 2 not taken.
 3994 Parse(spec);
24
2/2
✓ Branch 1 taken 27 times.
✓ Branch 2 taken 3967 times.
 3994 if (patterns_.size() == 0) {
25 27 valid_ = false;
26 }
27
28 3994 ElementPatterns::const_iterator i = patterns_.begin();
29 3994 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 8665 times.
✓ Branch 3 taken 3994 times.
 12659 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 41 times.
✓ Branch 3 taken 8624 times.
 8665 if (!i->IsValid()) {
32 41 valid_ = false;
33 }
34 }
35 3994 }
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 3831 Pathspec::Pathspec(const Pathspec &other)
40 3831 : patterns_(other.patterns_)
41 3831 , regex_(NULL)
42 3831 , relaxed_regex_(NULL)
43 3831 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 3831 times.
✗ Branch 2 not taken.
 3831 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 3831 times.
✗ Branch 2 not taken.
 3831 , glob_string_sequence_(other.glob_string_sequence_)
46 3831 , regex_compiled_(false)
47 3831 , relaxed_regex_compiled_(false)
48 3831 , prefix_regex_compiled_(false)
49 3831 , glob_string_compiled_(other.glob_string_compiled_)
50 3831 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 3831 , valid_(other.valid_)
52 3831 , absolute_(other.absolute_) { }
53
54 7822 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 81 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 81 times.
✗ Branch 1 not taken.
 81 if (this != &other) {
58 81 DestroyRegularExpressions(); // see: copy c'tor for details
59 81 patterns_ = other.patterns_;
60
61 81 glob_string_compiled_ = other.glob_string_compiled_;
62 81 glob_string_ = other.glob_string_;
63
64 81 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 81 glob_string_sequence_ = other.glob_string_sequence_;
66
67 81 valid_ = other.valid_;
68 81 absolute_ = other.absolute_;
69 }
70
71 81 return *this;
72 }
73
74
75 3994 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 3994 std::string::const_iterator itr = spec.begin();
80 3994 const std::string::const_iterator end = spec.end();
81
82 3994 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 16398 times.
✓ Branch 2 taken 3994 times.
 20392 while (itr != end) {
84
2/2
✓ Branch 1 taken 7733 times.
✓ Branch 2 taken 8665 times.
 16398 if (*itr == kSeparator) {
85 7733 ++itr;
86 7733 continue;
87 }
88
1/2
✓ Branch 1 taken 8665 times.
✗ Branch 2 not taken.
 8665 ParsePathElement(end, &itr);
89 }
90 3994 }
91
92 8665 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 8665 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 42611 times.
✓ Branch 2 taken 3778 times.
✓ Branch 4 taken 37724 times.
✓ Branch 5 taken 4887 times.
✓ Branch 6 taken 37724 times.
✓ Branch 7 taken 8665 times.
 46389 while (*itr != end && **itr != kSeparator) {
97 37724 ++(*itr);
98 }
99 8665 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 8665 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 8665 times.
✗ Branch 5 not taken.
 8665 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 8665 }
104
105 10306 bool Pathspec::IsMatching(const std::string &query_path) const {
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 10306 times.
 10306 assert(IsValid());
107
108
2/2
✓ Branch 1 taken 455 times.
✓ Branch 2 taken 9851 times.
 10306 if (query_path.empty()) {
109 455 return false;
110 }
111
112 9851 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 7197 times.
✓ Branch 2 taken 346 times.
 7543 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 7543 times.
✓ Branch 1 taken 2308 times.
✓ Branch 3 taken 3709 times.
✓ Branch 4 taken 5796 times.
 17394 && IsPathspecMatching(query_path);
115 }
116
117 324 bool Pathspec::IsPrefixMatching(const std::string &query_path) const {
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 324 times.
 324 assert(IsValid());
119
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 324 times.
 324 assert(IsAbsolute());
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 324 times.
 324 if (query_path.empty()) {
122 ✗ return false;
123 }
124
125 324 const bool query_is_absolute = (query_path[0] == kSeparator);
126
4/4
✓ Branch 0 taken 297 times.
✓ Branch 1 taken 27 times.
✓ Branch 3 taken 189 times.
✓ Branch 4 taken 108 times.
 324 return (query_is_absolute && IsPathspecPrefixMatching(query_path));
127 }
128
129 7101 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 7101 times.
 7101 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 972 times.
✓ Branch 2 taken 6129 times.
 7101 if (query_path.empty()) {
133 972 return false;
134 }
135
136 6129 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 9505 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 9505 return ApplyRegularExpression(query_path, GetRegularExpression());
141 }
142
143 297 bool Pathspec::IsPathspecPrefixMatching(const std::string &query_path) const {
144 297 return ApplyRegularExpression(query_path, GetPrefixRegularExpression());
145 }
146
147 6129 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 6129 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 15931 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 15931 const char *path = query_path.c_str();
154 15931 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 10893 times.
✓ Branch 1 taken 5038 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 10893 times.
 15931 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 15931 return (retval == 0);
161 }
162
163 9505 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 1933 times.
✓ Branch 1 taken 7572 times.
 9505 if (!regex_compiled_) {
165 1933 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 1933 times.
✗ Branch 2 not taken.
 1933 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 1933 times.
✗ Branch 3 not taken.
 1933 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 1933 times.
✗ Branch 2 not taken.
 1933 regex_ = CompileRegularExpression(regex);
170 1933 regex_compiled_ = true;
171 1933 }
172
173 9505 return regex_;
174 }
175
176 297 regex_t *Pathspec::GetPrefixRegularExpression() const {
177
2/2
✓ Branch 0 taken 54 times.
✓ Branch 1 taken 243 times.
 297 if (!prefix_regex_compiled_) {
178 54 const bool is_relaxed = false;
179 54 const bool is_prefix = true;
180
1/2
✓ Branch 1 taken 54 times.
✗ Branch 2 not taken.
 54 const std::string regex = GenerateRegularExpression(is_relaxed, is_prefix);
181
1/2
✓ Branch 2 taken 54 times.
✗ Branch 3 not taken.
 54 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
182
183
1/2
✓ Branch 1 taken 54 times.
✗ Branch 2 not taken.
 54 prefix_regex_ = CompileRegularExpression(regex);
184 54 prefix_regex_compiled_ = true;
185 54 }
186
187 297 return prefix_regex_;
188 }
189
190 6129 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 648 times.
✓ Branch 1 taken 5481 times.
 6129 if (!relaxed_regex_compiled_) {
192 648 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 648 times.
✗ Branch 2 not taken.
 648 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 648 times.
✗ Branch 3 not taken.
 648 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 648 times.
✗ Branch 2 not taken.
 648 relaxed_regex_ = CompileRegularExpression(regex);
198 648 relaxed_regex_compiled_ = true;
199 648 }
200
201 6129 return relaxed_regex_;
202 }
203
204 2635 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 2635 times.
✗ Branch 3 not taken.
 2635 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 2154 times.
✓ Branch 2 taken 481 times.
 2635 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 2154 times.
✗ Branch 2 not taken.
 2154 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 2635 ElementPatterns::const_iterator i = patterns_.begin();
216 2635 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 5647 times.
✓ Branch 3 taken 2635 times.
 8282 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 5647 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 5647 times.
✗ Branch 6 not taken.
 5647 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 3012 times.
✓ Branch 3 taken 2635 times.
 5647 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 3012 times.
✗ Branch 2 not taken.
 3012 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 54 times.
✓ Branch 1 taken 2581 times.
 2635 if (is_prefix) {
225
1/2
✓ Branch 1 taken 54 times.
✗ Branch 2 not taken.
 54 regex += "($|";
226
1/2
✓ Branch 1 taken 54 times.
✗ Branch 2 not taken.
 54 regex += kSeparator;
227
1/2
✓ Branch 1 taken 54 times.
✗ Branch 2 not taken.
 54 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 2581 times.
✗ Branch 2 not taken.
 2581 regex += kSeparator;
232
1/2
✓ Branch 1 taken 2581 times.
✗ Branch 2 not taken.
 2581 regex += "?$";
233 }
234
235 5270 return regex;
236 }
237
238 2635 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 2635 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 2635 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 2635 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2635 times.
 2635 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 2635 return result;
249 }
250
251 7903 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 1933 times.
✓ Branch 1 taken 5970 times.
 7903 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1933 times.
 1933 assert(regex_ != NULL);
254 1933 regfree(regex_);
255 1933 regex_ = NULL;
256 1933 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 648 times.
✓ Branch 1 taken 7255 times.
 7903 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 648 times.
 648 assert(relaxed_regex_ != NULL);
261 648 regfree(relaxed_regex_);
262 648 relaxed_regex_ = NULL;
263 648 relaxed_regex_compiled_ = false;
264 }
265 7903 }
266
267 2118 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 1278 times.
✗ Branch 5 not taken.
 3396 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 1278 times.
✓ Branch 1 taken 840 times.
✓ Branch 4 taken 99 times.
✓ Branch 5 taken 1179 times.
✓ Branch 6 taken 939 times.
✓ Branch 7 taken 1179 times.
 3396 || IsAbsolute() != other.IsAbsolute()) {
270 939 return false;
271 }
272
273 1179 ElementPatterns::const_iterator i = patterns_.begin();
274 1179 const ElementPatterns::const_iterator iend = patterns_.end();
275 1179 ElementPatterns::const_iterator j = other.patterns_.begin();
276 1179 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 2442 times.
✓ Branch 4 taken 420 times.
✓ Branch 6 taken 2442 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 2442 times.
✓ Branch 9 taken 420 times.
 2862 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 2442 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 759 times.
✓ Branch 6 taken 1683 times.
 2442 if (*i != *j) {
280 759 return false;
281 }
282 }
283
284 420 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 448 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 448 times.
✗ Branch 1 not taken.
 448 if (!glob_string_sequence_compiled_) {
297 448 GenerateGlobStringSequence();
298 448 glob_string_sequence_compiled_ = true;
299 }
300 448 return glob_string_sequence_;
301 }
302
303
304 448 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 448 times.
 448 assert(glob_string_sequence_.empty());
306 448 ElementPatterns::const_iterator i = patterns_.begin();
307 448 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 896 times.
✓ Branch 3 taken 448 times.
 1344 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 896 times.
✗ Branch 3 not taken.
 896 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 896 times.
✗ Branch 2 not taken.
 896 glob_string_sequence_.push_back(glob_string);
311 896 }
312 448 }
313
314
315 610 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 448 times.
✓ Branch 1 taken 162 times.
 610 if (!glob_string_compiled_) {
317 448 GenerateGlobString();
318 448 glob_string_compiled_ = true;
319 }
320 610 return glob_string_;
321 }
322
323
324 448 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 448 times.
 448 assert(glob_string_.empty());
326
327 448 bool is_first = true;
328
1/2
✓ Branch 1 taken 448 times.
✗ Branch 2 not taken.
 448 const GlobStringSequence &seq = GetGlobStringSequence();
329 448 GlobStringSequence::const_iterator i = seq.begin();
330 448 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 896 times.
✓ Branch 2 taken 448 times.
 1344 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 448 times.
✓ Branch 1 taken 448 times.
✓ Branch 3 taken 292 times.
✓ Branch 4 taken 156 times.
✓ Branch 5 taken 740 times.
✓ Branch 6 taken 156 times.
 896 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 740 times.
✗ Branch 2 not taken.
 740 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 896 times.
✗ Branch 3 not taken.
 896 glob_string_ += *i;
336 896 is_first = false;
337 }
338 448 }
339