1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
3 /* This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
7 // Undefine windows version of LoadImage because our code uses that name.
8 #include "mozilla/ScopeExit.h"
9 #include "nsIChildChannel.h"
12 #include "imgLoader.h"
17 #include "DecoderFactory.h"
19 #include "ImageLogging.h"
20 #include "ReferrerInfo.h"
21 #include "imgRequestProxy.h"
22 #include "mozilla/Attributes.h"
23 #include "mozilla/BasePrincipal.h"
24 #include "mozilla/ChaosMode.h"
25 #include "mozilla/ClearOnShutdown.h"
26 #include "mozilla/LoadInfo.h"
27 #include "mozilla/NullPrincipal.h"
28 #include "mozilla/Preferences.h"
29 #include "mozilla/ProfilerLabels.h"
30 #include "mozilla/StaticPrefs_image.h"
31 #include "mozilla/StaticPrefs_network.h"
32 #include "mozilla/StoragePrincipalHelper.h"
33 #include "mozilla/dom/ContentParent.h"
34 #include "mozilla/dom/nsMixedContentBlocker.h"
35 #include "mozilla/image/ImageMemoryReporter.h"
36 #include "mozilla/layers/CompositorManagerChild.h"
39 #include "nsComponentManagerUtils.h"
40 #include "nsContentPolicyUtils.h"
41 #include "nsContentSecurityManager.h"
42 #include "nsContentUtils.h"
43 #include "nsHttpChannel.h"
44 #include "nsIAsyncVerifyRedirectCallback.h"
45 #include "nsICacheInfoChannel.h"
46 #include "nsIChannelEventSink.h"
47 #include "nsIClassOfService.h"
48 #include "nsIEffectiveTLDService.h"
50 #include "nsIFileURL.h"
51 #include "nsIHttpChannel.h"
52 #include "nsIInterfaceRequestor.h"
53 #include "nsIInterfaceRequestorUtils.h"
54 #include "nsIMemoryReporter.h"
55 #include "nsINetworkPredictor.h"
56 #include "nsIProgressEventSink.h"
57 #include "nsIProtocolHandler.h"
58 #include "nsImageModule.h"
59 #include "nsMediaSniffer.h"
60 #include "nsMimeTypes.h"
62 #include "nsNetUtil.h"
63 #include "nsProxyRelease.h"
64 #include "nsQueryObject.h"
65 #include "nsReadableUtils.h"
66 #include "nsStreamUtils.h"
69 // we want to explore making the document own the load group
70 // so we can associate the document URI with the load group.
71 // until this point, we have an evil hack:
72 #include "nsIHttpChannelInternal.h"
73 #include "nsILoadGroupChild.h"
74 #include "nsIDocShell.h"
76 using namespace mozilla
;
77 using namespace mozilla::dom
;
78 using namespace mozilla::image
;
79 using namespace mozilla::net
;
81 MOZ_DEFINE_MALLOC_SIZE_OF(ImagesMallocSizeOf
)
83 class imgMemoryReporter final
: public nsIMemoryReporter
{
84 ~imgMemoryReporter() = default;
89 NS_IMETHOD
CollectReports(nsIHandleReportCallback
* aHandleReport
,
90 nsISupports
* aData
, bool aAnonymize
) override
{
91 MOZ_ASSERT(NS_IsMainThread());
93 layers::CompositorManagerChild
* manager
=
94 mozilla::layers::CompositorManagerChild::GetInstance();
95 if (!manager
|| !StaticPrefs::image_mem_debug_reporting()) {
96 layers::SharedSurfacesMemoryReport sharedSurfaces
;
97 FinishCollectReports(aHandleReport
, aData
, aAnonymize
, sharedSurfaces
);
101 RefPtr
<imgMemoryReporter
> self(this);
102 nsCOMPtr
<nsIHandleReportCallback
> handleReport(aHandleReport
);
103 nsCOMPtr
<nsISupports
> data(aData
);
104 manager
->SendReportSharedSurfacesMemory(
105 [=](layers::SharedSurfacesMemoryReport aReport
) {
106 self
->FinishCollectReports(handleReport
, data
, aAnonymize
, aReport
);
108 [=](mozilla::ipc::ResponseRejectReason
&& aReason
) {
109 layers::SharedSurfacesMemoryReport sharedSurfaces
;
110 self
->FinishCollectReports(handleReport
, data
, aAnonymize
,
116 void FinishCollectReports(
117 nsIHandleReportCallback
* aHandleReport
, nsISupports
* aData
,
118 bool aAnonymize
, layers::SharedSurfacesMemoryReport
& aSharedSurfaces
) {
119 nsTArray
<ImageMemoryCounter
> chrome
;
120 nsTArray
<ImageMemoryCounter
> content
;
121 nsTArray
<ImageMemoryCounter
> uncached
;
123 for (uint32_t i
= 0; i
< mKnownLoaders
.Length(); i
++) {
124 for (imgCacheEntry
* entry
: mKnownLoaders
[i
]->mCache
.Values()) {
125 RefPtr
<imgRequest
> req
= entry
->GetRequest();
126 RecordCounterForRequest(req
, &content
, !entry
->HasNoProxies());
128 MutexAutoLock
lock(mKnownLoaders
[i
]->mUncachedImagesMutex
);
129 for (RefPtr
<imgRequest
> req
: mKnownLoaders
[i
]->mUncachedImages
) {
130 RecordCounterForRequest(req
, &uncached
, req
->HasConsumers());
134 // Note that we only need to anonymize content image URIs.
136 ReportCounterArray(aHandleReport
, aData
, chrome
, "images/chrome",
137 /* aAnonymize */ false, aSharedSurfaces
);
139 ReportCounterArray(aHandleReport
, aData
, content
, "images/content",
140 aAnonymize
, aSharedSurfaces
);
142 // Uncached images may be content or chrome, so anonymize them.
143 ReportCounterArray(aHandleReport
, aData
, uncached
, "images/uncached",
144 aAnonymize
, aSharedSurfaces
);
146 // Report any shared surfaces that were not merged with the surface cache.
147 ImageMemoryReporter::ReportSharedSurfaces(aHandleReport
, aData
,
150 nsCOMPtr
<nsIMemoryReporterManager
> imgr
=
151 do_GetService("@mozilla.org/memory-reporter-manager;1");
157 static int64_t ImagesContentUsedUncompressedDistinguishedAmount() {
159 for (uint32_t i
= 0; i
< imgLoader::sMemReporter
->mKnownLoaders
.Length();
161 for (imgCacheEntry
* entry
:
162 imgLoader::sMemReporter
->mKnownLoaders
[i
]->mCache
.Values()) {
163 if (entry
->HasNoProxies()) {
167 RefPtr
<imgRequest
> req
= entry
->GetRequest();
168 RefPtr
<image::Image
> image
= req
->GetImage();
173 // Both this and EntryImageSizes measure
174 // images/content/raster/used/decoded memory. This function's
175 // measurement is secondary -- the result doesn't go in the "explicit"
176 // tree -- so we use moz_malloc_size_of instead of ImagesMallocSizeOf to
177 // prevent DMD from seeing it reported twice.
178 SizeOfState
state(moz_malloc_size_of
);
179 ImageMemoryCounter
counter(req
, image
, state
, /* aIsUsed = */ true);
181 n
+= counter
.Values().DecodedHeap();
182 n
+= counter
.Values().DecodedNonHeap();
183 n
+= counter
.Values().DecodedUnknown();
189 void RegisterLoader(imgLoader
* aLoader
) {
190 mKnownLoaders
.AppendElement(aLoader
);
193 void UnregisterLoader(imgLoader
* aLoader
) {
194 mKnownLoaders
.RemoveElement(aLoader
);
198 nsTArray
<imgLoader
*> mKnownLoaders
;
201 MemoryTotal
& operator+=(const ImageMemoryCounter
& aImageCounter
) {
202 if (aImageCounter
.Type() == imgIContainer::TYPE_RASTER
) {
203 if (aImageCounter
.IsUsed()) {
204 mUsedRasterCounter
+= aImageCounter
.Values();
206 mUnusedRasterCounter
+= aImageCounter
.Values();
208 } else if (aImageCounter
.Type() == imgIContainer::TYPE_VECTOR
) {
209 if (aImageCounter
.IsUsed()) {
210 mUsedVectorCounter
+= aImageCounter
.Values();
212 mUnusedVectorCounter
+= aImageCounter
.Values();
214 } else if (aImageCounter
.Type() == imgIContainer::TYPE_REQUEST
) {
215 // Nothing to do, we did not get to the point of having an image.
217 MOZ_CRASH("Unexpected image type");
223 const MemoryCounter
& UsedRaster() const { return mUsedRasterCounter
; }
224 const MemoryCounter
& UnusedRaster() const { return mUnusedRasterCounter
; }
225 const MemoryCounter
& UsedVector() const { return mUsedVectorCounter
; }
226 const MemoryCounter
& UnusedVector() const { return mUnusedVectorCounter
; }
229 MemoryCounter mUsedRasterCounter
;
230 MemoryCounter mUnusedRasterCounter
;
231 MemoryCounter mUsedVectorCounter
;
232 MemoryCounter mUnusedVectorCounter
;
235 // Reports all images of a single kind, e.g. all used chrome images.
236 void ReportCounterArray(nsIHandleReportCallback
* aHandleReport
,
238 nsTArray
<ImageMemoryCounter
>& aCounterArray
,
239 const char* aPathPrefix
, bool aAnonymize
,
240 layers::SharedSurfacesMemoryReport
& aSharedSurfaces
) {
241 MemoryTotal summaryTotal
;
242 MemoryTotal nonNotableTotal
;
244 // Report notable images, and compute total and non-notable aggregate sizes.
245 for (uint32_t i
= 0; i
< aCounterArray
.Length(); i
++) {
246 ImageMemoryCounter
& counter
= aCounterArray
[i
];
249 counter
.URI().Truncate();
250 counter
.URI().AppendPrintf("<anonymized-%u>", i
);
252 // The URI could be an extremely long data: URI. Truncate if needed.
253 static const size_t max
= 256;
254 if (counter
.URI().Length() > max
) {
255 counter
.URI().Truncate(max
);
256 counter
.URI().AppendLiteral(" (truncated)");
258 counter
.URI().ReplaceChar('/', '\\');
261 summaryTotal
+= counter
;
263 if (counter
.IsNotable() || StaticPrefs::image_mem_debug_reporting()) {
264 ReportImage(aHandleReport
, aData
, aPathPrefix
, counter
,
267 ImageMemoryReporter::TrimSharedSurfaces(counter
, aSharedSurfaces
);
268 nonNotableTotal
+= counter
;
272 // Report non-notable images in aggregate.
273 ReportTotal(aHandleReport
, aData
, /* aExplicit = */ true, aPathPrefix
,
274 "<non-notable images>/", nonNotableTotal
);
276 // Report a summary in aggregate, outside of the explicit tree.
277 ReportTotal(aHandleReport
, aData
, /* aExplicit = */ false, aPathPrefix
, "",
281 static void ReportImage(nsIHandleReportCallback
* aHandleReport
,
282 nsISupports
* aData
, const char* aPathPrefix
,
283 const ImageMemoryCounter
& aCounter
,
284 layers::SharedSurfacesMemoryReport
& aSharedSurfaces
) {
285 nsAutoCString
pathPrefix("explicit/"_ns
);
286 pathPrefix
.Append(aPathPrefix
);
288 switch (aCounter
.Type()) {
289 case imgIContainer::TYPE_RASTER
:
290 pathPrefix
.AppendLiteral("/raster/");
292 case imgIContainer::TYPE_VECTOR
:
293 pathPrefix
.AppendLiteral("/vector/");
295 case imgIContainer::TYPE_REQUEST
:
296 pathPrefix
.AppendLiteral("/request/");
299 pathPrefix
.AppendLiteral("/unknown=");
300 pathPrefix
.AppendInt(aCounter
.Type());
301 pathPrefix
.AppendLiteral("/");
305 pathPrefix
.Append(aCounter
.IsUsed() ? "used/" : "unused/");
306 if (aCounter
.IsValidating()) {
307 pathPrefix
.AppendLiteral("validating/");
309 if (aCounter
.HasError()) {
310 pathPrefix
.AppendLiteral("err/");
313 pathPrefix
.AppendLiteral("progress=");
314 pathPrefix
.AppendInt(aCounter
.Progress(), 16);
315 pathPrefix
.AppendLiteral("/");
317 pathPrefix
.AppendLiteral("image(");
318 pathPrefix
.AppendInt(aCounter
.IntrinsicSize().width
);
319 pathPrefix
.AppendLiteral("x");
320 pathPrefix
.AppendInt(aCounter
.IntrinsicSize().height
);
321 pathPrefix
.AppendLiteral(", ");
323 if (aCounter
.URI().IsEmpty()) {
324 pathPrefix
.AppendLiteral("<unknown URI>");
326 pathPrefix
.Append(aCounter
.URI());
329 pathPrefix
.AppendLiteral(")/");
331 ReportSurfaces(aHandleReport
, aData
, pathPrefix
, aCounter
, aSharedSurfaces
);
333 ReportSourceValue(aHandleReport
, aData
, pathPrefix
, aCounter
.Values());
336 static void ReportSurfaces(
337 nsIHandleReportCallback
* aHandleReport
, nsISupports
* aData
,
338 const nsACString
& aPathPrefix
, const ImageMemoryCounter
& aCounter
,
339 layers::SharedSurfacesMemoryReport
& aSharedSurfaces
) {
340 for (const SurfaceMemoryCounter
& counter
: aCounter
.Surfaces()) {
341 nsAutoCString
surfacePathPrefix(aPathPrefix
);
342 switch (counter
.Type()) {
343 case SurfaceMemoryCounterType::NORMAL
:
344 if (counter
.IsLocked()) {
345 surfacePathPrefix
.AppendLiteral("locked/");
347 surfacePathPrefix
.AppendLiteral("unlocked/");
349 if (counter
.IsFactor2()) {
350 surfacePathPrefix
.AppendLiteral("factor2/");
352 if (counter
.CannotSubstitute()) {
353 surfacePathPrefix
.AppendLiteral("cannot_substitute/");
356 case SurfaceMemoryCounterType::CONTAINER
:
357 surfacePathPrefix
.AppendLiteral("container/");
360 MOZ_ASSERT_UNREACHABLE("Unknown counter type");
364 surfacePathPrefix
.AppendLiteral("types=");
365 surfacePathPrefix
.AppendInt(counter
.Values().SurfaceTypes(), 16);
366 surfacePathPrefix
.AppendLiteral("/surface(");
367 surfacePathPrefix
.AppendInt(counter
.Key().Size().width
);
368 surfacePathPrefix
.AppendLiteral("x");
369 surfacePathPrefix
.AppendInt(counter
.Key().Size().height
);
371 if (!counter
.IsFinished()) {
372 surfacePathPrefix
.AppendLiteral(", incomplete");
375 if (counter
.Values().ExternalHandles() > 0) {
376 surfacePathPrefix
.AppendLiteral(", handles:");
377 surfacePathPrefix
.AppendInt(
378 uint32_t(counter
.Values().ExternalHandles()));
381 ImageMemoryReporter::AppendSharedSurfacePrefix(surfacePathPrefix
, counter
,
384 PlaybackType playback
= counter
.Key().Playback();
385 if (playback
== PlaybackType::eAnimated
) {
386 if (StaticPrefs::image_mem_debug_reporting()) {
387 surfacePathPrefix
.AppendPrintf(
388 " (animation %4u)", uint32_t(counter
.Values().FrameIndex()));
390 surfacePathPrefix
.AppendLiteral(" (animation)");
394 if (counter
.Key().Flags() != DefaultSurfaceFlags()) {
395 surfacePathPrefix
.AppendLiteral(", flags:");
396 surfacePathPrefix
.AppendInt(uint32_t(counter
.Key().Flags()),
400 if (counter
.Key().Region()) {
401 const ImageIntRegion
& region
= counter
.Key().Region().ref();
402 const gfx::IntRect
& rect
= region
.Rect();
403 surfacePathPrefix
.AppendLiteral(", region:[ rect=(");
404 surfacePathPrefix
.AppendInt(rect
.x
);
405 surfacePathPrefix
.AppendLiteral(",");
406 surfacePathPrefix
.AppendInt(rect
.y
);
407 surfacePathPrefix
.AppendLiteral(") ");
408 surfacePathPrefix
.AppendInt(rect
.width
);
409 surfacePathPrefix
.AppendLiteral("x");
410 surfacePathPrefix
.AppendInt(rect
.height
);
411 if (region
.IsRestricted()) {
412 const gfx::IntRect
& restrict
= region
.Restriction();
413 if (restrict
== rect
) {
414 surfacePathPrefix
.AppendLiteral(", restrict=rect");
416 surfacePathPrefix
.AppendLiteral(", restrict=(");
417 surfacePathPrefix
.AppendInt(restrict
.x
);
418 surfacePathPrefix
.AppendLiteral(",");
419 surfacePathPrefix
.AppendInt(restrict
.y
);
420 surfacePathPrefix
.AppendLiteral(") ");
421 surfacePathPrefix
.AppendInt(restrict
.width
);
422 surfacePathPrefix
.AppendLiteral("x");
423 surfacePathPrefix
.AppendInt(restrict
.height
);
426 if (region
.GetExtendMode() != gfx::ExtendMode::CLAMP
) {
427 surfacePathPrefix
.AppendLiteral(", extendMode=");
428 surfacePathPrefix
.AppendInt(int32_t(region
.GetExtendMode()));
430 surfacePathPrefix
.AppendLiteral("]");
433 const SVGImageContext
& context
= counter
.Key().SVGContext();
434 surfacePathPrefix
.AppendLiteral(", svgContext:[ ");
435 if (context
.GetViewportSize()) {
436 const CSSIntSize
& size
= context
.GetViewportSize().ref();
437 surfacePathPrefix
.AppendLiteral("viewport=(");
438 surfacePathPrefix
.AppendInt(size
.width
);
439 surfacePathPrefix
.AppendLiteral("x");
440 surfacePathPrefix
.AppendInt(size
.height
);
441 surfacePathPrefix
.AppendLiteral(") ");
443 if (context
.GetPreserveAspectRatio()) {
445 context
.GetPreserveAspectRatio()->ToString(aspect
);
446 surfacePathPrefix
.AppendLiteral("preserveAspectRatio=(");
447 LossyAppendUTF16toASCII(aspect
, surfacePathPrefix
);
448 surfacePathPrefix
.AppendLiteral(") ");
450 if (auto scheme
= context
.GetColorScheme()) {
451 surfacePathPrefix
.AppendLiteral("colorScheme=");
452 surfacePathPrefix
.AppendInt(int32_t(*scheme
));
453 surfacePathPrefix
.AppendLiteral(" ");
455 if (context
.GetContextPaint()) {
456 const SVGEmbeddingContextPaint
* paint
= context
.GetContextPaint();
457 surfacePathPrefix
.AppendLiteral("contextPaint=(");
458 if (paint
->GetFill()) {
459 surfacePathPrefix
.AppendLiteral(" fill=");
460 surfacePathPrefix
.AppendInt(paint
->GetFill()->ToABGR(), 16);
462 if (paint
->GetFillOpacity() != 1.0) {
463 surfacePathPrefix
.AppendLiteral(" fillOpa=");
464 surfacePathPrefix
.AppendFloat(paint
->GetFillOpacity());
466 if (paint
->GetStroke()) {
467 surfacePathPrefix
.AppendLiteral(" stroke=");
468 surfacePathPrefix
.AppendInt(paint
->GetStroke()->ToABGR(), 16);
470 if (paint
->GetStrokeOpacity() != 1.0) {
471 surfacePathPrefix
.AppendLiteral(" strokeOpa=");
472 surfacePathPrefix
.AppendFloat(paint
->GetStrokeOpacity());
474 surfacePathPrefix
.AppendLiteral(" ) ");
476 surfacePathPrefix
.AppendLiteral("]");
478 surfacePathPrefix
.AppendLiteral(")/");
480 ReportValues(aHandleReport
, aData
, surfacePathPrefix
, counter
.Values());
484 static void ReportTotal(nsIHandleReportCallback
* aHandleReport
,
485 nsISupports
* aData
, bool aExplicit
,
486 const char* aPathPrefix
, const char* aPathInfix
,
487 const MemoryTotal
& aTotal
) {
488 nsAutoCString pathPrefix
;
490 pathPrefix
.AppendLiteral("explicit/");
492 pathPrefix
.Append(aPathPrefix
);
494 nsAutoCString
rasterUsedPrefix(pathPrefix
);
495 rasterUsedPrefix
.AppendLiteral("/raster/used/");
496 rasterUsedPrefix
.Append(aPathInfix
);
497 ReportValues(aHandleReport
, aData
, rasterUsedPrefix
, aTotal
.UsedRaster());
499 nsAutoCString
rasterUnusedPrefix(pathPrefix
);
500 rasterUnusedPrefix
.AppendLiteral("/raster/unused/");
501 rasterUnusedPrefix
.Append(aPathInfix
);
502 ReportValues(aHandleReport
, aData
, rasterUnusedPrefix
,
503 aTotal
.UnusedRaster());
505 nsAutoCString
vectorUsedPrefix(pathPrefix
);
506 vectorUsedPrefix
.AppendLiteral("/vector/used/");
507 vectorUsedPrefix
.Append(aPathInfix
);
508 ReportValues(aHandleReport
, aData
, vectorUsedPrefix
, aTotal
.UsedVector());
510 nsAutoCString
vectorUnusedPrefix(pathPrefix
);
511 vectorUnusedPrefix
.AppendLiteral("/vector/unused/");
512 vectorUnusedPrefix
.Append(aPathInfix
);
513 ReportValues(aHandleReport
, aData
, vectorUnusedPrefix
,
514 aTotal
.UnusedVector());
517 static void ReportValues(nsIHandleReportCallback
* aHandleReport
,
518 nsISupports
* aData
, const nsACString
& aPathPrefix
,
519 const MemoryCounter
& aCounter
) {
520 ReportSourceValue(aHandleReport
, aData
, aPathPrefix
, aCounter
);
522 ReportValue(aHandleReport
, aData
, KIND_HEAP
, aPathPrefix
, "decoded-heap",
523 "Decoded image data which is stored on the heap.",
524 aCounter
.DecodedHeap());
526 ReportValue(aHandleReport
, aData
, KIND_NONHEAP
, aPathPrefix
,
528 "Decoded image data which isn't stored on the heap.",
529 aCounter
.DecodedNonHeap());
531 // We don't know for certain whether or not it is on the heap, so let's
532 // just report it as non-heap for reporting purposes.
533 ReportValue(aHandleReport
, aData
, KIND_NONHEAP
, aPathPrefix
,
535 "Decoded image data which is unknown to be on the heap or not.",
536 aCounter
.DecodedUnknown());
539 static void ReportSourceValue(nsIHandleReportCallback
* aHandleReport
,
541 const nsACString
& aPathPrefix
,
542 const MemoryCounter
& aCounter
) {
543 ReportValue(aHandleReport
, aData
, KIND_HEAP
, aPathPrefix
, "source",
544 "Raster image source data and vector image documents.",
548 static void ReportValue(nsIHandleReportCallback
* aHandleReport
,
549 nsISupports
* aData
, int32_t aKind
,
550 const nsACString
& aPathPrefix
,
551 const char* aPathSuffix
, const char* aDescription
,
557 nsAutoCString
desc(aDescription
);
558 nsAutoCString
path(aPathPrefix
);
559 path
.Append(aPathSuffix
);
561 aHandleReport
->Callback(""_ns
, path
, aKind
, UNITS_BYTES
, aValue
, desc
,
565 static void RecordCounterForRequest(imgRequest
* aRequest
,
566 nsTArray
<ImageMemoryCounter
>* aArray
,
568 SizeOfState
state(ImagesMallocSizeOf
);
569 RefPtr
<image::Image
> image
= aRequest
->GetImage();
571 ImageMemoryCounter
counter(aRequest
, image
, state
, aIsUsed
);
572 aArray
->AppendElement(std::move(counter
));
574 // We can at least record some information about the image from the
575 // request, and mark it as not knowing the image type yet.
576 ImageMemoryCounter
counter(aRequest
, state
, aIsUsed
);
577 aArray
->AppendElement(std::move(counter
));
582 NS_IMPL_ISUPPORTS(imgMemoryReporter
, nsIMemoryReporter
)
584 NS_IMPL_ISUPPORTS(nsProgressNotificationProxy
, nsIProgressEventSink
,
585 nsIChannelEventSink
, nsIInterfaceRequestor
)
588 nsProgressNotificationProxy::OnProgress(nsIRequest
* request
, int64_t progress
,
589 int64_t progressMax
) {
590 nsCOMPtr
<nsILoadGroup
> loadGroup
;
591 request
->GetLoadGroup(getter_AddRefs(loadGroup
));
593 nsCOMPtr
<nsIProgressEventSink
> target
;
594 NS_QueryNotificationCallbacks(mOriginalCallbacks
, loadGroup
,
595 NS_GET_IID(nsIProgressEventSink
),
596 getter_AddRefs(target
));
600 return target
->OnProgress(mImageRequest
, progress
, progressMax
);
604 nsProgressNotificationProxy::OnStatus(nsIRequest
* request
, nsresult status
,
605 const char16_t
* statusArg
) {
606 nsCOMPtr
<nsILoadGroup
> loadGroup
;
607 request
->GetLoadGroup(getter_AddRefs(loadGroup
));
609 nsCOMPtr
<nsIProgressEventSink
> target
;
610 NS_QueryNotificationCallbacks(mOriginalCallbacks
, loadGroup
,
611 NS_GET_IID(nsIProgressEventSink
),
612 getter_AddRefs(target
));
616 return target
->OnStatus(mImageRequest
, status
, statusArg
);
620 nsProgressNotificationProxy::AsyncOnChannelRedirect(
621 nsIChannel
* oldChannel
, nsIChannel
* newChannel
, uint32_t flags
,
622 nsIAsyncVerifyRedirectCallback
* cb
) {
623 // Tell the original original callbacks about it too
624 nsCOMPtr
<nsILoadGroup
> loadGroup
;
625 newChannel
->GetLoadGroup(getter_AddRefs(loadGroup
));
626 nsCOMPtr
<nsIChannelEventSink
> target
;
627 NS_QueryNotificationCallbacks(mOriginalCallbacks
, loadGroup
,
628 NS_GET_IID(nsIChannelEventSink
),
629 getter_AddRefs(target
));
631 cb
->OnRedirectVerifyCallback(NS_OK
);
635 // Delegate to |target| if set, reusing |cb|
636 return target
->AsyncOnChannelRedirect(oldChannel
, newChannel
, flags
, cb
);
640 nsProgressNotificationProxy::GetInterface(const nsIID
& iid
, void** result
) {
641 if (iid
.Equals(NS_GET_IID(nsIProgressEventSink
))) {
642 *result
= static_cast<nsIProgressEventSink
*>(this);
646 if (iid
.Equals(NS_GET_IID(nsIChannelEventSink
))) {
647 *result
= static_cast<nsIChannelEventSink
*>(this);
651 if (mOriginalCallbacks
) {
652 return mOriginalCallbacks
->GetInterface(iid
, result
);
654 return NS_NOINTERFACE
;
657 static void NewRequestAndEntry(bool aForcePrincipalCheckForCacheEntry
,
658 imgLoader
* aLoader
, const ImageCacheKey
& aKey
,
659 imgRequest
** aRequest
, imgCacheEntry
** aEntry
) {
660 RefPtr
<imgRequest
> request
= new imgRequest(aLoader
, aKey
);
661 RefPtr
<imgCacheEntry
> entry
=
662 new imgCacheEntry(aLoader
, request
, aForcePrincipalCheckForCacheEntry
);
663 aLoader
->AddToUncachedImages(request
);
664 request
.forget(aRequest
);
665 entry
.forget(aEntry
);
668 static bool ShouldRevalidateEntry(imgCacheEntry
* aEntry
, nsLoadFlags aFlags
,
670 if (aFlags
& nsIRequest::LOAD_BYPASS_CACHE
) {
673 if (aFlags
& nsIRequest::VALIDATE_ALWAYS
) {
676 if (aEntry
->GetMustValidate()) {
680 // The cache entry has expired... Determine whether the stale cache
681 // entry can be used without validation...
682 if (aFlags
& (nsIRequest::LOAD_FROM_CACHE
| nsIRequest::VALIDATE_NEVER
|
683 nsIRequest::VALIDATE_ONCE_PER_SESSION
)) {
684 // LOAD_FROM_CACHE, VALIDATE_NEVER and VALIDATE_ONCE_PER_SESSION allow
685 // stale cache entries to be used unless they have been explicitly marked
686 // to indicate that revalidation is necessary.
689 // Entry is expired, revalidate.
695 /* Call content policies on cached images that went through a redirect */
696 static bool ShouldLoadCachedImage(imgRequest
* aImgRequest
,
697 Document
* aLoadingDocument
,
698 nsIPrincipal
* aTriggeringPrincipal
,
699 nsContentPolicyType aPolicyType
,
700 bool aSendCSPViolationReports
) {
701 /* Call content policies on cached images - Bug 1082837
702 * Cached images are keyed off of the first uri in a redirect chain.
703 * Hence content policies don't get a chance to test the intermediate hops
704 * or the final destination. Here we test the final destination using
705 * mFinalURI off of the imgRequest and passing it into content policies.
706 * For Mixed Content Blocker, we do an additional check to determine if any
707 * of the intermediary hops went through an insecure redirect with the
708 * mHadInsecureRedirect flag
710 bool insecureRedirect
= aImgRequest
->HadInsecureRedirect();
711 nsCOMPtr
<nsIURI
> contentLocation
;
712 aImgRequest
->GetFinalURI(getter_AddRefs(contentLocation
));
715 nsCOMPtr
<nsIPrincipal
> loadingPrincipal
=
716 aLoadingDocument
? aLoadingDocument
->NodePrincipal()
717 : aTriggeringPrincipal
;
718 // If there is no context and also no triggeringPrincipal, then we use a fresh
719 // nullPrincipal as the loadingPrincipal because we can not create a loadinfo
720 // without a valid loadingPrincipal.
721 if (!loadingPrincipal
) {
722 loadingPrincipal
= NullPrincipal::CreateWithoutOriginAttributes();
725 nsCOMPtr
<nsILoadInfo
> secCheckLoadInfo
= new LoadInfo(
726 loadingPrincipal
, aTriggeringPrincipal
, aLoadingDocument
,
727 nsILoadInfo::SEC_ONLY_FOR_EXPLICIT_CONTENTSEC_CHECK
, aPolicyType
);
729 secCheckLoadInfo
->SetSendCSPViolationEvents(aSendCSPViolationReports
);
731 int16_t decision
= nsIContentPolicy::REJECT_REQUEST
;
732 rv
= NS_CheckContentLoadPolicy(contentLocation
, secCheckLoadInfo
,
734 &decision
, nsContentUtils::GetContentPolicy());
735 if (NS_FAILED(rv
) || !NS_CP_ACCEPTED(decision
)) {
739 // We call all Content Policies above, but we also have to call mcb
740 // individually to check the intermediary redirect hops are secure.
741 if (insecureRedirect
) {
742 // Bug 1314356: If the image ended up in the cache upgraded by HSTS and the
743 // page uses upgrade-inscure-requests it had an insecure redirect
744 // (http->https). We need to invalidate the image and reload it because
745 // mixed content blocker only bails if upgrade-insecure-requests is set on
746 // the doc and the resource load is http: which would result in an incorrect
747 // mixed content warning.
748 nsCOMPtr
<nsIDocShell
> docShell
=
749 NS_CP_GetDocShellFromContext(ToSupports(aLoadingDocument
));
751 Document
* document
= docShell
->GetDocument();
752 if (document
&& document
->GetUpgradeInsecureRequests(false)) {
757 if (!aTriggeringPrincipal
|| !aTriggeringPrincipal
->IsSystemPrincipal()) {
758 // reset the decision for mixed content blocker check
759 decision
= nsIContentPolicy::REJECT_REQUEST
;
760 rv
= nsMixedContentBlocker::ShouldLoad(insecureRedirect
, contentLocation
,
763 true, // aReportError
765 if (NS_FAILED(rv
) || !NS_CP_ACCEPTED(decision
)) {
774 // Returns true if this request is compatible with the given CORS mode on the
775 // given loading principal, and false if the request may not be reused due
777 static bool ValidateCORSMode(imgRequest
* aRequest
, bool aForcePrincipalCheck
,
779 nsIPrincipal
* aTriggeringPrincipal
) {
780 // If the entry's CORS mode doesn't match, or the CORS mode matches but the
781 // document principal isn't the same, we can't use this request.
782 if (aRequest
->GetCORSMode() != aCORSMode
) {
786 if (aRequest
->GetCORSMode() != CORS_NONE
|| aForcePrincipalCheck
) {
787 nsCOMPtr
<nsIPrincipal
> otherprincipal
= aRequest
->GetTriggeringPrincipal();
789 // If we previously had a principal, but we don't now, we can't use this
791 if (otherprincipal
&& !aTriggeringPrincipal
) {
795 if (otherprincipal
&& aTriggeringPrincipal
&&
796 !otherprincipal
->Equals(aTriggeringPrincipal
)) {
804 static bool ValidateSecurityInfo(imgRequest
* aRequest
,
805 bool aForcePrincipalCheck
, CORSMode aCORSMode
,
806 nsIPrincipal
* aTriggeringPrincipal
,
807 Document
* aLoadingDocument
,
808 nsContentPolicyType aPolicyType
) {
809 if (!ValidateCORSMode(aRequest
, aForcePrincipalCheck
, aCORSMode
,
810 aTriggeringPrincipal
)) {
813 // Content Policy Check on Cached Images
814 return ShouldLoadCachedImage(aRequest
, aLoadingDocument
, aTriggeringPrincipal
,
816 /* aSendCSPViolationReports */ false);
819 static nsresult
NewImageChannel(
820 nsIChannel
** aResult
,
821 // If aForcePrincipalCheckForCacheEntry is true, then we will
822 // force a principal check even when not using CORS before
823 // assuming we have a cache hit on a cache entry that we
824 // create for this channel. This is an out param that should
825 // be set to true if this channel ends up depending on
826 // aTriggeringPrincipal and false otherwise.
827 bool* aForcePrincipalCheckForCacheEntry
, nsIURI
* aURI
,
828 nsIURI
* aInitialDocumentURI
, CORSMode aCORSMode
,
829 nsIReferrerInfo
* aReferrerInfo
, nsILoadGroup
* aLoadGroup
,
830 nsLoadFlags aLoadFlags
, nsContentPolicyType aPolicyType
,
831 nsIPrincipal
* aTriggeringPrincipal
, nsINode
* aRequestingNode
,
832 bool aRespectPrivacy
, uint64_t aEarlyHintPreloaderId
) {
836 nsCOMPtr
<nsIHttpChannel
> newHttpChannel
;
838 nsCOMPtr
<nsIInterfaceRequestor
> callbacks
;
841 // Get the notification callbacks from the load group for the new channel.
843 // XXX: This is not exactly correct, because the network request could be
844 // referenced by multiple windows... However, the new channel needs
845 // something. So, using the 'first' notification callbacks is better
848 aLoadGroup
->GetNotificationCallbacks(getter_AddRefs(callbacks
));
851 // Pass in a nullptr loadgroup because this is the underlying network
852 // request. This request may be referenced by several proxy image requests
853 // (possibly in different documents).
854 // If all of the proxy requests are canceled then this request should be
858 nsSecurityFlags securityFlags
=
859 nsContentSecurityManager::ComputeSecurityFlags(
860 aCORSMode
, nsContentSecurityManager::CORSSecurityMapping::
861 CORS_NONE_MAPS_TO_INHERITED_CONTEXT
);
863 securityFlags
|= nsILoadInfo::SEC_ALLOW_CHROME
;
865 // Note we are calling NS_NewChannelWithTriggeringPrincipal() here with a
866 // node and a principal. This is for things like background images that are
867 // specified by user stylesheets, where the document is being styled, but
868 // the principal is that of the user stylesheet.
869 if (aRequestingNode
&& aTriggeringPrincipal
) {
870 rv
= NS_NewChannelWithTriggeringPrincipal(aResult
, aURI
, aRequestingNode
,
871 aTriggeringPrincipal
,
872 securityFlags
, aPolicyType
,
873 nullptr, // PerformanceStorage
874 nullptr, // loadGroup
875 callbacks
, aLoadFlags
);
881 if (aPolicyType
== nsIContentPolicy::TYPE_INTERNAL_IMAGE_FAVICON
) {
882 // If this is a favicon loading, we will use the originAttributes from the
883 // triggeringPrincipal as the channel's originAttributes. This allows the
884 // favicon loading from XUL will use the correct originAttributes.
886 nsCOMPtr
<nsILoadInfo
> loadInfo
= (*aResult
)->LoadInfo();
887 rv
= loadInfo
->SetOriginAttributes(
888 aTriggeringPrincipal
->OriginAttributesRef());
891 // either we are loading something inside a document, in which case
892 // we should always have a requestingNode, or we are loading something
893 // outside a document, in which case the triggeringPrincipal and
894 // triggeringPrincipal should always be the systemPrincipal.
895 // However, there are exceptions: one is Notifications which create a
896 // channel in the parent process in which case we can't get a
898 rv
= NS_NewChannel(aResult
, aURI
, nsContentUtils::GetSystemPrincipal(),
899 securityFlags
, aPolicyType
,
900 nullptr, // nsICookieJarSettings
901 nullptr, // PerformanceStorage
902 nullptr, // loadGroup
903 callbacks
, aLoadFlags
);
909 // Use the OriginAttributes from the loading principal, if one is available,
910 // and adjust the private browsing ID based on what kind of load the caller
911 // has asked us to perform.
912 OriginAttributes attrs
;
913 if (aTriggeringPrincipal
) {
914 attrs
= aTriggeringPrincipal
->OriginAttributesRef();
916 attrs
.mPrivateBrowsingId
= aRespectPrivacy
? 1 : 0;
918 nsCOMPtr
<nsILoadInfo
> loadInfo
= (*aResult
)->LoadInfo();
919 rv
= loadInfo
->SetOriginAttributes(attrs
);
926 // only inherit if we have a principal
927 *aForcePrincipalCheckForCacheEntry
=
928 aTriggeringPrincipal
&& nsContentUtils::ChannelShouldInheritPrincipal(
929 aTriggeringPrincipal
, aURI
,
930 /* aInheritForAboutBlank */ false,
931 /* aForceInherit */ false);
933 // Initialize HTTP-specific attributes
934 newHttpChannel
= do_QueryInterface(*aResult
);
935 if (newHttpChannel
) {
936 nsCOMPtr
<nsIHttpChannelInternal
> httpChannelInternal
=
937 do_QueryInterface(newHttpChannel
);
938 NS_ENSURE_TRUE(httpChannelInternal
, NS_ERROR_UNEXPECTED
);
939 rv
= httpChannelInternal
->SetDocumentURI(aInitialDocumentURI
);
940 MOZ_ASSERT(NS_SUCCEEDED(rv
));
942 DebugOnly
<nsresult
> rv
= newHttpChannel
->SetReferrerInfo(aReferrerInfo
);
943 MOZ_ASSERT(NS_SUCCEEDED(rv
));
946 if (aEarlyHintPreloaderId
) {
947 rv
= httpChannelInternal
->SetEarlyHintPreloaderId(aEarlyHintPreloaderId
);
948 NS_ENSURE_SUCCESS(rv
, rv
);
952 // Image channels are loaded by default with reduced priority.
953 nsCOMPtr
<nsISupportsPriority
> p
= do_QueryInterface(*aResult
);
955 uint32_t priority
= nsISupportsPriority::PRIORITY_LOW
;
957 if (aLoadFlags
& nsIRequest::LOAD_BACKGROUND
) {
958 ++priority
; // further reduce priority for background loads
961 p
->AdjustPriority(priority
);
964 // Create a new loadgroup for this new channel, using the old group as
965 // the parent. The indirection keeps the channel insulated from cancels,
966 // but does allow a way for this revalidation to be associated with at
967 // least one base load group for scheduling/caching purposes.
969 nsCOMPtr
<nsILoadGroup
> loadGroup
= do_CreateInstance(NS_LOADGROUP_CONTRACTID
);
970 nsCOMPtr
<nsILoadGroupChild
> childLoadGroup
= do_QueryInterface(loadGroup
);
971 if (childLoadGroup
) {
972 childLoadGroup
->SetParentLoadGroup(aLoadGroup
);
974 (*aResult
)->SetLoadGroup(loadGroup
);
979 static uint32_t SecondsFromPRTime(PRTime aTime
) {
980 return nsContentUtils::SecondsFromPRTime(aTime
);
984 imgCacheEntry::imgCacheEntry(imgLoader
* loader
, imgRequest
* request
,
985 bool forcePrincipalCheck
)
989 mTouchedTime(SecondsFromPRTime(PR_Now())),
990 mLoadTime(SecondsFromPRTime(PR_Now())),
992 mMustValidate(false),
993 // We start off as evicted so we don't try to update the cache.
994 // PutIntoCache will set this to false.
997 mForcePrincipalCheck(forcePrincipalCheck
),
998 mHasNotified(false) {}
1000 imgCacheEntry::~imgCacheEntry() {
1001 LOG_FUNC(gImgLog
, "imgCacheEntry::~imgCacheEntry()");
1004 void imgCacheEntry::Touch(bool updateTime
/* = true */) {
1005 LOG_SCOPE(gImgLog
, "imgCacheEntry::Touch");
1008 mTouchedTime
= SecondsFromPRTime(PR_Now());
1014 void imgCacheEntry::UpdateCache(int32_t diff
/* = 0 */) {
1015 // Don't update the cache if we've been removed from it or it doesn't care
1016 // about our size or usage.
1017 if (!Evicted() && HasNoProxies()) {
1018 mLoader
->CacheEntriesChanged(diff
);
1022 void imgCacheEntry::UpdateLoadTime() {
1023 mLoadTime
= SecondsFromPRTime(PR_Now());
1026 void imgCacheEntry::SetHasNoProxies(bool hasNoProxies
) {
1027 if (MOZ_LOG_TEST(gImgLog
, LogLevel::Debug
)) {
1029 LOG_FUNC_WITH_PARAM(gImgLog
, "imgCacheEntry::SetHasNoProxies true", "uri",
1030 mRequest
->CacheKey().URI());
1032 LOG_FUNC_WITH_PARAM(gImgLog
, "imgCacheEntry::SetHasNoProxies false",
1033 "uri", mRequest
->CacheKey().URI());
1037 mHasNoProxies
= hasNoProxies
;
1040 imgCacheQueue::imgCacheQueue() : mDirty(false), mSize(0) {}
1042 void imgCacheQueue::UpdateSize(int32_t diff
) { mSize
+= diff
; }
1044 uint32_t imgCacheQueue::GetSize() const { return mSize
; }
1046 void imgCacheQueue::Remove(imgCacheEntry
* entry
) {
1047 uint64_t index
= mQueue
.IndexOf(entry
);
1048 if (index
== queueContainer::NoIndex
) {
1052 mSize
-= mQueue
[index
]->GetDataSize();
1054 // If the queue is clean and this is the first entry,
1055 // then we can efficiently remove the entry without
1056 // dirtying the sort order.
1057 if (!IsDirty() && index
== 0) {
1058 std::pop_heap(mQueue
.begin(), mQueue
.end(), imgLoader::CompareCacheEntries
);
1059 mQueue
.RemoveLastElement();
1063 // Remove from the middle of the list. This potentially
1064 // breaks the binary heap sort order.
1065 mQueue
.RemoveElementAt(index
);
1067 // If we only have one entry or the queue is empty, though,
1068 // then the sort order is still effectively good. Simply
1069 // refresh the list to clear the dirty flag.
1070 if (mQueue
.Length() <= 1) {
1075 // Otherwise we must mark the queue dirty and potentially
1076 // trigger an expensive sort later.
1080 void imgCacheQueue::Push(imgCacheEntry
* entry
) {
1081 mSize
+= entry
->GetDataSize();
1083 RefPtr
<imgCacheEntry
> refptr(entry
);
1084 mQueue
.AppendElement(std::move(refptr
));
1085 // If we're not dirty already, then we can efficiently add this to the
1086 // binary heap immediately. This is only O(log n).
1088 std::push_heap(mQueue
.begin(), mQueue
.end(),
1089 imgLoader::CompareCacheEntries
);
1093 already_AddRefed
<imgCacheEntry
> imgCacheQueue::Pop() {
1094 if (mQueue
.IsEmpty()) {
1101 std::pop_heap(mQueue
.begin(), mQueue
.end(), imgLoader::CompareCacheEntries
);
1102 RefPtr
<imgCacheEntry
> entry
= mQueue
.PopLastElement();
1104 mSize
-= entry
->GetDataSize();
1105 return entry
.forget();
1108 void imgCacheQueue::Refresh() {
1109 // Resort the list. This is an O(3 * n) operation and best avoided
1111 std::make_heap(mQueue
.begin(), mQueue
.end(), imgLoader::CompareCacheEntries
);
1115 void imgCacheQueue::MarkDirty() { mDirty
= true; }
1117 bool imgCacheQueue::IsDirty() { return mDirty
; }
1119 uint32_t imgCacheQueue::GetNumElements() const { return mQueue
.Length(); }
1121 bool imgCacheQueue::Contains(imgCacheEntry
* aEntry
) const {
1122 return mQueue
.Contains(aEntry
);
1125 imgCacheQueue::iterator
imgCacheQueue::begin() { return mQueue
.begin(); }
1127 imgCacheQueue::const_iterator
imgCacheQueue::begin() const {
1128 return mQueue
.begin();
1131 imgCacheQueue::iterator
imgCacheQueue::end() { return mQueue
.end(); }
1133 imgCacheQueue::const_iterator
imgCacheQueue::end() const {
1134 return mQueue
.end();
1137 nsresult
imgLoader::CreateNewProxyForRequest(
1138 imgRequest
* aRequest
, nsIURI
* aURI
, nsILoadGroup
* aLoadGroup
,
1139 Document
* aLoadingDocument
, imgINotificationObserver
* aObserver
,
1140 nsLoadFlags aLoadFlags
, imgRequestProxy
** _retval
) {
1141 LOG_SCOPE_WITH_PARAM(gImgLog
, "imgLoader::CreateNewProxyForRequest",
1142 "imgRequest", aRequest
);
1144 /* XXX If we move decoding onto separate threads, we should save off the
1145 calling thread here and pass it off to |proxyRequest| so that it call
1146 proxy calls to |aObserver|.
1149 RefPtr
<imgRequestProxy
> proxyRequest
= new imgRequestProxy();
1151 /* It is important to call |SetLoadFlags()| before calling |Init()| because
1152 |Init()| adds the request to the loadgroup.
1154 proxyRequest
->SetLoadFlags(aLoadFlags
);
1156 // init adds itself to imgRequest's list of observers
1157 nsresult rv
= proxyRequest
->Init(aRequest
, aLoadGroup
, aURI
, aObserver
);
1158 if (NS_WARN_IF(NS_FAILED(rv
))) {
1162 proxyRequest
.forget(_retval
);
1166 class imgCacheExpirationTracker final
1167 : public nsExpirationTracker
<imgCacheEntry
, 3> {
1168 enum { TIMEOUT_SECONDS
= 10 };
1171 imgCacheExpirationTracker();
1174 void NotifyExpired(imgCacheEntry
* entry
) override
;
1177 imgCacheExpirationTracker::imgCacheExpirationTracker()
1178 : nsExpirationTracker
<imgCacheEntry
, 3>(TIMEOUT_SECONDS
* 1000,
1179 "imgCacheExpirationTracker") {}
1181 void imgCacheExpirationTracker::NotifyExpired(imgCacheEntry
* entry
) {
1182 // Hold on to a reference to this entry, because the expiration tracker
1183 // mechanism doesn't.
1184 RefPtr
<imgCacheEntry
> kungFuDeathGrip(entry
);
1186 if (MOZ_LOG_TEST(gImgLog
, LogLevel::Debug
)) {
1187 RefPtr
<imgRequest
> req
= entry
->GetRequest();
1189 LOG_FUNC_WITH_PARAM(gImgLog
, "imgCacheExpirationTracker::NotifyExpired",
1190 "entry", req
->CacheKey().URI());
1194 // We can be called multiple times on the same entry. Don't do work multiple
1196 if (!entry
->Evicted()) {
1197 entry
->Loader()->RemoveFromCache(entry
);
1200 entry
->Loader()->VerifyCacheSizes();
1203 ///////////////////////////////////////////////////////////////////////////////
1205 ///////////////////////////////////////////////////////////////////////////////
1207 double imgLoader::sCacheTimeWeight
;
1208 uint32_t imgLoader::sCacheMaxSize
;
1209 imgMemoryReporter
* imgLoader::sMemReporter
;
1211 NS_IMPL_ISUPPORTS(imgLoader
, imgILoader
, nsIContentSniffer
, imgICache
,
1212 nsISupportsWeakReference
, nsIObserver
)
1214 static imgLoader
* gNormalLoader
= nullptr;
1215 static imgLoader
* gPrivateBrowsingLoader
= nullptr;
1218 already_AddRefed
<imgLoader
> imgLoader::CreateImageLoader() {
1219 // In some cases, such as xpctests, XPCOM modules are not automatically
1220 // initialized. We need to make sure that our module is initialized before
1221 // we hand out imgLoader instances and code starts using them.
1222 mozilla::image::EnsureModuleInitialized();
1224 RefPtr
<imgLoader
> loader
= new imgLoader();
1227 return loader
.forget();
1230 imgLoader
* imgLoader::NormalLoader() {
1231 if (!gNormalLoader
) {
1232 gNormalLoader
= CreateImageLoader().take();
1234 return gNormalLoader
;
1237 imgLoader
* imgLoader::PrivateBrowsingLoader() {
1238 if (!gPrivateBrowsingLoader
) {
1239 gPrivateBrowsingLoader
= CreateImageLoader().take();
1240 gPrivateBrowsingLoader
->RespectPrivacyNotifications();
1242 return gPrivateBrowsingLoader
;
1245 imgLoader::imgLoader()
1246 : mUncachedImagesMutex("imgLoader::UncachedImages"),
1247 mRespectPrivacy(false) {
1248 sMemReporter
->AddRef();
1249 sMemReporter
->RegisterLoader(this);
1252 imgLoader::~imgLoader() {
1255 // If there are any of our imgRequest's left they are in the uncached
1256 // images set, so clear their pointer to us.
1257 MutexAutoLock
lock(mUncachedImagesMutex
);
1258 for (RefPtr
<imgRequest
> req
: mUncachedImages
) {
1262 sMemReporter
->UnregisterLoader(this);
1263 sMemReporter
->Release();
1266 void imgLoader::VerifyCacheSizes() {
1268 if (!mCacheTracker
) {
1272 uint32_t cachesize
= mCache
.Count();
1273 uint32_t queuesize
= mCacheQueue
.GetNumElements();
1274 uint32_t trackersize
= 0;
1275 for (nsExpirationTracker
<imgCacheEntry
, 3>::Iterator
it(mCacheTracker
.get());
1279 MOZ_ASSERT(queuesize
== trackersize
, "Queue and tracker sizes out of sync!");
1280 MOZ_ASSERT(queuesize
<= cachesize
, "Queue has more elements than cache!");
1284 void imgLoader::GlobalInit() {
1285 sCacheTimeWeight
= StaticPrefs::image_cache_timeweight_AtStartup() / 1000.0;
1286 int32_t cachesize
= StaticPrefs::image_cache_size_AtStartup();
1287 sCacheMaxSize
= cachesize
> 0 ? cachesize
: 0;
1289 sMemReporter
= new imgMemoryReporter();
1290 RegisterStrongAsyncMemoryReporter(sMemReporter
);
1291 RegisterImagesContentUsedUncompressedDistinguishedAmount(
1292 imgMemoryReporter::ImagesContentUsedUncompressedDistinguishedAmount
);
1295 void imgLoader::ShutdownMemoryReporter() {
1296 UnregisterImagesContentUsedUncompressedDistinguishedAmount();
1297 UnregisterStrongMemoryReporter(sMemReporter
);
1300 nsresult
imgLoader::InitCache() {
1301 nsCOMPtr
<nsIObserverService
> os
= mozilla::services::GetObserverService();
1303 return NS_ERROR_FAILURE
;
1306 os
->AddObserver(this, "memory-pressure", false);
1307 os
->AddObserver(this, "chrome-flush-caches", false);
1308 os
->AddObserver(this, "last-pb-context-exited", false);
1309 os
->AddObserver(this, "profile-before-change", false);
1310 os
->AddObserver(this, "xpcom-shutdown", false);
1312 mCacheTracker
= MakeUnique
<imgCacheExpirationTracker
>();
1317 nsresult
imgLoader::Init() {
1324 imgLoader::RespectPrivacyNotifications() {
1325 mRespectPrivacy
= true;
1330 imgLoader::Observe(nsISupports
* aSubject
, const char* aTopic
,
1331 const char16_t
* aData
) {
1332 if (strcmp(aTopic
, "memory-pressure") == 0) {
1334 } else if (strcmp(aTopic
, "chrome-flush-caches") == 0) {
1336 ClearImageCache({ClearOption::ChromeOnly
});
1337 } else if (strcmp(aTopic
, "last-pb-context-exited") == 0) {
1338 if (mRespectPrivacy
) {
1341 } else if (strcmp(aTopic
, "profile-before-change") == 0) {
1342 mCacheTracker
= nullptr;
1343 } else if (strcmp(aTopic
, "xpcom-shutdown") == 0) {
1344 mCacheTracker
= nullptr;
1345 ShutdownMemoryReporter();
1348 // (Nothing else should bring us here)
1349 MOZ_ASSERT(0, "Invalid topic received");
1356 imgLoader::ClearCache(bool chrome
) {
1357 if (XRE_IsParentProcess()) {
1358 bool privateLoader
= this == gPrivateBrowsingLoader
;
1359 for (auto* cp
: ContentParent::AllProcesses(ContentParent::eLive
)) {
1360 Unused
<< cp
->SendClearImageCache(privateLoader
, chrome
);
1363 ClearOptions options
;
1365 options
+= ClearOption::ChromeOnly
;
1367 return ClearImageCache(options
);
1371 imgLoader::RemoveEntriesFromPrincipalInAllProcesses(nsIPrincipal
* aPrincipal
) {
1372 if (!XRE_IsParentProcess()) {
1373 return NS_ERROR_NOT_AVAILABLE
;
1376 for (auto* cp
: ContentParent::AllProcesses(ContentParent::eLive
)) {
1377 Unused
<< cp
->SendClearImageCacheFromPrincipal(aPrincipal
);
1381 if (aPrincipal
->OriginAttributesRef().mPrivateBrowsingId
==
1382 nsIScriptSecurityManager::DEFAULT_PRIVATE_BROWSING_ID
) {
1383 loader
= imgLoader::NormalLoader();
1385 loader
= imgLoader::PrivateBrowsingLoader();
1388 return loader
->RemoveEntriesInternal(aPrincipal
, nullptr);
1392 imgLoader::RemoveEntriesFromBaseDomainInAllProcesses(
1393 const nsACString
& aBaseDomain
) {
1394 if (!XRE_IsParentProcess()) {
1395 return NS_ERROR_NOT_AVAILABLE
;
1398 for (auto* cp
: ContentParent::AllProcesses(ContentParent::eLive
)) {
1399 Unused
<< cp
->SendClearImageCacheFromBaseDomain(aBaseDomain
);
1402 return RemoveEntriesInternal(nullptr, &aBaseDomain
);
1405 nsresult
imgLoader::RemoveEntriesInternal(nsIPrincipal
* aPrincipal
,
1406 const nsACString
* aBaseDomain
) {
1407 // Can only clear by either principal or base domain.
1408 if ((!aPrincipal
&& !aBaseDomain
) || (aPrincipal
&& aBaseDomain
)) {
1409 return NS_ERROR_INVALID_ARG
;
1412 nsCOMPtr
<nsIEffectiveTLDService
> tldService
;
1413 AutoTArray
<RefPtr
<imgCacheEntry
>, 128> entriesToBeRemoved
;
1415 // For base domain we only clear the non-chrome cache.
1416 for (const auto& entry
: mCache
) {
1417 const auto& key
= entry
.GetKey();
1419 const bool shouldRemove
= [&] {
1421 nsCOMPtr
<nsIPrincipal
> keyPrincipal
=
1422 BasePrincipal::CreateContentPrincipal(key
.URI(),
1423 key
.OriginAttributesRef());
1424 return keyPrincipal
->Equals(aPrincipal
);
1430 // Clear by baseDomain.
1432 nsresult rv
= key
.URI()->GetHost(host
);
1433 if (NS_FAILED(rv
) || host
.IsEmpty()) {
1438 tldService
= do_GetService(NS_EFFECTIVETLDSERVICE_CONTRACTID
);
1440 if (NS_WARN_IF(!tldService
)) {
1444 bool hasRootDomain
= false;
1445 rv
= tldService
->HasRootDomain(host
, *aBaseDomain
, &hasRootDomain
);
1446 if (NS_SUCCEEDED(rv
) && hasRootDomain
) {
1450 // If we don't get a direct base domain match, also check for cache of
1451 // third parties partitioned under aBaseDomain.
1453 // The isolation key is either just the base domain, or an origin suffix
1454 // which contains the partitionKey holding the baseDomain.
1456 if (key
.IsolationKeyRef().Equals(*aBaseDomain
)) {
1460 // The isolation key does not match the given base domain. It may be an
1461 // origin suffix. Parse it into origin attributes.
1462 OriginAttributes attrs
;
1463 if (!attrs
.PopulateFromSuffix(key
.IsolationKeyRef())) {
1464 // Key is not an origin suffix.
1468 return StoragePrincipalHelper::PartitionKeyHasBaseDomain(
1469 attrs
.mPartitionKey
, *aBaseDomain
);
1473 entriesToBeRemoved
.AppendElement(entry
.GetData());
1477 for (auto& entry
: entriesToBeRemoved
) {
1478 if (!RemoveFromCache(entry
)) {
1480 "Couldn't remove an entry from the cache in "
1481 "RemoveEntriesInternal()\n");
1488 constexpr auto AllCORSModes() {
1489 return MakeInclusiveEnumeratedRange(kFirstCORSMode
, kLastCORSMode
);
1493 imgLoader::RemoveEntry(nsIURI
* aURI
, Document
* aDoc
) {
1497 OriginAttributes attrs
;
1499 attrs
= aDoc
->NodePrincipal()->OriginAttributesRef();
1501 for (auto corsMode
: AllCORSModes()) {
1502 ImageCacheKey
key(aURI
, corsMode
, attrs
, aDoc
);
1503 RemoveFromCache(key
);
1509 imgLoader::FindEntryProperties(nsIURI
* uri
, Document
* aDoc
,
1510 nsIProperties
** _retval
) {
1513 OriginAttributes attrs
;
1515 nsCOMPtr
<nsIPrincipal
> principal
= aDoc
->NodePrincipal();
1517 attrs
= principal
->OriginAttributesRef();
1521 for (auto corsMode
: AllCORSModes()) {
1522 ImageCacheKey
key(uri
, corsMode
, attrs
, aDoc
);
1523 RefPtr
<imgCacheEntry
> entry
;
1524 if (!mCache
.Get(key
, getter_AddRefs(entry
)) || !entry
) {
1527 if (mCacheTracker
&& entry
->HasNoProxies()) {
1528 mCacheTracker
->MarkUsed(entry
);
1530 RefPtr
<imgRequest
> request
= entry
->GetRequest();
1532 nsCOMPtr
<nsIProperties
> properties
= request
->Properties();
1533 properties
.forget(_retval
);
1540 NS_IMETHODIMP_(void)
1541 imgLoader::ClearCacheForControlledDocument(Document
* aDoc
) {
1543 AutoTArray
<RefPtr
<imgCacheEntry
>, 128> entriesToBeRemoved
;
1544 for (const auto& entry
: mCache
) {
1545 const auto& key
= entry
.GetKey();
1546 if (key
.ControlledDocument() == aDoc
) {
1547 entriesToBeRemoved
.AppendElement(entry
.GetData());
1550 for (auto& entry
: entriesToBeRemoved
) {
1551 if (!RemoveFromCache(entry
)) {
1553 "Couldn't remove an entry from the cache in "
1554 "ClearCacheForControlledDocument()\n");
1559 void imgLoader::Shutdown() {
1560 NS_IF_RELEASE(gNormalLoader
);
1561 gNormalLoader
= nullptr;
1562 NS_IF_RELEASE(gPrivateBrowsingLoader
);
1563 gPrivateBrowsingLoader
= nullptr;
1566 bool imgLoader::PutIntoCache(const ImageCacheKey
& aKey
, imgCacheEntry
* entry
) {
1567 LOG_STATIC_FUNC_WITH_PARAM(gImgLog
, "imgLoader::PutIntoCache", "uri",
1570 // Check to see if this request already exists in the cache. If so, we'll
1571 // replace the old version.
1572 RefPtr
<imgCacheEntry
> tmpCacheEntry
;
1573 if (mCache
.Get(aKey
, getter_AddRefs(tmpCacheEntry
)) && tmpCacheEntry
) {
1575 gImgLog
, LogLevel::Debug
,
1576 ("[this=%p] imgLoader::PutIntoCache -- Element already in the cache",
1578 RefPtr
<imgRequest
> tmpRequest
= tmpCacheEntry
->GetRequest();
1580 // If it already exists, and we're putting the same key into the cache, we
1581 // should remove the old version.
1582 MOZ_LOG(gImgLog
, LogLevel::Debug
,
1583 ("[this=%p] imgLoader::PutIntoCache -- Replacing cached element",
1586 RemoveFromCache(aKey
);
1588 MOZ_LOG(gImgLog
, LogLevel::Debug
,
1589 ("[this=%p] imgLoader::PutIntoCache --"
1590 " Element NOT already in the cache",
1594 mCache
.InsertOrUpdate(aKey
, RefPtr
{entry
});
1596 // We can be called to resurrect an evicted entry.
1597 if (entry
->Evicted()) {
1598 entry
->SetEvicted(false);
1601 // If we're resurrecting an entry with no proxies, put it back in the
1602 // tracker and queue.
1603 if (entry
->HasNoProxies()) {
1604 nsresult addrv
= NS_OK
;
1606 if (mCacheTracker
) {
1607 addrv
= mCacheTracker
->AddObject(entry
);
1610 if (NS_SUCCEEDED(addrv
)) {
1611 mCacheQueue
.Push(entry
);
1615 RefPtr
<imgRequest
> request
= entry
->GetRequest();
1616 request
->SetIsInCache(true);
1617 RemoveFromUncachedImages(request
);
1622 bool imgLoader::SetHasNoProxies(imgRequest
* aRequest
, imgCacheEntry
* aEntry
) {
1623 LOG_STATIC_FUNC_WITH_PARAM(gImgLog
, "imgLoader::SetHasNoProxies", "uri",
1624 aRequest
->CacheKey().URI());
1626 aEntry
->SetHasNoProxies(true);
1628 if (aEntry
->Evicted()) {
1632 nsresult addrv
= NS_OK
;
1634 if (mCacheTracker
) {
1635 addrv
= mCacheTracker
->AddObject(aEntry
);
1638 if (NS_SUCCEEDED(addrv
)) {
1639 mCacheQueue
.Push(aEntry
);
1645 bool imgLoader::SetHasProxies(imgRequest
* aRequest
) {
1648 const ImageCacheKey
& key
= aRequest
->CacheKey();
1650 LOG_STATIC_FUNC_WITH_PARAM(gImgLog
, "imgLoader::SetHasProxies", "uri",
1653 RefPtr
<imgCacheEntry
> entry
;
1654 if (mCache
.Get(key
, getter_AddRefs(entry
)) && entry
) {
1655 // Make sure the cache entry is for the right request
1656 RefPtr
<imgRequest
> entryRequest
= entry
->GetRequest();
1657 if (entryRequest
== aRequest
&& entry
->HasNoProxies()) {
1658 mCacheQueue
.Remove(entry
);
1660 if (mCacheTracker
) {
1661 mCacheTracker
->RemoveObject(entry
);
1664 entry
->SetHasNoProxies(false);
1673 void imgLoader::CacheEntriesChanged(int32_t aSizeDiff
/* = 0 */) {
1674 // We only need to dirty the queue if there is any sorting
1675 // taking place. Empty or single-entry lists can't become
1677 if (mCacheQueue
.GetNumElements() > 1) {
1678 mCacheQueue
.MarkDirty();
1680 mCacheQueue
.UpdateSize(aSizeDiff
);
1683 void imgLoader::CheckCacheLimits() {
1684 if (mCacheQueue
.GetNumElements() == 0) {
1685 NS_ASSERTION(mCacheQueue
.GetSize() == 0,
1686 "imgLoader::CheckCacheLimits -- incorrect cache size");
1689 // Remove entries from the cache until we're back at our desired max size.
1690 while (mCacheQueue
.GetSize() > sCacheMaxSize
) {
1691 // Remove the first entry in the queue.
1692 RefPtr
<imgCacheEntry
> entry(mCacheQueue
.Pop());
1694 NS_ASSERTION(entry
, "imgLoader::CheckCacheLimits -- NULL entry pointer");
1696 if (MOZ_LOG_TEST(gImgLog
, LogLevel::Debug
)) {
1697 RefPtr
<imgRequest
> req
= entry
->GetRequest();
1699 LOG_STATIC_FUNC_WITH_PARAM(gImgLog
, "imgLoader::CheckCacheLimits",
1700 "entry", req
->CacheKey().URI());
1705 // We just popped this entry from the queue, so pass AlreadyRemoved
1706 // to avoid searching the queue again in RemoveFromCache.
1707 RemoveFromCache(entry
, QueueState::AlreadyRemoved
);
1712 bool imgLoader::ValidateRequestWithNewChannel(
1713 imgRequest
* request
, nsIURI
* aURI
, nsIURI
* aInitialDocumentURI
,
1714 nsIReferrerInfo
* aReferrerInfo
, nsILoadGroup
* aLoadGroup
,
1715 imgINotificationObserver
* aObserver
, Document
* aLoadingDocument
,
1716 uint64_t aInnerWindowId
, nsLoadFlags aLoadFlags
,
1717 nsContentPolicyType aLoadPolicyType
, imgRequestProxy
** aProxyRequest
,
1718 nsIPrincipal
* aTriggeringPrincipal
, CORSMode aCORSMode
, bool aLinkPreload
,
1719 uint64_t aEarlyHintPreloaderId
, bool* aNewChannelCreated
) {
1720 // now we need to insert a new channel request object in between the real
1721 // request and the proxy that basically delays loading the image until it
1722 // gets a 304 or figures out that this needs to be a new request
1726 // If we're currently in the middle of validating this request, just hand
1727 // back a proxy to it; the required work will be done for us.
1728 if (imgCacheValidator
* validator
= request
->GetValidator()) {
1729 rv
= CreateNewProxyForRequest(request
, aURI
, aLoadGroup
, aLoadingDocument
,
1730 aObserver
, aLoadFlags
, aProxyRequest
);
1731 if (NS_FAILED(rv
)) {
1735 if (*aProxyRequest
) {
1736 imgRequestProxy
* proxy
= static_cast<imgRequestProxy
*>(*aProxyRequest
);
1738 // We will send notifications from imgCacheValidator::OnStartRequest().
1739 // In the mean time, we must defer notifications because we are added to
1740 // the imgRequest's proxy list, and we can get extra notifications
1741 // resulting from methods such as StartDecoding(). See bug 579122.
1742 proxy
->MarkValidating();
1745 MOZ_ASSERT(aLoadingDocument
);
1746 proxy
->PrioritizeAsPreload();
1747 auto preloadKey
= PreloadHashKey::CreateAsImage(
1748 aURI
, aTriggeringPrincipal
, aCORSMode
);
1749 proxy
->NotifyOpen(preloadKey
, aLoadingDocument
, true);
1752 // Attach the proxy without notifying
1753 validator
->AddProxy(proxy
);
1758 // We will rely on Necko to cache this request when it's possible, and to
1759 // tell imgCacheValidator::OnStartRequest whether the request came from its
1761 nsCOMPtr
<nsIChannel
> newChannel
;
1762 bool forcePrincipalCheck
;
1764 NewImageChannel(getter_AddRefs(newChannel
), &forcePrincipalCheck
, aURI
,
1765 aInitialDocumentURI
, aCORSMode
, aReferrerInfo
, aLoadGroup
,
1766 aLoadFlags
, aLoadPolicyType
, aTriggeringPrincipal
,
1767 aLoadingDocument
, mRespectPrivacy
, aEarlyHintPreloaderId
);
1768 if (NS_FAILED(rv
)) {
1772 if (aNewChannelCreated
) {
1773 *aNewChannelCreated
= true;
1776 RefPtr
<imgRequestProxy
> req
;
1777 rv
= CreateNewProxyForRequest(request
, aURI
, aLoadGroup
, aLoadingDocument
,
1778 aObserver
, aLoadFlags
, getter_AddRefs(req
));
1779 if (NS_FAILED(rv
)) {
1783 // Make sure that OnStatus/OnProgress calls have the right request set...
1784 RefPtr
<nsProgressNotificationProxy
> progressproxy
=
1785 new nsProgressNotificationProxy(newChannel
, req
);
1786 if (!progressproxy
) {
1790 RefPtr
<imgCacheValidator
> hvc
=
1791 new imgCacheValidator(progressproxy
, this, request
, aLoadingDocument
,
1792 aInnerWindowId
, forcePrincipalCheck
);
1794 // Casting needed here to get past multiple inheritance.
1795 nsCOMPtr
<nsIStreamListener
> listener
=
1796 do_QueryInterface(static_cast<nsIThreadRetargetableStreamListener
*>(hvc
));
1797 NS_ENSURE_TRUE(listener
, false);
1799 // We must set the notification callbacks before setting up the
1800 // CORS listener, because that's also interested inthe
1801 // notification callbacks.
1802 newChannel
->SetNotificationCallbacks(hvc
);
1804 request
->SetValidator(hvc
);
1806 // We will send notifications from imgCacheValidator::OnStartRequest().
1807 // In the mean time, we must defer notifications because we are added to
1808 // the imgRequest's proxy list, and we can get extra notifications
1809 // resulting from methods such as StartDecoding(). See bug 579122.
1810 req
->MarkValidating();
1813 MOZ_ASSERT(aLoadingDocument
);
1814 req
->PrioritizeAsPreload();
1816 PreloadHashKey::CreateAsImage(aURI
, aTriggeringPrincipal
, aCORSMode
);
1817 req
->NotifyOpen(preloadKey
, aLoadingDocument
, true);
1820 // Add the proxy without notifying
1823 mozilla::net::PredictorLearn(aURI
, aInitialDocumentURI
,
1824 nsINetworkPredictor::LEARN_LOAD_SUBRESOURCE
,
1826 rv
= newChannel
->AsyncOpen(listener
);
1827 if (NS_WARN_IF(NS_FAILED(rv
))) {
1828 req
->CancelAndForgetObserver(rv
);
1829 // This will notify any current or future <link preload> tags. Pass the
1830 // non-open channel so that we can read loadinfo and referrer info of that
1832 req
->NotifyStart(newChannel
);
1833 // Use the non-channel overload of this method to force the notification to
1834 // happen. The preload request has not been assigned a channel.
1835 req
->NotifyStop(rv
);
1839 req
.forget(aProxyRequest
);
1843 void imgLoader::NotifyObserversForCachedImage(
1844 imgCacheEntry
* aEntry
, imgRequest
* request
, nsIURI
* aURI
,
1845 nsIReferrerInfo
* aReferrerInfo
, Document
* aLoadingDocument
,
1846 nsIPrincipal
* aTriggeringPrincipal
, CORSMode aCORSMode
,
1847 uint64_t aEarlyHintPreloaderId
) {
1848 if (aEntry
->HasNotified()) {
1852 nsCOMPtr
<nsIObserverService
> obsService
= services::GetObserverService();
1854 if (!obsService
->HasObservers("http-on-image-cache-response")) {
1858 aEntry
->SetHasNotified();
1860 nsCOMPtr
<nsIChannel
> newChannel
;
1861 bool forcePrincipalCheck
;
1862 nsresult rv
= NewImageChannel(
1863 getter_AddRefs(newChannel
), &forcePrincipalCheck
, aURI
, nullptr,
1864 aCORSMode
, aReferrerInfo
, nullptr, 0,
1865 nsIContentPolicy::TYPE_INTERNAL_IMAGE
, aTriggeringPrincipal
,
1866 aLoadingDocument
, mRespectPrivacy
, aEarlyHintPreloaderId
);
1867 if (NS_FAILED(rv
)) {
1871 RefPtr
<HttpBaseChannel
> httpBaseChannel
= do_QueryObject(newChannel
);
1872 if (httpBaseChannel
) {
1873 httpBaseChannel
->SetDummyChannelForImageCache();
1874 newChannel
->SetContentType(nsDependentCString(request
->GetMimeType()));
1875 RefPtr
<mozilla::image::Image
> image
= request
->GetImage();
1877 newChannel
->SetContentLength(aEntry
->GetDataSize());
1879 obsService
->NotifyObservers(newChannel
, "http-on-image-cache-response",
1884 bool imgLoader::ValidateEntry(
1885 imgCacheEntry
* aEntry
, nsIURI
* aURI
, nsIURI
* aInitialDocumentURI
,
1886 nsIReferrerInfo
* aReferrerInfo
, nsILoadGroup
* aLoadGroup
,
1887 imgINotificationObserver
* aObserver
, Document
* aLoadingDocument
,
1888 nsLoadFlags aLoadFlags
, nsContentPolicyType aLoadPolicyType
,
1889 bool aCanMakeNewChannel
, bool* aNewChannelCreated
,
1890 imgRequestProxy
** aProxyRequest
, nsIPrincipal
* aTriggeringPrincipal
,
1891 CORSMode aCORSMode
, bool aLinkPreload
, uint64_t aEarlyHintPreloaderId
) {
1892 LOG_SCOPE(gImgLog
, "imgLoader::ValidateEntry");
1894 // If the expiration time is zero, then the request has not gotten far enough
1895 // to know when it will expire, or we know it will never expire (see
1896 // nsContentUtils::GetSubresourceCacheValidationInfo).
1897 uint32_t expiryTime
= aEntry
->GetExpiryTime();
1898 bool hasExpired
= expiryTime
&& expiryTime
<= SecondsFromPRTime(PR_Now());
1900 // Special treatment for file URLs - aEntry has expired if file has changed
1901 if (nsCOMPtr
<nsIFileURL
> fileUrl
= do_QueryInterface(aURI
)) {
1902 uint32_t lastModTime
= aEntry
->GetLoadTime();
1903 nsCOMPtr
<nsIFile
> theFile
;
1904 if (NS_SUCCEEDED(fileUrl
->GetFile(getter_AddRefs(theFile
)))) {
1906 if (NS_SUCCEEDED(theFile
->GetLastModifiedTime(&fileLastMod
))) {
1907 // nsIFile uses millisec, NSPR usec.
1908 fileLastMod
*= 1000;
1909 hasExpired
= SecondsFromPRTime((PRTime
)fileLastMod
) > lastModTime
;
1914 RefPtr
<imgRequest
> request(aEntry
->GetRequest());
1920 if (!ValidateSecurityInfo(request
, aEntry
->ForcePrincipalCheck(), aCORSMode
,
1921 aTriggeringPrincipal
, aLoadingDocument
,
1926 // data URIs are immutable and by their nature can't leak data, so we can
1927 // just return true in that case. Doing so would mean that shift-reload
1928 // doesn't reload data URI documents/images though (which is handy for
1929 // debugging during gecko development) so we make an exception in that case.
1930 if (aURI
->SchemeIs("data") && !(aLoadFlags
& nsIRequest::LOAD_BYPASS_CACHE
)) {
1934 bool validateRequest
= false;
1936 if (!request
->CanReuseWithoutValidation(aLoadingDocument
)) {
1937 // If we would need to revalidate this entry, but we're being told to
1938 // bypass the cache, we don't allow this entry to be used.
1939 if (aLoadFlags
& nsIRequest::LOAD_BYPASS_CACHE
) {
1943 if (MOZ_UNLIKELY(ChaosMode::isActive(ChaosFeature::ImageCache
))) {
1944 if (ChaosMode::randomUint32LessThan(4) < 1) {
1949 // Determine whether the cache aEntry must be revalidated...
1950 validateRequest
= ShouldRevalidateEntry(aEntry
, aLoadFlags
, hasExpired
);
1952 MOZ_LOG(gImgLog
, LogLevel::Debug
,
1953 ("imgLoader::ValidateEntry validating cache entry. "
1954 "validateRequest = %d",
1956 } else if (!aLoadingDocument
&& MOZ_LOG_TEST(gImgLog
, LogLevel::Debug
)) {
1957 MOZ_LOG(gImgLog
, LogLevel::Debug
,
1958 ("imgLoader::ValidateEntry BYPASSING cache validation for %s "
1959 "because of NULL loading document",
1960 aURI
->GetSpecOrDefault().get()));
1963 // If the original request is still transferring don't kick off a validation
1964 // network request because it is a bit silly to issue a validation request if
1965 // the original request hasn't even finished yet. So just return true
1966 // indicating the caller can create a new proxy for the request and use it as
1968 // This is an optimization but it's also required for correctness. If we don't
1969 // do this then when firing the load complete notification for the original
1970 // request that can unblock load for the document and then spin the event loop
1971 // (see the stack in bug 1641682) which then the OnStartRequest for the
1972 // validation request can fire which can call UpdateProxies and can sync
1973 // notify on the progress tracker about all existing state, which includes
1974 // load complete, so we fire a second load complete notification for the
1976 // In addition, we want to validate if the original request encountered
1977 // an error for two reasons. The first being if the error was a network error
1978 // then trying to re-fetch the image might succeed. The second is more
1979 // complicated. We decide if we should fire the load or error event for img
1980 // elements depending on if the image has error in its status at the time when
1981 // the load complete notification is received, and we set error status on an
1982 // image if it encounters a network error or a decode error with no real way
1983 // to tell them apart. So if we load an image that will produce a decode error
1984 // the first time we will usually fire the load event, and then decode enough
1985 // to encounter the decode error and set the error status on the image. The
1986 // next time we reference the image in the same document the load complete
1987 // notification is replayed and this time the error status from the decode is
1988 // already present so we fire the error event instead of the load event. This
1989 // is a bug (bug 1645576) that we should fix. In order to avoid that bug in
1990 // some cases (specifically the cases when we hit this code and try to
1991 // validate the request) we make sure to validate. This avoids the bug because
1992 // when the load complete notification arrives the proxy is marked as
1993 // validating so it lies about its status and returns nothing.
1994 const bool requestComplete
= [&] {
1995 RefPtr
<ProgressTracker
> tracker
;
1996 RefPtr
<mozilla::image::Image
> image
= request
->GetImage();
1998 tracker
= image
->GetProgressTracker();
2000 tracker
= request
->GetProgressTracker();
2003 tracker
->GetProgress() & (FLAG_LOAD_COMPLETE
| FLAG_HAS_ERROR
);
2006 if (!requestComplete
) {
2010 if (validateRequest
&& aCanMakeNewChannel
) {
2011 LOG_SCOPE(gImgLog
, "imgLoader::ValidateRequest |cache hit| must validate");
2013 uint64_t innerWindowID
=
2014 aLoadingDocument
? aLoadingDocument
->InnerWindowID() : 0;
2015 return ValidateRequestWithNewChannel(
2016 request
, aURI
, aInitialDocumentURI
, aReferrerInfo
, aLoadGroup
,
2017 aObserver
, aLoadingDocument
, innerWindowID
, aLoadFlags
, aLoadPolicyType
,
2018 aProxyRequest
, aTriggeringPrincipal
, aCORSMode
, aLinkPreload
,
2019 aEarlyHintPreloaderId
, aNewChannelCreated
);
2022 if (!validateRequest
) {
2023 NotifyObserversForCachedImage(aEntry
, request
, aURI
, aReferrerInfo
,
2024 aLoadingDocument
, aTriggeringPrincipal
,
2025 aCORSMode
, aEarlyHintPreloaderId
);
2028 return !validateRequest
;
2031 bool imgLoader::RemoveFromCache(const ImageCacheKey
& aKey
) {
2032 LOG_STATIC_FUNC_WITH_PARAM(gImgLog
, "imgLoader::RemoveFromCache", "uri",
2034 RefPtr
<imgCacheEntry
> entry
;
2035 mCache
.Remove(aKey
, getter_AddRefs(entry
));
2037 MOZ_ASSERT(!entry
->Evicted(), "Evicting an already-evicted cache entry!");
2039 // Entries with no proxies are in the tracker.
2040 if (entry
->HasNoProxies()) {
2041 if (mCacheTracker
) {
2042 mCacheTracker
->RemoveObject(entry
);
2044 mCacheQueue
.Remove(entry
);
2047 entry
->SetEvicted(true);
2049 RefPtr
<imgRequest
> request
= entry
->GetRequest();
2050 request
->SetIsInCache(false);
2051 AddToUncachedImages(request
);
2058 bool imgLoader::RemoveFromCache(imgCacheEntry
* entry
, QueueState aQueueState
) {
2059 LOG_STATIC_FUNC(gImgLog
, "imgLoader::RemoveFromCache entry");
2061 RefPtr
<imgRequest
> request
= entry
->GetRequest();
2063 const ImageCacheKey
& key
= request
->CacheKey();
2064 LOG_STATIC_FUNC_WITH_PARAM(gImgLog
, "imgLoader::RemoveFromCache",
2065 "entry's uri", key
.URI());
2069 if (entry
->HasNoProxies()) {
2070 LOG_STATIC_FUNC(gImgLog
,
2071 "imgLoader::RemoveFromCache removing from tracker");
2072 if (mCacheTracker
) {
2073 mCacheTracker
->RemoveObject(entry
);
2075 // Only search the queue to remove the entry if its possible it might
2076 // be in the queue. If we know its not in the queue this would be
2078 MOZ_ASSERT_IF(aQueueState
== QueueState::AlreadyRemoved
,
2079 !mCacheQueue
.Contains(entry
));
2080 if (aQueueState
== QueueState::MaybeExists
) {
2081 mCacheQueue
.Remove(entry
);
2085 entry
->SetEvicted(true);
2086 request
->SetIsInCache(false);
2087 AddToUncachedImages(request
);
2095 nsresult
imgLoader::ClearImageCache(ClearOptions aOptions
) {
2096 const bool chromeOnly
= aOptions
.contains(ClearOption::ChromeOnly
);
2097 const auto ShouldRemove
= [&](imgCacheEntry
* aEntry
) {
2099 // TODO: Consider also removing "resource://" etc?
2100 RefPtr
<imgRequest
> request
= aEntry
->GetRequest();
2101 if (!request
|| !request
->CacheKey().URI()->SchemeIs("chrome")) {
2107 if (aOptions
.contains(ClearOption::UnusedOnly
)) {
2108 LOG_STATIC_FUNC(gImgLog
, "imgLoader::ClearImageCache queue");
2109 // We have to make a temporary, since RemoveFromCache removes the element
2110 // from the queue, invalidating iterators.
2111 nsTArray
<RefPtr
<imgCacheEntry
>> entries(mCacheQueue
.GetNumElements());
2112 for (auto& entry
: mCacheQueue
) {
2113 if (ShouldRemove(entry
)) {
2114 entries
.AppendElement(entry
);
2118 // Iterate in reverse order to minimize array copying.
2119 for (auto& entry
: entries
) {
2120 if (!RemoveFromCache(entry
)) {
2121 return NS_ERROR_FAILURE
;
2125 MOZ_ASSERT(chromeOnly
|| mCacheQueue
.GetNumElements() == 0);
2129 LOG_STATIC_FUNC(gImgLog
, "imgLoader::ClearImageCache table");
2130 // We have to make a temporary, since RemoveFromCache removes the element
2131 // from the queue, invalidating iterators.
2132 const auto entries
=
2133 ToTArray
<nsTArray
<RefPtr
<imgCacheEntry
>>>(mCache
.Values());
2134 for (const auto& entry
: entries
) {
2135 if (!ShouldRemove(entry
)) {
2138 if (!RemoveFromCache(entry
)) {
2139 return NS_ERROR_FAILURE
;
2142 MOZ_ASSERT(chromeOnly
|| mCache
.IsEmpty());
2146 void imgLoader::AddToUncachedImages(imgRequest
* aRequest
) {
2147 MutexAutoLock
lock(mUncachedImagesMutex
);
2148 mUncachedImages
.Insert(aRequest
);
2151 void imgLoader::RemoveFromUncachedImages(imgRequest
* aRequest
) {
2152 MutexAutoLock
lock(mUncachedImagesMutex
);
2153 mUncachedImages
.Remove(aRequest
);
2156 #define LOAD_FLAGS_CACHE_MASK \
2157 (nsIRequest::LOAD_BYPASS_CACHE | nsIRequest::LOAD_FROM_CACHE)
2159 #define LOAD_FLAGS_VALIDATE_MASK \
2160 (nsIRequest::VALIDATE_ALWAYS | nsIRequest::VALIDATE_NEVER | \
2161 nsIRequest::VALIDATE_ONCE_PER_SESSION)
2164 imgLoader::LoadImageXPCOM(
2165 nsIURI
* aURI
, nsIURI
* aInitialDocumentURI
, nsIReferrerInfo
* aReferrerInfo
,
2166 nsIPrincipal
* aTriggeringPrincipal
, nsILoadGroup
* aLoadGroup
,
2167 imgINotificationObserver
* aObserver
, Document
* aLoadingDocument
,
2168 nsLoadFlags aLoadFlags
, nsISupports
* aCacheKey
,
2169 nsContentPolicyType aContentPolicyType
, imgIRequest
** _retval
) {
2170 // Optional parameter, so defaults to 0 (== TYPE_INVALID)
2171 if (!aContentPolicyType
) {
2172 aContentPolicyType
= nsIContentPolicy::TYPE_INTERNAL_IMAGE
;
2174 imgRequestProxy
* proxy
;
2176 LoadImage(aURI
, aInitialDocumentURI
, aReferrerInfo
, aTriggeringPrincipal
,
2177 0, aLoadGroup
, aObserver
, aLoadingDocument
, aLoadingDocument
,
2178 aLoadFlags
, aCacheKey
, aContentPolicyType
, u
""_ns
,
2179 /* aUseUrgentStartForChannel */ false, /* aListPreload */ false,
2185 static void MakeRequestStaticIfNeeded(
2186 Document
* aLoadingDocument
, imgRequestProxy
** aProxyAboutToGetReturned
) {
2187 if (!aLoadingDocument
|| !aLoadingDocument
->IsStaticDocument()) {
2191 if (!*aProxyAboutToGetReturned
) {
2195 RefPtr
<imgRequestProxy
> proxy
= dont_AddRef(*aProxyAboutToGetReturned
);
2196 *aProxyAboutToGetReturned
= nullptr;
2198 RefPtr
<imgRequestProxy
> staticProxy
=
2199 proxy
->GetStaticRequest(aLoadingDocument
);
2200 if (staticProxy
!= proxy
) {
2201 proxy
->CancelAndForgetObserver(NS_BINDING_ABORTED
);
2202 proxy
= std::move(staticProxy
);
2204 proxy
.forget(aProxyAboutToGetReturned
);
2207 bool imgLoader::IsImageAvailable(nsIURI
* aURI
,
2208 nsIPrincipal
* aTriggeringPrincipal
,
2209 CORSMode aCORSMode
, Document
* aDocument
) {
2210 ImageCacheKey
key(aURI
, aCORSMode
,
2211 aTriggeringPrincipal
->OriginAttributesRef(), aDocument
);
2212 RefPtr
<imgCacheEntry
> entry
;
2213 if (!mCache
.Get(key
, getter_AddRefs(entry
)) || !entry
) {
2216 RefPtr
<imgRequest
> request
= entry
->GetRequest();
2220 if (nsCOMPtr
<nsILoadGroup
> docLoadGroup
= aDocument
->GetDocumentLoadGroup()) {
2221 nsLoadFlags requestFlags
= nsIRequest::LOAD_NORMAL
;
2222 docLoadGroup
->GetLoadFlags(&requestFlags
);
2223 if (requestFlags
& nsIRequest::LOAD_BYPASS_CACHE
) {
2224 // If we're bypassing the cache, treat the image as not available.
2228 return ValidateCORSMode(request
, false, aCORSMode
, aTriggeringPrincipal
);
2231 nsresult
imgLoader::LoadImage(
2232 nsIURI
* aURI
, nsIURI
* aInitialDocumentURI
, nsIReferrerInfo
* aReferrerInfo
,
2233 nsIPrincipal
* aTriggeringPrincipal
, uint64_t aRequestContextID
,
2234 nsILoadGroup
* aLoadGroup
, imgINotificationObserver
* aObserver
,
2235 nsINode
* aContext
, Document
* aLoadingDocument
, nsLoadFlags aLoadFlags
,
2236 nsISupports
* aCacheKey
, nsContentPolicyType aContentPolicyType
,
2237 const nsAString
& initiatorType
, bool aUseUrgentStartForChannel
,
2238 bool aLinkPreload
, uint64_t aEarlyHintPreloaderId
,
2239 imgRequestProxy
** _retval
) {
2242 NS_ASSERTION(aURI
, "imgLoader::LoadImage -- NULL URI pointer");
2245 return NS_ERROR_NULL_POINTER
;
2248 auto makeStaticIfNeeded
= mozilla::MakeScopeExit(
2249 [&] { MakeRequestStaticIfNeeded(aLoadingDocument
, _retval
); });
2251 AUTO_PROFILER_LABEL_DYNAMIC_NSCSTRING("imgLoader::LoadImage", NETWORK
,
2252 aURI
->GetSpecOrDefault());
2254 LOG_SCOPE_WITH_PARAM(gImgLog
, "imgLoader::LoadImage", "aURI", aURI
);
2258 RefPtr
<imgRequest
> request
;
2261 nsLoadFlags requestFlags
= nsIRequest::LOAD_NORMAL
;
2264 bool isPrivate
= false;
2266 if (aLoadingDocument
) {
2267 isPrivate
= nsContentUtils::IsInPrivateBrowsing(aLoadingDocument
);
2268 } else if (aLoadGroup
) {
2269 isPrivate
= nsContentUtils::IsInPrivateBrowsing(aLoadGroup
);
2271 MOZ_ASSERT(isPrivate
== mRespectPrivacy
);
2273 if (aLoadingDocument
) {
2274 // The given load group should match that of the document if given. If
2275 // that isn't the case, then we need to add more plumbing to ensure we
2276 // block the document as well.
2277 nsCOMPtr
<nsILoadGroup
> docLoadGroup
=
2278 aLoadingDocument
->GetDocumentLoadGroup();
2279 MOZ_ASSERT(docLoadGroup
== aLoadGroup
);
2283 // Get the default load flags from the loadgroup (if possible)...
2285 aLoadGroup
->GetLoadFlags(&requestFlags
);
2288 // Merge the default load flags with those passed in via aLoadFlags.
2289 // Currently, *only* the caching, validation and background load flags
2292 // The flags in aLoadFlags take precedence over the default flags!
2294 if (aLoadFlags
& LOAD_FLAGS_CACHE_MASK
) {
2295 // Override the default caching flags...
2296 requestFlags
= (requestFlags
& ~LOAD_FLAGS_CACHE_MASK
) |
2297 (aLoadFlags
& LOAD_FLAGS_CACHE_MASK
);
2299 if (aLoadFlags
& LOAD_FLAGS_VALIDATE_MASK
) {
2300 // Override the default validation flags...
2301 requestFlags
= (requestFlags
& ~LOAD_FLAGS_VALIDATE_MASK
) |
2302 (aLoadFlags
& LOAD_FLAGS_VALIDATE_MASK
);
2304 if (aLoadFlags
& nsIRequest::LOAD_BACKGROUND
) {
2305 // Propagate background loading...
2306 requestFlags
|= nsIRequest::LOAD_BACKGROUND
;
2310 // Set background loading if it is <link rel=preload>
2311 requestFlags
|= nsIRequest::LOAD_BACKGROUND
;
2314 CORSMode corsmode
= CORS_NONE
;
2315 if (aLoadFlags
& imgILoader::LOAD_CORS_ANONYMOUS
) {
2316 corsmode
= CORS_ANONYMOUS
;
2317 } else if (aLoadFlags
& imgILoader::LOAD_CORS_USE_CREDENTIALS
) {
2318 corsmode
= CORS_USE_CREDENTIALS
;
2321 // Look in the preloaded images of loading document first.
2322 if (!aLinkPreload
&& aLoadingDocument
) {
2323 // All Early Hints preloads are Link preloads, therefore we don't have a
2324 // Early Hints preload here
2325 MOZ_ASSERT(!aEarlyHintPreloaderId
);
2327 PreloadHashKey::CreateAsImage(aURI
, aTriggeringPrincipal
, corsmode
);
2328 if (RefPtr
<PreloaderBase
> preload
=
2329 aLoadingDocument
->Preloads().LookupPreload(key
)) {
2330 RefPtr
<imgRequestProxy
> proxy
= do_QueryObject(preload
);
2333 MOZ_LOG(gImgLog
, LogLevel::Debug
,
2334 ("[this=%p] imgLoader::LoadImage -- preloaded [proxy=%p]"
2336 this, proxy
.get(), aLoadingDocument
));
2338 // Removing the preload for this image to be in parity with Chromium. Any
2339 // following regular image request will be reloaded using the regular
2340 // path: image cache, http cache, network. Any following `<link
2341 // rel=preload as=image>` will start a new image preload that can be
2342 // satisfied from http cache or network.
2344 // There is a spec discussion for "preload cache", see
2345 // https://github.com/w3c/preload/issues/97. And it is also not clear how
2346 // preload image interacts with list of available images, see
2347 // https://github.com/whatwg/html/issues/4474.
2348 proxy
->RemoveSelf(aLoadingDocument
);
2349 proxy
->NotifyUsage(aLoadingDocument
);
2351 imgRequest
* request
= proxy
->GetOwner();
2353 CreateNewProxyForRequest(request
, aURI
, aLoadGroup
, aLoadingDocument
,
2354 aObserver
, requestFlags
, _retval
);
2355 NS_ENSURE_SUCCESS(rv
, rv
);
2357 imgRequestProxy
* newProxy
= *_retval
;
2358 if (imgCacheValidator
* validator
= request
->GetValidator()) {
2359 newProxy
->MarkValidating();
2360 // Attach the proxy without notifying and this will add us to the load
2362 validator
->AddProxy(newProxy
);
2364 // It's OK to add here even if the request is done. If it is, it'll send
2365 // a OnStopRequest()and the proxy will be removed from the loadgroup in
2366 // imgRequestProxy::OnLoadComplete.
2367 newProxy
->AddToLoadGroup();
2368 newProxy
->NotifyListener();
2375 RefPtr
<imgCacheEntry
> entry
;
2377 // Look in the cache for our URI, and then validate it.
2378 // XXX For now ignore aCacheKey. We will need it in the future
2379 // for correctly dealing with image load requests that are a result
2381 OriginAttributes attrs
;
2382 if (aTriggeringPrincipal
) {
2383 attrs
= aTriggeringPrincipal
->OriginAttributesRef();
2385 ImageCacheKey
key(aURI
, corsmode
, attrs
, aLoadingDocument
);
2386 if (mCache
.Get(key
, getter_AddRefs(entry
)) && entry
) {
2387 bool newChannelCreated
= false;
2388 if (ValidateEntry(entry
, aURI
, aInitialDocumentURI
, aReferrerInfo
,
2389 aLoadGroup
, aObserver
, aLoadingDocument
, requestFlags
,
2390 aContentPolicyType
, true, &newChannelCreated
, _retval
,
2391 aTriggeringPrincipal
, corsmode
, aLinkPreload
,
2392 aEarlyHintPreloaderId
)) {
2393 request
= entry
->GetRequest();
2395 // If this entry has no proxies, its request has no reference to the
2397 if (entry
->HasNoProxies()) {
2398 LOG_FUNC_WITH_PARAM(gImgLog
,
2399 "imgLoader::LoadImage() adding proxyless entry",
2401 MOZ_ASSERT(!request
->HasCacheEntry(),
2402 "Proxyless entry's request has cache entry!");
2403 request
->SetCacheEntry(entry
);
2405 if (mCacheTracker
&& entry
->GetExpirationState()->IsTracked()) {
2406 mCacheTracker
->MarkUsed(entry
);
2412 if (!newChannelCreated
) {
2413 // This is ugly but it's needed to report CSP violations. We have 3
2415 // - we don't have cache. We are not in this if() stmt. A new channel is
2416 // created and that triggers the CSP checks.
2417 // - We have a cache entry and this is blocked by CSP directives.
2418 DebugOnly
<bool> shouldLoad
= ShouldLoadCachedImage(
2419 request
, aLoadingDocument
, aTriggeringPrincipal
, aContentPolicyType
,
2420 /* aSendCSPViolationReports */ true);
2421 MOZ_ASSERT(shouldLoad
);
2424 // We can't use this entry. We'll try to load it off the network, and if
2425 // successful, overwrite the old entry in the cache with a new one.
2430 // Keep the channel in this scope, so we can adjust its notificationCallbacks
2431 // later when we create the proxy.
2432 nsCOMPtr
<nsIChannel
> newChannel
;
2433 // If we didn't get a cache hit, we need to load from the network.
2435 LOG_SCOPE(gImgLog
, "imgLoader::LoadImage |cache miss|");
2437 bool forcePrincipalCheck
;
2438 rv
= NewImageChannel(getter_AddRefs(newChannel
), &forcePrincipalCheck
, aURI
,
2439 aInitialDocumentURI
, corsmode
, aReferrerInfo
,
2440 aLoadGroup
, requestFlags
, aContentPolicyType
,
2441 aTriggeringPrincipal
, aContext
, mRespectPrivacy
,
2442 aEarlyHintPreloaderId
);
2443 if (NS_FAILED(rv
)) {
2444 return NS_ERROR_FAILURE
;
2447 MOZ_ASSERT(NS_UsePrivateBrowsing(newChannel
) == mRespectPrivacy
);
2449 NewRequestAndEntry(forcePrincipalCheck
, this, key
, getter_AddRefs(request
),
2450 getter_AddRefs(entry
));
2452 MOZ_LOG(gImgLog
, LogLevel::Debug
,
2453 ("[this=%p] imgLoader::LoadImage -- Created new imgRequest"
2455 this, request
.get()));
2457 nsCOMPtr
<nsIClassOfService
> cos(do_QueryInterface(newChannel
));
2459 if (aUseUrgentStartForChannel
&& !aLinkPreload
) {
2460 cos
->AddClassFlags(nsIClassOfService::UrgentStart
);
2463 if (StaticPrefs::network_http_tailing_enabled() &&
2464 aContentPolicyType
== nsIContentPolicy::TYPE_INTERNAL_IMAGE_FAVICON
) {
2465 cos
->AddClassFlags(nsIClassOfService::Throttleable
|
2466 nsIClassOfService::Tail
);
2467 nsCOMPtr
<nsIHttpChannel
> httpChannel(do_QueryInterface(newChannel
));
2469 Unused
<< httpChannel
->SetRequestContextID(aRequestContextID
);
2474 nsCOMPtr
<nsILoadGroup
> channelLoadGroup
;
2475 newChannel
->GetLoadGroup(getter_AddRefs(channelLoadGroup
));
2476 rv
= request
->Init(aURI
, aURI
, /* aHadInsecureRedirect = */ false,
2477 channelLoadGroup
, newChannel
, entry
, aLoadingDocument
,
2478 aTriggeringPrincipal
, corsmode
, aReferrerInfo
);
2479 if (NS_FAILED(rv
)) {
2480 return NS_ERROR_FAILURE
;
2483 // Add the initiator type for this image load
2484 nsCOMPtr
<nsITimedChannel
> timedChannel
= do_QueryInterface(newChannel
);
2486 timedChannel
->SetInitiatorType(initiatorType
);
2489 // create the proxy listener
2490 nsCOMPtr
<nsIStreamListener
> listener
= new ProxyListener(request
.get());
2492 MOZ_LOG(gImgLog
, LogLevel::Debug
,
2493 ("[this=%p] imgLoader::LoadImage -- Calling channel->AsyncOpen()\n",
2496 mozilla::net::PredictorLearn(aURI
, aInitialDocumentURI
,
2497 nsINetworkPredictor::LEARN_LOAD_SUBRESOURCE
,
2501 openRes
= newChannel
->AsyncOpen(listener
);
2503 if (NS_FAILED(openRes
)) {
2505 gImgLog
, LogLevel::Debug
,
2506 ("[this=%p] imgLoader::LoadImage -- AsyncOpen() failed: 0x%" PRIx32
2508 this, static_cast<uint32_t>(openRes
)));
2509 request
->CancelAndAbort(openRes
);
2513 // Try to add the new request into the cache.
2514 PutIntoCache(key
, entry
);
2516 LOG_MSG_WITH_PARAM(gImgLog
, "imgLoader::LoadImage |cache hit|", "request",
2520 // If we didn't get a proxy when validating the cache entry, we need to
2523 // ValidateEntry() has three return values: "Is valid," "might be valid --
2524 // validating over network", and "not valid." If we don't have a _retval,
2525 // we know ValidateEntry is not validating over the network, so it's safe
2526 // to SetLoadId here because we know this request is valid for this context.
2528 // Note, however, that this doesn't guarantee the behaviour we want (one
2529 // URL maps to the same image on a page) if we load the same image in a
2530 // different tab (see bug 528003), because its load id will get re-set, and
2531 // that'll cause us to validate over the network.
2532 request
->SetLoadId(aLoadingDocument
);
2534 LOG_MSG(gImgLog
, "imgLoader::LoadImage", "creating proxy request.");
2535 rv
= CreateNewProxyForRequest(request
, aURI
, aLoadGroup
, aLoadingDocument
,
2536 aObserver
, requestFlags
, _retval
);
2537 if (NS_FAILED(rv
)) {
2541 imgRequestProxy
* proxy
= *_retval
;
2543 // Make sure that OnStatus/OnProgress calls have the right request set, if
2544 // we did create a channel here.
2546 nsCOMPtr
<nsIInterfaceRequestor
> requestor(
2547 new nsProgressNotificationProxy(newChannel
, proxy
));
2549 return NS_ERROR_OUT_OF_MEMORY
;
2551 newChannel
->SetNotificationCallbacks(requestor
);
2555 MOZ_ASSERT(aLoadingDocument
);
2556 proxy
->PrioritizeAsPreload();
2558 PreloadHashKey::CreateAsImage(aURI
, aTriggeringPrincipal
, corsmode
);
2559 proxy
->NotifyOpen(preloadKey
, aLoadingDocument
, true);
2562 // Note that it's OK to add here even if the request is done. If it is,
2563 // it'll send a OnStopRequest() to the proxy in imgRequestProxy::Notify and
2564 // the proxy will be removed from the loadgroup.
2565 proxy
->AddToLoadGroup();
2567 // If we're loading off the network, explicitly don't notify our proxy,
2568 // because necko (or things called from necko, such as imgCacheValidator)
2569 // are going to call our notifications asynchronously, and we can't make it
2570 // further asynchronous because observers might rely on imagelib completing
2571 // its work between the channel's OnStartRequest and OnStopRequest.
2573 proxy
->NotifyListener();
2579 NS_ASSERTION(*_retval
, "imgLoader::LoadImage -- no return value");
2585 imgLoader::LoadImageWithChannelXPCOM(nsIChannel
* channel
,
2586 imgINotificationObserver
* aObserver
,
2587 Document
* aLoadingDocument
,
2588 nsIStreamListener
** listener
,
2589 imgIRequest
** _retval
) {
2591 imgRequestProxy
* proxy
;
2592 result
= LoadImageWithChannel(channel
, aObserver
, aLoadingDocument
, listener
,
2598 nsresult
imgLoader::LoadImageWithChannel(nsIChannel
* channel
,
2599 imgINotificationObserver
* aObserver
,
2600 Document
* aLoadingDocument
,
2601 nsIStreamListener
** listener
,
2602 imgRequestProxy
** _retval
) {
2603 NS_ASSERTION(channel
,
2604 "imgLoader::LoadImageWithChannel -- NULL channel pointer");
2606 MOZ_ASSERT(NS_UsePrivateBrowsing(channel
) == mRespectPrivacy
);
2608 auto makeStaticIfNeeded
= mozilla::MakeScopeExit(
2609 [&] { MakeRequestStaticIfNeeded(aLoadingDocument
, _retval
); });
2611 LOG_SCOPE(gImgLog
, "imgLoader::LoadImageWithChannel");
2612 RefPtr
<imgRequest
> request
;
2614 nsCOMPtr
<nsIURI
> uri
;
2615 channel
->GetURI(getter_AddRefs(uri
));
2617 NS_ENSURE_TRUE(channel
, NS_ERROR_FAILURE
);
2618 nsCOMPtr
<nsILoadInfo
> loadInfo
= channel
->LoadInfo();
2620 OriginAttributes attrs
= loadInfo
->GetOriginAttributes();
2622 // TODO: Get a meaningful cors mode from the caller probably?
2623 const auto corsMode
= CORS_NONE
;
2624 ImageCacheKey
key(uri
, corsMode
, attrs
, aLoadingDocument
);
2626 nsLoadFlags requestFlags
= nsIRequest::LOAD_NORMAL
;
2627 channel
->GetLoadFlags(&requestFlags
);
2629 RefPtr
<imgCacheEntry
> entry
;
2631 if (requestFlags
& nsIRequest::LOAD_BYPASS_CACHE
) {
2632 RemoveFromCache(key
);
2634 // Look in the cache for our URI, and then validate it.
2635 // XXX For now ignore aCacheKey. We will need it in the future
2636 // for correctly dealing with image load requests that are a result
2638 if (mCache
.Get(key
, getter_AddRefs(entry
)) && entry
) {
2639 // We don't want to kick off another network load. So we ask
2640 // ValidateEntry to only do validation without creating a new proxy. If
2641 // it says that the entry isn't valid any more, we'll only use the entry
2642 // we're getting if the channel is loading from the cache anyways.
2644 // XXX -- should this be changed? it's pretty much verbatim from the old
2645 // code, but seems nonsensical.
2647 // Since aCanMakeNewChannel == false, we don't need to pass content policy
2648 // type/principal/etc
2650 nsCOMPtr
<nsILoadInfo
> loadInfo
= channel
->LoadInfo();
2651 // if there is a loadInfo, use the right contentType, otherwise
2652 // default to the internal image type
2653 nsContentPolicyType policyType
= loadInfo
->InternalContentPolicyType();
2655 if (ValidateEntry(entry
, uri
, nullptr, nullptr, nullptr, aObserver
,
2656 aLoadingDocument
, requestFlags
, policyType
, false,
2657 nullptr, nullptr, nullptr, corsMode
, false, 0)) {
2658 request
= entry
->GetRequest();
2660 nsCOMPtr
<nsICacheInfoChannel
> cacheChan(do_QueryInterface(channel
));
2664 cacheChan
->IsFromCache(&bUseCacheCopy
);
2666 bUseCacheCopy
= false;
2669 if (!bUseCacheCopy
) {
2672 request
= entry
->GetRequest();
2676 if (request
&& entry
) {
2677 // If this entry has no proxies, its request has no reference to
2679 if (entry
->HasNoProxies()) {
2680 LOG_FUNC_WITH_PARAM(
2682 "imgLoader::LoadImageWithChannel() adding proxyless entry", "uri",
2684 MOZ_ASSERT(!request
->HasCacheEntry(),
2685 "Proxyless entry's request has cache entry!");
2686 request
->SetCacheEntry(entry
);
2688 if (mCacheTracker
&& entry
->GetExpirationState()->IsTracked()) {
2689 mCacheTracker
->MarkUsed(entry
);
2696 nsCOMPtr
<nsILoadGroup
> loadGroup
;
2697 channel
->GetLoadGroup(getter_AddRefs(loadGroup
));
2700 if (aLoadingDocument
) {
2701 // The load group of the channel should always match that of the
2702 // document if given. If that isn't the case, then we need to add more
2703 // plumbing to ensure we block the document as well.
2704 nsCOMPtr
<nsILoadGroup
> docLoadGroup
=
2705 aLoadingDocument
->GetDocumentLoadGroup();
2706 MOZ_ASSERT(docLoadGroup
== loadGroup
);
2710 // Filter out any load flags not from nsIRequest
2711 requestFlags
&= nsIRequest::LOAD_REQUESTMASK
;
2713 nsresult rv
= NS_OK
;
2715 // we have this in our cache already.. cancel the current (document) load
2717 // this should fire an OnStopRequest
2718 channel
->Cancel(NS_ERROR_PARSED_DATA_CACHED
);
2720 *listener
= nullptr; // give them back a null nsIStreamListener
2722 rv
= CreateNewProxyForRequest(request
, uri
, loadGroup
, aLoadingDocument
,
2723 aObserver
, requestFlags
, _retval
);
2724 static_cast<imgRequestProxy
*>(*_retval
)->NotifyListener();
2726 // We use originalURI here to fulfil the imgIRequest contract on GetURI.
2727 nsCOMPtr
<nsIURI
> originalURI
;
2728 channel
->GetOriginalURI(getter_AddRefs(originalURI
));
2730 // XXX(seth): We should be able to just use |key| here, except that |key| is
2731 // constructed above with the *current URI* and not the *original URI*. I'm
2732 // pretty sure this is a bug, and it's preventing us from ever getting a
2733 // cache hit in LoadImageWithChannel when redirects are involved.
2734 ImageCacheKey
originalURIKey(originalURI
, corsMode
, attrs
,
2737 // Default to doing a principal check because we don't know who
2738 // started that load and whether their principal ended up being
2739 // inherited on the channel.
2740 NewRequestAndEntry(/* aForcePrincipalCheckForCacheEntry = */ true, this,
2741 originalURIKey
, getter_AddRefs(request
),
2742 getter_AddRefs(entry
));
2744 // No principal specified here, because we're not passed one.
2745 // In LoadImageWithChannel, the redirects that may have been
2746 // associated with this load would have gone through necko.
2747 // We only have the final URI in ImageLib and hence don't know
2748 // if the request went through insecure redirects. But if it did,
2749 // the necko cache should have handled that (since all necko cache hits
2750 // including the redirects will go through content policy). Hence, we
2751 // can set aHadInsecureRedirect to false here.
2752 rv
= request
->Init(originalURI
, uri
, /* aHadInsecureRedirect = */ false,
2753 channel
, channel
, entry
, aLoadingDocument
, nullptr,
2755 NS_ENSURE_SUCCESS(rv
, rv
);
2757 RefPtr
<ProxyListener
> pl
=
2758 new ProxyListener(static_cast<nsIStreamListener
*>(request
.get()));
2759 pl
.forget(listener
);
2761 // Try to add the new request into the cache.
2762 PutIntoCache(originalURIKey
, entry
);
2764 rv
= CreateNewProxyForRequest(request
, originalURI
, loadGroup
,
2765 aLoadingDocument
, aObserver
, requestFlags
,
2768 // Explicitly don't notify our proxy, because we're loading off the
2769 // network, and necko (or things called from necko, such as
2770 // imgCacheValidator) are going to call our notifications asynchronously,
2771 // and we can't make it further asynchronous because observers might rely
2772 // on imagelib completing its work between the channel's OnStartRequest and
2776 if (NS_FAILED(rv
)) {
2780 (*_retval
)->AddToLoadGroup();
2784 bool imgLoader::SupportImageWithMimeType(const nsACString
& aMimeType
,
2785 AcceptedMimeTypes aAccept
2786 /* = AcceptedMimeTypes::IMAGES */) {
2787 nsAutoCString
mimeType(aMimeType
);
2788 ToLowerCase(mimeType
);
2790 if (aAccept
== AcceptedMimeTypes::IMAGES_AND_DOCUMENTS
&&
2791 mimeType
.EqualsLiteral("image/svg+xml")) {
2795 DecoderType type
= DecoderFactory::GetDecoderType(mimeType
.get());
2796 return type
!= DecoderType::UNKNOWN
;
2800 imgLoader::GetMIMETypeFromContent(nsIRequest
* aRequest
,
2801 const uint8_t* aContents
, uint32_t aLength
,
2802 nsACString
& aContentType
) {
2803 nsCOMPtr
<nsIChannel
> channel(do_QueryInterface(aRequest
));
2805 nsCOMPtr
<nsILoadInfo
> loadInfo
= channel
->LoadInfo();
2806 if (loadInfo
->GetSkipContentSniffing()) {
2807 return NS_ERROR_NOT_AVAILABLE
;
2812 GetMimeTypeFromContent((const char*)aContents
, aLength
, aContentType
);
2813 if (NS_SUCCEEDED(rv
) && channel
&& XRE_IsParentProcess()) {
2814 if (RefPtr
<mozilla::net::nsHttpChannel
> httpChannel
=
2815 do_QueryObject(channel
)) {
2816 // If the image type pattern matching algorithm given bytes does not
2817 // return undefined, then disable the further check and allow the
2819 httpChannel
->DisableIsOpaqueResponseAllowedAfterSniffCheck(
2820 mozilla::net::nsHttpChannel::SnifferType::Image
);
2828 nsresult
imgLoader::GetMimeTypeFromContent(const char* aContents
,
2830 nsACString
& aContentType
) {
2831 nsAutoCString detected
;
2835 (!strncmp(aContents
, "GIF87a", 6) || !strncmp(aContents
, "GIF89a", 6))) {
2836 aContentType
.AssignLiteral(IMAGE_GIF
);
2839 } else if (aLength
>= 8 && ((unsigned char)aContents
[0] == 0x89 &&
2840 (unsigned char)aContents
[1] == 0x50 &&
2841 (unsigned char)aContents
[2] == 0x4E &&
2842 (unsigned char)aContents
[3] == 0x47 &&
2843 (unsigned char)aContents
[4] == 0x0D &&
2844 (unsigned char)aContents
[5] == 0x0A &&
2845 (unsigned char)aContents
[6] == 0x1A &&
2846 (unsigned char)aContents
[7] == 0x0A)) {
2847 aContentType
.AssignLiteral(IMAGE_PNG
);
2849 /* maybe a JPEG (JFIF)? */
2850 /* JFIF files start with SOI APP0 but older files can start with SOI DQT
2851 * so we test for SOI followed by any marker, i.e. FF D8 FF
2852 * this will also work for SPIFF JPEG files if they appear in the future.
2854 * (JFIF is 0XFF 0XD8 0XFF 0XE0 <skip 2> 0X4A 0X46 0X49 0X46 0X00)
2856 } else if (aLength
>= 3 && ((unsigned char)aContents
[0]) == 0xFF &&
2857 ((unsigned char)aContents
[1]) == 0xD8 &&
2858 ((unsigned char)aContents
[2]) == 0xFF) {
2859 aContentType
.AssignLiteral(IMAGE_JPEG
);
2861 /* or how about ART? */
2862 /* ART begins with JG (4A 47). Major version offset 2.
2863 * Minor version offset 3. Offset 4 must be nullptr.
2865 } else if (aLength
>= 5 && ((unsigned char)aContents
[0]) == 0x4a &&
2866 ((unsigned char)aContents
[1]) == 0x47 &&
2867 ((unsigned char)aContents
[4]) == 0x00) {
2868 aContentType
.AssignLiteral(IMAGE_ART
);
2870 } else if (aLength
>= 2 && !strncmp(aContents
, "BM", 2)) {
2871 aContentType
.AssignLiteral(IMAGE_BMP
);
2873 // ICOs always begin with a 2-byte 0 followed by a 2-byte 1.
2874 // CURs begin with 2-byte 0 followed by 2-byte 2.
2875 } else if (aLength
>= 4 && (!memcmp(aContents
, "\000\000\001\000", 4) ||
2876 !memcmp(aContents
, "\000\000\002\000", 4))) {
2877 aContentType
.AssignLiteral(IMAGE_ICO
);
2879 // WebPs always begin with RIFF, a 32-bit length, and WEBP.
2880 } else if (aLength
>= 12 && !memcmp(aContents
, "RIFF", 4) &&
2881 !memcmp(aContents
+ 8, "WEBP", 4)) {
2882 aContentType
.AssignLiteral(IMAGE_WEBP
);
2884 } else if (MatchesMP4(reinterpret_cast<const uint8_t*>(aContents
), aLength
,
2886 detected
.Equals(IMAGE_AVIF
)) {
2887 aContentType
.AssignLiteral(IMAGE_AVIF
);
2888 } else if ((aLength
>= 2 && !memcmp(aContents
, "\xFF\x0A", 2)) ||
2890 !memcmp(aContents
, "\x00\x00\x00\x0CJXL \x0D\x0A\x87\x0A", 12))) {
2891 // Each version is for containerless and containerful files respectively.
2892 aContentType
.AssignLiteral(IMAGE_JXL
);
2894 /* none of the above? I give up */
2895 return NS_ERROR_NOT_AVAILABLE
;
2902 * proxy stream listener class used to handle multipart/x-mixed-replace
2905 #include "nsIRequest.h"
2906 #include "nsIStreamConverterService.h"
2908 NS_IMPL_ISUPPORTS(ProxyListener
, nsIStreamListener
,
2909 nsIThreadRetargetableStreamListener
, nsIRequestObserver
)
2911 ProxyListener::ProxyListener(nsIStreamListener
* dest
) : mDestListener(dest
) {}
2913 ProxyListener::~ProxyListener() = default;
2915 /** nsIRequestObserver methods **/
2918 ProxyListener::OnStartRequest(nsIRequest
* aRequest
) {
2919 if (!mDestListener
) {
2920 return NS_ERROR_FAILURE
;
2923 nsCOMPtr
<nsIChannel
> channel(do_QueryInterface(aRequest
));
2925 // We need to set the initiator type for the image load
2926 nsCOMPtr
<nsITimedChannel
> timedChannel
= do_QueryInterface(channel
);
2929 timedChannel
->GetInitiatorType(type
);
2930 if (type
.IsEmpty()) {
2931 timedChannel
->SetInitiatorType(u
"img"_ns
);
2935 nsAutoCString contentType
;
2936 nsresult rv
= channel
->GetContentType(contentType
);
2938 if (!contentType
.IsEmpty()) {
2939 /* If multipart/x-mixed-replace content, we'll insert a MIME decoder
2940 in the pipeline to handle the content and pass it along to our
2943 if ("multipart/x-mixed-replace"_ns
.Equals(contentType
)) {
2944 nsCOMPtr
<nsIStreamConverterService
> convServ(
2945 do_GetService("@mozilla.org/streamConverters;1", &rv
));
2946 if (NS_SUCCEEDED(rv
)) {
2947 nsCOMPtr
<nsIStreamListener
> toListener(mDestListener
);
2948 nsCOMPtr
<nsIStreamListener
> fromListener
;
2950 rv
= convServ
->AsyncConvertData("multipart/x-mixed-replace", "*/*",
2951 toListener
, nullptr,
2952 getter_AddRefs(fromListener
));
2953 if (NS_SUCCEEDED(rv
)) {
2954 mDestListener
= fromListener
;
2961 return mDestListener
->OnStartRequest(aRequest
);
2965 ProxyListener::OnStopRequest(nsIRequest
* aRequest
, nsresult status
) {
2966 if (!mDestListener
) {
2967 return NS_ERROR_FAILURE
;
2970 return mDestListener
->OnStopRequest(aRequest
, status
);
2973 /** nsIStreamListener methods **/
2976 ProxyListener::OnDataAvailable(nsIRequest
* aRequest
, nsIInputStream
* inStr
,
2977 uint64_t sourceOffset
, uint32_t count
) {
2978 if (!mDestListener
) {
2979 return NS_ERROR_FAILURE
;
2982 return mDestListener
->OnDataAvailable(aRequest
, inStr
, sourceOffset
, count
);
2985 /** nsThreadRetargetableStreamListener methods **/
2987 ProxyListener::CheckListenerChain() {
2988 NS_ASSERTION(NS_IsMainThread(), "Should be on the main thread!");
2989 nsresult rv
= NS_OK
;
2990 nsCOMPtr
<nsIThreadRetargetableStreamListener
> retargetableListener
=
2991 do_QueryInterface(mDestListener
, &rv
);
2992 if (retargetableListener
) {
2993 rv
= retargetableListener
->CheckListenerChain();
2996 gImgLog
, LogLevel::Debug
,
2997 ("ProxyListener::CheckListenerChain %s [this=%p listener=%p rv=%" PRIx32
2999 (NS_SUCCEEDED(rv
) ? "success" : "failure"), this,
3000 (nsIStreamListener
*)mDestListener
, static_cast<uint32_t>(rv
)));
3005 * http validate class. check a channel for a 304
3008 NS_IMPL_ISUPPORTS(imgCacheValidator
, nsIStreamListener
, nsIRequestObserver
,
3009 nsIThreadRetargetableStreamListener
, nsIChannelEventSink
,
3010 nsIInterfaceRequestor
, nsIAsyncVerifyRedirectCallback
)
3012 imgCacheValidator::imgCacheValidator(nsProgressNotificationProxy
* progress
,
3013 imgLoader
* loader
, imgRequest
* request
,
3014 Document
* aDocument
,
3015 uint64_t aInnerWindowId
,
3016 bool forcePrincipalCheckForCacheEntry
)
3017 : mProgressProxy(progress
),
3019 mDocument(aDocument
),
3020 mInnerWindowId(aInnerWindowId
),
3022 mHadInsecureRedirect(false) {
3023 NewRequestAndEntry(forcePrincipalCheckForCacheEntry
, loader
,
3024 mRequest
->CacheKey(), getter_AddRefs(mNewRequest
),
3025 getter_AddRefs(mNewEntry
));
3028 imgCacheValidator::~imgCacheValidator() {
3030 // If something went wrong, and we never unblocked the requests waiting on
3031 // validation, now is our last chance. We will cancel the new request and
3032 // switch the waiting proxies to it.
3033 UpdateProxies(/* aCancelRequest */ true, /* aSyncNotify */ false);
3037 void imgCacheValidator::AddProxy(imgRequestProxy
* aProxy
) {
3038 // aProxy needs to be in the loadgroup since we're validating from
3040 aProxy
->AddToLoadGroup();
3042 mProxies
.AppendElement(aProxy
);
3045 void imgCacheValidator::RemoveProxy(imgRequestProxy
* aProxy
) {
3046 mProxies
.RemoveElement(aProxy
);
3049 void imgCacheValidator::UpdateProxies(bool aCancelRequest
, bool aSyncNotify
) {
3050 MOZ_ASSERT(mRequest
);
3052 // Clear the validator before updating the proxies. The notifications may
3053 // clone an existing request, and its state could be inconsistent.
3054 mRequest
->SetValidator(nullptr);
3057 // If an error occurred, we will want to cancel the new request, and make the
3058 // validating proxies point to it. Any proxies still bound to the original
3059 // request which are not validating should remain untouched.
3060 if (aCancelRequest
) {
3061 MOZ_ASSERT(mNewRequest
);
3062 mNewRequest
->CancelAndAbort(NS_BINDING_ABORTED
);
3065 // We have finished validating the request, so we can safely take ownership
3066 // of the proxy list. imgRequestProxy::SyncNotifyListener can mutate the list
3067 // if imgRequestProxy::CancelAndForgetObserver is called by its owner. Note
3068 // that any potential notifications should still be suppressed in
3069 // imgRequestProxy::ChangeOwner because we haven't cleared the validating
3070 // flag yet, and thus they will remain deferred.
3071 AutoTArray
<RefPtr
<imgRequestProxy
>, 4> proxies(std::move(mProxies
));
3073 for (auto& proxy
: proxies
) {
3074 // First update the state of all proxies before notifying any of them
3075 // to ensure a consistent state (e.g. in case the notification causes
3076 // other proxies to be touched indirectly.)
3077 MOZ_ASSERT(proxy
->IsValidating());
3078 MOZ_ASSERT(proxy
->NotificationsDeferred(),
3079 "Proxies waiting on cache validation should be "
3080 "deferring notifications!");
3082 proxy
->ChangeOwner(mNewRequest
);
3084 proxy
->ClearValidating();
3087 mNewRequest
= nullptr;
3088 mNewEntry
= nullptr;
3090 for (auto& proxy
: proxies
) {
3092 // Notify synchronously, because the caller knows we are already in an
3093 // asynchronously-called function (e.g. OnStartRequest).
3094 proxy
->SyncNotifyListener();
3096 // Notify asynchronously, because the caller does not know our current
3097 // call state (e.g. ~imgCacheValidator).
3098 proxy
->NotifyListener();
3103 /** nsIRequestObserver methods **/
3106 imgCacheValidator::OnStartRequest(nsIRequest
* aRequest
) {
3107 // We may be holding on to a document, so ensure that it's released.
3108 RefPtr
<Document
> document
= mDocument
.forget();
3110 // If for some reason we don't still have an existing request (probably
3111 // because OnStartRequest got delivered more than once), just bail.
3113 MOZ_ASSERT_UNREACHABLE("OnStartRequest delivered more than once?");
3114 aRequest
->CancelWithReason(NS_BINDING_ABORTED
,
3115 "OnStartRequest delivered more than once?"_ns
);
3116 return NS_ERROR_FAILURE
;
3119 // If this request is coming from cache and has the same URI as our
3120 // imgRequest, the request all our proxies are pointing at is valid, and all
3121 // we have to do is tell them to notify their listeners.
3122 nsCOMPtr
<nsICacheInfoChannel
> cacheChan(do_QueryInterface(aRequest
));
3123 nsCOMPtr
<nsIChannel
> channel(do_QueryInterface(aRequest
));
3124 if (cacheChan
&& channel
) {
3125 bool isFromCache
= false;
3126 cacheChan
->IsFromCache(&isFromCache
);
3128 nsCOMPtr
<nsIURI
> channelURI
;
3129 channel
->GetURI(getter_AddRefs(channelURI
));
3131 nsCOMPtr
<nsIURI
> finalURI
;
3132 mRequest
->GetFinalURI(getter_AddRefs(finalURI
));
3134 bool sameURI
= false;
3135 if (channelURI
&& finalURI
) {
3136 channelURI
->Equals(finalURI
, &sameURI
);
3139 if (isFromCache
&& sameURI
) {
3140 // We don't need to load this any more.
3141 aRequest
->CancelWithReason(NS_BINDING_ABORTED
,
3142 "imgCacheValidator::OnStartRequest"_ns
);
3143 mNewRequest
= nullptr;
3145 // Clear the validator before updating the proxies. The notifications may
3146 // clone an existing request, and its state could be inconsistent.
3147 mRequest
->SetLoadId(document
);
3148 mRequest
->SetInnerWindowID(mInnerWindowId
);
3149 UpdateProxies(/* aCancelRequest */ false, /* aSyncNotify */ true);
3154 // We can't load out of cache. We have to create a whole new request for the
3155 // data that's coming in off the channel.
3156 nsCOMPtr
<nsIURI
> uri
;
3157 mRequest
->GetURI(getter_AddRefs(uri
));
3159 LOG_MSG_WITH_PARAM(gImgLog
,
3160 "imgCacheValidator::OnStartRequest creating new request",
3163 CORSMode corsmode
= mRequest
->GetCORSMode();
3164 nsCOMPtr
<nsIReferrerInfo
> referrerInfo
= mRequest
->GetReferrerInfo();
3165 nsCOMPtr
<nsIPrincipal
> triggeringPrincipal
=
3166 mRequest
->GetTriggeringPrincipal();
3168 // Doom the old request's cache entry
3169 mRequest
->RemoveFromCache();
3171 // We use originalURI here to fulfil the imgIRequest contract on GetURI.
3172 nsCOMPtr
<nsIURI
> originalURI
;
3173 channel
->GetOriginalURI(getter_AddRefs(originalURI
));
3174 nsresult rv
= mNewRequest
->Init(originalURI
, uri
, mHadInsecureRedirect
,
3175 aRequest
, channel
, mNewEntry
, document
,
3176 triggeringPrincipal
, corsmode
, referrerInfo
);
3177 if (NS_FAILED(rv
)) {
3178 UpdateProxies(/* aCancelRequest */ true, /* aSyncNotify */ true);
3182 mDestListener
= new ProxyListener(mNewRequest
);
3184 // Try to add the new request into the cache. Note that the entry must be in
3185 // the cache before the proxies' ownership changes, because adding a proxy
3186 // changes the caching behaviour for imgRequests.
3187 mImgLoader
->PutIntoCache(mNewRequest
->CacheKey(), mNewEntry
);
3188 UpdateProxies(/* aCancelRequest */ false, /* aSyncNotify */ true);
3189 return mDestListener
->OnStartRequest(aRequest
);
3193 imgCacheValidator::OnStopRequest(nsIRequest
* aRequest
, nsresult status
) {
3194 // Be sure we've released the document that we may have been holding on to.
3195 mDocument
= nullptr;
3197 if (!mDestListener
) {
3201 return mDestListener
->OnStopRequest(aRequest
, status
);
3204 /** nsIStreamListener methods **/
3207 imgCacheValidator::OnDataAvailable(nsIRequest
* aRequest
, nsIInputStream
* inStr
,
3208 uint64_t sourceOffset
, uint32_t count
) {
3209 if (!mDestListener
) {
3210 // XXX see bug 113959
3212 inStr
->ReadSegments(NS_DiscardSegment
, nullptr, count
, &_retval
);
3216 return mDestListener
->OnDataAvailable(aRequest
, inStr
, sourceOffset
, count
);
3219 /** nsIThreadRetargetableStreamListener methods **/
3222 imgCacheValidator::CheckListenerChain() {
3223 NS_ASSERTION(NS_IsMainThread(), "Should be on the main thread!");
3224 nsresult rv
= NS_OK
;
3225 nsCOMPtr
<nsIThreadRetargetableStreamListener
> retargetableListener
=
3226 do_QueryInterface(mDestListener
, &rv
);
3227 if (retargetableListener
) {
3228 rv
= retargetableListener
->CheckListenerChain();
3231 gImgLog
, LogLevel::Debug
,
3232 ("[this=%p] imgCacheValidator::CheckListenerChain -- rv %" PRId32
"=%s",
3233 this, static_cast<uint32_t>(rv
),
3234 NS_SUCCEEDED(rv
) ? "succeeded" : "failed"));
3238 /** nsIInterfaceRequestor methods **/
3241 imgCacheValidator::GetInterface(const nsIID
& aIID
, void** aResult
) {
3242 if (aIID
.Equals(NS_GET_IID(nsIChannelEventSink
))) {
3243 return QueryInterface(aIID
, aResult
);
3246 return mProgressProxy
->GetInterface(aIID
, aResult
);
3249 // These functions are materially the same as the same functions in imgRequest.
3250 // We duplicate them because we're verifying whether cache loads are necessary,
3251 // not unconditionally loading.
3253 /** nsIChannelEventSink methods **/
3255 imgCacheValidator::AsyncOnChannelRedirect(
3256 nsIChannel
* oldChannel
, nsIChannel
* newChannel
, uint32_t flags
,
3257 nsIAsyncVerifyRedirectCallback
* callback
) {
3258 // Note all cache information we get from the old channel.
3259 mNewRequest
->SetCacheValidation(mNewEntry
, oldChannel
);
3261 // If the previous URI is a non-HTTPS URI, record that fact for later use by
3262 // security code, which needs to know whether there is an insecure load at any
3263 // point in the redirect chain.
3264 nsCOMPtr
<nsIURI
> oldURI
;
3265 bool schemeLocal
= false;
3266 if (NS_FAILED(oldChannel
->GetURI(getter_AddRefs(oldURI
))) ||
3267 NS_FAILED(NS_URIChainHasFlags(
3268 oldURI
, nsIProtocolHandler::URI_IS_LOCAL_RESOURCE
, &schemeLocal
)) ||
3269 (!oldURI
->SchemeIs("https") && !oldURI
->SchemeIs("chrome") &&
3271 mHadInsecureRedirect
= true;
3274 // Prepare for callback
3275 mRedirectCallback
= callback
;
3276 mRedirectChannel
= newChannel
;
3278 return mProgressProxy
->AsyncOnChannelRedirect(oldChannel
, newChannel
, flags
,
3283 imgCacheValidator::OnRedirectVerifyCallback(nsresult aResult
) {
3284 // If we've already been told to abort, just do so.
3285 if (NS_FAILED(aResult
)) {
3286 mRedirectCallback
->OnRedirectVerifyCallback(aResult
);
3287 mRedirectCallback
= nullptr;
3288 mRedirectChannel
= nullptr;
3292 // make sure we have a protocol that returns data rather than opens
3293 // an external application, e.g. mailto:
3294 nsCOMPtr
<nsIURI
> uri
;
3295 mRedirectChannel
->GetURI(getter_AddRefs(uri
));
3297 nsresult result
= NS_OK
;
3299 if (nsContentUtils::IsExternalProtocol(uri
)) {
3300 result
= NS_ERROR_ABORT
;
3303 mRedirectCallback
->OnRedirectVerifyCallback(result
);
3304 mRedirectCallback
= nullptr;
3305 mRedirectChannel
= nullptr;