Changeset 12181

Timestamp:

01/27/08 22:21:23 (12 months ago)

Author:

jburke

Message:

Refs #5699. Safari 3 is now working, and the general approach is much simpler than before. No need for a third iframe in IE7 now. Still need to fix Opera, but that will be hopefully fairly straight-forward. \!strict

Location:

dojox/trunk/io/proxy

Files:

• xip.js (modified) (5 diffs)
• xip_client.html (modified) (6 diffs)
• xip_server.html (modified) (3 diffs)

dojox/trunk/io/proxy/xip.js

@@ -12 +12 @@
         //Usage of XHR IFrame Proxying does not work from local disk in Safari.
 
-        xipClientUrl: dojo.config["xipClientUrl"] || dojo.moduleUrl("dojox.io.proxy", "xip_client.html"),
-
+        /*
+        This code is really focused on just sending one complete request to the server, and
+        receiving one complete response per iframe. The code does not expect to reuse iframes for multiple XHR request/response
+        sequences. This might be reworked later if performance indicates a need for it.
+        
+        xip fragment identifier/hash values have the form:
+        #id:cmd:realEncodedMessage
+
+        id: some ID that should be unique among message fragments. No inherent meaning,
+                just something to make sure the hash value is unique so the message
+                receiver knows a new message is available.
+                
+        cmd: command to the receiver. Valid values are:
+                 - init: message used to init the frame. Sent as the first URL when loading
+                         the page. Contains some config parameters.
+                 - loaded: the remote frame is loaded. Only sent from xip_client.html to this module.
+                 - ok: the message that this page sent was received OK. The next message may
+                       now be sent.
+                 - start: the start message of a block of messages (a complete message may
+                          need to be segmented into many messages to get around the limitiations
+                          of the size of an URL that a browser accepts.
+                 - part: indicates this is a part of a message.
+                 - end: the end message of a block of messages. The message can now be acted upon.
+                        If the message is small enough that it doesn't need to be segmented, then
+                        just one hash value message can be sent with "end" as the command.
+        
+        To reassemble a segmented message, the realEncodedMessage parts just have to be concatenated
+        together.
+        */
+
+        xipClientUrl: ((dojo.config || djConfig)["xipClientUrl"]) || dojo.moduleUrl("dojox.io.proxy", "xip_client.html"),
+
+
+        //MSIE has the lowest limit for URLs with fragment identifiers,
+        //at around 4K. Choosing a slightly smaller number for good measure.
+        urlLimit: 4000,
+
+        _callbackName: (dojox._scopeName || "dojox") + ".io.proxy.xip.fragmentReceived",
         _state: {},
         _stateIdCounter: 0,
