ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
HTMLPurifier_Lexer_DOMLex Class Reference

Parser that uses PHP 5's DOM extension (part of the core). More...

+ Inheritance diagram for HTMLPurifier_Lexer_DOMLex:
+ Collaboration diagram for HTMLPurifier_Lexer_DOMLex:

Public Member Functions

 __construct ()
 
 tokenizeHTML ($html, $config, $context)
 
 muteErrorHandler ($errno, $errstr)
 An error handler that mutes all errors. More...
 
 callbackUndoCommentSubst ($matches)
 Callback function for undoing escaping of stray angled brackets in comments. More...
 
 callbackArmorCommentEntities ($matches)
 Callback function that entity-izes ampersands in comments so that callbackUndoCommentSubst doesn't clobber them. More...
 
- Public Member Functions inherited from HTMLPurifier_Lexer
 __construct ()
 
 parseText ($string, $config)
 
 parseAttr ($string, $config)
 
 parseData ($string, $is_attr, $config)
 Parses special entities into the proper characters. More...
 
 tokenizeHTML ($string, $config, $context)
 Lexes an HTML string into tokens. More...
 
 normalize ($html, $config, $context)
 Takes a piece of HTML and normalizes it by converting entities, fixing encoding, extracting bits, and other good stuff. More...
 
 extractBody ($html)
 Takes a string of HTML (fragment or document) and returns the content. More...
 

Protected Member Functions

 tokenizeDOM ($node, &$tokens, $config)
 Iterative function that tokenizes a node, putting it into an accumulator. More...
 
 createStartNode ($node, &$tokens, $collect, $config)
 
 createEndNode ($node, &$tokens)
 
 transformAttrToAssoc ($node_map)
 Converts a DOMNamedNodeMap of DOMAttr objects into an assoc array. More...
 
 wrapHTML ($html, $config, $context, $use_div=true)
 Wraps an HTML fragment in the necessary HTML. More...
 

Private Attributes

 $factory
 @type HTMLPurifier_TokenFactory More...
 

Additional Inherited Members

- Static Public Member Functions inherited from HTMLPurifier_Lexer
static create ($config)
 Retrieves or sets the default Lexer as a Prototype Factory. More...
 
- Data Fields inherited from HTMLPurifier_Lexer
 $tracksLineNumbers = false
 Whether or not this lexer implements line-number/column-number tracking. More...
 
- Static Protected Member Functions inherited from HTMLPurifier_Lexer
static escapeCDATA ($string)
 Translates CDATA sections into regular sections (through escaping). More...
 
static escapeCommentedCDATA ($string)
 Special CDATA case that is especially convoluted for <script> More...
 
static removeIEConditional ($string)
 Special Internet Explorer conditional comments should be removed. More...
 
static CDATACallback ($matches)
 Callback function for escapeCDATA() that does the work. More...
 
- Protected Attributes inherited from HTMLPurifier_Lexer
 $_special_entity2str
 Most common entity to raw value conversion table for special entities. More...
 

Detailed Description

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.
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

Definition at line 27 of file DOMLex.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLPurifier_Lexer_DOMLex::__construct ( )

Reimplemented from HTMLPurifier_Lexer.

Definition at line 35 of file DOMLex.php.

36 {
37 // setup the factory
38 parent::__construct();
39 $this->factory = new HTMLPurifier_TokenFactory();
40 }
Factory for token generation.

Member Function Documentation

◆ callbackArmorCommentEntities()

HTMLPurifier_Lexer_DOMLex::callbackArmorCommentEntities (   $matches)

Callback function that entity-izes ampersands in comments so that callbackUndoCommentSubst doesn't clobber them.

Parameters
array$matches
Returns
string

Definition at line 251 of file DOMLex.php.

252 {
253 return '<!--' . str_replace('&', '&amp;', $matches[1]) . $matches[2];
254 }

◆ callbackUndoCommentSubst()

