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 IDBObjectStore_h 27 #define IDBObjectStore_h 28 29 #include "bindings/v8/Dictionary.h" 30 #include "bindings/v8/ScriptWrappable.h" 31 #include "bindings/v8/SerializedScriptValue.h" 32 #include "modules/indexeddb/IDBCursor.h" 33 #include "modules/indexeddb/IDBIndex.h" 34 #include "modules/indexeddb/IDBKey.h" 35 #include "modules/indexeddb/IDBKeyRange.h" 36 #include "modules/indexeddb/IDBMetadata.h" 37 #include "modules/indexeddb/IDBRequest.h" 38 #include "modules/indexeddb/IDBTransaction.h" 39 #include "public/platform/WebIDBDatabase.h" 40 #include "wtf/PassRefPtr.h" 41 #include "wtf/RefCounted.h" 42 #include "wtf/RefPtr.h" 43 #include "wtf/text/WTFString.h" 44 45 namespace WebCore { 46 47 class DOMStringList; 48 class IDBAny; 49 class ExceptionState; 50 51 class IDBObjectStore : public ScriptWrappable, public RefCounted<IDBObjectStore> { 52 public: create(const IDBObjectStoreMetadata & metadata,IDBTransaction * transaction)53 static PassRefPtr<IDBObjectStore> create(const IDBObjectStoreMetadata& metadata, IDBTransaction* transaction) 54 { 55 return adoptRef(new IDBObjectStore(metadata, transaction)); 56 } ~IDBObjectStore()57 ~IDBObjectStore() { } 58 59 // Implement the IDBObjectStore IDL id()60 int64_t id() const { return m_metadata.id; } name()61 const String& name() const { return m_metadata.name; } 62 ScriptValue keyPath(ExecutionContext*) const; 63 PassRefPtr<DOMStringList> indexNames() const; transaction()64 PassRefPtr<IDBTransaction> transaction() const { return m_transaction; } autoIncrement()65 bool autoIncrement() const { return m_metadata.autoIncrement; } 66 67 PassRefPtr<IDBRequest> openCursor(ExecutionContext*, const ScriptValue& range, const String& direction, ExceptionState&); 68 PassRefPtr<IDBRequest> openKeyCursor(ExecutionContext*, const ScriptValue& range, const String& direction, ExceptionState&); 69 PassRefPtr<IDBRequest> get(ExecutionContext*, const ScriptValue& key, ExceptionState&); 70 PassRefPtr<IDBRequest> add(ScriptState*, ScriptValue&, const ScriptValue& key, ExceptionState&); 71 PassRefPtr<IDBRequest> put(ScriptState*, ScriptValue&, const ScriptValue& key, ExceptionState&); 72 PassRefPtr<IDBRequest> deleteFunction(ExecutionContext*, const ScriptValue& key, ExceptionState&); 73 PassRefPtr<IDBRequest> clear(ExecutionContext*, ExceptionState&); 74 createIndex(ExecutionContext * context,const String & name,const String & keyPath,const Dictionary & options,ExceptionState & exceptionState)75 PassRefPtr<IDBIndex> createIndex(ExecutionContext* context, const String& name, const String& keyPath, const Dictionary& options, ExceptionState& exceptionState) { return createIndex(context, name, IDBKeyPath(keyPath), options, exceptionState); } createIndex(ExecutionContext * context,const String & name,const Vector<String> & keyPath,const Dictionary & options,ExceptionState & exceptionState)76 PassRefPtr<IDBIndex> createIndex(ExecutionContext* context, const String& name, const Vector<String>& keyPath, const Dictionary& options, ExceptionState& exceptionState) { return createIndex(context, name, IDBKeyPath(keyPath), options, exceptionState); } 77 PassRefPtr<IDBIndex> index(const String& name, ExceptionState&); 78 void deleteIndex(const String& name, ExceptionState&); 79 80 PassRefPtr<IDBRequest> count(ExecutionContext*, const ScriptValue& range, ExceptionState&); 81 82 // Used by IDBCursor::update(): 83 PassRefPtr<IDBRequest> put(blink::WebIDBDatabase::PutMode, PassRefPtr<IDBAny> source, ScriptState*, ScriptValue&, PassRefPtr<IDBKey>, ExceptionState&); 84 85 // Used internally and by InspectorIndexedDBAgent: 86 PassRefPtr<IDBRequest> openCursor(ExecutionContext*, PassRefPtr<IDBKeyRange>, IndexedDB::CursorDirection, blink::WebIDBDatabase::TaskType = blink::WebIDBDatabase::NormalTask); 87 markDeleted()88 void markDeleted() { m_deleted = true; } isDeleted()89 bool isDeleted() const { return m_deleted; } 90 void transactionFinished(); 91 metadata()92 const IDBObjectStoreMetadata& metadata() const { return m_metadata; } setMetadata(const IDBObjectStoreMetadata & metadata)93 void setMetadata(const IDBObjectStoreMetadata& metadata) { m_metadata = metadata; } 94 95 typedef Vector<RefPtr<IDBKey> > IndexKeys; 96 typedef HashMap<String, IndexKeys> IndexKeyMap; 97 98 blink::WebIDBDatabase* backendDB() const; 99 100 private: 101 IDBObjectStore(const IDBObjectStoreMetadata&, IDBTransaction*); 102 103 PassRefPtr<IDBIndex> createIndex(ExecutionContext*, const String& name, const IDBKeyPath&, const Dictionary&, ExceptionState&); 104 PassRefPtr<IDBIndex> createIndex(ExecutionContext*, const String& name, const IDBKeyPath&, bool unique, bool multiEntry, ExceptionState&); 105 PassRefPtr<IDBRequest> put(blink::WebIDBDatabase::PutMode, PassRefPtr<IDBAny> source, ScriptState*, ScriptValue&, const ScriptValue& key, ExceptionState&); 106 107 int64_t findIndexId(const String& name) const; containsIndex(const String & name)108 bool containsIndex(const String& name) const 109 { 110 return findIndexId(name) != IDBIndexMetadata::InvalidId; 111 } 112 113 IDBObjectStoreMetadata m_metadata; 114 RefPtr<IDBTransaction> m_transaction; 115 bool m_deleted; 116 117 typedef HashMap<String, RefPtr<IDBIndex> > IDBIndexMap; 118 IDBIndexMap m_indexMap; 119 }; 120 121 } // namespace WebCore 122 123 #endif // IDBObjectStore_h 124