-
-        needFrameRecursion: function(){
-                return (dojo.isIE >= 7);
-        },
-
-        send: function(facade){         
+        _isWebKit: navigator.userAgent.indexOf("WebKit") != -1,
+
+        send: function(facade){
                 var stateId = "XhrIframeProxy" + (this._stateIdCounter++);
                 facade._stateId = stateId;
-
-
-                var frameUrl = this.xipClientUrl + "#0:init:id=" + stateId + "&server=" 
-                        + encodeURIComponent(facade._ifpServerUrl) + "&fr=false";
-                if(this.needFrameRecursion()){
-                        //IE7 hack. Need to load server URL, and have that load the xip_client.html.
-                        //Also, this server URL needs to different from the one eventually loaded by xip_client.html
-                        //Otherwise, IE7 will not load it. Funky.
-                        var fullClientUrl = window.location.href.split("#")[0].split("?")[0];
-                        if((this.xipClientUrl + "").charAt(0) == "/"){
-                                var endIndex = fullClientUrl.indexOf("://");
-                                endIndex = fullClientUrl.indexOf("/", endIndex + 3);
-                                fullClientUrl = fullClientUrl.substring(0, endIndex);
-                        }else{
-                                fullClientUrl = fullClientUrl.substring(0, fullClientUrl.lastIndexOf("/") + 1);
-                        }
-                        fullClientUrl += this.xipClientUrl;
-                
-                        var serverUrl = facade._ifpServerUrl
-                                + (facade._ifpServerUrl.indexOf("?") == -1 ? "?" : "&") + "dojo.fr=1";
-
-                        frameUrl = serverUrl + "#0:init:id=" + stateId + "&client=" 
-                                + encodeURIComponent(fullClientUrl) + "&fr=" + this.needFrameRecursion(); //fr is for Frame Recursion
-                }
-
-                this._state[stateId] = {
-                        facade: facade,
-                        stateId: stateId,
-                        clientFrame: dojo.io.iframe.create(stateId, "", frameUrl)
-                };
-                
-                return stateId;
-        },
-        
+                var url = this.xipClientUrl;
+
+                //Make sure we are not dealing with javascript urls, just to be safe.
+                if(!url.split(":")[0].match(/javascript/i) && !facade._ifpServerUrl.split(":")[0].match(/javascript/i)){
+                        //Make xip_client a full URL.
+                        var colonIndex = url.indexOf(":");
+                        var slashIndex = url.indexOf("/");
+                        if(colonIndex == -1 || slashIndex < colonIndex){
+                                //No colon or we are starting with a / before a colon, so we need to make a full URL.
+                                var loc = window.location.href;
+                                if(slashIndex == 0){
+                                        //Have a full path, just need the domain.
+                                        url = loc.substring(0, loc.indexOf("/", 9)) + url; //Using 9 to get past http(s)://
+                                }else{
+                                        url = loc.substring(0, (loc.lastIndexOf("/") + 1)) + url;
+                                }
+                        }
+        
+                        var frameUrl = facade._ifpServerUrl + "#0:init:id=" + stateId + "&client=" 
+                                + encodeURIComponent(url) + "&callback=" + encodeURIComponent(this._callbackName);
+        
+                        this._state[stateId] = {
+                                facade: facade,
+                                stateId: stateId,
+                                clientFrame: dojo.io.iframe.create(stateId, "", frameUrl),
+                                isSending: false,
+                                serverUrl: facade._ifpServerUrl,
+                                requestData: null,
+                                responseMessage: "",
+                                requestParts: [],
+                                idCounter: 1,
+                                partIndex: 0,
+                                serverWindow: null
+                        };
+        
+                        return stateId;
+                }
+        },
+
         receive: function(/*String*/stateId, /*String*/urlEncodedData){
                 /* urlEncodedData should have the following params:
@@ -93 +131 @@
                         if(contentType){
                                 var mimeType = contentType.split(";")[0];
-                                if(mimeType == "application/xml" || mimeType == "text/xml"){
+                                if(mimeType.indexOf("application/xml") == 0 || mimeType.indexOf("text/xml") == 0){
                                         facade.responseXML = dojox.data.dom.createDocument(response.responseText, contentType);
                                 }
@@ -103 +141 @@
         },
 
-        clientFrameLoaded: function(/*String*/stateId){
+        frameLoaded: function(/*String*/stateId){
                 var state = this._state[stateId];
                 var facade = state.facade;
 
-                var clientWindow = this.needFrameRecursion() ? window.open("", state.stateId + "_clientEndPoint") : state.clientFrame.contentWindow;
+                var clientWindow = state.clientFrame.contentWindow;
 
                 var reqHeaders = [];
@@ -127 +165 @@
                 }
 
-                clientWindow.send(dojo.objectToQuery(requestData));
+                this.sendRequest(stateId, dojo.objectToQuery(requestData));
         },
         
@@ -147 +185 @@
                         return dojox.io.proxy.xip._xhrObjOld.apply(dojo, arguments);
                 }
