/**
    * 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.field;
  
  import info.magnolia.ui.editor.ByIndexedChildNodes;
  import info.magnolia.ui.editor.CurrentItemProviderDefinition;
  import info.magnolia.ui.editor.DefaultJcrNodeOrderHandler;
  import info.magnolia.ui.editor.ItemProviderDefinition;
  import info.magnolia.ui.editor.JcrChildNodeProviderDefinition;
  import info.magnolia.ui.editor.MultiFieldEntryResolution;
  import info.magnolia.ui.editor.MultiFormView;
  
  import javax.jcr.Node;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Default pre-configured definition of JCR multi-fields.
   */
  @FieldType("jcrMultiField")
  public class JcrMultiFieldDefinition extends MultiFieldDefinition<Node> {
  
      private static final Logger log = LoggerFactory.getLogger(JcrMultiFieldDefinition.class);
  
      public JcrMultiFieldDefinition() {
          setEntryResolution(new MultiFieldEntryResolution.Definition());
          setOrderHandler(new DefaultJcrNodeOrderHandler.Definition());
          setItemProvider(new JcrChildNodeProviderDefinition());
          setCanRemoveItems(true);
      }
  
      /**
       * <pre>
       * This is to ensure backwards compatibility for two cases:
       * - when a user already configured multi field with {@link info.magnolia.ui.editor.CurrentItemProvider}, but uses
       * {@link ByIndexedChildNodes.Definition} the resolving of nodes will be set {@link
       * ByIndexedChildNodes.Definition#setStrict(boolean)} to false, because otherwise other non-multi related nodes
       * would be resolved as multis, resulting in errors and possibly overwritten non-multi related data.
       * - when {@link JcrChildNodeProviderDefinition#isSupportI18N()} is false, because that configuration flattens
       * localized multi parent nodes into a single parent and then you have to resolve child nodes respecting their
       * locale suffix, which wouldn't happen when strict is false (it would resolve everything beneath the parent for any
       * locale. This is to support compatibility of non-ported transformer classes like
       * MultiValueSubChildrenNodePropertiesTransformer and DelegatingMultiValueSubnodeTransformer.
       * </pre>
       */
      @Deprecated
      private void safeguardAgainstIncompatibleCombination(ItemProviderDefinition itemProvider, MultiFormView.EntryResolution.Definition<Node> entryResolution) {
          if (entryResolution instanceof ByIndexedChildNodes.Definition) {
              ByIndexedChildNodes.Definition def = (ByIndexedChildNodes.Definition) entryResolution;
              if (itemProvider instanceof JcrChildNodeProviderDefinition) {
                  if (((JcrChildNodeProviderDefinition) itemProvider).isSupportI18N()) {
                      if (def.isStrict()) {
                          def.setStrict(false);
                          throw new IllegalStateException("Falling back to non-strict entry resolution. All nodes in its localized parent are resolved, regardless of their node names. Set strictness resolution to false to remove this problem.");
                      }
                  } else {
                      if (!def.isStrict()) {
                          def.setStrict(true);
                          throw new IllegalStateException("Falling back to strict mode entry resolution, to be able to distinguish multi field entries by locale. Reason: supporti18n is set to false which means entries of different locales share parent. Set entry resolution to strict manually to remove this problem.");
                      }
                  }
              } else if (itemProvider instanceof CurrentItemProviderDefinition) {
                  if (!def.isStrict()) {
                      def.setStrict(true);
                      throw new IllegalStateException("Falling back to strict mode entry resolution, to be able to " +
                              "distinguish multi field entries. Reason: CurrentItemProvider is used in multi which means " +
                              "entries are stored without a parent adjacent to nodes that are not related to this multi " +
                             "field. Non-strict resolution could result in overwriting of non-multi field related nodes." +
                             "Set entry resolution definition to strict manually, to remove this problem.");
                 }
             }
         }
     }
 
     public void init() {
         safeguardAgainstIncompatibleCombination(getItemProvider(), getEntryResolution());
     }
 }