image/imgLoader.cpp

   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/. */
   6
   7 // Undefine windows version of LoadImage because our code uses that name.
   8 #include "mozilla/ScopeExit.h"
   9 #include "nsIChildChannel.h"
  10 #undef LoadImage
  11
  12 #include "imgLoader.h"
  13
  14 #include <algorithm>
  15 #include <utility>
  16
  17 #include "DecoderFactory.h"
  18 #include "Image.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"
  37 #include "nsCOMPtr.h"
  38 #include "nsCRT.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"
  49 #include "nsIFile.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"
  61 #include "nsNetCID.h"
  62 #include "nsNetUtil.h"
  63 #include "nsProxyRelease.h"
  64 #include "nsQueryObject.h"
  65 #include "nsReadableUtils.h"
  66 #include "nsStreamUtils.h"
  67 #include "prtime.h"
  68
  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"
  75
  76 using namespace mozilla;
  77 using namespace mozilla::dom;
  78 using namespace mozilla::image;
  79 using namespace mozilla::net;
  80
  81 MOZ_DEFINE_MALLOC_SIZE_OF(ImagesMallocSizeOf)
  82
  83 class imgMemoryReporter final : public nsIMemoryReporter {
  84   ~imgMemoryReporter() = default;
  85
  86  public:
  87   NS_DECL_ISUPPORTS
  88
  89   NS_IMETHOD CollectReports(nsIHandleReportCallback* aHandleReport,
  90                             nsISupports* aData, bool aAnonymize) override {
  91     MOZ_ASSERT(NS_IsMainThread());
  92
  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);
  98       return NS_OK;
  99     }
 100
 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);
 107         },
 108         [=](mozilla::ipc::ResponseRejectReason&& aReason) {
 109           layers::SharedSurfacesMemoryReport sharedSurfaces;
 110           self->FinishCollectReports(handleReport, data, aAnonymize,
 111                                      sharedSurfaces);
 112         });
 113     return NS_OK;
 114   }
 115
 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;
 122
 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());
 127       }
 128       MutexAutoLock lock(mKnownLoaders[i]->mUncachedImagesMutex);
 129       for (RefPtr<imgRequest> req : mKnownLoaders[i]->mUncachedImages) {
 130         RecordCounterForRequest(req, &uncached, req->HasConsumers());
 131       }
 132     }
 133
 134     // Note that we only need to anonymize content image URIs.
 135
 136     ReportCounterArray(aHandleReport, aData, chrome, "images/chrome",
 137                        /* aAnonymize */ false, aSharedSurfaces);
 138
 139     ReportCounterArray(aHandleReport, aData, content, "images/content",
 140                        aAnonymize, aSharedSurfaces);
 141
 142     // Uncached images may be content or chrome, so anonymize them.
 143     ReportCounterArray(aHandleReport, aData, uncached, "images/uncached",
 144                        aAnonymize, aSharedSurfaces);
 145
 146     // Report any shared surfaces that were not merged with the surface cache.
 147     ImageMemoryReporter::ReportSharedSurfaces(aHandleReport, aData,
 148                                               aSharedSurfaces);
 149
 150     nsCOMPtr<nsIMemoryReporterManager> imgr =
 151         do_GetService("@mozilla.org/memory-reporter-manager;1");
 152     if (imgr) {
 153       imgr->EndReport();
 154     }
 155   }
 156
 157   static int64_t ImagesContentUsedUncompressedDistinguishedAmount() {
 158     size_t n = 0;
 159     for (uint32_t i = 0; i < imgLoader::sMemReporter->mKnownLoaders.Length();
 160          i++) {
 161       for (imgCacheEntry* entry :
 162            imgLoader::sMemReporter->mKnownLoaders[i]->mCache.Values()) {
 163         if (entry->HasNoProxies()) {
 164           continue;
 165         }
 166
 167         RefPtr<imgRequest> req = entry->GetRequest();
 168         RefPtr<image::Image> image = req->GetImage();
 169         if (!image) {
 170           continue;
 171         }
 172
 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);
 180
 181         n += counter.Values().DecodedHeap();
 182         n += counter.Values().DecodedNonHeap();
 183         n += counter.Values().DecodedUnknown();
 184       }
 185     }
 186     return n;
 187   }
 188
 189   void RegisterLoader(imgLoader* aLoader) {
 190     mKnownLoaders.AppendElement(aLoader);
 191   }
 192
 193   void UnregisterLoader(imgLoader* aLoader) {
 194     mKnownLoaders.RemoveElement(aLoader);
 195   }
 196
 197  private:
 198   nsTArray<imgLoader*> mKnownLoaders;
 199
 200   struct MemoryTotal {
 201     MemoryTotal& operator+=(const ImageMemoryCounter& aImageCounter) {
 202       if (aImageCounter.Type() == imgIContainer::TYPE_RASTER) {
 203         if (aImageCounter.IsUsed()) {
 204           mUsedRasterCounter += aImageCounter.Values();
 205         } else {
 206           mUnusedRasterCounter += aImageCounter.Values();
 207         }
 208       } else if (aImageCounter.Type() == imgIContainer::TYPE_VECTOR) {
 209         if (aImageCounter.IsUsed()) {
 210           mUsedVectorCounter += aImageCounter.Values();
 211         } else {
 212           mUnusedVectorCounter += aImageCounter.Values();
 213         }
 214       } else if (aImageCounter.Type() == imgIContainer::TYPE_REQUEST) {
 215         // Nothing to do, we did not get to the point of having an image.
 216       } else {
 217         MOZ_CRASH("Unexpected image type");
 218       }
 219
 220       return *this;
 221     }
 222
 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; }
 227
 228    private:
 229     MemoryCounter mUsedRasterCounter;
 230     MemoryCounter mUnusedRasterCounter;
 231     MemoryCounter mUsedVectorCounter;
 232     MemoryCounter mUnusedVectorCounter;
 233   };
 234
 235   // Reports all images of a single kind, e.g. all used chrome images.
 236   void ReportCounterArray(nsIHandleReportCallback* aHandleReport,
 237                           nsISupports* aData,
 238                           nsTArray<ImageMemoryCounter>& aCounterArray,
 239                           const char* aPathPrefix, bool aAnonymize,
 240                           layers::SharedSurfacesMemoryReport& aSharedSurfaces) {
 241     MemoryTotal summaryTotal;
 242     MemoryTotal nonNotableTotal;
 243
 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];
 247
 248       if (aAnonymize) {
 249         counter.URI().Truncate();
 250         counter.URI().AppendPrintf("<anonymized-%u>", i);
 251       } else {
 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)");
 257         }
 258         counter.URI().ReplaceChar('/', '\\');
 259       }
 260
 261       summaryTotal += counter;
 262
 263       if (counter.IsNotable() || StaticPrefs::image_mem_debug_reporting()) {
 264         ReportImage(aHandleReport, aData, aPathPrefix, counter,
 265                     aSharedSurfaces);
 266       } else {
 267         ImageMemoryReporter::TrimSharedSurfaces(counter, aSharedSurfaces);
 268         nonNotableTotal += counter;
 269       }
 270     }
 271
 272     // Report non-notable images in aggregate.
 273     ReportTotal(aHandleReport, aData, /* aExplicit = */ true, aPathPrefix,
 274                 "<non-notable images>/", nonNotableTotal);
 275
 276     // Report a summary in aggregate, outside of the explicit tree.
 277     ReportTotal(aHandleReport, aData, /* aExplicit = */ false, aPathPrefix, "",
 278                 summaryTotal);
 279   }
 280
 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);
 287
 288     switch (aCounter.Type()) {
 289       case imgIContainer::TYPE_RASTER:
 290         pathPrefix.AppendLiteral("/raster/");
 291         break;
 292       case imgIContainer::TYPE_VECTOR:
 293         pathPrefix.AppendLiteral("/vector/");
 294         break;
 295       case imgIContainer::TYPE_REQUEST:
 296         pathPrefix.AppendLiteral("/request/");
 297         break;
 298       default:
 299         pathPrefix.AppendLiteral("/unknown=");
 300         pathPrefix.AppendInt(aCounter.Type());
 301         pathPrefix.AppendLiteral("/");
 302         break;
 303     }
 304
 305     pathPrefix.Append(aCounter.IsUsed() ? "used/" : "unused/");
 306     if (aCounter.IsValidating()) {
 307       pathPrefix.AppendLiteral("validating/");
 308     }
 309     if (aCounter.HasError()) {
 310       pathPrefix.AppendLiteral("err/");
 311     }
 312
 313     pathPrefix.AppendLiteral("progress=");
 314     pathPrefix.AppendInt(aCounter.Progress(), 16);
 315     pathPrefix.AppendLiteral("/");
 316
 317     pathPrefix.AppendLiteral("image(");
 318     pathPrefix.AppendInt(aCounter.IntrinsicSize().width);
 319     pathPrefix.AppendLiteral("x");
 320     pathPrefix.AppendInt(aCounter.IntrinsicSize().height);
 321     pathPrefix.AppendLiteral(", ");
 322
 323     if (aCounter.URI().IsEmpty()) {
 324       pathPrefix.AppendLiteral("<unknown URI>");
 325     } else {
 326       pathPrefix.Append(aCounter.URI());
 327     }
 328
 329     pathPrefix.AppendLiteral(")/");
 330
 331     ReportSurfaces(aHandleReport, aData, pathPrefix, aCounter, aSharedSurfaces);
 332
 333     ReportSourceValue(aHandleReport, aData, pathPrefix, aCounter.Values());
 334   }
 335
 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/");
 346           } else {
 347             surfacePathPrefix.AppendLiteral("unlocked/");
 348           }
 349           if (counter.IsFactor2()) {
 350             surfacePathPrefix.AppendLiteral("factor2/");
 351           }
 352           if (counter.CannotSubstitute()) {
 353             surfacePathPrefix.AppendLiteral("cannot_substitute/");
 354           }
 355           break;
 356         case SurfaceMemoryCounterType::CONTAINER:
 357           surfacePathPrefix.AppendLiteral("container/");
 358           break;
 359         default:
 360           MOZ_ASSERT_UNREACHABLE("Unknown counter type");
 361           break;
 362       }
 363
 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);
 370
 371       if (!counter.IsFinished()) {
 372         surfacePathPrefix.AppendLiteral(", incomplete");
 373       }
 374
 375       if (counter.Values().ExternalHandles() > 0) {
 376         surfacePathPrefix.AppendLiteral(", handles:");
 377         surfacePathPrefix.AppendInt(
 378             uint32_t(counter.Values().ExternalHandles()));
 379       }
 380
 381       ImageMemoryReporter::AppendSharedSurfacePrefix(surfacePathPrefix, counter,
 382                                                      aSharedSurfaces);
 383
 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()));
 389         } else {
 390           surfacePathPrefix.AppendLiteral(" (animation)");
 391         }
 392       }
 393
 394       if (counter.Key().Flags() != DefaultSurfaceFlags()) {
 395         surfacePathPrefix.AppendLiteral(", flags:");
 396         surfacePathPrefix.AppendInt(uint32_t(counter.Key().Flags()),
 397                                     /* aRadix = */ 16);
 398       }
 399
 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");
 415           } else {
 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);
 424           }
 425         }
 426         if (region.GetExtendMode() != gfx::ExtendMode::CLAMP) {
 427           surfacePathPrefix.AppendLiteral(", extendMode=");
 428           surfacePathPrefix.AppendInt(int32_t(region.GetExtendMode()));
 429         }
 430         surfacePathPrefix.AppendLiteral("]");
 431       }
 432
 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(") ");
 442       }
 443       if (context.GetPreserveAspectRatio()) {
 444         nsAutoString aspect;
 445         context.GetPreserveAspectRatio()->ToString(aspect);
 446         surfacePathPrefix.AppendLiteral("preserveAspectRatio=(");
 447         LossyAppendUTF16toASCII(aspect, surfacePathPrefix);
 448         surfacePathPrefix.AppendLiteral(") ");
 449       }
 450       if (auto scheme = context.GetColorScheme()) {
 451         surfacePathPrefix.AppendLiteral("colorScheme=");
 452         surfacePathPrefix.AppendInt(int32_t(*scheme));
 453         surfacePathPrefix.AppendLiteral(" ");
 454       }
 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);
 461         }
 462         if (paint->GetFillOpacity() != 1.0) {
 463           surfacePathPrefix.AppendLiteral(" fillOpa=");
 464           surfacePathPrefix.AppendFloat(paint->GetFillOpacity());
 465         }
 466         if (paint->GetStroke()) {
 467           surfacePathPrefix.AppendLiteral(" stroke=");
 468           surfacePathPrefix.AppendInt(paint->GetStroke()->ToABGR(), 16);
 469         }
 470         if (paint->GetStrokeOpacity() != 1.0) {
 471           surfacePathPrefix.AppendLiteral(" strokeOpa=");
 472           surfacePathPrefix.AppendFloat(paint->GetStrokeOpacity());
 473         }
 474         surfacePathPrefix.AppendLiteral(" ) ");
 475       }
 476       surfacePathPrefix.AppendLiteral("]");
 477
 478       surfacePathPrefix.AppendLiteral(")/");
 479
 480       ReportValues(aHandleReport, aData, surfacePathPrefix, counter.Values());
 481     }
 482   }
 483
 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;
 489     if (aExplicit) {
 490       pathPrefix.AppendLiteral("explicit/");
 491     }
 492     pathPrefix.Append(aPathPrefix);
 493
 494     nsAutoCString rasterUsedPrefix(pathPrefix);
 495     rasterUsedPrefix.AppendLiteral("/raster/used/");
 496     rasterUsedPrefix.Append(aPathInfix);
 497     ReportValues(aHandleReport, aData, rasterUsedPrefix, aTotal.UsedRaster());
 498
 499     nsAutoCString rasterUnusedPrefix(pathPrefix);
 500     rasterUnusedPrefix.AppendLiteral("/raster/unused/");
 501     rasterUnusedPrefix.Append(aPathInfix);
 502     ReportValues(aHandleReport, aData, rasterUnusedPrefix,
 503                  aTotal.UnusedRaster());
 504
 505     nsAutoCString vectorUsedPrefix(pathPrefix);
 506     vectorUsedPrefix.AppendLiteral("/vector/used/");
 507     vectorUsedPrefix.Append(aPathInfix);
 508     ReportValues(aHandleReport, aData, vectorUsedPrefix, aTotal.UsedVector());
 509
 510     nsAutoCString vectorUnusedPrefix(pathPrefix);
 511     vectorUnusedPrefix.AppendLiteral("/vector/unused/");
 512     vectorUnusedPrefix.Append(aPathInfix);
 513     ReportValues(aHandleReport, aData, vectorUnusedPrefix,
 514                  aTotal.UnusedVector());
 515   }
 516
 517   static void ReportValues(nsIHandleReportCallback* aHandleReport,
 518                            nsISupports* aData, const nsACString& aPathPrefix,
 519                            const MemoryCounter& aCounter) {
 520     ReportSourceValue(aHandleReport, aData, aPathPrefix, aCounter);
 521
 522     ReportValue(aHandleReport, aData, KIND_HEAP, aPathPrefix, "decoded-heap",
 523                 "Decoded image data which is stored on the heap.",
 524                 aCounter.DecodedHeap());
 525
 526     ReportValue(aHandleReport, aData, KIND_NONHEAP, aPathPrefix,
 527                 "decoded-nonheap",
 528                 "Decoded image data which isn't stored on the heap.",
 529                 aCounter.DecodedNonHeap());
 530
 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,
 534                 "decoded-unknown",
 535                 "Decoded image data which is unknown to be on the heap or not.",
 536                 aCounter.DecodedUnknown());
 537   }
 538
 539   static void ReportSourceValue(nsIHandleReportCallback* aHandleReport,
 540                                 nsISupports* aData,
 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.",
 545                 aCounter.Source());
 546   }
 547
 548   static void ReportValue(nsIHandleReportCallback* aHandleReport,
 549                           nsISupports* aData, int32_t aKind,
 550                           const nsACString& aPathPrefix,
 551                           const char* aPathSuffix, const char* aDescription,
 552                           size_t aValue) {
 553     if (aValue == 0) {
 554       return;
 555     }
 556
 557     nsAutoCString desc(aDescription);
 558     nsAutoCString path(aPathPrefix);
 559     path.Append(aPathSuffix);
 560
 561     aHandleReport->Callback(""_ns, path, aKind, UNITS_BYTES, aValue, desc,
 562                             aData);
 563   }
 564
 565   static void RecordCounterForRequest(imgRequest* aRequest,
 566                                       nsTArray<ImageMemoryCounter>* aArray,
 567                                       bool aIsUsed) {
 568     SizeOfState state(ImagesMallocSizeOf);
 569     RefPtr<image::Image> image = aRequest->GetImage();
 570     if (image) {
 571       ImageMemoryCounter counter(aRequest, image, state, aIsUsed);
 572       aArray->AppendElement(std::move(counter));
 573     } else {
 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));
 578     }
 579   }
 580 };
 581
 582 NS_IMPL_ISUPPORTS(imgMemoryReporter, nsIMemoryReporter)
 583
 584 NS_IMPL_ISUPPORTS(nsProgressNotificationProxy, nsIProgressEventSink,
 585                   nsIChannelEventSink, nsIInterfaceRequestor)
 586
 587 NS_IMETHODIMP
 588 nsProgressNotificationProxy::OnProgress(nsIRequest* request, int64_t progress,
 589                                         int64_t progressMax) {
 590   nsCOMPtr<nsILoadGroup> loadGroup;
 591   request->GetLoadGroup(getter_AddRefs(loadGroup));
 592
 593   nsCOMPtr<nsIProgressEventSink> target;
 594   NS_QueryNotificationCallbacks(mOriginalCallbacks, loadGroup,
 595                                 NS_GET_IID(nsIProgressEventSink),
 596                                 getter_AddRefs(target));
 597   if (!target) {
 598     return NS_OK;
 599   }
 600   return target->OnProgress(mImageRequest, progress, progressMax);
 601 }
 602
 603 NS_IMETHODIMP
 604 nsProgressNotificationProxy::OnStatus(nsIRequest* request, nsresult status,
 605                                       const char16_t* statusArg) {
 606   nsCOMPtr<nsILoadGroup> loadGroup;
 607   request->GetLoadGroup(getter_AddRefs(loadGroup));
 608
 609   nsCOMPtr<nsIProgressEventSink> target;
 610   NS_QueryNotificationCallbacks(mOriginalCallbacks, loadGroup,
 611                                 NS_GET_IID(nsIProgressEventSink),
 612                                 getter_AddRefs(target));
 613   if (!target) {
 614     return NS_OK;
 615   }
 616   return target->OnStatus(mImageRequest, status, statusArg);
 617 }
 618
 619 NS_IMETHODIMP
 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));
 630   if (!target) {
 631     cb->OnRedirectVerifyCallback(NS_OK);
 632     return NS_OK;
 633   }
 634
 635   // Delegate to |target| if set, reusing |cb|
 636   return target->AsyncOnChannelRedirect(oldChannel, newChannel, flags, cb);
 637 }
 638
 639 NS_IMETHODIMP
 640 nsProgressNotificationProxy::GetInterface(const nsIID& iid, void** result) {
 641   if (iid.Equals(NS_GET_IID(nsIProgressEventSink))) {
 642     *result = static_cast<nsIProgressEventSink*>(this);
 643     NS_ADDREF_THIS();
 644     return NS_OK;
 645   }
 646   if (iid.Equals(NS_GET_IID(nsIChannelEventSink))) {
 647     *result = static_cast<nsIChannelEventSink*>(this);
 648     NS_ADDREF_THIS();
 649     return NS_OK;
 650   }
 651   if (mOriginalCallbacks) {
 652     return mOriginalCallbacks->GetInterface(iid, result);
 653   }
 654   return NS_NOINTERFACE;
 655 }
 656
 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);
 666 }
 667
 668 static bool ShouldRevalidateEntry(imgCacheEntry* aEntry, nsLoadFlags aFlags,
 669                                   bool aHasExpired) {
 670   if (aFlags & nsIRequest::LOAD_BYPASS_CACHE) {
 671     return false;
 672   }
 673   if (aFlags & nsIRequest::VALIDATE_ALWAYS) {
 674     return true;
 675   }
 676   if (aEntry->GetMustValidate()) {
 677     return true;
 678   }
 679   if (aHasExpired) {
 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.
 687       return false;
 688     }
 689     // Entry is expired, revalidate.
 690     return true;
 691   }
 692   return false;
 693 }
 694
 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
 709    */
 710   bool insecureRedirect = aImgRequest->HadInsecureRedirect();
 711   nsCOMPtr<nsIURI> contentLocation;
 712   aImgRequest->GetFinalURI(getter_AddRefs(contentLocation));
 713   nsresult rv;
 714
 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();
 723   }
 724
 725   nsCOMPtr<nsILoadInfo> secCheckLoadInfo = new LoadInfo(
 726       loadingPrincipal, aTriggeringPrincipal, aLoadingDocument,
 727       nsILoadInfo::SEC_ONLY_FOR_EXPLICIT_CONTENTSEC_CHECK, aPolicyType);
 728
 729   secCheckLoadInfo->SetSendCSPViolationEvents(aSendCSPViolationReports);
 730
 731   int16_t decision = nsIContentPolicy::REJECT_REQUEST;
 732   rv = NS_CheckContentLoadPolicy(contentLocation, secCheckLoadInfo,
 733                                  ""_ns,  // mime guess
 734                                  &decision, nsContentUtils::GetContentPolicy());
 735   if (NS_FAILED(rv) || !NS_CP_ACCEPTED(decision)) {
 736     return false;
 737   }
 738
 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));
 750     if (docShell) {
 751       Document* document = docShell->GetDocument();
 752       if (document && document->GetUpgradeInsecureRequests(false)) {
 753         return false;
 754       }
 755     }
 756
 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,
 761                                              secCheckLoadInfo,
 762                                              ""_ns,  // mime guess
 763                                              true,   // aReportError
 764                                              &decision);
 765       if (NS_FAILED(rv) || !NS_CP_ACCEPTED(decision)) {
 766         return false;
 767       }
 768     }
 769   }
 770
 771   return true;
 772 }
 773
 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
 776 // to CORS.
 777 static bool ValidateCORSMode(imgRequest* aRequest, bool aForcePrincipalCheck,
 778                              CORSMode aCORSMode,
 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) {
 783     return false;
 784   }
 785
 786   if (aRequest->GetCORSMode() != CORS_NONE || aForcePrincipalCheck) {
 787     nsCOMPtr<nsIPrincipal> otherprincipal = aRequest->GetTriggeringPrincipal();
 788
 789     // If we previously had a principal, but we don't now, we can't use this
 790     // request.
 791     if (otherprincipal && !aTriggeringPrincipal) {
 792       return false;
 793     }
 794
 795     if (otherprincipal && aTriggeringPrincipal &&
 796         !otherprincipal->Equals(aTriggeringPrincipal)) {
 797       return false;
 798     }
 799   }
 800
 801   return true;
 802 }
 803
 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)) {
 811     return false;
 812   }
 813   // Content Policy Check on Cached Images
 814   return ShouldLoadCachedImage(aRequest, aLoadingDocument, aTriggeringPrincipal,
 815                                aPolicyType,
 816                                /* aSendCSPViolationReports */ false);
 817 }
 818
 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) {
 833   MOZ_ASSERT(aResult);
 834
 835   nsresult rv;
 836   nsCOMPtr<nsIHttpChannel> newHttpChannel;
 837
 838   nsCOMPtr<nsIInterfaceRequestor> callbacks;
 839
 840   if (aLoadGroup) {
 841     // Get the notification callbacks from the load group for the new channel.
 842     //
 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
 846     //      than nothing...
 847     //
 848     aLoadGroup->GetNotificationCallbacks(getter_AddRefs(callbacks));
 849   }
 850
 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
 855   // canceled too.
 856   //
 857
 858   nsSecurityFlags securityFlags =
 859       nsContentSecurityManager::ComputeSecurityFlags(
 860           aCORSMode, nsContentSecurityManager::CORSSecurityMapping::
 861                          CORS_NONE_MAPS_TO_INHERITED_CONTEXT);
 862
 863   securityFlags |= nsILoadInfo::SEC_ALLOW_CHROME;
 864
 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);
 876
 877     if (NS_FAILED(rv)) {
 878       return rv;
 879     }
 880
 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.
 885
 886       nsCOMPtr<nsILoadInfo> loadInfo = (*aResult)->LoadInfo();
 887       rv = loadInfo->SetOriginAttributes(
 888           aTriggeringPrincipal->OriginAttributesRef());
 889     }
 890   } else {
 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
 897     // requestingNode.
 898     rv = NS_NewChannel(aResult, aURI, nsContentUtils::GetSystemPrincipal(),
 899                        securityFlags, aPolicyType,
 900                        nullptr,  // nsICookieJarSettings
 901                        nullptr,  // PerformanceStorage
 902                        nullptr,  // loadGroup
 903                        callbacks, aLoadFlags);
 904
 905     if (NS_FAILED(rv)) {
 906       return rv;
 907     }
 908
 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();
 915     }
 916     attrs.mPrivateBrowsingId = aRespectPrivacy ? 1 : 0;
 917
 918     nsCOMPtr<nsILoadInfo> loadInfo = (*aResult)->LoadInfo();
 919     rv = loadInfo->SetOriginAttributes(attrs);
 920   }
 921
 922   if (NS_FAILED(rv)) {
 923     return rv;
 924   }
 925
 926   // only inherit if we have a principal
 927   *aForcePrincipalCheckForCacheEntry =
 928       aTriggeringPrincipal && nsContentUtils::ChannelShouldInheritPrincipal(
 929                                   aTriggeringPrincipal, aURI,
 930                                   /* aInheritForAboutBlank */ false,
 931                                   /* aForceInherit */ false);
 932
 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));
 941     if (aReferrerInfo) {
 942       DebugOnly<nsresult> rv = newHttpChannel->SetReferrerInfo(aReferrerInfo);
 943       MOZ_ASSERT(NS_SUCCEEDED(rv));
 944     }
 945
 946     if (aEarlyHintPreloaderId) {
 947       rv = httpChannelInternal->SetEarlyHintPreloaderId(aEarlyHintPreloaderId);
 948       NS_ENSURE_SUCCESS(rv, rv);
 949     }
 950   }
 951
 952   // Image channels are loaded by default with reduced priority.
 953   nsCOMPtr<nsISupportsPriority> p = do_QueryInterface(*aResult);
 954   if (p) {
 955     uint32_t priority = nsISupportsPriority::PRIORITY_LOW;
 956
 957     if (aLoadFlags & nsIRequest::LOAD_BACKGROUND) {
 958       ++priority;  // further reduce priority for background loads
 959     }
 960
 961     p->AdjustPriority(priority);
 962   }
 963
 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.
 968
 969   nsCOMPtr<nsILoadGroup> loadGroup = do_CreateInstance(NS_LOADGROUP_CONTRACTID);
 970   nsCOMPtr<nsILoadGroupChild> childLoadGroup = do_QueryInterface(loadGroup);
 971   if (childLoadGroup) {
 972     childLoadGroup->SetParentLoadGroup(aLoadGroup);
 973   }
 974   (*aResult)->SetLoadGroup(loadGroup);
 975
 976   return NS_OK;
 977 }
 978
 979 static uint32_t SecondsFromPRTime(PRTime aTime) {
 980   return nsContentUtils::SecondsFromPRTime(aTime);
 981 }
 982
 983 /* static */
 984 imgCacheEntry::imgCacheEntry(imgLoader* loader, imgRequest* request,
 985                              bool forcePrincipalCheck)
 986     : mLoader(loader),
 987       mRequest(request),
 988       mDataSize(0),
 989       mTouchedTime(SecondsFromPRTime(PR_Now())),
 990       mLoadTime(SecondsFromPRTime(PR_Now())),
 991       mExpiryTime(0),
 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.
 995       mEvicted(true),
 996       mHasNoProxies(true),
 997       mForcePrincipalCheck(forcePrincipalCheck),
 998       mHasNotified(false) {}
 999
