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