initial import
[vuplus_webkit] / Source / WebCore / storage / StorageTracker.h
1 /*
2  * Copyright (C) 2011 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef StorageTracker_h
27 #define StorageTracker_h
28
29 #if ENABLE(DOM_STORAGE)
30     
31 #include "PlatformString.h"
32 #include "SQLiteDatabase.h"
33 #include <wtf/HashSet.h>
34 #include <wtf/OwnPtr.h>
35 #include <wtf/Vector.h>
36 #include <wtf/text/StringHash.h>
37
38 namespace WebCore {
39
40 class LocalStorageTask;
41 class LocalStorageThread;
42 class SecurityOrigin;
43 class StorageTrackerClient;    
44
45 class StorageTracker {
46     WTF_MAKE_NONCOPYABLE(StorageTracker);
47     WTF_MAKE_FAST_ALLOCATED;
48 public:
49     static void initializeTracker(const String& storagePath, StorageTrackerClient*);
50     static StorageTracker& tracker();
51
52     void setOriginDetails(const String& originIdentifier, const String& databaseFile);
53     
54     void deleteAllOrigins();
55     void deleteOrigin(SecurityOrigin*);
56     void deleteOrigin(const String& originIdentifier);
57     void origins(Vector<RefPtr<SecurityOrigin> >& result);
58     long long diskUsageForOrigin(SecurityOrigin*);
59     
60     void cancelDeletingOrigin(const String& originIdentifier);
61     
62     void setClient(StorageTrackerClient*);
63     
64     bool isActive();
65
66     // Sync to disk on background thread.
67     void syncDeleteAllOrigins();
68     void syncDeleteOrigin(const String& originIdentifier);
69     void syncSetOriginDetails(const String& originIdentifier, const String& databaseFile);
70     void syncImportOriginIdentifiers();
71     void syncFileSystemAndTrackerDatabase();
72
73     void syncLocalStorage();
74
75 private:
76     StorageTracker(const String& storagePath);
77     static void scheduleTask(void*);
78
79     void internalInitialize();
80
81     String trackerDatabasePath();
82     void openTrackerDatabase(bool createIfDoesNotExist);
83
84     void importOriginIdentifiers();
85     
86     void deleteTrackerFiles();
87     String databasePathForOrigin(const String& originIdentifier);
88
89     bool canDeleteOrigin(const String& originIdentifier);
90     void willDeleteOrigin(const String& originIdentifier);
91     void willDeleteAllOrigins();
92     static void deleteOriginOnMainThread(void* originIdentifier);
93
94     void originFilePaths(Vector<String>& paths);
95     
96     void setIsActive(bool);
97
98     // Guard for m_database, m_storageDirectoryPath and static Strings in syncFileSystemAndTrackerDatabase().
99     Mutex m_databaseGuard;
100     SQLiteDatabase m_database;
101     String m_storageDirectoryPath;
102
103     Mutex m_clientGuard;
104     StorageTrackerClient* m_client;
105
106     // Guard for m_originSet and m_originsBeingDeleted.
107     Mutex m_originSetGuard;
108     typedef HashSet<String> OriginSet;
109     OriginSet m_originSet;
110     OriginSet m_originsBeingDeleted;
111
112     OwnPtr<LocalStorageThread> m_thread;
113     
114     bool m_isActive;
115     bool m_needsInitialization;
116 };
117     
118 } // namespace WebCore
119
120 #endif // ENABLE(DOM_STORAGE)
121
122 #endif // StorageTracker_h