mirrors/htmlpurifier
0
0
Fork 0
mirror of https://github.com/ezyang/htmlpurifier.git synced 2024-09-18 18:25:18 +00:00
Code Releases Activity

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.

Browse Source 
git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1105 48356398-32a2-884e-a903-53898d9a118a
This commit is contained in:
Edward Z. Yang 2007-05-28 03:33:12 +00:00
parent aaf4839c34
commit e06929c218
9 changed files with 112 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
configdoc/generate.php
View File

@ -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

28
configdoc/library/ConfigDoc.php
View File

@ -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');
}
}

6
configdoc/library/ConfigDoc/HTMLXSLTProcessor.php
View File

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

3
configdoc/library/ConfigDoc/XMLSerializer.php
View File

@ -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);

4
configdoc/library/ConfigDoc/XMLSerializer/ConfigSchema.php
View File

@ -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);
}

8
configdoc/styles/plain.xsl
View File

@ -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" />

17
library/HTMLPurifier.php
View File

@ -164,6 +164,23 @@ class HTMLPurifier
return $array_of_html;
}
/**
* Singleton for enforcing just one HTML Purifier in your system
*/
function &getInstance($prototype = null) {
static $htmlpurifier;
if (!$htmlpurifier || $prototype) {
if (is_a($prototype, 'HTMLPurifier')) {
$htmlpurifier = $prototype;
} elseif ($prototype) {
$htmlpurifier = new HTMLPurifier(HTMLPurifier_Config::create($prototype));
} else {
$htmlpurifier = new HTMLPurifier();
}
}
return $htmlpurifier;
}
}

17
library/HTMLPurifier/Config.php
View File

@ -297,6 +297,23 @@ class HTMLPurifier_Config
}
}
/**
* Loads configuration values from $_GET/$_POST that were posted
* via ConfigForm
* @static
*/
function loadArrayFromForm($array) {
$mq = get_magic_quotes_gpc();
foreach ($array as $key => $value) {
if (!strncmp($key, 'Null_', 5) && !empty($value)) {
unset($array[substr($key, 5)]);
unset($array[$key]);
}
if ($mq) $array[$key] = stripslashes($value);
}
return @HTMLPurifier_Config::create($array);
}
/**
* Loads configuration values from an ini file
* @param $filename Name of ini file

47
smoketests/configForm.php
View File

@ -3,12 +3,37 @@
require_once 'common.php';
if (isset($_GET['doc'])) {
if (
file_exists('testSchema.html') &&
filemtime('testSchema.php') < filemtime('testSchema.html') &&
!isset($_GET['purge'])
) {
echo file_get_contents('testSchema.html');
exit;
}
if (version_compare('5', PHP_VERSION, '>')) exit('Requires PHP 5 or higher.');
// setup schema for parsing
require_once 'testSchema.php';
$new_schema = $custom_schema;
HTMLPurifier_ConfigSchema::instance($old);
define('HTMLPURIFIER_CUSTOM_SCHEMA', 'new_schema');
define('HTMLPURIFIER_SCRIPT_LOCATION', '../configdoc/');
require_once '../configdoc/generate.php';
$new_schema = $custom_schema; // dereference the reference
HTMLPurifier_ConfigSchema::instance($old); // restore old version
// setup ConfigDoc environment
require_once '../configdoc/library/ConfigDoc.auto.php';
// perform the ConfigDoc generation
$configdoc = new ConfigDoc();
$html = $configdoc->generate($new_schema, 'plain', array(
'css' => '../configdoc/styles/plain.css',
'title' => 'Sample Configuration Documentation'
));
$configdoc->cleanup();
file_put_contents('testSchema.html', $html);
echo $html;
exit;
}
@ -37,17 +62,7 @@ require_once 'HTMLPurifier/Printer/ConfigForm.php';
require_once 'testSchema.php';
// cleanup ( this should be rolled into Config )
$get = isset($_GET) ? $_GET : array();
$mq = get_magic_quotes_gpc();
foreach ($_GET as $key => $value) {
if (!strncmp($key, 'Null_', 5) && !empty($value)) {
unset($get[substr($key, 5)]);
unset($get[$key]);
}
if ($mq) $get[$key] = stripslashes($value);
}
$config = @HTMLPurifier_Config::create($get);
$config = HTMLPurifier_Config::loadArrayFromForm($_GET);
$printer = new HTMLPurifier_Printer_ConfigForm('?doc');
echo $printer->render($config);