DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Implementation

Mercurial (d96ee8115c5a)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef nsOfflineCacheUpdate_h__
#define nsOfflineCacheUpdate_h__

#include "nsIOfflineCacheUpdate.h"

#include "nsAutoPtr.h"
#include "nsCOMArray.h"
#include "nsCOMPtr.h"
#include "nsIChannelEventSink.h"
#include "nsIDOMDocument.h"
#include "nsIDOMNode.h"
#include "nsIInterfaceRequestor.h"
#include "nsIMutableArray.h"
#include "nsIObserver.h"
#include "nsIObserverService.h"
#include "nsIApplicationCache.h"
#include "nsIRequestObserver.h"
#include "nsIRunnable.h"
#include "nsIStreamListener.h"
#include "nsIURI.h"
#include "nsIWebProgressListener.h"
#include "nsClassHashtable.h"
#include "nsString.h"
#include "nsTArray.h"
#include "nsWeakReference.h"
#include "nsICryptoHash.h"
#include "mozilla/Attributes.h"
#include "mozilla/WeakPtr.h"
#include "nsTHashtable.h"
#include "nsHashKeys.h"

class nsOfflineCacheUpdate;

class nsOfflineCacheUpdateItem : public nsIStreamListener,
                                 public nsIRunnable,
                                 public nsIInterfaceRequestor,
                                 public nsIChannelEventSink {
 public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIREQUESTOBSERVER
  NS_DECL_NSISTREAMLISTENER
  NS_DECL_NSIRUNNABLE
  NS_DECL_NSIINTERFACEREQUESTOR
  NS_DECL_NSICHANNELEVENTSINK

  nsOfflineCacheUpdateItem(nsIURI *aURI, nsIURI *aReferrerURI,
                           nsIPrincipal *aLoadingPrincipal,
                           nsIApplicationCache *aApplicationCache,
                           nsIApplicationCache *aPreviousApplicationCache,
                           uint32_t aType, uint32_t aLoadFlags);

  nsCOMPtr<nsIURI> mURI;
  nsCOMPtr<nsIURI> mReferrerURI;
  nsCOMPtr<nsIPrincipal> mLoadingPrincipal;
  nsCOMPtr<nsIApplicationCache> mApplicationCache;
  nsCOMPtr<nsIApplicationCache> mPreviousApplicationCache;
  nsCString mCacheKey;
  uint32_t mItemType;
  uint32_t mLoadFlags;

  nsresult OpenChannel(nsOfflineCacheUpdate *aUpdate);
  nsresult Cancel();
  nsresult GetRequestSucceeded(bool *succeeded);

  bool IsInProgress();
  bool IsScheduled();
  bool IsCompleted();

  nsresult GetStatus(uint16_t *aStatus);

 private:
  enum LoadStatus : uint16_t {
    UNINITIALIZED = 0U,
    REQUESTED = 1U,
    RECEIVING = 2U,
    LOADED = 3U
  };

  RefPtr<nsOfflineCacheUpdate> mUpdate;
  nsCOMPtr<nsIChannel> mChannel;
  uint16_t mState;

 protected:
  virtual ~nsOfflineCacheUpdateItem();

  int64_t mBytesRead;
};

class nsOfflineManifestItem : public nsOfflineCacheUpdateItem {
 public:
  NS_DECL_NSISTREAMLISTENER
  NS_DECL_NSIREQUESTOBSERVER

  nsOfflineManifestItem(nsIURI *aURI, nsIURI *aReferrerURI,
                        nsIPrincipal *aLoadingPrincipal,
                        nsIApplicationCache *aApplicationCache,
                        nsIApplicationCache *aPreviousApplicationCache);
  virtual ~nsOfflineManifestItem();

  nsCOMArray<nsIURI> &GetExplicitURIs() { return mExplicitURIs; }
  nsCOMArray<nsIURI> &GetAnonymousURIs() { return mAnonymousURIs; }
  nsCOMArray<nsIURI> &GetFallbackURIs() { return mFallbackURIs; }

  nsTArray<nsCString> &GetOpportunisticNamespaces() {
    return mOpportunisticNamespaces;
  }
  nsIArray *GetNamespaces() { return mNamespaces.get(); }

  bool ParseSucceeded() {
    return (mParserState != PARSE_INIT && mParserState != PARSE_ERROR);
  }
  bool NeedsUpdate() { return mParserState != PARSE_INIT && mNeedsUpdate; }

  void GetManifestHash(nsCString &aManifestHash) {
    aManifestHash = mManifestHashValue;
  }

