-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Expand file tree
/
Copy pathImageLoader.cpp
More file actions
781 lines (655 loc) · 29 KB
/
ImageLoader.cpp
File metadata and controls
781 lines (655 loc) · 29 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
/*
* Copyright (C) 1999 Lars Knoll (knoll@kde.org)
* (C) 1999 Antti Koivisto (koivisto@kde.org)
* Copyright (C) 2004-2025 Apple Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#include "config.h"
#include "ImageLoader.h"
#include "ArchiveResource.h"
#include "BitmapImage.h"
#include "CachedImage.h"
#include "CachedResourceRequest.h"
#include "Chrome.h"
#include "ChromeClient.h"
#include "ContainerNodeInlines.h"
#include "CookieJar.h"
#include "CrossOriginAccessControl.h"
#include "DocumentLoader.h"
#include "DocumentPage.h"
#include "DocumentResourceLoader.h"
#include "DocumentSecurityOrigin.h"
#include "DocumentView.h"
#include "ElementInlines.h"
#include "Event.h"
#include "EventNames.h"
#include "EventSender.h"
#include "FrameDestructionObserverInlines.h"
#include "FrameLoader.h"
#include "HTMLImageElement.h"
#include "HTMLNames.h"
#include "HTMLObjectElement.h"
#include "HTMLPlugInElement.h"
#include "HTMLSrcsetParser.h"
#include "InspectorInstrumentation.h"
#include "JSDOMPromiseDeferred.h"
#include "LazyLoadImageObserver.h"
#include "LegacyRenderSVGImage.h"
#include "LocalFrame.h"
#include "Logging.h"
#include "MemoryCache.h"
#include "Page.h"
#include "RenderImage.h"
#include "RenderSVGImage.h"
#include "Settings.h"
#include <wtf/NeverDestroyed.h>
#include <wtf/Scope.h>
#include <wtf/text/MakeString.h>
#include <wtf/text/TextStream.h>
#if ENABLE(VIDEO)
#include "RenderVideo.h"
#endif
#if ENABLE(SPATIAL_IMAGE_CONTROLS)
#include "SpatialImageControls.h"
#endif
#if ASSERT_ENABLED
// ImageLoader objects are allocated as members of other objects, so generic pointer check would always fail.
namespace WTF {
template<> struct ValueCheck<WebCore::ImageLoader*> {
typedef WebCore::ImageLoader* TraitType;
static void checkConsistency(const WebCore::ImageLoader* p)
{
if (!p)
return;
ValueCheck<WebCore::Element*>::checkConsistency(&p->element());
}
};
} // namespace WTF
#endif // ASSERT_ENABLED
namespace WebCore {
#if !LOG_DISABLED
static TextStream& operator<<(TextStream& ts, LazyImageLoadState state)
{
switch (state) {
case LazyImageLoadState::None: ts << "None"_s; break;
case LazyImageLoadState::Deferred: ts << "Deferred"_s; break;
case LazyImageLoadState::LoadImmediately: ts << "LoadImmediately"_s; break;
case LazyImageLoadState::FullImage: ts << "FullImage"_s; break;
}
return ts;
}
static TextStream& operator<<(TextStream& ts, ImageLoading loading)
{
switch (loading) {
case ImageLoading::Immediate: ts << "Immediate"_s; break;
case ImageLoading::DeferredUntilVisible: ts << "DeferredUntilVisible"_s; break;
}
return ts;
}
#endif // !LOG_DISABLED
static ImageEventSender& loadEventSender()
{
static NeverDestroyed<ImageEventSender> sender;
return sender;
}
static inline bool NODELETE pageIsBeingDismissed(Document& document)
{
auto* frame = document.frame();
return frame && frame->loader().pageDismissalEventBeingDispatched() != FrameLoader::PageDismissalType::None;
}
// https://html.spec.whatwg.org/multipage/images.html#updating-the-image-data:list-of-available-images
static bool canReuseFromListOfAvailableImages(const CachedResourceRequest& request, Document& document)
{
RefPtr resource = MemoryCache::singleton().resourceForRequest(request.resourceRequest(), document.page()->sessionID());
if (!resource || resource->stillNeedsLoad() || resource->isPreloaded())
return false;
if (resource->options().mode == FetchOptions::Mode::Cors && !protect(document.securityOrigin())->isSameOriginAs(*protect(resource->origin())))
return false;
if (resource->options().mode != request.options().mode || resource->options().credentials != request.options().credentials)
return false;
return true;
}
ImageLoader::ImageLoader(Element& element)
: m_element(element)
, m_derefElementTimer(*this, &ImageLoader::timerFired)
, m_hasPendingBeforeLoadEvent(false)
, m_hasPendingLoadEvent(false)
, m_hasPendingErrorEvent(false)
, m_imageComplete(true)
, m_loadManually(false)
, m_elementIsProtected(false)
{
}
ImageLoader::~ImageLoader()
{
if (RefPtr image = m_image)
image->removeClient(*this);
ASSERT(m_hasPendingLoadEvent || m_hasPendingErrorEvent || !loadEventSender().hasPendingEvents(*this));
if (m_hasPendingLoadEvent || m_hasPendingErrorEvent)
loadEventSender().cancelEvent(*this);
}
void ImageLoader::ref() const
{
m_element->ref();
}
void ImageLoader::deref() const
{
m_element->deref();
}
void ImageLoader::clearImage()
{
clearImageWithoutConsideringPendingLoadEvent();
// Only consider updating the protection ref-count of the Element immediately before returning
// from this function as doing so might result in the destruction of this ImageLoader.
updatedHasPendingEvent();
}
void ImageLoader::clearImageWithoutConsideringPendingLoadEvent()
{
LOG_WITH_STREAM(LazyLoading, stream << "ImageLoader " << this << " clearImageWithoutConsideringPendingLoadEvent");
ASSERT(m_failedLoadURL.isEmpty());
if (RefPtr oldImage = std::exchange(m_image, nullptr)) {
m_hasPendingBeforeLoadEvent = false;
if (m_hasPendingLoadEvent || m_hasPendingErrorEvent) {
loadEventSender().cancelEvent(*this);
m_hasPendingLoadEvent = m_hasPendingErrorEvent = false;
}
m_imageComplete = true;
oldImage->removeClient(*this);
}
if (CheckedPtr imageResource = renderImageResource())
imageResource->resetAnimation();
}
void ImageLoader::updateFromElement(RelevantMutation relevantMutation)
{
// This is implementing https://html.spec.whatwg.org/#update-the-image-data
//
// If we're not making renderers for the page, then don't load images. We don't want to slow
// down the raw HTML parsing case by loading images we don't intend to display.
Ref element = this->element();
Ref document = element->document();
if (!document->hasLivingRenderTree())
return;
AtomString attr = element->imageSourceURL();
LOG_WITH_STREAM(LazyLoading, stream << "ImageLoader " << this << " updateFromElement, current URL is " << attr);
// Avoid loading a URL we already failed to load.
if (!m_failedLoadURL.isEmpty() && attr == m_failedLoadURL)
return;
RefPtr<CachedImage> newImage;
// Do not load any image if the 'src' attribute is missing.
if (attr.isNull()) {
didUpdateCachedImage(relevantMutation, WTF::move(newImage));
return;
}
// Fire an error event if the URL contains only whitespace.
if (StringView(attr).containsOnly<isASCIIWhitespace<char16_t>>()) {
m_failedLoadURL = attr;
m_hasPendingErrorEvent = true;
loadEventSender().dispatchEventSoon(*this, eventNames().errorEvent);
didUpdateCachedImage(relevantMutation, WTF::move(newImage));
return;
}
// Set up resource loading options.
ResourceLoaderOptions options = CachedResourceLoader::defaultCachedResourceOptions();
auto loadingForElementInShadowTree = element->isInUserAgentShadowTree() || m_elementIsUserAgentShadowRootResource;
options.contentSecurityPolicyImposition = loadingForElementInShadowTree ? ContentSecurityPolicyImposition::SkipPolicyCheck : ContentSecurityPolicyImposition::DoPolicyCheck;
options.shouldEnableContentExtensionsCheck = loadingForElementInShadowTree ? ShouldEnableContentExtensionsCheck::No : ShouldEnableContentExtensionsCheck::Yes;
options.loadedFromPluginElement = is<HTMLPlugInElement>(element) ? LoadedFromPluginElement::Yes : LoadedFromPluginElement::No;
options.sameOriginDataURLFlag = SameOriginDataURLFlag::Set;
options.serviceWorkersMode = is<HTMLPlugInElement>(element) ? ServiceWorkersMode::None : ServiceWorkersMode::All;
RefPtr imageElement = dynamicDowncast<HTMLImageElement>(element);
if (imageElement) {
options.referrerPolicy = imageElement->referrerPolicy();
options.fetchPriority = imageElement->fetchPriority();
if (imageElement->usesSrcsetOrPicture())
options.initiator = Initiator::Imageset;
}
auto crossOriginAttribute = element->attributeWithoutSynchronization(HTMLNames::crossoriginAttr);
// Use URL from original request for same URL loads in order to preserve the original base URL.
URL imageURL;
if (RefPtr image = m_image; image && attr == m_pendingURL)
imageURL = image->url();
else {
if (imageElement) {
// It is possible that attributes are bulk-set via Element::parserSetAttributes. In that case, it is possible that attribute vectors are already configured,
// but corresponding attributeChanged is not called yet. This causes inconsistency in HTMLImageElement. Eventually, we will get the consistent state, but
// if "src" attributeChanged is not called yet, imageURL can be invalid and it does not work well for ResourceRequest.
// In this case, we should behave same as attr.isNull().
imageURL = imageElement->currentURL();
if (imageURL.isNull()) {
didUpdateCachedImage(relevantMutation, WTF::move(newImage));
return;
}
} else
imageURL = document->completeURL(attr);
m_pendingURL = attr;
}
ResourceRequest resourceRequest(WTF::move(imageURL));
resourceRequest.setInspectorInitiatorNodeIdentifier(InspectorInstrumentation::identifierForNode(element));
auto request = createPotentialAccessControlRequest(WTF::move(resourceRequest), WTF::move(options), document, crossOriginAttribute);
request.setInitiator(element);
if (m_loadManually) {
Ref cachedResourceLoader = document->cachedResourceLoader();
bool autoLoadOtherImages = cachedResourceLoader->autoLoadImages();
cachedResourceLoader->setAutoLoadImages(false);
RefPtr page = m_element->document().page();
// FIXME: We shouldn't do an explicit `new` here.
newImage = adoptRef(*new CachedImage(WTF::move(request), page->sessionID(), &page->cookieJar()));
newImage->setStatus(CachedResource::Pending);
newImage->setLoading(true);
cachedResourceLoader->m_documentResources.set(newImage->url().string(), *newImage);
cachedResourceLoader->setAutoLoadImages(autoLoadOtherImages);
} else {
#if !LOG_DISABLED
auto oldState = m_lazyImageLoadState;
#endif
if (m_lazyImageLoadState == LazyImageLoadState::None && imageElement) {
if (imageElement->isLazyLoadable() && document->settings().lazyImageLoadingEnabled() && !canReuseFromListOfAvailableImages(request, document)) {
m_lazyImageLoadState = LazyImageLoadState::Deferred;
request.setIgnoreForRequestCount(true);
}
}
auto imageLoading = (m_lazyImageLoadState == LazyImageLoadState::Deferred) ? ImageLoading::DeferredUntilVisible : ImageLoading::Immediate;
newImage = protect(document->cachedResourceLoader())->requestImage(WTF::move(request), imageLoading).value_or(nullptr);
LOG_WITH_STREAM(LazyLoading, stream << "ImageLoader " << this << " updateFromElement " << element.get() << " - state changed from " << oldState << " to " << m_lazyImageLoadState << ", loading is " << imageLoading << " new image " << newImage.get());
}
#if ENABLE(MULTI_REPRESENTATION_HEIC)
// Adaptive image glyphs need to load both the high fidelity HEIC and the
// fallback PNG resource, as both resources are treated as an atomic unit.
if (imageElement && imageElement->isMultiRepresentationHEIC()) {
auto fallbackURL = imageElement->getURLAttribute(HTMLNames::srcAttr);
if (!fallbackURL.isNull()) {
ResourceLoaderOptions fallbackOptions = CachedResourceLoader::defaultCachedResourceOptions();
fallbackOptions.contentSecurityPolicyImposition = loadingForElementInShadowTree ? ContentSecurityPolicyImposition::SkipPolicyCheck : ContentSecurityPolicyImposition::DoPolicyCheck;
fallbackOptions.sameOriginDataURLFlag = SameOriginDataURLFlag::Set;
ResourceRequest fallbackResourceRequest(WTF::move(fallbackURL));
fallbackResourceRequest.setInspectorInitiatorNodeIdentifier(InspectorInstrumentation::identifierForNode(*imageElement));
auto fallbackRequest = createPotentialAccessControlRequest(WTF::move(fallbackResourceRequest), WTF::move(fallbackOptions), document, crossOriginAttribute);
fallbackRequest.setInitiator(*imageElement);
protect(document->cachedResourceLoader())->requestImage(WTF::move(fallbackRequest));
}
}
#endif
// If we do not have an image here, it means that a cross-site
// violation occurred, or that the image was blocked via Content
// Security Policy, or the page is being dismissed. Trigger an
// error event if the page is not being dismissed.
if (!newImage && !pageIsBeingDismissed(document)) {
m_failedLoadURL = attr;
m_hasPendingErrorEvent = true;
loadEventSender().dispatchEventSoon(*this, eventNames().errorEvent);
} else
clearFailedLoadURL();
didUpdateCachedImage(relevantMutation, WTF::move(newImage));
}
void ImageLoader::didUpdateCachedImage(RelevantMutation relevantMutation, RefPtr<CachedImage>&& newImage)
{
LOG_WITH_STREAM(LazyLoading, stream << "ImageLoader " << this << " didUpdateCachedImage " << newImage.get());
Ref document = element().document();
RefPtr oldImage = m_image;
if (newImage != oldImage || relevantMutation == RelevantMutation::Yes) {
LOG_WITH_STREAM(LazyLoading, stream << " switching from old image " << oldImage.get() << " to image " << newImage.get() << " " << (newImage ? newImage->url() : URL()));
m_hasPendingBeforeLoadEvent = false;
if (m_hasPendingLoadEvent) {
loadEventSender().cancelEvent(*this, eventNames().loadEvent);
m_hasPendingLoadEvent = false;
}
// Cancel error events that belong to the previous load, which is now cancelled by changing the src attribute.
// If newImage is null and m_hasPendingErrorEvent is true, we know the error event has been just posted by
// this load and we should not cancel the event.
// FIXME: If both previous load and this one got blocked with an error, we can receive one error event instead of two.
if (m_hasPendingErrorEvent && newImage) {
loadEventSender().cancelEvent(*this, eventNames().errorEvent);
m_hasPendingErrorEvent = false;
}
m_image = newImage;
m_hasPendingBeforeLoadEvent = !document->isImageDocument() && newImage;
m_hasPendingLoadEvent = newImage;
m_imageComplete = !newImage;
if (newImage) {
if (!document->isImageDocument())
dispatchPendingBeforeLoadEvent();
else
updateRenderer();
if (m_lazyImageLoadState == LazyImageLoadState::Deferred)
LazyLoadImageObserver::observe(protect(element()));
// If newImage is cached, addClient() will result in the load event
// being queued to fire.
newImage->addClient(*this);
} else
resetLazyImageLoading(protect(element().document()));
if (oldImage) {
oldImage->removeClient(*this);
updateRenderer();
}
}
if (CheckedPtr imageResource = renderImageResource())
imageResource->resetAnimation();
// Only consider updating the protection ref-count of the Element immediately before returning
// from this function as doing so might result in the destruction of this ImageLoader.
updatedHasPendingEvent();
}
void ImageLoader::updateFromElementIgnoringPreviousError(RelevantMutation relevantMutation)
{
clearFailedLoadURL();
updateFromElement(relevantMutation);
}
void ImageLoader::updateFromElementIgnoringPreviousErrorToSameValue()
{
if (!m_image || !m_image->allowsCaching() || !m_failedLoadURL.isEmpty() || element().document().activeServiceWorker()) {
updateFromElementIgnoringPreviousError(RelevantMutation::Yes);
return;
}
if (m_hasPendingLoadEvent || !m_pendingURL.isEmpty())
return;
ASSERT(m_image);
m_hasPendingLoadEvent = true;
notifyFinished(*protect(image()), NetworkLoadMetrics { });
}
static inline void resolvePromises(Vector<Ref<DeferredPromise>>& promises)
{
ASSERT(!promises.isEmpty());
auto promisesToBeResolved = std::exchange(promises, { });
for (auto& promise : promisesToBeResolved)
promise->resolve();
}
static inline void rejectPromises(Vector<Ref<DeferredPromise>>& promises, ASCIILiteral message)
{
ASSERT(!promises.isEmpty());
auto promisesToBeRejected = std::exchange(promises, { });
for (auto& promise : promisesToBeRejected)
promise->reject(Exception { ExceptionCode::EncodingError, message });
}
inline void ImageLoader::resolveDecodePromises()
{
resolvePromises(m_decodingPromises);
}
inline void ImageLoader::rejectDecodePromises(ASCIILiteral message)
{
rejectPromises(m_decodingPromises, message);
}
void ImageLoader::notifyFinished(CachedResource& resource, const NetworkLoadMetrics&, LoadWillContinueInAnotherProcess)
{
LOG_WITH_STREAM(LazyLoading, stream << "ImageLoader " << this << " notifyFinished - hasPendingLoadEvent " << m_hasPendingLoadEvent);
ASSERT(m_failedLoadURL.isEmpty());
ASSERT_UNUSED(resource, &resource == m_image.get());
m_pendingURL = { };
if (isDeferred()) {
LazyLoadImageObserver::unobserve(protect(element()), protect(document()));
m_lazyImageLoadState = LazyImageLoadState::FullImage;
LOG_WITH_STREAM(LazyLoading, stream << "ImageLoader " << this << " notifyFinished() for element " << element() << " setting lazy load state to " << m_lazyImageLoadState);
}
if (!m_hasPendingLoadEvent) {
setImageCompleteAndMaybeUpdateRenderer();
return;
}
RefPtr image = m_image;
if (image->resourceError().isAccessControl()) {
setImageCompleteAndMaybeUpdateRenderer();
auto imageURL = image->url();
clearImageWithoutConsideringPendingLoadEvent();
m_hasPendingErrorEvent = true;
loadEventSender().dispatchEventSoon(*this, eventNames().errorEvent);
auto message = makeString("Cannot load image "_s, imageURL.string(), " due to access control checks."_s);
protect(document())->addConsoleMessage(MessageSource::Security, MessageLevel::Error, message);
if (hasPendingDecodePromises())
rejectDecodePromises("Access control error."_s);
ASSERT(!m_hasPendingLoadEvent);
// Only consider updating the protection ref-count of the Element immediately before returning
// from this function as doing so might result in the destruction of this ImageLoader.
updatedHasPendingEvent();
return;
}
if (image->wasCanceled()) {
setImageCompleteAndMaybeUpdateRenderer();
if (hasPendingDecodePromises())
rejectDecodePromises("Loading was canceled."_s);
m_hasPendingLoadEvent = false;
// Only consider updating the protection ref-count of the Element immediately before returning
// from this function as doing so might result in the destruction of this ImageLoader.
updatedHasPendingEvent();
return;
}
protect(image->image())->subresourcesAreFinished(protect(document()).ptr(), [this, protectedThis = Ref { *this }]() mutable {
// It is technically possible state changed underneath us.
if (!m_hasPendingLoadEvent)
return;
setImageCompleteAndMaybeUpdateRenderer();
if (hasPendingDecodePromises())
decode();
loadEventSender().dispatchEventSoon(*this, eventNames().loadEvent);
#if ENABLE(QUICKLOOK_FULLSCREEN)
if (RefPtr page = element().document().page())
page->chrome().client().updateImageSource(protect(element()).get());
#endif
#if ENABLE(SPATIAL_IMAGE_CONTROLS)
if (RefPtr imageElement = dynamicDowncast<HTMLImageElement>(element()))
SpatialImageControls::updateSpatialImageControls(*imageElement);
#endif
});
}
RenderImageResource* ImageLoader::renderImageResource()
{
auto* renderer = element().renderer();
if (!renderer)
return nullptr;
// We don't return style generated image because it doesn't belong to the ImageLoader.
// See <https://bugs.webkit.org/show_bug.cgi?id=42840>
if (auto* renderImage = dynamicDowncast<RenderImage>(*renderer); renderImage && !renderImage->isGeneratedContent())
return &renderImage->imageResource();
if (auto* svgImage = dynamicDowncast<LegacyRenderSVGImage>(*renderer))
return &svgImage->imageResource();
if (auto* svgImage = dynamicDowncast<RenderSVGImage>(*renderer))
return &svgImage->imageResource();
#if ENABLE(VIDEO)
if (auto* renderVideo = dynamicDowncast<RenderVideo>(*renderer))
return &renderVideo->imageResource();
#endif
return nullptr;
}
void ImageLoader::updateRenderer()
{
CheckedPtr imageResource = renderImageResource();
if (!imageResource)
return;
// Only update the renderer if it doesn't have an image or if what we have
// is a complete image. This prevents flickering in the case where a dynamic
// change is happening between two images.
RefPtr cachedImage = imageResource->cachedImage();
if (m_image != cachedImage && (m_imageComplete || !cachedImage))
imageResource->setCachedImage(protect(m_image));
}
void ImageLoader::setImageCompleteAndMaybeUpdateRenderer()
{
m_imageComplete = true;
if (!hasPendingBeforeLoadEvent())
updateRenderer();
}
void ImageLoader::updatedHasPendingEvent()
{
// If an Element that does image loading is removed from the DOM the load/error event for the image is still observable.
// As long as the ImageLoader is actively loading, the Element itself needs to be ref'ed to keep it from being
// destroyed by DOM manipulation or garbage collection.
// If such an Element wishes for the load to stop when removed from the DOM it needs to stop the ImageLoader explicitly.
bool wasProtected = m_elementIsProtected;
m_elementIsProtected = hasPendingActivity();
if (wasProtected == m_elementIsProtected)
return;
if (m_elementIsProtected) {
if (m_derefElementTimer.isActive())
m_derefElementTimer.stop();
else
m_protectedElement = element();
} else {
ASSERT(!m_derefElementTimer.isActive());
m_derefElementTimer.startOneShot(0_s);
}
}
void ImageLoader::decode(Ref<DeferredPromise>&& promise)
{
m_decodingPromises.append(WTF::move(promise));
if (!element().document().window()) {
rejectDecodePromises("Inactive document."_s);
return;
}
auto attr = protect(element())->imageSourceURL();
if (StringView(attr).containsOnly<isASCIIWhitespace<char16_t>>()) {
rejectDecodePromises("Missing source URL."_s);
return;
}
if (m_imageComplete)
decode();
}
void ImageLoader::decode()
{
ASSERT(hasPendingDecodePromises());
if (!element().document().window()) {
rejectDecodePromises("Inactive document."_s);
return;
}
RefPtr image = m_image;
if (!image || !image->image() || image->errorOccurred()) {
rejectDecodePromises("Loading error."_s);
return;
}
RefPtr bitmapImage = dynamicDowncast<BitmapImage>(image->image());
if (!bitmapImage) {
resolveDecodePromises();
return;
}
bitmapImage->decode([promises = WTF::move(m_decodingPromises)](DecodingStatus decodingStatus) mutable {
ASSERT(decodingStatus != DecodingStatus::Decoding);
if (decodingStatus == DecodingStatus::Invalid)
rejectPromises(promises, "Decoding error."_s);
else
resolvePromises(promises);
});
}
void ImageLoader::timerFired()
{
m_protectedElement = nullptr;
}
bool ImageLoader::hasPendingActivity() const
{
// Because of lazy image loading, an image's load may be deferred indefinitely. To avoid leaking the element, we only
// protect it once the load has actually started.
// We are using SUPPRESS_UNCOUNTED_ARG and not ref'ing m_image here because this function
// may get called on the GC thread, and it would trip threading assertion in RefCounted.
SUPPRESS_UNCOUNTED_ARG bool imageWillBeLoadedLater = m_image && !m_image->isLoading() && m_image->stillNeedsLoad();
return (m_hasPendingLoadEvent && !imageWillBeLoadedLater) || m_hasPendingErrorEvent;
}
void ImageLoader::dispatchPendingEvent(ImageEventSender* eventSender, const AtomString& eventType)
{
ASSERT_UNUSED(eventSender, eventSender == &loadEventSender());
if (eventType == eventNames().loadEvent)
dispatchPendingLoadEvent();
if (eventType == eventNames().errorEvent)
dispatchPendingErrorEvent();
}
void ImageLoader::dispatchPendingBeforeLoadEvent()
{
if (!m_hasPendingBeforeLoadEvent)
return;
if (!m_image)
return;
if (!element().document().hasLivingRenderTree())
return;
m_hasPendingBeforeLoadEvent = false;
if (!element().isConnected())
return;
updateRenderer();
}
void ImageLoader::dispatchPendingLoadEvent()
{
if (!m_hasPendingLoadEvent)
return;
if (!m_image)
return;
m_hasPendingLoadEvent = false;
if (element().document().hasLivingRenderTree())
dispatchLoadEvent();
// Only consider updating the protection ref-count of the Element immediately before returning
// from this function as doing so might result in the destruction of this ImageLoader.
updatedHasPendingEvent();
}
void ImageLoader::dispatchPendingErrorEvent()
{
if (!m_hasPendingErrorEvent)
return;
m_hasPendingErrorEvent = false;
loadEventSender().cancelEvent(*this, eventNames().errorEvent);
if (element().document().hasLivingRenderTree())
protect(element())->dispatchEvent(Event::create(eventNames().errorEvent, Event::CanBubble::No, Event::IsCancelable::No));
// Only consider updating the protection ref-count of the Element immediately before returning
// from this function as doing so might result in the destruction of this ImageLoader.
updatedHasPendingEvent();
}
void ImageLoader::dispatchPendingLoadEvents(Page* page)
{
loadEventSender().dispatchPendingEvents(page);
}
void ImageLoader::elementDidMoveToNewDocument(Document& oldDocument)
{
clearFailedLoadURL();
clearImage();
resetLazyImageLoading(oldDocument);
}
inline void ImageLoader::clearFailedLoadURL()
{
m_failedLoadURL = nullAtom();
}
void ImageLoader::loadDeferredImage()
{
LOG_WITH_STREAM(LazyLoading, stream << "ImageLoader " << this << " loadDeferredImage - state is " << m_lazyImageLoadState);
if (m_lazyImageLoadState != LazyImageLoadState::Deferred)
return;
m_lazyImageLoadState = LazyImageLoadState::LoadImmediately;
updateFromElement(RelevantMutation::No);
}
void ImageLoader::resetLazyImageLoading(Document& document)
{
LOG_WITH_STREAM(LazyLoading, stream << "ImageLoader " << this << " resetLazyImageLoading - state is " << m_lazyImageLoadState);
if (isDeferred())
LazyLoadImageObserver::unobserve(protect(element()), document);
m_lazyImageLoadState = LazyImageLoadState::None;
}
VisibleInViewportState ImageLoader::imageVisibleInViewport(const Document& document) const
{
if (&element().document() != &document)
return VisibleInViewportState::No;
CheckedPtr renderReplaced = dynamicDowncast<RenderReplaced>(element().renderer());
return renderReplaced && renderReplaced->isContentLikelyVisibleInViewport() ? VisibleInViewportState::Yes : VisibleInViewportState::No;
}
bool ImageLoader::shouldIgnoreCandidateWhenLoadingFromArchive(const ImageCandidate& candidate) const
{
#if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
if (candidate.originAttribute == ImageCandidate::SrcOrigin)
return false;
Ref document = element().document();
RefPtr loader = document->loader();
if (!loader || !loader->hasArchiveResourceCollection())
return false;
auto candidateURL = URL { protect(element())->resolveURLStringIfNeeded(candidate.string.toString()) };
if (loader->archiveResourceForURL(candidateURL))
return false;
RefPtr page = document->page();
return !page || !page->allowsLoadFromURL(candidateURL, MainFrameMainResource::No);
#else
UNUSED_PARAM(candidate);
return false;
#endif
}
} // namespace WebCore