9e301dbf68408a4fb03abf229a6eeed5f6d8eda4
[WebKit-https.git] / Source / WebCore / inspector / InspectorPageAgent.h
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  * Copyright (C) 2015-2016 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 "LayoutRect.h"
36 #include <inspector/InspectorBackendDispatchers.h>
37 #include <inspector/InspectorFrontendDispatchers.h>
38 #include <wtf/HashMap.h>
39 #include <wtf/Seconds.h>
40 #include <wtf/text/WTFString.h>
41
42 namespace Inspector {
43 class InspectorObject;
44 }
45
46 namespace WebCore {
47
48 class CachedResource;
49 class DOMWrapperWorld;
50 class DocumentLoader;
51 class Frame;
52 class InspectorClient;
53 class InspectorOverlay;
54 class MainFrame;
55 class Page;
56 class RenderObject;
57 class SharedBuffer;
58 class TextResourceDecoder;
59 class URL;
60
61 typedef String ErrorString;
62
63 class InspectorPageAgent final : public InspectorAgentBase, public Inspector::PageBackendDispatcherHandler {
64     WTF_MAKE_NONCOPYABLE(InspectorPageAgent);
65     WTF_MAKE_FAST_ALLOCATED;
66 public:
67     InspectorPageAgent(PageAgentContext&, InspectorClient*, InspectorOverlay*);
68
69     enum ResourceType {
70         DocumentResource,
71         StylesheetResource,
72         ImageResource,
73         FontResource,
74         ScriptResource,
75         XHRResource,
76         FetchResource,
77         WebSocketResource,
78         OtherResource,
79     };
80
81     static bool cachedResourceContent(CachedResource*, String* result, bool* base64Encoded);
82     static bool sharedBufferContent(RefPtr<SharedBuffer>&&, const String& textEncodingName, bool withBase64Encode, String* result);
83     static void resourceContent(ErrorString&, Frame*, const URL&, String* result, bool* base64Encoded);
84     static String sourceMapURLForResource(CachedResource*);
85
86     static CachedResource* cachedResource(Frame*, const URL&);
87     static Inspector::Protocol::Page::ResourceType resourceTypeJson(ResourceType);
88     static ResourceType cachedResourceType(const CachedResource&);
89     static Inspector::Protocol::Page::ResourceType cachedResourceTypeJson(const CachedResource&);
90     static RefPtr<TextResourceDecoder> createTextDecoder(const String& mimeType, const String& textEncodingName);
91
92     // Page API for InspectorFrontend
93     void enable(ErrorString&) override;
94     void disable(ErrorString&) override;
95     void reload(ErrorString&, const bool* const optionalReloadFromOrigin, const bool* const optionalRevalidateAllResources, const String* const optionalScriptToEvaluateOnLoad) override;
96     void navigate(ErrorString&, const String& url) override;
97     void getCookies(ErrorString&, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Page::Cookie>>& cookies) override;
98     void deleteCookie(ErrorString&, const String& cookieName, const String& url) override;
99     void getResourceTree(ErrorString&, RefPtr<Inspector::Protocol::Page::FrameResourceTree>&) override;
100     void getResourceContent(ErrorString&, const String& frameId, const String& url, String* content, bool* base64Encoded) override;
101     void searchInResource(ErrorString&, const String& frameId, const String& url, const String& query, const bool* const optionalCaseSensitive, const bool* const optionalIsRegex, const String* const optionalRequestId, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::GenericTypes::SearchMatch>>&) override;
102     void searchInResources(ErrorString&, const String&, const bool* const caseSensitive, const bool* const isRegex, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Page::SearchResult>>&) override;
103     void setShowPaintRects(ErrorString&, bool show) override;
104     void setEmulatedMedia(ErrorString&, const String&) override;
105     void getCompositingBordersVisible(ErrorString&, bool* out_param) override;
106     void setCompositingBordersVisible(ErrorString&, bool) override;
107     void snapshotNode(ErrorString&, int nodeId, String* outDataURL) override;
108     void snapshotRect(ErrorString&, int x, int y, int width, int height, const String& coordinateSystem, String* outDataURL) override;
109     void archive(ErrorString&, String* data) override;
110
111     // InspectorInstrumentation
112     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld&);
113     void domContentEventFired();
114     void loadEventFired();
115     void frameNavigated(Frame&);
116     void frameDetached(Frame&);
117     void loaderDetachedFromFrame(DocumentLoader&);
118     void frameStartedLoading(Frame&);
119     void frameStoppedLoading(Frame&);
120     void frameScheduledNavigation(Frame&, Seconds delay);
121     void frameClearedScheduledNavigation(Frame&);
122     void applyEmulatedMedia(String&);
123     void didPaint(RenderObject&, const LayoutRect&);
124     void didLayout();
125     void didScroll();
126     void didRecalculateStyle();
127
128     // Inspector Controller API
129     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) override;
130     void willDestroyFrontendAndBackend(Inspector::DisconnectReason) override;
131
132     // Cross-agents API
133     Page& page() { return m_page; }
134     MainFrame& mainFrame();
135     Frame* frameForId(const String& frameId);
136     WEBCORE_EXPORT String frameId(Frame*);
137     bool hasIdForFrame(Frame*) const;
138     String loaderId(DocumentLoader*);
139     Frame* findFrameWithSecurityOrigin(const String& originRawString);
140     Frame* assertFrame(ErrorString&, const String& frameId);
141     static DocumentLoader* assertDocumentLoader(ErrorString&, Frame*);
142
143 private:
144     double timestamp();
145
146     static bool mainResourceContent(Frame*, bool withBase64Encode, String* result);
147     static bool dataContent(const char* data, unsigned size, const String& textEncodingName, bool withBase64Encode, String* result);
148
149     Ref<Inspector::Protocol::Page::Frame> buildObjectForFrame(Frame*);
150     Ref<Inspector::Protocol::Page::FrameResourceTree> buildObjectForFrameTree(Frame*);
151
152     std::unique_ptr<Inspector::PageFrontendDispatcher> m_frontendDispatcher;
153     RefPtr<Inspector::PageBackendDispatcher> m_backendDispatcher;
154
155     Page& m_page;
156     InspectorClient* m_client { nullptr };
157     InspectorOverlay* m_overlay { nullptr };
158
159     String m_pendingScriptToEvaluateOnLoadOnce;
160     String m_scriptToEvaluateOnLoadOnce;
161     HashMap<Frame*, String> m_frameToIdentifier;
162     HashMap<String, Frame*> m_identifierToFrame;
163     HashMap<DocumentLoader*, String> m_loaderToIdentifier;
164     bool m_enabled { false };
165     bool m_isFirstLayoutAfterOnLoad { false };
166     bool m_showPaintRects { false };
167     String m_emulatedMedia;
168 };
169
170 } // namespace WebCore