1/*
2 * Copyright (C) 2011, 2013, 2019 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/SecurityOriginData.h>
29#include <wtf/Markable.h>
30#include <wtf/RefPtr.h>
31#include <wtf/ThreadSafeRefCounted.h>
32#include <wtf/WallTime.h>
33#include <wtf/WorkQueue.h>
34#include <wtf/text/WTFString.h>
35
36namespace WebKit {
37
38class LocalStorageDatabaseTracker : public ThreadSafeRefCounted<LocalStorageDatabaseTracker> {
39public:
40 static Ref<LocalStorageDatabaseTracker> create(Ref<WorkQueue>&&, const String& localStorageDirectory);
41 ~LocalStorageDatabaseTracker();
42
43 String databasePath(const WebCore::SecurityOriginData&) const;
44
45 void didOpenDatabaseWithOrigin(const WebCore::SecurityOriginData&);
46 void deleteDatabaseWithOrigin(const WebCore::SecurityOriginData&);
47 void deleteAllDatabases();
48
49 // Returns a vector of the origins whose databases should be deleted.
50 Vector<WebCore::SecurityOriginData> databasesModifiedSince(WallTime);
51
52 Vector<WebCore::SecurityOriginData> origins() const;
53
54 struct OriginDetails {
55 String originIdentifier;
56 Optional<WallTime> creationTime;
57 Optional<WallTime> modificationTime;
58
59 template<class Encoder> void encode(Encoder&) const;
60 template<class Decoder> static Optional<OriginDetails> decode(Decoder&);
61 };
62 Vector<OriginDetails> originDetails();
63
64private:
65 LocalStorageDatabaseTracker(Ref<WorkQueue>&&, const String& localStorageDirectory);
66
67 String databasePath(const String& filename) const;
68
69 enum DatabaseOpeningStrategy {
70 CreateIfNonExistent,
71 SkipIfNonExistent
72 };
73
74 Ref<WorkQueue> m_queue;
75 String m_localStorageDirectory;
76
77#if PLATFORM(IOS_FAMILY)
78 void platformMaybeExcludeFromBackup() const;
79
80 mutable bool m_hasExcludedFromBackup { false };
81#endif
82};
83
84template<class Encoder>
85void LocalStorageDatabaseTracker::OriginDetails::encode(Encoder& encoder) const
86{
87 encoder << originIdentifier << creationTime << modificationTime;
88}
89
90template<class Decoder>
91Optional<LocalStorageDatabaseTracker::OriginDetails> LocalStorageDatabaseTracker::OriginDetails::decode(Decoder& decoder)
92{
93 LocalStorageDatabaseTracker::OriginDetails result;
94 if (!decoder.decode(result.originIdentifier))
95 return WTF::nullopt;
96
97 if (!decoder.decode(result.creationTime))
98 return WTF::nullopt;
99
100 if (!decoder.decode(result.modificationTime))
101 return WTF::nullopt;
102
103 return result;
104}
105
106} // namespace WebKit
107