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.editor;
35
36 import org.jsoup.safety.Safelist;
37
38 /**
39 *
40 * This Interface Provides a parser BBCODE
41 *
42 */
43 public interface IEditorBbcodeService
44 {
45 /**
46 * Parse BBCODE text and return safe HTML
47 * This method clean a <code>body</code> fragment of HTML with {@link Safelist#basicWithImages()}
48 * @param strValue
49 * the value of the text
50 * @return HTML Text
51 * @See {@link Safelist#basicWithImages()}
52 */
53 String parse( String strValue );
54
55 /**
56 * Parses the input string using BBCodeUtil.parse() and cleans the resulting HTML
57 * using Jsoup.clean() with the specified Safelist, and returns the cleaned string.
58 *
59 * @param strValue the input string to be parsed and cleaned
60 * @param safelist the Safelist to be used for cleaning the HTML
61 * @return the cleaned and sanitized string
62 */
63 public String parseAndClean(String strValue, Safelist safelist);
64 }