FreeMarkerTemplateService.java

  1. /*
  2.  * Copyright (c) 2002-2022, City of Paris
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  *  1. Redistributions of source code must retain the above copyright notice
  10.  *     and the following disclaimer.
  11.  *
  12.  *  2. Redistributions in binary form must reproduce the above copyright notice
  13.  *     and the following disclaimer in the documentation and/or other materials
  14.  *     provided with the distribution.
  15.  *
  16.  *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
  17.  *     contributors may be used to endorse or promote products derived from
  18.  *     this software without specific prior written permission.
  19.  *
  20.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21.  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23.  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  24.  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25.  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26.  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27.  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28.  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30.  * POSSIBILITY OF SUCH DAMAGE.
  31.  *
  32.  * License 1.0
  33.  */
  34. package fr.paris.lutece.portal.service.template;

  35. import fr.paris.lutece.portal.business.template.AutoInclude;
  36. import fr.paris.lutece.portal.business.template.CommonsInclude;
  37. import fr.paris.lutece.portal.service.util.AppPathService;
  38. import fr.paris.lutece.portal.service.util.AppPropertiesService;
  39. import fr.paris.lutece.util.date.DateUtil;
  40. import java.util.ArrayList;
  41. import java.util.List;

  42. import java.util.Locale;

  43. /**
  44.  * Template service based on the Freemarker template engine
  45.  */
  46. public class FreeMarkerTemplateService extends AbstractFreeMarkerTemplateService
  47. {
  48.     public static final String BEAN_SERVICE = "freeMarkerTemplateService";
  49.     private static final String PROPERTY_TEMPLATE_UPDATE_DELAY = "service.freemarker.templateUpdateDelay";
  50.     private static final int TEMPLATE_UPDATE_DELAY = AppPropertiesService.getPropertyInt( PROPERTY_TEMPLATE_UPDATE_DELAY, 5 );
  51.     private static FreeMarkerTemplateService _singleton;

  52.     /**
  53.      * Get the instance of the freemarker template service
  54.      *
  55.      * @return the instance of the freemarker template service
  56.      */
  57.     public static synchronized FreeMarkerTemplateService getInstance( )
  58.     {
  59.         if ( _singleton == null )
  60.         {
  61.             FreeMarkerTemplateService service = new FreeMarkerTemplateService( );
  62.             service.setTemplateUpdateDelay( TEMPLATE_UPDATE_DELAY );
  63.             _singleton = service;
  64.         }

  65.         return _singleton;
  66.     }

  67.     /**
  68.      * {@inheritDoc}
  69.      */
  70.     @Override
  71.     public String getAbsolutePathFromRelativePath( String strPath )
  72.     {
  73.         return AppPathService.getAbsolutePathFromRelativePath( strPath );
  74.     }

  75.     /**
  76.      * {@inheritDoc}
  77.      */
  78.     @Override
  79.     public String getDefaultPattern( Locale locale )
  80.     {
  81.         return DateUtil.getDefaultPattern( locale );
  82.     }

  83.     /**
  84.      * Load the data of all the autoInclude objects and returns them as a list
  85.      *
  86.      * @return the list which contains the data of all the autoInclude objects
  87.      */
  88.     public List<AutoInclude> getAutoIncludesList( )
  89.     {
  90.         CommonsInclude ciCurrent = CommonsService.getCurrentCommonsInclude( );
  91.         List<AutoInclude> list = new ArrayList<>( );
  92.         for ( String strAutoIncludePath : getAutoIncludes( ) )
  93.         {
  94.             AutoInclude include = new AutoInclude( strAutoIncludePath );
  95.             for ( String strFile : ciCurrent.getFiles( ) )
  96.             {
  97.                 if ( strFile.equals( include.getFilePath( ) ) )
  98.                 {
  99.                     include.setOwner( ciCurrent.getName( ) );
  100.                 }
  101.             }
  102.             list.add( include );

  103.         }
  104.         return list;
  105.     }

  106. }