MODE-1706 Support for extra properties

modeshape-jcr/src/main/java/org/modeshape/connector/filesystem/InclusionExclusionFilenameFilter.java

@@ -0,0 +1,66 @@
+package org.modeshape.connector.filesystem;
+
+import java.io.File;
+import java.io.FilenameFilter;
+import java.util.regex.Pattern;
+
+/**
+ * A {@link FilenameFilter} implementation that supports an inclusion and exclusion pattern.
+ */
+class InclusionExclusionFilenameFilter implements java.io.FilenameFilter {
+    private String inclusionPattern = null;
+    private String exclusionPattern = null;
+    private Pattern inclusion;
+    private Pattern exclusion;
+    private Pattern extraPropertiesExclusion;
+
+    public void setExclusionPattern( String exclusionPattern ) {
+        this.exclusionPattern = exclusionPattern;
+        if (exclusionPattern == null) {
+            this.exclusion = null;
+        } else {
+            this.exclusion = Pattern.compile(exclusionPattern);
+        }
+    }
+
+    public void setExtraPropertiesExclusionPattern( String exclusionPattern ) {
+        if (exclusionPattern == null) {
+            this.extraPropertiesExclusion = null;
+        } else {
+            this.extraPropertiesExclusion = Pattern.compile(exclusionPattern);
+        }
+    }
+
+    public void setInclusionPattern( String inclusionPattern ) {
+        this.inclusionPattern = inclusionPattern;
+        if (inclusionPattern == null) {
+            this.inclusion = null;
+        } else {
+            this.inclusion = Pattern.compile(inclusionPattern);
+        }
+    }
+
+    public String getExclusionPattern() {
+        return exclusionPattern;
+    }
+
+    public String getInclusionPattern() {
+        return inclusionPattern;
+    }
+
+    @Override
+    public boolean accept( File file,
+                           String string ) {
+        if (inclusionPattern == null) {
+            // Include unless it matches an exclusion ...
+            if (exclusionPattern != null && exclusion.matcher(string).matches()) return false;
+            if (extraPropertiesExclusion != null && extraPropertiesExclusion.matcher(string).matches()) return false;
+            return true;
+        }
+        // Include ONLY if it matches the inclusion AND not matched by the exclusions ...
+        if (!inclusion.matcher(string).matches()) return false;
+        if (exclusionPattern != null && exclusion.matcher(string).matches()) return false;
+        if (extraPropertiesExclusion != null && extraPropertiesExclusion.matcher(string).matches()) return false;
+        return true;
+    }
+}

modeshape-jcr/src/main/java/org/modeshape/connector/filesystem/JsonSidecarExtraPropertyStore.java

@@ -0,0 +1,162 @@
+/*
+ * ModeShape (http://www.modeshape.org)
+ * See the COPYRIGHT.txt file distributed with this work for information
+ * regarding copyright ownership.  Some portions may be licensed
+ * to Red Hat, Inc. under one or more contributor license agreements.
+ * See the AUTHORS.txt file in the distribution for a full listing of 
+ * individual contributors.
+ *
+ * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
+ * is licensed to you under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ * 
+ * ModeShape is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package org.modeshape.connector.filesystem;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.util.HashMap;
+import java.util.Map;
+import org.infinispan.schematic.Schematic;
+import org.infinispan.schematic.document.Document;
+import org.infinispan.schematic.document.EditableDocument;
+import org.infinispan.schematic.document.Json;
+import org.modeshape.jcr.cache.DocumentStoreException;
+import org.modeshape.jcr.cache.document.DocumentTranslator;
+import org.modeshape.jcr.federation.spi.ExtraPropertiesStore;
+import org.modeshape.jcr.value.Name;
+import org.modeshape.jcr.value.Property;
+
+/**
+ * An {@link ExtraPropertiesStore} implementation that stores extra properties in JSON sidecar files adjacent to the actual file
+ * or directory corresponding to the external node.
+ */
+class JsonSidecarExtraPropertyStore implements ExtraPropertiesStore {
+
+    public static final String DEFAULT_EXTENSION = ".modeshape.json";
+    public static final String DEFAULT_RESOURCE_EXTENSION = ".content.modeshape.json";
+
+    private final FileSystemConnector connector;
+    private final DocumentTranslator translator;
+
+    protected JsonSidecarExtraPropertyStore( FileSystemConnector connector,
+                                                     DocumentTranslator translator ) {
+        this.connector = connector;
+        this.translator = translator;
+    }
+
+    protected String getExclusionPattern() {
+        return "(.+)\\.(content\\.)?modeshape\\.json$";
+
+    }
+
+    @Override
+    public Map<Name, Property> getProperties( String id ) {
+        File sidecarFile = sidecarFile(id);
+        if (!sidecarFile.exists()) return NO_PROPERTIES;
+        try {
+            Document document = read(new FileInputStream(sidecarFile));
+            Map<Name, Property> results = new HashMap<Name, Property>();
+            translator.getProperties(document, results);
+            return results;
+        } catch (IOException e) {
+            throw new DocumentStoreException(id, e);
+        }
+    }
+
+    @Override
+    public void updateProperties( String id,
+                                  Map<Name, Property> properties ) {
+        File sidecarFile = sidecarFile(id);
+        try {
+            EditableDocument document = null;
+            if (!sidecarFile.exists()) {
+                if (properties.isEmpty()) return;
+                sidecarFile.createNewFile();
+                document = Schematic.newDocument();
+            } else {
+                Document existing = read(new FileInputStream(sidecarFile));
+                document = Schematic.newDocument(existing);
+            }
+            for (Map.Entry<Name, Property> entry : properties.entrySet()) {
+                Property property = entry.getValue();
+                if (property == null) {
+                    translator.removeProperty(document, entry.getKey(), null);
+                } else {
+                    translator.setProperty(document, property, null);
+                }
+            }
+            write(document, new FileOutputStream(sidecarFile));
+        } catch (IOException e) {
+            throw new DocumentStoreException(id, e);
+        }
+    }
+
+    @Override
+    public void storeProperties( String id,
+                                 Map<Name, Property> properties ) {
+        File sidecarFile = sidecarFile(id);
+        try {
+            if (!sidecarFile.exists()) {
+                if (properties.isEmpty()) return;
+                sidecarFile.createNewFile();
+            }
+            EditableDocument document = Schematic.newDocument();
+            for (Property property : properties.values()) {
+                if (property == null) continue;
+                translator.setProperty(document, property, null);
+            }
+            write(document, new FileOutputStream(sidecarFile));
+        } catch (IOException e) {
+            throw new DocumentStoreException(id, e);
+        }
+    }
+
+    protected Document read( InputStream stream ) throws IOException {
+        return Json.read(stream);
+    }
+
+    protected void write( Document document,
+                          OutputStream stream ) throws IOException {
+        Json.write(document, stream);
+    }
+
+    protected String extension() {
+        return DEFAULT_EXTENSION;
+    }
+
+    protected String resourceExtension() {
+        return DEFAULT_EXTENSION;
+    }
+
+    @Override
+    public boolean removeProperties( String id ) {
+        File file = sidecarFile(id);
+        if (!file.exists()) return false;
+        file.delete();
+        return true;
+    }
+
+    protected File sidecarFile( String id ) {
+        File actualFile = connector.fileFor(id);
+        String extension = extension();
+        if (connector.isContentNode(id)) {
+            extension = resourceExtension();
+        }
+        return new File(actualFile.getAbsolutePath() + extension);
+    }
+}