1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/*
* SonarQube
* Copyright (C) 2009-2020 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.scanner.config;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import javax.annotation.concurrent.Immutable;
import org.apache.commons.lang.ArrayUtils;
import org.sonar.api.config.Configuration;
import org.sonar.api.config.Encryption;
import org.sonar.api.config.PropertyDefinition;
import org.sonar.api.config.PropertyDefinitions;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;
import static java.util.Objects.requireNonNull;
import static org.apache.commons.lang.StringUtils.trim;
import static org.sonar.api.config.internal.MultivalueProperty.parseAsCsv;
@Immutable
public abstract class DefaultConfiguration implements Configuration {
private static final Logger LOG = Loggers.get(DefaultConfiguration.class);
private final PropertyDefinitions definitions;
private final Encryption encryption;
private final Map<String, String> properties;
private final Map<String, String> originalProperties;
public DefaultConfiguration(PropertyDefinitions propertyDefinitions, Encryption encryption, Map<String, String> props) {
this.definitions = requireNonNull(propertyDefinitions);
this.encryption = encryption;
this.properties = unmodifiableMapWithTrimmedValues(definitions, props);
this.originalProperties = Collections.unmodifiableMap(props);
}
protected static Map<String, String> unmodifiableMapWithTrimmedValues(PropertyDefinitions definitions, Map<String, String> props) {
Map<String, String> map = new HashMap<>(props.size());
props.forEach((k, v) -> {
String validKey = definitions.validKey(k);
map.put(validKey, trim(v));
});
return Collections.unmodifiableMap(map);
}
public Encryption getEncryption() {
return encryption;
}
public PropertyDefinitions getDefinitions() {
return definitions;
}
public Map<String, String> getProperties() {
return properties;
}
public Map<String, String> getOriginalProperties() {
return originalProperties;
}
@Override
public boolean hasKey(String key) {
return properties.containsKey(key);
}
@Override
public Optional<String> get(String key) {
String effectiveKey = definitions.validKey(key);
PropertyDefinition def = definitions.get(effectiveKey);
if (def != null && (def.multiValues() || !def.fields().isEmpty())) {
LOG.warn("Access to the multi-values/property set property '{}' should be made using 'getStringArray' method. The SonarQube plugin using this property should be updated.",
key);
}
return getInternal(effectiveKey);
}
@Override
public String[] getStringArray(String key) {
String effectiveKey = definitions.validKey(key);
PropertyDefinition def = definitions.get(effectiveKey);
if (def != null && !def.multiValues() && def.fields().isEmpty()) {
LOG.warn(
"Property '{}' is not declared as multi-values/property set but was read using 'getStringArray' method. The SonarQube plugin declaring this property should be updated.",
key);
}
Optional<String> value = getInternal(effectiveKey);
if (value.isPresent()) {
return parseAsCsv(effectiveKey, value.get());
}
return ArrayUtils.EMPTY_STRING_ARRAY;
}
private Optional<String> getInternal(String key) {
Optional<String> value = Optional.ofNullable(properties.get(key));
if (!value.isPresent()) {
// default values cannot be encrypted, so return value as-is.
return Optional.ofNullable(definitions.getDefaultValue(key));
}
if (encryption.isEncrypted(value.get())) {
try {
return Optional.of(encryption.decrypt(value.get()));
} catch (Exception e) {
throw new IllegalStateException("Fail to decrypt the property " + key + ". Please check your secret key.", e);
}
}
return value;
}
}
|
