GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2026-07-12 02:35:48
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 6616 Pathspec::Pathspec(const std::string &spec)
13 6616 : regex_(NULL)
14 6616 , relaxed_regex_(NULL)
15 6616 , prefix_regex_(NULL)
16 6616 , regex_compiled_(false)
17 6616 , relaxed_regex_compiled_(false)
18 6616 , prefix_regex_compiled_(false)
19 6616 , glob_string_compiled_(false)
20 6616 , glob_string_sequence_compiled_(false)
21 6616 , valid_(true)
22 6616 , absolute_(false) {
23
1/2
✓ Branch 1 taken 6616 times.
✗ Branch 2 not taken.
 6616 Parse(spec);
24
2/2
✓ Branch 1 taken 31 times.
✓ Branch 2 taken 6585 times.
 6616 if (patterns_.size() == 0) {
25 31 valid_ = false;
26 }
27
28 6616 ElementPatterns::const_iterator i = patterns_.begin();
29 6616 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 14747 times.
✓ Branch 3 taken 6616 times.
 21363 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 80 times.
✓ Branch 3 taken 14667 times.
 14747 if (!i->IsValid()) {
32 80 valid_ = false;
33 }
34 }
35 6616 }
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 9330 Pathspec::Pathspec(const Pathspec &other)
40 9330 : patterns_(other.patterns_)
41 9330 , regex_(NULL)
42 9330 , relaxed_regex_(NULL)
43 9330 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 9330 times.
✗ Branch 2 not taken.
 9330 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 9330 times.
✗ Branch 2 not taken.
 9330 , glob_string_sequence_(other.glob_string_sequence_)
46 9330 , regex_compiled_(false)
47 9330 , relaxed_regex_compiled_(false)
48 9330 , prefix_regex_compiled_(false)
49 9330 , glob_string_compiled_(other.glob_string_compiled_)
50 9330 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 9330 , valid_(other.valid_)
52 9330 , absolute_(other.absolute_) { }
53
54 15943 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 93 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 93 times.
✗ Branch 1 not taken.
 93 if (this != &other) {
58 93 DestroyRegularExpressions(); // see: copy c'tor for details
59 93 patterns_ = other.patterns_;
60
61 93 glob_string_compiled_ = other.glob_string_compiled_;
62 93 glob_string_ = other.glob_string_;
63
64 93 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 93 glob_string_sequence_ = other.glob_string_sequence_;
66
67 93 valid_ = other.valid_;
68 93 absolute_ = other.absolute_;
69 }
70
71 93 return *this;
72 }
73
74
75 6616 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 6616 std::string::const_iterator itr = spec.begin();
80 6616 const std::string::const_iterator end = spec.end();
81
82 6616 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 28260 times.
✓ Branch 2 taken 6616 times.
 34876 while (itr != end) {
84
2/2
✓ Branch 1 taken 13513 times.
✓ Branch 2 taken 14747 times.
 28260 if (*itr == kSeparator) {
85 13513 ++itr;
86 13513 continue;
87 }
88
1/2
✓ Branch 1 taken 14747 times.
✗ Branch 2 not taken.
 14747 ParsePathElement(end, &itr);
89 }
90 6616 }
91
92 14747 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 14747 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 73450 times.
✓ Branch 2 taken 6438 times.
✓ Branch 4 taken 65141 times.
✓ Branch 5 taken 8309 times.
✓ Branch 6 taken 65141 times.
✓ Branch 7 taken 14747 times.
 79888 while (*itr != end && **itr != kSeparator) {
97 65141 ++(*itr);
98 }
99 14747 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 14747 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 14747 times.
✗ Branch 5 not taken.
 14747 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 14747 }
