DefaultSettingsValidator.java
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.impl;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.regex.Pattern;
import org.apache.maven.api.services.BuilderProblem;
import org.apache.maven.api.services.ProblemCollector;
import org.apache.maven.api.settings.Mirror;
import org.apache.maven.api.settings.Profile;
import org.apache.maven.api.settings.Proxy;
import org.apache.maven.api.settings.Repository;
import org.apache.maven.api.settings.Server;
import org.apache.maven.api.settings.Settings;
/**
*/
public class DefaultSettingsValidator {
private static final String ID = "[\\w.-]+";
private static final Pattern ID_REGEX = Pattern.compile(ID);
private static final String ILLEGAL_NTFS_FILENAME_CHARS = "\\/:\"<>|?*";
@SuppressWarnings("checkstyle:MethodLength")
public void validate(Settings settings, boolean isProjectSettings, ProblemCollector<BuilderProblem> problems) {
if (isProjectSettings) {
String msgS = "is not supported on project settings.";
String msgP = "are not supported on project settings.";
if (settings.getLocalRepository() != null
&& !settings.getLocalRepository().isEmpty()) {
addViolation(problems, BuilderProblem.Severity.WARNING, "localRepository", null, msgS);
}
if (!settings.isInteractiveMode()) {
addViolation(problems, BuilderProblem.Severity.WARNING, "interactiveMode", null, msgS);
}
if (settings.isOffline()) {
addViolation(problems, BuilderProblem.Severity.WARNING, "offline", null, msgS);
}
if (!settings.getProxies().isEmpty()) {
addViolation(problems, BuilderProblem.Severity.WARNING, "proxies", null, msgP);
}
if (settings.isUsePluginRegistry()) {
addViolation(problems, BuilderProblem.Severity.WARNING, "usePluginRegistry", null, msgS);
}
List<Server> servers = settings.getServers();
for (int i = 0; i < servers.size(); i++) {
Server server = servers.get(i);
String serverField = "servers.server[" + i + "]";
validateStringEmpty(problems, serverField + ".username", server.getUsername(), msgS);
validateStringEmpty(problems, serverField + ".password", server.getPassword(), msgS);
validateStringEmpty(problems, serverField + ".privateKey", server.getPrivateKey(), msgS);
validateStringEmpty(problems, serverField + ".passphrase", server.getPassphrase(), msgS);
validateStringEmpty(problems, serverField + ".filePermissions", server.getFilePermissions(), msgS);
validateStringEmpty(
problems, serverField + ".directoryPermissions", server.getDirectoryPermissions(), msgS);
if (!server.getAliases().isEmpty()) {
addViolation(problems, BuilderProblem.Severity.WARNING, serverField + ".aliases", null, msgP);
}
if (!server.getRepositoryOrigins().isEmpty()) {
addViolation(
problems, BuilderProblem.Severity.WARNING, serverField + ".repositoryOrigins", null, msgP);
}
}
}
if (settings.isUsePluginRegistry()) {
addViolation(
problems,
BuilderProblem.Severity.WARNING,
"usePluginRegistry",
null,
"is deprecated and has no effect.");
}
List<String> pluginGroups = settings.getPluginGroups();
if (pluginGroups != null) {
for (int i = 0; i < pluginGroups.size(); i++) {
String pluginGroup = pluginGroups.get(i);
validateStringNotEmpty(problems, "pluginGroups.pluginGroup[" + i + "]", pluginGroup, null);
if (!ID_REGEX.matcher(pluginGroup).matches()) {
addViolation(
problems,
BuilderProblem.Severity.ERROR,
"pluginGroups.pluginGroup[" + i + "]",
null,
"must denote a valid group id and match the pattern " + ID);
}
}
}
List<Server> servers = settings.getServers();
if (servers != null) {
Set<String> serverIds = new HashSet<>();
for (int i = 0; i < servers.size(); i++) {
Server server = servers.get(i);
validateStringNotEmpty(problems, "servers.server[" + i + "].id", server.getId(), null);
if (!serverIds.add(server.getId())) {
addViolation(
problems,
BuilderProblem.Severity.WARNING,
"servers.server.id",
null,
"must be unique but found duplicate server with id " + server.getId());
}
}
for (int i = 0; i < servers.size(); i++) {
Server server = servers.get(i);
for (int a = 0; a < server.getAliases().size(); a++) {
String alias = server.getAliases().get(a);
validateStringNotEmpty(
problems, "servers.server[" + i + "].aliases[" + a + "]", alias, server.getId());
if (!serverIds.add(alias)) {
addViolation(
problems,
BuilderProblem.Severity.WARNING,
"servers.server[" + i + "].aliases[" + a + "]",
server.getId(),
"must be unique across all server ids and aliases but found duplicate alias " + alias);
}
}
validateRepositoryOrigins(problems, server, i);
}
}
List<Mirror> mirrors = settings.getMirrors();
if (mirrors != null) {
for (Mirror mirror : mirrors) {
validateStringNotEmpty(problems, "mirrors.mirror.id", mirror.getId(), mirror.getUrl());
validateBannedCharacters(
problems,
"mirrors.mirror.id",
BuilderProblem.Severity.WARNING,
mirror.getId(),
null,
ILLEGAL_NTFS_FILENAME_CHARS);
if ("local".equals(mirror.getId())) {
addViolation(
problems,
BuilderProblem.Severity.WARNING,
"mirrors.mirror.id",
null,
"must not be 'local'"
+ ", this identifier is reserved for the local repository"
+ ", using it for other repositories will corrupt your repository metadata.");
}
validateStringNotEmpty(problems, "mirrors.mirror.url", mirror.getUrl(), mirror.getId());
validateStringNotEmpty(problems, "mirrors.mirror.mirrorOf", mirror.getMirrorOf(), mirror.getId());
}
}
List<Profile> profiles = settings.getProfiles();
if (profiles != null) {
Set<String> profileIds = new HashSet<>();
for (Profile profile : profiles) {
if (!profileIds.add(profile.getId())) {
addViolation(
problems,
BuilderProblem.Severity.WARNING,
"profiles.profile.id",
null,
"must be unique but found duplicate profile with id " + profile.getId());
}
String prefix = "profiles.profile[" + profile.getId() + "].";
validateRepositories(problems, profile.getRepositories(), prefix + "repositories.repository");
validateRepositories(
problems, profile.getPluginRepositories(), prefix + "pluginRepositories.pluginRepository");
}
}
List<Proxy> proxies = settings.getProxies();
if (proxies != null) {
Set<String> proxyIds = new HashSet<>();
for (Proxy proxy : proxies) {
if (!proxyIds.add(proxy.getId())) {
addViolation(
problems,
BuilderProblem.Severity.WARNING,
"proxies.proxy.id",
null,
"must be unique but found duplicate proxy with id " + proxy.getId());
}
validateStringNotEmpty(problems, "proxies.proxy.host", proxy.getHost(), proxy.getId());
try {
Integer.parseInt(proxy.getPortString());
} catch (NumberFormatException e) {
addViolation(
problems,
BuilderProblem.Severity.ERROR,
"proxies.proxy[" + proxy.getId() + "].port",
null,
"must be a valid integer but found '" + proxy.getPortString() + "'");
}
}
}
}
private void validateRepositories(
ProblemCollector<BuilderProblem> problems, List<Repository> repositories, String prefix) {
Set<String> repoIds = new HashSet<>();
for (Repository repository : repositories) {
validateStringNotEmpty(problems, prefix + ".id", repository.getId(), repository.getUrl());
validateBannedCharacters(
problems,
prefix + ".id",
BuilderProblem.Severity.WARNING,
repository.getId(),
null,
ILLEGAL_NTFS_FILENAME_CHARS);
if ("local".equals(repository.getId())) {
addViolation(
problems,
BuilderProblem.Severity.WARNING,
prefix + ".id",
null,
"must not be 'local'"
+ ", this identifier is reserved for the local repository"
+ ", using it for other repositories will corrupt your repository metadata.");
}
if (!repoIds.add(repository.getId())) {
addViolation(
problems,
BuilderProblem.Severity.WARNING,
prefix + ".id",
null,
"must be unique but found duplicate repository with id " + repository.getId());
}
validateStringNotEmpty(problems, prefix + ".url", repository.getUrl(), repository.getId());
if ("legacy".equals(repository.getLayout())) {
addViolation(
problems,
BuilderProblem.Severity.WARNING,
prefix + ".layout",
repository.getId(),
"uses the unsupported value 'legacy', artifact resolution might fail.");
}
}
}
private static void validateRepositoryOrigins(ProblemCollector<BuilderProblem> problems, Server server, int index) {
for (int o = 0; o < server.getRepositoryOrigins().size(); o++) {
String repositoryOrigin = server.getRepositoryOrigins().get(o);
String fieldName = "servers.server[" + index + "].repositoryOrigins[" + o + "]";
if (!validateStringNotEmpty(problems, fieldName, repositoryOrigin, server.getId())) {
continue;
}
// settings are interpolated before they are validated, so a placeholder left here is a defect
// and would silently never match any repository
if (repositoryOrigin.contains("${")) {
addViolation(
problems,
BuilderProblem.Severity.ERROR,
fieldName,
server.getId(),
"contains an unresolved property placeholder: '" + repositoryOrigin + "'");
continue;
}
String invalid = invalidRepositoryOriginReason(repositoryOrigin);
if (invalid != null) {
addViolation(problems, BuilderProblem.Severity.ERROR, fieldName, server.getId(), invalid);
continue;
}
String ignored = ignoredRepositoryOriginPartsReason(repositoryOrigin);
if (ignored != null) {
addViolation(problems, BuilderProblem.Severity.WARNING, fieldName, server.getId(), ignored);
}
}
}
/**
* Parses a {@code <server><repositoryOrigins>} value the way the credential scoping does; see
* {@code OriginBoundAuthenticationSelector#originOf(String)} in maven-core, which is the authority
* on what an origin is. Returns {@code null} when the value is not a URI at all.
*/
private static URI parseRepositoryOrigin(String value) {
try {
return new URI(value).parseServerAuthority();
} catch (URISyntaxException e) {
return null;
}
}
/**
* @return the reason why no origin can be derived from the given value, or {@code null} if one can
*/
private static String invalidRepositoryOriginReason(String value) {
URI uri = parseRepositoryOrigin(value);
if (uri == null) {
return "must be a repository origin of the form scheme://host[:port] but found '" + value + "'";
}
if (uri.getScheme() == null) {
return "must start with a scheme, for example https://repo.example.org, but found '" + value + "'";
}
if (uri.getHost() == null) {
return "must name a host, for example https://repo.example.org, but found '" + value + "'";
}
if (uri.getUserInfo() != null) {
return "must not carry user information but found '" + value + "'";
}
return null;
}
/**
* @return the reason why parts of the given value are ignored, or {@code null} if it is a bare origin
*/
private static String ignoredRepositoryOriginPartsReason(String value) {
URI uri = parseRepositoryOrigin(value);
String path = uri.getRawPath();
boolean extraPath = path != null && !path.isEmpty() && !"/".equals(path);
if (!extraPath && uri.getRawQuery() == null && uri.getRawFragment() == null) {
return null;
}
return "is a repository origin, not a repository URL; only '" + uri.getScheme() + "://" + uri.getAuthority()
+ "' of '" + value + "' is used";
}
// ----------------------------------------------------------------------
// Field validation
// ----------------------------------------------------------------------
/**
* Asserts:
* <p/>
* <ul>
* <li><code>string.length == null</code>
* <li><code>string.length == 0</code>
* </ul>
*/
private static boolean validateStringEmpty(
ProblemCollector<BuilderProblem> problems, String fieldName, String string, String message) {
if (string == null || string.isEmpty()) {
return true;
}
addViolation(problems, BuilderProblem.Severity.WARNING, fieldName, null, message);
return false;
}
/**
* Asserts:
* <p/>
* <ul>
* <li><code>string.length != null</code>
* <li><code>string.length > 0</code>
* </ul>
*/
private static boolean validateStringNotEmpty(
ProblemCollector<BuilderProblem> problems, String fieldName, String string, String sourceHint) {
if (!validateNotNull(problems, fieldName, string, sourceHint)) {
return false;
}
if (!string.isEmpty()) {
return true;
}
addViolation(problems, BuilderProblem.Severity.ERROR, fieldName, sourceHint, "is missing");
return false;
}
/**
* Asserts:
* <p/>
* <ul>
* <li><code>string != null</code>
* </ul>
*/
private static boolean validateNotNull(
ProblemCollector<BuilderProblem> problems, String fieldName, Object object, String sourceHint) {
if (object != null) {
return true;
}
addViolation(problems, BuilderProblem.Severity.ERROR, fieldName, sourceHint, "is missing");
return false;
}
private static boolean validateBannedCharacters(
ProblemCollector<BuilderProblem> problems,
String fieldName,
BuilderProblem.Severity severity,
String string,
String sourceHint,
String banned) {
if (string != null) {
for (int i = string.length() - 1; i >= 0; i--) {
if (banned.indexOf(string.charAt(i)) >= 0) {
addViolation(
problems,
severity,
fieldName,
sourceHint,
"must not contain any of these characters " + banned + " but found " + string.charAt(i));
return false;
}
}
}
return true;
}
private static void addViolation(
ProblemCollector<BuilderProblem> problems,
BuilderProblem.Severity severity,
String fieldName,
String sourceHint,
String message) {
StringBuilder buffer = new StringBuilder(256);
buffer.append('\'').append(fieldName).append('\'');
if (sourceHint != null) {
buffer.append(" for ").append(sourceHint);
}
buffer.append(' ').append(message);
problems.reportProblem(new DefaultBuilderProblem(null, -1, -1, null, buffer.toString(), severity));
}
}