View Javadoc
1   /**
2    * This file Copyright (c) 2013-2018 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.ui.dialog.action;
35  
36  import info.magnolia.event.EventBus;
37  import info.magnolia.ui.api.action.AbstractAction;
38  import info.magnolia.ui.api.action.ActionExecutionException;
39  import info.magnolia.ui.api.app.SubAppEventBus;
40  import info.magnolia.ui.form.EditorCallback;
41  import info.magnolia.ui.form.EditorValidator;
42  import info.magnolia.ui.vaadin.integration.jcr.AbstractJcrNodeAdapter;
43  import info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter;
44  import info.magnolia.ui.vaadin.integration.jcr.JcrPropertyAdapter;
45  import info.magnolia.ui.vaadin.integration.jcr.JcrPropertyItemId;
46  import info.magnolia.ui.workbench.event.SelectionChangedEvent;
47  
48  import java.util.Arrays;
49  import java.util.HashSet;
50  
51  import javax.inject.Inject;
52  import javax.inject.Named;
53  import javax.jcr.Node;
54  import javax.jcr.RepositoryException;
55  
56  import org.slf4j.Logger;
57  import org.slf4j.LoggerFactory;
58  
59  import com.vaadin.v7.data.Item;
60  
61  /**
62   * The SaveConfigDialogAction is a special dialog commit action for saving configuration properties,
63   * when editing them in the Configuration app.
64   *
65   * @deprecated since 6.2 - use {@link info.magnolia.ui.contentapp.action.CommitAction} instead.
66   *
67   * @see <a href="https://documentation.magnolia-cms.com/display/DOCS62/Upgrading+to+Magnolia+6.2.x">Upgrading to Magnolia 6.2.x</a>
68   */
69  @Deprecated
70  public class SaveConfigDialogAction extends AbstractAction<SaveConfigDialogActionDefinition> {
71  
72      private static final Logger log = LoggerFactory.getLogger(SaveConfigDialogAction.class);
73  
74      protected final Item item;
75  
76      protected final EditorValidator validator;
77      protected final EditorCallback callback;
78  
79      private final EventBus eventBus;
80  
81      @Inject
82      public SaveConfigDialogAction(SaveConfigDialogActionDefinition definition, Item item, EditorValidator validator, EditorCallback callback, final @Named(SubAppEventBus.NAME) EventBus eventBus) {
83          super(definition);
84          this.item = item;
85          this.validator = validator;
86          this.callback = callback;
87          this.eventBus = eventBus;
88      }
89  
90      @Override
91      public void execute() throws ActionExecutionException {
92          // First Validate
93          validator.showValidation(true);
94          if (validator.isValid()) {
95  
96              // we support only JCR item adapters
97              if (!(item instanceof JcrItemAdapter)) {
98                  return;
99              }
100 
101             // don't save if no value changes occurred on adapter
102             if (!((JcrItemAdapter) item).hasChangedProperties()) {
103                 return;
104             }
105 
106             if (item instanceof AbstractJcrNodeAdapter) {
107                 // Saving JCR Node, getting updated node first
108                 AbstractJcrNodeAdapteragnolia/ui/vaadin/integration/jcr/AbstractJcrNodeAdapter.html#AbstractJcrNodeAdapter">AbstractJcrNodeAdapter nodeAdapter = (AbstractJcrNodeAdapter) item;
109                 try {
110                     // get modifications
111                     Node node = nodeAdapter.applyChanges();
112                     node.getSession().save();
113                 } catch (RepositoryException e) {
114                     log.error("Could not save changes to node", e);
115                 }
116 
117             } else if (item instanceof JcrPropertyAdapter) {
118                 // Saving JCR Property, update it first
119                 JcrPropertyAdapteragnolia/ui/vaadin/integration/jcr/JcrPropertyAdapter.html#JcrPropertyAdapter">JcrPropertyAdapter propertyAdapter = (JcrPropertyAdapter) item;
120                 try {
121                     // get parent first because once property is updated, it won't exist anymore if the name changes
122                     Node parent = propertyAdapter.getJcrItem().getParent();
123 
124                     // get modifications
125                     propertyAdapter.applyChanges();
126                     parent.getSession().save();
127 
128                     // update workbench selection in case the property changed name
129                     JcrPropertyItemId newItemId = propertyAdapter.getItemId();
130                     eventBus.fireEvent(new SelectionChangedEvent(new HashSet<Object>(Arrays.asList(newItemId))));
131 
132                 } catch (RepositoryException e) {
133                     log.error("Could not save changes to property", e);
134                 }
135             }
136             callback.onSuccess(getDefinition().getName());
137         } else {
138             log.debug("Validation error(s) occurred. No save performed.");
139         }
140     }
141 
142 }