104
105 15147 bool Pathspec::IsMatching(const std::string &query_path) const {
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 15147 times.
 15147 assert(IsValid());
107
108
2/2
✓ Branch 1 taken 604 times.
✓ Branch 2 taken 14543 times.
 15147 if (query_path.empty()) {
109 604 return false;
110 }
111
112 14543 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 11309 times.
✓ Branch 2 taken 403 times.
 11712 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 11712 times.
✓ Branch 1 taken 2831 times.
✓ Branch 3 taken 5306 times.
✓ Branch 4 taken 8834 times.
 26255 && IsPathspecMatching(query_path);
115 }
116
117 384 bool Pathspec::IsPrefixMatching(const std::string &query_path) const {
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 384 times.
 384 assert(IsValid());
119
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 384 times.
 384 assert(IsAbsolute());
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 384 times.
 384 if (query_path.empty()) {
122 ✗ return false;
123 }
124
125 384 const bool query_is_absolute = (query_path[0] == kSeparator);
126
4/4
✓ Branch 0 taken 352 times.
✓ Branch 1 taken 32 times.
✓ Branch 3 taken 224 times.
✓ Branch 4 taken 128 times.
 384 return (query_is_absolute && IsPathspecPrefixMatching(query_path));
127 }
128
129 8686 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 8686 times.
 8686 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 255 times.
✓ Branch 2 taken 8431 times.
 8686 if (query_path.empty()) {
133 255 return false;
134 }
135
136 8431 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 14140 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 14140 return ApplyRegularExpression(query_path, GetRegularExpression());
141 }
142
143 352 bool Pathspec::IsPathspecPrefixMatching(const std::string &query_path) const {
144 352 return ApplyRegularExpression(query_path, GetPrefixRegularExpression());
145 }
146
147 8431 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 8431 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 22923 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 22923 const char *path = query_path.c_str();
154 22923 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 15455 times.
✓ Branch 1 taken 7468 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 15455 times.
 22923 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 22923 return (retval == 0);
161 }
162
163 14140 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 3042 times.
✓ Branch 1 taken 11098 times.
 14140 if (!regex_compiled_) {
165 3042 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 3042 times.
✗ Branch 2 not taken.
 3042 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 3042 times.
✗ Branch 3 not taken.
 3042 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 3042 times.
✗ Branch 2 not taken.
 3042 regex_ = CompileRegularExpression(regex);
170 3042 regex_compiled_ = true;
171 3042 }
172
173 14140 return regex_;
174 }
175
176 352 regex_t *Pathspec::GetPrefixRegularExpression() const {
177
2/2
✓ Branch 0 taken 64 times.
✓ Branch 1 taken 288 times.
 352 if (!prefix_regex_compiled_) {
178 64 const bool is_relaxed = false;
179 64 const bool is_prefix = true;
180
1/2
✓ Branch 1 taken 64 times.
✗ Branch 2 not taken.
 64 const std::string regex = GenerateRegularExpression(is_relaxed, is_prefix);
181
1/2
✓ Branch 2 taken 64 times.
✗ Branch 3 not taken.
 64 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
182
183
1/2
✓ Branch 1 taken 64 times.
✗ Branch 2 not taken.
 64 prefix_regex_ = CompileRegularExpression(regex);
184 64 prefix_regex_compiled_ = true;
185 64 }
186
187 352 return prefix_regex_;
188 }
189
190 8431 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 876 times.
✓ Branch 1 taken 7555 times.
 8431 if (!relaxed_regex_compiled_) {
192 876 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 876 times.
✗ Branch 2 not taken.
 876 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 876 times.
✗ Branch 3 not taken.
 876 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 876 times.
✗ Branch 2 not taken.
 876 relaxed_regex_ = CompileRegularExpression(regex);
198 876 relaxed_regex_compiled_ = true;
199 876 }
200
201 8431 return relaxed_regex_;
202 }
203
204 3982 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 3982 times.
✗ Branch 3 not taken.
 3982 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 3413 times.
✓ Branch 2 taken 569 times.
 3982 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 3413 times.
✗ Branch 2 not taken.
 3413 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 3982 ElementPatterns::const_iterator i = patterns_.begin();
216 3982 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 8989 times.
✓ Branch 3 taken 3982 times.
 12971 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 8989 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 8989 times.
✗ Branch 6 not taken.
 8989 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 5007 times.
✓ Branch 3 taken 3982 times.
 8989 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 5007 times.
✗ Branch 2 not taken.
 5007 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 64 times.
