GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2026-02-08 02:36:20
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 6375 Pathspec::Pathspec(const std::string &spec)
13 6375 : regex_(NULL)
14 6375 , relaxed_regex_(NULL)
15 6375 , prefix_regex_(NULL)
16 6375 , regex_compiled_(false)
17 6375 , relaxed_regex_compiled_(false)
18 6375 , prefix_regex_compiled_(false)
19 6375 , glob_string_compiled_(false)
20 6375 , glob_string_sequence_compiled_(false)
21 6375 , valid_(true)
22 6375 , absolute_(false) {
23
1/2
✓ Branch 1 taken 6375 times.
✗ Branch 2 not taken.
 6375 Parse(spec);
24
2/2
✓ Branch 1 taken 38 times.
✓ Branch 2 taken 6337 times.
 6375 if (patterns_.size() == 0) {
25 38 valid_ = false;
26 }
27
28 6375 ElementPatterns::const_iterator i = patterns_.begin();
29 6375 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 14123 times.
✓ Branch 3 taken 6375 times.
 20498 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 88 times.
✓ Branch 3 taken 14035 times.
 14123 if (!i->IsValid()) {
32 88 valid_ = false;
33 }
34 }
35 6375 }
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 6946 Pathspec::Pathspec(const Pathspec &other)
40 6946 : patterns_(other.patterns_)
41 6946 , regex_(NULL)
42 6946 , relaxed_regex_(NULL)
43 6946 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 6946 times.
✗ Branch 2 not taken.
 6946 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 6946 times.
✗ Branch 2 not taken.
 6946 , glob_string_sequence_(other.glob_string_sequence_)
46 6946 , regex_compiled_(false)
47 6946 , relaxed_regex_compiled_(false)
48 6946 , prefix_regex_compiled_(false)
49 6946 , glob_string_compiled_(other.glob_string_compiled_)
50 6946 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 6946 , valid_(other.valid_)
52 6946 , absolute_(other.absolute_) { }
53
54 13318 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 114 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 114 times.
✗ Branch 1 not taken.
 114 if (this != &other) {
58 114 DestroyRegularExpressions(); // see: copy c'tor for details
59 114 patterns_ = other.patterns_;
60
61 114 glob_string_compiled_ = other.glob_string_compiled_;
62 114 glob_string_ = other.glob_string_;
63
64 114 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 114 glob_string_sequence_ = other.glob_string_sequence_;
66
67 114 valid_ = other.valid_;
68 114 absolute_ = other.absolute_;
69 }
70
71 114 return *this;
72 }
73
74
75 6375 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 6375 std::string::const_iterator itr = spec.begin();
80 6375 const std::string::const_iterator end = spec.end();
81
82 6375 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 26737 times.
✓ Branch 2 taken 6375 times.
 33112 while (itr != end) {
84
2/2
✓ Branch 1 taken 12614 times.
✓ Branch 2 taken 14123 times.
 26737 if (*itr == kSeparator) {
85 12614 ++itr;
86 12614 continue;
87 }
88
1/2
✓ Branch 1 taken 14123 times.
✗ Branch 2 not taken.
 14123 ParsePathElement(end, &itr);
89 }
90 6375 }
91
92 14123 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 14123 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 66599 times.
✓ Branch 2 taken 6131 times.
✓ Branch 4 taken 58607 times.
✓ Branch 5 taken 7992 times.
✓ Branch 6 taken 58607 times.
✓ Branch 7 taken 14123 times.
 72730 while (*itr != end && **itr != kSeparator) {
97 58607 ++(*itr);
98 }
99 14123 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 14123 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 14123 times.
✗ Branch 5 not taken.
 14123 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 14123 }
