PHPIDS
Current file: /home/mario/workspace/php-ids.org/trunk/lib/IDS/vendors/htmlpurifier/HTMLPurifier/HTMLModuleManager.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
83.73 %83.73%
83.73% 139 / 166
 
HTMLPurifier_HTMLModuleManager
100.00 %100.00%
100.00% 1 / 1
75.00 %75.00%
75.00% 6 / 8
83.73 %83.73%
83.73% 139 / 166
 public function __construct()
100.00 %100.00%
100.00% 1 / 1
100.00 %100.00%
100.00% 45 / 45
 public function registerModule($module, $overload = false)
100.00 %100.00%
100.00% 1 / 1
57.69 %57.69%
57.69% 15 / 26
 public function addModule($module)
0.00 %0.00%
0.00% 0 / 1
0.00 %0.00%
0.00% 0 / 4
 public function addPrefix($prefix)
0.00 %0.00%
0.00% 0 / 1
0.00 %0.00%
0.00% 0 / 2
 public function setup($config)
100.00 %100.00%
100.00% 1 / 1
82.50 %82.50%
82.50% 33 / 40
 public function processModule($module)
100.00 %100.00%
100.00% 1 / 1
100.00 %100.00%
100.00% 5 / 5
 public function getElements()
100.00 %100.00%
100.00% 1 / 1
100.00 %100.00%
100.00% 12 / 12
 public function getElement($name, $trusted = NULL)
