GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2026-01-25 02:35:50
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 4579 Pathspec::Pathspec(const std::string &spec)
13 4579 : regex_(NULL)
14 4579 , relaxed_regex_(NULL)
15 4579 , prefix_regex_(NULL)
16 4579 , regex_compiled_(false)
17 4579 , relaxed_regex_compiled_(false)
18 4579 , prefix_regex_compiled_(false)
19 4579 , glob_string_compiled_(false)
20 4579 , glob_string_sequence_compiled_(false)
21 4579 , valid_(true)
22 4579 , absolute_(false) {
23
1/2
✓ Branch 1 taken 4579 times.
✗ Branch 2 not taken.
 4579 Parse(spec);
24
2/2
✓ Branch 1 taken 39 times.
✓ Branch 2 taken 4540 times.
 4579 if (patterns_.size() == 0) {
25 39 valid_ = false;
26 }
27
28 4579 ElementPatterns::const_iterator i = patterns_.begin();
29 4579 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 9728 times.
✓ Branch 3 taken 4579 times.
 14307 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 52 times.
✓ Branch 3 taken 9676 times.
 9728 if (!i->IsValid()) {
32 52 valid_ = false;
33 }
34 }
35 4579 }
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 1983 Pathspec::Pathspec(const Pathspec &other)
40 1983 : patterns_(other.patterns_)
41 1983 , regex_(NULL)
42 1983 , relaxed_regex_(NULL)
43 1983 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 1983 times.
✗ Branch 2 not taken.
 1983 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 1983 times.
✗ Branch 2 not taken.
 1983 , glob_string_sequence_(other.glob_string_sequence_)
46 1983 , regex_compiled_(false)
47 1983 , relaxed_regex_compiled_(false)
48 1983 , prefix_regex_compiled_(false)
49 1983 , glob_string_compiled_(other.glob_string_compiled_)
50 1983 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 1983 , valid_(other.valid_)
52 1983 , absolute_(other.absolute_) { }
53
54 6559 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 117 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 117 times.
✗ Branch 1 not taken.
 117 if (this != &other) {
58 117 DestroyRegularExpressions(); // see: copy c'tor for details
59 117 patterns_ = other.patterns_;
60
61 117 glob_string_compiled_ = other.glob_string_compiled_;
62 117 glob_string_ = other.glob_string_;
63
64 117 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 117 glob_string_sequence_ = other.glob_string_sequence_;
66
67 117 valid_ = other.valid_;
68 117 absolute_ = other.absolute_;
69 }
70
71 117 return *this;
72 }
73
74
75 4579 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 4579 std::string::const_iterator itr = spec.begin();
80 4579 const std::string::const_iterator end = spec.end();
81
82 4579 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 17980 times.
✓ Branch 2 taken 4579 times.
 22559 while (itr != end) {
84
2/2
✓ Branch 1 taken 8252 times.
✓ Branch 2 taken 9728 times.
 17980 if (*itr == kSeparator) {
85 8252 ++itr;
86 8252 continue;
87 }
88
1/2
✓ Branch 1 taken 9728 times.
✗ Branch 2 not taken.
 9728 ParsePathElement(end, &itr);
89 }
90 4579 }
91
92 9728 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 9728 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 48589 times.
✓ Branch 2 taken 4446 times.
✓ Branch 4 taken 43307 times.
✓ Branch 5 taken 5282 times.
✓ Branch 6 taken 43307 times.
✓ Branch 7 taken 9728 times.
 53035 while (*itr != end && **itr != kSeparator) {
97 43307 ++(*itr);
98 }
99 9728 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 9728 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 9728 times.
✗ Branch 5 not taken.
 9728 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 9728 }
