Add new version of FlashBridge for AS3

This class implements a synchronous bridge for SWF to SWF communication.

It works by taking advantage of sharedEvents being synchronous and crossing sandbox origins.

A developer would modify it's source code by changing:
import flash.external.ExternalInterface
to
import com.google.caja.external.ExternalInterface

this change can be done automatically by simply adding the com.google.caja package and modifying references to the package flash.external with com.google.external.

[Jasvir, 2010-11-04 19:16:12]

Given that it needs Flex to compile this, please checkin a compiled version of
the flash bridge together with the rest of the change.  A good place to put it
is in com/google/caja/flash.  You can also move some of the .as files that are
in com/google/caja directory to the flash subdirectory.

Stay please add comments on what the whitelisting that addCallback the bridge
needs.

Thanks for you help evn!

http://codereview.appspot.com/2885041/diff/1/FlashBridge.as
File FlashBridge.as (right):

http://codereview.appspot.com/2885041/diff/1/FlashBridge.as#newcode143
FlashBridge.as:143: navigateToURL(data.url);
Ok.  When the flash bridge is initialized, it should be passed a reference to
the uriCallback which this function can in turn call.  You can leave this as a
TODO for this CL.

[metaweta, 2010-11-04 20:14:41]

Thanks, evn!

It looks like there's a mix of tabs and spaces throughout the files; please use
two spaces to indent functions and four on long line continuations.

Also, please put this in the com.google.caja.flash package, not in
com.google.caja itself.

http://codereview.appspot.com/2885041/diff/1/FlashBridge.as
File FlashBridge.as (right):

http://codereview.appspot.com/2885041/diff/1/FlashBridge.as#newcode89
FlashBridge.as:89: ExternalInterface.call("onLoaderInit", cajaContext);
We'd like to put all of these event handlers into one namespace, so please
change 
  ExternalInterface.call("onLoaderInit", cajaContext);
to
  ExternalInterface.call("___.flash.onLoaderInit", cajaContext);

http://codereview.appspot.com/2885041/diff/1/FlashBridge.as#newcode93
FlashBridge.as:93: ExternalInterface.call("onLoaderError", cajaContext);
Ditto, ___.flash.onLoaderError

http://codereview.appspot.com/2885041/diff/1/FlashBridge.as#newcode107
FlashBridge.as:107: data.functionCallback);
After adding the callback, insert

ExternalInterface.call('___.flash.onAddCallback', cajaContext,
data.functionName)

so that Caja can whitelist the method on the flash object.

http://codereview.appspot.com/2885041/diff/1/FlashBridge.as#newcode124
FlashBridge.as:124: "callJS",
Change "callJS" to "___.flash.onCall"

http://codereview.appspot.com/2885041/diff/1/FlashBridge.as#newcode143
FlashBridge.as:143: navigateToURL(data.url);
On 2010/11/04 19:16:12, jasvir wrote:
> Ok.  When the flash bridge is initialized, it should be passed a reference to

Jas, you can't pass references across the Flash/JS boundary.  Instead of doing
the call to navigateToURL, it should do

ExternalInterface.call("___.flash.onNavigateToURL", data.url);

and the host page can decide what to do with the URL.

http://codereview.appspot.com/2885041/diff/1/FlashBridgeClient.as
File FlashBridgeClient.as (right):

