GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/options.cc
Date: 2025-10-05 02:35:40
Exec Total Coverage
Lines: 274 354 77.4%
Branches: 280 655 42.7%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 *
4 * Fills an internal map of key-value pairs from ASCII files in key=value
5 * style. Parameters can be overwritten. Used to read configuration from
6 * /etc/cvmfs/...
7 */
8
9
10 #include "options.h"
11
12 #include <fcntl.h>
13 #include <sys/wait.h>
14 #include <unistd.h>
15
16 #include <cassert>
17 #include <cstdio>
18 #include <cstdlib>
19 #include <utility>
20
21 #include "sanitizer.h"
22 #include "util/exception.h"
23 #include "util/logging.h"
24 #include "util/posix.h"
25 #include "util/string.h"
26
27 using namespace std; // NOLINT
28
29 #ifdef CVMFS_NAMESPACE_GUARD
30 namespace CVMFS_NAMESPACE_GUARD {
31 #endif
32
33
34 4614 static string EscapeShell(const std::string &raw) {
35
2/2
✓ Branch 1 taken 71120 times.
✓ Branch 2 taken 4584 times.
 75704 for (unsigned i = 0, l = raw.length(); i < l; ++i) {
36
6/6
✓ Branch 1 taken 62915 times.
✓ Branch 2 taken 8205 times.
✓ Branch 4 taken 56726 times.
✓ Branch 5 taken 6189 times.
✓ Branch 6 taken 30 times.
✓ Branch 7 taken 71090 times.
 136051 if (!(((raw[i] >= '0') && (raw[i] <= '9'))
37
4/4
✓ Branch 1 taken 56475 times.
✓ Branch 2 taken 8456 times.
✓ Branch 4 taken 50609 times.
✓ Branch 5 taken 5866 times.
 64931 || ((raw[i] >= 'A') && (raw[i] <= 'Z'))
38
5/6
✓ Branch 1 taken 47297 times.
✓ Branch 2 taken 11768 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 47297 times.
✓ Branch 7 taken 6356 times.
✓ Branch 8 taken 5412 times.
 59065 || ((raw[i] >= 'a') && (raw[i] <= 'z')) || (raw[i] == '/')
39
6/6
✓ Branch 1 taken 6125 times.
✓ Branch 2 taken 231 times.
✓ Branch 4 taken 3422 times.
✓ Branch 5 taken 2703 times.
✓ Branch 7 taken 110 times.
✓ Branch 8 taken 3312 times.
 6356 || (raw[i] == ':') || (raw[i] == '.') || (raw[i] == '_')
40
3/4
✓ Branch 1 taken 30 times.
✓ Branch 2 taken 80 times.
✓ Branch 4 taken 30 times.
✗ Branch 5 not taken.
 110 || (raw[i] == '-') || (raw[i] == ','))) {
41 30 goto escape_shell_quote;
42 }
43 }
44
1/2
✓ Branch 1 taken 4584 times.
✗ Branch 2 not taken.
 4584 return raw;
45
46 30 escape_shell_quote:
47
1/2
✓ Branch 2 taken 30 times.
✗ Branch 3 not taken.
 60 string result = "'";
48
2/2
✓ Branch 1 taken 1100 times.
✓ Branch 2 taken 30 times.
 1130 for (unsigned i = 0, l = raw.length(); i < l; ++i) {
49
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1100 times.
 1100 if (raw[i] == '\'')
50 ✗ result += "\\";
51
1/2
✓ Branch 2 taken 1100 times.
✗ Branch 3 not taken.
 1100 result += raw[i];
52 }
53
1/2
✓ Branch 1 taken 30 times.
✗ Branch 2 not taken.
 30 result += "'";
54 30 return result;
55 }
56
57
58 4424 string OptionsManager::TrimParameter(const string &parameter) {
59 4424 string result = Trim(parameter);
60 // Strip "readonly"
61
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4424 times.
 4424 if (result.find("readonly ") == 0) {
62 ✗ result = result.substr(9);
63 ✗ result = Trim(result);
64
2/2
✓ Branch 1 taken 132 times.
✓ Branch 2 taken 4292 times.
 4424 } else if (result.find("export ") == 0) {
65
1/2
✓ Branch 1 taken 132 times.
✗ Branch 2 not taken.
 132 result = result.substr(7);
66
1/2
✓ Branch 1 taken 132 times.
✗ Branch 2 not taken.
 132 result = Trim(result);
67
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4292 times.
 4292 } else if (result.find("eval ") == 0) {
68 ✗ result = result.substr(5);
69 ✗ result = Trim(result);
70 }
71 4424 return result;
72 }
73
74 4820 string OptionsManager::SanitizeParameterAssignment(string *line,
75 vector<string> *tokens) {
76 4820 const size_t comment_idx = line->find("#");
77
2/2
✓ Branch 0 taken 264 times.
✓ Branch 1 taken 4556 times.
 4820 if (comment_idx != string::npos)
78
1/2
✓ Branch 1 taken 264 times.
✗ Branch 2 not taken.
 264 *line = line->substr(0, comment_idx);
79
1/2
✓ Branch 1 taken 4820 times.
✗ Branch 2 not taken.
 4820 *line = Trim(*line);
80
2/2
✓ Branch 1 taken 264 times.
✓ Branch 2 taken 4556 times.
 4820 if (line->empty())
81
1/2
✓ Branch 2 taken 264 times.
✗ Branch 3 not taken.
 264 return "";
82
1/2
✓ Branch 1 taken 4556 times.
✗ Branch 2 not taken.
 4556 *tokens = SplitString(*line, '=');
83
2/2
✓ Branch 1 taken 132 times.
✓ Branch 2 taken 4424 times.
 4556 if (tokens->size() < 2)
84
1/2
✓ Branch 2 taken 132 times.
✗ Branch 3 not taken.
 132 return "";
85
1/2
✓ Branch 2 taken 4424 times.
✗ Branch 3 not taken.
 4424 string parameter = TrimParameter((*tokens)[0]);
86
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4424 times.
 4424 if (parameter.find(" ") != string::npos)
87 ✗ return "";
88 4424 return parameter;
89 4424 }
90
91 105 void OptionsManager::SwitchTemplateManager(
92 OptionsTemplateManager *opt_templ_mgr_param) {
93
1/2
✓ Branch 0 taken 105 times.
✗ Branch 1 not taken.
 105 delete opt_templ_mgr_;
94
1/2
✓ Branch 0 taken 105 times.
✗ Branch 1 not taken.
 105 if (opt_templ_mgr_param != NULL) {
95 105 opt_templ_mgr_ = opt_templ_mgr_param;
96 } else {
97 ✗ opt_templ_mgr_ = new OptionsTemplateManager();
98 }
99 105 for (std::map<std::string, std::string>::iterator it =
100 105 templatable_values_.begin();
101
2/2
✓ Branch 2 taken 42 times.
✓ Branch 3 taken 105 times.
 147 it != templatable_values_.end();
102 42 it++) {
103
2/4
✓ Branch 3 taken 42 times.
✗ Branch 4 not taken.
✓ Branch 6 taken 42 times.
✗ Branch 7 not taken.
 42 config_[it->first].value = it->second;
104
2/4
✓ Branch 2 taken 42 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 42 times.
✗ Branch 6 not taken.
 42 opt_templ_mgr_->ParseString(&(config_[it->first].value));
105
2/4
✓ Branch 2 taken 42 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 42 times.
✗ Branch 6 not taken.
 42 UpdateEnvironment(it->first, config_[it->first]);
106 }
107 105 }
108
109 99 bool SimpleOptionsParser::TryParsePath(const string &config_file) {
110
1/2
✓ Branch 2 taken 99 times.
✗ Branch 3 not taken.
 99 LogCvmfs(kLogCvmfs, kLogDebug, "Fast-parsing config file %s",
111 config_file.c_str());
112 99 string line;
113
1/2
✓ Branch 2 taken 99 times.
✗ Branch 3 not taken.
 99 FILE *fconfig = fopen(config_file.c_str(), "r");
114
2/2
✓ Branch 0 taken 11 times.
✓ Branch 1 taken 88 times.
 99 if (fconfig == NULL)
115 11 return false;
116
117 // Read line by line and extract parameters
118
3/4
✓ Branch 1 taken 1364 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 1276 times.
✓ Branch 4 taken 88 times.
 1364 while (GetLineFile(fconfig, &line)) {
119 1276 vector<string> tokens;
120
1/2
✓ Branch 1 taken 1276 times.
✗ Branch 2 not taken.
 1276 const string parameter = SanitizeParameterAssignment(&line, &tokens);
121
2/2
✓ Branch 1 taken 330 times.
✓ Branch 2 taken 946 times.
 1276 if (parameter.empty())
122 330 continue;
123
124 // Strip quotes from value
125
1/2
✓ Branch 3 taken 946 times.
✗ Branch 4 not taken.
 946 tokens.erase(tokens.begin());
126
3/6
✓ Branch 2 taken 946 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 946 times.
✗ Branch 6 not taken.
✓ Branch 8 taken 946 times.
✗ Branch 9 not taken.
 1892 string value = Trim(JoinStrings(tokens, "="));
127 946 const unsigned value_length = value.length();
128
2/2
✓ Branch 0 taken 682 times.
✓ Branch 1 taken 264 times.
 946 if (value_length > 2) {
129
3/7
✓ Branch 1 taken 682 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 66 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 66 times.
 748 if (((value[0] == '"') && ((value[value_length - 1] == '"')))
130
9/13
✓ Branch 0 taken 66 times.
✓ Branch 1 taken 616 times.
✓ Branch 3 taken 616 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 66 times.
✓ Branch 6 taken 550 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 66 times.
✗ Branch 9 not taken.
✓ Branch 10 taken 66 times.
✗ Branch 11 not taken.
✓ Branch 12 taken 132 times.
✓ Branch 13 taken 550 times.
 748 || ((value[0] == '\'') && ((value[value_length - 1] == '\'')))) {
131
1/2
✓ Branch 1 taken 132 times.
✗ Branch 2 not taken.
 132 value = value.substr(1, value_length - 2);
132 }
133 }
134
135 946 ConfigValue config_value;
136
1/2
✓ Branch 1 taken 946 times.
✗ Branch 2 not taken.
 946 config_value.source = config_file;
137
1/2
✓ Branch 1 taken 946 times.
✗ Branch 2 not taken.
 946 config_value.value = value;
138
2/4
✓ Branch 1 taken 946 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 946 times.
✗ Branch 5 not taken.
 946 PopulateParameter(parameter, config_value);
139
4/4
✓ Branch 3 taken 946 times.
✓ Branch 4 taken 330 times.
✓ Branch 6 taken 946 times.
✓ Branch 7 taken 330 times.
 1606 }
140
1/2
✓ Branch 1 taken 88 times.
✗ Branch 2 not taken.
 88 fclose(fconfig);
141 88 return true;
142 99 }
143
144 351 void BashOptionsManager::ParsePath(const string &config_file,
145 const bool external) {
146
1/2
✓ Branch 2 taken 351 times.
✗ Branch 3 not taken.
 351 LogCvmfs(kLogCvmfs, kLogDebug, "Parsing config file %s", config_file.c_str());
147 int retval;
148 int pipe_open[2];
149 int pipe_quit[2];
150 351 pid_t pid_child = 0;
151
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 351 times.
 351 if (external) {
152 // cvmfs can run in the process group of automount in which case
153 // autofs won't mount an additional config repository. We create a
154 // short-lived process that detaches from the process group and triggers
155 // autofs to mount the config repository, if necessary. It holds a file
156 // handle to the config file until the main process opened the file, too.
157 ✗ MakePipe(pipe_open);
158 ✗ MakePipe(pipe_quit);
159 ✗ switch (pid_child = fork()) {
160 ✗ case -1:
161 ✗ PANIC(NULL);
162 ✗ case 0: { // Child
163 ✗ close(pipe_open[0]);
164 ✗ close(pipe_quit[1]);
165 // If this is not a process group leader, create a new session
166 ✗ if (getpgrp() != getpid()) {
167 ✗ const pid_t new_session = setsid();
168 ✗ assert(new_session != (pid_t)-1);
169 }
170 ✗ (void)open(config_file.c_str(), O_RDONLY);
171 ✗ char ready = 'R';
172 ✗ WritePipe(pipe_open[1], &ready, 1);
173 ✗ retval = read(pipe_quit[0], &ready, 1);
174 ✗ _exit(retval); // Don't flush shared file descriptors
175 }
176 }
177 // Parent
178 ✗ close(pipe_open[1]);
179 ✗ close(pipe_quit[0]);
180 ✗ char ready = 0;
181 ✗ ReadPipe(pipe_open[0], &ready, 1);
182 ✗ assert(ready == 'R');
183 ✗ close(pipe_open[0]);
184 }
185
1/2
✓ Branch 1 taken 351 times.
✗ Branch 2 not taken.
 351 const string config_path = GetParentPath(config_file);
186
1/2
✓ Branch 2 taken 351 times.
✗ Branch 3 not taken.
 351 FILE *fconfig = fopen(config_file.c_str(), "r");
187
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 351 times.
 351 if (pid_child > 0) {
188 ✗ char c = 'C';
189 ✗ WritePipe(pipe_quit[1], &c, 1);
190 int statloc;
191 ✗ waitpid(pid_child, &statloc, 0);
192 ✗ close(pipe_quit[1]);
193 }
194
2/2
✓ Branch 0 taken 11 times.
✓ Branch 1 taken 340 times.
 351 if (!fconfig) {
195
2/8
✗ Branch 0 not taken.
✓ Branch 1 taken 11 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✓ Branch 8 taken 11 times.
 11 if (external && !DirectoryExists(config_path)) {
196 ✗ string repo_required;
197 ✗ if (GetValue("CVMFS_CONFIG_REPO_REQUIRED", &repo_required)
198 ✗ && IsOn(repo_required)) {
199 ✗ LogCvmfs(
200 kLogCvmfs, kLogStderr | kLogSyslogErr,
201 "required configuration repository directory does not exist: %s",
202 config_path.c_str());
203 // Do not crash as in abort(), which can trigger core file creation
204 // from the mount helper
205 ✗ exit(1);
206 }
207
208 ✗ LogCvmfs(kLogCvmfs, kLogDebug | kLogSyslogWarn,
209 "configuration repository directory does not exist: %s",
210 config_path.c_str());
211 }
212 11 return;
213 }
214
215 int fd_stdin;
216 int fd_stdout;
217 int fd_stderr;
218
1/2
✓ Branch 1 taken 340 times.
✗ Branch 2 not taken.
 340 retval = Shell(&fd_stdin, &fd_stdout, &fd_stderr);
219
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 340 times.
 340 assert(retval);
220
221 // Let the shell read the file
222 680 string line;
223
1/2
✓ Branch 2 taken 340 times.
✗ Branch 3 not taken.
 680 const string newline = "\n";
224
5/15
✗ Branch 1 not taken.
✓ Branch 2 taken 340 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 8 taken 340 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 340 times.
✗ Branch 12 not taken.
✓ Branch 14 taken 340 times.
✗ Branch 15 not taken.
✗ Branch 18 not taken.
✓ Branch 19 taken 340 times.
✗ Branch 20 not taken.
✗ Branch 21 not taken.
 680 const string cd = "cd \"" + ((config_path == "") ? "/" : config_path) + "\""
225
1/2
✓ Branch 1 taken 340 times.
✗ Branch 2 not taken.
 680 + newline;
226
1/2
✓ Branch 3 taken 340 times.
✗ Branch 4 not taken.
 340 WritePipe(fd_stdin, cd.data(), cd.length());
227
3/4
✓ Branch 1 taken 3884 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 3544 times.
✓ Branch 4 taken 340 times.
 3884 while (GetLineFile(fconfig, &line)) {
228
1/2
✓ Branch 3 taken 3544 times.
✗ Branch 4 not taken.
 3544 WritePipe(fd_stdin, line.data(), line.length());
229
1/2
✓ Branch 3 taken 3544 times.
✗ Branch 4 not taken.
 3544 WritePipe(fd_stdin, newline.data(), newline.length());
230 }
231
1/2
✓ Branch 1 taken 340 times.
✗ Branch 2 not taken.
 340 rewind(fconfig);
232
233 // Read line by line and extract parameters
234
3/4
✓ Branch 1 taken 3884 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 3544 times.
✓ Branch 4 taken 340 times.
 3884 while (GetLineFile(fconfig, &line)) {
235 3544 vector<string> tokens;
236
1/2
✓ Branch 1 taken 3544 times.
✗ Branch 2 not taken.
 3544 const string parameter = SanitizeParameterAssignment(&line, &tokens);
237
2/2
✓ Branch 1 taken 330 times.
✓ Branch 2 taken 3214 times.
 3544 if (parameter.empty())
238 330 continue;
239
240 3214 ConfigValue value;
241
1/2
✓ Branch 1 taken 3214 times.
✗ Branch 2 not taken.
 3214 value.source = config_file;
242
2/4
✓ Branch 1 taken 3214 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 3214 times.
✗ Branch 5 not taken.
 3214 const string sh_echo = "echo $" + parameter + "\n";
243
1/2
✓ Branch 3 taken 3214 times.
✗ Branch 4 not taken.
 3214 WritePipe(fd_stdin, sh_echo.data(), sh_echo.length());
244
1/2
✓ Branch 1 taken 3214 times.
✗ Branch 2 not taken.
 3214 GetLineFd(fd_stdout, &value.value);
245
2/4
✓ Branch 1 taken 3214 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 3214 times.
✗ Branch 5 not taken.
 3214 PopulateParameter(parameter, value);
246
4/4
✓ Branch 3 taken 3214 times.
✓ Branch 4 taken 330 times.
✓ Branch 6 taken 3214 times.
✓ Branch 7 taken 330 times.
 3874 }
247
248
1/2
✓ Branch 1 taken 340 times.
✗ Branch 2 not taken.
 340 close(fd_stderr);
249
1/2
✓ Branch 1 taken 340 times.
✗ Branch 2 not taken.
 340 close(fd_stdout);
250
1/2
✓ Branch 1 taken 340 times.
✗ Branch 2 not taken.
 340 close(fd_stdin);
251
1/2
✓ Branch 1 taken 340 times.
✗ Branch 2 not taken.
 340 fclose(fconfig);
252 }
253
254
255 368 bool OptionsManager::HasConfigRepository(const string &fqrn,
256 string *config_path) {
257 368 string cvmfs_mount_dir;
258
3/6
✓ Branch 2 taken 368 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 368 times.
✗ Branch 6 not taken.
✗ Branch 9 not taken.
✓ Branch 10 taken 368 times.
 368 if (!GetValue("CVMFS_MOUNT_DIR", &cvmfs_mount_dir)) {
259 ✗ LogCvmfs(kLogCvmfs, kLogDebug | kLogSyslogErr, "CVMFS_MOUNT_DIR missing");
260 ✗ return false;
261 }
262
263 368 string config_repository;
264
4/6
✓ Branch 2 taken 368 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 368 times.
✗ Branch 6 not taken.
✓ Branch 9 taken 30 times.
✓ Branch 10 taken 338 times.
 368 if (GetValue("CVMFS_CONFIG_REPOSITORY", &config_repository)) {
265
3/6
✓ Branch 1 taken 30 times.
✗ Branch 2 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 30 times.
✗ Branch 6 not taken.
✓ Branch 7 taken 30 times.
 30 if (config_repository.empty() || (config_repository == fqrn))
266 ✗ return false;
267
1/2
✓ Branch 1 taken 30 times.
✗ Branch 2 not taken.
 30 const sanitizer::RepositorySanitizer repository_sanitizer;
268
2/4
✓ Branch 1 taken 30 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 30 times.
 30 if (!repository_sanitizer.IsValid(config_repository)) {
269 ✗ LogCvmfs(kLogCvmfs, kLogDebug | kLogSyslogErr,
270 "invalid CVMFS_CONFIG_REPOSITORY: %s",
271 config_repository.c_str());
272 ✗ return false;
273 }
274
3/6
✓ Branch 1 taken 30 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 30 times.
✗ Branch 5 not taken.
✓ Branch 7 taken 30 times.
✗ Branch 8 not taken.
 30 *config_path = cvmfs_mount_dir + "/" + config_repository + "/etc/cvmfs/";
275 30 return true;
276 30 }
277 338 return false;
278 368 }
279
280
281 ✗ void OptionsManager::ParseDefault(const string &fqrn) {
282 ✗ if (taint_environment_) {
283 ✗ const int retval = setenv("CVMFS_FQRN", fqrn.c_str(), 1);
284 ✗ assert(retval == 0);
285 }
286
287 ✗ protected_parameters_.clear();
288 ✗ ParsePath("/etc/cvmfs/default.conf", false);
289 vector<string> dist_defaults = FindFilesBySuffix("/etc/cvmfs/default.d",
290 ✗ ".conf");
291 ✗ for (unsigned i = 0; i < dist_defaults.size(); ++i) {
292 ✗ ParsePath(dist_defaults[i], false);
293 }
294 ✗ ProtectParameter("CVMFS_CONFIG_REPOSITORY");
295 ✗ string external_config_path;
296 ✗ if ((fqrn != "") && HasConfigRepository(fqrn, &external_config_path))
297 ✗ ParsePath(external_config_path + "default.conf", true);
298 ✗ ParsePath("/etc/cvmfs/default.local", false);
299
300 ✗ if (fqrn != "") {
301 ✗ string domain;
302 ✗ vector<string> tokens = SplitString(fqrn, '.');
303 ✗ assert(tokens.size() > 1);
304 ✗ tokens.erase(tokens.begin());
305 ✗ domain = JoinStrings(tokens, ".");
306
307 ✗ if (HasConfigRepository(fqrn, &external_config_path))
308 ✗ ParsePath(external_config_path + "domain.d/" + domain + ".conf", true);
309 ✗ ParsePath("/etc/cvmfs/domain.d/" + domain + ".conf", false);
310 ✗ ParsePath("/etc/cvmfs/domain.d/" + domain + ".local", false);
311
312 ✗ if (HasConfigRepository(fqrn, &external_config_path))
313 ✗ ParsePath(external_config_path + "config.d/" + fqrn + ".conf", true);
314 ✗ ParsePath("/etc/cvmfs/config.d/" + fqrn + ".conf", false);
315 ✗ ParsePath("/etc/cvmfs/config.d/" + fqrn + ".local", false);
316 }
317 }
318
319
320 8345 void OptionsManager::PopulateParameter(const string &param, ConfigValue val) {
321
1/2
✓ Branch 1 taken 8345 times.
✗ Branch 2 not taken.
 8345 const map<string, string>::const_iterator iter = protected_parameters_.find(
322 8345 param);
323
5/6
✓ Branch 3 taken 22 times.
✓ Branch 4 taken 8323 times.
✓ Branch 7 taken 22 times.
✗ Branch 8 not taken.
✓ Branch 9 taken 22 times.
✓ Branch 10 taken 8323 times.
 8345 if ((iter != protected_parameters_.end()) && (iter->second != val.value)) {
324
1/3
✓ Branch 4 taken 22 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
 44 LogCvmfs(kLogCvmfs, kLogDebug | kLogSyslogErr,
325 "error in cvmfs configuration: attempt to change protected %s "
326 "from %s to %s",
327 22 param.c_str(), iter->second.c_str(), val.value.c_str());
328 22 return;
329 }
330
2/4
✓ Branch 1 taken 8323 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 8323 times.
✗ Branch 5 not taken.
 8323 ParseValue(param, &val);
331
2/4
✓ Branch 1 taken 8323 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 8323 times.
✗ Branch 5 not taken.
 8323 config_[param] = val;
332
1/2
✓ Branch 1 taken 8323 times.
✗ Branch 2 not taken.
 8323 UpdateEnvironment(param, val);
333 }
334
335 8365 void OptionsManager::UpdateEnvironment(const string &param, ConfigValue val) {
336
2/2
✓ Branch 0 taken 7273 times.
✓ Branch 1 taken 1092 times.
 8365 if (taint_environment_) {
337 7273 const int retval = setenv(param.c_str(), val.value.c_str(), 1);
338
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 7273 times.
 7273 assert(retval == 0);
339 }
340 8365 }
341
342 8323 void OptionsManager::ParseValue(std::string param, ConfigValue *val) {
343
1/2
✓ Branch 1 taken 8323 times.
✗ Branch 2 not taken.
 8323 const string orig = val->value;
344
1/2
✓ Branch 1 taken 8323 times.
✗ Branch 2 not taken.
 8323 const bool has_templ = opt_templ_mgr_->ParseString(&(val->value));
345
2/2
✓ Branch 0 taken 152 times.
✓ Branch 1 taken 8171 times.
 8323 if (has_templ) {
346
2/4
✓ Branch 1 taken 152 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 152 times.
✗ Branch 5 not taken.
 152 templatable_values_[param] = orig;
347 }
348 8323 }
349
350
351 22 void OptionsManager::ProtectParameter(const string &param) {
352 22 string value;
353 // We don't care about the result. If param does not yet exists, we lock it
354 // to the empty string.
355
1/2
✓ Branch 1 taken 22 times.
✗ Branch 2 not taken.
 22 (void)GetValue(param, &value);
356
2/4
✓ Branch 1 taken 22 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 22 times.
✗ Branch 5 not taken.
 22 protected_parameters_[param] = value;
357 22 }
358
359
360 22 void OptionsManager::ClearConfig() { config_.clear(); }
361
362
363 4289 bool OptionsManager::IsDefined(const std::string &key) {
364
1/2
✓ Branch 1 taken 4289 times.
✗ Branch 2 not taken.
 4289 const map<string, ConfigValue>::const_iterator iter = config_.find(key);
365 4289 return iter != config_.end();
366 }
367
368
369 48605 bool OptionsManager::GetValue(const string &key, string *value) const {
370
1/2
✓ Branch 1 taken 48605 times.
✗ Branch 2 not taken.
 48605 const map<string, ConfigValue>::const_iterator iter = config_.find(key);
371
2/2
✓ Branch 2 taken 12618 times.
✓ Branch 3 taken 35987 times.
 48605 if (iter != config_.end()) {
372
1/2
✓ Branch 2 taken 12618 times.
✗ Branch 3 not taken.
 12618 *value = iter->second.value;
373 12618 return true;
374 }
375
1/2
✓ Branch 1 taken 35987 times.
✗ Branch 2 not taken.
 35987 *value = "";
376 35987 return false;
377 }
378
379
380 69 std::string OptionsManager::GetValueOrDie(const string &key) {
381 69 std::string value;
382
1/2
✓ Branch 1 taken 69 times.
✗ Branch 2 not taken.
 69 const bool retval = GetValue(key, &value);
383
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 69 times.
 69 if (!retval) {
384 ✗ PANIC(kLogStderr | kLogDebug, "%s configuration parameter missing",
385 key.c_str());
386 }
387 69 return value;
388 }
389
390
391 4746 bool OptionsManager::GetSource(const string &key, string *value) {
392
1/2
✓ Branch 1 taken 4746 times.
✗ Branch 2 not taken.
 4746 const map<string, ConfigValue>::const_iterator iter = config_.find(key);
393
1/2
✓ Branch 3 taken 4746 times.
✗ Branch 4 not taken.
 4746 if (iter != config_.end()) {
394
1/2
✓ Branch 2 taken 4746 times.
✗ Branch 3 not taken.
 4746 *value = iter->second.source;
395 4746 return true;
396 }
397 ✗ *value = "";
398 ✗ return false;
399 }
400
401
402 833 bool OptionsManager::IsOn(const std::string &param_value) const {
403
1/2
✓ Branch 1 taken 833 times.
✗ Branch 2 not taken.
 833 const string uppercase = ToUpper(param_value);
404
2/4
✓ Branch 2 taken 753 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 753 times.
✗ Branch 6 not taken.
 1586 return ((uppercase == "YES") || (uppercase == "ON") || (uppercase == "1")
405
3/4
✓ Branch 0 taken 753 times.
✓ Branch 1 taken 80 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 753 times.
 2419 || (uppercase == "TRUE"));
406 833 }
407
408
409 28 bool OptionsManager::IsOff(const std::string &param_value) const {
410
1/2
✓ Branch 1 taken 28 times.
✗ Branch 2 not taken.
 28 const string uppercase = ToUpper(param_value);
411
3/4
✓ Branch 2 taken 14 times.
✓ Branch 3 taken 14 times.
✓ Branch 5 taken 14 times.
✗ Branch 6 not taken.
 56 return ((uppercase == "NO") || (uppercase == "OFF") || (uppercase == "0")
412
2/4
✓ Branch 0 taken 28 times.
✗ Branch 1 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 14 times.
 84 || (uppercase == "FALSE"));
413 28 }
414
415
416 753 vector<string> OptionsManager::GetAllKeys() {
417 753 vector<string> result;
418 753 for (map<string, ConfigValue>::const_iterator i = config_.begin(),
419 753 iEnd = config_.end();
420
2/2
✓ Branch 1 taken 4922 times.
✓ Branch 2 taken 753 times.
 5675 i != iEnd;
421 4922 ++i) {
422
1/2
✓ Branch 2 taken 4922 times.
✗ Branch 3 not taken.
 4922 result.push_back(i->first);
423 }
424 753 return result;
425 }
426
427
428 284 vector<string> OptionsManager::GetEnvironmentSubset(const string &key_prefix,
429 bool strip_prefix) {
430 284 vector<string> result;
431 284 for (map<string, ConfigValue>::const_iterator i = config_.begin(),
432 284 iEnd = config_.end();
433
2/2
✓ Branch 1 taken 1232 times.
✓ Branch 2 taken 284 times.
 1516 i != iEnd;
434 1232 ++i) {
435 1232 const bool ignore_prefix = false;
436
3/4
✓ Branch 2 taken 1232 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 154 times.
✓ Branch 5 taken 1078 times.
 1232 if (HasPrefix(i->first, key_prefix, ignore_prefix)) {
437 const string output_key = strip_prefix
438 22 ? i->first.substr(key_prefix.length())
439
4/6
✓ Branch 0 taken 22 times.
✓ Branch 1 taken 132 times.
✓ Branch 4 taken 22 times.
✗ Branch 5 not taken.
✓ Branch 8 taken 132 times.
✗ Branch 9 not taken.
 176 : i->first;
440
3/6
✓ Branch 2 taken 154 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 154 times.
✗ Branch 6 not taken.
✓ Branch 8 taken 154 times.
✗ Branch 9 not taken.
 154 result.push_back(output_key + "=" + i->second.value);
441 154 }
442 }
443 284 return result;
444 }
445
446
447 709 string OptionsManager::Dump() {
448 709 string result;
449
1/2
✓ Branch 1 taken 709 times.
✗ Branch 2 not taken.
 709 vector<string> keys = GetAllKeys();
450
2/2
✓ Branch 1 taken 4614 times.
✓ Branch 2 taken 709 times.
 5323 for (unsigned i = 0, l = keys.size(); i < l; ++i) {
451 bool retval;
452 4614 string value;
453 4614 string source;
454
455
1/2
✓ Branch 2 taken 4614 times.
✗ Branch 3 not taken.
 4614 retval = GetValue(keys[i], &value);
456
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4614 times.
 4614 assert(retval);
457
1/2
✓ Branch 2 taken 4614 times.
✗ Branch 3 not taken.
 4614 retval = GetSource(keys[i], &source);
458
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4614 times.
 4614 assert(retval);
459
5/10
✓ Branch 1 taken 4614 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 4614 times.
✗ Branch 6 not taken.
✓ Branch 8 taken 4614 times.
✗ Branch 9 not taken.
✓ Branch 11 taken 4614 times.
✗ Branch 12 not taken.
✓ Branch 14 taken 4614 times.
✗ Branch 15 not taken.
 9228 result += keys[i] + "=" + EscapeShell(value) + " # from " + source
460
2/4
✓ Branch 1 taken 4614 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 4614 times.
✗ Branch 5 not taken.
 4614 + "\n";
461 4614 }
462 1418 return result;
463 709 }
464
465 ✗ void OptionsManager::SetValueFromTalk(const string &key, const string &value) {
466 ✗ ConfigValue config_value;
467 ✗ config_value.source = "cvmfs_talk";
468 ✗ config_value.value = value;
469 ✗ PopulateParameter(key, config_value);
470 }
471
472 4185 void OptionsManager::SetValue(const string &key, const string &value) {
473 4185 ConfigValue config_value;
474
1/2
✓ Branch 1 taken 4185 times.
✗ Branch 2 not taken.
 4185 config_value.source = "@INTERNAL@";
475
1/2
✓ Branch 1 taken 4185 times.
✗ Branch 2 not taken.
 4185 config_value.value = value;
476
2/4
✓ Branch 1 taken 4185 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 4185 times.
✗ Branch 5 not taken.
 4185 PopulateParameter(key, config_value);
477 4185 }
478
479
480 259 void OptionsManager::UnsetValue(const string &key) {
481 259 protected_parameters_.erase(key);
482 259 config_.erase(key);
483
2/2
✓ Branch 0 taken 237 times.
✓ Branch 1 taken 22 times.
 259 if (taint_environment_)
484 237 unsetenv(key.c_str());
485 259 }
486
487 const char *DefaultOptionsTemplateManager ::kTemplateIdentFqrn = "fqrn";
488
489 const char *DefaultOptionsTemplateManager ::kTemplateIdentOrg = "org";
490
491 374 DefaultOptionsTemplateManager::DefaultOptionsTemplateManager(std::string fqrn) {
492
3/6
✓ Branch 1 taken 374 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 374 times.
✗ Branch 6 not taken.
✓ Branch 8 taken 374 times.
✗ Branch 9 not taken.
 374 SetTemplate(kTemplateIdentFqrn, fqrn);
493
1/2
✓ Branch 1 taken 374 times.
✗ Branch 2 not taken.
 374 vector<string> fqrn_parts = SplitString(fqrn, '.');
494
3/6
✓ Branch 2 taken 374 times.
✗ Branch 3 not taken.
✓ Branch 6 taken 374 times.
✗ Branch 7 not taken.
✓ Branch 9 taken 374 times.
✗ Branch 10 not taken.
 374 SetTemplate(kTemplateIdentOrg, fqrn_parts[0]);
495 374 }
496
497 838 void OptionsTemplateManager::SetTemplate(std::string name, std::string val) {
498 838 templates_[name] = val;
499 838 }
500
501 706 std::string OptionsTemplateManager::GetTemplate(std::string name) {
502
2/2
✓ Branch 1 taken 200 times.
✓ Branch 2 taken 506 times.
 706 if (templates_.count(name)) {
503 200 return templates_[name];
504 } else {
505
2/4
✓ Branch 1 taken 506 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 506 times.
✗ Branch 5 not taken.
 506 std::string var_name = "@" + name + "@";
506
1/2
✓ Branch 2 taken 506 times.
✗ Branch 3 not taken.
 506 LogCvmfs(kLogCvmfs, kLogDebug, "Undeclared variable: %s", var_name.c_str());
507 506 return var_name;
508 506 }
509 }
510
511 8433 bool OptionsTemplateManager::ParseString(std::string *input) {
512 8433 std::string result;
513
1/2
✓ Branch 1 taken 8433 times.
✗ Branch 2 not taken.
 8433 std::string in = *input;
514 8433 bool has_vars = false;
515 8433 int mode = 0;
516 8433 std::string stock;
517
2/2
✓ Branch 1 taken 250400 times.
✓ Branch 2 taken 8433 times.
 258833 for (std::string::size_type i = 0; i < in.size(); i++) {
518
2/3
✓ Branch 0 taken 246818 times.
✓ Branch 1 taken 3582 times.
✗ Branch 2 not taken.
 250400 switch (mode) {
519 246818 case 0:
520
3/4
✓ Branch 1 taken 246818 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 753 times.
✓ Branch 4 taken 246065 times.
 246818 if (in[i] == '@') {
521 753 mode = 1;
522 } else {
523
2/4
✓ Branch 1 taken 246065 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 246065 times.
✗ Branch 5 not taken.
 246065 result += in[i];
524 }
525 246818 break;
526 3582 case 1:
527
3/4
✓ Branch 1 taken 3582 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 587 times.
✓ Branch 4 taken 2995 times.
 3582 if (in[i] == '@') {
528 587 mode = 0;
529
3/6
✓ Branch 1 taken 587 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 587 times.
✗ Branch 5 not taken.
✓ Branch 7 taken 587 times.
✗ Branch 8 not taken.
 587 result += GetTemplate(stock);
530
1/2
✓ Branch 1 taken 587 times.
✗ Branch 2 not taken.
 587 stock = "";
531 587 has_vars = true;
532 } else {
533
2/4
✓ Branch 1 taken 2995 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 2995 times.
✗ Branch 5 not taken.
 2995 stock += in[i];
534 }
535 3582 break;
536 }
537 }
538
2/2
✓ Branch 0 taken 166 times.
✓ Branch 1 taken 8267 times.
 8433 if (mode == 1) {
539
2/4
✓ Branch 1 taken 166 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 166 times.
✗ Branch 5 not taken.
 166 result += "@" + stock;
540 }
541
1/2
✓ Branch 1 taken 8433 times.
✗ Branch 2 not taken.
 8433 *input = result;
542 8433 return has_vars;
543 8433 }
544
545 119 bool OptionsTemplateManager::HasTemplate(std::string name) {
546 119 return templates_.count(name);
547 }
548
549 #ifdef CVMFS_NAMESPACE_GUARD
550 } // namespace CVMFS_NAMESPACE_GUARD
551 #endif
552