[1.7.0] Wire in Language and ErrorCollector to main class, now, the only thing to do is actually implement the stuff

git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1157 48356398-32a2-884e-a903-53898d9a118a

library/HTMLPurifier.php

@@ -51,6 +51,23 @@ require_once 'HTMLPurifier/Generator.php';
 require_once 'HTMLPurifier/Strategy/Core.php';
 require_once 'HTMLPurifier/Encoder.php';
 
+require_once 'HTMLPurifier/LanguageFactory.php';
+
+HTMLPurifier_ConfigSchema::define(
+    'Core', 'Language', 'en', 'string', '
+ISO 639 language code for localizable things in HTML Purifier to use,
+which is mainly error reporting. There is currently only an English (en)
+translation, so this directive is currently useless.
+This directive has been available since 1.7.0.
+');
+
+HTMLPurifier_ConfigSchema::define(
+    'Core', 'CollectErrors', false, 'bool', '
+Whether or not to collect errors found while filtering the document. This
+is a useful way to give feedback to your users. CURRENTLY NOT IMPLEMENTED.
+This directive has been available since 1.7.0.
+');
+
 /**
  * Main library execution class.
  * 
@@ -121,6 +138,18 @@ class HTMLPurifier
         $lexer = HTMLPurifier_Lexer::create($config);
         
         $context = new HTMLPurifier_Context();
+        
+        // set up global context variables
+        if ($config->get('Core', 'CollectErrors')) {
+            // may get moved out if other facilities use it
+            $language_factory = HTMLPurifier_LanguageFactory::instance();
+            $language = $language_factory->create($config->get('Core', 'Language'));
+            $context->register('Locale', $language);
+            
+            $error_collector = new HTMLPurifier_ErrorCollector();
+            $context->register('ErrorCollector', $language);
+        }
+        
         $html = HTMLPurifier_Encoder::convertToUTF8($html, $config, $context);
         
         for ($i = 0, $size = count($this->filters); $i < $size; $i++) {

library/HTMLPurifier/ErrorCollector.php

@@ -0,0 +1,73 @@
+<?php
+
+require_once 'HTMLPurifier/Generator.php';
+
+/**
+ * Error collection class that enables HTML Purifier to report HTML
+ * problems back to the user
+ */
+class HTMLPurifier_ErrorCollector
+{
+    
+    var $errors = array();
+    
+    /**
+     * Sends an error message to the collector for later use
+     * @param string Error message text
+     * @param HTMLPurifier_Token Token that caused error
+     * @param array Tokens surrounding the offending token above, use true as placeholder
+     */
+    function send($msg, $token, $context_tokens = array(true)) {
+        $this->errors[] = array($msg, $token, $context_tokens);
+    }
+    
+    /**
+     * Retrieves raw error data for custom formatter to use
+     * @param List of arrays in format of array(Error message text,
+     *        token that caused error, tokens surrounding token)
+     */
+    function getRaw() {
+        return $this->errors;
+    }
+    
+    /**
+     * Default HTML formatting implementation for error messages
+     * @param $config Configuration array, vital for HTML output nature
+     */
+    function getHTMLFormatted($config) {
+        $generator = new HTMLPurifier_Generator();
+        $context = new HTMLPurifier_Context();
+        $generator->generateFromTokens(array(), $config, $context); // initialize
+        $ret = array();
+        
+        $errors = $this->errors;
+        
+        // sort error array by line
+        if ($config->get('Core', 'MaintainLineNumbers')) {
+            $lines  = array();
+            foreach ($errors as $error) $lines[] = $error[1]->line;
+            array_multisort($lines, SORT_ASC, $errors);
+        }
+        
+        foreach ($errors as $error) {
+            $string = $generator->escape($error[0]); // message
+            if (!empty($error[1]->line)) {
+                $string .= ' at line ' . $error[1]->line;
+            }
+            $string .= ' (<code>';
+            foreach ($error[2] as $token) {
+                if ($token !== true) {
+                    $string .= $generator->escape($generator->generateFromToken($token));
+                } else {
+                    $string .= '<strong>' . $generator->escape($generator->generateFromToken($error[1])) . '</strong>';
+                }
+            }
+            $string .= '</code>)';
+            $ret[] = $string;
+        }
+        return $ret;
+    }
+    
+}
+
+?>

library/HTMLPurifier/Language.php

@@ -2,8 +2,6 @@
 
 require_once 'HTMLPurifier/LanguageFactory.php';
 
-// UNUSED
-
 class HTMLPurifier_Language
 {
     

library/HTMLPurifier/Language/messages/en.php

@@ -7,6 +7,8 @@ $messages = array(
 'htmlpurifier' => 'HTML Purifier',
 'pizza' => 'Pizza', // for unit testing purposes
 
+
+
 );
 
 ?>

library/HTMLPurifier/LanguageFactory.php

@@ -3,8 +3,6 @@
 require_once 'HTMLPurifier/Language.php';
 require_once 'HTMLPurifier/AttrDef/Lang.php';
 
-// UNUSED
-
 /**
  * Class responsible for generating HTMLPurifier_Language objects, managing
  * caching and fallbacks.