1000 imgCacheEntry::~imgCacheEntry() {
1001   LOG_FUNC(gImgLog, "imgCacheEntry::~imgCacheEntry()");
1002 }
1003
1004 void imgCacheEntry::Touch(bool updateTime /* = true */) {
1005   LOG_SCOPE(gImgLog, "imgCacheEntry::Touch");
1006
1007   if (updateTime) {
1008     mTouchedTime = SecondsFromPRTime(PR_Now());
1009   }
1010
1011   UpdateCache();
1012 }
1013
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);
1019   }
1020 }
1021
1022 void imgCacheEntry::UpdateLoadTime() {
1023   mLoadTime = SecondsFromPRTime(PR_Now());
1024 }
1025
1026 void imgCacheEntry::SetHasNoProxies(bool hasNoProxies) {
1027   if (MOZ_LOG_TEST(gImgLog, LogLevel::Debug)) {
1028     if (hasNoProxies) {
1029       LOG_FUNC_WITH_PARAM(gImgLog, "imgCacheEntry::SetHasNoProxies true", "uri",
1030                           mRequest->CacheKey().URI());
1031     } else {
1032       LOG_FUNC_WITH_PARAM(gImgLog, "imgCacheEntry::SetHasNoProxies false",
1033                           "uri", mRequest->CacheKey().URI());
1034     }
1035   }
1036
1037   mHasNoProxies = hasNoProxies;
1038 }
1039
1040 imgCacheQueue::imgCacheQueue() : mDirty(false), mSize(0) {}
1041
1042 void imgCacheQueue::UpdateSize(int32_t diff) { mSize += diff; }
1043
1044 uint32_t imgCacheQueue::GetSize() const { return mSize; }
1045
1046 void imgCacheQueue::Remove(imgCacheEntry* entry) {
1047   uint64_t index = mQueue.IndexOf(entry);
1048   if (index == queueContainer::NoIndex) {
1049     return;
1050   }
1051
1052   mSize -= mQueue[index]->GetDataSize();
1053
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();
1060     return;
1061   }
1062
1063   // Remove from the middle of the list.  This potentially
1064   // breaks the binary heap sort order.
1065   mQueue.RemoveElementAt(index);
1066
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) {
1071     Refresh();
1072     return;
1073   }
1074
1075   // Otherwise we must mark the queue dirty and potentially
1076   // trigger an expensive sort later.
1077   MarkDirty();
1078 }
1079
1080 void imgCacheQueue::Push(imgCacheEntry* entry) {
1081   mSize += entry->GetDataSize();
1082
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).
1087   if (!IsDirty()) {
1088     std::push_heap(mQueue.begin(), mQueue.end(),
1089                    imgLoader::CompareCacheEntries);
1090   }
1091 }
1092
1093 already_AddRefed<imgCacheEntry> imgCacheQueue::Pop() {
1094   if (mQueue.IsEmpty()) {
1095     return nullptr;
1096   }
1097   if (IsDirty()) {
1098     Refresh();
1099   }
1100
1101   std::pop_heap(mQueue.begin(), mQueue.end(), imgLoader::CompareCacheEntries);
1102   RefPtr<imgCacheEntry> entry = mQueue.PopLastElement();
1103
1104   mSize -= entry->GetDataSize();
1105   return entry.forget();
1106 }
1107
1108 void imgCacheQueue::Refresh() {
1109   // Resort the list.  This is an O(3 * n) operation and best avoided
1110   // if possible.
1111   std::make_heap(mQueue.begin(), mQueue.end(), imgLoader::CompareCacheEntries);
1112   mDirty = false;
1113 }
1114
1115 void imgCacheQueue::MarkDirty() { mDirty = true; }
1116
1117 bool imgCacheQueue::IsDirty() { return mDirty; }
1118
1119 uint32_t imgCacheQueue::GetNumElements() const { return mQueue.Length(); }
1120
1121 bool imgCacheQueue::Contains(imgCacheEntry* aEntry) const {
1122   return mQueue.Contains(aEntry);
1123 }
1124
1125 imgCacheQueue::iterator imgCacheQueue::begin() { return mQueue.begin(); }
1126
1127 imgCacheQueue::const_iterator imgCacheQueue::begin() const {
1128   return mQueue.begin();
1129 }
1130
1131 imgCacheQueue::iterator imgCacheQueue::end() { return mQueue.end(); }
1132
1133 imgCacheQueue::const_iterator imgCacheQueue::end() const {
1134   return mQueue.end();
1135 }
1136
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);
1143
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|.
1147    */
1148
1149   RefPtr<imgRequestProxy> proxyRequest = new imgRequestProxy();
1150
1151   /* It is important to call |SetLoadFlags()| before calling |Init()| because
1152      |Init()| adds the request to the loadgroup.
1153    */
1154   proxyRequest->SetLoadFlags(aLoadFlags);
1155
1156   // init adds itself to imgRequest's list of observers
1157   nsresult rv = proxyRequest->Init(aRequest, aLoadGroup, aLoadingDocument, aURI,
1158                                    aObserver);
1159   if (NS_WARN_IF(NS_FAILED(rv))) {
1160     return rv;
1161   }
1162
1163   proxyRequest.forget(_retval);
1164   return NS_OK;
1165 }
1166
1167 class imgCacheExpirationTracker final
1168     : public nsExpirationTracker<imgCacheEntry, 3> {
1169   enum { TIMEOUT_SECONDS = 10 };
1170
1171  public:
1172   imgCacheExpirationTracker();
1173
1174  protected:
1175   void NotifyExpired(imgCacheEntry* entry) override;
1176 };
1177
1178 imgCacheExpirationTracker::imgCacheExpirationTracker()
1179     : nsExpirationTracker<imgCacheEntry, 3>(TIMEOUT_SECONDS * 1000,
1180                                             "imgCacheExpirationTracker") {}
1181
1182 void imgCacheExpirationTracker::NotifyExpired(imgCacheEntry* entry) {
1183   // Hold on to a reference to this entry, because the expiration tracker
1184   // mechanism doesn't.
1185   RefPtr<imgCacheEntry> kungFuDeathGrip(entry);
1186
1187   if (MOZ_LOG_TEST(gImgLog, LogLevel::Debug)) {
1188     RefPtr<imgRequest> req = entry->GetRequest();
1189     if (req) {
1190       LOG_FUNC_WITH_PARAM(gImgLog, "imgCacheExpirationTracker::NotifyExpired",
1191                           "entry", req->CacheKey().URI());
1192     }
1193   }
1194
1195   // We can be called multiple times on the same entry. Don't do work multiple
1196   // times.
1197   if (!entry->Evicted()) {
1198     entry->Loader()->RemoveFromCache(entry);
1199   }
1200
1201   entry->Loader()->VerifyCacheSizes();
1202 }
1203
1204 ///////////////////////////////////////////////////////////////////////////////
1205 // imgLoader
1206 ///////////////////////////////////////////////////////////////////////////////
1207
1208 double imgLoader::sCacheTimeWeight;
1209 uint32_t imgLoader::sCacheMaxSize;
1210 imgMemoryReporter* imgLoader::sMemReporter;
1211
1212 NS_IMPL_ISUPPORTS(imgLoader, imgILoader, nsIContentSniffer, imgICache,
1213                   nsISupportsWeakReference, nsIObserver)
1214
1215 static imgLoader* gNormalLoader = nullptr;
1216 static imgLoader* gPrivateBrowsingLoader = nullptr;
1217
1218 /* static */
1219 already_AddRefed<imgLoader> imgLoader::CreateImageLoader() {
1220   // In some cases, such as xpctests, XPCOM modules are not automatically
1221   // initialized.  We need to make sure that our module is initialized before
1222   // we hand out imgLoader instances and code starts using them.
1223   mozilla::image::EnsureModuleInitialized();
1224
1225   RefPtr<imgLoader> loader = new imgLoader();
1226   loader->Init();
1227
1228   return loader.forget();
1229 }
1230
1231 imgLoader* imgLoader::NormalLoader() {
1232   if (!gNormalLoader) {
1233     gNormalLoader = CreateImageLoader().take();
1234   }
1235   return gNormalLoader;
1236 }
1237
1238 imgLoader* imgLoader::PrivateBrowsingLoader() {
1239   if (!gPrivateBrowsingLoader) {
1240     gPrivateBrowsingLoader = CreateImageLoader().take();
1241     gPrivateBrowsingLoader->RespectPrivacyNotifications();
1242   }
1243   return gPrivateBrowsingLoader;
1244 }
1245
1246 imgLoader::imgLoader()
1247     : mUncachedImagesMutex("imgLoader::UncachedImages"),
1248       mRespectPrivacy(false) {
1249   sMemReporter->AddRef();
1250   sMemReporter->RegisterLoader(this);
1251 }
1252
1253 imgLoader::~imgLoader() {
1254   ClearImageCache();
1255   {
1256     // If there are any of our imgRequest's left they are in the uncached
1257     // images set, so clear their pointer to us.
1258     MutexAutoLock lock(mUncachedImagesMutex);
1259     for (RefPtr<imgRequest> req : mUncachedImages) {
1260       req->ClearLoader();
1261     }
1262   }
1263   sMemReporter->UnregisterLoader(this);
1264   sMemReporter->Release();
1265 }
1266
1267 void imgLoader::VerifyCacheSizes() {
1268 #ifdef DEBUG
1269   if (!mCacheTracker) {
1270     return;
1271   }
1272
1273   uint32_t cachesize = mCache.Count();
1274   uint32_t queuesize = mCacheQueue.GetNumElements();
1275   uint32_t trackersize = 0;
1276   for (nsExpirationTracker<imgCacheEntry, 3>::Iterator it(mCacheTracker.get());
1277        it.Next();) {
1278     trackersize++;
1279   }
1280   MOZ_ASSERT(queuesize == trackersize, "Queue and tracker sizes out of sync!");
1281   MOZ_ASSERT(queuesize <= cachesize, "Queue has more elements than cache!");
1282 #endif
1283 }
1284
1285 void imgLoader::GlobalInit() {
1286   sCacheTimeWeight = StaticPrefs::image_cache_timeweight_AtStartup() / 1000.0;
1287   int32_t cachesize = StaticPrefs::image_cache_size_AtStartup();
1288   sCacheMaxSize = cachesize > 0 ? cachesize : 0;
1289
1290   sMemReporter = new imgMemoryReporter();
1291   RegisterStrongAsyncMemoryReporter(sMemReporter);
1292   RegisterImagesContentUsedUncompressedDistinguishedAmount(
1293       imgMemoryReporter::ImagesContentUsedUncompressedDistinguishedAmount);
1294 }
1295
1296 void imgLoader::ShutdownMemoryReporter() {
1297   UnregisterImagesContentUsedUncompressedDistinguishedAmount();
1298   UnregisterStrongMemoryReporter(sMemReporter);
1299 }
1300
1301 nsresult imgLoader::InitCache() {
1302   nsCOMPtr<nsIObserverService> os = mozilla::services::GetObserverService();
1303   if (!os) {
1304     return NS_ERROR_FAILURE;
1305   }
1306
1307   os->AddObserver(this, "memory-pressure", false);
1308   os->AddObserver(this, "chrome-flush-caches", false);
1309   os->AddObserver(this, "last-pb-context-exited", false);
1310   os->AddObserver(this, "profile-before-change", false);
1311   os->AddObserver(this, "xpcom-shutdown", false);
1312
1313   mCacheTracker = MakeUnique<imgCacheExpirationTracker>();
1314
1315   return NS_OK;
1316 }
1317
1318 nsresult imgLoader::Init() {
1319   InitCache();
1320
1321   return NS_OK;
1322 }
1323
1324 NS_IMETHODIMP
1325 imgLoader::RespectPrivacyNotifications() {
1326   mRespectPrivacy = true;
1327   return NS_OK;
1328 }
1329
1330 NS_IMETHODIMP
1331 imgLoader::Observe(nsISupports* aSubject, const char* aTopic,
1332                    const char16_t* aData) {
1333   if (strcmp(aTopic, "memory-pressure") == 0) {
1334     MinimizeCache();
1335   } else if (strcmp(aTopic, "chrome-flush-caches") == 0) {
1336     MinimizeCache();
1337     ClearImageCache({ClearOption::ChromeOnly});
1338   } else if (strcmp(aTopic, "last-pb-context-exited") == 0) {
1339     if (mRespectPrivacy) {
1340       ClearImageCache();
1341     }
1342   } else if (strcmp(aTopic, "profile-before-change") == 0) {
1343     mCacheTracker = nullptr;
1344   } else if (strcmp(aTopic, "xpcom-shutdown") == 0) {
1345     mCacheTracker = nullptr;
1346     ShutdownMemoryReporter();
1347
1348   } else {
1349     // (Nothing else should bring us here)
1350     MOZ_ASSERT(0, "Invalid topic received");
1351   }
1352
1353   return NS_OK;
1354 }
1355
1356 NS_IMETHODIMP
1357 imgLoader::ClearCache(bool chrome) {
1358   if (XRE_IsParentProcess()) {
1359     bool privateLoader = this == gPrivateBrowsingLoader;
1360     for (auto* cp : ContentParent::AllProcesses(ContentParent::eLive)) {
1361       Unused << cp->SendClearImageCache(privateLoader, chrome);
1362     }
1363   }
1364   ClearOptions options;
1365   if (chrome) {
1366     options += ClearOption::ChromeOnly;
1367   }
1368   return ClearImageCache(options);
1369 }
1370
1371 NS_IMETHODIMP
1372 imgLoader::RemoveEntriesFromPrincipalInAllProcesses(nsIPrincipal* aPrincipal) {
1373   if (!XRE_IsParentProcess()) {
1374     return NS_ERROR_NOT_AVAILABLE;
1375   }
1376
1377   for (auto* cp : ContentParent::AllProcesses(ContentParent::eLive)) {
1378     Unused << cp->SendClearImageCacheFromPrincipal(aPrincipal);
1379   }
1380
1381   imgLoader* loader;
1382   if (aPrincipal->OriginAttributesRef().mPrivateBrowsingId ==
1383       nsIScriptSecurityManager::DEFAULT_PRIVATE_BROWSING_ID) {
1384     loader = imgLoader::NormalLoader();
1385   } else {
1386     loader = imgLoader::PrivateBrowsingLoader();
1387   }
1388
1389   return loader->RemoveEntriesInternal(aPrincipal, nullptr);
1390 }
1391
1392 NS_IMETHODIMP
1393 imgLoader::RemoveEntriesFromBaseDomainInAllProcesses(
1394     const nsACString& aBaseDomain) {
1395   if (!XRE_IsParentProcess()) {
1396     return NS_ERROR_NOT_AVAILABLE;
1397   }
1398
1399   for (auto* cp : ContentParent::AllProcesses(ContentParent::eLive)) {
1400     Unused << cp->SendClearImageCacheFromBaseDomain(aBaseDomain);
1401   }
1402
1403   return RemoveEntriesInternal(nullptr, &aBaseDomain);
1404 }
1405
1406 nsresult imgLoader::RemoveEntriesInternal(nsIPrincipal* aPrincipal,
1407                                           const nsACString* aBaseDomain) {
1408   // Can only clear by either principal or base domain.
1409   if ((!aPrincipal && !aBaseDomain) || (aPrincipal && aBaseDomain)) {
1410     return NS_ERROR_INVALID_ARG;
1411   }
1412
1413   nsCOMPtr<nsIEffectiveTLDService> tldService;
1414   AutoTArray<RefPtr<imgCacheEntry>, 128> entriesToBeRemoved;
1415
1416   // For base domain we only clear the non-chrome cache.
1417   for (const auto& entry : mCache) {
1418     const auto& key = entry.GetKey();
1419
1420     const bool shouldRemove = [&] {
1421       if (aPrincipal) {
1422         nsCOMPtr<nsIPrincipal> keyPrincipal =
1423             BasePrincipal::CreateContentPrincipal(key.URI(),
1424                                                   key.OriginAttributesRef());
1425         return keyPrincipal->Equals(aPrincipal);
1426       }
1427
1428       if (!aBaseDomain) {
1429         return false;
1430       }
1431       // Clear by baseDomain.
1432       nsAutoCString host;
1433       nsresult rv = key.URI()->GetHost(host);
1434       if (NS_FAILED(rv) || host.IsEmpty()) {
1435         return false;
1436       }
1437
1438       if (!tldService) {
1439         tldService = do_GetService(NS_EFFECTIVETLDSERVICE_CONTRACTID);
1440       }
1441       if (NS_WARN_IF(!tldService)) {
1442         return false;
1443       }
1444
1445       bool hasRootDomain = false;
1446       rv = tldService->HasRootDomain(host, *aBaseDomain, &hasRootDomain);
1447       if (NS_SUCCEEDED(rv) && hasRootDomain) {
1448         return true;
1449       }
1450
1451       // If we don't get a direct base domain match, also check for cache of
1452       // third parties partitioned under aBaseDomain.
1453
1454       // The isolation key is either just the base domain, or an origin suffix
1455       // which contains the partitionKey holding the baseDomain.
1456
1457       if (key.IsolationKeyRef().Equals(*aBaseDomain)) {
1458         return true;
1459       }
1460
1461       // The isolation key does not match the given base domain. It may be an
1462       // origin suffix. Parse it into origin attributes.
1463       OriginAttributes attrs;
1464       if (!attrs.PopulateFromSuffix(key.IsolationKeyRef())) {
1465         // Key is not an origin suffix.
1466         return false;
1467       }
1468
1469       return StoragePrincipalHelper::PartitionKeyHasBaseDomain(
1470           attrs.mPartitionKey, *aBaseDomain);
1471     }();
1472
1473     if (shouldRemove) {
1474       entriesToBeRemoved.AppendElement(entry.GetData());
1475     }
1476   }
1477
1478   for (auto& entry : entriesToBeRemoved) {
1479     if (!RemoveFromCache(entry)) {
1480       NS_WARNING(
1481           "Couldn't remove an entry from the cache in "
1482           "RemoveEntriesInternal()\n");
1483     }
1484   }
1485
1486   return NS_OK;
1487 }
1488
1489 constexpr auto AllCORSModes() {
1490   return MakeInclusiveEnumeratedRange(kFirstCORSMode, kLastCORSMode);
1491 }
1492
1493 NS_IMETHODIMP
1494 imgLoader::RemoveEntry(nsIURI* aURI, Document* aDoc) {
1495   if (!aURI) {
1496     return NS_OK;
1497   }
1498   OriginAttributes attrs;
1499   if (aDoc) {
1500     attrs = aDoc->NodePrincipal()->OriginAttributesRef();
1501   }
1502   for (auto corsMode : AllCORSModes()) {
1503     ImageCacheKey key(aURI, corsMode, attrs, aDoc);
1504     RemoveFromCache(key);
1505   }
1506   return NS_OK;
1507 }
1508
1509 NS_IMETHODIMP
1510 imgLoader::FindEntryProperties(nsIURI* uri, Document* aDoc,
1511                                nsIProperties** _retval) {
1512   *_retval = nullptr;
1513
1514   OriginAttributes attrs;
1515   if (aDoc) {
1516     nsCOMPtr<nsIPrincipal> principal = aDoc->NodePrincipal();
1517     if (principal) {
1518       attrs = principal->OriginAttributesRef();
1519     }
1520   }
1521
1522   for (auto corsMode : AllCORSModes()) {
1523     ImageCacheKey key(uri, corsMode, attrs, aDoc);
1524     RefPtr<imgCacheEntry> entry;
1525     if (!mCache.Get(key, getter_AddRefs(entry)) || !entry) {
1526       continue;
1527     }
1528     if (mCacheTracker && entry->HasNoProxies()) {
1529       mCacheTracker->MarkUsed(entry);
1530     }
1531     RefPtr<imgRequest> request = entry->GetRequest();
1532     if (request) {
1533       nsCOMPtr<nsIProperties> properties = request->Properties();
1534       properties.forget(_retval);
1535       return NS_OK;
1536     }
1537   }
1538   return NS_OK;
1539 }
1540
1541 NS_IMETHODIMP_(void)
1542 imgLoader::ClearCacheForControlledDocument(Document* aDoc) {
1543   MOZ_ASSERT(aDoc);
1544   AutoTArray<RefPtr<imgCacheEntry>, 128> entriesToBeRemoved;
1545   for (const auto& entry : mCache) {
1546     const auto& key = entry.GetKey();
1547     if (key.ControlledDocument() == aDoc) {
1548       entriesToBeRemoved.AppendElement(entry.GetData());
1549     }
1550   }
1551   for (auto& entry : entriesToBeRemoved) {
1552     if (!RemoveFromCache(entry)) {
1553       NS_WARNING(
1554           "Couldn't remove an entry from the cache in "
1555           "ClearCacheForControlledDocument()\n");
1556     }
1557   }
1558 }
1559
1560 void imgLoader::Shutdown() {
1561   NS_IF_RELEASE(gNormalLoader);
1562   gNormalLoader = nullptr;
1563   NS_IF_RELEASE(gPrivateBrowsingLoader);
1564   gPrivateBrowsingLoader = nullptr;
1565 }
1566
1567 bool imgLoader::PutIntoCache(const ImageCacheKey& aKey, imgCacheEntry* entry) {
1568   LOG_STATIC_FUNC_WITH_PARAM(gImgLog, "imgLoader::PutIntoCache", "uri",
1569                              aKey.URI());
1570
1571   // Check to see if this request already exists in the cache. If so, we'll
1572   // replace the old version.
1573   RefPtr<imgCacheEntry> tmpCacheEntry;
1574   if (mCache.Get(aKey, getter_AddRefs(tmpCacheEntry)) && tmpCacheEntry) {
1575     MOZ_LOG(
1576         gImgLog, LogLevel::Debug,
1577         ("[this=%p] imgLoader::PutIntoCache -- Element already in the cache",
1578          nullptr));
1579     RefPtr<imgRequest> tmpRequest = tmpCacheEntry->GetRequest();
1580
1581     // If it already exists, and we're putting the same key into the cache, we
1582     // should remove the old version.
1583     MOZ_LOG(gImgLog, LogLevel::Debug,
1584             ("[this=%p] imgLoader::PutIntoCache -- Replacing cached element",
1585              nullptr));
1586
1587     RemoveFromCache(aKey);
1588   } else {
1589     MOZ_LOG(gImgLog, LogLevel::Debug,
1590             ("[this=%p] imgLoader::PutIntoCache --"
1591              " Element NOT already in the cache",
1592              nullptr));
1593   }
1594
1595   mCache.InsertOrUpdate(aKey, RefPtr{entry});
1596
1597   // We can be called to resurrect an evicted entry.
1598   if (entry->Evicted()) {
1599     entry->SetEvicted(false);
1600   }
1601
1602   // If we're resurrecting an entry with no proxies, put it back in the
1603   // tracker and queue.
1604   if (entry->HasNoProxies()) {
1605     nsresult addrv = NS_OK;
1606
1607     if (mCacheTracker) {
1608       addrv = mCacheTracker->AddObject(entry);
1609     }
1610
1611     if (NS_SUCCEEDED(addrv)) {
1612       mCacheQueue.Push(entry);
1613     }
1614   }
1615
1616   RefPtr<imgRequest> request = entry->GetRequest();
1617   request->SetIsInCache(true);
1618   RemoveFromUncachedImages(request);
1619
1620   return true;
1621 }
1622
1623 bool imgLoader::SetHasNoProxies(imgRequest* aRequest, imgCacheEntry* aEntry) {
1624   LOG_STATIC_FUNC_WITH_PARAM(gImgLog, "imgLoader::SetHasNoProxies", "uri",
1625                              aRequest->CacheKey().URI());
1626
1627   aEntry->SetHasNoProxies(true);
1628
1629   if (aEntry->Evicted()) {
1630     return false;
1631   }
1632
1633   nsresult addrv = NS_OK;
1634
1635   if (mCacheTracker) {
1636     addrv = mCacheTracker->AddObject(aEntry);
1637   }
1638
1639   if (NS_SUCCEEDED(addrv)) {
1640     mCacheQueue.Push(aEntry);
1641   }
1642
1643   return true;
1644 }
1645
1646 bool imgLoader::SetHasProxies(imgRequest* aRequest) {
1647   VerifyCacheSizes();
1648
1649   const ImageCacheKey& key = aRequest->CacheKey();
1650
1651   LOG_STATIC_FUNC_WITH_PARAM(gImgLog, "imgLoader::SetHasProxies", "uri",
1652                              key.URI());
1653
1654   RefPtr<imgCacheEntry> entry;
1655   if (mCache.Get(key, getter_AddRefs(entry)) && entry) {
1656     // Make sure the cache entry is for the right request
1657     RefPtr<imgRequest> entryRequest = entry->GetRequest();
1658     if (entryRequest == aRequest && entry->HasNoProxies()) {
1659       mCacheQueue.Remove(entry);
1660
1661       if (mCacheTracker) {
1662         mCacheTracker->RemoveObject(entry);
1663       }
1664
1665       entry->SetHasNoProxies(false);
1666
1667       return true;
1668     }
1669   }
1670
1671   return false;
1672 }
1673
1674 void imgLoader::CacheEntriesChanged(int32_t aSizeDiff /* = 0 */) {
1675   // We only need to dirty the queue if there is any sorting
1676   // taking place.  Empty or single-entry lists can't become
1677   // dirty.
1678   if (mCacheQueue.GetNumElements() > 1) {
1679     mCacheQueue.MarkDirty();
1680   }
1681   mCacheQueue.UpdateSize(aSizeDiff);
1682 }
1683
1684 void imgLoader::CheckCacheLimits() {
1685   if (mCacheQueue.GetNumElements() == 0) {
1686     NS_ASSERTION(mCacheQueue.GetSize() == 0,
1687                  "imgLoader::CheckCacheLimits -- incorrect cache size");
1688   }
1689
1690   // Remove entries from the cache until we're back at our desired max size.
1691   while (mCacheQueue.GetSize() > sCacheMaxSize) {
1692     // Remove the first entry in the queue.
1693     RefPtr<imgCacheEntry> entry(mCacheQueue.Pop());
1694
1695     NS_ASSERTION(entry, "imgLoader::CheckCacheLimits -- NULL entry pointer");
1696
1697     if (MOZ_LOG_TEST(gImgLog, LogLevel::Debug)) {
1698       RefPtr<imgRequest> req = entry->GetRequest();
1699       if (req) {
1700         LOG_STATIC_FUNC_WITH_PARAM(gImgLog, "imgLoader::CheckCacheLimits",
1701                                    "entry", req->CacheKey().URI());
1702       }
1703     }
1704
1705     if (entry) {
1706       // We just popped this entry from the queue, so pass AlreadyRemoved
1707       // to avoid searching the queue again in RemoveFromCache.
1708       RemoveFromCache(entry, QueueState::AlreadyRemoved);
1709     }
1710   }
1711 }
1712
1713 bool imgLoader::ValidateRequestWithNewChannel(
1714     imgRequest* request, nsIURI* aURI, nsIURI* aInitialDocumentURI,
1715     nsIReferrerInfo* aReferrerInfo, nsILoadGroup* aLoadGroup,
1716     imgINotificationObserver* aObserver, Document* aLoadingDocument,
1717     uint64_t aInnerWindowId, nsLoadFlags aLoadFlags,
1718     nsContentPolicyType aLoadPolicyType, imgRequestProxy** aProxyRequest,
1719     nsIPrincipal* aTriggeringPrincipal, CORSMode aCORSMode, bool aLinkPreload,
1720     uint64_t aEarlyHintPreloaderId, bool* aNewChannelCreated) {
1721   // now we need to insert a new channel request object in between the real
1722   // request and the proxy that basically delays loading the image until it
1723   // gets a 304 or figures out that this needs to be a new request
1724
1725   nsresult rv;
1726
1727   // If we're currently in the middle of validating this request, just hand
1728   // back a proxy to it; the required work will be done for us.
1729   if (imgCacheValidator* validator = request->GetValidator()) {
1730     rv = CreateNewProxyForRequest(request, aURI, aLoadGroup, aLoadingDocument,
1731                                   aObserver, aLoadFlags, aProxyRequest);
1732     if (NS_FAILED(rv)) {
1733       return false;
1734     }
1735
1736     if (*aProxyRequest) {
1737       imgRequestProxy* proxy = static_cast<imgRequestProxy*>(*aProxyRequest);
1738
1739       // We will send notifications from imgCacheValidator::OnStartRequest().
1740       // In the mean time, we must defer notifications because we are added to
1741       // the imgRequest's proxy list, and we can get extra notifications
1742       // resulting from methods such as StartDecoding(). See bug 579122.
1743       proxy->MarkValidating();
1744
1745       if (aLinkPreload) {
1746         MOZ_ASSERT(aLoadingDocument);
1747         proxy->PrioritizeAsPreload();
1748         auto preloadKey = PreloadHashKey::CreateAsImage(
1749             aURI, aTriggeringPrincipal, aCORSMode);
1750         proxy->NotifyOpen(preloadKey, aLoadingDocument, true);
1751       }
1752
1753       // Attach the proxy without notifying
1754       validator->AddProxy(proxy);
1755     }
1756
1757     return true;
1758   }
1759   // We will rely on Necko to cache this request when it's possible, and to
1760   // tell imgCacheValidator::OnStartRequest whether the request came from its
1761   // cache.
1762   nsCOMPtr<nsIChannel> newChannel;
1763   bool forcePrincipalCheck;
1764   rv =
1765       NewImageChannel(getter_AddRefs(newChannel), &forcePrincipalCheck, aURI,
1766                       aInitialDocumentURI, aCORSMode, aReferrerInfo, aLoadGroup,
1767                       aLoadFlags, aLoadPolicyType, aTriggeringPrincipal,
1768                       aLoadingDocument, mRespectPrivacy, aEarlyHintPreloaderId);
1769   if (NS_FAILED(rv)) {
1770     return false;
1771   }
1772
1773   if (aNewChannelCreated) {
1774     *aNewChannelCreated = true;
1775   }
1776
1777   RefPtr<imgRequestProxy> req;
1778   rv = CreateNewProxyForRequest(request, aURI, aLoadGroup, aLoadingDocument,
1779                                 aObserver, aLoadFlags, getter_AddRefs(req));
1780   if (NS_FAILED(rv)) {
1781     return false;
1782   }
1783
1784   // Make sure that OnStatus/OnProgress calls have the right request set...
1785   RefPtr<nsProgressNotificationProxy> progressproxy =
1786       new nsProgressNotificationProxy(newChannel, req);
1787   if (!progressproxy) {
1788     return false;
1789   }
1790
1791   RefPtr<imgCacheValidator> hvc =
1792       new imgCacheValidator(progressproxy, this, request, aLoadingDocument,
1793                             aInnerWindowId, forcePrincipalCheck);
1794
1795   // Casting needed here to get past multiple inheritance.
1796   nsCOMPtr<nsIStreamListener> listener =
1797       do_QueryInterface(static_cast<nsIThreadRetargetableStreamListener*>(hvc));
1798   NS_ENSURE_TRUE(listener, false);
1799
1800   // We must set the notification callbacks before setting up the
1801   // CORS listener, because that's also interested inthe
1802   // notification callbacks.
1803   newChannel->SetNotificationCallbacks(hvc);
1804
1805   request->SetValidator(hvc);
1806
1807   // We will send notifications from imgCacheValidator::OnStartRequest().
1808   // In the mean time, we must defer notifications because we are added to
1809   // the imgRequest's proxy list, and we can get extra notifications
1810   // resulting from methods such as StartDecoding(). See bug 579122.
1811   req->MarkValidating();
1812
1813   if (aLinkPreload) {
1814     MOZ_ASSERT(aLoadingDocument);
1815     req->PrioritizeAsPreload();
1816     auto preloadKey =
1817         PreloadHashKey::CreateAsImage(aURI, aTriggeringPrincipal, aCORSMode);
1818     req->NotifyOpen(preloadKey, aLoadingDocument, true);
1819   }
1820
1821   // Add the proxy without notifying
1822   hvc->AddProxy(req);
1823
1824   mozilla::net::PredictorLearn(aURI, aInitialDocumentURI,
1825                                nsINetworkPredictor::LEARN_LOAD_SUBRESOURCE,
1826                                aLoadGroup);
1827   rv = newChannel->AsyncOpen(listener);
1828   if (NS_WARN_IF(NS_FAILED(rv))) {
1829     req->CancelAndForgetObserver(rv);
1830     // This will notify any current or future <link preload> tags.  Pass the
1831     // non-open channel so that we can read loadinfo and referrer info of that
1832     // channel.
1833     req->NotifyStart(newChannel);
1834     // Use the non-channel overload of this method to force the notification to
1835     // happen.  The preload request has not been assigned a channel.
1836     req->NotifyStop(rv);
1837     return false;
1838   }
1839
1840   req.forget(aProxyRequest);
1841   return true;
1842 }
1843
1844 void imgLoader::NotifyObserversForCachedImage(
1845     imgCacheEntry* aEntry, imgRequest* request, nsIURI* aURI,
1846     nsIReferrerInfo* aReferrerInfo, Document* aLoadingDocument,
1847     nsIPrincipal* aTriggeringPrincipal, CORSMode aCORSMode,
1848     uint64_t aEarlyHintPreloaderId) {
1849   if (aEntry->HasNotified()) {
1850     return;
1851   }
1852
1853   nsCOMPtr<nsIObserverService> obsService = services::GetObserverService();
1854
1855   if (!obsService->HasObservers("http-on-image-cache-response")) {
1856     return;
1857   }
1858
1859   aEntry->SetHasNotified();
1860
1861   nsCOMPtr<nsIChannel> newChannel;
1862   bool forcePrincipalCheck;
1863   nsresult rv = NewImageChannel(
1864       getter_AddRefs(newChannel), &forcePrincipalCheck, aURI, nullptr,
1865       aCORSMode, aReferrerInfo, nullptr, 0,
1866       nsIContentPolicy::TYPE_INTERNAL_IMAGE, aTriggeringPrincipal,
1867       aLoadingDocument, mRespectPrivacy, aEarlyHintPreloaderId);
1868   if (NS_FAILED(rv)) {
1869     return;
1870   }
1871
1872   RefPtr<HttpBaseChannel> httpBaseChannel = do_QueryObject(newChannel);
1873   if (httpBaseChannel) {
1874     httpBaseChannel->SetDummyChannelForImageCache();
1875     newChannel->SetContentType(nsDependentCString(request->GetMimeType()));
1876     RefPtr<mozilla::image::Image> image = request->GetImage();
1877     if (image) {
1878       newChannel->SetContentLength(aEntry->GetDataSize());
1879     }
1880     obsService->NotifyObservers(newChannel, "http-on-image-cache-response",
1881                                 nullptr);
1882   }
1883 }
1884
1885 bool imgLoader::ValidateEntry(
1886     imgCacheEntry* aEntry, nsIURI* aURI, nsIURI* aInitialDocumentURI,
1887     nsIReferrerInfo* aReferrerInfo, nsILoadGroup* aLoadGroup,
1888     imgINotificationObserver* aObserver, Document* aLoadingDocument,
1889     nsLoadFlags aLoadFlags, nsContentPolicyType aLoadPolicyType,
1890     bool aCanMakeNewChannel, bool* aNewChannelCreated,
1891     imgRequestProxy** aProxyRequest, nsIPrincipal* aTriggeringPrincipal,
1892     CORSMode aCORSMode, bool aLinkPreload, uint64_t aEarlyHintPreloaderId) {
1893   LOG_SCOPE(gImgLog, "imgLoader::ValidateEntry");
1894
1895   // If the expiration time is zero, then the request has not gotten far enough
1896   // to know when it will expire, or we know it will never expire (see
1897   // nsContentUtils::GetSubresourceCacheValidationInfo).
1898   uint32_t expiryTime = aEntry->GetExpiryTime();
1899   bool hasExpired = expiryTime && expiryTime <= SecondsFromPRTime(PR_Now());
1900
1901   // Special treatment for file URLs - aEntry has expired if file has changed
1902   if (nsCOMPtr<nsIFileURL> fileUrl = do_QueryInterface(aURI)) {
1903     uint32_t lastModTime = aEntry->GetLoadTime();
1904     nsCOMPtr<nsIFile> theFile;
1905     if (NS_SUCCEEDED(fileUrl->GetFile(getter_AddRefs(theFile)))) {
1906       PRTime fileLastMod;
1907       if (NS_SUCCEEDED(theFile->GetLastModifiedTime(&fileLastMod))) {
1908         // nsIFile uses millisec, NSPR usec.
1909         fileLastMod *= 1000;
1910         hasExpired = SecondsFromPRTime((PRTime)fileLastMod) > lastModTime;
1911       }
1912     }
1913   }
1914
1915   RefPtr<imgRequest> request(aEntry->GetRequest());
1916
1917   if (!request) {
1918     return false;
1919   }
1920
1921   if (!ValidateSecurityInfo(request, aEntry->ForcePrincipalCheck(), aCORSMode,
1922                             aTriggeringPrincipal, aLoadingDocument,
1923                             aLoadPolicyType)) {
1924     return false;
1925   }
1926
1927   // data URIs are immutable and by their nature can't leak data, so we can
1928   // just return true in that case.  Doing so would mean that shift-reload
1929   // doesn't reload data URI documents/images though (which is handy for
1930   // debugging during gecko development) so we make an exception in that case.
1931   if (aURI->SchemeIs("data") && !(aLoadFlags & nsIRequest::LOAD_BYPASS_CACHE)) {
1932     return true;
1933   }
1934
1935   bool validateRequest = false;
1936
1937   if (!request->CanReuseWithoutValidation(aLoadingDocument)) {
1938     // If we would need to revalidate this entry, but we're being told to
1939     // bypass the cache, we don't allow this entry to be used.
1940     if (aLoadFlags & nsIRequest::LOAD_BYPASS_CACHE) {
1941       return false;
1942     }
1943
1944     if (MOZ_UNLIKELY(ChaosMode::isActive(ChaosFeature::ImageCache))) {
1945       if (ChaosMode::randomUint32LessThan(4) < 1) {
1946         return false;
1947       }
1948     }
1949
1950     // Determine whether the cache aEntry must be revalidated...
1951     validateRequest = ShouldRevalidateEntry(aEntry, aLoadFlags, hasExpired);
1952
1953     MOZ_LOG(gImgLog, LogLevel::Debug,
1954             ("imgLoader::ValidateEntry validating cache entry. "
1955              "validateRequest = %d",
1956              validateRequest));
1957   } else if (!aLoadingDocument && MOZ_LOG_TEST(gImgLog, LogLevel::Debug)) {
1958     MOZ_LOG(gImgLog, LogLevel::Debug,
1959             ("imgLoader::ValidateEntry BYPASSING cache validation for %s "
1960              "because of NULL loading document",
1961              aURI->GetSpecOrDefault().get()));
1962   }
1963
1964   // If the original request is still transferring don't kick off a validation
1965   // network request because it is a bit silly to issue a validation request if
1966   // the original request hasn't even finished yet. So just return true
1967   // indicating the caller can create a new proxy for the request and use it as
1968   // is.
1969   // This is an optimization but it's also required for correctness. If we don't
1970   // do this then when firing the load complete notification for the original
1971   // request that can unblock load for the document and then spin the event loop
1972   // (see the stack in bug 1641682) which then the OnStartRequest for the
1973   // validation request can fire which can call UpdateProxies and can sync
1974   // notify on the progress tracker about all existing state, which includes
1975   // load complete, so we fire a second load complete notification for the
1976   // image.
1977   // In addition, we want to validate if the original request encountered
1978   // an error for two reasons. The first being if the error was a network error
1979   // then trying to re-fetch the image might succeed. The second is more
1980   // complicated. We decide if we should fire the load or error event for img
1981   // elements depending on if the image has error in its status at the time when
1982   // the load complete notification is received, and we set error status on an
1983   // image if it encounters a network error or a decode error with no real way
1984   // to tell them apart. So if we load an image that will produce a decode error
1985   // the first time we will usually fire the load event, and then decode enough
1986   // to encounter the decode error and set the error status on the image. The
1987   // next time we reference the image in the same document the load complete
1988   // notification is replayed and this time the error status from the decode is
1989   // already present so we fire the error event instead of the load event. This
1990   // is a bug (bug 1645576) that we should fix. In order to avoid that bug in
1991   // some cases (specifically the cases when we hit this code and try to
1992   // validate the request) we make sure to validate. This avoids the bug because
1993   // when the load complete notification arrives the proxy is marked as
1994   // validating so it lies about its status and returns nothing.
1995   const bool requestComplete = [&] {
1996     RefPtr<ProgressTracker> tracker;
1997     RefPtr<mozilla::image::Image> image = request->GetImage();
1998     if (image) {
1999       tracker = image->GetProgressTracker();
2000     } else {
2001       tracker = request->GetProgressTracker();
2002     }
2003     return tracker &&
2004            tracker->GetProgress() & (FLAG_LOAD_COMPLETE | FLAG_HAS_ERROR);
2005   }();
2006
2007   if (!requestComplete) {
2008     return true;
2009   }
2010
2011   if (validateRequest && aCanMakeNewChannel) {
2012     LOG_SCOPE(gImgLog, "imgLoader::ValidateRequest |cache hit| must validate");
2013
2014     uint64_t innerWindowID =
2015         aLoadingDocument ? aLoadingDocument->InnerWindowID() : 0;
2016     return ValidateRequestWithNewChannel(
2017         request, aURI, aInitialDocumentURI, aReferrerInfo, aLoadGroup,
2018         aObserver, aLoadingDocument, innerWindowID, aLoadFlags, aLoadPolicyType,
2019         aProxyRequest, aTriggeringPrincipal, aCORSMode, aLinkPreload,
2020         aEarlyHintPreloaderId, aNewChannelCreated);
2021   }
2022
2023   if (!validateRequest) {
2024     NotifyObserversForCachedImage(aEntry, request, aURI, aReferrerInfo,
2025                                   aLoadingDocument, aTriggeringPrincipal,
2026                                   aCORSMode, aEarlyHintPreloaderId);
2027   }
2028
2029   return !validateRequest;
2030 }
2031
2032 bool imgLoader::RemoveFromCache(const ImageCacheKey& aKey) {
2033   LOG_STATIC_FUNC_WITH_PARAM(gImgLog, "imgLoader::RemoveFromCache", "uri",
2034                              aKey.URI());
2035   RefPtr<imgCacheEntry> entry;
2036   mCache.Remove(aKey, getter_AddRefs(entry));
2037   if (entry) {
2038     MOZ_ASSERT(!entry->Evicted(), "Evicting an already-evicted cache entry!");
2039
2040     // Entries with no proxies are in the tracker.
2041     if (entry->HasNoProxies()) {
2042       if (mCacheTracker) {
2043         mCacheTracker->RemoveObject(entry);
2044       }
2045       mCacheQueue.Remove(entry);
2046     }
2047
2048     entry->SetEvicted(true);
2049
2050     RefPtr<imgRequest> request = entry->GetRequest();
2051     request->SetIsInCache(false);
2052     AddToUncachedImages(request);
2053
2054     return true;
2055   }
2056   return false;
2057 }
2058
2059 bool imgLoader::RemoveFromCache(imgCacheEntry* entry, QueueState aQueueState) {
2060   LOG_STATIC_FUNC(gImgLog, "imgLoader::RemoveFromCache entry");
2061
2062   RefPtr<imgRequest> request = entry->GetRequest();
2063   if (request) {
2064     const ImageCacheKey& key = request->CacheKey();
2065     LOG_STATIC_FUNC_WITH_PARAM(gImgLog, "imgLoader::RemoveFromCache",
2066                                "entry's uri", key.URI());
2067
2068     mCache.Remove(key);
2069
2070     if (entry->HasNoProxies()) {
2071       LOG_STATIC_FUNC(gImgLog,
2072                       "imgLoader::RemoveFromCache removing from tracker");
2073       if (mCacheTracker) {
2074         mCacheTracker->RemoveObject(entry);
2075       }
2076       // Only search the queue to remove the entry if its possible it might
2077       // be in the queue.  If we know its not in the queue this would be
2078       // wasted work.
2079       MOZ_ASSERT_IF(aQueueState == QueueState::AlreadyRemoved,
2080                     !mCacheQueue.Contains(entry));
2081       if (aQueueState == QueueState::MaybeExists) {
2082         mCacheQueue.Remove(entry);
2083       }
2084     }
2085
2086     entry->SetEvicted(true);
2087     request->SetIsInCache(false);
2088     AddToUncachedImages(request);
2089
2090     return true;
2091   }
2092
2093   return false;
2094 }
2095
2096 nsresult imgLoader::ClearImageCache(ClearOptions aOptions) {
2097   const bool chromeOnly = aOptions.contains(ClearOption::ChromeOnly);
2098   const auto ShouldRemove = [&](imgCacheEntry* aEntry) {
2099     if (chromeOnly) {
2100       // TODO: Consider also removing "resource://" etc?
2101       RefPtr<imgRequest> request = aEntry->GetRequest();
2102       if (!request || !request->CacheKey().URI()->SchemeIs("chrome")) {
2103         return false;
2104       }
2105     }
2106     return true;
2107   };
2108   if (aOptions.contains(ClearOption::UnusedOnly)) {
2109     LOG_STATIC_FUNC(gImgLog, "imgLoader::ClearImageCache queue");
2110     // We have to make a temporary, since RemoveFromCache removes the element
2111     // from the queue, invalidating iterators.
2112     nsTArray<RefPtr<imgCacheEntry>> entries(mCacheQueue.GetNumElements());
2113     for (auto& entry : mCacheQueue) {
2114       if (ShouldRemove(entry)) {
2115         entries.AppendElement(entry);
2116       }
2117     }
2118
2119     // Iterate in reverse order to minimize array copying.
2120     for (auto& entry : entries) {
2121       if (!RemoveFromCache(entry)) {
2122         return NS_ERROR_FAILURE;
2123       }
2124     }
2125
2126     MOZ_ASSERT(chromeOnly || mCacheQueue.GetNumElements() == 0);
2127     return NS_OK;
2128   }
2129
2130   LOG_STATIC_FUNC(gImgLog, "imgLoader::ClearImageCache table");
2131   // We have to make a temporary, since RemoveFromCache removes the element
2132   // from the queue, invalidating iterators.
2133   const auto entries =
2134       ToTArray<nsTArray<RefPtr<imgCacheEntry>>>(mCache.Values());
2135   for (const auto& entry : entries) {
2136     if (!ShouldRemove(entry)) {
2137       continue;
2138     }
2139     if (!RemoveFromCache(entry)) {
2140       return NS_ERROR_FAILURE;
2141     }
2142   }
2143   MOZ_ASSERT(chromeOnly || mCache.IsEmpty());
2144   return NS_OK;
2145 }
2146
2147 void imgLoader::AddToUncachedImages(imgRequest* aRequest) {
2148   MutexAutoLock lock(mUncachedImagesMutex);
2149   mUncachedImages.Insert(aRequest);
2150 }
2151
2152 void imgLoader::RemoveFromUncachedImages(imgRequest* aRequest) {
2153   MutexAutoLock lock(mUncachedImagesMutex);
2154   mUncachedImages.Remove(aRequest);
2155 }
2156
2157 #define LOAD_FLAGS_CACHE_MASK \
2158   (nsIRequest::LOAD_BYPASS_CACHE | nsIRequest::LOAD_FROM_CACHE)
2159
2160 #define LOAD_FLAGS_VALIDATE_MASK                              \
2161   (nsIRequest::VALIDATE_ALWAYS | nsIRequest::VALIDATE_NEVER | \
2162    nsIRequest::VALIDATE_ONCE_PER_SESSION)
2163
2164 NS_IMETHODIMP
2165 imgLoader::LoadImageXPCOM(
2166     nsIURI* aURI, nsIURI* aInitialDocumentURI, nsIReferrerInfo* aReferrerInfo,
2167     nsIPrincipal* aTriggeringPrincipal, nsILoadGroup* aLoadGroup,
2168     imgINotificationObserver* aObserver, Document* aLoadingDocument,
2169     nsLoadFlags aLoadFlags, nsISupports* aCacheKey,
2170     nsContentPolicyType aContentPolicyType, imgIRequest** _retval) {
2171   // Optional parameter, so defaults to 0 (== TYPE_INVALID)
2172   if (!aContentPolicyType) {
2173     aContentPolicyType = nsIContentPolicy::TYPE_INTERNAL_IMAGE;
2174   }
2175   imgRequestProxy* proxy;
2176   nsresult rv =
2177       LoadImage(aURI, aInitialDocumentURI, aReferrerInfo, aTriggeringPrincipal,
2178                 0, aLoadGroup, aObserver, aLoadingDocument, aLoadingDocument,
2179                 aLoadFlags, aCacheKey, aContentPolicyType, u""_ns,
2180                 /* aUseUrgentStartForChannel */ false, /* aListPreload */ false,
2181                 0, &proxy);
2182   *_retval = proxy;
2183   return rv;
2184 }
2185
2186 static void MakeRequestStaticIfNeeded(
2187     Document* aLoadingDocument, imgRequestProxy** aProxyAboutToGetReturned) {
2188   if (!aLoadingDocument || !aLoadingDocument->IsStaticDocument()) {
2189     return;
2190   }
2191
2192   if (!*aProxyAboutToGetReturned) {
2193     return;
2194   }
2195
2196   RefPtr<imgRequestProxy> proxy = dont_AddRef(*aProxyAboutToGetReturned);
2197   *aProxyAboutToGetReturned = nullptr;
2198
2199   RefPtr<imgRequestProxy> staticProxy =
2200       proxy->GetStaticRequest(aLoadingDocument);
2201   if (staticProxy != proxy) {
2202     proxy->CancelAndForgetObserver(NS_BINDING_ABORTED);
2203     proxy = std::move(staticProxy);
2204   }
2205   proxy.forget(aProxyAboutToGetReturned);
2206 }
2207
2208 bool imgLoader::IsImageAvailable(nsIURI* aURI,
2209                                  nsIPrincipal* aTriggeringPrincipal,
2210                                  CORSMode aCORSMode, Document* aDocument) {
2211   ImageCacheKey key(aURI, aCORSMode,
2212                     aTriggeringPrincipal->OriginAttributesRef(), aDocument);
2213   RefPtr<imgCacheEntry> entry;
2214   if (!mCache.Get(key, getter_AddRefs(entry)) || !entry) {
2215     return false;
2216   }
2217   RefPtr<imgRequest> request = entry->GetRequest();
2218   if (!request) {
2219     return false;
2220   }
2221   if (nsCOMPtr<nsILoadGroup> docLoadGroup = aDocument->GetDocumentLoadGroup()) {
2222     nsLoadFlags requestFlags = nsIRequest::LOAD_NORMAL;
2223     docLoadGroup->GetLoadFlags(&requestFlags);
2224     if (requestFlags & nsIRequest::LOAD_BYPASS_CACHE) {
2225       // If we're bypassing the cache, treat the image as not available.
2226       return false;
2227     }
2228   }
2229   return ValidateCORSMode(request, false, aCORSMode, aTriggeringPrincipal);
2230 }
2231
2232 nsresult imgLoader::LoadImage(
2233     nsIURI* aURI, nsIURI* aInitialDocumentURI, nsIReferrerInfo* aReferrerInfo,
2234     nsIPrincipal* aTriggeringPrincipal, uint64_t aRequestContextID,
2235     nsILoadGroup* aLoadGroup, imgINotificationObserver* aObserver,
2236     nsINode* aContext, Document* aLoadingDocument, nsLoadFlags aLoadFlags,
2237     nsISupports* aCacheKey, nsContentPolicyType aContentPolicyType,
2238     const nsAString& initiatorType, bool aUseUrgentStartForChannel,
2239     bool aLinkPreload, uint64_t aEarlyHintPreloaderId,
2240     imgRequestProxy** _retval) {
2241   VerifyCacheSizes();
2242
2243   NS_ASSERTION(aURI, "imgLoader::LoadImage -- NULL URI pointer");
2244
2245   if (!aURI) {
2246     return NS_ERROR_NULL_POINTER;
2247   }
2248
2249   auto makeStaticIfNeeded = mozilla::MakeScopeExit(
2250       [&] { MakeRequestStaticIfNeeded(aLoadingDocument, _retval); });
2251
2252   AUTO_PROFILER_LABEL_DYNAMIC_NSCSTRING("imgLoader::LoadImage", NETWORK,
2253                                         aURI->GetSpecOrDefault());
2254
2255   LOG_SCOPE_WITH_PARAM(gImgLog, "imgLoader::LoadImage", "aURI", aURI);
2256
2257   *_retval = nullptr;
2258
2259   RefPtr<imgRequest> request;
2260
2261   nsresult rv;
2262   nsLoadFlags requestFlags = nsIRequest::LOAD_NORMAL;
2263
2264 #ifdef DEBUG
2265   bool isPrivate = false;
2266
2267   if (aLoadingDocument) {
2268     isPrivate = nsContentUtils::IsInPrivateBrowsing(aLoadingDocument);
2269   } else if (aLoadGroup) {
2270     isPrivate = nsContentUtils::IsInPrivateBrowsing(aLoadGroup);
2271   }
2272   MOZ_ASSERT(isPrivate == mRespectPrivacy);
2273
2274   if (aLoadingDocument) {
2275     // The given load group should match that of the document if given. If
2276     // that isn't the case, then we need to add more plumbing to ensure we
2277     // block the document as well.
2278     nsCOMPtr<nsILoadGroup> docLoadGroup =
2279         aLoadingDocument->GetDocumentLoadGroup();
2280     MOZ_ASSERT(docLoadGroup == aLoadGroup);
2281   }
2282 #endif
2283
2284   // Get the default load flags from the loadgroup (if possible)...
2285   if (aLoadGroup) {
2286     aLoadGroup->GetLoadFlags(&requestFlags);
2287   }
2288   //
2289   // Merge the default load flags with those passed in via aLoadFlags.
2290   // Currently, *only* the caching, validation and background load flags
2291   // are merged...
2292   //
2293   // The flags in aLoadFlags take precedence over the default flags!
2294   //
2295   if (aLoadFlags & LOAD_FLAGS_CACHE_MASK) {
2296     // Override the default caching flags...
2297     requestFlags = (requestFlags & ~LOAD_FLAGS_CACHE_MASK) |
2298                    (aLoadFlags & LOAD_FLAGS_CACHE_MASK);
2299   }
2300   if (aLoadFlags & LOAD_FLAGS_VALIDATE_MASK) {
2301     // Override the default validation flags...
2302     requestFlags = (requestFlags & ~LOAD_FLAGS_VALIDATE_MASK) |
2303                    (aLoadFlags & LOAD_FLAGS_VALIDATE_MASK);
2304   }
2305   if (aLoadFlags & nsIRequest::LOAD_BACKGROUND) {
2306     // Propagate background loading...
2307     requestFlags |= nsIRequest::LOAD_BACKGROUND;
2308   }
2309
2310   if (aLinkPreload) {
2311     // Set background loading if it is <link rel=preload>
2312     requestFlags |= nsIRequest::LOAD_BACKGROUND;
2313   }
2314
2315   CORSMode corsmode = CORS_NONE;
2316   if (aLoadFlags & imgILoader::LOAD_CORS_ANONYMOUS) {
2317     corsmode = CORS_ANONYMOUS;
2318   } else if (aLoadFlags & imgILoader::LOAD_CORS_USE_CREDENTIALS) {
2319     corsmode = CORS_USE_CREDENTIALS;
2320   }
2321
2322   // Look in the preloaded images of loading document first.
2323   if (!aLinkPreload && aLoadingDocument) {
2324     // All Early Hints preloads are Link preloads, therefore we don't have a
2325     // Early Hints preload here
2326     MOZ_ASSERT(!aEarlyHintPreloaderId);
2327     auto key =
2328         PreloadHashKey::CreateAsImage(aURI, aTriggeringPrincipal, corsmode);
2329     if (RefPtr<PreloaderBase> preload =
2330             aLoadingDocument->Preloads().LookupPreload(key)) {
2331       RefPtr<imgRequestProxy> proxy = do_QueryObject(preload);
2332       MOZ_ASSERT(proxy);
2333
2334       MOZ_LOG(gImgLog, LogLevel::Debug,
2335               ("[this=%p] imgLoader::LoadImage -- preloaded [proxy=%p]"
2336                " [document=%p]\n",
2337                this, proxy.get(), aLoadingDocument));
2338
2339       // Removing the preload for this image to be in parity with Chromium.  Any
2340       // following regular image request will be reloaded using the regular
2341       // path: image cache, http cache, network.  Any following `<link
2342       // rel=preload as=image>` will start a new image preload that can be
2343       // satisfied from http cache or network.
2344       //
2345       // There is a spec discussion for "preload cache", see
2346       // https://github.com/w3c/preload/issues/97. And it is also not clear how
2347       // preload image interacts with list of available images, see
2348       // https://github.com/whatwg/html/issues/4474.
2349       proxy->RemoveSelf(aLoadingDocument);
2350       proxy->NotifyUsage(aLoadingDocument);
2351
2352       imgRequest* request = proxy->GetOwner();
2353       nsresult rv =
2354           CreateNewProxyForRequest(request, aURI, aLoadGroup, aLoadingDocument,
2355                                    aObserver, requestFlags, _retval);
2356       NS_ENSURE_SUCCESS(rv, rv);
2357
2358       imgRequestProxy* newProxy = *_retval;
2359       if (imgCacheValidator* validator = request->GetValidator()) {
2360         newProxy->MarkValidating();
2361         // Attach the proxy without notifying and this will add us to the load
2362         // group.
2363         validator->AddProxy(newProxy);
2364       } else {
2365         // It's OK to add here even if the request is done. If it is, it'll send
2366         // a OnStopRequest()and the proxy will be removed from the loadgroup in
2367         // imgRequestProxy::OnLoadComplete.
2368         newProxy->AddToLoadGroup();
2369         newProxy->NotifyListener();
2370       }
2371
2372       return NS_OK;
2373     }
2374   }
2375
2376   RefPtr<imgCacheEntry> entry;
2377
2378   // Look in the cache for our URI, and then validate it.
2379   // XXX For now ignore aCacheKey. We will need it in the future
2380   // for correctly dealing with image load requests that are a result
2381   // of post data.
2382   OriginAttributes attrs;
2383   if (aTriggeringPrincipal) {
2384     attrs = aTriggeringPrincipal->OriginAttributesRef();
2385   }
2386   ImageCacheKey key(aURI, corsmode, attrs, aLoadingDocument);
2387   if (mCache.Get(key, getter_AddRefs(entry)) && entry) {
2388     bool newChannelCreated = false;
2389     if (ValidateEntry(entry, aURI, aInitialDocumentURI, aReferrerInfo,
2390                       aLoadGroup, aObserver, aLoadingDocument, requestFlags,
2391                       aContentPolicyType, true, &newChannelCreated, _retval,
2392                       aTriggeringPrincipal, corsmode, aLinkPreload,
2393                       aEarlyHintPreloaderId)) {
2394       request = entry->GetRequest();
2395
2396       // If this entry has no proxies, its request has no reference to the
2397       // entry.
2398       if (entry->HasNoProxies()) {
2399         LOG_FUNC_WITH_PARAM(gImgLog,
2400                             "imgLoader::LoadImage() adding proxyless entry",
2401                             "uri", key.URI());
2402         MOZ_ASSERT(!request->HasCacheEntry(),
2403                    "Proxyless entry's request has cache entry!");
2404         request->SetCacheEntry(entry);
2405
2406         if (mCacheTracker && entry->GetExpirationState()->IsTracked()) {
2407           mCacheTracker->MarkUsed(entry);
2408         }
2409       }
2410
2411       entry->Touch();
2412
2413       if (!newChannelCreated) {
2414         // This is ugly but it's needed to report CSP violations. We have 3
2415         // scenarios:
2416         // - we don't have cache. We are not in this if() stmt. A new channel is
2417         //   created and that triggers the CSP checks.
2418         // - We have a cache entry and this is blocked by CSP directives.
2419         DebugOnly<bool> shouldLoad = ShouldLoadCachedImage(
2420             request, aLoadingDocument, aTriggeringPrincipal, aContentPolicyType,
2421             /* aSendCSPViolationReports */ true);
2422         MOZ_ASSERT(shouldLoad);
2423       }
2424     } else {
2425       // We can't use this entry. We'll try to load it off the network, and if
2426       // successful, overwrite the old entry in the cache with a new one.
2427       entry = nullptr;
2428     }
2429   }
2430
2431   // Keep the channel in this scope, so we can adjust its notificationCallbacks
2432   // later when we create the proxy.
2433   nsCOMPtr<nsIChannel> newChannel;
2434   // If we didn't get a cache hit, we need to load from the network.
2435   if (!request) {
2436     LOG_SCOPE(gImgLog, "imgLoader::LoadImage |cache miss|");
2437
2438     bool forcePrincipalCheck;
2439     rv = NewImageChannel(getter_AddRefs(newChannel), &forcePrincipalCheck, aURI,
2440                          aInitialDocumentURI, corsmode, aReferrerInfo,
2441                          aLoadGroup, requestFlags, aContentPolicyType,
2442                          aTriggeringPrincipal, aContext, mRespectPrivacy,
2443                          aEarlyHintPreloaderId);
2444     if (NS_FAILED(rv)) {
2445       return NS_ERROR_FAILURE;
2446     }
2447
2448     MOZ_ASSERT(NS_UsePrivateBrowsing(newChannel) == mRespectPrivacy);
2449
2450     NewRequestAndEntry(forcePrincipalCheck, this, key, getter_AddRefs(request),
2451                        getter_AddRefs(entry));
2452
2453     MOZ_LOG(gImgLog, LogLevel::Debug,
2454             ("[this=%p] imgLoader::LoadImage -- Created new imgRequest"
2455              " [request=%p]\n",
2456              this, request.get()));
2457
2458     nsCOMPtr<nsIClassOfService> cos(do_QueryInterface(newChannel));
2459     if (cos) {
2460       if (aUseUrgentStartForChannel && !aLinkPreload) {
2461         cos->AddClassFlags(nsIClassOfService::UrgentStart);
2462       }
2463
2464       if (StaticPrefs::network_http_tailing_enabled() &&
2465           aContentPolicyType == nsIContentPolicy::TYPE_INTERNAL_IMAGE_FAVICON) {
2466         cos->AddClassFlags(nsIClassOfService::Throttleable |
2467                            nsIClassOfService::Tail);
2468         nsCOMPtr<nsIHttpChannel> httpChannel(do_QueryInterface(newChannel));
2469         if (httpChannel) {
2470           Unused << httpChannel->SetRequestContextID(aRequestContextID);
2471         }
2472       }
2473     }
2474
2475     nsCOMPtr<nsILoadGroup> channelLoadGroup;
2476     newChannel->GetLoadGroup(getter_AddRefs(channelLoadGroup));
2477     rv = request->Init(aURI, aURI, /* aHadInsecureRedirect = */ false,
2478                        channelLoadGroup, newChannel, entry, aLoadingDocument,
2479                        aTriggeringPrincipal, corsmode, aReferrerInfo);
2480     if (NS_FAILED(rv)) {
2481       return NS_ERROR_FAILURE;
2482     }
2483
2484     // Add the initiator type for this image load
2485     nsCOMPtr<nsITimedChannel> timedChannel = do_QueryInterface(newChannel);
2486     if (timedChannel) {
2487       timedChannel->SetInitiatorType(initiatorType);
2488     }
2489
2490     // create the proxy listener
2491     nsCOMPtr<nsIStreamListener> listener = new ProxyListener(request.get());
2492
2493     MOZ_LOG(gImgLog, LogLevel::Debug,
2494             ("[this=%p] imgLoader::LoadImage -- Calling channel->AsyncOpen()\n",
2495              this));
2496
2497     mozilla::net::PredictorLearn(aURI, aInitialDocumentURI,
2498                                  nsINetworkPredictor::LEARN_LOAD_SUBRESOURCE,
2499                                  aLoadGroup);
2500
2501     nsresult openRes;
2502     openRes = newChannel->AsyncOpen(listener);
2503
2504     if (NS_FAILED(openRes)) {
2505       MOZ_LOG(
2506           gImgLog, LogLevel::Debug,
2507           ("[this=%p] imgLoader::LoadImage -- AsyncOpen() failed: 0x%" PRIx32
2508            "\n",
2509            this, static_cast<uint32_t>(openRes)));
2510       request->CancelAndAbort(openRes);
2511       return openRes;
2512     }
2513
2514     // Try to add the new request into the cache.
2515     PutIntoCache(key, entry);
2516   } else {
2517     LOG_MSG_WITH_PARAM(gImgLog, "imgLoader::LoadImage |cache hit|", "request",
2518                        request);
2519   }
2520
2521   // If we didn't get a proxy when validating the cache entry, we need to
2522   // create one.
2523   if (!*_retval) {
2524     // ValidateEntry() has three return values: "Is valid," "might be valid --
2525     // validating over network", and "not valid." If we don't have a _retval,
2526     // we know ValidateEntry is not validating over the network, so it's safe
2527     // to SetLoadId here because we know this request is valid for this context.
2528     //
2529     // Note, however, that this doesn't guarantee the behaviour we want (one
2530     // URL maps to the same image on a page) if we load the same image in a
2531     // different tab (see bug 528003), because its load id will get re-set, and
2532     // that'll cause us to validate over the network.
2533     request->SetLoadId(aLoadingDocument);
2534
2535     LOG_MSG(gImgLog, "imgLoader::LoadImage", "creating proxy request.");
2536     rv = CreateNewProxyForRequest(request, aURI, aLoadGroup, aLoadingDocument,
2537                                   aObserver, requestFlags, _retval);
2538     if (NS_FAILED(rv)) {
2539       return rv;
2540     }
2541
2542     imgRequestProxy* proxy = *_retval;
2543
2544     // Make sure that OnStatus/OnProgress calls have the right request set, if
2545     // we did create a channel here.
2546     if (newChannel) {
2547       nsCOMPtr<nsIInterfaceRequestor> requestor(
2548           new nsProgressNotificationProxy(newChannel, proxy));
2549       if (!requestor) {
2550         return NS_ERROR_OUT_OF_MEMORY;
2551       }
2552       newChannel->SetNotificationCallbacks(requestor);
2553     }
2554
2555     if (aLinkPreload) {
2556       MOZ_ASSERT(aLoadingDocument);
2557       proxy->PrioritizeAsPreload();
2558       auto preloadKey =
2559           PreloadHashKey::CreateAsImage(aURI, aTriggeringPrincipal, corsmode);
2560       proxy->NotifyOpen(preloadKey, aLoadingDocument, true);
2561     }
2562
2563     // Note that it's OK to add here even if the request is done.  If it is,
2564     // it'll send a OnStopRequest() to the proxy in imgRequestProxy::Notify and
2565     // the proxy will be removed from the loadgroup.
2566     proxy->AddToLoadGroup();
2567
2568     // If we're loading off the network, explicitly don't notify our proxy,
2569     // because necko (or things called from necko, such as imgCacheValidator)
2570     // are going to call our notifications asynchronously, and we can't make it
2571     // further asynchronous because observers might rely on imagelib completing
2572     // its work between the channel's OnStartRequest and OnStopRequest.
2573     if (!newChannel) {
2574       proxy->NotifyListener();
2575     }
2576
2577     return rv;
2578   }
2579
2580   NS_ASSERTION(*_retval, "imgLoader::LoadImage -- no return value");
2581
2582   return NS_OK;
2583 }
2584
2585 NS_IMETHODIMP
2586 imgLoader::LoadImageWithChannelXPCOM(nsIChannel* channel,
2587                                      imgINotificationObserver* aObserver,
2588                                      Document* aLoadingDocument,
2589                                      nsIStreamListener** listener,
2590                                      imgIRequest** _retval) {
2591   nsresult result;
2592   imgRequestProxy* proxy;
2593   result = LoadImageWithChannel(channel, aObserver, aLoadingDocument, listener,
2594                                 &proxy);
2595   *_retval = proxy;
2596   return result;
2597 }
2598
2599 nsresult imgLoader::LoadImageWithChannel(nsIChannel* channel,
2600                                          imgINotificationObserver* aObserver,
2601                                          Document* aLoadingDocument,
2602                                          nsIStreamListener** listener,
2603                                          imgRequestProxy** _retval) {
2604   NS_ASSERTION(channel,
2605                "imgLoader::LoadImageWithChannel -- NULL channel pointer");
2606
2607   MOZ_ASSERT(NS_UsePrivateBrowsing(channel) == mRespectPrivacy);
2608
2609   auto makeStaticIfNeeded = mozilla::MakeScopeExit(
2610       [&] { MakeRequestStaticIfNeeded(aLoadingDocument, _retval); });
2611
2612   LOG_SCOPE(gImgLog, "imgLoader::LoadImageWithChannel");
2613   RefPtr<imgRequest> request;
2614
2615   nsCOMPtr<nsIURI> uri;
2616   channel->GetURI(getter_AddRefs(uri));
2617
2618   NS_ENSURE_TRUE(channel, NS_ERROR_FAILURE);
2619   nsCOMPtr<nsILoadInfo> loadInfo = channel->LoadInfo();
2620
2621   OriginAttributes attrs = loadInfo->GetOriginAttributes();
2622
2623   // TODO: Get a meaningful cors mode from the caller probably?
2624   const auto corsMode = CORS_NONE;
2625   ImageCacheKey key(uri, corsMode, attrs, aLoadingDocument);
2626
2627   nsLoadFlags requestFlags = nsIRequest::LOAD_NORMAL;
2628   channel->GetLoadFlags(&requestFlags);
2629
2630   RefPtr<imgCacheEntry> entry;
2631
2632   if (requestFlags & nsIRequest::LOAD_BYPASS_CACHE) {
2633     RemoveFromCache(key);
2634   } else {
2635     // Look in the cache for our URI, and then validate it.
2636     // XXX For now ignore aCacheKey. We will need it in the future
2637     // for correctly dealing with image load requests that are a result
2638     // of post data.
2639     if (mCache.Get(key, getter_AddRefs(entry)) && entry) {
2640       // We don't want to kick off another network load. So we ask
2641       // ValidateEntry to only do validation without creating a new proxy. If
2642       // it says that the entry isn't valid any more, we'll only use the entry
2643       // we're getting if the channel is loading from the cache anyways.
2644       //
2645       // XXX -- should this be changed? it's pretty much verbatim from the old
2646       // code, but seems nonsensical.
2647       //
2648       // Since aCanMakeNewChannel == false, we don't need to pass content policy
2649       // type/principal/etc
2650
2651       nsCOMPtr<nsILoadInfo> loadInfo = channel->LoadInfo();
2652       // if there is a loadInfo, use the right contentType, otherwise
2653       // default to the internal image type
2654       nsContentPolicyType policyType = loadInfo->InternalContentPolicyType();
2655
2656       if (ValidateEntry(entry, uri, nullptr, nullptr, nullptr, aObserver,
2657                         aLoadingDocument, requestFlags, policyType, false,
2658                         nullptr, nullptr, nullptr, corsMode, false, 0)) {
2659         request = entry->GetRequest();
2660       } else {
2661         nsCOMPtr<nsICacheInfoChannel> cacheChan(do_QueryInterface(channel));
2662         bool bUseCacheCopy;
2663
2664         if (cacheChan) {
2665           cacheChan->IsFromCache(&bUseCacheCopy);
2666         } else {
2667           bUseCacheCopy = false;
2668         }
2669
2670         if (!bUseCacheCopy) {
2671           entry = nullptr;
2672         } else {
2673           request = entry->GetRequest();
2674         }
2675       }
2676
2677       if (request && entry) {
2678         // If this entry has no proxies, its request has no reference to
2679         // the entry.
2680         if (entry->HasNoProxies()) {
2681           LOG_FUNC_WITH_PARAM(
2682               gImgLog,
2683               "imgLoader::LoadImageWithChannel() adding proxyless entry", "uri",
2684               key.URI());
2685           MOZ_ASSERT(!request->HasCacheEntry(),
2686                      "Proxyless entry's request has cache entry!");
2687           request->SetCacheEntry(entry);
2688
2689           if (mCacheTracker && entry->GetExpirationState()->IsTracked()) {
2690             mCacheTracker->MarkUsed(entry);
2691           }
2692         }
2693       }
2694     }
2695   }
2696
2697   nsCOMPtr<nsILoadGroup> loadGroup;
2698   channel->GetLoadGroup(getter_AddRefs(loadGroup));
2699
2700 #ifdef DEBUG
2701   if (aLoadingDocument) {
2702     // The load group of the channel should always match that of the
2703     // document if given. If that isn't the case, then we need to add more
2704     // plumbing to ensure we block the document as well.
2705     nsCOMPtr<nsILoadGroup> docLoadGroup =
2706         aLoadingDocument->GetDocumentLoadGroup();
2707     MOZ_ASSERT(docLoadGroup == loadGroup);
2708   }
2709 #endif
2710
2711   // Filter out any load flags not from nsIRequest
2712   requestFlags &= nsIRequest::LOAD_REQUESTMASK;
2713
2714   nsresult rv = NS_OK;
2715   if (request) {
2716     // we have this in our cache already.. cancel the current (document) load
2717
2718     // this should fire an OnStopRequest
2719     channel->Cancel(NS_ERROR_PARSED_DATA_CACHED);
2720
2721     *listener = nullptr;  // give them back a null nsIStreamListener
2722
2723     rv = CreateNewProxyForRequest(request, uri, loadGroup, aLoadingDocument,
2724                                   aObserver, requestFlags, _retval);
2725     static_cast<imgRequestProxy*>(*_retval)->NotifyListener();
2726   } else {
2727     // We use originalURI here to fulfil the imgIRequest contract on GetURI.
2728     nsCOMPtr<nsIURI> originalURI;
2729     channel->GetOriginalURI(getter_AddRefs(originalURI));
2730
2731     // XXX(seth): We should be able to just use |key| here, except that |key| is
2732     // constructed above with the *current URI* and not the *original URI*. I'm
2733     // pretty sure this is a bug, and it's preventing us from ever getting a
2734     // cache hit in LoadImageWithChannel when redirects are involved.
2735     ImageCacheKey originalURIKey(originalURI, corsMode, attrs,
2736                                  aLoadingDocument);
2737
2738     // Default to doing a principal check because we don't know who
2739     // started that load and whether their principal ended up being
2740     // inherited on the channel.
2741     NewRequestAndEntry(/* aForcePrincipalCheckForCacheEntry = */ true, this,
2742                        originalURIKey, getter_AddRefs(request),
2743                        getter_AddRefs(entry));
2744
2745     // No principal specified here, because we're not passed one.
2746     // In LoadImageWithChannel, the redirects that may have been
2747     // associated with this load would have gone through necko.
2748     // We only have the final URI in ImageLib and hence don't know
2749     // if the request went through insecure redirects.  But if it did,
2750     // the necko cache should have handled that (since all necko cache hits
2751     // including the redirects will go through content policy).  Hence, we
2752     // can set aHadInsecureRedirect to false here.
2753     rv = request->Init(originalURI, uri, /* aHadInsecureRedirect = */ false,
2754                        channel, channel, entry, aLoadingDocument, nullptr,
2755                        corsMode, nullptr);
2756     NS_ENSURE_SUCCESS(rv, rv);
2757
2758     RefPtr<ProxyListener> pl =
2759         new ProxyListener(static_cast<nsIStreamListener*>(request.get()));
2760     pl.forget(listener);
2761
2762     // Try to add the new request into the cache.
2763     PutIntoCache(originalURIKey, entry);
2764
2765     rv = CreateNewProxyForRequest(request, originalURI, loadGroup,
2766                                   aLoadingDocument, aObserver, requestFlags,
2767                                   _retval);
2768
2769     // Explicitly don't notify our proxy, because we're loading off the
2770     // network, and necko (or things called from necko, such as
2771     // imgCacheValidator) are going to call our notifications asynchronously,
2772     // and we can't make it further asynchronous because observers might rely
2773     // on imagelib completing its work between the channel's OnStartRequest and
2774     // OnStopRequest.
2775   }
2776
2777   if (NS_FAILED(rv)) {
2778     return rv;
2779   }
2780
2781   (*_retval)->AddToLoadGroup();
2782   return rv;
2783 }
2784
2785 bool imgLoader::SupportImageWithMimeType(const nsACString& aMimeType,
2786                                          AcceptedMimeTypes aAccept
2787                                          /* = AcceptedMimeTypes::IMAGES */) {
2788   nsAutoCString mimeType(aMimeType);
2789   ToLowerCase(mimeType);
2790
2791   if (aAccept == AcceptedMimeTypes::IMAGES_AND_DOCUMENTS &&
2792       mimeType.EqualsLiteral("image/svg+xml")) {
2793     return true;
2794   }
2795
2796   DecoderType type = DecoderFactory::GetDecoderType(mimeType.get());
2797   return type != DecoderType::UNKNOWN;
2798 }
2799
2800 NS_IMETHODIMP
2801 imgLoader::GetMIMETypeFromContent(nsIRequest* aRequest,
2802                                   const uint8_t* aContents, uint32_t aLength,
2803                                   nsACString& aContentType) {
2804   nsCOMPtr<nsIChannel> channel(do_QueryInterface(aRequest));
2805   if (channel) {
2806     nsCOMPtr<nsILoadInfo> loadInfo = channel->LoadInfo();
2807     if (loadInfo->GetSkipContentSniffing()) {
2808       return NS_ERROR_NOT_AVAILABLE;
2809     }
2810   }
2811
2812   nsresult rv =
2813       GetMimeTypeFromContent((const char*)aContents, aLength, aContentType);
2814   if (NS_SUCCEEDED(rv) && channel && XRE_IsParentProcess()) {
2815     if (RefPtr<mozilla::net::nsHttpChannel> httpChannel =
2816             do_QueryObject(channel)) {
2817       // If the image type pattern matching algorithm given bytes does not
2818       // return undefined, then disable the further check and allow the
2819       // response.
2820       httpChannel->DisableIsOpaqueResponseAllowedAfterSniffCheck(
2821           mozilla::net::nsHttpChannel::SnifferType::Image);
2822     }
2823   }
2824
2825   return rv;
2826 }
2827
2828 /* static */
2829 nsresult imgLoader::GetMimeTypeFromContent(const char* aContents,
2830                                            uint32_t aLength,
2831                                            nsACString& aContentType) {
2832   nsAutoCString detected;
2833
2834   /* Is it a GIF? */
2835   if (aLength >= 6 &&
2836       (!strncmp(aContents, "GIF87a", 6) || !strncmp(aContents, "GIF89a", 6))) {
2837     aContentType.AssignLiteral(IMAGE_GIF);
2838
2839     /* or a PNG? */
2840   } else if (aLength >= 8 && ((unsigned char)aContents[0] == 0x89 &&
2841                               (unsigned char)aContents[1] == 0x50 &&
2842                               (unsigned char)aContents[2] == 0x4E &&
2843                               (unsigned char)aContents[3] == 0x47 &&
2844                               (unsigned char)aContents[4] == 0x0D &&
2845                               (unsigned char)aContents[5] == 0x0A &&
2846                               (unsigned char)aContents[6] == 0x1A &&
2847                               (unsigned char)aContents[7] == 0x0A)) {
2848     aContentType.AssignLiteral(IMAGE_PNG);
2849
2850     /* maybe a JPEG (JFIF)? */
2851     /* JFIF files start with SOI APP0 but older files can start with SOI DQT
2852      * so we test for SOI followed by any marker, i.e. FF D8 FF
2853      * this will also work for SPIFF JPEG files if they appear in the future.
2854      *
2855      * (JFIF is 0XFF 0XD8 0XFF 0XE0 <skip 2> 0X4A 0X46 0X49 0X46 0X00)
2856      */
2857   } else if (aLength >= 3 && ((unsigned char)aContents[0]) == 0xFF &&
2858              ((unsigned char)aContents[1]) == 0xD8 &&
2859              ((unsigned char)aContents[2]) == 0xFF) {
2860     aContentType.AssignLiteral(IMAGE_JPEG);
2861
2862     /* or how about ART? */
2863     /* ART begins with JG (4A 47). Major version offset 2.
2864      * Minor version offset 3. Offset 4 must be nullptr.
2865      */
2866   } else if (aLength >= 5 && ((unsigned char)aContents[0]) == 0x4a &&
2867              ((unsigned char)aContents[1]) == 0x47 &&
2868              ((unsigned char)aContents[4]) == 0x00) {
2869     aContentType.AssignLiteral(IMAGE_ART);
2870
2871   } else if (aLength >= 2 && !strncmp(aContents, "BM", 2)) {
2872     aContentType.AssignLiteral(IMAGE_BMP);
2873
2874     // ICOs always begin with a 2-byte 0 followed by a 2-byte 1.
2875     // CURs begin with 2-byte 0 followed by 2-byte 2.
2876   } else if (aLength >= 4 && (!memcmp(aContents, "\000\000\001\000", 4) ||
2877                               !memcmp(aContents, "\000\000\002\000", 4))) {
2878     aContentType.AssignLiteral(IMAGE_ICO);
2879
2880     // WebPs always begin with RIFF, a 32-bit length, and WEBP.
2881   } else if (aLength >= 12 && !memcmp(aContents, "RIFF", 4) &&
2882              !memcmp(aContents + 8, "WEBP", 4)) {
2883     aContentType.AssignLiteral(IMAGE_WEBP);
2884
2885   } else if (MatchesMP4(reinterpret_cast<const uint8_t*>(aContents), aLength,
2886                         detected) &&
2887              detected.Equals(IMAGE_AVIF)) {
2888     aContentType.AssignLiteral(IMAGE_AVIF);
2889   } else if ((aLength >= 2 && !memcmp(aContents, "\xFF\x0A", 2)) ||
2890              (aLength >= 12 &&
2891               !memcmp(aContents, "\x00\x00\x00\x0CJXL \x0D\x0A\x87\x0A", 12))) {
2892     // Each version is for containerless and containerful files respectively.
2893     aContentType.AssignLiteral(IMAGE_JXL);
2894   } else {
2895     /* none of the above?  I give up */
2896     return NS_ERROR_NOT_AVAILABLE;
2897   }
2898
2899   return NS_OK;
2900 }
2901
2902 /**
2903  * proxy stream listener class used to handle multipart/x-mixed-replace
2904  */
2905
2906 #include "nsIRequest.h"
2907 #include "nsIStreamConverterService.h"
2908
2909 NS_IMPL_ISUPPORTS(ProxyListener, nsIStreamListener,
2910                   nsIThreadRetargetableStreamListener, nsIRequestObserver)
2911
2912 ProxyListener::ProxyListener(nsIStreamListener* dest) : mDestListener(dest) {}
2913
2914 ProxyListener::~ProxyListener() = default;
2915
2916 /** nsIRequestObserver methods **/
2917
2918 NS_IMETHODIMP
2919 ProxyListener::OnStartRequest(nsIRequest* aRequest) {
2920   if (!mDestListener) {
2921     return NS_ERROR_FAILURE;
2922   }
2923
2924   nsCOMPtr<nsIChannel> channel(do_QueryInterface(aRequest));
2925   if (channel) {
2926     // We need to set the initiator type for the image load
2927     nsCOMPtr<nsITimedChannel> timedChannel = do_QueryInterface(channel);
2928     if (timedChannel) {
2929       nsAutoString type;
2930       timedChannel->GetInitiatorType(type);
2931       if (type.IsEmpty()) {
2932         timedChannel->SetInitiatorType(u"img"_ns);
2933       }
2934     }
2935
2936     nsAutoCString contentType;
2937     nsresult rv = channel->GetContentType(contentType);
2938
2939     if (!contentType.IsEmpty()) {
2940       /* If multipart/x-mixed-replace content, we'll insert a MIME decoder
2941          in the pipeline to handle the content and pass it along to our
2942          original listener.
2943        */
2944       if ("multipart/x-mixed-replace"_ns.Equals(contentType)) {
2945         nsCOMPtr<nsIStreamConverterService> convServ(
2946             do_GetService("@mozilla.org/streamConverters;1", &rv));
2947         if (NS_SUCCEEDED(rv)) {
2948           nsCOMPtr<nsIStreamListener> toListener(mDestListener);
2949           nsCOMPtr<nsIStreamListener> fromListener;
2950
2951           rv = convServ->AsyncConvertData("multipart/x-mixed-replace", "*/*",
2952                                           toListener, nullptr,
2953                                           getter_AddRefs(fromListener));
2954           if (NS_SUCCEEDED(rv)) {
2955             mDestListener = fromListener;
2956           }
2957         }
2958       }
2959     }
2960   }
2961
2962   return mDestListener->OnStartRequest(aRequest);
2963 }
2964
2965 NS_IMETHODIMP
2966 ProxyListener::OnStopRequest(nsIRequest* aRequest, nsresult status) {
2967   if (!mDestListener) {
2968     return NS_ERROR_FAILURE;
2969   }
2970
2971   return mDestListener->OnStopRequest(aRequest, status);
2972 }
2973
2974 /** nsIStreamListener methods **/
2975
2976 NS_IMETHODIMP
2977 ProxyListener::OnDataAvailable(nsIRequest* aRequest, nsIInputStream* inStr,
2978                                uint64_t sourceOffset, uint32_t count) {
2979   if (!mDestListener) {
2980     return NS_ERROR_FAILURE;
2981   }
2982
2983   return mDestListener->OnDataAvailable(aRequest, inStr, sourceOffset, count);
2984 }
2985
2986 /** nsThreadRetargetableStreamListener methods **/
2987 NS_IMETHODIMP
2988 ProxyListener::CheckListenerChain() {
2989   NS_ASSERTION(NS_IsMainThread(), "Should be on the main thread!");
2990   nsresult rv = NS_OK;
2991   nsCOMPtr<nsIThreadRetargetableStreamListener> retargetableListener =
2992       do_QueryInterface(mDestListener, &rv);
2993   if (retargetableListener) {
2994     rv = retargetableListener->CheckListenerChain();
2995   }
2996   MOZ_LOG(
2997       gImgLog, LogLevel::Debug,
2998       ("ProxyListener::CheckListenerChain %s [this=%p listener=%p rv=%" PRIx32
2999        "]",
3000        (NS_SUCCEEDED(rv) ? "success" : "failure"), this,
3001        (nsIStreamListener*)mDestListener, static_cast<uint32_t>(rv)));
3002   return rv;
3003 }
3004
3005 /**
3006  * http validate class.  check a channel for a 304
3007  */
3008
3009 NS_IMPL_ISUPPORTS(imgCacheValidator, nsIStreamListener, nsIRequestObserver,
3010                   nsIThreadRetargetableStreamListener, nsIChannelEventSink,
3011                   nsIInterfaceRequestor, nsIAsyncVerifyRedirectCallback)
3012
3013 imgCacheValidator::imgCacheValidator(nsProgressNotificationProxy* progress,
3014                                      imgLoader* loader, imgRequest* request,
3015                                      Document* aDocument,
3016                                      uint64_t aInnerWindowId,
3017                                      bool forcePrincipalCheckForCacheEntry)
3018     : mProgressProxy(progress),
3019       mRequest(request),
3020       mDocument(aDocument),
3021       mInnerWindowId(aInnerWindowId),
3022       mImgLoader(loader),
3023       mHadInsecureRedirect(false) {
3024   NewRequestAndEntry(forcePrincipalCheckForCacheEntry, loader,
3025                      mRequest->CacheKey(), getter_AddRefs(mNewRequest),
3026                      getter_AddRefs(mNewEntry));
3027 }
3028
3029 imgCacheValidator::~imgCacheValidator() {
3030   if (mRequest) {
3031     // If something went wrong, and we never unblocked the requests waiting on
3032     // validation, now is our last chance. We will cancel the new request and
3033     // switch the waiting proxies to it.
3034     UpdateProxies(/* aCancelRequest */ true, /* aSyncNotify */ false);
3035   }
3036 }
3037
3038 void imgCacheValidator::AddProxy(imgRequestProxy* aProxy) {
3039   // aProxy needs to be in the loadgroup since we're validating from
3040   // the network.
3041   aProxy->AddToLoadGroup();
3042
3043   mProxies.AppendElement(aProxy);
3044 }
3045
3046 void imgCacheValidator::RemoveProxy(imgRequestProxy* aProxy) {
3047   mProxies.RemoveElement(aProxy);
3048 }
3049
3050 void imgCacheValidator::UpdateProxies(bool aCancelRequest, bool aSyncNotify) {
3051   MOZ_ASSERT(mRequest);
3052
3053   // Clear the validator before updating the proxies. The notifications may
3054   // clone an existing request, and its state could be inconsistent.
3055   mRequest->SetValidator(nullptr);
3056   mRequest = nullptr;
3057
3058   // If an error occurred, we will want to cancel the new request, and make the
3059   // validating proxies point to it. Any proxies still bound to the original
3060   // request which are not validating should remain untouched.
3061   if (aCancelRequest) {
3062     MOZ_ASSERT(mNewRequest);
3063     mNewRequest->CancelAndAbort(NS_BINDING_ABORTED);
3064   }
3065
3066   // We have finished validating the request, so we can safely take ownership
3067   // of the proxy list. imgRequestProxy::SyncNotifyListener can mutate the list
3068   // if imgRequestProxy::CancelAndForgetObserver is called by its owner. Note
3069   // that any potential notifications should still be suppressed in
3070   // imgRequestProxy::ChangeOwner because we haven't cleared the validating
3071   // flag yet, and thus they will remain deferred.
3072   AutoTArray<RefPtr<imgRequestProxy>, 4> proxies(std::move(mProxies));
3073
3074   for (auto& proxy : proxies) {
3075     // First update the state of all proxies before notifying any of them
3076     // to ensure a consistent state (e.g. in case the notification causes
3077     // other proxies to be touched indirectly.)
3078     MOZ_ASSERT(proxy->IsValidating());
3079     MOZ_ASSERT(proxy->NotificationsDeferred(),
3080                "Proxies waiting on cache validation should be "
3081                "deferring notifications!");
3082     if (mNewRequest) {
3083       proxy->ChangeOwner(mNewRequest);
3084     }
3085     proxy->ClearValidating();
3086   }
3087
3088   mNewRequest = nullptr;
3089   mNewEntry = nullptr;
3090
3091   for (auto& proxy : proxies) {
3092     if (aSyncNotify) {
3093       // Notify synchronously, because the caller knows we are already in an
3094       // asynchronously-called function (e.g. OnStartRequest).
3095       proxy->SyncNotifyListener();
3096     } else {
3097       // Notify asynchronously, because the caller does not know our current
3098       // call state (e.g. ~imgCacheValidator).
3099       proxy->NotifyListener();
3100     }
3101   }
3102 }
3103
3104 /** nsIRequestObserver methods **/
3105
3106 NS_IMETHODIMP
3107 imgCacheValidator::OnStartRequest(nsIRequest* aRequest) {
3108   // We may be holding on to a document, so ensure that it's released.
3109   RefPtr<Document> document = mDocument.forget();
3110
3111   // If for some reason we don't still have an existing request (probably
3112   // because OnStartRequest got delivered more than once), just bail.
3113   if (!mRequest) {
3114     MOZ_ASSERT_UNREACHABLE("OnStartRequest delivered more than once?");
3115     aRequest->CancelWithReason(NS_BINDING_ABORTED,
3116                                "OnStartRequest delivered more than once?"_ns);
3117     return NS_ERROR_FAILURE;
3118   }
3119
3120   // If this request is coming from cache and has the same URI as our
3121   // imgRequest, the request all our proxies are pointing at is valid, and all
3122   // we have to do is tell them to notify their listeners.
3123   nsCOMPtr<nsICacheInfoChannel> cacheChan(do_QueryInterface(aRequest));
3124   nsCOMPtr<nsIChannel> channel(do_QueryInterface(aRequest));
3125   if (cacheChan && channel) {
3126     bool isFromCache = false;
3127     cacheChan->IsFromCache(&isFromCache);
3128
3129     nsCOMPtr<nsIURI> channelURI;
3130     channel->GetURI(getter_AddRefs(channelURI));
3131
3132     nsCOMPtr<nsIURI> finalURI;
3133     mRequest->GetFinalURI(getter_AddRefs(finalURI));
3134
3135     bool sameURI = false;
3136     if (channelURI && finalURI) {
3137       channelURI->Equals(finalURI, &sameURI);
3138     }
3139
3140     if (isFromCache && sameURI) {
3141       // We don't need to load this any more.
3142       aRequest->CancelWithReason(NS_BINDING_ABORTED,
3143                                  "imgCacheValidator::OnStartRequest"_ns);
3144       mNewRequest = nullptr;
3145
3146       // Clear the validator before updating the proxies. The notifications may
3147       // clone an existing request, and its state could be inconsistent.
3148       mRequest->SetLoadId(document);
3149       mRequest->SetInnerWindowID(mInnerWindowId);
3150       UpdateProxies(/* aCancelRequest */ false, /* aSyncNotify */ true);
3151       return NS_OK;
3152     }
3153   }
3154
3155   // We can't load out of cache. We have to create a whole new request for the
3156   // data that's coming in off the channel.
3157   nsCOMPtr<nsIURI> uri;
3158   mRequest->GetURI(getter_AddRefs(uri));
3159
3160   LOG_MSG_WITH_PARAM(gImgLog,
3161                      "imgCacheValidator::OnStartRequest creating new request",
3162                      "uri", uri);
3163
3164   CORSMode corsmode = mRequest->GetCORSMode();
3165   nsCOMPtr<nsIReferrerInfo> referrerInfo = mRequest->GetReferrerInfo();
3166   nsCOMPtr<nsIPrincipal> triggeringPrincipal =
3167       mRequest->GetTriggeringPrincipal();
3168
3169   // Doom the old request's cache entry
3170   mRequest->RemoveFromCache();
3171
3172   // We use originalURI here to fulfil the imgIRequest contract on GetURI.
3173   nsCOMPtr<nsIURI> originalURI;
3174   channel->GetOriginalURI(getter_AddRefs(originalURI));
3175   nsresult rv = mNewRequest->Init(originalURI, uri, mHadInsecureRedirect,
3176                                   aRequest, channel, mNewEntry, document,
3177                                   triggeringPrincipal, corsmode, referrerInfo);
3178   if (NS_FAILED(rv)) {
3179     UpdateProxies(/* aCancelRequest */ true, /* aSyncNotify */ true);
3180     return rv;
3181   }
3182
3183   mDestListener = new ProxyListener(mNewRequest);
3184
3185   // Try to add the new request into the cache. Note that the entry must be in
3186   // the cache before the proxies' ownership changes, because adding a proxy
3187   // changes the caching behaviour for imgRequests.
3188   mImgLoader->PutIntoCache(mNewRequest->CacheKey(), mNewEntry);
3189   UpdateProxies(/* aCancelRequest */ false, /* aSyncNotify */ true);
3190   return mDestListener->OnStartRequest(aRequest);
3191 }
3192
3193 NS_IMETHODIMP
3194 imgCacheValidator::OnStopRequest(nsIRequest* aRequest, nsresult status) {
3195   // Be sure we've released the document that we may have been holding on to.
3196   mDocument = nullptr;
3197
3198   if (!mDestListener) {
3199     return NS_OK;
3200   }
3201
3202   return mDestListener->OnStopRequest(aRequest, status);
3203 }
3204
3205 /** nsIStreamListener methods **/
3206
3207 NS_IMETHODIMP
3208 imgCacheValidator::OnDataAvailable(nsIRequest* aRequest, nsIInputStream* inStr,
3209                                    uint64_t sourceOffset, uint32_t count) {
3210   if (!mDestListener) {
3211     // XXX see bug 113959
3212     uint32_t _retval;
3213     inStr->ReadSegments(NS_DiscardSegment, nullptr, count, &_retval);
3214     return NS_OK;
3215   }
3216
3217   return mDestListener->OnDataAvailable(aRequest, inStr, sourceOffset, count);
3218 }
3219
3220 /** nsIThreadRetargetableStreamListener methods **/
3221
3222 NS_IMETHODIMP
3223 imgCacheValidator::CheckListenerChain() {
3224   NS_ASSERTION(NS_IsMainThread(), "Should be on the main thread!");
3225   nsresult rv = NS_OK;
3226   nsCOMPtr<nsIThreadRetargetableStreamListener> retargetableListener =
3227       do_QueryInterface(mDestListener, &rv);
3228   if (retargetableListener) {
3229     rv = retargetableListener->CheckListenerChain();
3230   }
3231   MOZ_LOG(
3232       gImgLog, LogLevel::Debug,
3233       ("[this=%p] imgCacheValidator::CheckListenerChain -- rv %" PRId32 "=%s",
3234        this, static_cast<uint32_t>(rv),
3235        NS_SUCCEEDED(rv) ? "succeeded" : "failed"));
3236   return rv;
3237 }
3238
3239 /** nsIInterfaceRequestor methods **/
3240
3241 NS_IMETHODIMP
3242 imgCacheValidator::GetInterface(const nsIID& aIID, void** aResult) {
3243   if (aIID.Equals(NS_GET_IID(nsIChannelEventSink))) {
3244     return QueryInterface(aIID, aResult);
3245   }
3246
3247   return mProgressProxy->GetInterface(aIID, aResult);
3248 }
3249
3250 // These functions are materially the same as the same functions in imgRequest.
3251 // We duplicate them because we're verifying whether cache loads are necessary,
3252 // not unconditionally loading.
3253
3254 /** nsIChannelEventSink methods **/
3255 NS_IMETHODIMP
3256 imgCacheValidator::AsyncOnChannelRedirect(
3257     nsIChannel* oldChannel, nsIChannel* newChannel, uint32_t flags,
3258     nsIAsyncVerifyRedirectCallback* callback) {
3259   // Note all cache information we get from the old channel.
3260   mNewRequest->SetCacheValidation(mNewEntry, oldChannel);
3261
3262   // If the previous URI is a non-HTTPS URI, record that fact for later use by
3263   // security code, which needs to know whether there is an insecure load at any
3264   // point in the redirect chain.
3265   nsCOMPtr<nsIURI> oldURI;
3266   bool schemeLocal = false;
3267   if (NS_FAILED(oldChannel->GetURI(getter_AddRefs(oldURI))) ||
3268       NS_FAILED(NS_URIChainHasFlags(
3269           oldURI, nsIProtocolHandler::URI_IS_LOCAL_RESOURCE, &schemeLocal)) ||
3270       (!oldURI->SchemeIs("https") && !oldURI->SchemeIs("chrome") &&
3271        !schemeLocal)) {
3272     mHadInsecureRedirect = true;
3273   }
3274
3275   // Prepare for callback
3276   mRedirectCallback = callback;
3277   mRedirectChannel = newChannel;
3278
3279   return mProgressProxy->AsyncOnChannelRedirect(oldChannel, newChannel, flags,
3280                                                 this);
3281 }
3282
3283 NS_IMETHODIMP
3284 imgCacheValidator::OnRedirectVerifyCallback(nsresult aResult) {
3285   // If we've already been told to abort, just do so.
3286   if (NS_FAILED(aResult)) {
3287     mRedirectCallback->OnRedirectVerifyCallback(aResult);
3288     mRedirectCallback = nullptr;
3289     mRedirectChannel = nullptr;
3290     return NS_OK;
3291   }
3292
3293   // make sure we have a protocol that returns data rather than opens
3294   // an external application, e.g. mailto:
3295   nsCOMPtr<nsIURI> uri;
3296   mRedirectChannel->GetURI(getter_AddRefs(uri));
3297
3298   nsresult result = NS_OK;
3299
3300   if (nsContentUtils::IsExternalProtocol(uri)) {
3301     result = NS_ERROR_ABORT;
3302   }
3303
3304   mRedirectCallback->OnRedirectVerifyCallback(result);
3305   mRedirectCallback = nullptr;
3306   mRedirectChannel = nullptr;
3307   return NS_OK;
3308 }