+        },
+        
+        //**** State-bound methods ****
+        sendRequest: function(stateId, encodedData){
+                var state = this._state[stateId];
+                if(!state.isSending){
+                        state.isSending = true;
+
+                        state.requestData = encodedData || "";
+
+                        //Get a handle to the server iframe.
+                        state.serverWindow = frames[state.stateId];
+                        if (!state.serverWindow){
+                                state.serverWindow = document.getElementById(state.stateId).contentWindow;
+                        }
+                        
+                        if(state.serverWindow.contentWindow){
+                                state.serverWindow = state.serverWindow.contentWindow;
+                        }
+
+                        this.sendRequestStart(stateId);
+                }
+        },
+
+        sendRequestStart: function(stateId){
+                //Break the message into parts, if necessary.
+                var state = this._state[stateId];
+                state.requestParts = [];
+                var reqData = state.requestData;
+                var urlLength = state.serverUrl.length;
+                var partLength = this.urlLimit - urlLength;
+                var reqIndex = 0;
+
+                while((reqData.length - reqIndex) + urlLength > this.urlLimit){
+                        var part = reqData.substring(reqIndex, reqIndex + partLength);
+                        //Safari will do some extra hex escaping unless we keep the original hex
+                        //escaping complete.
+                        var percentIndex = part.lastIndexOf("%");
+                        if(percentIndex == part.length - 1 || percentIndex == part.length - 2){
+                                part = part.substring(0, percentIndex);
+                        }
+                        state.requestParts.push(part);
+                        reqIndex += part.length;
+                }
+                state.requestParts.push(reqData.substring(reqIndex, reqData.length));
+                
+                state.partIndex = 0;
+                this.sendRequestPart(stateId);
+
+        },
+        
+        sendRequestPart: function(stateId){
+                var state = this._state[stateId];
+
+                if(state.partIndex < state.requestParts.length){
+                        //Get the message part.
+                        var partData = state.requestParts[state.partIndex];
+
+                        //Get the command.
+                        var cmd = "part";
+                        if(state.partIndex + 1 == state.requestParts.length){
+                                cmd = "end";
+                        }else if (state.partIndex == 0){
+                                cmd = "start";
+                        }
+                        
+                        this.setServerUrl(stateId, cmd, partData);
+                        state.partIndex++;
+                }
+        },
+
+        setServerUrl: function(stateId, cmd, message){
+                var serverUrl = this.makeServerUrl(stateId, cmd, message);
+                var state = this._state[stateId];
+
+                //Safari won't let us replace across domains.
+                if(this._isWebKit){
+                        state.serverWindow.location = serverUrl;
+                }else{
+                        state.serverWindow.location.replace(serverUrl);
+                }
+        },
+
+        makeServerUrl: function(stateId, cmd, message){
+                var state = this._state[stateId];
+                var serverUrl = state.serverUrl + "#" + (state.idCounter++) + ":" + cmd;
+                if(message){
+                        serverUrl += ":" + message;
+                }
+                return serverUrl;
+        },
+
+        fragmentReceived: function(frag){
+                var index = frag.indexOf("#");
+                var stateId = frag.substring(0, index);
+                var encodedData = frag.substring(index + 1, frag.length);
+
+                var msg = this.unpackMessage(encodedData);
+                var state = this._state[stateId];
+
+                switch(msg.command){
+                        case "loaded":
+                                this.frameLoaded(stateId);
+                                break;
+                        case "ok":
+                                this.sendRequestPart(stateId);
+                                break;
+                        case "start":
+                                state.responseMessage = "" + msg.message;
+                                this.setServerUrl(stateId, "ok");
+                                break;
+                        case "part":
+                                state.responseMessage += msg.message;                   
+                                this.setServerUrl(stateId, "ok");
+                                break;
+                        case "end":
+                                this.setServerUrl(stateId, "ok");
+                                state.responseMessage += msg.message;
+                                this.receive(stateId, state.responseMessage);
+                                break;
+                }
+        },
+        
+        unpackMessage: function(encodedMessage){
+                var parts = encodedMessage.split(":");
+                var command = parts[1];
+                encodedMessage = parts[2] || "";
+
+                var config = null;
+                if(command == "init"){
+                        var configParts = encodedMessage.split("&");
+                        config = {};
+                        for(var i = 0; i < configParts.length; i++){
+                                var nameValue = configParts[i].split("=");
+                                config[decodeURIComponent(nameValue[0])] = decodeURIComponent(nameValue[1]);
+                        }
+                }
+                return {command: command, message: encodedMessage, config: config};
         }
 }

dojox/trunk/io/proxy/xip_client.html

@@ +1 @@
+<!--
+        /*
+                Copyright (c) 2004-2008, The Dojo Foundation
+                All Rights Reserved.
+        
+                Licensed under the Academic Free License version 2.1 or above OR the
+                modified BSD license. For more information on Dojo licensing, see:
+        
+                        http://dojotoolkit.org/community/licensing.shtml
+        */
+-->
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
@@ -9 +20 @@
         <!-- script type="text/javascript" -->
         // <!--
