Web Inspector: Audit: provide a way to get the contents of resources
[WebKit-https.git] / Source / WebCore / inspector / agents / 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 "CachedResource.h"
35 #include "InspectorWebAgentBase.h"
36 #include "LayoutRect.h"
37 #include <JavaScriptCore/InspectorBackendDispatchers.h>
38 #include <JavaScriptCore/InspectorFrontendDispatchers.h>
39 #include <wtf/HashMap.h>
40 #include <wtf/Seconds.h>
41 #include <wtf/text/WTFString.h>
42
43 namespace WebCore {
44
45 class DocumentLoader;
46 class Frame;
47 class InspectorClient;
48 class InspectorOverlay;
49 class Page;
50 class RenderObject;
51 class SharedBuffer;
52
53 typedef String ErrorString;
54
55 class InspectorPageAgent final : public InspectorAgentBase, public Inspector::PageBackendDispatcherHandler {
56     WTF_MAKE_NONCOPYABLE(InspectorPageAgent);
57     WTF_MAKE_FAST_ALLOCATED;
58 public:
59     InspectorPageAgent(PageAgentContext&, InspectorClient*, InspectorOverlay*);
60
61     enum ResourceType {
62         DocumentResource,
63         StylesheetResource,
64         ImageResource,
65         FontResource,
66         ScriptResource,
67         XHRResource,
68         FetchResource,
69         PingResource,
70         BeaconResource,
71         WebSocketResource,
72 #if ENABLE(APPLICATION_MANIFEST)
73         ApplicationManifestResource,
74 #endif
75         OtherResource,
76     };
77
78     static bool sharedBufferContent(RefPtr<SharedBuffer>&&, const String& textEncodingName, bool withBase64Encode, String* result);
79     static Vector<CachedResource*> cachedResourcesForFrame(Frame*);
80     static void resourceContent(ErrorString&, Frame*, const URL&, String* result, bool* base64Encoded);
81     static String sourceMapURLForResource(CachedResource*);
82
83     static CachedResource* cachedResource(Frame*, const URL&);
84     static Inspector::Protocol::Page::ResourceType resourceTypeJSON(ResourceType);
85     static ResourceType inspectorResourceType(CachedResource::Type);
86     static ResourceType inspectorResourceType(const CachedResource&);
87     static Inspector::Protocol::Page::ResourceType cachedResourceTypeJSON(const CachedResource&);
88
89     // Page API for InspectorFrontend
90     void enable(ErrorString&) final;
91     void disable(ErrorString&) final;
92     void reload(ErrorString&, const bool* optionalReloadFromOrigin, const bool* optionalRevalidateAllResources) final;
93     void navigate(ErrorString&, const String& url) final;
94     void overrideUserAgent(ErrorString&, const String* value) final;
95     void overrideSetting(ErrorString&, const String& setting, const bool* value) final;
96     void getCookies(ErrorString&, RefPtr<JSON::ArrayOf<Inspector::Protocol::Page::Cookie>>& cookies) final;
97     void deleteCookie(ErrorString&, const String& cookieName, const String& url) final;
98     void getResourceTree(ErrorString&, RefPtr<Inspector::Protocol::Page::FrameResourceTree>&) final;
99     void getResourceContent(ErrorString&, const String& frameId, const String& url, String* content, bool* base64Encoded) final;
100     void searchInResource(ErrorString&, const String& frameId, const String& url, const String& query, const bool* optionalCaseSensitive, const bool* optionalIsRegex, const String* optionalRequestId, RefPtr<JSON::ArrayOf<Inspector::Protocol::GenericTypes::SearchMatch>>&) final;
101     void searchInResources(ErrorString&, const String&, const bool* caseSensitive, const bool* isRegex, RefPtr<JSON::ArrayOf<Inspector::Protocol::Page::SearchResult>>&) final;
102     void setShowRulers(ErrorString&, bool) final;
103     void setShowPaintRects(ErrorString&, bool show) final;
104     void setEmulatedMedia(ErrorString&, const String&) final;
105     void setForcedAppearance(ErrorString&, const String&) final;
106     void getCompositingBordersVisible(ErrorString&, bool* out_param) final;
107     void setCompositingBordersVisible(ErrorString&, bool) final;
108     void snapshotNode(ErrorString&, int nodeId, String* outDataURL) final;
109     void snapshotRect(ErrorString&, int x, int y, int width, int height, const String& coordinateSystem, String* outDataURL) final;
110     void archive(ErrorString&, String* data) final;
111
112     // InspectorInstrumentation
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 defaultAppearanceDidChange(bool useDarkAppearance);
123     void applyUserAgentOverride(String&);
124     void applyEmulatedMedia(String&);
125     void didPaint(RenderObject&, const LayoutRect&);
126     void didLayout();
127     void didScroll();
128     void didRecalculateStyle();
129
130     // Inspector Controller API
131     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) final;
132     void willDestroyFrontendAndBackend(Inspector::DisconnectReason) final;
133
134     // Cross-agents API
135     Page& page() { return m_page; }
136     Frame& mainFrame();
137     Frame* frameForId(const String& frameId);
138     WEBCORE_EXPORT String frameId(Frame*);
139     bool hasIdForFrame(Frame*) const;
140     String loaderId(DocumentLoader*);
141     Frame* findFrameWithSecurityOrigin(const String& originRawString);
142     Frame* assertFrame(ErrorString&, const String& frameId);
143     static DocumentLoader* assertDocumentLoader(ErrorString&, Frame*);
144
145 private:
146     double timestamp();
147
148     static bool mainResourceContent(Frame*, bool withBase64Encode, String* result);
149     static bool dataContent(const char* data, unsigned size, const String& textEncodingName, bool withBase64Encode, String* result);
150
151     Ref<Inspector::Protocol::Page::Frame> buildObjectForFrame(Frame*);
152     Ref<Inspector::Protocol::Page::FrameResourceTree> buildObjectForFrameTree(Frame*);
153
154     std::unique_ptr<Inspector::PageFrontendDispatcher> m_frontendDispatcher;
155     RefPtr<Inspector::PageBackendDispatcher> m_backendDispatcher;
156
157     Page& m_page;
158     InspectorClient* m_client { nullptr };
159     InspectorOverlay* m_overlay { nullptr };
160
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_userAgentOverride;
168     String m_emulatedMedia;
169     String m_forcedAppearance;
170 };
171
172 } // namespace WebCore