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