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