6db35b3c98
Remex is pure PHP so there is no reason to use an external tidy any more. Configuration variables and implementation classes were deprecated in 1.32 or earlier. We've kept only $wgTidyConfig which can be used for experimental features or debugging Remex. Bug: T198214 Change-Id: I99d48f858d97b6e1d1e6cd76a42c960cc2c61f9f
96 lines
2.6 KiB
PHP
96 lines
2.6 KiB
PHP
<?php
|
|
/**
|
|
* HTML validation and correction
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup Parser
|
|
*/
|
|
|
|
/**
|
|
* Class to interact with and configure Remex tidy
|
|
*
|
|
* @ingroup Parser
|
|
*/
|
|
class MWTidy {
|
|
private static $instance;
|
|
|
|
/**
|
|
* Interface with Remex tidy.
|
|
* If tidy isn't able to correct the markup, the original will be
|
|
* returned in all its glory with a warning comment appended.
|
|
*
|
|
* @param string $text HTML input fragment. This should not contain a
|
|
* <body> or <html> tag.
|
|
* @return string Corrected HTML output
|
|
* @throws MWException
|
|
*/
|
|
public static function tidy( $text ) {
|
|
$driver = self::singleton();
|
|
if ( !$driver ) {
|
|
throw new MWException( __METHOD__ .
|
|
': tidy is disabled, caller should have checked MWTidy::isEnabled()' );
|
|
}
|
|
return $driver->tidy( $text );
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public static function isEnabled() {
|
|
return self::singleton() !== false;
|
|
}
|
|
|
|
/**
|
|
* @return bool|\MediaWiki\Tidy\TidyDriverBase
|
|
*/
|
|
public static function singleton() {
|
|
global $wgTidyConfig;
|
|
if ( self::$instance === null ) {
|
|
self::$instance = self::factory( $wgTidyConfig );
|
|
}
|
|
return self::$instance;
|
|
}
|
|
|
|
/**
|
|
* Create a new Tidy driver object from configuration.
|
|
* @see $wgTidyConfig
|
|
* @param array|null $config Optional since 1.33
|
|
* @return bool|\MediaWiki\Tidy\TidyDriverBase
|
|
* @throws MWException
|
|
*/
|
|
public static function factory( array $config = null ) {
|
|
return new MediaWiki\Tidy\RemexDriver( $config ?? [] );
|
|
}
|
|
|
|
/**
|
|
* Set the driver to be used. This is for testing.
|
|
* @param MediaWiki\Tidy\TidyDriverBase|false|null $instance
|
|
* @deprecated Since 1.33
|
|
*/
|
|
public static function setInstance( $instance ) {
|
|
wfDeprecated( __METHOD__, '1.33' );
|
|
self::$instance = $instance;
|
|
}
|
|
|
|
/**
|
|
* Destroy the current singleton instance
|
|
*/
|
|
public static function destroySingleton() {
|
|
self::$instance = null;
|
|
}
|
|
}
|