com.opera.core.systems.scope.stp.services

Class ScopeEcmascriptDebugger

java.lang.Object

com.opera.core.systems.scope.AbstractService

com.opera.core.systems.scope.AbstractEcmascriptService

com.opera.core.systems.scope.stp.services.ScopeEcmascriptDebugger

All Implemented Interfaces:

Service, Debugger, EcmascriptDebugger

Direct Known Subclasses:

ScopeEcmascriptDebugger6

public class ScopeEcmascriptDebugger
extends AbstractEcmascriptService
implements EcmascriptDebugger

Manages the ecmascript-debugger service Handles runtime management and script injection.

Field Summary

Fields inherited from class com.opera.core.systems.scope.AbstractEcmascriptService

activeWindowId, currentFramePath, driver, retries, sleepDuration, windowManager

Fields inherited from class com.opera.core.systems.scope.AbstractService

services

Fields inherited from interface com.opera.core.systems.scope.services.EcmascriptDebugger

SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
ScopeEcmascriptDebugger(ScopeServices services, String requiredVersion)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRuntime(EsdbgProtos.RuntimeInfo runtime) Adds a runtime to the list of runtimes maintained in the service (STP/1 only)
protected EsdbgProtos.EvalData.Builder	buildEval(String using, int runtimeId)
protected EsdbgProtos.EvalData.Variable	buildVariable(String name, int objectId)
String	callFunctionOnObject(String using, int objectId) The script to be executed on/using an object
Object	callFunctionOnObject(String using, int objectId, boolean responseExpected)
void	changeRuntime(int index) Changes the frame by index
void	changeRuntime(String frameName) Changes the frame by frame name address nested frames by dot (first.second)
void	cleanUpRuntimes(int windowId) Cleanup possible dead/suspended runtimes on runtime-started or window-closed
protected void	createAllRuntimes() Gets a list of runtimes and keeps the list, create runtimes for all pages so even if the pages don't have script we can still inject to a "fake" runtime.
protected UmsProtos.Response	eval(String using, EsdbgProtos.EvalData.Variable... variables)
protected UmsProtos.Response	eval(String using, int runtimeId, EsdbgProtos.EvalData.Variable... variables)
List<Integer>	examineObjects(Integer id) Request additional information about an object, such as its prototype or its properties.
Object	examineScriptResult(Integer id) Recursively iterates through the property hierarchies of underneath the given object and unwraps the node elements into suitable types.
String	executeJavascript(String using, Integer windowId) Executes an arbitrary block of JavaScript on a given window, and returns the result of the evaluation.
Object	executeScript(String using, boolean responseExpected) Executes a script and returns the response (based on responseExpected)
Object	executeScript(String using, boolean responseExpected, int runtimeId)
Integer	executeScriptOnObject(String using, int objectId)
protected EsdbgProtos.RuntimeInfo	findRuntime() Find the runtime for injection (default) Typically this is _top runtime with the active window that has focus
protected EsdbgProtos.RuntimeInfo	findRuntime(int windowId)
Integer	getObject(String using) Gets the object id using a script
protected Integer	getObject(String using, int runtimeId)
int	getRuntimeId() Get the current runtime ID.
void	init() Initialize the debugger, set the configuration to NOT stop on error, exception, script or abort Create all runtimes and find a suitable runtime for injection (Currently has a workaround or 'return 1;' for GOGI dialog at opera:debug)
List<String>	listFramePaths() Lists the frame paths of available runtimes
protected List<EsdbgProtos.RuntimeInfo>	listRuntimes(boolean allRuntimes)
protected Object	parseEvalReply(EsdbgProtos.EvalResult result) Parses a reply and returns the following types String presentation of number, boolean or string.
protected Object	parseValue(String dataType, String value)
void	readyStateChanged(EcmascriptProtos.ReadyStateChange change) Triggered on the ecmascript service when the state of a runtime changes
void	releaseObject(int objectId) Releases a specific object
void	releaseObjects() Makes objects available to gc, this doesn't free the objects immediately
void	removeRuntime(int runtimeId) Removes a runtime from the list, doesnt get called often due to runtime-stopped being sent late (runtimes get suspended)
void	resetFramePath() Resets the frame path context to the top level frame and reinitializes the debugger runtime.
void	resetRuntimesList() Resets the list of runtimes and fetches a fresh list from Opera, this can be used to recover in cases where runtimes go out of sync
Object	scriptExecutor(String script, Object... params) Executes the given javascript via eval call
void	setFormElementValue(int objectId, String value) Set value of a form element.
void	setRuntime(EsdbgProtos.RuntimeInfo runtime) Sets the runtime to be used in injection required for event handler (STP/1 only)
boolean	updateRuntime() Finds a valid runtime and updates the runtime reference (active runtime)

