com.opera.core.systems.scope.services.ums
Class EcmaScriptDebugger

java.lang.Object
  com.opera.core.systems.scope.AbstractService
      com.opera.core.systems.scope.services.ums.EcmaScriptDebugger

All Implemented Interfaces:

IEcmaScriptDebugger

Direct Known Subclasses:

EcmaScriptDebugger6

public class EcmaScriptDebugger
extends AbstractService
implements IEcmaScriptDebugger

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

Author:

Deniz Turkoglu

Field Summary

protected int	activeWindowId
protected OperaDriver	driver
protected IWindowManager	windowManager

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

services

Constructor Summary

EcmaScriptDebugger(ScopeServices services, java.lang.String version)

Method Summary

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(java.lang.String using, int runtimeId)
protected EsdbgProtos.EvalData.Variable	buildVariable(java.lang.String name, int objectId)
java.lang.String	callFunctionOnObject(java.lang.String using, int objectId) The script to be executed on/using an object
java.lang.Object	callFunctionOnObject(java.lang.String using, int objectId, boolean responseExpected)
void	changeRuntime(int index) Changes the frame by index
void	changeRuntime(java.lang.String frameName) Changes the frame by frame name address nested frames by dot (first.second)
void	cleanUpRuntimes() Cleanup runtimes with the active window id
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 dont have script we can still inject to a 'fake' runtime
protected UmsProtos.Response	eval(java.lang.String using, EsdbgProtos.EvalData.Variable... variables)
protected UmsProtos.Response	eval(java.lang.String using, int runtimeId, EsdbgProtos.EvalData.Variable... variables)
java.util.List<java.lang.Integer>	examineObjects(java.lang.Integer id)
java.lang.Object	examineScriptResult(java.lang.Integer id)
java.lang.String	executeJavascript(java.lang.String using) Execute a script and wait for response
java.lang.String	executeJavascript(java.lang.String using, boolean responseExpected) Execute a script, this method allows fine tuning of responses, we are not interested in return value in some injections
java.lang.String	executeJavascript(java.lang.String using, java.lang.Integer windowId)
java.lang.Object	executeScript(java.lang.String using, boolean responseExpected) Executes a script and returns the response (based on responseExpected)
java.lang.Object	executeScript(java.lang.String using, boolean responseExpected, int runtimeId)
java.lang.Integer	executeScriptOnObject(java.lang.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)
java.lang.Integer	getObject(java.lang.String using) Gets the object id using a script
protected java.lang.Integer	getObject(java.lang.String using, int runtimeId)
int	getRuntimeId()
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)
java.util.List<java.lang.String>	listFramePaths() Lists the frame paths of available runtimes
protected java.util.List<EsdbgProtos.RuntimeInfo>	listRuntimes(boolean allRuntimes)
protected java.lang.Object	parseEvalReply(EsdbgProtos.EvalResult result) Parses a reply and returns the following types String presentation of number, boolean or string
protected java.lang.Object	parseNumber(java.lang.String value)
protected java.lang.Object	parseValue(java.lang.String dataType, java.lang.String value)
protected void	processArgument(java.lang.Object object, java.lang.StringBuilder builder, java.util.List<org.openqa.selenium.WebElement> elements)
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()
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
java.lang.Object	scriptExecutor(java.lang.String script, java.lang.Object... params) Executes the given javascript via eval call
void	setDriver(OperaDriver driver) Set the driver this service belongs to.
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.AbstractService

buildPayload, executeCommand, executeCommand, getVersion, isVersionInRange, sleep, xpathIterator, xpathPointer, xpathQuery

Methods inherited from class java.lang.Object

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

Field Detail

activeWindowId

protected int activeWindowId

windowManager

protected final IWindowManager windowManager

driver

protected OperaDriver driver

Constructor Detail

EcmaScriptDebugger

public EcmaScriptDebugger(ScopeServices services,
                          java.lang.String version)

Method Detail

setDriver

public void setDriver(OperaDriver driver)

Description copied from interface: IEcmaScriptDebugger

Set the driver this service belongs to. Needed so that we can create OperaWebElements in this service.

Specified by:

setDriver in interface IEcmaScriptDebugger

getRuntimeId

public int getRuntimeId()

Specified by:

getRuntimeId in interface IEcmaScriptDebugger

setRuntime

public void setRuntime(EsdbgProtos.RuntimeInfo runtime)

Description copied from interface: IEcmaScriptDebugger

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

Specified by:

setRuntime in interface IEcmaScriptDebugger

addRuntime

public void addRuntime(EsdbgProtos.RuntimeInfo runtime)

Description copied from interface: IEcmaScriptDebugger

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

Specified by:

addRuntime in interface IEcmaScriptDebugger

removeRuntime

public void removeRuntime(int runtimeId)

Description copied from interface: IEcmaScriptDebugger

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 IEcmaScriptDebugger

init

public void init()

Description copied from interface: IEcmaScriptDebugger

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 IEcmaScriptDebugger

updateRuntime

public boolean updateRuntime()

Description copied from interface: IEcmaScriptDebugger

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

Specified by:

updateRuntime in interface IEcmaScriptDebugger

Returns:

true if a runtime is found and updated

listRuntimes

protected java.util.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 dont have script we can still inject to a 'fake' runtime

scriptExecutor

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

