GCC Code Coverage Report

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