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/core/v8/ScriptWrappable.h"
     33 #include "modules/webdatabase/SQLStatement.h"
     34 #include "modules/webdatabase/SQLTransactionStateMachine.h"
     35 #include "platform/heap/Handle.h"
     36 #include "wtf/PassRefPtr.h"
     37 #include "wtf/RefPtr.h"
     38 
     39 namespace blink {
     40 
     41 class Database;
     42 class ExceptionState;
     43 class SQLErrorData;
     44 class SQLStatementCallback;
     45 class SQLStatementErrorCallback;
     46 class SQLTransactionBackend;
     47 class SQLTransactionCallback;
     48 class SQLTransactionErrorCallback;
     49 class SQLValue;
     50 class VoidCallback;
     51 
     52 class SQLTransaction FINAL
     53     : public ThreadSafeRefCountedWillBeGarbageCollectedFinalized<SQLTransaction>
     54     , public SQLTransactionStateMachine<SQLTransaction>
     55     , public ScriptWrappable {
     56     DEFINE_WRAPPERTYPEINFO();
     57 public:
     58     static PassRefPtrWillBeRawPtr<SQLTransaction> create(Database*, SQLTransactionCallback*,
     59         VoidCallback* successCallback, SQLTransactionErrorCallback*,
     60         bool readOnly);
     61     ~SQLTransaction();
     62     void trace(Visitor*);
     63 
     64     void performPendingCallback();
     65 
     66     void executeSQL(const String& sqlStatement, const Vector<SQLValue>& arguments,
     67         SQLStatementCallback*, SQLStatementErrorCallback*, ExceptionState&);
     68 
     69     Database* database() { return m_database.get(); }
     70 
     71     SQLTransactionErrorCallback* releaseErrorCallback();
     72 
     73     // APIs called from the backend published:
     74     void requestTransitToState(SQLTransactionState);
     75     bool hasCallback() const;
     76     bool hasSuccessCallback() const;
     77     bool hasErrorCallback() const;
     78     void setBackend(SQLTransactionBackend*);
     79 
     80 private:
     81     SQLTransaction(Database*, SQLTransactionCallback*,
     82         VoidCallback* successCallback, SQLTransactionErrorCallback*,
     83         bool readOnly);
     84 
     85     void clearCallbacks();
     86 
     87     // State Machine functions:
     88     virtual StateFunction stateFunctionFor(SQLTransactionState) OVERRIDE;
     89     bool computeNextStateAndCleanupIfNeeded();
     90 
     91     // State functions:
     92     SQLTransactionState deliverTransactionCallback();
     93     SQLTransactionState deliverTransactionErrorCallback();
     94     SQLTransactionState deliverStatementCallback();
     95     SQLTransactionState deliverQuotaIncreaseCallback();
     96     SQLTransactionState deliverSuccessCallback();
     97 
     98     SQLTransactionState unreachableState();
     99     SQLTransactionState sendToBackendState();
    100 
    101     SQLTransactionState nextStateForTransactionError();
    102 
    103     RefPtrWillBeMember<Database> m_database;
    104     RefPtrWillBeMember<SQLTransactionBackend> m_backend;
    105     CrossThreadPersistentWillBeMember<SQLTransactionCallback> m_callback;
    106     CrossThreadPersistentWillBeMember<VoidCallback> m_successCallback;
    107     CrossThreadPersistentWillBeMember<SQLTransactionErrorCallback> m_errorCallback;
    108 
    109     bool m_executeSqlAllowed;
    110     OwnPtr<SQLErrorData> m_transactionError;
    111 
    112     bool m_readOnly;
    113 };
    114 
    115 } // namespace blink
    116 
    117 #endif // SQLTransaction_h
    118