/*
    * Copyright (c) 2002-2018, Mairie de Paris
    * All rights reserved.
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    *
    *  1. Redistributions of source code must retain the above copyright notice
   *     and the following disclaimer.
   *
   *  2. Redistributions in binary form must reproduce the above copyright notice
   *     and the following disclaimer in the documentation and/or other materials
   *     provided with the distribution.
   *
   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
   *     contributors may be used to endorse or promote products derived from
   *     this software without specific prior written permission.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   * POSSIBILITY OF SUCH DAMAGE.
   *
   * License 1.0
   */
  package fr.paris.lutece.plugins.easyrulesbot.service.bot.rules;
  
  import fr.paris.lutece.plugins.easyrulesbot.service.bot.BotExecutor;
  import fr.paris.lutece.plugins.easyrulesbot.service.yaml.model.YamlButton;
  import fr.paris.lutece.plugins.easyrulesbot.service.bot.rules.conditions.Condition;
  import fr.paris.lutece.plugins.easyrulesbot.service.response.processors.ResponseProcessor;
  import fr.paris.lutece.portal.service.template.AppTemplateService;
  import fr.paris.lutece.portal.web.l10n.LocaleService;
  import fr.paris.lutece.util.html.HtmlTemplate;
  
  import org.easyrules.api.Rule;
  
  import java.io.Serializable;
  import java.util.HashMap;
  
  import java.util.List;
  import java.util.Locale;
  import java.util.Map;
  
  /**
   * BotRule
   */
  public class BotRule implements Rule, Comparable, Serializable
  {
      private static final String TEMPLATE_BUTTONS = "/skin/plugins/easyrulesbot/buttons_message.html";
      private static final String MARK_BUTTONS = "buttons";
      private static final String DEFAULT_MESSAGE_TYPE = "text";
      private static final long serialVersionUID = 1L;
  
      // Variables declarations
      private String _strName;
      private String _strDescription;
      private String _strMessageTemplate;
      private String _strMessageType = DEFAULT_MESSAGE_TYPE;
      private String _strResponseCommentTemplate;
      private String _strDataKey;
      private List<YamlButton> _listButtons;
      private int _nPriority;
      private BotExecutor _executor;
      private ResponseProcessor _responseProcessor;
      private List<Condition> _listConditions;
  
      /**
       * {@inheritDoc }
       */
      @Override
      public String getName( )
      {
          return _strName;
      }
  
      /**
       * Sets the Name
       * 
       * @param strName
       *            The Name
       */
      public void setName( String strName )
      {
          _strName = strName;
      }
  
      /**
       * {@inheritDoc }
       */
      @Override
     public String getDescription( )
     {
         return _strDescription;
     }
 
     /**
      * Sets the Description
      * 
      * @param strDescription
      *            The Description
      */
     public void setDescription( String strDescription )
     {
         _strDescription = strDescription;
     }
 
     /**
      * Returns the MessageType
      * 
      * @return The MessageType
      */
     public String getMessageType( )
     {
         return _strMessageType;
     }
 
     /**
      * Sets the MessageType
      * 
      * @param strMessageType
      *            The MessageType
      */
     public void setMessageType( String strMessageType )
     {
         _strMessageType = strMessageType;
     }
 
     /**
      * {@inheritDoc }
      */
     @Override
     public int getPriority( )
     {
         return _nPriority;
     }
 
     /**
      * Sets the Priority
      * 
      * @param nPriority
      *            The Priority
      */
     public void setPriority( int nPriority )
     {
         _nPriority = nPriority;
     }
 
     /**
      * Returns the DataKey
      * 
      * @return The DataKey
      */
     public String getDataKey( )
     {
         return _strDataKey;
     }
 
     /**
      * Sets the DataKey
      * 
      * @param strDataKey
      *            The DataKey
      */
     public void setDataKey( String strDataKey )
     {
         _strDataKey = strDataKey;
     }
 
     /**
      * Returns the Buttons
      * 
      * @return The Buttons
      */
     public List<YamlButton> getButtons( )
     {
         return _listButtons;
     }
 
     /**
      * Sets the Buttons
      * 
      * @param listButtons
      *            The Buttons
      */
     public void setButtons( List<YamlButton> listButtons )
     {
         _listButtons = listButtons;
     }
 
     /**
      * Returns the Question
      * 
      * @param mapData
      *            The map of data
      * @param locale
      *            The locale
      * @return The Question
      */
     public String getMessage( Map<String, String> mapData, Locale locale )
     {
         String strMessage = fillTemplate( _strMessageTemplate , mapData );
         
         
         if( (_listButtons != null) && ! _listButtons.isEmpty() )
         {
             Map< String , Object> model = new HashMap<>();
             model.put( MARK_BUTTONS , _listButtons );
             HtmlTemplate tButtons = AppTemplateService.getTemplate( TEMPLATE_BUTTONS, locale, model );
             String strButtons = tButtons.getHtml();
             strMessage += "\n" + strButtons; 
         }
 
         return strMessage;
     }
 
     /**
      * Sets the Question
      * 
      * @param strQuestion
      *            The Question
      */
     public void setMessageTemplate( String strQuestion )
     {
         _strMessageTemplate = strQuestion;
     }
 
     /**
      * Define the current executor using the rule
      * 
      * @param executor
      *            The executor
      */
     public void setExecutor( BotExecutor executor )
     {
         _executor = executor;
     }
 
     /**
      * Sets the response processor
      * 
      * @param responseProcessor
      *            the response processor
      */
     public void setResponseProcessor( ResponseProcessor responseProcessor )
     {
         _responseProcessor = responseProcessor;
     }
 
     /**
      * Gets the response processor
      * 
      * @return the response processor
      */
     public ResponseProcessor getResponseProcessor( )
     {
         return _responseProcessor;
     }
 
     /**
      * Sets the conditions list
      * 
      * @param listConditions
      *            The list of condition
      */
     public void setListConditions( List<Condition> listConditions )
     {
         _listConditions = listConditions;
     }
 
     /**
      * Define the response comment template
      * 
      * @param strResponseCommentTemplate
      *            The template
      */
     public void setResponseCommentTemplate( String strResponseCommentTemplate )
     {
         _strResponseCommentTemplate = strResponseCommentTemplate;
     }
 
     /**
      * Provides a comment after the user's response
      * 
      * @param mapData
      *            The data
      * @param locale
      *            The locale
      * @return The response
      */
     public String getResponseComment( Map<String, String> mapData, Locale locale )
     {
         String strTemplate = _strResponseCommentTemplate;
 
         if ( strTemplate != null )
         {
             return fillTemplate( strTemplate, mapData );
         }
 
         return null;
     }
 
     /**
      * {@inheritDoc }
      */
     @Override
     public boolean evaluate( )
     {
         Map<String, String> mapData = _executor.getDataMap( );
 
         for ( Condition condition : _listConditions )
         {
             if ( !condition.evaluate( mapData, _strDataKey ) )
             {
                 return false;
             }
         }
 
         return true;
     }
 
     /**
      * {@inheritDoc }
      */
     @Override
     public void execute( ) throws Exception
     {
         _executor.setCurrentRule( this );
     }
 
     /**
      * {@inheritDoc }
      */
     @Override
     public int compareTo( Object object )
     {
         Rule rule = (Rule) object;
 
         return getPriority( ) - rule.getPriority( );
     }
 
     /**
      * Fill a template with data contained in a model map
      * 
      * @param strTemplateString
      *            The template
      * @param model
      *            The model
      * @return The filled string
      */
     private String fillTemplate( String strTemplateString, Map<String, String> model )
     {
         if ( !strTemplateString.contains( "{" ) && !strTemplateString.contains( "<#" ) )
         {
             // No marker and no freemarker tag so nothing to transform
             return strTemplateString;
         }
 
         String strTemplate = strTemplateString.replace( "{", "${" ); // $ removed in context file
         HtmlTemplate template = AppTemplateService.getTemplateFromStringFtl( strTemplate, LocaleService.getDefault( ), model );
 
         return template.getHtml( );
     }
 
     /**
      * {@inheritDoc }
      */
     @Override
     public String toString()
     {
         StringBuilder sbOutput = new StringBuilder( "\n   RULE");
         sbOutput.append( "\n   name : " ).append( _strName );
         sbOutput.append( "\n   description : " ).append( _strDescription );
         sbOutput.append( "\n   message : " ).append( _strMessageTemplate );
         sbOutput.append( "\n   priority : " ).append( _nPriority );
         sbOutput.append( "\n   data key : " ).append( _strDataKey );
         sbOutput.append( "\n   Conditions : " );
         if( _listConditions != null )
         {
             for( Condition condition : _listConditions )
             {
                 sbOutput.append( "\n  " ).append( condition );
             }
         }
         return sbOutput.toString();
     }
     
     
 }