GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2026-07-26 02:35:14
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 5463 Pathspec::Pathspec(const std::string &spec)
13 5463 : regex_(NULL)
14 5463 , relaxed_regex_(NULL)
15 5463 , prefix_regex_(NULL)
16 5463 , regex_compiled_(false)
17 5463 , relaxed_regex_compiled_(false)
18 5463 , prefix_regex_compiled_(false)
19 5463 , glob_string_compiled_(false)
20 5463 , glob_string_sequence_compiled_(false)
21 5463 , valid_(true)
22 5463 , absolute_(false) {
23
1/2
✓ Branch 1 taken 5463 times.
✗ Branch 2 not taken.
 5463 Parse(spec);
24
2/2
✓ Branch 1 taken 38 times.
✓ Branch 2 taken 5425 times.
 5463 if (patterns_.size() == 0) {
25 38 valid_ = false;
26 }
27
28 5463 ElementPatterns::const_iterator i = patterns_.begin();
29 5463 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 11687 times.
✓ Branch 3 taken 5463 times.
 17150 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 45 times.
✓ Branch 3 taken 11642 times.
 11687 if (!i->IsValid()) {
32 45 valid_ = false;
33 }
34 }
35 5463 }
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 4905 Pathspec::Pathspec(const Pathspec &other)
40 4905 : patterns_(other.patterns_)
41 4905 , regex_(NULL)
42 4905 , relaxed_regex_(NULL)
43 4905 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 4905 times.
✗ Branch 2 not taken.
 4905 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 4905 times.
✗ Branch 2 not taken.
 4905 , glob_string_sequence_(other.glob_string_sequence_)
46 4905 , regex_compiled_(false)
47 4905 , relaxed_regex_compiled_(false)
48 4905 , prefix_regex_compiled_(false)
49 4905 , glob_string_compiled_(other.glob_string_compiled_)
50 4905 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 4905 , valid_(other.valid_)
52 4905 , absolute_(other.absolute_) { }
53
54 10365 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 114 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 114 times.
✗ Branch 1 not taken.
 114 if (this != &other) {
58 114 DestroyRegularExpressions(); // see: copy c'tor for details
59 114 patterns_ = other.patterns_;
60
61 114 glob_string_compiled_ = other.glob_string_compiled_;
62 114 glob_string_ = other.glob_string_;
63
64 114 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 114 glob_string_sequence_ = other.glob_string_sequence_;
66
67 114 valid_ = other.valid_;
68 114 absolute_ = other.absolute_;
69 }
70
71 114 return *this;
72 }
73
74
75 5463 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 5463 std::string::const_iterator itr = spec.begin();
80 5463 const std::string::const_iterator end = spec.end();
81
82 5463 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 22112 times.
✓ Branch 2 taken 5463 times.
 27575 while (itr != end) {
84
2/2
✓ Branch 1 taken 10425 times.
✓ Branch 2 taken 11687 times.
 22112 if (*itr == kSeparator) {
85 10425 ++itr;
86 10425 continue;
87 }
88
1/2
✓ Branch 1 taken 11687 times.
✗ Branch 2 not taken.
 11687 ParsePathElement(end, &itr);
89 }
90 5463 }
91
92 11687 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 11687 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 59703 times.
✓ Branch 2 taken 5139 times.
✓ Branch 4 taken 53155 times.
✓ Branch 5 taken 6548 times.
✓ Branch 6 taken 53155 times.
✓ Branch 7 taken 11687 times.
 64842 while (*itr != end && **itr != kSeparator) {
97 53155 ++(*itr);
98 }
99 11687 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 11687 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 11687 times.
✗ Branch 5 not taken.
 11687 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 11687 }
