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