GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2025-12-21 02:39:23
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 4676 Pathspec::Pathspec(const std::string &spec)
13 4676 : regex_(NULL)
14 4676 , relaxed_regex_(NULL)
15 4676 , prefix_regex_(NULL)
16 4676 , regex_compiled_(false)
17 4676 , relaxed_regex_compiled_(false)
18 4676 , prefix_regex_compiled_(false)
19 4676 , glob_string_compiled_(false)
20 4676 , glob_string_sequence_compiled_(false)
21 4676 , valid_(true)
22 4676 , absolute_(false) {
23
1/2
✓ Branch 1 taken 4676 times.
✗ Branch 2 not taken.
 4676 Parse(spec);
24
2/2
✓ Branch 1 taken 42 times.
✓ Branch 2 taken 4634 times.
 4676 if (patterns_.size() == 0) {
25 42 valid_ = false;
26 }
27
28 4676 ElementPatterns::const_iterator i = patterns_.begin();
29 4676 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 9891 times.
✓ Branch 3 taken 4676 times.
 14567 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 51 times.
✓ Branch 3 taken 9840 times.
 9891 if (!i->IsValid()) {
32 51 valid_ = false;
33 }
34 }
35 4676 }
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 1723 Pathspec::Pathspec(const Pathspec &other)
40 1723 : patterns_(other.patterns_)
41 1723 , regex_(NULL)
42 1723 , relaxed_regex_(NULL)
43 1723 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 1723 times.
✗ Branch 2 not taken.
 1723 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 1723 times.
✗ Branch 2 not taken.
 1723 , glob_string_sequence_(other.glob_string_sequence_)
46 1723 , regex_compiled_(false)
47 1723 , relaxed_regex_compiled_(false)
48 1723 , prefix_regex_compiled_(false)
49 1723 , glob_string_compiled_(other.glob_string_compiled_)
50 1723 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 1723 , valid_(other.valid_)
52 1723 , absolute_(other.absolute_) { }
53
54 6396 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 126 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 126 times.
✗ Branch 1 not taken.
 126 if (this != &other) {
58 126 DestroyRegularExpressions(); // see: copy c'tor for details
59 126 patterns_ = other.patterns_;
60
61 126 glob_string_compiled_ = other.glob_string_compiled_;
62 126 glob_string_ = other.glob_string_;
63
64 126 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 126 glob_string_sequence_ = other.glob_string_sequence_;
66
67 126 valid_ = other.valid_;
68 126 absolute_ = other.absolute_;
69 }
70
71 126 return *this;
72 }
73
74
75 4676 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 4676 std::string::const_iterator itr = spec.begin();
80 4676 const std::string::const_iterator end = spec.end();
81
82 4676 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 18243 times.
✓ Branch 2 taken 4676 times.
 22919 while (itr != end) {
84
2/2
✓ Branch 1 taken 8352 times.
✓ Branch 2 taken 9891 times.
 18243 if (*itr == kSeparator) {
85 8352 ++itr;
86 8352 continue;
87 }
88
1/2
✓ Branch 1 taken 9891 times.
✗ Branch 2 not taken.
 9891 ParsePathElement(end, &itr);
89 }
90 4676 }
91
92 9891 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 9891 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 49706 times.
✓ Branch 2 taken 4544 times.
✓ Branch 4 taken 44359 times.
✓ Branch 5 taken 5347 times.
✓ Branch 6 taken 44359 times.
✓ Branch 7 taken 9891 times.
 54250 while (*itr != end && **itr != kSeparator) {
97 44359 ++(*itr);
98 }
99 9891 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 9891 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 9891 times.
✗ Branch 5 not taken.
 9891 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 9891 }
