/**
    * This file Copyright (c) 2009-2013 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.module.templatingkit.sites;
  
  import info.magnolia.context.MgnlContext;
  import info.magnolia.jcr.util.MetaDataUtil;
  import info.magnolia.module.templatingkit.templates.category.TemplateCategory;
  import info.magnolia.module.templatingkit.templates.category.TemplateCategoryUtil;
  import info.magnolia.module.templatingkit.templates.pages.STKPage;
  import info.magnolia.repository.RepositoryConstants;
  
  import java.util.Collection;
  import java.util.LinkedHashMap;
  import java.util.Map;
  
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  import javax.jcr.Workspace;
  
  import org.apache.commons.collections.CollectionUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  
  /**
   * Wrapper class containing the list of available templates.
   * It contains also the hierarchy of content for site creation:
   * Root can only be Home or functional, can not add a Root to a Root, .....
   */
  public class TemplateAvailability {
  
      private static final Logger log = LoggerFactory.getLogger(TemplateAvailability.class);
  
      private final Map<String, TemplateConfig> templates = new LinkedHashMap<String, TemplateConfig>();
  
      public Map<String, TemplateConfig> getTemplates() {
          return this.templates;
      }
  
      public void addTemplate(String name, TemplateConfig templateConfig) {
          templates.put(templateConfig.getId(), templateConfig);
      }
  
      public boolean isAvailable(Node node, STKPage template) {
  
          Workspace workspace;
          try {
              workspace = node.getSession().getWorkspace();
              if(!RepositoryConstants.WEBSITE.equals(workspace.getName())){
                  return false;
              }
          } catch (RepositoryException e) {
              log.error("Not able to access the Node's session or workspace.", e);
              return false;
          }
          if (!getTemplates().containsKey(template.getId())) {
              return false;
          }
          TemplateConfig templateConfig = getTemplates().get(template.getId());
  
          // check roles
          final Collection<String> roles = templateConfig.getRoles();
          if(!roles.isEmpty()){
              if(!CollectionUtils.containsAny(MgnlContext.getUser().getAllRoles(), roles)){
                  return false;
              }
          }
  
         try {
             // only home or functional can be the root node
             final String category = template.getCategory();
             if(node.getDepth() == 1){
                 return category.equals(TemplateCategory.HOME) || category.equals(TemplateCategory.FUNCTIONAL);
             }
             // section and functional pages are structural pages
             final String parentTemplateCategory = TemplateCategoryUtil.getTemplateCategory(node.getParent());
             //if home category was already used it should be no longer available
             if(category.equals(TemplateCategory.HOME) && TemplateCategoryUtil.findParentWithTemplateCategory(node, TemplateCategory.HOME) != null){
                 return false;
             }
             if(category.equals(TemplateCategory.SECTION) || category.equals(TemplateCategory.HOME) || category.equals(TemplateCategory.FUNCTIONAL)){
                 return parentTemplateCategory.equals(TemplateCategory.HOME) || parentTemplateCategory.equals(TemplateCategory.SECTION) || parentTemplateCategory.equals(TemplateCategory.FEATURE) || parentTemplateCategory.equals(TemplateCategory.FUNCTIONAL);
             }
             // only section pages can have content
             if(category.equals(TemplateCategory.CONTENT)){
                 return parentTemplateCategory.equals(TemplateCategory.SECTION) || parentTemplateCategory.equals(TemplateCategory.CONTENT) || parentTemplateCategory.equals(TemplateCategory.FEATURE) || parentTemplateCategory.equals(TemplateCategory.FUNCTIONAL);
             }
             if(category.equals(TemplateCategory.FEATURE)){
                 if("form".equals(template.getSubcategory())){
                     //stkFormStep is available only as child of form
                     if("stkFormStep".equals(template.getName())) {
                         return node.getParent() != null && MetaDataUtil.getTemplate(node.getParent()).endsWith("stkForm");
                     }
                 }
                 return true;
             }
         }
         catch (RepositoryException e) {
             throw new IllegalStateException("Can't verify availability of the template", e);
         }
         return false;
     }
 }