104
105 10880 bool Pathspec::IsMatching(const std::string &query_path) const {
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 10880 times.
 10880 assert(IsValid());
107
108
2/2
✓ Branch 1 taken 273 times.
✓ Branch 2 taken 10607 times.
 10880 if (query_path.empty()) {
109 273 return false;
110 }
111
112 10607 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 6704 times.
✓ Branch 2 taken 514 times.
 7218 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 7218 times.
✓ Branch 1 taken 3389 times.
✓ Branch 3 taken 4630 times.
✓ Branch 4 taken 5463 times.
 17825 && IsPathspecMatching(query_path);
115 }
116
117 480 bool Pathspec::IsPrefixMatching(const std::string &query_path) const {
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 480 times.
 480 assert(IsValid());
119
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 480 times.
 480 assert(IsAbsolute());
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 480 times.
 480 if (query_path.empty()) {
122 ✗ return false;
123 }
124
125 480 const bool query_is_absolute = (query_path[0] == kSeparator);
126
4/4
✓ Branch 0 taken 440 times.
✓ Branch 1 taken 40 times.
✓ Branch 3 taken 280 times.
✓ Branch 4 taken 160 times.
 480 return (query_is_absolute && IsPathspecPrefixMatching(query_path));
127 }
128
129 4756 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4756 times.
 4756 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 324 times.
✓ Branch 2 taken 4432 times.
 4756 if (query_path.empty()) {
133 324 return false;
134 }
135
136 4432 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 10093 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 10093 return ApplyRegularExpression(query_path, GetRegularExpression());
141 }
142
143 440 bool Pathspec::IsPathspecPrefixMatching(const std::string &query_path) const {
144 440 return ApplyRegularExpression(query_path, GetPrefixRegularExpression());
145 }
146
147 4432 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 4432 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 14965 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 14965 const char *path = query_path.c_str();
154 14965 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 8783 times.
✓ Branch 1 taken 6182 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 8783 times.
 14965 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 14965 return (retval == 0);
161 }
162
163 10093 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 2114 times.
✓ Branch 1 taken 7979 times.
 10093 if (!regex_compiled_) {
165 2114 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 2114 times.
✗ Branch 2 not taken.
 2114 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 2114 times.
✗ Branch 3 not taken.
 2114 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 2114 times.
✗ Branch 2 not taken.
 2114 regex_ = CompileRegularExpression(regex);
170 2114 regex_compiled_ = true;
171 2114 }
172
173 10093 return regex_;
174 }
175
176 440 regex_t *Pathspec::GetPrefixRegularExpression() const {
177
2/2
✓ Branch 0 taken 80 times.
✓ Branch 1 taken 360 times.
 440 if (!prefix_regex_compiled_) {
178 80 const bool is_relaxed = false;
179 80 const bool is_prefix = true;
180
1/2
✓ Branch 1 taken 80 times.
✗ Branch 2 not taken.
 80 const std::string regex = GenerateRegularExpression(is_relaxed, is_prefix);
181
1/2
✓ Branch 2 taken 80 times.
✗ Branch 3 not taken.
 80 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
182
183
1/2
✓ Branch 1 taken 80 times.
✗ Branch 2 not taken.
 80 prefix_regex_ = CompileRegularExpression(regex);
184 80 prefix_regex_compiled_ = true;
185 80 }
186
187 440 return prefix_regex_;
188 }
189
190 4432 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 584 times.
✓ Branch 1 taken 3848 times.
 4432 if (!relaxed_regex_compiled_) {
192 584 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 584 times.
✗ Branch 2 not taken.
 584 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 584 times.
✗ Branch 3 not taken.
 584 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 584 times.
✗ Branch 2 not taken.
 584 relaxed_regex_ = CompileRegularExpression(regex);
198 584 relaxed_regex_compiled_ = true;
199 584 }
200
201 4432 return relaxed_regex_;
202 }
203
204 2778 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 2778 times.
✗ Branch 3 not taken.
 2778 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 2147 times.
✓ Branch 2 taken 631 times.
 2778 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 2147 times.
✗ Branch 2 not taken.
 2147 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 2778 ElementPatterns::const_iterator i = patterns_.begin();
216 2778 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 5848 times.
✓ Branch 3 taken 2778 times.
 8626 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 5848 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 5848 times.
✗ Branch 6 not taken.
 5848 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 3070 times.
✓ Branch 3 taken 2778 times.
 5848 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 3070 times.
✗ Branch 2 not taken.
 3070 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 80 times.
