/**
    * This file Copyright (c) 2019 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.ui.form.field.definition.migration;
  
  import info.magnolia.ui.editor.ByLexicographicallyIndexedChildNodes;
  import info.magnolia.ui.editor.ComplexPropertyDefinition;
  import info.magnolia.ui.editor.CurrentItemProviderDefinition;
  import info.magnolia.ui.editor.ItemProviderDefinition;
  import info.magnolia.ui.editor.JcrChildNodeProviderDefinition;
  import info.magnolia.ui.editor.JcrPropertyProvider;
  import info.magnolia.ui.editor.LexicographicallyIndexedJcrNodeOrderHandler;
  import info.magnolia.ui.editor.MultiFieldEntryResolution;
  import info.magnolia.ui.editor.MultiValueAsMultipleProperties;
  import info.magnolia.ui.field.AlwaysEmptyPrefixNameDecorator;
  import info.magnolia.ui.field.CompositeFieldDefinition;
  import info.magnolia.ui.field.ConfiguredComplexPropertyDefinition;
  import info.magnolia.ui.field.ConfiguredSwitchableFieldDefinition;
  import info.magnolia.ui.field.EditorPropertyDefinition;
  import info.magnolia.ui.field.JcrMultiFieldDefinition;
  import info.magnolia.ui.field.JcrMultiValueFieldDefinition;
  import info.magnolia.ui.field.MultiFieldDefinition;
  import info.magnolia.ui.field.NoopNameDecorator;
  import info.magnolia.ui.form.definition.DefinitionConverter;
  import info.magnolia.ui.form.field.definition.MultiValueFieldDefinition;
  import info.magnolia.ui.form.field.transformer.composite.DelegatingCompositeFieldTransformer;
  import info.magnolia.ui.form.field.transformer.composite.NoOpCompositeTransformer;
  import info.magnolia.ui.form.field.transformer.multi.DelegatingMultiValueFieldTransformer;
  import info.magnolia.ui.form.field.transformer.multi.DelegatingMultiValueSubnodeTransformer;
  import info.magnolia.ui.form.field.transformer.multi.MultiValueChildNodeTransformer;
  import info.magnolia.ui.form.field.transformer.multi.MultiValueSubChildrenNodePropertiesTransformer;
  import info.magnolia.ui.form.field.transformer.multi.MultiValueTransformer;
  import info.magnolia.ui.framework.layout.SingleFieldLayoutProducer;
  
  import java.util.Collections;
  import java.util.Optional;
  
  import javax.jcr.Node;
  
  
  /**
   * Converter from old {@link MultiValueFieldDefinition} to new {@link MultiFieldDefinition}.
   */
  public class MultiValueFieldDefinitionConverter extends AbstractComplexFieldDefinitionConverter<Node, MultiFieldDefinition<Node>, MultiValueFieldDefinition> {
  
      public MultiFieldDefinition<Node> convert(MultiValueFieldDefinition oldDefinition) {
          MultiFieldDefinition newDefinition = super.convert(oldDefinition);
          newDefinition.setButtonSelectAddLabel(oldDefinition.getButtonSelectAddLabel());
          newDefinition.setButtonSelectRemoveLabel(oldDefinition.getButtonSelectRemoveLabel());
  
          Optional.ofNullable(oldDefinition.getField()) // nested composite fields should work with NoOpCompositeTransformer
                  .filter(info.magnolia.ui.form.field.definition.CompositeFieldDefinition.class::isInstance)
                  .map(info.magnolia.ui.form.field.definition.CompositeFieldDefinition.class::cast)
                  .map(info.magnolia.ui.form.field.definition.CompositeFieldDefinition::getTransformerClass)
                  .filter(NoOpCompositeTransformer.class::equals)
                  .ifPresent(noop -> oldDefinition.getField().setTransformerClass(DelegatingCompositeFieldTransformer.class));
  
          final EditorPropertyDefinition field = DefinitionConverter.FIELD.convert(oldDefinition.getField());
          if (newDefinition instanceof JcrMultiValueFieldDefinition) {
              final JcrPropertyProvider.Definition definition = new JcrPropertyProvider.Definition(oldDefinition.getName());
              definition.setMultiple(true);
              newDefinition.setItemProvider(definition);
              newDefinition.setField(field);
              convertTransformerStrategy(oldDefinition, newDefinition);
              ((JcrMultiValueFieldDefinition) newDefinition).init();
          } else {
              ComplexPropertyDefinition<Object> fieldToMultiFormEntryRelay;
  
              if (field instanceof ComplexPropertyDefinition) {
                fieldToMultiFormEntryRelay = (ComplexPropertyDefinition<Object>) field;
                // legacy dialog do not render the captions of the entry fields,
                // let them also be suppressed in converted variant
                if (field instanceof ConfiguredComplexPropertyDefinition) {
                    ((ConfiguredComplexPropertyDefinition) field).setLabel(null);
                }
             } else {
                 CompositeFieldDefinition<Object> adhocComposite = new CompositeFieldDefinition<>();
                 adhocComposite.setLayout(new SingleFieldLayoutProducer.Definition());
                 adhocComposite.setProperties(Collections.singletonList(field));
                 adhocComposite.setName(oldDefinition.getName());
                 adhocComposite.setLabel(null);
 
                 fieldToMultiFormEntryRelay = adhocComposite;
             }
 
             newDefinition.setField(fieldToMultiFormEntryRelay);
             convertTransformerStrategy(oldDefinition, newDefinition);
         }
         return newDefinition;
     }
 
     @Override
     MultiFieldDefinition createNewDefinition(MultiValueFieldDefinition oldDefinition) {
         return oldDefinition.getTransformerClass().equals(MultiValueTransformer.class)
                 || oldDefinition.getTransformerClass().equals(MultiValueChildNodeTransformer.class)
                 ? new JcrMultiValueFieldDefinition() : new JcrMultiFieldDefinition();
     }
 
     private void convertTransformerStrategy(info.magnolia.ui.form.field.definition.MultiValueFieldDefinition oldDefinition, MultiFieldDefinition<Node> newDefinition) {
         if (oldDefinition.getTransformerClass().equals(DelegatingMultiValueFieldTransformer.class)) {
             newDefinition.setItemProvider(new CurrentItemProviderDefinition<>());
         }
         if (oldDefinition.getTransformerClass().equals(DelegatingMultiValueSubnodeTransformer.class)) {
             JcrChildNodeProviderDefinition providerDefinition = new JcrChildNodeProviderDefinition();
             providerDefinition.setSupportI18N(false); // this ensures only one node is created for all (localized) sub nodes
             newDefinition.setItemProvider(providerDefinition);
             MultiFieldEntryResolution.Definition entryResolution = new MultiFieldEntryResolution.Definition();
             entryResolution.setPropertyNameDecorator(AlwaysEmptyPrefixNameDecorator.class);
             newDefinition.setEntryResolution(entryResolution);
         }
         if (oldDefinition.getTransformerClass().equals(MultiValueSubChildrenNodePropertiesTransformer.class)) {
             JcrChildNodeProviderDefinition providerDefinition = new JcrChildNodeProviderDefinition();
             providerDefinition.setSupportI18N(false);
             newDefinition.setItemProvider(providerDefinition);
             newDefinition.setEntryResolution(new ByLexicographicallyIndexedChildNodes.Definition());
             newDefinition.setOrderHandler(new LexicographicallyIndexedJcrNodeOrderHandler.Definition());
             Optional.ofNullable(newDefinition.getField()) // nested switchablefield doesn't use name prefixes here
                     .filter(CompositeFieldDefinition.class::isInstance)
                     .map(CompositeFieldDefinition.class::cast)
                     .map(CompositeFieldDefinition::getProperties)
                     .filter(properties -> !properties.isEmpty())
                     .map(properties -> properties.get(0))
                     .filter(ConfiguredSwitchableFieldDefinition.class::isInstance)
                     .map(ConfiguredSwitchableFieldDefinition.class::cast)
                     .ifPresent(switchable -> switchable.setPropertyNameDecorator(NoopNameDecorator.class));
         }
         if (oldDefinition.getTransformerClass().equals(MultiValueChildNodeTransformer.class)) {
             newDefinition.setItemProvider((ItemProviderDefinition) new MultiValueAsMultipleProperties.Definition());
         }
     }
 
     @Override
     protected boolean supportsTransformerClass(Class transformerClass) {
         return transformerClass.equals(MultiValueTransformer.class) ||
                 transformerClass.equals(DelegatingMultiValueFieldTransformer.class) ||
                 transformerClass.equals(DelegatingMultiValueSubnodeTransformer.class) ||
                 transformerClass.equals(MultiValueSubChildrenNodePropertiesTransformer.class) ||
                 transformerClass.equals(MultiValueChildNodeTransformer.class);
     }
 }