0
0
mirror of https://github.com/ezyang/htmlpurifier.git synced 2025-01-18 11:41:52 +00:00

[1.7.0] New compact syntax for AttrDef objects that can be used to instantiate new objects via make()

- Implemented make() for Enum and Bool
- Migrate classes over to this new syntax
- Add AttrDef_HTML_Bool unit test

git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1088 48356398-32a2-884e-a903-53898d9a118a
This commit is contained in:
Edward Z. Yang 2007-05-23 00:39:07 +00:00
parent 818d0d7a23
commit 7579932948
14 changed files with 114 additions and 45 deletions

2
NEWS
View File

@ -18,6 +18,8 @@ NEWS ( CHANGELOG and HISTORY ) HTMLPurifier
performed on it, ensuring that its internal state stays consistent. performed on it, ensuring that its internal state stays consistent.
To revert this behavior, you can set the $autoFinalize member variable To revert this behavior, you can set the $autoFinalize member variable
off, but it's not recommended. off, but it's not recommended.
# New compact syntax for AttrDef objects that can be used to instantiate
new objects via make()
- Deprecated and removed EnableRedundantUTF8Cleaning. It didn't even work! - Deprecated and removed EnableRedundantUTF8Cleaning. It didn't even work!
. Unit test for ElementDef created, ElementDef behavior modified to . Unit test for ElementDef created, ElementDef behavior modified to
be more flexible be more flexible

View File

@ -62,6 +62,20 @@ class HTMLPurifier_AttrDef
$string = str_replace(array("\r", "\t"), ' ', $string); $string = str_replace(array("\r", "\t"), ' ', $string);
return $string; return $string;
} }
/**
* Factory method for creating this class from a string.
* @param $string String construction info
* @return Created AttrDef object corresponding to $string
* @public
*/
function make($string) {
// default implementation, return flyweight of this object
// if overloaded, it is *necessary* for you to clone the
// object (usually by instantiating a new copy) and return that
return $this;
}
} }
?> ?>

View File

@ -45,6 +45,15 @@ class HTMLPurifier_AttrDef_Enum extends HTMLPurifier_AttrDef
return $result ? $string : false; return $result ? $string : false;
} }
/**
* @param $string In form of comma-delimited list of case-insensitive
* valid values. Example: "foo,bar,baz"
*/
function make($string) {
$values = explode(',', $string);
return new HTMLPurifier_AttrDef_Enum($values);
}
} }
?> ?>

View File

@ -11,13 +11,20 @@ class HTMLPurifier_AttrDef_HTML_Bool extends HTMLPurifier_AttrDef
var $name; var $name;
var $minimized = true; var $minimized = true;
function HTMLPurifier_AttrDef_HTML_Bool($name) {$this->name = $name;} function HTMLPurifier_AttrDef_HTML_Bool($name = false) {$this->name = $name;}
function validate($string, $config, &$context) { function validate($string, $config, &$context) {
if (empty($string)) return false; if (empty($string)) return false;
return $name; return $name;
} }
/**
* @param $string Name of attribute
*/
function make($string) {
return new HTMLPurifier_AttrDef_HTML_Bool($string);
}
} }
?> ?>

View File

