GCC Code Coverage Report

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