GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/path_filters/dirtab.cc
Date: 2026-02-01 02:35:56
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 888 Dirtab::Dirtab() : valid_(true) { }
19
20
21 30 bool Dirtab::Open(const std::string &dirtab_path) {
22
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 30 times.
 30 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 30 FILE *dirtab_file = fopen(dirtab_path.c_str(), "r");
30
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 30 times.
 30 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 30 valid_ = Parse(dirtab_file);
40 30 fclose(dirtab_file);
41 30 return valid_;
42 }
43
44 768 bool Dirtab::Parse(const std::string &dirtab) {
45 768 valid_ = true;
46 768 off_t line_offset = 0;
47
2/2
✓ Branch 1 taken 3564 times.
✓ Branch 2 taken 768 times.
 4332 while (line_offset < static_cast<off_t>(dirtab.size())) {
48 7128 const std::string line = GetLineMem(dirtab.c_str() + line_offset,
49
1/2
✓ Branch 3 taken 3564 times.
✗ Branch 4 not taken.
 3564 dirtab.size() - line_offset);
50 3564 line_offset += line.size() + 1; // +1 == skipped \n
51
3/4
✓ Branch 1 taken 3564 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 84 times.
✓ Branch 4 taken 3480 times.
 3564 if (!ParseLine(line)) {
52 84 valid_ = false;
53 }
54 3564 }
55
4/4
✓ Branch 0 taken 684 times.
✓ Branch 1 taken 84 times.
✓ Branch 3 taken 642 times.
✓ Branch 4 taken 42 times.
 768 valid_ = valid_ && CheckRuleValidity();
56 768 return valid_;
57 }
58
59
60 60 bool Dirtab::Parse(FILE *dirtab_file) {
61 60 valid_ = true;
62 60 std::string line;
63
3/4
✓ Branch 1 taken 120 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 60 times.
✓ Branch 4 taken 60 times.
 120 while (GetLineFile(dirtab_file, &line)) {
64
2/4
✓ Branch 1 taken 60 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 60 times.
 60 if (!ParseLine(line)) {
65 ✗ valid_ = false;
66 }
67 }
68
3/6
✓ Branch 0 taken 60 times.
✗ Branch 1 not taken.
✓ Branch 3 taken 60 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 60 times.
✗ Branch 6 not taken.
 60 valid_ = valid_ && CheckRuleValidity();
69 60 return valid_;
70 60 }
71
72
73 3624 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 3624 std::string::const_iterator itr = line.begin();
78 3624 const std::string::const_iterator iend = line.end();
79 3624 bool negation = false;
80
81 // parse preamble
82 3624 SkipWhitespace(iend, &itr);
83
2/2
✓ Branch 1 taken 1074 times.
✓ Branch 2 taken 2550 times.
 3624 if (*itr == Dirtab::kCommentMarker) {
84 1074 return true;
85
2/2
✓ Branch 1 taken 1056 times.
✓ Branch 2 taken 1494 times.
 2550 } else if (*itr == Dirtab::kNegationMarker) {
86 1056 negation = true;
87 1056 ++itr;
88 1056 SkipWhitespace(iend, &itr);
89 }
90
91 // extract and parse pathspec
92
2/4
✓ Branch 2 taken 2550 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 2550 times.
✗ Branch 6 not taken.
 5100 const std::string pathspec_str(Trim(std::string(itr, iend)));
93
1/2
✓ Branch 1 taken 2550 times.
✗ Branch 2 not taken.
 2550 return this->ParsePathspec(pathspec_str, negation);
