src/third_party/WebKit/Source/modules/indexeddb/IDBDatabase.h

   1 /*
   2  * Copyright (C) 2010 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef IDBDatabase_h
  27 #define IDBDatabase_h
  28
  29 #include "bindings/v8/Dictionary.h"
  30 #include "bindings/v8/ScriptWrappable.h"
  31 #include "core/dom/ActiveDOMObject.h"
  32 #include "core/dom/DOMStringList.h"
  33 #include "core/events/Event.h"
  34 #include "core/events/EventTarget.h"
  35 #include "modules/indexeddb/IDBDatabaseCallbacks.h"
  36 #include "modules/indexeddb/IDBMetadata.h"
  37 #include "modules/indexeddb/IDBObjectStore.h"
  38 #include "modules/indexeddb/IDBTransaction.h"
  39 #include "modules/indexeddb/IndexedDB.h"
  40 #include "platform/heap/Handle.h"
  41 #include "public/platform/WebIDBDatabase.h"
  42 #include "wtf/OwnPtr.h"
  43 #include "wtf/PassOwnPtr.h"
  44 #include "wtf/PassRefPtr.h"
  45 #include "wtf/RefCounted.h"
  46 #include "wtf/RefPtr.h"
  47
  48 namespace WebCore {
  49
  50 class DOMError;
  51 class ExceptionState;
  52 class ExecutionContext;
  53
  54 class IDBDatabase FINAL
  55     : public RefCountedWillBeRefCountedGarbageCollected<IDBDatabase>
  56     , public ScriptWrappable
  57     , public EventTargetWithInlineData
  58     , public ActiveDOMObject {
  59     DEFINE_EVENT_TARGET_REFCOUNTING(RefCountedWillBeRefCountedGarbageCollected<IDBDatabase>);
  60
  61 public:
  62     static PassRefPtrWillBeRawPtr<IDBDatabase> create(ExecutionContext*, PassOwnPtr<blink::WebIDBDatabase>, PassRefPtrWillBeRawPtr<IDBDatabaseCallbacks>);
  63     virtual ~IDBDatabase();
  64     void trace(Visitor*);
  65
  66     void setMetadata(const IDBDatabaseMetadata& metadata) { m_metadata = metadata; }
  67     void indexCreated(int64_t objectStoreId, const IDBIndexMetadata&);
  68     void indexDeleted(int64_t objectStoreId, int64_t indexId);
  69     void transactionCreated(IDBTransaction*);
  70     void transactionFinished(const IDBTransaction*);
  71
  72     // Implement the IDL
  73     const String& name() const { return m_metadata.name; }
  74     ScriptValue version(ScriptState*) const;
  75     PassRefPtrWillBeRawPtr<DOMStringList> objectStoreNames() const;
  76
  77     PassRefPtrWillBeRawPtr<IDBObjectStore> createObjectStore(const String& name, const Dictionary&, ExceptionState&);
  78     PassRefPtrWillBeRawPtr<IDBObjectStore> createObjectStore(const String& name, const IDBKeyPath&, bool autoIncrement, ExceptionState&);
  79     PassRefPtrWillBeRawPtr<IDBTransaction> transaction(ExecutionContext* context, PassRefPtrWillBeRawPtr<DOMStringList> scope, const String& mode, ExceptionState& exceptionState) { return transaction(context, *scope, mode, exceptionState); }
  80     PassRefPtrWillBeRawPtr<IDBTransaction> transaction(ExecutionContext*, const Vector<String>&, const String& mode, ExceptionState&);
  81     PassRefPtrWillBeRawPtr<IDBTransaction> transaction(ExecutionContext*, const String&, const String& mode, ExceptionState&);
  82     void deleteObjectStore(const String& name, ExceptionState&);
  83     void close();
  84
  85     DEFINE_ATTRIBUTE_EVENT_LISTENER(abort);
  86     DEFINE_ATTRIBUTE_EVENT_LISTENER(close);
  87     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
  88     DEFINE_ATTRIBUTE_EVENT_LISTENER(versionchange);
  89
  90     // IDBDatabaseCallbacks
  91     void onVersionChange(int64_t oldVersion, int64_t newVersion);
  92     void onAbort(int64_t, PassRefPtrWillBeRawPtr<DOMError>);
  93     void onComplete(int64_t);
  94
  95     // ActiveDOMObject
  96     virtual bool hasPendingActivity() const OVERRIDE;
  97     virtual void stop() OVERRIDE;
  98
  99     // EventTarget
 100     virtual const AtomicString& interfaceName() const OVERRIDE;
 101     virtual ExecutionContext* executionContext() const OVERRIDE;
 102
 103     bool isClosePending() const { return m_closePending; }
 104     void forceClose();
 105     const IDBDatabaseMetadata& metadata() const { return m_metadata; }
 106     void enqueueEvent(PassRefPtrWillBeRawPtr<Event>);
 107
 108     using EventTarget::dispatchEvent;
 109     virtual bool dispatchEvent(PassRefPtrWillBeRawPtr<Event>) OVERRIDE;
 110
 111     int64_t findObjectStoreId(const String& name) const;
 112     bool containsObjectStore(const String& name) const
 113     {
 114         return findObjectStoreId(name) != IDBObjectStoreMetadata::InvalidId;
 115     }
 116
 117     // Will return nullptr if this database is stopped.
 118     blink::WebIDBDatabase* backend() const { return m_backend.get(); }
 119
 120     static int64_t nextTransactionId();
 121
 122     void ackReceivedBlobs(const Vector<blink::WebBlobInfo>*);
 123
 124     static const char indexDeletedErrorMessage[];
 125     static const char isKeyCursorErrorMessage[];
 126     static const char noKeyOrKeyRangeErrorMessage[];
 127     static const char noSuchIndexErrorMessage[];
 128     static const char noSuchObjectStoreErrorMessage[];
 129     static const char noValueErrorMessage[];
 130     static const char notValidKeyErrorMessage[];
 131     static const char notVersionChangeTransactionErrorMessage[];
 132     static const char objectStoreDeletedErrorMessage[];
 133     static const char requestNotFinishedErrorMessage[];
 134     static const char sourceDeletedErrorMessage[];
 135     static const char transactionFinishedErrorMessage[];
 136     static const char transactionInactiveErrorMessage[];
 137     static const char transactionReadOnlyErrorMessage[];
 138     static const char databaseClosedErrorMessage[];
 139
 140 private:
 141     IDBDatabase(ExecutionContext*, PassOwnPtr<blink::WebIDBDatabase>, PassRefPtrWillBeRawPtr<IDBDatabaseCallbacks>);
 142
 143     void closeConnection();
 144
 145     IDBDatabaseMetadata m_metadata;
 146     OwnPtr<blink::WebIDBDatabase> m_backend;
 147     RefPtrWillBeMember<IDBTransaction> m_versionChangeTransaction;
 148     typedef WillBeHeapHashMap<int64_t, RefPtrWillBeMember<IDBTransaction> > TransactionMap;
 149     TransactionMap m_transactions;
 150
 151     bool m_closePending;
 152     bool m_contextStopped;
 153
 154     // Keep track of the versionchange events waiting to be fired on this
 155     // database so that we can cancel them if the database closes.
 156     WillBeHeapVector<RefPtrWillBeMember<Event> > m_enqueuedEvents;
 157
 158     RefPtrWillBeMember<IDBDatabaseCallbacks> m_databaseCallbacks;
 159 };
 160
 161 } // namespace WebCore
 162
 163 #endif // IDBDatabase_h