Implement %HTML.AllowedComments and %HTML.AllowedCommentsRegexp
[htmlpurifier.git] / TODO
blob820159c3802c656f40e90f2c0cabf1b38fd09391
2 TODO List
4 = KEY ====================
5     # Flagship
6     - Regular
7     ? Maybe I'll Do It
8 ==========================
10 If no interest is expressed for a feature that may require 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!
14 Things to do as soon as possible:
16  - Think about allowing explicit order of operations hooks for transforms
17  - Inputs don't do the right thing with submit
18  - Fix "<.<" bug (trailing < is removed if not EOD)
19  - Build in better internal state dumps and debugging tools for remote
20    debugging
21  - Allowed/Allowed* have strange interactions when both set
22  - Transform lone embeds into object tags
23  - Deprecated config options that emit warnings when you set them (with'
24    a way of muting the warning if you really want to)
25  - Make HTML.Trusted work with Output.FlashCompat
27 FUTURE VERSIONS
28 ---------------
30 4.4 release [OMG CONFIG PONIES]
31  ! Fix Printer. It's from the old days when we didn't have decent XML classes
32  ! Factor demo.php into a set of Printer classes, and then create a stub
33    file for users here (inside the actual HTML Purifier library)
34  - Fix error handling with form construction
35  - Do encoding validation in Printers, or at least, where user data comes in
36  - Config: Add examples to everything (make built-in which also automatically
37    gives output)
38  - Add "register" field to config schemas to eliminate dependence on
39    naming conventions (try to remember why we ultimately decided on tihs)
41 5.0 release [HTML 5]
42  # Swap out code to use html5lib tokenizer and tree-builder
43  ! Allow turning off of FixNesting and required attribute insertion
45 5.1 release [It's All About Trust] (floating)
46  # Implement untrusted, dangerous elements/attributes
47  # Implement IDREF support (harder than it seems, since you cannot have
48    IDREFs to non-existent IDs)
49      - Implement <area> (client and server side image maps are blocking
50        on IDREF support)
51  # Frameset XHTML 1.0 and HTML 4.01 doctypes
52  - Figure out how to simultaneously set %CSS.Trusted and %HTML.Trusted (?)
54 5.2 release [Error'ed]
55  # Error logging for filtering/cleanup procedures
56  # Additional support for poorly written HTML
57     - Microsoft Word HTML cleaning (i.e. MsoNormal, but research essential!)
58     - Friendly strict handling of <address> (block -> <br>)
59  - XSS-attempt detection--certain errors are flagged XSS-like
60  - Append something to duplicate IDs so they're still usable (impl. note: the
61    dupe detector would also need to detect the suffix as well)
63 6.0 release [Beyond HTML]
64  # Legit token based CSS parsing (will require revamping almost every
65    AttrDef class). Probably will use CSSTidy
66  # More control over allowed CSS properties using a modularization
67  # IRI support (this includes IDN)
68  - Standardize token armor for all areas of processing
70 7.0 release [To XML and Beyond]
71  - Extended HTML capabilities based on namespacing and tag transforms (COMPLEX)
72     - Hooks for adding custom processors to custom namespaced tags and
73       attributes, offer default implementation
74     - Lots of documentation and samples
76 Ongoing
77  - More refactoring to take advantage of PHP5's facilities
78  - Refactor unit tests into lots of test methods
79  - Plugins for major CMSes (COMPLEX)
80     - phpBB
81     - Also, a FAQ for extension writers with HTML Purifier
83 AutoFormat
84  - Smileys
85  - Syntax highlighting (with GeSHi) with <pre> and possibly <?php
86  - Look at http://drupal.org/project/Modules/category/63 for ideas
88 Neat feature related
89  ! Support exporting configuration, so users can easily tweak settings
90    in the demo, and then copy-paste into their own setup
91  - Advanced URI filtering schemes (see docs/proposal-new-directives.txt)
92  - Allow scoped="scoped" attribute in <style> tags; may be troublesome
93    because regular CSS has no way of uniquely identifying nodes, so we'd
94    have to generate IDs
95  - Explain how to use HTML Purifier in non-PHP languages / create
96    a simple command line stub (or complicated?)
97  - Fixes for Firefox's inability to handle COL alignment props (Bug 915)
98  - Automatically add non-breaking spaces to empty table cells when
99    empty-cells:show is applied to have compatibility with Internet Explorer
100  - Table of Contents generation (XHTML Compiler might be reusable). May also
101    be out-of-band information.
102  - Full set of color keywords. Also, a way to add onto them without
103    finalizing the configuration object.
104  - Write a var_export and memcached DefinitionCache - Denis
105  - Built-in support for target="_blank" on all external links
106  - Convert RTL/LTR override characters to <bdo> tags, or vice versa on demand.
107    Also, enable disabling of directionality
108  ? Externalize inline CSS to promote clean HTML, proposed by Sander Tekelenburg
109  ? Remove redundant tags, ex. <u><u>Underlined</u></u>. Implementation notes:
110     1. Analyzing which tags to remove duplicants
111     2. Ensure attributes are merged into the parent tag
112     3. Extend the tag exclusion system to specify whether or not the
113     contents should be dropped or not (currently, there's code that could do
114     something like this if it didn't drop the inner text too.)
115  ? Make AutoParagraph also support paragraph-izing double <br> tags, and not
116    just double newlines.  This is kind of tough to do in the current framework,
117    though, and might be reasonably approximated by search replacing double <br>s
118    with newlines before running it through HTML Purifier.
120 Maintenance related (slightly boring)
121  # CHMOD install script for PEAR installs
122  ! Factor out command line parser into its own class, and unit test it
123  - Reduce size of internal data-structures (esp. HTMLDefinition)
124  - Allow merging configurations.  Thus,
125         a -> b -> default
126         c -> d -> default
127    becomes
128         a -> b -> c -> d -> default
129    Maybe allow more fine-grained tuning of this behavior. Alternatively,
130    encourage people to use short plist depths before building them up.
131  - Time PHPT tests
133 ChildDef related (very boring)
134  - Abstract ChildDef_BlockQuote to work with all elements that only
135    allow blocks in them, required or optional
136  - Implement lenient <ruby> child validation
138 Wontfix
139  - Non-lossy smart alternate character encoding transformations (unless
140    patch provided)
141  - Pretty-printing HTML: users can use Tidy on the output on entire page
142  - Native content compression, whitespace stripping: use gzip if this is
143    really important
145     vim: et sw=4 sts=4