• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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/inspector/InspectorBaseAgent.h"
33 #include "core/storage/StorageArea.h"
34 #include "wtf/PassOwnPtr.h"
35 #include "wtf/text/WTFString.h"
36 
37 namespace WebCore {
38 
39 class Frame;
40 class InspectorFrontend;
41 class InspectorPageAgent;
42 class InstrumentingAgents;
43 class JSONObject;
44 class Storage;
45 class StorageArea;
46 
47 typedef String ErrorString;
48 
49 class InspectorDOMStorageAgent : public InspectorBaseAgent<InspectorDOMStorageAgent>, public InspectorBackendDispatcher::DOMStorageCommandHandler {
50 public:
create(InstrumentingAgents * instrumentingAgents,InspectorPageAgent * pageAgent,InspectorCompositeState * state)51     static PassOwnPtr<InspectorDOMStorageAgent> create(InstrumentingAgents* instrumentingAgents, InspectorPageAgent* pageAgent, InspectorCompositeState* state)
52     {
53         return adoptPtr(new InspectorDOMStorageAgent(instrumentingAgents, pageAgent, state));
54     }
55     ~InspectorDOMStorageAgent();
56 
57     virtual void setFrontend(InspectorFrontend*);
58     virtual void clearFrontend();
59 
60     // Called from the front-end.
61     virtual void enable(ErrorString*);
62     virtual void disable(ErrorString*);
63     virtual void getDOMStorageItems(ErrorString*, const RefPtr<JSONObject>& storageId, RefPtr<TypeBuilder::Array<TypeBuilder::Array<String> > >& items);
64     virtual void setDOMStorageItem(ErrorString*, const RefPtr<JSONObject>& storageId, const String& key, const String& value);
65     virtual void removeDOMStorageItem(ErrorString*, const RefPtr<JSONObject>& storageId, const String& key);
66 
67     // Called from the injected script.
68     String storageId(Storage*);
69     PassRefPtr<TypeBuilder::DOMStorage::StorageId> storageId(SecurityOrigin*, bool isLocalStorage);
70 
71     // Called from InspectorInstrumentation
72     void didDispatchDOMStorageEvent(const String& key, const String& oldValue, const String& newValue, StorageType, SecurityOrigin*);
73 
74 private:
75 
76     InspectorDOMStorageAgent(InstrumentingAgents*, InspectorPageAgent*, InspectorCompositeState*);
77 
78     bool isEnabled() const;
79     PassOwnPtr<StorageArea> findStorageArea(ErrorString*, const RefPtr<JSONObject>&, Frame*&);
80 
81     InspectorPageAgent* m_pageAgent;
82     InspectorFrontend* m_frontend;
83 };
84 
85 } // namespace WebCore
86 
87 #endif // !defined(InspectorDOMStorageAgent_h)
88