michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
michael@0:  * You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsISupports.idl"
michael@0: 
michael@0: interface nsIDOMElement;
michael@0: interface nsIDOMDocumentFragment;
michael@0: interface nsIURI;
michael@0: 
michael@0: /**
michael@0:  * Non-Web HTML parser functionality to Firefox extensions and XULRunner apps. 
michael@0:  * Don't use this from within Gecko--use nsContentUtils, nsTreeSanitizer, etc.
michael@0:  * directly instead.
michael@0:  */
michael@0: [scriptable, uuid(a1101145-0025-411e-8873-fdf57bf28128)]
michael@0: interface nsIParserUtils : nsISupports
michael@0: {
michael@0: 
michael@0:   /**
michael@0:    * Flag for sanitizer: Allow comment nodes.
michael@0:    */
michael@0:   const unsigned long SanitizerAllowComments = (1 << 0);
michael@0: 
michael@0:   /**
michael@0:    * Flag for sanitizer: Allow <style> and style="" (with contents sanitized
michael@0:    * in case of -moz-binding). Note! If -moz-binding is absent, properties
michael@0:    * that might be XSS risks in other Web engines are preserved!
michael@0:    */
michael@0:   const unsigned long SanitizerAllowStyle = (1 << 1);
michael@0: 
michael@0:   /**
michael@0:    * Flag for sanitizer: Only allow cid: URLs for embedded content.
michael@0:    *
michael@0:    * At present, sanitizing CSS backgrounds, etc., is not supported, so setting 
michael@0:    * this together with SanitizerAllowStyle doesn't make sense.
michael@0:    *
michael@0:    * At present, sanitizing CSS syntax in SVG presentational attributes is not
michael@0:    * supported, so this option flattens out SVG.
michael@0:    */
michael@0:   const unsigned long SanitizerCidEmbedsOnly = (1 << 2);
michael@0: 
michael@0:   /**
michael@0:    * Flag for sanitizer: Drop non-CSS presentational HTML elements and 
michael@0:    * attributes, such as <font>, <center> and bgcolor="".
michael@0:    */
michael@0:   const unsigned long SanitizerDropNonCSSPresentation = (1 << 3);
michael@0: 
michael@0:   /**
michael@0:    * Flag for sanitizer: Drop forms and form controls (excluding 
michael@0:    * fieldset/legend).
michael@0:    */
michael@0:   const unsigned long SanitizerDropForms = (1 << 4);
michael@0: 
michael@0:   /**
michael@0:    * Flag for sanitizer: Drop <img>, <video>, <audio> and <source> and flatten
michael@0:    * out SVG.
michael@0:    */
michael@0:   const unsigned long SanitizerDropMedia = (1 << 5);
michael@0: 
michael@0:   /**
michael@0:    * Parses a string into an HTML document, sanitizes the document and 
michael@0:    * returns the result serialized to a string.
michael@0:    *
michael@0:    * The sanitizer is designed to protect against XSS when sanitized content
michael@0:    * is inserted into a different-origin context without an iframe-equivalent
michael@0:    * sandboxing mechanism.
michael@0:    *
michael@0:    * By default, the sanitizer doesn't try to avoid leaking information that 
michael@0:    * the content was viewed to third parties. That is, by default, e.g. 
michael@0:    * <img src> pointing to an HTTP server potentially controlled by a third 
michael@0:    * party is not removed. To avoid ambient information leakage upon loading
michael@0:    * the sanitized content, use the SanitizerInternalEmbedsOnly flag. In that 
michael@0:    * case, <a href> links (and similar) to other content are preserved, so an
michael@0:    * explicit user action (following a link) after the content has been loaded
michael@0:    * can still leak information.
michael@0:    *
michael@0:    * By default, non-dangerous non-CSS presentational HTML elements and 
michael@0:    * attributes or forms are not removed. To remove these, use 
michael@0:    * SanitizerDropNonCSSPresentation and/or SanitizerDropForms.
michael@0:    *
michael@0:    * By default, comments and CSS is removed. To preserve comments, use
michael@0:    * SanitizerAllowComments. To preserve <style> and style="", use 
michael@0:    * SanitizerAllowStyle. -moz-binding is removed from <style> and style="" if
michael@0:    * present. In this case, properties that Gecko doesn't recognize can get 
michael@0:    * removed as a side effect. Note! If -moz-binding is not present, <style>
michael@0:    * and style="" and SanitizerAllowStyle is specified, the sanitized content
michael@0:    * may still be XSS dangerous if loaded into a non-Gecko Web engine!
michael@0:    *
michael@0:    * @param src the HTML source to parse (C++ callers are allowed but not
michael@0:    *            required to use the same string for the return value.)
michael@0:    * @param flags sanitization option flags defined above
michael@0:    */
michael@0:   AString sanitize(in AString src, in unsigned long flags);
michael@0: 
michael@0:   /**
michael@0:    * Convert HTML to plain text.
michael@0:    *
michael@0:    * @param src the HTML source to parse (C++ callers are allowed but not
michael@0:    *            required to use the same string for the return value.)
michael@0:    * @param flags conversion option flags defined in nsIDocumentEncoder
michael@0:    * @param wrapCol number of characters per line; 0 for no auto-wrapping
michael@0:    */
michael@0:   AString convertToPlainText(in AString src,
michael@0:                              in unsigned long flags,
michael@0:                              in unsigned long wrapCol);
michael@0: 
michael@0:   /**
michael@0:    * Parses markup into a sanitized document fragment.
michael@0:    *
michael@0:    * @param fragment the input markup
michael@0:    * @param flags sanitization option flags defined above
michael@0:    * @param isXML true if |fragment| is XML and false if HTML
michael@0:    * @param baseURI the base URL for this fragment
michael@0:    * @param element the context node for the fragment parsing algorithm
michael@0:    */
michael@0:   nsIDOMDocumentFragment parseFragment(in AString fragment,
michael@0:                                        in unsigned long flags,
michael@0:                                        in boolean isXML,
michael@0:                                        in nsIURI baseURI,
michael@0:                                        in nsIDOMElement element);
michael@0: 
michael@0: };
michael@0: 
michael@0: %{ C++
michael@0: #define NS_PARSERUTILS_CONTRACTID \
michael@0:     "@mozilla.org/parserutils;1"
michael@0: #define NS_PARSERUTILS_CID  \
michael@0: { 0xaf7b24cb, 0x893f, 0x41bb, { 0x96, 0x1f, 0x5a, 0x69, 0x38, 0x8e, 0x27, 0xc3 } }
michael@0: %}