GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2025-10-19 02:35:28
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 6350 Pathspec::Pathspec(const std::string &spec)
13 6350 : regex_(NULL)
14 6350 , relaxed_regex_(NULL)
15 6350 , prefix_regex_(NULL)
16 6350 , regex_compiled_(false)
17 6350 , relaxed_regex_compiled_(false)
18 6350 , prefix_regex_compiled_(false)
19 6350 , glob_string_compiled_(false)
20 6350 , glob_string_sequence_compiled_(false)
21 6350 , valid_(true)
22 6350 , absolute_(false) {
23
1/2
✓ Branch 1 taken 6350 times.
✗ Branch 2 not taken.
 6350 Parse(spec);
24
2/2
✓ Branch 1 taken 43 times.
✓ Branch 2 taken 6307 times.
 6350 if (patterns_.size() == 0) {
25 43 valid_ = false;
26 }
27
28 6350 ElementPatterns::const_iterator i = patterns_.begin();
29 6350 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 13900 times.
✓ Branch 3 taken 6350 times.
 20250 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 83 times.
✓ Branch 3 taken 13817 times.
 13900 if (!i->IsValid()) {
32 83 valid_ = false;
33 }
34 }
35 6350 }
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 5629 Pathspec::Pathspec(const Pathspec &other)
40 5629 : patterns_(other.patterns_)
41 5629 , regex_(NULL)
42 5629 , relaxed_regex_(NULL)
43 5629 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 5629 times.
✗ Branch 2 not taken.
 5629 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 5629 times.
✗ Branch 2 not taken.
 5629 , glob_string_sequence_(other.glob_string_sequence_)
46 5629 , regex_compiled_(false)
47 5629 , relaxed_regex_compiled_(false)
48 5629 , prefix_regex_compiled_(false)
49 5629 , glob_string_compiled_(other.glob_string_compiled_)
50 5629 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 5629 , valid_(other.valid_)
52 5629 , absolute_(other.absolute_) { }
53
54 11976 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 132 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 132 times.
✗ Branch 1 not taken.
 132 if (this != &other) {
58 132 DestroyRegularExpressions(); // see: copy c'tor for details
59 132 patterns_ = other.patterns_;
60
61 132 glob_string_compiled_ = other.glob_string_compiled_;
62 132 glob_string_ = other.glob_string_;
63
64 132 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 132 glob_string_sequence_ = other.glob_string_sequence_;
66
67 132 valid_ = other.valid_;
68 132 absolute_ = other.absolute_;
69 }
70
71 132 return *this;
72 }
73
74
75 6350 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 6350 std::string::const_iterator itr = spec.begin();
80 6350 const std::string::const_iterator end = spec.end();
81
82 6350 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 26122 times.
✓ Branch 2 taken 6350 times.
 32472 while (itr != end) {
84
2/2
✓ Branch 1 taken 12222 times.
✓ Branch 2 taken 13900 times.
 26122 if (*itr == kSeparator) {
85 12222 ++itr;
86 12222 continue;
87 }
88
1/2
✓ Branch 1 taken 13900 times.
✗ Branch 2 not taken.
 13900 ParsePathElement(end, &itr);
89 }
90 6350 }
91
92 13900 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 13900 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 66614 times.
✓ Branch 2 taken 6132 times.
✓ Branch 4 taken 58846 times.
✓ Branch 5 taken 7768 times.
✓ Branch 6 taken 58846 times.
✓ Branch 7 taken 13900 times.
 72746 while (*itr != end && **itr != kSeparator) {
97 58846 ++(*itr);
98 }
99 13900 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 13900 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 13900 times.
✗ Branch 5 not taken.
 13900 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 13900 }
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 458 times.
✓ Branch 2 taken 14343 times.
 14801 if (query_path.empty()) {
109 458 return false;
110 }
111
112 14343 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 9931 times.
✓ Branch 2 taken 560 times.
 10491 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 10491 times.
✓ Branch 1 taken 3852 times.
✓ Branch 3 taken 5961 times.
✓ Branch 4 taken 7822 times.
 24834 && 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 10113 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 10113 times.
 10113 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 792 times.
✓ Branch 2 taken 9321 times.
 10113 if (query_path.empty()) {
133 792 return false;
134 }
135
136 9321 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 13783 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 13783 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 9321 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 9321 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 23588 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 23588 const char *path = query_path.c_str();
154 23588 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 15272 times.
✓ Branch 1 taken 8316 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 15272 times.
 23588 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 23588 return (retval == 0);
