GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/path_filters/dirtab.cc
Date: 2026-01-25 02:35:50
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 258 Dirtab::Dirtab() : valid_(true) { }
19
20
21 9 bool Dirtab::Open(const std::string &dirtab_path) {
22
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 9 times.
 9 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 9 FILE *dirtab_file = fopen(dirtab_path.c_str(), "r");
30
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 9 times.
 9 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 9 valid_ = Parse(dirtab_file);
40 9 fclose(dirtab_file);
41 9 return valid_;
42 }
43
44 222 bool Dirtab::Parse(const std::string &dirtab) {
45 222 valid_ = true;
46 222 off_t line_offset = 0;
47
2/2
✓ Branch 1 taken 1032 times.
✓ Branch 2 taken 222 times.
 1254 while (line_offset < static_cast<off_t>(dirtab.size())) {
48 2064 const std::string line = GetLineMem(dirtab.c_str() + line_offset,
49
1/2
✓ Branch 3 taken 1032 times.
✗ Branch 4 not taken.
 1032 dirtab.size() - line_offset);
50 1032 line_offset += line.size() + 1; // +1 == skipped \n
51
3/4
✓ Branch 1 taken 1032 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 24 times.
✓ Branch 4 taken 1008 times.
 1032 if (!ParseLine(line)) {
52 24 valid_ = false;
53 }
54 1032 }
55
4/4
✓ Branch 0 taken 198 times.
✓ Branch 1 taken 24 times.
✓ Branch 3 taken 186 times.
✓ Branch 4 taken 12 times.
 222 valid_ = valid_ && CheckRuleValidity();
56 222 return valid_;
57 }
58
59
60 18 bool Dirtab::Parse(FILE *dirtab_file) {
61 18 valid_ = true;
62 18 std::string line;
63
3/4
✓ Branch 1 taken 36 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 18 times.
✓ Branch 4 taken 18 times.
 36 while (GetLineFile(dirtab_file, &line)) {
64
2/4
✓ Branch 1 taken 18 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 18 times.
 18 if (!ParseLine(line)) {
65 ✗ valid_ = false;
66 }
67 }
68
3/6
✓ Branch 0 taken 18 times.
✗ Branch 1 not taken.
✓ Branch 3 taken 18 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 18 times.
✗ Branch 6 not taken.
 18 valid_ = valid_ && CheckRuleValidity();
69 18 return valid_;
70 18 }
71
72
73 1050 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 1050 std::string::const_iterator itr = line.begin();
78 1050 const std::string::const_iterator iend = line.end();
79 1050 bool negation = false;
80
81 // parse preamble
82 1050 SkipWhitespace(iend, &itr);
83
2/2
✓ Branch 1 taken 312 times.
✓ Branch 2 taken 738 times.
 1050 if (*itr == Dirtab::kCommentMarker) {
84 312 return true;
85
2/2
✓ Branch 1 taken 306 times.
✓ Branch 2 taken 432 times.
 738 } else if (*itr == Dirtab::kNegationMarker) {
86 306 negation = true;
87 306 ++itr;
88 306 SkipWhitespace(iend, &itr);
89 }
90
91 // extract and parse pathspec
92
2/4
✓ Branch 2 taken 738 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 738 times.
✗ Branch 6 not taken.
 1476 const std::string pathspec_str(Trim(std::string(itr, iend)));
93
1/2
✓ Branch 1 taken 738 times.
✗ Branch 2 not taken.
 738 return this->ParsePathspec(pathspec_str, negation);
