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 2022/04/09 18:06:08 UTC
[jackrabbit-filevault-package-maven-plugin] branch feature/JCRVLT-621-add-builtWIth-property updated (e8c7401 -> b347370)
This is an automated email from the ASF dual-hosted git repository.
kwin pushed a change to branch feature/JCRVLT-621-add-builtWIth-property
in repository https://gitbox.apache.org/repos/asf/jackrabbit-filevault-package-maven-plugin.git
discard e8c7401 JCRVLT-621 add "builtWith" property in package definition serialization
new b347370 JCRVLT-621 add "builtWith" property in package definition serialization
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (e8c7401)
\
N -- N -- N refs/heads/feature/JCRVLT-621-add-builtWIth-property (b347370)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
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.
Summary of changes:
pom.xml | 9 ++++
.../maven/packaging/mojo/GenerateMetadataMojo.java | 50 ++++++++++++++++------
.../resources-filtered/maven-project.properties} | 8 ++--
3 files changed, 50 insertions(+), 17 deletions(-)
copy src/{test/resources/test-projects/filtering-tests/simple-filter/filter.properties => main/resources-filtered/maven-project.properties} (93%)
[jackrabbit-filevault-package-maven-plugin] 01/01: JCRVLT-621 add "builtWith" property in package definition serialization
Posted by kw...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch feature/JCRVLT-621-add-builtWIth-property
in repository https://gitbox.apache.org/repos/asf/jackrabbit-filevault-package-maven-plugin.git
commit b3473709d18bc394044d77e9e49b94e50037d76f
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Fri Apr 8 16:01:41 2022 +0200
JCRVLT-621 add "builtWith" property in package definition serialization
---
pom.xml | 11 ++-
.../maven/packaging/mojo/GenerateMetadataMojo.java | 86 ++++++++++++++++++----
.../resources-filtered/maven-project.properties | 19 +++++
3 files changed, 99 insertions(+), 17 deletions(-)
diff --git a/pom.xml b/pom.xml
index e1ec1cc..a853a4f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -24,7 +24,7 @@
<groupId>org.apache.jackrabbit.vault</groupId>
<artifactId>parent</artifactId>
<relativePath />
- <version>3.6.0</version>
+ <version>3.6.1-SNAPSHOT</version>
</parent>
<!-- ====================================================================== -->
@@ -87,6 +87,15 @@
<!-- B U I L D D E F I N I T I O N -->
<!-- ====================================================================== -->
<build>
+ <resources>
+ <resource>
+ <directory>src/main/resources</directory>
+ </resource>
+ <resource>
+ <directory>src/main/resources-filtered</directory>
+ <filtering>true</filtering>
+ </resource>
+ </resources>
<pluginManagement>
<plugins>
<!-- update from 3.6.1 in ASF parent -->
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/GenerateMetadataMojo.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/GenerateMetadataMojo.java
index 7400bff..f8ca121 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/GenerateMetadataMojo.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/mojo/GenerateMetadataMojo.java
@@ -27,8 +27,10 @@ import java.net.URISyntaxException;
import java.nio.file.Files;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
+import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
+import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
@@ -48,6 +50,11 @@ import java.util.stream.Collectors;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
+import javax.jcr.NamespaceException;
+import javax.jcr.PropertyType;
+import javax.xml.stream.FactoryConfigurationError;
+import javax.xml.stream.XMLStreamException;
+
import org.apache.commons.io.FilenameUtils;
import org.apache.jackrabbit.filevault.maven.packaging.ArtifactCoordinates;
import org.apache.jackrabbit.filevault.maven.packaging.Embedded;
@@ -55,6 +62,10 @@ import org.apache.jackrabbit.filevault.maven.packaging.Filters;
import org.apache.jackrabbit.filevault.maven.packaging.MavenBasedPackageDependency;
import org.apache.jackrabbit.filevault.maven.packaging.SubPackage;
import org.apache.jackrabbit.filevault.maven.packaging.SubPackageHandlingEntry;
+import org.apache.jackrabbit.spi.Name;
+import org.apache.jackrabbit.spi.commons.name.NameConstants;
+import org.apache.jackrabbit.spi.commons.name.NameFactoryImpl;
+import org.apache.jackrabbit.spi.commons.namespace.NamespaceMapping;
import org.apache.jackrabbit.util.Text;
import org.apache.jackrabbit.vault.fs.api.PathFilterSet;
import org.apache.jackrabbit.vault.fs.api.WorkspaceFilter;
@@ -62,18 +73,24 @@ import org.apache.jackrabbit.vault.fs.config.ConfigurationException;
import org.apache.jackrabbit.vault.fs.config.DefaultWorkspaceFilter;
import org.apache.jackrabbit.vault.fs.filter.DefaultPathFilter;
import org.apache.jackrabbit.vault.fs.io.AccessControlHandling;
+import org.apache.jackrabbit.vault.fs.io.DocViewFormat;
import org.apache.jackrabbit.vault.packaging.Dependency;
+import org.apache.jackrabbit.vault.packaging.JcrPackage;
import org.apache.jackrabbit.vault.packaging.PackageId;
import org.apache.jackrabbit.vault.packaging.PackageProperties;
import org.apache.jackrabbit.vault.packaging.PackageType;
import org.apache.jackrabbit.vault.packaging.SubPackageHandling;
import org.apache.jackrabbit.vault.util.Constants;
+import org.apache.jackrabbit.vault.util.DocViewNode2;
+import org.apache.jackrabbit.vault.util.DocViewProperty2;
+import org.apache.jackrabbit.vault.util.xml.serialize.FormattingXmlStreamWriter;
import org.apache.maven.archiver.ManifestConfiguration;
import org.apache.maven.archiver.MavenArchiveConfiguration;
import org.apache.maven.archiver.MavenArchiver;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.DependencyResolutionRequiredException;
import org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout;
+import org.apache.maven.artifact.resolver.filter.ScopeArtifactFilter;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
@@ -196,7 +213,7 @@ public class GenerateMetadataMojo extends AbstractMetadataPackageMojo {
private boolean failOnEmptyFilter;
/**
- * Specifies additional properties to be set in the properties.xml file.
+ * Specifies additional <a href="https://jackrabbit.apache.org/filevault/properties.html">package properties</a> to be set in the properties.xml file.
* These properties cannot overwrite the following predefined properties:
* <p>
* <table>
@@ -219,6 +236,14 @@ public class GenerateMetadataMojo extends AbstractMetadataPackageMojo {
@Parameter
private final Properties properties = new Properties();
+ /**
+ * Specifies <a href="https://jackrabbit.apache.org/filevault/packagedefinition.html">JCR package definition properties</a> to be serialized into the {@code META-INF/vault/definition/.content.xml} file.
+ * Those are implementation-specific and not standardized by FileVault. Only non-namespaced string properties are allowed here.
+ * Properties canonically stored somewhere else (like package properties or filter rules) should not be set.
+ */
+ @Parameter
+ private final Map<String,String> packageDefinitionProperties = new HashMap<>();
+
/**
* Defines the list of dependencies
* A dependency is declared as a {@code <dependency>} element of a list
@@ -558,38 +583,67 @@ public class GenerateMetadataMojo extends AbstractMetadataPackageMojo {
writeFilters(sourceFilters);
copyFile("/vault/config.xml", new File(vaultDir, Constants.CONFIG_XML));
copyFile("/vault/settings.xml", new File(vaultDir, Constants.SETTINGS_XML));
-
- // add package thumbnail
+ File packageDefinitionXml = new File(vaultDir, Constants.PACKAGE_DEFINITION_XML);
+ if (!packageDefinitionXml.getParentFile().exists()) {
+ packageDefinitionXml.getParentFile().mkdir();
+ }
+ try (OutputStream output = new FileOutputStream( packageDefinitionXml )) {
+ writePackageDefinition(output);
+ }
if (thumbnailImage != null && thumbnailImage.exists()) {
- File vaultDefinitionFolder = new File(vaultDir, "definition");
- if (!vaultDefinitionFolder.exists()) {
- vaultDefinitionFolder.mkdir();
- }
- copyFile("/vault/definition/.content.xml", new File(vaultDefinitionFolder, ".content.xml"));
- // copy thumbnail image only when it's not already placed in the source META-INF directory
- if (!thumbnailImage.equals(new File(metaInfDirectory, "/definition/thumbnail.png"))) {
- FileUtils.copyFile(thumbnailImage, new File(vaultDefinitionFolder, "thumbnail.png"));
- }
+ FileUtils.copyFile(thumbnailImage, new File(packageDefinitionXml.getParentFile(), "thumbnail.png"));
}
-
writeManifest(getGeneratedManifestFile(true), dependenciesString, dependenciesLocations, vaultProperties);
- } catch (IOException | ManifestException | DependencyResolutionRequiredException | ConfigurationException e) {
+ } catch (IOException | ManifestException | DependencyResolutionRequiredException | ConfigurationException | NamespaceException | XMLStreamException e) {
throw new MojoExecutionException(e.toString(), e);
}
buildContext.refresh(vaultDir);
}
+ void writePackageDefinition(OutputStream outputStream) throws XMLStreamException, FactoryConfigurationError, NamespaceException, IllegalArgumentException, IOException {
+ NamespaceMapping namespaceResolver = new NamespaceMapping(); // no namespaces necessary
+ namespaceResolver.setMapping(Name.NS_EMPTY_PREFIX, Name.NS_DEFAULT_URI);
+ namespaceResolver.setMapping(Name.NS_JCR_PREFIX, Name.NS_JCR_URI);
+ try (FormattingXmlStreamWriter xmlWriter = FormattingXmlStreamWriter.create(outputStream, new DocViewFormat().getXmlOutputFormat())) {
+ Collection<DocViewProperty2> packDefProps = new ArrayList<>();
+ packDefProps.add(new DocViewProperty2(NameConstants.JCR_PRIMARYTYPE, JcrPackage.NT_VLT_PACKAGE_DEFINITION));
+ packDefProps.add(new DocViewProperty2(NameFactoryImpl.getInstance().create(Name.NS_DEFAULT_URI, "builtWith"), getCreatedBy(), PropertyType.STRING));
+ for (Map.Entry<String, String> propertyEntry : packageDefinitionProperties.entrySet()) {
+ packDefProps.add(new DocViewProperty2(NameFactoryImpl.getInstance().create(Name.NS_DEFAULT_URI, propertyEntry.getKey()), propertyEntry.getValue(), PropertyType.STRING));
+ }
+ DocViewNode2 docViewNode = new DocViewNode2(NameConstants.JCR_ROOT, packDefProps);
+ docViewNode.writeStart(xmlWriter, namespaceResolver, Collections.singleton(Name.NS_JCR_PREFIX));
+ DocViewNode2.writeEnd(xmlWriter);
+ }
+ }
+
void writeManifest(File file, String dependenciesString, String dependenciesLocations, final Properties vaultProperties)
throws ManifestException, DependencyResolutionRequiredException, IOException, FileNotFoundException {
// generate manifest file
MavenArchiver mavenArchiver = new MavenArchiver();
- mavenArchiver.setCreatedBy("Apache Jackrabbit FileVault - Package Maven Plugin", "org.apache.jackrabbit", "filevault-package-maven-plugin");
+ // it is not possible to manually set the version
+ mavenArchiver.setCreatedBy(getMavenProjectProperties().getProperty("name"), "org.apache.jackrabbit", "filevault-package-maven-plugin");
Manifest manifest = mavenArchiver.getManifest(session, project, getMavenArchiveConfiguration(vaultProperties, dependenciesString, dependenciesLocations));
try (OutputStream out = new FileOutputStream(file)) {
manifest.write(out);
}
}
-
+
+ static Properties getMavenProjectProperties() throws IOException {
+ // name and version from pom.xml
+ final Properties properties = new Properties();
+ try (InputStream input = GenerateMetadataMojo.class.getResourceAsStream("/maven-project.properties")) {
+ properties.load(input);
+ }
+ return properties;
+ }
+
+ static String getCreatedBy() throws IOException {
+ // name and version from pom.xml
+ Properties properties = getMavenProjectProperties();
+ return properties.getProperty("name") + " " + properties.getProperty("version");
+ }
+
/**
* Computes the package filters.
*
diff --git a/src/main/resources-filtered/maven-project.properties b/src/main/resources-filtered/maven-project.properties
new file mode 100644
index 0000000..a0ae01d
--- /dev/null
+++ b/src/main/resources-filtered/maven-project.properties
@@ -0,0 +1,19 @@
+# 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.
+#
+name=${project.name}
+version=${project.version}
\ No newline at end of file