PHPIDS
Current file: /home/mario/workspace/php-ids.org/trunk/lib/IDS/vendors/htmlpurifier/HTMLPurifier/Lexer/DOMLex.php
Legend: executed not executed dead code

  Coverage
  Classes Methods Lines
Total
100.00 %100.00%
100.00% 1 / 1
75.00 %75.00%
75.00% 6 / 8
82.02 %82.02%
82.02% 73 / 89
 
HTMLPurifier_Lexer_DOMLex
100.00 %100.00%
100.00% 1 / 1
75.00 %75.00%
75.00% 6 / 8
82.02 %82.02%
82.02% 73 / 89
 public function __construct()
100.00 %100.00%
100.00% 1 / 1
100.00 %100.00%
100.00% 3 / 3
 public function tokenizeHTML($html, $config, $context)
100.00 %100.00%
100.00% 1 / 1
71.43 %71.43%
71.43% 15 / 21
 protected function tokenizeDOM($node, &$tokens, $collect = false)
100.00 %100.00%
100.00% 1 / 1
81.40 %81.40%
81.40% 35 / 43
 protected function transformAttrToAssoc($node_map)
100.00 %100.00%
100.00% 1 / 1
100.00 %100.00%
100.00% 6 / 6
 public function muteErrorHandler($errno, $errstr)
100.00 %100.00%
100.00% 1 / 1
100.00 %100.00%
100.00% 1 / 1
 public function callbackUndoCommentSubst($matches)
0.00 %0.00%
0.00% 0 / 1
0.00 %0.00%
0.00% 0 / 1
 public function callbackArmorCommentEntities($matches)
0.00 %0.00%
0.00% 0 / 1
0.00 %0.00%
0.00% 0 / 1
 protected function wrapHTML($html, $config, $context)
