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