✓ Branch 1 taken 3918 times.
 3982 if (is_prefix) {
225
1/2
✓ Branch 1 taken 64 times.
✗ Branch 2 not taken.
 64 regex += "($|";
226
1/2
✓ Branch 1 taken 64 times.
✗ Branch 2 not taken.
 64 regex += kSeparator;
227
1/2
✓ Branch 1 taken 64 times.
✗ Branch 2 not taken.
 64 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 3918 times.
✗ Branch 2 not taken.
 3918 regex += kSeparator;
232
1/2
✓ Branch 1 taken 3918 times.
✗ Branch 2 not taken.
 3918 regex += "?$";
233 }
234
235 7964 return regex;
236 }
237
238 3982 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 3982 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 3982 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 3982 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3982 times.
 3982 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 3982 return result;
249 }
250
251 16036 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 3042 times.
✓ Branch 1 taken 12994 times.
 16036 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3042 times.
 3042 assert(regex_ != NULL);
254 3042 regfree(regex_);
255 3042 regex_ = NULL;
256 3042 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 876 times.
✓ Branch 1 taken 15160 times.
 16036 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 876 times.
 876 assert(relaxed_regex_ != NULL);
261 876 regfree(relaxed_regex_);
262 876 relaxed_regex_ = NULL;
263 876 relaxed_regex_compiled_ = false;
264 }
265 16036 }
266
267 2642 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 1776 times.
✗ Branch 5 not taken.
 4418 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 1776 times.
✓ Branch 1 taken 866 times.
✓ Branch 4 taken 181 times.
✓ Branch 5 taken 1595 times.
✓ Branch 6 taken 1047 times.
✓ Branch 7 taken 1595 times.
 4418 || IsAbsolute() != other.IsAbsolute()) {
270 1047 return false;
271 }
272
273 1595 ElementPatterns::const_iterator i = patterns_.begin();
274 1595 const ElementPatterns::const_iterator iend = patterns_.end();
275 1595 ElementPatterns::const_iterator j = other.patterns_.begin();
276 1595 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 3406 times.
✓ Branch 4 taken 514 times.
✓ Branch 6 taken 3406 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 3406 times.
✓ Branch 9 taken 514 times.
 3920 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 3406 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 1081 times.
✓ Branch 6 taken 2325 times.
 3406 if (*i != *j) {
280 1081 return false;
281 }
282 }
283
284 514 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 527 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 527 times.
✗ Branch 1 not taken.
 527 if (!glob_string_sequence_compiled_) {
297 527 GenerateGlobStringSequence();
298 527 glob_string_sequence_compiled_ = true;
299 }
300 527 return glob_string_sequence_;
301 }
302
303
304 527 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 527 times.
 527 assert(glob_string_sequence_.empty());
306 527 ElementPatterns::const_iterator i = patterns_.begin();
307 527 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 1054 times.
✓ Branch 3 taken 527 times.
 1581 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 1054 times.
✗ Branch 3 not taken.
 1054 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 1054 times.
✗ Branch 2 not taken.
 1054 glob_string_sequence_.push_back(glob_string);
311 1054 }
312 527 }
313
314
315 713 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 527 times.
✓ Branch 1 taken 186 times.
 713 if (!glob_string_compiled_) {
317 527 GenerateGlobString();
318 527 glob_string_compiled_ = true;
319 }
320 713 return glob_string_;
321 }
322
323
324 527 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 527 times.
 527 assert(glob_string_.empty());
326
327 527 bool is_first = true;
328
1/2
✓ Branch 1 taken 527 times.
✗ Branch 2 not taken.
 527 const GlobStringSequence &seq = GetGlobStringSequence();
329 527 GlobStringSequence::const_iterator i = seq.begin();
330 527 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 1054 times.
✓ Branch 2 taken 527 times.
 1581 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 527 times.
✓ Branch 1 taken 527 times.
✓ Branch 3 taken 341 times.
✓ Branch 4 taken 186 times.
✓ Branch 5 taken 868 times.
✓ Branch 6 taken 186 times.
 1054 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 868 times.
✗ Branch 2 not taken.
 868 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 1054 times.
✗ Branch 3 not taken.
 1054 glob_string_ += *i;
336 1054 is_first = false;
337 }
338 527 }
339