1 /*
2 * Copyright (c) 2002-2025, 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.DatabaseTemplateHome;
37 import fr.paris.lutece.portal.service.editor.RichTextContentService;
38 import fr.paris.lutece.portal.service.editor.RichTextParsingException;
39 import fr.paris.lutece.portal.service.util.AppLogService;
40
41 /**
42 * This class provides methods to access templates stored in the database.
43 */
44 public final class DatabaseTemplateService
45 {
46 /**
47 * Instantiates a new database template service.
48 */
49 private DatabaseTemplateService( )
50 {
51 }
52
53 /**
54 * Get a template in the database from its key
55 *
56 * @param strKey
57 * The key of the template to get
58 * @return The template loaded from the database
59 */
60 public static String getTemplateFromKey( String strKey )
61 {
62 return getTemplateFromKey( strKey, false );
63 }
64
65 /**
66 * Get a template in the database from its key
67 *
68 * @param strKey
69 * The key of the template to get
70 * @param bForEditor
71 * True if the template is to be displayed in an editor
72 * @return The template loaded from the database
73 */
74 public static String getTemplateFromKey( String strKey, boolean bForEditor )
75 {
76 String strTemplate = DatabaseTemplateHome.getTemplateFromKey( strKey );
77 if ( !bForEditor )
78 {
79 try
80 {
81 strTemplate = RichTextContentService.getContent( strTemplate );
82 }
83 catch( RichTextParsingException e )
84 {
85 AppLogService.error( e.getMessage( ), e );
86 }
87 }
88 return strTemplate;
89 }
90
91 /**
92 * Update a template in the database
93 *
94 * @param strKey
95 * The key of the template
96 * @param strValue
97 * The new value of the template
98 */
99 public static void updateTemplate( String strKey, String strValue )
100 {
101 DatabaseTemplateHome.updateTemplate( strKey, strValue );
102 }
103 }