Prevent new loads while in PageCache (or being added to PageCache)
[WebKit-https.git] / Source / WebCore / loader / ImageLoader.cpp
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  * Copyright (C) 2004, 2005, 2006, 2007, 2009, 2010 Apple Inc. All rights reserved.
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 "ImageLoader.h"
24
25 #include "CachedImage.h"
26 #include "CachedResourceLoader.h"
27 #include "CachedResourceRequest.h"
28 #include "CrossOriginAccessControl.h"
29 #include "Document.h"
30 #include "Element.h"
31 #include "Event.h"
32 #include "EventSender.h"
33 #include "Frame.h"
34 #include "HTMLNames.h"
35 #include "HTMLObjectElement.h"
36 #include "HTMLParserIdioms.h"
37 #include "Page.h"
38 #include "RenderImage.h"
39 #include "RenderSVGImage.h"
40 #include "SecurityOrigin.h"
41 #include <wtf/NeverDestroyed.h>
42
43 #if ENABLE(VIDEO)
44 #include "RenderVideo.h"
45 #endif
46
47 #if !ASSERT_DISABLED
48 // ImageLoader objects are allocated as members of other objects, so generic pointer check would always fail.
49 namespace WTF {
50
51 template<> struct ValueCheck<WebCore::ImageLoader*> {
52     typedef WebCore::ImageLoader* TraitType;
53     static void checkConsistency(const WebCore::ImageLoader* p)
54     {
55         if (!p)
56             return;
57         ValueCheck<WebCore::Element*>::checkConsistency(&p->element());
58     }
59 };
60
61 }
62 #endif
63
64 namespace WebCore {
65
66 static ImageEventSender& beforeLoadEventSender()
67 {
68     static NeverDestroyed<ImageEventSender> sender(eventNames().beforeloadEvent);
69     return sender;
70 }
71
72 static ImageEventSender& loadEventSender()
73 {
74     static NeverDestroyed<ImageEventSender> sender(eventNames().loadEvent);
75     return sender;
76 }
77
78 static ImageEventSender& errorEventSender()
79 {
80     static NeverDestroyed<ImageEventSender> sender(eventNames().errorEvent);
81     return sender;
82 }
83
84 static inline bool pageIsBeingDismissed(Document& document)
85 {
86     Frame* frame = document.frame();
87     return frame && frame->loader().pageDismissalEventBeingDispatched() != FrameLoader::PageDismissalType::None;
88 }
89
90 ImageLoader::ImageLoader(Element& element)
91     : m_element(element)
92     , m_image(0)
93     , m_derefElementTimer(*this, &ImageLoader::timerFired)
94     , m_hasPendingBeforeLoadEvent(false)
95     , m_hasPendingLoadEvent(false)
96     , m_hasPendingErrorEvent(false)
97     , m_imageComplete(true)
98     , m_loadManually(false)
99     , m_elementIsProtected(false)
100 {
101 }
102
103 ImageLoader::~ImageLoader()
104 {
105     if (m_image)
106         m_image->removeClient(this);
107
108     ASSERT(m_hasPendingBeforeLoadEvent || !beforeLoadEventSender().hasPendingEvents(*this));
109     if (m_hasPendingBeforeLoadEvent)
110         beforeLoadEventSender().cancelEvent(*this);
111
112     ASSERT(m_hasPendingLoadEvent || !loadEventSender().hasPendingEvents(*this));
113     if (m_hasPendingLoadEvent)
114         loadEventSender().cancelEvent(*this);
115
116     ASSERT(m_hasPendingErrorEvent || !errorEventSender().hasPendingEvents(*this));
117     if (m_hasPendingErrorEvent)
118         errorEventSender().cancelEvent(*this);
119
120     // If the ImageLoader is being destroyed but it is still protecting its image-loading Element,
121     // remove that protection here.
122     if (m_elementIsProtected)
123         element().deref();
124 }
125
126 void ImageLoader::clearImage()
127 {
128     clearImageWithoutConsideringPendingLoadEvent();
129
130     // Only consider updating the protection ref-count of the Element immediately before returning
131     // from this function as doing so might result in the destruction of this ImageLoader.
132     updatedHasPendingEvent();
133 }
134
135 void ImageLoader::clearImageWithoutConsideringPendingLoadEvent()
136 {
137     ASSERT(m_failedLoadURL.isEmpty());
138     CachedImage* oldImage = m_image.get();
139     if (oldImage) {
140         m_image = nullptr;
141         if (m_hasPendingBeforeLoadEvent) {
142             beforeLoadEventSender().cancelEvent(*this);
143             m_hasPendingBeforeLoadEvent = false;
144         }
145         if (m_hasPendingLoadEvent) {
146             loadEventSender().cancelEvent(*this);
147             m_hasPendingLoadEvent = false;
148         }
149         if (m_hasPendingErrorEvent) {
150             errorEventSender().cancelEvent(*this);
151             m_hasPendingErrorEvent = false;
152         }
153         m_imageComplete = true;
154         if (oldImage)
155             oldImage->removeClient(this);
156     }
157
158     if (RenderImageResource* imageResource = renderImageResource())
159         imageResource->resetAnimation();
160 }
161
162 void ImageLoader::updateFromElement()
163 {
164     // If we're not making renderers for the page, then don't load images.  We don't want to slow
165     // down the raw HTML parsing case by loading images we don't intend to display.
166     Document& document = element().document();
167     if (!document.hasLivingRenderTree())
168         return;
169
170     AtomicString attr = element().imageSourceURL();
171
172     // Avoid loading a URL we already failed to load.
173     if (!m_failedLoadURL.isEmpty() && attr == m_failedLoadURL)
174         return;
175
176     // Do not load any image if the 'src' attribute is missing or if it is
177     // an empty string.
178     CachedResourceHandle<CachedImage> newImage = 0;
179     if (!attr.isNull() && !stripLeadingAndTrailingHTMLSpaces(attr).isEmpty()) {
180         CachedResourceRequest request(ResourceRequest(document.completeURL(sourceURI(attr))));
181         request.setInitiator(&element());
182
183         String crossOriginMode = element().fastGetAttribute(HTMLNames::crossoriginAttr);
184         if (!crossOriginMode.isNull()) {
185             StoredCredentials allowCredentials = equalIgnoringCase(crossOriginMode, "use-credentials") ? AllowStoredCredentials : DoNotAllowStoredCredentials;
186             updateRequestForAccessControl(request.mutableResourceRequest(), document.securityOrigin(), allowCredentials);
187         }
188
189         if (m_loadManually) {
190             bool autoLoadOtherImages = document.cachedResourceLoader().autoLoadImages();
191             document.cachedResourceLoader().setAutoLoadImages(false);
192             newImage = new CachedImage(request.resourceRequest(), m_element.document().page()->sessionID());
193             newImage->setLoading(true);
194             newImage->setOwningCachedResourceLoader(&document.cachedResourceLoader());
195             document.cachedResourceLoader().m_documentResources.set(newImage->url(), newImage.get());
196             document.cachedResourceLoader().setAutoLoadImages(autoLoadOtherImages);
197         } else
198             newImage = document.cachedResourceLoader().requestImage(request);
199
200         // If we do not have an image here, it means that a cross-site
201         // violation occurred, or that the image was blocked via Content
202         // Security Policy, or the page is being dismissed. Trigger an
203         // error event if the page is not being dismissed.
204         if (!newImage && !pageIsBeingDismissed(document)) {
205             m_failedLoadURL = attr;
206             m_hasPendingErrorEvent = true;
207             errorEventSender().dispatchEventSoon(*this);
208         } else
209             clearFailedLoadURL();
210     } else if (!attr.isNull()) {
211         // Fire an error event if the url is empty.
212         m_failedLoadURL = attr;
213         m_hasPendingErrorEvent = true;
214         errorEventSender().dispatchEventSoon(*this);
215     }
216     
217     CachedImage* oldImage = m_image.get();
218     if (newImage != oldImage) {
219         if (m_hasPendingBeforeLoadEvent) {
220             beforeLoadEventSender().cancelEvent(*this);
221             m_hasPendingBeforeLoadEvent = false;
222         }
223         if (m_hasPendingLoadEvent) {
224             loadEventSender().cancelEvent(*this);
225             m_hasPendingLoadEvent = false;
226         }
227
228         // Cancel error events that belong to the previous load, which is now cancelled by changing the src attribute.
229         // If newImage is null and m_hasPendingErrorEvent is true, we know the error event has been just posted by
230         // this load and we should not cancel the event.
231         // FIXME: If both previous load and this one got blocked with an error, we can receive one error event instead of two.
232         if (m_hasPendingErrorEvent && newImage) {
233             errorEventSender().cancelEvent(*this);
234             m_hasPendingErrorEvent = false;
235         }
236
237         m_image = newImage;
238         m_hasPendingBeforeLoadEvent = !document.isImageDocument() && newImage;
239         m_hasPendingLoadEvent = newImage;
240         m_imageComplete = !newImage;
241
242         if (newImage) {
243             if (!document.isImageDocument()) {
244                 if (!document.hasListenerType(Document::BEFORELOAD_LISTENER))
245                     dispatchPendingBeforeLoadEvent();
246                 else
247                     beforeLoadEventSender().dispatchEventSoon(*this);
248             } else
249                 updateRenderer();
250
251             // If newImage is cached, addClient() will result in the load event
252             // being queued to fire. Ensure this happens after beforeload is
253             // dispatched.
254             newImage->addClient(this);
255         }
256         if (oldImage) {
257             oldImage->removeClient(this);
258             updateRenderer();
259         }
260     }
261
262     if (RenderImageResource* imageResource = renderImageResource())
263         imageResource->resetAnimation();
264
265     // Only consider updating the protection ref-count of the Element immediately before returning
266     // from this function as doing so might result in the destruction of this ImageLoader.
267     updatedHasPendingEvent();
268 }
269
270 void ImageLoader::updateFromElementIgnoringPreviousError()
271 {
272     clearFailedLoadURL();
273     updateFromElement();
274 }
275
276 void ImageLoader::notifyFinished(CachedResource* resource)
277 {
278     ASSERT(m_failedLoadURL.isEmpty());
279     ASSERT(resource == m_image.get());
280
281     m_imageComplete = true;
282     if (!hasPendingBeforeLoadEvent())
283         updateRenderer();
284
285     if (!m_hasPendingLoadEvent)
286         return;
287
288     if (element().fastHasAttribute(HTMLNames::crossoriginAttr) && !resource->passesSameOriginPolicyCheck(*element().document().securityOrigin())) {
289         clearImageWithoutConsideringPendingLoadEvent();
290
291         m_hasPendingErrorEvent = true;
292         errorEventSender().dispatchEventSoon(*this);
293
294         DEPRECATED_DEFINE_STATIC_LOCAL(String, consoleMessage, (ASCIILiteral("Cross-origin image load denied by Cross-Origin Resource Sharing policy.")));
295         element().document().addConsoleMessage(MessageSource::Security, MessageLevel::Error, consoleMessage);
296
297         ASSERT(!m_hasPendingLoadEvent);
298
299         // Only consider updating the protection ref-count of the Element immediately before returning
300         // from this function as doing so might result in the destruction of this ImageLoader.
301         updatedHasPendingEvent();
302         return;
303     }
304
305     if (resource->wasCanceled()) {
306         m_hasPendingLoadEvent = false;
307         // Only consider updating the protection ref-count of the Element immediately before returning
308         // from this function as doing so might result in the destruction of this ImageLoader.
309         updatedHasPendingEvent();
310         return;
311     }
312
313     loadEventSender().dispatchEventSoon(*this);
314 }
315
316 RenderImageResource* ImageLoader::renderImageResource()
317 {
318     auto* renderer = element().renderer();
319     if (!renderer)
320         return nullptr;
321
322     // We don't return style generated image because it doesn't belong to the ImageLoader.
323     // See <https://bugs.webkit.org/show_bug.cgi?id=42840>
324     if (is<RenderImage>(*renderer) && !downcast<RenderImage>(*renderer).isGeneratedContent())
325         return &downcast<RenderImage>(*renderer).imageResource();
326
327     if (is<RenderSVGImage>(*renderer))
328         return &downcast<RenderSVGImage>(*renderer).imageResource();
329
330 #if ENABLE(VIDEO)
331     if (is<RenderVideo>(*renderer))
332         return &downcast<RenderVideo>(*renderer).imageResource();
333 #endif
334
335     return nullptr;
336 }
337
338 void ImageLoader::updateRenderer()
339 {
340     RenderImageResource* imageResource = renderImageResource();
341
342     if (!imageResource)
343         return;
344
345     // Only update the renderer if it doesn't have an image or if what we have
346     // is a complete image.  This prevents flickering in the case where a dynamic
347     // change is happening between two images.
348     CachedImage* cachedImage = imageResource->cachedImage();
349     if (m_image != cachedImage && (m_imageComplete || !cachedImage))
350         imageResource->setCachedImage(m_image.get());
351 }
352
353 void ImageLoader::updatedHasPendingEvent()
354 {
355     // If an Element that does image loading is removed from the DOM the load/error event for the image is still observable.
356     // As long as the ImageLoader is actively loading, the Element itself needs to be ref'ed to keep it from being
357     // destroyed by DOM manipulation or garbage collection.
358     // If such an Element wishes for the load to stop when removed from the DOM it needs to stop the ImageLoader explicitly.
359     bool wasProtected = m_elementIsProtected;
360     m_elementIsProtected = m_hasPendingLoadEvent || m_hasPendingErrorEvent;
361     if (wasProtected == m_elementIsProtected)
362         return;
363
364     if (m_elementIsProtected) {
365         if (m_derefElementTimer.isActive())
366             m_derefElementTimer.stop();
367         else
368             element().ref();
369     } else {
370         ASSERT(!m_derefElementTimer.isActive());
371         m_derefElementTimer.startOneShot(0);
372     }   
373 }
374
375 void ImageLoader::timerFired()
376 {
377     element().deref();
378 }
379
380 void ImageLoader::dispatchPendingEvent(ImageEventSender* eventSender)
381 {
382     ASSERT(eventSender == &beforeLoadEventSender() || eventSender == &loadEventSender() || eventSender == &errorEventSender());
383     const AtomicString& eventType = eventSender->eventType();
384     if (eventType == eventNames().beforeloadEvent)
385         dispatchPendingBeforeLoadEvent();
386     if (eventType == eventNames().loadEvent)
387         dispatchPendingLoadEvent();
388     if (eventType == eventNames().errorEvent)
389         dispatchPendingErrorEvent();
390 }
391
392 void ImageLoader::dispatchPendingBeforeLoadEvent()
393 {
394     if (!m_hasPendingBeforeLoadEvent)
395         return;
396     if (!m_image)
397         return;
398     if (!element().document().hasLivingRenderTree())
399         return;
400     m_hasPendingBeforeLoadEvent = false;
401     if (element().dispatchBeforeLoadEvent(m_image->url())) {
402         updateRenderer();
403         return;
404     }
405     if (m_image) {
406         m_image->removeClient(this);
407         m_image = nullptr;
408     }
409
410     loadEventSender().cancelEvent(*this);
411     m_hasPendingLoadEvent = false;
412     
413     if (is<HTMLObjectElement>(element()))
414         downcast<HTMLObjectElement>(element()).renderFallbackContent();
415
416     // Only consider updating the protection ref-count of the Element immediately before returning
417     // from this function as doing so might result in the destruction of this ImageLoader.
418     updatedHasPendingEvent();
419 }
420
421 void ImageLoader::dispatchPendingLoadEvent()
422 {
423     if (!m_hasPendingLoadEvent)
424         return;
425     if (!m_image)
426         return;
427     m_hasPendingLoadEvent = false;
428     if (element().document().hasLivingRenderTree())
429         dispatchLoadEvent();
430
431     // Only consider updating the protection ref-count of the Element immediately before returning
432     // from this function as doing so might result in the destruction of this ImageLoader.
433     updatedHasPendingEvent();
434 }
435
436 void ImageLoader::dispatchPendingErrorEvent()
437 {
438     if (!m_hasPendingErrorEvent)
439         return;
440     m_hasPendingErrorEvent = false;
441     if (element().document().hasLivingRenderTree())
442         element().dispatchEvent(Event::create(eventNames().errorEvent, false, false));
443
444     // Only consider updating the protection ref-count of the Element immediately before returning
445     // from this function as doing so might result in the destruction of this ImageLoader.
446     updatedHasPendingEvent();
447 }
448
449 void ImageLoader::dispatchPendingBeforeLoadEvents()
450 {
451     beforeLoadEventSender().dispatchPendingEvents();
452 }
453
454 void ImageLoader::dispatchPendingLoadEvents()
455 {
456     loadEventSender().dispatchPendingEvents();
457 }
458
459 void ImageLoader::dispatchPendingErrorEvents()
460 {
461     errorEventSender().dispatchPendingEvents();
462 }
463
464 void ImageLoader::elementDidMoveToNewDocument()
465 {
466     clearFailedLoadURL();
467     clearImage();
468 }
469
470 inline void ImageLoader::clearFailedLoadURL()
471 {
472     m_failedLoadURL = AtomicString();
473 }
474
475 }