/**
    * This file Copyright (c) 2008-2011 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.templates.components;
  
  
  import info.magnolia.cms.beans.config.ContentRepository;
  import info.magnolia.context.MgnlContext;
  import info.magnolia.jcr.util.NodeUtil;
  import info.magnolia.jcr.util.PropertyUtil;
  import info.magnolia.module.templatingkit.functions.STKTemplatingFunctions;
  import info.magnolia.module.templatingkit.templates.AbstractSTKTemplateModel;
  import info.magnolia.module.templatingkit.templates.category.TemplateCategory;
  import info.magnolia.module.templatingkit.util.STKPager;
  import info.magnolia.rendering.model.RenderingModel;
  import info.magnolia.rendering.template.TemplateDefinition;
  import info.magnolia.templating.functions.TemplatingFunctions;
  
  import java.util.Collection;
  import java.util.List;
  
  import javax.inject.Inject;
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  
  import org.apache.commons.lang.StringUtils;
  
  
  
  /**
   * Abstract STK Rendable definition dedicated to Content list manipulation.
   *
   * @author cringele
   * @version $Id$
   * @param <RD>
   */
  
  public abstract class AbstractItemListModel<RD extends TemplateDefinition> extends AbstractSTKTemplateModel<TemplateDefinition> {
  
      @Inject
      public AbstractItemListModel(Node content, RD definition, RenderingModel< ? > parent, STKTemplatingFunctions stkFunctions, TemplatingFunctions templatingFunctions) {
          super(content, definition, parent, stkFunctions, templatingFunctions);
      }
  
      /**
       * FIXME usage of deprecated classes: {@link ContentRepository}.
       */
      protected String getRepository() {
          return ContentRepository.WEBSITE;
      }
  
      protected String getCategoryName() {
          return StringUtils.defaultString((String) definition.getParameters().get("searchForCategory"), TemplateCategory.CONTENT);
      }
  
      protected String getSubcategoryName() {
          return (String) definition.getParameters().get("searchForSubcategory");
      }
  
      abstract protected int getMaxResults();
  
  
      protected Node getSearchRoot() throws RepositoryException {
          // Default value as searchRoot is the site root
          Node siteRoot = getSiteRoot();
  
          // "getConstrainedSearchRoot()" provides the possibility to define a manually chosen sub node
          // as search root.
          Node constrainedSearchRoot = getConstrainedSearchRoot();
         if (constrainedSearchRoot != null) {
             return constrainedSearchRoot;
         }
 
         return siteRoot;
     }
 
     private Node getConstrainedSearchRoot() {
         // The "searchLink" parameter provides a search on a manually chosen sub node as search
         // root.
         // The "searchLink" parameter must be defined on the paragraph using this model class.
         // This method can be overwritten for defining a different parameter/parameter name.
         String id = PropertyUtil.getString(content, "searchLink");
         Node subNodeSearchPath = null;
         if (StringUtils.isNotEmpty(id)) {
             try {
                 subNodeSearchPath = NodeUtil.getNodeByIdentifier(getRepository(),id);
             }
             catch (RepositoryException e) {
             }
         }
         return subNodeSearchPath;
     }
 
     public Collection<Node> getItems() throws RepositoryException {
         List<Node> itemsList = search();
 
         this.filter(itemsList);
         this.sort(itemsList);
         itemsList = this.shrink(itemsList);
 
         return itemsList;
     }
 
     public STKPager getPager() throws RepositoryException {
 
         final String currentPageLink;
         if (MgnlContext.isWebContext() && MgnlContext.getAggregationState() != null) {
             currentPageLink = MgnlContext.getAggregationState().getOriginalURL();
         }
         else {
             currentPageLink = templatingFunctions.link(MgnlContext.getAggregationState().getMainContent().getJCRNode());
         }
         // FIXME : Review STKPAger?
         return new STKPager(currentPageLink, getItems(), content);
     }
 
     // FIXME: What to do?
     protected List<Node> search() throws RepositoryException {
         return stkFunctions.getContentListByTemplateCategorySubCategory(getSearchRoot(), getCategoryName(), getSubcategoryName());
     }
 
     abstract protected void filter(List<Node> itemList);
 
     abstract protected void sort(List<Node> itemList);
 
     private List<Node> shrink(List<Node> itemsList) {
         return stkFunctions.cutList(itemsList, getMaxResults());
     }
 
 }