mirror of
https://github.com/ezyang/htmlpurifier.git
synced 2024-11-10 15:48:42 +00:00
01c85b71d2
git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@699 48356398-32a2-884e-a903-53898d9a118a
152 lines
5.8 KiB
PHP
152 lines
5.8 KiB
PHP
<?php
|
|
|
|
require_once 'HTMLPurifier/Lexer.php';
|
|
require_once 'HTMLPurifier/TokenFactory.php';
|
|
|
|
/**
|
|
* Parser that uses PHP 5's DOM extension (part of the core).
|
|
*
|
|
* In PHP 5, the DOM XML extension was revamped into DOM and added to the core.
|
|
* It gives us a forgiving HTML parser, which we use to transform the HTML
|
|
* into a DOM, and then into the tokens. It is blazingly fast (for large
|
|
* documents, it performs twenty times faster than
|
|
* HTMLPurifier_Lexer_DirectLex,and is the default choice for PHP 5.
|
|
*
|
|
* @note Any empty elements will have empty tokens associated with them, even if
|
|
* this is prohibited by the spec. This is cannot be fixed until the spec
|
|
* comes into play.
|
|
*
|
|
* @note PHP's DOM extension does not actually parse any entities, we use
|
|
* our own function to do that.
|
|
*
|
|
* @warning DOM tends to drop whitespace, which may wreak havoc on indenting.
|
|
* If this is a huge problem, due to the fact that HTML is hand
|
|
* edited and you are unable to get a parser cache that caches the
|
|
* the output of HTML Purifier while keeping the original HTML lying
|
|
* around, you may want to run Tidy on the resulting output or use
|
|
* HTMLPurifier_DirectLex
|
|
*/
|
|
|
|
class HTMLPurifier_Lexer_DOMLex extends HTMLPurifier_Lexer
|
|
{
|
|
|
|
private $factory;
|
|
|
|
public function __construct() {
|
|
// setup the factory
|
|
parent::HTMLPurifier_Lexer();
|
|
$this->factory = new HTMLPurifier_TokenFactory();
|
|
}
|
|
|
|
public function tokenizeHTML($string, $config, &$context) {
|
|
|
|
$string = $this->normalize($string, $config, $context);
|
|
|
|
// preprocess string, essential for UTF-8
|
|
$string =
|
|
'<!DOCTYPE html '.
|
|
'PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"'.
|
|
'"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'.
|
|
'<html><head>'.
|
|
'<meta http-equiv="Content-Type" content="text/html;'.
|
|
' charset=utf-8" />'.
|
|
'</head><body><div>'.$string.'</div></body></html>';
|
|
|
|
$doc = new DOMDocument();
|
|
$doc->encoding = 'UTF-8'; // technically does nothing, but whatever
|
|
|
|
// DOM will toss errors if the HTML its parsing has really big
|
|
// problems, so we're going to mute them. This can cause problems
|
|
// if a custom error handler that doesn't implement error_reporting
|
|
// is set, as noted by a Drupal plugin of HTML Purifier. Consider
|
|
// making our own error reporter to temporarily load in
|
|
@$doc->loadHTML($string);
|
|
|
|
$tokens = array();
|
|
$this->tokenizeDOM(
|
|
$doc->getElementsByTagName('html')->item(0)-> // html
|
|
getElementsByTagName('body')->item(0)-> // body
|
|
getElementsByTagName('div')->item(0) // div
|
|
, $tokens);
|
|
return $tokens;
|
|
}
|
|
|
|
/**
|
|
* Recursive function that tokenizes a node, putting it into an accumulator.
|
|
*
|
|
* @param $node DOMNode to be tokenized.
|
|
* @param $tokens Array-list of already tokenized tokens.
|
|
* @param $collect Says whether or start and close are collected, set to
|
|
* false at first recursion because it's the implicit DIV
|
|
* tag you're dealing with.
|
|
* @returns Tokens of node appended to previously passed tokens.
|
|
*/
|
|
protected function tokenizeDOM($node, &$tokens, $collect = false) {
|
|
// recursive goodness!
|
|
|
|
// intercept non element nodes. WE MUST catch all of them,
|
|
// but we're not getting the character reference nodes because
|
|
// those should have been preprocessed
|
|
if ($node->nodeType === XML_TEXT_NODE ||
|
|
$node->nodeType === XML_CDATA_SECTION_NODE) {
|
|
$tokens[] = $this->factory->createText($node->data);
|
|
return;
|
|
} elseif ($node->nodeType === XML_COMMENT_NODE) {
|
|
$tokens[] = $this->factory->createComment($node->data);
|
|
return;
|
|
} elseif (
|
|
// not-well tested: there may be other nodes we have to grab
|
|
$node->nodeType !== XML_ELEMENT_NODE
|
|
) {
|
|
return;
|
|
}
|
|
|
|
$attr = $node->hasAttributes() ?
|
|
$this->transformAttrToAssoc($node->attributes) :
|
|
array();
|
|
|
|
// We still have to make sure that the element actually IS empty
|
|
if (!$node->childNodes->length) {
|
|
if ($collect) {
|
|
$tokens[] = $this->factory->createEmpty($node->tagName, $attr);
|
|
}
|
|
} else {
|
|
if ($collect) { // don't wrap on first iteration
|
|
$tokens[] = $this->factory->createStart(
|
|
$tag_name = $node->tagName, // somehow, it get's dropped
|
|
$attr
|
|
);
|
|
}
|
|
foreach ($node->childNodes as $node) {
|
|
// remember, it's an accumulator. Otherwise, we'd have
|
|
// to use array_merge
|
|
$this->tokenizeDOM($node, $tokens, true);
|
|
}
|
|
if ($collect) {
|
|
$tokens[] = $this->factory->createEnd($tag_name);
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Converts a DOMNamedNodeMap of DOMAttr objects into an assoc array.
|
|
*
|
|
* @param $attribute_list DOMNamedNodeMap of DOMAttr objects.
|
|
* @returns Associative array of attributes.
|
|
*/
|
|
protected function transformAttrToAssoc($node_map) {
|
|
// NamedNodeMap is documented very well, so we're using undocumented
|
|
// features, namely, the fact that it implements Iterator and
|
|
// has a ->length attribute
|
|
if ($node_map->length === 0) return array();
|
|
$array = array();
|
|
foreach ($node_map as $attr) {
|
|
$array[$attr->name] = $attr->value;
|
|
}
|
|
return $array;
|
|
}
|
|
|
|
}
|
|
|
|
?>
|