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