#include "config.h"
#include "CachedImage.h"
#include "BitmapImage.h"
#include "CachedImageClient.h"
#include "CachedResourceClient.h"
#include "CachedResourceClientWalker.h"
#include "CachedResourceLoader.h"
#include "Frame.h"
#include "FrameLoader.h"
#include "FrameLoaderClient.h"
#include "FrameLoaderTypes.h"
#include "FrameView.h"
#include "MemoryCache.h"
#include "RenderElement.h"
#include "SVGImage.h"
#include "SecurityOrigin.h"
#include "Settings.h"
#include "SharedBuffer.h"
#include "SubresourceLoader.h"
#include <wtf/CurrentTime.h>
#include <wtf/NeverDestroyed.h>
#include <wtf/StdLibExtras.h>
#if PLATFORM(IOS)
#include "SystemMemory.h"
#endif
#if USE(CG)
#include "PDFDocumentImage.h"
#endif
namespace WebCore {
CachedImage::CachedImage(CachedResourceRequest&& request, SessionID sessionID)
: CachedResource(WTFMove(request), ImageResource, sessionID)
{
setStatus(Unknown);
}
CachedImage::CachedImage(Image* image, SessionID sessionID)
: CachedResource(URL(), ImageResource, sessionID)
, m_image(image)
{
}
CachedImage::CachedImage(const URL& url, Image* image, SessionID sessionID)
: CachedResource(url, ImageResource, sessionID)
, m_image(image)
, m_isManuallyCached(true)
{
m_response.setURL(url);
}
CachedImage::~CachedImage()
{
clearImage();
}
void CachedImage::load(CachedResourceLoader& loader)
{
if (loader.shouldPerformImageLoad(url()))
CachedResource::load(loader);
else
setLoading(false);
}
void CachedImage::setBodyDataFrom(const CachedResource& resource)
{
ASSERT(resource.type() == type());
const CachedImage& image = static_cast<const CachedImage&>(resource);
CachedResource::setBodyDataFrom(resource);
m_image = image.m_image;
m_imageObserver = image.m_imageObserver;
if (m_imageObserver)
m_imageObserver->cachedImages().add(this);
if (m_image && is<SVGImage>(*m_image))
m_svgImageCache = std::make_unique<SVGImageCache>(&downcast<SVGImage>(*m_image));
}
void CachedImage::didAddClient(CachedResourceClient& client)
{
if (m_data && !m_image && !errorOccurred()) {
createImage();
m_image->setData(m_data.copyRef(), true);
}
ASSERT(client.resourceClientType() == CachedImageClient::expectedType());
if (m_image && !m_image->isNull())
static_cast<CachedImageClient&>(client).imageChanged(this);
if (m_image)
m_image->startAnimationAsynchronously();
CachedResource::didAddClient(client);
}
void CachedImage::didRemoveClient(CachedResourceClient& client)
{
ASSERT(client.resourceClientType() == CachedImageClient::expectedType());
m_pendingContainerSizeRequests.remove(&static_cast<CachedImageClient&>(client));
m_pendingImageDrawingClients.remove(&static_cast<CachedImageClient&>(client));
if (m_svgImageCache)
m_svgImageCache->removeClientFromCache(&static_cast<CachedImageClient&>(client));
CachedResource::didRemoveClient(client);
static_cast<CachedImageClient&>(client).didRemoveCachedImageClient(*this);
}
void CachedImage::addPendingImageDrawingClient(CachedImageClient& client)
{
ASSERT(client.resourceClientType() == CachedImageClient::expectedType());
if (m_pendingImageDrawingClients.contains(&client))
return;
if (!m_clients.contains(&client)) {
CachedResourceClientWalker<CachedImageClient> walker(m_clients);
while (auto* client = walker.next())
m_pendingImageDrawingClients.add(client);
} else
m_pendingImageDrawingClients.add(&client);
}
void CachedImage::switchClientsToRevalidatedResource()
{
ASSERT(is<CachedImage>(resourceToRevalidate()));
if (!m_pendingContainerSizeRequests.isEmpty()) {
ContainerSizeRequests switchContainerSizeRequests;
for (auto& request : m_pendingContainerSizeRequests)
switchContainerSizeRequests.set(request.key, request.value);
CachedResource::switchClientsToRevalidatedResource();
CachedImage& revalidatedCachedImage = downcast<CachedImage>(*resourceToRevalidate());
for (auto& request : switchContainerSizeRequests)
revalidatedCachedImage.setContainerSizeForRenderer(request.key, request.value.first, request.value.second);
return;
}
CachedResource::switchClientsToRevalidatedResource();
}
void CachedImage::allClientsRemoved()
{
m_pendingContainerSizeRequests.clear();
m_pendingImageDrawingClients.clear();
if (m_image && !errorOccurred())
m_image->resetAnimation();
}
std::pair<Image*, float> CachedImage::brokenImage(float deviceScaleFactor) const
{
if (deviceScaleFactor >= 3) {
static NeverDestroyed<Image*> brokenImageVeryHiRes(&Image::loadPlatformResource("missingImage@3x").leakRef());
return std::make_pair(brokenImageVeryHiRes, 3);
}
if (deviceScaleFactor >= 2) {
static NeverDestroyed<Image*> brokenImageHiRes(&Image::loadPlatformResource("missingImage@2x").leakRef());
return std::make_pair(brokenImageHiRes, 2);
}
static NeverDestroyed<Image*> brokenImageLoRes(&Image::loadPlatformResource("missingImage").leakRef());
return std::make_pair(brokenImageLoRes, 1);
}
bool CachedImage::willPaintBrokenImage() const
{
return errorOccurred() && m_shouldPaintBrokenImage;
}
Image* CachedImage::image()
{
if (errorOccurred() && m_shouldPaintBrokenImage) {
return brokenImage(1).first;
}
if (m_image)
return m_image.get();
return &Image::nullImage();
}
Image* CachedImage::imageForRenderer(const RenderObject* renderer)
{
if (errorOccurred() && m_shouldPaintBrokenImage) {
return brokenImage(1).first;
}
if (!m_image)
return &Image::nullImage();
if (m_image->isSVGImage()) {
Image* image = m_svgImageCache->imageForRenderer(renderer);
if (image != &Image::nullImage())
return image;
}
return m_image.get();
}
void CachedImage::setContainerSizeForRenderer(const CachedImageClient* renderer, const LayoutSize& containerSize, float containerZoom)
{
if (containerSize.isEmpty())
return;
ASSERT(renderer);
ASSERT(containerZoom);
if (!m_image) {
m_pendingContainerSizeRequests.set(renderer, SizeAndZoom(containerSize, containerZoom));
return;
}
if (!m_image->isSVGImage()) {
m_image->setContainerSize(containerSize);
return;
}
m_svgImageCache->setContainerSizeForRenderer(renderer, containerSize, containerZoom);
}
LayoutSize CachedImage::imageSizeForRenderer(const RenderElement* renderer, float multiplier, SizeType sizeType)
{
if (!m_image)
return LayoutSize();
LayoutSize imageSize;
if (is<BitmapImage>(*m_image) && renderer && renderer->shouldRespectImageOrientation() == RespectImageOrientation)
imageSize = LayoutSize(downcast<BitmapImage>(*m_image).sizeRespectingOrientation());
else if (is<SVGImage>(*m_image) && sizeType == UsedSize)
imageSize = LayoutSize(m_svgImageCache->imageSizeForRenderer(renderer));
else
imageSize = LayoutSize(m_image->size());
if (multiplier == 1.0f)
return imageSize;
float widthScale = m_image->hasRelativeWidth() ? 1.0f : multiplier;
float heightScale = m_image->hasRelativeHeight() ? 1.0f : multiplier;
LayoutSize minimumSize(imageSize.width() > 0 ? 1 : 0, imageSize.height() > 0 ? 1 : 0);
imageSize.scale(widthScale, heightScale);
imageSize.clampToMinimumSize(minimumSize);
ASSERT(multiplier != 1.0f || (imageSize.width().fraction() == 0.0f && imageSize.height().fraction() == 0.0f));
return imageSize;
}
void CachedImage::computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio)
{
if (m_image)
m_image->computeIntrinsicDimensions(intrinsicWidth, intrinsicHeight, intrinsicRatio);
}
void CachedImage::notifyObservers(const IntRect* changeRect)
{
CachedResourceClientWalker<CachedImageClient> w(m_clients);
while (CachedImageClient* c = w.next())
c->imageChanged(this, changeRect);
}
void CachedImage::checkShouldPaintBrokenImage()
{
if (!m_loader || m_loader->reachedTerminalState())
return;
m_shouldPaintBrokenImage = m_loader->frameLoader()->client().shouldPaintBrokenImage(url());
}
void CachedImage::clear()
{
destroyDecodedData();
clearImage();
m_pendingContainerSizeRequests.clear();
m_pendingImageDrawingClients.clear();
setEncodedSize(0);
}
inline void CachedImage::createImage()
{
if (m_image)
return;
m_imageObserver = CachedImageObserver::create(*this);
if (m_response.mimeType() == "image/svg+xml") {
auto svgImage = SVGImage::create(*m_imageObserver, url());
m_svgImageCache = std::make_unique<SVGImageCache>(svgImage.ptr());
m_image = WTFMove(svgImage);
#if USE(CG) && !USE(WEBKIT_IMAGE_DECODERS)
} else if (m_response.mimeType() == "application/pdf") {
m_image = PDFDocumentImage::create(m_imageObserver.get());
#endif
} else
m_image = BitmapImage::create(m_imageObserver.get());
if (m_image) {
if (m_image->usesContainerSize()) {
for (auto& request : m_pendingContainerSizeRequests)
setContainerSizeForRenderer(request.key, request.value.first, request.value.second);
}
m_pendingContainerSizeRequests.clear();
m_pendingImageDrawingClients.clear();
}
}
CachedImage::CachedImageObserver::CachedImageObserver(CachedImage& image)
{
m_cachedImages.add(&image);
}
void CachedImage::CachedImageObserver::decodedSizeChanged(const Image& image, long long delta)
{
for (auto cachedImage : m_cachedImages)
cachedImage->decodedSizeChanged(image, delta);
}
void CachedImage::CachedImageObserver::didDraw(const Image& image)
{
for (auto cachedImage : m_cachedImages)
cachedImage->didDraw(image);
}
bool CachedImage::CachedImageObserver::canDestroyDecodedData(const Image& image)
{
for (auto cachedImage : m_cachedImages) {
if (&image != cachedImage->image())
continue;
if (!cachedImage->canDestroyDecodedData(image))
return false;
}
return true;
}
void CachedImage::CachedImageObserver::imageFrameAvailable(const Image& image, ImageAnimatingState animatingState, const IntRect* changeRect, DecodingStatus decodingStatus)
{
for (auto cachedImage : m_cachedImages)
cachedImage->imageFrameAvailable(image, animatingState, changeRect, decodingStatus);
}
void CachedImage::CachedImageObserver::changedInRect(const Image& image, const IntRect* rect)
{
for (auto cachedImage : m_cachedImages)
cachedImage->changedInRect(image, rect);
}
inline void CachedImage::clearImage()
{
if (!m_image)
return;
if (m_imageObserver) {
m_imageObserver->cachedImages().remove(this);
if (m_imageObserver->cachedImages().isEmpty()) {
ASSERT(m_imageObserver->hasOneRef());
m_image->setImageObserver(nullptr);
}
m_imageObserver = nullptr;
}
m_image = nullptr;
}
void CachedImage::addIncrementalDataBuffer(SharedBuffer& data)
{
m_data = &data;
createImage();
EncodedDataStatus encodedDataStatus = setImageDataBuffer(&data, false);
if (encodedDataStatus > EncodedDataStatus::Error && encodedDataStatus < EncodedDataStatus::SizeAvailable)
return;
if (encodedDataStatus == EncodedDataStatus::Error || m_image->isNull()) {
error(errorOccurred() ? status() : DecodeError);
if (m_loader && encodedDataStatus == EncodedDataStatus::Error)
m_loader->cancel();
if (inCache())
MemoryCache::singleton().remove(*this);
return;
}
notifyObservers();
setEncodedSize(m_image->data() ? m_image->data()->size() : 0);
}
EncodedDataStatus CachedImage::setImageDataBuffer(SharedBuffer* data, bool allDataReceived)
{
return m_image ? m_image->setData(data, allDataReceived) : EncodedDataStatus::Error;
}
void CachedImage::addDataBuffer(SharedBuffer& data)
{
ASSERT(dataBufferingPolicy() == BufferData);
addIncrementalDataBuffer(data);
CachedResource::addDataBuffer(data);
}
void CachedImage::addData(const char* data, unsigned length)
{
ASSERT(dataBufferingPolicy() == DoNotBufferData);
addIncrementalDataBuffer(SharedBuffer::create(data, length));
CachedResource::addData(data, length);
}
void CachedImage::finishLoading(SharedBuffer* data)
{
m_data = data;
if (!m_image && data)
createImage();
EncodedDataStatus encodedDataStatus = setImageDataBuffer(data, true);
if (encodedDataStatus == EncodedDataStatus::Error || m_image->isNull()) {
error(errorOccurred() ? status() : DecodeError);
if (inCache())
MemoryCache::singleton().remove(*this);
return;
}
notifyObservers();
if (m_image)
setEncodedSize(m_image->data() ? m_image->data()->size() : 0);
CachedResource::finishLoading(data);
}
void CachedImage::didReplaceSharedBufferContents()
{
if (m_image) {
m_image->destroyDecodedData(true);
}
CachedResource::didReplaceSharedBufferContents();
}
void CachedImage::error(CachedResource::Status status)
{
checkShouldPaintBrokenImage();
clear();
CachedResource::error(status);
notifyObservers();
}
void CachedImage::responseReceived(const ResourceResponse& response)
{
if (!m_response.isNull())
clear();
CachedResource::responseReceived(response);
}
void CachedImage::destroyDecodedData()
{
bool canDeleteImage = !m_image || (m_image->hasOneRef() && m_image->isBitmapImage());
if (canDeleteImage && !isLoading() && !hasClients()) {
m_image = nullptr;
setDecodedSize(0);
} else if (m_image && !errorOccurred())
m_image->destroyDecodedData();
}
void CachedImage::decodedSizeChanged(const Image& image, long long delta)
{
if (&image != m_image)
return;
ASSERT(delta >= 0 || decodedSize() + delta >= 0);
setDecodedSize(static_cast<unsigned>(decodedSize() + delta));
}
void CachedImage::didDraw(const Image& image)
{
if (&image != m_image)
return;
double timeStamp = FrameView::currentPaintTimeStamp();
if (!timeStamp) timeStamp = monotonicallyIncreasingTime();
CachedResource::didAccessDecodedData(timeStamp);
}
bool CachedImage::canDestroyDecodedData(const Image& image)
{
if (&image != m_image)
return false;
CachedResourceClientWalker<CachedImageClient> clientWalker(m_clients);
while (CachedImageClient* client = clientWalker.next()) {
if (!client->canDestroyDecodedData())
return false;
}
return true;
}
void CachedImage::imageFrameAvailable(const Image& image, ImageAnimatingState animatingState, const IntRect* changeRect, DecodingStatus decodingStatus)
{
if (&image != m_image)
return;
CachedResourceClientWalker<CachedImageClient> clientWalker(m_clients);
VisibleInViewportState visibleState = VisibleInViewportState::No;
while (CachedImageClient* client = clientWalker.next()) {
if (animatingState == ImageAnimatingState::No && !m_pendingImageDrawingClients.contains(client))
continue;
if (client->imageFrameAvailable(*this, animatingState, changeRect) == VisibleInViewportState::Yes)
visibleState = VisibleInViewportState::Yes;
}
if (visibleState == VisibleInViewportState::No && animatingState == ImageAnimatingState::Yes)
m_image->stopAnimation();
if (decodingStatus != DecodingStatus::Partial)
m_pendingImageDrawingClients.clear();
}
void CachedImage::changedInRect(const Image& image, const IntRect* rect)
{
if (&image != m_image)
return;
notifyObservers(rect);
}
bool CachedImage::currentFrameKnownToBeOpaque(const RenderElement* renderer)
{
Image* image = imageForRenderer(renderer);
return image->currentFrameKnownToBeOpaque();
}
bool CachedImage::isOriginClean(SecurityOrigin* origin)
{
ASSERT_UNUSED(origin, origin);
ASSERT(this->origin());
ASSERT(origin->toString() == this->origin()->toString());
return !loadFailedOrCanceled() && isCORSSameOrigin();
}
CachedResource::RevalidationDecision CachedImage::makeRevalidationDecision(CachePolicy cachePolicy) const
{
if (UNLIKELY(isManuallyCached())) {
return RevalidationDecision::No;
}
return CachedResource::makeRevalidationDecision(cachePolicy);
}
}