includes/HtmlFormatter.php

   1 <?php
   2 /**
   3  * Performs transformations of HTML by wrapping around libxml2 and working
   4  * around its countless bugs.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  */
  23 class HtmlFormatter {
  24         /**
  25          * @var DOMDocument
  26          */
  27         private $doc;
  28
  29         private $html;
  30         private $itemsToRemove = array();
  31         private $elementsToFlatten = array();
  32         protected $removeMedia = false;
  33
  34         /**
  35          * Constructor
  36          *
  37          * @param string $html: Text to process
  38          */
  39         public function __construct( $html ) {
  40                 $this->html = $html;
  41         }
  42
  43         /**
  44          * Turns a chunk of HTML into a proper document
  45          * @param string $html
  46          * @return string
  47          */
  48         public static function wrapHTML( $html ) {
  49                 return '<!doctype html><html><head></head><body>' . $html . '</body></html>';
  50         }
  51
  52         /**
  53          * Override this in descendant class to modify HTML after it has been converted from DOM tree
  54          * @param string $html: HTML to process
  55          * @return string: Processed HTML
  56          */
  57         protected function onHtmlReady( $html ) {
  58                 return $html;
  59         }
  60
  61         /**
  62          * @return DOMDocument: DOM to manipulate
  63          */
  64         public function getDoc() {
  65                 if ( !$this->doc ) {
  66                         $html = mb_convert_encoding( $this->html, 'HTML-ENTITIES', 'UTF-8' );
  67
  68                         // Workaround for bug that caused spaces before references
  69                         // to disappear during processing:
  70                         // https://bugzilla.wikimedia.org/show_bug.cgi?id=53086
  71                         //
  72                         // Please replace with a better fix if one can be found.
  73                         $html = str_replace( ' <', '&#32;<', $html );
  74
  75                         libxml_use_internal_errors( true );
  76                         $loader = libxml_disable_entity_loader();
  77                         $this->doc = new DOMDocument();
  78                         $this->doc->strictErrorChecking = false;
  79                         $this->doc->loadHTML( $html );
  80                         libxml_disable_entity_loader( $loader );
  81                         libxml_use_internal_errors( false );
  82                         $this->doc->encoding = 'UTF-8';
  83                 }
  84                 return $this->doc;
  85         }
  86
  87         /**
  88          * Sets whether images/videos/sounds should be removed from output
  89          * @param bool $flag
  90          */
  91         public function setRemoveMedia( $flag = true ) {
  92                 $this->removeMedia = $flag;
  93         }
  94
  95         /**
  96          * Adds one or more selector of content to remove. A subset of CSS selector
  97          * syntax is supported:
  98          *
  99          *   <tag>
 100          *   <tag>.class
 101          *   .<class>
 102          *   #<id>
 103          *
 104          * @param Array|string $selectors: Selector(s) of stuff to remove
 105          */
 106         public function remove( $selectors ) {
 107                 $this->itemsToRemove = array_merge( $this->itemsToRemove, (array)$selectors );
 108         }
 109
 110         /**
 111          * Adds one or more element name to the list to flatten (remove tag, but not its content)
 112          * Can accept undelimited regexes
 113          *
 114          * Note this interface may fail in surprising unexpected ways due to usage of regexes,
 115          * so should not be relied on for HTML markup security measures.
 116          *
 117          * @param Array|string $elements: Name(s) of tag(s) to flatten
 118          */
 119         public function flatten( $elements ) {
 120                 $this->elementsToFlatten = array_merge( $this->elementsToFlatten, (array)$elements );
 121         }
 122
 123         /**
 124          * Instructs the formatter to flatten all tags
 125          */
 126         public function flattenAllTags() {
 127                 $this->flatten( '[?!]?[a-z0-9]+' );
 128         }
 129
 130         /**
 131          * Removes content we've chosen to remove
 132          */
 133         public function filterContent() {
 134                 wfProfileIn( __METHOD__ );
 135                 $removals = $this->parseItemsToRemove();
 136
 137                 if ( !$removals ) {
 138                         return;
 139                 }
 140
 141                 $doc = $this->getDoc();
 142
 143                 // Remove tags
 144
 145                 // You can't remove DOMNodes from a DOMNodeList as you're iterating
 146                 // over them in a foreach loop. It will seemingly leave the internal
 147                 // iterator on the foreach out of wack and results will be quite
 148                 // strange. Though, making a queue of items to remove seems to work.
 149                 $domElemsToRemove = array();
 150                 foreach ( $removals['TAG'] as $tagToRemove ) {
 151                         $tagToRemoveNodes = $doc->getElementsByTagName( $tagToRemove );
 152                         foreach ( $tagToRemoveNodes as $tagToRemoveNode ) {
 153                                 if ( $tagToRemoveNode ) {
 154                                         $domElemsToRemove[] = $tagToRemoveNode;
 155                                 }
 156                         }
 157                 }
 158
 159                 $this->removeElements( $domElemsToRemove );
 160
 161                 // Elements with named IDs
 162                 $domElemsToRemove = array();
 163                 foreach ( $removals['ID'] as $itemToRemove ) {
 164                         $itemToRemoveNode = $doc->getElementById( $itemToRemove );
 165                         if ( $itemToRemoveNode ) {
 166                                 $domElemsToRemove[] = $itemToRemoveNode;
 167                         }
 168                 }
 169                 $this->removeElements( $domElemsToRemove );
 170
 171                 // CSS Classes
 172                 $domElemsToRemove = array();
 173                 $xpath = new DOMXpath( $doc );
 174                 foreach ( $removals['CLASS'] as $classToRemove ) {
 175                         $elements = $xpath->query( '//*[contains(@class, "' . $classToRemove . '")]' );
 176
 177                         /** @var $element DOMElement */
 178                         foreach ( $elements as $element ) {
 179                                 $classes = $element->getAttribute( 'class' );
 180                                 if ( preg_match( "/\b$classToRemove\b/", $classes ) && $element->parentNode ) {
 181                                         $domElemsToRemove[] = $element;
 182                                 }
 183                         }
 184                 }
 185                 $this->removeElements( $domElemsToRemove );
 186
 187                 // Tags with CSS Classes
 188                 foreach ( $removals['TAG_CLASS'] as $classToRemove ) {
 189                         $parts = explode( '.', $classToRemove );
 190
 191                         $elements = $xpath->query(
 192                                 '//' . $parts[0] . '[@class="' . $parts[1] . '"]'
 193                         );
 194
 195                         $this->removeElements( $elements );
 196                 }
 197
 198                 wfProfileOut( __METHOD__ );
 199         }
 200
 201         /**
 202          * Removes a list of elelments from DOMDocument
 203          * @param array|DOMNodeList $elements
 204          */
 205         private function removeElements( $elements ) {
 206                 $list = $elements;
 207                 if ( $elements instanceof DOMNodeList ) {
 208                         $list = array();
 209                         foreach ( $elements as $element ) {
 210                                 $list[] = $element;
 211                         }
 212                 }
 213                 /** @var $element DOMElement */
 214                 foreach ( $list as $element ) {
 215                         if ( $element->parentNode ) {
 216                                 $element->parentNode->removeChild( $element );
 217                         }
 218                 }
 219         }
 220
 221         /**
 222          * libxml in its usual pointlessness converts many chars to entities - this function
 223          * perfoms a reverse conversion
 224          * @param string $html
 225          * @return string
 226          */
 227         private function fixLibXML( $html ) {
 228                 wfProfileIn( __METHOD__ );
 229                 static $replacements;
 230                 if ( ! $replacements ) {
 231                         // We don't include rules like '&#34;' => '&amp;quot;' because entities had already been
 232                         // normalized by libxml. Using this function with input not sanitized by libxml is UNSAFE!
 233                         $replacements = new ReplacementArray( array(
 234                                 '&quot;' => '&amp;quot;',
 235                                 '&amp;' => '&amp;amp;',
 236                                 '&lt;' => '&amp;lt;',
 237                                 '&gt;' => '&amp;gt;',
 238                         ) );
 239                 }
 240                 $html = $replacements->replace( $html );
 241                 $html = mb_convert_encoding( $html, 'UTF-8', 'HTML-ENTITIES' );
 242                 wfProfileOut( __METHOD__ );
 243                 return $html;
 244         }
 245
 246         /**
 247          * Performs final transformations and returns resulting HTML
 248          *
 249          * @param DOMElement|string|null $element: ID of element to get HTML from or false to get it from the whole tree
 250          * @return string: Processed HTML
 251          */
 252         public function getText( $element = null ) {
 253                 wfProfileIn( __METHOD__ );
 254
 255                 if ( $this->doc ) {
 256                         if ( $element !== null && !( $element instanceof DOMElement ) ) {
 257                                 $element = $this->doc->getElementById( $element );
 258                         }
 259                         if ( $element ) {
 260                                 $body = $this->doc->getElementsByTagName( 'body' )->item( 0 );
 261                                 $nodesArray = array();
 262                                 foreach ( $body->childNodes as $node ) {
 263                                         $nodesArray[] = $node;
 264                                 }
 265                                 foreach ( $nodesArray as $nodeArray ) {
 266                                         $body->removeChild( $nodeArray );
 267                                 }
 268                                 $body->appendChild( $element );
 269                         }
 270                         $html = $this->doc->saveHTML();
 271                         $html = $this->fixLibXml( $html );
 272                 } else {
 273                         $html = $this->html;
 274                 }
 275                 if ( wfIsWindows() ) {
 276                         // Appears to be cleanup for CRLF misprocessing of unknown origin
 277                         // when running server on Windows platform.
 278                         //
 279                         // If this error continues in the future, please track it down in the
 280                         // XML code paths if possible and fix there.
 281                         $html = str_replace( '&#13;', '', $html );
 282                 }
 283                 $html = preg_replace( '/<!--.*?-->|^.*?<body>|<\/body>.*$/s', '', $html );
 284                 $html = $this->onHtmlReady( $html );
 285
 286                 if ( $this->elementsToFlatten ) {
 287                         $elements = implode( '|', $this->elementsToFlatten );
 288                         $html = preg_replace( "#</?($elements)\\b[^>]*>#is", '', $html );
 289                 }
 290
 291                 wfProfileOut( __METHOD__ );
 292                 return $html;
 293         }
 294
 295         /**
 296          * @param $selector: CSS selector to parse
 297          * @param $type
 298          * @param $rawName
 299          * @return bool: Whether the selector was successfully recognised
 300          */
 301         protected function parseSelector( $selector, &$type, &$rawName ) {
 302                 if ( strpos( $selector, '.' ) === 0 ) {
 303                         $type = 'CLASS';
 304                         $rawName = substr( $selector, 1 );
 305                 } elseif ( strpos( $selector, '#' ) === 0 ) {
 306                         $type = 'ID';
 307                         $rawName = substr( $selector, 1 );
 308                 } elseif ( strpos( $selector, '.' ) !== 0 &&
 309                         strpos( $selector, '.' ) !== false )
 310                 {
 311                         $type = 'TAG_CLASS';
 312                         $rawName = $selector;
 313                 } elseif ( strpos( $selector, '[' ) === false
 314                         && strpos( $selector, ']' ) === false )
 315                 {
 316                         $type = 'TAG';
 317                         $rawName = $selector;
 318                 } else {
 319                         throw new MWException( __METHOD__ . "(): unrecognized selector '$selector'" );
 320                 }
 321
 322                 return true;
 323         }
 324
 325         /**
 326          * Transforms CSS selectors into an internal representation suitable for processing
 327          * @return array
 328          */
 329         protected function parseItemsToRemove() {
 330                 wfProfileIn( __METHOD__ );
 331                 $removals = array(
 332                         'ID' => array(),
 333                         'TAG' => array(),
 334                         'CLASS' => array(),
 335                         'TAG_CLASS' => array(),
 336                 );
 337
 338                 foreach ( $this->itemsToRemove as $itemToRemove ) {
 339                         $type = '';
 340                         $rawName = '';
 341                         if ( $this->parseSelector( $itemToRemove, $type, $rawName ) ) {
 342                                 $removals[$type][] = $rawName;
 343                         }
 344                 }
 345
 346                 if ( $this->removeMedia ) {
 347                         $removals['TAG'][] = 'img';
 348                         $removals['TAG'][] = 'audio';
 349                         $removals['TAG'][] = 'video';
 350                 }
 351
 352                 wfProfileOut( __METHOD__ );
 353                 return $removals;
 354         }
 355 }