View Javadoc
1   /**
2    * This file Copyright (c) 2019 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.form.field.definition.migration;
35  
36  import info.magnolia.ui.editor.ByLexicographicallyIndexedChildNodes;
37  import info.magnolia.ui.editor.CurrentItemProviderDefinition;
38  import info.magnolia.ui.editor.JcrChildNodeProviderDefinition;
39  import info.magnolia.ui.editor.JcrPropertyProvider;
40  import info.magnolia.ui.editor.LexicographicallyIndexedJcrNodeOrderHandler;
41  import info.magnolia.ui.editor.MultiFieldEntryResolution;
42  import info.magnolia.ui.field.AlwaysEmptyPrefixNameDecorator;
43  import info.magnolia.ui.field.CompositeFieldDefinition;
44  import info.magnolia.ui.field.ConfiguredSwitchableFieldDefinition;
45  import info.magnolia.ui.field.EditorPropertyDefinition;
46  import info.magnolia.ui.field.JcrMultiFieldDefinition;
47  import info.magnolia.ui.field.JcrMultiValueFieldDefinition;
48  import info.magnolia.ui.field.MultiFieldDefinition;
49  import info.magnolia.ui.field.NoopNameDecorator;
50  import info.magnolia.ui.form.definition.DefinitionConverter;
51  import info.magnolia.ui.form.field.definition.MultiValueFieldDefinition;
52  import info.magnolia.ui.form.field.transformer.composite.DelegatingCompositeFieldTransformer;
53  import info.magnolia.ui.form.field.transformer.composite.NoOpCompositeTransformer;
54  import info.magnolia.ui.form.field.transformer.multi.DelegatingMultiValueFieldTransformer;
55  import info.magnolia.ui.form.field.transformer.multi.DelegatingMultiValueSubnodeTransformer;
56  import info.magnolia.ui.form.field.transformer.multi.MultiValueSubChildrenNodePropertiesTransformer;
57  import info.magnolia.ui.form.field.transformer.multi.MultiValueTransformer;
58  
59  import java.util.ArrayList;
60  import java.util.List;
61  import java.util.Optional;
62  
63  import javax.jcr.Node;
64  
65  
66  /**
67   * Converter from old {@link MultiValueFieldDefinition} to new {@link MultiFieldDefinition}.
68   */
69  public class MultiValueFieldDefinitionConverter extends AbstractComplexFieldDefinitionConverter<Node, MultiFieldDefinition<Node>, MultiValueFieldDefinition> {
70  
71      public MultiFieldDefinition<Node> convert(MultiValueFieldDefinition oldDefinition) {
72          MultiFieldDefinition newDefinition = super.convert(oldDefinition);
73  
74          Optional.ofNullable(oldDefinition.getField()) // nested composite fields should work with NoOpCompositeTransformer
75                  .filter(info.magnolia.ui.form.field.definition.CompositeFieldDefinition.class::isInstance)
76                  .map(info.magnolia.ui.form.field.definition.CompositeFieldDefinition.class::cast)
77                  .map(info.magnolia.ui.form.field.definition.CompositeFieldDefinition::getTransformerClass)
78                  .filter(NoOpCompositeTransformer.class::equals)
79                  .ifPresent(noop -> oldDefinition.getField().setTransformerClass(DelegatingCompositeFieldTransformer.class));
80  
81          final EditorPropertyDefinition field = DefinitionConverter.FIELD.convert(oldDefinition.getField());
82          if (newDefinition instanceof JcrMultiValueFieldDefinition) {
83              final JcrPropertyProvider.Definition definition = new JcrPropertyProvider.Definition(oldDefinition.getName());
84              definition.setMultiple(true);
85              newDefinition.setItemProvider(definition);
86              newDefinition.setField(field);
87              ((JcrMultiValueFieldDefinition) newDefinition).init();
88          } else {
89              List<EditorPropertyDefinition> properties = new ArrayList<>();
90              properties.add(field);
91              CompositeFieldDefinition<Object> compositeFieldDefinition = new CompositeFieldDefinition<>();
92              final JcrChildNodeProviderDefinition providerDefinition = new JcrChildNodeProviderDefinition();
93              providerDefinition.setNodeName(oldDefinition.getName());
94              compositeFieldDefinition.setName(oldDefinition.getName());
95              compositeFieldDefinition.setProperties(properties);
96              newDefinition.setField(compositeFieldDefinition);
97              convertTransformerStrategy(oldDefinition, newDefinition);
98          }
99          return newDefinition;
100     }
101 
102     @Override
103     MultiFieldDefinition createNewDefinition(MultiValueFieldDefinition oldDefinition) {
104         return oldDefinition.getTransformerClass().equals(MultiValueTransformer.class) ? new JcrMultiValueFieldDefinition() : new JcrMultiFieldDefinition();
105     }
106 
107     private void convertTransformerStrategy(info.magnolia.ui.form.field.definition.MultiValueFieldDefinition oldDefinition, MultiFieldDefinition<Node> newDefinition) {
108         if (oldDefinition.getTransformerClass().equals(DelegatingMultiValueFieldTransformer.class)) {
109             newDefinition.setItemProvider(new CurrentItemProviderDefinition<>());
110         }
111         if (oldDefinition.getTransformerClass().equals(DelegatingMultiValueSubnodeTransformer.class)) {
112             JcrChildNodeProviderDefinition providerDefinition = new JcrChildNodeProviderDefinition();
113             providerDefinition.setSupportI18N(false); // this ensures only one node is created for all (localized) sub nodes
114             newDefinition.setItemProvider(providerDefinition);
115             MultiFieldEntryResolution.Definition entryResolution = new MultiFieldEntryResolution.Definition();
116             entryResolution.setPropertyNameDecorator(AlwaysEmptyPrefixNameDecorator.class);
117             newDefinition.setEntryResolution(entryResolution);
118         }
119         if (oldDefinition.getTransformerClass().equals(MultiValueSubChildrenNodePropertiesTransformer.class)) {
120             JcrChildNodeProviderDefinition providerDefinition = new JcrChildNodeProviderDefinition();
121             providerDefinition.setSupportI18N(false);
122             newDefinition.setItemProvider(providerDefinition);
123             newDefinition.setEntryResolution(new ByLexicographicallyIndexedChildNodes.Definition());
124             newDefinition.setOrderHandler(new LexicographicallyIndexedJcrNodeOrderHandler.Definition());
125             Optional.ofNullable(newDefinition.getField()) // nested switchablefield doesn't use name prefixes here
126                     .filter(CompositeFieldDefinition.class::isInstance)
127                     .map(CompositeFieldDefinition.class::cast)
128                     .map(CompositeFieldDefinition::getProperties)
129                     .filter(properties -> !properties.isEmpty())
130                     .map(properties -> properties.get(0))
131                     .filter(ConfiguredSwitchableFieldDefinition.class::isInstance)
132                     .map(ConfiguredSwitchableFieldDefinition.class::cast)
133                     .ifPresent(switchable -> switchable.setPropertyNameDecorator(NoopNameDecorator.class));
134         }
135     }
136 
137     @Override
138     protected boolean supportsTransformerClass(Class transformerClass) {
139         return transformerClass.equals(MultiValueTransformer.class) ||
140                 transformerClass.equals(DelegatingMultiValueFieldTransformer.class) ||
141                 transformerClass.equals(DelegatingMultiValueSubnodeTransformer.class) ||
142                 transformerClass.equals(MultiValueSubChildrenNodePropertiesTransformer.class);
143     }
144 }