/**
    * This file Copyright (c) 2019-2020 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 info.magnolia.jcr.RuntimeRepositoryException;
  import info.magnolia.jcr.util.NodeNameHelper;
  import info.magnolia.jcr.util.NodeUtil;
  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
  
  import java.util.List;
  import java.util.Locale;
  import java.util.regex.Matcher;
  import java.util.regex.Pattern;
  
  import javax.inject.Inject;
  import javax.jcr.Item;
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  
  import org.apache.commons.lang3.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import com.google.common.collect.Lists;
  
  /**
   * Arranges provided JCR nodes according to their order, renames them so that
   * the node names reflect the indices correctly.
   */
  public class DefaultJcrNodeOrderHandler implements MultiFormDefinition.OrderHandler<Node> {
  
      private static final Logger log = LoggerFactory.getLogger(DefaultJcrNodeOrderHandler.class);
  
      private static final Pattern INDEX_PATTERN = Pattern.compile("(?<name>.*?)(?<index>\\d+)(?<i18n>_[a-z]{2})?");
      private static final String TMP_NAME_PREFIX = "__TMP_NAME_PREFIX";
  
      private final I18NAuthoringSupport<Item> i18NAuthoringSupport;
      private final NodeNameHelper nodeNameHelper;
      private final Locale locale;
  
      @Inject
      public DefaultJcrNodeOrderHandler(I18NAuthoringSupport<Item> i18NAuthoringSupport,
                                        Locale locale,
                                        NodeNameHelper nodeNameHelper) {
          this.i18NAuthoringSupport = i18NAuthoringSupport;
          this.locale = locale;
          this.nodeNameHelper = nodeNameHelper;
      }
  
      @Override
      public void applyOrder(List<Node> nodeOrder) {
          if (nodeOrder.isEmpty()) {
              return;
          }
  
          try {
              Node parent = nodeOrder.get(0).getParent();
  
              for (int idx = 0; idx < nodeOrder.size(); ++idx) {
                  Node node = nodeOrder.get(idx);
                  Matcher indexedNameMatcher = INDEX_PATTERN.matcher(node.getName());
                  if (indexedNameMatcher.matches()) {
                      String name = createIndexedName(indexedNameMatcher.group("name"), idx);
                      if (i18NAuthoringSupport.getDefaultLocale(node) != null && !i18NAuthoringSupport.isDefaultLocale(locale, node)) {
                          name = i18NAuthoringSupport.deriveLocalisedPropertyName(name, locale);
                      }
  
                      node.getSession().move(node.getPath(), getParentPathWithSlash(node) + TMP_NAME_PREFIX + name);
                 } else {
                     log.warn("Node name [{}] mentions no index, node is ignored by [{}]", node.getName(), DefaultJcrNodeOrderHandler.class.getName());
                 }
             }
 
             for (Node node : Lists.newArrayList(NodeUtil.getNodes(parent))) {
                 String nodeName = node.getName();
                 if (nodeName.startsWith(TMP_NAME_PREFIX)) {
                     String parentPath = getParentPathWithSlash(node);
                     node.getSession().move(
                             parentPath + nodeName,
                             parentPath + nodeName.substring(TMP_NAME_PREFIX.length()));
                 }
             }
 
         } catch (RepositoryException e) {
             throw new RuntimeRepositoryException(e);
         }
     }
 
     protected String createIndexedName(String name, int idx) {
         return name + idx;
     }
 
     private String getParentPathWithSlash(Node node) throws RepositoryException {
         return StringUtils.appendIfMissing(node.getParent().getPath(), "/");
     }
 
     /**
      * Definition of {@link DefaultJcrNodeOrderHandler}.
      */
     public static class Definition extends MultiFormDefinition.OrderHandlerDefinition<Node> {
 
         public Definition() {
             setImplementationClass(DefaultJcrNodeOrderHandler.class);
         }
     }
 }