Methods inherited from class com.opera.core.systems.scope.AbstractEcmascriptService

buildEvalString, cleanUpRuntimes, executeJavascript, executeJavascript, isNumber, isScriptInjectable, parseNumber, processArgument, recover, resetCounters, setDriver

Methods inherited from class com.opera.core.systems.scope.AbstractService

buildPayload, executeMessage, executeMessage, executeMessage, getServiceName, getServiceVersion, isVersionInRange, sleep, toString, xpathIterator, xpathPointer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.opera.core.systems.scope.services.Debugger

cleanUpRuntimes, executeJavascript, executeJavascript, isScriptInjectable, setDriver

Methods inherited from interface com.opera.core.systems.scope.Service

getServiceName, getServiceVersion

Constructor Detail

ScopeEcmascriptDebugger

public ScopeEcmascriptDebugger(ScopeServices services,
                       String requiredVersion)

Method Detail

getRuntimeId

public int getRuntimeId()

Description copied from interface: Debugger

Get the current runtime ID.

Specified by:

getRuntimeId in interface Debugger

Returns:

runtime ID

setRuntime

public void setRuntime(EsdbgProtos.RuntimeInfo runtime)

Description copied from interface: Debugger

Sets the runtime to be used in injection required for event handler (STP/1 only)

Specified by:

setRuntime in interface Debugger

addRuntime

public void addRuntime(EsdbgProtos.RuntimeInfo runtime)

Description copied from interface: Debugger

Adds a runtime to the list of runtimes maintained in the service (STP/1 only)

Specified by:

addRuntime in interface Debugger

removeRuntime

public void removeRuntime(int runtimeId)

Description copied from interface: Debugger

Removes a runtime from the list, doesnt get called often due to runtime-stopped being sent late (runtimes get suspended)

Specified by:

removeRuntime in interface Debugger

init

public void init()

Initialize the debugger, set the configuration to NOT stop on error, exception, script or abort Create all runtimes and find a suitable runtime for injection (Currently has a workaround or 'return 1;' for GOGI dialog at opera:debug)

Specified by:

init in interface Service

updateRuntime

public boolean updateRuntime()

Description copied from interface: Debugger

Finds a valid runtime and updates the runtime reference (active runtime)

Specified by:

updateRuntime in interface Debugger

Returns:

true if a runtime is found and updated

listRuntimes

protected List<EsdbgProtos.RuntimeInfo> listRuntimes(boolean allRuntimes)

createAllRuntimes

protected void createAllRuntimes()

Gets a list of runtimes and keeps the list, create runtimes for all pages so even if the pages don't have script we can still inject to a "fake" runtime.

scriptExecutor

public Object scriptExecutor(String script,
                    Object... params)

Description copied from interface: Debugger

Executes the given javascript via eval call

Specified by:

scriptExecutor in interface Debugger

Parameters:

script - the script to be executed on host

params - array of params, can be string, long or web element(s)

buildEval

protected final EsdbgProtos.EvalData.Builder buildEval(String using,
                                     int runtimeId)

buildVariable

protected final EsdbgProtos.EvalData.Variable buildVariable(String name,
                                          int objectId)

eval

protected UmsProtos.Response eval(String using,
                      int runtimeId,
                      EsdbgProtos.EvalData.Variable... variables)

eval

protected UmsProtos.Response eval(String using,
                      EsdbgProtos.EvalData.Variable... variables)

executeScript

public Object executeScript(String using,
                   boolean responseExpected)

Description copied from interface: Debugger

Executes a script and returns the response (based on responseExpected)

Specified by:

executeScript in interface Debugger

Parameters:

using - the script to be injected

responseExpected - the flag to enable/disable parsing response

Returns:

the raw result object if response is expected, null otherwise

executeScript

public Object executeScript(String using,
                   boolean responseExpected,
                   int runtimeId)

getObject

public Integer getObject(String using)

Description copied from interface: Debugger

Gets the object id using a script

Specified by:

getObject in interface Debugger

Parameters:

using - the script to find the object

Returns:

object id with the result

getObject

protected Integer getObject(String using,
                int runtimeId)

callFunctionOnObject

public String callFunctionOnObject(String using,
                          int objectId)

