ea1cec78f93fdbb3fe89d4e5404fcd006545ca53
[WebKit-https.git] / Source / WebCore / loader / icon / IconDatabase.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
3  * Copyright (C) 2007 Justin Haygood (jhaygood@reaktix.com)
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26  
27 #ifndef IconDatabase_h
28 #define IconDatabase_h
29
30 #include "IconDatabaseBase.h"
31 #include "Timer.h"
32 #include <wtf/HashCountedSet.h>
33 #include <wtf/HashMap.h>
34 #include <wtf/HashSet.h>
35 #include <wtf/Noncopyable.h>
36 #include <wtf/OwnPtr.h>
37 #include <wtf/PassOwnPtr.h>
38 #include <wtf/text/StringHash.h>
39 #include <wtf/text/WTFString.h>
40
41 #if ENABLE(ICONDATABASE)
42 #include "SQLiteDatabase.h"
43 #include <wtf/Threading.h>
44 #endif // ENABLE(ICONDATABASE)
45
46 namespace WebCore { 
47
48 class DocumentLoader;
49 class Image;
50 class IntSize;
51 class IconDatabaseClient;
52 class IconRecord;
53 class IconSnapshot;
54 class KURL;
55 class PageURLRecord;
56 class PageURLSnapshot;
57 class SharedBuffer;
58
59 #if ENABLE(ICONDATABASE)
60 class SQLTransaction;
61 #endif
62
63 #if !ENABLE(ICONDATABASE)
64 // For builds with IconDatabase disabled, they'll just use a default derivation of IconDatabaseBase. Which does nothing.
65 class IconDatabase : public IconDatabaseBase {
66 public:
67     static PassOwnPtr<IconDatabase> create() { return adoptPtr(new IconDatabase); }
68     static void delayDatabaseCleanup() { }
69     static void allowDatabaseCleanup() { }
70     static void checkIntegrityBeforeOpening() { }
71     static String defaultDatabaseFilename() { return "WebpageIcons.db"; }
72 };
73 #else 
74
75 class IconDatabase : public IconDatabaseBase {
76     WTF_MAKE_FAST_ALLOCATED;
77     
78 // *** Main Thread Only ***
79 public:
80     static PassOwnPtr<IconDatabase> create() { return adoptPtr(new IconDatabase); }
81     ~IconDatabase();
82
83     virtual void setClient(IconDatabaseClient*);
84
85     virtual bool open(const String& directory, const String& filename);
86     virtual void close();
87             
88     virtual void removeAllIcons();
89
90     void readIconForPageURLFromDisk(const String&);
91
92     virtual Image* defaultIcon(const IntSize&);
93
94     virtual void retainIconForPageURL(const String&);
95     virtual void releaseIconForPageURL(const String&);
96     virtual void setIconDataForIconURL(PassRefPtr<SharedBuffer> data, const String&) OVERRIDE;
97     virtual void setIconBitmapForIconURL(PassRefPtr<Image>, const String&) OVERRIDE;
98     virtual void setIconURLForPageURL(const String& iconURL, const String& pageURL);
99
100     virtual Image* synchronousIconForPageURL(const String&, const IntSize&);
101     virtual PassNativeImagePtr synchronousNativeIconForPageURL(const String& pageURLOriginal, const IntSize&);
102     virtual String synchronousIconURLForPageURL(const String&);
103     virtual bool synchronousIconDataKnownForIconURL(const String&);
104     virtual IconLoadDecision synchronousLoadDecisionForIconURL(const String&, DocumentLoader*);    
105     
106     virtual void setEnabled(bool);
107     virtual bool isEnabled() const;
108     
109     virtual void setPrivateBrowsingEnabled(bool flag);
110     bool isPrivateBrowsingEnabled() const;
111     
112     static void delayDatabaseCleanup();
113     static void allowDatabaseCleanup();
114     static void checkIntegrityBeforeOpening();
115         
116     // Support for WebCoreStatistics in WebKit
117     virtual size_t pageURLMappingCount();
118     virtual size_t retainedPageURLCount();
119     virtual size_t iconRecordCount();
120     virtual size_t iconRecordCountWithData();
121
122 private:
123     IconDatabase();
124     friend IconDatabaseBase& iconDatabase();
125
126     static void notifyPendingLoadDecisionsOnMainThread(void*);
127     void notifyPendingLoadDecisions();
128
129     void wakeSyncThread();
130     void scheduleOrDeferSyncTimer();
131     void syncTimerFired(Timer<IconDatabase>*);
132
133     void updateIconRecord(PassRefPtr<SharedBuffer>, PassRefPtr<Image>, const String&);
134     
135     Timer<IconDatabase> m_syncTimer;
136     ThreadIdentifier m_syncThread;
137     bool m_syncThreadRunning;
138     
139     HashSet<RefPtr<DocumentLoader> > m_loadersPendingDecision;
140
141     RefPtr<IconRecord> m_defaultIconRecord;
142
143     static void performScheduleOrDeferSyncTimerOnMainThread(void*);
144     void performScheduleOrDeferSyncTimer();
145
146     bool m_scheduleOrDeferSyncTimerRequested;
147
148 // *** Any Thread ***
149 public:
150     virtual bool isOpen() const;
151     virtual String databasePath() const;
152     static String defaultDatabaseFilename();
153
154 private:
155     PassRefPtr<IconRecord> getOrCreateIconRecord(const String& iconURL);
156     PageURLRecord* getOrCreatePageURLRecord(const String& pageURL);
157     
158     bool m_isEnabled;
159     bool m_privateBrowsingEnabled;
160
161     mutable Mutex m_syncLock;
162     ThreadCondition m_syncCondition;
163     String m_databaseDirectory;
164     // Holding m_syncLock is required when accessing m_completeDatabasePath
165     String m_completeDatabasePath;
166
167     bool m_threadTerminationRequested;
168     bool m_removeIconsRequested;
169     bool m_iconURLImportComplete;
170     bool m_syncThreadHasWorkToDo;
171     bool m_disabledSuddenTerminationForSyncThread;
172
173     Mutex m_urlAndIconLock;
174     // Holding m_urlAndIconLock is required when accessing any of the following data structures or the objects they contain
175     HashMap<String, IconRecord*> m_iconURLToRecordMap;
176     HashMap<String, PageURLRecord*> m_pageURLToRecordMap;
177     HashSet<String> m_retainedPageURLs;
178
179     Mutex m_pendingSyncLock;
180     // Holding m_pendingSyncLock is required when accessing any of the following data structures
181     HashMap<String, PageURLSnapshot> m_pageURLsPendingSync;
182     HashMap<String, IconSnapshot> m_iconsPendingSync;
183     
184     Mutex m_pendingReadingLock;    
185     // Holding m_pendingSyncLock is required when accessing any of the following data structures - when dealing with IconRecord*s, holding m_urlAndIconLock is also required
186     HashSet<String> m_pageURLsPendingImport;
187     HashSet<String> m_pageURLsInterestedInIcons;
188     HashSet<IconRecord*> m_iconsPendingReading;
189
190     Mutex m_urlsToRetainOrReleaseLock;
191     // Holding m_urlsToRetainOrReleaseLock is required when accessing any of the following data structures.
192     HashCountedSet<String> m_urlsToRetain;
193     HashCountedSet<String> m_urlsToRelease;
194     bool m_retainOrReleaseIconRequested;
195
196 // *** Sync Thread Only ***
197 public:
198     virtual bool shouldStopThreadActivity() const;
199
200 private:    
201     static void iconDatabaseSyncThreadStart(void *);
202     void iconDatabaseSyncThread();
203     
204     // The following block of methods are called exclusively by the sync thread to manage i/o to and from the database
205     // Each method should periodically monitor m_threadTerminationRequested when it makes sense to return early on shutdown
206     void performOpenInitialization();
207     bool checkIntegrity();
208     void performURLImport();
209     void syncThreadMainLoop();
210     bool readFromDatabase();
211     bool writeToDatabase();
212     void pruneUnretainedIcons();
213     void checkForDanglingPageURLs(bool pruneIfFound);
214     void removeAllIconsOnThread();
215     void deleteAllPreparedStatements();
216     void* cleanupSyncThread();
217     void performRetainIconForPageURL(const String&, int retainCount);
218     void performReleaseIconForPageURL(const String&, int releaseCount);
219     
220     bool wasExcludedFromBackup();
221     void setWasExcludedFromBackup();
222
223     bool m_initialPruningComplete;
224         
225     void setIconURLForPageURLInSQLDatabase(const String&, const String&);
226     void setIconIDForPageURLInSQLDatabase(int64_t, const String&);
227     void removePageURLFromSQLDatabase(const String& pageURL);
228     int64_t getIconIDForIconURLFromSQLDatabase(const String& iconURL);
229     int64_t addIconURLToSQLDatabase(const String&);
230     PassRefPtr<SharedBuffer> getImageDataForIconURLFromSQLDatabase(const String& iconURL);
231     void removeIconFromSQLDatabase(const String& iconURL);
232     void writeIconSnapshotToSQLDatabase(const IconSnapshot&);    
233
234     void performPendingRetainAndReleaseOperations();
235
236     // Methods to dispatch client callbacks on the main thread
237     void dispatchDidImportIconURLForPageURLOnMainThread(const String&);
238     void dispatchDidImportIconDataForPageURLOnMainThread(const String&);
239     void dispatchDidRemoveAllIconsOnMainThread();
240     void dispatchDidFinishURLImportOnMainThread();
241     
242     // The client is set by the main thread before the thread starts, and from then on is only used by the sync thread
243     IconDatabaseClient* m_client;
244     
245     SQLiteDatabase m_syncDB;
246     
247     OwnPtr<SQLiteStatement> m_setIconIDForPageURLStatement;
248     OwnPtr<SQLiteStatement> m_removePageURLStatement;
249     OwnPtr<SQLiteStatement> m_getIconIDForIconURLStatement;
250     OwnPtr<SQLiteStatement> m_getImageDataForIconURLStatement;
251     OwnPtr<SQLiteStatement> m_addIconToIconInfoStatement;
252     OwnPtr<SQLiteStatement> m_addIconToIconDataStatement;
253     OwnPtr<SQLiteStatement> m_getImageDataStatement;
254     OwnPtr<SQLiteStatement> m_deletePageURLsForIconURLStatement;
255     OwnPtr<SQLiteStatement> m_deleteIconFromIconInfoStatement;
256     OwnPtr<SQLiteStatement> m_deleteIconFromIconDataStatement;
257     OwnPtr<SQLiteStatement> m_updateIconInfoStatement;
258     OwnPtr<SQLiteStatement> m_updateIconDataStatement;
259     OwnPtr<SQLiteStatement> m_setIconInfoStatement;
260     OwnPtr<SQLiteStatement> m_setIconDataStatement;
261 };
262
263 #endif // !ENABLE(ICONDATABASE)
264
265 } // namespace WebCore
266
267 #endif // IconDatabase_h