2009-07-14 Brent Fulgham <bfulgham@webkit.org>
[WebKit-https.git] / WebCore / storage / StorageAreaSync.h
1 /*
2  * Copyright (C) 2008, 2009 Apple 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef StorageAreaSync_h
27 #define StorageAreaSync_h
28
29 #if ENABLE(DOM_STORAGE)
30
31 #include "SQLiteDatabase.h"
32 #include "StringHash.h"
33 #include "StorageSyncManager.h"
34 #include "Timer.h"
35 #include <wtf/HashMap.h>
36
37 namespace WebCore {
38
39     class Frame;
40     class StorageArea;
41     class StorageSyncManager;
42     
43     class StorageAreaSync : public RefCounted<StorageAreaSync> {
44     public:
45 #ifndef NDEBUG
46         ~StorageAreaSync();
47 #endif
48
49         static PassRefPtr<StorageAreaSync> create(PassRefPtr<StorageSyncManager> storageSyncManager, PassRefPtr<StorageArea> storageArea);
50         
51         void scheduleFinalSync();
52         void blockUntilImportComplete() const;
53
54         void scheduleItemForSync(const String& key, const String& value);
55         void scheduleClear();
56         
57     private:
58         StorageAreaSync(PassRefPtr<StorageSyncManager> storageSyncManager, PassRefPtr<StorageArea> storageArea);
59
60         void dispatchStorageEvent(const String& key, const String& oldValue, const String& newValue, Frame* sourceFrame);
61
62         Timer<StorageAreaSync> m_syncTimer;        
63         HashMap<String, String> m_changedItems;
64         bool m_itemsCleared;
65         
66         bool m_finalSyncScheduled;
67
68         RefPtr<StorageArea> m_storageArea;
69         RefPtr<StorageSyncManager> m_syncManager;
70
71         // The database handle will only ever be opened and used on the background thread.
72         SQLiteDatabase m_database;
73
74     // The following members are subject to thread synchronization issues.
75     public:
76         // Called from the background thread
77         void performImport();
78         void performSync();
79
80     private:
81         void syncTimerFired(Timer<StorageAreaSync>*);
82         void sync(bool clearItems, const HashMap<String, String>& items);
83
84         Mutex m_syncLock;
85         HashMap<String, String> m_itemsPendingSync;
86         bool m_clearItemsWhileSyncing;
87         bool m_syncScheduled;
88
89         mutable Mutex m_importLock;
90         mutable ThreadCondition m_importCondition;
91         mutable bool m_importComplete;
92         void markImported();
93     };
94
95 } // namespace WebCore
96
97 #endif // ENABLE(DOM_STORAGE)
98
99 #endif // StorageAreaSync_h