StringUtils

/*
 * Copyright (c) 2002-2023, 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.utilitairesfo.utils;

import java.text.Normalizer;
import java.util.Arrays;
import java.util.StringJoiner;

public class StringUtils extends org.apache.commons.lang3.StringUtils
{
    private static final String STRING_UNICODE_THORN_UPPER = "þ";
    private static final String STRING_UNICODE_TIRET = "-";
    private static final char       CHAR_BACK_SLASH                          = '\\';
    private static final char       CHAR_TIRET                               = '-';
    private static final char       CHAR_QUOTE                               = '\'';
    private static final char       CHAR_DOUBLE_QUOTE                        = '"';
    private static final char       CHAR_QUOTE_1                             = '‘';
    private static final char       CHAR_QUOTE_2                             = '’';
    private static final char       CHAR_CHAR_SPACE                          = ' ';
    private static final String[] CHAR_TO_REPLACE_FOR_NAME                 = { "μ", "µ", "Μ", "Ÿ",                                                                                     // mu, micro, mu majuscule
            "Þ", STRING_UNICODE_THORN_UPPER, STRING_UNICODE_TIRET, "\\", "'", "\"", "‘", "’"                                                                                                 // Þ,þ,ß
            // symbols
    };

    private static final String[] CHAR_REPLACEMENT_FOR_NAME                = { "M", "M", "M", "Y",                                                                                                    // M, M, M
            "ß", "ß", STRING_UNICODE_TIRET, STRING_UNICODE_TIRET, "'", "'", "'", "'"                                                                                                              // ß,ß
            // symbols
    };

    private StringUtils()
    {

    }

    /**
     * Concatène les chaines non nulles avec le séparateur fourni (sans séparateur si null)
     * @param separateur séparateur
     * @param chaines liste dse chaines à concaténer
     * @return chaine concaténée
     */
    public static String concateneStringNonVideAvecSeparateur( String separateur, String... chaines )
    {
        if ( chaines == null )
        {
            return StringUtils.EMPTY;
        }

        StringJoiner joiner = new StringJoiner( separateur!=null?separateur: StringUtils.EMPTY );
        Arrays.stream( chaines ).filter( org.apache.commons.lang3.StringUtils::isNotBlank ).forEach( joiner::add );

        return joiner.toString( );
    }

    /**
     * Concatène les chaines non nulles et non "null" avec le séparateur fourni (sans séparateur si null)
     * @param separateur séparateur
     * @param chaines liste dse chaines à concaténer
     * @return chaine concaténée
     */
    public static String concateneStringNonVideNonStrNullAvecSeparateur( String separateur, String... chaines )
    {
        if ( chaines == null )
        {
            return StringUtils.EMPTY;
        }

        StringJoiner joiner = new StringJoiner( separateur!=null?separateur: StringUtils.EMPTY );
        Arrays.stream( chaines ).filter( org.apache.commons.lang3.StringUtils::isNotBlank ).filter( str -> !org.apache.commons.lang3.StringUtils.equalsIgnoreCase( "null", str.trim( ) ) ).forEach( joiner::add );

        return joiner.toString( );
    }


    /**
     * Remplace les caractères autres que chiffres et lettres non accentuées
     * @param text texte à traiter
     * @param specialReplacement caractère de remplacement des caractères spéciaux, par chaine vide si null
     * @return
     */
    public static String remplaceCaracteresSpeciaux( String text, String specialReplacement )
    {
        return text == null ? null : text.replaceAll( "[^a-zA-Z0-9]+", specialReplacement == null ? StringUtils.EMPTY : specialReplacement );
    }

    /**
     * Remplace les accents par le caractère non accentué correspondant.
     * @param text texte à traiter
     * @return
     */
    public static String remplaceAccents( String text )
    {
        return text == null ? null : Normalizer.normalize( text, Normalizer.Form.NFD ).replaceAll( "\\p{InCombiningDiacriticalMarks}+", StringUtils.EMPTY );
    }

    /**
     * Met le nom en majuscule
     * @param nom
     * @return
     */
    public static String formatteNom( String nom )
    {
        if ( nom == null )
        {
            return null;
        }

        // To upper case
        String sNormalized = nom.toUpperCase( );

        // Replacement char
        sNormalized = StringUtils.replaceEach( sNormalized, CHAR_TO_REPLACE_FOR_NAME, CHAR_REPLACEMENT_FOR_NAME );

        return trim( sNormalized );

    }

    public static String formatteChar( String character )
    {
        if ( character == null )
        {
            return null;
        }

        // To upper case
        String sNormalized = character.toUpperCase( );

        // Replacement char
        sNormalized = StringUtils.replaceEach( sNormalized, CHAR_TO_REPLACE_FOR_NAME, CHAR_REPLACEMENT_FOR_NAME );

        return sNormalized;

    }

    /**
     *
     * @param prenom
     * @return
     */
    public static String formattePrenom( String prenom )
    {
        if ( prenom == null )
        {
            return null;
        }

        StringBuilder sb = new StringBuilder( );
        // La première passe en majuscule
        boolean bCapitalizeNext = true;

        for ( char c : prenom.toCharArray( ) )
        {
            if ( c == CHAR_BACK_SLASH || c == CHAR_TIRET || c == CHAR_QUOTE || c == CHAR_DOUBLE_QUOTE || c == CHAR_QUOTE_1 || c == CHAR_QUOTE_2 || c == CHAR_CHAR_SPACE )
            {
                bCapitalizeNext = true;
                String s = String.valueOf( c );
                s = formatteChar( s );
                sb.append( s );
            }
            else
            {
                if ( bCapitalizeNext )
                {
                    String s = String.valueOf( c );
                    s = formatteChar( s );
                    sb.append( s );
                    bCapitalizeNext = false;
                }
                else
                {
                    String s = String.valueOf( c );
                    s = s.toLowerCase( );
                    sb.append( s );
                }
            }
        }

        return trim( sb.toString( ) );
    }
}