1 NEWS ( CHANGELOG and HISTORY ) HTMLPurifier
2 |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
4 = KEY ====================
10 ==========================
12 2.1.3, released 2007-11-05
13 ! tests/multitest.php allows you to test multiple versions by running
14 tests/index.php through multiple interpreters using `phpv` shell
15 script (you must provide this script!)
16 - Fixed poor include ordering for Email URI AttrDefs, causes fatal errors
18 - Injector algorithm further refined: off-by-one error regarding skip
19 counts for dormant injectors fixed
20 - Corrective blockquote definition now enabled for HTML 4.01 Strict
21 - Fatal error when <img> tag (or any other element with required attributes)
22 has 'id' attribute fixed, thanks NykO18 for reporting
23 - Fix warning emitted when a non-supported URI scheme is passed to the
24 MakeAbsolute URIFilter, thanks NykO18 (again)
25 - Further refine AutoParagraph injector. Behavior inside of elements
26 allowing paragraph tags clarified: only inline content delimeted by
27 double newlines (not block elements) are paragraphed.
28 - Buggy treatment of end tags of elements that have required attributes
29 fixed (does not manifest on default tag-set)
30 - Spurious internal content reorganization error suppressed
31 - HTMLDefinition->addElement now returns a reference to the created
32 element object, as implied by the documentation
33 - Phorum mod's HTML Purifier help message expanded (unreleased elsewhere)
34 - Fix a theoretical class of infinite loops from DirectLex reported
36 - Work around unnecessary DOMElement type-cast in PH5P that caused errors
38 - Work around PHP 4 SimpleTest lack-of-error complaining for one-time-only
39 HTMLDefinition errors, this may indicate problems with error-collecting
41 - Make ErrorCollectorEMock work in both PHP 4 and PHP 5
42 - Make PH5P work with PHP 5.0 by removing unnecessary array parameter typedef
43 . %Core.AcceptFullDocuments renamed to %Core.ConvertDocumentToFragment
44 to better communicate its purpose
45 . Error unit tests can now specify the expectation of no errors. Future
46 iterations of the harness will be extremely strict about what errors
48 . Extend Injector hooks to allow for more powerful injector routines
49 . HTMLDefinition->addBlankElement created, as according to the HTMLModule
51 . Doxygen configuration file updated, with minor improvements
52 . Test runner now checks for similarly named files in conf/ directory too.
53 . Minor cosmetic change to flush-definition-cache.php: trailing newline is
55 . Maintenance script for generating PH5P patch added, original PH5P source
56 file also added under version control
57 . Full unit test runner script title made more descriptive with PHP version
58 . Updated INSTALL file to state that 4.3.7 is the earliest version we
61 2.1.2, released 2007-09-03
62 ! Implemented Object module for trusted users
63 ! Implemented experimental HTML5 parsing mode using PH5P. To use, add
65 require_once 'HTMLPurifier/Lexer/PH5P.php';
66 $config->set('Core', 'LexerImpl', 'PH5P');
67 Note that this Lexer introduces some classes not in the HTMLPurifier
68 namespace. Also, this is PHP5 only.
69 ! CSS property border-spacing implemented
70 - Fix non-visible parsing error in DirectLex with empty tags that have
71 slashes inside attribute values.
72 - Fix typo in CSS definition: border-collapse:seperate; was incorrectly
73 accepted as valid CSS. Usually non-visible, because this styling is the
74 default for tables in most browsers. Thanks Brett Zamir for pointing
76 - Fix validation errors in configuration form
77 - Hammer out a bunch of edge-case bugs in the standalone distribution
78 - Inclusion reflection removed from URISchemeRegistry; you must manually
79 include any new schema files you wish to use
80 - Numerous typo fixes in documentation thanks to Brett Zamir
81 . Unit test refactoring for one logical test per test function
82 . Config and context parameters in ComplexHarness deprecated: instead, edit
83 the $config and $context member variables
84 . HTML wrapper in DOMLex now takes DTD identifiers into account; doesn't
85 really make a difference, but is good for completeness sake
86 . merge-library.php script refactored for greater code reusability and
89 2.1.1, released 2007-08-04
90 - Fix show-stopper bug in %URI.MakeAbsolute functionality
91 - Fix PHP4 syntax error in standalone version
92 . Add prefix directory to include path for standalone, this prevents
93 other installations from clobbering the standalone's URI schemes
94 . Single test methods can be invoked by prefixing with __only
96 2.1.0, released 2007-08-02
97 # flush-htmldefinition-cache.php superseded in favor of a generic
98 flush-definition-cache.php script, you can clear a specific cache
99 by passing its name as a parameter to the script
100 ! Phorum mod implemented for HTML Purifier
101 ! With %Core.AggressivelyFixLt, <3 and similar emoticons no longer
102 trigger HTML removal in PHP5 (DOMLex). This directive is not necessary
103 for PHP4 (DirectLex).
104 ! Standalone file now available, which greatly reduces the amount of
105 includes (although there are still a few files that reside in the
107 ! Relative URIs can now be transformed into their absolute equivalents
108 using %URI.Base and %URI.MakeAbsolute
109 ! Ruby implemented for XHTML 1.1
110 ! You can now define custom URI filtering behavior, see enduser-uri-filter.html
112 ! UTF-8 font names now supported in CSS
113 - AutoFormatters emit friendly error messages if tags or attributes they
115 - ConfigForm's compactification of directive names is now configurable
116 - AutoParagraph autoformatter algorithm refined after field-testing
117 - XHTML 1.1 now applies XHTML 1.0 Strict cleanup routines, namely
119 - Contents of <style> tags removed by default when tags are removed
120 . HTMLPurifier_Config->getSerial() implemented, this is extremely useful
121 for output cache invalidation
122 . ConfigForm printer now can retrieve CSS and JS files as strings, in
123 case HTML Purifier's directory is not publically accessible
124 . Introduce new text/itext configuration directive values: these represent
125 longer strings that would be more appropriately edited with a textarea
126 . Allow newlines to act as separators for lists, hashes, lookups and
128 . ConfigForm generates textareas instead of text inputs for lists, hashes,
129 lookups, text and itext fields
130 . Hidden element content removal genericized: %Core.HiddenElements can
131 be used to customize this behavior, by default <script> and <style> are
133 . Added HTMLPURIFIER_PREFIX constant, should be used instead of dirname(__FILE__)
134 . Custom ChildDef added to default include list
135 . URIScheme reflection improved: will not attempt to include file if class
136 already exists. May clobber autoload, so I need to keep an eye on it
137 . ConfigSchema heavily optimized, will only collect information and validate
138 definitions when HTMLPURIFIER_SCHEMA_STRICT is true.
139 . AttrDef_URI unit tests and implementation refactored
140 . benchmarks/ directory now protected from public view with .htaccess file;
141 run the tests via command line
142 . URI scheme is munged off if there is no authority and the scheme is the
144 . All unit tests inherit from HTMLPurifier_Harness, not UnitTestCase
145 . Interface for URIScheme changed
146 . Generic URI object to hold components of URI added, most systems involved
147 in URI validation have been migrated to use it
148 . Custom filtering for URIs factored out to URIDefinition interface for
149 maximum extensibility
151 2.0.1, released 2007-06-27
152 ! Tag auto-closing now based on a ChildDef heuristic rather than a
153 manually set auto_close array; some behavior may change
154 ! Experimental AutoFormat functionality added: auto-paragraph and
155 linkify your HTML input by setting %AutoFormat.AutoParagraph and
156 %AutoFormat.Linkify to true
157 ! Newlines normalized internally, and then converted back to the
158 value of PHP_EOL. If this is not desired, set your newline format
159 using %Output.Newline.
160 ! Beta error collection, messages are implemented for the most generic
161 cases involving Lexing or Strategies
162 - Clean up special case code for <script> tags
163 - Reorder includes for DefinitionCache decorators, fixes a possible
165 - Fixed bug where manually modified definitions were not saved via cache
166 (mostly harmless, except for the fact that it would be a little slower)
167 - Configuration objects with different serials do not clobber each
168 others when revision numbers are unequal
169 - Improve Serializer DefinitionCache directory permissions checks
170 - DefinitionCache no longer throws errors when it encounters old
171 serial files that do not conform to the current style
172 - Stray xmlns attributes removed from configuration documentation
173 - configForm.php smoketest no longer has XSS vulnerability due to
174 unescaped print_r output
175 - Printer adheres to configuration's directives on output format
176 - Fix improperly named form field in ConfigForm printer
177 . Rewire some test-cases to swallow errors rather than expect them
178 . HTMLDefinition printer updated with some of the new attributes
179 . DefinitionCache keys reordered to reflect precedence: version number,
180 hash, then revision number
181 . %Core.DefinitionCache renamed to %Cache.DefinitionImpl
182 . Interlinking in configuration documentation added using
183 Injector_PurifierLinkify
184 . Directives now keep track of aliases to themselves
185 . Error collector now requires a severity to be passed, use PHP's internal
186 error constants for this
187 . HTMLPurifier_Config::getAllowedDirectivesForForm implemented, allows
188 much easier selective embedding of configuration values
189 . Doctype objects now accept public and system DTD identifiers
190 . %HTML.Doctype is now constrained by specific values, to specify a custom
191 doctype use new %HTML.CustomDoctype
192 . ConfigForm truncates long directives to keep the form small, and does
193 not re-output namespaces
195 2.0.0, released 2007-06-20
196 # Completely refactored HTMLModuleManager, decentralizing safety
198 # Transform modules changed to Tidy modules, which offer more flexibility
199 and better modularization
200 # Configuration object now finalizes itself when a read operation is
201 performed on it, ensuring that its internal state stays consistent.
202 To revert this behavior, you can set the $autoFinalize member variable
203 off, but it's not recommended.
204 # New compact syntax for AttrDef objects that can be used to instantiate
205 new objects via make()
206 # Definitions (esp. HTMLDefinition) are now cached for a significant
207 performance boost. You can disable caching by setting %Core.DefinitionCache
208 to null. You CANNOT edit raw definitions without setting the corresponding
209 DefinitionID directive (%HTML.DefinitionID for HTMLDefinition).
210 # Contents between <script> tags are now completely removed if <script>
212 # Prototype-declarations for Lexer removed in favor of configuration
213 determination of Lexer implementations.
214 ! HTML Purifier now works in PHP 4.3.2.
215 ! Configuration form-editing API makes tweaking HTMLPurifier_Config a
217 ! Configuration directives that accept hashes now allow new string
218 format: key1:value1,key2:value2
219 ! ConfigDoc now factored into OOP design
220 ! All deprecated elements now natively supported
221 ! Implement TinyMCE styled whitelist specification format in
223 ! Config object gives more friendly error messages when things go wrong
224 ! Advanced API implemented: easy functions for creating elements (addElement)
225 and attributes (addAttribute) on HTMLDefinition
226 ! Add native support for required attributes
227 - Deprecated and removed EnableRedundantUTF8Cleaning. It didn't even work!
228 - DOMLex will not emit errors when a custom error handler that does not
229 honor error_reporting is used
230 - StrictBlockquote child definition refrains from wrapping whitespace
232 - Bug resulting from tag transforms to non-allowed elements fixed
233 - ChildDef_Custom's regex generation has been improved, removing several
235 . Unit test for ElementDef created, ElementDef behavior modified to
237 . Added convenience functions for HTMLModule constructors
238 . AttrTypes now has accessor functions that should be used instead
239 of directly manipulating info
240 . TagTransform_Center deprecated in favor of generic TagTransform_Simple
241 . Add extra protection in AttrDef_URI against phantom Schemes
242 . Doctype object added to HTMLDefinition which describes certain aspects
243 of the operational document type
244 . Lexer is now pre-emptively included, with a conditional include for the
246 . HTMLDefinition and CSSDefinition have a common parent class: Definition.
247 . DirectLex can now track line-numbers
248 . Preliminary error collector is in place, although no code actually reports
250 . Factor out most of ValidateAttributes to new AttrValidator class
252 1.6.1, released 2007-05-05
253 ! Support for more deprecated attributes via transformations:
254 + hspace and vspace in img
255 + size and noshade in hr
258 + align in caption, table, img and hr
259 + type in ul, ol and li
260 ! DirectLex now preserves text in which a < bracket is followed by
261 a non-alphanumeric character. This means that certain emoticons
263 ! %Core.RemoveInvalidImg is now operational, when set to false invalid
264 images will hang around with an empty src
265 ! target attribute in a tag supported, use %Attr.AllowedFrameTargets
267 ! CSS property white-space now allows nowrap (supported in all modern
268 browsers) but not others (which have spotty browser implementations)
269 ! XHTML 1.1 mode now sort-of works without any fatal errors, and
270 lang is now moved over to xml:lang.
271 ! Attribute transformation smoketest available at smoketests/attrTransform.php
272 ! Transformation of font's size attribute now handles super-large numbers
273 - Possibly fatal bug with __autoload() fixed in module manager
274 - Invert HTMLModuleManager->addModule() processing order to check
275 prefixes first and then the literal module
276 - Empty strings get converted to empty arrays instead of arrays with
277 an empty string in them.
278 - Merging in attribute lists now works.
279 . Demo script removed: it has been added to the website's repository
280 . Basic.php script modified to work out of the box
281 . Refactor AttrTransform classes to reduce duplication
282 . AttrTransform_TextAlign axed in favor of a more general
283 AttrTransform_EnumToCSS, refer to HTMLModule/TransformToStrict.php to
284 see how the new equivalent is implemented
285 . Unit tests now use exclusively assertIdentical
287 1.6.0, released 2007-04-01
288 ! Support for most common deprecated attributes via transformations:
289 + bgcolor in td, th, tr and table
292 + width in td, th and hr
294 ! Support for CSS attribute 'height' added
295 ! Support for rel and rev attributes in a tags added, use %Attr.AllowedRel
296 and %Attr.AllowedRev to activate
297 - You can define ID blacklists using regular expressions via
298 %Attr.IDBlacklistRegexp
299 - Error messages are emitted when you attempt to "allow" elements or
300 attributes that HTML Purifier does not support
301 - Fix segfault in unit test. The problem is not very reproduceable and
302 I don't know what causes it, but a six line patch fixed it.
304 1.5.0, released 2007-03-23
305 ! Added a rudimentary I18N and L10N system modeled off MediaWiki. It
306 doesn't actually do anything yet, but keep your eyes peeled.
307 ! docs/enduser-utf8.html explains how to use UTF-8 and HTML Purifier
308 ! Newly structured HTMLDefinition modeled off of XHTML 1.1 modules.
309 I am loathe to release beta quality APIs, but this is exactly that;
310 don't use the internal interfaces if you're not willing to do migration
312 - Allow 'x' subtag in language codes
313 - Fixed buggy chameleon-support for ins and del
314 . Added support for IDREF attributes (i.e. for)
315 . Renamed HTMLPurifier_AttrDef_Class to HTMLPurifier_AttrDef_Nmtokens
316 . Removed context variable ParentType, replaced with IsInline, which
317 is false when you're not inline and an integer of the parent that
318 caused you to become inline when you are (so possibly zero)
319 . Removed ElementDef->type in favor of ElementDef->descendants_are_inline
320 and HTMLDefinition->content_sets
321 . StrictBlockquote now reports what elements its supposed to allow,
322 rather than what it does allow
323 . Removed HTMLDefinition->info_flow_elements in favor of
324 HTMLDefinition->content_sets['Flow']
325 . Removed redundant "exclusionary" definitions from DTD roster
326 . StrictBlockquote now requires a construction parameter as if it
327 were an Required ChildDef, this is the "real" set of allowed elements
328 . AttrDef partitioned into HTML, CSS and URI segments
329 . Modify Youtube filter regexp to be multiline
330 . Require both PHP5 and DOM extension in order to use DOMLex, fixes
331 some edge cases where a DOMDocument class exists in a PHP4 environment
332 due to DOM XML extension.
334 1.4.1, released 2007-01-21
335 ! docs/enduser-youtube.html updated according to new functionality
336 - YouTube IDs can have underscores and dashes
338 1.4.0, released 2007-01-21
339 ! Implemented list-style-image, URIs now allowed in list-style
340 ! Implemented background-image, background-repeat, background-attachment
341 and background-position CSS properties. Shorthand property background
342 supports all of these properties.
343 ! Configuration documentation looks nicer
344 ! Added %Core.EscapeNonASCIICharacters to workaround loss of Unicode
345 characters while %Core.Encoding is set to a non-UTF-8 encoding.
346 ! Support for configuration directive aliases added
347 ! Config object can now be instantiated from ini files
348 ! YouTube preservation code added to the core, with two lines of code
349 you can add it as a filter to your code. See smoketests/preserveYouTube.php
351 ! Moved SLOW to docs/enduser-slow.html and added code examples
352 - Replaced version check with functionality check for DOM (thanks Stephen
354 . Added smoketest 'all.php', which loads all other smoketests via frames
355 . Implemented AttrDef_CSSURI for url(http://google.com) style declarations
356 . Added convenient single test selector form on test runner
358 1.3.2, released 2006-12-25
359 ! HTMLPurifier object now accepts configuration arrays, no need to manually
360 instantiate a configuration object
361 ! Context object now accessible to outside
362 ! Added enduser-youtube.html, explains how to embed YouTube videos. See
363 also corresponding smoketest preserveYouTube.php.
364 ! Added purifyArray(), which takes a list of HTML and purifies it all
365 ! Added static member variable $version to HTML Purifier with PHP-compatible
366 version number string.
367 - Fixed fatal error thrown by upper-cased language attributes
368 - printDefinition.php: added labels, added better clarification
369 . HTMLPurifier_Config::create() added, takes mixed variable and converts into
370 a HTMLPurifier_Config object.
372 1.3.1, released 2006-12-06
373 ! Added HTMLPurifier.func.php stub for a convenient function to call the library
374 - Fixed bug in RemoveInvalidImg code that caused all images to be dropped
375 (thanks to .mario for reporting this)
376 . Standardized all attribute handling variables to attr, made it plural
378 1.3.0, released 2006-11-26
379 # Invalid images are now removed, rather than replaced with a dud
380 <img src="" alt="Invalid image" />. Previous behavior can be restored
381 with new directive %Core.RemoveInvalidImg set to false.
382 ! (X)HTML Strict now supported
383 + Transparently handles inline elements in block context (blockquote)
384 ! Added GET method to demo for easier validation, added 50kb max input size
385 ! New directive %HTML.BlockWrapper, for block-ifying inline elements
386 ! New directive %HTML.Parent, allows you to only allow inline content
387 ! New directives %HTML.AllowedElements and %HTML.AllowedAttributes to let
388 users narrow the set of allowed tags
389 ! <li value="4"> and <ul start="2"> now allowed in loose mode
390 ! New directives %URI.DisableExternalResources and %URI.DisableResources
391 ! New directive %Attr.DisableURI, which eliminates all hyperlinking
392 ! New directive %URI.Munge, munges URI so you can use some sort of redirector
393 service to avoid PageRank leaks or warn users that they are exiting your site.
394 ! Added spiffy new smoketest printDefinition.php, which lets you twiddle with
395 the configuration settings and see how the internal rules are affected.
396 ! New directive %URI.HostBlacklist for blocking links to bad hosts.
397 xssAttacks.php smoketest updated accordingly.
398 - Added missing type to ChildDef_Chameleon
399 - Remove Tidy option from demo if there is not Tidy available
400 . ChildDef_Required guards against empty tags
401 . Lookup table HTMLDefinition->info_flow_elements added
402 . Added peace-of-mind variable initialization to Strategy_FixNesting
403 . Added HTMLPurifier->info_parent_def, parent child processing made special
404 . Added internal documents briefly summarizing future progression of HTML
405 . HTMLPurifier_Config->getBatch($namespace) added
406 . More lenient casting to bool from string in HTMLPurifier_ConfigSchema
407 . Refactored ChildDef classes into their own files
409 1.2.0, released 2006-11-19
410 # ID attributes now disabled by default. New directives:
411 + %HTML.EnableAttrID - restores old behavior by allowing IDs
412 + %Attr.IDPrefix - %Attr.IDBlacklist alternative that munges all user IDs
413 so that they don't collide with your IDs
414 + %Attr.IDPrefixLocal - Same as above, but for when there are multiple
415 instances of user content on the page
416 + Profuse documentation on how to use these available in docs/enduser-id.txt
417 ! Added MODx plugin <http://modxcms.com/forums/index.php/topic,6604.0.html>
418 ! Added percent encoding normalization
419 ! XSS attacks smoketest given facelift
420 ! Configuration documentation now has table of contents
421 ! Added %URI.DisableExternal, which prevents links to external websites. You
422 can also use %URI.Host to permit absolute linking to subdomains
423 ! Non-accessible resources (ex. mailto) blocked from embedded URIs (img src)
424 - Type variable in HTMLDefinition was not being set properly, fixed
425 - Documentation updated
426 + TODO added request Phalanger
427 + TODO added request Native compression
428 + TODO added request Remove redundant tags
429 + TODO added possible plaintext formatter for HTML Purifier documentation
430 + Updated ConfigDoc TODO
431 + Improved inline comments in AttrDef/Class.php, AttrDef/CSS.php
433 + Revamped documentation into HTML, along with misc updates
434 - HTMLPurifier_Context doesn't throw a variable reference error if you attempt
435 to retrieve a non-existent variable
436 . Switched to purify()-wide Context object registry
437 . Refactored unit tests to minimize duplication
438 . XSS attack sheet updated
439 . configdoc.xml now has xml:space attached to default value nodes
440 . Allow configuration directives to permit null values
441 . Cleaned up test-cases to remove unnecessary swallowErrors()
443 1.1.2, released 2006-09-30
444 ! Add HTMLPurifier.auto.php stub file that configures include_path
445 - Documentation updated
446 + INSTALL document rewritten
447 + TODO added semi-lossy conversion
448 + API Doxygen docs' file exclusions updated
449 + Added notes on HTML versus XML attribute whitespace handling
450 + Noted that HTMLPurifier_ChildDef_Custom isn't being used
451 + Noted that config object's definitions are cached versions
452 - Fixed lack of attribute parsing in HTMLPurifier_Lexer_PEARSax3
453 - ftp:// URIs now have their typecodes checked
454 - Hooked up HTMLPurifier_ChildDef_Custom's unit tests (they weren't being run)
455 . Line endings standardized throughout project (svn:eol-style standardized)
456 . Refactored parseData() to general Lexer class
457 . Tester named "HTML Purifier" not "HTMLPurifier"
459 1.1.1, released 2006-09-24
460 ! Configuration option to optionally Tidy up output for indentation to make up
461 for dropped whitespace by DOMLex (pretty-printing for the entire application
462 should be done by a page-wide Tidy)
463 - Various documentation updates
464 - Fixed parse error in configuration documentation script
465 - Fixed fatal error in benchmark scripts, slightly augmented
466 - As far as possible, whitespace is preserved in-between table children
467 - Sample test-settings.php file included
469 1.1.0, released 2006-09-16
470 ! Directive documentation generation using XSLT
471 ! XHTML can now be turned off, output becomes <br>
472 - Made URI validator more forgiving: will ignore leading and trailing
473 quotes, apostrophes and less than or greater than signs.
474 - Enforce alphanumeric namespace and directive names for configuration.
475 - Table child definition made more flexible, will fix up poorly ordered elements
476 . Renamed ConfigDef to ConfigSchema
478 1.0.1, released 2006-09-04
479 - Fixed slight bug in DOMLex attribute parsing
480 - Fixed rejection of case-insensitive configuration values when there is a
481 set of allowed values. This manifested in %Core.Encoding.
482 - Fixed rejection of inline style declarations that had lots of extra
483 space in them. This manifested in TinyMCE.
485 1.0.0, released 2006-09-01
486 ! Shorthand CSS properties implemented: font, border, background, list-style
487 ! Basic color keywords translated into hexadecimal values
488 ! Table CSS properties implemented
489 ! Support for charsets other than UTF-8 (defined by iconv)
490 ! Malformed UTF-8 and non-SGML character detection and cleaning implemented
491 - Fixed broken numeric entity conversion
492 - API documentation completed
493 . (HTML|CSS)Definition de-singleton-ized
495 1.0.0beta, released 2006-08-16
496 ! First public release, most functionality implemented. Notable omissions are:
497 + Shorthand CSS properties
498 + Table CSS properties
499 + Deprecated attribute transformations