mirror of
https://github.com/ezyang/htmlpurifier.git
synced 2024-12-23 08:51:53 +00:00
eee45fed37
git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1202 48356398-32a2-884e-a903-53898d9a118a
290 lines
11 KiB
PHP
290 lines
11 KiB
PHP
<?php
|
|
|
|
require_once 'HTMLPurifier/Strategy.php';
|
|
require_once 'HTMLPurifier/HTMLDefinition.php';
|
|
require_once 'HTMLPurifier/Generator.php';
|
|
|
|
HTMLPurifier_ConfigSchema::define(
|
|
'Core', 'AutoParagraph', false, 'bool', '
|
|
<p>
|
|
This directive will cause HTML Purifier to automatically paragraph text
|
|
in the document fragment root based on two newlines and block tags.
|
|
This directive has been available since 2.0.1.
|
|
</p>
|
|
'
|
|
);
|
|
|
|
/**
|
|
* Takes tokens makes them well-formed (balance end tags, etc.)
|
|
*/
|
|
class HTMLPurifier_Strategy_MakeWellFormed extends HTMLPurifier_Strategy
|
|
{
|
|
|
|
function execute($tokens, $config, &$context) {
|
|
$definition = $config->getHTMLDefinition();
|
|
$generator = new HTMLPurifier_Generator();
|
|
$result = array();
|
|
$current_nesting = array();
|
|
|
|
$escape_invalid_tags = $config->get('Core', 'EscapeInvalidTags');
|
|
$auto_paragraph = $config->get('Core', 'AutoParagraph');
|
|
|
|
for ($k = 0, $tokens_count = count($tokens); $k < $tokens_count; $k++) {
|
|
$token = $tokens[$k];
|
|
if (empty( $token->is_tag )) {
|
|
if ($auto_paragraph && $token->type === 'text') {
|
|
$this->autoParagraphText($result, $current_nesting, $tokens, $k, $token, $context, $config);
|
|
}
|
|
if ($token) $result[] = $token;
|
|
continue;
|
|
}
|
|
|
|
// DEFINITION CALL
|
|
$info = $definition->info[$token->name]->child;
|
|
|
|
// test if it claims to be a start tag but is empty
|
|
if ($info->type == 'empty' &&
|
|
$token->type == 'start' ) {
|
|
|
|
$result[] = new HTMLPurifier_Token_Empty($token->name,
|
|
$token->attr);
|
|
continue;
|
|
}
|
|
|
|
// test if it claims to be empty but really is a start tag
|
|
if ($info->type != 'empty' &&
|
|
$token->type == 'empty' ) {
|
|
|
|
$result[] = new HTMLPurifier_Token_Start($token->name,
|
|
$token->attr);
|
|
$result[] = new HTMLPurifier_Token_End($token->name);
|
|
|
|
continue;
|
|
}
|
|
|
|
// automatically insert empty tags
|
|
if ($token->type == 'empty') {
|
|
$result[] = $token;
|
|
continue;
|
|
}
|
|
|
|
// we give start tags precedence, so automatically accept unless...
|
|
// it's one of those special cases
|
|
if ($token->type == 'start') {
|
|
|
|
// if there's a parent, check for special case
|
|
if (!empty($current_nesting)) {
|
|
|
|
$parent = array_pop($current_nesting);
|
|
$parent_name = $parent->name;
|
|
$parent_info = $definition->info[$parent_name];
|
|
|
|
// we need to replace this with a more general
|
|
// algorithm
|
|
if (isset($parent_info->auto_close[$token->name])) {
|
|
$result[] = new HTMLPurifier_Token_End($parent_name);
|
|
$result[] = $token;
|
|
$current_nesting[] = $token;
|
|
continue;
|
|
}
|
|
|
|
$current_nesting[] = $parent; // undo the pop
|
|
}
|
|
|
|
if ($auto_paragraph) $this->autoParagraphStart($result, $current_nesting, $tokens, $k, $token, $context, $config);
|
|
|
|
$result[] = $token;
|
|
$current_nesting[] = $token;
|
|
continue;
|
|
}
|
|
|
|
// sanity check
|
|
if ($token->type != 'end') continue;
|
|
|
|
// okay, we're dealing with a closing tag
|
|
|
|
// make sure that we have something open
|
|
if (empty($current_nesting)) {
|
|
if ($escape_invalid_tags) {
|
|
$result[] = new HTMLPurifier_Token_Text(
|
|
$generator->generateFromToken($token, $config, $context)
|
|
);
|
|
}
|
|
continue;
|
|
}
|
|
|
|
// first, check for the simplest case: everything closes neatly
|
|
|
|
// current_nesting is modified
|
|
$current_parent = array_pop($current_nesting);
|
|
if ($current_parent->name == $token->name) {
|
|
$result[] = $token;
|
|
continue;
|
|
}
|
|
|
|
// undo the array_pop
|
|
$current_nesting[] = $current_parent;
|
|
|
|
// okay, so we're trying to close the wrong tag
|
|
|
|
// scroll back the entire nest, trying to find our tag
|
|
// feature could be to specify how far you'd like to go
|
|
$size = count($current_nesting);
|
|
// -2 because -1 is the last element, but we already checked that
|
|
$skipped_tags = false;
|
|
for ($i = $size - 2; $i >= 0; $i--) {
|
|
if ($current_nesting[$i]->name == $token->name) {
|
|
// current nesting is modified
|
|
$skipped_tags = array_splice($current_nesting, $i);
|
|
break;
|
|
}
|
|
}
|
|
|
|
// we still didn't find the tag, so translate to text
|
|
if ($skipped_tags === false) {
|
|
if ($escape_invalid_tags) {
|
|
$result[] = new HTMLPurifier_Token_Text(
|
|
$generator->generateFromToken($token, $config, $context)
|
|
);
|
|
}
|
|
continue;
|
|
}
|
|
|
|
// okay, we found it, close all the skipped tags
|
|
// note that skipped tags contains the element we need closed
|
|
$size = count($skipped_tags);
|
|
for ($i = $size - 1; $i >= 0; $i--) {
|
|
$result[] = new HTMLPurifier_Token_End($skipped_tags[$i]->name);
|
|
}
|
|
|
|
// done!
|
|
|
|
}
|
|
|
|
// we're at the end now, fix all still unclosed tags
|
|
|
|
if (!empty($current_nesting)) {
|
|
$size = count($current_nesting);
|
|
for ($i = $size - 1; $i >= 0; $i--) {
|
|
$result[] =
|
|
new HTMLPurifier_Token_End($current_nesting[$i]->name);
|
|
}
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Sub-function call for auto-paragraphing for any old text node.
|
|
* This will eventually
|
|
* be factored out into a generic Formatter class
|
|
* @note This function does not care at all about ending paragraph
|
|
* tags: the rest of MakeWellFormed handles that!
|
|
*/
|
|
function autoParagraphText(&$result, &$current_nesting, $tokens, $k, &$token, &$context, $config) {
|
|
$dnl = PHP_EOL . PHP_EOL; // double-newline
|
|
// paragraphing is on
|
|
if (empty($current_nesting)) {
|
|
// we're in root node, great time to start a paragraph
|
|
// since we're also dealing with a text node
|
|
$result[] = new HTMLPurifier_Token_Start('p');
|
|
$current_nesting[] = new HTMLPurifier_Token_Start('p');
|
|
$this->autoParagraphSplitText($result, $current_nesting, $tokens, $k, $token, $context, $config);
|
|
} else {
|
|
// we're not in root node, so let's see whether or not
|
|
// we're in a paragraph
|
|
|
|
// losslessly access the parent element
|
|
$parent = array_pop($current_nesting);
|
|
$current_nesting[] = $parent;
|
|
|
|
if ($parent->name === 'p') {
|
|
$this->autoParagraphSplitText($result, $current_nesting, $tokens, $k, $token, $context, $config);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Sub-function for auto-paragraphing that takes a token and splits it
|
|
* up into paragraphs unconditionally. Requires that a paragraph was
|
|
* already started
|
|
*/
|
|
function autoParagraphSplitText(&$result, &$current_nesting, $tokens, $k, &$token, &$context, $config) {
|
|
$dnl = PHP_EOL . PHP_EOL; // double-newline
|
|
$definition = $config->getHTMLDefinition();
|
|
|
|
$raw_paragraphs = explode($dnl, $token->data);
|
|
|
|
$token = false; // token has been completely dismantled
|
|
|
|
// remove empty paragraphs
|
|
$paragraphs = array();
|
|
foreach ($raw_paragraphs as $par) {
|
|
if (trim($par) !== '') $paragraphs[] = $par;
|
|
}
|
|
|
|
if (empty($paragraphs) && count($raw_paragraphs) > 1) {
|
|
$result[] = new HTMLPurifier_Token_End('p');
|
|
array_pop($current_nesting);
|
|
return;
|
|
}
|
|
|
|
foreach ($paragraphs as $data) {
|
|
$result[] = new HTMLPurifier_Token_Text($data);
|
|
$result[] = new HTMLPurifier_Token_End('p');
|
|
$result[] = new HTMLPurifier_Token_Start('p');
|
|
}
|
|
array_pop($result); // remove trailing start token
|
|
|
|
// check the outside to determine whether or not
|
|
// another start tag is needed
|
|
$end_paragraph = $this->autoParagraphEndParagraph($tokens, $k, $definition);
|
|
if (!$end_paragraph) {
|
|
array_pop($result);
|
|
} else {
|
|
array_pop($current_nesting);
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Determines if up-coming code requires an end-paragraph tag,
|
|
* otherwise, keep the paragraph open (don't make another one)
|
|
* @protected
|
|
*/
|
|
function autoParagraphEndParagraph($tokens, $k, $definition) {
|
|
$end_paragraph = false;
|
|
for ($j = $k + 1; isset($tokens[$j]); $j++) {
|
|
if ($tokens[$j]->type == 'start' || $tokens[$j]->type == 'empty') {
|
|
if ($tokens[$j]->name == 'p') $end_paragraph = true;
|
|
else $end_paragraph = isset($definition->info['p']->auto_close[$tokens[$j]->name]);
|
|
break;
|
|
} elseif ($tokens[$j]->type == 'text') {
|
|
if (!$tokens[$j]->is_whitespace) {
|
|
$end_paragraph = false;
|
|
break;
|
|
}
|
|
} elseif ($tokens[$j]->type == 'end') {
|
|
// nonsensical case
|
|
$end_paragraph = false;
|
|
break;
|
|
}
|
|
}
|
|
return $end_paragraph;
|
|
}
|
|
|
|
/**
|
|
* Sub-function for auto-paragraphing that processes element starts
|
|
*/
|
|
function autoParagraphStart(&$result, &$current_nesting, $tokens, $k, &$token, &$context, $config) {
|
|
if (!empty($current_nesting)) return;
|
|
$definition = $config->getHTMLDefinition();
|
|
// a better check would be to use the projected new algorithm
|
|
// for auto_close
|
|
if (isset($definition->info['p']->auto_close[$token->name])) return;
|
|
$result[] = $current_nesting[] = new HTMLPurifier_Token_Start('p');
|
|
}
|
|
|
|
}
|
|
|
|
?>
|