src/third_party/WebKit/Source/modules/webdatabase/Database.h

   1 /*
   2  * Copyright (C) 2007, 2008, 2013 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  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef Database_h
  30 #define Database_h
  31
  32 #include "bindings/v8/ScriptWrappable.h"
  33 #include "modules/webdatabase/DatabaseBackend.h"
  34 #include "modules/webdatabase/DatabaseBase.h"
  35 #include "modules/webdatabase/DatabaseBasicTypes.h"
  36 #include "modules/webdatabase/DatabaseError.h"
  37 #include "wtf/text/WTFString.h"
  38
  39 namespace WebCore {
  40
  41 class ChangeVersionData;
  42 class DatabaseCallback;
  43 class DatabaseContext;
  44 class SecurityOrigin;
  45 class SQLTransaction;
  46 class SQLTransactionBackend;
  47 class SQLTransactionCallback;
  48 class SQLTransactionErrorCallback;
  49 class VoidCallback;
  50
  51 class Database FINAL : public DatabaseBase, public DatabaseBackend, public ScriptWrappable {
  52 public:
  53     virtual ~Database();
  54
  55     // Direct support for the DOM API
  56     virtual String version() const OVERRIDE;
  57     void changeVersion(const String& oldVersion, const String& newVersion, PassOwnPtr<SQLTransactionCallback>, PassOwnPtr<SQLTransactionErrorCallback>, PassOwnPtr<VoidCallback> successCallback);
  58     void transaction(PassOwnPtr<SQLTransactionCallback>, PassOwnPtr<SQLTransactionErrorCallback>, PassOwnPtr<VoidCallback> successCallback);
  59     void readTransaction(PassOwnPtr<SQLTransactionCallback>, PassOwnPtr<SQLTransactionErrorCallback>, PassOwnPtr<VoidCallback> successCallback);
  60
  61     // Internal engine support
  62     static Database* from(DatabaseBackend*);
  63     DatabaseContext* databaseContext() const { return m_databaseContext.get(); }
  64
  65     Vector<String> tableNames();
  66
  67     virtual SecurityOrigin* securityOrigin() const OVERRIDE;
  68
  69     virtual void closeImmediately() OVERRIDE;
  70
  71     void scheduleTransactionCallback(SQLTransaction*);
  72
  73 private:
  74     Database(PassRefPtr<DatabaseContext>, const String& name,
  75         const String& expectedVersion, const String& displayName, unsigned long estimatedSize);
  76     PassRefPtr<DatabaseBackend> backend();
  77     static PassRefPtr<Database> create(ExecutionContext*, PassRefPtr<DatabaseBackendBase>);
  78
  79     void runTransaction(PassOwnPtr<SQLTransactionCallback>, PassOwnPtr<SQLTransactionErrorCallback>,
  80         PassOwnPtr<VoidCallback> successCallback, bool readOnly, const ChangeVersionData* = 0);
  81
  82     Vector<String> performGetTableNames();
  83
  84     void reportStartTransactionResult(int errorSite, int webSqlErrorCode, int sqliteErrorCode);
  85     void reportCommitTransactionResult(int errorSite, int webSqlErrorCode, int sqliteErrorCode);
  86
  87     RefPtr<SecurityOrigin> m_databaseThreadSecurityOrigin;
  88     RefPtr<DatabaseContext> m_databaseContext;
  89
  90     friend class DatabaseManager;
  91     friend class DatabaseServer; // FIXME: remove this when the backend has been split out.
  92     friend class DatabaseBackend; // FIXME: remove this when the backend has been split out.
  93     friend class SQLStatement;
  94     friend class SQLTransaction;
  95 };
  96
  97 } // namespace WebCore
  98
  99 #endif // Database_h