GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/path_filters/dirtab.cc
Date: 2025-12-07 02:35:36
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 308 Dirtab::Dirtab() : valid_(true) { }
19
20
21 28 bool Dirtab::Open(const std::string &dirtab_path) {
22
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 28 times.
 28 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 28 FILE *dirtab_file = fopen(dirtab_path.c_str(), "r");
30
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 28 times.
 28 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 28 valid_ = Parse(dirtab_file);
40 28 fclose(dirtab_file);
41 28 return valid_;
42 }
43
44 196 bool Dirtab::Parse(const std::string &dirtab) {
45 196 valid_ = true;
46 196 off_t line_offset = 0;
47
2/2
✓ Branch 1 taken 1020 times.
✓ Branch 2 taken 196 times.
 1216 while (line_offset < static_cast<off_t>(dirtab.size())) {
48 2040 const std::string line = GetLineMem(dirtab.c_str() + line_offset,
49
1/2
✓ Branch 3 taken 1020 times.
✗ Branch 4 not taken.
 1020 dirtab.size() - line_offset);
50 1020 line_offset += line.size() + 1; // +1 == skipped \n
51
3/4
✓ Branch 1 taken 1020 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 4 times.
✓ Branch 4 taken 1016 times.
 1020 if (!ParseLine(line)) {
52 4 valid_ = false;
53 }
54 1020 }
55
4/4
✓ Branch 0 taken 192 times.
✓ Branch 1 taken 4 times.
✓ Branch 3 taken 190 times.
✓ Branch 4 taken 2 times.
 196 valid_ = valid_ && CheckRuleValidity();
56 196 return valid_;
57 }
58
59
60 56 bool Dirtab::Parse(FILE *dirtab_file) {
61 56 valid_ = true;
62 56 std::string line;
63
3/4
✓ Branch 1 taken 112 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 56 times.
✓ Branch 4 taken 56 times.
 112 while (GetLineFile(dirtab_file, &line)) {
64
2/4
✓ Branch 1 taken 56 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 56 times.
 56 if (!ParseLine(line)) {
65 ✗ valid_ = false;
66 }
67 }
68
3/6
✓ Branch 0 taken 56 times.
✗ Branch 1 not taken.
✓ Branch 3 taken 56 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 56 times.
✗ Branch 6 not taken.
 56 valid_ = valid_ && CheckRuleValidity();
69 56 return valid_;
70 56 }
71
72
73 1076 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 1076 std::string::const_iterator itr = line.begin();
78 1076 const std::string::const_iterator iend = line.end();
79 1076 bool negation = false;
80
81 // parse preamble
82 1076 SkipWhitespace(iend, &itr);
83
2/2
✓ Branch 1 taken 370 times.
✓ Branch 2 taken 706 times.
 1076 if (*itr == Dirtab::kCommentMarker) {
84 370 return true;
85
2/2
✓ Branch 1 taken 316 times.
✓ Branch 2 taken 390 times.
 706 } else if (*itr == Dirtab::kNegationMarker) {
86 316 negation = true;
87 316 ++itr;
88 316 SkipWhitespace(iend, &itr);
89 }
90
91 // extract and parse pathspec
92
2/4
✓ Branch 2 taken 706 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 706 times.
✗ Branch 6 not taken.
 1412 const std::string pathspec_str(Trim(std::string(itr, iend)));
93
1/2
✓ Branch 1 taken 706 times.
✗ Branch 2 not taken.
 706 return this->ParsePathspec(pathspec_str, negation);