-        /*
-        This file is really focused on just sending one message to the server, and
-        receiving one response. The code does not expect to be re-used for multiple messages.
-        This might be reworked later if performance indicates a need for it.
-        
-        xip fragment identifier/hash values have the form:
-        #id:cmd:realEncodedMessage
-
-        id: some ID that should be unique among messages. No inherent meaning,
-                just something to make sure the hash value is unique so the message
-                receiver knows a new message is available.
-                
-        cmd: command to the receiver. Valid values are:
-                 - init: message used to init the frame. Sent as the first URL when loading
-                         the page. Contains some config parameters.
-                 - loaded: the remote frame is loaded. Only sent from server to client.
-                 - ok: the message that this page sent was received OK. The next message may
-                       now be sent.
-                 - start: the start message of a block of messages (a complete message may
-                          need to be segmented into many messages to get around the limitiations
-                          of the size of an URL that a browser accepts.
-                 - part: indicates this is a part of a message.
-                 - end: the end message of a block of messages. The message can now be acted upon.
-                        If the message is small enough that it doesn't need to be segmented, then
-                        just one hash value message can be sent with "end" as the command.
-        
-        To reassemble a segmented message, the realEncodedMessage parts just have to be concatenated
-        together.
-        */
-
-        //MSIE has the lowest limit for URLs with fragment identifiers,
-        //at around 4K. Choosing a slightly smaller number for good measure.
-        xipUrlLimit = 4000;
-        xipIdCounter = 1;
-
-        function xipInit(){
-                xipStateId = "";
-                xipIsSending = false;
-                xipServerUrl = null;
-                xipStateId = null;
-                xipRequestData = null;
-                xipCurrentHash = "";
-                xipResponseMessage = "";
-                xipRequestParts = [];
-                xipPartIndex = 0;
-                xipServerWindow = null;
-                xipUseFrameRecursion = false;
-        }
-        xipInit();
-        
-        function send(encodedData){
-                if(xipUseFrameRecursion == "true"){
-                        var clientEndPoint = window.open(xipStateId + "_clientEndPoint");
-                        clientEndPoint.send(encodedData);
-                }else{
-                        if(!xipIsSending){
-                                xipIsSending = true;
-        
-                                xipRequestData = encodedData || "";
-
-                                //Get a handle to the server iframe.
-                                xipServerWindow = frames[xipStateId + "_frame"];
-                                if (!xipServerWindow){
-                                        xipServerWindow = document.getElementById(xipStateId + "_frame").contentWindow;
-                                }
-        
-                                sendRequestStart();
-                        }
-                }
-        }
-
-        //Modify the server URL if it is a local path and 
-        //This is done for local/same domain testing.
-        function fixServerUrl(ifpServerUrl){
-                if(ifpServerUrl.indexOf("..") == 0){
-                        var parts = ifpServerUrl.split("/");
-                        ifpServerUrl = parts[parts.length - 1];
-                }
-                return ifpServerUrl;
-        }
-        
         
         function pollHash(){
@@ -98 +28 @@
                         if(newHash != xipCurrentHash){
                                 try{
-                                        messageReceived(newHash);
+                                        callMaster(xipStateId, newHash);
                                 }catch(e){
                                         //Make sure to not keep processing the error hash value.
@@ -107 +37 @@
                         }
                 }
-        }
-
-        function messageReceived(encodedData){
-                var msg = unpackMessage(encodedData);
-
-                switch(msg.command){
-                        case "loaded":
-                                xipMasterFrame.dojox.io.proxy.xip.clientFrameLoaded(xipStateId);
-                                break;
-                        case "ok":
-                                sendRequestPart();
-                                break;
-                        case "start":
-                                xipResponseMessage = "";
-                                xipResponseMessage += msg.message;
-                                setServerUrl("ok");
-                                break;
-                        case "part":
-                                xipResponseMessage += msg.message;                      
-                                setServerUrl("ok");
-                                break;
-                        case "end":
-                                setServerUrl("ok");
-                                xipResponseMessage += msg.message;
-                                xipMasterFrame.dojox.io.proxy.xip.receive(xipStateId, xipResponseMessage);
-                                break;
-                }
-        }
-        
-        function sendRequestStart(){
-                //Break the message into parts, if necessary.
-                xipRequestParts = [];
-                var reqData = xipRequestData;
-                var urlLength = xipServerUrl.length;
-                var partLength = xipUrlLimit - urlLength;
-                var reqIndex = 0;
-
-                while((reqData.length - reqIndex) + urlLength > xipUrlLimit){
-                        var part = reqData.substring(reqIndex, reqIndex + partLength);
-                        //Safari will do some extra hex escaping unless we keep the original hex
-                        //escaping complete.
-                        var percentIndex = part.lastIndexOf("%");
-                        if(percentIndex == part.length - 1 || percentIndex == part.length - 2){
-                                part = part.substring(0, percentIndex);
-                        }
-                        xipRequestParts.push(part);
-                        reqIndex += part.length;
-                }
-                xipRequestParts.push(reqData.substring(reqIndex, reqData.length));
-                
-                xipPartIndex = 0;
-                sendRequestPart();
-                
-        }
-        
-        function sendRequestPart(){
-                if(xipPartIndex < xipRequestParts.length){
-                        //Get the message part.
-                        var partData = xipRequestParts[xipPartIndex];
-
-                        //Get the command.
-                        var cmd = "part";
-                        if(xipPartIndex + 1 == xipRequestParts.length){
-                                cmd = "end";
-                        }else if (xipPartIndex == 0){
-                                cmd = "start";
-                        }
-                        
-                        setServerUrl(cmd, partData);
-                        xipPartIndex++;
-                }
-        }
-        
-        function setServerUrl(cmd, message){
-                var serverUrl = makeServerUrl(cmd, message);
-
-                //Safari won't let us replace across domains.
-                if(navigator.userAgent.indexOf("Safari") == -1){
-                        xipServerWindow.location.replace(serverUrl);
-                }else{
-                        xipServerWindow.location = serverUrl;
-                }
-        }
-        
-        function makeServerUrl(cmd, message){
-                var serverUrl = xipServerUrl + "#" + (xipIdCounter++) + ":" + cmd;
-                if(message){
-                        serverUrl += ":" + message;
-                }
-                return serverUrl;
         }
 
