GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2026-10-18 02:40:11
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 6790 Pathspec::Pathspec(const std::string &spec)
13 6790 : regex_(NULL)
14 6790 , relaxed_regex_(NULL)
15 6790 , prefix_regex_(NULL)
16 6790 , regex_compiled_(false)
17 6790 , relaxed_regex_compiled_(false)
18 6790 , prefix_regex_compiled_(false)
19 6790 , glob_string_compiled_(false)
20 6790 , glob_string_sequence_compiled_(false)
21 6790 , valid_(true)
22 6790 , absolute_(false) {
23
1/2
✓ Branch 1 taken 6790 times.
✗ Branch 2 not taken.
 6790 Parse(spec);
24
2/2
✓ Branch 1 taken 35 times.
✓ Branch 2 taken 6755 times.
 6790 if (patterns_.size() == 0) {
25 35 valid_ = false;
26 }
27
28 6790 ElementPatterns::const_iterator i = patterns_.begin();
29 6790 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 14916 times.
✓ Branch 3 taken 6790 times.
 21706 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 68 times.
✓ Branch 3 taken 14848 times.
 14916 if (!i->IsValid()) {
32 68 valid_ = false;
33 }
34 }
35 6790 }
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 8834 Pathspec::Pathspec(const Pathspec &other)
40 8834 : patterns_(other.patterns_)
41 8834 , regex_(NULL)
42 8834 , relaxed_regex_(NULL)
43 8834 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 8834 times.
✗ Branch 2 not taken.
 8834 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 8834 times.
✗ Branch 2 not taken.
 8834 , glob_string_sequence_(other.glob_string_sequence_)
46 8834 , regex_compiled_(false)
47 8834 , relaxed_regex_compiled_(false)
48 8834 , prefix_regex_compiled_(false)
49 8834 , glob_string_compiled_(other.glob_string_compiled_)
50 8834 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 8834 , valid_(other.valid_)
52 8834 , absolute_(other.absolute_) { }
53
54 15621 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 105 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 105 times.
✗ Branch 1 not taken.
 105 if (this != &other) {
58 105 DestroyRegularExpressions(); // see: copy c'tor for details
59 105 patterns_ = other.patterns_;
60
61 105 glob_string_compiled_ = other.glob_string_compiled_;
62 105 glob_string_ = other.glob_string_;
63
64 105 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 105 glob_string_sequence_ = other.glob_string_sequence_;
66
67 105 valid_ = other.valid_;
68 105 absolute_ = other.absolute_;
69 }
70
71 105 return *this;
72 }
73
74
75 6790 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 6790 std::string::const_iterator itr = spec.begin();
80 6790 const std::string::const_iterator end = spec.end();
81
82 6790 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 28544 times.
✓ Branch 2 taken 6790 times.
 35334 while (itr != end) {
84
2/2
✓ Branch 1 taken 13628 times.
✓ Branch 2 taken 14916 times.
 28544 if (*itr == kSeparator) {
85 13628 ++itr;
86 13628 continue;
87 }
88
1/2
✓ Branch 1 taken 14916 times.
✗ Branch 2 not taken.
 14916 ParsePathElement(end, &itr);
89 }
90 6790 }
91
92 14916 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 14916 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 76242 times.
✓ Branch 2 taken 6544 times.
✓ Branch 4 taken 67870 times.
✓ Branch 5 taken 8372 times.
✓ Branch 6 taken 67870 times.
✓ Branch 7 taken 14916 times.
 82786 while (*itr != end && **itr != kSeparator) {
97 67870 ++(*itr);
98 }
99 14916 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 14916 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 14916 times.
✗ Branch 5 not taken.
 14916 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 14916 }
