From bf6de96bd008df6df7a6b7eb095a8282c0163f09 Mon Sep 17 00:00:00 2001
From: "Edward Z. Yang" <edwardzyang@thewritingpot.com>
Date: Mon, 11 Feb 2008 00:27:35 +0000
Subject: [PATCH] - More TODO items - Update comments

git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1549 48356398-32a2-884e-a903-53898d9a118a
---
 TODO                                           | 18 +++++++++++++++---
 .../HTMLPurifier/AttrDef/CSS/FontFamily.php    |  3 +--
 library/HTMLPurifier/AttrDef/URI.php           |  4 ----
 library/HTMLPurifier/Bootstrap.php             | 17 ++++++++++++++++-
 library/HTMLPurifier/ChildDef.php              |  5 -----
 library/HTMLPurifier/Config.php                | 16 ----------------
 library/HTMLPurifier/DoctypeRegistry.php       |  1 -
 library/HTMLPurifier/Generator.php             |  1 -
 library/HTMLPurifier/HTMLDefinition.php        |  6 +++---
 library/HTMLPurifier/URIDefinition.php         |  2 --
 10 files changed, 35 insertions(+), 38 deletions(-)

diff --git a/TODO b/TODO
index b11bdb49..668f8cba 100644
--- a/TODO
+++ b/TODO
@@ -40,12 +40,23 @@ IMPORTANT
  - Document that standalone doesn't load autoload by default, so you need
    to include HTMLPurifier.autoload.php after it
  - Simplify merge library script by removing recursion? (or other things)
+ - Optimize ConfigSchema by only caching things necessary for runtime
+ - Perhaps replace types with integer identifiers in ConfigSchema?
+ - Properly integrate new ConfigSchema system into configdoc (Configdoc
+   should directly read the configuration files)
+ - Reduce code duplication between Serializer and Adapter/ReverseAdapter
+   (we probably want to use ReverseAdapter for the long haul)
+ - Have configdoc use version and deprecated information (hide deprecated
+   info, for example)
+ - Update unit tests for ConfigSchema
+ - Implement file sniffing for configdoc, so we can easily figure out
+   which files use what configuration
 
-3.1 release [Error'ed]
+3.2 release [Error'ed]
  # Error logging for filtering/cleanup procedures
  - XSS-attempt detection
 
-3.2 release [Do What I Mean, Not What I Say]
+3.3 release [Do What I Mean, Not What I Say]
  # Additional support for poorly written HTML
     - Microsoft Word HTML cleaning (i.e. MsoNormal, but research essential!)
     - Friendly strict handling of <address> (block -> <br>)
@@ -61,7 +72,7 @@ IMPORTANT
    dupe detector would also need to detect the suffix as well)
  - Externalize inline CSS to promote clean HTML
 
-3.3 release [It's All About Trust] (floating)
+3.4 release [It's All About Trust] (floating)
  # Implement untrusted, dangerous elements/attributes
  # Implement IDREF support (harder than it seems, since you cannot have
    IDREFs to non-existent IDs)
@@ -72,6 +83,7 @@ IMPORTANT
    AttrDef class). Probably will use CSSTidy class
  # More control over allowed CSS properties (maybe modularize it in the
    same fashion!)
+ # HTML 5 support
  - Standardize token armor for all areas of processing
  - Convert RTL/LTR override characters to <bdo> tags, or vice versa on demand.
    Also, enable disabling of directionality
diff --git a/library/HTMLPurifier/AttrDef/CSS/FontFamily.php b/library/HTMLPurifier/AttrDef/CSS/FontFamily.php
index a09fd428..51f83ac5 100644
--- a/library/HTMLPurifier/AttrDef/CSS/FontFamily.php
+++ b/library/HTMLPurifier/AttrDef/CSS/FontFamily.php
@@ -1,9 +1,8 @@
 <?php
 
