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