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