NEWS 44 KB

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