View Javadoc

1   /**
2    * This file Copyright (c) 2011-2014 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.cms.core.version;
35  
36  import info.magnolia.cms.core.HierarchyManager;
37  import info.magnolia.cms.core.Path;
38  import info.magnolia.cms.security.PermissionUtil;
39  import info.magnolia.context.MgnlContext;
40  import info.magnolia.context.MgnlContext.Op;
41  import info.magnolia.jcr.decoration.ContentDecoratorNodeWrapper;
42  
43  import javax.jcr.InvalidItemStateException;
44  import javax.jcr.ItemExistsException;
45  import javax.jcr.ItemNotFoundException;
46  import javax.jcr.Node;
47  import javax.jcr.PathNotFoundException;
48  import javax.jcr.RepositoryException;
49  import javax.jcr.Session;
50  import javax.jcr.UnsupportedRepositoryOperationException;
51  import javax.jcr.lock.LockException;
52  import javax.jcr.nodetype.ConstraintViolationException;
53  import javax.jcr.nodetype.NodeType;
54  import javax.jcr.version.Version;
55  import javax.jcr.version.VersionException;
56  import javax.jcr.version.VersionHistory;
57  import javax.jcr.version.VersionIterator;
58  
59  import org.slf4j.Logger;
60  import org.slf4j.LoggerFactory;
61  
62  /**
63   * Wrapper providing support for Magnolia specific versioning ops (by copy).
64   */
65  public class MgnlVersioningNodeWrapper extends ContentDecoratorNodeWrapper<MgnlVersioningContentDecorator> {
66  
67      private static final Logger log = LoggerFactory.getLogger(MgnlVersioningNodeWrapper.class);
68  
69      public MgnlVersioningNodeWrapper(Node node) {
70          super(node, new MgnlVersioningContentDecorator());
71      }
72  
73      public MgnlVersioningNodeWrapper(Node node, MgnlVersioningContentDecorator mgnlVersioningContentDecorator) {
74          super(node, mgnlVersioningContentDecorator);
75      }
76  
77      @Override
78      public void restore(String versionName, boolean removeExisting) throws VersionException, ItemExistsException, UnsupportedRepositoryOperationException,
79              LockException, InvalidItemStateException, RepositoryException {
80          VersionManager versionMan = VersionManager.getInstance();
81          Node raw = deepUnwrap(getClass());
82          Version version = versionMan.getVersion(raw, versionName);
83          versionMan.restore(raw, version, removeExisting);
84      }
85  
86      @Override
87      public void restore(Version version, boolean removeExisting) throws VersionException, ItemExistsException, InvalidItemStateException,
88              UnsupportedRepositoryOperationException, LockException, RepositoryException {
89          VersionManager versionMan = VersionManager.getInstance();
90          versionMan.restore(deepUnwrap(getClass()), version, removeExisting);
91      }
92  
93      @Override
94      public void restore(Version version, String relPath, boolean removeExisting) throws PathNotFoundException, ItemExistsException, VersionException,
95              ConstraintViolationException, UnsupportedRepositoryOperationException, LockException, InvalidItemStateException, RepositoryException {
96          throw new UnsupportedOperationException("Magnolia doesn't support restore into specified path at the moment");
97      }
98  
99      @Override
100     public void restoreByLabel(String versionLabel, boolean removeExisting) throws VersionException, ItemExistsException,
101             UnsupportedRepositoryOperationException, LockException, InvalidItemStateException, RepositoryException {
102         throw new UnsupportedOperationException("Magnolia doesn't support locating versions by label at the moment");
103     }
104 
105     /**
106      * Remove version history while removing the content.
107      */
108     @Override
109     public void remove() throws RepositoryException {
110         wrapped = getWrappedNode();
111         final String nodePath = Path.getAbsolutePath(wrapped.getPath());
112         log.debug("removing {} from {}", wrapped.getPath(), getSession().getWorkspace().getName());
113         PermissionUtil.verifyIsGrantedOrThrowException(getSession(), Path.getAbsolutePath(getPath()), Session.ACTION_REMOVE);
114         NodeType nodeType = this.getPrimaryNodeType();
115         String workspaceName = getSession().getWorkspace().getName();
116         if (!workspaceName.startsWith("mgnl")) {
117             MgnlContext.doInSystemContext(new Op<Void, RepositoryException>() {
118                 @Override
119                 public Void exec() throws RepositoryException {
120                     try {
121                         final String uuid = wrapped.getUUID();
122                         HierarchyManager hm = MgnlContext.getHierarchyManager("mgnlVersion");
123                         Node versionedNode = hm.getContentByUUID(uuid).getJCRNode();
124                         log.debug("Located versioned node {}({})", uuid, nodePath);
125 
126                         VersionHistory history = versionedNode.getVersionHistory();
127 
128                         log.debug("Removing versioned node {}({})", uuid, nodePath);
129                         versionedNode.remove();
130                         hm.save();
131 
132                         VersionIterator iter = history.getAllVersions();
133                         // skip root version. It can't be deleted manually, but will be cleaned up automatically after removing all other versions (see JCR-134)
134                         iter.nextVersion();
135                         while (iter.hasNext()) {
136                             Version version = iter.nextVersion();
137                             log.debug("removing version {}", version.getName());
138                             history.removeVersion(version.getName());
139                         }
140                         // at this point history should be deleted automatically (at least on JR)
141                     } catch (ItemNotFoundException e) {
142                         // doesn't exist in version store, ignore
143                     } catch (UnsupportedRepositoryOperationException e) {
144                         // not versionable or not referenceable ... either way ignore
145                     }
146                     return null;
147                 }
148             });
149         }
150         wrapped.remove();
151     }
152 }