Home | History | Annotate | Download | only in storage 
      1 /*
      2  * Copyright (C) 2008, 2009 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 StorageAreaSync_h
     27 #define StorageAreaSync_h
     28 
     29 #if ENABLE(DOM_STORAGE)
     30 
     31 #include "PlatformString.h"
     32 #include "SQLiteDatabase.h"
     33 #include "StringHash.h"
     34 #include "Timer.h"
     35 #include <wtf/HashMap.h>
     36 
     37 namespace WebCore {
     38 
     39     class Frame;
     40     class StorageAreaImpl;
     41     class StorageSyncManager;
     42 
     43     class StorageAreaSync : public RefCounted<StorageAreaSync> {
     44     public:
     45         static PassRefPtr<StorageAreaSync> create(PassRefPtr<StorageSyncManager> storageSyncManager, PassRefPtr<StorageAreaImpl> storageArea, String databaseIdentifier);
     46         ~StorageAreaSync();
     47 
     48         void scheduleFinalSync();
     49         void blockUntilImportComplete();
     50 
     51         void scheduleItemForSync(const String& key, const String& value);
     52         void scheduleClear();
     53 
     54     private:
     55         StorageAreaSync(PassRefPtr<StorageSyncManager> storageSyncManager, PassRefPtr<StorageAreaImpl> storageArea, String databaseIdentifier);
     56 
     57         void dispatchStorageEvent(const String& key, const String& oldValue, const String& newValue, Frame* sourceFrame);
     58 
     59         Timer<StorageAreaSync> m_syncTimer;
     60         HashMap<String, String> m_changedItems;
     61         bool m_itemsCleared;
     62 
     63         bool m_finalSyncScheduled;
     64 
     65         RefPtr<StorageAreaImpl> m_storageArea;
     66         RefPtr<StorageSyncManager> m_syncManager;
     67 
     68         // The database handle will only ever be opened and used on the background thread.
     69         SQLiteDatabase m_database;
     70 
     71     // The following members are subject to thread synchronization issues.
     72     public:
     73         // Called from the background thread
     74         void performImport();
     75         void performSync();
     76 
     77     private:
     78         void syncTimerFired(Timer<StorageAreaSync>*);
     79         void sync(bool clearItems, const HashMap<String, String>& items);
     80 
     81         const String m_databaseIdentifier;
     82 
     83         Mutex m_syncLock;
     84         HashMap<String, String> m_itemsPendingSync;
     85         bool m_clearItemsWhileSyncing;
     86         bool m_syncScheduled;
     87 
     88         mutable Mutex m_importLock;
     89         mutable ThreadCondition m_importCondition;
     90         mutable bool m_importComplete;
     91         void markImported();
     92     };
     93 
     94 } // namespace WebCore
     95 
     96 #endif // ENABLE(DOM_STORAGE)
     97 
     98 #endif // StorageAreaSync_h
     99