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