104
105 16621 bool Pathspec::IsMatching(const std::string &query_path) const {
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 16621 times.
 16621 assert(IsValid());
107
108
2/2
✓ Branch 1 taken 754 times.
✓ Branch 2 taken 15867 times.
 16621 if (query_path.empty()) {
109 754 return false;
110 }
111
112 15867 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 12280 times.
✓ Branch 2 taken 459 times.
 12739 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 12739 times.
✓ Branch 1 taken 3128 times.
✓ Branch 3 taken 5578 times.
✓ Branch 4 taken 9830 times.
 28606 && IsPathspecMatching(query_path);
115 }
116
117 432 bool Pathspec::IsPrefixMatching(const std::string &query_path) const {
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 432 times.
 432 assert(IsValid());
119
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 432 times.
 432 assert(IsAbsolute());
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 432 times.
 432 if (query_path.empty()) {
122 ✗ return false;
123 }
124
125 432 const bool query_is_absolute = (query_path[0] == kSeparator);
126
4/4
✓ Branch 0 taken 396 times.
✓ Branch 1 taken 36 times.
✓ Branch 3 taken 252 times.
✓ Branch 4 taken 144 times.
 432 return (query_is_absolute && IsPathspecPrefixMatching(query_path));
127 }
128
129 8488 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 8488 times.
 8488 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 615 times.
✓ Branch 2 taken 7873 times.
 8488 if (query_path.empty()) {
133 615 return false;
134 }
135
136 7873 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 15408 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 15408 return ApplyRegularExpression(query_path, GetRegularExpression());
141 }
142
143 396 bool Pathspec::IsPathspecPrefixMatching(const std::string &query_path) const {
144 396 return ApplyRegularExpression(query_path, GetPrefixRegularExpression());
145 }
146
147 7873 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 7873 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 23677 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 23677 const char *path = query_path.c_str();
154 23677 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 16105 times.
✓ Branch 1 taken 7572 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 16105 times.
 23677 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 23677 return (retval == 0);
161 }
162
163 15408 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 3362 times.
✓ Branch 1 taken 12046 times.
 15408 if (!regex_compiled_) {
165 3362 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 3362 times.
✗ Branch 2 not taken.
 3362 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 3362 times.
✗ Branch 3 not taken.
 3362 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 3362 times.
✗ Branch 2 not taken.
 3362 regex_ = CompileRegularExpression(regex);
170 3362 regex_compiled_ = true;
171 3362 }
172
173 15408 return regex_;
174 }
175
176 396 regex_t *Pathspec::GetPrefixRegularExpression() const {
177
2/2
✓ Branch 0 taken 72 times.
✓ Branch 1 taken 324 times.
 396 if (!prefix_regex_compiled_) {
178 72 const bool is_relaxed = false;
179 72 const bool is_prefix = true;
180
1/2
✓ Branch 1 taken 72 times.
✗ Branch 2 not taken.
 72 const std::string regex = GenerateRegularExpression(is_relaxed, is_prefix);
181
1/2
✓ Branch 2 taken 72 times.
✗ Branch 3 not taken.
 72 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
182
183
1/2
✓ Branch 1 taken 72 times.
✗ Branch 2 not taken.
 72 prefix_regex_ = CompileRegularExpression(regex);
184 72 prefix_regex_compiled_ = true;
185 72 }
186
187 396 return prefix_regex_;
188 }
189
190 7873 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 862 times.
✓ Branch 1 taken 7011 times.
 7873 if (!relaxed_regex_compiled_) {
192 862 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 862 times.
✗ Branch 2 not taken.
 862 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 862 times.
✗ Branch 3 not taken.
 862 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 862 times.
✗ Branch 2 not taken.
 862 relaxed_regex_ = CompileRegularExpression(regex);
198 862 relaxed_regex_compiled_ = true;
199 862 }
200
201 7873 return relaxed_regex_;
202 }
203
204 4296 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 4296 times.
✗ Branch 3 not taken.
 4296 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 3677 times.
✓ Branch 2 taken 619 times.
 4296 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 3677 times.
✗ Branch 2 not taken.
 3677 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 4296 ElementPatterns::const_iterator i = patterns_.begin();
216 4296 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 9580 times.
✓ Branch 3 taken 4296 times.
 13876 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 9580 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 9580 times.
✗ Branch 6 not taken.
 9580 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 5284 times.
✓ Branch 3 taken 4296 times.
 9580 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 5284 times.
✗ Branch 2 not taken.
 5284 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 72 times.
