3f14ccd0b2604de09622401eb55838cc6d988bf2
[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 LayoutRect& 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 PassRefPtr<SVGImage> SVGImage::createWithDataAndSize(ImageObserver* observer, SharedBuffer* data, const IntSize& size, float zoom)
106 {
107     ASSERT(!size.isEmpty());
108
109     RefPtr<SVGImage> image = adoptRef(new SVGImage(0));
110     image->setData(data, true);
111     image->setContainerSize(size);
112     image->setContainerZoom(zoom);
113     image->setImageObserver(observer);
114     return image.release();
115 }
116
117 void SVGImage::setContainerZoom(float containerZoom)
118 {
119     if (!m_page)
120         return;
121     Frame* frame = m_page->mainFrame();
122     frame->setPageZoomFactor(containerZoom);
123 }
124
125 void SVGImage::setContainerSize(const IntSize& containerSize)
126 {
127     ASSERT(!containerSize.isEmpty());
128     ASSERT(!imageObserver());
129     
130     if (!m_page)
131         return;
132     Frame* frame = m_page->mainFrame();
133     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
134     if (!rootElement)
135         return;
136
137     RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer());
138     if (!renderer)
139         return;
140     renderer->setContainerSize(containerSize);
141     frame->view()->resize(size());
142 }
143
144 bool SVGImage::usesContainerSize() const
145 {
146     if (!m_page)
147         return false;
148     Frame* frame = m_page->mainFrame();
149     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
150     if (!rootElement)
151         return false;
152     if (RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer()))
153         return !renderer->containerSize().isEmpty();
154     return false;
155 }
156
157 IntSize SVGImage::size() const
158 {
159     if (!m_page)
160         return IntSize();
161     Frame* frame = m_page->mainFrame();
162     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
163     if (!rootElement)
164         return IntSize();
165
166     RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer());
167     if (!renderer)
168         return IntSize();
169
170     // If a container size is available it has precedence.
171     IntSize containerSize = renderer->containerSize();
172     if (!containerSize.isEmpty())
173         return containerSize;
174
175     // Assure that a container size is always given for a non-identity zoom level.
176     ASSERT(renderer->style()->effectiveZoom() == 1);
177     IntSize size = enclosingIntRect(rootElement->currentViewBoxRect()).size();
178     if (!size.isEmpty())
179         return size;
180
181     // As last resort, use CSS default intrinsic size.
182     return IntSize(300, 150);
183 }
184
185 void SVGImage::draw(GraphicsContext* context, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace, CompositeOperator compositeOp)
186 {
187     if (!m_page)
188         return;
189
190     FrameView* view = m_page->mainFrame()->view();
191
192     GraphicsContextStateSaver stateSaver(*context);
193     context->setCompositeOperation(compositeOp);
194     context->clip(enclosingIntRect(dstRect));
195     if (compositeOp != CompositeSourceOver)
196         context->beginTransparencyLayer(1);
197
198     FloatSize scale(dstRect.width() / srcRect.width(), dstRect.height() / srcRect.height());
199     
200     // We can only draw the entire frame, clipped to the rect we want. So compute where the top left
201     // of the image would be if we were drawing without clipping, and translate accordingly.
202     FloatSize topLeftOffset(srcRect.location().x() * scale.width(), srcRect.location().y() * scale.height());
203     FloatPoint destOffset = dstRect.location() - topLeftOffset;
204
205     context->translate(destOffset.x(), destOffset.y());
206     context->scale(scale);
207
208     view->resize(size());
209
210     if (view->needsLayout())
211         view->layout();
212
213     view->paint(context, IntRect(0, 0, view->width(), view->height()));
214
215     if (compositeOp != CompositeSourceOver)
216         context->endTransparencyLayer();
217
218     stateSaver.restore();
219
220     if (imageObserver())
221         imageObserver()->didDraw(this);
222 }
223
224 RenderBox* SVGImage::embeddedContentBox() const
225 {
226     if (!m_page)
227         return 0;
228     Frame* frame = m_page->mainFrame();
229     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
230     if (!rootElement)
231         return 0;
232     return toRenderBox(rootElement->renderer());
233 }
234
235 void SVGImage::computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio)
236 {
237     if (!m_page)
238         return;
239     Frame* frame = m_page->mainFrame();
240     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
241     if (!rootElement)
242         return;
243     RenderBox* renderer = toRenderBox(rootElement->renderer());
244     if (!renderer)
245         return;
246
247     intrinsicWidth = renderer->style()->width();
248     intrinsicHeight = renderer->style()->height();
249     if (rootElement->preserveAspectRatio().align() != SVGPreserveAspectRatio::SVG_PRESERVEASPECTRATIO_NONE)
250         intrinsicRatio = rootElement->currentViewBoxRect().size();
251 }
252
253 NativeImagePtr SVGImage::nativeImageForCurrentFrame()
254 {
255     // FIXME: In order to support dynamic SVGs we need to have a way to invalidate this
256     // frame cache, or better yet, not use a cache for tiled drawing at all, instead
257     // having a tiled drawing callback (hopefully non-virtual).
258     if (!m_frameCache) {
259         if (!m_page)
260             return 0;
261         OwnPtr<ImageBuffer> buffer = ImageBuffer::create(size());
262         if (!buffer) // failed to allocate image
263             return 0;
264         draw(buffer->context(), rect(), rect(), ColorSpaceDeviceRGB, CompositeSourceOver);
265         m_frameCache = buffer->copyImage(CopyBackingStore);
266     }
267     return m_frameCache->nativeImageForCurrentFrame();
268 }
269
270 bool SVGImage::dataChanged(bool allDataReceived)
271 {
272     // Don't do anything if is an empty image.
273     if (!data()->size())
274         return true;
275
276     if (allDataReceived) {
277         static FrameLoaderClient* dummyFrameLoaderClient =  new EmptyFrameLoaderClient;
278
279         Page::PageClients pageClients;
280         m_chromeClient = adoptPtr(new SVGImageChromeClient(this));
281         pageClients.chromeClient = m_chromeClient.get();
282 #if ENABLE(CONTEXT_MENUS)
283         static ContextMenuClient* dummyContextMenuClient = new EmptyContextMenuClient;
284         pageClients.contextMenuClient = dummyContextMenuClient;
285 #endif
286         static EditorClient* dummyEditorClient = new EmptyEditorClient;
287         pageClients.editorClient = dummyEditorClient;
288 #if ENABLE(DRAG_SUPPORT)
289         static DragClient* dummyDragClient = new EmptyDragClient;
290         pageClients.dragClient = dummyDragClient;
291 #endif
292         static InspectorClient* dummyInspectorClient = new EmptyInspectorClient;
293         pageClients.inspectorClient = dummyInspectorClient;
294 #if ENABLE(DEVICE_ORIENTATION)
295         static DeviceMotionClient* dummyDeviceMotionClient = new EmptyDeviceMotionClient;
296         pageClients.deviceMotionClient = dummyDeviceMotionClient;
297         static DeviceOrientationClient* dummyDeviceOrientationClient = new EmptyDeviceOrientationClient;
298         pageClients.deviceOrientationClient = dummyDeviceOrientationClient;
299 #endif
300
301         // FIXME: If this SVG ends up loading itself, we might leak the world.
302         // The Cache code does not know about CachedImages holding Frames and
303         // won't know to break the cycle.
304         // This will become an issue when SVGImage will be able to load other
305         // SVGImage objects, but we're safe now, because SVGImage can only be
306         // loaded by a top-level document.
307         m_page = adoptPtr(new Page(pageClients));
308         m_page->settings()->setMediaEnabled(false);
309         m_page->settings()->setScriptEnabled(false);
310         m_page->settings()->setPluginsEnabled(false);
311
312         RefPtr<Frame> frame = Frame::create(m_page.get(), 0, dummyFrameLoaderClient);
313         frame->setView(FrameView::create(frame.get()));
314         frame->init();
315         FrameLoader* loader = frame->loader();
316         loader->forceSandboxFlags(SandboxAll);
317
318         frame->view()->setCanHaveScrollbars(false); // SVG Images will always synthesize a viewBox, if it's not available, and thus never see scrollbars.
319         frame->view()->setTransparent(true); // SVG Images are transparent.
320
321         ASSERT(loader->activeDocumentLoader()); // DocumentLoader should have been created by frame->init().
322         loader->activeDocumentLoader()->writer()->setMIMEType("image/svg+xml");
323         loader->activeDocumentLoader()->writer()->begin(KURL()); // create the empty document
324         loader->activeDocumentLoader()->writer()->addData(data()->data(), data()->size());
325         loader->activeDocumentLoader()->writer()->end();
326     }
327
328     return m_page;
329 }
330
331 String SVGImage::filenameExtension() const
332 {
333     return "svg";
334 }
335
336 }
337
338 #endif // ENABLE(SVG)