blob: 1df40003f4b31c54b18417068d0313460252cecc [file] [log] [blame]
/*
* Copyright (C) 2006 Eric Seidel <eric@webkit.org>
* Copyright (C) 2008-2019 Apple Inc. All rights reserved.
* Copyright (C) Research In Motion Limited 2011. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "SVGImage.h"
#include "CacheStorageProvider.h"
#include "Chrome.h"
#include "CommonVM.h"
#include "CustomHeaderFields.h"
#include "DOMWindow.h"
#include "DocumentLoader.h"
#include "EditorClient.h"
#include "ElementIterator.h"
#include "Frame.h"
#include "FrameLoader.h"
#include "FrameView.h"
#include "ImageBuffer.h"
#include "ImageObserver.h"
#include "IntRect.h"
#include "JSDOMWindowBase.h"
#include "LibWebRTCProvider.h"
#include "Page.h"
#include "PageConfiguration.h"
#include "RenderSVGRoot.h"
#include "RenderStyle.h"
#include "RenderView.h"
#include "SVGDocument.h"
#include "SVGFEImageElement.h"
#include "SVGForeignObjectElement.h"
#include "SVGImageClients.h"
#include "SVGImageElement.h"
#include "SVGSVGElement.h"
#include "ScriptDisallowedScope.h"
#include "Settings.h"
#include "SocketProvider.h"
#include <JavaScriptCore/JSCInlines.h>
#include <JavaScriptCore/JSLock.h>
#include <wtf/text/TextStream.h>
#if PLATFORM(MAC)
#include "LocalDefaultSystemAppearance.h"
#endif
#if USE(DIRECT2D)
#include "COMPtr.h"
#include "Direct2DUtilities.h"
#include "GraphicsContext.h"
#include "ImageDecoderDirect2D.h"
#include "PlatformContextDirect2D.h"
#include <d2d1.h>
#endif
namespace WebCore {
SVGImage::SVGImage(ImageObserver& observer)
: Image(&observer)
, m_startAnimationTimer(*this, &SVGImage::startAnimationTimerFired)
{
}
SVGImage::~SVGImage()
{
if (m_page) {
ScriptDisallowedScope::DisableAssertionsInScope disabledScope;
// Store m_page in a local variable, clearing m_page, so that SVGImageChromeClient knows we're destructed.
std::unique_ptr<Page> currentPage = WTFMove(m_page);
currentPage->mainFrame().loader().frameDetached(); // Break both the loader and view references to the frame
}
// Verify that page teardown destroyed the Chrome
ASSERT(!m_chromeClient || !m_chromeClient->image());
}
inline RefPtr<SVGSVGElement> SVGImage::rootElement() const
{
if (!m_page)
return nullptr;
return SVGDocument::rootElement(*m_page->mainFrame().document());
}
bool SVGImage::hasSingleSecurityOrigin() const
{
auto rootElement = this->rootElement();
if (!rootElement)
return true;
// FIXME: Once foreignObject elements within SVG images are updated to not leak cross-origin data
// (e.g., visited links, spellcheck) we can remove the SVGForeignObjectElement check here and
// research if we can remove the Image::hasSingleSecurityOrigin mechanism entirely.
for (auto& element : descendantsOfType<SVGElement>(*rootElement)) {
if (is<SVGForeignObjectElement>(element))
return false;
if (is<SVGImageElement>(element)) {
if (!downcast<SVGImageElement>(element).hasSingleSecurityOrigin())
return false;
} else if (is<SVGFEImageElement>(element)) {
if (!downcast<SVGFEImageElement>(element).hasSingleSecurityOrigin())
return false;
}
}
// Because SVG image rendering disallows external resources and links,
// these images effectively are restricted to a single security origin.
return true;
}
void SVGImage::setContainerSize(const FloatSize& size)
{
if (!usesContainerSize())
return;
auto rootElement = this->rootElement();
if (!rootElement)
return;
auto* renderer = downcast<RenderSVGRoot>(rootElement->renderer());
if (!renderer)
return;
auto view = makeRefPtr(frameView());
view->resize(this->containerSize());
renderer->setContainerSize(IntSize(size));
}
IntSize SVGImage::containerSize() const
{
auto rootElement = this->rootElement();
if (!rootElement)
return IntSize();
auto* renderer = downcast<RenderSVGRoot>(rootElement->renderer());
if (!renderer)
return IntSize();
// If a container size is available it has precedence.
IntSize containerSize = renderer->containerSize();
if (!containerSize.isEmpty())
return containerSize;
// Assure that a container size is always given for a non-identity zoom level.
ASSERT(renderer->style().effectiveZoom() == 1);
FloatSize currentSize;
if (rootElement->hasIntrinsicWidth() && rootElement->hasIntrinsicHeight())
currentSize = rootElement->currentViewportSize();
else
currentSize = rootElement->currentViewBoxRect().size();
if (!currentSize.isEmpty())
return IntSize(static_cast<int>(ceilf(currentSize.width())), static_cast<int>(ceilf(currentSize.height())));
// As last resort, use CSS default intrinsic size.
return IntSize(300, 150);
}
ImageDrawResult SVGImage::drawForContainer(GraphicsContext& context, const FloatSize containerSize, float containerZoom, const URL& initialFragmentURL, const FloatRect& dstRect,
const FloatRect& srcRect, const ImagePaintingOptions& options)
{
if (!m_page)
return ImageDrawResult::DidNothing;
ImageObserver* observer = imageObserver();
ASSERT(observer);
// Temporarily reset image observer, we don't want to receive any changeInRect() calls due to this relayout.
setImageObserver(nullptr);
IntSize roundedContainerSize = roundedIntSize(containerSize);
setContainerSize(roundedContainerSize);
FloatRect scaledSrc = srcRect;
scaledSrc.scale(1 / containerZoom);
// Compensate for the container size rounding by adjusting the source rect.
FloatSize adjustedSrcSize = scaledSrc.size();
adjustedSrcSize.scale(roundedContainerSize.width() / containerSize.width(), roundedContainerSize.height() / containerSize.height());
scaledSrc.setSize(adjustedSrcSize);
frameView()->scrollToFragment(initialFragmentURL);
ImageDrawResult result = draw(context, dstRect, scaledSrc, options);
setImageObserver(observer);
return result;
}
#if USE(CAIRO)
// Passes ownership of the native image to the caller so NativeImagePtr needs
// to be a smart pointer type.
NativeImagePtr SVGImage::nativeImageForCurrentFrame(const GraphicsContext*)
{
if (!m_page)
return nullptr;
// Cairo does not use the accelerated drawing flag, so it's OK to make an unconditionally unaccelerated buffer.
std::unique_ptr<ImageBuffer> buffer = ImageBuffer::create(size(), Unaccelerated);
if (!buffer) // failed to allocate image
return nullptr;
draw(buffer->context(), rect(), rect());
// FIXME: WK(Bug 113657): We should use DontCopyBackingStore here.
return buffer->copyImage(CopyBackingStore)->nativeImageForCurrentFrame();
}
#endif
#if USE(DIRECT2D)
NativeImagePtr SVGImage::nativeImage(const GraphicsContext* targetContext)
{
ASSERT(targetContext);
if (!m_page || !targetContext)
return nullptr;
ASSERT(targetContext->hasPlatformContext());
auto* renderTarget = targetContext->platformContext()->renderTarget();
IntSize bitmapSize(size().width(), size().height());
auto nativeImageTarget = Direct2D::createBitmapRenderTargetOfSize(bitmapSize, renderTarget, 1.0);
if (!nativeImageTarget)
return nullptr;
PlatformContextDirect2D platformContext(nativeImageTarget.get());
GraphicsContext localContext(&platformContext, GraphicsContext::BitmapRenderingContextType::GPUMemory);
draw(localContext, rect(), rect(), { CompositeSourceOver, BlendMode::Normal, DecodingMode::Synchronous, ImageOrientation::None });
COMPtr<ID2D1Bitmap> nativeImage;
HRESULT hr = nativeImageTarget->GetBitmap(&nativeImage);
if (!SUCCEEDED(hr))
return nullptr;
#if !ASSERT_DISABLED
auto nativeImageSize = nativeImage->GetPixelSize();
ASSERT(nativeImageSize.height = rect().size().height());
ASSERT(nativeImageSize.width = rect().size().width());
#endif
return nativeImage;
}
#endif
void SVGImage::drawPatternForContainer(GraphicsContext& context, const FloatSize& containerSize, float containerZoom, const URL& initialFragmentURL, const FloatRect& srcRect,
const AffineTransform& patternTransform, const FloatPoint& phase, const FloatSize& spacing, const FloatRect& dstRect, const ImagePaintingOptions& options)
{
FloatRect zoomedContainerRect = FloatRect(FloatPoint(), containerSize);
zoomedContainerRect.scale(containerZoom);
// The ImageBuffer size needs to be scaled to match the final resolution.
AffineTransform transform = context.getCTM();
FloatSize imageBufferScale = FloatSize(transform.xScale(), transform.yScale());
ASSERT(imageBufferScale.width());
ASSERT(imageBufferScale.height());
FloatRect imageBufferSize = zoomedContainerRect;
imageBufferSize.scale(imageBufferScale.width(), imageBufferScale.height());
std::unique_ptr<ImageBuffer> buffer = ImageBuffer::createCompatibleBuffer(expandedIntSize(imageBufferSize.size()), 1, ColorSpaceSRGB, context);
if (!buffer) // Failed to allocate buffer.
return;
drawForContainer(buffer->context(), containerSize, containerZoom, initialFragmentURL, imageBufferSize, zoomedContainerRect);
if (context.drawLuminanceMask())
buffer->convertToLuminanceMask();
RefPtr<Image> image = ImageBuffer::sinkIntoImage(WTFMove(buffer), PreserveResolution::Yes);
if (!image)
return;
// Adjust the source rect and transform due to the image buffer's scaling.
FloatRect scaledSrcRect = srcRect;
scaledSrcRect.scale(imageBufferScale.width(), imageBufferScale.height());
AffineTransform unscaledPatternTransform(patternTransform);
unscaledPatternTransform.scale(1 / imageBufferScale.width(), 1 / imageBufferScale.height());
context.setDrawLuminanceMask(false);
image->drawPattern(context, dstRect, scaledSrcRect, unscaledPatternTransform, phase, spacing, options);
}
ImageDrawResult SVGImage::draw(GraphicsContext& context, const FloatRect& dstRect, const FloatRect& srcRect, const ImagePaintingOptions& options)
{
if (!m_page)
return ImageDrawResult::DidNothing;
auto view = makeRefPtr(frameView());
ASSERT(view);
GraphicsContextStateSaver stateSaver(context);
context.setCompositeOperation(options.compositeOperator(), options.blendMode());
context.clip(enclosingIntRect(dstRect));
float alpha = context.alpha();
bool compositingRequiresTransparencyLayer = options.compositeOperator() != CompositeSourceOver || options.blendMode() != BlendMode::Normal || alpha < 1;
if (compositingRequiresTransparencyLayer) {
context.beginTransparencyLayer(alpha);
context.setCompositeOperation(CompositeSourceOver, BlendMode::Normal);
}
FloatSize scale(dstRect.size() / srcRect.size());
// We can only draw the entire frame, clipped to the rect we want. So compute where the top left
// of the image would be if we were drawing without clipping, and translate accordingly.
FloatSize topLeftOffset(srcRect.location().x() * scale.width(), srcRect.location().y() * scale.height());
FloatPoint destOffset = dstRect.location() - topLeftOffset;
context.translate(destOffset);
context.scale(scale);
view->resize(containerSize());
{
ScriptDisallowedScope::DisableAssertionsInScope disabledScope;
if (view->needsLayout())
view->layoutContext().layout();
}
#if PLATFORM(MAC)
LocalDefaultSystemAppearance localAppearance(view->useDarkAppearance());
#endif
view->paint(context, intersection(context.clipBounds(), enclosingIntRect(srcRect)));
if (compositingRequiresTransparencyLayer)
context.endTransparencyLayer();
stateSaver.restore();
if (imageObserver())
imageObserver()->didDraw(*this);
return ImageDrawResult::DidDraw;
}
RenderBox* SVGImage::embeddedContentBox() const
{
auto rootElement = this->rootElement();
if (!rootElement)
return nullptr;
return downcast<RenderBox>(rootElement->renderer());
}
FrameView* SVGImage::frameView() const
{
if (!m_page)
return nullptr;
return m_page->mainFrame().view();
}
bool SVGImage::hasRelativeWidth() const
{
auto rootElement = this->rootElement();
if (!rootElement)
return false;
return rootElement->intrinsicWidth().isPercentOrCalculated();
}
bool SVGImage::hasRelativeHeight() const
{
auto rootElement = this->rootElement();
if (!rootElement)
return false;
return rootElement->intrinsicHeight().isPercentOrCalculated();
}
void SVGImage::computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio)
{
auto rootElement = this->rootElement();
if (!rootElement)
return;
intrinsicWidth = rootElement->intrinsicWidth();
intrinsicHeight = rootElement->intrinsicHeight();
if (rootElement->preserveAspectRatio().align() == SVGPreserveAspectRatioValue::SVG_PRESERVEASPECTRATIO_NONE)
return;
intrinsicRatio = rootElement->viewBox().size();
if (intrinsicRatio.isEmpty() && intrinsicWidth.isFixed() && intrinsicHeight.isFixed())
intrinsicRatio = FloatSize(floatValueForLength(intrinsicWidth, 0), floatValueForLength(intrinsicHeight, 0));
}
void SVGImage::startAnimationTimerFired()
{
startAnimation();
}
void SVGImage::scheduleStartAnimation()
{
auto rootElement = this->rootElement();
if (!rootElement || !rootElement->animationsPaused())
return;
m_startAnimationTimer.startOneShot(0_s);
}
void SVGImage::startAnimation()
{
auto rootElement = this->rootElement();
if (!rootElement || !rootElement->animationsPaused())
return;
rootElement->unpauseAnimations();
rootElement->setCurrentTime(0);
}
void SVGImage::stopAnimation()
{
m_startAnimationTimer.stop();
auto rootElement = this->rootElement();
if (!rootElement)
return;
rootElement->pauseAnimations();
}
void SVGImage::resetAnimation()
{
stopAnimation();
}
bool SVGImage::isAnimating() const
{
auto rootElement = this->rootElement();
if (!rootElement)
return false;
return rootElement->hasActiveAnimation();
}
void SVGImage::reportApproximateMemoryCost() const
{
auto document = makeRefPtr(m_page->mainFrame().document());
size_t decodedImageMemoryCost = 0;
for (RefPtr<Node> node = document; node; node = NodeTraversal::next(*node))
decodedImageMemoryCost += node->approximateMemoryCost();
JSC::VM& vm = commonVM();
JSC::JSLockHolder lock(vm);
// FIXME: Adopt reportExtraMemoryVisited, and switch to reportExtraMemoryAllocated.
// https://bugs.webkit.org/show_bug.cgi?id=142595
vm.heap.deprecatedReportExtraMemory(decodedImageMemoryCost + data()->size());
}
EncodedDataStatus SVGImage::dataChanged(bool allDataReceived)
{
// Don't do anything; it is an empty image.
if (!data()->size())
return EncodedDataStatus::Complete;
if (allDataReceived) {
auto pageConfiguration = pageConfigurationWithEmptyClients(PAL::SessionID::defaultSessionID());
m_chromeClient = makeUnique<SVGImageChromeClient>(this);
pageConfiguration.chromeClient = m_chromeClient.get();
// FIXME: If this SVG ends up loading itself, we might leak the world.
// The Cache code does not know about CachedImages holding Frames and
// won't know to break the cycle.
// This will become an issue when SVGImage will be able to load other
// SVGImage objects, but we're safe now, because SVGImage can only be
// loaded by a top-level document.
m_page = makeUnique<Page>(WTFMove(pageConfiguration));
m_page->settings().setMediaEnabled(false);
m_page->settings().setScriptEnabled(false);
m_page->settings().setPluginsEnabled(false);
m_page->settings().setAcceleratedCompositingEnabled(false);
m_page->settings().setShouldAllowUserInstalledFonts(false);
Frame& frame = m_page->mainFrame();
frame.setView(FrameView::create(frame));
frame.init();
FrameLoader& loader = frame.loader();
loader.forceSandboxFlags(SandboxAll);
frame.view()->setCanHaveScrollbars(false); // SVG Images will always synthesize a viewBox, if it's not available, and thus never see scrollbars.
frame.view()->setTransparent(true); // SVG Images are transparent.
ASSERT(loader.activeDocumentLoader()); // DocumentLoader should have been created by frame->init().
loader.activeDocumentLoader()->writer().setMIMEType("image/svg+xml");
loader.activeDocumentLoader()->writer().begin(URL()); // create the empty document
loader.activeDocumentLoader()->writer().addData(data()->data(), data()->size());
loader.activeDocumentLoader()->writer().end();
frame.document()->updateLayoutIgnorePendingStylesheets();
// Set the intrinsic size before a container size is available.
m_intrinsicSize = containerSize();
reportApproximateMemoryCost();
}
return m_page ? EncodedDataStatus::Complete : EncodedDataStatus::Unknown;
}
String SVGImage::filenameExtension() const
{
return "svg"_s;
}
bool isInSVGImage(const Element* element)
{
ASSERT(element);
Page* page = element->document().page();
if (!page)
return false;
return page->chrome().client().isSVGImageChromeClient();
}
}