94 706 }
95
96 986 bool Dirtab::ParsePathspec(const std::string &pathspec_str, bool negation) {
97
2/2
✓ Branch 1 taken 20 times.
✓ Branch 2 taken 966 times.
 986 if (pathspec_str.empty()) {
98 20 return true;
99 }
100
1/2
✓ Branch 1 taken 966 times.
✗ Branch 2 not taken.
 966 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 964 times.
✓ Branch 2 taken 2 times.
✓ Branch 3 taken 650 times.
✓ Branch 4 taken 314 times.
✓ Branch 6 taken 2 times.
✓ Branch 7 taken 648 times.
✓ Branch 8 taken 4 times.
✓ Branch 9 taken 962 times.
 966 if (!pathspec.IsValid() || (!negation && !pathspec.IsAbsolute())) {
105 4 return false;
106 }
107
108 // create a new dirtab rule
109
1/2
✓ Branch 1 taken 962 times.
✗ Branch 2 not taken.
 962 const Rule rule(pathspec, negation);
110
1/2
✓ Branch 1 taken 962 times.
✗ Branch 2 not taken.
 962 AddRule(rule);
111 962 return true;
112 966 }
113
114
115 962 void Dirtab::AddRule(const Rule &rule) {
116
2/2
✓ Branch 0 taken 314 times.
✓ Branch 1 taken 648 times.
 962 if (rule.is_negation) {
117 314 negative_rules_.push_back(rule);
118 } else {
119 648 positive_rules_.push_back(rule);
120 }
121 962 }
122
123
124 248 bool Dirtab::CheckRuleValidity() const {
125 // check if there are contradicting positive and negative rules
126 248 Rules::const_iterator p = positive_rules_.begin();
127 248 const Rules::const_iterator pend = positive_rules_.end();
128
2/2
✓ Branch 2 taken 646 times.
✓ Branch 3 taken 246 times.
 892 for (; p != pend; ++p) {
129
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 646 times.
 646 assert(!p->is_negation);
130 646 Rules::const_iterator n = negative_rules_.begin();
131 646 const Rules::const_iterator nend = negative_rules_.end();
132
2/2
✓ Branch 2 taken 864 times.
✓ Branch 3 taken 644 times.
 1508 for (; n != nend; ++n) {
133
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 864 times.
 864 assert(n->is_negation);
134
3/4
✓ Branch 3 taken 864 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 2 times.
✓ Branch 6 taken 862 times.
 864 if (p->pathspec == n->pathspec) {
135 2 return false;
136 }
137 }
138 }
139
140 246 return true;
141 }
142
143
144 1440 bool Dirtab::IsMatching(const std::string &path) const {
145 // check if path has a positive match
146 1440 bool has_positive_match = false;
147 1440 Rules::const_iterator p = positive_rules_.begin();
148 1440 const Rules::const_iterator pend = positive_rules_.end();
149
2/2
✓ Branch 2 taken 3624 times.
✓ Branch 3 taken 834 times.
 4458 for (; p != pend; ++p) {
150
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 3624 times.
 3624 assert(!p->is_negation);
151
3/4
✓ Branch 2 taken 3624 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 606 times.
✓ Branch 5 taken 3018 times.
 3624 if (p->pathspec.IsMatching(path)) {
152 606 has_positive_match = true;
153 606 break;
154 }
155 }
156
157
5/6
✓ Branch 0 taken 606 times.
✓ Branch 1 taken 834 times.
✓ Branch 3 taken 606 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 592 times.
✓ Branch 6 taken 14 times.
 1440 return has_positive_match && !IsOpposing(path);
158 }
159
160
161 3100 bool Dirtab::IsOpposing(const std::string &path) const {
162 3100 Rules::const_iterator n = negative_rules_.begin();
163 3100 const Rules::const_iterator nend = negative_rules_.end();
164
2/2
✓ Branch 2 taken 4350 times.
✓ Branch 3 taken 2888 times.
 7238 for (; n != nend; ++n) {
165
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4350 times.
 4350 assert(n->is_negation);
166
3/4
✓ Branch 2 taken 4350 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 212 times.
✓ Branch 5 taken 4138 times.
 4350 if (n->pathspec.IsMatchingRelaxed(path)) {
167 212 return true;
168 }
169 }
170
171 2888 return false;
172 }
173
174 } // namespace catalog
175