View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de 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.html;
35  
36  import fr.paris.lutece.portal.service.util.AppLogService;
37  import fr.paris.lutece.portal.service.util.AppPropertiesService;
38  
39  import org.w3c.tidy.Tidy;
40  
41  import java.io.IOException;
42  import java.io.StringReader;
43  import java.io.StringWriter;
44  
45  
46  /**
47   *
48   * This class is an implementation of IHtmlCleaner using the JTidy library
49   *
50   */
51  public class JTidyHtmlCleaner implements IHtmlCleaner
52  {
53      private static final String PROPERTY_JTIDY_FILE_PATH = "file.jtidy.properties";
54      private static String _strContent;
55      private static Tidy _tidy;
56  
57      /**
58       * {@inheritDoc}
59       */
60      public String clean( String strSource ) throws HtmlCleanerException
61      {
62          String strCleanedSource = strSource;
63  
64          String strOutput = "";
65  
66          StringReader sr = new StringReader( strCleanedSource );
67          StringWriter sw = new StringWriter(  );
68          //      Convert to XHTML using Tidy
69          _tidy.parse( sr, sw );
70  
71          _strContent = strCleanedSource;
72          strOutput = sw.toString(  );
73  
74          // Verify the content of html editor after using tidy
75          if ( _strContent.length(  ) != strOutput.length(  ) )
76          {
77              if ( strOutput.length(  ) == 0 )
78              {
79                  throw new HtmlCleanerException(  );
80              }
81          }
82  
83          sr.close(  );
84          sw.flush(  );
85  
86          try
87          {
88              sw.close(  );
89          }
90          catch ( IOException e )
91          {
92              AppLogService.error( e.getMessage(  ), e );
93          }
94  
95          return strOutput;
96      }
97  
98      /**
99       * {@inheritDoc}
100      */
101     public void init(  )
102     {
103         _tidy = new Tidy(  );
104         _tidy.setConfigurationFromFile( AppPropertiesService.getProperty( PROPERTY_JTIDY_FILE_PATH ) );
105     }
106 }