Home | History | Annotate | Download | only in storage
      1 /*
      2  * Copyright (C) 2009 Google 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 GOOGLE 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 GOOGLE 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 StorageArea_h
     27 #define StorageArea_h
     28 
     29 #include "platform/heap/Handle.h"
     30 #include "wtf/OwnPtr.h"
     31 #include "wtf/PassOwnPtr.h"
     32 #include "wtf/text/WTFString.h"
     33 
     34 namespace blink {
     35 class WebStorageArea;
     36 class WebStorageNamespace;
     37 }
     38 
     39 namespace WebCore {
     40 
     41 class ExceptionState;
     42 class LocalFrame;
     43 class KURL;
     44 class Page;
     45 class SecurityOrigin;
     46 class Storage;
     47 
     48 enum StorageType {
     49     LocalStorage,
     50     SessionStorage
     51 };
     52 
     53 class StorageArea : public NoBaseWillBeGarbageCollectedFinalized<StorageArea> {
     54 public:
     55     StorageArea(PassOwnPtr<blink::WebStorageArea>, StorageType);
     56     virtual ~StorageArea();
     57 
     58     // The HTML5 DOM Storage API
     59     unsigned length(ExceptionState&, LocalFrame* sourceFrame);
     60     String key(unsigned index, ExceptionState&, LocalFrame* sourceFrame);
     61     String getItem(const String& key, ExceptionState&, LocalFrame* sourceFrame);
     62     void setItem(const String& key, const String& value, ExceptionState&, LocalFrame* sourceFrame);
     63     void removeItem(const String& key, ExceptionState&, LocalFrame* sourceFrame);
     64     void clear(ExceptionState&, LocalFrame* sourceFrame);
     65     bool contains(const String& key, ExceptionState&, LocalFrame* sourceFrame);
     66 
     67     bool canAccessStorage(LocalFrame*);
     68     size_t memoryBytesUsedByCache();
     69 
     70     static void dispatchLocalStorageEvent(const String& key, const String& oldValue, const String& newValue,
     71         SecurityOrigin*, const KURL& pageURL, blink::WebStorageArea* sourceAreaInstance, bool originatedInProcess);
     72     static void dispatchSessionStorageEvent(const String& key, const String& oldValue, const String& newValue,
     73         SecurityOrigin*, const KURL& pageURL, const blink::WebStorageNamespace&,
     74         blink::WebStorageArea* sourceAreaInstance, bool originatedInProcess);
     75 
     76     void trace(Visitor*) { }
     77 
     78 private:
     79     static bool isEventSource(Storage*, blink::WebStorageArea* sourceAreaInstance);
     80 
     81     OwnPtr<blink::WebStorageArea> m_storageArea;
     82     StorageType m_storageType;
     83     bool m_canAccessStorageCachedResult;
     84     LocalFrame* m_canAccessStorageCachedFrame;
     85 };
     86 
     87 } // namespace WebCore
     88 
     89 #endif // StorageArea_h
     90