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/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
38struct LocalStorageDetails;
39
40class LocalStorageDatabaseTracker : public ThreadSafeRefCounted<LocalStorageDatabaseTracker> {
41public:
42 static Ref<LocalStorageDatabaseTracker> create(Ref<WorkQueue>&&, const String& localStorageDirectory);
43 ~LocalStorageDatabaseTracker();
44
45 String databasePath(const WebCore::SecurityOriginData&) const;
46
47 void didOpenDatabaseWithOrigin(const WebCore::SecurityOriginData&);
48 void deleteDatabaseWithOrigin(const WebCore::SecurityOriginData&);
49 void deleteAllDatabases();
50
51 // Returns a vector of the origins whose databases should be deleted.
52 Vector<WebCore::SecurityOriginData> databasesModifiedSince(WallTime);
53
54 Vector<WebCore::SecurityOriginData> origins() const;
55
56 struct OriginDetails {
57 String originIdentifier;
58 Markable<WallTime, WallTime::MarkableTraits> creationTime;
59 Markable<WallTime, WallTime::MarkableTraits> modificationTime;
60 };
61 Vector<OriginDetails> originDetails();
62
63private:
64 LocalStorageDatabaseTracker(Ref<WorkQueue>&&, const String& localStorageDirectory);
65
66 String databasePath(const String& filename) const;
67
68 enum DatabaseOpeningStrategy {
69 CreateIfNonExistent,
70 SkipIfNonExistent
71 };
72
73 RefPtr<WorkQueue> m_queue;
74 String m_localStorageDirectory;
75
76#if PLATFORM(IOS_FAMILY)
77 void platformMaybeExcludeFromBackup() const;
78
79 mutable bool m_hasExcludedFromBackup { false };
80#endif
81};
82
83} // namespace WebKit
84