100.00 %100.00%
100.00% 1 / 1
90.32 %90.32%
90.32% 28 / 31


       1                 : <?php                                                                                                              
       2                 :                                                                                                                    
       3                 : class HTMLPurifier_HTMLModuleManager                                                                               
       4               1 : {                                                                                                                  
       5                 :                                                                                                                    
       6                 :     /**                                                                                                            
       7                 :      * Instance of HTMLPurifier_DoctypeRegistry                                                                    
       8                 :      */                                                                                                            
       9                 :     public $doctypes;                                                                                              
      10                 :                                                                                                                    
      11                 :     /**                                                                                                            
      12                 :      * Instance of current doctype                                                                                 
      13                 :      */                                                                                                            
      14                 :     public $doctype;                                                                                               
      15                 :                                                                                                                    
      16                 :     /**                                                                                                            
      17                 :      * Instance of HTMLPurifier_AttrTypes                                                                          
      18                 :      */                                                                                                            
      19                 :     public $attrTypes;                                                                                             
      20                 :                                                                                                                    
      21                 :     /**                                                                                                            
      22                 :      * Active instances of modules for the specified doctype are                                                   
      23                 :      * indexed, by name, in this array.                                                                            
      24                 :      */                                                                                                            
      25                 :     public $modules = array();                                                                                     
      26                 :                                                                                                                    
      27                 :     /**                                                                                                            
      28                 :      * Array of recognized HTMLPurifier_Module instances, indexed by                                               
      29                 :      * module's class name. This array is usually lazy loaded, but a                                               
      30                 :      * user can overload a module by pre-emptively registering it.                                                 
      31                 :      */                                                                                                            
      32                 :     public $registeredModules = array();                                                                           
      33                 :                                                                                                                    
      34                 :     /**                                                                                                            
      35                 :      * List of extra modules that were added by the user using addModule().                                        
      36                 :      * These get unconditionally merged into the current doctype, whatever                                         
      37                 :      * it may be.                                                                                                  
      38                 :      */                                                                                                            
      39                 :     public $userModules = array();                                                                                 
      40                 :                                                                                                                    
      41                 :     /**                                                                                                            
      42                 :      * Associative array of element name to list of modules that have                                              
      43                 :      * definitions for the element; this array is dynamically filled.                                              
      44                 :      */                                                                                                            
      45                 :     public $elementLookup = array();                                                                               
      46                 :                                                                                                                    
      47                 :     /** List of prefixes we should use for registering small names */                                              
      48                 :     public $prefixes = array('HTMLPurifier_HTMLModule_');                                                          
      49                 :                                                                                                                    
      50                 :     public $contentSets;     /**< Instance of HTMLPurifier_ContentSets */                                          
      51                 :     public $attrCollections; /**< Instance of HTMLPurifier_AttrCollections */                                      
      52                 :                                                                                                                    
      53                 :     /** If set to true, unsafe elements and attributes will be allowed */                                          
      54                 :     public $trusted = false;                                                                                       
      55                 :                                                                                                                    
      56                 :     public function __construct() {                                                                                
      57                 :                                                                                                                    
      58                 :         // editable internal objects                                                                               
      59               1 :         $this->attrTypes = new HTMLPurifier_AttrTypes();                                                           
      60               1 :         $this->doctypes  = new HTMLPurifier_DoctypeRegistry();                                                     
      61                 :                                                                                                                    
      62                 :         // setup basic modules                                                                                     
      63                 :         $common = array(                                                                                           
      64               1 :             'CommonAttributes', 'Text', 'Hypertext', 'List',                                                       
      65               1 :             'Presentation', 'Edit', 'Bdo', 'Tables', 'Image',                                                      
      66               1 :             'StyleAttribute', 'Scripting', 'Object'                                                                
      67               1 :         );                                                                                                         
      68               1 :         $transitional = array('Legacy', 'Target');                                                                 
      69               1 :         $xml = array('XMLCommonAttributes');                                                                       
      70               1 :         $non_xml = array('NonXMLCommonAttributes');                                                                
      71                 :                                                                                                                    
      72                 :         // setup basic doctypes                                                                                    
      73               1 :         $this->doctypes->register(                                                                                 
      74               1 :             'HTML 4.01 Transitional', false,                                                                       
      75               1 :             array_merge($common, $transitional, $non_xml),                                                         
      76               1 :             array('Tidy_Transitional', 'Tidy_Proprietary'),                                                        
      77               1 :             array(),                                                                                               
      78               1 :             '-//W3C//DTD HTML 4.01 Transitional//EN',                                                              
      79                 :             'http://www.w3.org/TR/html4/loose.dtd'                                                                 
      80               1 :         );                                                                                                         
      81                 :                                                                                                                    
      82               1 :         $this->doctypes->register(                                                                                 
      83               1 :             'HTML 4.01 Strict', false,                                                                             
      84               1 :             array_merge($common, $non_xml),                                                                        
      85               1 :             array('Tidy_Strict', 'Tidy_Proprietary'),                                                              
      86               1 :             array(),                                                                                               
      87               1 :             '-//W3C//DTD HTML 4.01//EN',                                                                           
      88                 :             'http://www.w3.org/TR/html4/strict.dtd'                                                                
      89               1 :         );                                                                                                         
      90                 :                                                                                                                    
      91               1 :         $this->doctypes->register(                                                                                 
      92               1 :             'XHTML 1.0 Transitional', true,                                                                        
      93               1 :             array_merge($common, $transitional, $xml, $non_xml),                                                   
      94               1 :             array('Tidy_Transitional', 'Tidy_XHTML', 'Tidy_Proprietary'),                                          
      95               1 :             array(),                                                                                               
      96               1 :             '-//W3C//DTD XHTML 1.0 Transitional//EN',                                                              
      97                 :             'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'                                              
      98               1 :         );                                                                                                         
      99                 :                                                                                                                    
     100               1 :         $this->doctypes->register(                                                                                 
     101               1 :             'XHTML 1.0 Strict', true,                                                                              
     102               1 :             array_merge($common, $xml, $non_xml),                                                                  
     103               1 :             array('Tidy_Strict', 'Tidy_XHTML', 'Tidy_Strict', 'Tidy_Proprietary'),                                 
     104               1 :             array(),                                                                                               
     105               1 :             '-//W3C//DTD XHTML 1.0 Strict//EN',                                                                    
     106                 :             'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'                                                    
     107               1 :         );                                                                                                         
     108                 :                                                                                                                    
     109               1 :         $this->doctypes->register(                                                                                 
     110               1 :             'XHTML 1.1', true,                                                                                     
     111               1 :             array_merge($common, $xml, array('Ruby')),                                                             
     112               1 :             array('Tidy_Strict', 'Tidy_XHTML', 'Tidy_Proprietary', 'Tidy_Strict'), // Tidy_XHTML1_1                
     113               1 :             array(),                                                                                               
     114               1 :             '-//W3C//DTD XHTML 1.1//EN',                                                                           
     115                 :             'http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd'                                                         
     116               1 :         );                                                                                                         
     117                 :                                                                                                                    
     118               1 :     }                                                                                                              
     119                 :                                                                                                                    
     120                 :     /**                                                                                                            
     121                 :      * Registers a module to the recognized module list, useful for                                                
     122                 :      * overloading pre-existing modules.                                                                           
     123                 :      * @param $module Mixed: string module name, with or without                                                   
     124                 :      *                HTMLPurifier_HTMLModule prefix, or instance of                                               
     125                 :      *                subclass of HTMLPurifier_HTMLModule.                                                         
     126                 :      * @param $overload Boolean whether or not to overload previous modules.                                       
     127                 :      *                  If this is not set, and you do overload a module,                                          
     128                 :      *                  HTML Purifier will complain with a warning.                                                
     129                 :      * @note This function will not call autoload, you must instantiate                                            
     130                 :      *       (and thus invoke) autoload outside the method.                                                        
     131                 :      * @note If a string is passed as a module name, different variants                                            
     132                 :      *       will be tested in this order:                                                                         
     133                 :      *          - Check for HTMLPurifier_HTMLModule_$name                                                          
     134                 :      *          - Check all prefixes with $name in order they were added                                           
     135                 :      *          - Check for literal object name                                                                    
     136                 :      *          - Throw fatal error                                                                                
     137                 :      *       If your object name collides with an internal class, specify                                          
     138                 :      *       your module manually. All modules must have been included                                             
     139                 :      *       externally: registerModule will not perform inclusions for you!                                       
     140                 :      */                                                                                                            
     141                 :     public function registerModule($module, $overload = false) {                                                   
     142               1 :         if (is_string($module)) {                                                                                  
     143                 :             // attempt to load the module                                                                          
     144               1 :             $original_module = $module;                                                                            
     145               1 :             $ok = false;                                                                                           
     146               1 :             foreach ($this->prefixes as $prefix) {                                                                 
     147               1 :                 $module = $prefix . $original_module;                                                              
     148               1 :                 if (class_exists($module)) {                                                                       
     149               1 :                     $ok = true;                                                                                    
     150               1 :                     break;                                                                                         
     151                 :                 }                                                                                                  
     152               0 :             }                                                                                                      
     153               1 :             if (!$ok) {                                                                                            
     154               0 :                 $module = $original_module;                                                                        
     155               0 :                 if (!class_exists($module)) {                                                                      
     156               0 :                     trigger_error($original_module . ' module does not exist',                                     
     157               0 :                         E_USER_ERROR);                                                                             
     158               0 :                     return;                                                                                        
     159                 :                 }                                                                                                  
     160               0 :             }                                                                                                      
     161               1 :             $module = new $module();                                                                               
     162               1 :         }                                                                                                          
     163               1 :         if (empty($module->name)) {                                                                                
     164               0 :             trigger_error('Module instance of ' . get_class($module) . ' must have name');                         
     165               0 :             return;                                                                                                
     166                 :         }                                                                                                          
     167               1 :         if (!$overload && isset($this->registeredModules[$module->name])) {                                        
     168               0 :             trigger_error('Overloading ' . $module->name . ' without explicit overload parameter', E_USER_WARNING);
     169               0 :         }                                                                                                          
     170               1 :         $this->registeredModules[$module->name] = $module;                                                         
     171               1 :     }                                                                                                              
     172                 :                                                                                                                    
     173                 :     /**                                                                                                            
     174                 :      * Adds a module to the current doctype by first registering it,                                               
     175                 :      * and then tacking it on to the active doctype                                                                
     176                 :      */                                                                                                            
     177                 :     public function addModule($module) {                                                                           
     178               0 :         $this->registerModule($module);                                                                            
     179               0 :         if (is_object($module)) $module = $module->name;                                                           
     180               0 :         $this->userModules[] = $module;                                                                            
     181               0 :     }                                                                                                              
     182                 :                                                                                                                    
     183                 :     /**                                                                                                            
     184                 :      * Adds a class prefix that registerModule() will use to resolve a                                             
     185                 :      * string name to a concrete class                                                                             
     186                 :      */                                                                                                            
     187                 :     public function addPrefix($prefix) {                                                                           
     188               0 :         $this->prefixes[] = $prefix;                                                                               
     189               0 :     }                                                                                                              
     190                 :                                                                                                                    
     191                 :     /**                                                                                                            
     192                 :      * Performs processing on modules, after being called you may                                                  
     193                 :      * use getElement() and getElements()                                                                          
     194                 :      * @param $config Instance of HTMLPurifier_Config                                                              
     195                 :      */                                                                                                            
     196                 :     public function setup($config) {                                                                               
     197                 :                                                                                                                    
     198               1 :         $this->trusted = $config->get('HTML', 'Trusted');                                                          
     199                 :                                                                                                                    
     200                 :         // generate                                                                                                
     201               1 :         $this->doctype = $this->doctypes->make($config);                                                           
     202               1 :         $modules = $this->doctype->modules;                                                                        
     203                 :                                                                                                                    
     204                 :         // take out the default modules that aren't allowed                                                        
     205               1 :         $lookup = $config->get('HTML', 'AllowedModules');                                                          
     206               1 :         $special_cases = $config->get('HTML', 'CoreModules');                                                      
     207                 :                                                                                                                    
     208               1 :         if (is_array($lookup)) {                                                                                   
     209               0 :             foreach ($modules as $k => $m) {                                                                       
     210               0 :                 if (isset($special_cases[$m])) continue;                                                           
     211               0 :                 if (!isset($lookup[$m])) unset($modules[$k]);                                                      
     212               0 :             }                                                                                                      
     213               0 :         }                                                                                                          
     214                 :                                                                                                                    
     215                 :         // merge in custom modules                                                                                 
     216               1 :         $modules = array_merge($modules, $this->userModules);                                                      
     217                 :                                                                                                                    
     218                 :         // add proprietary module (this gets special treatment because                                             
     219                 :         // it is completely removed from doctypes, etc.)                                                           
     220               1 :         if ($config->get('HTML', 'Proprietary')) {                                                                 
     221               0 :             $modules[] = 'Proprietary';                                                                            
     222               0 :         }                                                                                                          
     223                 :                                                                                                                    
     224               1 :         foreach ($modules as $module) {                                                                            
     225               1 :             $this->processModule($module);                                                                         
     226               1 :         }                                                                                                          
     227                 :                                                                                                                    
     228               1 :         foreach ($this->doctype->tidyModules as $module) {                                                         
     229               1 :             $this->processModule($module);                                                                         
     230               1 :             if (method_exists($this->modules[$module], 'construct')) {                                             
     231               1 :                 $this->modules[$module]->construct($config);                                                       
     232               1 :             }                                                                                                      
     233               1 :         }                                                                                                          
     234                 :                                                                                                                    
     235                 :         // setup lookup table based on all valid modules                                                           
     236               1 :         foreach ($this->modules as $module) {                                                                      
     237               1 :             foreach ($module->info as $name => $def) {                                                             
     238               1 :                 if (!isset($this->elementLookup[$name])) {                                                         
     239               1 :                     $this->elementLookup[$name] = array();                                                         
     240               1 :                 }                                                                                                  
     241               1 :                 $this->elementLookup[$name][] = $module->name;                                                     
     242               1 :             }                                                                                                      
     243               1 :         }                                                                                                          
     244                 :                                                                                                                    
     245                 :         // note the different choice                                                                               
     246               1 :         $this->contentSets = new HTMLPurifier_ContentSets(                                                         
     247                 :             // content set assembly deals with all possible modules,                                               
     248                 :             // not just ones deemed to be "safe"                                                                   
     249               1 :             $this->modules                                                                                         
     250               1 :         );                                                                                                         
     251               1 :         $this->attrCollections = new HTMLPurifier_AttrCollections(                                                 
     252               1 :             $this->attrTypes,                                                                                      
     253                 :             // there is no way to directly disable a global attribute,                                             
     254                 :             // but using AllowedAttributes or simply not including                                                 
     255                 :             // the module in your custom doctype should be sufficient                                              
     256               1 :             $this->modules                                                                                         
     257               1 :         );                                                                                                         
     258               1 :     }                                                                                                              
     259                 :                                                                                                                    
     260                 :     /**                                                                                                            
     261                 :      * Takes a module and adds it to the active module collection,                                                 
     262                 :      * registering it if necessary.                                                                                
     263                 :      */                                                                                                            
     264                 :     public function processModule($module) {                                                                       
     265               1 :         if (!isset($this->registeredModules[$module]) || is_object($module)) {                                     
     266               1 :             $this->registerModule($module);                                                                        
     267               1 :         }                                                                                                          
     268               1 :         $this->modules[$module] = $this->registeredModules[$module];                                               
     269               1 :     }                                                                                                              
     270                 :                                                                                                                    
     271                 :     /**                                                                                                            
     272                 :      * Retrieves merged element definitions.                                                                       
     273                 :      * @return Array of HTMLPurifier_ElementDef                                                                    
     274                 :      */                                                                                                            
     275                 :     public function getElements() {                                                                                
     276                 :                                                                                                                    
     277               1 :         $elements = array();                                                                                       
     278               1 :         foreach ($this->modules as $module) {                                                                      
     279               1 :             if (!$this->trusted && !$module->safe) continue;                                                       
     280               1 :             foreach ($module->info as $name => $v) {                                                               
     281               1 :                 if (isset($elements[$name])) continue;                                                             
     282               1 :                 $elements[$name] = $this->getElement($name);                                                       
     283               1 :             }                                                                                                      
     284               1 :         }                                                                                                          
     285                 :                                                                                                                    
     286                 :         // remove dud elements, this happens when an element that                                                  
     287                 :         // appeared to be safe actually wasn't                                                                     
     288               1 :         foreach ($elements as $n => $v) {                                                                          
     289               1 :             if ($v === false) unset($elements[$n]);                                                                
     290               1 :         }                                                                                                          
     291                 :                                                                                                                    
     292               1 :         return $elements;                                                                                          
     293                 :                                                                                                                    
     294                 :     }                                                                                                              
     295                 :                                                                                                                    
     296                 :     /**                                                                                                            
     297                 :      * Retrieves a single merged element definition                                                                
     298                 :      * @param $name Name of element                                                                                
     299                 :      * @param $trusted Boolean trusted overriding parameter: set to true                                           
     300                 :      *                 if you want the full version of an element                                                  
     301                 :      * @return Merged HTMLPurifier_ElementDef                                                                      
     302                 :      * @note You may notice that modules are getting iterated over twice (once                                     
     303                 :      *       in getElements() and once here). This                                                                 
     304                 :      *       is because                                                                                            
     305                 :      */                                                                                                            
     306                 :     public function getElement($name, $trusted = null) {                                                           
     307                 :                                                                                                                    
     308               1 :         if (!isset($this->elementLookup[$name])) {                                                                 
     309               0 :             return false;                                                                                          
     310                 :         }                                                                                                          
     311                 :                                                                                                                    
     312                 :         // setup global state variables                                                                            
     313               1 :         $def = false;                                                                                              
     314               1 :         if ($trusted === null) $trusted = $this->trusted;                                                          
     315                 :                                                                                                                    
     316                 :         // iterate through each module that has registered itself to this                                          
     317                 :         // element                                                                                                 
     318               1 :         foreach($this->elementLookup[$name] as $module_name) {                                                     
     319                 :                                                                                                                    
     320               1 :             $module = $this->modules[$module_name];                                                                
     321                 :                                                                                                                    
     322                 :             // refuse to create/merge from a module that is deemed unsafe--                                        
     323                 :             // pretend the module doesn't exist--when trusted mode is not on.                                      
     324               1 :             if (!$trusted && !$module->safe) {                                                                     
     325               0 :                 continue;                                                                                          
     326                 :             }                                                                                                      
     327                 :                                                                                                                    
     328                 :             // clone is used because, ideally speaking, the original                                               
     329                 :             // definition should not be modified. Usually, this will                                               
     330                 :             // make no difference, but for consistency's sake                                                      
     331               1 :             $new_def = clone $module->info[$name];                                                                 
     332                 :                                                                                                                    
     333               1 :             if (!$def && $new_def->standalone) {                                                                   
     334               1 :                 $def = $new_def;                                                                                   
     335               1 :             } elseif ($def) {                                                                                      
     336                 :                 // This will occur even if $new_def is standalone. In practice,                                    
     337                 :                 // this will usually result in a full replacement.                                                 
     338               1 :                 $def->mergeIn($new_def);                                                                           
     339               1 :             } else {                                                                                               
     340                 :                 // :TODO:                                                                                          
     341                 :                 // non-standalone definitions that don't have a standalone                                         
     342                 :                 // to merge into could be deferred to the end                                                      
     343               0 :                 continue;                                                                                          
     344                 :             }                                                                                                      
     345                 :                                                                                                                    
     346                 :             // attribute value expansions                                                                          
     347               1 :             $this->attrCollections->performInclusions($def->attr);                                                 
     348               1 :             $this->attrCollections->expandIdentifiers($def->attr, $this->attrTypes);                               
     349                 :                                                                                                                    
     350                 :             // descendants_are_inline, for ChildDef_Chameleon                                                      
     351               1 :             if (is_string($def->content_model) &&                                                                  
     352               1 :                 strpos($def->content_model, 'Inline') !== false) {                                                 
     353               1 :                 if ($name != 'del' && $name != 'ins') {                                                            
     354                 :                     // this is for you, ins/del                                                                    
     355               1 :                     $def->descendants_are_inline = true;                                                           
     356               1 :                 }                                                                                                  
     357               1 :             }                                                                                                      
     358                 :                                                                                                                    
     359               1 :             $this->contentSets->generateChildDef($def, $module);                                                   
     360               1 :         }                                                                                                          
     361                 :                                                                                                                    
     362                 :         // add information on required attributes                                                                  
     363               1 :         foreach ($def->attr as $attr_name => $attr_def) {                                                          
     364               1 :             if ($attr_def->required) {                                                                             
     365               1 :                 $def->required_attr[] = $attr_name;                                                                
     366               1 :             }                                                                                                      
     367               1 :         }                                                                                                          
     368                 :                                                                                                                    
     369               1 :         return $def;                                                                                               
     370                 :                                                                                                                    
     371                 :     }                                                                                                              
     372                 :                                                                                                                    
     373                 : }                                                                                                                  
     374                 :                                                                                                                    
     375                 :                                                                                                                    

Generated by PHPUnit 3.2.20 and Xdebug 2.0.3 at Sat Jun 7 16:15:42 CEST 2008.