Update TODO.
[htmlpurifier.git] / NEWS
blobc180fd178dc2417293623c409be9f4b69893e030
1 NEWS ( CHANGELOG and HISTORY )                                     HTMLPurifier
2 |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
4 = KEY ====================
5     # Breaks back-compat
6     ! Feature
7     - Bugfix
8       + Sub-comment
9     . Internal change
10 ==========================
12 3.1.1, unknown release date
13 ! More robust imagecrash protection with height/width CSS with %CSS.MaxImgLength,
14   and height/width HTML with %HTML.MaxImgLength.
15 ! %URI.SecureMunge for secure URI munging (as opposed to %URI.Munge). Be sure
16   to set %URI.SecureMungeSecretKey when using this directive. Thanks Chris
17   for sponsoring this feature.
18 ! Implemented post URI filtering. Set member variable $post to true to set
19   a URIFilter as such.
20 - Disable percent height/width attributes for img
21 - AttrValidator operations are now atomic; updates to attributes are not
22   manifest in token until end of operations. This prevents naughty internal
23   code from directly modifying CurrentToken when they're not supposed to.
24 - Percent encoding checks enabled for URI query and fragment
25 - Fix stray backslashes in font-family; CSS Unicode character escapes are
26   now properly resolved (although *only* in font-family).
27 - Improve parseCDATA algorithm to take into account newline normalization
28 - Account for browser confusion between Yen character and backslash in
29   Shift_JIS encoding. This fix generalizes to any other encoding which is not
30   a strict superset of printable ASCII.
31 - Fix missing configuration parameter in Generator calls. Thanks vs for the
32   partial patch.
33 - Improved adherence to Unicode by checking for non-character codepoints.
34   Thanks Geoffrey Sneddon for reporting. This may result in degraded
35   performance for extremely large inputs.
36 . Added HTMLPurifier_UnitConverter and HTMLPurifier_Length for convenient
37   handling of CSS-style lengths. HTMLPurifier_AttrDef_CSS_Length now uses
38   this class.
39 . API of HTMLPurifier_AttrDef_CSS_Length changed from __construct($disable_negative)
40   to __construct($min, $max). __construct(true) is equivalent to
41   __construct('0').
42 . Added HTMLPurifier_AttrDef_Switch class
43 . Rename HTMLPurifier_HTMLModule_Tidy->construct() to setup() and bubble method
44   up inheritance hierarchy to HTMLPurifier_HTMLModule. All HTMLModules
45   get this called with the configuration object.  All modules now
46   use this rather than __construct(), although legacy code using constructors
47   will still work--the new format, however, lets modules access the
48   configuration object for HTML namespace dependant tweaks.
49 . AttrDef_HTML_Pixels now takes a single construction parameter, pixels.
50 . ConfigSchema data-structure heavily optimized; on average it uses a third
51   the memory it did previously. The interface has changed accordingly,
52   consult changes to HTMLPurifier_Config for details.
53 . Variable parsing types now are magic integers instead of strings
54 . Added benchmark for ConfigSchema
55 . HTMLPurifier_Generator requires $config and $context parameters. If you 
56   don't know what they should be, use HTMLPurifier_Config::createDefault()
57   and new HTMLPurifier_Context().
58 . Printers now properly distinguish between output configuration, and 
59   target configuration. This is not applicable to scripts using
60   the Printers for HTML Purifier related tasks.
61 . HTML/CSS Printers must be primed with prepareGenerator($gen_config), otherwise
62   fatal errors will ensue.
63 . URIFilter->prepare can return false in order to abort loading of the filter
65 3.1.0, released 2008-05-18
66 # Unnecessary references to objects (vestiges of PHP4) removed from method
67   signatures.  The following methods do not need references when assigning from
68   them and will result in E_STRICT errors if you try:
69     + HTMLPurifier_Config->get*Definition() [* = HTML, CSS]
70     + HTMLPurifier_ConfigSchema::instance()
71     + HTMLPurifier_DefinitionCacheFactory::instance()
72     + HTMLPurifier_DefinitionCacheFactory->create()
73     + HTMLPurifier_DoctypeRegistry->register()
74     + HTMLPurifier_DoctypeRegistry->get()
75     + HTMLPurifier_HTMLModule->addElement()
76     + HTMLPurifier_HTMLModule->addBlankElement()
77     + HTMLPurifier_LanguageFactory::instance()
78 # Printer_ConfigForm's get*() functions were static-ified
79 # %HTML.ForbiddenAttributes requires attribute declarations to be in the
80   form of tag@attr, NOT tag.attr (which will throw an error and won't do
81   anything). This is for forwards compatibility with XML; you'd do best
82   to migrate an %HTML.AllowedAttributes directives to this syntax too.
83 ! Allow index to be false for config from form creation
84 ! Added HTMLPurifier::VERSION constant
85 ! Commas, not dashes, used for serializer IDs. This change is forwards-compatible
86   and allows for version numbers like "3.1.0-dev".
87 ! %HTML.Allowed deals gracefully with whitespace anywhere, anytime!
88 ! HTML Purifier's URI handling is a lot more robust, with much stricter
89   validation checks and better percent encoding handling.
90 ! Bootstrap autoloader deals more robustly with classes that don't exist,
91   preventing class_exists($class, true) from barfing.
92 - InterchangeBuilder now alphabetizes its lists
93 - Validation error in configdoc output fixed
94 - Iconv and other encoding errors muted even with custom error handlers that
95   do not honor error_reporting
96 - Add protection against imagecrash attack with CSS height/width
97 - HTMLPurifier::instance() created for consistency, is equivalent to getInstance()
98 - Fixed and revamped broken ConfigForm smoketest
99 - Bug with bool/null fields in Printer_ConfigForm fixed
100 - Bug with global forbidden attributes fixed
101 - Improved error messages for allowed and forbidden HTML elements and attributes
102 - Missing (or null) in configdoc documentation restored
103 - If DOM throws and exception during parsing with PH5P (occurs in newer versions
104   of DOM), HTML Purifier punts to DirectLex
105 - Fatal error with unserialization of ScriptRequired
106 - Created directories are now chmod'ed properly
107 - Fixed bug with fallback languages in LanguageFactory
108 - Standalone testing setup properly with autoload
109 . Out-of-date documentation revised
110 . UTF-8 encoding check optimization as suggested by Diego
111 . HTMLPurifier_Error removed in favor of exceptions
112 . More copy() function removed; should use clone instead
113 . More extensive unit tests for HTMLDefinition
114 . assertPurification moved to central harness
115 . HTMLPurifier_Generator accepts $config and $context parameters during
116   instantiation, not runtime
117 . Double-quotes outside of attribute values are now unescaped
119 3.1.0rc1, released 2008-04-22
120 # Autoload support added. Internal require_once's removed in favor of an
121   explicit require list or autoloading. To use HTML Purifier,
122   you must now either use HTMLPurifier.auto.php
123   or HTMLPurifier.includes.php; setting the include path and including
124   HTMLPurifier.php is insufficient--in such cases include HTMLPurifier.autoload.php
125   as well to register our autoload handler (or modify your autoload function
126   to check HTMLPurifier_Bootstrap::getPath($class)). You can also use
127   HTMLPurifier.safe-includes.php for a less performance friendly but more
128   user-friendly library load.
129 # HTMLPurifier_ConfigSchema static functions are officially deprecated. Schema
130   information is stored in the ConfigSchema directory, and the
131   maintenance/generate-schema-cache.php generates the schema.ser file, which
132   is now instantiated. Support for userland schema changes coming soon!
133 # HTMLPurifier_Config will now throw E_USER_NOTICE when you use a directive
134   alias; to get rid of these errors just modify your configuration to use
135   the new directive name.
136 # HTMLPurifier->addFilter is deprecated; built-in filters can now be
137   enabled using %Filter.$filter_name or by setting your own filters using
138   %Filter.Custom
139 # Directive-level safety properties superceded in favor of module-level
140   safety. Internal method HTMLModule->addElement() has changed, although 
141   the externally visible HTMLDefinition->addElement has *not* changed.
142 ! Extra utility classes for testing and non-library operations can
143   be found in extras/. Specifically, these are FSTools and ConfigDoc.
144   You may find a use for these in your own project, but right now they
145   are highly experimental and volatile.
146 ! Integration with PHPT allows for automated smoketests
147 ! Limited support for proprietary HTML elements, namely <marquee>, sponsored
148   by Chris. You can enable them with %HTML.Proprietary if your client
149   demands them.
150 ! Support for !important CSS cascade modifier. By default, this will be stripped
151   from CSS, but you can enable it using %CSS.AllowImportant
152 ! Support for display and visibility CSS properties added, set %CSS.AllowTricky
153   to true to use them.
154 ! HTML Purifier now has its own Exception hierarchy under HTMLPurifier_Exception.
155   Developer error (not enduser error) can cause these to be triggered.
156 ! Experimental kses() wrapper introduced with HTMLPurifier.kses.php
157 ! Finally %CSS.AllowedProperties for tweaking allowed CSS properties without
158   mucking around with HTMLPurifier_CSSDefinition
159 ! ConfigDoc output has been enhanced with version and deprecation info.
160 ! %HTML.ForbiddenAttributes and %HTML.ForbiddenElements implemented.
161 - Autoclose now operates iteratively, i.e. <span><span><div> now has
162   both span tags closed.
163 - Various HTMLPurifier_Config convenience functions now accept another parameter
164   $schema which defines what HTMLPurifier_ConfigSchema to use besides the
165   global default.
166 - Fix bug with trusted script handling in libxml versions later than 2.6.28.
167 - Fix bug in ExtractStyleBlocks with comments in style tags
168 - Fix bug in comment parsing for DirectLex
169 - Flush output now displayed when in command line mode for unit tester
170 - Fix bug with rgb(0, 1, 2) color syntax with spaces inside shorthand syntax
171 - HTMLPurifier_HTMLDefinition->addAttribute can now be called multiple times
172   on the same element without emitting errors.
173 - Fixed fatal error in PH5P lexer with invalid tag names
174 . Plugins now get their own changelogs according to project conventions.
175 . Convert tokens to use instanceof, reducing memory footprint and
176   improving comparison speed.
177 . Dry runs now supported in SimpleTest; testing facilities improved
178 . Bootstrap class added for handling autoloading functionality
179 . Implemented recursive glob at FSTools->globr
180 . ConfigSchema now has instance methods for all corresponding define* 
181   static methods.
182 . A couple of new historical maintenance scripts were added.
183 . HTMLPurifier/HTMLModule/Tidy/XHTMLAndHTML4.php split into two files
184 . tests/index.php can now be run from any directory.
185 . HTMLPurifier_Token subclasses split into seperate files
186 . HTMLPURIFIER_PREFIX now is defined in Bootstrap.php, NOT HTMLPurifier.php
187 . HTMLPURIFIER_PREFIX can now be defined outside of HTML Purifier
188 . New --php=php flag added, allows PHP executable to be specified (command
189   line only!)
190 . htmlpurifier_add_test() preferred method to translate test files in to
191   classes, because it handles PHPT files too.
192 . Debugger class is deprecated and will be removed soon.
193 . Command line argument parsing for testing scripts revamped, now --opt value
194   format is supported.
195 . Smoketests now cleanup after magic quotes
196 . Generator now can output comments (however, comments are still stripped
197   from HTML Purifier output)
198 . HTMLPurifier_ConfigSchema->validate() deprecated in favor of
199   HTMLPurifier_VarParser->parse()
200 . Integers auto-cast into float type by VarParser.
201 . HTMLPURIFIER_STRICT removed; no validation is performed on runtime, only 
202   during cache generation
203 . Reordered script calls in maintenance/flush.php
204 . Command line scripts now honor exit codes
205 . When --flush fails in unit testers, abort tests and print message
206 . Improved documentation in docs/dev-flush.html about the maintenance scripts
207 . copy() methods removed in favor of clone keyword
209 3.0.0, released 2008-01-06
210 # HTML Purifier is PHP 5 only! The 2.1.x branch will be maintained
211   until PHP 4 is completely deprecated, but no new features will be added
212   to it.
213   + Visibility declarations added
214   + Constructor methods renamed to __construct()
215   + PHP4 reference cruft removed (in progress)
216 ! CSS properties are now case-insensitive
217 ! DefinitionCacheFactory now can register new implementations
218 ! New HTMLPurifier_Filter_ExtractStyleBlocks for extracting <style> from
219   documents and cleaning their contents up. Requires the CSSTidy library
220   <http://csstidy.sourceforge.net/>. You can access the blocks with the
221   'StyleBlocks' Context variable ($purifier->context->get('StyleBlocks')).
222   The output CSS can also be "scoped" for a specific element, use:
223   %Filter.ExtractStyleBlocksScope
224 ! Experimental support for some proprietary CSS attributes allowed:
225   opacity (and all of the browser-specific equivalents) and scrollbar colors.
226   Enable by setting %CSS.Proprietary to true.
227 - Colors missing # but in hex form will be corrected
228 - CSS Number algorithm improved
229 - Unit testing and multi-testing now on steroids: command lines,
230   XML output, and other goodies now added.
231 . Unit tests for Injector improved
232 . New classes:
233   + HTMLPurifier_AttrDef_CSS_AlphaValue
234   + HTMLPurifier_AttrDef_CSS_Filter
235 . Multitest now has a file docblock
237 2.1.3, released 2007-11-05
238 ! tests/multitest.php allows you to test multiple versions by running
239   tests/index.php through multiple interpreters using `phpv` shell
240   script (you must provide this script!)
241 - Fixed poor include ordering for Email URI AttrDefs, causes fatal errors
242   on some systems.
243 - Injector algorithm further refined: off-by-one error regarding skip 
244   counts for dormant injectors fixed
245 - Corrective blockquote definition now enabled for HTML 4.01 Strict
246 - Fatal error when <img> tag (or any other element with required attributes)
247   has 'id' attribute fixed, thanks NykO18 for reporting
248 - Fix warning emitted when a non-supported URI scheme is passed to the
249   MakeAbsolute URIFilter, thanks NykO18 (again)
250 - Further refine AutoParagraph injector. Behavior inside of elements
251   allowing paragraph tags clarified: only inline content delimeted by
252   double newlines (not block elements) are paragraphed.
253 - Buggy treatment of end tags of elements that have required attributes
254   fixed (does not manifest on default tag-set)
255 - Spurious internal content reorganization error suppressed
256 - HTMLDefinition->addElement now returns a reference to the created
257   element object, as implied by the documentation
258 - Phorum mod's HTML Purifier help message expanded (unreleased elsewhere)
259 - Fix a theoretical class of infinite loops from DirectLex reported
260   by Nate Abele
261 - Work around unnecessary DOMElement type-cast in PH5P that caused errors
262   in PHP 5.1
263 - Work around PHP 4 SimpleTest lack-of-error complaining for one-time-only
264   HTMLDefinition errors, this may indicate problems with error-collecting
265   facilities in PHP 5
266 - Make ErrorCollectorEMock work in both PHP 4 and PHP 5
267 - Make PH5P work with PHP 5.0 by removing unnecessary array parameter typedef
268 . %Core.AcceptFullDocuments renamed to %Core.ConvertDocumentToFragment 
269   to better communicate its purpose
270 . Error unit tests can now specify the expectation of no errors. Future
271   iterations of the harness will be extremely strict about what errors
272   are allowed
273 . Extend Injector hooks to allow for more powerful injector routines
274 . HTMLDefinition->addBlankElement created, as according to the HTMLModule
275   method
276 . Doxygen configuration file updated, with minor improvements
277 . Test runner now checks for similarly named files in conf/ directory too.
278 . Minor cosmetic change to flush-definition-cache.php: trailing newline is
279   outputted
280 . Maintenance script for generating PH5P patch added, original PH5P source
281   file also added under version control
282 . Full unit test runner script title made more descriptive with PHP version
283 . Updated INSTALL file to state that 4.3.7 is the earliest version we
284   are actively testing
286 2.1.2, released 2007-09-03
287 ! Implemented Object module for trusted users
288 ! Implemented experimental HTML5 parsing mode using PH5P. To use, add
289   this to your code:
290         require_once 'HTMLPurifier/Lexer/PH5P.php';
291         $config->set('Core', 'LexerImpl', 'PH5P');
292   Note that this Lexer introduces some classes not in the HTMLPurifier
293   namespace.  Also, this is PHP5 only.
294 ! CSS property border-spacing implemented
295 - Fix non-visible parsing error in DirectLex with empty tags that have
296   slashes inside attribute values.
297 - Fix typo in CSS definition: border-collapse:seperate; was incorrectly
298   accepted as valid CSS. Usually non-visible, because this styling is the
299   default for tables in most browsers. Thanks Brett Zamir for pointing
300   this out.
301 - Fix validation errors in configuration form
302 - Hammer out a bunch of edge-case bugs in the standalone distribution
303 - Inclusion reflection removed from URISchemeRegistry; you must manually
304   include any new schema files you wish to use
305 - Numerous typo fixes in documentation thanks to Brett Zamir
306 . Unit test refactoring for one logical test per test function
307 . Config and context parameters in ComplexHarness deprecated: instead, edit
308   the $config and $context member variables
309 . HTML wrapper in DOMLex now takes DTD identifiers into account; doesn't
310   really make a difference, but is good for completeness sake
311 . merge-library.php script refactored for greater code reusability and
312   PHP4 compatibility
314 2.1.1, released 2007-08-04
315 - Fix show-stopper bug in %URI.MakeAbsolute functionality
316 - Fix PHP4 syntax error in standalone version
317 . Add prefix directory to include path for standalone, this prevents
318   other installations from clobbering the standalone's URI schemes
319 . Single test methods can be invoked by prefixing with __only
321 2.1.0, released 2007-08-02
322 # flush-htmldefinition-cache.php superseded in favor of a generic
323   flush-definition-cache.php script, you can clear a specific cache
324   by passing its name as a parameter to the script
325 ! Phorum mod implemented for HTML Purifier
326 ! With %Core.AggressivelyFixLt, <3 and similar emoticons no longer
327   trigger HTML removal in PHP5 (DOMLex). This directive is not necessary
328   for PHP4 (DirectLex).
329 ! Standalone file now available, which greatly reduces the amount of
330   includes (although there are still a few files that reside in the
331   standalone folder)
332 ! Relative URIs can now be transformed into their absolute equivalents
333   using %URI.Base and %URI.MakeAbsolute
334 ! Ruby implemented for XHTML 1.1
335 ! You can now define custom URI filtering behavior, see enduser-uri-filter.html
336   for more details
337 ! UTF-8 font names now supported in CSS
338 - AutoFormatters emit friendly error messages if tags or attributes they
339   need are not allowed
340 - ConfigForm's compactification of directive names is now configurable
341 - AutoParagraph autoformatter algorithm refined after field-testing
342 - XHTML 1.1 now applies XHTML 1.0 Strict cleanup routines, namely
343   blockquote wrapping
344 - Contents of <style> tags removed by default when tags are removed
345 . HTMLPurifier_Config->getSerial() implemented, this is extremely useful
346   for output cache invalidation
347 . ConfigForm printer now can retrieve CSS and JS files as strings, in
348   case HTML Purifier's directory is not publically accessible
349 . Introduce new text/itext configuration directive values: these represent
350   longer strings that would be more appropriately edited with a textarea
351 . Allow newlines to act as separators for lists, hashes, lookups and
352   %HTML.Allowed
353 . ConfigForm generates textareas instead of text inputs for lists, hashes,
354   lookups, text and itext fields
355 . Hidden element content removal genericized: %Core.HiddenElements can
356   be used to customize this behavior, by default <script> and <style> are
357   hidden
358 . Added HTMLPURIFIER_PREFIX constant, should be used instead of dirname(__FILE__)
359 . Custom ChildDef added to default include list
360 . URIScheme reflection improved: will not attempt to include file if class
361   already exists. May clobber autoload, so I need to keep an eye on it
362 . ConfigSchema heavily optimized, will only collect information and validate
363   definitions when HTMLPURIFIER_SCHEMA_STRICT is true.
364 . AttrDef_URI unit tests and implementation refactored
365 . benchmarks/ directory now protected from public view with .htaccess file;
366   run the tests via command line
367 . URI scheme is munged off if there is no authority and the scheme is the
368   default one
369 . All unit tests inherit from HTMLPurifier_Harness, not UnitTestCase
370 . Interface for URIScheme changed
371 . Generic URI object to hold components of URI added, most systems involved
372   in URI validation have been migrated to use it
373 . Custom filtering for URIs factored out to URIDefinition interface for
374   maximum extensibility
376 2.0.1, released 2007-06-27
377 ! Tag auto-closing now based on a ChildDef heuristic rather than a
378   manually set auto_close array; some behavior may change
379 ! Experimental AutoFormat functionality added: auto-paragraph and
380   linkify your HTML input by setting %AutoFormat.AutoParagraph and
381   %AutoFormat.Linkify to true
382 ! Newlines normalized internally, and then converted back to the
383   value of PHP_EOL. If this is not desired, set your newline format
384   using %Output.Newline.
385 ! Beta error collection, messages are implemented for the most generic
386   cases involving Lexing or Strategies
387 - Clean up special case code for <script> tags
388 - Reorder includes for DefinitionCache decorators, fixes a possible
389   missing class error
390 - Fixed bug where manually modified definitions were not saved via cache
391   (mostly harmless, except for the fact that it would be a little slower)
392 - Configuration objects with different serials do not clobber each
393   others when revision numbers are unequal
394 - Improve Serializer DefinitionCache directory permissions checks
395 - DefinitionCache no longer throws errors when it encounters old
396   serial files that do not conform to the current style
397 - Stray xmlns attributes removed from configuration documentation
398 - configForm.php smoketest no longer has XSS vulnerability due to
399   unescaped print_r output
400 - Printer adheres to configuration's directives on output format
401 - Fix improperly named form field in ConfigForm printer
402 . Rewire some test-cases to swallow errors rather than expect them
403 . HTMLDefinition printer updated with some of the new attributes
404 . DefinitionCache keys reordered to reflect precedence: version number,
405   hash, then revision number
406 . %Core.DefinitionCache renamed to %Cache.DefinitionImpl
407 . Interlinking in configuration documentation added using
408   Injector_PurifierLinkify
409 . Directives now keep track of aliases to themselves
410 . Error collector now requires a severity to be passed, use PHP's internal
411   error constants for this
412 . HTMLPurifier_Config::getAllowedDirectivesForForm implemented, allows
413   much easier selective embedding of configuration values
414 . Doctype objects now accept public and system DTD identifiers
415 . %HTML.Doctype is now constrained by specific values, to specify a custom
416   doctype use new %HTML.CustomDoctype
417 . ConfigForm truncates long directives to keep the form small, and does
418   not re-output namespaces
420 2.0.0, released 2007-06-20
421 # Completely refactored HTMLModuleManager, decentralizing safety
422   information
423 # Transform modules changed to Tidy modules, which offer more flexibility
424   and better modularization
425 # Configuration object now finalizes itself when a read operation is
426   performed on it, ensuring that its internal state stays consistent.
427   To revert this behavior, you can set the $autoFinalize member variable 
428   off, but it's not recommended.
429 # New compact syntax for AttrDef objects that can be used to instantiate
430   new objects via make()
431 # Definitions (esp. HTMLDefinition) are now cached for a significant
432   performance boost. You can disable caching by setting %Core.DefinitionCache
433   to null. You CANNOT edit raw definitions without setting the corresponding
434   DefinitionID directive (%HTML.DefinitionID for HTMLDefinition).
435 # Contents between <script> tags are now completely removed if <script>
436   is not allowed
437 # Prototype-declarations for Lexer removed in favor of configuration
438   determination of Lexer implementations.
439 ! HTML Purifier now works in PHP 4.3.2.
440 ! Configuration form-editing API makes tweaking HTMLPurifier_Config a
441   breeze!
442 ! Configuration directives that accept hashes now allow new string
443   format: key1:value1,key2:value2
444 ! ConfigDoc now factored into OOP design
445 ! All deprecated elements now natively supported
446 ! Implement TinyMCE styled whitelist specification format in
447   %HTML.Allowed
448 ! Config object gives more friendly error messages when things go wrong
449 ! Advanced API implemented: easy functions for creating elements (addElement)
450   and attributes (addAttribute) on HTMLDefinition
451 ! Add native support for required attributes
452 - Deprecated and removed EnableRedundantUTF8Cleaning. It didn't even work!
453 - DOMLex will not emit errors when a custom error handler that does not
454   honor error_reporting is used
455 - StrictBlockquote child definition refrains from wrapping whitespace
456   in tags now.
457 - Bug resulting from tag transforms to non-allowed elements fixed
458 - ChildDef_Custom's regex generation has been improved, removing several
459   false positives
460 . Unit test for ElementDef created, ElementDef behavior modified to
461   be more flexible
462 . Added convenience functions for HTMLModule constructors
463 . AttrTypes now has accessor functions that should be used instead
464   of directly manipulating info
465 . TagTransform_Center deprecated in favor of generic TagTransform_Simple
466 . Add extra protection in AttrDef_URI against phantom Schemes
467 . Doctype object added to HTMLDefinition which describes certain aspects
468   of the operational document type
469 . Lexer is now pre-emptively included, with a conditional include for the
470   PHP5 only version.
471 . HTMLDefinition and CSSDefinition have a common parent class: Definition.
472 . DirectLex can now track line-numbers
473 . Preliminary error collector is in place, although no code actually reports
474   errors yet
475 . Factor out most of ValidateAttributes to new AttrValidator class
477 1.6.1, released 2007-05-05
478 ! Support for more deprecated attributes via transformations:
479   + hspace and vspace in img
480   + size and noshade in hr
481   + nowrap in td
482   + clear in br
483   + align in caption, table, img and hr
484   + type in ul, ol and li
485 ! DirectLex now preserves text in which a < bracket is followed by
486   a non-alphanumeric character. This means that certain emoticons
487   are now preserved.
488 ! %Core.RemoveInvalidImg is now operational, when set to false invalid
489   images will hang around with an empty src
490 ! target attribute in a tag supported, use %Attr.AllowedFrameTargets
491   to enable
492 ! CSS property white-space now allows nowrap (supported in all modern
493   browsers) but not others (which have spotty browser implementations)
494 ! XHTML 1.1 mode now sort-of works without any fatal errors, and
495   lang is now moved over to xml:lang.
496 ! Attribute transformation smoketest available at smoketests/attrTransform.php
497 ! Transformation of font's size attribute now handles super-large numbers
498 - Possibly fatal bug with __autoload() fixed in module manager
499 - Invert HTMLModuleManager->addModule() processing order to check
500   prefixes first and then the literal module
501 - Empty strings get converted to empty arrays instead of arrays with
502   an empty string in them.
503 - Merging in attribute lists now works.
504 . Demo script removed: it has been added to the website's repository
505 . Basic.php script modified to work out of the box
506 . Refactor AttrTransform classes to reduce duplication
507 . AttrTransform_TextAlign axed in favor of a more general
508   AttrTransform_EnumToCSS, refer to HTMLModule/TransformToStrict.php to
509   see how the new equivalent is implemented
510 . Unit tests now use exclusively assertIdentical
512 1.6.0, released 2007-04-01
513 ! Support for most common deprecated attributes via transformations:
514   + bgcolor in td, th, tr and table
515   + border in img
516   + name in a and img
517   + width in td, th and hr
518   + height in td, th
519 ! Support for CSS attribute 'height' added
520 ! Support for rel and rev attributes in a tags added, use %Attr.AllowedRel
521   and %Attr.AllowedRev to activate
522 - You can define ID blacklists using regular expressions via
523   %Attr.IDBlacklistRegexp
524 - Error messages are emitted when you attempt to "allow" elements or
525   attributes that HTML Purifier does not support
526 - Fix segfault in unit test. The problem is not very reproduceable and
527   I don't know what causes it, but a six line patch fixed it.
529 1.5.0, released 2007-03-23
530 ! Added a rudimentary I18N and L10N system modeled off MediaWiki. It
531   doesn't actually do anything yet, but keep your eyes peeled.
532 ! docs/enduser-utf8.html explains how to use UTF-8 and HTML Purifier
533 ! Newly structured HTMLDefinition modeled off of XHTML 1.1 modules.
534   I am loathe to release beta quality APIs, but this is exactly that;
535   don't use the internal interfaces if you're not willing to do migration
536   later on.
537 - Allow 'x' subtag in language codes
538 - Fixed buggy chameleon-support for ins and del
539 . Added support for IDREF attributes (i.e. for)
540 . Renamed HTMLPurifier_AttrDef_Class to HTMLPurifier_AttrDef_Nmtokens
541 . Removed context variable ParentType, replaced with IsInline, which
542   is false when you're not inline and an integer of the parent that
543   caused you to become inline when you are (so possibly zero)
544 . Removed ElementDef->type in favor of ElementDef->descendants_are_inline
545   and HTMLDefinition->content_sets
546 . StrictBlockquote now reports what elements its supposed to allow,
547   rather than what it does allow
548 . Removed HTMLDefinition->info_flow_elements in favor of
549   HTMLDefinition->content_sets['Flow']
550 . Removed redundant "exclusionary" definitions from DTD roster
551 . StrictBlockquote now requires a construction parameter as if it
552   were an Required ChildDef, this is the "real" set of allowed elements
553 . AttrDef partitioned into HTML, CSS and URI segments
554 . Modify Youtube filter regexp to be multiline
555 . Require both PHP5 and DOM extension in order to use DOMLex, fixes
556   some edge cases where a DOMDocument class exists in a PHP4 environment
557   due to DOM XML extension.
559 1.4.1, released 2007-01-21
560 ! docs/enduser-youtube.html updated according to new functionality
561 - YouTube IDs can have underscores and dashes
563 1.4.0, released 2007-01-21
564 ! Implemented list-style-image, URIs now allowed in list-style
565 ! Implemented background-image, background-repeat, background-attachment
566   and background-position CSS properties. Shorthand property background
567   supports all of these properties.
568 ! Configuration documentation looks nicer
569 ! Added %Core.EscapeNonASCIICharacters to workaround loss of Unicode
570   characters while %Core.Encoding is set to a non-UTF-8 encoding.
571 ! Support for configuration directive aliases added
572 ! Config object can now be instantiated from ini files
573 ! YouTube preservation code added to the core, with two lines of code
574   you can add it as a filter to your code. See smoketests/preserveYouTube.php
575   for sample code.
576 ! Moved SLOW to docs/enduser-slow.html and added code examples
577 - Replaced version check with functionality check for DOM (thanks Stephen
578   Khoo)
579 . Added smoketest 'all.php', which loads all other smoketests via frames
580 . Implemented AttrDef_CSSURI for url(http://google.com) style declarations
581 . Added convenient single test selector form on test runner
583 1.3.2, released 2006-12-25
584 ! HTMLPurifier object now accepts configuration arrays, no need to manually
585   instantiate a configuration object
586 ! Context object now accessible to outside
587 ! Added enduser-youtube.html, explains how to embed YouTube videos. See
588   also corresponding smoketest preserveYouTube.php.
589 ! Added purifyArray(), which takes a list of HTML and purifies it all
590 ! Added static member variable $version to HTML Purifier with PHP-compatible
591   version number string.
592 - Fixed fatal error thrown by upper-cased language attributes
593 - printDefinition.php: added labels, added better clarification
594 . HTMLPurifier_Config::create() added, takes mixed variable and converts into
595   a HTMLPurifier_Config object.
597 1.3.1, released 2006-12-06
598 ! Added HTMLPurifier.func.php stub for a convenient function to call the library
599 - Fixed bug in RemoveInvalidImg code that caused all images to be dropped
600   (thanks to .mario for reporting this)
601 . Standardized all attribute handling variables to attr, made it plural
603 1.3.0, released 2006-11-26
604 # Invalid images are now removed, rather than replaced with a dud
605   <img src="" alt="Invalid image" />. Previous behavior can be restored
606   with new directive %Core.RemoveInvalidImg set to false.
607 ! (X)HTML Strict now supported
608   + Transparently handles inline elements in block context (blockquote)
609 ! Added GET method to demo for easier validation, added 50kb max input size
610 ! New directive %HTML.BlockWrapper, for block-ifying inline elements
611 ! New directive %HTML.Parent, allows you to only allow inline content
612 ! New directives %HTML.AllowedElements and %HTML.AllowedAttributes to let
613   users narrow the set of allowed tags
614 ! <li value="4"> and <ul start="2"> now allowed in loose mode
615 ! New directives %URI.DisableExternalResources and %URI.DisableResources
616 ! New directive %Attr.DisableURI, which eliminates all hyperlinking
617 ! New directive %URI.Munge, munges URI so you can use some sort of redirector
618   service to avoid PageRank leaks or warn users that they are exiting your site.
619 ! Added spiffy new smoketest printDefinition.php, which lets you twiddle with
620   the configuration settings and see how the internal rules are affected.
621 ! New directive %URI.HostBlacklist for blocking links to bad hosts.
622   xssAttacks.php smoketest updated accordingly.
623 - Added missing type to ChildDef_Chameleon
624 - Remove Tidy option from demo if there is not Tidy available
625 . ChildDef_Required guards against empty tags
626 . Lookup table HTMLDefinition->info_flow_elements added
627 . Added peace-of-mind variable initialization to Strategy_FixNesting
628 . Added HTMLPurifier->info_parent_def, parent child processing made special
629 . Added internal documents briefly summarizing future progression of HTML
630 . HTMLPurifier_Config->getBatch($namespace) added
631 . More lenient casting to bool from string in HTMLPurifier_ConfigSchema
632 . Refactored ChildDef classes into their own files
634 1.2.0, released 2006-11-19
635 # ID attributes now disabled by default. New directives:
636   + %HTML.EnableAttrID - restores old behavior by allowing IDs
637   + %Attr.IDPrefix - %Attr.IDBlacklist alternative that munges all user IDs
638     so that they don't collide with your IDs
639   + %Attr.IDPrefixLocal - Same as above, but for when there are multiple
640     instances of user content on the page
641   + Profuse documentation on how to use these available in docs/enduser-id.txt
642 ! Added MODx plugin <http://modxcms.com/forums/index.php/topic,6604.0.html>
643 ! Added percent encoding normalization
644 ! XSS attacks smoketest given facelift
645 ! Configuration documentation now has table of contents
646 ! Added %URI.DisableExternal, which prevents links to external websites.  You
647   can also use %URI.Host to permit absolute linking to subdomains
648 ! Non-accessible resources (ex. mailto) blocked from embedded URIs (img src)
649 - Type variable in HTMLDefinition was not being set properly, fixed
650 - Documentation updated
651   + TODO added request Phalanger
652   + TODO added request Native compression
653   + TODO added request Remove redundant tags
654   + TODO added possible plaintext formatter for HTML Purifier documentation
655   + Updated ConfigDoc TODO
656   + Improved inline comments in AttrDef/Class.php, AttrDef/CSS.php
657     and AttrDef/Host.php
658   + Revamped documentation into HTML, along with misc updates
659 - HTMLPurifier_Context doesn't throw a variable reference error if you attempt
660   to retrieve a non-existent variable
661 . Switched to purify()-wide Context object registry
662 . Refactored unit tests to minimize duplication
663 . XSS attack sheet updated
664 . configdoc.xml now has xml:space attached to default value nodes
665 . Allow configuration directives to permit null values
666 . Cleaned up test-cases to remove unnecessary swallowErrors()
668 1.1.2, released 2006-09-30
669 ! Add HTMLPurifier.auto.php stub file that configures include_path
670 - Documentation updated
671   + INSTALL document rewritten
672   + TODO added semi-lossy conversion
673   + API Doxygen docs' file exclusions updated
674   + Added notes on HTML versus XML attribute whitespace handling
675   + Noted that HTMLPurifier_ChildDef_Custom isn't being used
676   + Noted that config object's definitions are cached versions
677 - Fixed lack of attribute parsing in HTMLPurifier_Lexer_PEARSax3
678 - ftp:// URIs now have their typecodes checked
679 - Hooked up HTMLPurifier_ChildDef_Custom's unit tests (they weren't being run)
680 . Line endings standardized throughout project (svn:eol-style standardized)
681 . Refactored parseData() to general Lexer class
682 . Tester named "HTML Purifier" not "HTMLPurifier"
684 1.1.1, released 2006-09-24
685 ! Configuration option to optionally Tidy up output for indentation to make up
686   for dropped whitespace by DOMLex (pretty-printing for the entire application
687   should be done by a page-wide Tidy)
688 - Various documentation updates
689 - Fixed parse error in configuration documentation script
690 - Fixed fatal error in benchmark scripts, slightly augmented
691 - As far as possible, whitespace is preserved in-between table children
692 - Sample test-settings.php file included
694 1.1.0, released 2006-09-16
695 ! Directive documentation generation using XSLT
696 ! XHTML can now be turned off, output becomes <br>
697 - Made URI validator more forgiving: will ignore leading and trailing
698   quotes, apostrophes and less than or greater than signs.
699 - Enforce alphanumeric namespace and directive names for configuration.
700 - Table child definition made more flexible, will fix up poorly ordered elements
701 . Renamed ConfigDef to ConfigSchema
703 1.0.1, released 2006-09-04
704 - Fixed slight bug in DOMLex attribute parsing
705 - Fixed rejection of case-insensitive configuration values when there is a
706   set of allowed values.  This manifested in %Core.Encoding.
707 - Fixed rejection of inline style declarations that had lots of extra
708   space in them.  This manifested in TinyMCE.
710 1.0.0, released 2006-09-01
711 ! Shorthand CSS properties implemented: font, border, background, list-style
712 ! Basic color keywords translated into hexadecimal values
713 ! Table CSS properties implemented
714 ! Support for charsets other than UTF-8 (defined by iconv)
715 ! Malformed UTF-8 and non-SGML character detection and cleaning implemented
716 - Fixed broken numeric entity conversion
717 - API documentation completed
718 . (HTML|CSS)Definition de-singleton-ized
720 1.0.0beta, released 2006-08-16
721 ! First public release, most functionality implemented. Notable omissions are:
722   + Shorthand CSS properties
723   + Table CSS properties
724   + Deprecated attribute transformations