View Javadoc

1   /**
2    * This file Copyright (c) 2013-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.pages.app.action;
35  
36  import info.magnolia.cms.core.version.VersionManager;
37  import info.magnolia.event.EventBus;
38  import info.magnolia.i18nsystem.SimpleTranslator;
39  import info.magnolia.ui.api.action.AbstractAction;
40  import info.magnolia.ui.api.action.ActionExecutionException;
41  import info.magnolia.ui.api.app.SubAppContext;
42  import info.magnolia.ui.api.event.AdmincentralEventBus;
43  import info.magnolia.ui.api.event.ContentChangedEvent;
44  import info.magnolia.ui.api.location.LocationController;
45  import info.magnolia.ui.contentapp.detail.DetailLocation;
46  import info.magnolia.ui.contentapp.detail.DetailView;
47  import info.magnolia.ui.vaadin.integration.jcr.AbstractJcrNodeAdapter;
48  import info.magnolia.ui.vaadin.integration.jcr.JcrItemUtil;
49  import info.magnolia.ui.vaadin.overlay.MessageStyleTypeEnum;
50  
51  import javax.inject.Inject;
52  import javax.inject.Named;
53  import javax.jcr.Node;
54  import javax.jcr.RepositoryException;
55  import javax.jcr.version.Version;
56  import javax.jcr.version.VersionIterator;
57  
58  import org.slf4j.Logger;
59  import org.slf4j.LoggerFactory;
60  
61  /**
62   * Restore the previous version of a page and edit it.
63   */
64  public class RestorePreviousVersionAction extends AbstractAction<RestorePreviousVersionActionDefinition> {
65      private final Logger log = LoggerFactory.getLogger(getClass());
66      private final AbstractJcrNodeAdapter nodeItemToEdit;
67      private final LocationController locationController;
68      private final VersionManager versionManager;
69      private final SubAppContext subAppContext;
70      private final SimpleTranslator i18n;
71      private EventBus eventBus;
72  
73      /**
74       * @deprecated since 5.3. Use {@link RestorePreviousVersionAction#RestorePreviousVersionAction(RestorePreviousVersionActionDefinition, AbstractJcrNodeAdapter, LocationController, VersionManager, SubAppContext, SimpleTranslator, EventBus) instead.
75       */
76      public RestorePreviousVersionAction(RestorePreviousVersionActionDefinition definition, AbstractJcrNodeAdapter nodeItemToEdit, LocationController locationController,
77              VersionManager versionManager, SubAppContext subAppContext, SimpleTranslator i18n) {
78          this(definition, nodeItemToEdit, locationController, versionManager, subAppContext, i18n, null);
79      }
80  
81      @Inject
82      public RestorePreviousVersionAction(RestorePreviousVersionActionDefinition definition, AbstractJcrNodeAdapter nodeItemToEdit, LocationController locationController,
83              VersionManager versionManager, SubAppContext subAppContext, SimpleTranslator i18n, @Named(AdmincentralEventBus.NAME) final EventBus eventBus) {
84          super(definition);
85          this.nodeItemToEdit = nodeItemToEdit;
86          this.locationController = locationController;
87          this.versionManager = versionManager;
88          this.subAppContext = subAppContext;
89          this.i18n = i18n;
90          this.eventBus = eventBus;
91      }
92  
93      @Override
94      public void execute() throws ActionExecutionException {
95          try {
96              final String path = nodeItemToEdit.getJcrItem().getPath();
97  
98              // Get last version.
99              Version version = getPreviousVersion();
100             // Check the version.
101             if (version == null) {
102                 //
103                 subAppContext.openNotification(MessageStyleTypeEnum.ERROR, true, i18n.translate("pages.restorePreviousVersionAction.noVersion.actionCanceled.message"));
104                 return;
105             }
106             // Restore previous version
107             Node node = nodeItemToEdit.getJcrItem();
108             versionManager.restore(node, version, true);
109 
110             if (this.getDefinition().isShowPreview()) {
111                 DetailLocation location = new DetailLocation("pages", "detail", DetailView.ViewType.EDIT, path, "");
112                 locationController.goTo(location);
113             } else if (eventBus != null) {
114                 Object itemId = JcrItemUtil.getItemId(node);
115                 eventBus.fireEvent(new ContentChangedEvent(itemId, true));
116             }
117 
118         } catch (RepositoryException e) {
119             subAppContext.openNotification(MessageStyleTypeEnum.ERROR, true, i18n.translate("pages.restorePreviousVersionAction.repositoryException.actionCanceled.message"));
120             throw new ActionExecutionException("Could not execute RestorePreviousVersionAction: ", e);
121         }
122     }
123 
124     /**
125      * @return Previous version or null if not founded.
126      */
127     private Version getPreviousVersion() throws RepositoryException {
128         Version previousVersion = null;
129         VersionIterator versionIterator = versionManager.getAllVersions(nodeItemToEdit.getJcrItem());
130         if (versionIterator == null) {
131             return previousVersion;
132         }
133 
134         while (versionIterator.hasNext()) {
135             previousVersion = versionIterator.nextVersion();
136         }
137 
138         return previousVersion;
139     }
140 }