 private:
  static nsresult ReadManifest(nsIInputStream *aInputStream, void *aClosure,
                               const char *aFromSegment, uint32_t aOffset,
                               uint32_t aCount, uint32_t *aBytesConsumed);

  nsresult AddNamespace(uint32_t namespaceType, const nsCString &namespaceSpec,
                        const nsCString &data);

  nsresult HandleManifestLine(const nsCString::const_iterator &aBegin,
                              const nsCString::const_iterator &aEnd);

  /**
   * Saves "offline-manifest-hash" meta data from the old offline cache
   * token to mOldManifestHashValue member to be compared on
   * successfull load.
   */
  nsresult GetOldManifestContentHash(nsIRequest *aRequest);
  /**
   * This method setups the mNeedsUpdate to false when hash value
   * of the just downloaded manifest file is the same as stored in cache's
   * "offline-manifest-hash" meta data. Otherwise stores the new value
   * to this meta data.
   */
  nsresult CheckNewManifestContentHash(nsIRequest *aRequest);

  void ReadStrictFileOriginPolicyPref();

  enum {
    PARSE_INIT,
    PARSE_CACHE_ENTRIES,
    PARSE_FALLBACK_ENTRIES,
    PARSE_BYPASS_ENTRIES,
    PARSE_UNKNOWN_SECTION,
    PARSE_ERROR
  } mParserState;

  nsCString mReadBuf;

  nsCOMArray<nsIURI> mExplicitURIs;
  nsCOMArray<nsIURI> mAnonymousURIs;
  nsCOMArray<nsIURI> mFallbackURIs;

  // All opportunistic caching namespaces.  Used to decide whether
  // to include previously-opportunistically-cached entries.
  nsTArray<nsCString> mOpportunisticNamespaces;

  // Array of nsIApplicationCacheNamespace objects specified by the
  // manifest.
  nsCOMPtr<nsIMutableArray> mNamespaces;

  bool mNeedsUpdate;
  bool mStrictFileOriginPolicy;

  // manifest hash data
  nsCOMPtr<nsICryptoHash> mManifestHash;
  bool mManifestHashInitialized;
  nsCString mManifestHashValue;
  nsCString mOldManifestHashValue;
};

class nsOfflineCacheUpdateOwner
    : public mozilla::SupportsWeakPtr<nsOfflineCacheUpdateOwner> {
 public:
  MOZ_DECLARE_WEAKREFERENCE_TYPENAME(nsOfflineCacheUpdateOwner)
  virtual ~nsOfflineCacheUpdateOwner() {}
  virtual nsresult UpdateFinished(nsOfflineCacheUpdate *aUpdate) = 0;
};