@@ -216 +56 @@
         }
 
-        function onClientLoad(){
-                //Decode the init params
-                var config = unpackMessage(window.location.href.split("#")[1]).config;
+        //************** Init **************************
+        xipCurrentHash = "";
+        
+        //Decode the init params
+        var fragId = window.location.href.split("#")[1];
+        var config = unpackMessage(fragId).config;
 
-                xipStateId = config.id;
+        xipStateId = config.id;
+        xipMasterFrame = parent.parent;
 
-                //Remove the query param for the IE7 recursive case.
-                xipServerUrl = fixServerUrl(config.server).replace(/(\?|\&)dojo\.fr\=1/, "");
-                
-                //Make sure we don't have a javascript: url, just for good measure.
-                if(xipServerUrl.split(":")[0].match(/javascript/i)){
-                        throw "Invalid server URL";
-                }
-
-                xipUseFrameRecursion = config["fr"];
-                
-                if(xipUseFrameRecursion == "endpoint"){
-                        xipMasterFrame = parent.parent;
-                }else{
-                        xipMasterFrame = parent;
-                }
-                
-                //Start counter to inspect hash value.
-                setInterval(pollHash, 10);
-
-                var clientUrl = window.location.href.split("#")[0];
-                var iframeNode = document.getElementsByTagName("iframe")[0];
-                iframeNode.id = xipStateId + "_frame";
-                iframeNode.src = makeServerUrl("init", 'id=' + xipStateId + '&client='
-                        + encodeURIComponent(clientUrl) + '&fr=' + xipUseFrameRecursion);
+        var parts = config.callback.split(".");
+        xipCallbackObject = xipMasterFrame;
+        for(var i = 0; i < parts.length - 1; i++){
+                xipCallbackObject = xipCallbackObject[parts[i]];
+        }
+        xipCallback = parts[parts.length - 1];
+        
+        callMaster = function(stateId, message){
+                xipCallbackObject[xipCallback](stateId + "#" + message);
         }
 
-        if(typeof(window.addEventListener) == "undefined"){
-                window.attachEvent("onload", onClientLoad);
-        }else{
-                window.addEventListener('load', onClientLoad, false);
-        }
+        //Call the master frame to let it know it is OK to start sending.
+        callMaster(xipStateId, "0:loaded");
         
+        //Start counter to inspect hash value.
+        setInterval(pollHash, 10);
+
         // -->
         <!-- </script> -->
@@ -262 +91 @@
         <p>This file is used for Dojo's XMLHttpRequest Iframe Proxy. This is the "client" file used
         internally by dojox.io.proxy.xip.</p>
-        
-        <iframe src="javascript:false"></iframe>
 </body>
 </html>

dojox/trunk/io/proxy/xip_server.html

@@ -1 +1 @@
 <!--
         /*
-                Copyright (c) 2004-2006, The Dojo Foundation
+                Copyright (c) 2004-2008, The Dojo Foundation
                 All Rights Reserved.
         
@@ -201 +201 @@
                 //Safari won't let us replace across domains.
                 if(navigator.userAgent.indexOf("Safari") == -1){
-    &nb