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#include "modules/webdatabase/DatabaseBasicTypes.h"
30#include "modules/webdatabase/DatabaseDetails.h"
31#include "modules/webdatabase/DatabaseError.h"
32#include "wtf/Assertions.h"
33#include "wtf/HashMap.h"
34#include "wtf/PassRefPtr.h"
35#include "wtf/ThreadingPrimitives.h"
36
37namespace WebCore {
38
39class AbstractDatabaseServer;
40class Database;
41class DatabaseBackendBase;
42class DatabaseCallback;
43class DatabaseContext;
44class DatabaseSync;
45class DatabaseTaskSynchronizer;
46class SecurityOrigin;
47class ScriptExecutionContext;
48
49typedef int ExceptionCode;
50
51class DatabaseManager {
52    WTF_MAKE_NONCOPYABLE(DatabaseManager); WTF_MAKE_FAST_ALLOCATED;
53public:
54    static DatabaseManager& manager();
55
56    // This gets a DatabaseContext for the specified ScriptExecutionContext.
57    // If one doesn't already exist, it will create a new one.
58    PassRefPtr<DatabaseContext> databaseContextFor(ScriptExecutionContext*);
59
60    // These 2 methods are for DatabaseContext (un)registration, and should only
61    // be called by the DatabaseContext constructor and destructor.
62    void registerDatabaseContext(DatabaseContext*);
63    void unregisterDatabaseContext(DatabaseContext*);
64
65#if !ASSERT_DISABLED
66    void didConstructDatabaseContext();
67    void didDestructDatabaseContext();
68#else
69    void didConstructDatabaseContext() { }
70    void didDestructDatabaseContext() { }
71#endif
72
73    static ExceptionCode exceptionCodeForDatabaseError(DatabaseError);
74
75    PassRefPtr<Database> openDatabase(ScriptExecutionContext*, const String& name, const String& expectedVersion, const String& displayName, unsigned long estimatedSize, PassRefPtr<DatabaseCallback>, DatabaseError&);
76    PassRefPtr<DatabaseSync> openDatabaseSync(ScriptExecutionContext*, const String& name, const String& expectedVersion, const String& displayName, unsigned long estimatedSize, PassRefPtr<DatabaseCallback>, DatabaseError&);
77
78    bool hasOpenDatabases(ScriptExecutionContext*);
79    void stopDatabases(ScriptExecutionContext*, DatabaseTaskSynchronizer*);
80
81    String fullPathForDatabase(SecurityOrigin*, const String& name, bool createIfDoesNotExist = true);
82
83    void closeDatabasesImmediately(const String& originIdentifier, const String& name);
84
85    void interruptAllDatabasesForContext(ScriptExecutionContext*);
86
87private:
88    DatabaseManager();
89    ~DatabaseManager() { }
90
91    // This gets a DatabaseContext for the specified ScriptExecutionContext if
92    // it already exist previously. Otherwise, it returns 0.
93    PassRefPtr<DatabaseContext> existingDatabaseContextFor(ScriptExecutionContext*);
94
95    PassRefPtr<DatabaseBackendBase> openDatabaseBackend(ScriptExecutionContext*,
96        DatabaseType, const String& name, const String& expectedVersion, const String& displayName,
97        unsigned long estimatedSize, bool setVersionInNewDatabase, DatabaseError&, String& errorMessage);
98
99    static void logErrorMessage(ScriptExecutionContext*, const String& message);
100
101    AbstractDatabaseServer* m_server;
102
103    // Access to the following fields require locking m_contextMapLock:
104    typedef HashMap<ScriptExecutionContext*, DatabaseContext*> ContextMap;
105    ContextMap m_contextMap;
106#if !ASSERT_DISABLED
107    int m_databaseContextRegisteredCount;
108    int m_databaseContextInstanceCount;
109#endif
110    Mutex m_contextMapLock;
111};
112
113} // namespace WebCore
114
115#endif // DatabaseManager_h
116