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