/*
    * Copyright (c) 2002-2021, City of 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.captcha.web;
  
  import fr.paris.lutece.plugins.captcha.service.CaptchaService;
  import fr.paris.lutece.portal.business.user.AdminUser;
  import fr.paris.lutece.portal.service.admin.AdminUserService;
  import fr.paris.lutece.portal.service.captcha.ICaptchaService;
  import fr.paris.lutece.portal.service.i18n.I18nService;
  import fr.paris.lutece.portal.service.spring.SpringContextService;
  import fr.paris.lutece.portal.service.template.AppTemplateService;
  import fr.paris.lutece.portal.service.util.AppPathService;
  import fr.paris.lutece.portal.service.dashboard.admin.AdminDashboardComponent;
  import fr.paris.lutece.portal.web.l10n.LocaleService;
  import fr.paris.lutece.util.html.HtmlTemplate;
  
  import java.util.HashMap;
  import java.util.Map;
  
  import javax.servlet.http.HttpServletRequest;
  
  /**
   * Panel for global management page
   */
  public class CaptchaLutecePanelJspBean extends AdminDashboardComponent
  {
      /**
       * generated serial version UID
       */
      private static final long serialVersionUID = 8792952492908177294L;
  
      private static final String LABEL_TITLE_CAPTCHA = "captcha.globalmanagement.panelTitle";
  
      private static final String PARAMETER_CAPTCHA_ENGINE = "captcha_engine";
  
      private static final String MARK_CURRENT_CAPTCHA_ENGINE = "current_captcha_engine";
      private static final String MARK_LIST_CAPTCHA_ENGINE = "listCaptchaEngine";
  
      private static final String TEMPLATE_CAPTCHA_PANEL = "admin/plugins/captcha/panel_captcha_management.html";
  
      private ICaptchaService _captchaService;
  
      /**
       * {@inheritDoc}
       */
      @Override
      public String getName( )
      {
          return I18nService.getLocalizedString( LABEL_TITLE_CAPTCHA, LocaleService.getDefault( ) );
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public String getDashboardData( AdminUser user, HttpServletRequest request )
      {
          ICaptchaService captchaService = getCaptchaService( );
          Map<String, Object> model = new HashMap<>( );
          model.put( MARK_CURRENT_CAPTCHA_ENGINE, captchaService.getDefaultCaptchaEngineName( ) );
          model.put( MARK_LIST_CAPTCHA_ENGINE, captchaService.getCaptchaEngineNameList( ) );
  
          HtmlTemplate template = AppTemplateService.getTemplate( TEMPLATE_CAPTCHA_PANEL, AdminUserService.getLocale( request ), model );
  
          return template.getHtml( );
      }
  
      /**
      * Returns the panel's order. This panel is a second panel.
      * 
      * @return 2
      */
     @Override
     public int getOrder( )
     {
         return 2;
     }
 
     /**
      * Update the default captcha to use
      * 
      * @param request
      *            The request
      * @return The next URL to redirect to
      */
     public String updateDefaultCaptcha( HttpServletRequest request )
     {
         String strDefaultCaptcha = request.getParameter( PARAMETER_CAPTCHA_ENGINE );
         ICaptchaService captchaService = getCaptchaService( );
         captchaService.setDefaultCaptchaEngineName( strDefaultCaptcha );
         return AppPathService.getBaseUrl( request );
     }
 
     /**
      * Get a captcha service instance
      * 
      * @return An instance of the captcha servcie
      */
     private ICaptchaService getCaptchaService( )
     {
         if ( _captchaService == null )
         {
             _captchaService = SpringContextService.getBean( CaptchaService.BEAN_NAME );
         }
         return _captchaService;
     }
 }