[ https://issues.apache.org/jira/browse/MNG-7914?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17864789#comment-17864789 ]
ASF GitHub Bot commented on MNG-7914: ------------------------------------- slawekjaranowski commented on code in PR #1595: URL: https://github.com/apache/maven/pull/1595#discussion_r1672839368 ########## maven-embedder/src/main/java/org/apache/maven/cli/props/MavenPropertiesLoader.java: ########## @@ -0,0 +1,176 @@ +/* + * 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.cli.props; + +import java.nio.file.NoSuchFileException; +import java.nio.file.Path; +import java.util.Enumeration; +import java.util.StringTokenizer; +import java.util.function.Function; + +import static org.apache.maven.cli.props.InterpolationHelper.substVars; + +public class MavenPropertiesLoader { + + public static final String INCLUDES_PROPERTY = "${includes}"; // includes + + public static final String OVERRIDE_PREFIX = + "maven.override."; // prefix that marks that system property should override defaults. + + public static void loadProperties( + java.util.Properties properties, Path path, Function<String, String> callback, boolean escape) + throws Exception { + MavenProperties sp = new MavenProperties(false); + try { + sp.load(path); + } catch (NoSuchFileException ex) { + // ignore + } + properties.forEach( + (k, v) -> sp.put(k.toString(), escape ? InterpolationHelper.escape(v.toString()) : v.toString())); + substitute(sp, callback, INCLUDES_PROPERTY); + loadIncludes(INCLUDES_PROPERTY, path, sp); + substitute(sp, callback); + sp.forEach(properties::setProperty); + } + + public static void substitute(MavenProperties props, Function<String, String> callback) { + for (Enumeration<?> e = props.propertyNames(); e.hasMoreElements(); ) { + String name = (String) e.nextElement(); + String value = props.getProperty(name); + if (value == null) { + value = callback.apply(name); + } + if (name.startsWith(OVERRIDE_PREFIX)) { + String overrideName = name.substring(OVERRIDE_PREFIX.length()); + props.put(overrideName, substVars(value, name, null, props, callback)); + } else { + props.put(name, substVars(value, name, null, props, callback)); + } + } + props.keySet().removeIf(k -> k.startsWith(OVERRIDE_PREFIX)); + } + + private static void substitute(MavenProperties props, Function<String, String> callback, String name) { + String value = props.getProperty(name); + if (value == null) { + value = callback.apply(name); + } + if (value != null) { + props.put(name, substVars(value, name, null, props, callback)); + } + } + + private static MavenProperties loadPropertiesFile(Path path, boolean failIfNotFound) throws Exception { + MavenProperties configProps = new MavenProperties(null, false); + try { + configProps.load(path); + } catch (NoSuchFileException ex) { + if (failIfNotFound) { + throw ex; + } + } catch (Exception ex) { + System.err.println("Error loading config properties from " + path); + System.err.println("Main: " + ex); + return configProps; + } + loadIncludes(INCLUDES_PROPERTY, path, configProps); + trimValues(configProps); + return configProps; + } + + private static void loadIncludes(String propertyName, Path configProp, MavenProperties configProps) + throws Exception { + String includes = configProps.get(propertyName); + if (includes != null) { + StringTokenizer st = new StringTokenizer(includes, "?\",", true); + if (st.countTokens() > 0) { + String location; + do { + location = nextLocation(st); + if (location != null) { + boolean mandatory = true; + if (location.startsWith("?")) { + mandatory = false; + location = location.substring(1); + } + Path path = configProp.resolve(location); Review Comment: proposition: ``` Path path = configProp.getParent().resolve(location); ``` `path` is a path for current properties which contains includes so we should resolve against directory contains properties - not a property file. it will allow relative path in properties like: ``` ${includes}=default.properties ``` > Provide a single entry point for configuration > ---------------------------------------------- > > Key: MNG-7914 > URL: https://issues.apache.org/jira/browse/MNG-7914 > Project: Maven > Issue Type: New Feature > Reporter: Guillaume Nodet > Priority: Major > Fix For: 4.0.x-candidate > > > Looking at MNG-7772, this should not require any code change, but it's all > about configuration. > I propose to load / interpolate the following files: > * {{${maven.home}/conf/maven.user.properties}} > * {{${maven.home}/conf/maven.system.properties}} > Those files would be used to load additional user properties and system > properties for Maven. In addition to the simple interpolation mechanism, we > should provide two enhancements using special keys {{{}$\{includes{}}}} and > {{{}$\{optionals{}}}} which would be used to load additional referenced > configuration files such as: > {{ ${optionals} = ${user.home}/.m2/maven.user.properties, > ${session.rootDirectory}/.mvn/maven.user.properties}} > Being loaded early when Maven is loaded, those files could reference > directories to load extensions from: > {{{}maven.core.extensions.directories = > ${session.rootDirectory}/.mvn/extensions.xml,{}}}{{{}${user.home}/.m2/extensions.xml,${maven.home}/extensions.xml{}}} > > In various places, the maven code could be simplified and offer more > configuration points at the same time. -- This message was sent by Atlassian Jira (v8.20.10#820010)