126c9fc0820393ad77bb12a7a117e67ad82d40b5
[WebKit-https.git] / Source / WebCore / inspector / InspectorPageAgent.h
1 /*
2  * Copyright (C) 2011 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 are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #pragma once
33
34 #include "InspectorWebAgentBase.h"
35 #include "IntSize.h"
36 #include "LayoutRect.h"
37 #include <inspector/InspectorBackendDispatchers.h>
38 #include <inspector/InspectorFrontendDispatchers.h>
39 #include <wtf/HashMap.h>
40 #include <wtf/text/WTFString.h>
41
42 namespace Inspector {
43 class InspectorArray;
44 class InspectorObject;
45 }
46
47 namespace WebCore {
48
49 class CachedResource;
50 class DOMWrapperWorld;
51 class DocumentLoader;
52 class Frame;
53 class Frontend;
54 class InspectorClient;
55 class InspectorOverlay;
56 class MainFrame;
57 class URL;
58 class Page;
59 class RenderObject;
60 class SharedBuffer;
61 class TextResourceDecoder;
62
63 typedef String ErrorString;
64
65 class InspectorPageAgent final : public InspectorAgentBase, public Inspector::PageBackendDispatcherHandler {
66     WTF_MAKE_NONCOPYABLE(InspectorPageAgent);
67     WTF_MAKE_FAST_ALLOCATED;
68 public:
69     InspectorPageAgent(PageAgentContext&, InspectorClient*, InspectorOverlay*);
70
71     enum ResourceType {
72         DocumentResource,
73         StylesheetResource,
74         ImageResource,
75         FontResource,
76         ScriptResource,
77         XHRResource,
78         WebSocketResource,
79         OtherResource
80     };
81
82     static bool cachedResourceContent(CachedResource*, String* result, bool* base64Encoded);
83     static bool sharedBufferContent(RefPtr<SharedBuffer>&&, const String& textEncodingName, bool withBase64Encode, String* result);
84     static void resourceContent(ErrorString&, Frame*, const URL&, String* result, bool* base64Encoded);
85     static String sourceMapURLForResource(CachedResource*);
86
87     static PassRefPtr<SharedBuffer> resourceData(Frame*, const URL&, String* textEncodingName);
88     static CachedResource* cachedResource(Frame*, const URL&);
89     static Inspector::Protocol::Page::ResourceType resourceTypeJson(ResourceType);
90     static ResourceType cachedResourceType(const CachedResource&);
91     static Inspector::Protocol::Page::ResourceType cachedResourceTypeJson(const CachedResource&);
92
93     // Page API for InspectorFrontend
94     void enable(ErrorString&) override;
95     void disable(ErrorString&) override;
96     void addScriptToEvaluateOnLoad(ErrorString&, const String& source, String* result) override;
97     void removeScriptToEvaluateOnLoad(ErrorString&, const String& identifier) override;
98     void reload(ErrorString&, const bool* optionalIgnoreCache, const String* optionalScriptToEvaluateOnLoad) override;
99     void navigate(ErrorString&, const String& url) override;
100     void getCookies(ErrorString&, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Page::Cookie>>& cookies) override;
101     void deleteCookie(ErrorString&, const String& cookieName, const String& url) override;
102     void getResourceTree(ErrorString&, RefPtr<Inspector::Protocol::Page::FrameResourceTree>&) override;
103     void getResourceContent(ErrorString&, const String& frameId, const String& url, String* content, bool* base64Encoded) override;
104     void searchInResource(ErrorString&, const String& frameId, const String& url, const String& query, const bool* optionalCaseSensitive, const bool* optionalIsRegex, const String* optionalRequestId, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::GenericTypes::SearchMatch>>&) override;
105     void searchInResources(ErrorString&, const String&, const bool* caseSensitive, const bool* isRegex, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Page::SearchResult>>&) override;
106     void setDocumentContent(ErrorString&, const String& frameId, const String& html) override;
107     void setShowPaintRects(ErrorString&, bool show) override;
108     void getScriptExecutionStatus(ErrorString&, Inspector::PageBackendDispatcherHandler::Result*) override;
109     void setScriptExecutionDisabled(ErrorString&, bool) override;
110     void setTouchEmulationEnabled(ErrorString&, bool) override;
111     void setEmulatedMedia(ErrorString&, const String&) override;
112     void getCompositingBordersVisible(ErrorString&, bool* out_param) override;
113     void setCompositingBordersVisible(ErrorString&, bool) override;
114     void snapshotNode(ErrorString&, int nodeId, String* outDataURL) override;
115     void snapshotRect(ErrorString&, int x, int y, int width, int height, const String& coordinateSystem, String* outDataURL) override;
116     void handleJavaScriptDialog(ErrorString&, bool accept, const String* promptText) override;
117     void archive(ErrorString&, String* data) override;
118
119     // InspectorInstrumentation callbacks.
120     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld&);
121     void domContentEventFired();
122     void loadEventFired();
123     void frameNavigated(Frame&);
124     void frameDetached(Frame&);
125     void loaderDetachedFromFrame(DocumentLoader&);
126     void frameStartedLoading(Frame&);
127     void frameStoppedLoading(Frame&);
128     void frameScheduledNavigation(Frame&, double delay);
129     void frameClearedScheduledNavigation(Frame&);
130     void willRunJavaScriptDialog(const String& message);
131     void didRunJavaScriptDialog();
132     void applyEmulatedMedia(String&);
133     void didPaint(RenderObject&, const LayoutRect&);
134     void didLayout();
135     void didScroll();
136     void didRecalculateStyle();
137     void scriptsEnabled(bool isEnabled);
138
139     // Inspector Controller API
140     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) override;
141     void willDestroyFrontendAndBackend(Inspector::DisconnectReason) override;
142
143     // Cross-agents API
144     Page& page() { return m_page; }
145     MainFrame& mainFrame();
146     String createIdentifier();
147     Frame* frameForId(const String& frameId);
148     WEBCORE_EXPORT String frameId(Frame*);
149     bool hasIdForFrame(Frame*) const;
150     String loaderId(DocumentLoader*);
151     Frame* findFrameWithSecurityOrigin(const String& originRawString);
152     Frame* assertFrame(ErrorString&, const String& frameId);
153     static DocumentLoader* assertDocumentLoader(ErrorString&, Frame*);
154
155 private:
156 #if ENABLE(TOUCH_EVENTS)
157     void updateTouchEventEmulationInPage(bool);
158 #endif
159
160     double timestamp();
161
162     static bool mainResourceContent(Frame*, bool withBase64Encode, String* result);
163     static bool dataContent(const char* data, unsigned size, const String& textEncodingName, bool withBase64Encode, String* result);
164
165     Ref<Inspector::Protocol::Page::Frame> buildObjectForFrame(Frame*);
166     Ref<Inspector::Protocol::Page::FrameResourceTree> buildObjectForFrameTree(Frame*);
167
168     std::unique_ptr<Inspector::PageFrontendDispatcher> m_frontendDispatcher;
169     RefPtr<Inspector::PageBackendDispatcher> m_backendDispatcher;
170
171     Page& m_page;
172     InspectorClient* m_client { nullptr };
173     InspectorOverlay* m_overlay { nullptr };
174
175     long m_lastScriptIdentifier { 0 };
176     String m_pendingScriptToEvaluateOnLoadOnce;
177     String m_scriptToEvaluateOnLoadOnce;
178     HashMap<Frame*, String> m_frameToIdentifier;
179     HashMap<String, Frame*> m_identifierToFrame;
180     HashMap<DocumentLoader*, String> m_loaderToIdentifier;
181     bool m_enabled { false };
182     bool m_isFirstLayoutAfterOnLoad { false };
183     bool m_originalScriptExecutionDisabled { false };
184     bool m_ignoreScriptsEnabledNotification { false };
185     bool m_showPaintRects { false };
186     String m_emulatedMedia;
187     RefPtr<Inspector::InspectorObject> m_scriptsToEvaluateOnLoad;
188 };
189
190 } // namespace WebCore