SVG animations are not paused when inserted into a hidden page
[WebKit-https.git] / Source / WebCore / svg / SVGDocumentExtensions.cpp
1 /*
2  * Copyright (C) 2006 Apple Inc. All rights reserved.
3  * Copyright (C) 2006 Nikolas Zimmermann <zimmermann@kde.org>
4  * Copyright (C) 2007 Rob Buis <buis@kde.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 "SVGDocumentExtensions.h"
24
25 #include "DOMWindow.h"
26 #include "Document.h"
27 #include "EventListener.h"
28 #include "Frame.h"
29 #include "FrameLoader.h"
30 #include "Page.h"
31 #include "SMILTimeContainer.h"
32 #include "SVGElement.h"
33 #include "SVGResourcesCache.h"
34 #include "SVGSMILElement.h"
35 #include "SVGSVGElement.h"
36 #include "ScriptableDocumentParser.h"
37 #include "ShadowRoot.h"
38 #include "XLinkNames.h"
39 #include <wtf/text/AtomicString.h>
40
41 namespace WebCore {
42
43 SVGDocumentExtensions::SVGDocumentExtensions(Document& document)
44     : m_document(document)
45     , m_resourcesCache(std::make_unique<SVGResourcesCache>())
46     , m_areAnimationsPaused(!document.page() || !document.page()->isVisible())
47 {
48 }
49
50 SVGDocumentExtensions::~SVGDocumentExtensions()
51 {
52 }
53
54 void SVGDocumentExtensions::addTimeContainer(SVGSVGElement* element)
55 {
56     m_timeContainers.add(element);
57     if (m_areAnimationsPaused)
58         element->pauseAnimations();
59 }
60
61 void SVGDocumentExtensions::removeTimeContainer(SVGSVGElement* element)
62 {
63     m_timeContainers.remove(element);
64 }
65
66 void SVGDocumentExtensions::addResource(const AtomicString& id, RenderSVGResourceContainer* resource)
67 {
68     ASSERT(resource);
69
70     if (id.isEmpty())
71         return;
72
73     // Replaces resource if already present, to handle potential id changes
74     m_resources.set(id, resource);
75 }
76
77 void SVGDocumentExtensions::removeResource(const AtomicString& id)
78 {
79     if (id.isEmpty())
80         return;
81
82     m_resources.remove(id);
83 }
84
85 RenderSVGResourceContainer* SVGDocumentExtensions::resourceById(const AtomicString& id) const
86 {
87     if (id.isEmpty())
88         return 0;
89
90     return m_resources.get(id);
91 }
92
93 void SVGDocumentExtensions::startAnimations()
94 {
95     // FIXME: Eventually every "Time Container" will need a way to latch on to some global timer
96     // starting animations for a document will do this "latching"
97     // FIXME: We hold a ref pointers to prevent a shadow tree from getting removed out from underneath us.
98     // In the future we should refactor the use-element to avoid this. See https://webkit.org/b/53704
99     Vector<RefPtr<SVGSVGElement>> timeContainers;
100     timeContainers.appendRange(m_timeContainers.begin(), m_timeContainers.end());
101     for (auto& element : timeContainers)
102         element->timeContainer().begin();
103 }
104
105 void SVGDocumentExtensions::pauseAnimations()
106 {
107     for (auto& container : m_timeContainers)
108         container->pauseAnimations();
109     m_areAnimationsPaused = true;
110 }
111
112 void SVGDocumentExtensions::unpauseAnimations()
113 {
114     for (auto& container : m_timeContainers)
115         container->unpauseAnimations();
116     m_areAnimationsPaused = false;
117 }
118
119 void SVGDocumentExtensions::dispatchSVGLoadEventToOutermostSVGElements()
120 {
121     Vector<RefPtr<SVGSVGElement>> timeContainers;
122     timeContainers.appendRange(m_timeContainers.begin(), m_timeContainers.end());
123
124     for (auto& container : timeContainers) {
125         if (!container->isOutermostSVGSVGElement())
126             continue;
127         container->sendSVGLoadEventIfPossible();
128     }
129 }
130
131 static void reportMessage(Document& document, MessageLevel level, const String& message)
132 {
133     if (document.frame())
134         document.addConsoleMessage(MessageSource::Rendering, level, message);
135 }
136
137 void SVGDocumentExtensions::reportWarning(const String& message)
138 {
139     reportMessage(m_document, MessageLevel::Warning, "Warning: " + message);
140 }
141
142 void SVGDocumentExtensions::reportError(const String& message)
143 {
144     reportMessage(m_document, MessageLevel::Error, "Error: " + message);
145 }
146
147 void SVGDocumentExtensions::addPendingResource(const AtomicString& id, Element* element)
148 {
149     ASSERT(element);
150
151     if (id.isEmpty())
152         return;
153
154     auto result = m_pendingResources.add(id, nullptr);
155     if (result.isNewEntry)
156         result.iterator->value = std::make_unique<PendingElements>();
157     result.iterator->value->add(element);
158
159     element->setHasPendingResources();
160 }
161
162 bool SVGDocumentExtensions::isIdOfPendingResource(const AtomicString& id) const
163 {
164     if (id.isEmpty())
165         return false;
166
167     return m_pendingResources.contains(id);
168 }
169
170 bool SVGDocumentExtensions::isElementWithPendingResources(Element* element) const
171 {
172     // This algorithm takes time proportional to the number of pending resources and need not.
173     // If performance becomes an issue we can keep a counted set of elements and answer the question efficiently.
174     ASSERT(element);
175     for (auto& elements : m_pendingResources.values()) {
176         ASSERT(elements);
177
178         if (elements->contains(element))
179             return true;
180     }
181     return false;
182 }
183
184 bool SVGDocumentExtensions::isPendingResource(Element* element, const AtomicString& id) const
185 {
186     ASSERT(element);
187
188     if (!isIdOfPendingResource(id))
189         return false;
190
191     return m_pendingResources.get(id)->contains(element);
192 }
193
194 void SVGDocumentExtensions::clearHasPendingResourcesIfPossible(Element* element)
195 {
196     if (!isElementWithPendingResources(element))
197         element->clearHasPendingResources();
198 }
199
200 void SVGDocumentExtensions::removeElementFromPendingResources(Element* element)
201 {
202     ASSERT(element);
203
204     // Remove the element from pending resources.
205     if (!m_pendingResources.isEmpty() && element->hasPendingResources()) {
206         Vector<AtomicString> toBeRemoved;
207         for (auto& resource : m_pendingResources) {
208             PendingElements* elements = resource.value.get();
209             ASSERT(elements);
210             ASSERT(!elements->isEmpty());
211
212             elements->remove(element);
213             if (elements->isEmpty())
214                 toBeRemoved.append(resource.key);
215         }
216
217         clearHasPendingResourcesIfPossible(element);
218
219         // We use the removePendingResource function here because it deals with set lifetime correctly.
220         for (auto& resource : toBeRemoved)
221             removePendingResource(resource);
222     }
223
224     // Remove the element from pending resources that were scheduled for removal.
225     if (!m_pendingResourcesForRemoval.isEmpty()) {
226         Vector<AtomicString> toBeRemoved;
227         for (auto& resource : m_pendingResourcesForRemoval) {
228             PendingElements* elements = resource.value.get();
229             ASSERT(elements);
230             ASSERT(!elements->isEmpty());
231
232             elements->remove(element);
233             if (elements->isEmpty())
234                 toBeRemoved.append(resource.key);
235         }
236
237         // We use the removePendingResourceForRemoval function here because it deals with set lifetime correctly.
238         for (auto& resource : toBeRemoved)
239             removePendingResourceForRemoval(resource);
240     }
241 }
242
243 std::unique_ptr<SVGDocumentExtensions::PendingElements> SVGDocumentExtensions::removePendingResource(const AtomicString& id)
244 {
245     ASSERT(m_pendingResources.contains(id));
246     return m_pendingResources.take(id);
247 }
248
249 std::unique_ptr<SVGDocumentExtensions::PendingElements> SVGDocumentExtensions::removePendingResourceForRemoval(const AtomicString& id)
250 {
251     ASSERT(m_pendingResourcesForRemoval.contains(id));
252     return m_pendingResourcesForRemoval.take(id);
253 }
254
255 void SVGDocumentExtensions::markPendingResourcesForRemoval(const AtomicString& id)
256 {
257     if (id.isEmpty())
258         return;
259
260     ASSERT(!m_pendingResourcesForRemoval.contains(id));
261
262     std::unique_ptr<PendingElements> existing = m_pendingResources.take(id);
263     if (existing && !existing->isEmpty())
264         m_pendingResourcesForRemoval.add(id, WTFMove(existing));
265 }
266
267 Element* SVGDocumentExtensions::removeElementFromPendingResourcesForRemovalMap(const AtomicString& id)
268 {
269     if (id.isEmpty())
270         return 0;
271
272     PendingElements* resourceSet = m_pendingResourcesForRemoval.get(id);
273     if (!resourceSet || resourceSet->isEmpty())
274         return 0;
275
276     auto firstElement = resourceSet->begin();
277     Element* element = *firstElement;
278
279     resourceSet->remove(firstElement);
280
281     if (resourceSet->isEmpty())
282         removePendingResourceForRemoval(id);
283
284     return element;
285 }
286
287 HashSet<SVGElement*>* SVGDocumentExtensions::setOfElementsReferencingTarget(SVGElement* referencedElement) const
288 {
289     ASSERT(referencedElement);
290     const auto it = m_elementDependencies.find(referencedElement);
291     if (it == m_elementDependencies.end())
292         return 0;
293     return it->value.get();
294 }
295
296 void SVGDocumentExtensions::addElementReferencingTarget(SVGElement* referencingElement, SVGElement* referencedElement)
297 {
298     ASSERT(referencingElement);
299     ASSERT(referencedElement);
300
301     if (HashSet<SVGElement*>* elements = m_elementDependencies.get(referencedElement)) {
302         elements->add(referencingElement);
303         return;
304     }
305
306     auto elements = std::make_unique<HashSet<SVGElement*>>();
307     elements->add(referencingElement);
308     m_elementDependencies.set(referencedElement, WTFMove(elements));
309 }
310
311 void SVGDocumentExtensions::removeAllTargetReferencesForElement(SVGElement* referencingElement)
312 {
313     Vector<SVGElement*> toBeRemoved;
314
315     for (auto& dependency : m_elementDependencies) {
316         SVGElement* referencedElement = dependency.key;
317         HashSet<SVGElement*>& referencingElements = *dependency.value;
318         referencingElements.remove(referencingElement);
319         if (referencingElements.isEmpty())
320             toBeRemoved.append(referencedElement);
321     }
322
323     for (auto& element : toBeRemoved)
324         m_elementDependencies.remove(element);
325 }
326
327 void SVGDocumentExtensions::rebuildElements()
328 {
329     Vector<SVGElement*> shadowRebuildElements = WTFMove(m_rebuildElements);
330     for (auto* element : shadowRebuildElements)
331         element->svgAttributeChanged(XLinkNames::hrefAttr);
332 }
333
334 void SVGDocumentExtensions::clearTargetDependencies(SVGElement& referencedElement)
335 {
336     auto it = m_elementDependencies.find(&referencedElement);
337     if (it == m_elementDependencies.end())
338         return;
339     ASSERT(it->key == &referencedElement);
340     HashSet<SVGElement*>* referencingElements = it->value.get();
341     for (auto* element : *referencingElements) {
342         m_rebuildElements.append(element);
343         element->callClearTarget();
344     }
345 }
346
347 void SVGDocumentExtensions::rebuildAllElementReferencesForTarget(SVGElement& referencedElement)
348 {
349     auto it = m_elementDependencies.find(&referencedElement);
350     if (it == m_elementDependencies.end())
351         return;
352     ASSERT(it->key == &referencedElement);
353
354     HashSet<SVGElement*>* referencingElements = it->value.get();
355     Vector<SVGElement*> elementsToRebuild;
356     elementsToRebuild.reserveInitialCapacity(referencingElements->size());
357     for (auto* element : *referencingElements)
358         elementsToRebuild.uncheckedAppend(element);
359
360     for (auto* element : elementsToRebuild)
361         element->svgAttributeChanged(XLinkNames::hrefAttr);
362 }
363
364 void SVGDocumentExtensions::removeAllElementReferencesForTarget(SVGElement* referencedElement)
365 {
366     m_elementDependencies.remove(referencedElement);
367     m_rebuildElements.removeFirst(referencedElement);
368 }
369
370 #if ENABLE(SVG_FONTS)
371 void SVGDocumentExtensions::registerSVGFontFaceElement(SVGFontFaceElement* element)
372 {
373     m_svgFontFaceElements.add(element);
374 }
375
376 void SVGDocumentExtensions::unregisterSVGFontFaceElement(SVGFontFaceElement* element)
377 {
378     ASSERT(m_svgFontFaceElements.contains(element));
379     m_svgFontFaceElements.remove(element);
380 }
381 #endif
382
383 }