You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by al...@apache.org on 2013/04/23 14:16:29 UTC

svn commit: r1470912 - in /jackrabbit/oak/trunk: oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/nodetype/ oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/ oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/

Author: alexparvulescu
Date: Tue Apr 23 12:16:28 2013
New Revision: 1470912

URL: http://svn.apache.org/r1470912
Log:
OAK-673 Unified hook processing - versioning related refactoring

Added:
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionEditor.java   (with props)
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionEditorProvider.java   (with props)
Removed:
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionHook.java
Modified:
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/nodetype/TypeEditor.java
    jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/Jcr.java

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/nodetype/TypeEditor.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/nodetype/TypeEditor.java?rev=1470912&r1=1470911&r2=1470912&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/nodetype/TypeEditor.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/nodetype/TypeEditor.java Tue Apr 23 12:16:28 2013
@@ -71,7 +71,7 @@ class TypeEditor extends DefaultEditor {
     private final List<String> typeNames = newArrayList();
 
     private EffectiveType effective = null;
-    
+
     private final NodeBuilder node;
 
     // TODO: Calculate default type from the node definition
@@ -131,7 +131,7 @@ class TypeEditor extends DefaultEditor {
         // TODO: add any auto-created items that are still missing
 
         // verify the presence of all mandatory items
-        Set<String> missing = effective.findMissingMandatoryItems(after);
+        Set<String> missing = effective.findMissingMandatoryItems(node.getNodeState());
         if (!missing.isEmpty()) {
             throw constraintViolation(
                     2, "Missing mandatory items " + Joiner.on(", ").join(missing));

Added: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionEditor.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionEditor.java?rev=1470912&view=auto
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionEditor.java (added)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionEditor.java Tue Apr 23 12:16:28 2013
@@ -0,0 +1,212 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.jackrabbit.oak.plugins.version;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+import static org.apache.jackrabbit.oak.plugins.memory.EmptyNodeState.EMPTY_NODE;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import javax.jcr.RepositoryException;
+import javax.jcr.nodetype.ConstraintViolationException;
+import javax.jcr.version.VersionException;
+
+import org.apache.jackrabbit.JcrConstants;
+import org.apache.jackrabbit.oak.api.CommitFailedException;
+import org.apache.jackrabbit.oak.api.PropertyState;
+import org.apache.jackrabbit.oak.api.Tree;
+import org.apache.jackrabbit.oak.api.Type;
+import org.apache.jackrabbit.oak.core.ReadOnlyTree;
+import org.apache.jackrabbit.oak.spi.commit.Editor;
+import org.apache.jackrabbit.oak.spi.state.NodeBuilder;
+import org.apache.jackrabbit.oak.spi.state.NodeState;
+
+/**
+ * TODO document
+ */
+class VersionEditor implements Editor {
+
+    private final VersionEditor parent;
+    private final ReadWriteVersionManager vMgr;
+    private final NodeBuilder node;
+    private Boolean isVersionable = null;
+
+    public VersionEditor(@Nonnull NodeBuilder versionStore,
+            @Nonnull NodeBuilder workspaceRoot) {
+        this(null, new ReadWriteVersionManager(checkNotNull(versionStore),
+                checkNotNull(workspaceRoot)), workspaceRoot);
+    }
+
+    VersionEditor(@Nullable VersionEditor parent,
+            @Nonnull ReadWriteVersionManager vMgr, @Nonnull NodeBuilder node) {
+        this.parent = parent;
+        this.vMgr = checkNotNull(vMgr);
+        this.node = checkNotNull(node);
+    }
+
+    @Override
+    public void enter(NodeState before, NodeState after)
+            throws CommitFailedException {
+        if (isVersionable()) {
+            vMgr.getOrCreateVersionHistory(node);
+        }
+    }
+
+    @Override
+    public void leave(NodeState before, NodeState after)
+            throws CommitFailedException {
+
+    }
+
+    @Override
+    public void propertyAdded(PropertyState after) {
+        if (!isVersionable()) {
+            return;
+        }
+        // JCR allows to put a lock on a checked in node.
+        if (after.getName().equals(JcrConstants.JCR_LOCKOWNER)
+                || after.getName().equals(JcrConstants.JCR_LOCKISDEEP)) {
+            return;
+        }
+        if (wasCheckedIn()) {
+            throwCheckedIn("Cannot add property " + after.getName()
+                    + " on checked in node");
+        }
+    }
+
+    @Override
+    public void propertyChanged(PropertyState before, PropertyState after) {
+        if (!isVersionable()) {
+            if (!isVersionProperty(after) && wasCheckedIn()) {
+                throwCheckedIn("Cannot change property " + after.getName()
+                        + " on checked in node");
+            }
+            return;
+        }
+        String propName = after.getName();
+        if (propName.equals(VersionConstants.JCR_ISCHECKEDOUT)) {
+            if (wasCheckedIn()) {
+                vMgr.checkout(node);
+            } else {
+                vMgr.checkin(node);
+            }
+        } else if (propName.equals(VersionConstants.JCR_BASEVERSION)) {
+            vMgr.restore(node);
+        } else if (isVersionProperty(after)) {
+            throwProtected(after.getName());
+        } else if (wasCheckedIn()) {
+            throwCheckedIn("Cannot change property " + after.getName()
+                    + " on checked in node");
+        }
+    }
+
+    @Override
+    public void propertyDeleted(PropertyState before) {
+        if (!isVersionable()) {
+            if (!isVersionProperty(before) && wasCheckedIn()) {
+                throwProtected("Cannot delete property on checked in node");
+            }
+        }
+    }
+
+    @Override
+    public Editor childNodeAdded(String name, NodeState after) {
+        return childNodeChanged(name, EMPTY_NODE, after);
+    }
+
+    @Override
+    public Editor childNodeChanged(String name, NodeState before,
+            NodeState after) {
+        return new VersionEditor(this, vMgr, node.child(name));
+    }
+
+    @Override
+    public Editor childNodeDeleted(String name, NodeState before) {
+        return new VersionEditor(this, vMgr, EMPTY_NODE.builder());
+    }
+
+    /**
+     * Returns <code>true</code> if the node of this VersionDiff is versionable;
+     * <code>false</code> otherwise.
+     * 
+     * @return whether the node is versionable.
+     */
+    private boolean isVersionable() {
+        if (isVersionable == null) {
+            // this is not 100% correct, because t.getPath() will
+            // not return the correct path for nodeAfter, but is
+            // sufficient to check if it is versionable
+            Tree t = new ReadOnlyTree(node.getNodeState());
+            isVersionable = vMgr.isVersionable(t);
+        }
+        return isVersionable;
+    }
+
+    private boolean isVersionProperty(PropertyState state) {
+        return VersionConstants.VERSION_PROPERTY_NAMES
+                .contains(state.getName());
+    }
+
+    /**
+     * @return <code>true</code> if this node <b>was</b> checked in. That is,
+     *         this method checks the base state for the jcr:isCheckedOut
+     *         property.
+     */
+    private boolean wasCheckedIn() {
+        NodeState state = node.getBaseState();
+        if (state != null) {
+            PropertyState prop = state
+                    .getProperty(VersionConstants.JCR_ISCHECKEDOUT);
+            if (prop != null) {
+                return !prop.getValue(Type.BOOLEAN);
+            }
+        }
+        // new node or not versionable, check parent
+        return parent != null && parent.wasCheckedIn();
+    }
+
+    private static void throwCheckedIn(String msg)
+            throws UncheckedRepositoryException {
+        throwUnchecked(new VersionException(msg));
+    }
+
+    private static void throwProtected(String name)
+            throws UncheckedRepositoryException {
+        throwUnchecked(new ConstraintViolationException(
+                "Property is protected: " + name));
+    }
+
+    private static void throwUnchecked(RepositoryException e)
+            throws UncheckedRepositoryException {
+        throw new UncheckedRepositoryException(e);
+    }
+
+    private static class UncheckedRepositoryException extends RuntimeException {
+
+        private static final long serialVersionUID = 5220620245610340169L;
+
+        public UncheckedRepositoryException(RepositoryException cause) {
+            super(cause);
+        }
+
+        public RepositoryException getCause() {
+            return (RepositoryException) super.getCause();
+        }
+    }
+}

Propchange: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionEditor.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionEditor.java
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision Rev URL

Added: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionEditorProvider.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionEditorProvider.java?rev=1470912&view=auto
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionEditorProvider.java (added)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionEditorProvider.java Tue Apr 23 12:16:28 2013
@@ -0,0 +1,48 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.jackrabbit.oak.plugins.version;
+
+import static org.apache.jackrabbit.JcrConstants.JCR_SYSTEM;
+import static org.apache.jackrabbit.oak.plugins.nodetype.NodeTypeConstants.JCR_VERSIONSTORAGE;
+
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Service;
+import org.apache.jackrabbit.oak.spi.commit.Editor;
+import org.apache.jackrabbit.oak.spi.commit.EditorProvider;
+import org.apache.jackrabbit.oak.spi.commit.VisibleEditor;
+import org.apache.jackrabbit.oak.spi.state.NodeBuilder;
+import org.apache.jackrabbit.oak.spi.state.NodeState;
+
+@Component
+@Service(EditorProvider.class)
+public class VersionEditorProvider implements EditorProvider {
+
+    @Override
+    public Editor getRootEditor(NodeState before, NodeState after,
+            NodeBuilder builder) {
+        if (!builder.hasChildNode(JCR_SYSTEM)) {
+            return null;
+        }
+        NodeBuilder system = builder.child(JCR_SYSTEM);
+        if (!system.hasChildNode(JCR_VERSIONSTORAGE)) {
+            return null;
+        }
+        NodeBuilder version = system.child(JCR_VERSIONSTORAGE);
+        return new VisibleEditor(new VersionEditor(version, builder));
+    }
+
+}

Propchange: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionEditorProvider.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionEditorProvider.java
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision Rev URL

Modified: jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/Jcr.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/Jcr.java?rev=1470912&r1=1470911&r2=1470912&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/Jcr.java (original)
+++ jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/Jcr.java Tue Apr 23 12:16:28 2013
@@ -34,11 +34,12 @@ import org.apache.jackrabbit.oak.plugins
 import org.apache.jackrabbit.oak.plugins.nodetype.RegistrationEditorProvider;
 import org.apache.jackrabbit.oak.plugins.nodetype.TypeEditorProvider;
 import org.apache.jackrabbit.oak.plugins.nodetype.write.InitialContent;
-import org.apache.jackrabbit.oak.plugins.version.VersionHook;
+import org.apache.jackrabbit.oak.plugins.version.VersionEditorProvider;
 import org.apache.jackrabbit.oak.security.SecurityProviderImpl;
 import org.apache.jackrabbit.oak.spi.commit.CommitHook;
 import org.apache.jackrabbit.oak.spi.commit.ConflictHandler;
 import org.apache.jackrabbit.oak.spi.commit.Editor;
+import org.apache.jackrabbit.oak.spi.commit.EditorHook;
 import org.apache.jackrabbit.oak.spi.commit.EditorProvider;
 import org.apache.jackrabbit.oak.spi.lifecycle.RepositoryInitializer;
 import org.apache.jackrabbit.oak.spi.query.QueryIndexProvider;
@@ -58,7 +59,7 @@ public class Jcr {
         with(new InitialContent());
 
         with(JcrConflictHandler.JCR_CONFLICT_HANDLER);
-        with(new VersionHook());
+        with(new EditorHook(new VersionEditorProvider()));
 
         with(new SecurityProviderImpl());