GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2025-09-28 02:35:26
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 4696 Pathspec::Pathspec(const std::string &spec)
13 4696 : regex_(NULL)
14 4696 , relaxed_regex_(NULL)
15 4696 , prefix_regex_(NULL)
16 4696 , regex_compiled_(false)
17 4696 , relaxed_regex_compiled_(false)
18 4696 , prefix_regex_compiled_(false)
19 4696 , glob_string_compiled_(false)
20 4696 , glob_string_sequence_compiled_(false)
21 4696 , valid_(true)
22 4696 , absolute_(false) {
23
1/2
✓ Branch 1 taken 4696 times.
✗ Branch 2 not taken.
 4696 Parse(spec);
24
2/2
✓ Branch 1 taken 33 times.
✓ Branch 2 taken 4663 times.
 4696 if (patterns_.size() == 0) {
25 33 valid_ = false;
26 }
27
28 4696 ElementPatterns::const_iterator i = patterns_.begin();
29 4696 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 10370 times.
✓ Branch 3 taken 4696 times.
 15066 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 74 times.
✓ Branch 3 taken 10296 times.
 10370 if (!i->IsValid()) {
32 74 valid_ = false;
33 }
34 }
35 4696 }
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 3797 Pathspec::Pathspec(const Pathspec &other)
40 3797 : patterns_(other.patterns_)
41 3797 , regex_(NULL)
42 3797 , relaxed_regex_(NULL)
43 3797 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 3797 times.
✗ Branch 2 not taken.
 3797 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 3797 times.
✗ Branch 2 not taken.
 3797 , glob_string_sequence_(other.glob_string_sequence_)
46 3797 , regex_compiled_(false)
47 3797 , relaxed_regex_compiled_(false)
48 3797 , prefix_regex_compiled_(false)
49 3797 , glob_string_compiled_(other.glob_string_compiled_)
50 3797 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 3797 , valid_(other.valid_)
52 3797 , absolute_(other.absolute_) { }
53
54 8490 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 99 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 99 times.
✗ Branch 1 not taken.
 99 if (this != &other) {
58 99 DestroyRegularExpressions(); // see: copy c'tor for details
59 99 patterns_ = other.patterns_;
60
61 99 glob_string_compiled_ = other.glob_string_compiled_;
62 99 glob_string_ = other.glob_string_;
63
64 99 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 99 glob_string_sequence_ = other.glob_string_sequence_;
66
67 99 valid_ = other.valid_;
68 99 absolute_ = other.absolute_;
69 }
70
71 99 return *this;
72 }
73
74
75 4696 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 4696 std::string::const_iterator itr = spec.begin();
80 4696 const std::string::const_iterator end = spec.end();
81
82 4696 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 19360 times.
✓ Branch 2 taken 4696 times.
 24056 while (itr != end) {
84
2/2
✓ Branch 1 taken 8990 times.
✓ Branch 2 taken 10370 times.
 19360 if (*itr == kSeparator) {
85 8990 ++itr;
86 8990 continue;
87 }
88
1/2
✓ Branch 1 taken 10370 times.
✗ Branch 2 not taken.
 10370 ParsePathElement(end, &itr);
89 }
90 4696 }
91
92 10370 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 10370 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 48403 times.
✓ Branch 2 taken 4624 times.
✓ Branch 4 taken 42657 times.
✓ Branch 5 taken 5746 times.
✓ Branch 6 taken 42657 times.
✓ Branch 7 taken 10370 times.
 53027 while (*itr != end && **itr != kSeparator) {
97 42657 ++(*itr);
98 }
99 10370 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 10370 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 10370 times.
✗ Branch 5 not taken.
 10370 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 10370 }
