3 * HTML validation and correction
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * Class to interact with HTML tidy
27 * Either the external tidy program or the in-process tidy extension
28 * will be used depending on availability. Override the default
29 * $wgTidyInternal setting to disable the internal if it's not working.
34 private static $instance;
37 * Interface with html tidy.
38 * If tidy isn't able to correct the markup, the original will be
39 * returned in all its glory with a warning comment appended.
41 * @param string $text HTML input fragment. This should not contain a
42 * <body> or <html> tag.
43 * @return string Corrected HTML output
45 public static function tidy( $text ) {
46 $driver = self
::singleton();
48 throw new MWException( __METHOD__
.
49 ': tidy is disabled, caller should have checked MWTidy::isEnabled()' );
51 return $driver->tidy( $text );
55 * Check HTML for errors, used if $wgValidateAllHtml = true.
58 * @param string &$errorStr Return the error string
59 * @return bool Whether the HTML is valid
61 public static function checkErrors( $text, &$errorStr = null ) {
62 $driver = self
::singleton();
64 throw new MWException( __METHOD__
.
65 ': tidy is disabled, caller should have checked MWTidy::isEnabled()' );
67 if ( $driver->supportsValidate() ) {
68 return $driver->validate( $text, $errorStr );
70 throw new MWException( __METHOD__
. ": error text return from HHVM tidy is not supported" );
74 public static function isEnabled() {
75 return self
::singleton() !== false;
78 protected static function singleton() {
79 global $wgUseTidy, $wgTidyInternal, $wgTidyConf, $wgDebugTidy, $wgTidyConfig,
80 $wgTidyBin, $wgTidyOpts;
82 if ( self
::$instance === null ) {
83 if ( $wgTidyConfig !== null ) {
84 $config = $wgTidyConfig;
85 } elseif ( $wgUseTidy ) {
88 'tidyConfigFile' => $wgTidyConf,
89 'debugComment' => $wgDebugTidy,
90 'tidyBin' => $wgTidyBin,
91 'tidyCommandLine' => $wgTidyOpts ];
92 if ( $wgTidyInternal ) {
94 $config['driver'] = 'RaggettInternalHHVM';
96 $config['driver'] = 'RaggettInternalPHP';
99 $config['driver'] = 'RaggettExternal';
104 switch ( $config['driver'] ) {
105 case 'RaggettInternalHHVM':
106 self
::$instance = new MediaWiki\Tidy\
RaggettInternalHHVM( $config );
108 case 'RaggettInternalPHP':
109 self
::$instance = new MediaWiki\Tidy\
RaggettInternalPHP( $config );
111 case 'RaggettExternal':
112 self
::$instance = new MediaWiki\Tidy\
RaggettExternal( $config );
114 case 'Html5Depurate':
115 self
::$instance = new MediaWiki\Tidy\
Html5Depurate( $config );
117 case 'Html5Internal':
118 self
::$instance = new MediaWiki\Tidy\
Html5Internal( $config );
123 throw new MWException( "Invalid tidy driver: \"{$config['driver']}\"" );
126 return self
::$instance;
130 * Set the driver to be used. This is for testing.
131 * @param TidyDriverBase|false|null $instance
133 public static function setInstance( $instance ) {
134 self
::$instance = $instance;
138 * Destroy the current singleton instance
140 public static function destroySingleton() {
141 self
::$instance = null;