/*
    * Copyright (c) 2002-2022, 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.genericattributes.service.entrytype;
  
  import java.util.List;
  import java.util.Locale;
  
  import javax.servlet.http.HttpServletRequest;
  
  import fr.paris.lutece.plugins.genericattributes.business.Entry;
  import fr.paris.lutece.plugins.genericattributes.business.GenericAttributeError;
  import fr.paris.lutece.plugins.genericattributes.business.Response;
  import fr.paris.lutece.portal.service.i18n.I18nService;
  import fr.paris.lutece.portal.service.plugin.Plugin;
  import fr.paris.lutece.portal.service.security.LuteceUser;
  import fr.paris.lutece.portal.service.security.SecurityService;
  import fr.paris.lutece.portal.service.security.UserNotSignedException;
  import fr.paris.lutece.portal.service.util.AppLogService;
  import fr.paris.lutece.util.ReferenceList;
  
  /**
   * Abstract entry type for MyLutece users
   */
  public abstract class AbstractEntryTypeMyLuteceUser extends EntryTypeService
  {
      private static final String PROPERTY_ENTRY_TITLE = "genericattributes.entryTypeMyLuteceUser.title";
      private static final String EMPTY_STRING = "";
  
      /**
       * {@inheritDoc}
       */
      @Override
      public String getTemplateCreate( Entry entry, boolean bDisplayFront )
      {
          return null;
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public String getTemplateModify( Entry entry, boolean bDisplayFront )
      {
          return null;
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public String getRequestData( Entry entry, HttpServletRequest request, Locale locale )
      {
          initCommonRequestData( entry, request );
          String strIndexed = request.getParameter( PARAMETER_INDEXED );
  
          entry.setTitle( I18nService.getLocalizedString( PROPERTY_ENTRY_TITLE, locale ) );
  
          String strCode = request.getParameter( PARAMETER_ENTRY_CODE );
          entry.setHelpMessage( EMPTY_STRING );
          entry.setComment( EMPTY_STRING );
          entry.setIndexed( strIndexed != null );
  
          entry.setCode( strCode );
          return null;
      }
  
      /**
       * {@inheritDoc}
      */
     @Override
     public ReferenceList getReferenceListRegularExpression( Entry entry, Plugin plugin )
     {
         return null;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public GenericAttributeError getResponseData( Entry entry, HttpServletRequest request, List<Response> listResponse, Locale locale )
     {
         LuteceUser user = SecurityService.getInstance( ).getRegisteredUser( request );
 
         if ( SecurityService.isAuthenticationEnable( ) && SecurityService.getInstance( ).isExternalAuthentication( ) && user == null )
         {
             try
             {
                 user = SecurityService.getInstance( ).getRemoteUser( request );
             }
             catch( UserNotSignedException e )
             {
                 AppLogService.error( e.getMessage( ), e );
             }
         }
 
         if ( user == null )
         {
             GenericAttributeErrortributes/business/GenericAttributeError.html#GenericAttributeError">GenericAttributeError error = new GenericAttributeError( );
             error.setMandatoryError( false );
             error.setTitleQuestion( entry.getTitle( ) );
             error.setErrorMessage( I18nService.getLocalizedString( MESSAGE_MYLUTECE_AUTHENTIFICATION_REQUIRED, request.getLocale( ) ) );
 
             return error;
         }
 
         Response/genericattributes/business/Response.html#Response">Response response = new Response( );
         response.setEntry( entry );
         response.setResponseValue( user.getName( ) );
         response.setIterationNumber( getResponseIterationValue( request ) );
 
         listResponse.add( response );
 
         return null;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getResponseValueForExport( Entry entry, HttpServletRequest request, Response response, Locale locale )
     {
         return response.getResponseValue( );
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getResponseValueForRecap( Entry entry, HttpServletRequest request, Response response, Locale locale )
     {
         return null;
     }
 }