/**
    * This file Copyright (c) 2008-2012 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.util;
  
  
  
  import java.util.Calendar;
  import java.util.Collections;
  import java.util.Comparator;
  import java.util.List;
  
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  
  import org.apache.commons.collections.CollectionUtils;
  import org.apache.commons.collections.Predicate;
  import org.apache.commons.lang.StringUtils;
  
  /**
   * Date Utility. Allows to sort content list based to theirs.
   * node 'date'.
   * @author cringele
   * @version $Id$
   */
  
  public class STKDateContentUtil {
  
      public static final Object INSTANCE = new STKDateContentUtil();
  
      public static final String ASCENDING = "ascending";
      public static final String DESCENDING = "descending";
      private static final String DEFAULT_DATE_PROPERTY_NAME = "date";
  
      public static void filterDateContentList(List<Node> itemsList, final Calendar minDate, final Calendar maxDate) {
          filterDateContentList(itemsList, minDate, maxDate, DEFAULT_DATE_PROPERTY_NAME);
      }
  
      public static void filterDateContentList(List<Node> itemsList, final Calendar minDate, final Calendar maxDate, final String datePropertyName) {
          CollectionUtils.filter(itemsList, new Predicate(){
              @Override
              public boolean evaluate(Object object) {
                   Node node = (Node) object;
                   Calendar date = getDate(node, datePropertyName, Calendar.getInstance());
                   // INSMR-447: Increase milliseconds by one. Otherwise event will not be shown if date==minDate.
                   if (date.getTimeInMillis() ==  minDate.getTimeInMillis()) {
                       date.add(Calendar.SECOND, 1);
                   }
                   return date.after(minDate) && date.before(maxDate);
               }
           });
      }
  
      public static void sortDateContentList(final List<Node> itemsList, final String sortDirection) {
          sortDateContentList(itemsList, sortDirection, DEFAULT_DATE_PROPERTY_NAME);
      }
  
      public static void sortDateContentList(final List<Node> itemsList, final String sortDirection, final String datePropertyName) {
          Calendar veryOld = Calendar.getInstance();
          veryOld.setTimeInMillis(0);
          sortDateContentList(itemsList, sortDirection, datePropertyName, veryOld);
      }
  
      public static void sortDateContentList(final List<Node> itemsList, final String sortDirection, final String datePropertyName, final Calendar defaultDate) {
          Collections.sort(itemsList, new Comparator<Node>(){
              @Override
              public int compare(Node c1, Node c2) {
                  Calendar date1 = getDate(c1, datePropertyName, defaultDate);
                  Calendar date2 = getDate(c2, datePropertyName, defaultDate);
                 if(StringUtils.equals(sortDirection, ASCENDING)){
                     return date2.compareTo(date1);
                 }
                 return date1.compareTo(date2);
             }
         });
     }
 
     //FIXME: Should be put in a helper class
     private static Calendar getDate(Node node, String name, Calendar defaultValue) {
         try {
             if (node.hasProperty(name)) {
                 return node.getProperty(name).getDate();
             }
         } catch (RepositoryException e) {
         }
         return defaultValue;
     }
 }