Home | History | Annotate | Download | only in webdatabase
      1 /*
      2  * Copyright (C) 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  * 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 DatabaseBackend_h
     27 #define DatabaseBackend_h
     28 
     29 #include "modules/webdatabase/DatabaseBackendBase.h"
     30 #include "wtf/Deque.h"
     31 #include "wtf/text/WTFString.h"
     32 
     33 namespace WebCore {
     34 
     35 class ChangeVersionData;
     36 class Database;
     37 class DatabaseServer;
     38 class SQLTransaction;
     39 class SQLTransactionBackend;
     40 class SQLTransactionClient;
     41 class SQLTransactionCoordinator;
     42 
     43 // FIXME: This implementation of DatabaseBackend is only a place holder
     44 // for the split out of the Database backend to be done later. This
     45 // place holder is needed to allow other code that need to reference the
     46 // DatabaseBackend to do so before the proper backend split is
     47 // available. This should be replaced with the actual implementation later.
     48 
     49 class DatabaseBackend : public DatabaseBackendBase {
     50 public:
     51     DatabaseBackend(PassRefPtr<DatabaseContext>, const String& name, const String& expectedVersion, const String& displayName, unsigned long estimatedSize);
     52 
     53     virtual bool openAndVerifyVersion(bool setVersionInNewDatabase, DatabaseError&, String& errorMessage);
     54     void close();
     55 
     56     PassRefPtr<SQLTransactionBackend> runTransaction(PassRefPtr<SQLTransaction>, bool readOnly, const ChangeVersionData*);
     57     void scheduleTransactionStep(SQLTransactionBackend*);
     58     void inProgressTransactionCompleted();
     59 
     60     SQLTransactionClient* transactionClient() const;
     61     SQLTransactionCoordinator* transactionCoordinator() const;
     62 
     63 private:
     64     class DatabaseOpenTask;
     65     class DatabaseCloseTask;
     66     class DatabaseTransactionTask;
     67     class DatabaseTableNamesTask;
     68 
     69     virtual bool performOpenAndVerify(bool setVersionInNewDatabase, DatabaseError&, String& errorMessage);
     70 
     71     void scheduleTransaction();
     72 
     73     Deque<RefPtr<SQLTransactionBackend> > m_transactionQueue;
     74     Mutex m_transactionInProgressMutex;
     75     bool m_transactionInProgress;
     76     bool m_isTransactionQueueEnabled;
     77 
     78     friend class Database;
     79 };
     80 
     81 } // namespace WebCore
     82 
     83 #endif // DatabaseBackend_h
     84