Home | History | Annotate | Download | only in webdatabase 
      1 /*
      2  * Copyright (C) 2007, 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 SQLTransaction_h
     30 #define SQLTransaction_h
     31 
     32 #include "bindings/v8/ScriptWrappable.h"
     33 #include "modules/webdatabase/AbstractSQLTransaction.h"
     34 #include "modules/webdatabase/SQLCallbackWrapper.h"
     35 #include "modules/webdatabase/SQLStatement.h"
     36 #include "modules/webdatabase/SQLTransactionStateMachine.h"
     37 #include "wtf/PassRefPtr.h"
     38 #include "wtf/RefPtr.h"
     39 
     40 namespace WebCore {
     41 
     42 class AbstractSQLTransactionBackend;
     43 class Database;
     44 class ExceptionState;
     45 class SQLError;
     46 class SQLStatementCallback;
     47 class SQLStatementErrorCallback;
     48 class SQLTransactionCallback;
     49 class SQLTransactionErrorCallback;
     50 class SQLValue;
     51 class VoidCallback;
     52 
     53 class SQLTransaction : public SQLTransactionStateMachine<SQLTransaction>, public AbstractSQLTransaction, public ScriptWrappable {
     54 public:
     55     static PassRefPtr<SQLTransaction> create(Database*, PassRefPtr<SQLTransactionCallback>,
     56         PassRefPtr<VoidCallback> successCallback, PassRefPtr<SQLTransactionErrorCallback>,
     57         bool readOnly);
     58 
     59     void performPendingCallback();
     60 
     61     void executeSQL(const String& sqlStatement, const Vector<SQLValue>& arguments,
     62         PassRefPtr<SQLStatementCallback>, PassRefPtr<SQLStatementErrorCallback>, ExceptionState&);
     63 
     64     Database* database() { return m_database.get(); }
     65 
     66 private:
     67     SQLTransaction(Database*, PassRefPtr<SQLTransactionCallback>,
     68         PassRefPtr<VoidCallback> successCallback, PassRefPtr<SQLTransactionErrorCallback>,
     69         bool readOnly);
     70 
     71     void clearCallbackWrappers();
     72 
     73     // APIs called from the backend published via AbstractSQLTransaction:
     74     virtual void requestTransitToState(SQLTransactionState) OVERRIDE;
     75     virtual bool hasCallback() const OVERRIDE;
     76     virtual bool hasSuccessCallback() const OVERRIDE;
     77     virtual bool hasErrorCallback() const OVERRIDE;
     78     virtual void setBackend(AbstractSQLTransactionBackend*) OVERRIDE;
     79 
     80     // State Machine functions:
     81     virtual StateFunction stateFunctionFor(SQLTransactionState) OVERRIDE;
     82     bool computeNextStateAndCleanupIfNeeded();
     83 
     84     // State functions:
     85     SQLTransactionState deliverTransactionCallback();
     86     SQLTransactionState deliverTransactionErrorCallback();
     87     SQLTransactionState deliverStatementCallback();
     88     SQLTransactionState deliverQuotaIncreaseCallback();
     89     SQLTransactionState deliverSuccessCallback();
     90 
     91     SQLTransactionState unreachableState();
     92     SQLTransactionState sendToBackendState();
     93 
     94     SQLTransactionState nextStateForTransactionError();
     95 
     96     RefPtr<Database> m_database;
     97     RefPtr<AbstractSQLTransactionBackend> m_backend;
     98     SQLCallbackWrapper<SQLTransactionCallback> m_callbackWrapper;
     99     SQLCallbackWrapper<VoidCallback> m_successCallbackWrapper;
    100     SQLCallbackWrapper<SQLTransactionErrorCallback> m_errorCallbackWrapper;
    101 
    102     bool m_executeSqlAllowed;
    103     RefPtr<SQLError> m_transactionError;
    104 
    105     bool m_readOnly;
    106 };
    107 
    108 } // namespace WebCore
    109 
    110 #endif // SQLTransaction_h
    111