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
46 public static function tidy( $text ) {
47 $driver = self
::singleton();
49 throw new MWException( __METHOD__
.
50 ': tidy is disabled, caller should have checked MWTidy::isEnabled()' );
52 return $driver->tidy( $text );
58 public static function isEnabled() {
59 return self
::singleton() !== false;
63 * @return bool|\MediaWiki\Tidy\TidyDriverBase
65 public static function singleton() {
66 global $wgUseTidy, $wgTidyInternal, $wgTidyConf, $wgDebugTidy, $wgTidyConfig,
67 $wgTidyBin, $wgTidyOpts;
69 if ( self
::$instance === null ) {
70 if ( $wgTidyConfig !== null ) {
71 $config = $wgTidyConfig;
72 } elseif ( $wgUseTidy ) {
74 wfDeprecated( '$wgUseTidy', '1.26' );
76 'tidyConfigFile' => $wgTidyConf,
77 'debugComment' => $wgDebugTidy,
78 'tidyBin' => $wgTidyBin,
79 'tidyCommandLine' => $wgTidyOpts ];
80 if ( $wgTidyInternal ) {
82 $config['driver'] = 'RaggettInternalHHVM';
84 $config['driver'] = 'RaggettInternalPHP';
87 $config['driver'] = 'RaggettExternal';
90 wfDeprecated( '$wgTidyConfig = null and $wgUseTidy = false', '1.26' );
93 self
::$instance = self
::factory( $config );
95 return self
::$instance;
99 * Create a new Tidy driver object from configuration.
101 * @param array $config
102 * @return bool|\MediaWiki\Tidy\TidyDriverBase
103 * @throws MWException
105 public static function factory( array $config ) {
106 switch ( $config['driver'] ) {
107 case 'RaggettInternalHHVM':
108 $instance = new MediaWiki\Tidy\
RaggettInternalHHVM( $config );
110 case 'RaggettInternalPHP':
111 $instance = new MediaWiki\Tidy\
RaggettInternalPHP( $config );
113 case 'RaggettExternal':
114 $instance = new MediaWiki\Tidy\
RaggettExternal( $config );
117 $instance = new MediaWiki\Tidy\
RemexDriver( $config );
120 wfDeprecated( '"disabled" tidy driver', '1.32' );
123 throw new MWException( "Invalid tidy driver: \"{$config['driver']}\"" );
129 * Set the driver to be used. This is for testing.
130 * @param MediaWiki\Tidy\TidyDriverBase|false|null $instance
132 public static function setInstance( $instance ) {
133 self
::$instance = $instance;
137 * Destroy the current singleton instance
139 public static function destroySingleton() {
140 self
::$instance = null;