image/ImageFactory.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   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 #include "ImageFactory.h"
   8
   9 #include <algorithm>
  10
  11 #include "mozilla/Likely.h"
  12
  13 #include "nsIChannel.h"
  14 #include "nsIFileChannel.h"
  15 #include "nsIObserverService.h"
  16 #include "nsIFile.h"
  17 #include "nsMimeTypes.h"
  18 #include "nsIRequest.h"
  19
  20 #include "MultipartImage.h"
  21 #include "RasterImage.h"
  22 #include "VectorImage.h"
  23 #include "Image.h"
  24 #include "nsMediaFragmentURIParser.h"
  25 #include "nsContentUtils.h"
  26
  27 #include "mozilla/SchedulerGroup.h"
  28 #include "mozilla/StaticPrefs_image.h"
  29 #include "mozilla/ProfilerMarkers.h"
  30
  31 namespace mozilla {
  32 namespace image {
  33
  34 /*static*/
  35 void ImageFactory::Initialize() {}
  36
  37 static uint32_t ComputeImageFlags(nsIURI* uri, const nsCString& aMimeType,
  38                                   bool isMultiPart) {
  39   // We default to the static globals.
  40   bool isDiscardable = StaticPrefs::image_mem_discardable();
  41   bool doDecodeImmediately = StaticPrefs::image_decode_immediately_enabled();
  42
  43   // We want UI to be as snappy as possible and not to flicker. Disable
  44   // discarding for chrome URLS.
  45   if (uri->SchemeIs("chrome")) {
  46     isDiscardable = false;
  47   }
  48
  49   // We don't want resources like the "loading" icon to be discardable either.
  50   if (uri->SchemeIs("resource")) {
  51     isDiscardable = false;
  52   }
  53
  54   // For multipart/x-mixed-replace, we basically want a direct channel to the
  55   // decoder. Disable everything for this case.
  56   if (isMultiPart) {
  57     isDiscardable = false;
  58   }
  59
  60   // We have all the information we need.
  61   uint32_t imageFlags = Image::INIT_FLAG_NONE;
  62   if (isDiscardable) {
  63     imageFlags |= Image::INIT_FLAG_DISCARDABLE;
  64   }
  65   if (doDecodeImmediately) {
  66     imageFlags |= Image::INIT_FLAG_DECODE_IMMEDIATELY;
  67   }
  68   if (isMultiPart) {
  69     imageFlags |= Image::INIT_FLAG_TRANSIENT;
  70   }
  71
  72   // Synchronously decode metadata (including size) if we have a data URI since
  73   // the data is immediately available.
  74   if (uri->SchemeIs("data")) {
  75     imageFlags |= Image::INIT_FLAG_SYNC_LOAD;
  76   }
  77
  78   return imageFlags;
  79 }
  80
  81 #ifdef DEBUG
  82 static void NotifyImageLoading(nsIURI* aURI) {
  83   if (!NS_IsMainThread()) {
  84     nsCOMPtr<nsIURI> uri(aURI);
  85     nsCOMPtr<nsIRunnable> ev = NS_NewRunnableFunction(
  86         "NotifyImageLoading", [uri]() -> void { NotifyImageLoading(uri); });
  87     SchedulerGroup::Dispatch(TaskCategory::Other, ev.forget());
  88     return;
  89   }
  90
  91   nsCOMPtr<nsIObserverService> obs = services::GetObserverService();
  92   NS_WARNING_ASSERTION(obs, "Can't get an observer service handle");
  93   if (obs) {
  94     nsAutoCString spec;
  95     aURI->GetSpec(spec);
  96     obs->NotifyObservers(nullptr, "image-loading",
  97                          NS_ConvertUTF8toUTF16(spec).get());
  98   }
  99 }
 100 #endif
 101
 102 /* static */
 103 already_AddRefed<Image> ImageFactory::CreateImage(
 104     nsIRequest* aRequest, ProgressTracker* aProgressTracker,
 105     const nsCString& aMimeType, nsIURI* aURI, bool aIsMultiPart,
 106     uint32_t aInnerWindowId) {
 107   // Compute the image's initialization flags.
 108   uint32_t imageFlags = ComputeImageFlags(aURI, aMimeType, aIsMultiPart);
 109
 110 #ifdef DEBUG
 111   // Record the image load for startup performance testing.
 112   if (aURI->SchemeIs("resource") || aURI->SchemeIs("chrome")) {
 113     NotifyImageLoading(aURI);
 114   }
 115 #endif
 116
 117   if (profiler_can_accept_markers()) {
 118     static const size_t sMaxTruncatedLength = 1024;
 119     nsAutoCString spec;
 120     aURI->GetSpec(spec);
 121     if (spec.Length() >= sMaxTruncatedLength) {
 122       spec.Truncate(sMaxTruncatedLength);
 123     }
 124     PROFILER_MARKER_TEXT("Image Load", GRAPHICS,
 125                          MarkerInnerWindowId(aInnerWindowId), spec);
 126   }
 127
 128   // Select the type of image to create based on MIME type.
 129   if (aMimeType.EqualsLiteral(IMAGE_SVG_XML)) {
 130     return CreateVectorImage(aRequest, aProgressTracker, aMimeType, aURI,
 131                              imageFlags, aInnerWindowId);
 132   } else {
 133     return CreateRasterImage(aRequest, aProgressTracker, aMimeType, aURI,
 134                              imageFlags, aInnerWindowId);
 135   }
 136 }
 137
 138 // Marks an image as having an error before returning it.
 139 template <typename T>
 140 static already_AddRefed<Image> BadImage(const char* aMessage,
 141                                         RefPtr<T>& aImage) {
 142   aImage->SetHasError();
 143   return aImage.forget();
 144 }
 145
 146 /* static */
 147 already_AddRefed<Image> ImageFactory::CreateAnonymousImage(
 148     const nsCString& aMimeType, uint32_t aSizeHint /* = 0 */) {
 149   nsresult rv;
 150
 151   RefPtr<RasterImage> newImage = new RasterImage();
 152
 153   RefPtr<ProgressTracker> newTracker = new ProgressTracker();
 154   newTracker->SetImage(newImage);
 155   newImage->SetProgressTracker(newTracker);
 156
 157   rv = newImage->Init(aMimeType.get(), Image::INIT_FLAG_SYNC_LOAD);
 158   if (NS_FAILED(rv)) {
 159     return BadImage("RasterImage::Init failed", newImage);
 160   }
 161
 162   rv = newImage->SetSourceSizeHint(aSizeHint);
 163   if (NS_FAILED(rv)) {
 164     return BadImage("RasterImage::SetSourceSizeHint failed", newImage);
 165   }
 166
 167   return newImage.forget();
 168 }
 169
 170 /* static */
 171 already_AddRefed<MultipartImage> ImageFactory::CreateMultipartImage(
 172     Image* aFirstPart, ProgressTracker* aProgressTracker) {
 173   MOZ_ASSERT(aFirstPart);
 174   MOZ_ASSERT(aProgressTracker);
 175
 176   RefPtr<MultipartImage> newImage = new MultipartImage(aFirstPart);
 177   aProgressTracker->SetImage(newImage);
 178   newImage->SetProgressTracker(aProgressTracker);
 179
 180   newImage->Init();
 181
 182   return newImage.forget();
 183 }
 184
 185 int32_t SaturateToInt32(int64_t val) {
 186   if (val > INT_MAX) {
 187     return INT_MAX;
 188   }
 189   if (val < INT_MIN) {
 190     return INT_MIN;
 191   }
 192
 193   return static_cast<int32_t>(val);
 194 }
 195
 196 uint32_t GetContentSize(nsIRequest* aRequest) {
 197   nsCOMPtr<nsIChannel> channel(do_QueryInterface(aRequest));
 198   if (channel) {
 199     int64_t size;
 200     nsresult rv = channel->GetContentLength(&size);
 201     if (NS_SUCCEEDED(rv)) {
 202       return std::max(SaturateToInt32(size), 0);
 203     }
 204   }
 205
 206   // Use the file size as a size hint for file channels.
 207   nsCOMPtr<nsIFileChannel> fileChannel(do_QueryInterface(aRequest));
 208   if (fileChannel) {
 209     nsCOMPtr<nsIFile> file;
 210     nsresult rv = fileChannel->GetFile(getter_AddRefs(file));
 211     if (NS_SUCCEEDED(rv)) {
 212       int64_t filesize;
 213       rv = file->GetFileSize(&filesize);
 214       if (NS_SUCCEEDED(rv)) {
 215         return std::max(SaturateToInt32(filesize), 0);
 216       }
 217     }
 218   }
 219
 220   // Fallback - neither http nor file. We'll use dynamic allocation.
 221   return 0;
 222 }
 223
 224 /* static */
 225 already_AddRefed<Image> ImageFactory::CreateRasterImage(
 226     nsIRequest* aRequest, ProgressTracker* aProgressTracker,
 227     const nsCString& aMimeType, nsIURI* aURI, uint32_t aImageFlags,
 228     uint32_t aInnerWindowId) {
 229   MOZ_ASSERT(aProgressTracker);
 230
 231   nsresult rv;
 232
 233   RefPtr<RasterImage> newImage = new RasterImage(aURI);
 234   aProgressTracker->SetImage(newImage);
 235   newImage->SetProgressTracker(aProgressTracker);
 236
 237   rv = newImage->Init(aMimeType.get(), aImageFlags);
 238   if (NS_FAILED(rv)) {
 239     return BadImage("RasterImage::Init failed", newImage);
 240   }
 241
 242   newImage->SetInnerWindowID(aInnerWindowId);
 243
 244   rv = newImage->SetSourceSizeHint(GetContentSize(aRequest));
 245   if (NS_FAILED(rv)) {
 246     return BadImage("RasterImage::SetSourceSizeHint failed", newImage);
 247   }
 248
 249   return newImage.forget();
 250 }
 251
 252 /* static */
 253 already_AddRefed<Image> ImageFactory::CreateVectorImage(
 254     nsIRequest* aRequest, ProgressTracker* aProgressTracker,
 255     const nsCString& aMimeType, nsIURI* aURI, uint32_t aImageFlags,
 256     uint32_t aInnerWindowId) {
 257   MOZ_ASSERT(aProgressTracker);
 258
 259   nsresult rv;
 260
 261   RefPtr<VectorImage> newImage = new VectorImage(aURI);
 262   aProgressTracker->SetImage(newImage);
 263   newImage->SetProgressTracker(aProgressTracker);
 264
 265   rv = newImage->Init(aMimeType.get(), aImageFlags);
 266   if (NS_FAILED(rv)) {
 267     return BadImage("VectorImage::Init failed", newImage);
 268   }
 269
 270   newImage->SetInnerWindowID(aInnerWindowId);
 271
 272   rv = newImage->OnStartRequest(aRequest);
 273   if (NS_FAILED(rv)) {
 274     return BadImage("VectorImage::OnStartRequest failed", newImage);
 275   }
 276
 277   return newImage.forget();
 278 }
 279
 280 }  // namespace image
 281 }  // namespace mozilla