GCC Code Coverage Report

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