http://codereview.appspot.com/2885041/diff/1/FlashBridgeClient.as#newcode36
FlashBridgeClient.as:36: if
(ApplicationDomain.currentDomain.hasDefinition("com.google.caja.Rewriter")) {
long line

http://codereview.appspot.com/2885041/diff/1/FlashBridgeClient.as#newcode37
FlashBridgeClient.as:37: var rw:Class =
ApplicationDomain.currentDomain.getDefinition("com.google.caja.Rewriter") as
Class;
long line

http://codereview.appspot.com/2885041/diff/1/FlashBridgeTest.as
File FlashBridgeTest.as (right):

http://codereview.appspot.com/2885041/diff/1/FlashBridgeTest.as#newcode25
FlashBridgeTest.as:25: flash.external.ExternalInterface.call(
We expect this to fail when it gets loaded by the bridge, right?

http://codereview.appspot.com/2885041/diff/1/Rewriter.as
File Rewriter.as (right):

http://codereview.appspot.com/2885041/diff/1/Rewriter.as#newcode41
Rewriter.as:41: l.load(u, new LoaderContext(true,
ApplicationDomain.currentDomain, SecurityDomain.currentDomain));
long line

http://codereview.appspot.com/2885041/diff/1/Rewriter.as#newcode42
Rewriter.as:42: l.contentLoaderInfo.addEventListener(Event.INIT, function():* {
long line

[evn, 2010-11-04 23:24:57]

Done most of the changes, another will come soon.

http://codereview.appspot.com/2885041/diff/1/FlashBridge.as
File FlashBridge.as (right):

http://codereview.appspot.com/2885041/diff/1/FlashBridge.as#newcode89
FlashBridge.as:89: ExternalInterface.call("onLoaderInit", cajaContext);
On 2010/11/04 20:14:41, metaweta wrote:
> We'd like to put all of these event handlers into one namespace, so please
> change 
>   ExternalInterface.call("onLoaderInit", cajaContext);
> to
>   ExternalInterface.call("___.flash.onLoaderInit", cajaContext);

Done.

http://codereview.appspot.com/2885041/diff/1/FlashBridge.as#newcode93
FlashBridge.as:93: ExternalInterface.call("onLoaderError", cajaContext);
On 2010/11/04 20:14:41, metaweta wrote:
> Ditto, ___.flash.onLoaderError

Done.

http://codereview.appspot.com/2885041/diff/1/FlashBridge.as#newcode107
FlashBridge.as:107: data.functionCallback);
On 2010/11/04 20:14:41, metaweta wrote:
> After adding the callback, insert
> 
> ExternalInterface.call('___.flash.onAddCallback', cajaContext,
> data.functionName)
> 
> so that Caja can whitelist the method on the flash object.

Done.

http://codereview.appspot.com/2885041/diff/1/FlashBridge.as#newcode124
FlashBridge.as:124: "callJS",
On 2010/11/04 20:14:41, metaweta wrote:
> Change "callJS" to "___.flash.onCall"

Done.

http://codereview.appspot.com/2885041/diff/1/FlashBridge.as#newcode143
FlashBridge.as:143: navigateToURL(data.url);
On 2010/11/04 20:14:41, metaweta wrote:
> On 2010/11/04 19:16:12, jasvir wrote:
> > Ok.  When the flash bridge is initialized, it should be passed a reference
to
> 
> Jas, you can't pass references across the Flash/JS boundary.  Instead of doing
> the call to navigateToURL, it should do
> 
> ExternalInterface.call("___.flash.onNavigateToURL", data.url);
> 
> and the host page can decide what to do with the URL.

I'm also sending cajaContext

Done.

http://codereview.appspot.com/2885041/diff/1/FlashBridgeClient.as
File FlashBridgeClient.as (right):

http://codereview.appspot.com/2885041/diff/1/FlashBridgeClient.as#newcode36
FlashBridgeClient.as:36: if
(ApplicationDomain.currentDomain.hasDefinition("com.google.caja.Rewriter")) {
On 2010/11/04 20:14:41, metaweta wrote:
> long line

Done.

http://codereview.appspot.com/2885041/diff/1/FlashBridgeClient.as#newcode37
FlashBridgeClient.as:37: var rw:Class =
ApplicationDomain.currentDomain.getDefinition("com.google.caja.Rewriter") as
Class;
On 2010/11/04 20:14:41, metaweta wrote:
> long line

Done.

http://codereview.appspot.com/2885041/diff/1/FlashBridgeTest.as
File FlashBridgeTest.as (right):

http://codereview.appspot.com/2885041/diff/1/FlashBridgeTest.as#newcode25
FlashBridgeTest.as:25: flash.external.ExternalInterface.call(
On 2010/11/04 20:14:41, metaweta wrote:
> We expect this to fail when it gets loaded by the bridge, right?

yep, at the end when you get the errors (last line) you should get
com.google.caja.flash.external pass and flash.external win when loaded without
the sandbox, and viceversa.

http://codereview.appspot.com/2885041/diff/1/Rewriter.as
File Rewriter.as (right):

http://codereview.appspot.com/2885041/diff/1/Rewriter.as#newcode41
Rewriter.as:41: l.load(u, new LoaderContext(true,
ApplicationDomain.currentDomain, SecurityDomain.currentDomain));
On 2010/11/04 20:14:41, metaweta wrote:
> long line

Done.

http://codereview.appspot.com/2885041/diff/1/Rewriter.as#newcode42
Rewriter.as:42: l.contentLoaderInfo.addEventListener(Event.INIT, function():* {
On 2010/11/04 20:14:41, metaweta wrote:
> long line

Done.

[evn, 2010-11-04 23:39:51]

Ok, now everything is really done. fixed the tabs and a few other style
problems..

Since I changed the files (before they were in src/com/google/caja and now in
src/com/google/caja/flash the comments and the "Done" are in the wrong file.. so
even if it looks like it's not Done, it is..

[metaweta, 2010-11-04 23:50:24]

LGTM

[evn, 2010-11-05 00:50:56]

On 2010/11/04 23:50:24, metaweta wrote:
> LGTM

Added flashbridge.swf and flashbridgetest.swf as jas suggested.

[evn, 2010-11-05 01:13:41]

evn@greencat:~/svn-changes/flashbridge/google-caja/src/com/google/caja$
~/google-caja/tools/myvn submit
/home/evn/google-caja/tools/myvn: line 282: ant-lib/runtests.current.patch: No
such file or directory
Running tests before submission
Buildfile: build.xml does not exist!
Build failed

How the submission works?

[metaweta, 2010-11-05 01:32:14]

You have to run myvn submit from the google-caja directory.

On Thu, Nov 4, 2010 at 6:13 PM,  <evn@google.com> wrote:
> evn@greencat:~/svn-changes/flashbridge/google-caja/src/com/google/caja$
> ~/google-caja/tools/myvn submit
> /home/evn/google-caja/tools/myvn: line 282:
> ant-lib/runtests.current.patch: No such file or directory
> Running tests before submission
> Buildfile: build.xml does not exist!
> Build failed
>
> How the submission works?
>
> http://codereview.appspot.com/2885041/
>



-- 
Mike Stay - metaweta@gmail.com
http://www.cs.auckland.ac.nz/~mike
http://reperiendi.wordpress.com