/* -*- 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/. */ #include "mozilla/dom/SVGUseElement.h" #include "mozilla/ArrayUtils.h" #include "mozilla/ErrorResult.h" #include "mozilla/ScopeExit.h" #include "mozilla/StaticPrefs_svg.h" #include "mozilla/SVGObserverUtils.h" #include "mozilla/SVGUseFrame.h" #include "mozilla/URLExtraData.h" #include "mozilla/dom/Document.h" #include "mozilla/dom/Element.h" #include "mozilla/dom/ShadowIncludingTreeIterator.h" #include "mozilla/dom/SVGLengthBinding.h" #include "mozilla/dom/SVGSVGElement.h" #include "mozilla/dom/SVGUseElementBinding.h" #include "nsGkAtoms.h" #include "nsContentUtils.h" #include "nsIURI.h" #include "SVGGeometryProperty.h" NS_IMPL_NS_NEW_SVG_ELEMENT(Use) namespace mozilla::dom { JSObject* SVGUseElement::WrapNode(JSContext* aCx, JS::Handle aGivenProto) { return SVGUseElement_Binding::Wrap(aCx, this, aGivenProto); } //////////////////////////////////////////////////////////////////////// // implementation SVGElement::LengthInfo SVGUseElement::sLengthInfo[4] = { {nsGkAtoms::x, 0, SVGLength_Binding::SVG_LENGTHTYPE_NUMBER, SVGContentUtils::X}, {nsGkAtoms::y, 0, SVGLength_Binding::SVG_LENGTHTYPE_NUMBER, SVGContentUtils::Y}, {nsGkAtoms::width, 0, SVGLength_Binding::SVG_LENGTHTYPE_NUMBER, SVGContentUtils::X}, {nsGkAtoms::height, 0, SVGLength_Binding::SVG_LENGTHTYPE_NUMBER, SVGContentUtils::Y}, }; SVGElement::StringInfo SVGUseElement::sStringInfo[2] = { {nsGkAtoms::href, kNameSpaceID_None, true}, {nsGkAtoms::href, kNameSpaceID_XLink, true}}; //---------------------------------------------------------------------- // nsISupports methods NS_IMPL_CYCLE_COLLECTION_CLASS(SVGUseElement) NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN_INHERITED(SVGUseElement, SVGUseElementBase) nsAutoScriptBlocker scriptBlocker; NS_IMPL_CYCLE_COLLECTION_UNLINK(mOriginal) tmp->UnlinkSource(); NS_IMPL_CYCLE_COLLECTION_UNLINK_END NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INHERITED(SVGUseElement, SVGUseElementBase) NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mOriginal) tmp->mReferencedElementTracker.Traverse(&cb); NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END NS_IMPL_ISUPPORTS_CYCLE_COLLECTION_INHERITED(SVGUseElement, SVGUseElementBase, nsIMutationObserver) //---------------------------------------------------------------------- // Implementation SVGUseElement::SVGUseElement( already_AddRefed&& aNodeInfo) : SVGUseElementBase(std::move(aNodeInfo)), mReferencedElementTracker(this) {} SVGUseElement::~SVGUseElement() { UnlinkSource(); MOZ_DIAGNOSTIC_ASSERT(!OwnerDoc()->SVGUseElementNeedsShadowTreeUpdate(*this), "Dying without unbinding?"); } namespace SVGT = SVGGeometryProperty::Tags; //---------------------------------------------------------------------- // nsINode methods bool SVGUseElement::IsNodeOfType(uint32_t aFlags) const { return !(aFlags & ~eUSE_TARGET); } void SVGUseElement::ProcessAttributeChange(int32_t aNamespaceID, nsAtom* aAttribute) { if (aNamespaceID == kNameSpaceID_None) { if (aAttribute == nsGkAtoms::width || aAttribute == nsGkAtoms::height) { const bool hadValidDimensions = HasValidDimensions(); const bool isUsed = OurWidthAndHeightAreUsed(); if (isUsed) { SyncWidthOrHeight(aAttribute); } if (auto* frame = GetFrame()) { frame->DimensionAttributeChanged(hadValidDimensions, isUsed); } } } if ((aNamespaceID == kNameSpaceID_XLink || aNamespaceID == kNameSpaceID_None) && aAttribute == nsGkAtoms::href) { // We're changing our nature, clear out the clone information. if (auto* frame = GetFrame()) { frame->HrefChanged(); } mOriginal = nullptr; UnlinkSource(); TriggerReclone(); } } nsresult SVGUseElement::AfterSetAttr(int32_t aNamespaceID, nsAtom* aAttribute, const nsAttrValue* aValue, const nsAttrValue* aOldValue, nsIPrincipal* aSubjectPrincipal, bool aNotify) { ProcessAttributeChange(aNamespaceID, aAttribute); return SVGUseElementBase::AfterSetAttr(aNamespaceID, aAttribute, aValue, aOldValue, aSubjectPrincipal, aNotify); } nsresult SVGUseElement::Clone(dom::NodeInfo* aNodeInfo, nsINode** aResult) const { *aResult = nullptr; SVGUseElement* it = new (aNodeInfo->NodeInfoManager()) SVGUseElement(do_AddRef(aNodeInfo)); nsCOMPtr kungFuDeathGrip(it); nsresult rv1 = it->Init(); nsresult rv2 = const_cast(this)->CopyInnerTo(it); // SVGUseElement specific portion - record who we cloned from it->mOriginal = const_cast(this); if (NS_SUCCEEDED(rv1) && NS_SUCCEEDED(rv2)) { kungFuDeathGrip.swap(*aResult); } return NS_FAILED(rv1) ? rv1 : rv2; } nsresult SVGUseElement::BindToTree(BindContext& aContext, nsINode& aParent) { nsresult rv = SVGUseElementBase::BindToTree(aContext, aParent); NS_ENSURE_SUCCESS(rv, rv); TriggerReclone(); return NS_OK; } void SVGUseElement::UnbindFromTree(bool aNullParent) { SVGUseElementBase::UnbindFromTree(aNullParent); OwnerDoc()->UnscheduleSVGUseElementShadowTreeUpdate(*this); } already_AddRefed SVGUseElement::Href() { return mStringAttributes[HREF].IsExplicitlySet() ? mStringAttributes[HREF].ToDOMAnimatedString(this) : mStringAttributes[XLINK_HREF].ToDOMAnimatedString(this); } //---------------------------------------------------------------------- already_AddRefed SVGUseElement::X() { return mLengthAttributes[ATTR_X].ToDOMAnimatedLength(this); } already_AddRefed SVGUseElement::Y() { return mLengthAttributes[ATTR_Y].ToDOMAnimatedLength(this); } already_AddRefed SVGUseElement::Width() { return mLengthAttributes[ATTR_WIDTH].ToDOMAnimatedLength(this); } already_AddRefed SVGUseElement::Height() { return mLengthAttributes[ATTR_HEIGHT].ToDOMAnimatedLength(this); } //---------------------------------------------------------------------- // nsIMutationObserver methods void SVGUseElement::CharacterDataChanged(nsIContent* aContent, const CharacterDataChangeInfo&) { if (nsContentUtils::IsInSameAnonymousTree(mReferencedElementTracker.get(), aContent)) { TriggerReclone(); } } void SVGUseElement::AttributeChanged(Element* aElement, int32_t aNamespaceID, nsAtom* aAttribute, int32_t aModType, const nsAttrValue* aOldValue) { if (nsContentUtils::IsInSameAnonymousTree(mReferencedElementTracker.get(), aElement)) { TriggerReclone(); } } void SVGUseElement::ContentAppended(nsIContent* aFirstNewContent) { // FIXME(emilio, bug 1442336): Why does this check the parent but // ContentInserted the child? if (nsContentUtils::IsInSameAnonymousTree(mReferencedElementTracker.get(), aFirstNewContent->GetParent())) { TriggerReclone(); } } void SVGUseElement::ContentInserted(nsIContent* aChild) { // FIXME(emilio, bug 1442336): Why does this check the child but // ContentAppended the parent? if (nsContentUtils::IsInSameAnonymousTree(mReferencedElementTracker.get(), aChild)) { TriggerReclone(); } } void SVGUseElement::ContentRemoved(nsIContent* aChild, nsIContent* aPreviousSibling) { if (nsContentUtils::IsInSameAnonymousTree(mReferencedElementTracker.get(), aChild)) { TriggerReclone(); } } void SVGUseElement::NodeWillBeDestroyed(nsINode* aNode) { nsCOMPtr kungFuDeathGrip(this); UnlinkSource(); } // Returns whether this node could ever be displayed. static bool NodeCouldBeRendered(const nsINode& aNode) { if (aNode.IsSVGElement(nsGkAtoms::symbol)) { // Only elements in the root of a shadow tree are // displayed. auto* shadowRoot = ShadowRoot::FromNodeOrNull(aNode.GetParentNode()); return shadowRoot && shadowRoot->Host()->IsSVGElement(nsGkAtoms::use); } // TODO: Do we have other cases we can optimize out easily? return true; } // Circular loop detection, plus detection of whether this shadow tree is // rendered at all. auto SVGUseElement::ScanAncestors(const Element& aTarget) const -> ScanResult { if (&aTarget == this) { return ScanResult::CyclicReference; } if (mOriginal && mOriginal->ScanAncestors(aTarget) == ScanResult::CyclicReference) { return ScanResult::CyclicReference; } auto result = ScanResult::Ok; for (nsINode* parent = GetParentOrShadowHostNode(); parent; parent = parent->GetParentOrShadowHostNode()) { if (parent == &aTarget) { return ScanResult::CyclicReference; } if (auto* use = SVGUseElement::FromNode(*parent)) { if (mOriginal && use->mOriginal == mOriginal) { return ScanResult::CyclicReference; } } // Do we have other similar cases we can optimize out easily? if (!NodeCouldBeRendered(*parent)) { // NOTE(emilio): We can't just return here. If we're cyclic, we need to // know. result = ScanResult::Invisible; } } return result; } //---------------------------------------------------------------------- static bool IsForbiddenUseNode(const nsINode& aNode) { if (!aNode.IsElement()) { return false; } const auto* svg = SVGElement::FromNode(aNode); return !svg || !svg->IsSVGGraphicsElement(); } static void CollectForbiddenNodes(Element& aRoot, nsTArray>& aNodes) { auto iter = dom::ShadowIncludingTreeIterator(aRoot); while (iter) { nsINode* node = *iter; if (IsForbiddenUseNode(*node)) { aNodes.AppendElement(node); iter.SkipChildren(); continue; } ++iter; } } // SVG1 restricted trees to SVGGraphicsElements. // https://www.w3.org/TR/SVG11/struct.html#UseElement: // // Any ‘svg’, ‘symbol’, ‘g’, graphics element or other ‘use’ is potentially a // template object that can be re-used (i.e., "instanced") in the SVG // document via a ‘use’ element. The ‘use’ element references another element // and indicates that the graphical contents of that element is // included/drawn at that given point in the document. // // SVG2 doesn't have that same restriction. // https://www.w3.org/TR/SVG2/struct.html#UseShadowTree: // // Previous versions of SVG restricted the contents of the shadow tree to SVG // graphics elements. This specification allows any valid SVG document // subtree to be cloned. Cloning non-graphical content, however, will not // usually have any visible effect. // // But it's pretty ambiguous as to what the behavior should be for some // elements, because