100.00 %100.00%
100.00% 1 / 1
100.00 %100.00%
100.00% 12 / 12


       1                 : <?php                                                                                                                
       2                 :                                                                                                                      
       3                 : /**                                                                                                                  
       4                 :  * Parser that uses PHP 5's DOM extension (part of the core).                                                        
       5                 :  *                                                                                                                   
       6                 :  * In PHP 5, the DOM XML extension was revamped into DOM and added to the core.                                      
       7                 :  * It gives us a forgiving HTML parser, which we use to transform the HTML                                           
       8                 :  * into a DOM, and then into the tokens.  It is blazingly fast (for large                                            
       9                 :  * documents, it performs twenty times faster than                                                                   
      10                 :  * HTMLPurifier_Lexer_DirectLex,and is the default choice for PHP 5.                                                 
      11                 :  *                                                                                                                   
      12                 :  * @note Any empty elements will have empty tokens associated with them, even if                                     
      13                 :  * this is prohibited by the spec. This is cannot be fixed until the spec                                            
      14                 :  * comes into play.                                                                                                  
      15                 :  *                                                                                                                   
      16                 :  * @note PHP's DOM extension does not actually parse any entities, we use                                            
      17                 :  *       our own function to do that.                                                                                
      18                 :  *                                                                                                                   
      19                 :  * @warning DOM tends to drop whitespace, which may wreak havoc on indenting.                                        
      20                 :  *          If this is a huge problem, due to the fact that HTML is hand                                             
      21                 :  *          edited and you are unable to get a parser cache that caches the                                          
      22                 :  *          the output of HTML Purifier while keeping the original HTML lying                                        
      23                 :  *          around, you may want to run Tidy on the resulting output or use                                          
      24                 :  *          HTMLPurifier_DirectLex                                                                                   
      25                 :  */                                                                                                                  
      26                 :                                                                                                                      
      27               1 : class HTMLPurifier_Lexer_DOMLex extends HTMLPurifier_Lexer                                                           
      28                 : {                                                                                                                    
      29                 :                                                                                                                      
      30                 :     private $factory;                                                                                                
      31                 :                                                                                                                      
      32                 :     public function __construct() {                                                                                  
      33                 :         // setup the factory                                                                                         
      34               2 :         parent::__construct();                                                                                       
      35               2 :         $this->factory = new HTMLPurifier_TokenFactory();                                                            
      36               2 :     }                                                                                                                
      37                 :                                                                                                                      
      38                 :     public function tokenizeHTML($html, $config, $context) {                                                         
      39                 :                                                                                                                      
      40               2 :         $html = $this->normalize($html, $config, $context);                                                          
      41                 :                                                                                                                      
      42                 :         // attempt to armor stray angled brackets that cannot possibly                                               
      43                 :         // form tags and thus are probably being used as emoticons                                                   
      44               2 :         if ($config->get('Core', 'AggressivelyFixLt')) {                                                             
      45               0 :             $char = '[^a-z!\/]';                                                                                     
      46               0 :             $comment = "/<!--(.*?)(-->|\z)/is";                                                                      
      47               0 :             $html = preg_replace_callback($comment, array($this, 'callbackArmorCommentEntities'), $html);            
      48               0 :             $html = preg_replace("/<($char)/i", '&lt;\\1', $html);                                                   
      49               0 :             $html = preg_replace_callback($comment, array($this, 'callbackUndoCommentSubst'), $html); // fix comments
      50               0 :         }                                                                                                            
      51                 :                                                                                                                      
      52                 :         // preprocess html, essential for UTF-8                                                                      
      53               2 :         $html = $this->wrapHTML($html, $config, $context);                                                           
      54                 :                                                                                                                      
      55               2 :         $doc = new DOMDocument();                                                                                    
      56               2 :         $doc->encoding = 'UTF-8'; // theoretically, the above has this covered                                       
      57                 :                                                                                                                      
      58               2 :         set_error_handler(array($this, 'muteErrorHandler'));                                                         
      59               2 :         $doc->loadHTML($html);                                                                                       
      60               2 :         restore_error_handler();                                                                                     
      61                 :                                                                                                                      
      62               2 :         $tokens = array();                                                                                           
      63               2 :         $this->tokenizeDOM(                                                                                          
      64               2 :             $doc->getElementsByTagName('html')->item(0)-> // <html>                                                  
      65               2 :                   getElementsByTagName('body')->item(0)-> //   <body>                                                
      66               2 :                   getElementsByTagName('div')->item(0)    //     <div>                                               
      67               2 :             , $tokens);                                                                                              
      68               2 :         return $tokens;                                                                                              
      69                 :     }                                                                                                                
      70                 :                                                                                                                      
      71                 :     /**                                                                                                              
      72                 :      * Recursive function that tokenizes a node, putting it into an accumulator.                                     
      73                 :      *                                                                                                               
      74                 :      * @param $node     DOMNode to be tokenized.                                                                     
      75                 :      * @param $tokens   Array-list of already tokenized tokens.                                                      
      76                 :      * @param $collect  Says whether or start and close are collected, set to                                        
      77                 :      *                  false at first recursion because it's the implicit DIV                                       
      78                 :      *                  tag you're dealing with.                                                                     
      79                 :      * @returns Tokens of node appended to previously passed tokens.                                                 
      80                 :      */                                                                                                              
      81                 :     protected function tokenizeDOM($node, &$tokens, $collect = false) {                                              
      82                 :                                                                                                                      
      83                 :         // intercept non element nodes. WE MUST catch all of them,                                                   
      84                 :         // but we're not getting the character reference nodes because                                               
      85                 :         // those should have been preprocessed                                                                       
      86               2 :         if ($node->nodeType === XML_TEXT_NODE) {                                                                     
      87               2 :             $tokens[] = $this->factory->createText($node->data);                                                     
      88               2 :             return;                                                                                                  
      89               2 :         } elseif ($node->nodeType === XML_CDATA_SECTION_NODE) {                                                      
      90                 :             // undo libxml's special treatment of <script> and <style> tags                                          
      91               1 :             $last = end($tokens);                                                                                    
      92               1 :             $data = $node->data;                                                                                     
      93                 :             // (note $node->tagname is already normalized)                                                           
      94               1 :             if ($last instanceof HTMLPurifier_Token_Start && ($last->name == 'script' || $last->name == 'style')) {  
      95               1 :                 $new_data = trim($data);                                                                             
      96               1 :                 if (substr($new_data, 0, 4) === '<!--') {                                                            
      97               0 :                     $data = substr($new_data, 4);                                                                    
      98               0 :                     if (substr($data, -3) === '-->') {                                                               
      99               0 :                         $data = substr($data, 0, -3);                                                                
     100               0 :                     } else {                                                                                         
     101                 :                         // Highly suspicious! Not sure what to do...                                                 
     102                 :                     }                                                                                                
     103               0 :                 }                                                                                                    
     104               1 :             }                                                                                                        
     105               1 :             $tokens[] = $this->factory->createText($this->parseData($data));                                         
     106               1 :             return;                                                                                                  
     107               2 :         } elseif ($node->nodeType === XML_COMMENT_NODE) {                                                            
     108                 :             // this is code is only invoked for comments in script/style in versions                                 
     109                 :             // of libxml pre-2.6.28 (regular comments, of course, are still                                          
     110                 :             // handled regularly)                                                                                    
     111               0 :             $tokens[] = $this->factory->createComment($node->data);                                                  
     112               0 :             return;                                                                                                  
     113                 :         } elseif (                                                                                                   
     114                 :             // not-well tested: there may be other nodes we have to grab                                             
     115               2 :             $node->nodeType !== XML_ELEMENT_NODE                                                                     
     116               2 :         ) {                                                                                                          
     117               0 :             return;                                                                                                  
     118                 :         }                                                                                                            
     119                 :                                                                                                                      
     120               2 :         $attr = $node->hasAttributes() ?                                                                             
     121               2 :             $this->transformAttrToAssoc($node->attributes) :                                                         
     122               2 :             array();                                                                                                 
     123                 :                                                                                                                      
     124                 :         // We still have to make sure that the element actually IS empty                                             
     125               2 :         if (!$node->childNodes->length) {                                                                            
     126               2 :             if ($collect) {                                                                                          
     127               2 :                 $tokens[] = $this->factory->createEmpty($node->tagName, $attr);                                      
     128               2 :             }                                                                                                        
     129               2 :         } else {                                                                                                     
     130               2 :             if ($collect) { // don't wrap on first iteration                                                         
     131               2 :                 $tokens[] = $this->factory->createStart(                                                             
     132               2 :                     $tag_name = $node->tagName, // somehow, it get's dropped                                         
     133                 :                     $attr                                                                                            
     134               2 :                 );                                                                                                   
     135               2 :             }                                                                                                        
     136               2 :             foreach ($node->childNodes as $node) {                                                                   
     137                 :                 // remember, it's an accumulator. Otherwise, we'd have                                               
     138                 :                 // to use array_merge                                                                                
     139               2 :                 $this->tokenizeDOM($node, $tokens, true);                                                            
     140               2 :             }                                                                                                        
     141               2 :             if ($collect) {                                                                                          
     142               2 :                 $tokens[] = $this->factory->createEnd($tag_name);                                                    
     143               2 :             }                                                                                                        
     144                 :         }                                                                                                            
     145                 :                                                                                                                      
     146               2 :     }                                                                                                                
     147                 :                                                                                                                      
     148                 :     /**                                                                                                              
     149                 :      * Converts a DOMNamedNodeMap of DOMAttr objects into an assoc array.                                            
     150                 :      *                                                                                                               
     151                 :      * @param $attribute_list DOMNamedNodeMap of DOMAttr objects.                                                    
     152                 :      * @returns Associative array of attributes.                                                                     
     153                 :      */                                                                                                              
     154                 :     protected function transformAttrToAssoc($node_map) {                                                             
     155                 :         // NamedNodeMap is documented very well, so we're using undocumented                                         
     156                 :         // features, namely, the fact that it implements Iterator and                                                
     157                 :         // has a ->length attribute                                                                                  
     158               2 :         if ($node_map->length === 0) return array();                                                                 
     159               2 :         $array = array();                                                                                            
     160               2 :         foreach ($node_map as $attr) {                                                                               
     161               2 :             $array[$attr->name] = $attr->value;                                                                      
     162               2 :         }                                                                                                            
     163               2 :         return $array;                                                                                               
     164                 :     }                                                                                                                
     165                 :                                                                                                                      
     166                 :     /**                                                                                                              
     167                 :      * An error handler that mutes all errors                                                                        
     168                 :      */                                                                                                              
     169               1 :     public function muteErrorHandler($errno, $errstr) {}                                                             
     170                 :                                                                                                                      
     171                 :     /**                                                                                                              
     172                 :      * Callback function for undoing escaping of stray angled brackets                                               
     173                 :      * in comments                                                                                                   
     174                 :      */                                                                                                              
     175                 :     public function callbackUndoCommentSubst($matches) {                                                             
     176               0 :         return '<!--' . strtr($matches[1], array('&amp;'=>'&','&lt;'=>'<')) . $matches[2];                           
     177                 :     }                                                                                                                
     178                 :                                                                                                                      
     179                 :     /**                                                                                                              
     180                 :      * Callback function that entity-izes ampersands in comments so that                                             
     181                 :      * callbackUndoCommentSubst doesn't clobber them                                                                 
     182                 :      */                                                                                                              
     183                 :     public function callbackArmorCommentEntities($matches) {                                                         
     184               0 :         return '<!--' . str_replace('&', '&amp;', $matches[1]) . $matches[2];                                        
     185                 :     }                                                                                                                
     186                 :                                                                                                                      
     187                 :     /**                                                                                                              
     188                 :      * Wraps an HTML fragment in the necessary HTML                                                                  
     189                 :      */                                                                                                              
     190                 :     protected function wrapHTML($html, $config, $context) {                                                          
     191               2 :         $def = $config->getDefinition('HTML');                                                                       
     192               2 :         $ret = '';                                                                                                   
     193                 :                                                                                                                      
     194               2 :         if (!empty($def->doctype->dtdPublic) || !empty($def->doctype->dtdSystem)) {                                  
     195               2 :             $ret .= '<!DOCTYPE html ';                                                                               
     196               2 :             if (!empty($def->doctype->dtdPublic)) $ret .= 'PUBLIC "' . $def->doctype->dtdPublic . '" ';              
     197               2 :             if (!empty($def->doctype->dtdSystem)) $ret .= '"' . $def->doctype->dtdSystem . '" ';                     
     198               2 :             $ret .= '>';                                                                                             
     199               2 :         }                                                                                                            
     200                 :                                                                                                                      
     201               2 :         $ret .= '<html><head>';                                                                                      
     202               2 :         $ret .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';                             
     203                 :         // No protection if $html contains a stray </div>!                                                           
     204               2 :         $ret .= '</head><body><div>'.$html.'</div></body></html>';                                                   
     205               2 :         return $ret;                                                                                                 
     206                 :     }                                                                                                                
     207                 :                                                                                                                      
     208                 : }                                                                                                                    
     209                 :                                                                                                                      

Generated by PHPUnit 3.3.1 and Xdebug 2.0.2 at Thu Sep 25 18:42:10 CEST 2008.