View Javadoc
1   /**
2    * This file Copyright (c) 2016-2017 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.event.EventBus;
37  import info.magnolia.i18nsystem.SimpleTranslator;
38  import info.magnolia.jcr.util.NodeTypes;
39  import info.magnolia.objectfactory.Components;
40  import info.magnolia.pages.app.editor.ComponentContentClipboard;
41  import info.magnolia.ui.api.action.ActionExecutionException;
42  import info.magnolia.ui.api.app.SubAppEventBus;
43  import info.magnolia.ui.api.context.UiContext;
44  import info.magnolia.ui.api.event.ContentChangedEvent;
45  import info.magnolia.ui.contentapp.browser.action.CopyContentAction;
46  import info.magnolia.ui.framework.ContentClipboard;
47  import info.magnolia.ui.framework.ContentClipboardException;
48  import info.magnolia.ui.vaadin.gwt.client.shared.AreaElement;
49  import info.magnolia.ui.vaadin.gwt.client.shared.ComponentElement;
50  import info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter;
51  import info.magnolia.ui.vaadin.integration.jcr.JcrItemId;
52  import info.magnolia.ui.vaadin.overlay.MessageStyleTypeEnum;
53  
54  import java.util.Arrays;
55  
56  import javax.inject.Inject;
57  import javax.inject.Named;
58  import javax.jcr.Node;
59  import javax.jcr.NodeIterator;
60  import javax.jcr.RepositoryException;
61  
62  /**
63   * Copies the reference(s) of a single component or of all components present in an area to the clipboard.
64   */
65  public class CopyComponentAction extends CopyContentAction {
66  
67      @Inject
68      public CopyComponentAction(CopyComponentActionDefinition definition, JcrItemAdapter source,
69                                 @Named(SubAppEventBus.NAME) EventBus eventBus, UiContext uiContext, ComponentContentClipboard componentContentClipboard, SimpleTranslator i18n) {
70          super(definition, Arrays.asList(source), componentContentClipboard, uiContext, eventBus, i18n);
71      }
72  
73      /**
74       * @deprecated since 5.5.1. Use {@link #CopyComponentAction(CopyComponentActionDefinition, JcrItemAdapter, EventBus, UiContext, ComponentContentClipboard, SimpleTranslator)} instead.
75       */
76      public CopyComponentAction(CopyComponentActionDefinition definition, JcrItemAdapter source,
77                                 @Named(SubAppEventBus.NAME) EventBus eventBus, UiContext uiContext, ContentClipboard contentClipboard, SimpleTranslator i18n) {
78          this(definition, source, eventBus, uiContext, Components.getComponent(ComponentContentClipboard.class), i18n);
79      }
80  
81      @Override
82      public void execute() throws ActionExecutionException {
83          try {
84              final JcrItemAdapter itemAdapter = getSource().get(0);
85              final JcrItemId itemId = itemAdapter.getItemId();
86              Node node = (Node) itemAdapter.getJcrItem();
87  
88              if (NodeTypes.Area.NAME.equals(node.getPrimaryNodeType().getName())) {
89                  int components = 0;
90                  NodeIterator nit = node.getNodes();
91                  while (nit.hasNext()) {
92                      Node componentNode = nit.nextNode();
93                      if (NodeTypes.Component.NAME.equals(componentNode.getPrimaryNodeType().getName())) {
94                          components++;
95                      }
96                  }
97                  getContentClipboard().copy(Arrays.asList(new AreaElement(itemAdapter.getWorkspace(), itemAdapter.getJcrItem().getPath(), null, null)));
98  
99                  getUiContext().openNotification(MessageStyleTypeEnum.INFO, true, getI18n().translate("actions.copyComponent.successAreaCopied", components));
100             } else if (NodeTypes.Component.NAME.equals(node.getPrimaryNodeType().getName())) {
101                 getContentClipboard().copy(Arrays.asList(new ComponentElement(itemAdapter.getWorkspace(), itemAdapter.getJcrItem().getPath(), null)));
102 
103                 getUiContext().openNotification(MessageStyleTypeEnum.INFO, true, getI18n().translate("actions.copyComponent.successComponentCopied"));
104             }
105 
106             getEventBus().fireEvent(new ContentChangedEvent(itemId));
107         } catch (RepositoryException | ContentClipboardException e) {
108             throw new ActionExecutionException(getI18n().translate("actions.copyComponent.failure"));
109         }
110     }
111 }