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