Clover icon

Magnolia Resources App Module 2.4.7

  1. Project Clover database Fri Sep 9 2016 16:27:56 CEST
  2. Package info.magnolia.resources.app.action

File HotfixResourceAction.java

 

Coverage histogram

../../../../../img/srcFileCovDistChart9.png
42% of files have more coverage

Code metrics

4
37
5
1
155
91
10
0.27
7.4
5
2

Classes

Class Line # Actions
HotfixResourceAction 79 37 0% 10 5
0.891304489.1%
 

Contributing tests

This file is covered by 3 tests. .

Source view

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