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
36 import fr.paris.lutece.portal.business.template.AutoInclude;
37 import fr.paris.lutece.portal.business.template.CommonsInclude;
38 import fr.paris.lutece.portal.service.util.AppPathService;
39 import fr.paris.lutece.portal.service.util.AppPropertiesService;
40 import fr.paris.lutece.util.date.DateUtil;
41 import java.util.ArrayList;
42 import java.util.List;
43
44 import java.util.Locale;
45
46 /**
47 * Template service based on the Freemarker template engine
48 */
49 public class FreeMarkerTemplateService extends AbstractFreeMarkerTemplateService
50 {
51 public static final String BEAN_SERVICE = "freeMarkerTemplateService";
52 private static final String PROPERTY_TEMPLATE_UPDATE_DELAY = "service.freemarker.templateUpdateDelay";
53 private static final int TEMPLATE_UPDATE_DELAY = AppPropertiesService.getPropertyInt( PROPERTY_TEMPLATE_UPDATE_DELAY, 5 );
54 private static FreeMarkerTemplateService _singleton;
55
56 /**
57 * Get the instance of the freemarker template service
58 *
59 * @return the instance of the freemarker template service
60 */
61 public static synchronized FreeMarkerTemplateService getInstance( )
62 {
63 if ( _singleton == null )
64 {
65 FreeMarkerTemplateServiceeeMarkerTemplateService.html#FreeMarkerTemplateService">FreeMarkerTemplateService service = new FreeMarkerTemplateService( );
66 service.setTemplateUpdateDelay( TEMPLATE_UPDATE_DELAY );
67 _singleton = service;
68 }
69
70 return _singleton;
71 }
72
73 /**
74 * {@inheritDoc}
75 */
76 @Override
77 public String getAbsolutePathFromRelativePath( String strPath )
78 {
79 return AppPathService.getAbsolutePathFromRelativePath( strPath );
80 }
81
82 /**
83 * {@inheritDoc}
84 */
85 @Override
86 public String getDefaultPattern( Locale locale )
87 {
88 return DateUtil.getDefaultPattern( locale );
89 }
90
91 /**
92 * Load the data of all the autoInclude objects and returns them as a list
93 *
94 * @return the list which contains the data of all the autoInclude objects
95 */
96 public List<AutoInclude> getAutoIncludesList( )
97 {
98 CommonsInclude ciCurrent = CommonsService.getCurrentCommonsInclude( );
99 List<AutoInclude> list = new ArrayList<>( );
100 for ( String strAutoIncludePath : getAutoIncludes( ) )
101 {
102 AutoIncludeess/template/AutoInclude.html#AutoInclude">AutoInclude include = new AutoInclude( strAutoIncludePath );
103 for ( String strFile : ciCurrent.getFiles( ) )
104 {
105 if ( strFile.equals( include.getFilePath( ) ) )
106 {
107 include.setOwner( ciCurrent.getName( ) );
108 }
109 }
110 list.add( include );
111
112 }
113 return list;
114 }
115
116 }