Description copied from interface: IEcmaScriptDebugger

Executes the given javascript via eval call

Specified by:

scriptExecutor in interface IEcmaScriptDebugger

Parameters:

script - The script to be executed on host

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

processArgument

protected void processArgument(java.lang.Object object,
                               java.lang.StringBuilder builder,
                               java.util.List<org.openqa.selenium.WebElement> elements)

executeJavascript

public java.lang.String executeJavascript(java.lang.String using)

Description copied from interface: IEcmaScriptDebugger

Execute a script and wait for response

Specified by:

executeJavascript in interface IEcmaScriptDebugger

Parameters:

using - script to execute

executeJavascript

public java.lang.String executeJavascript(java.lang.String using,
                                          boolean responseExpected)

Description copied from interface: IEcmaScriptDebugger

Execute a script, this method allows fine tuning of responses, we are not interested in return value in some injections

Specified by:

executeJavascript in interface IEcmaScriptDebugger

Parameters:

using - script to execute

responseExpected - if true parse the response

Returns:

String representation of the response

buildEval

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

buildVariable

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

eval

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

eval

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

executeScript

public java.lang.Object executeScript(java.lang.String using,
                                      boolean responseExpected)

Description copied from interface: IEcmaScriptDebugger

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

Specified by:

executeScript in interface IEcmaScriptDebugger

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 java.lang.Object executeScript(java.lang.String using,
                                      boolean responseExpected,
                                      int runtimeId)

getObject

public java.lang.Integer getObject(java.lang.String using)

Description copied from interface: IEcmaScriptDebugger

Gets the object id using a script

Specified by:

getObject in interface IEcmaScriptDebugger

Parameters:

using - the script to find the object

Returns:

object id with the result

getObject

protected java.lang.Integer getObject(java.lang.String using,
                                      int runtimeId)

callFunctionOnObject

public java.lang.String callFunctionOnObject(java.lang.String using,
                                             int objectId)

Description copied from interface: IEcmaScriptDebugger

The script to be executed on/using an object

Specified by:

callFunctionOnObject in interface IEcmaScriptDebugger

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 java.lang.Object callFunctionOnObject(java.lang.String using,
                                             int objectId,
                                             boolean responseExpected)

Specified by:

callFunctionOnObject in interface IEcmaScriptDebugger

executeScriptOnObject

public java.lang.Integer executeScriptOnObject(java.lang.String using,
                                               int objectId)

Specified by:

executeScriptOnObject in interface IEcmaScriptDebugger

parseEvalReply

protected java.lang.Object parseEvalReply(EsdbgProtos.EvalResult result)

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

parseValue

protected java.lang.Object parseValue(java.lang.String dataType,
                                      java.lang.String value)

parseNumber

protected java.lang.Object parseNumber(java.lang.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: IEcmaScriptDebugger

Changes the frame by index

Specified by:

changeRuntime in interface IEcmaScriptDebugger

changeRuntime

public void changeRuntime(java.lang.String frameName)

Description copied from interface: IEcmaScriptDebugger

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

Specified by:

changeRuntime in interface IEcmaScriptDebugger

cleanUpRuntimes

public void cleanUpRuntimes(int windowId)

Description copied from interface: IEcmaScriptDebugger

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

Specified by:

cleanUpRuntimes in interface IEcmaScriptDebugger

cleanUpRuntimes

public void cleanUpRuntimes()

Description copied from interface: IEcmaScriptDebugger

Cleanup runtimes with the active window id

Specified by:

cleanUpRuntimes in interface IEcmaScriptDebugger

examineObjects

public java.util.List<java.lang.Integer> examineObjects(java.lang.Integer id)

Specified by:

examineObjects in interface IEcmaScriptDebugger

listFramePaths

public java.util.List<java.lang.String> listFramePaths()

Description copied from interface: IEcmaScriptDebugger

Lists the frame paths of available runtimes

Specified by:

listFramePaths in interface IEcmaScriptDebugger

Returns:

a List of String framepaths

releaseObjects

public void releaseObjects()

Description copied from interface: IEcmaScriptDebugger

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

Specified by:

releaseObjects in interface IEcmaScriptDebugger

resetRuntimesList

public void resetRuntimesList()

Description copied from interface: IEcmaScriptDebugger

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 IEcmaScriptDebugger

readyStateChanged

public void readyStateChanged(EcmascriptProtos.ReadyStateChange change)

Description copied from interface: IEcmaScriptDebugger

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

Specified by:

readyStateChanged in interface IEcmaScriptDebugger

Parameters:

change - EcmascriptProtos.ReadyStateChange object with runtime info

releaseObject

public void releaseObject(int objectId)

Description copied from interface: IEcmaScriptDebugger

Releases a specific object

Specified by:

releaseObject in interface IEcmaScriptDebugger

Parameters:

objectId - Id of the object to be released

resetFramePath

public void resetFramePath()

Specified by:

resetFramePath in interface IEcmaScriptDebugger

executeJavascript

public java.lang.String executeJavascript(java.lang.String using,
                                          java.lang.Integer windowId)

Specified by:

executeJavascript in interface IEcmaScriptDebugger

examineScriptResult

public java.lang.Object examineScriptResult(java.lang.Integer id)

Specified by:

examineScriptResult in interface IEcmaScriptDebugger