Home | History | Annotate | Download | only in inspector
      1 /*
      2  * Copyright (C) 2010 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  *
      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 InspectorDOMStorageAgent_h
     30 #define InspectorDOMStorageAgent_h
     31 
     32 #include "core/InspectorFrontend.h"
     33 #include "core/inspector/InspectorBaseAgent.h"
     34 #include "core/storage/StorageArea.h"
     35 #include "wtf/PassOwnPtr.h"
     36 #include "wtf/text/WTFString.h"
     37 
     38 namespace blink {
     39 
     40 class LocalFrame;
     41 class InspectorPageAgent;
     42 class InstrumentingAgents;
     43 class JSONObject;
     44 class Storage;
     45 class StorageArea;
     46 
     47 typedef String ErrorString;
     48 
     49 class InspectorDOMStorageAgent FINAL : public InspectorBaseAgent<InspectorDOMStorageAgent>, public InspectorBackendDispatcher::DOMStorageCommandHandler {
     50 public:
     51     static PassOwnPtrWillBeRawPtr<InspectorDOMStorageAgent> create(InspectorPageAgent* pageAgent)
     52     {
     53         return adoptPtrWillBeNoop(new InspectorDOMStorageAgent(pageAgent));
     54     }
     55     virtual ~InspectorDOMStorageAgent();
     56     virtual void trace(Visitor*) OVERRIDE;
     57 
     58     virtual void setFrontend(InspectorFrontend*) OVERRIDE;
     59     virtual void clearFrontend() OVERRIDE;
     60     virtual void restore() OVERRIDE;
     61 
     62     // Called from the front-end.
     63     virtual void enable(ErrorString*) OVERRIDE;
     64     virtual void disable(ErrorString*) OVERRIDE;
     65     virtual void getDOMStorageItems(ErrorString*, const RefPtr<JSONObject>& storageId, RefPtr<TypeBuilder::Array<TypeBuilder::Array<String> > >& items) OVERRIDE;
     66     virtual void setDOMStorageItem(ErrorString*, const RefPtr<JSONObject>& storageId, const String& key, const String& value) OVERRIDE;
     67     virtual void removeDOMStorageItem(ErrorString*, const RefPtr<JSONObject>& storageId, const String& key) OVERRIDE;
     68 
     69     // Called from InspectorInstrumentation
     70     void didDispatchDOMStorageEvent(const String& key, const String& oldValue, const String& newValue, StorageType, SecurityOrigin*);
     71 
     72 private:
     73 
     74     explicit InspectorDOMStorageAgent(InspectorPageAgent*);
     75 
     76     bool isEnabled() const;
     77     PassOwnPtrWillBeRawPtr<StorageArea> findStorageArea(ErrorString*, const RefPtr<JSONObject>&, LocalFrame*&);
     78     PassRefPtr<TypeBuilder::DOMStorage::StorageId> storageId(SecurityOrigin*, bool isLocalStorage);
     79 
     80     RawPtrWillBeMember<InspectorPageAgent> m_pageAgent;
     81     InspectorFrontend::DOMStorage* m_frontend;
     82 };
     83 
     84 } // namespace blink
     85 
     86 #endif // !defined(InspectorDOMStorageAgent_h)
     87