View Javadoc
1   /**
2    * This file Copyright (c) 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.resources.app.action;
35  
36  import static info.magnolia.resources.app.action.OpenResourceAction.HOTFIX_SUBAPP_NAME;
37  import static info.magnolia.ui.vaadin.overlay.MessageStyleTypeEnum.*;
38  
39  import info.magnolia.context.Context;
40  import info.magnolia.event.EventBus;
41  import info.magnolia.i18nsystem.SimpleTranslator;
42  import info.magnolia.jcr.util.NodeTypes;
43  import info.magnolia.jcr.util.NodeUtil;
44  import info.magnolia.resourceloader.Resource;
45  import info.magnolia.resourceloader.ResourceOrigin;
46  import info.magnolia.resourceloader.jcr.JcrResourceOrigin;
47  import info.magnolia.resourceloader.layered.LayeredResource;
48  import info.magnolia.resources.app.workbench.ResourcesContainer;
49  import info.magnolia.ui.api.action.ActionExecutionException;
50  import info.magnolia.ui.api.app.AppContext;
51  import info.magnolia.ui.api.event.AdmincentralEventBus;
52  import info.magnolia.ui.api.event.ContentChangedEvent;
53  import info.magnolia.ui.api.location.LocationController;
54  import info.magnolia.ui.api.overlay.AlertCallback;
55  import info.magnolia.ui.contentapp.detail.DetailLocation;
56  import info.magnolia.ui.contentapp.detail.DetailView.ViewType;
57  
58  import java.io.IOException;
59  import java.io.Reader;
60  
61  import javax.inject.Named;
62  import javax.jcr.Node;
63  import javax.jcr.RepositoryException;
64  import javax.jcr.Session;
65  
66  import org.apache.commons.io.IOUtils;
67  
68  import com.vaadin.data.Item;
69  
70  /**
71   * Action for creating a hotfix from the resources app.
72   * <p>
73   * A hotfix consists in importing a resource from classpath or file-system, into the 'resources' JCR workspace.
74   * By doing this, the newly imported resource takes precedence over the original one in the resources loading cascade.
75   * It may then be edited, on a live instance, and it may eventually be published to a public instance as well.
76   */
77  public class HotfixResourceAction extends AbstractResourceAction<HotfixResourceActionDefinition> {
78  
79      private final Item resourceItem;
80      private final Context context;
81      private final SimpleTranslator i18n;
82      private final AppContext appContext;
83      private final LocationController locationController;
84      private final ResourceOrigin origin;
85      private final EventBus eventBus;
86  
87      public HotfixResourceAction(HotfixResourceActionDefinition definition, Item resourceItem, Context context, AppContext appContext, SimpleTranslator i18n, LocationController locationController, ResourceOrigin origin, @Named(AdmincentralEventBus.NAME) EventBus eventBus) {
88          super(definition, origin);
89          this.resourceItem = resourceItem;
90          this.context = context;
91          this.i18n = i18n;
92          this.appContext = appContext;
93          this.locationController = locationController;
94          this.origin = origin;
95          this.eventBus = eventBus;
96      }
97  
98      @Override
99      public void execute() throws ActionExecutionException {
100         Resource resourceToHotfix = fetchResourceToHotfix();
101         Resource parent = resourceToHotfix.getParent();
102 
103         if (parent == null) {
104             throw new ActionExecutionException(new IllegalStateException("Could not get parent of resource to hotfix."));
105         }
106 
107         try {
108             Session jcrSession = context.getJCRSession(JcrResourceOrigin.RESOURCES_WORKSPACE);
109             if (jcrSession.nodeExists(resourceToHotfix.getPath())) {
110                 String title = i18n.translate("resources.actions.hotfixResource.notification.alreadyExists.title");
111                 String body = i18n.translate("resources.actions.hotfixResource.notification.alreadyExists.body", resourceToHotfix.getPath());
112                 appContext.openAlert(WARNING, title, body, i18n.translate("button.ok"), new AlertCallback() {
113                     @Override
114                     public void onOk() {
115                     }
116                 });
117                 return;
118             }
119 
120             // create parent directories in JCR if they don't exist yet
121             Node parentNode = NodeUtil.createPath(jcrSession.getRootNode(), parent.getPath(), NodeTypes.Folder.NAME);
122             Node resourceNode = createResourceNode(resourceToHotfix, parentNode, resourceToHotfix.getName());
123             jcrSession.save();
124 
125             // Open the newly imported resource in the hotfix subapp
126             String resourceNodePath = resourceNode.getPath();
127             DetailLocation detailLocation = new DetailLocation(appContext.getName(), HOTFIX_SUBAPP_NAME, ViewType.EDIT, resourceNodePath, null);
128             locationController.goTo(detailLocation);
129 
130             eventBus.fireEvent(new ContentChangedEvent(resourceNodePath));
131 
132             appContext.openNotification(INFO, true, i18n.translate("resources.actions.hotfixResource.notification.success"));
133 
134         } catch (Exception e) {
135             appContext.openNotification(ERROR, false, i18n.translate("resources.actions.hotfixResource.notification.error"));
136             throw new ActionExecutionException(e);
137         }
138     }
139 
140     private Resource fetchResourceToHotfix() {
141         String resourcePath = (String) resourceItem.getItemProperty(ResourcesContainer.RESOURCE_PATH).getValue();
142         return ((LayeredResource) origin.getByPath(resourcePath)).getFirst();
143     }
144 
145     private Node createResourceNode(Resource resourceToHotfix, Node parentNode, String resourceName) throws RepositoryException, IOException {
146         try (Reader reader = resourceToHotfix.openReader()) {
147             String content = IOUtils.toString(reader);
148             Node resourceNode = parentNode.addNode(resourceName, NodeTypes.Content.NAME);
149             resourceNode.setProperty(JcrResourceOrigin.TEXT_PROPERTY, content);
150             return resourceNode;
151         }
152     }
153 }