class nsOfflineCacheUpdate final : public nsIOfflineCacheUpdate,
                                   public nsIOfflineCacheUpdateObserver,
                                   public nsIRunnable,
                                   public nsOfflineCacheUpdateOwner {
 public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIOFFLINECACHEUPDATE
  NS_DECL_NSIOFFLINECACHEUPDATEOBSERVER
  NS_DECL_NSIRUNNABLE

  nsOfflineCacheUpdate();

  static nsresult GetCacheKey(nsIURI *aURI, nsACString &aKey);

  nsresult Init();

  nsresult Begin();

  void LoadCompleted(nsOfflineCacheUpdateItem *aItem);
  void ManifestCheckCompleted(nsresult aStatus, const nsCString &aManifestHash);
  void StickDocument(nsIURI *aDocumentURI);

  void SetOwner(nsOfflineCacheUpdateOwner *aOwner);

  bool IsForGroupID(const nsACString &groupID);
  bool IsForProfile(nsIFile *aCustomProfileDir);

  virtual nsresult UpdateFinished(nsOfflineCacheUpdate *aUpdate) override;

 protected:
  ~nsOfflineCacheUpdate();

  friend class nsOfflineCacheUpdateItem;
  void OnByteProgress(uint64_t byteIncrement);

 private:
  nsresult InitInternal(nsIURI *aManifestURI, nsIPrincipal *aPrincipal);
  nsresult HandleManifest(bool *aDoUpdate);
  nsresult AddURI(nsIURI *aURI, uint32_t aItemType, uint32_t aLoadFlags = 0);

  nsresult ProcessNextURI();

  // Adds items from the previous cache witha type matching aType.
  // If namespaceFilter is non-null, only items matching the
  // specified namespaces will be added.
  nsresult AddExistingItems(uint32_t aType,
                            nsTArray<nsCString> *namespaceFilter = nullptr);
  nsresult ScheduleImplicit();
  void AssociateDocuments(nsIApplicationCache *cache);
  bool CheckUpdateAvailability();
  void NotifyUpdateAvailability(bool updateAvailable);

  void GatherObservers(nsCOMArray<nsIOfflineCacheUpdateObserver> &aObservers);
  void NotifyState(uint32_t state);
  nsresult Finish();
  nsresult FinishNoNotify();

  void AsyncFinishWithError();

  // Find one non-pinned cache group and evict it.
  nsresult EvictOneNonPinned();

  enum {
    STATE_UNINITIALIZED,
    STATE_INITIALIZED,
    STATE_CHECKING,
    STATE_DOWNLOADING,
    STATE_CANCELLED,
    STATE_FINISHED
  } mState;

  mozilla::WeakPtr<nsOfflineCacheUpdateOwner> mOwner;

  bool mAddedItems;
  bool mPartialUpdate;
  bool mOnlyCheckUpdate;
  bool mSucceeded;
  bool mObsolete;

  nsCString mUpdateDomain;
  nsCString mGroupID;
  nsCOMPtr<nsIURI> mManifestURI;
  nsCOMPtr<nsIURI> mDocumentURI;
  nsCOMPtr<nsIPrincipal> mLoadingPrincipal;
  nsCOMPtr<nsIFile> mCustomProfileDir;

  nsCOMPtr<nsIObserver> mUpdateAvailableObserver;

  nsCOMPtr<nsIApplicationCache> mApplicationCache;
  nsCOMPtr<nsIApplicationCache> mPreviousApplicationCache;

  nsCOMPtr<nsIObserverService> mObserverService;

  RefPtr<nsOfflineManifestItem> mManifestItem;

  /* Items being updated */
  uint32_t mItemsInProgress;
  nsTArray<RefPtr<nsOfflineCacheUpdateItem> > mItems;

  /* Clients watching this update for changes */
  nsCOMArray<nsIWeakReference> mWeakObservers;
  nsCOMArray<nsIOfflineCacheUpdateObserver> mObservers;

  /* Documents that requested this update */
  nsCOMArray<nsIURI> mDocumentURIs;

  /* Reschedule count.  When an update is rescheduled due to
   * mismatched manifests, the reschedule count will be increased. */
  uint32_t mRescheduleCount;

  /* Whena an entry for a pinned app is retried, retries count is
   * increaded. */
  uint32_t mPinnedEntryRetriesCount;

  RefPtr<nsOfflineCacheUpdate> mImplicitUpdate;

  bool mPinned;

  uint64_t mByteProgress;
};

class nsOfflineCacheUpdateService final : public nsIOfflineCacheUpdateService,
                                          public nsIObserver,
                                          public nsOfflineCacheUpdateOwner,
                                          public nsSupportsWeakReference {
 public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIOFFLINECACHEUPDATESERVICE
  NS_DECL_NSIOBSERVER

  nsOfflineCacheUpdateService();

  nsresult Init();

  nsresult ScheduleUpdate(nsOfflineCacheUpdate *aUpdate);
  nsresult FindUpdate(nsIURI *aManifestURI, nsACString const &aOriginSuffix,
                      nsIFile *aCustomProfileDir,
                      nsOfflineCacheUpdate **aUpdate);

  nsresult Schedule(nsIURI *aManifestURI, nsIURI *aDocumentURI,
                    nsIPrincipal *aLoadingPrincipal, nsIDOMDocument *aDocument,
                    nsPIDOMWindowInner *aWindow, nsIFile *aCustomProfileDir,
                    nsIOfflineCacheUpdate **aUpdate);

  virtual nsresult UpdateFinished(nsOfflineCacheUpdate *aUpdate) override;

  /**
   * Returns the singleton nsOfflineCacheUpdateService without an addref, or
   * nullptr if the service couldn't be created.
   */
  static nsOfflineCacheUpdateService *EnsureService();

  static already_AddRefed<nsOfflineCacheUpdateService> GetInstance();

  static nsresult OfflineAppPinnedForURI(nsIURI *aDocumentURI,
                                         nsIPrefBranch *aPrefBranch,
                                         bool *aPinned);

  static nsTHashtable<nsCStringHashKey> *AllowedDomains();

 private:
  ~nsOfflineCacheUpdateService();

  nsresult ProcessNextUpdate();

  nsTArray<RefPtr<nsOfflineCacheUpdate> > mUpdates;
  static nsTHashtable<nsCStringHashKey> *mAllowedDomains;

  bool mDisabled;
  bool mUpdateRunning;
  bool mLowFreeSpace;
};

#endif