/**
    * This file Copyright (c) 2018 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.editor;
  
  import static java.util.stream.Collectors.*;
  
  import info.magnolia.objectfactory.Components;
  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
  import info.magnolia.ui.contentapp.configuration.column.ColumnDefinition;
  import info.magnolia.ui.field.FieldDefinition;
  import info.magnolia.ui.field.NoopNameDecorator;
  import info.magnolia.ui.field.WithPropertyNameDecorator.PropertyNameDecorator;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.List;
  import java.util.Locale;
  import java.util.Map;
  import java.util.Optional;
  import java.util.stream.Stream;
  
  import javax.jcr.Item;
  import javax.jcr.Node;
  
  import com.machinezoo.noexception.Exceptions;
  import com.vaadin.data.PropertyDefinition;
  import com.vaadin.data.PropertySet;
  import com.vaadin.data.ValueProvider;
  import com.vaadin.server.Setter;
  
  import lombok.Data;
  import lombok.extern.slf4j.Slf4j;
  
  
  /**
   * Describes a set of JCR properties that can be used for configuration based on
   * {@link JcrPropertyDescriptor}. Supports both JCR nodes and properties.
   *
   * In order to not clutter this class logic, the actual interaction with JCR items is
   * delegated to {@link JcrItemInteractionStrategy} (provides separate implementation
   * for nodes and properties).
   */
  @Slf4j
  public class JcrItemPropertySet implements PropertySet<Item> {
  
      /**
       * Initialise JCR property set based on a simple map of
       * property names mapped to their types.
       *
       * @param properties property names mapped to their respective types
       * @deprecated since 6.2.4. Use {@link JcrItemPropertySet#JcrItemPropertySet(java.util.List, info.magnolia.ui.api.i18n.I18NAuthoringSupport)} instead.
       */
      @Deprecated
      public static JcrItemPropertySet withProperties(Map<String, Class> properties) {
          List<JcrItemPropertySet.JcrPropertyDescriptor> propertyDescriptors = properties.entrySet().stream()
                  .map(entry -> JcrPropertyDescriptor.builder()
                          .type(entry.getValue())
                          .name(entry.getKey())
                          .build())
                  .collect(toList());
  
          return new JcrItemPropertySet(propertyDescriptors, Components.getComponent(I18NAuthoringSupport.class));
      }
  
      /**
       * Initialise JCR property set based on list of column definitions.
       * Useful for grid row editors.
       *
      * @param columnDefinitions list of column definitions used as property set source
      * @deprecated since 6.2.4. Use {@link JcrItemPropertySet#JcrItemPropertySet(java.util.List, info.magnolia.ui.api.i18n.I18NAuthoringSupport)} instead.
      */
     @Deprecated
     public static <T> PropertySet<Item> fromColumns(List<ColumnDefinition<T>> columnDefinitions) {
         return withProperties(columnDefinitions.stream().collect(toMap(ColumnDefinition::getName, ColumnDefinition::getType)));
     }
 
     /**
      * Initialise JCR property set based on list of field definitions definitions.
      * Useful for grid row editors.
      *
      * @param fieldDefinitions list of column definitions used as property set source
      */
     public static PropertySet<Item> fromFieldDefinitions(Collection<FieldDefinition> fieldDefinitions, Locale locale) {
         //noinspection unchecked
         return new JcrItemPropertySet(fieldDefinitions.stream()
                 .map(fieldDefinition -> JcrPropertyDescriptor
                         .builder()
                         .name(fieldDefinition.getName())
                         .isReadonly(fieldDefinition.isReadOnly())
                         .type(fieldDefinition.getType())
                         .build())
                 .collect(toList()), locale, Components.getComponent(I18NAuthoringSupport.class), null);
     }
 
     private final List<PropertyDefinition<Item, ?>> knownProperties = new ArrayList<>();
     private final Locale locale;
     private final I18NAuthoringSupport<Item> genericLocalisationSupport;
     private final PropertyNameDecorator propertyNameDecorator;
 
     public JcrItemPropertySet(List<JcrPropertyDescriptor> knownProperties, I18NAuthoringSupport<Item> genericLocalisationSupport) {
         this(knownProperties, null, genericLocalisationSupport, new NoopNameDecorator());
     }
 
     public JcrItemPropertySet(List<JcrPropertyDescriptor> knownProperties, Locale locale, I18NAuthoringSupport<Item> genericLocalisationSupport) {
         this(knownProperties, locale, genericLocalisationSupport, new NoopNameDecorator());
     }
 
     public JcrItemPropertySet(List<JcrPropertyDescriptor> knownProperties, Locale locale, I18NAuthoringSupport<Item> genericLocalisationSupport, PropertyNameDecorator propertyNameDecorator) {
         this.locale = locale;
         this.genericLocalisationSupport = genericLocalisationSupport;
         this.propertyNameDecorator = propertyNameDecorator;
         //noinspection unchecked
         knownProperties.forEach(property -> this.knownProperties.add(new JcrItemPropertyDefinition<>(this, property)));
     }
 
     @Override
     public Stream<PropertyDefinition<Item, ?>> getProperties() {
         return knownProperties.stream();
     }
 
     @Override
     public Optional<PropertyDefinition<Item, ?>> getProperty(String name) {
         return Optional.of(knownProperties.stream()
                 .filter(def -> def.getName().equals(name))
                 .findFirst()
                 .orElse(getDecoratedProperty(name)));
     }
 
     private PropertyDefinition<Item, ?> getDecoratedProperty(String name) {
         return Optional.of(knownProperties.stream()
                 .filter(def -> def.getName().equals(propertyNameDecorator.apply(name)))
                 .findFirst()
                 .orElse(new JcrItemPropertyDefinition<>(this, JcrItemPropertySet.JcrPropertyDescriptor.builder()
                         .type(Object.class)
                         .name(name)
                         .build()))).get();
     }
 
     /**
      * Jcr property descriptor.
      *
      * @param <T> property type
      */
     @Data
     public static class JcrPropertyDescriptor<T> {
         private Class<T> type;
         private String name;
         private String nodeNameProperty;
         private boolean isReadonly;
         private boolean isI18n;
         private Locale locale;
         private PropertyNameDecorator propertyNameDecorator = new NoopNameDecorator();
 
         public JcrPropertyDescriptor() {
         }
 
         JcrPropertyDescriptor(Class<T> type, String name, boolean isReadonly, boolean isI18n, Locale locale, PropertyNameDecorator propertyNameDecorator, String nodeNameProperty) {
             this.type = type;
             this.name = name;
             this.isReadonly = isReadonly;
             this.isI18n = isI18n;
             this.locale = locale;
             this.nodeNameProperty = nodeNameProperty;
             if (propertyNameDecorator != null) {
                 this.propertyNameDecorator = propertyNameDecorator;
             }
         }
 
         public static <T> JcrPropertyDescriptorBuilder<T> builder() {
             return new JcrPropertyDescriptorBuilder<T>();
         }
 
         public String getName() {
             return this.propertyNameDecorator.apply(this.name);
         }
 
         /**
          * @deprecated since 6.2.4, use {@link FormView#applyDefaults()} to facilitate default values.
          */
         @Deprecated
         public void setDefaultValue(T defaultValue) {
             log.warn("JcrPropertyDescriptor#setDefaultValue is deprecated since 6.2.4, doesn't keep the default value");
         }
 
         /**
          * @deprecated since 6.2.4, use {@link FormView#applyDefaults()} to facilitate default values.
          */
         @Deprecated
         public T getDefaultValue() {
             log.warn("JcrPropertyDescriptor#getDefaultValue is deprecated since 6.2.4, doesn't keep the default value configuration and returns null");
             return null;
         }
 
         /**
          * Builder type for {@link JcrPropertyDescriptor}.
          *
          * @param <T>
          *      property type
          */
         public static class JcrPropertyDescriptorBuilder<T> {
             private Class<T> type;
             private String name;
             private boolean isReadonly;
             private boolean isI18n;
             private Locale locale;
             private PropertyNameDecorator propertyNameDecorator;
             private String nodeNameProperty;
 
             JcrPropertyDescriptorBuilder() {
             }
 
             public JcrPropertyDescriptorBuilder<T> type(Class<T> type) {
                 this.type = type;
                 return this;
             }
 
             public JcrPropertyDescriptorBuilder<T> name(String name) {
                 this.name = name;
                 return this;
             }
 
             public JcrPropertyDescriptorBuilder<T> isReadonly(boolean isReadonly) {
                 this.isReadonly = isReadonly;
                 return this;
             }
 
             public JcrPropertyDescriptorBuilder<T> isI18n(boolean isI18n) {
                 this.isI18n = isI18n;
                 return this;
             }
 
             public JcrPropertyDescriptorBuilder<T> locale(Locale locale) {
                 this.locale = locale;
                 return this;
             }
 
             public JcrPropertyDescriptorBuilder<T> propertyNameDecorator(PropertyNameDecorator propertyNameDecorator) {
                 this.propertyNameDecorator = propertyNameDecorator;
                 return this;
             }
 
             public JcrPropertyDescriptorBuilder<T> nodeNameProperty(String nodeNameProperty) {
                 this.nodeNameProperty = nodeNameProperty;
                 return this;
             }
 
             /**
              * @deprecated since 6.2.4, use {@link FormView#applyDefaults()} to facilitate default values.
              */
             @Deprecated
             public JcrPropertyDescriptorBuilder<T> defaultValue(String ignoredDefaultValue) {
                 return this;
             }
 
             public JcrPropertyDescriptor<T> build() {
                 return new JcrPropertyDescriptor<T>(type, name, isReadonly, isI18n, locale, propertyNameDecorator, nodeNameProperty);
             }
 
             public String toString() {
                 return "JcrItemPropertySet.JcrPropertyDescriptor.JcrPropertyDescriptorBuilder(type=" + this.type + ", name=" + this.name + ", isReadonly=" + this.isReadonly + ", isI18n=" + this.isI18n + ", locale=" + this.locale + ", propertyNameDecorator=" + this.propertyNameDecorator + ", nodeNameProperty=" + this.nodeNameProperty + ")";
             }
         }
     }
 
 
     /**
      * Wrapper utility for JCR property descriptors.
      *
      * @param <T>
      *     item type
      */
     class JcrPropertyDescriptorWrapper<T> extends JcrPropertyDescriptor<T> {
 
         private JcrPropertyDescriptor<T> delegate;
 
         public JcrPropertyDescriptorWrapper(JcrPropertyDescriptor<T> delegate) {
             this.delegate = delegate;
         }
 
         @Override
         public Class<T> getType() {
             return delegate.getType();
         }
 
         @Override
         public void setType(Class<T> type) {
             delegate.setType(type);
         }
 
         @Override
         public String getName() {
             return delegate.getName();
         }
 
         @Override
         public void setName(String name) {
             delegate.setName(name);
         }
 
         @Override
         public boolean isReadonly() {
             return delegate.isReadonly();
         }
 
         @Override
         public void setReadonly(boolean isReadonly) {
             delegate.setReadonly(isReadonly);
         }
 
         @Override
         public boolean isI18n() {
             return delegate.isI18n();
         }
 
         @Override
         public void setI18n(boolean isI18n) {
             delegate.setI18n(isI18n);
         }
 
         @Override
         public Locale getLocale() {
             return delegate.getLocale();
         }
 
         @Override
         public void setLocale(Locale locale) {
             delegate.setLocale(locale);
         }
 
         @Override
         public PropertyNameDecorator getPropertyNameDecorator() {
             return delegate.getPropertyNameDecorator();
         }
 
         @Override
         public void setPropertyNameDecorator(PropertyNameDecorator propertyNameDecorator) {
             delegate.setPropertyNameDecorator(propertyNameDecorator);
         }
 
         @Override
         public String getNodeNameProperty() {
             return delegate.getNodeNameProperty();
         }
 
         @Override
         public void setNodeNameProperty(String nodeNameProperty) {
             delegate.setNodeNameProperty(nodeNameProperty);
         }
     }
 
     /**
      * Wraps a delegate property descriptor and may append a locale
      * suffix depending on the node property interacts with and the
      * locale settings of the related property set.
      *
      * @param <T>
      *     item type
      */
     class LocalisedJcrPropertyDescriptor<T> extends JcrPropertyDescriptorWrapper<T> {
 
         private final Node relatedNode;
 
         LocalisedJcrPropertyDescriptor(JcrPropertyDescriptor<T> delegate, Node relatedNode) {
             super(delegate);
             this.relatedNode = relatedNode;
         }
 
         @Override
         public String getName() {
             return getName(relatedNode);
         }
 
         public String getName(Node node) {
             if (locale != null &&
                     isI18n() &&
                     !genericLocalisationSupport.isDefaultLocale(locale, node)) {
                 return genericLocalisationSupport.deriveLocalisedPropertyName(super.getName(), locale);
             }
             return super.getName();
         }
     }
 
     /**
      * Connects JCR node to a PropertySet's property definitions.
      * Getters and setters are delegated to JCR via {@link JcrItemInteractionStrategy}.
      *
      * @param <V>
      *     property value type
      */
     private class JcrItemPropertyDefinition<V> implements PropertyDefinition<Item, V> {
 
         private final PropertySet<Item> propertySet;
         private final JcrItemPropertySet.JcrPropertyDescriptor<V> descriptor;
 
         private JcrItemPropertyDefinition(PropertySet<Item> propertySet, JcrPropertyDescriptor<V> descriptor) {
             this.propertySet = propertySet;
             this.descriptor = descriptor;
         }
 
         @Override
         public ValueProvider<Item, V> getGetter() {
             return item -> {
                 JcrPropertyDescriptor<V> descriptor = this.descriptor;
                 if (item.isNode()) {
                     descriptor = new LocalisedJcrPropertyDescriptor<>(descriptor, (Node) item);
                 }
                 return JcrItemInteractionStrategy.get(item).get(item, descriptor);
             };
         }
 
         @Override
         public Optional<Setter<Item, V>> getSetter() {
             return Optional.of((Setter<Item, V>) (Item item, V value) -> {
                 JcrPropertyDescriptor<V> descriptor = this.descriptor;
                 if (item.isNode()) {
                     descriptor = new LocalisedJcrPropertyDescriptor<>(descriptor, (Node) item);
                 }
 
                 boolean isPropertyUpdatePermitted = !descriptor.isReadonly;
 
                 if (!isPropertyUpdatePermitted && item.isNode()) {
                     Node asNode = (Node) item;
                     String propertyName = descriptor.getName();
                     // the field is marked as read-only, but the target node doesn't have the property at all
                     isPropertyUpdatePermitted = !Exceptions.wrap().get(() -> asNode.hasProperty(propertyName));
                 }
 
                 if (isPropertyUpdatePermitted) {
                     JcrItemInteractionStrategy.get(item).set(item, value, descriptor);
                 }
             });
         }
 
         @Override
         public Class<V> getType() {
             return descriptor.getType();
         }
 
         @Override
         public Class<?> getPropertyHolderType() {
             return Node.class;
         }
 
         @Override
         public String getName() {
             return descriptor.getName();
         }
 
         @Override
         public String getCaption() {
             return descriptor.getName();
         }
 
         @Override
         public PropertySet<Item> getPropertySet() {
             return propertySet;
         }
     }
 }