WebCore/storage/LocalStorageArea.h

   1 /*
   2  * Copyright (C) 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  * 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 LocalStorageArea_h
  27 #define LocalStorageArea_h
  28
  29 #include "LocalStorageTask.h"
  30 #include "LocalStorageThread.h"
  31
  32 #include "SQLiteDatabase.h"
  33 #include "StorageArea.h"
  34 #include "StringHash.h"
  35 #include "Timer.h"
  36
  37 #include <wtf/HashMap.h>
  38 #include <wtf/PassRefPtr.h>
  39 #include <wtf/Threading.h>
  40
  41 namespace WebCore {
  42
  43     class LocalStorage;
  44
  45     class LocalStorageArea : public StorageArea {
  46     public:
  47         virtual ~LocalStorageArea();
  48
  49         static PassRefPtr<LocalStorageArea> create(SecurityOrigin* origin, LocalStorage* localStorage) { return adoptRef(new LocalStorageArea(origin, localStorage)); }
  50
  51         void scheduleFinalSync();
  52
  53     private:
  54         LocalStorageArea(SecurityOrigin*, LocalStorage*);
  55
  56         virtual void itemChanged(const String& key, const String& oldValue, const String& newValue, Frame* sourceFrame);
  57         virtual void itemRemoved(const String& key, const String& oldValue, Frame* sourceFrame);
  58         virtual void areaCleared(Frame* sourceFrame);
  59
  60         void scheduleItemForSync(const String& key, const String& value);
  61         void scheduleClear();
  62         void dispatchStorageEvent(const String& key, const String& oldValue, const String& newValue, Frame* sourceFrame);
  63
  64         Timer<LocalStorageArea> m_syncTimer;
  65         HashMap<String, String> m_changedItems;
  66         bool m_itemsCleared;
  67
  68         bool m_finalSyncScheduled;
  69
  70         LocalStorage* m_localStorage;
  71
  72         // The database handle will only ever be opened and used on the background thread.
  73         SQLiteDatabase m_database;
  74
  75     // The following members are subject to thread synchronization issues.
  76     public:
  77         // Called on the main thread
  78         virtual unsigned length() const;
  79         virtual String key(unsigned index, ExceptionCode&) const;
  80         virtual String getItem(const String&) const;
  81         virtual void setItem(const String& key, const String& value, ExceptionCode&, Frame* sourceFrame);
  82         virtual void removeItem(const String&, Frame* sourceFrame);
  83         virtual bool contains(const String& key) const;
  84
  85         // Called from the background thread
  86         virtual void performImport();
  87         virtual void performSync();
  88
  89     private:
  90         void syncTimerFired(Timer<LocalStorageArea>*);
  91
  92         Mutex m_syncLock;
  93         HashMap<String, String> m_itemsPendingSync;
  94         bool m_clearItemsWhileSyncing;
  95         bool m_syncScheduled;
  96
  97         mutable Mutex m_importLock;
  98         mutable ThreadCondition m_importCondition;
  99         mutable bool m_importComplete;
 100         void markImported();
 101     };
 102
 103 } // namespace WebCore
 104
 105 #endif // LocalStorageArea_h