/**
    * This file Copyright (c) 2016-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;
  
  import static info.magnolia.jcr.util.NodeTypeTemplateUtil.createNodeType;
  
  import info.magnolia.jcr.util.NodeTypes;
  import info.magnolia.setup.nodetype.AbstractNodeTypeRegistrationTask;
  
  import java.util.Collections;
  import java.util.List;
  
  import javax.jcr.PropertyType;
  import javax.jcr.RepositoryException;
  import javax.jcr.nodetype.NodeTypeDefinition;
  import javax.jcr.nodetype.NodeTypeManager;
  import javax.jcr.nodetype.NodeTypeTemplate;
  import javax.jcr.nodetype.PropertyDefinitionTemplate;
  import javax.jcr.version.OnParentVersionAction;
  
  import org.apache.jackrabbit.JcrConstants;
  
  import com.google.common.collect.Lists;
  
  /**
   * Adds lockable mixin {@link JcrConstants#MIX_LOCKABLE} to the {@link info.magnolia.jcr.util.NodeTypes.Versionable} node type.
   */
  public class AddLockableMixinToVersionableMixinTask extends AbstractNodeTypeRegistrationTask {
  
      public AddLockableMixinToVersionableMixinTask(String name, String description, String workspaceName) {
          super(name, description, workspaceName);
      }
  
      @Override
      public List<NodeTypeDefinition> getNodeTypesToRegister(NodeTypeManager nodeTypeManager) throws RepositoryException {
          List<PropertyDefinitionTemplate> properties = Lists.newArrayList(
                  createPropertyDefinitionTemplate(nodeTypeManager, "mgnl:comment", "String", false, false, "COPY", false, false));
  
          NodeTypeDefinition ntd = createNodeTypeWithProperties(nodeTypeManager, NodeTypes.Versionable.NAME,
                  new String[]{JcrConstants.MIX_LOCKABLE}, true, false, null, false, properties);
          return Collections.singletonList(ntd);
      }
  
      @Override
      public List<String> getNodeTypesToUnregister(NodeTypeManager nodeTypeManager) throws RepositoryException {
          return Lists.newArrayList();
      }
  
      /**
       * Create a {@link NodeTypeTemplate} by using a {@link javax.jcr.nodetype.NodeType definition}.
       * This method is takes {@link PropertyDefinitionTemplate}s into consideration as well.
       */
      private NodeTypeTemplate createNodeTypeWithProperties(NodeTypeManager nodeTypeManager, String name, String[] superTypeNames, boolean isMixin, boolean isOrderableChildNodes, String primaryItemName, boolean isQueryable, List<PropertyDefinitionTemplate> properties) throws RepositoryException {
          NodeTypeTemplate nodeType = createNodeType(nodeTypeManager, name, superTypeNames, isMixin, isOrderableChildNodes, primaryItemName, isQueryable);
          nodeType.getPropertyDefinitionTemplates().addAll(properties);
  
          return nodeType;
      }
  
      /**
       * Creates a {@link PropertyDefinitionTemplate} for given parameters.
       */
      private PropertyDefinitionTemplate createPropertyDefinitionTemplate(NodeTypeManager nodeTypeManager, String name,
                                                                          String type, boolean isAutoCreated,
                                                                          boolean isMandatory, String onParentVersion,
                                                                          boolean isProtected, boolean isMultiple) throws RepositoryException {
          PropertyDefinitionTemplate template = nodeTypeManager.createPropertyDefinitionTemplate();
          template.setName(name);
         template.setRequiredType(PropertyType.valueFromName(type));
         template.setAutoCreated(isAutoCreated);
         template.setMandatory(isMandatory);
         template.setOnParentVersion(OnParentVersionAction.valueFromName(onParentVersion));
         template.setProtected(isProtected);
         template.setMultiple(isMultiple);
         return template;
     }
 }