Description copied from interface: Debugger

The script to be executed on/using an object

Specified by:

callFunctionOnObject in interface Debugger

Parameters:

using - script with reference to the object "locator"

objectId - the object to be used for injection

Returns:

the string value returned by the executed Javascript

callFunctionOnObject

public Object callFunctionOnObject(String using,
                          int objectId,
                          boolean responseExpected)

Specified by:

callFunctionOnObject in interface Debugger

executeScriptOnObject

public Integer executeScriptOnObject(String using,
                            int objectId)

Specified by:

executeScriptOnObject in interface Debugger

parseEvalReply

protected Object parseEvalReply(EsdbgProtos.EvalResult result)

Parses a reply and returns the following types String presentation of number, boolean or string.

parseValue

protected Object parseValue(String dataType,
                String value)

findRuntime

protected EsdbgProtos.RuntimeInfo findRuntime()

Find the runtime for injection (default) Typically this is _top runtime with the active window that has focus

findRuntime

protected EsdbgProtos.RuntimeInfo findRuntime(int windowId)

changeRuntime

public void changeRuntime(int index)

Description copied from interface: Debugger

Changes the frame by index

Specified by:

changeRuntime in interface Debugger

changeRuntime

public void changeRuntime(String frameName)

Description copied from interface: Debugger

Changes the frame by frame name address nested frames by dot (first.second)

Specified by:

changeRuntime in interface Debugger

cleanUpRuntimes

public void cleanUpRuntimes(int windowId)

Description copied from interface: Debugger

Cleanup possible dead/suspended runtimes on runtime-started or window-closed

Specified by:

cleanUpRuntimes in interface Debugger

examineObjects

public List<Integer> examineObjects(Integer id)

Description copied from interface: Debugger

Request additional information about an object, such as its prototype or its properties.

Specified by:

examineObjects in interface Debugger

Parameters:

id - object ID previously returned from an eval call to the debugger

Returns:

list of ID's of object's which are considered web elements

listFramePaths

public List<String> listFramePaths()

Description copied from interface: Debugger

Lists the frame paths of available runtimes

Specified by:

listFramePaths in interface Debugger

Returns:

a List of String framepaths

releaseObjects

public void releaseObjects()

Description copied from interface: Debugger

Makes objects available to gc, this doesn't free the objects immediately

Specified by:

releaseObjects in interface Debugger

resetRuntimesList

public void resetRuntimesList()

Description copied from interface: Debugger

Resets the list of runtimes and fetches a fresh list from Opera, this can be used to recover in cases where runtimes go out of sync

Specified by:

resetRuntimesList in interface Debugger

readyStateChanged

public void readyStateChanged(EcmascriptProtos.ReadyStateChange change)

Description copied from interface: Debugger

Triggered on the ecmascript service when the state of a runtime changes

Specified by:

readyStateChanged in interface Debugger

Parameters:

change - EcmascriptProtos.ReadyStateChange object with runtime info

releaseObject

public void releaseObject(int objectId)

Description copied from interface: Debugger

Releases a specific object

Specified by:

releaseObject in interface Debugger

Parameters:

objectId - Id of the object to be released

resetFramePath

public void resetFramePath()

Description copied from interface: Debugger

Resets the frame path context to the top level frame and reinitializes the debugger runtime.

Specified by:

resetFramePath in interface Debugger

executeJavascript

public String executeJavascript(String using,
                       Integer windowId)

Description copied from interface: Debugger

Executes an arbitrary block of JavaScript on a given window, and returns the result of the evaluation.

Specified by:

executeJavascript in interface Debugger

Parameters:

using - the code to evaluate

windowId - the runtime ID, previously retrieved from the WindowManager

Returns:

the result of the evaluation

examineScriptResult

public Object examineScriptResult(Integer id)

Description copied from interface: Debugger

Recursively iterates through the property hierarchies of underneath the given object and unwraps the node elements into suitable types. DOM elements will be coerced into OperaWebElement's, arrays into Java List's, hashes into Map's, numbers into Integer's, and the remaining properties into String's.

Specified by:

examineScriptResult in interface Debugger

Parameters:

id - the object to examine the hierarchy of

Returns:

the unwrapped object tree

setFormElementValue

public void setFormElementValue(int objectId,
                       String value)

Description copied from interface: Debugger

Set value of a form element.

Specified by:

setFormElementValue in interface Debugger

Parameters:

objectId - the ID of the object to set value

value - the value to set