GCC Code Coverage Report


Directory: cvmfs/
File: cvmfs/path_filters/dirtab.cc
Date: 2025-06-22 02:36:02
Exec Total Coverage
Lines: 86 94 91.5%
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 396 Dirtab::Dirtab() : valid_(true) { }
19
20
21 20 bool Dirtab::Open(const std::string &dirtab_path) {
22
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 20 times.
20 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 20 FILE *dirtab_file = fopen(dirtab_path.c_str(), "r");
30
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 20 times.
20 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 20 valid_ = Parse(dirtab_file);
40 20 fclose(dirtab_file);
41 20 return valid_;
42 }
43
44 316 bool Dirtab::Parse(const std::string &dirtab) {
45 316 valid_ = true;
46 316 off_t line_offset = 0;
47
2/2
✓ Branch 1 taken 1508 times.
✓ Branch 2 taken 316 times.
1824 while (line_offset < static_cast<off_t>(dirtab.size())) {
48 const std::string line =
49
1/2
✓ Branch 3 taken 1508 times.
✗ Branch 4 not taken.
1508 GetLineMem(dirtab.c_str() + line_offset, dirtab.size() - line_offset);
50 1508 line_offset += line.size() + 1; // +1 == skipped \n
51
3/4
✓ Branch 1 taken 1508 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 28 times.
✓ Branch 4 taken 1480 times.
1508 if (!ParseLine(line)) {
52 28 valid_ = false;
53 }
54 1508 }
55
4/4
✓ Branch 0 taken 288 times.
✓ Branch 1 taken 28 times.
✓ Branch 3 taken 274 times.
✓ Branch 4 taken 14 times.
316 valid_ = valid_ && CheckRuleValidity();
56 316 return valid_;
57 }
58
59
60 40 bool Dirtab::Parse(FILE *dirtab_file) {
61 40 valid_ = true;
62 40 std::string line;
63
3/4
✓ Branch 1 taken 80 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 40 times.
✓ Branch 4 taken 40 times.
80 while (GetLineFile(dirtab_file, &line)) {
64
2/4
✓ Branch 1 taken 40 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 40 times.
40 if (!ParseLine(line)) {
65 valid_ = false;
66 }
67 }
68
3/6
✓ Branch 0 taken 40 times.
✗ Branch 1 not taken.
✓ Branch 3 taken 40 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 40 times.
✗ Branch 6 not taken.
40 valid_ = valid_ && CheckRuleValidity();
69 40 return valid_;
70 40 }
71
72
73 1548 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 1548 std::string::const_iterator itr = line.begin();
78 1548 const std::string::const_iterator iend = line.end();
79 1548 bool negation = false;
80
81 // parse preamble
82 1548 SkipWhitespace(iend, &itr);
83
2/2
✓ Branch 1 taken 478 times.
✓ Branch 2 taken 1070 times.
1548 if (*itr == Dirtab::kCommentMarker) {
84 478 return true;
85
2/2
✓ Branch 1 taken 452 times.
✓ Branch 2 taken 618 times.
1070 } else if (*itr == Dirtab::kNegationMarker) {
86 452 negation = true;
87 452 ++itr;
88 452 SkipWhitespace(iend, &itr);
89 }
90
91 // extract and parse pathspec
92
2/4
✓ Branch 2 taken 1070 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 1070 times.
✗ Branch 6 not taken.
2140 const std::string pathspec_str(Trim(std::string(itr, iend)));
93
1/2
✓ Branch 1 taken 1070 times.
✗ Branch 2 not taken.
1070 return this->ParsePathspec(pathspec_str, negation);
94 1070 }
95
96 1270 bool Dirtab::ParsePathspec(const std::string &pathspec_str, bool negation) {
97
2/2
✓ Branch 1 taken 140 times.
✓ Branch 2 taken 1130 times.
1270 if (pathspec_str.empty()) {
98 140 return true;
99 }
100
1/2
✓ Branch 1 taken 1130 times.
✗ Branch 2 not taken.
1130 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 1116 times.
✓ Branch 2 taken 14 times.
✓ Branch 3 taken 678 times.
✓ Branch 4 taken 438 times.
✓ Branch 6 taken 14 times.
✓ Branch 7 taken 664 times.
✓ Branch 8 taken 28 times.
✓ Branch 9 taken 1102 times.
1130 if (!pathspec.IsValid() || (!negation && !pathspec.IsAbsolute())) {
105 28 return false;
106 }
107
108 // create a new dirtab rule
109
1/2
✓ Branch 1 taken 1102 times.
✗ Branch 2 not taken.
1102 const Rule rule(pathspec, negation);
110
1/2
✓ Branch 1 taken 1102 times.
✗ Branch 2 not taken.
1102 AddRule(rule);
111 1102 return true;
112 1130 }
113
114
115 1102 void Dirtab::AddRule(const Rule &rule) {
116
2/2
✓ Branch 0 taken 438 times.
✓ Branch 1 taken 664 times.
1102 if (rule.is_negation) {
117 438 negative_rules_.push_back(rule);
118 } else {
119 664 positive_rules_.push_back(rule);
120 }
121 1102 }
122
123
124 328 bool Dirtab::CheckRuleValidity() const {
125 // check if there are contradicting positive and negative rules
126 328 Rules::const_iterator p = positive_rules_.begin();
127 328 const Rules::const_iterator pend = positive_rules_.end();
128
2/2
✓ Branch 2 taken 650 times.
✓ Branch 3 taken 314 times.
964 for (; p != pend; ++p) {
129
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 650 times.
650 assert(!p->is_negation);
130 650 Rules::const_iterator n = negative_rules_.begin();
131 650 const Rules::const_iterator nend = negative_rules_.end();
132
2/2
✓ Branch 2 taken 944 times.
✓ Branch 3 taken 636 times.
1580 for (; n != nend; ++n) {
133
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 944 times.
944 assert(n->is_negation);
134
3/4
✓ Branch 3 taken 944 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 14 times.
✓ Branch 6 taken 930 times.
944 if (p->pathspec == n->pathspec) {
135 14 return false;
136 }
137 }
138 }
139
140 314 return true;
141 }
142
143
144 1456 bool Dirtab::IsMatching(const std::string &path) const {
145 // check if path has a positive match
146 1456 bool has_positive_match = false;
147 1456 Rules::const_iterator p = positive_rules_.begin();
148 1456 const Rules::const_iterator pend = positive_rules_.end();
149
2/2
✓ Branch 2 taken 3192 times.
✓ Branch 3 taken 734 times.
3926 for (; p != pend; ++p) {
150
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 3192 times.
3192 assert(!p->is_negation);
151
3/4
✓ Branch 2 taken 3192 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 722 times.
✓ Branch 5 taken 2470 times.
3192 if (p->pathspec.IsMatching(path)) {
152 722 has_positive_match = true;
153 722 break;
154 }
155 }
156
157
5/6
✓ Branch 0 taken 722 times.
✓ Branch 1 taken 734 times.
✓ Branch 3 taken 722 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 624 times.
✓ Branch 6 taken 98 times.
1456 return has_positive_match && !IsOpposing(path);
158 }
159
160
161 2868 bool Dirtab::IsOpposing(const std::string &path) const {
162 2868 Rules::const_iterator n = negative_rules_.begin();
163 2868 const Rules::const_iterator nend = negative_rules_.end();
164
2/2
✓ Branch 2 taken 4578 times.
✓ Branch 3 taken 2440 times.
7018 for (; n != nend; ++n) {
165
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4578 times.
4578 assert(n->is_negation);
166
3/4
✓ Branch 2 taken 4578 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 428 times.
✓ Branch 5 taken 4150 times.
4578 if (n->pathspec.IsMatchingRelaxed(path)) {
167 428 return true;
168 }
169 }
170
171 2440 return false;
172 }
173
174 } // namespace catalog
175