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