104
105 14801 bool Pathspec::IsMatching(const std::string &query_path) const {
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 14801 times.
 14801 assert(IsValid());
107
108
2/2
✓ Branch 1 taken 722 times.
✓ Branch 2 taken 14079 times.
 14801 if (query_path.empty()) {
109 722 return false;
110 }
111
112 14079 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 10343 times.
✓ Branch 2 taken 490 times.
 10833 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 10833 times.
✓ Branch 1 taken 3246 times.
✓ Branch 3 taken 5060 times.
✓ Branch 4 taken 8529 times.
 24912 && IsPathspecMatching(query_path);
115 }
116
117 456 bool Pathspec::IsPrefixMatching(const std::string &query_path) const {
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 456 times.
 456 assert(IsValid());
119
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 456 times.
 456 assert(IsAbsolute());
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 456 times.
 456 if (query_path.empty()) {
122 ✗ return false;
123 }
124
125 456 const bool query_is_absolute = (query_path[0] == kSeparator);
126
4/4
✓ Branch 0 taken 418 times.
✓ Branch 1 taken 38 times.
✓ Branch 3 taken 266 times.
✓ Branch 4 taken 152 times.
 456 return (query_is_absolute && IsPathspecPrefixMatching(query_path));
127 }
128
129 8623 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 8623 times.
 8623 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 1425 times.
✓ Branch 2 taken 7198 times.
 8623 if (query_path.empty()) {
133 1425 return false;
134 }
135
136 7198 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 13589 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 13589 return ApplyRegularExpression(query_path, GetRegularExpression());
141 }
142
143 418 bool Pathspec::IsPathspecPrefixMatching(const std::string &query_path) const {
144 418 return ApplyRegularExpression(query_path, GetPrefixRegularExpression());
145 }
146
147 7198 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 7198 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 21205 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 21205 const char *path = query_path.c_str();
154 21205 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 14565 times.
✓ Branch 1 taken 6640 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 14565 times.
 21205 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 21205 return (retval == 0);
161 }
162
163 13589 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 2855 times.
✓ Branch 1 taken 10734 times.
 13589 if (!regex_compiled_) {
165 2855 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 2855 times.
✗ Branch 2 not taken.
 2855 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 2855 times.
✗ Branch 3 not taken.
 2855 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 2855 times.
✗ Branch 2 not taken.
 2855 regex_ = CompileRegularExpression(regex);
170 2855 regex_compiled_ = true;
171 2855 }
172
173 13589 return regex_;
174 }
175
176 418 regex_t *Pathspec::GetPrefixRegularExpression() const {
177
2/2
✓ Branch 0 taken 76 times.
✓ Branch 1 taken 342 times.
 418 if (!prefix_regex_compiled_) {
178 76 const bool is_relaxed = false;
179 76 const bool is_prefix = true;
180
1/2
✓ Branch 1 taken 76 times.
✗ Branch 2 not taken.
 76 const std::string regex = GenerateRegularExpression(is_relaxed, is_prefix);
181
1/2
✓ Branch 2 taken 76 times.
✗ Branch 3 not taken.
 76 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
182
183
1/2
✓ Branch 1 taken 76 times.
✗ Branch 2 not taken.
 76 prefix_regex_ = CompileRegularExpression(regex);
184 76 prefix_regex_compiled_ = true;
185 76 }
186
187 418 return prefix_regex_;
188 }
189
190 7198 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 808 times.
✓ Branch 1 taken 6390 times.
 7198 if (!relaxed_regex_compiled_) {
192 808 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 808 times.
✗ Branch 2 not taken.
 808 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 808 times.
✗ Branch 3 not taken.
 808 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 808 times.
✗ Branch 2 not taken.
 808 relaxed_regex_ = CompileRegularExpression(regex);
198 808 relaxed_regex_compiled_ = true;
199 808 }
200
201 7198 return relaxed_regex_;
202 }
203
204 3739 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 3739 times.
✗ Branch 3 not taken.
 3739 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 3079 times.
✓ Branch 2 taken 660 times.
 3739 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 3079 times.
✗ Branch 2 not taken.
 3079 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 3739 ElementPatterns::const_iterator i = patterns_.begin();
216 3739 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 7991 times.
✓ Branch 3 taken 3739 times.
 11730 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 7991 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 7991 times.
✗ Branch 6 not taken.
 7991 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 4252 times.
✓ Branch 3 taken 3739 times.
 7991 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 4252 times.
✗ Branch 2 not taken.
 4252 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 76 times.
