Function Arguments
Function parameters whose value needs to be rewritten are classified into 4 categories:
Generic Syntax
<Function name="functionName" paramPatterns="y,y," [type="URL|EXPRESSION|DHTML|DJS" source=”*”]/>
where
name is the name of the JavaScript function (mandatory)
paramPatterns specifies the parameters that need to be rewritten (mandatory)
y the position of y indicates the parameter that the needs to be rewritten. For example, in the syntax, the first parameter needs to be rewritten, but the second parameter should not be rewritten.
type specifies the kind of value this parameter needs (optional, default is EXPRESSION type)
source page source URI (optional, default is *, meaning in any page)
URL Parameters
Function takes this parameter as a string and this string could be treated as URL.
This section is divided into the following parts:
URL Parameter Syntax
<Function name="functionName" paramPatterns="y,," type="URL" [source=”*”]/>
where
name is the name of the function with a type parameter of URL (mandatory)
paramPatterns specifies the parameters that need to be rewritten (mandatory)
y the position of y indicates the parameter that needs to be rewritten. For example, in the syntax, the first parameter needs to be rewritten, but the second parameter should not be rewritten.
type is the type of the function (mandatory, and the value must be URL)
source is the URL of the page which has this function call (optional, default is *, meaning in any URL)
URL Parameter Example
Assume the base URL of the page is:
http://abc.sesta.com/test/rewriter/test1/jscript/test2/page.html
Page Content
<script language="JavaScript">
<!--
function test(one,two,three){
alert(one + "##" + two + "##" +three);
}
test("/test.html","../test.html","123");
window.open("/index.html","gen",width=500,height=500);
//-->
</SCRIPT>
Rules
<Function type="URL" name="test" paramPatterns="y,y,"/> <Function type="URL" name="window.open" paramPatterns="y,,,"/>
Output
<SCRIPT language="JavaScript">
<!--
function test(one,two,three) {
alert(one + "##" + two + "##" +three);
}
test("gateway-URL/http://abc.sesta.com/test.html","
gateway-URL/http://abc.sesta.com/test/rewriter/
test1/jscript/test.html","123");window.open("gateway-URL/
http://abc.sesta.com/index.html","gen",width=500,height=500);
//-->
</SCRIPT>
Description
The first rule specifies that the first two parameters in the function with name test need to be rewritten. Hence the first two parameters of the test function are rewritten. The second rule specifies that the first parameter of the window.open function needs to be written. The URL within the window.open function is prefixed with the Gateway URL and the base URL of the page that contains the function parameters.
EXPRESSION Parameters
These parameters take an expression value, which when evaluated, results in a URL.
This section is divided into the following parts:
EXPRESSION Parameter Syntax
<Function name="functionName" paramPatterns="y" [type="EXPRESSION" source=”*”]/>
where
name is the name of the function (mandatory).
paramPatterns specifies the parameters that need to be rewritten (mandatory)
y the position of y indicates the function parameter that needs to be rewritten. In the syntax above, only the first parameter is rewritten.
type specifies the value EXPRESSION (optional)
source URI of the page where this function is called.
EXPRESSION Parameter Example
Assume the base URL of the page is:
http://abc.sesta.com/dir1/dir2/page.html
Page Content
<script language="JavaScript">
<!--
function jstest2(){
return ".html";
}
function jstest1(one){
return one;
}
var dir="/images/test"
var test1=jstest1(dir+"/test"+jstest2());
document.write("<a HREF="+test1+">TEST</a>");
alert(test1);
//-->
</SCRIPT>
Rules
<Function type="EXPRESSION" name="jstest1" paramPatterns="y"/> or <Function name="jstest1" paramPatterns="y"/>
Output
<script language="JavaScript">
<!--
function jstest2(){
return ".html";
}
function jstest1(one){
return one;
}
var dir="/images/test"
var test1=jstest1(psSRAPRewriter_convert_expression(dir+"/test"+jstest2()));
document.write("<a HREF="+test1+">TEST</a>");
alert(test1);
//-->
</SCRIPT>
Description
The rule specifies that the first parameter of the jstest1 function needs to be rewritten by considering this as an EXPRESSION function param. In the sample page content, the first parameter is an expression that will be evaluated only at runtime. Rewriter prefixes this expression with the psSRAPRewriter_convert_expression function. The expression is evaluated, and the psSRAPRewriter_convert_expression function rewrites the output at runtime.
Note –
In the above example, the variable test1 is not required as a part of the JavaScript variable rule. The function rule for jstest1 takes care of the rewriting.
DHTML Parameters
Function parameter whose value is HTML
Native JavaScript methods such as document.write() that generate an HTML page dynamically fall under this category.
This section is divided into the following parts:
DHTML Parameter Syntax
<Function name="functionName" paramPatterns="y" type="DHTML" [source=”*”]/>
where
name is the name of the function.
paramPatterns specifies the parameters that need to be rewritten (mandatory)
y the position of y indicates the function parameter that needs to be rewritten. In the syntax above, only the first parameter is rewritten.
DHTML Parameter Example
Assume the base URL of the page is:
http://xyz.siroe.com/test/rewriter/test1/jscript/JSFUNC/page.html
Page Content
<script>
<!--
document.write(\q<a href="/index.html">write</a><BR>\q)
document.writeln(\q<a href="index.html">writeln</a><BR>\q)
document.write("http://abc.sesta.com/index.html<BR>")
document.writeln("http://abc.sesta.com/index.html<BR>")
//-->
</SCRIPT>
Rules
<Function type="DHTML" name="document.write" paramPatterns="y"/> <Function type="DHTML" name="document.writeln" paramPatterns="y"/> <Attribute name="href"/>
Output
<SCRIPT>
<!--
document.write(\q<a href="gateway-URL/
http://xyz.siroe.com/index.html">write</a><BR>\q)
document.writeln(\q<a href="gateway-URL/
http://xyz.siroe.com/test/rewriter/test1/
jscript/JSFUNC/index.html">writeln</a><BR>\q)
document.write("http://abc.sesta.com/index.html<BR>")
document.writeln("http://abc.sesta.com/index.html<BR>")
//-->
</SCRIPT>
Description
The first rule specifies that the first parameter in the function document.write needs to be rewritten. The second rule specifies that the first parameter in the function document.writeln needs to be rewritten. The third rule is a simple HTML rule that specifies that all attributes with the name href need to be rewritten. In the example, the DHTML parameter rules identify the parameters in the functions that need to be rewritten. Then the HTML attribute rule is applied to actually rewrite the identified parameter.
DJS Parameters
Function parameters whose value is JavaScript.
This section is divided into the following sections:
DJS Parameter Syntax
<Function name="functionName" paramPatterns="y" type="DJS" [source=”*”]/>
where
name is the name of the function where one parameter is DJS (mandatory)
paramPatterns specifies which parameter in the above function is DJS (mandatory)
y the position of y indicates the function parameter that needs to be rewritten. In the syntax above, only the first parameter is rewritten.
type is DJS (mandatory)
source is the URI of the page (optional, default is *, meaning any URI)
DJS Parameter Example
Assume the base URL of the page is:
http://abc.sesta.com/page.html
Page Content
<script>
menu.addItem(new NavBarMenuItem("All Available Information","JavaScript:top.location=\qhttp://abc.sesta.com\q"));
</script>
Rules
<Function type="DJS" name="NavBarMenuItem" paramPatterns=",y"/> <Variable type="URL" name="top.location"/>
Output
<script>
menu.addItem(new NavBarMenuItem("All Available Information",
"JavaScript:top.location=\qgateway-URL/
http://abc.sesta.com\q"));
</script>
Description
The first rule specifies that the second parameter of the function NavBarMenuItem which contains JavaScript needs is to be rewritten. Within the JavaScript, the variable top.location also needs to be rewritten. This variable is rewritten using the second rule.
- © 2010, Oracle Corporation and/or its affiliates