@@ -267,6 +267,41 @@ Test.Example
If you ever make changes to your configuration directives, you
will need to run this script again.
+ Adding in-house schema definitions
+
+
+ Placing stuff directly in HTML Purifier's source tree is generally not a
+ good idea, so HTML Purifier 4.0.0+ has some facilities in place to make your
+ life easier.
+
+
+
+ The first is to pass an extra parameter to maintenance/generate-schema-cache.php
+ with the location of your directory (relative or absolute path will do). For example,
+ if I'm storing my custom definitions in /var/htmlpurifier/myschema, run:
+ php maintenance/generate-schema-cache.php /var/htmlpurifier/myschema.
+
+
+
+ Alternatively, you can create a small loader PHP file in the HTML Purifier base
+ directory named config-schema.php (this is the same directory
+ you would place a test-settings.php file). In this file, add
+ the following line for each directory you want to load:
+
+
+$builder->buildDir($interchange, '/var/htmlpurifier/myschema');
+
+ You can even load a single file using:
+
+$builder->buildFile($interchange, '/var/htmlpurifier/myschema/MyApp.Directive.txt');
+
+ Storing custom definitions that you don't plan on sending back upstream in
+ a separate directory is definitely a good idea! Additionally, picking
+ a good namespace can go a long way to saving you grief if you want to use
+ someone else's change, but they picked the same name, or if HTML Purifier
+ decides to add support for a configuration directive that has the same name.
+
+
Errors
diff --git a/docs/enduser-customize.html b/docs/enduser-customize.html
index 3562b4bb..6af0e9e7 100644
--- a/docs/enduser-customize.html
+++ b/docs/enduser-customize.html
@@ -18,12 +18,11 @@
- You may have heard of the Advanced API.
- If you're interested in reading dry prose and boring functional
- specifications, feel free to click that link to get a no-nonsense overview
- on the Advanced API. For the rest of us, there's this tutorial. By the time
- you're finished reading this, you should have a pretty good idea on
- how to implement custom tags and attributes that HTML Purifier may not have.
+ HTML Purifier has this quirk where if you try to allow certain elements or
+ attributes, HTML Purifier will tell you that it's not supported, and that
+ you should go to the forums to find out how to implement it. Well, this
+ document is how to implement elements and attributes which HTML Purifier
+ doesn't support out of the box.
Is it necessary?
diff --git a/library/HTMLPurifier/Config.php b/library/HTMLPurifier/Config.php
index 5f709e68..6927f990 100644
--- a/library/HTMLPurifier/Config.php
+++ b/library/HTMLPurifier/Config.php
@@ -216,6 +216,7 @@ class HTMLPurifier_Config
/**
* Retrieves all directives, organized by namespace
+ * @warning This is a pretty inefficient function, avoid if you can
*/
public function getAll() {
if (!$this->finalized) $this->autoFinalize();
diff --git a/library/HTMLPurifier/ConfigSchema/InterchangeBuilder.php b/library/HTMLPurifier/ConfigSchema/InterchangeBuilder.php
index a8db5c08..785b72ce 100644
--- a/library/HTMLPurifier/ConfigSchema/InterchangeBuilder.php
+++ b/library/HTMLPurifier/ConfigSchema/InterchangeBuilder.php
@@ -15,10 +15,15 @@ class HTMLPurifier_ConfigSchema_InterchangeBuilder
public static function buildFromDirectory($dir = null) {
$builder = new HTMLPurifier_ConfigSchema_InterchangeBuilder();
$interchange = new HTMLPurifier_ConfigSchema_Interchange();
+ return $builder->buildDir($interchange, $dir);
+ }
- if (!$dir) $dir = HTMLPURIFIER_PREFIX . '/HTMLPurifier/ConfigSchema/schema/';
- $info = parse_ini_file($dir . 'info.ini');
- $interchange->name = $info['name'];
+ public function buildDir($interchange, $dir = null) {
+ if (!$dir) $dir = HTMLPURIFIER_PREFIX . '/HTMLPurifier/ConfigSchema/schema';
+ if (file_exists($dir . '/info.ini')) {
+ $info = parse_ini_file($dir . '/info.ini');
+ $interchange->name = $info['name'];
+ }
$files = array();
$dh = opendir($dir);
@@ -32,7 +37,7 @@ class HTMLPurifier_ConfigSchema_InterchangeBuilder
sort($files);
foreach ($files as $file) {
- $builder->buildFile($interchange, $dir . $file);
+ $this->buildFile($interchange, $dir . '/' . $file);
}
return $interchange;
diff --git a/maintenance/common.php b/maintenance/common.php
index 82d3d00f..888c7daf 100644
--- a/maintenance/common.php
+++ b/maintenance/common.php
@@ -17,6 +17,6 @@ function postfix_is($comp, $subject) {
}
// Load useful stuff like FSTools
-require_once '../extras/HTMLPurifierExtras.auto.php';
+require_once dirname(__FILE__) . '/../extras/HTMLPurifierExtras.auto.php';
// vim: et sw=4 sts=4
diff --git a/maintenance/generate-schema-cache.php b/maintenance/generate-schema-cache.php
index e7a59c41..339ff12d 100644
--- a/maintenance/generate-schema-cache.php
+++ b/maintenance/generate-schema-cache.php
@@ -1,9 +1,8 @@
#!/usr/bin/php
buildDir($interchange);
+
+$loader = dirname(__FILE__) . '/../config-schema.php';
+if (file_exists($loader)) include $loader;
+foreach ($_SERVER['argv'] as $i => $dir) {
+ if ($i === 0) continue;
+ $builder->buildDir($interchange, realpath($dir));
+}
-$interchange = HTMLPurifier_ConfigSchema_InterchangeBuilder::buildFromDirectory();
$interchange->validate();
$schema_builder = new HTMLPurifier_ConfigSchema_Builder_ConfigSchema();