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