104
105 9745 bool Pathspec::IsMatching(const std::string &query_path) const {
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 9745 times.
 9745 assert(IsValid());
107
108
2/2
✓ Branch 1 taken 145 times.
✓ Branch 2 taken 9600 times.
 9745 if (query_path.empty()) {
109 145 return false;
110 }
111
112 9600 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 6219 times.
✓ Branch 2 taken 426 times.
 6645 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 6645 times.
✓ Branch 1 taken 2955 times.
✓ Branch 3 taken 4449 times.
✓ Branch 4 taken 4725 times.
 16245 && IsPathspecMatching(query_path);
115 }
116
117 396 bool Pathspec::IsPrefixMatching(const std::string &query_path) const {
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 396 times.
 396 assert(IsValid());
119
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 396 times.
 396 assert(IsAbsolute());
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 396 times.
 396 if (query_path.empty()) {
122 ✗ return false;
123 }
124
125 396 const bool query_is_absolute = (query_path[0] == kSeparator);
126
4/4
✓ Branch 0 taken 363 times.
✓ Branch 1 taken 33 times.
✓ Branch 3 taken 231 times.
✓ Branch 4 taken 132 times.
 396 return (query_is_absolute && IsPathspecPrefixMatching(query_path));
127 }
128
129 6587 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 6587 times.
 6587 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 36 times.
✓ Branch 2 taken 6551 times.
 6587 if (query_path.empty()) {
133 36 return false;
134 }
135
136 6551 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 9174 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 9174 return ApplyRegularExpression(query_path, GetRegularExpression());
141 }
142
143 363 bool Pathspec::IsPathspecPrefixMatching(const std::string &query_path) const {
144 363 return ApplyRegularExpression(query_path, GetPrefixRegularExpression());
145 }
146
147 6551 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 6551 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 16088 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 16088 const char *path = query_path.c_str();
154 16088 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 9726 times.
✓ Branch 1 taken 6362 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 9726 times.
 16088 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 16088 return (retval == 0);
161 }
162
163 9174 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 1814 times.
✓ Branch 1 taken 7360 times.
 9174 if (!regex_compiled_) {
165 1814 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 1814 times.
✗ Branch 2 not taken.
 1814 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 1814 times.
✗ Branch 3 not taken.
 1814 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 1814 times.
✗ Branch 2 not taken.
 1814 regex_ = CompileRegularExpression(regex);
170 1814 regex_compiled_ = true;
171 1814 }
172
173 9174 return regex_;
174 }
175
176 363 regex_t *Pathspec::GetPrefixRegularExpression() const {
177
2/2
✓ Branch 0 taken 66 times.
✓ Branch 1 taken 297 times.
 363 if (!prefix_regex_compiled_) {
178 66 const bool is_relaxed = false;
179 66 const bool is_prefix = true;
180
1/2
✓ Branch 1 taken 66 times.
✗ Branch 2 not taken.
 66 const std::string regex = GenerateRegularExpression(is_relaxed, is_prefix);
181
1/2
✓ Branch 2 taken 66 times.
✗ Branch 3 not taken.
 66 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
182
183
1/2
✓ Branch 1 taken 66 times.
✗ Branch 2 not taken.
 66 prefix_regex_ = CompileRegularExpression(regex);
184 66 prefix_regex_compiled_ = true;
185 66 }
186
187 363 return prefix_regex_;
188 }
189
190 6551 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 703 times.
✓ Branch 1 taken 5848 times.
 6551 if (!relaxed_regex_compiled_) {
192 703 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 703 times.
✗ Branch 2 not taken.
 703 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 703 times.
✗ Branch 3 not taken.
 703 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 703 times.
✗ Branch 2 not taken.
 703 relaxed_regex_ = CompileRegularExpression(regex);
198 703 relaxed_regex_compiled_ = true;
199 703 }
200
201 6551 return relaxed_regex_;
202 }
203
204 2583 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 2583 times.
✗ Branch 3 not taken.
 2583 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 2006 times.
✓ Branch 2 taken 577 times.
 2583 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 2006 times.
✗ Branch 2 not taken.
 2006 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 2583 ElementPatterns::const_iterator i = patterns_.begin();
216 2583 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 5593 times.
✓ Branch 3 taken 2583 times.
 8176 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 5593 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 5593 times.
✗ Branch 6 not taken.
 5593 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 3010 times.
✓ Branch 3 taken 2583 times.
 5593 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 3010 times.
✗ Branch 2 not taken.
 3010 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 66 times.
