RichTextEditorService.java

/*
 * 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.portal.service.editor;

import fr.paris.lutece.portal.business.editor.RichTextEditor;
import fr.paris.lutece.portal.business.editor.RichTextEditorHome;
import fr.paris.lutece.portal.service.datastore.DatastoreService;
import fr.paris.lutece.portal.service.i18n.I18nService;
import fr.paris.lutece.portal.service.util.AppPropertiesService;
import fr.paris.lutece.util.ReferenceItem;
import fr.paris.lutece.util.ReferenceList;

import java.util.Collection;
import java.util.Locale;

/**
 * Service to manage front office and back office default rich text editor
 */
public final class RichTextEditorService
{
    public static final String MARK_DEFAULT_TEXT_EDITOR = "default_text_editor";
    private static final String PARAMETER_DEFAULT_EDITOR_BACK_OFFICE = "core.backOffice.defaultEditor";
    private static final String PARAMETER_DEFAULT_EDITOR_FRONT_OFFICE = "core.frontOffice.defaultEditor";
    private static final String PROPERTY_DEFAULT_EDITOR_BACK_OFFICE = "lutece.backOffice.defaultEditor";
    private static final String PROPERTY_DEFAULT_EDITOR_FRONT_OFFICE = "lutece.frontOffice.defaultEditor";

    /**
     * Instantiates a new rich text editor service.
     */
    private RichTextEditorService( )
    {
    }

    /**
     * Get the default rich text editor for back office
     * 
     * @return The default rich text editor for back office
     */
    public static String getBackOfficeDefaultEditor( )
    {
        String strDefaultEditorName = AppPropertiesService.getProperty( PROPERTY_DEFAULT_EDITOR_BACK_OFFICE );

        return DatastoreService.getDataValue( PARAMETER_DEFAULT_EDITOR_BACK_OFFICE, strDefaultEditorName );
    }

    /**
     * Get the default rich text editor for front office
     * 
     * @return The default rich text editor for front office
     */
    public static String getFrontOfficeDefaultEditor( )
    {
        String strDefaultEditorName = AppPropertiesService.getProperty( PROPERTY_DEFAULT_EDITOR_FRONT_OFFICE );

        return DatastoreService.getDataValue( PARAMETER_DEFAULT_EDITOR_FRONT_OFFICE, strDefaultEditorName );
    }

    /**
     * Update the default rich text editor for back office
     * 
     * @param strEditorUrl
     *            Name of the new rich text editor for back office
     */
    public static void updateBackOfficeDefaultEditor( String strEditorUrl )
    {
        DatastoreService.setDataValue( PARAMETER_DEFAULT_EDITOR_BACK_OFFICE, strEditorUrl );
    }

    /**
     * Update the default rich text editor for front office
     * 
     * @param strEditorUrl
     *            Name of the new rich text editor for front office
     */
    public static void updateFrontOfficeDefaultEditor( String strEditorUrl )
    {
        DatastoreService.setDataValue( PARAMETER_DEFAULT_EDITOR_FRONT_OFFICE, strEditorUrl );
    }

    /**
     * Get the list of rich text editors for back office
     * 
     * @param locale
     *            The locale of to use
     * @return The list of rich text editors for back office
     */
    public static ReferenceList getListEditorsForBackOffice( Locale locale )
    {
        Collection<RichTextEditor> listRichTextEditor = RichTextEditorHome.findListEditorsForBackOffice( );
        ReferenceList refList = new ReferenceList( );

        for ( RichTextEditor editor : listRichTextEditor )
        {
            ReferenceItem refItem = new ReferenceItem( );
            refItem.setCode( editor.getEditorName( ) );
            refItem.setName( I18nService.getLocalizedString( editor.getDescription( ), locale ) );
            refList.add( refItem );
        }

        return refList;
    }

    /**
     * Get the list of rich text editors for front office
     * 
     * @param locale
     *            The locale of to use
     * @return The list of rich text editors for front office
     */
    public static ReferenceList getListEditorsForFrontOffice( Locale locale )
    {
        Collection<RichTextEditor> listRichTextEditor = RichTextEditorHome.findListEditorsForFrontOffice( );
        ReferenceList refList = new ReferenceList( );

        for ( RichTextEditor editor : listRichTextEditor )
        {
            ReferenceItem refItem = new ReferenceItem( );
            refItem.setCode( editor.getEditorName( ) );
            refItem.setName( I18nService.getLocalizedString( editor.getDescription( ), locale ) );
            refList.add( refItem );
        }

        return refList;
    }
}