/**
    * This file Copyright (c) 2013-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.setup.for5_0;
  
  import info.magnolia.jcr.util.NodeTypes;
  
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.List;
  
  import javax.jcr.RepositoryException;
  import javax.jcr.nodetype.NodeDefinition;
  import javax.jcr.nodetype.NodeType;
  import javax.jcr.nodetype.NodeTypeDefinition;
  import javax.jcr.nodetype.NodeTypeIterator;
  import javax.jcr.nodetype.NodeTypeManager;
  import javax.jcr.nodetype.NodeTypeTemplate;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Remove metaData nodeType's defined as 'childNodeDefinition' for all registered nodeType that still define this dependency.<br>
   * Create a list of registered nodeTypes that have metaData nodeType as 'childNodeDefinition'.<br>
   * This list is then return by {@link info.magnolia.setup.nodetype.AbstractNodeTypeRegistrationTask#getNodeTypesToRegister(NodeTypeManager)} and handled as an update of nodeType.
   */
  public class RemoveMetaDataInNodeTypeDefinitionTask extends info.magnolia.setup.nodetype.AbstractNodeTypeRegistrationTask {
  
      private final Logger log = LoggerFactory.getLogger(RemoveMetaDataInNodeTypeDefinitionTask.class);
  
      public RemoveMetaDataInNodeTypeDefinitionTask(String name, String description, String workspaceName) {
          super(name, description, workspaceName);
      }
  
      /**
       * Return a {@link NodeTypeDefinition} list where the metaData child node definition has been removed.
       */
      @Override
      public List<NodeTypeDefinition> getNodeTypesToRegister(NodeTypeManager nodeTypeManager) {
          List<NodeTypeDefinition> list = new ArrayList<NodeTypeDefinition>();
          try {
              NodeTypeIterator iterator = nodeTypeManager.getAllNodeTypes();
              while (iterator.hasNext()) {
                  NodeType nodeType = iterator.nextNodeType();
                  if (nodeType.getDeclaredChildNodeDefinitions() != null) {
                      // check if this type define metaData as child
                      List<NodeDefinition> childNodeDefinition = Arrays.asList(nodeType.getDeclaredChildNodeDefinitions());
                      for (NodeDefinition nodeDefinition : childNodeDefinition) {
  
                          if (nodeDefinition.getDefaultPrimaryType() != null && NodeTypes.MetaData.NAME.equals(nodeDefinition.getDefaultPrimaryType().getName())) {
                              NodeTypeTemplate newNodeType = createNodeTypeWithoutMetaData(nodeTypeManager, nodeType, nodeDefinition);
                              log.info("Add the following NodeType '{}' that currently defined a metaData nodeType as child node to the list.", newNodeType.getName());
                              list.add(newNodeType);
                              break;
                          }
                      }
                  }
              }
          } catch (RepositoryException e) {
              log.error("Could not create a List of existing NodeTpe declaring metaData as childNodeDefinition", e);
          }
  
          return list;
      }
  
      @Override
      public List<String> getNodeTypesToUnregister(NodeTypeManager nodeTypeManager) {
          return null;
     }
 
     /**
      * Create a new {@link NodeTypeTemplate} copy of the 'nodeType', but without <br>
      * metaData defined as 'childNodeDefinition'.
      */
     private NodeTypeTemplate createNodeTypeWithoutMetaData(NodeTypeManager nodeTypeManager, NodeType nodeType, NodeDefinition metaDataNode) throws RepositoryException {
         NodeTypeTemplate ntt = nodeTypeManager.createNodeTypeTemplate();
         ntt.setDeclaredSuperTypeNames(nodeType.getDeclaredSupertypeNames());
         ntt.setMixin(nodeType.isMixin());
         ntt.setName(nodeType.getName());
         ntt.setOrderableChildNodes(nodeType.hasOrderableChildNodes());
         ntt.setPrimaryItemName(nodeType.getPrimaryItemName());
         ntt.setQueryable(nodeType.isQueryable());
         ntt.getPropertyDefinitionTemplates().addAll(Arrays.asList(nodeType.getDeclaredPropertyDefinitions()));
         List<NodeDefinition> childNodeDefinition = new ArrayList<NodeDefinition>();
         childNodeDefinition.addAll(Arrays.asList(nodeType.getDeclaredChildNodeDefinitions()));
         childNodeDefinition.remove(metaDataNode);
         ntt.getNodeDefinitionTemplates().addAll(childNodeDefinition);
         return ntt;
     }
 }