104
105 11114 bool Pathspec::IsMatching(const std::string &query_path) const {
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 11114 times.
 11114 assert(IsValid());
107
108
2/2
✓ Branch 1 taken 268 times.
✓ Branch 2 taken 10846 times.
 11114 if (query_path.empty()) {
109 268 return false;
110 }
111
112 10846 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 6759 times.
✓ Branch 2 taken 537 times.
 7296 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 7296 times.
✓ Branch 1 taken 3550 times.
✓ Branch 3 taken 4764 times.
✓ Branch 4 taken 5545 times.
 18142 && IsPathspecMatching(query_path);
115 }
116
117 504 bool Pathspec::IsPrefixMatching(const std::string &query_path) const {
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 504 times.
 504 assert(IsValid());
119
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 504 times.
 504 assert(IsAbsolute());
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 504 times.
 504 if (query_path.empty()) {
122 ✗ return false;
123 }
124
125 504 const bool query_is_absolute = (query_path[0] == kSeparator);
126
4/4
✓ Branch 0 taken 462 times.
✓ Branch 1 taken 42 times.
✓ Branch 3 taken 294 times.
✓ Branch 4 taken 168 times.
 504 return (query_is_absolute && IsPathspecPrefixMatching(query_path));
127 }
128
129 4483 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4483 times.
 4483 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 288 times.
✓ Branch 2 taken 4195 times.
 4483 if (query_path.empty()) {
133 288 return false;
134 }
135
136 4195 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 10309 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 10309 return ApplyRegularExpression(query_path, GetRegularExpression());
141 }
142
143 462 bool Pathspec::IsPathspecPrefixMatching(const std::string &query_path) const {
144 462 return ApplyRegularExpression(query_path, GetPrefixRegularExpression());
145 }
146
147 4195 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 4195 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 14966 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 14966 const char *path = query_path.c_str();
154 14966 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 8635 times.
✓ Branch 1 taken 6331 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 8635 times.
 14966 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 14966 return (retval == 0);
161 }
162
163 10309 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 2181 times.
✓ Branch 1 taken 8128 times.
 10309 if (!regex_compiled_) {
165 2181 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 2181 times.
✗ Branch 2 not taken.
 2181 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 2181 times.
✗ Branch 3 not taken.
 2181 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 2181 times.
✗ Branch 2 not taken.
 2181 regex_ = CompileRegularExpression(regex);
170 2181 regex_compiled_ = true;
171 2181 }
172
173 10309 return regex_;
174 }
175
176 462 regex_t *Pathspec::GetPrefixRegularExpression() const {
177
2/2
✓ Branch 0 taken 84 times.
✓ Branch 1 taken 378 times.
 462 if (!prefix_regex_compiled_) {
178 84 const bool is_relaxed = false;
179 84 const bool is_prefix = true;
180
1/2
✓ Branch 1 taken 84 times.
✗ Branch 2 not taken.
 84 const std::string regex = GenerateRegularExpression(is_relaxed, is_prefix);
181
1/2
✓ Branch 2 taken 84 times.
✗ Branch 3 not taken.
 84 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
182
183
1/2
✓ Branch 1 taken 84 times.
✗ Branch 2 not taken.
 84 prefix_regex_ = CompileRegularExpression(regex);
184 84 prefix_regex_compiled_ = true;
185 84 }
186
187 462 return prefix_regex_;
188 }
189
190 4195 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 580 times.
✓ Branch 1 taken 3615 times.
 4195 if (!relaxed_regex_compiled_) {
192 580 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 580 times.
✗ Branch 2 not taken.
 580 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 580 times.
✗ Branch 3 not taken.
 580 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 580 times.
✗ Branch 2 not taken.
 580 relaxed_regex_ = CompileRegularExpression(regex);
198 580 relaxed_regex_compiled_ = true;
199 580 }
200
201 4195 return relaxed_regex_;
202 }
203
204 2845 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 2845 times.
✗ Branch 3 not taken.
 2845 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 2190 times.
✓ Branch 2 taken 655 times.
 2845 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 2190 times.
✗ Branch 2 not taken.
 2190 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 2845 ElementPatterns::const_iterator i = patterns_.begin();
216 2845 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 5975 times.
✓ Branch 3 taken 2845 times.
 8820 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 5975 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 5975 times.
✗ Branch 6 not taken.
 5975 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 3130 times.
✓ Branch 3 taken 2845 times.
 5975 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 3130 times.
✗ Branch 2 not taken.
 3130 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 84 times.
