56e675145e183addb1feba9f91d52728560c5dd2
[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 "CrossOriginAccessControl.h"
28 #include "Document.h"
29 #include "Element.h"
30 #include "Event.h"
31 #include "HTMLNames.h"
32 #include "HTMLObjectElement.h"
33 #include "HTMLParserIdioms.h"
34 #include "RenderImage.h"
35 #include "ScriptCallStack.h"
36 #include "SecurityOrigin.h"
37
38 #if ENABLE(SVG)
39 #include "RenderSVGImage.h"
40 #endif
41 #if ENABLE(VIDEO)
42 #include "RenderVideo.h"
43 #endif
44
45 #if !ASSERT_DISABLED
46 // ImageLoader objects are allocated as members of other objects, so generic pointer check would always fail.
47 namespace WTF {
48
49 template<> struct ValueCheck<WebCore::ImageLoader*> {
50     typedef WebCore::ImageLoader* TraitType;
51     static void checkConsistency(const WebCore::ImageLoader* p)
52     {
53         if (!p)
54             return;
55         ASSERT(p->element());
56         ValueCheck<WebCore::Element*>::checkConsistency(p->element());
57     }
58 };
59
60 }
61 #endif
62
63 namespace WebCore {
64
65 class ImageEventSender {
66     WTF_MAKE_NONCOPYABLE(ImageEventSender); WTF_MAKE_FAST_ALLOCATED;
67 public:
68     ImageEventSender(const AtomicString& eventType);
69
70     void dispatchEventSoon(ImageLoader*);
71     void cancelEvent(ImageLoader*);
72
73     void dispatchPendingEvents();
74
75 #ifndef NDEBUG
76     bool hasPendingEvents(ImageLoader* loader) const
77     {
78         return m_dispatchSoonList.find(loader) != notFound || m_dispatchingList.find(loader) != notFound;
79     }
80 #endif
81
82 private:
83     void timerFired(Timer<ImageEventSender>*);
84
85     AtomicString m_eventType;
86     Timer<ImageEventSender> m_timer;
87     Vector<ImageLoader*> m_dispatchSoonList;
88     Vector<ImageLoader*> m_dispatchingList;
89 };
90
91 static ImageEventSender& beforeLoadEventSender()
92 {
93     DEFINE_STATIC_LOCAL(ImageEventSender, sender, (eventNames().beforeloadEvent));
94     return sender;
95 }
96
97 static ImageEventSender& loadEventSender()
98 {
99     DEFINE_STATIC_LOCAL(ImageEventSender, sender, (eventNames().loadEvent));
100     return sender;
101 }
102
103 ImageLoader::ImageLoader(Element* element)
104     : m_element(element)
105     , m_image(0)
106     , m_firedBeforeLoad(true)
107     , m_firedLoad(true)
108     , m_imageComplete(true)
109     , m_loadManually(false)
110 {
111 }
112
113 ImageLoader::~ImageLoader()
114 {
115     if (m_image)
116         m_image->removeClient(this);
117
118     ASSERT(!m_firedBeforeLoad || !beforeLoadEventSender().hasPendingEvents(this));
119     if (!m_firedBeforeLoad)
120         beforeLoadEventSender().cancelEvent(this);
121
122     ASSERT(!m_firedLoad || !loadEventSender().hasPendingEvents(this));
123     if (!m_firedLoad)
124         loadEventSender().cancelEvent(this);
125 }
126
127 void ImageLoader::setImage(CachedImage* newImage)
128 {
129     ASSERT(m_failedLoadURL.isEmpty());
130     CachedImage* oldImage = m_image.get();
131     if (newImage != oldImage) {
132         m_image = newImage;
133         if (!m_firedBeforeLoad) {
134             beforeLoadEventSender().cancelEvent(this);
135             m_firedBeforeLoad = true;
136         }
137         if (!m_firedLoad) {
138             loadEventSender().cancelEvent(this);
139             m_firedLoad = true;
140         }
141         m_imageComplete = true;
142         if (newImage)
143             newImage->addClient(this);
144         if (oldImage)
145             oldImage->removeClient(this);
146     }
147
148     if (RenderImageResource* imageResource = renderImageResource())
149         imageResource->resetAnimation();
150 }
151
152 void ImageLoader::updateFromElement()
153 {
154     // If we're not making renderers for the page, then don't load images.  We don't want to slow
155     // down the raw HTML parsing case by loading images we don't intend to display.
156     Document* document = m_element->document();
157     if (!document->renderer())
158         return;
159
160     AtomicString attr = m_element->getAttribute(m_element->imageSourceAttributeName());
161
162     if (attr == m_failedLoadURL)
163         return;
164
165     // Do not load any image if the 'src' attribute is missing or if it is
166     // an empty string.
167     CachedImage* newImage = 0;
168     if (!attr.isNull() && !stripLeadingAndTrailingHTMLSpaces(attr).isEmpty()) {
169         ResourceRequest request = ResourceRequest(document->completeURL(sourceURI(attr)));
170
171         String crossOriginMode = m_element->fastGetAttribute(HTMLNames::crossoriginAttr);
172         if (!crossOriginMode.isNull()) {
173             StoredCredentials allowCredentials = equalIgnoringCase(crossOriginMode, "use-credentials") ? AllowStoredCredentials : DoNotAllowStoredCredentials;
174             updateRequestForAccessControl(request, document->securityOrigin(), allowCredentials);
175         }
176
177         if (m_loadManually) {
178             bool autoLoadOtherImages = document->cachedResourceLoader()->autoLoadImages();
179             document->cachedResourceLoader()->setAutoLoadImages(false);
180             newImage = new CachedImage(request);
181             newImage->setLoading(true);
182             newImage->setOwningCachedResourceLoader(document->cachedResourceLoader());
183             document->cachedResourceLoader()->m_documentResources.set(newImage->url(), newImage);
184             document->cachedResourceLoader()->setAutoLoadImages(autoLoadOtherImages);
185         } else
186             newImage = document->cachedResourceLoader()->requestImage(request);
187
188         // If we do not have an image here, it means that a cross-site
189         // violation occurred.
190         m_failedLoadURL = !newImage ? attr : AtomicString();
191     } else if (!attr.isNull()) // Fire an error event if the url is empty.
192         m_element->dispatchEvent(Event::create(eventNames().errorEvent, false, false));
193     
194     CachedImage* oldImage = m_image.get();
195     if (newImage != oldImage) {
196         if (!m_firedBeforeLoad)
197             beforeLoadEventSender().cancelEvent(this);
198         if (!m_firedLoad)
199             loadEventSender().cancelEvent(this);
200
201         m_image = newImage;
202         m_firedBeforeLoad = !newImage;
203         m_firedLoad = !newImage;
204         m_imageComplete = !newImage;
205
206         if (newImage) {
207             if (!m_element->document()->hasListenerType(Document::BEFORELOAD_LISTENER))
208                 dispatchPendingBeforeLoadEvent();
209             else
210                 beforeLoadEventSender().dispatchEventSoon(this);
211
212             // If newImage is cached, addClient() will result in the load event
213             // being queued to fire. Ensure this happens after beforeload is
214             // dispatched.
215             newImage->addClient(this);
216         }
217         if (oldImage)
218             oldImage->removeClient(this);
219     }
220
221     if (RenderImageResource* imageResource = renderImageResource())
222         imageResource->resetAnimation();
223 }
224
225 void ImageLoader::updateFromElementIgnoringPreviousError()
226 {
227     // Clear previous error.
228     m_failedLoadURL = AtomicString();
229     updateFromElement();
230 }
231
232 void ImageLoader::notifyFinished(CachedResource* resource)
233 {
234     ASSERT(m_failedLoadURL.isEmpty());
235     ASSERT(resource == m_image.get());
236
237     m_imageComplete = true;
238     if (haveFiredBeforeLoadEvent())
239         updateRenderer();
240
241     if (m_firedLoad)
242         return;
243
244     if (m_element->fastHasAttribute(HTMLNames::crossoriginAttr)
245         && !m_element->document()->securityOrigin()->canRequest(image()->response().url())
246         && !resource->passesAccessControlCheck(m_element->document()->securityOrigin())) {
247
248         setImage(0);
249
250         DEFINE_STATIC_LOCAL(String, consoleMessage, ("Cross-origin image load denied by Cross-Origin Resource Sharing policy."));
251         m_element->document()->addConsoleMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, consoleMessage);
252
253         ASSERT(m_firedLoad);
254         return;
255     }
256
257     if (resource->wasCanceled()) {
258         m_firedLoad = true;
259         return;
260     }
261
262     loadEventSender().dispatchEventSoon(this);
263 }
264
265 RenderImageResource* ImageLoader::renderImageResource()
266 {
267     RenderObject* renderer = m_element->renderer();
268
269     if (!renderer)
270         return 0;
271
272     // We don't return style generated image because it doesn't belong to the ImageLoader.
273     // See <https://bugs.webkit.org/show_bug.cgi?id=42840>
274     if (renderer->isImage() && !static_cast<RenderImage*>(renderer)->isGeneratedContent())
275         return toRenderImage(renderer)->imageResource();
276
277 #if ENABLE(SVG)
278     if (renderer->isSVGImage())
279         return toRenderSVGImage(renderer)->imageResource();
280 #endif
281
282 #if ENABLE(VIDEO)
283     if (renderer->isVideo())
284         return toRenderVideo(renderer)->imageResource();
285 #endif
286
287     return 0;
288 }
289
290 void ImageLoader::updateRenderer()
291 {
292     RenderImageResource* imageResource = renderImageResource();
293
294     if (!imageResource)
295         return;
296
297     // Only update the renderer if it doesn't have an image or if what we have
298     // is a complete image.  This prevents flickering in the case where a dynamic
299     // change is happening between two images.
300     CachedImage* cachedImage = imageResource->cachedImage();
301     if (m_image != cachedImage && (m_imageComplete || !cachedImage))
302         imageResource->setCachedImage(m_image.get());
303 }
304
305 void ImageLoader::dispatchPendingBeforeLoadEvent()
306 {
307     if (m_firedBeforeLoad)
308         return;
309     if (!m_image)
310         return;
311     if (!m_element->document()->attached())
312         return;
313     m_firedBeforeLoad = true;
314     if (m_element->dispatchBeforeLoadEvent(m_image->url())) {
315         updateRenderer();
316         return;
317     }
318     if (m_image) {
319         m_image->removeClient(this);
320         m_image = 0;
321     }
322
323     loadEventSender().cancelEvent(this);
324     m_firedLoad = true;
325     
326     if (m_element->hasTagName(HTMLNames::objectTag))
327         static_cast<HTMLObjectElement*>(m_element)->renderFallbackContent();
328 }
329
330 void ImageLoader::dispatchPendingLoadEvent()
331 {
332     if (m_firedLoad)
333         return;
334     if (!m_image)
335         return;
336     if (!m_element->document()->attached())
337         return;
338     m_firedLoad = true;
339     dispatchLoadEvent();
340 }
341
342 void ImageLoader::dispatchPendingBeforeLoadEvents()
343 {
344     beforeLoadEventSender().dispatchPendingEvents();
345 }
346
347 void ImageLoader::dispatchPendingLoadEvents()
348 {
349     loadEventSender().dispatchPendingEvents();
350 }
351
352 void ImageLoader::elementDidMoveToNewDocument()
353 {
354     setImage(0);
355 }
356
357 ImageEventSender::ImageEventSender(const AtomicString& eventType)
358     : m_eventType(eventType)
359     , m_timer(this, &ImageEventSender::timerFired)
360 {
361 }
362
363 void ImageEventSender::dispatchEventSoon(ImageLoader* loader)
364 {
365     m_dispatchSoonList.append(loader);
366     if (!m_timer.isActive())
367         m_timer.startOneShot(0);
368 }
369
370 void ImageEventSender::cancelEvent(ImageLoader* loader)
371 {
372     // Remove instances of this loader from both lists.
373     // Use loops because we allow multiple instances to get into the lists.
374     size_t size = m_dispatchSoonList.size();
375     for (size_t i = 0; i < size; ++i) {
376         if (m_dispatchSoonList[i] == loader)
377             m_dispatchSoonList[i] = 0;
378     }
379     size = m_dispatchingList.size();
380     for (size_t i = 0; i < size; ++i) {
381         if (m_dispatchingList[i] == loader)
382             m_dispatchingList[i] = 0;
383     }
384     if (m_dispatchSoonList.isEmpty())
385         m_timer.stop();
386 }
387
388 void ImageEventSender::dispatchPendingEvents()
389 {
390     // Need to avoid re-entering this function; if new dispatches are
391     // scheduled before the parent finishes processing the list, they
392     // will set a timer and eventually be processed.
393     if (!m_dispatchingList.isEmpty())
394         return;
395
396     m_timer.stop();
397
398     m_dispatchSoonList.checkConsistency();
399
400     m_dispatchingList.swap(m_dispatchSoonList);
401     size_t size = m_dispatchingList.size();
402     for (size_t i = 0; i < size; ++i) {
403         if (ImageLoader* loader = m_dispatchingList[i]) {
404             m_dispatchingList[i] = 0;
405             if (m_eventType == eventNames().beforeloadEvent)
406                 loader->dispatchPendingBeforeLoadEvent();
407             else
408                 loader->dispatchPendingLoadEvent();
409         }
410     }
411     m_dispatchingList.clear();
412 }
413
414 void ImageEventSender::timerFired(Timer<ImageEventSender>*)
415 {
416     dispatchPendingEvents();
417 }
418
419 }