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