94 738 }
95
96 828 bool Dirtab::ParsePathspec(const std::string &pathspec_str, bool negation) {
97
2/2
✓ Branch 1 taken 120 times.
✓ Branch 2 taken 708 times.
 828 if (pathspec_str.empty()) {
98 120 return true;
99 }
100
1/2
✓ Branch 1 taken 708 times.
✗ Branch 2 not taken.
 708 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 696 times.
✓ Branch 2 taken 12 times.
✓ Branch 3 taken 402 times.
✓ Branch 4 taken 294 times.
✓ Branch 6 taken 12 times.
✓ Branch 7 taken 390 times.
✓ Branch 8 taken 24 times.
✓ Branch 9 taken 684 times.
 708 if (!pathspec.IsValid() || (!negation && !pathspec.IsAbsolute())) {
105 24 return false;
106 }
107
108 // create a new dirtab rule
109
1/2
✓ Branch 1 taken 684 times.
✗ Branch 2 not taken.
 684 const Rule rule(pathspec, negation);
110
1/2
✓ Branch 1 taken 684 times.
✗ Branch 2 not taken.
 684 AddRule(rule);
111 684 return true;
112 708 }
113
114
115 684 void Dirtab::AddRule(const Rule &rule) {
116
2/2
✓ Branch 0 taken 294 times.
✓ Branch 1 taken 390 times.
 684 if (rule.is_negation) {
117 294 negative_rules_.push_back(rule);
118 } else {
119 390 positive_rules_.push_back(rule);
120 }
121 684 }
122
123
124 216 bool Dirtab::CheckRuleValidity() const {
125 // check if there are contradicting positive and negative rules
126 216 Rules::const_iterator p = positive_rules_.begin();
127 216 const Rules::const_iterator pend = positive_rules_.end();
128
2/2
✓ Branch 2 taken 378 times.
✓ Branch 3 taken 204 times.
 582 for (; p != pend; ++p) {
129
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 378 times.
 378 assert(!p->is_negation);
130 378 Rules::const_iterator n = negative_rules_.begin();
131 378 const Rules::const_iterator nend = negative_rules_.end();
132
2/2
✓ Branch 2 taken 573 times.
✓ Branch 3 taken 366 times.
 939 for (; n != nend; ++n) {
133
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 573 times.
 573 assert(n->is_negation);
134
3/4
✓ Branch 3 taken 573 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 12 times.
✓ Branch 6 taken 561 times.
 573 if (p->pathspec == n->pathspec) {
135 12 return false;
136 }
137 }
138 }
139
140 204 return true;
141 }
142
143
144 849 bool Dirtab::IsMatching(const std::string &path) const {
145 // check if path has a positive match
146 849 bool has_positive_match = false;
147 849 Rules::const_iterator p = positive_rules_.begin();
148 849 const Rules::const_iterator pend = positive_rules_.end();
149
2/2
✓ Branch 2 taken 1710 times.
✓ Branch 3 taken 393 times.
 2103 for (; p != pend; ++p) {
150
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1710 times.
 1710 assert(!p->is_negation);
151
3/4
✓ Branch 2 taken 1710 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 456 times.
✓ Branch 5 taken 1254 times.
 1710 if (p->pathspec.IsMatching(path)) {
152 456 has_positive_match = true;
153 456 break;
154 }
155 }
156
157
5/6
✓ Branch 0 taken 456 times.
✓ Branch 1 taken 393 times.
✓ Branch 3 taken 456 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 372 times.
✓ Branch 6 taken 84 times.
 849 return has_positive_match && !IsOpposing(path);
158 }
159
160
161 1587 bool Dirtab::IsOpposing(const std::string &path) const {
162 1587 Rules::const_iterator n = negative_rules_.begin();
163 1587 const Rules::const_iterator nend = negative_rules_.end();
164
2/2
✓ Branch 2 taken 2727 times.
✓ Branch 3 taken 1269 times.
 3996 for (; n != nend; ++n) {
165
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 2727 times.
 2727 assert(n->is_negation);
166
3/4
✓ Branch 2 taken 2727 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 318 times.
✓ Branch 5 taken 2409 times.
 2727 if (n->pathspec.IsMatchingRelaxed(path)) {
167 318 return true;
168 }
169 }
170
171 1269 return false;
172 }
173
174 } // namespace catalog
175