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