104
105 14839 bool Pathspec::IsMatching(const std::string &query_path) const {
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 14839 times.
 14839 assert(IsValid());
107
108
2/2
✓ Branch 1 taken 520 times.
✓ Branch 2 taken 14319 times.
 14839 if (query_path.empty()) {
109 520 return false;
110 }
111
112 14319 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 10349 times.
✓ Branch 2 taken 498 times.
 10847 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 10847 times.
✓ Branch 1 taken 3472 times.
✓ Branch 3 taken 5753 times.
✓ Branch 4 taken 8068 times.
 25166 && IsPathspecMatching(query_path);
115 }
116
117 468 bool Pathspec::IsPrefixMatching(const std::string &query_path) const {
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 468 times.
 468 assert(IsValid());
119
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 468 times.
 468 assert(IsAbsolute());
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 468 times.
 468 if (query_path.empty()) {
122 ✗ return false;
123 }
124
125 468 const bool query_is_absolute = (query_path[0] == kSeparator);
126
4/4
✓ Branch 0 taken 429 times.
✓ Branch 1 taken 39 times.
✓ Branch 3 taken 273 times.
✓ Branch 4 taken 156 times.
 468 return (query_is_absolute && IsPathspecPrefixMatching(query_path));
127 }
128
129 11787 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 11787 times.
 11787 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 1008 times.
✓ Branch 2 taken 10779 times.
 11787 if (query_path.empty()) {
133 1008 return false;
134 }
135
136 10779 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 13821 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 13821 return ApplyRegularExpression(query_path, GetRegularExpression());
141 }
142
143 429 bool Pathspec::IsPathspecPrefixMatching(const std::string &query_path) const {
144 429 return ApplyRegularExpression(query_path, GetPrefixRegularExpression());
145 }
146
147 10779 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 10779 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 25029 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 25029 const char *path = query_path.c_str();
154 25029 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 16845 times.
✓ Branch 1 taken 8184 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 16845 times.
 25029 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 25029 return (retval == 0);
161 }
162
163 13821 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 2715 times.
✓ Branch 1 taken 11106 times.
 13821 if (!regex_compiled_) {
165 2715 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 2715 times.
✗ Branch 2 not taken.
 2715 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 2715 times.
✗ Branch 3 not taken.
 2715 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 2715 times.
✗ Branch 2 not taken.
 2715 regex_ = CompileRegularExpression(regex);
170 2715 regex_compiled_ = true;
171 2715 }
172
173 13821 return regex_;
174 }
175
176 429 regex_t *Pathspec::GetPrefixRegularExpression() const {
177
2/2
✓ Branch 0 taken 78 times.
✓ Branch 1 taken 351 times.
 429 if (!prefix_regex_compiled_) {
178 78 const bool is_relaxed = false;
179 78 const bool is_prefix = true;
180
1/2
✓ Branch 1 taken 78 times.
✗ Branch 2 not taken.
 78 const std::string regex = GenerateRegularExpression(is_relaxed, is_prefix);
181
1/2
✓ Branch 2 taken 78 times.
✗ Branch 3 not taken.
 78 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
182
183
1/2
✓ Branch 1 taken 78 times.
✗ Branch 2 not taken.
 78 prefix_regex_ = CompileRegularExpression(regex);
184 78 prefix_regex_compiled_ = true;
185 78 }
186
187 429 return prefix_regex_;
188 }
189
190 10779 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 1073 times.
✓ Branch 1 taken 9706 times.
 10779 if (!relaxed_regex_compiled_) {
192 1073 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 1073 times.
✗ Branch 2 not taken.
 1073 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 1073 times.
✗ Branch 3 not taken.
 1073 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 1073 times.
✗ Branch 2 not taken.
 1073 relaxed_regex_ = CompileRegularExpression(regex);
198 1073 relaxed_regex_compiled_ = true;
199 1073 }
200
201 10779 return relaxed_regex_;
202 }
203
204 3866 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 3866 times.
✗ Branch 3 not taken.
 3866 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 3134 times.
✓ Branch 2 taken 732 times.
 3866 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 3134 times.
✗ Branch 2 not taken.
 3134 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 3866 ElementPatterns::const_iterator i = patterns_.begin();
216 3866 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 8395 times.
✓ Branch 3 taken 3866 times.
 12261 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 8395 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 8395 times.
✗ Branch 6 not taken.
 8395 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 4529 times.
✓ Branch 3 taken 3866 times.
 8395 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 4529 times.
✗ Branch 2 not taken.
 4529 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 78 times.
