GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2026-08-09 02:40:25
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 4226 Pathspec::Pathspec(const std::string &spec)
13 4226 : regex_(NULL)
14 4226 , relaxed_regex_(NULL)
15 4226 , prefix_regex_(NULL)
16 4226 , regex_compiled_(false)
17 4226 , relaxed_regex_compiled_(false)
18 4226 , prefix_regex_compiled_(false)
19 4226 , glob_string_compiled_(false)
20 4226 , glob_string_sequence_compiled_(false)
21 4226 , valid_(true)
22 4226 , absolute_(false) {
23
1/2
✓ Branch 1 taken 4226 times.
✗ Branch 2 not taken.
 4226 Parse(spec);
24
2/2
✓ Branch 1 taken 17 times.
✓ Branch 2 taken 4209 times.
 4226 if (patterns_.size() == 0) {
25 17 valid_ = false;
26 }
27
28 4226 ElementPatterns::const_iterator i = patterns_.begin();
29 4226 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 9355 times.
✓ Branch 3 taken 4226 times.
 13581 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 33 times.
✓ Branch 3 taken 9322 times.
 9355 if (!i->IsValid()) {
32 33 valid_ = false;
33 }
34 }
35 4226 }
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 7116 Pathspec::Pathspec(const Pathspec &other)
40 7116 : patterns_(other.patterns_)
41 7116 , regex_(NULL)
42 7116 , relaxed_regex_(NULL)
43 7116 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 7116 times.
✗ Branch 2 not taken.
 7116 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 7116 times.
✗ Branch 2 not taken.
 7116 , glob_string_sequence_(other.glob_string_sequence_)
46 7116 , regex_compiled_(false)
47 7116 , relaxed_regex_compiled_(false)
48 7116 , prefix_regex_compiled_(false)
49 7116 , glob_string_compiled_(other.glob_string_compiled_)
50 7116 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 7116 , valid_(other.valid_)
52 7116 , absolute_(other.absolute_) { }
53
54 11339 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 51 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 51 times.
✗ Branch 1 not taken.
 51 if (this != &other) {
58 51 DestroyRegularExpressions(); // see: copy c'tor for details
59 51 patterns_ = other.patterns_;
60
61 51 glob_string_compiled_ = other.glob_string_compiled_;
62 51 glob_string_ = other.glob_string_;
63
64 51 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 51 glob_string_sequence_ = other.glob_string_sequence_;
66
67 51 valid_ = other.valid_;
68 51 absolute_ = other.absolute_;
69 }
70
71 51 return *this;
72 }
73
74
75 4226 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 4226 std::string::const_iterator itr = spec.begin();
80 4226 const std::string::const_iterator end = spec.end();
81
82 4226 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 18255 times.
✓ Branch 2 taken 4226 times.
 22481 while (itr != end) {
84
2/2
✓ Branch 1 taken 8900 times.
✓ Branch 2 taken 9355 times.
 18255 if (*itr == kSeparator) {
85 8900 ++itr;
86 8900 continue;
87 }
88
1/2
✓ Branch 1 taken 9355 times.
✗ Branch 2 not taken.
 9355 ParsePathElement(end, &itr);
89 }
90 4226 }
91
92 9355 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 9355 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 47091 times.
✓ Branch 2 taken 3884 times.
✓ Branch 4 taken 41620 times.
✓ Branch 5 taken 5471 times.
✓ Branch 6 taken 41620 times.
✓ Branch 7 taken 9355 times.
 50975 while (*itr != end && **itr != kSeparator) {
97 41620 ++(*itr);
98 }
99 9355 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 9355 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 9355 times.
✗ Branch 5 not taken.
 9355 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 9355 }
