TODO

   1
   2 TODO List
   3
   4 = KEY ====================
   5     # Flagship
   6     - Regular
   7     ? Maybe I'll Do It
   8 ==========================
   9
  10 If no interest is expressed for a feature that may required a considerable
  11 amount of effort to implement, it may get endlessly delayed. Do not be
  12 afraid to cast your vote for the next feature to be implemented!
  13
  14
  15 UPCOMING RELEASE
  16 ----------------
  17
  18 IMPORTANT
  19  - Test HTMLPurifier.auto.php, HTMLPurifier.includes.php, and combinations
  20    of the two. This is related to standalone in tests/index.php. This should use
  21    semi-automated smoketests using PHPT style files (probably should be part
  22    of SimpleTest framework). These tests can be further extended to work for
  23    many of our other smoketests.
  24  - Release candidate, because of the major changes
  25  - Move utility classes for ConfigSchema into HTML Purifier itself: they're
  26    that important
  27
  28 DOCUMENTATION
  29  - Document new methods of including the library (probably can go in INSTALL)
  30  - Document new ConfigSchema setup and format; dev-includes.txt is a base
  31    but we need it in HTML
  32  - Update French translation of README
  33  - Document which scripts need to be called when a change is made
  34  - Document that standalone doesn't load autoload by default, so you need
  35    to include HTMLPurifier.autoload.php after it
  36
  37 IMPORTANT FEATURES
  38  - Get everything into configuration objects (filters, I'm looking at you)
  39  - Factor generate-schema-cache.php into a class, so that the maintenance script
  40    is as small as possible
  41  - Factor out command line parser into its own class
  42  - Optimize ConfigSchema by only caching things necessary for runtime
  43
  44 CONFIGDOC
  45  - Properly integrate new ConfigSchema system into configdoc (Configdoc
  46    should directly read the configuration files, or at the very least should
  47    not use static functions)
  48  - Reduce code duplication between Serializer and Adapter/ReverseAdapter
  49    (we probably want to use ReverseAdapter for the long haul)
  50  - Have configdoc use version and deprecated information (hide deprecated
  51    info, for example)
  52  - Implement file sniffing for configdoc, so we can easily figure out
  53    which files use what configuration
  54
  55 IF IT AIN'T BROKE...
  56  - Rename merge-library.php script
  57  - Create "super" script which performs all regeneration actions
  58  - Remove all includes from unit tests, and remove blanks/ folder and generation
  59  - Simplify merge library script by removing recursion? (or other things)
  60  - Update unit tests for ConfigSchema
  61  - Perhaps replace types with integer identifiers in ConfigSchema? (would be
  62    smaller, but not by much).
  63
  64 NICE FEATURES
  65  - Factor demo.php into a set of Printer classes, and then create a stub
  66    file for users here (inside the actual HTML Purifier library)
  67  - Support exporting configuration, so users can easily tweak settings
  68    in the demo, and then copy-paste into their own setup
  69
  70
  71 FUTURE VERSIONS
  72 ---------------
  73
  74 3.2 release [Error'ed]
  75  # Error logging for filtering/cleanup procedures
  76  - XSS-attempt detection
  77
  78 3.3 release [Do What I Mean, Not What I Say]
  79  # Additional support for poorly written HTML
  80     - Microsoft Word HTML cleaning (i.e. MsoNormal, but research essential!)
  81     - Friendly strict handling of <address> (block -> <br>)
  82  - Remove redundant tags, ex. <u><u>Underlined</u></u>. Implementation notes:
  83     1. Analyzing which tags to remove duplicants
  84     2. Ensure attributes are merged into the parent tag
  85     3. Extend the tag exclusion system to specify whether or not the
  86     contents should be dropped or not (currently, there's code that could do
  87     something like this if it didn't drop the inner text too.)
  88  - Remove <span> tags that don't do anything (no attributes)
  89  - Remove empty inline tags<i></i>
  90  - Append something to duplicate IDs so they're still usable (impl. note: the
  91    dupe detector would also need to detect the suffix as well)
  92  - Externalize inline CSS to promote clean HTML
  93
  94 3.4 release [It's All About Trust] (floating)
  95  # Implement untrusted, dangerous elements/attributes
  96  # Implement IDREF support (harder than it seems, since you cannot have
  97    IDREFs to non-existent IDs)
  98  # Frameset XHTML 1.0 and HTML 4.01 doctypes
  99
 100 4.0 release [Beyond HTML]
 101  # Legit token based CSS parsing (will require revamping almost every
 102    AttrDef class). Probably will use CSSTidy class
 103  # More control over allowed CSS properties (maybe modularize it in the
 104    same fashion!)
 105  # HTML 5 support
 106  - Standardize token armor for all areas of processing
 107  - Convert RTL/LTR override characters to <bdo> tags, or vice versa on demand.
 108    Also, enable disabling of directionality
 109  - Table of Contents generation (XHTML Compiler might be reusable)
 110
 111 5.0 release [To XML and Beyond]
 112  - Extended HTML capabilities based on namespacing and tag transforms (COMPLEX)
 113     - Hooks for adding custom processors to custom namespaced tags and
 114       attributes, offer default implementation
 115     - Lots of documentation and samples
 116
 117 Ongoing
 118  - More refactoring to take advantage of PHP5's facilities
 119  - Lots of profiling, make it faster!
 120  - Plugins for major CMSes (COMPLEX)
 121     - phpBB
 122     - more! (look for ones that use WYSIWYGs)
 123  - Complete basic smoketests
 124
 125 AutoFormat
 126  - Smileys
 127  - Syntax highlighting with <pre> and possibly <?php
 128  - Look at http://drupal.org/project/Modules/category/63 for ideas
 129
 130 Unknown release (on a scratch-an-itch basis)
 131  # CHMOD install script for PEAR installs
 132  ? Have 'lang' attribute be checked against official lists, achieved by
 133    encoding all characters that have string entity equivalents
 134  - Abstract ChildDef_BlockQuote to work with all elements that only
 135    allow blocks in them, required or optional
 136  - Reorganize Unit Tests
 137  - Advanced URI filtering schemes (see docs/proposal-new-directives.txt)
 138  - Implement lenient <ruby> child validation
 139  - Explain how to use HTML Purifier in non-PHP languages / create
 140    a simple command line stub (or complicated?)
 141  - Fixes for Firefox's inability to handle COL alignment props (Bug 915)
 142  - Automatically add non-breaking spaces to empty table cells when
 143    empty-cells:show is applied to have compatibility with Internet Explorer
 144  - Distinguish between default settings and explicitly set settings, so
 145    configurations can be merged
 146  - Nested configuration namespaces
 147  - Allow scoped="scoped" attribute in <style> tags; may be troublesome
 148    because regular CSS has no way of uniquely identifying nodes, so we'd
 149    have to generate IDs
 150
 151 Requested
 152
 153 Wontfix
 154  - Non-lossy smart alternate character encoding transformations (unless
 155    patch provided)
 156  - Pretty-printing HTML: users can use Tidy on the output on entire page
 157  - Native content compression, whitespace stripping (don't rely on Tidy, make
 158    sure we don't remove from <pre> or related tags): use gzip if this is
 159    really important