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 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 "InspectorWebAgentBase.h"
33#include "InspectorWebBackendDispatchers.h"
34#include "StorageArea.h"
35#include <wtf/HashMap.h>
36#include <wtf/text/WTFString.h>
37
38namespace Inspector {
39class InspectorArray;
40class InspectorDOMStorageFrontendDispatcher;
41}
42
43namespace WebCore {
44
45class Frame;
46class InspectorPageAgent;
47class InstrumentingAgents;
48class Page;
49class SecurityOrigin;
50class Storage;
51
52typedef String ErrorString;
53
54class InspectorDOMStorageAgent : public InspectorAgentBase, public Inspector::InspectorDOMStorageBackendDispatcherHandler {
55    WTF_MAKE_FAST_ALLOCATED;
56public:
57    InspectorDOMStorageAgent(InstrumentingAgents*, InspectorPageAgent*);
58    ~InspectorDOMStorageAgent();
59
60    virtual void didCreateFrontendAndBackend(Inspector::InspectorFrontendChannel*, Inspector::InspectorBackendDispatcher*) override;
61    virtual void willDestroyFrontendAndBackend(Inspector::InspectorDisconnectReason) override;
62
63    // Called from the front-end.
64    virtual void enable(ErrorString*) override;
65    virtual void disable(ErrorString*) override;
66    virtual void getDOMStorageItems(ErrorString*, const RefPtr<Inspector::InspectorObject>& storageId, RefPtr<Inspector::TypeBuilder::Array<Inspector::TypeBuilder::Array<String>>>& items) override;
67    virtual void setDOMStorageItem(ErrorString*, const RefPtr<Inspector::InspectorObject>& storageId, const String& key, const String& value) override;
68    virtual void removeDOMStorageItem(ErrorString*, const RefPtr<Inspector::InspectorObject>& storageId, const String& key) override;
69
70    // Called from the injected script.
71    String storageId(Storage*);
72    PassRefPtr<Inspector::TypeBuilder::DOMStorage::StorageId> storageId(SecurityOrigin*, bool isLocalStorage);
73
74    // Called from InspectorInstrumentation
75    void didDispatchDOMStorageEvent(const String& key, const String& oldValue, const String& newValue, StorageType, SecurityOrigin*, Page*);
76
77private:
78    PassRefPtr<StorageArea> findStorageArea(ErrorString*, const RefPtr<Inspector::InspectorObject>&, Frame*&);
79
80    InspectorPageAgent* m_pageAgent;
81    std::unique_ptr<Inspector::InspectorDOMStorageFrontendDispatcher> m_frontendDispatcher;
82    RefPtr<Inspector::InspectorDOMStorageBackendDispatcher> m_backendDispatcher;
83    bool m_enabled;
84};
85
86} // namespace WebCore
87
88#endif // !defined(InspectorDOMStorageAgent_h)
89