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