HTMLPurifier_Lexer_DOMLex::callbackUndoCommentSubst (   $matches)

Callback function for undoing escaping of stray angled brackets in comments.

Parameters
array$matches
Returns
string

Definition at line 240 of file DOMLex.php.

241 {
242 return '<!--' . strtr($matches[1], array('&amp;' => '&', '&lt;' => '<')) . $matches[2];
243 }

◆ createEndNode()

HTMLPurifier_Lexer_DOMLex::createEndNode (   $node,
$tokens 
)
protected
Parameters
DOMNode$node
HTMLPurifier_Token[]$tokens

Definition at line 198 of file DOMLex.php.

199 {
200 $tokens[] = $this->factory->createEnd($node->tagName);
201 }

Referenced by tokenizeDOM().

+ Here is the caller graph for this function:

◆ createStartNode()

HTMLPurifier_Lexer_DOMLex::createStartNode (   $node,
$tokens,
  $collect,
  $config 
)
protected
Parameters
DOMNode$nodeDOMNode to be tokenized.
HTMLPurifier_Token[]$tokensArray-list of already tokenized tokens.
bool$collectSays 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
bool if the token needs an endtoken
Todo:
data and tagName properties don't seem to exist in DOMNode?

Definition at line 138 of file DOMLex.php.

139 {
140 // intercept non element nodes. WE MUST catch all of them,
141 // but we're not getting the character reference nodes because
142 // those should have been preprocessed
143 if ($node->nodeType === XML_TEXT_NODE) {
144 $tokens[] = $this->factory->createText($node->data);
145 return false;
146 } elseif ($node->nodeType === XML_CDATA_SECTION_NODE) {
147 // undo libxml's special treatment of <script> and <style> tags
148 $last = end($tokens);
149 $data = $node->data;
150 // (note $node->tagname is already normalized)
151 if ($last instanceof HTMLPurifier_Token_Start && ($last->name == 'script' || $last->name == 'style')) {
152 $new_data = trim($data);
153 if (substr($new_data, 0, 4) === '<!--') {
154 $data = substr($new_data, 4);
155 if (substr($data, -3) === '-->') {
156 $data = substr($data, 0, -3);
157 } else {
158 // Highly suspicious! Not sure what to do...
159 }
160 }
161 }
162 $tokens[] = $this->factory->createText($this->parseText($data, $config));
163 return false;
164 } elseif ($node->nodeType === XML_COMMENT_NODE) {
165 // this is code is only invoked for comments in script/style in versions
166 // of libxml pre-2.6.28 (regular comments, of course, are still
167 // handled regularly)
168 $tokens[] = $this->factory->createComment($node->data);
169 return false;
170 } elseif ($node->nodeType !== XML_ELEMENT_NODE) {
171 // not-well tested: there may be other nodes we have to grab
172 return false;
173 }
174
175 $attr = $node->hasAttributes() ? $this->transformAttrToAssoc($node->attributes) : array();
176
177 // We still have to make sure that the element actually IS empty
178 if (!$node->childNodes->length) {
179 if ($collect) {
180 $tokens[] = $this->factory->createEmpty($node->tagName, $attr);
181 }
182 return false;
183 } else {
184 if ($collect) {
185 $tokens[] = $this->factory->createStart(
186 $tag_name = $node->tagName, // somehow, it get's dropped
187 $attr
188 );
189 }
190 return true;
191 }
192 }
transformAttrToAssoc($node_map)
Converts a DOMNamedNodeMap of DOMAttr objects into an assoc array.
Definition: DOMLex.php:210
parseText($string, $config)
Definition: Lexer.php:172
Concrete start token class.
Definition: Start.php:7

References $config, $data, HTMLPurifier_Lexer\parseText(), and transformAttrToAssoc().

Referenced by tokenizeDOM().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ muteErrorHandler()

HTMLPurifier_Lexer_DOMLex::muteErrorHandler (   $errno,
  $errstr 
)