✓ Branch 1 taken 4224 times.
 4296 if (is_prefix) {
225
1/2
✓ Branch 1 taken 72 times.
✗ Branch 2 not taken.
 72 regex += "($|";
226
1/2
✓ Branch 1 taken 72 times.
✗ Branch 2 not taken.
 72 regex += kSeparator;
227
1/2
✓ Branch 1 taken 72 times.
✗ Branch 2 not taken.
 72 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 4224 times.
✗ Branch 2 not taken.
 4224 regex += kSeparator;
232
1/2
✓ Branch 1 taken 4224 times.
✗ Branch 2 not taken.
 4224 regex += "?$";
233 }
234
235 8592 return regex;
236 }
237
238 4296 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 4296 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 4296 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 4296 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4296 times.
 4296 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 4296 return result;
249 }
250
251 15726 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 3362 times.
✓ Branch 1 taken 12364 times.
 15726 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3362 times.
 3362 assert(regex_ != NULL);
254 3362 regfree(regex_);
255 3362 regex_ = NULL;
256 3362 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 862 times.
✓ Branch 1 taken 14864 times.
 15726 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 862 times.
 862 assert(relaxed_regex_ != NULL);
261 862 regfree(relaxed_regex_);
262 862 relaxed_regex_ = NULL;
263 862 relaxed_regex_compiled_ = false;
264 }
265 15726 }
266
267 2656 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 1728 times.
✗ Branch 5 not taken.
 4384 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 1728 times.
✓ Branch 1 taken 928 times.
✓ Branch 4 taken 147 times.
✓ Branch 5 taken 1581 times.
✓ Branch 6 taken 1075 times.
✓ Branch 7 taken 1581 times.
 4384 || IsAbsolute() != other.IsAbsolute()) {
270 1075 return false;
271 }
272
273 1581 ElementPatterns::const_iterator i = patterns_.begin();
274 1581 const ElementPatterns::const_iterator iend = patterns_.end();
275 1581 ElementPatterns::const_iterator j = other.patterns_.begin();
276 1581 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 3342 times.
✓ Branch 4 taken 558 times.
✓ Branch 6 taken 3342 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 3342 times.
✓ Branch 9 taken 558 times.
 3900 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 3342 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 1023 times.
✓ Branch 6 taken 2319 times.
 3342 if (*i != *j) {
280 1023 return false;
281 }
282 }
283
284 558 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 595 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 595 times.
✗ Branch 1 not taken.
 595 if (!glob_string_sequence_compiled_) {
297 595 GenerateGlobStringSequence();
298 595 glob_string_sequence_compiled_ = true;
299 }
300 595 return glob_string_sequence_;
301 }
302
303
304 595 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 595 times.
 595 assert(glob_string_sequence_.empty());
306 595 ElementPatterns::const_iterator i = patterns_.begin();
307 595 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 1190 times.
✓ Branch 3 taken 595 times.
 1785 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 1190 times.
✗ Branch 3 not taken.
 1190 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 1190 times.
✗ Branch 2 not taken.
 1190 glob_string_sequence_.push_back(glob_string);
311 1190 }
312 595 }
313
314
315 805 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 595 times.
✓ Branch 1 taken 210 times.
 805 if (!glob_string_compiled_) {
317 595 GenerateGlobString();
318 595 glob_string_compiled_ = true;
319 }
320 805 return glob_string_;
321 }
322
323
324 595 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 595 times.
 595 assert(glob_string_.empty());
326
327 595 bool is_first = true;
328
1/2
✓ Branch 1 taken 595 times.
✗ Branch 2 not taken.
 595 const GlobStringSequence &seq = GetGlobStringSequence();
329 595 GlobStringSequence::const_iterator i = seq.begin();
330 595 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 1190 times.
✓ Branch 2 taken 595 times.
 1785 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 595 times.
✓ Branch 1 taken 595 times.
✓ Branch 3 taken 385 times.
✓ Branch 4 taken 210 times.
✓ Branch 5 taken 980 times.
✓ Branch 6 taken 210 times.
 1190 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 980 times.
✗ Branch 2 not taken.
 980 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 1190 times.
✗ Branch 3 not taken.
 1190 glob_string_ += *i;
336 1190 is_first = false;
337 }
338 595 }
339