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