/**
    * 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.editor;
  
  import static info.magnolia.jcr.util.NodeUtil.getName;
  import static java.util.stream.Collectors.toList;
  
  import info.magnolia.config.NamedDefinition;
  import info.magnolia.jcr.predicate.AbstractPredicate;
  import info.magnolia.jcr.util.NodeUtil;
  import info.magnolia.objectfactory.ComponentProvider;
  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
  import info.magnolia.ui.field.ConfiguredComplexPropertyDefinition;
  import info.magnolia.ui.field.NoopNameDecorator;
  import info.magnolia.ui.field.WithPropertyNameDecorator;
  
  import java.util.List;
  import java.util.Locale;
  import java.util.Optional;
  import java.util.concurrent.CompletableFuture;
  import java.util.stream.Stream;
  import java.util.stream.StreamSupport;
  
  import javax.inject.Inject;
  import javax.jcr.Node;
  
  import com.machinezoo.noexception.Exceptions;
  
  import lombok.AllArgsConstructor;
  import lombok.EqualsAndHashCode;
  import lombok.Getter;
  import lombok.Setter;
  
  /**
   * Resolves multi-field entries based on indexed sub-nodes.
   */
  public abstract class ByIndexedChildNodes implements MultiFormView.EntryResolution<Node> {
  
      private static final String INCREMENT_REGEX = "(\\d{1,3})";
  
      private final I18NAuthoringSupport<Node> i18NAuthoringSupport;
  
      private final Locale locale;
  
      protected final info.magnolia.ui.editor.ByIndexedChildNodes.Definition definition;
  
      protected final NamedDefinition propertyDefinition;
  
      private final WithPropertyNameDecorator.PropertyNameDecorator propertyNameDecorator;
  
      @Inject
      public ByIndexedChildNodes(info.magnolia.ui.editor.ByIndexedChildNodes.Definition definition, NamedDefinition relatedPropertyDefinition, I18NAuthoringSupport<Node> i18NAuthoringSupport, ComponentProvider componentProvider, Locale locale) {
          this.definition = definition;
          this.propertyDefinition = relatedPropertyDefinition;
          this.i18NAuthoringSupport = i18NAuthoringSupport;
          this.locale = locale;
          this.propertyNameDecorator = componentProvider.newInstance(definition.propertyNameDecorator);
      }
  
      /**
       * @deprecated since 6.2.1, use {@link #ByIndexedChildNodes(Definition, NamedDefinition, I18NAuthoringSupport, ComponentProvider, Locale)} instead.
       */
      @Deprecated
      public ByIndexedChildNodes(NamedDefinition relatedPropertyDefinition, I18NAuthoringSupport<Node> i18NAuthoringSupport, ComponentProvider componentProvider, Locale locale) {
          this(new info.magnolia.ui.editor.ByIndexedChildNodes.Definition(), relatedPropertyDefinition, i18NAuthoringSupport, componentProvider, locale);
      }
  
      @Override
     public Stream<ComplexPropertyDefinition<Node>> resolveForRoot(Node rootNode) {
         List<Node> childItems = getChildNodes(rootNode, getEntryPropertyNameBase()).collect(toList());
         Stream.Builder<ComplexPropertyDefinition<Node>> collector = Stream.builder();
         for (int idx = 0; idx < childItems.size(); ++idx) {
             resolvePropertyDefinition(childItems.get(idx), idx).ifPresent(collector::add);
         }
         return collector.build();
     }
 
     protected String getEntryPropertyNameBase() {
         return this.propertyNameDecorator.apply(propertyDefinition.getName());
     }
 
     @Override
     public CompletableFuture<ComplexPropertyDefinition<Node>> pick() {
         return CompletableFuture.completedFuture(resolvePropertyDefinition(null, -1).orElse(null));
     }
 
     protected abstract Optional<EditorDefinition<Node>> resolveEntryEditorDefinition(Node item, int index);
 
     protected Optional<ConfiguredComplexPropertyDefinition<Node>> resolvePropertyDefinition(Node item, int index) {
         return resolveEntryEditorDefinition(item, index)
                 .map(entryEditorDefinition -> {
                     ConfiguredComplexPropertyDefinition<Node> property = new ConfiguredComplexPropertyDefinition.Wrapper<>(entryEditorDefinition);
                     ItemProviderDefinition<Node, Node> indexedItemProvider = resolveItemProvider(item, index);
                     property.setItemProvider(indexedItemProvider);
                     return property;
                 });
     }
 
     /**
      * @deprecated since 6.2.1
      */
     @Deprecated
     protected JcrIndexedChildNodeProvider.Definition resolveItemProvider(Node node, int index) {
         JcrIndexedChildNodeProvider.Definition indexedItemProvider = new JcrIndexedChildNodeProvider.Definition();
 
         indexedItemProvider.setIndex(index);
         indexedItemProvider.setNodeName(getEntryPropertyNameBase());
 
         return indexedItemProvider;
     }
 
     protected Stream<Node> getChildNodes(Node node, String name) {
         Iterable<Node> nodes = Exceptions.wrap().get(() ->
                 NodeUtil.getNodes(node, new info.magnolia.ui.editor.ByIndexedChildNodes.IndexedChildNodeNameRegexPredicate(name)));
 
         return StreamSupport.stream(nodes.spliterator(), false);
     }
 
     private String deriveLocaleAwareName(String name, Locale locale) {
         return i18NAuthoringSupport.deriveLocalisedPropertyName(name, locale);
     }
 
     @AllArgsConstructor
     private class IndexedChildNodeNameRegexPredicate extends AbstractPredicate<Node> {
 
         private final String baseName;
 
         private String getIndexedChildNodeRegexp(String name) {
             return name + INCREMENT_REGEX;
         }
 
         @Override
         public boolean evaluateTyped(Node node) {
             String childNodeNameRegex = getIndexedChildNodeRegexp(baseName);
             return getName(node).matches(localiseChildName(childNodeNameRegex, node));
         }
 
         private String localiseChildName(String targetChildNodeName, Node node) {
             if (locale != null &&
                     i18NAuthoringSupport.getDefaultLocale(node) != null &&
                     !i18NAuthoringSupport.isDefaultLocale(locale, node)) {
                 targetChildNodeName = deriveLocaleAwareName(targetChildNodeName, locale);
             }
             return targetChildNodeName;
         }
     }
 
     /**
      * Definition of {@link ByIndexedChildNodes}.
      */
     @Getter
     @Setter
     @EqualsAndHashCode(callSuper = true)
     public static class Definition extends MultiFormView.EntryResolution.Definition<Node> implements WithPropertyNameDecorator {
 
         private Class<? extends PropertyNameDecorator> propertyNameDecorator = NoopNameDecorator.class;
 
         public Definition() {
             setImplementationClass(ByIndexedChildNodes.class);
         }
 
         @Override
         public Class<? extends PropertyNameDecorator> getPropertyNameDecorator() {
             return propertyNameDecorator;
         }
 
         public void setPropertyNameDecorator(Class<? extends PropertyNameDecorator> propertyNameDecoratorClass) {
             this.propertyNameDecorator = propertyNameDecoratorClass;
         }
     }
 }