From 47ae09467576f23b72292ba64694a9a4a36b221d Mon Sep 17 00:00:00 2001 From: Antoine Vandecreme Date: Tue, 15 Apr 2014 12:55:32 -0400 Subject: [PATCH 1/5] Fix ajax call for file: and ftp: #73 --- src/openseadragon.js | 22 ++++++++++++++++++++-- test/basic.js | 2 +- test/utils.js | 24 ++++++++++++++++++++++++ 3 files changed, 45 insertions(+), 3 deletions(-) diff --git a/src/openseadragon.js b/src/openseadragon.js index 3be339af..8b8c6a14 100644 --- a/src/openseadragon.js +++ b/src/openseadragon.js @@ -1725,6 +1725,21 @@ window.OpenSeadragon = window.OpenSeadragon || function( options ){ return value ? value : null; }, + /** + * Retrieves the protocol used by the url. The url can either be absolute + * or relative. + * @function + * @param {String} url The url to retrieve the protocol from. + * @return {String} The protocol (http:, https:, file:, ftp: ...) + */ + getUrlProtocol: function( url ) { + var match = url.match(/^([a-z]+:)\/\//i); + if ( match === null ) { + // Relative URL, retrive the protocol from window.location + return window.location.protocol; + } + return match[1].toLowerCase(); + }, createAjaxRequest: function(){ var request; @@ -1778,10 +1793,13 @@ window.OpenSeadragon = window.OpenSeadragon || function( options ){ if ( request.readyState == 4 ) { request.onreadystatechange = function(){}; - if ( request.status == 200 ) { + var protocol = $.getUrlProtocol( url ); + var successStatus = + protocol === "http:" || protocol === "https:" ? 200 : 0; + if ( request.status === successStatus ) { onSuccess( request ); } else { - $.console.log( "AJAX request returned %s: %s", request.status, url ); + $.console.log( "AJAX request returned %d: %s", request.status, url ); if ( $.isFunction( onError ) ) { onError( request ); diff --git a/test/basic.js b/test/basic.js index 946a8ff3..969f492f 100644 --- a/test/basic.js +++ b/test/basic.js @@ -56,7 +56,7 @@ equal($(".openseadragon-message").length, 1, "Open failures should display a message"); - ok(testLog.log.contains('["AJAX request returned %s: %s",404,"/test/data/not-a-real-file"]'), + ok(testLog.log.contains('["AJAX request returned %d: %s",404,"/test/data/not-a-real-file"]'), "AJAX failures should be logged to the console"); start(); diff --git a/test/utils.js b/test/utils.js index f46f9a84..92538375 100644 --- a/test/utils.js +++ b/test/utils.js @@ -87,6 +87,30 @@ ); }); + test("getUrlProtocol", function() { + + equal(OpenSeadragon.getUrlProtocol("test"), window.location.protocol, + "'test' url protocol should be window.location.protocol"); + + equal(OpenSeadragon.getUrlProtocol("/test"), window.location.protocol, + "'/test' url protocol should be window.location.protocol"); + + equal(OpenSeadragon.getUrlProtocol("//test"), window.location.protocol, + "'//test' url protocol should be window.location.protocol"); + + equal(OpenSeadragon.getUrlProtocol("http://test"), "http:", + "'http://test' url protocol should be http:"); + + equal(OpenSeadragon.getUrlProtocol("https://test"), "https:", + "'https://test' url protocol should be https:"); + + equal(OpenSeadragon.getUrlProtocol("file://test"), "file:", + "'file://test' url protocol should be file:"); + + equal(OpenSeadragon.getUrlProtocol("FTP://test"), "ftp:", + "'FTP://test' url protocol should be ftp:"); + }); + // ---------- asyncTest("requestAnimationFrame", function() { var timeWatcher = Util.timeWatcher(); From 3b4dca329db2480b1f7b09069a449d8eaa8453ec Mon Sep 17 00:00:00 2001 From: Antoine Vandecreme Date: Thu, 17 Apr 2014 16:13:26 -0400 Subject: [PATCH 2/5] Use ActiveX on IE when requesting a file: URL with ajax. --- src/openseadragon.js | 54 ++++++++++++++++++++++---------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/src/openseadragon.js b/src/openseadragon.js index 8b8c6a14..b74bdb9e 100644 --- a/src/openseadragon.js +++ b/src/openseadragon.js @@ -1741,35 +1741,35 @@ window.OpenSeadragon = window.OpenSeadragon || function( options ){ return match[1].toLowerCase(); }, - createAjaxRequest: function(){ - var request; - - if ( window.XMLHttpRequest ) { - $.createAjaxRequest = function( ){ + /** + * Create an XHR object + * @param {type} [local] If set to true, the XHR will be file: protocol + * compatible if possible (but may raise a warning in the browser). + * @returns {XMLHttpRequest} + */ + createAjaxRequest: function( local ) { + if ( window.ActiveXObject ) { + if ( window.XMLHttpRequest ) { + $.createAjaxRequest = function( local ) { + if ( local ) { + /* global ActiveXObject:true */ + return new ActiveXObject( "Microsoft.XMLHTTP" ); + } + return new XMLHttpRequest(); + }; + } else { + $.createAjaxRequest = function() { + return new ActiveXObject( "Microsoft.XMLHTTP" ); + }; + } + } else if ( window.XMLHttpRequest ) { + $.createAjaxRequest = function() { return new XMLHttpRequest(); }; - request = new XMLHttpRequest(); - } else if ( window.ActiveXObject ) { - /*jshint loopfunc:true*/ - /* global ActiveXObject:true */ - for ( var i = 0; i < ACTIVEX.length; i++ ) { - try { - request = new ActiveXObject( ACTIVEX[ i ] ); - $.createAjaxRequest = function( ){ - return new ActiveXObject( ACTIVEX[ i ] ); - }; - break; - } catch (e) { - continue; - } - } - } - - if ( !request ) { + } else { throw new Error( "Browser doesn't support XMLHttpRequest." ); } - - return request; + return $.createAjaxRequest( local ); }, @@ -1782,7 +1782,8 @@ window.OpenSeadragon = window.OpenSeadragon || function( options ){ * @throws {Error} */ makeAjaxRequest: function( url, onSuccess, onError ) { - var request = $.createAjaxRequest(); + var protocol = $.getUrlProtocol( url ); + var request = $.createAjaxRequest( protocol === "file:" ); if ( !$.isFunction( onSuccess ) ) { throw new Error( "makeAjaxRequest requires a success callback" ); @@ -1793,7 +1794,6 @@ window.OpenSeadragon = window.OpenSeadragon || function( options ){ if ( request.readyState == 4 ) { request.onreadystatechange = function(){}; - var protocol = $.getUrlProtocol( url ); var successStatus = protocol === "http:" || protocol === "https:" ? 200 : 0; if ( request.status === successStatus ) { From 116cf7449f64c60a4bee267ad3d152dc61f03983 Mon Sep 17 00:00:00 2001 From: Antoine Vandecreme Date: Thu, 17 Apr 2014 17:20:04 -0400 Subject: [PATCH 3/5] Test if activex is available by trying to create one for ie11 compatibility. --- src/openseadragon.js | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/src/openseadragon.js b/src/openseadragon.js index b74bdb9e..8e0168ac 100644 --- a/src/openseadragon.js +++ b/src/openseadragon.js @@ -1748,11 +1748,21 @@ window.OpenSeadragon = window.OpenSeadragon || function( options ){ * @returns {XMLHttpRequest} */ createAjaxRequest: function( local ) { - if ( window.ActiveXObject ) { + // IE11 does not support window.ActiveXObject so we just try to + // create one to see if it is supported. + // See: http://msdn.microsoft.com/en-us/library/ie/dn423948%28v=vs.85%29.aspx + var supportActiveX; + try { + /* global ActiveXObject:true */ + supportActiveX = !!new ActiveXObject( "Microsoft.XMLHTTP" ); + } catch( e ) { + supportActiveX = false; + } + + if ( supportActiveX ) { if ( window.XMLHttpRequest ) { $.createAjaxRequest = function( local ) { if ( local ) { - /* global ActiveXObject:true */ return new ActiveXObject( "Microsoft.XMLHTTP" ); } return new XMLHttpRequest(); @@ -2001,12 +2011,7 @@ window.OpenSeadragon = window.OpenSeadragon || function( options ){ }; - var ACTIVEX = [ - "Msxml2.XMLHTTP", - "Msxml3.XMLHTTP", - "Microsoft.XMLHTTP" - ], - FILEFORMATS = { + var FILEFORMATS = { "bmp": false, "jpeg": true, "jpg": true, From 6a24af3743a01a4407debf9f6f0533c1806cfd0a Mon Sep 17 00:00:00 2001 From: Antoine Vandecreme Date: Fri, 18 Apr 2014 16:59:47 -0400 Subject: [PATCH 4/5] Add @private to internal methods. --- src/openseadragon.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/openseadragon.js b/src/openseadragon.js index 8e0168ac..289652b6 100644 --- a/src/openseadragon.js +++ b/src/openseadragon.js @@ -1729,6 +1729,7 @@ window.OpenSeadragon = window.OpenSeadragon || function( options ){ * Retrieves the protocol used by the url. The url can either be absolute * or relative. * @function + * @private * @param {String} url The url to retrieve the protocol from. * @return {String} The protocol (http:, https:, file:, ftp: ...) */ @@ -1743,6 +1744,7 @@ window.OpenSeadragon = window.OpenSeadragon || function( options ){ /** * Create an XHR object + * @private * @param {type} [local] If set to true, the XHR will be file: protocol * compatible if possible (but may raise a warning in the browser). * @returns {XMLHttpRequest} @@ -1782,7 +1784,6 @@ window.OpenSeadragon = window.OpenSeadragon || function( options ){ return $.createAjaxRequest( local ); }, - /** * Makes an AJAX request. * @function From e7ca7b1e95385988272cbe5db393f32ca56e1636 Mon Sep 17 00:00:00 2001 From: Antoine Vandecreme Date: Mon, 21 Apr 2014 09:23:17 -0400 Subject: [PATCH 5/5] Prefer DOMParser over ActiveX when both are availables. --- src/openseadragon.js | 29 +++++++++++++---------------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/src/openseadragon.js b/src/openseadragon.js index 289652b6..628d128d 100644 --- a/src/openseadragon.js +++ b/src/openseadragon.js @@ -1947,23 +1947,9 @@ window.OpenSeadragon = window.OpenSeadragon || function( options ){ * @returns {Document} */ parseXml: function( string ) { - //TODO: yet another example where we can determine the correct - // implementation once at start-up instead of everytime we use - // the function. DONE. - if ( window.ActiveXObject ) { + if ( window.DOMParser ) { - $.parseXml = function( string ){ - var xmlDoc = null; - - xmlDoc = new ActiveXObject( "Microsoft.XMLDOM" ); - xmlDoc.async = false; - xmlDoc.loadXML( string ); - return xmlDoc; - }; - - } else if ( window.DOMParser ) { - - $.parseXml = function( string ){ + $.parseXml = function( string ) { var xmlDoc = null, parser; @@ -1972,6 +1958,17 @@ window.OpenSeadragon = window.OpenSeadragon || function( options ){ return xmlDoc; }; + } else if ( window.ActiveXObject ) { + + $.parseXml = function( string ) { + var xmlDoc = null; + + xmlDoc = new ActiveXObject( "Microsoft.XMLDOM" ); + xmlDoc.async = false; + xmlDoc.loadXML( string ); + return xmlDoc; + }; + } else { throw new Error( "Browser doesn't support XML DOM." ); }