You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
421 lines
14 KiB
421 lines
14 KiB
16 years ago
|
/**
|
||
|
|
* xslTransform
|
||
|
|
* Tools for XSLT transformations; jQuery wrapper for Sarissa <http://sarissa.sourceforge.net/>.
|
||
|
|
* See jQuery.fn.log below for documentation on $.log().
|
||
|
|
* See jQuery.fn.getTransform below for documention on the $.getTransform().
|
||
|
|
* See var DEBUG below for turning debugging/logging on and off.
|
||
|
|
*
|
||
|
|
* @version 20071214
|
||
|
|
* @since 2006-07-05
|
||
|
|
* @copyright Copyright (c) 2006 Glyphix Studio, Inc. http://www.glyphix.com
|
||
|
|
* @author Brad Brizendine <brizbane@gmail.com>, Matt Antone <antone@glyphix.com>
|
||
|
|
* @license MIT http://www.opensource.org/licenses/mit-license.php
|
||
|
|
* @requires >= jQuery 1.0.3 http://jquery.com/
|
||
|
|
* @requires jquery.debug.js http://jquery.glyphix.com/
|
||
|
|
* @requires >= sarissa.js 0.9.7.6 http://sarissa.sourceforge.net/
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var r = $.xsl.transform('path-to-xsl.xsl','path-to-xml.xml');
|
||
|
|
* @desc Perform a transformation and place the results in var r
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var r = $.xsl.transform('path-to-xsl.xsl','path-to-xml.xml');
|
||
|
|
* var str = $.xsl.serialize( r );
|
||
|
|
* @desc Perform a transformation, then turn the result into a string
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var doc = $.xsl.load('path-to-xml.xml');
|
||
|
|
* @desc Load an xml file and return a parsed xml object
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var xml = '<xmldoc><foo>bar</foo></xmldoc>';
|
||
|
|
* var doc = $.xsl.load(xml);
|
||
|
|
* @desc Load an xml string and return a parsed xml object
|
||
|
|
*/
|
||
|
|
|
||
|
|
(function($){
|
||
|
|
|
||
|
|
/*
|
||
|
|
* JQuery XSLT transformation plugin.
|
||
|
|
* Replaces all matched elements with the results of an XSLT transformation.
|
||
|
|
* See xslTransform above for more documentation.
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* @desc See the xslTransform-example/index.html
|
||
|
|
*
|
||
|
|
* @param xsl String the url to the xsl file
|
||
|
|
* @param xml String the url to the xml file
|
||
|
|
* @param options Object various switches you can send to this function
|
||
|
|
* + params: an object of key/value pairs to be sent to xsl as parameters
|
||
|
|
* + xpath: defines the root node within the provided xml file
|
||
|
|
* + eval: if true, will attempt to eval javascript found in the transformed result
|
||
|
|
* + callback: if a Function, evaluate it when transformation is complete
|
||
|
|
* @returns
|
||
|
|
*/
|
||
|
|
$.fn.getTransform = function( xsl, xml, options ){
|
||
|
|
var settings = {
|
||
|
|
params: {}, // object of key/value pairs ... parameters to send to the XSL stylesheet
|
||
|
|
xpath: '', // xpath, used to send only a portion of the XML file to the XSL stylesheet
|
||
|
|
eval: true, // evaluate <script> blocks found in the transformed result
|
||
|
|
callback: '' // callback function, to be run on completion of the transformation
|
||
|
|
};
|
||
|
|
// initialize options hash; override the defaults with supplied options
|
||
|
|
$.extend( settings, options );
|
||
|
|
$.log( 'getTransform: ' + xsl + '::' + xml + '::' + settings.toString() );
|
||
|
|
|
||
|
|
// must have both xsl and xml
|
||
|
|
if( !xsl || !xml ){
|
||
|
|
$.log( 'getTransform: missing xsl or xml' );
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
// run the jquery magic on all matched elements
|
||
|
|
return this.each( function(){
|
||
|
|
// perform the transformation
|
||
|
|
var trans = $.xsl.transform( xsl, xml, settings );
|
||
|
|
|
||
|
|
// make sure we have something
|
||
|
|
if( !trans.string ){
|
||
|
|
$.log('Received nothing from the transformation');
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
// ie can fail if there's an xml declaration line in the returned result
|
||
|
|
var re = trans.string.match(/<\?xml.*?\?>/);
|
||
|
|
if( re ){
|
||
|
|
trans.string = trans.string.replace( re, '' );
|
||
|
|
$.log( 'getTransform(): found an xml declaration and removed it' );
|
||
|
|
}
|
||
|
|
|
||
|
|
// place the result in the element
|
||
|
|
// 20070202: jquery 1.1.1 can get a "a.appendChild is not a function" error using html() sometimes ...
|
||
|
|
// no idea why yet, so adding a fallback to innerHTML
|
||
|
|
// ::warning:: ie6 has trouble with javascript events such as onclick assigned statically within the html when using innerHTML
|
||
|
|
try{
|
||
|
|
$(this).html( trans.string );
|
||
|
|
}catch(e){
|
||
|
|
$.log( 'getTransform: error placing results of transform into element, falling back to innerHTML: ' + e.toString() );
|
||
|
|
$(this)[0].innerHTML = trans.string;
|
||
|
|
}
|
||
|
|
|
||
|
|
// there might not be a scripts property
|
||
|
|
if( settings.eval && trans.scripts ){
|
||
|
|
if( trans.scripts.length > 0 ){
|
||
|
|
$.log( 'Found text/javascript in transformed result' );
|
||
|
|
// use jquery's globaleval to avoid security issues in adobe air
|
||
|
|
$.globalEval( trans.scripts );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// run the callback if it's a native function
|
||
|
|
if( settings.callback && $.isFunction(settings.callback) ){
|
||
|
|
settings.callback.apply();
|
||
|
|
}
|
||
|
|
|
||
|
|
});
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
// xsl scope
|
||
|
|
$.xsl = {
|
||
|
|
|
||
|
|
// version
|
||
|
|
version: 20071214,
|
||
|
|
|
||
|
|
// init ... test for requirements
|
||
|
|
init: function(){
|
||
|
|
// check for v1.0.4 / v1.1 or later of jQuery
|
||
|
|
try{
|
||
|
|
parseFloat($.fn.jquery) >= 1;
|
||
|
|
}catch(e){
|
||
|
|
alert('xslTransform requires jQuery 1.0.4 or greater ... please load it prior to xslTransform');
|
||
|
|
}
|
||
|
|
// check for Sarissa
|
||
|
|
try{
|
||
|
|
Sarissa;
|
||
|
|
}catch(e){
|
||
|
|
alert('Missing Sarissa ... please load it prior to xslTransform');
|
||
|
|
}
|
||
|
|
// if no log function, create a blank one
|
||
|
|
if( !$.log ){
|
||
|
|
$.log = function(){};
|
||
|
|
$.fn.debug = function(){};
|
||
|
|
}
|
||
|
|
// log the version
|
||
|
|
$.log( 'xslTransform:init(): version ' + this.version );
|
||
|
|
},
|
||
|
|
|
||
|
|
// initialize Sarissa's serializer
|
||
|
|
XMLSerializer: new XMLSerializer(),
|
||
|
|
|
||
|
|
/*
|
||
|
|
* serialize
|
||
|
|
* Turns the provided object into a string and returns it.
|
||
|
|
*
|
||
|
|
* @param data Mixed
|
||
|
|
* @returns String
|
||
|
|
*/
|
||
|
|
serialize: function( data ){
|
||
|
|
$.log( 'serialize(): received ' + typeof(data) );
|
||
|
|
// if it's already a string, no further processing required
|
||
|
|
if( typeof(data) == 'string' ){
|
||
|
|
$.log( 'data is already a string: ' + data );
|
||
|
|
return data;
|
||
|
|
}
|
||
|
|
return this.XMLSerializer.serializeToString( data );
|
||
|
|
},
|
||
|
|
|
||
|
|
/*
|
||
|
|
* xmlize
|
||
|
|
* Turns the provided javascript object into an xml document and returns it.
|
||
|
|
*
|
||
|
|
* @param data Mixed
|
||
|
|
* @returns String
|
||
|
|
*/
|
||
|
|
xmlize: function( data, root ){
|
||
|
|
$.log( 'xmlize(): received ' + typeof(data) );
|
||
|
|
root = root || 'root';
|
||
|
|
return Sarissa.xmlize(data,root);
|
||
|
|
},
|
||
|
|
|
||
|
|
/*
|
||
|
|
* load
|
||
|
|
* Attempts to load xml data by automatically sensing the type of the provided data.
|
||
|
|
*
|
||
|
|
* @param xml Mixed the xml data
|
||
|
|
* @returns Object
|
||
|
|
*/
|
||
|
|
load: function( xml ){
|
||
|
|
$.log( 'load(): received ' + typeof(xml) );
|
||
|
|
// the result
|
||
|
|
var r;
|
||
|
|
|
||
|
|
// if it's an object, assume it's already an XML object, so just return it
|
||
|
|
if( typeof(xml) == 'object' ){
|
||
|
|
return xml;
|
||
|
|
}
|
||
|
|
|
||
|
|
// if it's a string, determine if it's xml data or a path
|
||
|
|
// assume that the first character is an opening caret if it's XML data
|
||
|
|
if( xml.substring(0,1) == '<' ){
|
||
|
|
r = this.loadString( xml );
|
||
|
|
}else{
|
||
|
|
r = this.loadFile( xml );
|
||
|
|
}
|
||
|
|
|
||
|
|
if( r ){
|
||
|
|
// the following two lines are needed to get IE (msxml3) to run xpath ... set it on all xml data
|
||
|
|
r.setProperty( 'SelectionNamespaces', 'xmlns:xsl="http://www.w3.org/1999/XSL/Transform"' );
|
||
|
|
r.setProperty( 'SelectionLanguage', 'XPath' );
|
||
|
|
return r;
|
||
|
|
}else{
|
||
|
|
$.log( 'Unable to load ' + xml );
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
},
|
||
|
|
|
||
|
|
/*
|
||
|
|
* loadString
|
||
|
|
* Parses an XML string and returns the result.
|
||
|
|
*
|
||
|
|
* @param str String the xml string to turn into a parsed XML object
|
||
|
|
* @returns Object
|
||
|
|
*/
|
||
|
|
loadString: function( str ){
|
||
|
|
$.log( 'loadString(): ' + str + '::' + typeof(str) );
|
||
|
|
|
||
|
|
// use Sarissa to generate an XML doc
|
||
|
|
var p = new DOMParser();
|
||
|
|
var xml = p.parseFromString( str, 'text/xml' );
|
||
|
|
if( !xml ){
|
||
|
|
$.log( 'loadString(): parseFromString() failed' );
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
return xml;
|
||
|
|
},
|
||
|
|
|
||
|
|
/*
|
||
|
|
* loadFile
|
||
|
|
* Attempts to retrieve the requested path, specified by url.
|
||
|
|
* If url is an object, it's assumed it's already loaded, and just returns it.
|
||
|
|
*
|
||
|
|
* @param url Mixed
|
||
|
|
* @returns Object
|
||
|
|
*/
|
||
|
|
loadFile: function( url ){
|
||
|
|
$.log( 'loadFile(): ' + url + '::' + typeof(url) );
|
||
|
|
|
||
|
|
if( !url ){
|
||
|
|
$.log( 'ERROR: loadFile() missing url' );
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
// variable to hold ajax results
|
||
|
|
var doc;
|
||
|
|
/* ajax functionality provided by jQuery is commented, since it can't handle file:///
|
||
|
|
// function to receive data on successful download ... semicolon after brace is necessary for packing
|
||
|
|
this.xhrsuccess = function(data,str){
|
||
|
|
$.log( 'loadFile() completed successfully (' + str + ')' );
|
||
|
|
doc = data;
|
||
|
|
return true;
|
||
|
|
};
|
||
|
|
// function to handle downloading error ... semicolon after brace is necessary for packing
|
||
|
|
this.xhrerror = function(xhr,err){
|
||
|
|
// set debugging to true in order to force the display of this error
|
||
|
|
window.DEBUG = true;
|
||
|
|
$.log( 'loadFile() failed to load the requested file: (' + err + ') - xml: ' + xhr.responseXML + ' - text: ' + xhr.responseText );
|
||
|
|
doc = null;
|
||
|
|
return false;
|
||
|
|
};
|
||
|
|
|
||
|
|
// make asynchronous ajax call and call functions defined above on success/error
|
||
|
|
$.ajax({
|
||
|
|
type: 'GET',
|
||
|
|
url: url,
|
||
|
|
async: false,
|
||
|
|
success: this.xhrsuccess,
|
||
|
|
error: this.xhrerror
|
||
|
|
});
|
||
|
|
*/
|
||
|
|
|
||
|
|
var xmlhttp = new XMLHttpRequest();
|
||
|
|
xmlhttp.open('GET', url, false);
|
||
|
|
xmlhttp.send('');
|
||
|
|
doc = xmlhttp.responseXML;
|
||
|
|
|
||
|
|
// check for total failure
|
||
|
|
if( !doc ){
|
||
|
|
$.log( 'ERROR: document ' + url + ' not found (404), or unable to load' );
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
// check for success but no data
|
||
|
|
if( doc.length == 0 ){
|
||
|
|
$.log( 'ERROR: document ' + url + ' loaded in loadFile() has no data' );
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
return doc;
|
||
|
|
},
|
||
|
|
|
||
|
|
/*
|
||
|
|
* transform
|
||
|
|
* Central transformation function: takes an xml doc and an xsl doc.
|
||
|
|
*
|
||
|
|
* @param xsl Mixed the xsl transformation document
|
||
|
|
* @param xml Mixed the xml document to be transformed
|
||
|
|
* @param options Object various switches you can send to this function
|
||
|
|
* + params: an object of key/value pairs to be sent to xsl as parameters
|
||
|
|
* + xpath: defines the root node within the provided xml file
|
||
|
|
* @returns Object the results of the transformation
|
||
|
|
* + xsl: the raw xsl doc
|
||
|
|
* + doc: the raw results of the transform
|
||
|
|
* + string: the serialized doc
|
||
|
|
*/
|
||
|
|
transform: function( xsl, xml, options ){
|
||
|
|
$.log( 'transform(): ' + xsl + '::' + xml + '::' + (options ? options.toString() : 'no options provided') );
|
||
|
|
|
||
|
|
// set up request and result
|
||
|
|
var request = {
|
||
|
|
// the source and loaded object for xml
|
||
|
|
xsl: {
|
||
|
|
source: xsl,
|
||
|
|
doc: null
|
||
|
|
},
|
||
|
|
// the source and loaded object for xsl
|
||
|
|
xml: {
|
||
|
|
source: xml,
|
||
|
|
doc: null
|
||
|
|
},
|
||
|
|
// the options
|
||
|
|
options: options || {},
|
||
|
|
// the result doc and string
|
||
|
|
result: {
|
||
|
|
doc: null,
|
||
|
|
string: '',
|
||
|
|
scripts: null,
|
||
|
|
error: ''
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// set up error handler
|
||
|
|
var err = function( what ){
|
||
|
|
var docerr = '', srcerr = '';
|
||
|
|
// build the src error string
|
||
|
|
srcerr = (typeof(request[what].source) == 'string') ? ' (' + what + ' loaded from provided path)' : ' (' + what + ' loaded from provided object)';
|
||
|
|
// build the text error string
|
||
|
|
docerr = (typeof(request[what].doc) == 'object') ? '[success]' : '[failure]';
|
||
|
|
// include the root node if we have a doc object and it's xml
|
||
|
|
if( what == 'xml' && typeof(request[what].doc) == 'object' ){
|
||
|
|
docerr += ' root node of "' + request[what].doc.getElementsByTagName('*')[0].nodeName + '"';
|
||
|
|
}
|
||
|
|
return docerr + ' ' + srcerr;
|
||
|
|
}
|
||
|
|
|
||
|
|
// load the files
|
||
|
|
try{
|
||
|
|
request.xsl.doc = this.load(xsl);
|
||
|
|
request.xml.doc = this.load(xml);
|
||
|
|
}catch(e){
|
||
|
|
$.log('Unable to load either xsl [' + err('xsl') + '] or xml [' + err('xml') + ']');
|
||
|
|
throw( err('xsl') + '::' + err('xml') );
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
// if we have an xpath, replace xml.doc with the results of running it
|
||
|
|
// as of 2007-12-03, IE throws a "msxml6: the parameter is incorrect" error, so removing this
|
||
|
|
if( request.options.xpath && request.xml.doc && !jQuery.browser.msie ){
|
||
|
|
// run the xpath
|
||
|
|
request.xml.doc = request.xml.doc.selectSingleNode( request.options.xpath.toString() );
|
||
|
|
$.log( 'transform(): xpath has been run...resulting doc: ' + (this.serialize(request.xml.doc)) );
|
||
|
|
}
|
||
|
|
|
||
|
|
// attach the processor
|
||
|
|
var processor = new XSLTProcessor();
|
||
|
|
// stylesheet must be imported before parameters can be added
|
||
|
|
processor.importStylesheet( request.xsl.doc );
|
||
|
|
// add parameters to the processor
|
||
|
|
if( request.options.params && processor ){
|
||
|
|
$.log( 'transform(): received xsl params: ' + request.options.params.toString() );
|
||
|
|
for( key in request.options.params ){
|
||
|
|
// name and value must be strings; first parameter is namespace
|
||
|
|
var p = request.options.params[key] ? request.options.params[key].toString() : request.options.params[key];
|
||
|
|
try{
|
||
|
|
processor.setParameter( null, key.toString(), p );
|
||
|
|
}catch(e){
|
||
|
|
$.log('Unable to set parameter "' + key + '"');
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
$.log( 'set parameter "' + key.toString() + '" to "' + p + '"' );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// perform the transformation
|
||
|
|
try{
|
||
|
|
request.result.doc = processor.transformToDocument( request.xml.doc );
|
||
|
|
// handle transform error
|
||
|
|
request.result.error = Sarissa.getParseErrorText( request.result.doc );
|
||
|
|
if( request.result.error != Sarissa.PARSED_OK ){
|
||
|
|
// throw the error text
|
||
|
|
request.result.error = 'transform(): error in transformation: ' + request.result.error + ' :: using xsl: ' + err('xsl') + ' => xml: ' + err('xml');
|
||
|
|
$.log(request.result.error);
|
||
|
|
}
|
||
|
|
}catch(e){
|
||
|
|
request.result.error = 'Unable to perform transformation :: using xsl: ' + err('xsl') + ' => xml: ' + err('xml');
|
||
|
|
$.log(request.result.error);
|
||
|
|
throw(request.result.error);
|
||
|
|
return request.result;
|
||
|
|
}
|
||
|
|
|
||
|
|
// if we made it this far, the transformation was successful
|
||
|
|
request.result.string = this.serialize( request.result.doc );
|
||
|
|
// store reference to all scripts found in the doc (not result.string)
|
||
|
|
request.result.scripts = jQuery('script',request.result.doc).text();
|
||
|
|
|
||
|
|
return request.result;
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
// initialize the $.xsl object
|
||
|
|
$.xsl.init();
|
||
|
|
|
||
|
|
})(jQuery);
|