Source code

Revision control

Other Tools

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_dom_Sanitizer_h
#define mozilla_dom_Sanitizer_h
#include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/dom/DocumentFragment.h"
#include "mozilla/dom/SanitizerBinding.h"
#include "nsString.h"
#include "nsIGlobalObject.h"
#include "nsIParserUtils.h"
#include "nsTreeSanitizer.h"
// XXX(Bug 1673929) This is not really needed here, but the generated
// SanitizerBinding.cpp needs it and does not include it.
#include "mozilla/dom/Document.h"
class nsISupports;
namespace mozilla {
class ErrorResult;
namespace dom {
class GlobalObject;
class Sanitizer final : public nsISupports, public nsWrapperCache {
public:
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(Sanitizer);
explicit Sanitizer(nsIGlobalObject* aGlobal, const SanitizerConfig& aOptions)
: mGlobal(aGlobal), mTreeSanitizer(nsIParserUtils::SanitizerAllowStyle) {
MOZ_ASSERT(aGlobal);
mTreeSanitizer.WithWebSanitizerOptions(aOptions);
}
nsIGlobalObject* GetParentObject() const { return mGlobal; }
JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
/**
* Sanitizer() WebIDL constructor
* @return a new Sanitizer object, with methods as below
*/
static already_AddRefed<Sanitizer> Constructor(
const GlobalObject& aGlobal, const SanitizerConfig& aOptions,
ErrorResult& aRv);
/**
* sanitize WebIDL method.
* @param aInput "bad" HTML that needs to be sanitized
* @return DocumentFragment of the sanitized HTML
*/
already_AddRefed<DocumentFragment> Sanitize(
const mozilla::dom::DocumentFragmentOrDocument& aInput, ErrorResult& aRv);
/**
* sanitizeFor method.
* @param aElement name of HTML element to be constructed
* @param aInput "bad" HTML that needs to be sanitized
* @return DocumentFragment of the sanitized HTML
*/
already_AddRefed<Element> SanitizeFor(const nsAString& aElement,
const nsAString& aInput,
ErrorResult& aRv);
/**
* Sanitizes a fragment in place. This assumes that the fragment
* belongs but an inert document.
*
* @param aFragment Fragment to be sanitized in place
* @return DocumentFragment
*/
RefPtr<DocumentFragment> SanitizeFragment(RefPtr<DocumentFragment> aFragment,
ErrorResult& aRv);
/**
* Logs localized message to either content console or browser console
* @param aName Localization key
* @param aParams Localization parameters
* @param aFlags Logging Flag (see nsIScriptError)
*/
void LogLocalizedString(const char* aName, const nsTArray<nsString>& aParams,
uint32_t aFlags);
private:
~Sanitizer() = default;
already_AddRefed<DocumentFragment> InputToNewFragment(
const mozilla::dom::DocumentFragmentOrDocument& aInput, ErrorResult& aRv);
/**
* Logs localized message to either content console or browser console
* @param aMessage Message to log
* @param aFlags Logging Flag (see nsIScriptError)
* @param aInnerWindowID Inner Window ID (Logged on browser console if 0)
* @param aFromPrivateWindow If from private window
*/
static void LogMessage(const nsAString& aMessage, uint32_t aFlags,
uint64_t aInnerWindowID, bool aFromPrivateWindow);
RefPtr<nsIGlobalObject> mGlobal;
SanitizerConfig mOptions;
nsTreeSanitizer mTreeSanitizer;
};
} // namespace dom
} // namespace mozilla
#endif // ifndef mozilla_dom_Sanitizer_h