Replace all remaining uses of WTF::Mutex with WTF::Lock
[WebKit-https.git] / Source / WebKit / Storage / StorageAreaSync.h
1 /*
2  * Copyright (C) 2008, 2009, 2010 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 #include <WebCore/SQLiteDatabase.h>
30 #include <WebCore/Timer.h>
31 #include <wtf/Condition.h>
32 #include <wtf/HashMap.h>
33 #include <wtf/text/StringHash.h>
34
35 namespace WebCore {
36
37 class Frame;
38 class StorageAreaImpl;
39 class StorageSyncManager;
40
41 class StorageAreaSync : public ThreadSafeRefCounted<StorageAreaSync> {
42 public:
43     static Ref<StorageAreaSync> create(PassRefPtr<StorageSyncManager>, PassRefPtr<StorageAreaImpl>, const String& databaseIdentifier);
44     ~StorageAreaSync();
45
46     void scheduleFinalSync();
47     void blockUntilImportComplete();
48
49     void scheduleItemForSync(const String& key, const String& value);
50     void scheduleClear();
51     void scheduleCloseDatabase();
52
53     void scheduleSync();
54
55 private:
56     StorageAreaSync(PassRefPtr<StorageSyncManager>, PassRefPtr<StorageAreaImpl>, const String& databaseIdentifier);
57
58     Timer m_syncTimer;
59     HashMap<String, String> m_changedItems;
60     bool m_itemsCleared;
61
62     bool m_finalSyncScheduled;
63
64     RefPtr<StorageAreaImpl> m_storageArea;
65     RefPtr<StorageSyncManager> m_syncManager;
66
67     // The database handle will only ever be opened and used on the background thread.
68     SQLiteDatabase m_database;
69
70     // The following members are subject to thread synchronization issues.
71 public:
72     // Called from the background thread
73     void performImport();
74     void performSync();
75     void deleteEmptyDatabase();
76
77 private:
78     enum OpenDatabaseParamType {
79         CreateIfNonExistent,
80         SkipIfNonExistent
81     };
82
83     void syncTimerFired();
84     void openDatabase(OpenDatabaseParamType openingStrategy);
85     void sync(bool clearItems, const HashMap<String, String>& items);
86
87     const String m_databaseIdentifier;
88
89     Lock m_syncLock;
90     HashMap<String, String> m_itemsPendingSync;
91     bool m_clearItemsWhileSyncing;
92     bool m_syncScheduled;
93     bool m_syncInProgress;
94     bool m_databaseOpenFailed;
95
96     bool m_syncCloseDatabase;
97
98     mutable Lock m_importLock;
99     Condition m_importCondition;
100     bool m_importComplete;
101     void markImported();
102     void migrateItemTableIfNeeded();
103 };
104
105 } // namespace WebCore
106
107 #endif // StorageAreaSync_h