104
105 12051 bool Pathspec::IsMatching(const std::string &query_path) const {
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 12051 times.
 12051 assert(IsValid());
107
108
2/2
✓ Branch 1 taken 810 times.
✓ Branch 2 taken 11241 times.
 12051 if (query_path.empty()) {
109 810 return false;
110 }
111
112 11241 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 9580 times.
✓ Branch 2 taken 213 times.
 9793 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 9793 times.
✓ Branch 1 taken 1448 times.
✓ Branch 3 taken 3280 times.
✓ Branch 4 taken 7748 times.
 21034 && IsPathspecMatching(query_path);
115 }
116
117 204 bool Pathspec::IsPrefixMatching(const std::string &query_path) const {
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 204 times.
 204 assert(IsValid());
119
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 204 times.
 204 assert(IsAbsolute());
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 204 times.
 204 if (query_path.empty()) {
122 ✗ return false;
123 }
124
125 204 const bool query_is_absolute = (query_path[0] == kSeparator);
126
4/4
✓ Branch 0 taken 187 times.
✓ Branch 1 taken 17 times.
✓ Branch 3 taken 119 times.
✓ Branch 4 taken 68 times.
 204 return (query_is_absolute && IsPathspecPrefixMatching(query_path));
127 }
128
129 9760 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 9760 times.
 9760 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 1704 times.
✓ Branch 2 taken 8056 times.
 9760 if (query_path.empty()) {
133 1704 return false;
134 }
135
136 8056 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 11028 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 11028 return ApplyRegularExpression(query_path, GetRegularExpression());
141 }
142
143 187 bool Pathspec::IsPathspecPrefixMatching(const std::string &query_path) const {
144 187 return ApplyRegularExpression(query_path, GetPrefixRegularExpression());
145 }
146
147 8056 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 8056 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 19271 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 19271 const char *path = query_path.c_str();
154 19271 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 14825 times.
✓ Branch 1 taken 4446 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 14825 times.
 19271 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 19271 return (retval == 0);
161 }
162
163 11028 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 2277 times.
✓ Branch 1 taken 8751 times.
 11028 if (!regex_compiled_) {
165 2277 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 2277 times.
✗ Branch 2 not taken.
 2277 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 2277 times.
✗ Branch 3 not taken.
 2277 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 2277 times.
✗ Branch 2 not taken.
 2277 regex_ = CompileRegularExpression(regex);
170 2277 regex_compiled_ = true;
171 2277 }
172
173 11028 return regex_;
174 }
175
176 187 regex_t *Pathspec::GetPrefixRegularExpression() const {
177
2/2
✓ Branch 0 taken 34 times.
✓ Branch 1 taken 153 times.
 187 if (!prefix_regex_compiled_) {
178 34 const bool is_relaxed = false;
179 34 const bool is_prefix = true;
180
1/2
✓ Branch 1 taken 34 times.
✗ Branch 2 not taken.
 34 const std::string regex = GenerateRegularExpression(is_relaxed, is_prefix);
181
1/2
✓ Branch 2 taken 34 times.
✗ Branch 3 not taken.
 34 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
182
183
1/2
✓ Branch 1 taken 34 times.
✗ Branch 2 not taken.
 34 prefix_regex_ = CompileRegularExpression(regex);
184 34 prefix_regex_compiled_ = true;
185 34 }
186
187 187 return prefix_regex_;
188 }
189
190 8056 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 753 times.
✓ Branch 1 taken 7303 times.
 8056 if (!relaxed_regex_compiled_) {
192 753 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 753 times.
✗ Branch 2 not taken.
 753 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 753 times.
✗ Branch 3 not taken.
 753 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 753 times.
✗ Branch 2 not taken.
 753 relaxed_regex_ = CompileRegularExpression(regex);
198 753 relaxed_regex_compiled_ = true;
199 753 }
200
201 8056 return relaxed_regex_;
202 }
203
204 3064 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 3064 times.
✗ Branch 3 not taken.
 3064 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 2696 times.
✓ Branch 2 taken 368 times.
 3064 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 2696 times.
✗ Branch 2 not taken.
 2696 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 3064 ElementPatterns::const_iterator i = patterns_.begin();
216 3064 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 6760 times.
✓ Branch 3 taken 3064 times.
 9824 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 6760 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 6760 times.
✗ Branch 6 not taken.
 6760 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 3696 times.
✓ Branch 3 taken 3064 times.
 6760 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 3696 times.
✗ Branch 2 not taken.
 3696 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 34 times.
