GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2025-11-02 02:35:35
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 6324 Pathspec::Pathspec(const std::string &spec)
13 6324 : regex_(NULL)
14 6324 , relaxed_regex_(NULL)
15 6324 , prefix_regex_(NULL)
16 6324 , regex_compiled_(false)
17 6324 , relaxed_regex_compiled_(false)
18 6324 , prefix_regex_compiled_(false)
19 6324 , glob_string_compiled_(false)
20 6324 , glob_string_sequence_compiled_(false)
21 6324 , valid_(true)
22 6324 , absolute_(false) {
23
1/2
✓ Branch 1 taken 6324 times.
✗ Branch 2 not taken.
 6324 Parse(spec);
24
2/2
✓ Branch 1 taken 43 times.
✓ Branch 2 taken 6281 times.
 6324 if (patterns_.size() == 0) {
25 43 valid_ = false;
26 }
27
28 6324 ElementPatterns::const_iterator i = patterns_.begin();
29 6324 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 13743 times.
✓ Branch 3 taken 6324 times.
 20067 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 73 times.
✓ Branch 3 taken 13670 times.
 13743 if (!i->IsValid()) {
32 73 valid_ = false;
33 }
34 }
35 6324 }
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 5741 Pathspec::Pathspec(const Pathspec &other)
40 5741 : patterns_(other.patterns_)
41 5741 , regex_(NULL)
42 5741 , relaxed_regex_(NULL)
43 5741 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 5741 times.
✗ Branch 2 not taken.
 5741 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 5741 times.
✗ Branch 2 not taken.
 5741 , glob_string_sequence_(other.glob_string_sequence_)
46 5741 , regex_compiled_(false)
47 5741 , relaxed_regex_compiled_(false)
48 5741 , prefix_regex_compiled_(false)
49 5741 , glob_string_compiled_(other.glob_string_compiled_)
50 5741 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 5741 , valid_(other.valid_)
52 5741 , absolute_(other.absolute_) { }
53
54 12062 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 129 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 129 times.
✗ Branch 1 not taken.
 129 if (this != &other) {
58 129 DestroyRegularExpressions(); // see: copy c'tor for details
59 129 patterns_ = other.patterns_;
60
61 129 glob_string_compiled_ = other.glob_string_compiled_;
62 129 glob_string_ = other.glob_string_;
63
64 129 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 129 glob_string_sequence_ = other.glob_string_sequence_;
66
67 129 valid_ = other.valid_;
68 129 absolute_ = other.absolute_;
69 }
70
71 129 return *this;
72 }
73
74
75 6324 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 6324 std::string::const_iterator itr = spec.begin();
80 6324 const std::string::const_iterator end = spec.end();
81
82 6324 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 25912 times.
✓ Branch 2 taken 6324 times.
 32236 while (itr != end) {
84
2/2
✓ Branch 1 taken 12169 times.
✓ Branch 2 taken 13743 times.
 25912 if (*itr == kSeparator) {
85 12169 ++itr;
86 12169 continue;
87 }
88
1/2
✓ Branch 1 taken 13743 times.
✗ Branch 2 not taken.
 13743 ParsePathElement(end, &itr);
89 }
90 6324 }
91
92 13743 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 13743 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 67095 times.
✓ Branch 2 taken 6034 times.
✓ Branch 4 taken 59386 times.
✓ Branch 5 taken 7709 times.
✓ Branch 6 taken 59386 times.
✓ Branch 7 taken 13743 times.
 73129 while (*itr != end && **itr != kSeparator) {
97 59386 ++(*itr);
98 }
99 13743 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 13743 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 13743 times.
✗ Branch 5 not taken.
 13743 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 13743 }
