Home | History | Annotate | Download | only in inspector
      1 /*
      2  * Copyright (C) 2007 Apple Inc. All rights reserved.
      3  * Copyright (C) 2009 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 Computer, 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 #ifndef InjectedScriptHost_h
     31 #define InjectedScriptHost_h
     32 
     33 #include "bindings/v8/ScriptState.h"
     34 #include "bindings/v8/ScriptWrappable.h"
     35 #include "wtf/RefCounted.h"
     36 #include "wtf/Vector.h"
     37 
     38 namespace WebCore {
     39 
     40 class Database;
     41 class InjectedScript;
     42 class InstrumentingAgents;
     43 class JSONValue;
     44 class Node;
     45 class ScriptDebugServer;
     46 class ScriptValue;
     47 class Storage;
     48 
     49 struct EventListenerInfo;
     50 
     51 // SECURITY NOTE: Although the InjectedScriptHost is intended for use solely by the inspector,
     52 // a reference to the InjectedScriptHost may be leaked to the page being inspected. Thus, the
     53 // InjectedScriptHost must never implemment methods that have more power over the page than the
     54 // page already has itself (e.g. origin restriction bypasses).
     55 
     56 class InjectedScriptHost : public RefCounted<InjectedScriptHost>, public ScriptWrappable {
     57 public:
     58     static PassRefPtr<InjectedScriptHost> create();
     59     ~InjectedScriptHost();
     60 
     61     void init(InstrumentingAgents* instrumentingAgents, ScriptDebugServer* scriptDebugServer)
     62     {
     63         m_instrumentingAgents = instrumentingAgents;
     64         m_scriptDebugServer = scriptDebugServer;
     65     }
     66 
     67     static Node* scriptValueAsNode(ScriptValue);
     68     static ScriptValue nodeAsScriptValue(ScriptState*, Node*);
     69 
     70     void disconnect();
     71 
     72     class InspectableObject {
     73         WTF_MAKE_FAST_ALLOCATED;
     74     public:
     75         virtual ScriptValue get(ScriptState*);
     76         virtual ~InspectableObject() { }
     77     };
     78     void addInspectedObject(PassOwnPtr<InspectableObject>);
     79     void clearInspectedObjects();
     80     InspectableObject* inspectedObject(unsigned int num);
     81 
     82     void inspectImpl(PassRefPtr<JSONValue> objectToInspect, PassRefPtr<JSONValue> hints);
     83     void getEventListenersImpl(Node*, Vector<EventListenerInfo>& listenersArray);
     84 
     85     void clearConsoleMessages();
     86     String databaseIdImpl(Database*);
     87     String storageIdImpl(Storage*);
     88     void debugFunction(const String& scriptId, int lineNumber, int columnNumber);
     89     void undebugFunction(const String& scriptId, int lineNumber, int columnNumber);
     90     void monitorFunction(const String& scriptId, int lineNumber, int columnNumber, const String& functionName);
     91     void unmonitorFunction(const String& scriptId, int lineNumber, int columnNumber);
     92 
     93     ScriptDebugServer& scriptDebugServer() { return *m_scriptDebugServer; }
     94 
     95 private:
     96     InjectedScriptHost();
     97 
     98     InstrumentingAgents* m_instrumentingAgents;
     99     ScriptDebugServer* m_scriptDebugServer;
    100     Vector<OwnPtr<InspectableObject> > m_inspectedObjects;
    101     OwnPtr<InspectableObject> m_defaultInspectableObject;
    102 };
    103 
    104 } // namespace WebCore
    105 
    106 #endif // !defined(InjectedScriptHost_h)
    107