GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/options.cc
Date: 2025-09-14 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 17669 static string EscapeShell(const std::string &raw) {
35
2/2
✓ Branch 1 taken 257705 times.
✓ Branch 2 taken 17543 times.
 275248 for (unsigned i = 0, l = raw.length(); i < l; ++i) {
36
6/6
✓ Branch 1 taken 227034 times.
✓ Branch 2 taken 30671 times.
✓ Branch 4 taken 203610 times.
✓ Branch 5 taken 23424 times.
✓ Branch 6 taken 126 times.
✓ Branch 7 taken 257579 times.
 491986 if (!(((raw[i] >= '0') && (raw[i] <= '9'))
37
4/4
✓ Branch 1 taken 202795 times.
✓ Branch 2 taken 31486 times.
✓ Branch 4 taken 183001 times.
✓ Branch 5 taken 19794 times.
 234281 || ((raw[i] >= 'A') && (raw[i] <= 'Z'))
38
5/6
✓ Branch 1 taken 170673 times.
✓ Branch 2 taken 43814 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 170673 times.
✓ Branch 7 taken 23449 times.
✓ Branch 8 taken 20365 times.
 214487 || ((raw[i] >= 'a') && (raw[i] <= 'z')) || (raw[i] == '/')
39
6/6
✓ Branch 1 taken 22721 times.
✓ Branch 2 taken 728 times.
✓ Branch 4 taken 12766 times.
✓ Branch 5 taken 9955 times.
✓ Branch 7 taken 438 times.
✓ Branch 8 taken 12328 times.
 23449 || (raw[i] == ':') || (raw[i] == '.') || (raw[i] == '_')
40
3/4
✓ Branch 1 taken 126 times.
✓ Branch 2 taken 312 times.
✓ Branch 4 taken 126 times.
✗ Branch 5 not taken.
 438 || (raw[i] == '-') || (raw[i] == ','))) {
41 126 goto escape_shell_quote;
42 }
43 }
44
1/2
✓ Branch 1 taken 17543 times.
✗ Branch 2 not taken.
 17543 return raw;
45
46 126 escape_shell_quote:
47
1/2
✓ Branch 2 taken 126 times.
✗ Branch 3 not taken.
 252 string result = "'";
48
2/2
✓ Branch 1 taken 4389 times.
✓ Branch 2 taken 126 times.
 4515 for (unsigned i = 0, l = raw.length(); i < l; ++i) {
49
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4389 times.
 4389 if (raw[i] == '\'')
50 ✗ result += "\\";
51
1/2
✓ Branch 2 taken 4389 times.
✗ Branch 3 not taken.
 4389 result += raw[i];
52 }
53
1/2
✓ Branch 1 taken 126 times.
✗ Branch 2 not taken.
 126 result += "'";
54 126 return result;
55 }
56
57
58 12620 string OptionsManager::TrimParameter(const string &parameter) {
59 12620 string result = Trim(parameter);
60 // Strip "readonly"
61
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 12620 times.
 12620 if (result.find("readonly ") == 0) {
62 ✗ result = result.substr(9);
63 ✗ result = Trim(result);
64
2/2
✓ Branch 1 taken 528 times.
✓ Branch 2 taken 12092 times.
 12620 } else if (result.find("export ") == 0) {
65
1/2
✓ Branch 1 taken 528 times.
✗ Branch 2 not taken.
 528 result = result.substr(7);
66
1/2
✓ Branch 1 taken 528 times.
✗ Branch 2 not taken.
 528 result = Trim(result);
67
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 12092 times.
 12092 } else if (result.find("eval ") == 0) {
68 ✗ result = result.substr(5);
69 ✗ result = Trim(result);
70 }
71 12620 return result;
72 }
73
74 14204 string OptionsManager::SanitizeParameterAssignment(string *line,
75 vector<string> *tokens) {
76 14204 const size_t comment_idx = line->find("#");
77
2/2
✓ Branch 0 taken 1056 times.
✓ Branch 1 taken 13148 times.
 14204 if (comment_idx != string::npos)
78
1/2
✓ Branch 1 taken 1056 times.
✗ Branch 2 not taken.
 1056 *line = line->substr(0, comment_idx);
79
1/2
✓ Branch 1 taken 14204 times.
✗ Branch 2 not taken.
 14204 *line = Trim(*line);
80
2/2
✓ Branch 1 taken 1056 times.
✓ Branch 2 taken 13148 times.
 14204 if (line->empty())
81
1/2
✓ Branch 2 taken 1056 times.
✗ Branch 3 not taken.
 1056 return "";
82
1/2
✓ Branch 1 taken 13148 times.
✗ Branch 2 not taken.
 13148 *tokens = SplitString(*line, '=');
83
2/2
✓ Branch 1 taken 528 times.
✓ Branch 2 taken 12620 times.
 13148 if (tokens->size() < 2)
84
1/2
✓ Branch 2 taken 528 times.
✗ Branch 3 not taken.
 528 return "";
85
1/2
✓ Branch 2 taken 12620 times.
✗ Branch 3 not taken.
 12620 string parameter = TrimParameter((*tokens)[0]);
86
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 12620 times.
 12620 if (parameter.find(" ") != string::npos)
87 ✗ return "";
88 12620 return parameter;
89 12620 }
90
91 474 void OptionsManager::SwitchTemplateManager(
92 OptionsTemplateManager *opt_templ_mgr_param) {
93
1/2
✓ Branch 0 taken 474 times.
✗ Branch 1 not taken.
 474 delete opt_templ_mgr_;
94
1/2
✓ Branch 0 taken 474 times.
✗ Branch 1 not taken.
 474 if (opt_templ_mgr_param != NULL) {
95 474 opt_templ_mgr_ = opt_templ_mgr_param;
96 } else {
97 ✗ opt_templ_mgr_ = new OptionsTemplateManager();
98 }
99 474 for (std::map<std::string, std::string>::iterator it =
100 474 templatable_values_.begin();
101
2/2
✓ Branch 2 taken 184 times.
✓ Branch 3 taken 474 times.
 658 it != templatable_values_.end();
102 184 it++) {
103
2/4
✓ Branch 3 taken 184 times.
✗ Branch 4 not taken.
✓ Branch 6 taken 184 times.
✗ Branch 7 not taken.
 184 config_[it->first].value = it->second;
104
2/4
✓ Branch 2 taken 184 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 184 times.
✗ Branch 6 not taken.
 184 opt_templ_mgr_->ParseString(&(config_[it->first].value));
105
2/4
✓ Branch 2 taken 184 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 184 times.
✗ Branch 6 not taken.
 184 UpdateEnvironment(it->first, config_[it->first]);
106 }
107 474 }
108
109 441 bool SimpleOptionsParser::TryParsePath(const string &config_file) {
110
1/2
✓ Branch 2 taken 441 times.
✗ Branch 3 not taken.
 441 LogCvmfs(kLogCvmfs, kLogDebug, "Fast-parsing config file %s",
111 config_file.c_str());
112 441 string line;
113
1/2
✓ Branch 2 taken 441 times.
✗ Branch 3 not taken.
 441 FILE *fconfig = fopen(config_file.c_str(), "r");
114
2/2
✓ Branch 0 taken 49 times.
✓ Branch 1 taken 392 times.
 441 if (fconfig == NULL)
115 49 return false;
116
117 // Read line by line and extract parameters
118
3/4
✓ Branch 1 taken 6076 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 5684 times.
✓ Branch 4 taken 392 times.
 6076 while (GetLineFile(fconfig, &line)) {
119 5684 vector<string> tokens;
120
1/2
✓ Branch 1 taken 5684 times.
✗ Branch 2 not taken.
 5684 const string parameter = SanitizeParameterAssignment(&line, &tokens);
121
2/2
✓ Branch 1 taken 1470 times.
✓ Branch 2 taken 4214 times.
 5684 if (parameter.empty())
122 1470 continue;
123
124 // Strip quotes from value
125
1/2
✓ Branch 3 taken 4214 times.
✗ Branch 4 not taken.
 4214 tokens.erase(tokens.begin());
126
3/6
✓ Branch 2 taken 4214 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 4214 times.
✗ Branch 6 not taken.
✓ Branch 8 taken 4214 times.
✗ Branch 9 not taken.
 8428 string value = Trim(JoinStrings(tokens, "="));
127 4214 const unsigned value_length = value.length();
128
2/2
✓ Branch 0 taken 3038 times.
✓ Branch 1 taken 1176 times.
 4214 if (value_length > 2) {
129
3/7
✓ Branch 1 taken 3038 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 294 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 294 times.
 3332 if (((value[0] == '"') && ((value[value_length - 1] == '"')))
130
9/13
✓ Branch 0 taken 294 times.
✓ Branch 1 taken 2744 times.
✓ Branch 3 taken 2744 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 294 times.
✓ Branch 6 taken 2450 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 294 times.
✗ Branch 9 not taken.
✓ Branch 10 taken 294 times.
✗ Branch 11 not taken.
✓ Branch 12 taken 588 times.
✓ Branch 13 taken 2450 times.
 3332 || ((value[0] == '\'') && ((value[value_length - 1] == '\'')))) {
131
1/2
✓ Branch 1 taken 588 times.
✗ Branch 2 not taken.
 588 value = value.substr(1, value_length - 2);
132 }
133 }
134
135 4214 ConfigValue config_value;
136
1/2
✓ Branch 1 taken 4214 times.
✗ Branch 2 not taken.
 4214 config_value.source = config_file;
137
1/2
✓ Branch 1 taken 4214 times.
✗ Branch 2 not taken.
 4214 config_value.value = value;
138
2/4
✓ Branch 1 taken 4214 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 4214 times.
✗ Branch 5 not taken.
 4214 PopulateParameter(parameter, config_value);
139
4/4
✓ Branch 3 taken 4214 times.
✓ Branch 4 taken 1470 times.
✓ Branch 6 taken 4214 times.
✓ Branch 7 taken 1470 times.
 7154 }
140
1/2
✓ Branch 1 taken 392 times.
✗ Branch 2 not taken.
 392 fclose(fconfig);
141 392 return true;
142 441 }
143
144 795 void BashOptionsManager::ParsePath(const string &config_file,
145 const bool external) {
146
1/2
✓ Branch 2 taken 795 times.
✗ Branch 3 not taken.
 795 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 795 pid_t pid_child = 0;
151
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 795 times.
 795 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 795 times.
✗ Branch 2 not taken.
 795 const string config_path = GetParentPath(config_file);
186
1/2
✓ Branch 2 taken 795 times.
✗ Branch 3 not taken.
 795 FILE *fconfig = fopen(config_file.c_str(), "r");
187
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 795 times.
 795 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 39 times.
✓ Branch 1 taken 756 times.
 795 if (!fconfig) {
195
2/8
✗ Branch 0 not taken.
✓ Branch 1 taken 39 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
✓ Branch 8 taken 39 times.
 39 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 39 return;
213 }
214
215 int fd_stdin;
216 int fd_stdout;
217 int fd_stderr;
218
1/2
✓ Branch 1 taken 756 times.
✗ Branch 2 not taken.
 756 retval = Shell(&fd_stdin, &fd_stdout, &fd_stderr);
219
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 756 times.
 756 assert(retval);
220
221 // Let the shell read the file
222 1512 string line;
223
1/2
✓ Branch 2 taken 756 times.
✗ Branch 3 not taken.
 1512 const string newline = "\n";
224
5/15
✗ Branch 1 not taken.
✓ Branch 2 taken 756 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 8 taken 756 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✓ Branch 11 taken 756 times.
✗ Branch 12 not taken.
✓ Branch 14 taken 756 times.
✗ Branch 15 not taken.
✗ Branch 18 not taken.
✓ Branch 19 taken 756 times.
✗ Branch 20 not taken.
✗ Branch 21 not taken.
 1512 const string cd = "cd \"" + ((config_path == "") ? "/" : config_path) + "\""
225
1/2
✓ Branch 1 taken 756 times.
✗ Branch 2 not taken.
 1512 + newline;
226
1/2
✓ Branch 3 taken 756 times.
✗ Branch 4 not taken.
 756 WritePipe(fd_stdin, cd.data(), cd.length());
227
3/4
✓ Branch 1 taken 9276 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 8520 times.
✓ Branch 4 taken 756 times.
 9276 while (GetLineFile(fconfig, &line)) {
228
1/2
✓ Branch 3 taken 8520 times.
✗ Branch 4 not taken.
 8520 WritePipe(fd_stdin, line.data(), line.length());
229
1/2
✓ Branch 3 taken 8520 times.
✗ Branch 4 not taken.
 8520 WritePipe(fd_stdin, newline.data(), newline.length());
230 }
231
1/2
✓ Branch 1 taken 756 times.
✗ Branch 2 not taken.
 756 rewind(fconfig);
232
233 // Read line by line and extract parameters
234
3/4
✓ Branch 1 taken 9276 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 8520 times.
✓ Branch 4 taken 756 times.
 9276 while (GetLineFile(fconfig, &line)) {
235 8520 vector<string> tokens;
236
1/2
✓ Branch 1 taken 8520 times.
✗ Branch 2 not taken.
 8520 const string parameter = SanitizeParameterAssignment(&line, &tokens);
237
2/2
✓ Branch 1 taken 1170 times.
✓ Branch 2 taken 7350 times.
 8520 if (parameter.empty())
238 1170 continue;
239
240 7350 ConfigValue value;
241
1/2
✓ Branch 1 taken 7350 times.
✗ Branch 2 not taken.
 7350 value.source = config_file;
242
2/4
✓ Branch 1 taken 7350 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 7350 times.
✗ Branch 5 not taken.
 7350 const string sh_echo = "echo $" + parameter + "\n";
243
1/2
✓ Branch 3 taken 7350 times.
✗ Branch 4 not taken.
 7350 WritePipe(fd_stdin, sh_echo.data(), sh_echo.length());
244
1/2
✓ Branch 1 taken 7350 times.
✗ Branch 2 not taken.
 7350 GetLineFd(fd_stdout, &value.value);
245
2/4
✓ Branch 1 taken 7350 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 7350 times.
✗ Branch 5 not taken.
 7350 PopulateParameter(parameter, value);
246
4/4
✓ Branch 3 taken 7350 times.
✓ Branch 4 taken 1170 times.
✓ Branch 6 taken 7350 times.
✓ Branch 7 taken 1170 times.
 9690 }
247
248
1/2
✓ Branch 1 taken 756 times.
✗ Branch 2 not taken.
 756 close(fd_stderr);
249
1/2
✓ Branch 1 taken 756 times.
✗ Branch 2 not taken.
 756 close(fd_stdout);
250
1/2
✓ Branch 1 taken 756 times.
✗ Branch 2 not taken.
 756 close(fd_stdin);
251
1/2
✓ Branch 1 taken 756 times.
✗ Branch 2 not taken.
 756 fclose(fconfig);
252 }
253
254
255 1541 bool OptionsManager::HasConfigRepository(const string &fqrn,
256 string *config_path) {
257 1541 string cvmfs_mount_dir;
258
3/6
✓ Branch 2 taken 1541 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 1541 times.
✗ Branch 6 not taken.
✗ Branch 9 not taken.
✓ Branch 10 taken 1541 times.
 1541 if (!GetValue("CVMFS_MOUNT_DIR", &cvmfs_mount_dir)) {
259 ✗ LogCvmfs(kLogCvmfs, kLogDebug | kLogSyslogErr, "CVMFS_MOUNT_DIR missing");
260 ✗ return false;
261 }
262
263 1541 string config_repository;
264
4/6
✓ Branch 2 taken 1541 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 1541 times.
✗ Branch 6 not taken.
✓ Branch 9 taken 117 times.
✓ Branch 10 taken 1424 times.
 1541 if (GetValue("CVMFS_CONFIG_REPOSITORY", &config_repository)) {
265
3/6
✓ Branch 1 taken 117 times.
✗ Branch 2 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 117 times.
✗ Branch 6 not taken.
✓ Branch 7 taken 117 times.
 117 if (config_repository.empty() || (config_repository == fqrn))
266 ✗ return false;
267
1/2
✓ Branch 1 taken 117 times.
✗ Branch 2 not taken.
 117 const sanitizer::RepositorySanitizer repository_sanitizer;
268
2/4
✓ Branch 1 taken 117 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 117 times.
 117 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 117 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 117 times.
✗ Branch 5 not taken.
✓ Branch 7 taken 117 times.
✗ Branch 8 not taken.
 117 *config_path = cvmfs_mount_dir + "/" + config_repository + "/etc/cvmfs/";
275 117 return true;
276 117 }
277 1424 return false;
278 1541 }
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 25773 void OptionsManager::PopulateParameter(const string &param, ConfigValue val) {
321
1/2
✓ Branch 1 taken 25773 times.
✗ Branch 2 not taken.
 25773 const map<string, string>::const_iterator iter = protected_parameters_.find(
322 25773 param);
323
5/6
✓ Branch 3 taken 88 times.
✓ Branch 4 taken 25685 times.
✓ Branch 7 taken 88 times.
✗ Branch 8 not taken.
✓ Branch 9 taken 88 times.
✓ Branch 10 taken 25685 times.
 25773 if ((iter != protected_parameters_.end()) && (iter->second != val.value)) {
324
1/3
✓ Branch 4 taken 88 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
 176 LogCvmfs(kLogCvmfs, kLogDebug | kLogSyslogErr,
325 "error in cvmfs configuration: attempt to change protected %s "
326 "from %s to %s",
327 88 param.c_str(), iter->second.c_str(), val.value.c_str());
328 88 return;
329 }
330
2/4
✓ Branch 1 taken 25685 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 25685 times.
✗ Branch 5 not taken.
 25685 ParseValue(param, &val);
331
2/4
✓ Branch 1 taken 25685 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 25685 times.
✗ Branch 5 not taken.
 25685 config_[param] = val;
332
1/2
✓ Branch 1 taken 25685 times.
✗ Branch 2 not taken.
 25685 UpdateEnvironment(param, val);
333 }
334
335 25869 void OptionsManager::UpdateEnvironment(const string &param, ConfigValue val) {
336
2/2
✓ Branch 0 taken 20831 times.
✓ Branch 1 taken 5038 times.
 25869 if (taint_environment_) {
337 20831 const int retval = setenv(param.c_str(), val.value.c_str(), 1);
338
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 20831 times.
 20831 assert(retval == 0);
339 }
340 25869 }
341
342 25685 void OptionsManager::ParseValue(std::string param, ConfigValue *val) {
343
1/2
✓ Branch 1 taken 25685 times.
✗ Branch 2 not taken.
 25685 const string orig = val->value;
344
1/2
✓ Branch 1 taken 25685 times.
✗ Branch 2 not taken.
 25685 const bool has_templ = opt_templ_mgr_->ParseString(&(val->value));
345
2/2
✓ Branch 0 taken 624 times.
✓ Branch 1 taken 25061 times.
 25685 if (has_templ) {
346
2/4
✓ Branch 1 taken 624 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 624 times.
✗ Branch 5 not taken.
 624 templatable_values_[param] = orig;
347 }
348 25685 }
349
350
351 88 void OptionsManager::ProtectParameter(const string &param) {
352 88 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 88 times.
✗ Branch 2 not taken.
 88 (void)GetValue(param, &value);
356
2/4
✓ Branch 1 taken 88 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 88 times.
✗ Branch 5 not taken.
 88 protected_parameters_[param] = value;
357 88 }
358
359
360 88 void OptionsManager::ClearConfig() { config_.clear(); }
361
362
363 16613 bool OptionsManager::IsDefined(const std::string &key) {
364
1/2
✓ Branch 1 taken 16613 times.
✗ Branch 2 not taken.
 16613 const map<string, ConfigValue>::const_iterator iter = config_.find(key);
365 16613 return iter != config_.end();
366 }
367
368
369 180325 bool OptionsManager::GetValue(const string &key, string *value) const {
370
1/2
✓ Branch 1 taken 180325 times.
✗ Branch 2 not taken.
 180325 const map<string, ConfigValue>::const_iterator iter = config_.find(key);
371
2/2
✓ Branch 2 taken 43962 times.
✓ Branch 3 taken 136363 times.
 180325 if (iter != config_.end()) {
372
1/2
✓ Branch 2 taken 43962 times.
✗ Branch 3 not taken.
 43962 *value = iter->second.value;
373 43962 return true;
374 }
375
1/2
✓ Branch 1 taken 136363 times.
✗ Branch 2 not taken.
 136363 *value = "";
376 136363 return false;
377 }
378
379
380 48 std::string OptionsManager::GetValueOrDie(const string &key) {
381 48 std::string value;
382
1/2
✓ Branch 1 taken 48 times.
✗ Branch 2 not taken.
 48 const bool retval = GetValue(key, &value);
383
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 48 times.
 48 if (!retval) {
384 ✗ PANIC(kLogStderr | kLogDebug, "%s configuration parameter missing",
385 key.c_str());
386 }
387 48 return value;
388 }
389
390
391 18197 bool OptionsManager::GetSource(const string &key, string *value) {
392
1/2
✓ Branch 1 taken 18197 times.
✗ Branch 2 not taken.
 18197 const map<string, ConfigValue>::const_iterator iter = config_.find(key);
393
1/2
✓ Branch 3 taken 18197 times.
✗ Branch 4 not taken.
 18197 if (iter != config_.end()) {
394
1/2
✓ Branch 2 taken 18197 times.
✗ Branch 3 not taken.
 18197 *value = iter->second.source;
395 18197 return true;
396 }
397 ✗ *value = "";
398 ✗ return false;
399 }
400
401
402 3327 bool OptionsManager::IsOn(const std::string &param_value) const {
403
1/2
✓ Branch 1 taken 3327 times.
✗ Branch 2 not taken.
 3327 const string uppercase = ToUpper(param_value);
404
2/4
✓ Branch 2 taken 3015 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 3015 times.
✗ Branch 6 not taken.
 6342 return ((uppercase == "YES") || (uppercase == "ON") || (uppercase == "1")
405
3/4
✓ Branch 0 taken 3015 times.
✓ Branch 1 taken 312 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 3015 times.
 9669 || (uppercase == "TRUE"));
406 3327 }
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 3116 vector<string> OptionsManager::GetAllKeys() {
417 3116 vector<string> result;
418 3116 for (map<string, ConfigValue>::const_iterator i = config_.begin(),
419 3116 iEnd = config_.end();
420
2/2
✓ Branch 1 taken 18901 times.
✓ Branch 2 taken 3116 times.
 22017 i != iEnd;
421 18901 ++i) {
422
1/2
✓ Branch 2 taken 18901 times.
✗ Branch 3 not taken.
 18901 result.push_back(i->first);
423 }
424 3116 return result;
425 }
426
427
428 356 vector<string> OptionsManager::GetEnvironmentSubset(const string &key_prefix,
429 bool strip_prefix) {
430 356 vector<string> result;
431 356 for (map<string, ConfigValue>::const_iterator i = config_.begin(),
432 356 iEnd = config_.end();
433
2/2
✓ Branch 1 taken 4928 times.
✓ Branch 2 taken 356 times.
 5284 i != iEnd;
434 4928 ++i) {
435 4928 const bool ignore_prefix = false;
436
3/4
✓ Branch 2 taken 4928 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 616 times.
✓ Branch 5 taken 4312 times.
 4928 if (HasPrefix(i->first, key_prefix, ignore_prefix)) {
437 const string output_key = strip_prefix
438 88 ? i->first.substr(key_prefix.length())
439
4/6
✓ Branch 0 taken 88 times.
✓ Branch 1 taken 528 times.
✓ Branch 4 taken 88 times.
✗ Branch 5 not taken.
✓ Branch 8 taken 528 times.
✗ Branch 9 not taken.
 704 : i->first;
440
3/6
✓ Branch 2 taken 616 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 616 times.
✗ Branch 6 not taken.
✓ Branch 8 taken 616 times.
✗ Branch 9 not taken.
 616 result.push_back(output_key + "=" + i->second.value);
441 616 }
442 }
443 356 return result;
444 }
445
446
447 2940 string OptionsManager::Dump() {
448 2940 string result;
449
1/2
✓ Branch 1 taken 2940 times.
✗ Branch 2 not taken.
 2940 vector<string> keys = GetAllKeys();
450
2/2
✓ Branch 1 taken 17669 times.
✓ Branch 2 taken 2940 times.
 20609 for (unsigned i = 0, l = keys.size(); i < l; ++i) {
451 bool retval;
452 17669 string value;
453 17669 string source;
454
455
1/2
✓ Branch 2 taken 17669 times.
✗ Branch 3 not taken.
 17669 retval = GetValue(keys[i], &value);
456
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 17669 times.
 17669 assert(retval);
457
1/2
✓ Branch 2 taken 17669 times.
✗ Branch 3 not taken.
 17669 retval = GetSource(keys[i], &source);
458
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 17669 times.
 17669 assert(retval);
459
5/10
✓ Branch 1 taken 17669 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 17669 times.
✗ Branch 6 not taken.
✓ Branch 8 taken 17669 times.
✗ Branch 9 not taken.
✓ Branch 11 taken 17669 times.
✗ Branch 12 not taken.
✓ Branch 14 taken 17669 times.
✗ Branch 15 not taken.
 35338 result += keys[i] + "=" + EscapeShell(value) + " # from " + source
460
2/4
✓ Branch 1 taken 17669 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 17669 times.
✗ Branch 5 not taken.
 17669 + "\n";
461 17669 }
462 5880 return result;
463 2940 }
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 14209 void OptionsManager::SetValue(const string &key, const string &value) {
473 14209 ConfigValue config_value;
474
1/2
✓ Branch 1 taken 14209 times.
✗ Branch 2 not taken.
 14209 config_value.source = "@INTERNAL@";
475
1/2
✓ Branch 1 taken 14209 times.
✗ Branch 2 not taken.
 14209 config_value.value = value;
476
2/4
✓ Branch 1 taken 14209 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 14209 times.
✗ Branch 5 not taken.
 14209 PopulateParameter(key, config_value);
477 14209 }
478
479
480 755 void OptionsManager::UnsetValue(const string &key) {
481 755 protected_parameters_.erase(key);
482 755 config_.erase(key);
483
2/2
✓ Branch 0 taken 667 times.
✓ Branch 1 taken 88 times.
 755 if (taint_environment_)
484 667 unsetenv(key.c_str());
485 755 }
486
487 const char *DefaultOptionsTemplateManager ::kTemplateIdentFqrn = "fqrn";
488
489 const char *DefaultOptionsTemplateManager ::kTemplateIdentOrg = "org";
490
491 967 DefaultOptionsTemplateManager::DefaultOptionsTemplateManager(std::string fqrn) {
492
3/6
✓ Branch 1 taken 967 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 967 times.
✗ Branch 6 not taken.
✓ Branch 8 taken 967 times.
✗ Branch 9 not taken.
 967 SetTemplate(kTemplateIdentFqrn, fqrn);
493
1/2
✓ Branch 1 taken 967 times.
✗ Branch 2 not taken.
 967 vector<string> fqrn_parts = SplitString(fqrn, '.');
494
3/6
✓ Branch 2 taken 967 times.
✗ Branch 3 not taken.
✓ Branch 6 taken 967 times.
✗ Branch 7 not taken.
✓ Branch 9 taken 967 times.
✗ Branch 10 not taken.
 967 SetTemplate(kTemplateIdentOrg, fqrn_parts[0]);
495 967 }
496
497 2218 void OptionsTemplateManager::SetTemplate(std::string name, std::string val) {
498 2218 templates_[name] = val;
499 2218 }
500
501 2628 std::string OptionsTemplateManager::GetTemplate(std::string name) {
502
2/2
✓ Branch 1 taken 664 times.
✓ Branch 2 taken 1964 times.
 2628 if (templates_.count(name)) {
503 664 return templates_[name];
504 } else {
505
2/4
✓ Branch 1 taken 1964 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 1964 times.
✗ Branch 5 not taken.
 1964 std::string var_name = "@" + name + "@";
506
1/2
✓ Branch 2 taken 1964 times.
✗ Branch 3 not taken.
 1964 LogCvmfs(kLogCvmfs, kLogDebug, "Undeclared variable: %s", var_name.c_str());
507 1964 return var_name;
508 1964 }
509 }
510
511 26065 bool OptionsTemplateManager::ParseString(std::string *input) {
512 26065 std::string result;
513
1/2
✓ Branch 1 taken 26065 times.
✗ Branch 2 not taken.
 26065 std::string in = *input;
514 26065 bool has_vars = false;
515 26065 int mode = 0;
516 26065 std::string stock;
517
2/2
✓ Branch 1 taken 596792 times.
✓ Branch 2 taken 26065 times.
 622857 for (std::string::size_type i = 0; i < in.size(); i++) {
518
2/3
✓ Branch 0 taken 582852 times.
✓ Branch 1 taken 13940 times.
✗ Branch 2 not taken.
 596792 switch (mode) {
519 582852 case 0:
520
3/4
✓ Branch 1 taken 582852 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 2911 times.
✓ Branch 4 taken 579941 times.
 582852 if (in[i] == '@') {
521 2911 mode = 1;
522 } else {
523
2/4
✓ Branch 1 taken 579941 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 579941 times.
✗ Branch 5 not taken.
 579941 result += in[i];
524 }
525 582852 break;
526 13940 case 1:
527
3/4
✓ Branch 1 taken 13940 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 2285 times.
✓ Branch 4 taken 11655 times.
 13940 if (in[i] == '@') {
528 2285 mode = 0;
529
3/6
✓ Branch 1 taken 2285 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 2285 times.
✗ Branch 5 not taken.
✓ Branch 7 taken 2285 times.
✗ Branch 8 not taken.
 2285 result += GetTemplate(stock);
530
1/2
✓ Branch 1 taken 2285 times.
✗ Branch 2 not taken.
 2285 stock = "";
531 2285 has_vars = true;
532 } else {
533
2/4
✓ Branch 1 taken 11655 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 11655 times.
✗ Branch 5 not taken.
 11655 stock += in[i];
534 }
535 13940 break;
536 }
537 }
538
2/2
✓ Branch 0 taken 626 times.
✓ Branch 1 taken 25439 times.
 26065 if (mode == 1) {
539
2/4
✓ Branch 1 taken 626 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 626 times.
✗ Branch 5 not taken.
 626 result += "@" + stock;
540 }
541
1/2
✓ Branch 1 taken 26065 times.
✗ Branch 2 not taken.
 26065 *input = result;
542 26065 return has_vars;
543 26065 }
544
545 343 bool OptionsTemplateManager::HasTemplate(std::string name) {
546 343 return templates_.count(name);
547 }
548
549 #ifdef CVMFS_NAMESPACE_GUARD
550 } // namespace CVMFS_NAMESPACE_GUARD
551 #endif
552