-// whitelisting allowed fonts would be nice
-
 /**
  * Validates a font family list according to CSS spec
+ * @todo whitelisting allowed fonts would be nice
  */
 class HTMLPurifier_AttrDef_CSS_FontFamily extends HTMLPurifier_AttrDef
 {
diff --git a/library/HTMLPurifier/AttrDef/URI.php b/library/HTMLPurifier/AttrDef/URI.php
index 0cf5db82..13a30a6d 100644
--- a/library/HTMLPurifier/AttrDef/URI.php
+++ b/library/HTMLPurifier/AttrDef/URI.php
@@ -1,9 +1,5 @@
 <?php
 
-// special case filtering directives 
-
-// disabling directives
-
 /**
  * Validates a URI as defined by RFC 3986.
  * @note Scheme-specific mechanics deferred to HTMLPurifier_URIScheme
diff --git a/library/HTMLPurifier/Bootstrap.php b/library/HTMLPurifier/Bootstrap.php
index cb8273f7..672ec5f4 100644
--- a/library/HTMLPurifier/Bootstrap.php
+++ b/library/HTMLPurifier/Bootstrap.php
@@ -1,10 +1,25 @@
 <?php
 
-// constants are slow, but we'll make one exception
+// constants are slow, so we use as few as possible
 if (!defined('HTMLPURIFIER_PREFIX')) {
     define('HTMLPURIFIER_PREFIX', realpath(dirname(__FILE__) . '/..'));
 }
 
+// accomodations for versions earlier than 5.0.2
+// borrowed from PHP_Compat, LGPL licensed, by Aidan Lister <aidan@php.net>
+if (!defined('PHP_EOL')) {
+    switch (strtoupper(substr(PHP_OS, 0, 3))) {
+        case 'WIN':
+            define('PHP_EOL', "\r\n");
+            break;
+        case 'DAR':
+            define('PHP_EOL', "\r");
+            break;
+        default:
+            define('PHP_EOL', "\n");
+    }
+}
+
 /**
  * Bootstrap class that contains meta-functionality for HTML Purifier such as
  * the autoload function.
diff --git a/library/HTMLPurifier/ChildDef.php b/library/HTMLPurifier/ChildDef.php
index c5b5a5e5..3c290fd3 100644
--- a/library/HTMLPurifier/ChildDef.php
+++ b/library/HTMLPurifier/ChildDef.php
@@ -1,10 +1,5 @@
 <?php
 
-// HTMLPurifier_ChildDef and inheritance have three types of output:
-// true = leave nodes as is
-// false = delete parent node and all children
-// array(...) = replace children nodes with these
-
 /**
  * Defines allowed child nodes and validates tokens against it.
  */
diff --git a/library/HTMLPurifier/Config.php b/library/HTMLPurifier/Config.php
index 8e70ab5c..0f89de63 100644
--- a/library/HTMLPurifier/Config.php
+++ b/library/HTMLPurifier/Config.php
@@ -1,21 +1,5 @@
 <?php
 
-// member variables
-// accomodations for versions earlier than 4.3.10 and 5.0.2
-// borrowed from PHP_Compat, LGPL licensed, by Aidan Lister <aidan@php.net>
-if (!defined('PHP_EOL')) {
-    switch (strtoupper(substr(PHP_OS, 0, 3))) {
-        case 'WIN':
-            define('PHP_EOL', "\r\n");
-            break;
-        case 'DAR':
-            define('PHP_EOL', "\r");
-            break;
-        default:
-            define('PHP_EOL', "\n");
-    }
-}
-
 /**
  * Configuration object that triggers customizable behavior.
  *
diff --git a/library/HTMLPurifier/DoctypeRegistry.php b/library/HTMLPurifier/DoctypeRegistry.php
index d83e9223..8a2b0b9d 100644
--- a/library/HTMLPurifier/DoctypeRegistry.php
+++ b/library/HTMLPurifier/DoctypeRegistry.php
@@ -1,6 +1,5 @@
 <?php
 
-// Legacy directives for doctype specification
 class HTMLPurifier_DoctypeRegistry
 {
     
diff --git a/library/HTMLPurifier/Generator.php b/library/HTMLPurifier/Generator.php
index c02e9963..77fbb412 100644
--- a/library/HTMLPurifier/Generator.php
+++ b/library/HTMLPurifier/Generator.php
@@ -1,6 +1,5 @@
 <?php
 
-// extension constraints could be factored into ConfigSchema
 /**
  * Generates HTML from tokens.
  * @todo Refactor interface so that configuration/context is determined
diff --git a/library/HTMLPurifier/HTMLDefinition.php b/library/HTMLPurifier/HTMLDefinition.php
index ab029c58..f8cf093f 100644
--- a/library/HTMLPurifier/HTMLDefinition.php
+++ b/library/HTMLPurifier/HTMLDefinition.php
@@ -1,8 +1,5 @@
 <?php
 
-// this definition and its modules MUST NOT define configuration directives
-// outside of the HTML or Attr namespaces
-
 /**
  * Definition of the purified HTML that describes allowed children,
  * attributes, and many other things.
@@ -22,6 +19,9 @@
  * 
  * @note This class is inspected by Printer_HTMLDefinition; please
  *       update that class if things here change.
+ *
+ * @warning Directives that change this object's structure must be in
+ *          the HTML or Attr namespace!
  */
 class HTMLPurifier_HTMLDefinition extends HTMLPurifier_Definition
 {
diff --git a/library/HTMLPurifier/URIDefinition.php b/library/HTMLPurifier/URIDefinition.php
index eabe4562..390d97ec 100644
--- a/library/HTMLPurifier/URIDefinition.php
+++ b/library/HTMLPurifier/URIDefinition.php
@@ -1,7 +1,5 @@
 <?php
 
-// informative URI directives
-
 class HTMLPurifier_URIDefinition extends HTMLPurifier_Definition
 {