dom/indexedDB/IDBDatabase.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=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 #ifndef mozilla_dom_indexeddb_idbdatabase_h__
   8 #define mozilla_dom_indexeddb_idbdatabase_h__
   9
  10 #include "mozilla/Attributes.h"
  11 #include "mozilla/dom/IDBTransactionBinding.h"
  12 #include "mozilla/dom/StorageTypeBinding.h"
  13 #include "mozilla/dom/indexedDB/IDBWrapperCache.h"
  14 #include "mozilla/dom/quota/PersistenceType.h"
  15 #include "nsAutoPtr.h"
  16 #include "nsDataHashtable.h"
  17 #include "nsHashKeys.h"
  18 #include "nsString.h"
  19 #include "nsTHashtable.h"
  20
  21 class nsIDocument;
  22 class nsIWeakReference;
  23 class nsPIDOMWindow;
  24
  25 namespace mozilla {
  26
  27 class ErrorResult;
  28 class EventChainPostVisitor;
  29
  30 namespace dom {
  31
  32 class File;
  33 class DOMStringList;
  34 struct IDBObjectStoreParameters;
  35 template <typename> class Sequence;
  36
  37 namespace indexedDB {
  38
  39 class BackgroundDatabaseChild;
  40 class DatabaseSpec;
  41 class FileManager;
  42 class IDBFactory;
  43 class IDBMutableFile;
  44 class IDBObjectStore;
  45 class IDBRequest;
  46 class IDBTransaction;
  47 class PBackgroundIDBDatabaseFileChild;
  48
  49 class IDBDatabase MOZ_FINAL
  50   : public IDBWrapperCache
  51 {
  52   typedef mozilla::dom::StorageType StorageType;
  53   typedef mozilla::dom::quota::PersistenceType PersistenceType;
  54
  55   class LogWarningRunnable;
  56   friend class LogWarningRunnable;
  57
  58   class Observer;
  59   friend class Observer;
  60
  61   // The factory must be kept alive when IndexedDB is used in multiple
  62   // processes. If it dies then the entire actor tree will be destroyed with it
  63   // and the world will explode.
  64   nsRefPtr<IDBFactory> mFactory;
  65
  66   nsAutoPtr<DatabaseSpec> mSpec;
  67
  68   // Normally null except during a versionchange transaction.
  69   nsAutoPtr<DatabaseSpec> mPreviousSpec;
  70
  71   nsRefPtr<FileManager> mFileManager;
  72
  73   BackgroundDatabaseChild* mBackgroundActor;
  74
  75   nsTHashtable<nsPtrHashKey<IDBTransaction>> mTransactions;
  76
  77   nsDataHashtable<nsISupportsHashKey, PBackgroundIDBDatabaseFileChild*>
  78     mFileActors;
  79
  80   nsTHashtable<nsISupportsHashKey> mReceivedBlobs;
  81
  82   nsRefPtr<Observer> mObserver;
  83
  84   // Weak refs, IDBMutableFile strongly owns this IDBDatabase object.
  85   nsTArray<IDBMutableFile*> mLiveMutableFiles;
  86
  87   bool mClosed;
  88   bool mInvalidated;
  89
  90 public:
  91   static already_AddRefed<IDBDatabase>
  92   Create(IDBWrapperCache* aOwnerCache,
  93          IDBFactory* aFactory,
  94          BackgroundDatabaseChild* aActor,
  95          DatabaseSpec* aSpec);
  96
  97   void
  98   AssertIsOnOwningThread() const
  99 #ifdef DEBUG
 100   ;
 101 #else
 102   { }
 103 #endif
 104
 105   const nsString&
 106   Name() const;
 107
 108   void
 109   GetName(nsAString& aName) const
 110   {
 111     AssertIsOnOwningThread();
 112
 113     aName = Name();
 114   }
 115
 116   uint64_t
 117   Version() const;
 118
 119   already_AddRefed<nsIDocument>
 120   GetOwnerDocument() const;
 121
 122   void
 123   Close()
 124   {
 125     AssertIsOnOwningThread();
 126
 127     CloseInternal();
 128   }
 129
 130   bool
 131   IsClosed() const
 132   {
 133     AssertIsOnOwningThread();
 134
 135     return mClosed;
 136   }
 137
 138   void
 139   Invalidate();
 140
 141   // Whether or not the database has been invalidated. If it has then no further
 142   // transactions for this database will be allowed to run.
 143   bool
 144   IsInvalidated() const
 145   {
 146     AssertIsOnOwningThread();
 147
 148     return mInvalidated;
 149   }
 150
 151   void
 152   EnterSetVersionTransaction(uint64_t aNewVersion);
 153
 154   void
 155   ExitSetVersionTransaction();
 156
 157   // Called when a versionchange transaction is aborted to reset the
 158   // DatabaseInfo.
 159   void
 160   RevertToPreviousState();
 161
 162   IDBFactory*
 163   Factory() const
 164   {
 165     AssertIsOnOwningThread();
 166
 167     return mFactory;
 168   }
 169
 170   void
 171   RegisterTransaction(IDBTransaction* aTransaction);
 172
 173   void
 174   UnregisterTransaction(IDBTransaction* aTransaction);
 175
 176   void
 177   AbortTransactions(bool aShouldWarn);
 178
 179   PBackgroundIDBDatabaseFileChild*
 180   GetOrCreateFileActorForBlob(File* aBlob);
 181
 182   void
 183   NoteFinishedFileActor(PBackgroundIDBDatabaseFileChild* aFileActor);
 184
 185   void
 186   NoteReceivedBlob(File* aBlob);
 187
 188   void
 189   DelayedMaybeExpireFileActors();
 190
 191   // XXX This doesn't really belong here... It's only needed for IDBMutableFile
 192   //     serialization and should be removed someday.
 193   nsresult
 194   GetQuotaInfo(nsACString& aOrigin, PersistenceType* aPersistenceType);
 195
 196   void
 197   NoteLiveMutableFile(IDBMutableFile* aMutableFile);
 198
 199   void
 200   NoteFinishedMutableFile(IDBMutableFile* aMutableFile);
 201
 202   nsPIDOMWindow*
 203   GetParentObject() const;
 204
 205   already_AddRefed<DOMStringList>
 206   ObjectStoreNames() const;
 207
 208   already_AddRefed<IDBObjectStore>
 209   CreateObjectStore(const nsAString& aName,
 210                     const IDBObjectStoreParameters& aOptionalParameters,
 211                     ErrorResult& aRv);
 212
 213   void
 214   DeleteObjectStore(const nsAString& name, ErrorResult& aRv);
 215
 216   already_AddRefed<IDBTransaction>
 217   Transaction(const nsAString& aStoreName,
 218               IDBTransactionMode aMode,
 219               ErrorResult& aRv);
 220
 221   already_AddRefed<IDBTransaction>
 222   Transaction(const Sequence<nsString>& aStoreNames,
 223               IDBTransactionMode aMode,
 224               ErrorResult& aRv);
 225
 226   StorageType
 227   Storage() const;
 228
 229   IMPL_EVENT_HANDLER(abort)
 230   IMPL_EVENT_HANDLER(error)
 231   IMPL_EVENT_HANDLER(versionchange)
 232
 233   already_AddRefed<IDBRequest>
 234   CreateMutableFile(const nsAString& aName,
 235                     const Optional<nsAString>& aType,
 236                     ErrorResult& aRv);
 237
 238   already_AddRefed<IDBRequest>
 239   MozCreateFileHandle(const nsAString& aName,
 240                       const Optional<nsAString>& aType,
 241                       ErrorResult& aRv)
 242   {
 243     return CreateMutableFile(aName, aType, aRv);
 244   }
 245
 246   void
 247   ClearBackgroundActor()
 248   {
 249     AssertIsOnOwningThread();
 250
 251     mBackgroundActor = nullptr;
 252   }
 253
 254   const DatabaseSpec*
 255   Spec() const
 256   {
 257     return mSpec;
 258   }
 259
 260   NS_DECL_ISUPPORTS_INHERITED
 261   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(IDBDatabase, IDBWrapperCache)
 262
 263   // nsIDOMEventTarget
 264   virtual void
 265   LastRelease() MOZ_OVERRIDE;
 266
 267   virtual nsresult
 268   PostHandleEvent(EventChainPostVisitor& aVisitor) MOZ_OVERRIDE;
 269
 270   // nsWrapperCache
 271   virtual JSObject*
 272   WrapObject(JSContext* aCx) MOZ_OVERRIDE;
 273
 274 private:
 275   IDBDatabase(IDBWrapperCache* aOwnerCache,
 276               IDBFactory* aFactory,
 277               BackgroundDatabaseChild* aActor,
 278               DatabaseSpec* aSpec);
 279
 280   ~IDBDatabase();
 281
 282   void
 283   CloseInternal();
 284
 285   void
 286   InvalidateInternal();
 287
 288   bool
 289   RunningVersionChangeTransaction() const
 290   {
 291     AssertIsOnOwningThread();
 292
 293     return !!mPreviousSpec;
 294   }
 295
 296   void
 297   RefreshSpec(bool aMayDelete);
 298
 299   void
 300   ExpireFileActors(bool aExpireAll);
 301
 302   void
 303   InvalidateMutableFiles();
 304
 305   void
 306   LogWarning(const char* aMessageName,
 307              const nsAString& aFilename,
 308              uint32_t aLineNumber);
 309 };
 310
 311 } // namespace indexedDB
 312 } // namespace dom
 313 } // namespace mozilla
 314
 315 #endif // mozilla_dom_indexeddb_idbdatabase_h__