✓ Branch 1 taken 2698 times.
 2778 if (is_prefix) {
225
1/2
✓ Branch 1 taken 80 times.
✗ Branch 2 not taken.
 80 regex += "($|";
226
1/2
✓ Branch 1 taken 80 times.
✗ Branch 2 not taken.
 80 regex += kSeparator;
227
1/2
✓ Branch 1 taken 80 times.
✗ Branch 2 not taken.
 80 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 2698 times.
✗ Branch 2 not taken.
 2698 regex += kSeparator;
232
1/2
✓ Branch 1 taken 2698 times.
✗ Branch 2 not taken.
 2698 regex += "?$";
233 }
234
235 5556 return regex;
236 }
237
238 2778 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 2778 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 2778 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 2778 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2778 times.
 2778 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 2778 return result;
249 }
250
251 6676 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 2114 times.
✓ Branch 1 taken 4562 times.
 6676 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2114 times.
 2114 assert(regex_ != NULL);
254 2114 regfree(regex_);
255 2114 regex_ = NULL;
256 2114 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 584 times.
✓ Branch 1 taken 6092 times.
 6676 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 584 times.
 584 assert(relaxed_regex_ != NULL);
261 584 regfree(relaxed_regex_);
262 584 relaxed_regex_ = NULL;
263 584 relaxed_regex_compiled_ = false;
264 }
265 6676 }
266
267 1973 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 1554 times.
✗ Branch 5 not taken.
 3527 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 1554 times.
✓ Branch 1 taken 419 times.
✓ Branch 4 taken 85 times.
✓ Branch 5 taken 1469 times.
✓ Branch 6 taken 504 times.
✓ Branch 7 taken 1469 times.
 3527 || IsAbsolute() != other.IsAbsolute()) {
270 504 return false;
271 }
272
273 1469 ElementPatterns::const_iterator i = patterns_.begin();
274 1469 const ElementPatterns::const_iterator iend = patterns_.end();
275 1469 ElementPatterns::const_iterator j = other.patterns_.begin();
276 1469 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 3104 times.
✓ Branch 4 taken 612 times.
✓ Branch 6 taken 3104 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 3104 times.
✓ Branch 9 taken 612 times.
 3716 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 3104 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 857 times.
✓ Branch 6 taken 2247 times.
 3104 if (*i != *j) {
280 857 return false;
281 }
282 }
283
284 612 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 663 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 663 times.
✗ Branch 1 not taken.
 663 if (!glob_string_sequence_compiled_) {
297 663 GenerateGlobStringSequence();
298 663 glob_string_sequence_compiled_ = true;
299 }
300 663 return glob_string_sequence_;
301 }
302
303
304 663 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 663 times.
 663 assert(glob_string_sequence_.empty());
306 663 ElementPatterns::const_iterator i = patterns_.begin();
307 663 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 1326 times.
✓ Branch 3 taken 663 times.
 1989 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 1326 times.
✗ Branch 3 not taken.
 1326 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 1326 times.
✗ Branch 2 not taken.
 1326 glob_string_sequence_.push_back(glob_string);
311 1326 }
312 663 }
313
314
315 897 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 663 times.
✓ Branch 1 taken 234 times.
 897 if (!glob_string_compiled_) {
317 663 GenerateGlobString();
318 663 glob_string_compiled_ = true;
319 }
320 897 return glob_string_;
321 }
322
323
324 663 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 663 times.
 663 assert(glob_string_.empty());
326
327 663 bool is_first = true;
328
1/2
✓ Branch 1 taken 663 times.
✗ Branch 2 not taken.
 663 const GlobStringSequence &seq = GetGlobStringSequence();
329 663 GlobStringSequence::const_iterator i = seq.begin();
330 663 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 1326 times.
✓ Branch 2 taken 663 times.
 1989 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 663 times.
✓ Branch 1 taken 663 times.
✓ Branch 3 taken 429 times.
✓ Branch 4 taken 234 times.
✓ Branch 5 taken 1092 times.
✓ Branch 6 taken 234 times.
 1326 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 1092 times.
✗ Branch 2 not taken.
 1092 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 1326 times.
✗ Branch 3 not taken.
 1326 glob_string_ += *i;
336 1326 is_first = false;
337 }
338 663 }
339