Clean up Storage code
[WebKit-https.git] / Source / WebKit2 / UIProcess / Storage / LocalStorageDatabaseTracker.h
1 /*
2  * Copyright (C) 2011, 2013 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 #pragma once
27
28 #include <WebCore/SQLiteDatabase.h>
29 #include <wtf/HashSet.h>
30 #include <wtf/Optional.h>
31 #include <wtf/RefPtr.h>
32 #include <wtf/ThreadSafeRefCounted.h>
33 #include <wtf/WorkQueue.h>
34 #include <wtf/text/StringHash.h>
35 #include <wtf/text/WTFString.h>
36
37 namespace WebCore {
38 class SecurityOrigin;
39 }
40
41 namespace WebKit {
42
43 struct LocalStorageDetails;
44
45 class LocalStorageDatabaseTracker : public ThreadSafeRefCounted<LocalStorageDatabaseTracker> {
46 public:
47     static Ref<LocalStorageDatabaseTracker> create(Ref<WorkQueue>&&, const String& localStorageDirectory);
48     ~LocalStorageDatabaseTracker();
49
50     String databasePath(WebCore::SecurityOrigin*) const;
51
52     void didOpenDatabaseWithOrigin(WebCore::SecurityOrigin*);
53     void deleteDatabaseWithOrigin(WebCore::SecurityOrigin*);
54     void deleteAllDatabases();
55
56     // Returns a vector of the origins whose databases have been deleted.
57     Vector<Ref<WebCore::SecurityOrigin>> deleteDatabasesModifiedSince(std::chrono::system_clock::time_point);
58
59     Vector<Ref<WebCore::SecurityOrigin>> origins() const;
60
61     struct OriginDetails {
62         String originIdentifier;
63         Optional<time_t> creationTime;
64         Optional<time_t> modificationTime;
65     };
66     Vector<OriginDetails> originDetails();
67
68 private:
69     LocalStorageDatabaseTracker(Ref<WorkQueue>&&, const String& localStorageDirectory);
70
71     String databasePath(const String& filename) const;
72     String trackerDatabasePath() const;
73
74     enum DatabaseOpeningStrategy {
75         CreateIfNonExistent,
76         SkipIfNonExistent
77     };
78     void openTrackerDatabase(DatabaseOpeningStrategy);
79
80     void importOriginIdentifiers();
81     void updateTrackerDatabaseFromLocalStorageDatabaseFiles();
82
83     void addDatabaseWithOriginIdentifier(const String& originIdentifier, const String& databasePath);
84     void removeDatabaseWithOriginIdentifier(const String& originIdentifier);
85     String pathForDatabaseWithOriginIdentifier(const String& originIdentifier);
86
87     RefPtr<WorkQueue> m_queue;
88     String m_localStorageDirectory;
89
90     WebCore::SQLiteDatabase m_database;
91     HashSet<String> m_origins;
92 };
93
94 } // namespace WebKit