You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by kw...@apache.org on 2024/08/28 15:07:05 UTC
(jackrabbit-filevault-package-maven-plugin) branch feature/maven-filtering-3.4.0 created (now 7494129)
This is an automated email from the ASF dual-hosted git repository.
kwin pushed a change to branch feature/maven-filtering-3.4.0
in repository https://gitbox.apache.org/repos/asf/jackrabbit-filevault-package-maven-plugin.git
at 7494129 JCRVLT-757 use maven-filtering 3.4.0
This branch includes the following new commits:
new 7494129 JCRVLT-757 use maven-filtering 3.4.0
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(jackrabbit-filevault-package-maven-plugin) 01/01: JCRVLT-757 use maven-filtering 3.4.0
Posted by kw...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch feature/maven-filtering-3.4.0
in repository https://gitbox.apache.org/repos/asf/jackrabbit-filevault-package-maven-plugin.git
commit 7494129899d21e266476a524fc10aa86492a0102
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Wed Aug 28 17:06:57 2024 +0200
JCRVLT-757 use maven-filtering 3.4.0
---
pom.xml | 2 +-
.../packaging/CompositeInterpolatorCustomizer.java | 37 +++
.../maven/packaging/impl/DefaultFilterWrapper.java | 314 ---------------------
.../filevault/maven/packaging/mojo/VaultMojo.java | 9 +-
4 files changed, 44 insertions(+), 318 deletions(-)
diff --git a/pom.xml b/pom.xml
index 72a2a66..08b193f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -587,7 +587,7 @@
<dependency>
<groupId>org.apache.maven.shared</groupId>
<artifactId>maven-filtering</artifactId>
- <version>3.3.1</version>
+ <version>3.4.0-SNAPSHOT</version>
<scope>compile</scope>
<exclusions>
<exclusion>
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/CompositeInterpolatorCustomizer.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/CompositeInterpolatorCustomizer.java
new file mode 100644
index 0000000..abca8b1
--- /dev/null
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/CompositeInterpolatorCustomizer.java
@@ -0,0 +1,37 @@
+/*
+ * 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.jackrabbit.filevault.maven.packaging;
+
+import java.util.Collection;
+import java.util.function.Consumer;
+
+import org.codehaus.plexus.interpolation.Interpolator;
+
+public class CompositeInterpolatorCustomizer implements Consumer<Interpolator> {
+
+ private final Collection<Consumer<Interpolator>> interpolatorCustomizers;
+
+ public CompositeInterpolatorCustomizer(Collection<Consumer<Interpolator>> interpolatorCustomizers) {
+ this.interpolatorCustomizers = interpolatorCustomizers;
+ }
+
+ @Override
+ public void accept(Interpolator t) {
+ interpolatorCustomizers.forEach(c -> c.accept(t));
+ }
+
+}
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/DefaultFilterWrapper.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/DefaultFilterWrapper.java
deleted file mode 100644
index 88a1101..0000000
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/DefaultFilterWrapper.java
+++ /dev/null
@@ -1,314 +0,0 @@
-/*
- * 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.jackrabbit.filevault.maven.packaging.impl;
-
-import java.io.File;
-import java.io.IOException;
-import java.io.Reader;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.LinkedHashSet;
-import java.util.List;
-import java.util.Properties;
-import java.util.Set;
-import java.util.TreeSet;
-import java.util.function.Consumer;
-import java.util.stream.Collectors;
-
-import org.apache.jackrabbit.filevault.maven.packaging.InterpolatorCustomizerFactory;
-import org.apache.maven.execution.MavenSession;
-import org.apache.maven.project.MavenProject;
-import org.apache.maven.settings.Settings;
-import org.apache.maven.shared.filtering.AbstractMavenFilteringRequest;
-import org.apache.maven.shared.filtering.DefaultMavenFileFilter;
-import org.apache.maven.shared.filtering.FilterWrapper;
-import org.apache.maven.shared.filtering.FilteringUtils;
-import org.apache.maven.shared.filtering.MavenFilteringException;
-import org.apache.maven.shared.filtering.MultiDelimiterInterpolatorFilterReaderLineEnding;
-import org.apache.maven.shared.filtering.PropertyUtils;
-import org.codehaus.plexus.interpolation.Interpolator;
-import org.codehaus.plexus.interpolation.PrefixAwareRecursionInterceptor;
-import org.codehaus.plexus.interpolation.PrefixedObjectValueSource;
-import org.codehaus.plexus.interpolation.PropertiesBasedValueSource;
-import org.codehaus.plexus.interpolation.RecursionInterceptor;
-import org.codehaus.plexus.interpolation.SimpleRecursionInterceptor;
-import org.codehaus.plexus.interpolation.SingleResponseValueSource;
-import org.codehaus.plexus.interpolation.ValueSource;
-import org.codehaus.plexus.interpolation.multi.MultiDelimiterStringSearchInterpolator;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-/**
- * Mostly a copy from
- * <a href="https://github.com/apache/maven-filtering/blob/9d528d0871d93e317ae21a4b6922cd795502364c/src/main/java/org/apache/maven/shared/filtering/BaseFilter.java#L46">BaseFilter</a>.
- * Necessary due to <a href="https://issues.apache.org/jira/browse/MSHARED-1412">MSHARED-1412</a>
- * Allows to customize the underlying {@link Interpolator}, otherwise identical to the default filtering returned from {@link DefaultMavenFileFilter#getDefaultFilterWrappers(AbstractMavenFilteringRequest)}
- */
-public class DefaultFilterWrapper extends FilterWrapper {
-
- private static final Logger logger = LoggerFactory.getLogger(DefaultFilterWrapper.class);
-
- public static FilterWrapper createDefaultFilterWrapperWithInterpolationProcessors(final AbstractMavenFilteringRequest request, Set<InterpolatorCustomizerFactory> interpolationCustomizerFactory) throws MavenFilteringException {
- // copy of
- // https://github.com/apache/maven-filtering/blob/9d528d0871d93e317ae21a4b6922cd795502364c/src/main/java/org/apache/maven/shared/filtering/BaseFilter.java#L74C56-L74C100
- // backup values
- boolean supportMultiLineFiltering = request.isSupportMultiLineFiltering();
-
- request.setSupportMultiLineFiltering(supportMultiLineFiltering);
-
- // Here we build some properties which will be used to read some properties files
- // to interpolate the expression ${ } in this properties file
-
- // Take a copy of filterProperties to ensure that evaluated filterTokens are not propagated
- // to subsequent filter files. Note: this replicates current behaviour and seems to make sense.
-
- final Properties baseProps = new Properties();
-
- // Project properties
- if (request.getMavenProject() != null) {
- baseProps.putAll(
- request.getMavenProject().getProperties() == null
- ? Collections.emptyMap()
- : request.getMavenProject().getProperties());
- }
- // TODO this is NPE free but do we consider this as normal
- // or do we have to throw an MavenFilteringException with mavenSession cannot be null
- //
- // khmarbaise: 2016-05-21:
- // If we throw an MavenFilteringException tests will fail which is
- // caused by for example:
- // void copyFile( File from, final File to, boolean filtering, List<FileUtils.FilterWrapper> filterWrappers,
- // String encoding )
- // in MavenFileFilter interface where no MavenSession is given.
- // So changing here to throw a MavenFilteringException would make
- // it necessary to change the interface or we need to find a better solution.
- //
- if (request.getMavenSession() != null) {
- // User properties have precedence over system properties
- putAll(baseProps, request.getMavenSession().getSystemProperties());
- putAll(baseProps, request.getMavenSession().getUserProperties());
- }
-
- // now we build properties to use for resources interpolation
-
- final Properties filterProperties = new Properties();
-
- File basedir = request.getMavenProject() != null ? request.getMavenProject().getBasedir() : new File(".");
-
- loadProperties(filterProperties, basedir, request.getFileFilters(), baseProps);
- if (filterProperties.isEmpty()) {
- putAll(filterProperties, baseProps);
- }
-
- if (request.getMavenProject() != null) {
- if (request.isInjectProjectBuildFilters()) {
- List<String> buildFilters = new ArrayList<>(request.getMavenProject().getBuild().getFilters());
-
- // JDK-8015656: (coll) unexpected NPE from removeAll
- if (request.getFileFilters() != null) {
- buildFilters.removeAll(request.getFileFilters());
- }
-
- loadProperties(filterProperties, basedir, buildFilters, baseProps);
- }
-
- // Project properties
- filterProperties.putAll(
- request.getMavenProject().getProperties() == null
- ? Collections.emptyMap()
- : request.getMavenProject().getProperties());
- }
- if (request.getMavenSession() != null) {
- // User properties have precedence over system properties
- putAll(filterProperties, request.getMavenSession().getSystemProperties());
- putAll(filterProperties, request.getMavenSession().getUserProperties());
- }
-
- if (request.getAdditionalProperties() != null) {
- // additional properties wins
- putAll(filterProperties, request.getAdditionalProperties());
- }
-
- if (logger.isDebugEnabled()) {
- logger.debug("properties used:");
- for (String s : new TreeSet<>(filterProperties.stringPropertyNames())) {
- logger.debug(s + ": " + filterProperties.getProperty(s));
- }
- }
-
- final ValueSource propertiesValueSource = new PropertiesBasedValueSource(filterProperties);
-
- Collection<Consumer<Interpolator>> interpolatorCustomizers = interpolationCustomizerFactory.stream().map( f -> f.create(request.getMavenSession(), request.getMavenProject())).collect(Collectors.toList());
- FilterWrapper wrapper = new DefaultFilterWrapper(
- request.getDelimiters(),
- request.getMavenProject(),
- request.getMavenSession(),
- propertiesValueSource,
- request.getProjectStartExpressions(),
- request.getEscapeString(),
- request.isEscapeWindowsPaths(),
- request.isSupportMultiLineFiltering(),
- interpolatorCustomizers);
-
- return wrapper;
- }
-
- private static void putAll(Properties filterProperties, Properties request) {
- synchronized (request) {
- filterProperties.putAll(request);
- }
- }
-
- /** default visibility only for testing reason ! */
- private static void loadProperties(
- Properties filterProperties, File basedir, List<String> propertiesFilePaths, Properties baseProps)
- throws MavenFilteringException {
- if (propertiesFilePaths != null) {
- Properties workProperties = new Properties();
- putAll(workProperties, baseProps);
-
- for (String filterFile : propertiesFilePaths) {
- if (filterFile == null || filterFile.trim().isEmpty()) {
- // skip empty file name
- continue;
- }
- try {
- File propFile = FilteringUtils.resolveFile(basedir, filterFile);
- Properties properties = PropertyUtils.loadPropertyFile(propFile, workProperties, logger);
- putAll(filterProperties, properties);
- putAll(workProperties, properties);
- } catch (IOException e) {
- throw new MavenFilteringException("Error loading property file '" + filterFile + "'", e);
- }
- }
- }
- }
-
- private LinkedHashSet<String> delimiters;
-
- private MavenProject project;
-
- private ValueSource propertiesValueSource;
-
- private List<String> projectStartExpressions;
-
- private String escapeString;
-
- private boolean escapeWindowsPaths;
-
- private final MavenSession mavenSession;
-
- private boolean supportMultiLineFiltering;
-
- private final Collection<Consumer<Interpolator>> interpolatorCustomizers;
-
- DefaultFilterWrapper(
- LinkedHashSet<String> delimiters,
- MavenProject project,
- MavenSession mavenSession,
- ValueSource propertiesValueSource,
- List<String> projectStartExpressions,
- String escapeString,
- boolean escapeWindowsPaths,
- boolean supportMultiLineFiltering,
- Collection<Consumer<Interpolator>> interpolatorCustomizers) {
- super();
- this.delimiters = delimiters;
- this.project = project;
- this.mavenSession = mavenSession;
- this.propertiesValueSource = propertiesValueSource;
- this.projectStartExpressions = projectStartExpressions;
- this.escapeString = escapeString;
- this.escapeWindowsPaths = escapeWindowsPaths;
- this.supportMultiLineFiltering = supportMultiLineFiltering;
- this.interpolatorCustomizers = interpolatorCustomizers;
- }
-
- @Override
- public Reader getReader(Reader reader) {
- Interpolator interpolator = createInterpolator(
- delimiters,
- projectStartExpressions,
- propertiesValueSource,
- project,
- mavenSession,
- escapeString,
- escapeWindowsPaths);
-
- customizeInterpolator(interpolator);
-
- MultiDelimiterInterpolatorFilterReaderLineEnding filterReader = new MultiDelimiterInterpolatorFilterReaderLineEnding(
- reader, interpolator, supportMultiLineFiltering);
-
- final RecursionInterceptor ri;
- if (projectStartExpressions != null && !projectStartExpressions.isEmpty()) {
- ri = new PrefixAwareRecursionInterceptor(projectStartExpressions, true);
- } else {
- ri = new SimpleRecursionInterceptor();
- }
-
- filterReader.setRecursionInterceptor(ri);
- filterReader.setDelimiterSpecs(delimiters);
-
- filterReader.setInterpolateWithPrefixPattern(false);
- filterReader.setEscapeString(escapeString);
-
- return filterReader;
- }
-
- private void customizeInterpolator(Interpolator interpolator) {
- interpolatorCustomizers.forEach(c -> c.accept(interpolator));
- }
-
- private Interpolator createInterpolator(
- LinkedHashSet<String> delimiters,
- List<String> projectStartExpressions,
- ValueSource propertiesValueSource,
- MavenProject project,
- MavenSession mavenSession,
- String escapeString,
- boolean escapeWindowsPaths) {
- MultiDelimiterStringSearchInterpolator interpolator = new MultiDelimiterStringSearchInterpolator();
- interpolator.setDelimiterSpecs(delimiters);
-
- interpolator.addValueSource(propertiesValueSource);
-
- if (project != null) {
- interpolator.addValueSource(new PrefixedObjectValueSource(projectStartExpressions, project, true));
- }
-
- if (mavenSession != null) {
- interpolator.addValueSource(new PrefixedObjectValueSource("session", mavenSession));
-
- final Settings settings = mavenSession.getSettings();
- if (settings != null) {
- interpolator.addValueSource(new PrefixedObjectValueSource("settings", settings));
- interpolator.addValueSource(
- new SingleResponseValueSource("localRepository", settings.getLocalRepository()));
- }
- }
-
- interpolator.setEscapeString(escapeString);
-
- if (escapeWindowsPaths) {
- interpolator.addPostProcessor(
- (expression, value) -> (value instanceof String) ? FilteringUtils.escapeWindowsPath((String) value) : value);
- }
- return interpolator;
- }
-}
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/VaultMojo.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/VaultMojo.java
index c315602..2e97757 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/VaultMojo.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/VaultMojo.java
@@ -33,15 +33,16 @@ import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
+import java.util.function.Consumer;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.inject.Inject;
+import org.apache.jackrabbit.filevault.maven.packaging.CompositeInterpolatorCustomizer;
import org.apache.jackrabbit.filevault.maven.packaging.Filters;
import org.apache.jackrabbit.filevault.maven.packaging.InterpolatorCustomizerFactory;
import org.apache.jackrabbit.filevault.maven.packaging.impl.ContentPackageArchiver;
-import org.apache.jackrabbit.filevault.maven.packaging.impl.DefaultFilterWrapper;
import org.apache.jackrabbit.filevault.maven.packaging.impl.PlexusIoNonExistingDirectoryResource;
import org.apache.jackrabbit.vault.fs.api.PathFilterSet;
import org.apache.jackrabbit.vault.fs.config.ConfigurationException;
@@ -68,6 +69,7 @@ import org.apache.maven.shared.filtering.MavenResourcesFiltering;
import org.codehaus.plexus.archiver.FileSet;
import org.codehaus.plexus.archiver.jar.ManifestException;
import org.codehaus.plexus.archiver.util.DefaultFileSet;
+import org.codehaus.plexus.interpolation.Interpolator;
import org.codehaus.plexus.util.DirectoryScanner;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.MatchPatterns;
@@ -457,9 +459,10 @@ public class VaultMojo extends AbstractSourceAndMetadataPackageMojo {
mavenResourcesExecution.setAddDefaultExcludes(addDefaultExcludes);
mavenResourcesExecution.setOverwrite(true);
// cannot use default filter wrappers due to https://issues.apache.org/jira/browse/MSHARED-1412
- mavenResourcesExecution.setUseDefaultFilterWrappers(false);
+ mavenResourcesExecution.setUseDefaultFilterWrappers(true);
// rather use a custom wrapper which allows to customize the interpolator
- mavenResourcesExecution.addFilterWrapper(DefaultFilterWrapper.createDefaultFilterWrapperWithInterpolationProcessors(mavenResourcesExecution, interpolationCustomizerFactory));
+ Collection<Consumer<Interpolator>> interpolatorCustomizers = interpolationCustomizerFactory.stream().map( f -> f.create(session, project)).collect(Collectors.toList());
+ mavenResourcesExecution.setInterpolatorCustomizer(new CompositeInterpolatorCustomizer(interpolatorCustomizers));
return mavenResourcesExecution;
}