IndexedDB: Bounds check for IDBCursor.advance() incorrect
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBCursor.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 IDBCursor_h
27 #define IDBCursor_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBKey.h"
32 #include "IDBTransaction.h"
33 #include "ScriptValue.h"
34 #include <wtf/PassRefPtr.h>
35 #include <wtf/RefCounted.h>
36 #include <wtf/RefPtr.h>
37
38 namespace WebCore {
39
40 class IDBAny;
41 class IDBCallbacks;
42 class IDBCursorBackendInterface;
43 class IDBRequest;
44 class ScriptExecutionContext;
45
46 typedef int ExceptionCode;
47
48 class IDBCursor : public RefCounted<IDBCursor> {
49 public:
50     enum Direction {
51         NEXT = 0,
52         NEXT_NO_DUPLICATE = 1,
53         PREV = 2,
54         PREV_NO_DUPLICATE = 3,
55     };
56
57     static const AtomicString& directionNext();
58     static const AtomicString& directionNextUnique();
59     static const AtomicString& directionPrev();
60     static const AtomicString& directionPrevUnique();
61
62     static IDBCursor::Direction stringToDirection(const String& modeString, ScriptExecutionContext*, ExceptionCode&);
63     static const AtomicString& directionToString(unsigned short mode, ExceptionCode&);
64
65     static PassRefPtr<IDBCursor> create(PassRefPtr<IDBCursorBackendInterface>, Direction, IDBRequest*, IDBAny* source, IDBTransaction*);
66     virtual ~IDBCursor();
67
68     // FIXME: Try to modify the code generator so this is unneeded.
69     void continueFunction(ExceptionCode& ec) { continueFunction(0, ec); }
70
71     // Implement the IDL
72     const String& direction() const;
73     PassRefPtr<IDBKey> key() const;
74     PassRefPtr<IDBKey> primaryKey() const;
75     PassRefPtr<IDBAny> value();
76     IDBAny* source() const;
77
78     PassRefPtr<IDBRequest> update(ScriptExecutionContext*, ScriptValue&, ExceptionCode&);
79     // FIXME: Make this unsigned long once webkit.org/b/96798 lands.
80     void advance(long long, ExceptionCode&);
81     void continueFunction(PassRefPtr<IDBKey>, ExceptionCode&);
82     PassRefPtr<IDBRequest> deleteFunction(ScriptExecutionContext*, ExceptionCode&);
83
84     void postSuccessHandlerCallback();
85     void close();
86     void setValueReady(PassRefPtr<IDBKey>, PassRefPtr<IDBKey> primaryKey, ScriptValue&);
87
88     // The spec requires that the script object that wraps the value
89     // be unchanged until the value changes as a result of the cursor
90     // advancing.
91     bool valueIsDirty() { return m_valueIsDirty; }
92
93 protected:
94     IDBCursor(PassRefPtr<IDBCursorBackendInterface>, Direction, IDBRequest*, IDBAny* source, IDBTransaction*);
95     virtual bool isKeyCursor() const { return true; }
96
97 private:
98     PassRefPtr<IDBObjectStore> effectiveObjectStore();
99
100     RefPtr<IDBCursorBackendInterface> m_backend;
101     RefPtr<IDBRequest> m_request;
102     const Direction m_direction;
103     RefPtr<IDBAny> m_source;
104     RefPtr<IDBTransaction> m_transaction;
105     IDBTransaction::OpenCursorNotifier m_transactionNotifier;
106     bool m_gotValue;
107     // These values are held because m_backend may advance while they
108     // are still valid for the current success handlers.
109     RefPtr<IDBKey> m_currentKey;
110     RefPtr<IDBKey> m_currentPrimaryKey;
111     RefPtr<IDBAny> m_currentValue;
112     bool m_valueIsDirty;
113 };
114
115 } // namespace WebCore
116
117 #endif
118
119 #endif // IDBCursor_h