mirror of
https://github.com/ezyang/htmlpurifier.git
synced 2024-12-22 16:31:53 +00:00
[2.0.1] Add severity to error collector
git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1226 48356398-32a2-884e-a903-53898d9a118a
This commit is contained in:
parent
58064592ff
commit
7b087c7bbe
2
NEWS
2
NEWS
@ -34,6 +34,8 @@ NEWS ( CHANGELOG and HISTORY ) HTMLPurifier
|
|||||||
. Interlinking in configuration documentation added using
|
. Interlinking in configuration documentation added using
|
||||||
Injector_PurifierLinkify
|
Injector_PurifierLinkify
|
||||||
. Directives now keep track of aliases to themselves
|
. Directives now keep track of aliases to themselves
|
||||||
|
. Error collector now requires a severity to be passed, use PHP's internal
|
||||||
|
error constants for this
|
||||||
|
|
||||||
2.0.0, released 2007-06-20
|
2.0.0, released 2007-06-20
|
||||||
# Completely refactored HTMLModuleManager, decentralizing safety
|
# Completely refactored HTMLModuleManager, decentralizing safety
|
||||||
|
2
TODO
2
TODO
@ -45,7 +45,7 @@ TODO List
|
|||||||
same fashion!)
|
same fashion!)
|
||||||
# Formatters for plaintext
|
# Formatters for plaintext
|
||||||
- Smileys
|
- Smileys
|
||||||
- Linkification for HTML Purifier docs: notably configuration and classes
|
- Linkification for HTML Purifier docs: classes
|
||||||
- Standardize token armor for all areas of processing
|
- Standardize token armor for all areas of processing
|
||||||
- Fixes for Firefox's inability to handle COL alignment props (Bug 915)
|
- Fixes for Firefox's inability to handle COL alignment props (Bug 915)
|
||||||
- Automatically add non-breaking spaces to empty table cells when
|
- Automatically add non-breaking spaces to empty table cells when
|
||||||
|
@ -14,11 +14,12 @@ class HTMLPurifier_ErrorCollector
|
|||||||
/**
|
/**
|
||||||
* Sends an error message to the collector for later use
|
* Sends an error message to the collector for later use
|
||||||
* @param string Error message text
|
* @param string Error message text
|
||||||
|
* @param int Error severity, PHP error style (don't use E_USER_)
|
||||||
* @param HTMLPurifier_Token Token that caused error
|
* @param HTMLPurifier_Token Token that caused error
|
||||||
* @param array Tokens surrounding the offending token above, use true as placeholder
|
* @param array Tokens surrounding the offending token above, use true as placeholder
|
||||||
*/
|
*/
|
||||||
function send($msg, $token, $context_tokens = array(true)) {
|
function send($msg, $severity, $token, $context_tokens = array(true)) {
|
||||||
$this->errors[] = array($msg, $token, $context_tokens);
|
$this->errors[] = array($msg, $severity, $token, $context_tokens);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -34,32 +35,35 @@ class HTMLPurifier_ErrorCollector
|
|||||||
* Default HTML formatting implementation for error messages
|
* Default HTML formatting implementation for error messages
|
||||||
* @param $config Configuration array, vital for HTML output nature
|
* @param $config Configuration array, vital for HTML output nature
|
||||||
*/
|
*/
|
||||||
function getHTMLFormatted($config) {
|
function getHTMLFormatted($config, &$context) {
|
||||||
$generator = new HTMLPurifier_Generator();
|
$generator = new HTMLPurifier_Generator();
|
||||||
$context = new HTMLPurifier_Context();
|
|
||||||
$generator->generateFromTokens(array(), $config, $context); // initialize
|
$generator->generateFromTokens(array(), $config, $context); // initialize
|
||||||
$ret = array();
|
$ret = array();
|
||||||
|
|
||||||
$errors = $this->errors;
|
$errors = $this->errors;
|
||||||
|
$locale = $context->get('Locale');
|
||||||
|
|
||||||
// sort error array by line
|
// sort error array by line
|
||||||
if ($config->get('Core', 'MaintainLineNumbers')) {
|
if ($config->get('Core', 'MaintainLineNumbers')) {
|
||||||
$lines = array();
|
$lines = array();
|
||||||
foreach ($errors as $error) $lines[] = $error[1]->line;
|
foreach ($errors as $error) $lines[] = $error[2]->line;
|
||||||
array_multisort($lines, SORT_ASC, $errors);
|
array_multisort($lines, SORT_ASC, $errors);
|
||||||
}
|
}
|
||||||
|
|
||||||
foreach ($errors as $error) {
|
foreach ($errors as $error) {
|
||||||
$string = $generator->escape($error[0]); // message
|
list($msg, $severity, $token, $context_tokens) = $error;
|
||||||
if (!empty($error[1]->line)) {
|
$string = '';
|
||||||
$string .= ' at line ' . $error[1]->line;
|
$string .= $locale->getErrorName($severity) . ': ';
|
||||||
|
$string .= $generator->escape($msg);
|
||||||
|
if (!empty($token->line)) {
|
||||||
|
$string .= ' at line ' . $token->line;
|
||||||
}
|
}
|
||||||
$string .= ' (<code>';
|
$string .= ' (<code>';
|
||||||
foreach ($error[2] as $token) {
|
foreach ($context_tokens as $context_token) {
|
||||||
if ($token !== true) {
|
if ($context_token !== true) {
|
||||||
$string .= $generator->escape($generator->generateFromToken($token));
|
$string .= $generator->escape($generator->generateFromToken($context_token));
|
||||||
} else {
|
} else {
|
||||||
$string .= '<strong>' . $generator->escape($generator->generateFromToken($error[1])) . '</strong>';
|
$string .= '<strong>' . $generator->escape($generator->generateFromToken($token)) . '</strong>';
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
$string .= '</code>)';
|
$string .= '</code>)';
|
||||||
|
@ -20,6 +20,11 @@ class HTMLPurifier_Language
|
|||||||
*/
|
*/
|
||||||
var $messages = array();
|
var $messages = array();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Array of localizable error codes
|
||||||
|
*/
|
||||||
|
var $errorNames = array();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Has the language object been loaded yet?
|
* Has the language object been loaded yet?
|
||||||
* @private
|
* @private
|
||||||
@ -51,6 +56,18 @@ class HTMLPurifier_Language
|
|||||||
return $this->messages[$key];
|
return $this->messages[$key];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves a localised error name.
|
||||||
|
* @param $int integer error number, corresponding to PHP's error
|
||||||
|
* reporting
|
||||||
|
* @return string localised message
|
||||||
|
*/
|
||||||
|
function getErrorName($int) {
|
||||||
|
if (!$this->_loaded) $this->load();
|
||||||
|
if (!isset($this->errorNames[$int])) return "[Error: $int]";
|
||||||
|
return $this->errorNames[$int];
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Formats a localised message with passed parameters
|
* Formats a localised message with passed parameters
|
||||||
* @param $key string identifier of message
|
* @param $key string identifier of message
|
||||||
|
@ -9,6 +9,12 @@ $messages = array(
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
);
|
||||||
|
|
||||||
|
$errorNames = array(
|
||||||
|
E_ERROR => 'Error',
|
||||||
|
E_WARNING => 'Warning',
|
||||||
|
E_NOTICE => 'Notice'
|
||||||
);
|
);
|
||||||
|
|
||||||
?>
|
?>
|
@ -43,7 +43,7 @@ class HTMLPurifier_LanguageFactory
|
|||||||
* Keys whose contents are a hash map and can be merged
|
* Keys whose contents are a hash map and can be merged
|
||||||
* @value array lookup
|
* @value array lookup
|
||||||
*/
|
*/
|
||||||
var $mergeable_keys_map = array('messages' => true);
|
var $mergeable_keys_map = array('messages' => true, 'errorNames' => true);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Keys whose contents are a list and can be merged
|
* Keys whose contents are a list and can be merged
|
||||||
|
@ -17,23 +17,32 @@ class HTMLPurifier_ErrorCollectorTest extends UnitTestCase
|
|||||||
$tok4->line = 3;
|
$tok4->line = 3;
|
||||||
|
|
||||||
$collector = new HTMLPurifier_ErrorCollector();
|
$collector = new HTMLPurifier_ErrorCollector();
|
||||||
$collector->send('Big fat error', $tok1);
|
$collector->send('Big fat error', E_ERROR, $tok1);
|
||||||
$collector->send('Another <error>', $tok2, array($tok3, true, $tok4));
|
$collector->send('Another <warning>', E_WARNING, $tok2, array($tok3, true, $tok4));
|
||||||
|
|
||||||
$result = array(
|
$result = array(
|
||||||
0 => array('Big fat error', $tok1, array(true)),
|
0 => array('Big fat error', E_ERROR, $tok1, array(true)),
|
||||||
1 => array('Another <error>', $tok2, array($tok3, true, $tok4))
|
1 => array('Another <warning>', E_WARNING, $tok2, array($tok3, true, $tok4))
|
||||||
);
|
);
|
||||||
|
|
||||||
$this->assertIdentical($collector->getRaw(), $result);
|
$this->assertIdentical($collector->getRaw(), $result);
|
||||||
|
|
||||||
$formatted_result = array(
|
$formatted_result = array(
|
||||||
0 => 'Another <error> at line 3 (<code>Context before<strong><a></strong>Context after</code>)',
|
0 => 'Warning: Another <warning> at line 3 (<code>Context before<strong><a></strong>Context after</code>)',
|
||||||
1 => 'Big fat error at line 23 (<code><strong>Token that caused error</strong></code>)'
|
1 => 'Error: Big fat error at line 23 (<code><strong>Token that caused error</strong></code>)'
|
||||||
);
|
);
|
||||||
|
|
||||||
$config = HTMLPurifier_Config::create(array('Core.MaintainLineNumbers' => true));
|
$config = HTMLPurifier_Config::create(array('Core.MaintainLineNumbers' => true));
|
||||||
$this->assertIdentical($collector->getHTMLFormatted($config), $formatted_result);
|
|
||||||
|
$context = new HTMLPurifier_Context();
|
||||||
|
|
||||||
|
generate_mock_once('HTMLPurifier_Language');
|
||||||
|
$language = new HTMLPurifier_LanguageMock();
|
||||||
|
$language->setReturnValue('getErrorName', 'Error', array(E_ERROR));
|
||||||
|
$language->setReturnValue('getErrorName', 'Warning', array(E_WARNING));
|
||||||
|
$context->register('Locale', $language);
|
||||||
|
|
||||||
|
$this->assertIdentical($collector->getHTMLFormatted($config, $context), $formatted_result);
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user