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-whiteboard.git
The following commit(s) were added to refs/heads/master by this push:
new 097012c Very simple file system provider
097012c is described below
commit 097012ca7db585044aaafe09875b2f5f292ec8b7
Author: Carsten Ziegeler <[email protected]>
AuthorDate: Fri Nov 23 16:15:10 2018 +0100
Very simple file system provider
---
sfsresourceprovider/LICENSE | 201 +++++++++++++++++++++
sfsresourceprovider/bnd.bnd | 1 +
sfsresourceprovider/pom.xml | 92 ++++++++++
.../sling/sfsresource/impl/FileResource.java | 142 +++++++++++++++
.../sfsresource/impl/SFSResourceProvider.java | 138 ++++++++++++++
5 files changed, 574 insertions(+)
diff --git a/sfsresourceprovider/LICENSE b/sfsresourceprovider/LICENSE
new file mode 100644
index 0000000..261eeb9
--- /dev/null
+++ b/sfsresourceprovider/LICENSE
@@ -0,0 +1,201 @@
+ 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/sfsresourceprovider/bnd.bnd b/sfsresourceprovider/bnd.bnd
new file mode 100644
index 0000000..1bb8bf6
--- /dev/null
+++ b/sfsresourceprovider/bnd.bnd
@@ -0,0 +1 @@
+# empty
diff --git a/sfsresourceprovider/pom.xml b/sfsresourceprovider/pom.xml
new file mode 100644
index 0000000..8516b0c
--- /dev/null
+++ b/sfsresourceprovider/pom.xml
@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!-- 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</artifactId>
+ <version>33</version>
+ </parent>
+
+ <artifactId>org.apache.sling.sfsresourceprovider</artifactId>
+ <version>0.0.1-SNAPSHOT</version>
+
+ <name>Apache Sling Simple File System Resource Provider</name>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>biz.aQute.bnd</groupId>
+ <artifactId>bnd-maven-plugin</artifactId>
+ <version>4.1.0</version>
+ <executions>
+ <execution>
+ <id>run-bnd</id>
+ <goals>
+ <goal>bnd-process</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.api</artifactId>
+ <version>2.18.4</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.service.component.annotations</artifactId>
+ <version>1.4.0</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.service.metatype.annotations</artifactId>
+ <version>1.4.0</version>
+ <scope>provided</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.testing.sling-mock</artifactId>
+ <version>2.2.6</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.testing.logging-mock</artifactId>
+ <version>2.0.0</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.testing.hamcrest</artifactId>
+ <version>1.0.2</version>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+ <properties>
+ <sling.java.version>8</sling.java.version>
+ </properties>
+</project>
diff --git
a/sfsresourceprovider/src/main/java/org/apache/sling/sfsresource/impl/FileResource.java
b/sfsresourceprovider/src/main/java/org/apache/sling/sfsresource/impl/FileResource.java
new file mode 100644
index 0000000..1151a5b
--- /dev/null
+++
b/sfsresourceprovider/src/main/java/org/apache/sling/sfsresource/impl/FileResource.java
@@ -0,0 +1,142 @@
+/*
+ * 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.sfsresource.impl;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.HashMap;
+import java.util.Map;
+
+import org.apache.sling.api.resource.AbstractResource;
+import org.apache.sling.api.resource.ResourceMetadata;
+import org.apache.sling.api.resource.ResourceResolver;
+import org.apache.sling.api.resource.ValueMap;
+import org.apache.sling.api.wrappers.ValueMapDecorator;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+
+public class FileResource extends AbstractResource {
+
+ private static final Logger LOGGER =
LoggerFactory.getLogger(FileResource.class);
+
+ /**
+ * The resource type for file system files mapped into the resource tree
by the
+ * {@link SFSResourceProvider} (value is "nt:file").
+ */
+ static final String RESOURCE_TYPE_FILE = "nt:file";
+
+ /**
+ * The resource type for file system folders mapped into the resource tree
by
+ * the {@link SFSResourceProvider} (value is "nt:folder").
+ */
+ static final String RESOURCE_TYPE_FOLDER = "nt:folder";
+
+ private final ResourceResolver resolver;
+ private final String path;
+ private final File file;
+
+ private final ResourceMetadata metadata;
+
+ public FileResource(final ResourceResolver resourceResolver, final String
path, final File file) {
+ this.resolver = resourceResolver;
+ this.path = path;
+ this.file = file;
+ this.metadata = new ResourceMetadata();
+ this.metadata.setModificationTime(file.lastModified());
+ this.metadata.setResolutionPath(path);
+ if (file.isFile()) {
+ this.metadata.setContentLength(file.length());
+ }
+ }
+
+ @Override
+ public String getPath() {
+ return path;
+ }
+
+ @Override
+ public String getResourceType() {
+ return this.file.isDirectory() ? RESOURCE_TYPE_FOLDER :
RESOURCE_TYPE_FILE;
+ }
+
+ @Override
+ public String getResourceSuperType() {
+ return null;
+ }
+
+ @Override
+ public ResourceMetadata getResourceMetadata() {
+ return metadata;
+ }
+
+ @Override
+ public ResourceResolver getResourceResolver() {
+ return resolver;
+ }
+
+ /**
+ * Returns an adapter for this resource. This implementation supports
+ * <code>File</code>, <code>InputStream</code> and <code>URL</code> plus
those
+ * supported by the adapter manager.
+ */
+ @Override
+ public <AdapterType> AdapterType adaptTo(final Class<AdapterType> type) {
+ if (type == File.class) {
+ return type.cast(this.file);
+ } else if (type == InputStream.class) {
+ if (file.isFile() && file.canRead()) {
+ try {
+ return type.cast(new FileInputStream(file));
+ } catch (final IOException ioe) {
+ LOGGER.info("adaptTo: Cannot open a stream on the file " +
file, ioe);
+ }
+ } else {
+ LOGGER.debug("adaptTo: File {} is not a readable file", file);
+ }
+ } else if (type == URL.class) {
+ try {
+ return type.cast(file.toURI().toURL());
+ } catch (MalformedURLException mue) {
+ LOGGER.info("adaptTo: Cannot convert the file path " + file +
" to an URL", mue);
+ }
+ } else if (type == ValueMap.class) {
+ return type.cast(getValueMap());
+ }
+
+ return super.adaptTo(type);
+ }
+
+ @Override
+ public ValueMap getValueMap() {
+ Map<String, Object> props = new HashMap<>();
+ props.put("sling:resourceType", getResourceType());
+
+ return new ValueMapDecorator(props);
+ }
+
+ @Override
+ public String toString() {
+ return getClass().getSimpleName() + ", path: " + path + ", file: " +
file;
+ }
+}
diff --git
a/sfsresourceprovider/src/main/java/org/apache/sling/sfsresource/impl/SFSResourceProvider.java
b/sfsresourceprovider/src/main/java/org/apache/sling/sfsresource/impl/SFSResourceProvider.java
new file mode 100644
index 0000000..c85ef3d
--- /dev/null
+++
b/sfsresourceprovider/src/main/java/org/apache/sling/sfsresource/impl/SFSResourceProvider.java
@@ -0,0 +1,138 @@
+/*
+ * 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.sfsresource.impl;
+
+import java.io.File;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Iterator;
+import java.util.List;
+
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.spi.resource.provider.ResolveContext;
+import org.apache.sling.spi.resource.provider.ResourceContext;
+import org.apache.sling.spi.resource.provider.ResourceProvider;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.ConfigurationPolicy;
+import org.osgi.service.metatype.annotations.AttributeDefinition;
+import org.osgi.service.metatype.annotations.Designate;
+import org.osgi.service.metatype.annotations.ObjectClassDefinition;
+
+/**
+ * A simple {@code ResourceProvider} for the file system.
+ */
+@Component(
+ service = ResourceProvider.class,
+ configurationPolicy = ConfigurationPolicy.REQUIRE
+)
+@Designate(ocd = SFSResourceProvider.Config.class, factory = true)
+public class SFSResourceProvider extends ResourceProvider<Object> {
+
+ @ObjectClassDefinition(name = "Apache Sling Simple File System Resource
Provider", description = "Configure an instance of the file system resource
provider in terms of provider root and file system location")
+ public @interface Config {
+
+ @AttributeDefinition(name = "File System Root", description = "File
system directory mapped to the virtual "
+ + "resource tree. This property must not be an empty string.
If the path is "
+ + "relative it is resolved against sling.home or the current
working directory. "
+ + "The path may be a file or folder. If the path does not
address an existing "
+ + "file or folder, an empty folder is created.")
+ String provider_file();
+
+ @AttributeDefinition(name = "Provider Root", description = "Location
in the virtual resource tree where the "
+ + "file system resources are mapped in. This property must not
be an empty string.")
+ String provider_root();
+
+ // Internal Name hint for web console.
+ String webconsole_configurationFactory_nameHint() default "{"
+ + ResourceProvider.PROPERTY_ROOT + "}";
+ }
+
+ private final String pathPrefix;
+
+ private final String home;
+
+ @Activate
+ public SFSResourceProvider(final Config config) {
+ if (config.provider_root().endsWith("/")) {
+ this.pathPrefix = config.provider_root();
+ } else {
+ this.pathPrefix = config.provider_root().concat("/");
+ }
+ this.home = config.provider_file();
+ }
+
+ @Override
+ public Resource getResource(final ResolveContext<Object> ctx,
+ final String path,
+ final ResourceContext resourceContext,
+ final Resource parent) {
+ final String rsrcPath = path.length() < this.pathPrefix.length() ? ""
+ : path.substring(this.pathPrefix.length());
+
+ // try one to one mapping
+ final Path filePath = Paths.get(this.home, rsrcPath.replace('/',
File.separatorChar));
+ final File file = filePath.toFile();
+ if (file.isDirectory() || file.canRead()) {
+ return new FileResource(ctx.getResourceResolver(), path, file);
+ }
+
+ final int lastSlash = rsrcPath.lastIndexOf('/');
+ final int lastDot = rsrcPath.lastIndexOf('.');
+
+ if ( lastDot > lastSlash ) {
+ // has extension, don't try anything else
+ return null;
+ }
+ return null;
+ }
+
+ @Override
+ public Iterator<Resource> listChildren(final ResolveContext<Object> ctx,
final Resource parent) {
+ if
(FileResource.RESOURCE_TYPE_FOLDER.equals(parent.getResourceType())) {
+ final File file = parent.adaptTo(File.class);
+ if (file != null && file.isDirectory()) {
+ final List<File> children = new ArrayList<>();
+ // TODO filter out some files
+ for (final File c : file.listFiles()) {
+ children.add(c);
+ }
+ Collections.sort(children);
+ final Iterator<File> i = children.iterator();
+ return new Iterator<Resource>() {
+
+ @Override
+ public boolean hasNext() {
+ return i.hasNext();
+ }
+
+ @Override
+ public Resource next() {
+ final File file = i.next();
+ return new FileResource(ctx.getResourceResolver(),
+
parent.getPath().concat("/").concat(file.getName()), file);
+ }
+ };
+ }
+ }
+ return null;
+ }
+}
