1/*
2 * Copyright (C) 2010 Google Inc. All rights reserved.
3 * Copyright (C) 2015 Apple Inc. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of Apple Inc. ("Apple") nor the names of
15 * its contributors may be used to endorse or promote products derived
16 * from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30#pragma once
31
32#include "InspectorWebAgentBase.h"
33#include "StorageArea.h"
34#include <JavaScriptCore/InspectorBackendDispatchers.h>
35#include <wtf/text/WTFString.h>
36
37namespace Inspector {
38class DOMStorageFrontendDispatcher;
39}
40
41namespace WebCore {
42
43class Frame;
44class Page;
45class SecurityOrigin;
46class Storage;
47
48typedef String ErrorString;
49
50class InspectorDOMStorageAgent final : public InspectorAgentBase, public Inspector::DOMStorageBackendDispatcherHandler {
51 WTF_MAKE_NONCOPYABLE(InspectorDOMStorageAgent);
52 WTF_MAKE_FAST_ALLOCATED;
53public:
54 InspectorDOMStorageAgent(PageAgentContext&);
55 virtual ~InspectorDOMStorageAgent() = default;
56
57 void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) override;
58 void willDestroyFrontendAndBackend(Inspector::DisconnectReason) override;
59
60 // Called from the front-end.
61 void enable(ErrorString&) override;
62 void disable(ErrorString&) override;
63 void getDOMStorageItems(ErrorString&, const JSON::Object& storageId, RefPtr<JSON::ArrayOf<JSON::ArrayOf<String>>>& items) override;
64 void setDOMStorageItem(ErrorString&, const JSON::Object& storageId, const String& key, const String& value) override;
65 void removeDOMStorageItem(ErrorString&, const JSON::Object& storageId, const String& key) override;
66
67 // Called from the injected script.
68 static String storageId(Storage&);
69 static RefPtr<Inspector::Protocol::DOMStorage::StorageId> storageId(SecurityOrigin*, bool isLocalStorage);
70
71 // InspectorInstrumentation
72 void didDispatchDOMStorageEvent(const String& key, const String& oldValue, const String& newValue, StorageType, SecurityOrigin*);
73
74private:
75 RefPtr<StorageArea> findStorageArea(ErrorString&, const JSON::Object&, Frame*&);
76
77 std::unique_ptr<Inspector::DOMStorageFrontendDispatcher> m_frontendDispatcher;
78 RefPtr<Inspector::DOMStorageBackendDispatcher> m_backendDispatcher;
79
80 Page& m_inspectedPage;
81};
82
83} // namespace WebCore
84