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#include "SQLiteDatabase.h"
30#include <wtf/HashSet.h>
31#include <wtf/Vector.h>
32#include <wtf/text/StringHash.h>
33#include <wtf/text/WTFString.h>
34
35namespace WebCore {
36
37class StorageTask;
38class StorageThread;
39class SecurityOrigin;
40class StorageTrackerClient;
41
42class StorageTracker {
43    WTF_MAKE_NONCOPYABLE(StorageTracker);
44    WTF_MAKE_FAST_ALLOCATED;
45public:
46    static void initializeTracker(const String& storagePath, StorageTrackerClient*);
47    static StorageTracker& tracker();
48
49    void setDatabaseDirectoryPath(const String&);
50    String databaseDirectoryPath() const;
51
52    void setOriginDetails(const String& originIdentifier, const String& databaseFile);
53
54    void deleteAllOrigins();
55    void deleteOrigin(SecurityOrigin*);
56    void deleteOriginWithIdentifier(const String& originIdentifier);
57    void origins(Vector<RefPtr<SecurityOrigin>>& result);
58    long long diskUsageForOrigin(SecurityOrigin*);
59
60    void cancelDeletingOrigin(const String& originIdentifier);
61
62    bool isActive();
63
64    double storageDatabaseIdleInterval() { return m_StorageDatabaseIdleInterval; }
65    void setStorageDatabaseIdleInterval(double interval) { m_StorageDatabaseIdleInterval = interval; }
66
67    void syncFileSystemAndTrackerDatabase();
68
69private:
70    explicit StorageTracker(const String& storagePath);
71
72    void internalInitialize();
73
74    String trackerDatabasePath();
75    void openTrackerDatabase(bool createIfDoesNotExist);
76
77    void importOriginIdentifiers();
78    void finishedImportingOriginIdentifiers();
79
80    void deleteTrackerFiles();
81    String databasePathForOrigin(const String& originIdentifier);
82
83    bool canDeleteOrigin(const String& originIdentifier);
84    void willDeleteOrigin(const String& originIdentifier);
85    void willDeleteAllOrigins();
86
87    void originFilePaths(Vector<String>& paths);
88
89    void setIsActive(bool);
90
91    // Sync to disk on background thread.
92    void syncDeleteAllOrigins();
93    void syncDeleteOrigin(const String& originIdentifier);
94    void syncSetOriginDetails(const String& originIdentifier, const String& databaseFile);
95    void syncImportOriginIdentifiers();
96
97    // Mutex for m_database and m_storageDirectoryPath.
98    Mutex m_databaseMutex;
99    SQLiteDatabase m_database;
100    String m_storageDirectoryPath;
101
102    Mutex m_clientMutex;
103    StorageTrackerClient* m_client;
104
105    // Guard for m_originSet and m_originsBeingDeleted.
106    Mutex m_originSetMutex;
107    typedef HashSet<String> OriginSet;
108    OriginSet m_originSet;
109    OriginSet m_originsBeingDeleted;
110
111    std::unique_ptr<StorageThread> m_thread;
112
113    bool m_isActive;
114    bool m_needsInitialization;
115    double m_StorageDatabaseIdleInterval;
116};
117
118} // namespace WebCore
119
120#endif // StorageTracker_h
121