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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/*
* SonarQube
* Copyright (C) 2009-2018 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.io.IOException;
import java.io.StringReader;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.concurrent.Immutable;
import org.apache.commons.csv.CSVFormat;
import org.apache.commons.csv.CSVParser;
import org.apache.commons.csv.CSVRecord;
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.MessageException;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;
import org.sonar.scanner.bootstrap.GlobalAnalysisMode;
import static java.util.Objects.requireNonNull;
import static org.apache.commons.lang.StringUtils.trim;
@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 GlobalAnalysisMode mode;
private final Map<String, String> properties;
public DefaultConfiguration(PropertyDefinitions propertyDefinitions, Encryption encryption, GlobalAnalysisMode mode, Map<String, String> props) {
this.definitions = requireNonNull(propertyDefinitions);
this.encryption = encryption;
this.mode = mode;
this.properties = unmodifiableMapWithTrimmedValues(definitions, 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 GlobalAnalysisMode getMode() {
return mode;
}
public Encryption getEncryption() {
return encryption;
}
public PropertyDefinitions getDefinitions() {
return definitions;
}
public Map<String, String> getProperties() {
return properties;
}
@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;
}
public static String[] parseAsCsv(String key, String value) {
String cleanValue = MultivaluePropertyCleaner.trimFieldsAndRemoveEmptyFields(value);
List<String> result = new ArrayList<>();
try (CSVParser csvParser = CSVFormat.RFC4180
.withHeader((String) null)
.withIgnoreEmptyLines()
.withIgnoreSurroundingSpaces()
.parse(new StringReader(cleanValue))) {
List<CSVRecord> records = csvParser.getRecords();
if (records.isEmpty()) {
return ArrayUtils.EMPTY_STRING_ARRAY;
}
processRecords(result, records);
return result.toArray(new String[result.size()]);
} catch (IOException e) {
throw new IllegalStateException("Property: '" + key + "' doesn't contain a valid CSV value: '" + value + "'", e);
}
}
/**
* In most cases we expect a single record. <br>Having multiple records means the input value was splitted over multiple lines (this is common in Maven).
* For example:
* <pre>
* <sonar.exclusions>
* src/foo,
* src/bar,
* src/biz
* <sonar.exclusions>
* </pre>
* In this case records will be merged to form a single list of items. Last item of a record is appended to first item of next record.
* <p>
* This is a very curious case, but we try to preserve line break in the middle of an item:
* <pre>
* <sonar.exclusions>
* a
* b,
* c
* <sonar.exclusions>
* </pre>
* will produce ['a\nb', 'c']
*/
private static void processRecords(List<String> result, List<CSVRecord> records) {
for (CSVRecord csvRecord : records) {
Iterator<String> it = csvRecord.iterator();
if (!result.isEmpty()) {
String next = it.next();
if (!next.isEmpty()) {
int lastItemIdx = result.size() - 1;
String previous = result.get(lastItemIdx);
if (previous.isEmpty()) {
result.set(lastItemIdx, next);
} else {
result.set(lastItemIdx, previous + "\n" + next);
}
}
}
it.forEachRemaining(result::add);
}
}
private Optional<String> getInternal(String key) {
if (mode.isIssues() && key.endsWith(".secured") && !key.contains(".license")) {
throw MessageException.of("Access to the secured property '" + key
+ "' is not possible in issues mode. The SonarQube plugin which requires this property must be deactivated in issues mode.");
}
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;
}
}
|
