GCC Code Coverage Report

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