94 2550 }
95
96 2850 bool Dirtab::ParsePathspec(const std::string &pathspec_str, bool negation) {
97
2/2
✓ Branch 1 taken 420 times.
✓ Branch 2 taken 2430 times.
 2850 if (pathspec_str.empty()) {
98 420 return true;
99 }
100
1/2
✓ Branch 1 taken 2430 times.
✗ Branch 2 not taken.
 2430 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 2388 times.
✓ Branch 2 taken 42 times.
✓ Branch 3 taken 1374 times.
✓ Branch 4 taken 1014 times.
✓ Branch 6 taken 42 times.
✓ Branch 7 taken 1332 times.
✓ Branch 8 taken 84 times.
✓ Branch 9 taken 2346 times.
 2430 if (!pathspec.IsValid() || (!negation && !pathspec.IsAbsolute())) {
105 84 return false;
106 }
107
108 // create a new dirtab rule
109
1/2
✓ Branch 1 taken 2346 times.
✗ Branch 2 not taken.
 2346 const Rule rule(pathspec, negation);
110
1/2
✓ Branch 1 taken 2346 times.
✗ Branch 2 not taken.
 2346 AddRule(rule);
111 2346 return true;
112 2430 }
113
114
115 2346 void Dirtab::AddRule(const Rule &rule) {
116
2/2
✓ Branch 0 taken 1014 times.
✓ Branch 1 taken 1332 times.
 2346 if (rule.is_negation) {
117 1014 negative_rules_.push_back(rule);
118 } else {
119 1332 positive_rules_.push_back(rule);
120 }
121 2346 }
122
123
124 744 bool Dirtab::CheckRuleValidity() const {
125 // check if there are contradicting positive and negative rules
126 744 Rules::const_iterator p = positive_rules_.begin();
127 744 const Rules::const_iterator pend = positive_rules_.end();
128
2/2
✓ Branch 2 taken 1290 times.
✓ Branch 3 taken 702 times.
 1992 for (; p != pend; ++p) {
129
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1290 times.
 1290 assert(!p->is_negation);
130 1290 Rules::const_iterator n = negative_rules_.begin();
131 1290 const Rules::const_iterator nend = negative_rules_.end();
132
2/2
✓ Branch 2 taken 1962 times.
✓ Branch 3 taken 1248 times.
 3210 for (; n != nend; ++n) {
133
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1962 times.
 1962 assert(n->is_negation);
134
3/4
✓ Branch 3 taken 1962 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 42 times.
✓ Branch 6 taken 1920 times.
 1962 if (p->pathspec == n->pathspec) {
135 42 return false;
136 }
137 }
138 }
139
140 702 return true;
141 }
142
143
144 2898 bool Dirtab::IsMatching(const std::string &path) const {
145 // check if path has a positive match
146 2898 bool has_positive_match = false;
147 2898 Rules::const_iterator p = positive_rules_.begin();
148 2898 const Rules::const_iterator pend = positive_rules_.end();
149
2/2
✓ Branch 2 taken 5796 times.
✓ Branch 3 taken 1332 times.
 7128 for (; p != pend; ++p) {
150
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 5796 times.
 5796 assert(!p->is_negation);
151
3/4
✓ Branch 2 taken 5796 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 1566 times.
✓ Branch 5 taken 4230 times.
 5796 if (p->pathspec.IsMatching(path)) {
152 1566 has_positive_match = true;
153 1566 break;
154 }
155 }
156
157
5/6
✓ Branch 0 taken 1566 times.
✓ Branch 1 taken 1332 times.
✓ Branch 3 taken 1566 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 1272 times.
✓ Branch 6 taken 294 times.
 2898 return has_positive_match && !IsOpposing(path);
158 }
159
160
161 5394 bool Dirtab::IsOpposing(const std::string &path) const {
162 5394 Rules::const_iterator n = negative_rules_.begin();
163 5394 const Rules::const_iterator nend = negative_rules_.end();
164
2/2
✓ Branch 2 taken 9324 times.
✓ Branch 3 taken 4290 times.
 13614 for (; n != nend; ++n) {
165
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 9324 times.
 9324 assert(n->is_negation);
166
3/4
✓ Branch 2 taken 9324 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 1104 times.
✓ Branch 5 taken 8220 times.
 9324 if (n->pathspec.IsMatchingRelaxed(path)) {
167 1104 return true;
168 }
169 }
170
171 4290 return false;
172 }
173
174 } // namespace catalog
175