2008-10-22 Cameron Zwarich <zwarich@apple.com>
[WebKit-https.git] / WebCore / loader / CachedImage.cpp
1 /*
2     Copyright (C) 1998 Lars Knoll (knoll@mpi-hd.mpg.de)
3     Copyright (C) 2001 Dirk Mueller (mueller@kde.org)
4     Copyright (C) 2002 Waldo Bastian (bastian@kde.org)
5     Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
6     Copyright (C) 2004, 2005, 2006, 2007 Apple Inc. All rights reserved.
7
8     This library is free software; you can redistribute it and/or
9     modify it under the terms of the GNU Library General Public
10     License as published by the Free Software Foundation; either
11     version 2 of the License, or (at your option) any later version.
12
13     This library is distributed in the hope that it will be useful,
14     but WITHOUT ANY WARRANTY; without even the implied warranty of
15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16     Library General Public License for more details.
17
18     You should have received a copy of the GNU Library General Public License
19     along with this library; see the file COPYING.LIB.  If not, write to
20     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21     Boston, MA 02110-1301, USA.
22 */
23
24 #include "config.h"
25 #include "CachedImage.h"
26
27 #include "BitmapImage.h"
28 #include "Cache.h"
29 #include "CachedResourceClient.h"
30 #include "CachedResourceClientWalker.h"
31 #include "DocLoader.h"
32 #include "FrameView.h"
33 #include "Request.h"
34 #include "SystemTime.h"
35 #include <wtf/Vector.h>
36
37 #if PLATFORM(CG)
38 #include "PDFDocumentImage.h"
39 #endif
40
41 #if ENABLE(SVG_AS_IMAGE)
42 #include "SVGImage.h"
43 #endif
44
45 using std::max;
46
47 namespace WebCore {
48
49 CachedImage::CachedImage(const String& url)
50     : CachedResource(url, ImageResource)
51     , m_image(0)
52     , m_decodedDataDeletionTimer(this, &CachedImage::decodedDataDeletionTimerFired)
53 {
54     m_status = Unknown;
55 }
56
57 CachedImage::CachedImage(Image* image)
58     : CachedResource(String(), ImageResource)
59     , m_image(image)
60     , m_decodedDataDeletionTimer(this, &CachedImage::decodedDataDeletionTimerFired)
61 {
62     m_status = Cached;
63     m_loading = false;
64 }
65
66 CachedImage::~CachedImage()
67 {
68 }
69
70 void CachedImage::decodedDataDeletionTimerFired(Timer<CachedImage>*)
71 {
72     ASSERT(!hasClients());
73     destroyDecodedData();
74 }
75
76 void CachedImage::load(DocLoader* docLoader)
77 {
78     if (!docLoader || docLoader->autoLoadImages())
79         CachedResource::load(docLoader, true, false, true);
80     else
81         m_loading = false;
82 }
83
84 void CachedImage::addClient(CachedResourceClient* c)
85 {
86     CachedResource::addClient(c);
87
88     if (m_decodedDataDeletionTimer.isActive())
89         m_decodedDataDeletionTimer.stop();
90
91     if (m_image && !m_image->rect().isEmpty())
92         c->imageChanged(this);
93
94     if (!m_loading)
95         c->notifyFinished(this);
96 }
97
98 void CachedImage::allClientsRemoved()
99 {
100     if (m_image && !m_errorOccurred)
101         m_image->resetAnimation();
102     if (double interval = cache()->deadDecodedDataDeletionInterval())
103         m_decodedDataDeletionTimer.startOneShot(interval);
104 }
105
106 static Image* brokenImage()
107 {
108     static RefPtr<Image> brokenImage;
109     if (!brokenImage)
110         brokenImage = Image::loadPlatformResource("missingImage");
111     return brokenImage.get();
112 }
113
114 static Image* nullImage()
115 {
116     static RefPtr<BitmapImage> nullImage = BitmapImage::create();
117     return nullImage.get();
118 }
119
120 Image* CachedImage::image() const
121 {
122     if (m_errorOccurred)
123         return brokenImage();
124
125     if (m_image)
126         return m_image.get();
127
128     return nullImage();
129 }
130
131 void CachedImage::setImageContainerSize(const IntSize& containerSize)
132 {
133     if (m_image)
134         m_image->setContainerSize(containerSize);
135 }
136
137 bool CachedImage::usesImageContainerSize() const
138 {
139     if (m_image)
140         return m_image->usesContainerSize();
141
142     return false;
143 }
144
145 bool CachedImage::imageHasRelativeWidth() const
146 {
147     if (m_image)
148         return m_image->hasRelativeWidth();
149
150     return false;
151 }
152
153 bool CachedImage::imageHasRelativeHeight() const
154 {
155     if (m_image)
156         return m_image->hasRelativeHeight();
157
158     return false;
159 }
160
161 IntSize CachedImage::imageSize(float multiplier) const
162 {
163     if (!m_image)
164         return IntSize();
165     if (multiplier == 1.0f)
166         return m_image->size();
167         
168     // Don't let images that have a width/height >= 1 shrink below 1 when zoomed.
169     bool hasWidth = m_image->size().width() > 0;
170     bool hasHeight = m_image->size().height() > 0;
171     int width = m_image->size().width() * (m_image->hasRelativeWidth() ? 1.0f : multiplier);
172     int height = m_image->size().height() * (m_image->hasRelativeHeight() ? 1.0f : multiplier);
173     if (hasWidth)
174         width = max(1, width);
175     if (hasHeight)
176         height = max(1, height);
177     return IntSize(width, height);
178 }
179
180 IntRect CachedImage::imageRect(float multiplier) const
181 {
182     if (!m_image)
183         return IntRect();
184     if (multiplier == 1.0f || (!m_image->hasRelativeWidth() && !m_image->hasRelativeHeight()))
185         return m_image->rect();
186
187     float widthMultiplier = (m_image->hasRelativeWidth() ? 1.0f : multiplier);
188     float heightMultiplier = (m_image->hasRelativeHeight() ? 1.0f : multiplier);
189
190     // Don't let images that have a width/height >= 1 shrink below 1 when zoomed.
191     bool hasWidth = m_image->rect().width() > 0;
192     bool hasHeight = m_image->rect().height() > 0;
193
194     int width = static_cast<int>(m_image->rect().width() * widthMultiplier);
195     int height = static_cast<int>(m_image->rect().height() * heightMultiplier);
196     if (hasWidth)
197         width = max(1, width);
198     if (hasHeight)
199         height = max(1, height);
200
201     int x = static_cast<int>(m_image->rect().x() * widthMultiplier);
202     int y = static_cast<int>(m_image->rect().y() * heightMultiplier);
203
204     return IntRect(x, y, width, height);
205 }
206
207 void CachedImage::notifyObservers()
208 {
209     CachedResourceClientWalker w(m_clients);
210     while (CachedResourceClient* c = w.next())
211         c->imageChanged(this);
212 }
213
214 void CachedImage::clear()
215 {
216     destroyDecodedData();
217     m_image = 0;
218     setEncodedSize(0);
219 }
220
221 inline void CachedImage::createImage()
222 {
223     // Create the image if it doesn't yet exist.
224     if (m_image)
225         return;
226 #if PLATFORM(CG)
227     if (m_response.mimeType() == "application/pdf") {
228         m_image = PDFDocumentImage::create();
229         return;
230     }
231 #endif
232 #if ENABLE(SVG_AS_IMAGE)
233     if (m_response.mimeType() == "image/svg+xml") {
234         m_image = SVGImage::create(this);
235         return;
236     }
237 #endif
238     m_image = BitmapImage::create(this);
239 }
240
241 void CachedImage::data(PassRefPtr<SharedBuffer> data, bool allDataReceived)
242 {
243     m_data = data;
244
245     createImage();
246
247     bool sizeAvailable = false;
248
249     // Have the image update its data from its internal buffer.
250     // It will not do anything now, but will delay decoding until 
251     // queried for info (like size or specific image frames).
252     sizeAvailable = m_image->setData(m_data, allDataReceived);
253
254     // Go ahead and tell our observers to try to draw if we have either
255     // received all the data or the size is known.  Each chunk from the
256     // network causes observers to repaint, which will force that chunk
257     // to decode.
258     if (sizeAvailable || allDataReceived) {
259         if (m_image->isNull()) {
260             // FIXME: I'm not convinced this case can even be hit.
261             error();
262             if (inCache())
263                 cache()->remove(this);
264             return;
265         }
266         
267         notifyObservers();
268
269         if (m_image)
270             setEncodedSize(m_image->data() ? m_image->data()->size() : 0);
271     }
272     
273     if (allDataReceived) {
274         m_loading = false;
275         checkNotify();
276     }
277 }
278
279 void CachedImage::error()
280 {
281     clear();
282     m_errorOccurred = true;
283     notifyObservers();
284     m_loading = false;
285     checkNotify();
286 }
287
288 void CachedImage::checkNotify()
289 {
290     if (m_loading)
291         return;
292
293     CachedResourceClientWalker w(m_clients);
294     while (CachedResourceClient* c = w.next())
295         c->notifyFinished(this);
296 }
297
298 void CachedImage::destroyDecodedData()
299 {
300     if (m_image && !m_errorOccurred)
301         m_image->destroyDecodedData();
302 }
303
304 void CachedImage::decodedSizeChanged(const Image* image, int delta)
305 {
306     if (image != m_image)
307         return;
308     
309     setDecodedSize(decodedSize() + delta);
310 }
311
312 void CachedImage::didDraw(const Image* image)
313 {
314     if (image != m_image)
315         return;
316     
317     double timeStamp = FrameView::currentPaintTimeStamp();
318     if (!timeStamp) // If didDraw is called outside of a Frame paint.
319         timeStamp = currentTime();
320     
321     CachedResource::didAccessDecodedData(timeStamp);
322 }
323
324 bool CachedImage::shouldPauseAnimation(const Image* image)
325 {
326     if (image != m_image)
327         return false;
328     
329     CachedResourceClientWalker w(m_clients);
330     while (CachedResourceClient* c = w.next()) {
331         if (c->willRenderImage(this))
332             return false;
333     }
334
335     return true;
336 }
337
338 void CachedImage::animationAdvanced(const Image* image)
339 {
340     if (image == m_image)
341         notifyObservers();
342 }
343
344 } //namespace WebCore