✓ Branch 1 taken 2517 times.
 2583 if (is_prefix) {
225
1/2
✓ Branch 1 taken 66 times.
✗ Branch 2 not taken.
 66 regex += "($|";
226
1/2
✓ Branch 1 taken 66 times.
✗ Branch 2 not taken.
 66 regex += kSeparator;
227
1/2
✓ Branch 1 taken 66 times.
✗ Branch 2 not taken.
 66 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 2517 times.
✗ Branch 2 not taken.
 2517 regex += kSeparator;
232
1/2
✓ Branch 1 taken 2517 times.
✗ Branch 2 not taken.
 2517 regex += "?$";
233 }
234
235 5166 return regex;
236 }
237
238 2583 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 2583 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 2583 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 2583 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2583 times.
 2583 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 2583 return result;
249 }
250
251 8589 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 1814 times.
✓ Branch 1 taken 6775 times.
 8589 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1814 times.
 1814 assert(regex_ != NULL);
254 1814 regfree(regex_);
255 1814 regex_ = NULL;
256 1814 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 703 times.
✓ Branch 1 taken 7886 times.
 8589 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 703 times.
 703 assert(relaxed_regex_ != NULL);
261 703 regfree(relaxed_regex_);
262 703 relaxed_regex_ = NULL;
263 703 relaxed_regex_compiled_ = false;
264 }
265 8589 }
266
267 2250 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 1710 times.
✗ Branch 5 not taken.
 3960 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 1710 times.
✓ Branch 1 taken 540 times.
✓ Branch 4 taken 157 times.
✓ Branch 5 taken 1553 times.
✓ Branch 6 taken 697 times.
✓ Branch 7 taken 1553 times.
 3960 || IsAbsolute() != other.IsAbsolute()) {
270 697 return false;
271 }
272
273 1553 ElementPatterns::const_iterator i = patterns_.begin();
274 1553 const ElementPatterns::const_iterator iend = patterns_.end();
275 1553 ElementPatterns::const_iterator j = other.patterns_.begin();
276 1553 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 3318 times.
✓ Branch 4 taken 536 times.
✓ Branch 6 taken 3318 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 3318 times.
✓ Branch 9 taken 536 times.
 3854 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 3318 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 1017 times.
✓ Branch 6 taken 2301 times.
 3318 if (*i != *j) {
280 1017 return false;
281 }
282 }
283
284 536 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 561 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 561 times.
✗ Branch 1 not taken.
 561 if (!glob_string_sequence_compiled_) {
297 561 GenerateGlobStringSequence();
298 561 glob_string_sequence_compiled_ = true;
299 }
300 561 return glob_string_sequence_;
301 }
302
303
304 561 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 561 times.
 561 assert(glob_string_sequence_.empty());
306 561 ElementPatterns::const_iterator i = patterns_.begin();
307 561 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 1122 times.
✓ Branch 3 taken 561 times.
 1683 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 1122 times.
✗ Branch 3 not taken.
 1122 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 1122 times.
✗ Branch 2 not taken.
 1122 glob_string_sequence_.push_back(glob_string);
311 1122 }
312 561 }
313
314
315 759 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 561 times.
✓ Branch 1 taken 198 times.
 759 if (!glob_string_compiled_) {
317 561 GenerateGlobString();
318 561 glob_string_compiled_ = true;
319 }
320 759 return glob_string_;
321 }
322
323
324 561 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 561 times.
 561 assert(glob_string_.empty());
326
327 561 bool is_first = true;
328
1/2
✓ Branch 1 taken 561 times.
✗ Branch 2 not taken.
 561 const GlobStringSequence &seq = GetGlobStringSequence();
329 561 GlobStringSequence::const_iterator i = seq.begin();
330 561 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 1122 times.
✓ Branch 2 taken 561 times.
 1683 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 561 times.
✓ Branch 1 taken 561 times.
✓ Branch 3 taken 363 times.
✓ Branch 4 taken 198 times.
✓ Branch 5 taken 924 times.
✓ Branch 6 taken 198 times.
 1122 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 924 times.
✗ Branch 2 not taken.
 924 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 1122 times.
✗ Branch 3 not taken.
 1122 glob_string_ += *i;
336 1122 is_first = false;
337 }
338 561 }
339