src/third_party/WebKit/Source/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 #include "modules/webdatabase/DatabaseContext.h"
  30 #include "modules/webdatabase/DatabaseError.h"
  31 #include "platform/heap/Handle.h"
  32 #include "wtf/Assertions.h"
  33 #include "wtf/Forward.h"
  34 #include "wtf/HashMap.h"
  35
  36 namespace blink {
  37
  38 class Database;
  39 class DatabaseCallback;
  40 class DatabaseContext;
  41 class ExceptionState;
  42 class SecurityOrigin;
  43 class ExecutionContext;
  44
  45 class DatabaseManager {
  46     WTF_MAKE_NONCOPYABLE(DatabaseManager); WTF_MAKE_FAST_ALLOCATED;
  47 public:
  48     static DatabaseManager& manager();
  49
  50     // These 2 methods are for DatabaseContext (un)registration, and should only
  51     // be called by the DatabaseContext constructor and destructor.
  52     void registerDatabaseContext(DatabaseContext*);
  53     void unregisterDatabaseContext(DatabaseContext*);
  54
  55 #if ENABLE(ASSERT)
  56     void didConstructDatabaseContext();
  57     void didDestructDatabaseContext();
  58 #else
  59     void didConstructDatabaseContext() { }
  60     void didDestructDatabaseContext() { }
  61 #endif
  62
  63     static void throwExceptionForDatabaseError(DatabaseError, const String& errorMessage, ExceptionState&);
  64
  65     Database* openDatabase(ExecutionContext*, const String& name, const String& expectedVersion, const String& displayName, unsigned long estimatedSize, DatabaseCallback*, DatabaseError&, String& errorMessage);
  66
  67     String fullPathForDatabase(SecurityOrigin*, const String& name, bool createIfDoesNotExist = true);
  68
  69 private:
  70     DatabaseManager();
  71     ~DatabaseManager();
  72
  73     // This gets a DatabaseContext for the specified ExecutionContext.
  74     // If one doesn't already exist, it will create a new one.
  75     DatabaseContext* databaseContextFor(ExecutionContext*);
  76     // This gets a DatabaseContext for the specified ExecutionContext if
  77     // it already exist previously. Otherwise, it returns 0.
  78     DatabaseContext* existingDatabaseContextFor(ExecutionContext*);
  79
  80     Database* openDatabaseInternal(ExecutionContext*,
  81         const String& name, const String& expectedVersion, const String& displayName,
  82         unsigned long estimatedSize, bool setVersionInNewDatabase, DatabaseError&, String& errorMessage);
  83
  84     static void logErrorMessage(ExecutionContext*, const String& message);
  85
  86     typedef PersistentHeapHashMap<ExecutionContext*, Member<DatabaseContext> > ContextMap;
  87     ContextMap m_contextMap;
  88 #if ENABLE(ASSERT)
  89     int m_databaseContextRegisteredCount;
  90     int m_databaseContextInstanceCount;
  91 #endif
  92 };
  93
  94 } // namespace blink
  95
  96 #endif // DatabaseManager_h