✓ Branch 1 taken 3788 times.
 3866 if (is_prefix) {
225
1/2
✓ Branch 1 taken 78 times.
✗ Branch 2 not taken.
 78 regex += "($|";
226
1/2
✓ Branch 1 taken 78 times.
✗ Branch 2 not taken.
 78 regex += kSeparator;
227
1/2
✓ Branch 1 taken 78 times.
✗ Branch 2 not taken.
 78 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 3788 times.
✗ Branch 2 not taken.
 3788 regex += kSeparator;
232
1/2
✓ Branch 1 taken 3788 times.
✗ Branch 2 not taken.
 3788 regex += "?$";
233 }
234
235 7732 return regex;
236 }
237
238 3866 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 3866 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 3866 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 3866 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3866 times.
 3866 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 3866 return result;
249 }
250
251 13432 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 2715 times.
✓ Branch 1 taken 10717 times.
 13432 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2715 times.
 2715 assert(regex_ != NULL);
254 2715 regfree(regex_);
255 2715 regex_ = NULL;
256 2715 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 1073 times.
✓ Branch 1 taken 12359 times.
 13432 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1073 times.
 1073 assert(relaxed_regex_ != NULL);
261 1073 regfree(relaxed_regex_);
262 1073 relaxed_regex_ = NULL;
263 1073 relaxed_regex_compiled_ = false;
264 }
265 13432 }
266
267 3416 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 2157 times.
✗ Branch 5 not taken.
 5573 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 2157 times.
✓ Branch 1 taken 1259 times.
✓ Branch 4 taken 213 times.
✓ Branch 5 taken 1944 times.
✓ Branch 6 taken 1472 times.
✓ Branch 7 taken 1944 times.
 5573 || IsAbsolute() != other.IsAbsolute()) {
270 1472 return false;
271 }
272
273 1944 ElementPatterns::const_iterator i = patterns_.begin();
274 1944 const ElementPatterns::const_iterator iend = patterns_.end();
275 1944 ElementPatterns::const_iterator j = other.patterns_.begin();
276 1944 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 4082 times.
✓ Branch 4 taken 619 times.
✓ Branch 6 taken 4082 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 4082 times.
✓ Branch 9 taken 619 times.
 4701 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 4082 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 1325 times.
✓ Branch 6 taken 2757 times.
 4082 if (*i != *j) {
280 1325 return false;
281 }
282 }
283
284 619 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 646 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 646 times.
✗ Branch 1 not taken.
 646 if (!glob_string_sequence_compiled_) {
297 646 GenerateGlobStringSequence();
298 646 glob_string_sequence_compiled_ = true;
299 }
300 646 return glob_string_sequence_;
301 }
302
303
304 646 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 646 times.
 646 assert(glob_string_sequence_.empty());
306 646 ElementPatterns::const_iterator i = patterns_.begin();
307 646 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 1292 times.
✓ Branch 3 taken 646 times.
 1938 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 1292 times.
✗ Branch 3 not taken.
 1292 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 1292 times.
✗ Branch 2 not taken.
 1292 glob_string_sequence_.push_back(glob_string);
311 1292 }
312 646 }
313
314
315 874 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 646 times.
✓ Branch 1 taken 228 times.
 874 if (!glob_string_compiled_) {
317 646 GenerateGlobString();
318 646 glob_string_compiled_ = true;
319 }
320 874 return glob_string_;
321 }
322
323
324 646 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 646 times.
 646 assert(glob_string_.empty());
326
327 646 bool is_first = true;
328
1/2
✓ Branch 1 taken 646 times.
✗ Branch 2 not taken.
 646 const GlobStringSequence &seq = GetGlobStringSequence();
329 646 GlobStringSequence::const_iterator i = seq.begin();
330 646 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 1292 times.
✓ Branch 2 taken 646 times.
 1938 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 646 times.
✓ Branch 1 taken 646 times.
✓ Branch 3 taken 418 times.
✓ Branch 4 taken 228 times.
✓ Branch 5 taken 1064 times.
✓ Branch 6 taken 228 times.
 1292 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 1064 times.
✗ Branch 2 not taken.
 1064 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 1292 times.
✗ Branch 3 not taken.
 1292 glob_string_ += *i;
336 1292 is_first = false;
337 }
338 646 }
339