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