104
105 15695 bool Pathspec::IsMatching(const std::string &query_path) const {
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 15695 times.
 15695 assert(IsValid());
107
108
2/2
✓ Branch 1 taken 614 times.
✓ Branch 2 taken 15081 times.
 15695 if (query_path.empty()) {
109 614 return false;
110 }
111
112 15081 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 10751 times.
✓ Branch 2 taken 559 times.
 11310 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 11310 times.
✓ Branch 1 taken 3771 times.
✓ Branch 3 taken 5905 times.
✓ Branch 4 taken 8617 times.
 26391 && IsPathspecMatching(query_path);
115 }
116
117 528 bool Pathspec::IsPrefixMatching(const std::string &query_path) const {
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 528 times.
 528 assert(IsValid());
119
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 528 times.
 528 assert(IsAbsolute());
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 528 times.
 528 if (query_path.empty()) {
122 ✗ return false;
123 }
124
125 528 const bool query_is_absolute = (query_path[0] == kSeparator);
126
4/4
✓ Branch 0 taken 484 times.
✓ Branch 1 taken 44 times.
✓ Branch 3 taken 308 times.
✓ Branch 4 taken 176 times.
 528 return (query_is_absolute && IsPathspecPrefixMatching(query_path));
127 }
128
129 10584 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 10584 times.
 10584 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 1224 times.
✓ Branch 2 taken 9360 times.
 10584 if (query_path.empty()) {
133 1224 return false;
134 }
135
136 9360 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 14522 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 14522 return ApplyRegularExpression(query_path, GetRegularExpression());
141 }
142
143 484 bool Pathspec::IsPathspecPrefixMatching(const std::string &query_path) const {
144 484 return ApplyRegularExpression(query_path, GetPrefixRegularExpression());
145 }
146
147 9360 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 9360 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 24366 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 24366 const char *path = query_path.c_str();
154 24366 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 16279 times.
✓ Branch 1 taken 8087 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 16279 times.
 24366 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 24366 return (retval == 0);
161 }
162
163 14522 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 2943 times.
✓ Branch 1 taken 11579 times.
 14522 if (!regex_compiled_) {
165 2943 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 2943 times.
✗ Branch 2 not taken.
 2943 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 2943 times.
✗ Branch 3 not taken.
 2943 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 2943 times.
✗ Branch 2 not taken.
 2943 regex_ = CompileRegularExpression(regex);
170 2943 regex_compiled_ = true;
171 2943 }
172
173 14522 return regex_;
174 }
175
176 484 regex_t *Pathspec::GetPrefixRegularExpression() const {
177
2/2
✓ Branch 0 taken 88 times.
✓ Branch 1 taken 396 times.
 484 if (!prefix_regex_compiled_) {
178 88 const bool is_relaxed = false;
179 88 const bool is_prefix = true;
180
1/2
✓ Branch 1 taken 88 times.
✗ Branch 2 not taken.
 88 const std::string regex = GenerateRegularExpression(is_relaxed, is_prefix);
181
1/2
✓ Branch 2 taken 88 times.
✗ Branch 3 not taken.
 88 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
182
183
1/2
✓ Branch 1 taken 88 times.
✗ Branch 2 not taken.
 88 prefix_regex_ = CompileRegularExpression(regex);
184 88 prefix_regex_compiled_ = true;
185 88 }
186
187 484 return prefix_regex_;
188 }
189
190 9360 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 997 times.
✓ Branch 1 taken 8363 times.
 9360 if (!relaxed_regex_compiled_) {
192 997 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 997 times.
✗ Branch 2 not taken.
 997 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 997 times.
✗ Branch 3 not taken.
 997 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 997 times.
✗ Branch 2 not taken.
 997 relaxed_regex_ = CompileRegularExpression(regex);
198 997 relaxed_regex_compiled_ = true;
199 997 }
200
201 9360 return relaxed_regex_;
202 }
203
204 4028 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 4028 times.
✗ Branch 3 not taken.
 4028 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 3257 times.
✓ Branch 2 taken 771 times.
 4028 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 3257 times.
✗ Branch 2 not taken.
 3257 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 4028 ElementPatterns::const_iterator i = patterns_.begin();
216 4028 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 8636 times.
✓ Branch 3 taken 4028 times.
 12664 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 8636 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 8636 times.
✗ Branch 6 not taken.
 8636 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 4608 times.
✓ Branch 3 taken 4028 times.
 8636 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 4608 times.
✗ Branch 2 not taken.
 4608 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 88 times.
