/* * SonarQube * Copyright (C) 2009-2025 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.lang3.ArrayUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.sonar.api.config.Configuration; import org.sonar.api.config.PropertyDefinition; import org.sonar.api.config.PropertyDefinitions; import org.sonar.api.config.internal.Encryption; import static java.util.Objects.requireNonNull; import static org.apache.commons.lang3.StringUtils.trim; import static org.sonar.api.config.internal.MultivalueProperty.parseAsCsv; @Immutable public abstract class DefaultConfiguration implements Configuration { private static final Logger LOG = LoggerFactory.getLogger(DefaultConfiguration.class); private final PropertyDefinitions definitions; private final Encryption encryption; private final Map properties; private final Map originalProperties; public DefaultConfiguration(PropertyDefinitions propertyDefinitions, Encryption encryption, Map props) { this.definitions = requireNonNull(propertyDefinitions); this.encryption = encryption; this.properties = unmodifiableMapWithTrimmedValues(definitions, props); this.originalProperties = Collections.unmodifiableMap(props); } protected static Map unmodifiableMapWithTrimmedValues(PropertyDefinitions definitions, Map props) { Map 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 getProperties() { return properties; } public Map getOriginalProperties() { return originalProperties; } @Override public boolean hasKey(String key) { return properties.containsKey(key); } @Override public Optional 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 value = getInternal(effectiveKey); if (value.isPresent()) { return parseAsCsv(effectiveKey, value.get()); } return ArrayUtils.EMPTY_STRING_ARRAY; } private Optional getInternal(String key) { Optional 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; } }