GCC Code Coverage Report

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