✓ Branch 1 taken 3940 times.
 4028 if (is_prefix) {
225
1/2
✓ Branch 1 taken 88 times.
✗ Branch 2 not taken.
 88 regex += "($|";
226
1/2
✓ Branch 1 taken 88 times.
✗ Branch 2 not taken.
 88 regex += kSeparator;
227
1/2
✓ Branch 1 taken 88 times.
✗ Branch 2 not taken.
 88 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 3940 times.
✗ Branch 2 not taken.
 3940 regex += kSeparator;
232
1/2
✓ Branch 1 taken 3940 times.
✗ Branch 2 not taken.
 3940 regex += "?$";
233 }
234
235 8056 return regex;
236 }
237
238 4028 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 4028 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 4028 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 4028 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4028 times.
 4028 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 4028 return result;
249 }
250
251 12191 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 2943 times.
✓ Branch 1 taken 9248 times.
 12191 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2943 times.
 2943 assert(regex_ != NULL);
254 2943 regfree(regex_);
255 2943 regex_ = NULL;
256 2943 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 997 times.
✓ Branch 1 taken 11194 times.
 12191 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 997 times.
 997 assert(relaxed_regex_ != NULL);
261 997 regfree(relaxed_regex_);
262 997 relaxed_regex_ = NULL;
263 997 relaxed_regex_compiled_ = false;
264 }
265 12191 }
266
267 3245 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 2058 times.
✗ Branch 5 not taken.
 5303 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 2058 times.
✓ Branch 1 taken 1187 times.
✓ Branch 4 taken 164 times.
✓ Branch 5 taken 1894 times.
✓ Branch 6 taken 1351 times.
✓ Branch 7 taken 1894 times.
 5303 || IsAbsolute() != other.IsAbsolute()) {
270 1351 return false;
271 }
272
273 1894 ElementPatterns::const_iterator i = patterns_.begin();
274 1894 const ElementPatterns::const_iterator iend = patterns_.end();
275 1894 ElementPatterns::const_iterator j = other.patterns_.begin();
276 1894 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 3950 times.
✓ Branch 4 taken 674 times.
✓ Branch 6 taken 3950 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 3950 times.
✓ Branch 9 taken 674 times.
 4624 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 3950 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 1220 times.
✓ Branch 6 taken 2730 times.
 3950 if (*i != *j) {
280 1220 return false;
281 }
282 }
283
284 674 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 731 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 731 times.
✗ Branch 1 not taken.
 731 if (!glob_string_sequence_compiled_) {
297 731 GenerateGlobStringSequence();
298 731 glob_string_sequence_compiled_ = true;
299 }
300 731 return glob_string_sequence_;
301 }
302
303
304 731 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 731 times.
 731 assert(glob_string_sequence_.empty());
306 731 ElementPatterns::const_iterator i = patterns_.begin();
307 731 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 1462 times.
✓ Branch 3 taken 731 times.
 2193 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 1462 times.
✗ Branch 3 not taken.
 1462 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 1462 times.
✗ Branch 2 not taken.
 1462 glob_string_sequence_.push_back(glob_string);
311 1462 }
312 731 }
313
314
315 989 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 731 times.
✓ Branch 1 taken 258 times.
 989 if (!glob_string_compiled_) {
317 731 GenerateGlobString();
318 731 glob_string_compiled_ = true;
319 }
320 989 return glob_string_;
321 }
322
323
324 731 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 731 times.
 731 assert(glob_string_.empty());
326
327 731 bool is_first = true;
328
1/2
✓ Branch 1 taken 731 times.
✗ Branch 2 not taken.
 731 const GlobStringSequence &seq = GetGlobStringSequence();
329 731 GlobStringSequence::const_iterator i = seq.begin();
330 731 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 1462 times.
✓ Branch 2 taken 731 times.
 2193 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 731 times.
✓ Branch 1 taken 731 times.
✓ Branch 3 taken 473 times.
✓ Branch 4 taken 258 times.
✓ Branch 5 taken 1204 times.
✓ Branch 6 taken 258 times.
 1462 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 1204 times.
✗ Branch 2 not taken.
 1204 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 1462 times.
✗ Branch 3 not taken.
 1462 glob_string_ += *i;
336 1462 is_first = false;
337 }
338 731 }
339