Web Inspector: Search: allow DOM searches to be case sensitive
[WebKit-https.git] / Source / WebCore / inspector / agents / InspectorDOMAgent.h
1 /*
2  * Copyright (C) 2009-2017 Apple Inc. All rights reserved.
3  * Copyright (C) 2011 Google 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 "EventTarget.h"
33 #include "InspectorWebAgentBase.h"
34 #include "Timer.h"
35 #include <JavaScriptCore/InspectorBackendDispatchers.h>
36 #include <JavaScriptCore/InspectorFrontendDispatchers.h>
37 #include <wtf/HashMap.h>
38 #include <wtf/HashSet.h>
39 #include <wtf/JSONValues.h>
40 #include <wtf/RefPtr.h>
41 #include <wtf/Vector.h>
42 #include <wtf/text/AtomicString.h>
43
44 namespace Inspector {
45 class InjectedScriptManager;
46 }
47
48 namespace JSC {
49 class ExecState;
50 class JSValue;
51 }
52
53 namespace WebCore {
54     
55 class AccessibilityObject;
56 class CharacterData;
57 class DOMEditor;
58 class Document;
59 class Element;
60 class Event;
61 class Exception;
62 class FloatQuad;
63 class Frame;
64 class InspectorHistory;
65 class InspectorOverlay;
66 class InspectorPageAgent;
67 #if ENABLE(VIDEO)
68 class HTMLMediaElement;
69 #endif
70 class HitTestResult;
71 class Node;
72 class PseudoElement;
73 class RevalidateStyleAttributeTask;
74 class ShadowRoot;
75
76 struct HighlightConfig;
77
78 typedef String ErrorString;
79
80 struct EventListenerInfo {
81     EventListenerInfo(Node* node, const AtomicString& eventType, EventListenerVector&& eventListenerVector)
82         : node(node)
83         , eventType(eventType)
84         , eventListenerVector(WTFMove(eventListenerVector))
85     {
86     }
87
88     Node* node;
89     const AtomicString eventType;
90     const EventListenerVector eventListenerVector;
91 };
92
93 class InspectorDOMAgent final : public InspectorAgentBase, public Inspector::DOMBackendDispatcherHandler {
94     WTF_MAKE_NONCOPYABLE(InspectorDOMAgent);
95     WTF_MAKE_FAST_ALLOCATED;
96 public:
97     struct DOMListener {
98         virtual ~DOMListener() = default;
99         virtual void didRemoveDOMNode(Node&, int nodeId) = 0;
100         virtual void didModifyDOMAttr(Element&) = 0;
101     };
102
103     InspectorDOMAgent(WebAgentContext&, InspectorPageAgent*, InspectorOverlay*);
104     virtual ~InspectorDOMAgent();
105
106     static String toErrorString(ExceptionCode);
107     static String toErrorString(Exception&&);
108
109     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) override;
110     void willDestroyFrontendAndBackend(Inspector::DisconnectReason) override;
111
112     Vector<Document*> documents();
113     void reset();
114
115     // Methods called from the frontend for DOM nodes inspection.
116     void querySelector(ErrorString&, int nodeId, const String& selectors, int* elementId) override;
117     void querySelectorAll(ErrorString&, int nodeId, const String& selectors, RefPtr<JSON::ArrayOf<int>>& result) override;
118     void getDocument(ErrorString&, RefPtr<Inspector::Protocol::DOM::Node>& root) override;
119     void requestChildNodes(ErrorString&, int nodeId, const int* depth) override;
120     void setAttributeValue(ErrorString&, int elementId, const String& name, const String& value) override;
121     void setAttributesAsText(ErrorString&, int elementId, const String& text, const String* name) override;
122     void removeAttribute(ErrorString&, int elementId, const String& name) override;
123     void removeNode(ErrorString&, int nodeId) override;
124     void setNodeName(ErrorString&, int nodeId, const String& name, int* newId) override;
125     void getOuterHTML(ErrorString&, int nodeId, WTF::String* outerHTML) override;
126     void setOuterHTML(ErrorString&, int nodeId, const String& outerHTML) override;
127     void insertAdjacentHTML(ErrorString&, int nodeId, const String& position, const String& html) override;
128     void setNodeValue(ErrorString&, int nodeId, const String& value) override;
129     void getSupportedEventNames(ErrorString&, RefPtr<JSON::ArrayOf<String>>& eventNames) override;
130     void getDataBindingsForNode(ErrorString&, int nodeId, RefPtr<JSON::ArrayOf<Inspector::Protocol::DOM::DataBinding>>& dataArray) override;
131     void getAssociatedDataForNode(ErrorString&, int nodeId, Optional<String>& associatedData) override;
132     void getEventListenersForNode(ErrorString&, int nodeId, const WTF::String* objectGroup, RefPtr<JSON::ArrayOf<Inspector::Protocol::DOM::EventListener>>& listenersArray) override;
133     void setEventListenerDisabled(ErrorString&, int eventListenerId, bool disabled) override;
134     void setBreakpointForEventListener(ErrorString&, int eventListenerId) override;
135     void removeBreakpointForEventListener(ErrorString&, int eventListenerId) override;
136     void getAccessibilityPropertiesForNode(ErrorString&, int nodeId, RefPtr<Inspector::Protocol::DOM::AccessibilityProperties>& axProperties) override;
137     void performSearch(ErrorString&, const String& query, const JSON::Array* nodeIds, const bool* caseSensitive, String* searchId, int* resultCount) override;
138     void getSearchResults(ErrorString&, const String& searchId, int fromIndex, int toIndex, RefPtr<JSON::ArrayOf<int>>&) override;
139     void discardSearchResults(ErrorString&, const String& searchId) override;
140     void resolveNode(ErrorString&, int nodeId, const String* objectGroup, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result) override;
141     void getAttributes(ErrorString&, int nodeId, RefPtr<JSON::ArrayOf<String>>& result) override;
142     void setInspectModeEnabled(ErrorString&, bool enabled, const JSON::Object* highlightConfig) override;
143     void requestNode(ErrorString&, const String& objectId, int* nodeId) override;
144     void pushNodeByPathToFrontend(ErrorString&, const String& path, int* nodeId) override;
145     void hideHighlight(ErrorString&) override;
146     void highlightRect(ErrorString&, int x, int y, int width, int height, const JSON::Object* color, const JSON::Object* outlineColor, const bool* usePageCoordinates) override;
147     void highlightQuad(ErrorString&, const JSON::Array& quad, const JSON::Object* color, const JSON::Object* outlineColor, const bool* usePageCoordinates) override;
148     void highlightSelector(ErrorString&, const JSON::Object& highlightConfig, const String& selectorString, const String* frameId) override;
149     void highlightNode(ErrorString&, const JSON::Object& highlightConfig, const int* nodeId, const String* objectId) override;
150     void highlightNodeList(ErrorString&, const JSON::Array& nodeIds, const JSON::Object& highlightConfig) override;
151     void highlightFrame(ErrorString&, const String& frameId, const JSON::Object* color, const JSON::Object* outlineColor) override;
152     void moveTo(ErrorString&, int nodeId, int targetNodeId, const int* anchorNodeId, int* newNodeId) override;
153     void undo(ErrorString&) override;
154     void redo(ErrorString&) override;
155     void markUndoableState(ErrorString&) override;
156     void focus(ErrorString&, int nodeId) override;
157     void setInspectedNode(ErrorString&, int nodeId) override;
158
159     void getEventListeners(Node*, Vector<EventListenerInfo>& listenersArray, bool includeAncestors);
160
161
162     // InspectorInstrumentation
163     int identifierForNode(Node&);
164     void addEventListenersToNode(Node&);
165     void didInsertDOMNode(Node&);
166     void didRemoveDOMNode(Node&);
167     void willModifyDOMAttr(Element&, const AtomicString& oldValue, const AtomicString& newValue);
168     void didModifyDOMAttr(Element&, const AtomicString& name, const AtomicString& value);
169     void didRemoveDOMAttr(Element&, const AtomicString& name);
170     void characterDataModified(CharacterData&);
171     void didInvalidateStyleAttr(Node&);
172     void didPushShadowRoot(Element& host, ShadowRoot&);
173     void willPopShadowRoot(Element& host, ShadowRoot&);
174     void didChangeCustomElementState(Element&);
175     bool handleTouchEvent(Node&);
176     void didCommitLoad(Document*);
177     void frameDocumentUpdated(Frame&);
178     void pseudoElementCreated(PseudoElement&);
179     void pseudoElementDestroyed(PseudoElement&);
180     void didAddEventListener(EventTarget&);
181     void willRemoveEventListener(EventTarget&, const AtomicString& eventType, EventListener&, bool capture);
182     bool isEventListenerDisabled(EventTarget&, const AtomicString& eventType, EventListener&, bool capture);
183     void eventDidResetAfterDispatch(const Event&);
184
185     // Callbacks that don't directly correspond to an instrumentation entry point.
186     void setDocument(Document*);
187     void releaseDanglingNodes();
188
189     void styleAttributeInvalidated(const Vector<Element*>& elements);
190
191     int pushNodeToFrontend(ErrorString&, int documentNodeId, Node*);
192     Node* nodeForId(int nodeId);
193     int boundNodeId(const Node*);
194     void setDOMListener(DOMListener*);
195
196     static String documentURLString(Document*);
197
198     RefPtr<Inspector::Protocol::Runtime::RemoteObject> resolveNode(Node*, const String& objectGroup);
199     bool handleMousePress();
200     void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags);
201     void inspect(Node*);
202     void focusNode();
203
204     InspectorHistory* history() { return m_history.get(); }
205
206     // We represent embedded doms as a part of the same hierarchy. Hence we treat children of frame owners differently.
207     // We also skip whitespace text nodes conditionally. Following methods encapsulate these specifics.
208     static Node* innerFirstChild(Node*);
209     static Node* innerNextSibling(Node*);
210     static Node* innerPreviousSibling(Node*);
211     static unsigned innerChildNodeCount(Node*);
212     static Node* innerParentNode(Node*);
213
214     Node* assertNode(ErrorString&, int nodeId);
215     Element* assertElement(ErrorString&, int nodeId);
216     Document* assertDocument(ErrorString&, int nodeId);
217
218     static Node* scriptValueAsNode(JSC::JSValue);
219     static JSC::JSValue nodeAsScriptValue(JSC::ExecState&, Node*);
220
221     // Methods called from other agents.
222     InspectorPageAgent* pageAgent() { return m_pageAgent; }
223
224     bool hasBreakpointForEventListener(EventTarget&, const AtomicString& eventType, EventListener&, bool capture);
225     int idForEventListener(EventTarget&, const AtomicString& eventType, EventListener&, bool capture);
226
227 private:
228 #if ENABLE(VIDEO)
229     void mediaMetricsTimerFired();
230 #endif
231
232     void highlightMousedOverNode();
233     void setSearchingForNode(ErrorString&, bool enabled, const JSON::Object* highlightConfig);
234     std::unique_ptr<HighlightConfig> highlightConfigFromInspectorObject(ErrorString&, const JSON::Object* highlightInspectorObject);
235
236     // Node-related methods.
237     typedef HashMap<RefPtr<Node>, int> NodeToIdMap;
238     int bind(Node*, NodeToIdMap*);
239     void unbind(Node*, NodeToIdMap*);
240
241     Node* assertEditableNode(ErrorString&, int nodeId);
242     Element* assertEditableElement(ErrorString&, int nodeId);
243
244     int pushNodePathToFrontend(Node*);
245     void pushChildNodesToFrontend(int nodeId, int depth = 1);
246
247     Ref<Inspector::Protocol::DOM::Node> buildObjectForNode(Node*, int depth, NodeToIdMap*);
248     Ref<JSON::ArrayOf<String>> buildArrayForElementAttributes(Element*);
249     Ref<JSON::ArrayOf<Inspector::Protocol::DOM::Node>> buildArrayForContainerChildren(Node* container, int depth, NodeToIdMap* nodesMap);
250     RefPtr<JSON::ArrayOf<Inspector::Protocol::DOM::Node>> buildArrayForPseudoElements(const Element&, NodeToIdMap* nodesMap);
251     Ref<Inspector::Protocol::DOM::EventListener> buildObjectForEventListener(const RegisteredEventListener&, int identifier, const AtomicString& eventType, Node*, const String* objectGroupId, bool disabled, bool hasBreakpoint);
252     RefPtr<Inspector::Protocol::DOM::AccessibilityProperties> buildObjectForAccessibilityProperties(Node*);
253     void processAccessibilityChildren(AccessibilityObject&, JSON::ArrayOf<int>&);
254     
255     Node* nodeForPath(const String& path);
256     Node* nodeForObjectId(const String& objectId);
257
258     void discardBindings();
259
260     void innerHighlightQuad(std::unique_ptr<FloatQuad>, const JSON::Object* color, const JSON::Object* outlineColor, const bool* usePageCoordinates);
261
262     Inspector::InjectedScriptManager& m_injectedScriptManager;
263     std::unique_ptr<Inspector::DOMFrontendDispatcher> m_frontendDispatcher;
264     RefPtr<Inspector::DOMBackendDispatcher> m_backendDispatcher;
265     InspectorPageAgent* m_pageAgent { nullptr };
266
267     InspectorOverlay* m_overlay { nullptr };
268     DOMListener* m_domListener { nullptr };
269     NodeToIdMap m_documentNodeToIdMap;
270     // Owns node mappings for dangling nodes.
271     Vector<std::unique_ptr<NodeToIdMap>> m_danglingNodeToIdMaps;
272     HashMap<int, Node*> m_idToNode;
273     HashMap<int, NodeToIdMap*> m_idToNodesMap;
274     HashSet<int> m_childrenRequested;
275     int m_lastNodeId { 1 };
276     RefPtr<Document> m_document;
277     typedef HashMap<String, Vector<RefPtr<Node>>> SearchResults;
278     SearchResults m_searchResults;
279     std::unique_ptr<RevalidateStyleAttributeTask> m_revalidateStyleAttrTask;
280     RefPtr<Node> m_nodeToFocus;
281     RefPtr<Node> m_mousedOverNode;
282     std::unique_ptr<HighlightConfig> m_inspectModeHighlightConfig;
283     std::unique_ptr<InspectorHistory> m_history;
284     std::unique_ptr<DOMEditor> m_domEditor;
285     bool m_searchingForNode { false };
286     bool m_suppressAttributeModifiedEvent { false };
287     bool m_documentRequested { false };
288
289 #if ENABLE(VIDEO)
290     Timer m_mediaMetricsTimer;
291     struct MediaMetrics {
292         unsigned displayCompositedFrames { 0 };
293         bool isLowPower { false };
294
295         MediaMetrics() { }
296
297         MediaMetrics(unsigned displayCompositedFrames)
298             : displayCompositedFrames(displayCompositedFrames)
299         {
300         }
301     };
302
303     // The pointer key for this map should not be used for anything other than matching.
304     HashMap<HTMLMediaElement*, MediaMetrics> m_mediaMetrics;
305 #endif
306
307     struct InspectorEventListener {
308         int identifier { 1 };
309         RefPtr<EventTarget> eventTarget;
310         RefPtr<EventListener> eventListener;
311         AtomicString eventType;
312         bool useCapture { false };
313         bool disabled { false };
314         bool hasBreakpoint { false };
315
316         InspectorEventListener() { }
317
318         InspectorEventListener(int identifier, EventTarget& target, const AtomicString& type, EventListener& listener, bool capture)
319             : identifier(identifier)
320             , eventTarget(&target)
321             , eventListener(&listener)
322             , eventType(type)
323             , useCapture(capture)
324         {
325         }
326
327         bool matches(EventTarget& target, const AtomicString& type, EventListener& listener, bool capture)
328         {
329             if (eventTarget.get() != &target)
330                 return false;
331             if (eventListener.get() != &listener)
332                 return false;
333             if (eventType != type)
334                 return false;
335             if (useCapture != capture)
336                 return false;
337             return true;
338         }
339     };
340
341     friend class EventFiredCallback;
342
343     HashSet<const Event*> m_dispatchedEvents;
344     HashMap<int, InspectorEventListener> m_eventListenerEntries;
345     int m_lastEventListenerId { 1 };
346 };
347
348 } // namespace WebCore