GCC Code Coverage Report

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