✓ Branch 1 taken 3663 times.
 3739 if (is_prefix) {
225
1/2
✓ Branch 1 taken 76 times.
✗ Branch 2 not taken.
 76 regex += "($|";
226
1/2
✓ Branch 1 taken 76 times.
✗ Branch 2 not taken.
 76 regex += kSeparator;
227
1/2
✓ Branch 1 taken 76 times.
✗ Branch 2 not taken.
 76 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 3663 times.
✗ Branch 2 not taken.
 3663 regex += kSeparator;
232
1/2
✓ Branch 1 taken 3663 times.
✗ Branch 2 not taken.
 3663 regex += "?$";
233 }
234
235 7478 return regex;
236 }
237
238 3739 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 3739 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 3739 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 3739 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3739 times.
 3739 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 3739 return result;
249 }
250
251 10479 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 2855 times.
✓ Branch 1 taken 7624 times.
 10479 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2855 times.
 2855 assert(regex_ != NULL);
254 2855 regfree(regex_);
255 2855 regex_ = NULL;
256 2855 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 808 times.
✓ Branch 1 taken 9671 times.
 10479 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 808 times.
 808 assert(relaxed_regex_ != NULL);
261 808 regfree(relaxed_regex_);
262 808 relaxed_regex_ = NULL;
263 808 relaxed_regex_compiled_ = false;
264 }
265 10479 }
266
267 2671 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 1593 times.
✗ Branch 5 not taken.
 4264 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 1593 times.
✓ Branch 1 taken 1078 times.
✓ Branch 4 taken 98 times.
✓ Branch 5 taken 1495 times.
✓ Branch 6 taken 1176 times.
✓ Branch 7 taken 1495 times.
 4264 || IsAbsolute() != other.IsAbsolute()) {
270 1176 return false;
271 }
272
273 1495 ElementPatterns::const_iterator i = patterns_.begin();
274 1495 const ElementPatterns::const_iterator iend = patterns_.end();
275 1495 ElementPatterns::const_iterator j = other.patterns_.begin();
276 1495 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 3078 times.
✓ Branch 4 taken 577 times.
✓ Branch 6 taken 3078 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 3078 times.
✓ Branch 9 taken 577 times.
 3655 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 3078 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 918 times.
✓ Branch 6 taken 2160 times.
 3078 if (*i != *j) {
280 918 return false;
281 }
282 }
283
284 577 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 646 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 646 times.
✗ Branch 1 not taken.
 646 if (!glob_string_sequence_compiled_) {
297 646 GenerateGlobStringSequence();
298 646 glob_string_sequence_compiled_ = true;
299 }
300 646 return glob_string_sequence_;
301 }
302
303
304 646 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 646 times.
 646 assert(glob_string_sequence_.empty());
306 646 ElementPatterns::const_iterator i = patterns_.begin();
307 646 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 1292 times.
✓ Branch 3 taken 646 times.
 1938 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 1292 times.
✗ Branch 3 not taken.
 1292 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 1292 times.
✗ Branch 2 not taken.
 1292 glob_string_sequence_.push_back(glob_string);
311 1292 }
312 646 }
313
314
315 874 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 646 times.
✓ Branch 1 taken 228 times.
 874 if (!glob_string_compiled_) {
317 646 GenerateGlobString();
318 646 glob_string_compiled_ = true;
319 }
320 874 return glob_string_;
321 }
322
323
324 646 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 646 times.
 646 assert(glob_string_.empty());
326
327 646 bool is_first = true;
328
1/2
✓ Branch 1 taken 646 times.
✗ Branch 2 not taken.
 646 const GlobStringSequence &seq = GetGlobStringSequence();
329 646 GlobStringSequence::const_iterator i = seq.begin();
330 646 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 1292 times.
✓ Branch 2 taken 646 times.
 1938 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 646 times.
✓ Branch 1 taken 646 times.
✓ Branch 3 taken 418 times.
✓ Branch 4 taken 228 times.
✓ Branch 5 taken 1064 times.
✓ Branch 6 taken 228 times.
 1292 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 1064 times.
✗ Branch 2 not taken.
 1064 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 1292 times.
✗ Branch 3 not taken.
 1292 glob_string_ += *i;
336 1292 is_first = false;
337 }
338 646 }
339