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