GCC Code Coverage Report

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