✓ Branch 1 taken 2761 times.
 2845 if (is_prefix) {
225
1/2
✓ Branch 1 taken 84 times.
✗ Branch 2 not taken.
 84 regex += "($|";
226
1/2
✓ Branch 1 taken 84 times.
✗ Branch 2 not taken.
 84 regex += kSeparator;
227
1/2
✓ Branch 1 taken 84 times.
✗ Branch 2 not taken.
 84 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 2761 times.
✗ Branch 2 not taken.
 2761 regex += kSeparator;
232
1/2
✓ Branch 1 taken 2761 times.
✗ Branch 2 not taken.
 2761 regex += "?$";
233 }
234
235 5690 return regex;
236 }
237
238 2845 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 2845 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 2845 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 2845 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2845 times.
 2845 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 2845 return result;
249 }
250
251 6522 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 2181 times.
✓ Branch 1 taken 4341 times.
 6522 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2181 times.
 2181 assert(regex_ != NULL);
254 2181 regfree(regex_);
255 2181 regex_ = NULL;
256 2181 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 580 times.
✓ Branch 1 taken 5942 times.
 6522 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 580 times.
 580 assert(relaxed_regex_ != NULL);
261 580 regfree(relaxed_regex_);
262 580 relaxed_regex_ = NULL;
263 580 relaxed_regex_compiled_ = false;
264 }
265 6522 }
266
267 1962 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 1584 times.
✗ Branch 5 not taken.
 3546 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 1584 times.
✓ Branch 1 taken 378 times.
✓ Branch 4 taken 80 times.
✓ Branch 5 taken 1504 times.
✓ Branch 6 taken 458 times.
✓ Branch 7 taken 1504 times.
 3546 || IsAbsolute() != other.IsAbsolute()) {
270 458 return false;
271 }
272
273 1504 ElementPatterns::const_iterator i = patterns_.begin();
274 1504 const ElementPatterns::const_iterator iend = patterns_.end();
275 1504 ElementPatterns::const_iterator j = other.patterns_.begin();
276 1504 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 3180 times.
✓ Branch 4 taken 640 times.
✓ Branch 6 taken 3180 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 3180 times.
✓ Branch 9 taken 640 times.
 3820 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 3180 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 864 times.
✓ Branch 6 taken 2316 times.
 3180 if (*i != *j) {
280 864 return false;
281 }
282 }
283
284 640 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 701 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 701 times.
✗ Branch 1 not taken.
 701 if (!glob_string_sequence_compiled_) {
297 701 GenerateGlobStringSequence();
298 701 glob_string_sequence_compiled_ = true;
299 }
300 701 return glob_string_sequence_;
301 }
302
303
304 701 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 701 times.
 701 assert(glob_string_sequence_.empty());
306 701 ElementPatterns::const_iterator i = patterns_.begin();
307 701 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 1402 times.
✓ Branch 3 taken 701 times.
 2103 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 1402 times.
✗ Branch 3 not taken.
 1402 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 1402 times.
✗ Branch 2 not taken.
 1402 glob_string_sequence_.push_back(glob_string);
311 1402 }
312 701 }
313
314
315 950 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 701 times.
✓ Branch 1 taken 249 times.
 950 if (!glob_string_compiled_) {
317 701 GenerateGlobString();
318 701 glob_string_compiled_ = true;
319 }
320 950 return glob_string_;
321 }
322
323
324 701 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 701 times.
 701 assert(glob_string_.empty());
326
327 701 bool is_first = true;
328
1/2
✓ Branch 1 taken 701 times.
✗ Branch 2 not taken.
 701 const GlobStringSequence &seq = GetGlobStringSequence();
329 701 GlobStringSequence::const_iterator i = seq.begin();
330 701 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 1402 times.
✓ Branch 2 taken 701 times.
 2103 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 701 times.
✓ Branch 1 taken 701 times.
✓ Branch 3 taken 455 times.
✓ Branch 4 taken 246 times.
✓ Branch 5 taken 1156 times.
✓ Branch 6 taken 246 times.
 1402 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 1156 times.
✗ Branch 2 not taken.
 1156 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 1402 times.
✗ Branch 3 not taken.
 1402 glob_string_ += *i;
336 1402 is_first = false;
337 }
338 701 }
339