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, aURI, aObserver);
1158   if (NS_WARN_IF(NS_FAILED(rv))) {
1159     return rv;
1160   }
1161
1162   proxyRequest.forget(_retval);
1163   return NS_OK;
1164 }
1165
1166 class imgCacheExpirationTracker final
1167     : public nsExpirationTracker<imgCacheEntry, 3> {
1168   enum { TIMEOUT_SECONDS = 10 };
1169
1170  public:
1171   imgCacheExpirationTracker();
1172
1173  protected:
1174   void NotifyExpired(imgCacheEntry* entry) override;
1175 };
1176
1177 imgCacheExpirationTracker::imgCacheExpirationTracker()
1178     : nsExpirationTracker<imgCacheEntry, 3>(TIMEOUT_SECONDS * 1000,
1179                                             "imgCacheExpirationTracker") {}
1180
1181 void imgCacheExpirationTracker::NotifyExpired(imgCacheEntry* entry) {
1182   // Hold on to a reference to this entry, because the expiration tracker
1183   // mechanism doesn't.
1184   RefPtr<imgCacheEntry> kungFuDeathGrip(entry);
1185
1186   if (MOZ_LOG_TEST(gImgLog, LogLevel::Debug)) {
1187     RefPtr<imgRequest> req = entry->GetRequest();
1188     if (req) {
1189       LOG_FUNC_WITH_PARAM(gImgLog, "imgCacheExpirationTracker::NotifyExpired",
1190                           "entry", req->CacheKey().URI());
1191     }
1192   }
1193
1194   // We can be called multiple times on the same entry. Don't do work multiple
1195   // times.
1196   if (!entry->Evicted()) {
1197     entry->Loader()->RemoveFromCache(entry);
1198   }
1199
1200   entry->Loader()->VerifyCacheSizes();
1201 }
1202
1203 ///////////////////////////////////////////////////////////////////////////////
1204 // imgLoader
1205 ///////////////////////////////////////////////////////////////////////////////
1206
1207 double imgLoader::sCacheTimeWeight;
1208 uint32_t imgLoader::sCacheMaxSize;
1209 imgMemoryReporter* imgLoader::sMemReporter;
1210
1211 NS_IMPL_ISUPPORTS(imgLoader, imgILoader, nsIContentSniffer, imgICache,
1212                   nsISupportsWeakReference, nsIObserver)
1213
1214 static imgLoader* gNormalLoader = nullptr;
1215 static imgLoader* gPrivateBrowsingLoader = nullptr;
1216
1217 /* static */
1218 already_AddRefed<imgLoader> imgLoader::CreateImageLoader() {
1219   // In some cases, such as xpctests, XPCOM modules are not automatically
1220   // initialized.  We need to make sure that our module is initialized before
1221   // we hand out imgLoader instances and code starts using them.
1222   mozilla::image::EnsureModuleInitialized();
1223
1224   RefPtr<imgLoader> loader = new imgLoader();
1225   loader->Init();
1226
1227   return loader.forget();
1228 }
1229
1230 imgLoader* imgLoader::NormalLoader() {
1231   if (!gNormalLoader) {
1232     gNormalLoader = CreateImageLoader().take();
1233   }
1234   return gNormalLoader;
1235 }
1236
1237 imgLoader* imgLoader::PrivateBrowsingLoader() {
1238   if (!gPrivateBrowsingLoader) {
1239     gPrivateBrowsingLoader = CreateImageLoader().take();
1240     gPrivateBrowsingLoader->RespectPrivacyNotifications();
1241   }
1242   return gPrivateBrowsingLoader;
1243 }
1244
1245 imgLoader::imgLoader()
1246     : mUncachedImagesMutex("imgLoader::UncachedImages"),
1247       mRespectPrivacy(false) {
1248   sMemReporter->AddRef();
1249   sMemReporter->RegisterLoader(this);
1250 }
1251
1252 imgLoader::~imgLoader() {
1253   ClearImageCache();
1254   {
1255     // If there are any of our imgRequest's left they are in the uncached
1256     // images set, so clear their pointer to us.
1257     MutexAutoLock lock(mUncachedImagesMutex);
1258     for (RefPtr<imgRequest> req : mUncachedImages) {
1259       req->ClearLoader();
1260     }
1261   }
1262   sMemReporter->UnregisterLoader(this);
1263   sMemReporter->Release();
1264 }
1265
1266 void imgLoader::VerifyCacheSizes() {
1267 #ifdef DEBUG
1268   if (!mCacheTracker) {
1269     return;
1270   }
1271
1272   uint32_t cachesize = mCache.Count();
1273   uint32_t queuesize = mCacheQueue.GetNumElements();
1274   uint32_t trackersize = 0;
1275   for (nsExpirationTracker<imgCacheEntry, 3>::Iterator it(mCacheTracker.get());
1276        it.Next();) {
1277     trackersize++;
1278   }
1279   MOZ_ASSERT(queuesize == trackersize, "Queue and tracker sizes out of sync!");
1280   MOZ_ASSERT(queuesize <= cachesize, "Queue has more elements than cache!");
1281 #endif
1282 }
1283
1284 void imgLoader::GlobalInit() {
1285   sCacheTimeWeight = StaticPrefs::image_cache_timeweight_AtStartup() / 1000.0;
1286   int32_t cachesize = StaticPrefs::image_cache_size_AtStartup();
1287   sCacheMaxSize = cachesize > 0 ? cachesize : 0;
1288
1289   sMemReporter = new imgMemoryReporter();
1290   RegisterStrongAsyncMemoryReporter(sMemReporter);
1291   RegisterImagesContentUsedUncompressedDistinguishedAmount(
1292       imgMemoryReporter::ImagesContentUsedUncompressedDistinguishedAmount);
1293 }
1294
1295 void imgLoader::ShutdownMemoryReporter() {
1296   UnregisterImagesContentUsedUncompressedDistinguishedAmount();
1297   UnregisterStrongMemoryReporter(sMemReporter);
1298 }
1299
1300 nsresult imgLoader::InitCache() {
1301   nsCOMPtr<nsIObserverService> os = mozilla::services::GetObserverService();
1302   if (!os) {
1303     return NS_ERROR_FAILURE;
1304   }
1305
1306   os->AddObserver(this, "memory-pressure", false);
1307   os->AddObserver(this, "chrome-flush-caches", false);
1308   os->AddObserver(this, "last-pb-context-exited", false);
1309   os->AddObserver(this, "profile-before-change", false);
1310   os->AddObserver(this, "xpcom-shutdown", false);
1311
1312   mCacheTracker = MakeUnique<imgCacheExpirationTracker>();
1313
1314   return NS_OK;
1315 }
1316
1317 nsresult imgLoader::Init() {
1318   InitCache();
1319
1320   return NS_OK;
1321 }
1322
1323 NS_IMETHODIMP
1324 imgLoader::RespectPrivacyNotifications() {
1325   mRespectPrivacy = true;
1326   return NS_OK;
1327 }
1328
1329 NS_IMETHODIMP
1330 imgLoader::Observe(nsISupports* aSubject, const char* aTopic,
1331                    const char16_t* aData) {
1332   if (strcmp(aTopic, "memory-pressure") == 0) {
1333     MinimizeCache();
1334   } else if (strcmp(aTopic, "chrome-flush-caches") == 0) {
1335     MinimizeCache();
1336     ClearImageCache({ClearOption::ChromeOnly});
1337   } else if (strcmp(aTopic, "last-pb-context-exited") == 0) {
1338     if (mRespectPrivacy) {
1339       ClearImageCache();
1340     }
1341   } else if (strcmp(aTopic, "profile-before-change") == 0) {
1342     mCacheTracker = nullptr;
1343   } else if (strcmp(aTopic, "xpcom-shutdown") == 0) {
1344     mCacheTracker = nullptr;
1345     ShutdownMemoryReporter();
1346
1347   } else {
1348     // (Nothing else should bring us here)
1349     MOZ_ASSERT(0, "Invalid topic received");
1350   }
1351
1352   return NS_OK;
1353 }
1354
1355 NS_IMETHODIMP
1356 imgLoader::ClearCache(bool chrome) {
1357   if (XRE_IsParentProcess()) {
1358     bool privateLoader = this == gPrivateBrowsingLoader;
1359     for (auto* cp : ContentParent::AllProcesses(ContentParent::eLive)) {
1360       Unused << cp->SendClearImageCache(privateLoader, chrome);
1361     }
1362   }
1363   ClearOptions options;
1364   if (chrome) {
1365     options += ClearOption::ChromeOnly;
1366   }
1367   return ClearImageCache(options);
1368 }
1369
1370 NS_IMETHODIMP
1371 imgLoader::RemoveEntriesFromPrincipalInAllProcesses(nsIPrincipal* aPrincipal) {
1372   if (!XRE_IsParentProcess()) {
1373     return NS_ERROR_NOT_AVAILABLE;
1374   }
1375
1376   for (auto* cp : ContentParent::AllProcesses(ContentParent::eLive)) {
1377     Unused << cp->SendClearImageCacheFromPrincipal(aPrincipal);
1378   }
1379
1380   imgLoader* loader;
1381   if (aPrincipal->OriginAttributesRef().mPrivateBrowsingId ==
1382       nsIScriptSecurityManager::DEFAULT_PRIVATE_BROWSING_ID) {
1383     loader = imgLoader::NormalLoader();
1384   } else {
1385     loader = imgLoader::PrivateBrowsingLoader();
1386   }
1387
1388   return loader->RemoveEntriesInternal(aPrincipal, nullptr);
1389 }
1390
1391 NS_IMETHODIMP
1392 imgLoader::RemoveEntriesFromBaseDomainInAllProcesses(
1393     const nsACString& aBaseDomain) {
1394   if (!XRE_IsParentProcess()) {
1395     return NS_ERROR_NOT_AVAILABLE;
1396   }
1397
1398   for (auto* cp : ContentParent::AllProcesses(ContentParent::eLive)) {
1399     Unused << cp->SendClearImageCacheFromBaseDomain(aBaseDomain);
1400   }
1401
1402   return RemoveEntriesInternal(nullptr, &aBaseDomain);
1403 }
1404
1405 nsresult imgLoader::RemoveEntriesInternal(nsIPrincipal* aPrincipal,
1406                                           const nsACString* aBaseDomain) {
1407   // Can only clear by either principal or base domain.
1408   if ((!aPrincipal && !aBaseDomain) || (aPrincipal && aBaseDomain)) {
1409     return NS_ERROR_INVALID_ARG;
1410   }
1411
1412   nsCOMPtr<nsIEffectiveTLDService> tldService;
1413   AutoTArray<RefPtr<imgCacheEntry>, 128> entriesToBeRemoved;
1414
1415   // For base domain we only clear the non-chrome cache.
1416   for (const auto& entry : mCache) {
1417     const auto& key = entry.GetKey();
1418
1419     const bool shouldRemove = [&] {
1420       if (aPrincipal) {
1421         nsCOMPtr<nsIPrincipal> keyPrincipal =
1422             BasePrincipal::CreateContentPrincipal(key.URI(),
1423                                                   key.OriginAttributesRef());
1424         return keyPrincipal->Equals(aPrincipal);
1425       }
1426
1427       if (!aBaseDomain) {
1428         return false;
1429       }
1430       // Clear by baseDomain.
1431       nsAutoCString host;
1432       nsresult rv = key.URI()->GetHost(host);
1433       if (NS_FAILED(rv) || host.IsEmpty()) {
1434         return false;
1435       }
1436
1437       if (!tldService) {
1438         tldService = do_GetService(NS_EFFECTIVETLDSERVICE_CONTRACTID);
1439       }
1440       if (NS_WARN_IF(!tldService)) {
1441         return false;
1442       }
1443
1444       bool hasRootDomain = false;
1445       rv = tldService->HasRootDomain(host, *aBaseDomain, &hasRootDomain);
1446       if (NS_SUCCEEDED(rv) && hasRootDomain) {
1447         return true;
1448       }
1449
1450       // If we don't get a direct base domain match, also check for cache of
1451       // third parties partitioned under aBaseDomain.
1452
1453       // The isolation key is either just the base domain, or an origin suffix
1454       // which contains the partitionKey holding the baseDomain.
1455
1456       if (key.IsolationKeyRef().Equals(*aBaseDomain)) {
1457         return true;
1458       }
1459
1460       // The isolation key does not match the given base domain. It may be an
1461       // origin suffix. Parse it into origin attributes.
1462       OriginAttributes attrs;
1463       if (!attrs.PopulateFromSuffix(key.IsolationKeyRef())) {
1464         // Key is not an origin suffix.
1465         return false;
1466       }
1467
1468       return StoragePrincipalHelper::PartitionKeyHasBaseDomain(
1469           attrs.mPartitionKey, *aBaseDomain);
1470     }();
1471
1472     if (shouldRemove) {
1473       entriesToBeRemoved.AppendElement(entry.GetData());
1474     }
1475   }
1476
1477   for (auto& entry : entriesToBeRemoved) {
1478     if (!RemoveFromCache(entry)) {
1479       NS_WARNING(
1480           "Couldn't remove an entry from the cache in "
1481           "RemoveEntriesInternal()\n");
1482     }
1483   }
1484
1485   return NS_OK;
1486 }
1487
1488 constexpr auto AllCORSModes() {
1489   return MakeInclusiveEnumeratedRange(kFirstCORSMode, kLastCORSMode);
1490 }
1491
1492 NS_IMETHODIMP
1493 imgLoader::RemoveEntry(nsIURI* aURI, Document* aDoc) {
1494   if (!aURI) {
1495     return NS_OK;
1496   }
1497   OriginAttributes attrs;
1498   if (aDoc) {
1499     attrs = aDoc->NodePrincipal()->OriginAttributesRef();
1500   }
1501   for (auto corsMode : AllCORSModes()) {
1502     ImageCacheKey key(aURI, corsMode, attrs, aDoc);
1503     RemoveFromCache(key);
1504   }
1505   return NS_OK;
1506 }
1507
1508 NS_IMETHODIMP
1509 imgLoader::FindEntryProperties(nsIURI* uri, Document* aDoc,
1510                                nsIProperties** _retval) {
1511   *_retval = nullptr;
1512
1513   OriginAttributes attrs;
1514   if (aDoc) {
1515     nsCOMPtr<nsIPrincipal> principal = aDoc->NodePrincipal();
1516     if (principal) {
1517       attrs = principal->OriginAttributesRef();
1518     }
1519   }
1520
1521   for (auto corsMode : AllCORSModes()) {
1522     ImageCacheKey key(uri, corsMode, attrs, aDoc);
1523     RefPtr<imgCacheEntry> entry;
1524     if (!mCache.Get(key, getter_AddRefs(entry)) || !entry) {
1525       continue;
1526     }
1527     if (mCacheTracker && entry->HasNoProxies()) {
1528       mCacheTracker->MarkUsed(entry);
1529     }
1530     RefPtr<imgRequest> request = entry->GetRequest();
1531     if (request) {
1532       nsCOMPtr<nsIProperties> properties = request->Properties();
1533       properties.forget(_retval);
1534       return NS_OK;
1535     }
1536   }
1537   return NS_OK;
1538 }
1539
1540 NS_IMETHODIMP_(void)
1541 imgLoader::ClearCacheForControlledDocument(Document* aDoc) {
1542   MOZ_ASSERT(aDoc);
1543   AutoTArray<RefPtr<imgCacheEntry>, 128> entriesToBeRemoved;
1544   for (const auto& entry : mCache) {
1545     const auto& key = entry.GetKey();
1546     if (key.ControlledDocument() == aDoc) {
1547       entriesToBeRemoved.AppendElement(entry.GetData());
1548     }
1549   }
1550   for (auto& entry : entriesToBeRemoved) {
1551     if (!RemoveFromCache(entry)) {
1552       NS_WARNING(
1553           "Couldn't remove an entry from the cache in "
1554           "ClearCacheForControlledDocument()\n");
1555     }
1556   }
1557 }
1558
1559 void imgLoader::Shutdown() {
1560   NS_IF_RELEASE(gNormalLoader);
1561   gNormalLoader = nullptr;
1562   NS_IF_RELEASE(gPrivateBrowsingLoader);
1563   gPrivateBrowsingLoader = nullptr;
1564 }
1565
1566 bool imgLoader::PutIntoCache(const ImageCacheKey& aKey, imgCacheEntry* entry) {
1567   LOG_STATIC_FUNC_WITH_PARAM(gImgLog, "imgLoader::PutIntoCache", "uri",
1568                              aKey.URI());
1569
1570   // Check to see if this request already exists in the cache. If so, we'll
1571   // replace the old version.
1572   RefPtr<imgCacheEntry> tmpCacheEntry;
1573   if (mCache.Get(aKey, getter_AddRefs(tmpCacheEntry)) && tmpCacheEntry) {
1574     MOZ_LOG(
1575         gImgLog, LogLevel::Debug,
1576         ("[this=%p] imgLoader::PutIntoCache -- Element already in the cache",
1577          nullptr));
1578     RefPtr<imgRequest> tmpRequest = tmpCacheEntry->GetRequest();
1579
1580     // If it already exists, and we're putting the same key into the cache, we
1581     // should remove the old version.
1582     MOZ_LOG(gImgLog, LogLevel::Debug,
1583             ("[this=%p] imgLoader::PutIntoCache -- Replacing cached element",
1584              nullptr));
1585
1586     RemoveFromCache(aKey);
1587   } else {
1588     MOZ_LOG(gImgLog, LogLevel::Debug,
1589             ("[this=%p] imgLoader::PutIntoCache --"
1590              " Element NOT already in the cache",
1591              nullptr));
1592   }
1593
1594   mCache.InsertOrUpdate(aKey, RefPtr{entry});
1595
1596   // We can be called to resurrect an evicted entry.
1597   if (entry->Evicted()) {
1598     entry->SetEvicted(false);
1599   }
1600
1601   // If we're resurrecting an entry with no proxies, put it back in the
1602   // tracker and queue.
1603   if (entry->HasNoProxies()) {
1604     nsresult addrv = NS_OK;
1605
1606     if (mCacheTracker) {
1607       addrv = mCacheTracker->AddObject(entry);
1608     }
1609
1610     if (NS_SUCCEEDED(addrv)) {
1611       mCacheQueue.Push(entry);
1612     }
1613   }
1614
1615   RefPtr<imgRequest> request = entry->GetRequest();
1616   request->SetIsInCache(true);
1617   RemoveFromUncachedImages(request);
1618
1619   return true;
1620 }
1621
1622 bool imgLoader::SetHasNoProxies(imgRequest* aRequest, imgCacheEntry* aEntry) {
1623   LOG_STATIC_FUNC_WITH_PARAM(gImgLog, "imgLoader::SetHasNoProxies", "uri",
1624                              aRequest->CacheKey().URI());
1625
1626   aEntry->SetHasNoProxies(true);
1627
1628   if (aEntry->Evicted()) {
1629     return false;
1630   }
1631
1632   nsresult addrv = NS_OK;
1633
1634   if (mCacheTracker) {
1635     addrv = mCacheTracker->AddObject(aEntry);
1636   }
1637
1638   if (NS_SUCCEEDED(addrv)) {
1639     mCacheQueue.Push(aEntry);
1640   }
1641
1642   return true;
1643 }
1644
1645 bool imgLoader::SetHasProxies(imgRequest* aRequest) {
1646   VerifyCacheSizes();
1647
1648   const ImageCacheKey& key = aRequest->CacheKey();
1649
1650   LOG_STATIC_FUNC_WITH_PARAM(gImgLog, "imgLoader::SetHasProxies", "uri",
1651                              key.URI());
1652
1653   RefPtr<imgCacheEntry> entry;
1654   if (mCache.Get(key, getter_AddRefs(entry)) && entry) {
1655     // Make sure the cache entry is for the right request
1656     RefPtr<imgRequest> entryRequest = entry->GetRequest();
1657     if (entryRequest == aRequest && entry->HasNoProxies()) {
1658       mCacheQueue.Remove(entry);
1659
1660       if (mCacheTracker) {
1661         mCacheTracker->RemoveObject(entry);
1662       }
1663
1664       entry->SetHasNoProxies(false);
1665
1666       return true;
1667     }
1668   }
1669
1670   return false;
1671 }
1672
1673 void imgLoader::CacheEntriesChanged(int32_t aSizeDiff /* = 0 */) {
1674   // We only need to dirty the queue if there is any sorting
1675   // taking place.  Empty or single-entry lists can't become
1676   // dirty.
1677   if (mCacheQueue.GetNumElements() > 1) {
1678     mCacheQueue.MarkDirty();
1679   }
1680   mCacheQueue.UpdateSize(aSizeDiff);
1681 }
1682
1683 void imgLoader::CheckCacheLimits() {
1684   if (mCacheQueue.GetNumElements() == 0) {
1685     NS_ASSERTION(mCacheQueue.GetSize() == 0,
1686                  "imgLoader::CheckCacheLimits -- incorrect cache size");
1687   }
1688
1689   // Remove entries from the cache until we're back at our desired max size.
1690   while (mCacheQueue.GetSize() > sCacheMaxSize) {
1691     // Remove the first entry in the queue.
1692     RefPtr<imgCacheEntry> entry(mCacheQueue.Pop());
1693
1694     NS_ASSERTION(entry, "imgLoader::CheckCacheLimits -- NULL entry pointer");
1695
1696     if (MOZ_LOG_TEST(gImgLog, LogLevel::Debug)) {
1697       RefPtr<imgRequest> req = entry->GetRequest();
1698       if (req) {
1699         LOG_STATIC_FUNC_WITH_PARAM(gImgLog, "imgLoader::CheckCacheLimits",
1700                                    "entry", req->CacheKey().URI());
1701       }
1702     }
1703
1704     if (entry) {
1705       // We just popped this entry from the queue, so pass AlreadyRemoved
1706       // to avoid searching the queue again in RemoveFromCache.
1707       RemoveFromCache(entry, QueueState::AlreadyRemoved);
1708     }
1709   }
1710 }
1711
1712 bool imgLoader::ValidateRequestWithNewChannel(
1713     imgRequest* request, nsIURI* aURI, nsIURI* aInitialDocumentURI,
1714     nsIReferrerInfo* aReferrerInfo, nsILoadGroup* aLoadGroup,
1715     imgINotificationObserver* aObserver, Document* aLoadingDocument,
1716     uint64_t aInnerWindowId, nsLoadFlags aLoadFlags,
1717     nsContentPolicyType aLoadPolicyType, imgRequestProxy** aProxyRequest,
1718     nsIPrincipal* aTriggeringPrincipal, CORSMode aCORSMode, bool aLinkPreload,
1719     uint64_t aEarlyHintPreloaderId, bool* aNewChannelCreated) {
1720   // now we need to insert a new channel request object in between the real
1721   // request and the proxy that basically delays loading the image until it
1722   // gets a 304 or figures out that this needs to be a new request
1723
1724   nsresult rv;
1725
1726   // If we're currently in the middle of validating this request, just hand
1727   // back a proxy to it; the required work will be done for us.
1728   if (imgCacheValidator* validator = request->GetValidator()) {
1729     rv = CreateNewProxyForRequest(request, aURI, aLoadGroup, aLoadingDocument,
1730                                   aObserver, aLoadFlags, aProxyRequest);
1731     if (NS_FAILED(rv)) {
1732       return false;
1733     }
1734
1735     if (*aProxyRequest) {
1736       imgRequestProxy* proxy = static_cast<imgRequestProxy*>(*aProxyRequest);
1737
1738       // We will send notifications from imgCacheValidator::OnStartRequest().
1739       // In the mean time, we must defer notifications because we are added to
1740       // the imgRequest's proxy list, and we can get extra notifications
1741       // resulting from methods such as StartDecoding(). See bug 579122.
1742       proxy->MarkValidating();
1743
1744       if (aLinkPreload) {
1745         MOZ_ASSERT(aLoadingDocument);
1746         auto preloadKey = PreloadHashKey::CreateAsImage(
1747             aURI, aTriggeringPrincipal, aCORSMode);
1748         proxy->NotifyOpen(preloadKey, aLoadingDocument, true);
1749       }
1750
1751       // Attach the proxy without notifying
1752       validator->AddProxy(proxy);
1753     }
1754
1755     return true;
1756   }
1757   // We will rely on Necko to cache this request when it's possible, and to
1758   // tell imgCacheValidator::OnStartRequest whether the request came from its
1759   // cache.
1760   nsCOMPtr<nsIChannel> newChannel;
1761   bool forcePrincipalCheck;
1762   rv =
1763       NewImageChannel(getter_AddRefs(newChannel), &forcePrincipalCheck, aURI,
1764                       aInitialDocumentURI, aCORSMode, aReferrerInfo, aLoadGroup,
1765                       aLoadFlags, aLoadPolicyType, aTriggeringPrincipal,
1766                       aLoadingDocument, mRespectPrivacy, aEarlyHintPreloaderId);
1767   if (NS_FAILED(rv)) {
1768     return false;
1769   }
1770
1771   if (aNewChannelCreated) {
1772     *aNewChannelCreated = true;
1773   }
1774
1775   RefPtr<imgRequestProxy> req;
1776   rv = CreateNewProxyForRequest(request, aURI, aLoadGroup, aLoadingDocument,
1777                                 aObserver, aLoadFlags, getter_AddRefs(req));
1778   if (NS_FAILED(rv)) {
1779     return false;
1780   }
1781
1782   // Make sure that OnStatus/OnProgress calls have the right request set...
1783   RefPtr<nsProgressNotificationProxy> progressproxy =
1784       new nsProgressNotificationProxy(newChannel, req);
1785   if (!progressproxy) {
1786     return false;
1787   }
1788
1789   RefPtr<imgCacheValidator> hvc =
1790       new imgCacheValidator(progressproxy, this, request, aLoadingDocument,
1791                             aInnerWindowId, forcePrincipalCheck);
1792
1793   // Casting needed here to get past multiple inheritance.
1794   nsCOMPtr<nsIStreamListener> listener =
1795       do_QueryInterface(static_cast<nsIThreadRetargetableStreamListener*>(hvc));
1796   NS_ENSURE_TRUE(listener, false);
1797
1798   // We must set the notification callbacks before setting up the
1799   // CORS listener, because that's also interested inthe
1800   // notification callbacks.
1801   newChannel->SetNotificationCallbacks(hvc);
1802
1803   request->SetValidator(hvc);
1804
1805   // We will send notifications from imgCacheValidator::OnStartRequest().
1806   // In the mean time, we must defer notifications because we are added to
1807   // the imgRequest's proxy list, and we can get extra notifications
1808   // resulting from methods such as StartDecoding(). See bug 579122.
1809   req->MarkValidating();
1810
1811   if (aLinkPreload) {
1812     MOZ_ASSERT(aLoadingDocument);
1813     auto preloadKey =
1814         PreloadHashKey::CreateAsImage(aURI, aTriggeringPrincipal, aCORSMode);
1815     req->NotifyOpen(preloadKey, aLoadingDocument, true);
1816   }
1817
1818   // Add the proxy without notifying
1819   hvc->AddProxy(req);
1820
1821   mozilla::net::PredictorLearn(aURI, aInitialDocumentURI,
1822                                nsINetworkPredictor::LEARN_LOAD_SUBRESOURCE,
1823                                aLoadGroup);
1824   rv = newChannel->AsyncOpen(listener);
1825   if (NS_WARN_IF(NS_FAILED(rv))) {
1826     req->CancelAndForgetObserver(rv);
1827     // This will notify any current or future <link preload> tags.  Pass the
1828     // non-open channel so that we can read loadinfo and referrer info of that
1829     // channel.
1830     req->NotifyStart(newChannel);
1831     // Use the non-channel overload of this method to force the notification to
1832     // happen.  The preload request has not been assigned a channel.
1833     req->NotifyStop(rv);
1834     return false;
1835   }
1836
1837   req.forget(aProxyRequest);
1838   return true;
1839 }
1840
1841 void imgLoader::NotifyObserversForCachedImage(
1842     imgCacheEntry* aEntry, imgRequest* request, nsIURI* aURI,
1843     nsIReferrerInfo* aReferrerInfo, Document* aLoadingDocument,
1844     nsIPrincipal* aTriggeringPrincipal, CORSMode aCORSMode,
1845     uint64_t aEarlyHintPreloaderId) {
1846   if (aEntry->HasNotified()) {
1847     return;
1848   }
1849
1850   nsCOMPtr<nsIObserverService> obsService = services::GetObserverService();
1851
1852   if (!obsService->HasObservers("http-on-image-cache-response")) {
1853     return;
1854   }
1855
1856   aEntry->SetHasNotified();
1857
1858   nsCOMPtr<nsIChannel> newChannel;
1859   bool forcePrincipalCheck;
1860   nsresult rv = NewImageChannel(
1861       getter_AddRefs(newChannel), &forcePrincipalCheck, aURI, nullptr,
1862       aCORSMode, aReferrerInfo, nullptr, 0,
1863       nsIContentPolicy::TYPE_INTERNAL_IMAGE, aTriggeringPrincipal,
1864       aLoadingDocument, mRespectPrivacy, aEarlyHintPreloaderId);
1865   if (NS_FAILED(rv)) {
1866     return;
1867   }
1868
1869   RefPtr<HttpBaseChannel> httpBaseChannel = do_QueryObject(newChannel);
1870   if (httpBaseChannel) {
1871     httpBaseChannel->SetDummyChannelForImageCache();
1872     newChannel->SetContentType(nsDependentCString(request->GetMimeType()));
1873     RefPtr<mozilla::image::Image> image = request->GetImage();
1874     if (image) {
1875       newChannel->SetContentLength(aEntry->GetDataSize());
1876     }
1877     obsService->NotifyObservers(newChannel, "http-on-image-cache-response",
1878                                 nullptr);
1879   }
1880 }
1881
1882 bool imgLoader::ValidateEntry(
1883     imgCacheEntry* aEntry, nsIURI* aURI, nsIURI* aInitialDocumentURI,
1884     nsIReferrerInfo* aReferrerInfo, nsILoadGroup* aLoadGroup,
1885     imgINotificationObserver* aObserver, Document* aLoadingDocument,
1886     nsLoadFlags aLoadFlags, nsContentPolicyType aLoadPolicyType,
1887     bool aCanMakeNewChannel, bool* aNewChannelCreated,
1888     imgRequestProxy** aProxyRequest, nsIPrincipal* aTriggeringPrincipal,
1889     CORSMode aCORSMode, bool aLinkPreload, uint64_t aEarlyHintPreloaderId) {
1890   LOG_SCOPE(gImgLog, "imgLoader::ValidateEntry");
1891
1892   // If the expiration time is zero, then the request has not gotten far enough
1893   // to know when it will expire, or we know it will never expire (see
1894   // nsContentUtils::GetSubresourceCacheValidationInfo).
1895   uint32_t expiryTime = aEntry->GetExpiryTime();
1896   bool hasExpired = expiryTime && expiryTime <= SecondsFromPRTime(PR_Now());
1897
1898   // Special treatment for file URLs - aEntry has expired if file has changed
1899   if (nsCOMPtr<nsIFileURL> fileUrl = do_QueryInterface(aURI)) {
1900     uint32_t lastModTime = aEntry->GetLoadTime();
1901     nsCOMPtr<nsIFile> theFile;
1902     if (NS_SUCCEEDED(fileUrl->GetFile(getter_AddRefs(theFile)))) {
1903       PRTime fileLastMod;
1904       if (NS_SUCCEEDED(theFile->GetLastModifiedTime(&fileLastMod))) {
1905         // nsIFile uses millisec, NSPR usec.
1906         fileLastMod *= 1000;
1907         hasExpired = SecondsFromPRTime((PRTime)fileLastMod) > lastModTime;
1908       }
1909     }
1910   }
1911
1912   RefPtr<imgRequest> request(aEntry->GetRequest());
1913
1914   if (!request) {
1915     return false;
1916   }
1917
1918   if (!ValidateSecurityInfo(request, aEntry->ForcePrincipalCheck(), aCORSMode,
1919                             aTriggeringPrincipal, aLoadingDocument,
1920                             aLoadPolicyType)) {
1921     return false;
1922   }
1923
1924   // data URIs are immutable and by their nature can't leak data, so we can
1925   // just return true in that case.  Doing so would mean that shift-reload
1926   // doesn't reload data URI documents/images though (which is handy for
1927   // debugging during gecko development) so we make an exception in that case.
1928   if (aURI->SchemeIs("data") && !(aLoadFlags & nsIRequest::LOAD_BYPASS_CACHE)) {
1929     return true;
1930   }
1931
1932   bool validateRequest = false;
1933
1934   if (!request->CanReuseWithoutValidation(aLoadingDocument)) {
1935     // If we would need to revalidate this entry, but we're being told to
1936     // bypass the cache, we don't allow this entry to be used.
1937     if (aLoadFlags & nsIRequest::LOAD_BYPASS_CACHE) {
1938       return false;
1939     }
1940
1941     if (MOZ_UNLIKELY(ChaosMode::isActive(ChaosFeature::ImageCache))) {
1942       if (ChaosMode::randomUint32LessThan(4) < 1) {
1943         return false;
1944       }
1945     }
1946
1947     // Determine whether the cache aEntry must be revalidated...
1948     validateRequest = ShouldRevalidateEntry(aEntry, aLoadFlags, hasExpired);
1949
1950     MOZ_LOG(gImgLog, LogLevel::Debug,
1951             ("imgLoader::ValidateEntry validating cache entry. "
1952              "validateRequest = %d",
1953              validateRequest));
1954   } else if (!aLoadingDocument && MOZ_LOG_TEST(gImgLog, LogLevel::Debug)) {
1955     MOZ_LOG(gImgLog, LogLevel::Debug,
1956             ("imgLoader::ValidateEntry BYPASSING cache validation for %s "
1957              "because of NULL loading document",
1958              aURI->GetSpecOrDefault().get()));
1959   }
1960
1961   // If the original request is still transferring don't kick off a validation
1962   // network request because it is a bit silly to issue a validation request if
1963   // the original request hasn't even finished yet. So just return true
1964   // indicating the caller can create a new proxy for the request and use it as
1965   // is.
1966   // This is an optimization but it's also required for correctness. If we don't
1967   // do this then when firing the load complete notification for the original
1968   // request that can unblock load for the document and then spin the event loop
1969   // (see the stack in bug 1641682) which then the OnStartRequest for the
1970   // validation request can fire which can call UpdateProxies and can sync
1971   // notify on the progress tracker about all existing state, which includes
1972   // load complete, so we fire a second load complete notification for the
1973   // image.
1974   // In addition, we want to validate if the original request encountered
1975   // an error for two reasons. The first being if the error was a network error
1976   // then trying to re-fetch the image might succeed. The second is more
1977   // complicated. We decide if we should fire the load or error event for img
1978   // elements depending on if the image has error in its status at the time when
1979   // the load complete notification is received, and we set error status on an
1980   // image if it encounters a network error or a decode error with no real way
1981   // to tell them apart. So if we load an image that will produce a decode error
1982   // the first time we will usually fire the load event, and then decode enough
1983   // to encounter the decode error and set the error status on the image. The
1984   // next time we reference the image in the same document the load complete
1985   // notification is replayed and this time the error status from the decode is
1986   // already present so we fire the error event instead of the load event. This
1987   // is a bug (bug 1645576) that we should fix. In order to avoid that bug in
1988   // some cases (specifically the cases when we hit this code and try to
1989   // validate the request) we make sure to validate. This avoids the bug because
1990   // when the load complete notification arrives the proxy is marked as
1991   // validating so it lies about its status and returns nothing.
1992   const bool requestComplete = [&] {
1993     RefPtr<ProgressTracker> tracker;
1994     RefPtr<mozilla::image::Image> image = request->GetImage();
1995     if (image) {
1996       tracker = image->GetProgressTracker();
1997     } else {
1998       tracker = request->GetProgressTracker();
1999     }
2000     return tracker &&
2001            tracker->GetProgress() & (FLAG_LOAD_COMPLETE | FLAG_HAS_ERROR);
2002   }();
2003
2004   if (!requestComplete) {
2005     return true;
2006   }
2007
2008   if (validateRequest && aCanMakeNewChannel) {
2009     LOG_SCOPE(gImgLog, "imgLoader::ValidateRequest |cache hit| must validate");
2010
2011     uint64_t innerWindowID =
2012         aLoadingDocument ? aLoadingDocument->InnerWindowID() : 0;
2013     return ValidateRequestWithNewChannel(
2014         request, aURI, aInitialDocumentURI, aReferrerInfo, aLoadGroup,
2015         aObserver, aLoadingDocument, innerWindowID, aLoadFlags, aLoadPolicyType,
2016         aProxyRequest, aTriggeringPrincipal, aCORSMode, aLinkPreload,
2017         aEarlyHintPreloaderId, aNewChannelCreated);
2018   }
2019
2020   if (!validateRequest) {
2021     NotifyObserversForCachedImage(aEntry, request, aURI, aReferrerInfo,
2022                                   aLoadingDocument, aTriggeringPrincipal,
2023                                   aCORSMode, aEarlyHintPreloaderId);
2024   }
2025
2026   return !validateRequest;
2027 }
2028
2029 bool imgLoader::RemoveFromCache(const ImageCacheKey& aKey) {
2030   LOG_STATIC_FUNC_WITH_PARAM(gImgLog, "imgLoader::RemoveFromCache", "uri",
2031                              aKey.URI());
2032   RefPtr<imgCacheEntry> entry;
2033   mCache.Remove(aKey, getter_AddRefs(entry));
2034   if (entry) {
2035     MOZ_ASSERT(!entry->Evicted(), "Evicting an already-evicted cache entry!");
2036
2037     // Entries with no proxies are in the tracker.
2038     if (entry->HasNoProxies()) {
2039       if (mCacheTracker) {
2040         mCacheTracker->RemoveObject(entry);
2041       }
2042       mCacheQueue.Remove(entry);
2043     }
2044
2045     entry->SetEvicted(true);
2046
2047     RefPtr<imgRequest> request = entry->GetRequest();
2048     request->SetIsInCache(false);
2049     AddToUncachedImages(request);
2050
2051     return true;
2052   }
2053   return false;
2054 }
2055
2056 bool imgLoader::RemoveFromCache(imgCacheEntry* entry, QueueState aQueueState) {
2057   LOG_STATIC_FUNC(gImgLog, "imgLoader::RemoveFromCache entry");
2058
2059   RefPtr<imgRequest> request = entry->GetRequest();
2060   if (request) {
2061     const ImageCacheKey& key = request->CacheKey();
2062     LOG_STATIC_FUNC_WITH_PARAM(gImgLog, "imgLoader::RemoveFromCache",
2063                                "entry's uri", key.URI());
2064
2065     mCache.Remove(key);
2066
2067     if (entry->HasNoProxies()) {
2068       LOG_STATIC_FUNC(gImgLog,
2069                       "imgLoader::RemoveFromCache removing from tracker");
2070       if (mCacheTracker) {
2071         mCacheTracker->RemoveObject(entry);
2072       }
2073       // Only search the queue to remove the entry if its possible it might
2074       // be in the queue.  If we know its not in the queue this would be
2075       // wasted work.
2076       MOZ_ASSERT_IF(aQueueState == QueueState::AlreadyRemoved,
2077                     !mCacheQueue.Contains(entry));
2078       if (aQueueState == QueueState::MaybeExists) {
2079         mCacheQueue.Remove(entry);
2080       }
2081     }
2082
2083     entry->SetEvicted(true);
2084     request->SetIsInCache(false);
2085     AddToUncachedImages(request);
2086
2087     return true;
2088   }
2089
2090   return false;
2091 }
2092
2093 nsresult imgLoader::ClearImageCache(ClearOptions aOptions) {
2094   const bool chromeOnly = aOptions.contains(ClearOption::ChromeOnly);
2095   const auto ShouldRemove = [&](imgCacheEntry* aEntry) {
2096     if (chromeOnly) {
2097       // TODO: Consider also removing "resource://" etc?
2098       RefPtr<imgRequest> request = aEntry->GetRequest();
2099       if (!request || !request->CacheKey().URI()->SchemeIs("chrome")) {
2100         return false;
2101       }
2102     }
2103     return true;
2104   };
2105   if (aOptions.contains(ClearOption::UnusedOnly)) {
2106     LOG_STATIC_FUNC(gImgLog, "imgLoader::ClearImageCache queue");
2107     // We have to make a temporary, since RemoveFromCache removes the element
2108     // from the queue, invalidating iterators.
2109     nsTArray<RefPtr<imgCacheEntry>> entries(mCacheQueue.GetNumElements());
2110     for (auto& entry : mCacheQueue) {
2111       if (ShouldRemove(entry)) {
2112         entries.AppendElement(entry);
2113       }
2114     }
2115
2116     // Iterate in reverse order to minimize array copying.
2117     for (auto& entry : entries) {
2118       if (!RemoveFromCache(entry)) {
2119         return NS_ERROR_FAILURE;
2120       }
2121     }
2122
2123     MOZ_ASSERT(chromeOnly || mCacheQueue.GetNumElements() == 0);
2124     return NS_OK;
2125   }
2126
2127   LOG_STATIC_FUNC(gImgLog, "imgLoader::ClearImageCache table");
2128   // We have to make a temporary, since RemoveFromCache removes the element
2129   // from the queue, invalidating iterators.
2130   const auto entries =
2131       ToTArray<nsTArray<RefPtr<imgCacheEntry>>>(mCache.Values());
2132   for (const auto& entry : entries) {
2133     if (!ShouldRemove(entry)) {
2134       continue;
2135     }
2136     if (!RemoveFromCache(entry)) {
2137       return NS_ERROR_FAILURE;
2138     }
2139   }
2140   MOZ_ASSERT(chromeOnly || mCache.IsEmpty());
2141   return NS_OK;
2142 }
2143
2144 void imgLoader::AddToUncachedImages(imgRequest* aRequest) {
2145   MutexAutoLock lock(mUncachedImagesMutex);
2146   mUncachedImages.Insert(aRequest);
2147 }
2148
2149 void imgLoader::RemoveFromUncachedImages(imgRequest* aRequest) {
2150   MutexAutoLock lock(mUncachedImagesMutex);
2151   mUncachedImages.Remove(aRequest);
2152 }
2153
2154 #define LOAD_FLAGS_CACHE_MASK \
2155   (nsIRequest::LOAD_BYPASS_CACHE | nsIRequest::LOAD_FROM_CACHE)
2156
2157 #define LOAD_FLAGS_VALIDATE_MASK                              \
2158   (nsIRequest::VALIDATE_ALWAYS | nsIRequest::VALIDATE_NEVER | \
2159    nsIRequest::VALIDATE_ONCE_PER_SESSION)
2160
2161 NS_IMETHODIMP
2162 imgLoader::LoadImageXPCOM(
2163     nsIURI* aURI, nsIURI* aInitialDocumentURI, nsIReferrerInfo* aReferrerInfo,
2164     nsIPrincipal* aTriggeringPrincipal, nsILoadGroup* aLoadGroup,
2165     imgINotificationObserver* aObserver, Document* aLoadingDocument,
2166     nsLoadFlags aLoadFlags, nsISupports* aCacheKey,
2167     nsContentPolicyType aContentPolicyType, imgIRequest** _retval) {
2168   // Optional parameter, so defaults to 0 (== TYPE_INVALID)
2169   if (!aContentPolicyType) {
2170     aContentPolicyType = nsIContentPolicy::TYPE_INTERNAL_IMAGE;
2171   }
2172   imgRequestProxy* proxy;
2173   nsresult rv =
2174       LoadImage(aURI, aInitialDocumentURI, aReferrerInfo, aTriggeringPrincipal,
2175                 0, aLoadGroup, aObserver, aLoadingDocument, aLoadingDocument,
2176                 aLoadFlags, aCacheKey, aContentPolicyType, u""_ns,
2177                 /* aUseUrgentStartForChannel */ false, /* aListPreload */ false,
2178                 0, &proxy);
2179   *_retval = proxy;
2180   return rv;
2181 }
2182
2183 static void MakeRequestStaticIfNeeded(
2184     Document* aLoadingDocument, imgRequestProxy** aProxyAboutToGetReturned) {
2185   if (!aLoadingDocument || !aLoadingDocument->IsStaticDocument()) {
2186     return;
2187   }
2188
2189   if (!*aProxyAboutToGetReturned) {
2190     return;
2191   }
2192
2193   RefPtr<imgRequestProxy> proxy = dont_AddRef(*aProxyAboutToGetReturned);
2194   *aProxyAboutToGetReturned = nullptr;
2195
2196   RefPtr<imgRequestProxy> staticProxy =
2197       proxy->GetStaticRequest(aLoadingDocument);
2198   if (staticProxy != proxy) {
2199     proxy->CancelAndForgetObserver(NS_BINDING_ABORTED);
2200     proxy = std::move(staticProxy);
2201   }
2202   proxy.forget(aProxyAboutToGetReturned);
2203 }
2204
2205 bool imgLoader::IsImageAvailable(nsIURI* aURI,
2206                                  nsIPrincipal* aTriggeringPrincipal,
2207                                  CORSMode aCORSMode, Document* aDocument) {
2208   ImageCacheKey key(aURI, aCORSMode,
2209                     aTriggeringPrincipal->OriginAttributesRef(), aDocument);
2210   RefPtr<imgCacheEntry> entry;
2211   if (!mCache.Get(key, getter_AddRefs(entry)) || !entry) {
2212     return false;
2213   }
2214   RefPtr<imgRequest> request = entry->GetRequest();
2215   if (!request) {
2216     return false;
2217   }
2218   if (nsCOMPtr<nsILoadGroup> docLoadGroup = aDocument->GetDocumentLoadGroup()) {
2219     nsLoadFlags requestFlags = nsIRequest::LOAD_NORMAL;
2220     docLoadGroup->GetLoadFlags(&requestFlags);
2221     if (requestFlags & nsIRequest::LOAD_BYPASS_CACHE) {
2222       // If we're bypassing the cache, treat the image as not available.
2223       return false;
2224     }
2225   }
2226   return ValidateCORSMode(request, false, aCORSMode, aTriggeringPrincipal);
2227 }
2228
2229 nsresult imgLoader::LoadImage(
2230     nsIURI* aURI, nsIURI* aInitialDocumentURI, nsIReferrerInfo* aReferrerInfo,
2231     nsIPrincipal* aTriggeringPrincipal, uint64_t aRequestContextID,
2232     nsILoadGroup* aLoadGroup, imgINotificationObserver* aObserver,
2233     nsINode* aContext, Document* aLoadingDocument, nsLoadFlags aLoadFlags,
2234     nsISupports* aCacheKey, nsContentPolicyType aContentPolicyType,
2235     const nsAString& initiatorType, bool aUseUrgentStartForChannel,
2236     bool aLinkPreload, uint64_t aEarlyHintPreloaderId,
2237     imgRequestProxy** _retval) {
2238   VerifyCacheSizes();
2239
2240   NS_ASSERTION(aURI, "imgLoader::LoadImage -- NULL URI pointer");
2241
2242   if (!aURI) {
2243     return NS_ERROR_NULL_POINTER;
2244   }
2245
2246   auto makeStaticIfNeeded = mozilla::MakeScopeExit(
2247       [&] { MakeRequestStaticIfNeeded(aLoadingDocument, _retval); });
2248
2249   AUTO_PROFILER_LABEL_DYNAMIC_NSCSTRING("imgLoader::LoadImage", NETWORK,
2250                                         aURI->GetSpecOrDefault());
2251
2252   LOG_SCOPE_WITH_PARAM(gImgLog, "imgLoader::LoadImage", "aURI", aURI);
2253
2254   *_retval = nullptr;
2255
2256   RefPtr<imgRequest> request;
2257
2258   nsresult rv;
2259   nsLoadFlags requestFlags = nsIRequest::LOAD_NORMAL;
2260
2261 #ifdef DEBUG
2262   bool isPrivate = false;
2263
2264   if (aLoadingDocument) {
2265     isPrivate = nsContentUtils::IsInPrivateBrowsing(aLoadingDocument);
2266   } else if (aLoadGroup) {
2267     isPrivate = nsContentUtils::IsInPrivateBrowsing(aLoadGroup);
2268   }
2269   MOZ_ASSERT(isPrivate == mRespectPrivacy);
2270
2271   if (aLoadingDocument) {
2272     // The given load group should match that of the document if given. If
2273     // that isn't the case, then we need to add more plumbing to ensure we
2274     // block the document as well.
2275     nsCOMPtr<nsILoadGroup> docLoadGroup =
2276         aLoadingDocument->GetDocumentLoadGroup();
2277     MOZ_ASSERT(docLoadGroup == aLoadGroup);
2278   }
2279 #endif
2280
2281   // Get the default load flags from the loadgroup (if possible)...
2282   if (aLoadGroup) {
2283     aLoadGroup->GetLoadFlags(&requestFlags);
2284   }
2285   //
2286   // Merge the default load flags with those passed in via aLoadFlags.
2287   // Currently, *only* the caching, validation and background load flags
2288   // are merged...
2289   //
2290   // The flags in aLoadFlags take precedence over the default flags!
2291   //
2292   if (aLoadFlags & LOAD_FLAGS_CACHE_MASK) {
2293     // Override the default caching flags...
2294     requestFlags = (requestFlags & ~LOAD_FLAGS_CACHE_MASK) |
2295                    (aLoadFlags & LOAD_FLAGS_CACHE_MASK);
2296   }
2297   if (aLoadFlags & LOAD_FLAGS_VALIDATE_MASK) {
2298     // Override the default validation flags...
2299     requestFlags = (requestFlags & ~LOAD_FLAGS_VALIDATE_MASK) |
2300                    (aLoadFlags & LOAD_FLAGS_VALIDATE_MASK);
2301   }
2302   if (aLoadFlags & nsIRequest::LOAD_BACKGROUND) {
2303     // Propagate background loading...
2304     requestFlags |= nsIRequest::LOAD_BACKGROUND;
2305   }
2306
2307   if (aLinkPreload) {
2308     // Set background loading if it is <link rel=preload>
2309     requestFlags |= nsIRequest::LOAD_BACKGROUND;
2310   }
2311
2312   CORSMode corsmode = CORS_NONE;
2313   if (aLoadFlags & imgILoader::LOAD_CORS_ANONYMOUS) {
2314     corsmode = CORS_ANONYMOUS;
2315   } else if (aLoadFlags & imgILoader::LOAD_CORS_USE_CREDENTIALS) {
2316     corsmode = CORS_USE_CREDENTIALS;
2317   }
2318
2319   // Look in the preloaded images of loading document first.
2320   if (!aLinkPreload && aLoadingDocument) {
2321     // All Early Hints preloads are Link preloads, therefore we don't have a
2322     // Early Hints preload here
2323     MOZ_ASSERT(!aEarlyHintPreloaderId);
2324     auto key =
2325         PreloadHashKey::CreateAsImage(aURI, aTriggeringPrincipal, corsmode);
2326     if (RefPtr<PreloaderBase> preload =
2327             aLoadingDocument->Preloads().LookupPreload(key)) {
2328       RefPtr<imgRequestProxy> proxy = do_QueryObject(preload);
2329       MOZ_ASSERT(proxy);
2330
2331       MOZ_LOG(gImgLog, LogLevel::Debug,
2332               ("[this=%p] imgLoader::LoadImage -- preloaded [proxy=%p]"
2333                " [document=%p]\n",
2334                this, proxy.get(), aLoadingDocument));
2335
2336       // Removing the preload for this image to be in parity with Chromium.  Any
2337       // following regular image request will be reloaded using the regular
2338       // path: image cache, http cache, network.  Any following `<link
2339       // rel=preload as=image>` will start a new image preload that can be
2340       // satisfied from http cache or network.
2341       //
2342       // There is a spec discussion for "preload cache", see
2343       // https://github.com/w3c/preload/issues/97. And it is also not clear how
2344       // preload image interacts with list of available images, see
2345       // https://github.com/whatwg/html/issues/4474.
2346       proxy->RemoveSelf(aLoadingDocument);
2347       proxy->NotifyUsage(aLoadingDocument);
2348
2349       imgRequest* request = proxy->GetOwner();
2350       nsresult rv =
2351           CreateNewProxyForRequest(request, aURI, aLoadGroup, aLoadingDocument,
2352                                    aObserver, requestFlags, _retval);
2353       NS_ENSURE_SUCCESS(rv, rv);
2354
2355       imgRequestProxy* newProxy = *_retval;
2356       if (imgCacheValidator* validator = request->GetValidator()) {
2357         newProxy->MarkValidating();
2358         // Attach the proxy without notifying and this will add us to the load
2359         // group.
2360         validator->AddProxy(newProxy);
2361       } else {
2362         // It's OK to add here even if the request is done. If it is, it'll send
2363         // a OnStopRequest()and the proxy will be removed from the loadgroup in
2364         // imgRequestProxy::OnLoadComplete.
2365         newProxy->AddToLoadGroup();
2366         newProxy->NotifyListener();
2367       }
2368
2369       return NS_OK;
2370     }
2371   }
2372
2373   RefPtr<imgCacheEntry> entry;
2374
2375   // Look in the cache for our URI, and then validate it.
2376   // XXX For now ignore aCacheKey. We will need it in the future
2377   // for correctly dealing with image load requests that are a result
2378   // of post data.
2379   OriginAttributes attrs;
2380   if (aTriggeringPrincipal) {
2381     attrs = aTriggeringPrincipal->OriginAttributesRef();
2382   }
2383   ImageCacheKey key(aURI, corsmode, attrs, aLoadingDocument);
2384   if (mCache.Get(key, getter_AddRefs(entry)) && entry) {
2385     bool newChannelCreated = false;
2386     if (ValidateEntry(entry, aURI, aInitialDocumentURI, aReferrerInfo,
2387                       aLoadGroup, aObserver, aLoadingDocument, requestFlags,
2388                       aContentPolicyType, true, &newChannelCreated, _retval,
2389                       aTriggeringPrincipal, corsmode, aLinkPreload,
2390                       aEarlyHintPreloaderId)) {
2391       request = entry->GetRequest();
2392
2393       // If this entry has no proxies, its request has no reference to the
2394       // entry.
2395       if (entry->HasNoProxies()) {
2396         LOG_FUNC_WITH_PARAM(gImgLog,
2397                             "imgLoader::LoadImage() adding proxyless entry",
2398                             "uri", key.URI());
2399         MOZ_ASSERT(!request->HasCacheEntry(),
2400                    "Proxyless entry's request has cache entry!");
2401         request->SetCacheEntry(entry);
2402
2403         if (mCacheTracker && entry->GetExpirationState()->IsTracked()) {
2404           mCacheTracker->MarkUsed(entry);
2405         }
2406       }
2407
2408       entry->Touch();
2409
2410       if (!newChannelCreated) {
2411         // This is ugly but it's needed to report CSP violations. We have 3
2412         // scenarios:
2413         // - we don't have cache. We are not in this if() stmt. A new channel is
2414         //   created and that triggers the CSP checks.
2415         // - We have a cache entry and this is blocked by CSP directives.
2416         DebugOnly<bool> shouldLoad = ShouldLoadCachedImage(
2417             request, aLoadingDocument, aTriggeringPrincipal, aContentPolicyType,
2418             /* aSendCSPViolationReports */ true);
2419         MOZ_ASSERT(shouldLoad);
2420       }
2421     } else {
2422       // We can't use this entry. We'll try to load it off the network, and if
2423       // successful, overwrite the old entry in the cache with a new one.
2424       entry = nullptr;
2425     }
2426   }
2427
2428   // Keep the channel in this scope, so we can adjust its notificationCallbacks
2429   // later when we create the proxy.
2430   nsCOMPtr<nsIChannel> newChannel;
2431   // If we didn't get a cache hit, we need to load from the network.
2432   if (!request) {
2433     LOG_SCOPE(gImgLog, "imgLoader::LoadImage |cache miss|");
2434
2435     bool forcePrincipalCheck;
2436     rv = NewImageChannel(getter_AddRefs(newChannel), &forcePrincipalCheck, aURI,
2437                          aInitialDocumentURI, corsmode, aReferrerInfo,
2438                          aLoadGroup, requestFlags, aContentPolicyType,
2439                          aTriggeringPrincipal, aContext, mRespectPrivacy,
2440                          aEarlyHintPreloaderId);
2441     if (NS_FAILED(rv)) {
2442       return NS_ERROR_FAILURE;
2443     }
2444
2445     MOZ_ASSERT(NS_UsePrivateBrowsing(newChannel) == mRespectPrivacy);
2446
2447     NewRequestAndEntry(forcePrincipalCheck, this, key, getter_AddRefs(request),
2448                        getter_AddRefs(entry));
2449
2450     MOZ_LOG(gImgLog, LogLevel::Debug,
2451             ("[this=%p] imgLoader::LoadImage -- Created new imgRequest"
2452              " [request=%p]\n",
2453              this, request.get()));
2454
2455     nsCOMPtr<nsIClassOfService> cos(do_QueryInterface(newChannel));
2456     if (cos) {
2457       if (aUseUrgentStartForChannel && !aLinkPreload) {
2458         cos->AddClassFlags(nsIClassOfService::UrgentStart);
2459       }
2460
2461       if (StaticPrefs::network_http_tailing_enabled() &&
2462           aContentPolicyType == nsIContentPolicy::TYPE_INTERNAL_IMAGE_FAVICON) {
2463         cos->AddClassFlags(nsIClassOfService::Throttleable |
2464                            nsIClassOfService::Tail);
2465         nsCOMPtr<nsIHttpChannel> httpChannel(do_QueryInterface(newChannel));
2466         if (httpChannel) {
2467           Unused << httpChannel->SetRequestContextID(aRequestContextID);
2468         }
2469       }
2470     }
2471
2472     nsCOMPtr<nsILoadGroup> channelLoadGroup;
2473     newChannel->GetLoadGroup(getter_AddRefs(channelLoadGroup));
2474     rv = request->Init(aURI, aURI, /* aHadInsecureRedirect = */ false,
2475                        channelLoadGroup, newChannel, entry, aLoadingDocument,
2476                        aTriggeringPrincipal, corsmode, aReferrerInfo);
2477     if (NS_FAILED(rv)) {
2478       return NS_ERROR_FAILURE;
2479     }
2480
2481     // Add the initiator type for this image load
2482     nsCOMPtr<nsITimedChannel> timedChannel = do_QueryInterface(newChannel);
2483     if (timedChannel) {
2484       timedChannel->SetInitiatorType(initiatorType);
2485     }
2486
2487     // create the proxy listener
2488     nsCOMPtr<nsIStreamListener> listener = new ProxyListener(request.get());
2489
2490     MOZ_LOG(gImgLog, LogLevel::Debug,
2491             ("[this=%p] imgLoader::LoadImage -- Calling channel->AsyncOpen()\n",
2492              this));
2493
2494     mozilla::net::PredictorLearn(aURI, aInitialDocumentURI,
2495                                  nsINetworkPredictor::LEARN_LOAD_SUBRESOURCE,
2496                                  aLoadGroup);
2497
2498     nsresult openRes;
2499     openRes = newChannel->AsyncOpen(listener);
2500
2501     if (NS_FAILED(openRes)) {
2502       MOZ_LOG(
2503           gImgLog, LogLevel::Debug,
2504           ("[this=%p] imgLoader::LoadImage -- AsyncOpen() failed: 0x%" PRIx32
2505            "\n",
2506            this, static_cast<uint32_t>(openRes)));
2507       request->CancelAndAbort(openRes);
2508       return openRes;
2509     }
2510
2511     // Try to add the new request into the cache.
2512     PutIntoCache(key, entry);
2513   } else {
2514     LOG_MSG_WITH_PARAM(gImgLog, "imgLoader::LoadImage |cache hit|", "request",
2515                        request);
2516   }
2517
2518   // If we didn't get a proxy when validating the cache entry, we need to
2519   // create one.
2520   if (!*_retval) {
2521     // ValidateEntry() has three return values: "Is valid," "might be valid --
2522     // validating over network", and "not valid." If we don't have a _retval,
2523     // we know ValidateEntry is not validating over the network, so it's safe
2524     // to SetLoadId here because we know this request is valid for this context.
2525     //
2526     // Note, however, that this doesn't guarantee the behaviour we want (one
2527     // URL maps to the same image on a page) if we load the same image in a
2528     // different tab (see bug 528003), because its load id will get re-set, and
2529     // that'll cause us to validate over the network.
2530     request->SetLoadId(aLoadingDocument);
2531
2532     LOG_MSG(gImgLog, "imgLoader::LoadImage", "creating proxy request.");
2533     rv = CreateNewProxyForRequest(request, aURI, aLoadGroup, aLoadingDocument,
2534                                   aObserver, requestFlags, _retval);
2535     if (NS_FAILED(rv)) {
2536       return rv;
2537     }
2538
2539     imgRequestProxy* proxy = *_retval;
2540
2541     // Make sure that OnStatus/OnProgress calls have the right request set, if
2542     // we did create a channel here.
2543     if (newChannel) {
2544       nsCOMPtr<nsIInterfaceRequestor> requestor(
2545           new nsProgressNotificationProxy(newChannel, proxy));
2546       if (!requestor) {
2547         return NS_ERROR_OUT_OF_MEMORY;
2548       }
2549       newChannel->SetNotificationCallbacks(requestor);
2550     }
2551
2552     if (aLinkPreload) {
2553       MOZ_ASSERT(aLoadingDocument);
2554       auto preloadKey =
2555           PreloadHashKey::CreateAsImage(aURI, aTriggeringPrincipal, corsmode);
2556       proxy->NotifyOpen(preloadKey, aLoadingDocument, true);
2557     }
2558
2559     // Note that it's OK to add here even if the request is done.  If it is,
2560     // it'll send a OnStopRequest() to the proxy in imgRequestProxy::Notify and
2561     // the proxy will be removed from the loadgroup.
2562     proxy->AddToLoadGroup();
2563
2564     // If we're loading off the network, explicitly don't notify our proxy,
2565     // because necko (or things called from necko, such as imgCacheValidator)
2566     // are going to call our notifications asynchronously, and we can't make it
2567     // further asynchronous because observers might rely on imagelib completing
2568     // its work between the channel's OnStartRequest and OnStopRequest.
2569     if (!newChannel) {
2570       proxy->NotifyListener();
2571     }
2572
2573     return rv;
2574   }
2575
2576   NS_ASSERTION(*_retval, "imgLoader::LoadImage -- no return value");
2577
2578   return NS_OK;
2579 }
2580
2581 NS_IMETHODIMP
2582 imgLoader::LoadImageWithChannelXPCOM(nsIChannel* channel,
2583                                      imgINotificationObserver* aObserver,
2584                                      Document* aLoadingDocument,
2585                                      nsIStreamListener** listener,
2586                                      imgIRequest** _retval) {
2587   nsresult result;
2588   imgRequestProxy* proxy;
2589   result = LoadImageWithChannel(channel, aObserver, aLoadingDocument, listener,
2590                                 &proxy);
2591   *_retval = proxy;
2592   return result;
2593 }
2594
2595 nsresult imgLoader::LoadImageWithChannel(nsIChannel* channel,
2596                                          imgINotificationObserver* aObserver,
2597                                          Document* aLoadingDocument,
2598                                          nsIStreamListener** listener,
2599                                          imgRequestProxy** _retval) {
2600   NS_ASSERTION(channel,
2601                "imgLoader::LoadImageWithChannel -- NULL channel pointer");
2602
2603   MOZ_ASSERT(NS_UsePrivateBrowsing(channel) == mRespectPrivacy);
2604
2605   auto makeStaticIfNeeded = mozilla::MakeScopeExit(
2606       [&] { MakeRequestStaticIfNeeded(aLoadingDocument, _retval); });
2607
2608   LOG_SCOPE(gImgLog, "imgLoader::LoadImageWithChannel");
2609   RefPtr<imgRequest> request;
2610
2611   nsCOMPtr<nsIURI> uri;
2612   channel->GetURI(getter_AddRefs(uri));
2613
2614   NS_ENSURE_TRUE(channel, NS_ERROR_FAILURE);
2615   nsCOMPtr<nsILoadInfo> loadInfo = channel->LoadInfo();
2616
2617   OriginAttributes attrs = loadInfo->GetOriginAttributes();
2618
2619   // TODO: Get a meaningful cors mode from the caller probably?
2620   const auto corsMode = CORS_NONE;
2621   ImageCacheKey key(uri, corsMode, attrs, aLoadingDocument);
2622
2623   nsLoadFlags requestFlags = nsIRequest::LOAD_NORMAL;
2624   channel->GetLoadFlags(&requestFlags);
2625
2626   RefPtr<imgCacheEntry> entry;
2627
2628   if (requestFlags & nsIRequest::LOAD_BYPASS_CACHE) {
2629     RemoveFromCache(key);
2630   } else {
2631     // Look in the cache for our URI, and then validate it.
2632     // XXX For now ignore aCacheKey. We will need it in the future
2633     // for correctly dealing with image load requests that are a result
2634     // of post data.
2635     if (mCache.Get(key, getter_AddRefs(entry)) && entry) {
2636       // We don't want to kick off another network load. So we ask
2637       // ValidateEntry to only do validation without creating a new proxy. If
2638       // it says that the entry isn't valid any more, we'll only use the entry
2639       // we're getting if the channel is loading from the cache anyways.
2640       //
2641       // XXX -- should this be changed? it's pretty much verbatim from the old
2642       // code, but seems nonsensical.
2643       //
2644       // Since aCanMakeNewChannel == false, we don't need to pass content policy
2645       // type/principal/etc
2646
2647       nsCOMPtr<nsILoadInfo> loadInfo = channel->LoadInfo();
2648       // if there is a loadInfo, use the right contentType, otherwise
2649       // default to the internal image type
2650       nsContentPolicyType policyType = loadInfo->InternalContentPolicyType();
2651
2652       if (ValidateEntry(entry, uri, nullptr, nullptr, nullptr, aObserver,
2653                         aLoadingDocument, requestFlags, policyType, false,
2654                         nullptr, nullptr, nullptr, corsMode, false, 0)) {
2655         request = entry->GetRequest();
2656       } else {
2657         nsCOMPtr<nsICacheInfoChannel> cacheChan(do_QueryInterface(channel));
2658         bool bUseCacheCopy;
2659
2660         if (cacheChan) {
2661           cacheChan->IsFromCache(&bUseCacheCopy);
2662         } else {
2663           bUseCacheCopy = false;
2664         }
2665
2666         if (!bUseCacheCopy) {
2667           entry = nullptr;
2668         } else {
2669           request = entry->GetRequest();
2670         }
2671       }
2672
2673       if (request && entry) {
2674         // If this entry has no proxies, its request has no reference to
2675         // the entry.
2676         if (entry->HasNoProxies()) {
2677           LOG_FUNC_WITH_PARAM(
2678               gImgLog,
2679               "imgLoader::LoadImageWithChannel() adding proxyless entry", "uri",
2680               key.URI());
2681           MOZ_ASSERT(!request->HasCacheEntry(),
2682                      "Proxyless entry's request has cache entry!");
2683           request->SetCacheEntry(entry);
2684
2685           if (mCacheTracker && entry->GetExpirationState()->IsTracked()) {
2686             mCacheTracker->MarkUsed(entry);
2687           }
2688         }
2689       }
2690     }
2691   }
2692
2693   nsCOMPtr<nsILoadGroup> loadGroup;
2694   channel->GetLoadGroup(getter_AddRefs(loadGroup));
2695
2696 #ifdef DEBUG
2697   if (aLoadingDocument) {
2698     // The load group of the channel should always match that of the
2699     // document if given. If that isn't the case, then we need to add more
2700     // plumbing to ensure we block the document as well.
2701     nsCOMPtr<nsILoadGroup> docLoadGroup =
2702         aLoadingDocument->GetDocumentLoadGroup();
2703     MOZ_ASSERT(docLoadGroup == loadGroup);
2704   }
2705 #endif
2706
2707   // Filter out any load flags not from nsIRequest
2708   requestFlags &= nsIRequest::LOAD_REQUESTMASK;
2709
2710   nsresult rv = NS_OK;
2711   if (request) {
2712     // we have this in our cache already.. cancel the current (document) load
2713
2714     // this should fire an OnStopRequest
2715     channel->Cancel(NS_ERROR_PARSED_DATA_CACHED);
2716
2717     *listener = nullptr;  // give them back a null nsIStreamListener
2718
2719     rv = CreateNewProxyForRequest(request, uri, loadGroup, aLoadingDocument,
2720                                   aObserver, requestFlags, _retval);
2721     static_cast<imgRequestProxy*>(*_retval)->NotifyListener();
2722   } else {
2723     // We use originalURI here to fulfil the imgIRequest contract on GetURI.
2724     nsCOMPtr<nsIURI> originalURI;
2725     channel->GetOriginalURI(getter_AddRefs(originalURI));
2726
2727     // XXX(seth): We should be able to just use |key| here, except that |key| is
2728     // constructed above with the *current URI* and not the *original URI*. I'm
2729     // pretty sure this is a bug, and it's preventing us from ever getting a
2730     // cache hit in LoadImageWithChannel when redirects are involved.
2731     ImageCacheKey originalURIKey(originalURI, corsMode, attrs,
2732                                  aLoadingDocument);
2733
2734     // Default to doing a principal check because we don't know who
2735     // started that load and whether their principal ended up being
2736     // inherited on the channel.
2737     NewRequestAndEntry(/* aForcePrincipalCheckForCacheEntry = */ true, this,
2738                        originalURIKey, getter_AddRefs(request),
2739                        getter_AddRefs(entry));
2740
2741     // No principal specified here, because we're not passed one.
2742     // In LoadImageWithChannel, the redirects that may have been
2743     // associated with this load would have gone through necko.
2744     // We only have the final URI in ImageLib and hence don't know
2745     // if the request went through insecure redirects.  But if it did,
2746     // the necko cache should have handled that (since all necko cache hits
2747     // including the redirects will go through content policy).  Hence, we
2748     // can set aHadInsecureRedirect to false here.
2749     rv = request->Init(originalURI, uri, /* aHadInsecureRedirect = */ false,
2750                        channel, channel, entry, aLoadingDocument, nullptr,
2751                        corsMode, nullptr);
2752     NS_ENSURE_SUCCESS(rv, rv);
2753
2754     RefPtr<ProxyListener> pl =
2755         new ProxyListener(static_cast<nsIStreamListener*>(request.get()));
2756     pl.forget(listener);
2757
2758     // Try to add the new request into the cache.
2759     PutIntoCache(originalURIKey, entry);
2760
2761     rv = CreateNewProxyForRequest(request, originalURI, loadGroup,
2762                                   aLoadingDocument, aObserver, requestFlags,
2763                                   _retval);
2764
2765     // Explicitly don't notify our proxy, because we're loading off the
2766     // network, and necko (or things called from necko, such as
2767     // imgCacheValidator) are going to call our notifications asynchronously,
2768     // and we can't make it further asynchronous because observers might rely
2769     // on imagelib completing its work between the channel's OnStartRequest and
2770     // OnStopRequest.
2771   }
2772
2773   if (NS_FAILED(rv)) {
2774     return rv;
2775   }
2776
2777   (*_retval)->AddToLoadGroup();
2778   return rv;
2779 }
2780
2781 bool imgLoader::SupportImageWithMimeType(const nsACString& aMimeType,
2782                                          AcceptedMimeTypes aAccept
2783                                          /* = AcceptedMimeTypes::IMAGES */) {
2784   nsAutoCString mimeType(aMimeType);
2785   ToLowerCase(mimeType);
2786
2787   if (aAccept == AcceptedMimeTypes::IMAGES_AND_DOCUMENTS &&
2788       mimeType.EqualsLiteral("image/svg+xml")) {
2789     return true;
2790   }
2791
2792   DecoderType type = DecoderFactory::GetDecoderType(mimeType.get());
2793   return type != DecoderType::UNKNOWN;
2794 }
2795
2796 NS_IMETHODIMP
2797 imgLoader::GetMIMETypeFromContent(nsIRequest* aRequest,
2798                                   const uint8_t* aContents, uint32_t aLength,
2799                                   nsACString& aContentType) {
2800   nsCOMPtr<nsIChannel> channel(do_QueryInterface(aRequest));
2801   if (channel) {
2802     nsCOMPtr<nsILoadInfo> loadInfo = channel->LoadInfo();
2803     if (loadInfo->GetSkipContentSniffing()) {
2804       return NS_ERROR_NOT_AVAILABLE;
2805     }
2806   }
2807
2808   nsresult rv =
2809       GetMimeTypeFromContent((const char*)aContents, aLength, aContentType);
2810   if (NS_SUCCEEDED(rv) && channel && XRE_IsParentProcess()) {
2811     if (RefPtr<mozilla::net::nsHttpChannel> httpChannel =
2812             do_QueryObject(channel)) {
2813       // If the image type pattern matching algorithm given bytes does not
2814       // return undefined, then disable the further check and allow the
2815       // response.
2816       httpChannel->DisableIsOpaqueResponseAllowedAfterSniffCheck(
2817           mozilla::net::nsHttpChannel::SnifferType::Image);
2818     }
2819   }
2820
2821   return rv;
2822 }
2823
2824 /* static */
2825 nsresult imgLoader::GetMimeTypeFromContent(const char* aContents,
2826                                            uint32_t aLength,
2827                                            nsACString& aContentType) {
2828   nsAutoCString detected;
2829
2830   /* Is it a GIF? */
2831   if (aLength >= 6 &&
2832       (!strncmp(aContents, "GIF87a", 6) || !strncmp(aContents, "GIF89a", 6))) {
2833     aContentType.AssignLiteral(IMAGE_GIF);
2834
2835     /* or a PNG? */
2836   } else if (aLength >= 8 && ((unsigned char)aContents[0] == 0x89 &&
2837                               (unsigned char)aContents[1] == 0x50 &&
2838                               (unsigned char)aContents[2] == 0x4E &&
2839                               (unsigned char)aContents[3] == 0x47 &&
2840                               (unsigned char)aContents[4] == 0x0D &&
2841                               (unsigned char)aContents[5] == 0x0A &&
2842                               (unsigned char)aContents[6] == 0x1A &&
2843                               (unsigned char)aContents[7] == 0x0A)) {
2844     aContentType.AssignLiteral(IMAGE_PNG);
2845
2846     /* maybe a JPEG (JFIF)? */
2847     /* JFIF files start with SOI APP0 but older files can start with SOI DQT
2848      * so we test for SOI followed by any marker, i.e. FF D8 FF
2849      * this will also work for SPIFF JPEG files if they appear in the future.
2850      *
2851      * (JFIF is 0XFF 0XD8 0XFF 0XE0 <skip 2> 0X4A 0X46 0X49 0X46 0X00)
2852      */
2853   } else if (aLength >= 3 && ((unsigned char)aContents[0]) == 0xFF &&
2854              ((unsigned char)aContents[1]) == 0xD8 &&
2855              ((unsigned char)aContents[2]) == 0xFF) {
2856     aContentType.AssignLiteral(IMAGE_JPEG);
2857
2858     /* or how about ART? */
2859     /* ART begins with JG (4A 47). Major version offset 2.
2860      * Minor version offset 3. Offset 4 must be nullptr.
2861      */
2862   } else if (aLength >= 5 && ((unsigned char)aContents[0]) == 0x4a &&
2863              ((unsigned char)aContents[1]) == 0x47 &&
2864              ((unsigned char)aContents[4]) == 0x00) {
2865     aContentType.AssignLiteral(IMAGE_ART);
2866
2867   } else if (aLength >= 2 && !strncmp(aContents, "BM", 2)) {
2868     aContentType.AssignLiteral(IMAGE_BMP);
2869
2870     // ICOs always begin with a 2-byte 0 followed by a 2-byte 1.
2871     // CURs begin with 2-byte 0 followed by 2-byte 2.
2872   } else if (aLength >= 4 && (!memcmp(aContents, "\000\000\001\000", 4) ||
2873                               !memcmp(aContents, "\000\000\002\000", 4))) {
2874     aContentType.AssignLiteral(IMAGE_ICO);
2875
2876     // WebPs always begin with RIFF, a 32-bit length, and WEBP.
2877   } else if (aLength >= 12 && !memcmp(aContents, "RIFF", 4) &&
2878              !memcmp(aContents + 8, "WEBP", 4)) {
2879     aContentType.AssignLiteral(IMAGE_WEBP);
2880
2881   } else if (MatchesMP4(reinterpret_cast<const uint8_t*>(aContents), aLength,
2882                         detected) &&
2883              detected.Equals(IMAGE_AVIF)) {
2884     aContentType.AssignLiteral(IMAGE_AVIF);
2885   } else if ((aLength >= 2 && !memcmp(aContents, "\xFF\x0A", 2)) ||
2886              (aLength >= 12 &&
2887               !memcmp(aContents, "\x00\x00\x00\x0CJXL \x0D\x0A\x87\x0A", 12))) {
2888     // Each version is for containerless and containerful files respectively.
2889     aContentType.AssignLiteral(IMAGE_JXL);
2890   } else {
2891     /* none of the above?  I give up */
2892     return NS_ERROR_NOT_AVAILABLE;
2893   }
2894
2895   return NS_OK;
2896 }
2897
2898 /**
2899  * proxy stream listener class used to handle multipart/x-mixed-replace
2900  */
2901
2902 #include "nsIRequest.h"
2903 #include "nsIStreamConverterService.h"
2904
2905 NS_IMPL_ISUPPORTS(ProxyListener, nsIStreamListener,
2906                   nsIThreadRetargetableStreamListener, nsIRequestObserver)
2907
2908 ProxyListener::ProxyListener(nsIStreamListener* dest) : mDestListener(dest) {}
2909
2910 ProxyListener::~ProxyListener() = default;
2911
2912 /** nsIRequestObserver methods **/
2913
2914 NS_IMETHODIMP
2915 ProxyListener::OnStartRequest(nsIRequest* aRequest) {
2916   if (!mDestListener) {
2917     return NS_ERROR_FAILURE;
2918   }
2919
2920   nsCOMPtr<nsIChannel> channel(do_QueryInterface(aRequest));
2921   if (channel) {
2922     // We need to set the initiator type for the image load
2923     nsCOMPtr<nsITimedChannel> timedChannel = do_QueryInterface(channel);
2924     if (timedChannel) {
2925       nsAutoString type;
2926       timedChannel->GetInitiatorType(type);
2927       if (type.IsEmpty()) {
2928         timedChannel->SetInitiatorType(u"img"_ns);
2929       }
2930     }
2931
2932     nsAutoCString contentType;
2933     nsresult rv = channel->GetContentType(contentType);
2934
2935     if (!contentType.IsEmpty()) {
2936       /* If multipart/x-mixed-replace content, we'll insert a MIME decoder
2937          in the pipeline to handle the content and pass it along to our
2938          original listener.
2939        */
2940       if ("multipart/x-mixed-replace"_ns.Equals(contentType)) {
2941         nsCOMPtr<nsIStreamConverterService> convServ(
2942             do_GetService("@mozilla.org/streamConverters;1", &rv));
2943         if (NS_SUCCEEDED(rv)) {
2944           nsCOMPtr<nsIStreamListener> toListener(mDestListener);
2945           nsCOMPtr<nsIStreamListener> fromListener;
2946
2947           rv = convServ->AsyncConvertData("multipart/x-mixed-replace", "*/*",
2948                                           toListener, nullptr,
2949                                           getter_AddRefs(fromListener));
2950           if (NS_SUCCEEDED(rv)) {
2951             mDestListener = fromListener;
2952           }
2953         }
2954       }
2955     }
2956   }
2957
2958   return mDestListener->OnStartRequest(aRequest);
2959 }
2960
2961 NS_IMETHODIMP
2962 ProxyListener::OnStopRequest(nsIRequest* aRequest, nsresult status) {
2963   if (!mDestListener) {
2964     return NS_ERROR_FAILURE;
2965   }
2966
2967   return mDestListener->OnStopRequest(aRequest, status);
2968 }
2969
2970 /** nsIStreamListener methods **/
2971
2972 NS_IMETHODIMP
2973 ProxyListener::OnDataAvailable(nsIRequest* aRequest, nsIInputStream* inStr,
2974                                uint64_t sourceOffset, uint32_t count) {
2975   if (!mDestListener) {
2976     return NS_ERROR_FAILURE;
2977   }
2978
2979   return mDestListener->OnDataAvailable(aRequest, inStr, sourceOffset, count);
2980 }
2981
2982 /** nsThreadRetargetableStreamListener methods **/
2983 NS_IMETHODIMP
2984 ProxyListener::CheckListenerChain() {
2985   NS_ASSERTION(NS_IsMainThread(), "Should be on the main thread!");
2986   nsresult rv = NS_OK;
2987   nsCOMPtr<nsIThreadRetargetableStreamListener> retargetableListener =
2988       do_QueryInterface(mDestListener, &rv);
2989   if (retargetableListener) {
2990     rv = retargetableListener->CheckListenerChain();
2991   }
2992   MOZ_LOG(
2993       gImgLog, LogLevel::Debug,
2994       ("ProxyListener::CheckListenerChain %s [this=%p listener=%p rv=%" PRIx32
2995        "]",
2996        (NS_SUCCEEDED(rv) ? "success" : "failure"), this,
2997        (nsIStreamListener*)mDestListener, static_cast<uint32_t>(rv)));
2998   return rv;
2999 }
3000
3001 /**
3002  * http validate class.  check a channel for a 304
3003  */
3004
3005 NS_IMPL_ISUPPORTS(imgCacheValidator, nsIStreamListener, nsIRequestObserver,
3006                   nsIThreadRetargetableStreamListener, nsIChannelEventSink,
3007                   nsIInterfaceRequestor, nsIAsyncVerifyRedirectCallback)
3008
3009 imgCacheValidator::imgCacheValidator(nsProgressNotificationProxy* progress,
3010                                      imgLoader* loader, imgRequest* request,
3011                                      Document* aDocument,
3012                                      uint64_t aInnerWindowId,
3013                                      bool forcePrincipalCheckForCacheEntry)
3014     : mProgressProxy(progress),
3015       mRequest(request),
3016       mDocument(aDocument),
3017       mInnerWindowId(aInnerWindowId),
3018       mImgLoader(loader),
3019       mHadInsecureRedirect(false) {
3020   NewRequestAndEntry(forcePrincipalCheckForCacheEntry, loader,
3021                      mRequest->CacheKey(), getter_AddRefs(mNewRequest),
3022                      getter_AddRefs(mNewEntry));
3023 }
3024
3025 imgCacheValidator::~imgCacheValidator() {
3026   if (mRequest) {
3027     // If something went wrong, and we never unblocked the requests waiting on
3028     // validation, now is our last chance. We will cancel the new request and
3029     // switch the waiting proxies to it.
3030     UpdateProxies(/* aCancelRequest */ true, /* aSyncNotify */ false);
3031   }
3032 }
3033
3034 void imgCacheValidator::AddProxy(imgRequestProxy* aProxy) {
3035   // aProxy needs to be in the loadgroup since we're validating from
3036   // the network.
3037   aProxy->AddToLoadGroup();
3038
3039   mProxies.AppendElement(aProxy);
3040 }
3041
3042 void imgCacheValidator::RemoveProxy(imgRequestProxy* aProxy) {
3043   mProxies.RemoveElement(aProxy);
3044 }
3045
3046 void imgCacheValidator::UpdateProxies(bool aCancelRequest, bool aSyncNotify) {
3047   MOZ_ASSERT(mRequest);
3048
3049   // Clear the validator before updating the proxies. The notifications may
3050   // clone an existing request, and its state could be inconsistent.
3051   mRequest->SetValidator(nullptr);
3052   mRequest = nullptr;
3053
3054   // If an error occurred, we will want to cancel the new request, and make the
3055   // validating proxies point to it. Any proxies still bound to the original
3056   // request which are not validating should remain untouched.
3057   if (aCancelRequest) {
3058     MOZ_ASSERT(mNewRequest);
3059     mNewRequest->CancelAndAbort(NS_BINDING_ABORTED);
3060   }
3061
3062   // We have finished validating the request, so we can safely take ownership
3063   // of the proxy list. imgRequestProxy::SyncNotifyListener can mutate the list
3064   // if imgRequestProxy::CancelAndForgetObserver is called by its owner. Note
3065   // that any potential notifications should still be suppressed in
3066   // imgRequestProxy::ChangeOwner because we haven't cleared the validating
3067   // flag yet, and thus they will remain deferred.
3068   AutoTArray<RefPtr<imgRequestProxy>, 4> proxies(std::move(mProxies));
3069
3070   for (auto& proxy : proxies) {
3071     // First update the state of all proxies before notifying any of them
3072     // to ensure a consistent state (e.g. in case the notification causes
3073     // other proxies to be touched indirectly.)
3074     MOZ_ASSERT(proxy->IsValidating());
3075     MOZ_ASSERT(proxy->NotificationsDeferred(),
3076                "Proxies waiting on cache validation should be "
3077                "deferring notifications!");
3078     if (mNewRequest) {
3079       proxy->ChangeOwner(mNewRequest);
3080     }
3081     proxy->ClearValidating();
3082   }
3083
3084   mNewRequest = nullptr;
3085   mNewEntry = nullptr;
3086
3087   for (auto& proxy : proxies) {
3088     if (aSyncNotify) {
3089       // Notify synchronously, because the caller knows we are already in an
3090       // asynchronously-called function (e.g. OnStartRequest).
3091       proxy->SyncNotifyListener();
3092     } else {
3093       // Notify asynchronously, because the caller does not know our current
3094       // call state (e.g. ~imgCacheValidator).
3095       proxy->NotifyListener();
3096     }
3097   }
3098 }
3099
3100 /** nsIRequestObserver methods **/
3101
3102 NS_IMETHODIMP
3103 imgCacheValidator::OnStartRequest(nsIRequest* aRequest) {
3104   // We may be holding on to a document, so ensure that it's released.
3105   RefPtr<Document> document = mDocument.forget();
3106
3107   // If for some reason we don't still have an existing request (probably
3108   // because OnStartRequest got delivered more than once), just bail.
3109   if (!mRequest) {
3110     MOZ_ASSERT_UNREACHABLE("OnStartRequest delivered more than once?");
3111     aRequest->CancelWithReason(NS_BINDING_ABORTED,
3112                                "OnStartRequest delivered more than once?"_ns);
3113     return NS_ERROR_FAILURE;
3114   }
3115
3116   // If this request is coming from cache and has the same URI as our
3117   // imgRequest, the request all our proxies are pointing at is valid, and all
3118   // we have to do is tell them to notify their listeners.
3119   nsCOMPtr<nsICacheInfoChannel> cacheChan(do_QueryInterface(aRequest));
3120   nsCOMPtr<nsIChannel> channel(do_QueryInterface(aRequest));
3121   if (cacheChan && channel) {
3122     bool isFromCache = false;
3123     cacheChan->IsFromCache(&isFromCache);
3124
3125     nsCOMPtr<nsIURI> channelURI;
3126     channel->GetURI(getter_AddRefs(channelURI));
3127
3128     nsCOMPtr<nsIURI> finalURI;
3129     mRequest->GetFinalURI(getter_AddRefs(finalURI));
3130
3131     bool sameURI = false;
3132     if (channelURI && finalURI) {
3133       channelURI->Equals(finalURI, &sameURI);
3134     }
3135
3136     if (isFromCache && sameURI) {
3137       // We don't need to load this any more.
3138       aRequest->CancelWithReason(NS_BINDING_ABORTED,
3139                                  "imgCacheValidator::OnStartRequest"_ns);
3140       mNewRequest = nullptr;
3141
3142       // Clear the validator before updating the proxies. The notifications may
3143       // clone an existing request, and its state could be inconsistent.
3144       mRequest->SetLoadId(document);
3145       mRequest->SetInnerWindowID(mInnerWindowId);
3146       UpdateProxies(/* aCancelRequest */ false, /* aSyncNotify */ true);
3147       return NS_OK;
3148     }
3149   }
3150
3151   // We can't load out of cache. We have to create a whole new request for the
3152   // data that's coming in off the channel.
3153   nsCOMPtr<nsIURI> uri;
3154   mRequest->GetURI(getter_AddRefs(uri));
3155
3156   LOG_MSG_WITH_PARAM(gImgLog,
3157                      "imgCacheValidator::OnStartRequest creating new request",
3158                      "uri", uri);
3159
3160   CORSMode corsmode = mRequest->GetCORSMode();
3161   nsCOMPtr<nsIReferrerInfo> referrerInfo = mRequest->GetReferrerInfo();
3162   nsCOMPtr<nsIPrincipal> triggeringPrincipal =
3163       mRequest->GetTriggeringPrincipal();
3164
3165   // Doom the old request's cache entry
3166   mRequest->RemoveFromCache();
3167
3168   // We use originalURI here to fulfil the imgIRequest contract on GetURI.
3169   nsCOMPtr<nsIURI> originalURI;
3170   channel->GetOriginalURI(getter_AddRefs(originalURI));
3171   nsresult rv = mNewRequest->Init(originalURI, uri, mHadInsecureRedirect,
3172                                   aRequest, channel, mNewEntry, document,
3173                                   triggeringPrincipal, corsmode, referrerInfo);
3174   if (NS_FAILED(rv)) {
3175     UpdateProxies(/* aCancelRequest */ true, /* aSyncNotify */ true);
3176     return rv;
3177   }
3178
3179   mDestListener = new ProxyListener(mNewRequest);
3180
3181   // Try to add the new request into the cache. Note that the entry must be in
3182   // the cache before the proxies' ownership changes, because adding a proxy
3183   // changes the caching behaviour for imgRequests.
3184   mImgLoader->PutIntoCache(mNewRequest->CacheKey(), mNewEntry);
3185   UpdateProxies(/* aCancelRequest */ false, /* aSyncNotify */ true);
3186   return mDestListener->OnStartRequest(aRequest);
3187 }
3188
3189 NS_IMETHODIMP
3190 imgCacheValidator::OnStopRequest(nsIRequest* aRequest, nsresult status) {
3191   // Be sure we've released the document that we may have been holding on to.
3192   mDocument = nullptr;
3193
3194   if (!mDestListener) {
3195     return NS_OK;
3196   }
3197
3198   return mDestListener->OnStopRequest(aRequest, status);
3199 }
3200
3201 /** nsIStreamListener methods **/
3202
3203 NS_IMETHODIMP
3204 imgCacheValidator::OnDataAvailable(nsIRequest* aRequest, nsIInputStream* inStr,
3205                                    uint64_t sourceOffset, uint32_t count) {
3206   if (!mDestListener) {
3207     // XXX see bug 113959
3208     uint32_t _retval;
3209     inStr->ReadSegments(NS_DiscardSegment, nullptr, count, &_retval);
3210     return NS_OK;
3211   }
3212
3213   return mDestListener->OnDataAvailable(aRequest, inStr, sourceOffset, count);
3214 }
3215
3216 /** nsIThreadRetargetableStreamListener methods **/
3217
3218 NS_IMETHODIMP
3219 imgCacheValidator::CheckListenerChain() {
3220   NS_ASSERTION(NS_IsMainThread(), "Should be on the main thread!");
3221   nsresult rv = NS_OK;
3222   nsCOMPtr<nsIThreadRetargetableStreamListener> retargetableListener =
3223       do_QueryInterface(mDestListener, &rv);
3224   if (retargetableListener) {
3225     rv = retargetableListener->CheckListenerChain();
3226   }
3227   MOZ_LOG(
3228       gImgLog, LogLevel::Debug,
3229       ("[this=%p] imgCacheValidator::CheckListenerChain -- rv %" PRId32 "=%s",
3230        this, static_cast<uint32_t>(rv),
3231        NS_SUCCEEDED(rv) ? "succeeded" : "failed"));
3232   return rv;
3233 }
3234
3235 /** nsIInterfaceRequestor methods **/
3236
3237 NS_IMETHODIMP
3238 imgCacheValidator::GetInterface(const nsIID& aIID, void** aResult) {
3239   if (aIID.Equals(NS_GET_IID(nsIChannelEventSink))) {
3240     return QueryInterface(aIID, aResult);
3241   }
3242
3243   return mProgressProxy->GetInterface(aIID, aResult);
3244 }
3245
3246 // These functions are materially the same as the same functions in imgRequest.
3247 // We duplicate them because we're verifying whether cache loads are necessary,
3248 // not unconditionally loading.
3249
3250 /** nsIChannelEventSink methods **/
3251 NS_IMETHODIMP
3252 imgCacheValidator::AsyncOnChannelRedirect(
3253     nsIChannel* oldChannel, nsIChannel* newChannel, uint32_t flags,
3254     nsIAsyncVerifyRedirectCallback* callback) {
3255   // Note all cache information we get from the old channel.
3256   mNewRequest->SetCacheValidation(mNewEntry, oldChannel);
3257
3258   // If the previous URI is a non-HTTPS URI, record that fact for later use by
3259   // security code, which needs to know whether there is an insecure load at any
3260   // point in the redirect chain.
3261   nsCOMPtr<nsIURI> oldURI;
3262   bool schemeLocal = false;
3263   if (NS_FAILED(oldChannel->GetURI(getter_AddRefs(oldURI))) ||
3264       NS_FAILED(NS_URIChainHasFlags(
3265           oldURI, nsIProtocolHandler::URI_IS_LOCAL_RESOURCE, &schemeLocal)) ||
3266       (!oldURI->SchemeIs("https") && !oldURI->SchemeIs("chrome") &&
3267        !schemeLocal)) {
3268     mHadInsecureRedirect = true;
3269   }
3270
3271   // Prepare for callback
3272   mRedirectCallback = callback;
3273   mRedirectChannel = newChannel;
3274
3275   return mProgressProxy->AsyncOnChannelRedirect(oldChannel, newChannel, flags,
3276                                                 this);
3277 }
3278
3279 NS_IMETHODIMP
3280 imgCacheValidator::OnRedirectVerifyCallback(nsresult aResult) {
3281   // If we've already been told to abort, just do so.
3282   if (NS_FAILED(aResult)) {
3283     mRedirectCallback->OnRedirectVerifyCallback(aResult);
3284     mRedirectCallback = nullptr;
3285     mRedirectChannel = nullptr;
3286     return NS_OK;
3287   }
3288
3289   // make sure we have a protocol that returns data rather than opens
3290   // an external application, e.g. mailto:
3291   nsCOMPtr<nsIURI> uri;
3292   mRedirectChannel->GetURI(getter_AddRefs(uri));
3293
3294   nsresult result = NS_OK;
3295
3296   if (nsContentUtils::IsExternalProtocol(uri)) {
3297     result = NS_ERROR_ABORT;
3298   }
3299
3300   mRedirectCallback->OnRedirectVerifyCallback(result);
3301   mRedirectCallback = nullptr;
3302   mRedirectChannel = nullptr;
3303   return NS_OK;
3304 }