[3.1.0] Feature parity with configdoc rewrite

- Abolish most classes in ConfigDoc except for HTMLXSLTProcessor
- Implement Builder_Xml using XmlWriter
- Add some convenience functions

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

library/HTMLPurifier/ConfigSchema/Builder/Xml.php

@@ -0,0 +1,91 @@
+<?php
+
+/**
+ * Converts HTMLPurifier_ConfigSchema_Interchange to an XML format,
+ * which can be further processed to generate documentation.
+ */
+class HTMLPurifier_ConfigSchema_Builder_Xml extends XMLWriter
+{
+    
+    protected $interchange;
+    
+    protected function writeHTMLDiv($html) {
+        $this->startElement('div');
+        
+        $purifier = HTMLPurifier::getInstance();
+        $html = $purifier->purify($html);
+        $this->writeAttribute('xmlns', 'http://www.w3.org/1999/xhtml');
+        $this->writeRaw($html);
+        
+        $this->endElement(); // div
+    }
+    
+    protected function export($var) {
+        if ($var === array()) return 'array()';
+        return var_export($var, true);
+    }
+    
+    public function build($interchange) {
+        // global access, only use as last resort
+        $this->interchange = $interchange;
+        
+        $this->setIndent(true);
+        $this->startDocument('1.0', 'UTF-8');
+        $this->startElement('configdoc');
+        $this->writeElement('title', $interchange->name);
+        
+        foreach ($interchange->namespaces as $namespace) {
+            $this->buildNamespace($namespace);
+        }
+        
+        $this->endElement(); // configdoc
+        $this->flush();
+    }
+    
+    public function buildNamespace($namespace) {
+        $this->startElement('namespace');
+        $this->writeAttribute('id', $namespace->namespace);
+        
+        $this->writeElement('name', $namespace->namespace);
+        $this->startElement('description');
+            $this->writeHTMLDiv($namespace->description);
+        $this->endElement(); // description
+        
+        foreach ($this->interchange->directives as $directive) {
+            if ($directive->id->namespace !== $namespace->namespace) continue;
+            $this->buildDirective($directive);
+        }
+        
+        $this->endElement(); // namespace
+    }
+    
+    public function buildDirective($directive) {
+        $this->startElement('directive');
+        $this->writeAttribute('id', $directive->id->toString());
+        
+        $this->writeElement('name', $directive->id->directive);
+        
+        $this->startElement('aliases');
+            foreach ($directive->aliases as $alias) $this->writeElement('alias', $alias->toString());
+        $this->endElement(); // aliases
+        
+        $this->startElement('constraints');
+            $this->writeElement('type', $directive->type);
+            if ($directive->typeAllowsNull) $this->writeAttribute('allow-null', 'yes');
+            if ($directive->allowed) {
+                $this->startElement('allowed');
+                    foreach ($directive->allowed as $value => $x) $this->writeElement('value', $value);
+                $this->endElement(); // allowed
+            }
+            $this->writeElement('default', $this->export($directive->default));
+            $this->writeAttribute('xml:space', 'preserve');
+        $this->endElement(); // constraints
+        
+        $this->startElement('description');
+            $this->writeHTMLDiv($directive->description);
+        $this->endElement(); // description
+        
+        $this->endElement(); // directive
+    }
+    
+}

library/HTMLPurifier/ConfigSchema/Interchange.php

@@ -8,6 +8,11 @@
 class HTMLPurifier_ConfigSchema_Interchange
 {
     
+    /**
+     * Name of the application this schema is describing.
+     */
+    public $name;
+    
     /**
      * Array of Namespace ID => array(namespace info)
      */
@@ -38,4 +43,13 @@ class HTMLPurifier_ConfigSchema_Interchange
         $this->directives[$i] = $directive;
     }
     
+    /**
+     * Convenience function to perform standard validation. Throws exception
+     * on failed validation.
+     */
+    public function validate() {
+        $validator = new HTMLPurifier_ConfigSchema_Validator();
+        return $validator->validate($this);
+    }
+    
 }

library/HTMLPurifier/ConfigSchema/InterchangeBuilder.php

@@ -12,6 +12,30 @@ class HTMLPurifier_ConfigSchema_InterchangeBuilder
         $this->varParser = $varParser ? $varParser : new HTMLPurifier_VarParser_Native();
     }
     
+    public static function buildFromDirectory($dir = null) {
+        $parser      = new HTMLPurifier_StringHashParser();
+        $builder     = new HTMLPurifier_ConfigSchema_InterchangeBuilder();
+        $interchange = new HTMLPurifier_ConfigSchema_Interchange();
+        
+        if (!$dir) $dir = realpath(dirname(__FILE__) . '/schema/');
+        $info = parse_ini_file($dir . 'info.ini');
+        $interchange->name = $info['name'];
+        
+        $dh = opendir($dir);
+        while (false !== ($file = readdir($dh))) {
+            if (!$file || $file[0] == '.' || strrchr($file, '.') !== '.txt') {
+                continue;
+            }
+            $builder->build(
+                $interchange,
+                new HTMLPurifier_StringHash( $parser->parseFile($dir . $file) )
+            );
+        }
+        closedir($dh);
+        
+        return $interchange;
+    }
+    
     /**
      * Builds an interchange object based on a hash.
      * @param $interchange HTMLPurifier_ConfigSchema_Interchange object to build

library/HTMLPurifier/ConfigSchema/Validator.php

@@ -48,6 +48,7 @@ class HTMLPurifier_ConfigSchema_Validator
             if ($i != $id) $this->error(false, "Integrity violation: key '$i' does not match internal id '$id'");
             $this->validateDirective($directive);
         }
+        return true;
     }
     
     /**

library/HTMLPurifier/ConfigSchema/schema/info.ini

@@ -0,0 +1 @@
+name = "HTML Purifier"