You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by dk...@apache.org on 2018/02/07 06:21:28 UTC
[sling-whiteboard] branch master updated: Added a checkpoint
operation to support creating a version but not needing to checkin /
checkout
This is an automated email from the ASF dual-hosted git repository.
dklco 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 d388601 Added a checkpoint operation to support creating a version but not needing to checkin / checkout
d388601 is described below
commit d3886017da60b486b910ac2343c236a5a50a18e1
Author: Dan Klco <da...@gmail.com>
AuthorDate: Wed Feb 7 01:21:23 2018 -0500
Added a checkpoint operation to support creating a version but not needing to checkin / checkout
---
cms/core/pom.xml | 6 +
.../cms/core/operations/CheckpointOperation.java | 121 +++++++++++++++++++++
.../cms/versionmanager/versionmanager.jsp | 30 ++---
3 files changed, 135 insertions(+), 22 deletions(-)
diff --git a/cms/core/pom.xml b/cms/core/pom.xml
index b8c4a49..b3de0b7 100644
--- a/cms/core/pom.xml
+++ b/cms/core/pom.xml
@@ -128,6 +128,12 @@
<scope>provided</scope>
</dependency>
<dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.servlets.post</artifactId>
+ <version>2.3.22</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<scope>provided</scope>
diff --git a/cms/core/src/main/java/org/apache/sling/cms/core/operations/CheckpointOperation.java b/cms/core/src/main/java/org/apache/sling/cms/core/operations/CheckpointOperation.java
new file mode 100644
index 0000000..eb0ac59
--- /dev/null
+++ b/cms/core/src/main/java/org/apache/sling/cms/core/operations/CheckpointOperation.java
@@ -0,0 +1,121 @@
+/*
+ * 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.cms.core.operations;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import javax.jcr.Node;
+import javax.jcr.RepositoryException;
+import javax.servlet.http.HttpServletResponse;
+
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Property;
+import org.apache.felix.scr.annotations.Service;
+import org.apache.sling.api.SlingHttpServletRequest;
+import org.apache.sling.api.resource.PersistenceException;
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.servlets.post.Modification;
+import org.apache.sling.servlets.post.PostOperation;
+import org.apache.sling.servlets.post.PostResponse;
+import org.apache.sling.servlets.post.SlingPostProcessor;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * The <code>CheckpointOperation</code> class will perform a JCR Version
+ * Checkpoint operation on the underlying JCR Node. The checkpoint operation
+ * depends on the resources being backed up by a JCR node.
+ */
+@Component(immediate = true)
+@Service
+@Property(name = PostOperation.PROP_OPERATION_NAME, value = "checkpoint")
+public class CheckpointOperation implements PostOperation {
+
+ private static final Logger log = LoggerFactory.getLogger(CheckpointOperation.class);
+
+
+ public void run(final SlingHttpServletRequest request,
+ final PostResponse response,
+ final SlingPostProcessor[] processors) {
+
+
+ try {
+ // calculate the paths
+ String path = request.getResource().getPath();
+ response.setPath(path);
+
+
+ final List<Modification> changes = new ArrayList<>();
+
+ doRun(request, response, changes);
+
+ // invoke processors
+ if (processors != null) {
+ for (SlingPostProcessor processor : processors) {
+ processor.process(request, changes);
+ }
+ }
+
+ // check modifications for remaining postfix and store the base path
+ final Map<String, String> modificationSourcesContainingPostfix = new HashMap<>();
+ final Set<String> allModificationSources = new HashSet<>(changes.size());
+ for (final Modification modification : changes) {
+ final String source = modification.getSource();
+ if (source != null) {
+ allModificationSources.add(source);
+ final int atIndex = source.indexOf('@');
+ if (atIndex > 0) {
+ modificationSourcesContainingPostfix.put(source.substring(0, atIndex), source);
+ }
+ }
+ }
+
+
+ } catch (Exception e) {
+
+ log.error("Exception during response processing.", e);
+ response.setError(e);
+
+ }
+ }
+
+ protected void doRun(SlingHttpServletRequest request, PostResponse response, List<Modification> changes)
+ throws PersistenceException {
+ try {
+ Resource resource = request.getResource();
+ Node node = resource.adaptTo(Node.class);
+ if (node == null) {
+ response.setStatus(HttpServletResponse.SC_NOT_FOUND,
+ "Missing source " + resource + " for checkpoint");
+ return;
+ }
+
+ node.getSession().getWorkspace().getVersionManager().checkpoint(node.getPath());
+ changes.add(Modification.onCheckin(resource.getPath()));
+ changes.add(Modification.onCheckout(resource.getPath()));
+ } catch (final RepositoryException re) {
+ throw new PersistenceException(re.getMessage(), re);
+ }
+ }
+
+
+}
diff --git a/cms/ui/src/main/resources/jcr_root/libs/sling-cms/components/cms/versionmanager/versionmanager.jsp b/cms/ui/src/main/resources/jcr_root/libs/sling-cms/components/cms/versionmanager/versionmanager.jsp
index f5f603e..122fb3a 100644
--- a/cms/ui/src/main/resources/jcr_root/libs/sling-cms/components/cms/versionmanager/versionmanager.jsp
+++ b/cms/ui/src/main/resources/jcr_root/libs/sling-cms/components/cms/versionmanager/versionmanager.jsp
@@ -24,28 +24,14 @@
</c:if>
<c:choose>
<c:when test="${versionable == 'true'}">
- <c:choose>
- <c:when test="${sling:adaptTo(slingRequest.requestPathInfo.suffixResource,'javax.jcr.Node').checkedOut}">
- <form method="post" action="${slingRequest.requestPathInfo.suffix}" enctype="multipart/form-data" class="Form-Ajax" data-add-date="false">
- <input type="hidden" name=":operation" value="checkin" />
- <div class="Field-Group">
- <button type="submit" class="btn btn-success" title="Check the content back out so it can not be edited (opposite of JCR Checkout)">
- Checkout
- </button>
- </div>
- </form>
- </c:when>
- <c:otherwise>
- <form method="post" action="${slingRequest.requestPathInfo.suffix}" enctype="multipart/form-data" class="Form-Ajax" data-add-date="false">
- <input type="hidden" name=":operation" value="checkout" />
- <div class="Field-Group">
- <button type="submit" class="btn btn-success" title="Check the content back in so it can be edited (opposite of JCR Checkin)">
- Checkin
- </button>
- </div>
- </form>
- </c:otherwise>
- </c:choose>
+ <form method="post" action="${slingRequest.requestPathInfo.suffix}" enctype="multipart/form-data" class="Form-Ajax" data-add-date="false">
+ <input type="hidden" name=":operation" value="checkpoint" />
+ <div class="Field-Group">
+ <button type="submit" class="btn btn-success" title="Create a new version for the content">
+ Create Version
+ </button>
+ </div>
+ </form>
</c:when>
<c:otherwise>
<form method="post" action="${slingRequest.requestPathInfo.suffix}" enctype="multipart/form-data" class="Form-Ajax" data-add-date="false">
--
To stop receiving notification emails like this one, please contact
dklco@apache.org.