GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/path_filters/dirtab.cc
Date: 2025-10-05 02:35:40
Exec Total Coverage
Lines: 87 95 91.6%
Branches: 68 92 73.9%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #include "dirtab.h"
6
7 #include <cassert>
8 #include <cerrno>
9 #include <cstdio>
10 #include <cstdlib>
11
12 #include "util/logging.h"
13 #include "util/posix.h"
14 #include "util/string.h"
15
16 namespace catalog {
17
18 276 Dirtab::Dirtab() : valid_(true) { }
19
20
21 1 bool Dirtab::Open(const std::string &dirtab_path) {
22
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1 times.
 1 if (!FileExists(dirtab_path)) {
23 ✗ LogCvmfs(kLogCatalog, kLogStderr, "Cannot find dirtab at '%s'",
24 dirtab_path.c_str());
25 ✗ valid_ = false;
26 ✗ return valid_;
27 }
28
29 1 FILE *dirtab_file = fopen(dirtab_path.c_str(), "r");
30
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
 1 if (dirtab_file == NULL) {
31 ✗ LogCvmfs(kLogCatalog, kLogStderr,
32 "Cannot open dirtab for reading at '%s' "
33 "(errno: %d)",
34 ✗ dirtab_path.c_str(), errno);
35 ✗ valid_ = false;
36 ✗ return valid_;
37 }
38
39 1 valid_ = Parse(dirtab_file);
40 1 fclose(dirtab_file);
41 1 return valid_;
42 }
43
44 272 bool Dirtab::Parse(const std::string &dirtab) {
45 272 valid_ = true;
46 272 off_t line_offset = 0;
47
2/2
✓ Branch 1 taken 1210 times.
✓ Branch 2 taken 272 times.
 1482 while (line_offset < static_cast<off_t>(dirtab.size())) {
48 2420 const std::string line = GetLineMem(dirtab.c_str() + line_offset,
49
1/2
✓ Branch 3 taken 1210 times.
✗ Branch 4 not taken.
 1210 dirtab.size() - line_offset);
50 1210 line_offset += line.size() + 1; // +1 == skipped \n
51
3/4
✓ Branch 1 taken 1210 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 38 times.
✓ Branch 4 taken 1172 times.
 1210 if (!ParseLine(line)) {
52 38 valid_ = false;
53 }
54 1210 }
55
4/4
✓ Branch 0 taken 234 times.
✓ Branch 1 taken 38 times.
✓ Branch 3 taken 215 times.
✓ Branch 4 taken 19 times.
 272 valid_ = valid_ && CheckRuleValidity();
56 272 return valid_;
57 }
58
59
60 2 bool Dirtab::Parse(FILE *dirtab_file) {
61 2 valid_ = true;
62 2 std::string line;
63
3/4
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 2 times.
 4 while (GetLineFile(dirtab_file, &line)) {
64
2/4
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 2 times.
 2 if (!ParseLine(line)) {
65 ✗ valid_ = false;
66 }
67 }
68
3/6
✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
✓ Branch 3 taken 2 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✗ Branch 6 not taken.
 2 valid_ = valid_ && CheckRuleValidity();
69 2 return valid_;
70 2 }
71
72
73 1212 bool Dirtab::ParseLine(const std::string &line) {
74 // line parsing is done using std::string iterators. Each parsing method ex-
75 // pects an iterator and the end iterator. While parsing itr is constantly
76 // incremented to walk through the given .cvmfsdirtab line.
77 1212 std::string::const_iterator itr = line.begin();
78 1212 const std::string::const_iterator iend = line.end();
79 1212 bool negation = false;
80
81 // parse preamble
82 1212 SkipWhitespace(iend, &itr);
83
2/2
✓ Branch 1 taken 335 times.
✓ Branch 2 taken 877 times.
 1212 if (*itr == Dirtab::kCommentMarker) {
84 335 return true;
85
2/2
✓ Branch 1 taken 352 times.
✓ Branch 2 taken 525 times.
 877 } else if (*itr == Dirtab::kNegationMarker) {
86 352 negation = true;
87 352 ++itr;
88 352 SkipWhitespace(iend, &itr);
89 }
90
91 // extract and parse pathspec
92
2/4
✓ Branch 2 taken 877 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 877 times.
✗ Branch 6 not taken.
 1754 const std::string pathspec_str(Trim(std::string(itr, iend)));
93
1/2
✓ Branch 1 taken 877 times.
✗ Branch 2 not taken.
 877 return this->ParsePathspec(pathspec_str, negation);
94 877 }
95
96 887 bool Dirtab::ParsePathspec(const std::string &pathspec_str, bool negation) {
97
2/2
✓ Branch 1 taken 190 times.
✓ Branch 2 taken 697 times.
 887 if (pathspec_str.empty()) {
98 190 return true;
99 }
100
1/2
✓ Branch 1 taken 697 times.
✗ Branch 2 not taken.
 697 const Pathspec pathspec(pathspec_str);
101
102 // all generated Pathspecs need to be valid and positive rules must be
103 // absolute. Otherwise the .cvmfsdirtab is not valid.
104
8/8
✓ Branch 1 taken 678 times.
✓ Branch 2 taken 19 times.
✓ Branch 3 taken 345 times.
✓ Branch 4 taken 333 times.
✓ Branch 6 taken 19 times.
✓ Branch 7 taken 326 times.
✓ Branch 8 taken 38 times.
✓ Branch 9 taken 659 times.
 697 if (!pathspec.IsValid() || (!negation && !pathspec.IsAbsolute())) {
105 38 return false;
106 }
107
108 // create a new dirtab rule
109
1/2
✓ Branch 1 taken 659 times.
✗ Branch 2 not taken.
 659 const Rule rule(pathspec, negation);
110
1/2
✓ Branch 1 taken 659 times.
✗ Branch 2 not taken.
 659 AddRule(rule);
111 659 return true;
112 697 }
113
114
115 659 void Dirtab::AddRule(const Rule &rule) {
116
2/2
✓ Branch 0 taken 333 times.
✓ Branch 1 taken 326 times.
 659 if (rule.is_negation) {
117 333 negative_rules_.push_back(rule);
118 } else {
119 326 positive_rules_.push_back(rule);
120 }
121 659 }
122
123
124 236 bool Dirtab::CheckRuleValidity() const {
125 // check if there are contradicting positive and negative rules
126 236 Rules::const_iterator p = positive_rules_.begin();
127 236 const Rules::const_iterator pend = positive_rules_.end();
128
2/2
✓ Branch 2 taken 307 times.
✓ Branch 3 taken 217 times.
 524 for (; p != pend; ++p) {
129
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 307 times.
 307 assert(!p->is_negation);
130 307 Rules::const_iterator n = negative_rules_.begin();
131 307 const Rules::const_iterator nend = negative_rules_.end();
132
2/2
✓ Branch 2 taken 523 times.
✓ Branch 3 taken 288 times.
 811 for (; n != nend; ++n) {
133
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 523 times.
 523 assert(n->is_negation);
134
3/4
✓ Branch 3 taken 523 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 19 times.
✓ Branch 6 taken 504 times.
 523 if (p->pathspec == n->pathspec) {
135 19 return false;
136 }
137 }
138 }
139
140 217 return true;
141 }
142
143
144 695 bool Dirtab::IsMatching(const std::string &path) const {
145 // check if path has a positive match
146 695 bool has_positive_match = false;
147 695 Rules::const_iterator p = positive_rules_.begin();
148 695 const Rules::const_iterator pend = positive_rules_.end();
149
2/2
✓ Branch 2 taken 1038 times.
✓ Branch 3 taken 238 times.
 1276 for (; p != pend; ++p) {
150
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1038 times.
 1038 assert(!p->is_negation);
151
3/4
✓ Branch 2 taken 1038 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 457 times.
✓ Branch 5 taken 581 times.
 1038 if (p->pathspec.IsMatching(path)) {
152 457 has_positive_match = true;
153 457 break;
154 }
155 }
156
157
5/6
✓ Branch 0 taken 457 times.
✓ Branch 1 taken 238 times.
✓ Branch 3 taken 457 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 324 times.
✓ Branch 6 taken 133 times.
 695 return has_positive_match && !IsOpposing(path);
158 }
159
160
161 1095 bool Dirtab::IsOpposing(const std::string &path) const {
162 1095 Rules::const_iterator n = negative_rules_.begin();
163 1095 const Rules::const_iterator nend = negative_rules_.end();
164
2/2
✓ Branch 2 taken 2370 times.
✓ Branch 3 taken 671 times.
 3041 for (; n != nend; ++n) {
165
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 2370 times.
 2370 assert(n->is_negation);
166
3/4
✓ Branch 2 taken 2370 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 424 times.
✓ Branch 5 taken 1946 times.
 2370 if (n->pathspec.IsMatchingRelaxed(path)) {
167 424 return true;
168 }
169 }
170
171 671 return false;
172 }
173
174 } // namespace catalog
175