GCC Code Coverage Report

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