An error handler that mutes all errors.

Parameters
int$errno
string$errstr

Definition at line 230 of file DOMLex.php.

231 {
232 }

◆ tokenizeDOM()

HTMLPurifier_Lexer_DOMLex::tokenizeDOM (   $node,
$tokens,
  $config 
)
protected

Iterative function that tokenizes a node, putting it into an accumulator.

To iterate is human, to recurse divine - L. Peter Deutsch

Parameters
DOMNode$nodeDOMNode to be tokenized.
HTMLPurifier_Token[]$tokensArray-list of already tokenized tokens.
Returns
HTMLPurifier_Token of node appended to previously passed tokens.

Definition at line 99 of file DOMLex.php.

100 {
101 $level = 0;
102 $nodes = array($level => new HTMLPurifier_Queue(array($node)));
103 $closingNodes = array();
104 do {
105 while (!$nodes[$level]->isEmpty()) {
106 $node = $nodes[$level]->shift(); // FIFO
107 $collect = $level > 0 ? true : false;
108 $needEndingTag = $this->createStartNode($node, $tokens, $collect, $config);
109 if ($needEndingTag) {
110 $closingNodes[$level][] = $node;
111 }
112 if ($node->childNodes && $node->childNodes->length) {
113 $level++;
114 $nodes[$level] = new HTMLPurifier_Queue();
115 foreach ($node->childNodes as $childNode) {
116 $nodes[$level]->push($childNode);
117 }
118 }
119 }
120 $level--;
121 if ($level && isset($closingNodes[$level])) {
122 while ($node = array_pop($closingNodes[$level])) {
123 $this->createEndNode($node, $tokens);
124 }
125 }
126 } while ($level > 0);
127 }
createEndNode($node, &$tokens)
Definition: DOMLex.php:198
createStartNode($node, &$tokens, $collect, $config)
Definition: DOMLex.php:138
A simple array-backed queue, based off of the classic Okasaki persistent amortized queue.
Definition: Queue.php:20

References $config, createEndNode(), and createStartNode().

Referenced by tokenizeHTML(), and HTMLPurifier_Lexer_PH5P\tokenizeHTML().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ tokenizeHTML()

HTMLPurifier_Lexer_DOMLex::tokenizeHTML (   $html,
  $config,
  $context 
)
Parameters
string$html
HTMLPurifier_Config$config
HTMLPurifier_Context$context
Returns
HTMLPurifier_Token[]

Reimplemented from HTMLPurifier_Lexer.

Reimplemented in HTMLPurifier_Lexer_PH5P.

Definition at line 48 of file DOMLex.php.

49 {
50 $html = $this->normalize($html, $config, $context);
51
52 // attempt to armor stray angled brackets that cannot possibly
53 // form tags and thus are probably being used as emoticons
54 if ($config->get('Core.AggressivelyFixLt')) {
55 $char = '[^a-z!\/]';
56 $comment = "/<!--(.*?)(-->|\z)/is";
57 $html = preg_replace_callback($comment, array($this, 'callbackArmorCommentEntities'), $html);
58 do {
59 $old = $html;
60 $html = preg_replace("/<($char)/i", '&lt;\\1', $html);
61 } while ($html !== $old);
62 $html = preg_replace_callback($comment, array($this, 'callbackUndoCommentSubst'), $html); // fix comments
63 }
64
65 // preprocess html, essential for UTF-8
66 $html = $this->wrapHTML($html, $config, $context);
67
68 $doc = new DOMDocument();
69 $doc->encoding = 'UTF-8'; // theoretically, the above has this covered
70
71 set_error_handler(array($this, 'muteErrorHandler'));
72 $doc->loadHTML($html);
73 restore_error_handler();
74
75 $body = $doc->getElementsByTagName('html')->item(0)-> // <html>
76 getElementsByTagName('body')->item(0); // <body>
77
78 $div = $body->getElementsByTagName('div')->item(0); // <div>
79 $tokens = array();
80 $this->tokenizeDOM($div, $tokens, $config);
81 // If the div has a sibling, that means we tripped across
82 // a premature </div> tag. So remove the div we parsed,
83 // and then tokenize the rest of body. We can't tokenize
84 // the sibling directly as we'll lose the tags in that case.
85 if ($div->nextSibling) {
86 $body->removeChild($div);
87 $this->tokenizeDOM($body, $tokens, $config);
88 }
89 return $tokens;
90 }
$comment
Definition: buildRTE.php:83
tokenizeDOM($node, &$tokens, $config)
Iterative function that tokenizes a node, putting it into an accumulator.
Definition: DOMLex.php:99
wrapHTML($html, $config, $context, $use_div=true)
Wraps an HTML fragment in the necessary HTML.
Definition: DOMLex.php:263
normalize($html, $config, $context)
Takes a piece of HTML and normalizes it by converting entities, fixing encoding, extracting bits,...
Definition: Lexer.php:305
$html
Definition: example_001.php:87
$old

