CTTE: Pass DocumentWriter around as a reference
[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 "Chrome.h"
34 #include "DocumentLoader.h"
35 #include "ElementIterator.h"
36 #include "FrameView.h"
37 #include "ImageBuffer.h"
38 #include "ImageObserver.h"
39 #include "IntRect.h"
40 #include "MainFrame.h"
41 #include "RenderSVGRoot.h"
42 #include "RenderStyle.h"
43 #include "SVGDocument.h"
44 #include "SVGForeignObjectElement.h"
45 #include "SVGImageChromeClient.h"
46 #include "SVGSVGElement.h"
47 #include "Settings.h"
48
49 namespace WebCore {
50
51 SVGImage::SVGImage(ImageObserver* observer)
52     : Image(observer)
53 {
54 }
55
56 SVGImage::~SVGImage()
57 {
58     if (m_page) {
59         // Store m_page in a local variable, clearing m_page, so that SVGImageChromeClient knows we're destructed.
60         OwnPtr<Page> currentPage = m_page.release();
61         currentPage->mainFrame().loader().frameDetached(); // Break both the loader and view references to the frame
62     }
63
64     // Verify that page teardown destroyed the Chrome
65     ASSERT(!m_chromeClient || !m_chromeClient->image());
66 }
67
68 bool SVGImage::hasSingleSecurityOrigin() const
69 {
70     if (!m_page)
71         return true;
72
73     SVGSVGElement* rootElement = toSVGDocument(m_page->mainFrame().document())->rootElement();
74     if (!rootElement)
75         return true;
76
77     // Don't allow foreignObject elements since they can leak information with arbitrary HTML (like spellcheck or control theme).
78     if (descendantsOfType<SVGForeignObjectElement>(rootElement).first())
79         return false;
80
81     // Because SVG image rendering disallows external resources and links,
82     // these images effectively are restricted to a single security origin.
83     return true;
84 }
85
86 void SVGImage::setContainerSize(const IntSize& size)
87 {
88     if (!m_page || !usesContainerSize())
89         return;
90
91     SVGSVGElement* rootElement = toSVGDocument(m_page->mainFrame().document())->rootElement();
92     if (!rootElement)
93         return;
94     RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer());
95     if (!renderer)
96         return;
97
98     FrameView* view = frameView();
99     view->resize(this->containerSize());
100
101     renderer->setContainerSize(size);
102 }
103
104 IntSize SVGImage::containerSize() const
105 {
106     if (!m_page)
107         return IntSize();
108     SVGSVGElement* rootElement = toSVGDocument(m_page->mainFrame().document())->rootElement();
109     if (!rootElement)
110         return IntSize();
111
112     RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer());
113     if (!renderer)
114         return IntSize();
115
116     // If a container size is available it has precedence.
117     IntSize containerSize = renderer->containerSize();
118     if (!containerSize.isEmpty())
119         return containerSize;
120
121     // Assure that a container size is always given for a non-identity zoom level.
122     ASSERT(renderer->style()->effectiveZoom() == 1);
123
124     FloatSize currentSize;
125     if (rootElement->intrinsicWidth().isFixed() && rootElement->intrinsicHeight().isFixed())
126         currentSize = rootElement->currentViewportSize();
127     else
128         currentSize = rootElement->currentViewBoxRect().size();
129
130     if (!currentSize.isEmpty())
131         return IntSize(static_cast<int>(ceilf(currentSize.width())), static_cast<int>(ceilf(currentSize.height())));
132
133     // As last resort, use CSS default intrinsic size.
134     return IntSize(300, 150);
135 }
136
137 void SVGImage::drawForContainer(GraphicsContext* context, const FloatSize containerSize, float zoom, const FloatRect& dstRect,
138     const FloatRect& srcRect, ColorSpace colorSpace, CompositeOperator compositeOp, BlendMode blendMode)
139 {
140     if (!m_page)
141         return;
142
143     ImageObserver* observer = imageObserver();
144     ASSERT(observer);
145
146     // Temporarily reset image observer, we don't want to receive any changeInRect() calls due to this relayout.
147     setImageObserver(0);
148
149     IntSize roundedContainerSize = roundedIntSize(containerSize);
150     setContainerSize(roundedContainerSize);
151
152     FloatRect scaledSrc = srcRect;
153     scaledSrc.scale(1 / zoom);
154
155     // Compensate for the container size rounding by adjusting the source rect.
156     FloatSize adjustedSrcSize = scaledSrc.size();
157     adjustedSrcSize.scale(roundedContainerSize.width() / containerSize.width(), roundedContainerSize.height() / containerSize.height());
158     scaledSrc.setSize(adjustedSrcSize);
159
160     draw(context, dstRect, scaledSrc, colorSpace, compositeOp, blendMode);
161
162     setImageObserver(observer);
163 }
164
165 #if USE(CAIRO)
166 // Passes ownership of the native image to the caller so PassNativeImagePtr needs
167 // to be a smart pointer type.
168 PassNativeImagePtr SVGImage::nativeImageForCurrentFrame()
169 {
170     if (!m_page)
171         return 0;
172
173     OwnPtr<ImageBuffer> buffer = ImageBuffer::create(size(), 1);
174     if (!buffer) // failed to allocate image
175         return 0;
176
177     draw(buffer->context(), rect(), rect(), ColorSpaceDeviceRGB, CompositeSourceOver, BlendModeNormal);
178
179     // FIXME: WK(Bug 113657): We should use DontCopyBackingStore here.
180     return buffer->copyImage(CopyBackingStore)->nativeImageForCurrentFrame();
181 }
182 #endif
183
184 void SVGImage::drawPatternForContainer(GraphicsContext* context, const FloatSize containerSize, float zoom, const FloatRect& srcRect,
185     const AffineTransform& patternTransform, const FloatPoint& phase, ColorSpace colorSpace, CompositeOperator compositeOp, const FloatRect& dstRect)
186 {
187     FloatRect zoomedContainerRect = FloatRect(FloatPoint(), containerSize);
188     zoomedContainerRect.scale(zoom);
189
190     // The ImageBuffer size needs to be scaled to match the final resolution.
191     AffineTransform transform = context->getCTM();
192     FloatSize imageBufferScale = FloatSize(transform.xScale(), transform.yScale());
193     ASSERT(imageBufferScale.width());
194     ASSERT(imageBufferScale.height());
195
196     FloatRect imageBufferSize = zoomedContainerRect;
197     imageBufferSize.scale(imageBufferScale.width(), imageBufferScale.height());
198
199     OwnPtr<ImageBuffer> buffer = ImageBuffer::create(expandedIntSize(imageBufferSize.size()), 1);
200     if (!buffer) // Failed to allocate buffer.
201         return;
202     drawForContainer(buffer->context(), containerSize, zoom, imageBufferSize, zoomedContainerRect, ColorSpaceDeviceRGB, CompositeSourceOver, BlendModeNormal);
203     if (context->drawLuminanceMask())
204         buffer->convertToLuminanceMask();
205
206     RefPtr<Image> image = buffer->copyImage(DontCopyBackingStore, Unscaled);
207     image->setSpaceSize(spaceSize());
208
209     // Adjust the source rect and transform due to the image buffer's scaling.
210     FloatRect scaledSrcRect = srcRect;
211     scaledSrcRect.scale(imageBufferScale.width(), imageBufferScale.height());
212     AffineTransform unscaledPatternTransform(patternTransform);
213     unscaledPatternTransform.scale(1 / imageBufferScale.width(), 1 / imageBufferScale.height());
214
215     context->setDrawLuminanceMask(false);
216     image->drawPattern(context, scaledSrcRect, unscaledPatternTransform, phase, colorSpace, compositeOp, dstRect);
217 }
218
219 void SVGImage::draw(GraphicsContext* context, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace, CompositeOperator compositeOp, BlendMode blendMode)
220 {
221     if (!m_page)
222         return;
223
224     FrameView* view = frameView();
225
226     GraphicsContextStateSaver stateSaver(*context);
227     context->setCompositeOperation(compositeOp, blendMode);
228     context->clip(enclosingIntRect(dstRect));
229     if (compositeOp != CompositeSourceOver)
230         context->beginTransparencyLayer(1);
231
232     FloatSize scale(dstRect.width() / srcRect.width(), dstRect.height() / srcRect.height());
233     
234     // We can only draw the entire frame, clipped to the rect we want. So compute where the top left
235     // of the image would be if we were drawing without clipping, and translate accordingly.
236     FloatSize topLeftOffset(srcRect.location().x() * scale.width(), srcRect.location().y() * scale.height());
237     FloatPoint destOffset = dstRect.location() - topLeftOffset;
238
239     context->translate(destOffset.x(), destOffset.y());
240     context->scale(scale);
241
242     view->resize(containerSize());
243
244     if (view->needsLayout())
245         view->layout();
246
247     view->paint(context, enclosingIntRect(srcRect));
248
249     if (compositeOp != CompositeSourceOver)
250         context->endTransparencyLayer();
251
252     stateSaver.restore();
253
254     if (imageObserver())
255         imageObserver()->didDraw(this);
256 }
257
258 RenderBox* SVGImage::embeddedContentBox() const
259 {
260     if (!m_page)
261         return 0;
262     SVGSVGElement* rootElement = toSVGDocument(m_page->mainFrame().document())->rootElement();
263     if (!rootElement)
264         return 0;
265     return toRenderBox(rootElement->renderer());
266 }
267
268 FrameView* SVGImage::frameView() const
269 {
270     if (!m_page)
271         return 0;
272     return m_page->mainFrame().view();
273 }
274
275 bool SVGImage::hasRelativeWidth() const
276 {
277     if (!m_page)
278         return false;
279     SVGSVGElement* rootElement = toSVGDocument(m_page->mainFrame().document())->rootElement();
280     if (!rootElement)
281         return false;
282     return rootElement->intrinsicWidth().isPercent();
283 }
284
285 bool SVGImage::hasRelativeHeight() const
286 {
287     if (!m_page)
288         return false;
289     SVGSVGElement* rootElement = toSVGDocument(m_page->mainFrame().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)
296 {
297     if (!m_page)
298         return;
299     SVGSVGElement* rootElement = toSVGDocument(m_page->mainFrame().document())->rootElement();
300     if (!rootElement)
301         return;
302
303     intrinsicWidth = rootElement->intrinsicWidth();
304     intrinsicHeight = rootElement->intrinsicHeight();
305     if (rootElement->preserveAspectRatio().align() == SVGPreserveAspectRatio::SVG_PRESERVEASPECTRATIO_NONE)
306         return;
307
308     intrinsicRatio = rootElement->viewBox().size();
309     if (intrinsicRatio.isEmpty() && intrinsicWidth.isFixed() && intrinsicHeight.isFixed())
310         intrinsicRatio = FloatSize(floatValueForLength(intrinsicWidth, 0), floatValueForLength(intrinsicHeight, 0));
311 }
312
313 // FIXME: support catchUpIfNecessary.
314 void SVGImage::startAnimation(bool /* catchUpIfNecessary */)
315 {
316     if (!m_page)
317         return;
318     SVGSVGElement* rootElement = toSVGDocument(m_page->mainFrame().document())->rootElement();
319     if (!rootElement)
320         return;
321     rootElement->unpauseAnimations();
322     rootElement->setCurrentTime(0);
323 }
324
325 void SVGImage::stopAnimation()
326 {
327     if (!m_page)
328         return;
329     SVGSVGElement* rootElement = toSVGDocument(m_page->mainFrame().document())->rootElement();
330     if (!rootElement)
331         return;
332     rootElement->pauseAnimations();
333 }
334
335 void SVGImage::resetAnimation()
336 {
337     stopAnimation();
338 }
339
340 bool SVGImage::dataChanged(bool allDataReceived)
341 {
342     // Don't do anything if is an empty image.
343     if (!data()->size())
344         return true;
345
346     if (allDataReceived) {
347         Page::PageClients pageClients;
348         fillWithEmptyClients(pageClients);
349         m_chromeClient = adoptPtr(new SVGImageChromeClient(this));
350         pageClients.chromeClient = m_chromeClient.get();
351
352         // FIXME: If this SVG ends up loading itself, we might leak the world.
353         // The Cache code does not know about CachedImages holding Frames and
354         // won't know to break the cycle.
355         // This will become an issue when SVGImage will be able to load other
356         // SVGImage objects, but we're safe now, because SVGImage can only be
357         // loaded by a top-level document.
358         m_page = adoptPtr(new Page(pageClients));
359         m_page->settings().setMediaEnabled(false);
360         m_page->settings().setScriptEnabled(false);
361         m_page->settings().setPluginsEnabled(false);
362
363         Frame& frame = m_page->mainFrame();
364         frame.setView(FrameView::create(frame));
365         frame.init();
366         FrameLoader& loader = frame.loader();
367         loader.forceSandboxFlags(SandboxAll);
368
369         frame.view()->setCanHaveScrollbars(false); // SVG Images will always synthesize a viewBox, if it's not available, and thus never see scrollbars.
370         frame.view()->setTransparent(true); // SVG Images are transparent.
371
372         ASSERT(loader.activeDocumentLoader()); // DocumentLoader should have been created by frame->init().
373         loader.activeDocumentLoader()->writer().setMIMEType("image/svg+xml");
374         loader.activeDocumentLoader()->writer().begin(URL()); // create the empty document
375         loader.activeDocumentLoader()->writer().addData(data()->data(), data()->size());
376         loader.activeDocumentLoader()->writer().end();
377
378         // Set the intrinsic size before a container size is available.
379         m_intrinsicSize = containerSize();
380     }
381
382     return m_page;
383 }
384
385 String SVGImage::filenameExtension() const
386 {
387     return "svg";
388 }
389
390 bool isInSVGImage(const Element* element)
391 {
392     ASSERT(element);
393
394     Page* page = element->document().page();
395     if (!page)
396         return false;
397
398     return page->chrome().client().isSVGImageChromeClient();
399 }
400
401 }
402
403 #endif // ENABLE(SVG)