2011-11-10 Nikolas Zimmermann <nzimmermann@rim.com>
[WebKit-https.git] / Source / WebCore / svg / graphics / SVGImage.cpp
1 /*
2  * Copyright (C) 2006 Eric Seidel <eric@webkit.org>
3  * Copyright (C) 2008, 2009 Apple Inc. All rights reserved.
4  * Copyright (C) Research In Motion Limited 2011. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
26  */
27
28 #include "config.h"
29
30 #if ENABLE(SVG)
31 #include "SVGImage.h"
32
33 #include "CachedPage.h"
34 #include "DocumentLoader.h"
35 #include "EmptyClients.h"
36 #include "FileChooser.h"
37 #include "FileIconLoader.h"
38 #include "FloatRect.h"
39 #include "Frame.h"
40 #include "FrameLoader.h"
41 #include "FrameView.h"
42 #include "GraphicsContext.h"
43 #include "HTMLFormElement.h"
44 #include "ImageBuffer.h"
45 #include "ImageObserver.h"
46 #include "Length.h"
47 #include "Page.h"
48 #include "RenderSVGRoot.h"
49 #include "RenderView.h"
50 #include "ResourceError.h"
51 #include "SVGDocument.h"
52 #include "SVGLength.h"
53 #include "SVGRenderSupport.h"
54 #include "SVGSVGElement.h"
55 #include "Settings.h"
56
57 namespace WebCore {
58
59 class SVGImageChromeClient : public EmptyChromeClient {
60     WTF_MAKE_NONCOPYABLE(SVGImageChromeClient); WTF_MAKE_FAST_ALLOCATED;
61 public:
62     SVGImageChromeClient(SVGImage* image)
63         : m_image(image)
64     {
65     }
66
67     virtual bool isSVGImageChromeClient() const { return true; }
68     SVGImage* image() const { return m_image; }
69
70 private:
71     virtual void chromeDestroyed()
72     {
73         m_image = 0;
74     }
75
76     virtual void invalidateContentsAndWindow(const IntRect& r, bool)
77     {
78         if (m_image && m_image->imageObserver())
79             m_image->imageObserver()->changedInRect(m_image, r);
80     }
81
82     SVGImage* m_image;
83 };
84
85 SVGImage::SVGImage(ImageObserver* observer)
86     : Image(observer)
87 {
88 }
89
90 SVGImage::~SVGImage()
91 {
92     if (m_page) {
93         m_page->mainFrame()->loader()->frameDetached(); // Break both the loader and view references to the frame
94
95         // Clear explicitly because we want to delete the page before the ChromeClient.
96         // FIXME: I believe that's already guaranteed by C++ object destruction rules,
97         // so this may matter only for the assertion below.
98         m_page.clear();
99     }
100
101     // Verify that page teardown destroyed the Chrome
102     ASSERT(!m_chromeClient || !m_chromeClient->image());
103 }
104
105 void SVGImage::setContainerSize(const IntSize&)
106 {
107     ASSERT_NOT_REACHED();
108 }
109
110 bool SVGImage::usesContainerSize() const
111 {
112     if (!m_page)
113         return false;
114     Frame* frame = m_page->mainFrame();
115     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
116     if (!rootElement)
117         return false;
118     if (RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer()))
119         return !renderer->containerSize().isEmpty();
120     return false;
121 }
122
123 IntSize SVGImage::size() const
124 {
125     if (!m_page)
126         return IntSize();
127     Frame* frame = m_page->mainFrame();
128     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
129     if (!rootElement)
130         return IntSize();
131
132     RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer());
133     if (!renderer)
134         return IntSize();
135
136     // If a container size is available it has precedence.
137     IntSize containerSize = renderer->containerSize();
138     if (!containerSize.isEmpty())
139         return containerSize;
140
141     // Assure that a container size is always given for a non-identity zoom level.
142     ASSERT(renderer->style()->effectiveZoom() == 1);
143     IntSize size = enclosingIntRect(rootElement->currentViewBoxRect(SVGSVGElement::CalculateViewBoxInHostDocument)).size();
144     if (!size.isEmpty())
145         return size;
146
147     // As last resort, use CSS default intrinsic size.
148     return IntSize(300, 150);
149 }
150
151 void SVGImage::drawSVGToImageBuffer(ImageBuffer* buffer, const IntSize& size, float zoom, ShouldClearBuffer shouldClear)
152 {
153     // FIXME: This doesn't work correctly with animations. If an image contains animations, that say run for 2 seconds,
154     // and we currently have one <img> that displays us. If we open another document referencing the same SVGImage it
155     // will display the document at a time where animations already ran - even though it has its own ImageBuffer.
156     // We currently don't implement SVGSVGElement::setCurrentTime, and can NOT go back in time, once animations started.
157     // There's no way to fix this besides avoiding style/attribute mutations from SVGAnimationElement.
158     ASSERT(buffer);
159     ASSERT(!size.isEmpty());
160
161     if (!m_page)
162         return;
163
164     Frame* frame = m_page->mainFrame();
165     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
166     if (!rootElement)
167         return;
168     RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer());
169     if (!renderer)
170         return;
171
172     // Draw image at requested size.
173     ImageObserver* observer = imageObserver();
174     ASSERT(observer);
175
176     // Temporarily reset image observer, we don't want to receive any changeInRect() calls due this relayout.
177     setImageObserver(0);
178     renderer->setContainerSize(size);
179     frame->view()->resize(this->size());
180     if (zoom != 1)
181         frame->setPageZoomFactor(zoom);
182
183     // Eventually clear image buffer.
184     IntRect rect(IntPoint(), size);
185     if (shouldClear == ClearImageBuffer)
186         buffer->context()->clearRect(rect);
187
188     // Draw SVG on top of ImageBuffer.
189     draw(buffer->context(), rect, rect, ColorSpaceDeviceRGB, CompositeSourceOver);
190
191     // Reset container size & zoom to initial state. Otherwhise the size() of this
192     // image would return whatever last size was set by drawSVGToImageBuffer().
193     if (zoom != 1)
194         frame->setPageZoomFactor(1);
195
196     renderer->setContainerSize(IntSize());
197     frame->view()->resize(this->size());
198     if (frame->view()->needsLayout())
199         frame->view()->layout();
200
201     setImageObserver(observer); 
202 }
203
204 void SVGImage::draw(GraphicsContext* context, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace, CompositeOperator compositeOp)
205 {
206     if (!m_page)
207         return;
208
209     FrameView* view = m_page->mainFrame()->view();
210
211     GraphicsContextStateSaver stateSaver(*context);
212     context->setCompositeOperation(compositeOp);
213     context->clip(enclosingIntRect(dstRect));
214     if (compositeOp != CompositeSourceOver)
215         context->beginTransparencyLayer(1);
216
217     FloatSize scale(dstRect.width() / srcRect.width(), dstRect.height() / srcRect.height());
218     
219     // We can only draw the entire frame, clipped to the rect we want. So compute where the top left
220     // of the image would be if we were drawing without clipping, and translate accordingly.
221     FloatSize topLeftOffset(srcRect.location().x() * scale.width(), srcRect.location().y() * scale.height());
222     FloatPoint destOffset = dstRect.location() - topLeftOffset;
223
224     context->translate(destOffset.x(), destOffset.y());
225     context->scale(scale);
226
227     view->resize(size());
228
229     if (view->needsLayout())
230         view->layout();
231
232     view->paint(context, IntRect(0, 0, view->width(), view->height()));
233
234     if (compositeOp != CompositeSourceOver)
235         context->endTransparencyLayer();
236
237     stateSaver.restore();
238
239     if (imageObserver())
240         imageObserver()->didDraw(this);
241 }
242
243 RenderBox* SVGImage::embeddedContentBox() const
244 {
245     if (!m_page)
246         return 0;
247     Frame* frame = m_page->mainFrame();
248     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
249     if (!rootElement)
250         return 0;
251     return toRenderBox(rootElement->renderer());
252 }
253
254 void SVGImage::computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio)
255 {
256     if (!m_page)
257         return;
258     Frame* frame = m_page->mainFrame();
259     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
260     if (!rootElement)
261         return;
262     RenderBox* renderer = toRenderBox(rootElement->renderer());
263     if (!renderer)
264         return;
265
266     intrinsicWidth = renderer->style()->width();
267     intrinsicHeight = renderer->style()->height();
268     if (rootElement->preserveAspectRatio().align() != SVGPreserveAspectRatio::SVG_PRESERVEASPECTRATIO_NONE)
269         intrinsicRatio = rootElement->currentViewBoxRect().size();
270 }
271
272 NativeImagePtr SVGImage::nativeImageForCurrentFrame()
273 {
274     // FIXME: In order to support dynamic SVGs we need to have a way to invalidate this
275     // frame cache, or better yet, not use a cache for tiled drawing at all, instead
276     // having a tiled drawing callback (hopefully non-virtual).
277     if (!m_frameCache) {
278         if (!m_page)
279             return 0;
280         OwnPtr<ImageBuffer> buffer = ImageBuffer::create(size());
281         if (!buffer) // failed to allocate image
282             return 0;
283         draw(buffer->context(), rect(), rect(), ColorSpaceDeviceRGB, CompositeSourceOver);
284         m_frameCache = buffer->copyImage(CopyBackingStore);
285     }
286     return m_frameCache->nativeImageForCurrentFrame();
287 }
288
289 bool SVGImage::dataChanged(bool allDataReceived)
290 {
291     // Don't do anything if is an empty image.
292     if (!data()->size())
293         return true;
294
295     if (allDataReceived) {
296         static FrameLoaderClient* dummyFrameLoaderClient =  new EmptyFrameLoaderClient;
297
298         Page::PageClients pageClients;
299         m_chromeClient = adoptPtr(new SVGImageChromeClient(this));
300         pageClients.chromeClient = m_chromeClient.get();
301 #if ENABLE(CONTEXT_MENUS)
302         static ContextMenuClient* dummyContextMenuClient = new EmptyContextMenuClient;
303         pageClients.contextMenuClient = dummyContextMenuClient;
304 #endif
305         static EditorClient* dummyEditorClient = new EmptyEditorClient;
306         pageClients.editorClient = dummyEditorClient;
307 #if ENABLE(DRAG_SUPPORT)
308         static DragClient* dummyDragClient = new EmptyDragClient;
309         pageClients.dragClient = dummyDragClient;
310 #endif
311         static InspectorClient* dummyInspectorClient = new EmptyInspectorClient;
312         pageClients.inspectorClient = dummyInspectorClient;
313 #if ENABLE(DEVICE_ORIENTATION)
314         static DeviceMotionClient* dummyDeviceMotionClient = new EmptyDeviceMotionClient;
315         pageClients.deviceMotionClient = dummyDeviceMotionClient;
316         static DeviceOrientationClient* dummyDeviceOrientationClient = new EmptyDeviceOrientationClient;
317         pageClients.deviceOrientationClient = dummyDeviceOrientationClient;
318 #endif
319
320         // FIXME: If this SVG ends up loading itself, we might leak the world.
321         // The Cache code does not know about CachedImages holding Frames and
322         // won't know to break the cycle.
323         // This will become an issue when SVGImage will be able to load other
324         // SVGImage objects, but we're safe now, because SVGImage can only be
325         // loaded by a top-level document.
326         m_page = adoptPtr(new Page(pageClients));
327         m_page->settings()->setMediaEnabled(false);
328         m_page->settings()->setScriptEnabled(false);
329         m_page->settings()->setPluginsEnabled(false);
330
331         RefPtr<Frame> frame = Frame::create(m_page.get(), 0, dummyFrameLoaderClient);
332         frame->setView(FrameView::create(frame.get()));
333         frame->init();
334         FrameLoader* loader = frame->loader();
335         loader->forceSandboxFlags(SandboxAll);
336
337         frame->view()->setCanHaveScrollbars(false); // SVG Images will always synthesize a viewBox, if it's not available, and thus never see scrollbars.
338         frame->view()->setTransparent(true); // SVG Images are transparent.
339
340         ASSERT(loader->activeDocumentLoader()); // DocumentLoader should have been created by frame->init().
341         loader->activeDocumentLoader()->writer()->setMIMEType("image/svg+xml");
342         loader->activeDocumentLoader()->writer()->begin(KURL()); // create the empty document
343         loader->activeDocumentLoader()->writer()->addData(data()->data(), data()->size());
344         loader->activeDocumentLoader()->writer()->end();
345     }
346
347     return m_page;
348 }
349
350 String SVGImage::filenameExtension() const
351 {
352     return "svg";
353 }
354
355 }
356
357 #endif // ENABLE(SVG)