@ -1,6 +1,8 @@
<?php <?php
require_once 'HTMLPurifier/AttrDef/Lang.php'; require_once 'HTMLPurifier/AttrDef/Lang.php';
require_once 'HTMLPurifier/AttrDef/Enum.php';
require_once 'HTMLPurifier/AttrDef/HTML/Bool.php';
require_once 'HTMLPurifier/AttrDef/HTML/ID.php'; require_once 'HTMLPurifier/AttrDef/HTML/ID.php';
require_once 'HTMLPurifier/AttrDef/HTML/Length.php'; require_once 'HTMLPurifier/AttrDef/HTML/Length.php';
require_once 'HTMLPurifier/AttrDef/HTML/MultiLength.php'; require_once 'HTMLPurifier/AttrDef/HTML/MultiLength.php';
@ -27,6 +29,10 @@ class HTMLPurifier_AttrTypes
* types. * types.
*/ */
function HTMLPurifier_AttrTypes() { function HTMLPurifier_AttrTypes() {
// pseudo-types, must be instantiated via shorthand
$this->info['Enum'] = new HTMLPurifier_AttrDef_Enum();
$this->info['Bool'] = new HTMLPurifier_AttrDef_HTML_Bool();
$this->info['CDATA'] = new HTMLPurifier_AttrDef_Text(); $this->info['CDATA'] = new HTMLPurifier_AttrDef_Text();
$this->info['ID'] = new HTMLPurifier_AttrDef_HTML_ID(); $this->info['ID'] = new HTMLPurifier_AttrDef_HTML_ID();
$this->info['Length'] = new HTMLPurifier_AttrDef_HTML_Length(); $this->info['Length'] = new HTMLPurifier_AttrDef_HTML_Length();
@ -39,6 +45,7 @@ class HTMLPurifier_AttrTypes
$this->info['Color'] = new HTMLPurifier_AttrDef_HTML_Color(); $this->info['Color'] = new HTMLPurifier_AttrDef_HTML_Color();
// number is really a positive integer (one or more digits) // number is really a positive integer (one or more digits)
// FIXME: ^^ not always, see start and value of list items
$this->info['Number'] = new HTMLPurifier_AttrDef_Integer(false, false, true); $this->info['Number'] = new HTMLPurifier_AttrDef_Integer(false, false, true);
} }
@ -48,13 +55,18 @@ class HTMLPurifier_AttrTypes
* @return Object AttrDef for type * @return Object AttrDef for type
*/ */
function get($type) { function get($type) {
// If $type is complicated, we may to clone the attribute
// definition and make custom changes // determine if there is any extra info tacked on
if (strpos($type, '#') !== false) list($type, $string) = explode('#', $type, 2);
else $string = '';
if (!isset($this->info[$type])) { if (!isset($this->info[$type])) {
trigger_error('Cannot retrieve undefined attribute type ' . $type, E_USER_ERROR); trigger_error('Cannot retrieve undefined attribute type ' . $type, E_USER_ERROR);
return; return;
} }
return $this->info[$type];
return $this->info[$type]->make($string);
} }
/** /**

View File

@ -16,21 +16,17 @@ class HTMLPurifier_HTMLModule_Bdo extends HTMLPurifier_HTMLModule
); );
function HTMLPurifier_HTMLModule_Bdo() { function HTMLPurifier_HTMLModule_Bdo() {
$dir = new HTMLPurifier_AttrDef_Enum(array('ltr','rtl'), false);
$bdo =& $this->addElement( $bdo =& $this->addElement(
'bdo', true, 'Inline', 'Inline', array('Core', 'Lang'), 'bdo', true, 'Inline', 'Inline', array('Core', 'Lang'),
array( array(
'dir' => $dir, // required 'dir' => 'Enum#ltr,rtl', // required
// The Abstract Module specification has the attribute // The Abstract Module specification has the attribute
// inclusions wrong for bdo: bdo allows // inclusions wrong for bdo: bdo allows Lang
// xml:lang too (and we'll toss in lang for good measure,
// though it is not allowed for XHTML 1.1, this will
// be managed with a global attribute transform)
) )
); );
$bdo->attr_transform_post['required-dir'] = new HTMLPurifier_AttrTransform_BdoDir(); $bdo->attr_transform_post['required-dir'] = new HTMLPurifier_AttrTransform_BdoDir();
$this->attr_collections['I18N']['dir'] = $dir; $this->attr_collections['I18N']['dir'] = 'Enum#ltr,rtl';
} }
} }

View File

@ -35,7 +35,7 @@ class HTMLPurifier_HTMLModule_Legacy extends HTMLPurifier_HTMLModule
)); ));
$this->addElement('center', true, 'Block', 'Flow', 'Common'); $this->addElement('center', true, 'Block', 'Flow', 'Common');
$this->addElement('dir', true, 'Block', 'Required: li', 'Common', array( $this->addElement('dir', true, 'Block', 'Required: li', 'Common', array(
'compact' => new HTMLPurifier_AttrDef_HTML_Bool('compact') 'compact' => 'Bool#compact'
)); ));
$this->addElement('font', true, 'Inline', 'Inline', array('Core', 'I18N'), array( $this->addElement('font', true, 'Inline', 'Inline', array('Core', 'I18N'), array(
'color' => 'Color', 'color' => 'Color',
@ -43,7 +43,7 @@ class HTMLPurifier_HTMLModule_Legacy extends HTMLPurifier_HTMLModule
'size' => 'Text', // tighten it 'size' => 'Text', // tighten it
)); ));
$this->addElement('menu', true, 'Block', 'Required: li', 'Common', array( $this->addElement('menu', true, 'Block', 'Required: li', 'Common', array(
'compact' => new HTMLPurifier_AttrDef_HTML_Bool('compact') 'compact' => 'Bool#compact'
)); ));
$this->addElement('s', true, 'Inline', 'Inline', 'Common'); $this->addElement('s', true, 'Inline', 'Inline', 'Common');
$this->addElement('strike', true, 'Inline', 'Inline', 'Common'); $this->addElement('strike', true, 'Inline', 'Inline', 'Common');
@ -57,7 +57,7 @@ class HTMLPurifier_HTMLModule_Legacy extends HTMLPurifier_HTMLModule
$ol =& $this->addBlankElement('ol'); $ol =& $this->addBlankElement('ol');
$ol->attr['start'] = new HTMLPurifier_AttrDef_Integer(); $ol->attr['start'] = new HTMLPurifier_AttrDef_Integer();
$align = new HTMLPurifier_AttrDef_Enum(array('left', 'right', 'center', 'justify')); $align = 'Enum#left,right,center,justify';
$address =& $this->addBlankElement('address'); $address =& $this->addBlankElement('address');
$address->content_model = 'Inline | #PCDATA | p'; $address->content_model = 'Inline | #PCDATA | p';
@ -70,15 +70,16 @@ class HTMLPurifier_HTMLModule_Legacy extends HTMLPurifier_HTMLModule
$blockquote->child = false; $blockquote->child = false;
$br =& $this->addBlankElement('br'); $br =& $this->addBlankElement('br');
$br->attr['clear'] = new HTMLPurifier_AttrDef_Enum(array('left', 'all', 'right', 'none')); $br->attr['clear'] = 'Enum#left,all,right,none';
$caption =& $this->addBlankElement('caption'); $caption =& $this->addBlankElement('caption');
$caption->attr['align'] = new HTMLPurifier_AttrDef_Enum(array('top', 'bottom', 'left', 'right')); $caption->attr['align'] = 'Enum#top,bottom,left,right';
$div =& $this->addBlankElement('div'); $div =& $this->addBlankElement('div');
$div->attr['align'] = $align; $div->attr['align'] = $align;
// dl.compact omitted $dl =& $this->addBlankElement('dl');
$dl->attr['compact'] = 'Bool#compact';
for ($i = 1; $i <= 6; $i++) { for ($i = 1; $i <= 6; $i++) {
$h =& $this->addBlankElement("h$i"); $h =& $this->addBlankElement("h$i");

View File

@ -46,6 +46,9 @@ class HTMLPurifier_HTMLModule_Scripting extends HTMLPurifier_HTMLModule
// blockquote's custom definition (we would use it but // blockquote's custom definition (we would use it but
// blockquote's contents are optional while noscript's contents // blockquote's contents are optional while noscript's contents
// are required) // are required)
// TODO: convert this to new syntax, main problem is getting
// both content sets working
foreach ($this->elements as $element) { foreach ($this->elements as $element) {
$this->info[$element] = new HTMLPurifier_ElementDef(); $this->info[$element] = new HTMLPurifier_ElementDef();
$this->info[$element]->safe = false; $this->info[$element]->safe = false;

View File

@ -21,13 +21,8 @@ class HTMLPurifier_HTMLModule_Tables extends HTMLPurifier_HTMLModule
'border' => 'Pixels', 'border' => 'Pixels',
'cellpadding' => 'Length', 'cellpadding' => 'Length',
'cellspacing' => 'Length', 'cellspacing' => 'Length',
'frame' => new HTMLPurifier_AttrDef_Enum(array( 'frame' => 'Enum#void,above,below,hsides,lhs,rhs,vsides,box,border',
'void', 'above', 'below', 'hsides', 'lhs', 'rhs', 'rules' => 'Enum#none,groups,rows,cols,all',
'vsides', 'box', 'border'
), false),
'rules' => new HTMLPurifier_AttrDef_Enum(array(
'none', 'groups', 'rows', 'cols', 'all'
), false),
'summary' => 'Text', 'summary' => 'Text',
'width' => 'Length' 'width' => 'Length'
) )
@ -35,13 +30,9 @@ class HTMLPurifier_HTMLModule_Tables extends HTMLPurifier_HTMLModule
// common attributes // common attributes
$cell_align = array( $cell_align = array(
'align' => new HTMLPurifier_AttrDef_Enum(array( 'align' => 'Enum#left,center,right,justify,char',
'left', 'center', 'right', 'justify', 'char'
), false),
'charoff' => 'Length', 'charoff' => 'Length',
'valign' => new HTMLPurifier_AttrDef_Enum(array( 'valign' => 'Enum#top,middle,bottom,baseline',
'top', 'middle', 'bottom', 'baseline'
), false),
); );
$cell_t = array_merge( $cell_t = array_merge(

View File

@ -7,29 +7,27 @@ class HTMLPurifier_AttrDef_EnumTest extends HTMLPurifier_AttrDefHarness
{ {
function testCaseInsensitive() { function testCaseInsensitive() {
$this->def = new HTMLPurifier_AttrDef_Enum(array('one', 'two')); $this->def = new HTMLPurifier_AttrDef_Enum(array('one', 'two'));
$this->assertDef('one'); $this->assertDef('one');
$this->assertDef('ONE', 'one'); $this->assertDef('ONE', 'one');
} }
function testCaseSensitive() { function testCaseSensitive() {
$this->def = new HTMLPurifier_AttrDef_Enum(array('one', 'two'), true); $this->def = new HTMLPurifier_AttrDef_Enum(array('one', 'two'), true);
$this->assertDef('one'); $this->assertDef('one');
$this->assertDef('ONE', false); $this->assertDef('ONE', false);
} }
function testFixing() { function testFixing() {
$this->def = new HTMLPurifier_AttrDef_Enum(array('one')); $this->def = new HTMLPurifier_AttrDef_Enum(array('one'));
$this->assertDef(' one ', 'one'); $this->assertDef(' one ', 'one');
}
function test_make() {
$factory = new HTMLPurifier_AttrDef_Enum();
$def = $factory->make('foo,bar');
$def2 = new HTMLPurifier_AttrDef_Enum(array('foo', 'bar'));
$this->assertIdentical($def, $def2);
} }
} }

View File

@ -0,0 +1,25 @@
<?php
require_once 'HTMLPurifier/AttrDefHarness.php';
require_once 'HTMLPurifier/AttrDef/HTML/Bool.php';
class HTMLPurifier_AttrDef_HTML_BoolTest extends HTMLPurifier_AttrDefHarness
{
function test() {
$this->def = new HTMLPurifier_AttrDef_HTML_Bool('foo');
$this->assertDef('foo');
$this->assertDef('', false);
$this->assertDef('bar', false);
}
function test_make() {
$factory = new HTMLPurifier_AttrDef_HTML_Bool();
$def = $factory->make('foo');
$def2 = new HTMLPurifier_AttrDef_HTML_Bool('foo');
$this->assertIdentical($def, $def2);
}
}
?>

View File

@ -17,6 +17,14 @@ class HTMLPurifier_AttrDefTest extends UnitTestCase
} }
function test_make() {
$def = new HTMLPurifier_AttrDef();
$def2 = $def->make('');
$this->assertIdentical($def, $def2);
}
} }
?> ?>

View File

@ -16,10 +16,10 @@ class HTMLPurifier_AttrTypesTest extends UnitTestCase
$this->expectError('Cannot retrieve undefined attribute type foobar'); $this->expectError('Cannot retrieve undefined attribute type foobar');
$types->get('foobar'); $types->get('foobar');
//$this->assertIdentical( $this->assertIdentical(
// $types->get('Enum#foo,bar'), $types->get('Enum#foo,bar'),
// new HTMLPurifier_AttrDef_Enum(array('foo', 'bar')) new HTMLPurifier_AttrDef_Enum(array('foo', 'bar'))
//); );
} }

View File

@ -9,9 +9,12 @@ class HTMLPurifier_HTMLModuleManagerTest extends UnitTestCase
$manager = new HTMLPurifier_HTMLModuleManager(); $manager = new HTMLPurifier_HTMLModuleManager();
$manager->doctypes->register('Blank'); // doctype normally is blank... $manager->doctypes->register('Blank'); // doctype normally is blank...
$attrdef_nmtokens = 1; // magic number
generate_mock_once('HTMLPurifier_AttrDef'); generate_mock_once('HTMLPurifier_AttrDef');
$attrdef_nmtokens =& new HTMLPurifier_AttrDefMock($this); $attrdef =& new HTMLPurifier_AttrDefMock($this);
$manager->attrTypes->info['NMTOKENS'] =& $attrdef_nmtokens; $attrdef->setReturnValue('make', $attrdef_nmtokens);
$manager->attrTypes->info['NMTOKENS'] =& $attrdef;
// ...but we add user modules // ...but we add user modules