References $comment, $config, $html, $old, HTMLPurifier_Lexer\normalize(), tokenizeDOM(), and wrapHTML().

+ Here is the call graph for this function:

◆ transformAttrToAssoc()

HTMLPurifier_Lexer_DOMLex::transformAttrToAssoc (   $node_map)
protected

Converts a DOMNamedNodeMap of DOMAttr objects into an assoc array.

Parameters
DOMNamedNodeMap$node_mapDOMNamedNodeMap of DOMAttr objects.
Returns
array Associative array of attributes.

Definition at line 210 of file DOMLex.php.

211 {
212 // NamedNodeMap is documented very well, so we're using undocumented
213 // features, namely, the fact that it implements Iterator and
214 // has a ->length attribute
215 if ($node_map->length === 0) {
216 return array();
217 }
218 $array = array();
219 foreach ($node_map as $attr) {
220 $array[$attr->name] = $attr->value;
221 }
222 return $array;
223 }

Referenced by createStartNode().

+ Here is the caller graph for this function:

◆ wrapHTML()

HTMLPurifier_Lexer_DOMLex::wrapHTML (   $html,
  $config,
  $context,
  $use_div = true 
)
protected

Wraps an HTML fragment in the necessary HTML.

Parameters
string$html
HTMLPurifier_Config$config
HTMLPurifier_Context$context
Returns
string

Definition at line 263 of file DOMLex.php.

264 {
265 $def = $config->getDefinition('HTML');
266 $ret = '';
267
268 if (!empty($def->doctype->dtdPublic) || !empty($def->doctype->dtdSystem)) {
269 $ret .= '<!DOCTYPE html ';
270 if (!empty($def->doctype->dtdPublic)) {
271 $ret .= 'PUBLIC "' . $def->doctype->dtdPublic . '" ';
272 }
273 if (!empty($def->doctype->dtdSystem)) {
274 $ret .= '"' . $def->doctype->dtdSystem . '" ';
275 }
276 $ret .= '>';
277 }
278
279 $ret .= '<html><head>';
280 $ret .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
281 // No protection if $html contains a stray </div>!
282 $ret .= '</head><body>';
283 if ($use_div) $ret .= '<div>';
284 $ret .= $html;
285 if ($use_div) $ret .= '</div>';
286 $ret .= '</body></html>';
287 return $ret;
288 }
$def
Definition: croninfo.php:21
$ret
Definition: parser.php:6

References $config, $def, $html, and $ret.

Referenced by tokenizeHTML(), and HTMLPurifier_Lexer_PH5P\tokenizeHTML().

+ Here is the caller graph for this function:

Field Documentation

◆ $factory

HTMLPurifier_Lexer_DOMLex::$factory
private

@type HTMLPurifier_TokenFactory

Definition at line 33 of file DOMLex.php.


The documentation for this class was generated from the following file: