mirror of
https://github.com/ezyang/htmlpurifier.git
synced 2024-12-31 20:01:52 +00:00
3441421e8b
- Port ConfigSchema and Config tests to new syntax - Deprecate Debugger - Add $schema params to most Config convenience functions - Add --php flag to testing scripts for command line - NOT TESTED WITH MULTITEST.PHP! git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1551 48356398-32a2-884e-a903-53898d9a118a
455 lines
20 KiB
PHP
455 lines
20 KiB
PHP
<?php
|
|
|
|
require_once 'HTMLPurifier/Config.php';
|
|
|
|
class HTMLPurifier_ConfigTest extends HTMLPurifier_Harness
|
|
{
|
|
|
|
protected $schema;
|
|
|
|
function setUp() {
|
|
// set up a dummy schema object for testing
|
|
$this->schema = new HTMLPurifier_ConfigSchema();
|
|
}
|
|
|
|
function tearDown() {
|
|
tally_errors($this);
|
|
}
|
|
|
|
// test functionality based on ConfigSchema
|
|
|
|
function testNormal() {
|
|
$this->schema->addNamespace('Element', 'Chemical substances that cannot be further decomposed');
|
|
|
|
$this->schema->add('Element', 'Abbr', 'H', 'string', 'Abbreviation of element name.');
|
|
$this->schema->add('Element', 'Name', 'hydrogen', 'istring', 'Full name of atoms.');
|
|
$this->schema->add('Element', 'Number', 1, 'int', 'Atomic number, is identity.');
|
|
$this->schema->add('Element', 'Mass', 1.00794, 'float', 'Atomic mass.');
|
|
$this->schema->add('Element', 'Radioactive', false, 'bool', 'Does it have rapid decay?');
|
|
$this->schema->add('Element', 'Isotopes', array(1 => true, 2 => true, 3 => true), 'lookup',
|
|
'What numbers of neutrons for this element have been observed?');
|
|
$this->schema->add('Element', 'Traits', array('nonmetallic', 'odorless', 'flammable'), 'list',
|
|
'What are general properties of the element?');
|
|
$this->schema->add('Element', 'IsotopeNames', array(1 => 'protium', 2 => 'deuterium', 3 => 'tritium'), 'hash',
|
|
'Lookup hash of neutron counts to formal names.');
|
|
$this->schema->add('Element', 'Object', new stdClass(), 'mixed', 'Model representation.');
|
|
|
|
$config = new HTMLPurifier_Config($this->schema);
|
|
$config->autoFinalize = false;
|
|
|
|
// test default value retrieval
|
|
$this->assertIdentical($config->get('Element', 'Abbr'), 'H');
|
|
$this->assertIdentical($config->get('Element', 'Name'), 'hydrogen');
|
|
$this->assertIdentical($config->get('Element', 'Number'), 1);
|
|
$this->assertIdentical($config->get('Element', 'Mass'), 1.00794);
|
|
$this->assertIdentical($config->get('Element', 'Radioactive'), false);
|
|
$this->assertIdentical($config->get('Element', 'Isotopes'), array(1 => true, 2 => true, 3 => true));
|
|
$this->assertIdentical($config->get('Element', 'Traits'), array('nonmetallic', 'odorless', 'flammable'));
|
|
$this->assertIdentical($config->get('Element', 'IsotopeNames'), array(1 => 'protium', 2 => 'deuterium', 3 => 'tritium'));
|
|
$this->assertIdentical($config->get('Element', 'Object'), new stdClass());
|
|
|
|
// test setting values
|
|
$config->set('Element', 'Abbr', 'Pu');
|
|
$config->set('Element', 'Name', 'PLUTONIUM'); // test decaps
|
|
$config->set('Element', 'Number', '94'); // test parsing
|
|
$config->set('Element', 'Mass', '244.'); // test parsing
|
|
$config->set('Element', 'Radioactive', true);
|
|
$config->set('Element', 'Isotopes', array(238, 239)); // test inversion
|
|
$config->set('Element', 'Traits', 'nuclear, heavy, actinide'); // test parsing
|
|
$config->set('Element', 'IsotopeNames', array(238 => 'Plutonium-238', 239 => 'Plutonium-239'));
|
|
$config->set('Element', 'Object', false); // unmodeled
|
|
|
|
$this->expectError('Cannot set undefined directive Element.Metal to value');
|
|
$config->set('Element', 'Metal', true);
|
|
|
|
$this->expectError('Value for Element.Radioactive is of invalid type, should be bool');
|
|
$config->set('Element', 'Radioactive', 'very');
|
|
|
|
// test value retrieval
|
|
$this->assertIdentical($config->get('Element', 'Abbr'), 'Pu');
|
|
$this->assertIdentical($config->get('Element', 'Name'), 'plutonium');
|
|
$this->assertIdentical($config->get('Element', 'Number'), 94);
|
|
$this->assertIdentical($config->get('Element', 'Mass'), 244.);
|
|
$this->assertIdentical($config->get('Element', 'Radioactive'), true);
|
|
$this->assertIdentical($config->get('Element', 'Isotopes'), array(238 => true, 239 => true));
|
|
$this->assertIdentical($config->get('Element', 'Traits'), array('nuclear', 'heavy', 'actinide'));
|
|
$this->assertIdentical($config->get('Element', 'IsotopeNames'), array(238 => 'Plutonium-238', 239 => 'Plutonium-239'));
|
|
$this->assertIdentical($config->get('Element', 'Object'), false);
|
|
|
|
$this->expectError('Cannot retrieve value of undefined directive Element.Metal');
|
|
$config->get('Element', 'Metal');
|
|
|
|
}
|
|
|
|
function testEnumerated() {
|
|
|
|
$this->schema->addNamespace('Instrument', 'Of the musical type.');
|
|
|
|
// case sensitive
|
|
$this->schema->add('Instrument', 'Manufacturer', 'Yamaha', 'string', 'Who made it?');
|
|
$this->schema->addAllowedValues('Instrument', 'Manufacturer', array(
|
|
'Yamaha', 'Conn-Selmer', 'Vandoren', 'Laubin', 'Buffet', 'other'));
|
|
$this->schema->addValueAliases('Instrument', 'Manufacturer', array(
|
|
'Selmer' => 'Conn-Selmer'));
|
|
|
|
// case insensitive
|
|
$this->schema->add('Instrument', 'Family', 'woodwind', 'istring', 'What family is it?');
|
|
$this->schema->addAllowedValues('Instrument', 'Family', array(
|
|
'brass', 'woodwind', 'percussion', 'string', 'keyboard', 'electronic'));
|
|
$this->schema->addValueAliases('Instrument', 'Family', array(
|
|
'synth' => 'electronic'));
|
|
|
|
$config = new HTMLPurifier_Config($this->schema);
|
|
$config->autoFinalize = false;
|
|
|
|
// case sensitive
|
|
|
|
$config->set('Instrument', 'Manufacturer', 'Vandoren');
|
|
$this->assertIdentical($config->get('Instrument', 'Manufacturer'), 'Vandoren');
|
|
|
|
$config->set('Instrument', 'Manufacturer', 'Selmer');
|
|
$this->assertIdentical($config->get('Instrument', 'Manufacturer'), 'Conn-Selmer');
|
|
|
|
$this->expectError('Value not supported, valid values are: Yamaha, Conn-Selmer, Vandoren, Laubin, Buffet, other');
|
|
$config->set('Instrument', 'Manufacturer', 'buffet');
|
|
|
|
// case insensitive
|
|
|
|
$config->set('Instrument', 'Family', 'brass');
|
|
$this->assertIdentical($config->get('Instrument', 'Family'), 'brass');
|
|
|
|
$config->set('Instrument', 'Family', 'PERCUSSION');
|
|
$this->assertIdentical($config->get('Instrument', 'Family'), 'percussion');
|
|
|
|
$config->set('Instrument', 'Family', 'synth');
|
|
$this->assertIdentical($config->get('Instrument', 'Family'), 'electronic');
|
|
|
|
$config->set('Instrument', 'Family', 'Synth');
|
|
$this->assertIdentical($config->get('Instrument', 'Family'), 'electronic');
|
|
|
|
}
|
|
|
|
function testNull() {
|
|
|
|
$this->schema->addNamespace('ReportCard', 'It is for grades.');
|
|
$this->schema->add('ReportCard', 'English', null, 'string/null', 'Grade from English class.');
|
|
$this->schema->add('ReportCard', 'Absences', 0, 'int', 'How many times missing from school?');
|
|
|
|
$config = new HTMLPurifier_Config($this->schema);
|
|
$config->autoFinalize = false;
|
|
|
|
$config->set('ReportCard', 'English', 'B-');
|
|
$this->assertIdentical($config->get('ReportCard', 'English'), 'B-');
|
|
|
|
$config->set('ReportCard', 'English', null); // not yet graded
|
|
$this->assertIdentical($config->get('ReportCard', 'English'), null);
|
|
|
|
// error
|
|
$this->expectError('Value for ReportCard.Absences is of invalid type, should be int');
|
|
$config->set('ReportCard', 'Absences', null);
|
|
|
|
}
|
|
|
|
function testAliases() {
|
|
|
|
$this->schema->addNamespace('Home', 'Sweet home.');
|
|
$this->schema->add('Home', 'Rug', 3, 'int', 'ID.');
|
|
$this->schema->addAlias('Home', 'Carpet', 'Home', 'Rug');
|
|
|
|
$config = new HTMLPurifier_Config($this->schema);
|
|
$config->autoFinalize = false;
|
|
|
|
$this->assertIdentical($config->get('Home', 'Rug'), 3);
|
|
|
|
$this->expectError('Cannot get value from aliased directive, use real name Home.Rug');
|
|
$config->get('Home', 'Carpet');
|
|
|
|
$config->set('Home', 'Carpet', 999);
|
|
$this->assertIdentical($config->get('Home', 'Rug'), 999);
|
|
|
|
}
|
|
|
|
// test functionality based on method
|
|
|
|
function test_getBatch() {
|
|
|
|
$this->schema->addNamespace('Variables', 'Changing quantities in equation.');
|
|
$this->schema->add('Variables', 'TangentialAcceleration', 'a_tan', 'string', 'In m/s^2');
|
|
$this->schema->add('Variables', 'AngularAcceleration', 'alpha', 'string', 'In rad/s^2');
|
|
|
|
$config = new HTMLPurifier_Config($this->schema);
|
|
$config->autoFinalize = false;
|
|
|
|
// grab a namespace
|
|
$this->assertIdentical(
|
|
$config->getBatch('Variables'),
|
|
array(
|
|
'TangentialAcceleration' => 'a_tan',
|
|
'AngularAcceleration' => 'alpha'
|
|
)
|
|
);
|
|
|
|
// grab a non-existant namespace
|
|
$this->expectError('Cannot retrieve undefined namespace Constants');
|
|
$config->getBatch('Constants');
|
|
|
|
}
|
|
|
|
function test_loadIni() {
|
|
|
|
$this->schema->addNamespace('Shortcut', 'Keyboard shortcuts for commands');
|
|
$this->schema->add('Shortcut', 'Copy', 'c', 'istring', 'Copy text');
|
|
$this->schema->add('Shortcut', 'Paste', 'v', 'istring', 'Paste clipboard');
|
|
$this->schema->add('Shortcut', 'Cut', 'x', 'istring', 'Cut text');
|
|
|
|
$config = new HTMLPurifier_Config($this->schema);
|
|
$config->autoFinalize = false;
|
|
|
|
$config->loadIni(dirname(__FILE__) . '/ConfigTest-loadIni.ini');
|
|
|
|
$this->assertIdentical($config->get('Shortcut', 'Copy'), 'q');
|
|
$this->assertIdentical($config->get('Shortcut', 'Paste'), 'p');
|
|
$this->assertIdentical($config->get('Shortcut', 'Cut'), 't');
|
|
|
|
}
|
|
|
|
function test_getHTMLDefinition() {
|
|
|
|
// we actually want to use the old copy, because the definition
|
|
// generation routines have dependencies on configuration values
|
|
|
|
$config = HTMLPurifier_Config::createDefault();
|
|
$config->set('HTML', 'Doctype', 'XHTML 1.0 Strict');
|
|
$config->autoFinalize = false;
|
|
|
|
$def = $config->getCSSDefinition();
|
|
$this->assertIsA($def, 'HTMLPurifier_CSSDefinition');
|
|
|
|
$def =& $config->getHTMLDefinition();
|
|
$def2 =& $config->getHTMLDefinition();
|
|
$this->assertIsA($def, 'HTMLPurifier_HTMLDefinition');
|
|
$this->assertReference($def, $def2);
|
|
$this->assertTrue($def->setup);
|
|
|
|
// test re-calculation if HTML changes
|
|
unset($def, $def2);
|
|
$def2 = $config->getHTMLDefinition(); // forcibly de-reference
|
|
|
|
$config->set('HTML', 'Doctype', 'HTML 4.01 Transitional');
|
|
$def = $config->getHTMLDefinition();
|
|
$this->assertIsA($def, 'HTMLPurifier_HTMLDefinition');
|
|
$this->assertNotEqual($def, $def2);
|
|
$this->assertTrue($def->setup);
|
|
|
|
// test retrieval of raw definition
|
|
$config->set('HTML', 'DefinitionID', 'HTMLPurifier_ConfigTest->test_getHTMLDefinition()');
|
|
$config->set('HTML', 'DefinitionRev', 3);
|
|
$def =& $config->getHTMLDefinition(true);
|
|
$this->assertNotEqual($def, $def2);
|
|
$this->assertEqual(false, $def->setup);
|
|
|
|
// auto initialization
|
|
$config->getHTMLDefinition();
|
|
$this->assertTrue($def->setup);
|
|
|
|
}
|
|
|
|
function test_getHTMLDefinition_rawError() {
|
|
$config = HTMLPurifier_Config::createDefault();
|
|
$this->expectError('Cannot retrieve raw version without specifying %HTML.DefinitionID');
|
|
$def =& $config->getHTMLDefinition(true);
|
|
}
|
|
|
|
function test_getCSSDefinition() {
|
|
$config = HTMLPurifier_Config::createDefault();
|
|
$def = $config->getCSSDefinition();
|
|
$this->assertIsA($def, 'HTMLPurifier_CSSDefinition');
|
|
}
|
|
|
|
function test_getDefinition() {
|
|
$this->schema->addNamespace('Cache', 'Cache stuff');
|
|
$this->schema->add('Cache', 'DefinitionImpl', null, 'string/null', 'Cache?');
|
|
$this->schema->addNamespace('Crust', 'Krusty Krabs');
|
|
$config = new HTMLPurifier_Config($this->schema);
|
|
$this->expectError("Definition of Crust type not supported");
|
|
$config->getDefinition('Crust');
|
|
}
|
|
|
|
function test_loadArray() {
|
|
// setup a few dummy namespaces/directives for our testing
|
|
$this->schema->addNamespace('Zoo', 'Animals we have.');
|
|
$this->schema->add('Zoo', 'Aadvark', 0, 'int', 'Have?');
|
|
$this->schema->add('Zoo', 'Boar', 0, 'int', 'Have?');
|
|
$this->schema->add('Zoo', 'Camel', 0, 'int', 'Have?');
|
|
$this->schema->add(
|
|
'Zoo', 'Others', array(), 'list', 'Other animals we have one of.'
|
|
);
|
|
|
|
$config_manual = new HTMLPurifier_Config($this->schema);
|
|
$config_loadabbr = new HTMLPurifier_Config($this->schema);
|
|
$config_loadfull = new HTMLPurifier_Config($this->schema);
|
|
|
|
$config_manual->set('Zoo', 'Aadvark', 3);
|
|
$config_manual->set('Zoo', 'Boar', 5);
|
|
$config_manual->set('Zoo', 'Camel', 2000); // that's a lotta camels!
|
|
$config_manual->set('Zoo', 'Others', array('Peacock', 'Dodo')); // wtf!
|
|
|
|
// condensed form
|
|
$config_loadabbr->loadArray(array(
|
|
'Zoo.Aadvark' => 3,
|
|
'Zoo.Boar' => 5,
|
|
'Zoo.Camel' => 2000,
|
|
'Zoo.Others' => array('Peacock', 'Dodo')
|
|
));
|
|
|
|
// fully expanded form
|
|
$config_loadfull->loadArray(array(
|
|
'Zoo' => array(
|
|
'Aadvark' => 3,
|
|
'Boar' => 5,
|
|
'Camel' => 2000,
|
|
'Others' => array('Peacock', 'Dodo')
|
|
)
|
|
));
|
|
|
|
$this->assertIdentical($config_manual, $config_loadabbr);
|
|
$this->assertIdentical($config_manual, $config_loadfull);
|
|
|
|
}
|
|
|
|
function test_create() {
|
|
|
|
$this->schema->addNamespace('Cake', 'Properties of it.');
|
|
$this->schema->add('Cake', 'Sprinkles', 666, 'int', 'Number of.');
|
|
$this->schema->add('Cake', 'Flavor', 'vanilla', 'string', 'Flavor of the batter.');
|
|
|
|
$config = new HTMLPurifier_Config($this->schema);
|
|
$config->set('Cake', 'Sprinkles', 42);
|
|
|
|
// test flat pass-through
|
|
$created_config = HTMLPurifier_Config::create($config, $this->schema);
|
|
$this->assertIdentical($config, $created_config);
|
|
|
|
// test loadArray
|
|
$created_config = HTMLPurifier_Config::create(array('Cake.Sprinkles' => 42), $this->schema);
|
|
$this->assertIdentical($config, $created_config);
|
|
|
|
// test loadIni
|
|
$created_config = HTMLPurifier_Config::create(dirname(__FILE__) . '/ConfigTest-create.ini', $this->schema);
|
|
$this->assertIdentical($config, $created_config);
|
|
|
|
}
|
|
|
|
function test_finalize() {
|
|
|
|
// test finalization
|
|
|
|
$this->schema->addNamespace('Poem', 'Violets are red, roses are blue...');
|
|
$this->schema->add('Poem', 'Meter', 'iambic', 'string', 'Rhythm of poem.');
|
|
|
|
$config = new HTMLPurifier_Config($this->schema);
|
|
$config->autoFinalize = false;
|
|
|
|
$config->set('Poem', 'Meter', 'irregular');
|
|
|
|
$config->finalize();
|
|
|
|
$this->expectError('Cannot set directive after finalization');
|
|
$config->set('Poem', 'Meter', 'vedic');
|
|
|
|
$this->expectError('Cannot load directives after finalization');
|
|
$config->loadArray(array('Poem.Meter' => 'octosyllable'));
|
|
|
|
$this->expectError('Cannot load directives after finalization');
|
|
$config->loadIni(dirname(__FILE__) . '/ConfigTest-finalize.ini');
|
|
|
|
}
|
|
|
|
function __onlytest_loadArrayFromForm() {
|
|
|
|
$this->schema->addNamespace('Pancake', 'This should not be user customizable');
|
|
$this->schema->add('Pancake', 'Mix', 'buttermilk', 'string', 'Type of pancake mix to use.');
|
|
$this->schema->add('Pancake', 'Served', true, 'bool', 'But this is customizable by user.');
|
|
$this->schema->addNamespace('Toppings', 'This is user customizable');
|
|
$this->schema->add('Toppings', 'Syrup', true, 'bool', 'Absolutely standard!');
|
|
$this->schema->add('Toppings', 'Flavor', 'maple', 'string', 'What flavor is the syrup?');
|
|
$this->schema->add('Toppings', 'Strawberries', 3, 'int', 'Quite delightful fruit.');
|
|
$this->schema->add('Toppings', 'Calories', 2000, 'int/null', 'Some things are best left unknown.');
|
|
$this->schema->add('Toppings', 'DefinitionID', null, 'string/null', 'Do not let this be set');
|
|
$this->schema->add('Toppings', 'DefinitionRev', 1, 'int', 'Do not let this be set');
|
|
$this->schema->add('Toppings', 'Protected', 1, 'int', 'Do not let this be set');
|
|
|
|
$get = array(
|
|
'breakfast' => array(
|
|
'Pancake.Mix' => 'nasty',
|
|
'Pancake.Served' => '0',
|
|
'Toppings.Syrup' => '0',
|
|
'Toppings.Flavor' => "juice",
|
|
'Toppings.Strawberries' => '999',
|
|
'Toppings.Calories' => '',
|
|
'Null_Toppings.Calories' => '1',
|
|
'Toppings.DefinitionID' => '<argh>',
|
|
'Toppings.DefinitionRev' => '65',
|
|
'Toppings.Protected' => '4',
|
|
)
|
|
);
|
|
|
|
$config_expect = HTMLPurifier_Config::create(array(
|
|
'Pancake.Served' => false,
|
|
'Toppings.Syrup' => false,
|
|
'Toppings.Flavor' => "juice",
|
|
'Toppings.Strawberries' => 999,
|
|
'Toppings.Calories' => null
|
|
), $this->schema);
|
|
|
|
$config_result = HTMLPurifier_Config::loadArrayFromForm(
|
|
$get, 'breakfast',
|
|
array('Pancake.Served', 'Toppings', '-Toppings.Protected'),
|
|
true, // mq fix
|
|
$this->schema
|
|
);
|
|
|
|
$this->assertEqual($config_expect, $config_result);
|
|
|
|
/*
|
|
MAGIC QUOTES NOT TESTED!!!
|
|
|
|
$get = array(
|
|
'breakfast' => array(
|
|
'Pancake.Mix' => 'n\\asty'
|
|
)
|
|
);
|
|
$config_expect = HTMLPurifier_Config::create(array(
|
|
'Pancake.Mix' => 'n\\asty'
|
|
));
|
|
$config_result = HTMLPurifier_Config::loadArrayFromForm($get, 'breakfast', true, false);
|
|
$this->assertEqual($config_expect, $config_result);
|
|
*/
|
|
}
|
|
|
|
function test_getAllowedDirectivesForForm() {
|
|
$this->schema->addNamespace('Unused', 'Not mentioned, so deny');
|
|
$this->schema->add('Unused', 'Unused', 'Foobar', 'string', 'Not mentioned, do not allow');
|
|
$this->schema->addNamespace('Partial', 'Some are mentioned, allow only those');
|
|
$this->schema->add('Partial', 'Allowed', true, 'bool', 'Mentioned, allowed');
|
|
$this->schema->add('Partial', 'Unused', 'Foobar', 'string', 'Not mentioned, do not allow');
|
|
$this->schema->addNamespace('All', 'Entire namespace allowed, allow all unless...');
|
|
$this->schema->add('All', 'Allowed', true, 'bool', 'Not mentioned, allowed');
|
|
$this->schema->add('All', 'Blacklisted', 'Foobar', 'string', 'Specifically blacklisted');
|
|
$this->schema->add('All', 'DefinitionID', 'Foobar', 'string/null', 'Special case, auto-blacklisted');
|
|
$this->schema->add('All', 'DefinitionRev', 2, 'int', 'Special case, auto-blacklisted');
|
|
|
|
$input = array('Partial.Allowed', 'All', '-All.Blacklisted');
|
|
$output = HTMLPurifier_Config::getAllowedDirectivesForForm($input, $this->schema);
|
|
$expect = array(
|
|
array('Partial', 'Allowed'),
|
|
array('All', 'Allowed')
|
|
);
|
|
|
|
$this->assertEqual($output, $expect);
|
|
|
|
}
|
|
|
|
}
|
|
|