Home | History | Annotate | Download | only in storage 
      1 /*
      2  * Copyright (C) 2007, 2008 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 #if ENABLE(DATABASE)
     33 #include "AbstractDatabase.h"
     34 #include "ExceptionCode.h"
     35 #include "PlatformString.h"
     36 
     37 #include <wtf/Deque.h>
     38 #include <wtf/Forward.h>
     39 
     40 namespace WebCore {
     41 
     42 class DatabaseCallback;
     43 class ScriptExecutionContext;
     44 class SecurityOrigin;
     45 class SQLTransaction;
     46 class SQLTransactionCallback;
     47 class SQLTransactionClient;
     48 class SQLTransactionCoordinator;
     49 class SQLTransactionErrorCallback;
     50 class VoidCallback;
     51 
     52 class Database : public AbstractDatabase {
     53 public:
     54     virtual ~Database();
     55 
     56     // Direct support for the DOM API
     57     static PassRefPtr<Database> openDatabase(ScriptExecutionContext*, const String& name, const String& expectedVersion, const String& displayName,
     58                                              unsigned long estimatedSize, PassRefPtr<DatabaseCallback>, ExceptionCode&);
     59     virtual String version() const;
     60     void changeVersion(const String& oldVersion, const String& newVersion, PassRefPtr<SQLTransactionCallback>,
     61                        PassRefPtr<SQLTransactionErrorCallback>, PassRefPtr<VoidCallback> successCallback);
     62     void transaction(PassRefPtr<SQLTransactionCallback>, PassRefPtr<SQLTransactionErrorCallback>, PassRefPtr<VoidCallback> successCallback);
     63     void readTransaction(PassRefPtr<SQLTransactionCallback>, PassRefPtr<SQLTransactionErrorCallback>, PassRefPtr<VoidCallback> successCallback);
     64 
     65     // Internal engine support
     66     Vector<String> tableNames();
     67 
     68     virtual SecurityOrigin* securityOrigin() const;
     69 
     70     virtual void markAsDeletedAndClose();
     71     bool deleted() const { return m_deleted; }
     72 
     73     void close();
     74     virtual void closeImmediately();
     75 
     76     unsigned long long databaseSize() const;
     77     unsigned long long maximumSize() const;
     78 
     79     void scheduleTransactionCallback(SQLTransaction*);
     80     void scheduleTransactionStep(SQLTransaction*, bool immediately = false);
     81 
     82     SQLTransactionClient* transactionClient() const;
     83     SQLTransactionCoordinator* transactionCoordinator() const;
     84 
     85 private:
     86     class DatabaseOpenTask;
     87     class DatabaseCloseTask;
     88     class DatabaseTransactionTask;
     89     class DatabaseTableNamesTask;
     90 
     91     Database(ScriptExecutionContext*, const String& name, const String& expectedVersion,
     92              const String& displayName, unsigned long estimatedSize);
     93     void runTransaction(PassRefPtr<SQLTransactionCallback>, PassRefPtr<SQLTransactionErrorCallback>,
     94                         PassRefPtr<VoidCallback> successCallback, bool readOnly);
     95 
     96     bool openAndVerifyVersion(bool setVersionInNewDatabase, ExceptionCode&);
     97     virtual bool performOpenAndVerify(bool setVersionInNewDatabase, ExceptionCode&);
     98 
     99     void inProgressTransactionCompleted();
    100     void scheduleTransaction();
    101 
    102     Vector<String> performGetTableNames();
    103 
    104     static void deliverPendingCallback(void*);
    105 
    106     Deque<RefPtr<SQLTransaction> > m_transactionQueue;
    107     Mutex m_transactionInProgressMutex;
    108     bool m_transactionInProgress;
    109     bool m_isTransactionQueueEnabled;
    110 
    111     RefPtr<SecurityOrigin> m_databaseThreadSecurityOrigin;
    112 
    113     bool m_deleted;
    114 };
    115 
    116 } // namespace WebCore
    117 
    118 #endif // ENABLE(DATABASE)
    119 
    120 #endif // Database_h
    121