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