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