b7d3812a77f3bfe49c0f2b1c82424a797016fdea
[WebKit-https.git] / Source / WebCore / Modules / webdatabase / DatabaseManager.h
1 /*
2  * Copyright (C) 2012 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef DatabaseManager_h
27 #define DatabaseManager_h
28
29 #if ENABLE(SQL_DATABASE)
30
31 #include "DatabaseDetails.h"
32 #include <wtf/RefPtr.h>
33 #include <wtf/Vector.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace WebCore {
37
38 class AbstractDatabaseServer;
39 class DatabaseManagerClient;
40 class DatabaseTaskSynchronizer;
41 class SecurityOrigin;
42 class ScriptExecutionContext;
43
44 class DatabaseManager {
45     WTF_MAKE_NONCOPYABLE(DatabaseManager); WTF_MAKE_FAST_ALLOCATED;
46 public:
47     static DatabaseManager& manager();
48
49     void initialize(const String& databasePath);
50 #if !PLATFORM(CHROMIUM)
51     void setClient(DatabaseManagerClient*);
52     String databaseDirectoryPath() const;
53     void setDatabaseDirectoryPath(const String&);
54 #endif
55
56     bool isAvailable();
57     void setIsAvailable(bool);
58
59     bool hasOpenDatabases(ScriptExecutionContext*);
60     // When the database cleanup is done, cleanupSync will be signalled.
61     void stopDatabases(ScriptExecutionContext*, DatabaseTaskSynchronizer*);
62
63     String fullPathForDatabase(SecurityOrigin*, const String& name, bool createIfDoesNotExist = true);
64
65 #if !PLATFORM(CHROMIUM)
66     bool hasEntryForOrigin(SecurityOrigin*);
67     void origins(Vector<RefPtr<SecurityOrigin> >& result);
68     bool databaseNamesForOrigin(SecurityOrigin*, Vector<String>& result);
69     DatabaseDetails detailsForNameAndOrigin(const String&, SecurityOrigin*);
70
71     unsigned long long usageForOrigin(SecurityOrigin*);
72     unsigned long long quotaForOrigin(SecurityOrigin*);
73
74     void setQuota(SecurityOrigin*, unsigned long long);
75
76     void deleteAllDatabases();
77     bool deleteOrigin(SecurityOrigin*);
78     bool deleteDatabase(SecurityOrigin*, const String& name);
79
80 #else // PLATFORM(CHROMIUM)
81     void closeDatabasesImmediately(const String& originIdentifier, const String& name);
82 #endif // PLATFORM(CHROMIUM)
83
84     void interruptAllDatabasesForContext(const ScriptExecutionContext*);
85
86 private:
87     DatabaseManager();
88     ~DatabaseManager() { }
89
90     AbstractDatabaseServer* m_server;
91 };
92
93 } // namespace WebCore
94
95 #endif // ENABLE(SQL_DATABASE)
96
97 #endif // DatabaseManager_h