View Javadoc
1   /**
2    * This file Copyright (c) 2011-2015 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.version.Version;
54  import javax.jcr.version.VersionException;
55  import javax.jcr.version.VersionHistory;
56  import javax.jcr.version.VersionIterator;
57  
58  import org.slf4j.Logger;
59  import org.slf4j.LoggerFactory;
60  
61  /**
62   * Wrapper providing support for Magnolia specific versioning ops (by copy).
63   */
64  public class MgnlVersioningNodeWrapper extends ContentDecoratorNodeWrapper<MgnlVersioningContentDecorator> {
65  
66      private static final Logger log = LoggerFactory.getLogger(MgnlVersioningNodeWrapper.class);
67  
68      public MgnlVersioningNodeWrapper(Node node) {
69          super(node, new MgnlVersioningContentDecorator());
70      }
71  
72      public MgnlVersioningNodeWrapper(Node node, MgnlVersioningContentDecorator mgnlVersioningContentDecorator) {
73          super(node, mgnlVersioningContentDecorator);
74      }
75  
76      @Override
77      public void restore(String versionName, boolean removeExisting) throws VersionException, ItemExistsException, UnsupportedRepositoryOperationException,
78              LockException, InvalidItemStateException, RepositoryException {
79          VersionManager versionMan = VersionManager.getInstance();
80          Node raw = deepUnwrap(getClass());
81          Version version = versionMan.getVersion(raw, versionName);
82          versionMan.restore(raw, version, removeExisting);
83      }
84  
85      @Override
86      public void restore(Version version, boolean removeExisting) throws VersionException, ItemExistsException, InvalidItemStateException,
87              UnsupportedRepositoryOperationException, LockException, RepositoryException {
88          VersionManager versionMan = VersionManager.getInstance();
89          versionMan.restore(deepUnwrap(getClass()), version, removeExisting);
90      }
91  
92      @Override
93      public void restore(Version version, String relPath, boolean removeExisting) throws PathNotFoundException, ItemExistsException, VersionException,
94              ConstraintViolationException, UnsupportedRepositoryOperationException, LockException, InvalidItemStateException, RepositoryException {
95          throw new UnsupportedOperationException("Magnolia doesn't support restore into specified path at the moment");
96      }
97  
98      @Override
99      public void restoreByLabel(String versionLabel, boolean removeExisting) throws VersionException, ItemExistsException,
100             UnsupportedRepositoryOperationException, LockException, InvalidItemStateException, RepositoryException {
101         throw new UnsupportedOperationException("Magnolia doesn't support locating versions by label at the moment");
102     }
103 
104     /**
105      * Remove version history while removing the content.
106      */
107     @Override
108     public void remove() throws RepositoryException {
109         wrapped = getWrappedNode();
110         final String nodePath = Path.getAbsolutePath(wrapped.getPath());
111         log.debug("removing {} from {}", wrapped.getPath(), getSession().getWorkspace().getName());
112         PermissionUtil.verifyIsGrantedOrThrowException(getSession(), Path.getAbsolutePath(getPath()), Session.ACTION_REMOVE);
113         String workspaceName = getSession().getWorkspace().getName();
114         if (!workspaceName.startsWith("mgnl")) {
115             MgnlContext.doInSystemContext(new Op<Void, RepositoryException>() {
116                 @Override
117                 public Void exec() throws RepositoryException {
118                     try {
119                         final String uuid = wrapped.getUUID();
120                         HierarchyManager hm = MgnlContext.getHierarchyManager("mgnlVersion");
121                         Node versionedNode = hm.getContentByUUID(uuid).getJCRNode();
122                         log.debug("Located versioned node {}({})", uuid, nodePath);
123 
124                         VersionHistory history = versionedNode.getVersionHistory();
125 
126                         log.debug("Removing versioned node {}({})", uuid, nodePath);
127                         versionedNode.remove();
128                         hm.save();
129 
130                         VersionIterator iter = history.getAllVersions();
131                         // skip root version. It can't be deleted manually, but will be cleaned up automatically after removing all other versions (see JCR-134)
132                         iter.nextVersion();
133                         while (iter.hasNext()) {
134                             Version version = iter.nextVersion();
135                             log.debug("removing version {}", version.getName());
136                             history.removeVersion(version.getName());
137                         }
138                         // at this point history should be deleted automatically (at least on JR)
139                     } catch (ItemNotFoundException e) {
140                         // doesn't exist in version store, ignore
141                     } catch (UnsupportedRepositoryOperationException e) {
142                         // not versionable or not referenceable ... either way ignore
143                     }
144                     return null;
145                 }
146             });
147         }
148         wrapped.remove();
149     }
150 }