CachedResource client handling methods should take reference
[WebKit-https.git] / Source / WebCore / svg / SVGFEImageElement.cpp
1 /*
2  * Copyright (C) 2004, 2005, 2007 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005 Rob Buis <buis@kde.org>
4  * Copyright (C) 2010 Dirk Schulze <krit@webkit.org>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #include "config.h"
23 #include "SVGFEImageElement.h"
24
25 #include "CachedImage.h"
26 #include "CachedResourceLoader.h"
27 #include "CachedResourceRequest.h"
28 #include "ColorSpace.h"
29 #include "Document.h"
30 #include "Image.h"
31 #include "RenderObject.h"
32 #include "RenderSVGResource.h"
33 #include "SVGNames.h"
34 #include "SVGPreserveAspectRatio.h"
35 #include "XLinkNames.h"
36
37 namespace WebCore {
38
39 // Animated property definitions
40 DEFINE_ANIMATED_PRESERVEASPECTRATIO(SVGFEImageElement, SVGNames::preserveAspectRatioAttr, PreserveAspectRatio, preserveAspectRatio)
41 DEFINE_ANIMATED_STRING(SVGFEImageElement, XLinkNames::hrefAttr, Href, href)
42 DEFINE_ANIMATED_BOOLEAN(SVGFEImageElement, SVGNames::externalResourcesRequiredAttr, ExternalResourcesRequired, externalResourcesRequired)
43
44 BEGIN_REGISTER_ANIMATED_PROPERTIES(SVGFEImageElement)
45     REGISTER_LOCAL_ANIMATED_PROPERTY(preserveAspectRatio)
46     REGISTER_LOCAL_ANIMATED_PROPERTY(href)
47     REGISTER_LOCAL_ANIMATED_PROPERTY(externalResourcesRequired)
48     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGFilterPrimitiveStandardAttributes)
49 END_REGISTER_ANIMATED_PROPERTIES
50
51 inline SVGFEImageElement::SVGFEImageElement(const QualifiedName& tagName, Document& document)
52     : SVGFilterPrimitiveStandardAttributes(tagName, document)
53 {
54     ASSERT(hasTagName(SVGNames::feImageTag));
55     registerAnimatedPropertiesForSVGFEImageElement();
56 }
57
58 Ref<SVGFEImageElement> SVGFEImageElement::create(const QualifiedName& tagName, Document& document)
59 {
60     return adoptRef(*new SVGFEImageElement(tagName, document));
61 }
62
63 SVGFEImageElement::~SVGFEImageElement()
64 {
65     clearResourceReferences();
66 }
67
68 bool SVGFEImageElement::hasSingleSecurityOrigin() const
69 {
70     if (!m_cachedImage)
71         return true;
72     auto* image = m_cachedImage->image();
73     return !image || image->hasSingleSecurityOrigin();
74 }
75
76 void SVGFEImageElement::clearResourceReferences()
77 {
78     if (m_cachedImage) {
79         m_cachedImage->removeClient(*this);
80         m_cachedImage = nullptr;
81     }
82
83     document().accessSVGExtensions().removeAllTargetReferencesForElement(this);
84 }
85
86 void SVGFEImageElement::requestImageResource()
87 {
88     ResourceLoaderOptions options = CachedResourceLoader::defaultCachedResourceOptions();
89     options.contentSecurityPolicyImposition = isInUserAgentShadowTree() ? ContentSecurityPolicyImposition::SkipPolicyCheck : ContentSecurityPolicyImposition::DoPolicyCheck;
90
91     CachedResourceRequest request(ResourceRequest(document().completeURL(href())), options);
92     request.setInitiator(this);
93     m_cachedImage = document().cachedResourceLoader().requestImage(WTFMove(request));
94
95     if (m_cachedImage)
96         m_cachedImage->addClient(*this);
97 }
98
99 void SVGFEImageElement::buildPendingResource()
100 {
101     clearResourceReferences();
102     if (!inDocument())
103         return;
104
105     String id;
106     Element* target = SVGURIReference::targetElementFromIRIString(href(), document(), &id);
107     if (!target) {
108         if (id.isEmpty())
109             requestImageResource();
110         else {
111             document().accessSVGExtensions().addPendingResource(id, this);
112             ASSERT(hasPendingResources());
113         }
114     } else if (target->isSVGElement()) {
115         // Register us with the target in the dependencies map. Any change of hrefElement
116         // that leads to relayout/repainting now informs us, so we can react to it.
117         document().accessSVGExtensions().addElementReferencingTarget(this, downcast<SVGElement>(target));
118     }
119
120     invalidate();
121 }
122
123 void SVGFEImageElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
124 {
125     if (name == SVGNames::preserveAspectRatioAttr) {
126         SVGPreserveAspectRatio preserveAspectRatio;
127         preserveAspectRatio.parse(value);
128         setPreserveAspectRatioBaseValue(preserveAspectRatio);
129         return;
130     }
131
132     SVGFilterPrimitiveStandardAttributes::parseAttribute(name, value);
133     SVGURIReference::parseAttribute(name, value);
134     SVGExternalResourcesRequired::parseAttribute(name, value);
135 }
136
137 void SVGFEImageElement::svgAttributeChanged(const QualifiedName& attrName)
138 {
139     if (attrName == SVGNames::preserveAspectRatioAttr) {
140         InstanceInvalidationGuard guard(*this);
141         invalidate();
142         return;
143     }
144
145     if (SVGURIReference::isKnownAttribute(attrName)) {
146         InstanceInvalidationGuard guard(*this);
147         buildPendingResource();
148         return;
149     }
150
151     SVGFilterPrimitiveStandardAttributes::svgAttributeChanged(attrName);
152 }
153
154 Node::InsertionNotificationRequest SVGFEImageElement::insertedInto(ContainerNode& rootParent)
155 {
156     SVGFilterPrimitiveStandardAttributes::insertedInto(rootParent);
157     return InsertionShouldCallFinishedInsertingSubtree;
158 }
159
160 void SVGFEImageElement::finishedInsertingSubtree()
161 {
162     buildPendingResource();
163 }
164
165 void SVGFEImageElement::removedFrom(ContainerNode& rootParent)
166 {
167     SVGFilterPrimitiveStandardAttributes::removedFrom(rootParent);
168     if (rootParent.inDocument())
169         clearResourceReferences();
170 }
171
172 void SVGFEImageElement::notifyFinished(CachedResource*)
173 {
174     if (!inDocument())
175         return;
176
177     Element* parent = parentElement();
178
179     if (!parent || !parent->hasTagName(SVGNames::filterTag))
180         return;
181
182     RenderElement* parentRenderer = parent->renderer();
183     if (!parentRenderer)
184         return;
185
186     RenderSVGResource::markForLayoutAndParentResourceInvalidation(*parentRenderer);
187 }
188
189 RefPtr<FilterEffect> SVGFEImageElement::build(SVGFilterBuilder*, Filter& filter)
190 {
191     if (m_cachedImage)
192         return FEImage::createWithImage(filter, m_cachedImage->imageForRenderer(renderer()), preserveAspectRatio());
193     return FEImage::createWithIRIReference(filter, document(), href(), preserveAspectRatio());
194 }
195
196 void SVGFEImageElement::addSubresourceAttributeURLs(ListHashSet<URL>& urls) const
197 {
198     SVGFilterPrimitiveStandardAttributes::addSubresourceAttributeURLs(urls);
199
200     addSubresourceURL(urls, document().completeURL(href()));
201 }
202
203 }