https://bugs.webkit.org/show_bug.cgi?id=80322
[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 invalidateContentsAndRootView(const IntRect& r, bool)
77     {
78         // If m_image->m_page is null, we're being destructed, don't fire changedInRect() in that case.
79         if (m_image && m_image->imageObserver() && m_image->m_page)
80             m_image->imageObserver()->changedInRect(m_image, r);
81     }
82
83     SVGImage* m_image;
84 };
85
86 SVGImage::SVGImage(ImageObserver* observer)
87     : Image(observer)
88 {
89 }
90
91 SVGImage::~SVGImage()
92 {
93     if (m_page) {
94         // Store m_page in a local variable, clearing m_page, so that SVGImageChromeClient knows we're destructed.
95         OwnPtr<Page> currentPage = m_page.release();
96         currentPage->mainFrame()->loader()->frameDetached(); // Break both the loader and view references to the frame
97     }
98
99     // Verify that page teardown destroyed the Chrome
100     ASSERT(!m_chromeClient || !m_chromeClient->image());
101 }
102
103 void SVGImage::setContainerSize(const IntSize&)
104 {
105     ASSERT_NOT_REACHED();
106 }
107
108 bool SVGImage::usesContainerSize() const
109 {
110     if (!m_page)
111         return false;
112     Frame* frame = m_page->mainFrame();
113     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
114     if (!rootElement)
115         return false;
116     if (RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer()))
117         return !renderer->containerSize().isEmpty();
118     return false;
119 }
120
121 IntSize SVGImage::size() const
122 {
123     if (!m_page)
124         return IntSize();
125     Frame* frame = m_page->mainFrame();
126     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
127     if (!rootElement)
128         return IntSize();
129
130     RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer());
131     if (!renderer)
132         return IntSize();
133
134     // If a container size is available it has precedence.
135     IntSize containerSize = renderer->containerSize();
136     if (!containerSize.isEmpty())
137         return containerSize;
138
139     // Assure that a container size is always given for a non-identity zoom level.
140     ASSERT(renderer->style()->effectiveZoom() == 1);
141
142     FloatSize currentSize;
143     if (rootElement->intrinsicWidth().isFixed() && rootElement->intrinsicHeight().isFixed())
144         currentSize = rootElement->currentViewportSize();
145     else
146         currentSize = rootElement->currentViewBoxRect().size();
147
148     if (!currentSize.isEmpty())
149         return IntSize(static_cast<int>(ceilf(currentSize.width())), static_cast<int>(ceilf(currentSize.height())));
150
151     // As last resort, use CSS default intrinsic size.
152     return IntSize(300, 150);
153 }
154
155 void SVGImage::drawSVGToImageBuffer(ImageBuffer* buffer, const IntSize& size, float zoom, ShouldClearBuffer shouldClear)
156 {
157     // FIXME: This doesn't work correctly with animations. If an image contains animations, that say run for 2 seconds,
158     // and we currently have one <img> that displays us. If we open another document referencing the same SVGImage it
159     // will display the document at a time where animations already ran - even though it has its own ImageBuffer.
160     // We currently don't implement SVGSVGElement::setCurrentTime, and can NOT go back in time, once animations started.
161     // There's no way to fix this besides avoiding style/attribute mutations from SVGAnimationElement.
162     ASSERT(buffer);
163     ASSERT(!size.isEmpty());
164
165     if (!m_page)
166         return;
167
168     Frame* frame = m_page->mainFrame();
169     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
170     if (!rootElement)
171         return;
172     RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer());
173     if (!renderer)
174         return;
175
176     // Draw image at requested size.
177     ImageObserver* observer = imageObserver();
178     ASSERT(observer);
179
180     // Temporarily reset image observer, we don't want to receive any changeInRect() calls due to this relayout.
181     setImageObserver(0);
182
183     // Disable repainting; we don't want deferred repaints to schedule any timers due to this relayout.
184     frame->view()->beginDisableRepaints();
185
186     renderer->setContainerSize(size);
187     frame->view()->resize(this->size());
188
189     if (zoom != 1)
190         frame->setPageZoomFactor(zoom);
191
192     // Eventually clear image buffer.
193     IntRect rect(IntPoint(), size);
194     if (shouldClear == ClearImageBuffer)
195         buffer->context()->clearRect(rect);
196
197     // Draw SVG on top of ImageBuffer.
198     draw(buffer->context(), rect, rect, ColorSpaceDeviceRGB, CompositeSourceOver);
199
200     // Reset container size & zoom to initial state. Otherwhise the size() of this
201     // image would return whatever last size was set by drawSVGToImageBuffer().
202     if (zoom != 1)
203         frame->setPageZoomFactor(1);
204
205     renderer->setContainerSize(IntSize());
206     frame->view()->resize(this->size());
207     if (frame->view()->needsLayout())
208         frame->view()->layout();
209
210     setImageObserver(observer);
211
212     frame->view()->endDisableRepaints();
213 }
214
215 void SVGImage::draw(GraphicsContext* context, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace, CompositeOperator compositeOp)
216 {
217     if (!m_page)
218         return;
219
220     FrameView* view = frameView();
221
222     GraphicsContextStateSaver stateSaver(*context);
223     context->setCompositeOperation(compositeOp);
224     context->clip(enclosingIntRect(dstRect));
225     if (compositeOp != CompositeSourceOver)
226         context->beginTransparencyLayer(1);
227
228     FloatSize scale(dstRect.width() / srcRect.width(), dstRect.height() / srcRect.height());
229     
230     // We can only draw the entire frame, clipped to the rect we want. So compute where the top left
231     // of the image would be if we were drawing without clipping, and translate accordingly.
232     FloatSize topLeftOffset(srcRect.location().x() * scale.width(), srcRect.location().y() * scale.height());
233     FloatPoint destOffset = dstRect.location() - topLeftOffset;
234
235     context->translate(destOffset.x(), destOffset.y());
236     context->scale(scale);
237
238     view->resize(size());
239
240     if (view->needsLayout())
241         view->layout();
242
243     view->paint(context, IntRect(0, 0, view->width(), view->height()));
244
245     if (compositeOp != CompositeSourceOver)
246         context->endTransparencyLayer();
247
248     stateSaver.restore();
249
250     if (imageObserver())
251         imageObserver()->didDraw(this);
252 }
253
254 RenderBox* SVGImage::embeddedContentBox() const
255 {
256     if (!m_page)
257         return 0;
258     Frame* frame = m_page->mainFrame();
259     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
260     if (!rootElement)
261         return 0;
262     return toRenderBox(rootElement->renderer());
263 }
264
265 FrameView* SVGImage::frameView() const
266 {
267     if (!m_page)
268         return 0;
269
270     return m_page->mainFrame()->view();
271 }
272
273 bool SVGImage::hasRelativeWidth() const
274 {
275     if (!m_page)
276         return false;
277     Frame* frame = m_page->mainFrame();
278     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
279     if (!rootElement)
280         return false;
281     return rootElement->intrinsicWidth().isPercent();
282 }
283
284 bool SVGImage::hasRelativeHeight() const
285 {
286     if (!m_page)
287         return false;
288     Frame* frame = m_page->mainFrame();
289     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
290     if (!rootElement)
291         return false;
292     return rootElement->intrinsicHeight().isPercent();
293 }
294
295 void SVGImage::computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio, float)
296 {
297     if (!m_page)
298         return;
299     Frame* frame = m_page->mainFrame();
300     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
301     if (!rootElement)
302         return;
303
304     intrinsicWidth = rootElement->intrinsicWidth();
305     intrinsicHeight = rootElement->intrinsicHeight();
306     if (rootElement->preserveAspectRatio().align() == SVGPreserveAspectRatio::SVG_PRESERVEASPECTRATIO_NONE)
307         return;
308
309     intrinsicRatio = rootElement->viewBox().size();
310     if (intrinsicRatio.isEmpty() && intrinsicWidth.isFixed() && intrinsicHeight.isFixed())
311         intrinsicRatio = FloatSize(floatValueForLength(intrinsicWidth, 0), floatValueForLength(intrinsicHeight, 0));
312 }
313
314 NativeImagePtr SVGImage::nativeImageForCurrentFrame()
315 {
316     // FIXME: In order to support dynamic SVGs we need to have a way to invalidate this
317     // frame cache, or better yet, not use a cache for tiled drawing at all, instead
318     // having a tiled drawing callback (hopefully non-virtual).
319     if (!m_frameCache) {
320         if (!m_page)
321             return 0;
322         OwnPtr<ImageBuffer> buffer = ImageBuffer::create(size(), 1);
323         if (!buffer) // failed to allocate image
324             return 0;
325         draw(buffer->context(), rect(), rect(), ColorSpaceDeviceRGB, CompositeSourceOver);
326         m_frameCache = buffer->copyImage(CopyBackingStore);
327     }
328     return m_frameCache->nativeImageForCurrentFrame();
329 }
330
331 bool SVGImage::dataChanged(bool allDataReceived)
332 {
333     // Don't do anything if is an empty image.
334     if (!data()->size())
335         return true;
336
337     if (allDataReceived) {
338         static FrameLoaderClient* dummyFrameLoaderClient =  new EmptyFrameLoaderClient;
339
340         Page::PageClients pageClients;
341         m_chromeClient = adoptPtr(new SVGImageChromeClient(this));
342         pageClients.chromeClient = m_chromeClient.get();
343 #if ENABLE(CONTEXT_MENUS)
344         static ContextMenuClient* dummyContextMenuClient = new EmptyContextMenuClient;
345         pageClients.contextMenuClient = dummyContextMenuClient;
346 #endif
347         static EditorClient* dummyEditorClient = new EmptyEditorClient;
348         pageClients.editorClient = dummyEditorClient;
349 #if ENABLE(DRAG_SUPPORT)
350         static DragClient* dummyDragClient = new EmptyDragClient;
351         pageClients.dragClient = dummyDragClient;
352 #endif
353         static InspectorClient* dummyInspectorClient = new EmptyInspectorClient;
354         pageClients.inspectorClient = dummyInspectorClient;
355
356         // FIXME: If this SVG ends up loading itself, we might leak the world.
357         // The Cache code does not know about CachedImages holding Frames and
358         // won't know to break the cycle.
359         // This will become an issue when SVGImage will be able to load other
360         // SVGImage objects, but we're safe now, because SVGImage can only be
361         // loaded by a top-level document.
362         m_page = adoptPtr(new Page(pageClients));
363         m_page->settings()->setMediaEnabled(false);
364         m_page->settings()->setScriptEnabled(false);
365         m_page->settings()->setPluginsEnabled(false);
366
367         RefPtr<Frame> frame = Frame::create(m_page.get(), 0, dummyFrameLoaderClient);
368         frame->setView(FrameView::create(frame.get()));
369         frame->init();
370         FrameLoader* loader = frame->loader();
371         loader->forceSandboxFlags(SandboxAll);
372
373         frame->view()->setCanHaveScrollbars(false); // SVG Images will always synthesize a viewBox, if it's not available, and thus never see scrollbars.
374         frame->view()->setTransparent(true); // SVG Images are transparent.
375
376         ASSERT(loader->activeDocumentLoader()); // DocumentLoader should have been created by frame->init().
377         loader->activeDocumentLoader()->writer()->setMIMEType("image/svg+xml");
378         loader->activeDocumentLoader()->writer()->begin(KURL()); // create the empty document
379         loader->activeDocumentLoader()->writer()->addData(data()->data(), data()->size());
380         loader->activeDocumentLoader()->writer()->end();
381     }
382
383     return m_page;
384 }
385
386 String SVGImage::filenameExtension() const
387 {
388     return "svg";
389 }
390
391 }
392
393 #endif // ENABLE(SVG)