/**
    * This file Copyright (c) 2008-2015 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.search;
  
  import info.magnolia.cms.core.Content;
  import info.magnolia.cms.core.NodeData;
  import info.magnolia.jcr.util.NodeTypes;
  import info.magnolia.jcr.util.NodeUtil;
  import info.magnolia.jcr.util.PropertyUtil;
  import info.magnolia.module.templatingkit.templates.category.TemplateCategoryUtil;
  import info.magnolia.templating.functions.TemplatingFunctions;
  
  import java.util.ArrayList;
  import java.util.Calendar;
  import java.util.List;
  import java.util.regex.Pattern;
  
  import javax.jcr.Node;
  import javax.jcr.NodeIterator;
  import javax.jcr.Property;
  import javax.jcr.PropertyIterator;
  import javax.jcr.PropertyType;
  import javax.jcr.RepositoryException;
  
  import org.apache.commons.lang3.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Search Result Item Bean implementation. Used by STK SearchResultModel.
   */
  public class SearchResultItem {
      private static final Logger log = LoggerFactory.getLogger(SearchResultItem.class);
  
      private static final Pattern HTML_STRIP = Pattern.compile("<.*?>", Pattern.DOTALL);
  
      /**
       * Number of chars to include in result.
       */
      protected int chars = 100;
  
      /**
       * Maximum number of snippets to include in result.
       */
      protected int maxSnippets = 3;
  
      private Calendar date;
      private String author;
      private String category;
      private String title;
      private String text;
      private Node node;
      private String link;
      protected String query;
  
  
      public SearchResultItem(Node node, String query, TemplatingFunctions templatingFunctions) {
          this.query = query;
          this.node = node;
          this.title = PropertyUtil.getString(node, "title");
          this.author = PropertyUtil.getString(node, "author");
  
          this.category = StringUtils.capitalize(TemplateCategoryUtil.getTemplateSubCategory(node));
          if (StringUtils.isEmpty(category)) {
              this.category = StringUtils.capitalize(TemplateCategoryUtil.getTemplateCategory(node));
          }
  
          this.date = PropertyUtil.getDate(node, "date");
         if (date == null) {
             try {
                 this.date = NodeTypes.LastModified.getLastModified(node);
             } catch (RepositoryException e) {
                 // we'll leave it as null
             }
         }
 
         this.link = templatingFunctions.link(node);
         this.text = this.getSnippets();
     }
 
     public SearchResultItem(Node node, String query, String title, String author, String category, Calendar date, String link) {
         this.query = query;
         this.node = node;
         this.title = title;
         this.author = author;
 
         this.category = category;
         this.date = date;
         this.link = link;
 
         this.text = this.getSnippets();
     }
 
     public Calendar getDate() {
         return date;
     }
 
     public String getAuthor() {
         return author;
     }
 
     public String getCategory() {
         return category;
     }
 
     public String getTitle() {
         return title;
     }
 
     public String getText() {
         return text;
     }
 
     public String getLink() {
         return link;
     }
 
     public Node getNode() {
         return node;
     }
 
     public String getSnippets() {
 
         log.debug("collecting snippets");
 
         StringBuffer snippets = new StringBuffer();
         int numberOfSnippets = 0;
 
         boolean endProcess = false;
         try {
             if (processProperties(numberOfSnippets, snippets, node)) {
 
                 NodeIterator iterator = node.getNodes();
                 while (iterator.hasNext() && !endProcess) {
                     Node paragraphCollection = iterator.nextNode();
                     if (!processProperties(numberOfSnippets, snippets, paragraphCollection)) {
                         endProcess = true;
                         break;
                     }
                     Iterable<Node> paragraphs = NodeUtil.asIterable(paragraphCollection.getNodes());
 
                     for (Node paragraph : paragraphs) {
                         if (!processProperties(numberOfSnippets, snippets, paragraph)) {
                             endProcess = true;
                             break;
                         }
                         log.debug("Iterating on paragraph {}", paragraph);
 
                     }
                 }
             }
         } catch (RepositoryException e) {
             log.error("An error occurred while gettting search snippets", e);
         }
 
         return snippets.toString();
     }
 
 
     public int getMaxSnippets() {
         return maxSnippets;
     }
 
     public void setMaxSnippets(int maxSnippets) {
         this.maxSnippets = maxSnippets;
     }
 
     protected boolean processProperties(int numberOfSnippets, StringBuffer snippets, Node node) throws RepositoryException {
 
         List<String> snippetList = new ArrayList<String>();
 
         PropertyIterator iterator = node.getProperties();
         while (iterator.hasNext()) {
             Property property = iterator.nextProperty();
             if (property.getType() == PropertyType.STRING) {
                 highlightSnippet(snippetList, property);
                 if (snippetList.size() + numberOfSnippets >= maxSnippets) {
                     break;
                 }
             }
         }
         for (String snippet : snippetList) {
             snippets.append(snippet);
         }
         return snippetList.size() + numberOfSnippets < maxSnippets;
     }
 
     /**
      * @deprecated since 2.9, use {@link #processProperties(int, StringBuffer, Node)} instead.
      */
     @Deprecated
     protected boolean processNodeDatas(int numberOfSnippets, StringBuffer snippets, Content paragraph) throws RepositoryException {
         return processProperties(numberOfSnippets, snippets, paragraph.getJCRNode());
     }
 
     /**
      * @deprecated since 2.9, use {@link #highlightSnippet(List, Property)} instead.
      */
     @Deprecated
     protected void highlightSnippet(List<String> snippetList, NodeData property) throws RepositoryException {
         highlightSnippet(snippetList, property.getJCRProperty());
     }
 
     protected void highlightSnippet(List<String> snippetList, Property property) throws RepositoryException {
         if (property.isMultiple()) {
             return;
         }
         String resultString = property.getString();
 
         log.debug("Iterating on property {}", property.getName());
         log.debug("Property value is {}", resultString);
 
         String searchTerm = this.query;
 
         if (skipProperty(property.getName(), resultString, searchTerm)) {
             return;
         }
 
         // exclude words with less than 2 chars
         if (searchTerm != null && searchTerm.length() > 2) {
 
             log.debug("Looking for search term [{}] in [{}]", searchTerm, resultString);
 
             // if search term was wrapped in quotas, remove them now
             if (StringUtils.startsWith(searchTerm, "\"") && StringUtils.endsWith(searchTerm, "\"")) {
                 searchTerm = searchTerm.substring(1, searchTerm.length() - 1);
             }
 
             // first check, avoid using heavy string replaceAll operations if the search term is not
             // there
             if (!StringUtils.contains(resultString.toLowerCase(), searchTerm.toLowerCase())) {
                 return;
             }
 
             // strips out html tags using a regexp
             resultString = stripHtmlTags(resultString);
 
             // only get first matching keyword
             int pos = resultString.toLowerCase().indexOf(searchTerm.toLowerCase());
             if (pos > -1) {
 
                 int posEnd = pos + searchTerm.length();
                 int from = (pos - chars / 2);
                 if (from < 0) {
                     from = 0;
                 }
 
                 int to = from + chars;
                 if (to > resultString.length()) {
                     to = resultString.length();
                 }
 
                 StringBuffer snippet = new StringBuffer();
 
                 snippet.append(StringUtils.substring(resultString, from, pos));
                 snippet.append("<em class=\"highlight\">");
                 snippet.append(StringUtils.substring(resultString, pos, posEnd));
                 snippet.append("</em>");
                 snippet.append(StringUtils.substring(resultString, posEnd, to));
 
                 if (from > 0) {
                     snippet.insert(0, "... ");
                 }
                 if (to < resultString.length()) {
                     snippet.append("... ");
                 }
 
                 log.debug("Search term found, adding snippet {}", snippet);
 
                 snippetList.add(snippet + "<br />");
             }
         }
     }
 
     protected boolean skipProperty(String name, String resultString, String searchTerm) {
         // a quick and buggy way to avoid configuration properties, we should allow the user to
         // configure a list of nodeData to search for...
         return resultString.length() < 20;
     }
 
     protected String stripHtmlTags(String resultString) {
         return HTML_STRIP.matcher(resultString).replaceAll("");
     }
 
 
 }