161 }
162
163 13783 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 2767 times.
✓ Branch 1 taken 11016 times.
 13783 if (!regex_compiled_) {
165 2767 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 2767 times.
✗ Branch 2 not taken.
 2767 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 2767 times.
✗ Branch 3 not taken.
 2767 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 2767 times.
✗ Branch 2 not taken.
 2767 regex_ = CompileRegularExpression(regex);
170 2767 regex_compiled_ = true;
171 2767 }
172
173 13783 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 9321 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 991 times.
✓ Branch 1 taken 8330 times.
 9321 if (!relaxed_regex_compiled_) {
192 991 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 991 times.
✗ Branch 2 not taken.
 991 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 991 times.
✗ Branch 3 not taken.
 991 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 991 times.
✗ Branch 2 not taken.
 991 relaxed_regex_ = CompileRegularExpression(regex);
198 991 relaxed_regex_compiled_ = true;
199 991 }
200
201 9321 return relaxed_regex_;
202 }
203
204 3846 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 3846 times.
✗ Branch 3 not taken.
 3846 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 3068 times.
✓ Branch 2 taken 778 times.
 3846 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 3068 times.
✗ Branch 2 not taken.
 3068 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 3846 ElementPatterns::const_iterator i = patterns_.begin();
216 3846 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 8282 times.
✓ Branch 3 taken 3846 times.
 12128 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 8282 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 8282 times.
✗ Branch 6 not taken.
 8282 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 4436 times.
✓ Branch 3 taken 3846 times.
 8282 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 4436 times.
✗ Branch 2 not taken.
 4436 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 88 times.
✓ Branch 1 taken 3758 times.
 3846 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 3758 times.
✗ Branch 2 not taken.
 3758 regex += kSeparator;
232
1/2
✓ Branch 1 taken 3758 times.
✗ Branch 2 not taken.
 3758 regex += "?$";
233 }
234
235 7692 return regex;
236 }
237
238 3846 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 3846 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 3846 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 3846 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3846 times.
 3846 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 3846 return result;
249 }
250
251 12108 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 2767 times.
✓ Branch 1 taken 9341 times.
 12108 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2767 times.
 2767 assert(regex_ != NULL);
254 2767 regfree(regex_);
255 2767 regex_ = NULL;
256 2767 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 991 times.
✓ Branch 1 taken 11117 times.
 12108 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 991 times.
 991 assert(relaxed_regex_ != NULL);
261 991 regfree(relaxed_regex_);
262 991 relaxed_regex_ = NULL;
263 991 relaxed_regex_compiled_ = false;
264 }
265 12108 }
266
267 3183 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 2151 times.
✗ Branch 5 not taken.
 5334 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 2151 times.
✓ Branch 1 taken 1032 times.
✓ Branch 4 taken 185 times.
✓ Branch 5 taken 1966 times.
✓ Branch 6 taken 1217 times.
✓ Branch 7 taken 1966 times.
 5334 || IsAbsolute() != other.IsAbsolute()) {
270 1217 return false;
271 }
272
273 1966 ElementPatterns::const_iterator i = patterns_.begin();
274 1966 const ElementPatterns::const_iterator iend = patterns_.end();
275 1966 ElementPatterns::const_iterator j = other.patterns_.begin();
276 1966 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 4140 times.
✓ Branch 4 taken 685 times.
✓ Branch 6 taken 4140 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 4140 times.
✓ Branch 9 taken 685 times.
 4825 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 4140 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 1281 times.
✓ Branch 6 taken 2859 times.
 4140 if (*i != *j) {
280 1281 return false;
281 }
282 }
283
284 685 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 735 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 735 times.
✗ Branch 1 not taken.
 735 if (!glob_string_sequence_compiled_) {
297 735 GenerateGlobStringSequence();
298 735 glob_string_sequence_compiled_ = true;
299 }
300 735 return glob_string_sequence_;
301 }
302
303
304 735 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 735 times.
 735 assert(glob_string_sequence_.empty());
306 735 ElementPatterns::const_iterator i = patterns_.begin();
307 735 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 1470 times.
✓ Branch 3 taken 735 times.
 2205 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 1470 times.
✗ Branch 3 not taken.
 1470 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 1470 times.
✗ Branch 2 not taken.
 1470 glob_string_sequence_.push_back(glob_string);
311 1470 }
312 735 }
313
314
315 996 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 735 times.
✓ Branch 1 taken 261 times.
 996 if (!glob_string_compiled_) {
317 735 GenerateGlobString();
318 735 glob_string_compiled_ = true;
319 }
320 996 return glob_string_;
321 }
322
323
324 735 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 735 times.
 735 assert(glob_string_.empty());
326
327 735 bool is_first = true;
328
1/2
✓ Branch 1 taken 735 times.
✗ Branch 2 not taken.
 735 const GlobStringSequence &seq = GetGlobStringSequence();
329 735 GlobStringSequence::const_iterator i = seq.begin();
330 735 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 1470 times.
✓ Branch 2 taken 735 times.
 2205 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 735 times.
✓ Branch 1 taken 735 times.
✓ Branch 3 taken 477 times.
✓ Branch 4 taken 258 times.
✓ Branch 5 taken 1212 times.
✓ Branch 6 taken 258 times.
 1470 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 1212 times.
✗ Branch 2 not taken.
 1212 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 1470 times.
✗ Branch 3 not taken.
 1470 glob_string_ += *i;
336 1470 is_first = false;
337 }
338 735 }
339