This is an automated email from the ASF dual-hosted git repository. cziegeler pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-installer-factory-feature.git
commit 2d6c2e714b6e2c50a6d8730d23836b88d8624ad3 Author: Carsten Ziegeler <[email protected]> AuthorDate: Fri Feb 21 09:16:47 2020 +0100 Initial OSGi installer support for features --- .gitignore | 17 ++ CODE_OF_CONDUCT.md | 22 ++ CONTRIBUTING.md | 24 ++ Jenkinsfile | 20 ++ LICENSE | 202 ++++++++++++++ README.md | 9 + pom.xml | 120 +++++++++ .../model/impl/AbstractFeatureModelTask.java | 89 +++++++ .../model/impl/FeatureModelTaskFactory.java | 109 ++++++++ .../model/impl/FeatureModelTransformer.java | 126 +++++++++ .../model/impl/InstallFeatureModelTask.java | 290 +++++++++++++++++++++ .../model/impl/UninstallFeatureModelTask.java | 67 +++++ 12 files changed, 1095 insertions(+) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5b783ed --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +/target +.idea +.classpath +.metadata +.project +.settings +.externalToolBuilders +maven-eclipse.xml +*.swp +*.iml +*.ipr +*.iws +*.bak +.vlt +.DS_Store +jcr.log +atlassian-ide-plugin.xml diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0fa18e5 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,22 @@ +<!--/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ~ 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. + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/--> +Apache Software Foundation Code of Conduct +==== + +Being an Apache project, Apache Sling adheres to the Apache Software Foundation's [Code of Conduct](https://www.apache.org/foundation/policies/conduct.html). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ac82a1a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +<!--/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ~ 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. + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/--> +Contributing +==== + +Thanks for choosing to contribute! + +You will find all the necessary details about how you can do this at https://sling.apache.org/contributing.html. diff --git a/Jenkinsfile b/Jenkinsfile new file mode 100644 index 0000000..f582519 --- /dev/null +++ b/Jenkinsfile @@ -0,0 +1,20 @@ +/** + * 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. + */ + +slingOsgiBundleBuild() diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5a63122 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +[<img src="https://sling.apache.org/res/logos/sling.png"/>](https://sling.apache.org) + + [](https://builds.apache.org/job/Sling/job/sling-org-apache-sling-installer-factory-model/job/master) [](https://www.apache.org/licenses/LICENSE-2.0) [](https://github.com/apache/sling-aggregator/blob/master/docs/groups/installer.md) + +# Apache Sling Installer Provisioning Model Support + +This module is part of the [Apache Sling](https://sling.apache.org) project. + +Provides support for the provisioning model to the Apache Sling OSGi installer diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..815d242 --- /dev/null +++ b/pom.xml @@ -0,0 +1,120 @@ +<?xml version="1.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. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.sling</groupId> + <artifactId>sling-bundle-parent</artifactId> + <version>38</version> + <relativePath/> + </parent> + + <artifactId>org.apache.sling.installer.factory.feature</artifactId> + <version>0.1.0-SNAPSHOT</version> + + <name>Apache Sling Installer Feature Model Support</name> + <description> + Provides support for the feature model to the Apache Sling OSGi installer + </description> + + <scm> + <connection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-installer-factory-feature.git</connection> + <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-installer-factory-feature.git</developerConnection> + <url>https://gitbox.apache.org/repos/asf?p=sling-org-apache-sling-installer-factory-feature.git</url> + </scm> + + <build> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <configuration> + <excludePackageNames> + org.apache.sling.installer.factory.model.impl + </excludePackageNames> + </configuration> + </plugin> + </plugins> + </build> + + <dependencies> + <dependency> + <groupId>org.osgi</groupId> + <artifactId>org.osgi.annotation.versioning</artifactId> + </dependency> + <dependency> + <groupId>org.osgi</groupId> + <artifactId>org.osgi.service.component.annotations</artifactId> + </dependency> + <dependency> + <groupId>org.osgi</groupId> + <artifactId>org.osgi.service.metatype.annotations</artifactId> + </dependency> + <dependency> + <groupId>org.osgi</groupId> + <artifactId>osgi.core</artifactId> + </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-api</artifactId> + </dependency> + <dependency> + <groupId>javax.jcr</groupId> + <artifactId>jcr</artifactId> + </dependency> + <dependency> + <groupId>org.apache.sling</groupId> + <artifactId>org.apache.sling.installer.core</artifactId> + <version>3.8.0</version> + <scope>provided</scope> + </dependency> + <dependency> + <groupId>org.apache.sling</groupId> + <artifactId>org.apache.sling.jcr.api</artifactId> + <version>2.4.0</version> + <scope>provided</scope> + </dependency> + <dependency> + <groupId>org.apache.sling</groupId> + <artifactId>org.apache.sling.jcr.repoinit</artifactId> + <version>1.1.0</version> + <scope>provided</scope> + </dependency> + <dependency> + <groupId>org.apache.sling</groupId> + <artifactId>org.apache.sling.repoinit.parser</artifactId> + <version>1.1.0</version> + <scope>provided</scope> + </dependency> + <dependency> + <groupId>org.apache.sling</groupId> + <artifactId>org.apache.sling.feature</artifactId> + <version>1.1.2</version> + <scope>provided</scope> + </dependency> + <dependency> + <groupId>org.apache.sling</groupId> + <artifactId>org.apache.sling.feature.io</artifactId> + <version>1.3.0-SNAPSHOT</version> + <scope>provided</scope> + </dependency> + </dependencies> + +</project> diff --git a/src/main/java/org/apache/sling/installer/factory/model/impl/AbstractFeatureModelTask.java b/src/main/java/org/apache/sling/installer/factory/model/impl/AbstractFeatureModelTask.java new file mode 100644 index 0000000..2f6f459 --- /dev/null +++ b/src/main/java/org/apache/sling/installer/factory/model/impl/AbstractFeatureModelTask.java @@ -0,0 +1,89 @@ +/* + * 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.sling.installer.factory.model.impl; + +import java.io.File; +import java.util.HashMap; +import java.util.Map; + +import org.apache.sling.installer.api.tasks.InstallTask; +import org.apache.sling.installer.api.tasks.TaskResourceGroup; +import org.osgi.framework.BundleContext; +import org.osgi.framework.ServiceReference; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Abstract class for the tasks. + */ +public abstract class AbstractFeatureModelTask extends InstallTask { + + /** Logger. */ + protected final Logger logger = LoggerFactory.getLogger(this.getClass()); + + private final BundleContext bundleContext; + + private final Map<ServiceReference<?>, Object> services = new HashMap<>(); + + public AbstractFeatureModelTask(final TaskResourceGroup group, + final BundleContext bundleContext) { + super(group); + this.bundleContext = bundleContext; + } + + protected void cleanup() { + for(final ServiceReference<?> r : this.services.keySet()) { + this.bundleContext.ungetService(r); + } + this.services.clear(); + } + + @SuppressWarnings("unchecked") + protected <T> T getService(final Class<T> type) { + T service = null; + final ServiceReference<T> reference = this.bundleContext.getServiceReference(type); + if ( reference != null ) { + service = (T)this.services.get(reference); + if ( service == null ) { + service = this.bundleContext.getService(reference); + if ( service != null ) { + this.services.put(reference, service); + } else { + } + } + } + if ( service == null ) { + logger.error("Unable to get OSGi service " + type.getName()); + } + return service; + } + + protected void deleteDirectory(final File dir) { + if ( dir.exists() ) { + for(final File f : dir.listFiles()) { + if ( f.isDirectory() ) { + deleteDirectory(f); + } else { + f.delete(); + } + } + dir.delete(); + } + } +} diff --git a/src/main/java/org/apache/sling/installer/factory/model/impl/FeatureModelTaskFactory.java b/src/main/java/org/apache/sling/installer/factory/model/impl/FeatureModelTaskFactory.java new file mode 100644 index 0000000..60c1e76 --- /dev/null +++ b/src/main/java/org/apache/sling/installer/factory/model/impl/FeatureModelTaskFactory.java @@ -0,0 +1,109 @@ +/* + * 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.sling.installer.factory.model.impl; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import org.apache.sling.feature.io.artifacts.ArtifactManager; +import org.apache.sling.feature.io.artifacts.ArtifactManagerConfig; +import org.apache.sling.installer.api.tasks.InstallTask; +import org.apache.sling.installer.api.tasks.InstallTaskFactory; +import org.apache.sling.installer.api.tasks.ResourceState; +import org.apache.sling.installer.api.tasks.TaskResource; +import org.apache.sling.installer.api.tasks.TaskResourceGroup; +import org.apache.sling.jcr.api.SlingRepository; +import org.apache.sling.jcr.repoinit.JcrRepoInitOpsProcessor; +import org.apache.sling.repoinit.parser.RepoInitParser; +import org.osgi.framework.BundleContext; +import org.osgi.service.component.annotations.Activate; +import org.osgi.service.component.annotations.Component; +import org.osgi.service.component.annotations.Reference; +import org.osgi.service.metatype.annotations.AttributeDefinition; +import org.osgi.service.metatype.annotations.Designate; +import org.osgi.service.metatype.annotations.ObjectClassDefinition; + +/** + * This task factory processes model resources detected by + * the {@link FeatureModelTransformer}. + */ +@Component(service = InstallTaskFactory.class) +@Designate(ocd = FeatureModelTaskFactory.Config.class) +public class FeatureModelTaskFactory implements InstallTaskFactory { + + @ObjectClassDefinition(name = "Apache Sling Feature Model Installer", + description = "This component provides support for feature models to the OSGi installer") + public @interface Config { + + @AttributeDefinition(name = "Use Apache Maven", + description = "If enabled, missing artifacts from a feature are tried by invoking the mvn command") + boolean useMvn() default true; + + @AttributeDefinition(name = "Repository URLs", description = "Additional repository URLs to fetch artifacts") + String[] repositories(); + } + + @Reference + private SlingRepository repository; + + @Reference + private JcrRepoInitOpsProcessor repoInitProcessor; + + @Reference + private RepoInitParser repoInitParser; + + private final BundleContext bundleContext; + + private final ArtifactManager artifactManager; + + @Activate + public FeatureModelTaskFactory(final BundleContext ctx, final Config config) throws IOException { + this.bundleContext = ctx; + final ArtifactManagerConfig amCfg = new ArtifactManagerConfig(); + amCfg.setUseMvn(config.useMvn()); + if (config.repositories() != null && config.repositories().length > 0) { + final List<String> repos = new ArrayList<>(Arrays.asList(amCfg.getRepositoryUrls())); + for (final String r : config.repositories()) { + if (!r.trim().isEmpty()) { + repos.add(r); + } + } + amCfg.setRepositoryUrls(repos.toArray(new String[repos.size()])); + } + this.artifactManager = ArtifactManager.getArtifactManager(amCfg); + } + + @Override + public InstallTask createTask(final TaskResourceGroup group) { + final TaskResource rsrc = group.getActiveResource(); + if (!FeatureModelTransformer.TYPE_FEATURE_MODEL.equals(rsrc.getType())) { + return null; + } + if (rsrc.getState() == ResourceState.UNINSTALL ) { + return new UninstallFeatureModelTask(group, bundleContext); + } + return new InstallFeatureModelTask(group, + this.repository, + this.repoInitProcessor, + this.repoInitParser, + this.bundleContext, this.artifactManager); + } +} diff --git a/src/main/java/org/apache/sling/installer/factory/model/impl/FeatureModelTransformer.java b/src/main/java/org/apache/sling/installer/factory/model/impl/FeatureModelTransformer.java new file mode 100644 index 0000000..57b6b99 --- /dev/null +++ b/src/main/java/org/apache/sling/installer/factory/model/impl/FeatureModelTransformer.java @@ -0,0 +1,126 @@ +package org.apache.sling.installer.factory.model.impl;/* + * 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. + */ + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.Reader; +import java.io.StringWriter; +import java.util.HashMap; +import java.util.Map; + +import org.apache.sling.feature.ArtifactId; +import org.apache.sling.feature.Feature; +import org.apache.sling.feature.io.archive.ArchiveReader; +import org.apache.sling.feature.io.json.FeatureJSONReader; +import org.apache.sling.feature.io.json.FeatureJSONWriter; +import org.apache.sling.installer.api.InstallableResource; +import org.apache.sling.installer.api.tasks.RegisteredResource; +import org.apache.sling.installer.api.tasks.ResourceTransformer; +import org.apache.sling.installer.api.tasks.TransformationResult; +import org.osgi.framework.BundleContext; +import org.osgi.service.component.annotations.Activate; +import org.osgi.service.component.annotations.Component; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * This transformer detects a file with the ending ".feature" containing a + * feature model or a feature model archive ending in ".far" + */ +@Component(service = ResourceTransformer.class) +public class FeatureModelTransformer implements ResourceTransformer { + + public static final String FILE_EXTENSION = ".json"; + + public static final String TYPE_FEATURE_MODEL = "featuremodel"; + + public static final String ATTR_MODEL = "feature"; + + public static final String ATTR_BASE_PATH = "path"; + + public static final String ATTR_ID = "featureId"; + + /** Logger. */ + private final Logger logger = LoggerFactory.getLogger(this.getClass()); + + private final BundleContext bundleContext; + + @Activate + public FeatureModelTransformer(final BundleContext bc) { + this.bundleContext = bc; + } + + @Override + public TransformationResult[] transform(final RegisteredResource resource) { + Feature feature = null; + File baseDir = null; + if (resource.getType().equals(InstallableResource.TYPE_FILE) && resource.getURL().endsWith(FILE_EXTENSION)) { + try ( final Reader reader = new InputStreamReader(resource.getInputStream(), "UTF-8") ) { + feature = FeatureJSONReader.read(reader, resource.getURL()); + } catch ( final IOException ioe) { + logger.info("Unable to read feature model from " + resource.getURL(), ioe); + } + } + if (resource.getType().equals(InstallableResource.TYPE_FILE) + && resource.getURL().endsWith(".zip")) { + baseDir = this.bundleContext.getDataFile(""); + try ( final InputStream is = resource.getInputStream() ) { + + feature = ArchiveReader.read(is, new ArchiveReader.ArtifactConsumer() { + @Override + public void consume(final ArtifactId artifact, final InputStream is) throws IOException { + // nothing to do, install task does extraction + } + }); + } catch ( final IOException ioe) { + logger.info("Unable to read feature model from " + resource.getURL(), ioe); + } + } + if (feature != null) { + String featureJson = null; + try (final StringWriter sw = new StringWriter()) { + FeatureJSONWriter.write(sw, feature); + featureJson = sw.toString(); + } catch (final IOException ioe) { + logger.info("Unable to read feature model from " + resource.getURL(), ioe); + } + + if (featureJson != null) { + final TransformationResult tr = new TransformationResult(); + tr.setResourceType(TYPE_FEATURE_MODEL); + tr.setId(feature.getId().toMvnId()); + tr.setVersion(feature.getId().getOSGiVersion()); + + final Map<String, Object> attributes = new HashMap<>(); + attributes.put(ATTR_MODEL, featureJson); + attributes.put(ATTR_ID, feature.getId().toMvnId()); + if (baseDir != null) { + final File dir = new File(baseDir, feature.getId().toMvnName()); + attributes.put(ATTR_BASE_PATH, dir.getAbsolutePath()); + } + tr.setAttributes(attributes); + + return new TransformationResult[] { tr }; + } + } + return null; + } +} diff --git a/src/main/java/org/apache/sling/installer/factory/model/impl/InstallFeatureModelTask.java b/src/main/java/org/apache/sling/installer/factory/model/impl/InstallFeatureModelTask.java new file mode 100644 index 0000000..55f3f5c --- /dev/null +++ b/src/main/java/org/apache/sling/installer/factory/model/impl/InstallFeatureModelTask.java @@ -0,0 +1,290 @@ +/* + * 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.sling.installer.factory.model.impl; + +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.io.Reader; +import java.io.StringReader; +import java.net.MalformedURLException; +import java.net.URLConnection; +import java.util.ArrayList; +import java.util.Dictionary; +import java.util.Hashtable; +import java.util.List; + +import javax.jcr.RepositoryException; +import javax.jcr.Session; + +import org.apache.sling.feature.Artifact; +import org.apache.sling.feature.ArtifactId; +import org.apache.sling.feature.Configuration; +import org.apache.sling.feature.Extension; +import org.apache.sling.feature.ExtensionType; +import org.apache.sling.feature.Feature; +import org.apache.sling.feature.io.archive.ArchiveReader; +import org.apache.sling.feature.io.artifacts.ArtifactHandler; +import org.apache.sling.feature.io.artifacts.ArtifactManager; +import org.apache.sling.feature.io.json.FeatureJSONReader; +import org.apache.sling.installer.api.InstallableResource; +import org.apache.sling.installer.api.OsgiInstaller; +import org.apache.sling.installer.api.tasks.InstallationContext; +import org.apache.sling.installer.api.tasks.ResourceState; +import org.apache.sling.installer.api.tasks.TaskResource; +import org.apache.sling.installer.api.tasks.TaskResourceGroup; +import org.apache.sling.jcr.api.SlingRepository; +import org.apache.sling.jcr.repoinit.JcrRepoInitOpsProcessor; +import org.apache.sling.repoinit.parser.RepoInitParser; +import org.apache.sling.repoinit.parser.RepoInitParsingException; +import org.apache.sling.repoinit.parser.operations.Operation; +import org.osgi.framework.BundleContext; + +/** + * This task installs a feature model resources. + */ +public class InstallFeatureModelTask extends AbstractFeatureModelTask { + + private final SlingRepository repository; + + private final JcrRepoInitOpsProcessor repoInitProcessor; + + private final RepoInitParser repoInitParser; + + private final ArtifactManager artifactManager; + + public InstallFeatureModelTask(final TaskResourceGroup group, + final SlingRepository repository, + final JcrRepoInitOpsProcessor repoInitProcessor, + final RepoInitParser repoInitParser, + final BundleContext bundleContext, final ArtifactManager artifactManager) { + super(group, bundleContext); + this.repository = repository; + this.repoInitProcessor = repoInitProcessor; + this.repoInitParser = repoInitParser; + this.artifactManager = artifactManager; + } + + @SuppressWarnings("deprecation") + @Override + public void execute(final InstallationContext ctx) { + try { + final TaskResource resource = this.getResource(); + ctx.log("Installing {}", resource.getEntityId()); + final String featureJson = (String) resource.getAttribute(FeatureModelTransformer.ATTR_MODEL); + if (featureJson == null) { + ctx.log("Unable to install feature model resource {} : no model found", resource); + this.getResourceGroup().setFinishState(ResourceState.IGNORED); + } else { + final String path = (String) resource.getAttribute(FeatureModelTransformer.ATTR_BASE_PATH); + final File baseDir = (path == null ? null : new File(path)); + + boolean success = false; + try { + final Result result = this.transform(featureJson, resource, baseDir); + if ( result == null ) { + ctx.log("Unable to install feature model resource {} : unable to create resources", resource); + this.getResourceGroup().setFinishState(ResourceState.IGNORED); + } else { + // repo init first + if ( result.repoinit != null ) { + List<Operation> ops = null; + try ( final Reader r = new StringReader(result.repoinit) ) { + ops = this.repoInitParser.parse(r); + } catch (final IOException | RepoInitParsingException e) { + logger.error("Unable to parse repoinit text.", e); + ctx.log("Unable to install feature model resource {} : unable parse repoinit text.", + resource); + this.getResourceGroup().setFinishState(ResourceState.IGNORED); + return; + } + + // login admin is required for repo init + Session session = null; + try { + session = this.repository.loginAdministrative(null); + this.repoInitProcessor.apply(session, ops); + session.save(); + } catch ( final RepositoryException re) { + logger.error("Unable to process repoinit text.", re); + ctx.log("Unable to install feature model resource {} : unable to process repoinit text.", + resource); + this.getResourceGroup().setFinishState(ResourceState.IGNORED); + return; + + } finally { + if ( session != null ) { + session.logout(); + } + } + } + if ( !result.resources.isEmpty() ) { + final OsgiInstaller installer = this.getService(OsgiInstaller.class); + if ( installer != null ) { + installer.registerResources( + "model-" + resource.getAttribute(FeatureModelTransformer.ATTR_ID), + result.resources.toArray(new InstallableResource[result.resources.size()])); + } else { + ctx.log("Unable to install feature model resource {} : unable to get OSGi installer", + resource); + this.getResourceGroup().setFinishState(ResourceState.IGNORED); + return; + } + } + this.getResourceGroup().setFinishState(ResourceState.INSTALLED); + success = true; + } + } finally { + if ( !success && baseDir != null ) { + this.deleteDirectory(baseDir); + } + } + if ( success ) { + ctx.log("Installed {}", resource.getEntityId()); + } + } + } finally { + this.cleanup(); + } + } + + public static final class Result { + public final List<InstallableResource> resources = new ArrayList<>(); + public String repoinit; + } + + private File getArtifactFile(final File baseDir, final ArtifactId id) { + return new File(baseDir, id.toMvnId().replace('/', File.separatorChar)); + } + + private Result transform(final String featureJson, + final TaskResource rsrc, + final File baseDir) { + Feature feature = null; + try (final Reader reader = new StringReader(featureJson)) { + feature = FeatureJSONReader.read(reader, null); + } catch ( final IOException ioe) { + logger.warn("Unable to read feature model file", ioe); + } + if (feature == null) { + return null; + } + + if ( baseDir != null ) { + // extract artifacts + final byte[] buffer = new byte[1024*1024*256]; + + try ( final InputStream is = rsrc.getInputStream() ) { + ArchiveReader.read(is, new ArchiveReader.ArtifactConsumer() { + + @Override + public void consume(final ArtifactId id, final InputStream is) throws IOException { + final File artifactFile = getArtifactFile(baseDir, id); + if (!artifactFile.exists()) { + artifactFile.getParentFile().mkdirs(); + try (final OutputStream os = new FileOutputStream(artifactFile)) { + int l = 0; + while ((l = is.read(buffer)) > 0) { + os.write(buffer, 0, l); + } + } + } + } + }); + } catch ( final IOException ioe) { + logger.warn("Unable to extract artifacts from feature model " + feature.getId().toMvnId(), ioe); + return null; + } + } + + + final Result result = new Result(); + for (final Artifact bundle : feature.getBundles()) { + if (!addArtifact(baseDir, bundle, result)) { + return null; + } + } + final Extension ext = feature.getExtensions().getByName(Extension.EXTENSION_NAME_CONTENT_PACKAGES); + if (ext != null && ext.getType() == ExtensionType.ARTIFACTS) { + for (final Artifact artifact : ext.getArtifacts()) { + addArtifact(baseDir, artifact, result); + } + } + + for (final Configuration cfg : feature.getConfigurations()) { + result.resources.add(new InstallableResource("/".concat(cfg.getPid()).concat(".config"), null, + cfg.getConfigurationProperties(), null, InstallableResource.TYPE_CONFIG, null)); + } + + final Extension repoInit = feature.getExtensions().getByName(Extension.EXTENSION_NAME_REPOINIT); + if (repoInit != null && repoInit.getType() == ExtensionType.TEXT) { + result.repoinit = repoInit.getText(); + } + return result; + } + + private boolean addArtifact(final File baseDir, final Artifact artifact, + final Result result) { + File artifactFile = (baseDir == null ? null : getArtifactFile(baseDir, artifact.getId())); + ArtifactHandler handler; + if (artifactFile == null || !artifactFile.exists()) { + try { + handler = this.artifactManager.getArtifactHandler(artifact.getId().toMvnUrl()); + } catch (final IOException ignore) { + return false; + } + } else { + try { + handler = new ArtifactHandler(artifactFile); + } catch (final MalformedURLException e) { + return false; + } + } + if (handler == null) { + return false; + } + try { + final URLConnection connection = handler.getLocalURL().openConnection(); + connection.connect(); + final InputStream is = connection.getInputStream(); + final long lastModified = connection.getLastModified(); + final String digest = lastModified == 0 ? null : String.valueOf(lastModified); + // handle start order + final Dictionary<String, Object> dict = new Hashtable<String, Object>(); + if (artifact.getStartOrder() > 0) { + dict.put(InstallableResource.BUNDLE_START_LEVEL, artifact.getStartOrder()); + } + dict.put(InstallableResource.RESOURCE_URI_HINT, handler.getLocalURL().toString()); + + result.resources.add(new InstallableResource("/".concat(artifact.getId().toMvnName()), is, dict, digest, + InstallableResource.TYPE_FILE, null)); + } catch (final IOException ioe) { + logger.warn("Unable to read artifact " + handler.getLocalURL(), ioe); + return false; + } + return true; + } + + @Override + public String getSortKey() { + return "30-" + getResource().getAttribute(FeatureModelTransformer.ATTR_ID); + } +} diff --git a/src/main/java/org/apache/sling/installer/factory/model/impl/UninstallFeatureModelTask.java b/src/main/java/org/apache/sling/installer/factory/model/impl/UninstallFeatureModelTask.java new file mode 100644 index 0000000..ed437de --- /dev/null +++ b/src/main/java/org/apache/sling/installer/factory/model/impl/UninstallFeatureModelTask.java @@ -0,0 +1,67 @@ +/* + * 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.sling.installer.factory.model.impl; + +import java.io.File; + +import org.apache.sling.installer.api.OsgiInstaller; +import org.apache.sling.installer.api.tasks.InstallationContext; +import org.apache.sling.installer.api.tasks.ResourceState; +import org.apache.sling.installer.api.tasks.TaskResource; +import org.apache.sling.installer.api.tasks.TaskResourceGroup; +import org.osgi.framework.BundleContext; + +/** + * This task uninstalls feature model resources. + */ +public class UninstallFeatureModelTask extends AbstractFeatureModelTask { + + public UninstallFeatureModelTask(final TaskResourceGroup group, + final BundleContext bundleContext) { + super(group, bundleContext); + } + + @Override + public void execute(final InstallationContext ctx) { + try { + final OsgiInstaller installer = this.getService(OsgiInstaller.class); + if ( installer == null ) { + ctx.log("Unable to get OSGi Installer service!"); + } else { + final TaskResource resource = this.getResource(); + ctx.log("Uninstalling {}", resource.getEntityId()); + installer.registerResources("model-" + resource.getAttribute(FeatureModelTransformer.ATTR_ID), null); + final String path = (String)resource.getAttribute(FeatureModelTransformer.ATTR_BASE_PATH); + if ( path != null ) { + final File dir = new File(path); + deleteDirectory(dir); + } + this.getResourceGroup().setFinishState(ResourceState.UNINSTALLED); + ctx.log("Uninstalled {}", resource.getEntityId()); + } + } finally { + this.cleanup(); + } + } + + @Override + public String getSortKey() { + return "31-" + getResource().getAttribute(FeatureModelTransformer.ATTR_ID); + } +}
![https://sling.apache.org/res/logos/sling.png"/](https://sling.apache.org/res/logos/sling.png"/){kind=link}
