mirror of
https://github.com/ezyang/htmlpurifier.git
synced 2024-12-23 00:41:52 +00:00
53c19552d2
- Move Doctype to its own file - Remove vestigial autoDoctype and order - Setup will automatically load modules for you - Allow overriding trust level for parent element - Random documentation update git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1056 48356398-32a2-884e-a903-53898d9a118a
398 lines
14 KiB
PHP
398 lines
14 KiB
PHP
<?php
|
|
|
|
require_once 'HTMLPurifier/HTMLModule.php';
|
|
require_once 'HTMLPurifier/ElementDef.php';
|
|
require_once 'HTMLPurifier/Doctype.php';
|
|
|
|
require_once 'HTMLPurifier/ContentSets.php';
|
|
require_once 'HTMLPurifier/AttrTypes.php';
|
|
require_once 'HTMLPurifier/AttrCollections.php';
|
|
|
|
require_once 'HTMLPurifier/AttrDef.php';
|
|
require_once 'HTMLPurifier/AttrDef/Enum.php';
|
|
|
|
// W3C modules
|
|
require_once 'HTMLPurifier/HTMLModule/CommonAttributes.php';
|
|
require_once 'HTMLPurifier/HTMLModule/Text.php';
|
|
require_once 'HTMLPurifier/HTMLModule/Hypertext.php';
|
|
require_once 'HTMLPurifier/HTMLModule/List.php';
|
|
require_once 'HTMLPurifier/HTMLModule/Presentation.php';
|
|
require_once 'HTMLPurifier/HTMLModule/Edit.php';
|
|
require_once 'HTMLPurifier/HTMLModule/Bdo.php';
|
|
require_once 'HTMLPurifier/HTMLModule/Tables.php';
|
|
require_once 'HTMLPurifier/HTMLModule/Image.php';
|
|
require_once 'HTMLPurifier/HTMLModule/StyleAttribute.php';
|
|
require_once 'HTMLPurifier/HTMLModule/Legacy.php';
|
|
require_once 'HTMLPurifier/HTMLModule/Target.php';
|
|
require_once 'HTMLPurifier/HTMLModule/Scripting.php';
|
|
|
|
// proprietary modules
|
|
require_once 'HTMLPurifier/HTMLModule/TransformToStrict.php';
|
|
require_once 'HTMLPurifier/HTMLModule/TransformToXHTML11.php';
|
|
|
|
HTMLPurifier_ConfigSchema::define(
|
|
'HTML', 'Doctype', null, 'string/null',
|
|
'Doctype to use, pre-defined values are HTML 4.01 Transitional, HTML 4.01 '.
|
|
'Strict, XHTML 1.0 Transitional, XHTML 1.0 Strict, XHTML 1.1. '.
|
|
'Technically speaking this is not actually a doctype (as it does '.
|
|
'not identify a corresponding DTD), but we are using this name '.
|
|
'for sake of simplicity. This will override any older directives '.
|
|
'like %Core.XHTML or %HTML.Strict.'
|
|
);
|
|
|
|
class HTMLPurifier_HTMLModuleManager
|
|
{
|
|
|
|
/**
|
|
* Array of HTMLPurifier_Module instances, indexed by module's class name.
|
|
* All known modules, regardless of use, are in this array.
|
|
*/
|
|
var $modules = array();
|
|
|
|
/**
|
|
* String doctype we will validate against. See $validModules for use.
|
|
*
|
|
* @note
|
|
* There is a special doctype '*' that acts both as the "default"
|
|
* doctype if a customized system only defines one doctype and
|
|
* also a catch-all doctype that gets merged into all the other
|
|
* module collections. When possible, use a private collection to
|
|
* share modules between doctypes: this special doctype is to
|
|
* make life more convenient for users.
|
|
*/
|
|
var $doctype;
|
|
var $doctypeAliases = array(); /**< Lookup array of strings to real doctypes */
|
|
|
|
/**
|
|
* Associative array of doctype names to doctype definitions.
|
|
*/
|
|
var $doctypes;
|
|
|
|
/**
|
|
* Modules that may be used in a valid doctype of this kind.
|
|
* Correctional and leniency modules should not be placed in this
|
|
* array unless the user said so: don't stuff every possible lenient
|
|
* module for this doctype in here.
|
|
*/
|
|
var $validModules = array();
|
|
|
|
var $initialized = false; /**< Says whether initialize() was called */
|
|
|
|
/** Associative array of element name to defining modules (always array) */
|
|
var $elementLookup = array();
|
|
|
|
/** List of prefixes we should use for resolving small names */
|
|
var $prefixes = array('HTMLPurifier_HTMLModule_');
|
|
|
|
var $contentSets; /**< Instance of HTMLPurifier_ContentSets */
|
|
var $attrTypes; /**< Instance of HTMLPurifier_AttrTypes */
|
|
var $attrCollections; /**< Instance of HTMLPurifier_AttrCollections */
|
|
|
|
/** If set to true, unsafe elements and attributes will be allowed */
|
|
var $trusted = false;
|
|
|
|
/**
|
|
* @param $blank If true, don't do any initializing
|
|
*/
|
|
function HTMLPurifier_HTMLModuleManager($blank = false) {
|
|
|
|
// the only editable internal object. The rest need to
|
|
// be manipulated through modules
|
|
$this->attrTypes = new HTMLPurifier_AttrTypes();
|
|
|
|
if (!$blank) $this->initialize();
|
|
|
|
}
|
|
|
|
function initialize() {
|
|
$this->initialized = true;
|
|
|
|
// these doctype definitions should be placed somewhere else
|
|
|
|
$common = array(
|
|
'CommonAttributes', 'Text', 'Hypertext', 'List',
|
|
'Presentation', 'Edit', 'Bdo', 'Tables', 'Image',
|
|
'StyleAttribute', 'Scripting'
|
|
);
|
|
$transitional = array('Legacy', 'Target');
|
|
|
|
$d =& $this->addDoctype('HTML 4.01 Transitional');
|
|
$d->modules = array_merge($common, $transitional);
|
|
$d->modulesForMode['correctional'] = array('TransformToStrict');
|
|
|
|
$d =& $this->addDoctype('XHTML 1.0 Transitional');
|
|
$d->modules = array_merge($common, $transitional);
|
|
$d->modulesForMode['correctional'] = array('TransformToStrict');
|
|
|
|
$d =& $this->addDoctype('HTML 4.01 Strict');
|
|
$d->modules = array_merge($common);
|
|
$d->modulesForMode['lenient'] = array('TransformToStrict');
|
|
|
|
$d =& $this->addDoctype('XHTML 1.0 Strict');
|
|
$d->modules = array_merge($common);
|
|
$d->modulesForMode['lenient'] = array('TransformToStrict');
|
|
|
|
$d =& $this->addDoctype('XHTML 1.1');
|
|
$d->modules = array_merge($common);
|
|
$d->modulesForMode['lenient'] = array('TransformToStrict', 'TransformToXHTML11');
|
|
|
|
}
|
|
|
|
/**
|
|
* @temporary
|
|
* @note Real version should retrieve a fully formed instance of
|
|
* the doctype and register its aliases
|
|
*/
|
|
function &addDoctype($name) {
|
|
$this->doctypes[$name] = new HTMLPurifier_Doctype();
|
|
$this->doctypes[$name]->name = $name;
|
|
return $this->doctypes[$name];
|
|
}
|
|
|
|
/**
|
|
* Adds a module to the recognized module list. This does not
|
|
* do anything else: the module must be added to a corresponding
|
|
* collection to be "activated".
|
|
* @param $module Mixed: string module name, with or without
|
|
* HTMLPurifier_HTMLModule prefix, or instance of
|
|
* subclass of HTMLPurifier_HTMLModule.
|
|
* @note This function will not call autoload, you must instantiate
|
|
* (and thus invoke) autoload outside the method.
|
|
* @note If a string is passed as a module name, different variants
|
|
* will be tested in this order:
|
|
* - Check for HTMLPurifier_HTMLModule_$name
|
|
* - Check all prefixes with $name in order they were added
|
|
* - Check for literal object name
|
|
* - Throw fatal error
|
|
* If your object name collides with an internal class, specify
|
|
* your module manually.
|
|
* @warning If your module has the same name as an already loaded
|
|
* module, your module will overload the old one WITHOUT
|
|
* warning.
|
|
*/
|
|
function addModule($module) {
|
|
if (is_string($module)) {
|
|
$original_module = $module;
|
|
$ok = false;
|
|
foreach ($this->prefixes as $prefix) {
|
|
$module = $prefix . $original_module;
|
|
if ($this->_classExists($module)) {
|
|
$ok = true;
|
|
break;
|
|
}
|
|
}
|
|
if (!$ok) {
|
|
$module = $original_module;
|
|
if (!$this->_classExists($module)) {
|
|
trigger_error($original_module . ' module does not exist',
|
|
E_USER_ERROR);
|
|
return;
|
|
}
|
|
}
|
|
$module = new $module();
|
|
}
|
|
$this->modules[$module->name] = $module;
|
|
}
|
|
|
|
/**
|
|
* Safely tests for class existence without invoking __autoload in PHP5
|
|
* or greater.
|
|
* @param $name String class name to test
|
|
* @private
|
|
*/
|
|
function _classExists($name) {
|
|
static $is_php_4 = null;
|
|
if ($is_php_4 === null) {
|
|
$is_php_4 = version_compare(PHP_VERSION, '5', '<');
|
|
}
|
|
if ($is_php_4) {
|
|
return class_exists($name);
|
|
} else {
|
|
return class_exists($name, false);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds a class prefix that addModule() will use to resolve a
|
|
* string name to a concrete class
|
|
*/
|
|
function addPrefix($prefix) {
|
|
$this->prefixes[] = (string) $prefix;
|
|
}
|
|
|
|
/**
|
|
* Performs processing on modules, after being called you may
|
|
* use getElement() and getElements()
|
|
* @param $config Instance of HTMLPurifier_Config
|
|
*/
|
|
function setup($config) {
|
|
|
|
// retrieve the doctype
|
|
$this->doctype = $this->getDoctype($config);
|
|
if (isset($this->doctypeAliases[$this->doctype])) {
|
|
// resolve alias
|
|
$this->doctype = $this->doctypeAliases[$this->doctype];
|
|
}
|
|
|
|
// retrieve object instance of doctype
|
|
$doctype = $this->doctypes[$this->doctype];
|
|
$modules = $doctype->modules;
|
|
foreach ($doctype->modulesForMode as $mode => $mode_modules) {
|
|
// TODO: test if $mode is active
|
|
$modules = array_merge($modules, $mode_modules);
|
|
}
|
|
|
|
foreach ($modules as $module) {
|
|
if (is_object($module)) {
|
|
$this->validModules[$module->name] = $module;
|
|
continue;
|
|
} else {
|
|
if (!isset($this->modules[$module])) {
|
|
$this->addModule($module);
|
|
}
|
|
$this->validModules[$module] = $this->modules[$module];
|
|
}
|
|
}
|
|
|
|
// setup lookup table based on all valid modules
|
|
foreach ($this->validModules as $module) {
|
|
foreach ($module->info as $name => $def) {
|
|
if (!isset($this->elementLookup[$name])) {
|
|
$this->elementLookup[$name] = array();
|
|
}
|
|
$this->elementLookup[$name][] = $module->name;
|
|
}
|
|
}
|
|
|
|
// note the different choice
|
|
$this->contentSets = new HTMLPurifier_ContentSets(
|
|
// content set assembly deals with all possible modules,
|
|
// not just ones deemed to be "safe"
|
|
$this->validModules
|
|
);
|
|
$this->attrCollections = new HTMLPurifier_AttrCollections(
|
|
$this->attrTypes,
|
|
// there is no way to directly disable a global attribute,
|
|
// but using AllowedAttributes or simply not including
|
|
// the module in your custom doctype should be sufficient
|
|
$this->validModules
|
|
);
|
|
|
|
}
|
|
|
|
/**
|
|
* Retrieves the doctype from the configuration object
|
|
*/
|
|
function getDoctype($config) {
|
|
$doctype = $config->get('HTML', 'Doctype');
|
|
if ($doctype !== null) {
|
|
return $doctype;
|
|
}
|
|
// this is backwards-compatibility stuff
|
|
if ($config->get('Core', 'XHTML')) {
|
|
$doctype = 'XHTML 1.0';
|
|
} else {
|
|
$doctype = 'HTML 4.01';
|
|
}
|
|
if ($config->get('HTML', 'Strict')) {
|
|
$doctype .= ' Strict';
|
|
} else {
|
|
$doctype .= ' Transitional';
|
|
}
|
|
return $doctype;
|
|
}
|
|
|
|
/**
|
|
* Retrieves merged element definitions.
|
|
* @param $config Instance of HTMLPurifier_Config, for determining
|
|
* stray elements.
|
|
*/
|
|
function getElements($config) {
|
|
|
|
$elements = array();
|
|
foreach ($this->validModules as $module) {
|
|
foreach ($module->info as $name => $v) {
|
|
if (isset($elements[$name])) continue;
|
|
// if element is not safe, don't use it
|
|
if (!$this->trusted && ($v->safe === false)) continue;
|
|
$elements[$name] = $this->getElement($name, $config);
|
|
}
|
|
}
|
|
|
|
// remove dud elements
|
|
foreach ($elements as $n => $v) {
|
|
if ($v === false) unset($elements[$n]);
|
|
}
|
|
|
|
return $elements;
|
|
|
|
}
|
|
|
|
/**
|
|
* Retrieves a single merged element definition
|
|
* @param $name Name of element
|
|
* @param $config Instance of HTMLPurifier_Config, may not be necessary.
|
|
* @param $trusted Boolean trusted overriding parameter: set to true
|
|
* if you want the full version of an element
|
|
*/
|
|
function getElement($name, $config, $trusted = null) {
|
|
|
|
$def = false;
|
|
if ($trusted === null) $trusted = $this->trusted;
|
|
|
|
$modules = $this->validModules;
|
|
|
|
if (!isset($this->elementLookup[$name])) {
|
|
return false;
|
|
}
|
|
|
|
foreach($this->elementLookup[$name] as $module_name) {
|
|
|
|
$module = $modules[$module_name];
|
|
$new_def = $module->info[$name];
|
|
|
|
// refuse to create/merge in a definition that is deemed unsafe
|
|
if (!$trusted && ($new_def->safe === false)) {
|
|
$def = false;
|
|
continue;
|
|
}
|
|
|
|
if (!$def && $new_def->standalone) {
|
|
// element with unknown safety is not to be trusted.
|
|
// however, a merge-in definition with undefined safety
|
|
// is fine
|
|
if (!$new_def->safe) continue;
|
|
$def = $new_def;
|
|
} elseif ($def) {
|
|
$def->mergeIn($new_def);
|
|
} else {
|
|
// could "save it for another day":
|
|
// non-standalone definitions that don't have a standalone
|
|
// to merge into could be deferred to the end
|
|
continue;
|
|
}
|
|
|
|
// attribute value expansions
|
|
$this->attrCollections->performInclusions($def->attr);
|
|
$this->attrCollections->expandIdentifiers($def->attr, $this->attrTypes);
|
|
|
|
// descendants_are_inline, for ChildDef_Chameleon
|
|
if (is_string($def->content_model) &&
|
|
strpos($def->content_model, 'Inline') !== false) {
|
|
if ($name != 'del' && $name != 'ins') {
|
|
// this is for you, ins/del
|
|
$def->descendants_are_inline = true;
|
|
}
|
|
}
|
|
|
|
$this->contentSets->generateChildDef($def, $module);
|
|
}
|
|
|
|
return $def;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
?>
|