Further refactoring to remove hacks. Move everything into the ConfigDoc facade object. Add parameters to plain.xsl. Optionally singleton-ize HTML Purifier. Add loadArrayFromForm to Config object.

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

configdoc/generate.php

@@ -7,12 +7,11 @@
 
 /*
 TODO:
-- make XML format richer (see below)
+- make XML format richer (see XMLSerializer_ConfigSchema)
 - extend XSLT transformation (see the corresponding XSLT file)
 - allow generation of packaged docs that can be easily moved
 - multipage documentation
 - determine how to multilingualize
-- factor out code into classes
 */
 
 // there are several hacks for the configForm.php smoketest
@@ -37,53 +36,17 @@ require_once 'library/ConfigDoc.auto.php';
 // ---------------------------------------------------------------------------
 // Load copies of HTMLPurifier_ConfigDef and HTMLPurifier
 
-// hack
-if (defined('HTMLPURIFIER_CUSTOM_SCHEMA')) {
-    // included from somewhere else
-    $var = HTMLPURIFIER_CUSTOM_SCHEMA;
-    $schema = $$var;
-    chdir(dirname(__FILE__));
-} else {
-    $schema = HTMLPurifier_ConfigSchema::instance();
-}
-$purifier = new HTMLPurifier();
-
-
-// ---------------------------------------------------------------------------
-// Generate types.xml, a document describing the constraint "type"
-
-$types_serializer = new ConfigDoc_XMLSerializer_Types();
-$types_document = $types_serializer->serialize($schema);
-$types_document->save('types.xml');
-
-
-// ---------------------------------------------------------------------------
-// Generate configdoc.xml, a document documenting configuration directives
-
-$schema_serializer = new ConfigDoc_XMLSerializer_ConfigSchema();
-$dom_document = $schema_serializer->serialize($schema);
-$dom_document->save('configdoc.xml');
-
+$schema = HTMLPurifier_ConfigSchema::instance();
 
 // ---------------------------------------------------------------------------
 // Generate final output using XSLT
 
 // determine stylesheet name
-$xsl_stylesheet_name = 'plain';
-$xsl_stylesheet = "styles/$xsl_stylesheet_name.xsl";
+$xsl_stylesheet_name = 'plain'; // use $_GET in the future
+$configdoc = new ConfigDoc();
+$html_output = $configdoc->generate($schema, $xsl_stylesheet_name);
 
-// transform
-$xslt_processor = new ConfigDoc_HTMLXSLTProcessor();
-$xslt_processor->importStylesheet($xsl_stylesheet);
-$html_output = $xslt_processor->transformToHTML($dom_document);
-
-// hack
-if (!defined('HTMLPURIFIER_CUSTOM_SCHEMA')) {
-    // write it to a file (todo: parse into seperate pages)
-    file_put_contents("$xsl_stylesheet_name.html", $html_output);
-} elseif (defined('HTMLPURIFIER_SCRIPT_LOCATION')) {
-    $html_output = str_replace('styles/plain.css', HTMLPURIFIER_SCRIPT_LOCATION . 'styles/plain.css', $html_output);
-}
+file_put_contents("$xsl_stylesheet_name.html", $html_output);
 
 // ---------------------------------------------------------------------------
 // Output for instant feedback

configdoc/library/ConfigDoc.php

@@ -7,7 +7,33 @@ require_once 'ConfigDoc/XMLSerializer/ConfigSchema.php';
 class ConfigDoc
 {
     
-    // useless...
+    function generate($schema, $xsl_stylesheet_name = 'plain', $parameters = array()) {
+        // generate types document, describing type constraints
+        $types_serializer = new ConfigDoc_XMLSerializer_Types();
+        $types_document = $types_serializer->serialize($schema);
+        $types_document->save('types.xml');
+        
+        // generate configdoc.xml, documents configuration directives
+        $schema_serializer = new ConfigDoc_XMLSerializer_ConfigSchema();
+        $schema_document = $schema_serializer->serialize($schema);
+        $schema_document->save('configdoc.xml');
+        
+        // setup transformation
+        $xsl_stylesheet = dirname(__FILE__) . "/../styles/$xsl_stylesheet_name.xsl";
+        $xslt_processor = new ConfigDoc_HTMLXSLTProcessor();
+        $xslt_processor->setParameters($parameters);
+        $xslt_processor->importStylesheet($xsl_stylesheet);
+        
+        return $xslt_processor->transformToHTML($schema_document);
+    }
+    
+    /**
+     * Remove any generated files
+     */
+    function cleanup() {
+        unlink('types.xml');
+        unlink('configdoc.xml');
+    }
     
 }
 

configdoc/library/ConfigDoc/HTMLXSLTProcessor.php

@@ -51,6 +51,12 @@ class ConfigDoc_HTMLXSLTProcessor
         return $out;
     }
     
+    public function setParameters($options) {
+        foreach ($options as $name => $value) {
+            $this->xsltProcessor->setParameter('', $name, $value);
+        }
+    }
+    
 }
 
 ?>

configdoc/library/ConfigDoc/XMLSerializer.php

@@ -9,8 +9,7 @@ class ConfigDoc_XMLSerializer
 {
     
     protected function appendHTMLDiv($document, $node, $html) {
-        // oh no, it's a global!
-        global $purifier;
+        $purifier = HTMLPurifier::getInstance();
         $html = $purifier->purify($html);
         $dom_html = $document->createDocumentFragment();
         $dom_html->appendXML($html);

configdoc/library/ConfigDoc/XMLSerializer/ConfigSchema.php

@@ -95,8 +95,8 @@ class ConfigDoc_XMLSerializer_ConfigSchema extends ConfigDoc_XMLSerializer
                 foreach ($info->descriptions as $file => $file_descriptions) {
                     foreach ($file_descriptions as $line => $description) {
                         $dom_description = $dom_document->createElement('description');
-                        // hack
-                        if (!defined('HTMLPURIFIER_CUSTOM_SCHEMA')) {
+                        // refuse to write $file if it's a full path
+                        if (str_replace('\\', '/', realpath($file)) != $file) {
                             $dom_description->setAttribute('file', $file);
                             $dom_description->setAttribute('line', $line);
                         }

configdoc/styles/plain.xsl

@@ -12,19 +12,21 @@
         indent = "no"
         media-type = "text/html"
     />
+    <xsl:param name="css" select="'styles/plain.css'"/>
+    <xsl:param name="title" select="'Configuration Documentation'"/>
     
     <xsl:variable name="typeLookup" select="document('../types.xml')" />
     
     <xsl:template match="/">
         <html lang="en" xml:lang="en">
             <head>
-                <title>Configuration Documentation - <xsl:value-of select="/configdoc/title" /></title>
+                <title><xsl:value-of select="$title" /> - <xsl:value-of select="/configdoc/title" /></title>
                 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
-                <link rel="stylesheet" type="text/css" href="styles/plain.css" />
+                <link rel="stylesheet" type="text/css" href="{$css}" />
             </head>
             <body>
                 <div id="library"><xsl:value-of select="/configdoc/title" /></div>
-                <h1>Configuration Documentation</h1>
+                <h1><xsl:value-of select="$title" /></h1>
                 <h2>Table of Contents</h2>
                 <ul id="toc">
                     <xsl:apply-templates mode="toc" />