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