✓ Branch 1 taken 3030 times.
 3064 if (is_prefix) {
225
1/2
✓ Branch 1 taken 34 times.
✗ Branch 2 not taken.
 34 regex += "($|";
226
1/2
✓ Branch 1 taken 34 times.
✗ Branch 2 not taken.
 34 regex += kSeparator;
227
1/2
✓ Branch 1 taken 34 times.
✗ Branch 2 not taken.
 34 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 3030 times.
✗ Branch 2 not taken.
 3030 regex += kSeparator;
232
1/2
✓ Branch 1 taken 3030 times.
✗ Branch 2 not taken.
 3030 regex += "?$";
233 }
234
235 6128 return regex;
236 }
237
238 3064 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 3064 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 3064 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 3064 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3064 times.
 3064 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 3064 return result;
249 }
250
251 11390 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 2277 times.
✓ Branch 1 taken 9113 times.
 11390 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2277 times.
 2277 assert(regex_ != NULL);
254 2277 regfree(regex_);
255 2277 regex_ = NULL;
256 2277 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 753 times.
✓ Branch 1 taken 10637 times.
 11390 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 753 times.
 753 assert(relaxed_regex_ != NULL);
261 753 regfree(relaxed_regex_);
262 753 relaxed_regex_ = NULL;
263 753 relaxed_regex_compiled_ = false;
264 }
265 11390 }
266
267 2409 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 1077 times.
✗ Branch 5 not taken.
 3486 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 1077 times.
✓ Branch 1 taken 1332 times.
✓ Branch 4 taken 111 times.
✓ Branch 5 taken 966 times.
✓ Branch 6 taken 1443 times.
✓ Branch 7 taken 966 times.
 3486 || IsAbsolute() != other.IsAbsolute()) {
270 1443 return false;
271 }
272
273 966 ElementPatterns::const_iterator i = patterns_.begin();
274 966 const ElementPatterns::const_iterator iend = patterns_.end();
275 966 ElementPatterns::const_iterator j = other.patterns_.begin();
276 966 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 1940 times.
✓ Branch 4 taken 271 times.
✓ Branch 6 taken 1940 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 1940 times.
✓ Branch 9 taken 271 times.
 2211 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 1940 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 695 times.
✓ Branch 6 taken 1245 times.
 1940 if (*i != *j) {
280 695 return false;
281 }
282 }
283
284 271 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 276 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 276 times.
✗ Branch 1 not taken.
 276 if (!glob_string_sequence_compiled_) {
297 276 GenerateGlobStringSequence();
298 276 glob_string_sequence_compiled_ = true;
299 }
300 276 return glob_string_sequence_;
301 }
302
303
304 276 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 276 times.
 276 assert(glob_string_sequence_.empty());
306 276 ElementPatterns::const_iterator i = patterns_.begin();
307 276 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 552 times.
✓ Branch 3 taken 276 times.
 828 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 552 times.
✗ Branch 3 not taken.
 552 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 552 times.
✗ Branch 2 not taken.
 552 glob_string_sequence_.push_back(glob_string);
311 552 }
312 276 }
313
314
315 375 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 276 times.
✓ Branch 1 taken 99 times.
 375 if (!glob_string_compiled_) {
317 276 GenerateGlobString();
318 276 glob_string_compiled_ = true;
319 }
320 375 return glob_string_;
321 }
322
323
324 276 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 276 times.
 276 assert(glob_string_.empty());
326
327 276 bool is_first = true;
328
1/2
✓ Branch 1 taken 276 times.
✗ Branch 2 not taken.
 276 const GlobStringSequence &seq = GetGlobStringSequence();
329 276 GlobStringSequence::const_iterator i = seq.begin();
330 276 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 552 times.
✓ Branch 2 taken 276 times.
 828 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 276 times.
✓ Branch 1 taken 276 times.
✓ Branch 3 taken 180 times.
✓ Branch 4 taken 96 times.
✓ Branch 5 taken 456 times.
✓ Branch 6 taken 96 times.
 552 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 456 times.
✗ Branch 2 not taken.
 456 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 552 times.
✗ Branch 3 not taken.
 552 glob_string_ += *i;
336 552 is_first = false;
337 }
338 276 }
339