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