Sarissa is a utility class. Provides "static" methods for DOMDocument, - * DOM Node serialization to XML strings and other utility goodies.
- * @constructor - * @static - */ -function Sarissa(){} -Sarissa.VERSION = "0.9.9.3"; -Sarissa.PARSED_OK = "Document contains no parsing errors"; -Sarissa.PARSED_EMPTY = "Document is empty"; -Sarissa.PARSED_UNKNOWN_ERROR = "Not well-formed or other error"; -Sarissa.IS_ENABLED_TRANSFORM_NODE = false; -Sarissa.REMOTE_CALL_FLAG = "gr.abiss.sarissa.REMOTE_CALL_FLAG"; -/** @private */ -Sarissa._sarissa_iNsCounter = 0; -/** @private */ -Sarissa._SARISSA_IEPREFIX4XSLPARAM = ""; -/** @private */ -Sarissa._SARISSA_HAS_DOM_IMPLEMENTATION = document.implementation && true; -/** @private */ -Sarissa._SARISSA_HAS_DOM_CREATE_DOCUMENT = Sarissa._SARISSA_HAS_DOM_IMPLEMENTATION && document.implementation.createDocument; -/** @private */ -Sarissa._SARISSA_HAS_DOM_FEATURE = Sarissa._SARISSA_HAS_DOM_IMPLEMENTATION && document.implementation.hasFeature; -/** @private */ -Sarissa._SARISSA_IS_MOZ = Sarissa._SARISSA_HAS_DOM_CREATE_DOCUMENT && Sarissa._SARISSA_HAS_DOM_FEATURE; -/** @private */ -Sarissa._SARISSA_IS_SAFARI = navigator.userAgent.toLowerCase().indexOf("safari") != -1 || navigator.userAgent.toLowerCase().indexOf("konqueror") != -1; -/** @private */ -Sarissa._SARISSA_IS_SAFARI_OLD = Sarissa._SARISSA_IS_SAFARI && (parseInt((navigator.userAgent.match(/AppleWebKit\/(\d+)/)||{})[1], 10) < 420); -/** @private */ -Sarissa._SARISSA_IS_IE = document.all && window.ActiveXObject && navigator.userAgent.toLowerCase().indexOf("msie") > -1 && navigator.userAgent.toLowerCase().indexOf("opera") == -1; -/** @private */ -Sarissa._SARISSA_IS_OPERA = navigator.userAgent.toLowerCase().indexOf("opera") != -1; -if(!window.Node || !Node.ELEMENT_NODE){ - Node = {ELEMENT_NODE: 1, ATTRIBUTE_NODE: 2, TEXT_NODE: 3, CDATA_SECTION_NODE: 4, ENTITY_REFERENCE_NODE: 5, ENTITY_NODE: 6, PROCESSING_INSTRUCTION_NODE: 7, COMMENT_NODE: 8, DOCUMENT_NODE: 9, DOCUMENT_TYPE_NODE: 10, DOCUMENT_FRAGMENT_NODE: 11, NOTATION_NODE: 12}; -} - -//This breaks for(x in o) loops in the old Safari -if(Sarissa._SARISSA_IS_SAFARI_OLD){ - HTMLHtmlElement = document.createElement("html").constructor; - Node = HTMLElement = {}; - HTMLElement.prototype = HTMLHtmlElement.__proto__.__proto__; - HTMLDocument = Document = document.constructor; - var x = new DOMParser(); - XMLDocument = x.constructor; - Element = x.parseFromString("Ensures the document was loaded correctly, otherwise sets the - * parseError to -1 to indicate something went wrong. Internal use
- * @private - */ - Sarissa.__handleLoad__ = function(oDoc){ - Sarissa.__setReadyState__(oDoc, 4); - }; - /** - *Attached by an event handler to the load event. Internal use.
- * @private - */ - _sarissa_XMLDocument_onload = function(){ - Sarissa.__handleLoad__(this); - }; - /** - *Sets the readyState property of the given DOM Document object. - * Internal use.
- * @memberOf Sarissa - * @private - * @argument oDoc the DOM Document object to fire the - * readystatechange event - * @argument iReadyState the number to change the readystate property to - */ - Sarissa.__setReadyState__ = function(oDoc, iReadyState){ - oDoc.readyState = iReadyState; - oDoc.readystate = iReadyState; - if (oDoc.onreadystatechange != null && typeof oDoc.onreadystatechange == "function") { - oDoc.onreadystatechange(); - } - }; - - Sarissa.getDomDocument = function(sUri, sName){ - var oDoc = document.implementation.createDocument(sUri?sUri:null, sName?sName:null, null); - if(!oDoc.onreadystatechange){ - - /** - *Emulate IE's onreadystatechange attribute
- */ - oDoc.onreadystatechange = null; - } - if(!oDoc.readyState){ - /** - *Emulates IE's readyState property, which always gives an integer from 0 to 4:
- *Factory method to obtain a new DOM Document object
- * @memberOf Sarissa - * @argument sUri the namespace of the root node (if any) - * @argument sUri the local name of the root node (if any) - * @returns a new DOM Document - */ - Sarissa.getDomDocument = function(sUri, sName){ - var oDoc = document.implementation.createDocument(sUri?sUri:null, sName?sName:null, null); - return oDoc; - }; - } - else { - Sarissa.getDomDocument = function(sUri, sName){ - var oDoc = document.implementation.createDocument(sUri?sUri:null, sName?sName:null, null); - // looks like safari does not create the root element for some unknown reason - if(oDoc && (sUri || sName) && !oDoc.documentElement){ - oDoc.appendChild(oDoc.createElementNS(sUri, sName)); - } - return oDoc; - }; - } - }//if(Sarissa._SARISSA_HAS_DOM_CREATE_DOCUMENT) -} -//========================================== -// Common stuff -//========================================== -if(!window.DOMParser){ - if(Sarissa._SARISSA_IS_SAFARI){ - /* - * DOMParser is a utility class, used to construct DOMDocuments from XML strings - * @constructor - */ - DOMParser = function() { }; - /** - * Construct a new DOM Document from the given XMLstring - * @param sXml the given XML string - * @param contentType the content type of the document the given string represents (one of text/xml, application/xml, application/xhtml+xml). - * @return a new DOM Document from the given XML string - */ - DOMParser.prototype.parseFromString = function(sXml, contentType){ - var xmlhttp = new XMLHttpRequest(); - xmlhttp.open("GET", "data:text/xml;charset=utf-8," + encodeURIComponent(sXml), false); - xmlhttp.send(null); - return xmlhttp.responseXML; - }; - }else if(Sarissa.getDomDocument && Sarissa.getDomDocument() && Sarissa.getDomDocument(null, "bar").xml){ - DOMParser = function() { }; - DOMParser.prototype.parseFromString = function(sXml, contentType){ - var doc = Sarissa.getDomDocument(); - doc.loadXML(sXml); - return doc; - }; - } -} - -if((typeof(document.importNode) == "undefined") && Sarissa._SARISSA_IS_IE){ - try{ - /** - * Implementation of importNode for the context window document in IE. - * IfoNode is a TextNode, bChildren is ignored.
- * @param oNode the Node to import
- * @param bChildren whether to include the children of oNode
- * @returns the imported node for further use
- */
- document.importNode = function(oNode, bChildren){
- var tmp;
- if (oNode.nodeName=='#text') {
- return document.createTextNode(oNode.data);
- }
- else {
- if(oNode.nodeName == "tbody" || oNode.nodeName == "tr"){
- tmp = document.createElement("table");
- }
- else if(oNode.nodeName == "td"){
- tmp = document.createElement("tr");
- }
- else if(oNode.nodeName == "option"){
- tmp = document.createElement("select");
- }
- else{
- tmp = document.createElement("div");
- }
- if(bChildren){
- tmp.innerHTML = oNode.xml ? oNode.xml : oNode.outerHTML;
- }else{
- tmp.innerHTML = oNode.xml ? oNode.cloneNode(false).xml : oNode.cloneNode(false).outerHTML;
- }
- return tmp.getElementsByTagName("*")[0];
- }
- };
- }catch(e){ }
-}
-if(!Sarissa.getParseErrorText){
- /**
- * Returns a human readable description of the parsing error. Usefull - * for debugging. Tip: append the returned error string in a <pre> - * element if you want to render it.
- *Many thanks to Christian Stocker for the initial patch.
- * @memberOf Sarissa - * @argument oDoc The target DOM document - * @returns The parsing error description of the target Document in - * human readable form (preformated text) - */ - Sarissa.getParseErrorText = function (oDoc){ - var parseErrorText = Sarissa.PARSED_OK; - if(!oDoc.documentElement){ - parseErrorText = Sarissa.PARSED_EMPTY; - } else if(oDoc.documentElement.tagName == "parsererror"){ - parseErrorText = oDoc.documentElement.firstChild.data; - parseErrorText += "\n" + oDoc.documentElement.firstChild.nextSibling.firstChild.data; - } else if(oDoc.getElementsByTagName("parsererror").length > 0){ - var parsererror = oDoc.getElementsByTagName("parsererror")[0]; - parseErrorText = Sarissa.getText(parsererror, true)+"\n"; - } else if(oDoc.parseError && oDoc.parseError.errorCode != 0){ - parseErrorText = Sarissa.PARSED_UNKNOWN_ERROR; - } - return parseErrorText; - }; -} -/** - * Get a string with the concatenated values of all string nodes under the given node - * @memberOf Sarissa - * @argument oNode the given DOM node - * @argument deep whether to recursively scan the children nodes of the given node for text as well. Default isfalse
- */
-Sarissa.getText = function(oNode, deep){
- var s = "";
- var nodes = oNode.childNodes;
- for(var i=0; i < nodes.length; i++){
- var node = nodes[i];
- var nodeType = node.nodeType;
- if(nodeType == Node.TEXT_NODE || nodeType == Node.CDATA_SECTION_NODE){
- s += node.data;
- } else if(deep === true && (nodeType == Node.ELEMENT_NODE || nodeType == Node.DOCUMENT_NODE || nodeType == Node.DOCUMENT_FRAGMENT_NODE)){
- s += Sarissa.getText(node, true);
- }
- }
- return s;
-};
-if(!window.XMLSerializer && Sarissa.getDomDocument && Sarissa.getDomDocument("","foo", null).xml){
- /**
- * Utility class to serialize DOM Node objects to XML strings
- * @constructor
- */
- XMLSerializer = function(){};
- /**
- * Serialize the given DOM Node to an XML string
- * @param oNode the DOM Node to serialize
- */
- XMLSerializer.prototype.serializeToString = function(oNode) {
- return oNode.xml;
- };
-}
-
-/**
- * Strips tags from the given markup string. If the given string is
- * undefined, null or empty, it is returned as is.
- * @memberOf Sarissa
- */
-Sarissa.stripTags = function (s) {
- return s?s.replace(/<[^>]+>/g,""):s;
-};
-/**
- * Deletes all child nodes of the given node
- * @memberOf Sarissa - * @argument oNode the Node to empty - */ -Sarissa.clearChildNodes = function(oNode) { - // need to check for firstChild due to opera 8 bug with hasChildNodes - while(oNode.firstChild) { - oNode.removeChild(oNode.firstChild); - } -}; -/** - *Copies the childNodes of nodeFrom to nodeTo
- *Note: The second object's original content is deleted before - * the copy operation, unless you supply a true third parameter
- * @memberOf Sarissa - * @argument nodeFrom the Node to copy the childNodes from - * @argument nodeTo the Node to copy the childNodes to - * @argument bPreserveExisting whether to preserve the original content of nodeTo, default is false - */ -Sarissa.copyChildNodes = function(nodeFrom, nodeTo, bPreserveExisting) { - if(Sarissa._SARISSA_IS_SAFARI && nodeTo.nodeType == Node.DOCUMENT_NODE){ // SAFARI_OLD ?? - nodeTo = nodeTo.documentElement; //Apparently there's a bug in safari where you can't appendChild to a document node - } - - if((!nodeFrom) || (!nodeTo)){ - throw "Both source and destination nodes must be provided"; - } - if(!bPreserveExisting){ - Sarissa.clearChildNodes(nodeTo); - } - var ownerDoc = nodeTo.nodeType == Node.DOCUMENT_NODE ? nodeTo : nodeTo.ownerDocument; - var nodes = nodeFrom.childNodes; - var i; - if(typeof(ownerDoc.importNode) != "undefined") { - for(i=0;i < nodes.length;i++) { - nodeTo.appendChild(ownerDoc.importNode(nodes[i], true)); - } - } else { - for(i=0;i < nodes.length;i++) { - nodeTo.appendChild(nodes[i].cloneNode(true)); - } - } -}; - -/** - *Moves the childNodes of nodeFrom to nodeTo
- *Note: The second object's original content is deleted before - * the move operation, unless you supply a true third parameter
- * @memberOf Sarissa - * @argument nodeFrom the Node to copy the childNodes from - * @argument nodeTo the Node to copy the childNodes to - * @argument bPreserveExisting whether to preserve the original content of nodeTo, default is - */ -Sarissa.moveChildNodes = function(nodeFrom, nodeTo, bPreserveExisting) { - if((!nodeFrom) || (!nodeTo)){ - throw "Both source and destination nodes must be provided"; - } - if(!bPreserveExisting){ - Sarissa.clearChildNodes(nodeTo); - } - var nodes = nodeFrom.childNodes; - // if within the same doc, just move, else copy and delete - if(nodeFrom.ownerDocument == nodeTo.ownerDocument){ - while(nodeFrom.firstChild){ - nodeTo.appendChild(nodeFrom.firstChild); - } - } else { - var ownerDoc = nodeTo.nodeType == Node.DOCUMENT_NODE ? nodeTo : nodeTo.ownerDocument; - var i; - if(typeof(ownerDoc.importNode) != "undefined") { - for(i=0;i < nodes.length;i++) { - nodeTo.appendChild(ownerDoc.importNode(nodes[i], true)); - } - }else{ - for(i=0;i < nodes.length;i++) { - nodeTo.appendChild(nodes[i].cloneNode(true)); - } - } - Sarissa.clearChildNodes(nodeFrom); - } -}; - -/** - *Serialize any non DOM object to an XML string. All properties are serialized using the property name
- * as the XML element name. Array elements are rendered as array-item elements,
- * using their index/key as the value of the key attribute.
functionName(oNode, oTargetElement);
- * @memberOf Sarissa
- * @param sFromUrl the URL to make the request to
- * @param oTargetElement the element to update
- * @param xsltproc (optional) the transformer to use on the returned
- * content before updating the target element with it
- * @param callback (optional) a Function object to execute once the update is finished successfuly, called as callback(sFromUrl, oTargetElement).
- * In case an exception is thrown during execution, the callback is called as called as callback(sFromUrl, oTargetElement, oException)
- * @param skipCache (optional) whether to skip any cache
- */
-Sarissa.updateContentFromURI = function(sFromUrl, oTargetElement, xsltproc, callback, skipCache) {
- try{
- Sarissa.updateCursor(oTargetElement, "wait");
- var xmlhttp = new XMLHttpRequest();
- xmlhttp.open("GET", sFromUrl, true);
- xmlhttp.onreadystatechange = function() {
- if (xmlhttp.readyState == 4) {
- try{
- var oDomDoc = xmlhttp.responseXML;
- if(oDomDoc && Sarissa.getParseErrorText(oDomDoc) == Sarissa.PARSED_OK){
- Sarissa.updateContentFromNode(xmlhttp.responseXML, oTargetElement, xsltproc);
- callback(sFromUrl, oTargetElement);
- }
- else{
- throw Sarissa.getParseErrorText(oDomDoc);
- }
- }
- catch(e){
- if(callback){
- callback(sFromUrl, oTargetElement, e);
- }
- else{
- throw e;
- }
- }
- }
- };
- if (skipCache) {
- var oldage = "Sat, 1 Jan 2000 00:00:00 GMT";
- xmlhttp.setRequestHeader("If-Modified-Since", oldage);
- }
- xmlhttp.send("");
- }
- catch(e){
- Sarissa.updateCursor(oTargetElement, "auto");
- if(callback){
- callback(sFromUrl, oTargetElement, e);
- }
- else{
- throw e;
- }
- }
-};
-
-/**
- * Update an element's content with the given DOM node. Passing a configured XSLT
- * processor will result in transforming and updating oNode before using it to update oTargetElement.
- * You can also pass a callback function to be executed when the update is finished. The function will be called as
- * functionName(oNode, oTargetElement);
- * @memberOf Sarissa
- * @param oNode the URL to make the request to
- * @param oTargetElement the element to update
- * @param xsltproc (optional) the transformer to use on the given
- * DOM node before updating the target element with it
- */
-Sarissa.updateContentFromNode = function(oNode, oTargetElement, xsltproc) {
- try {
- Sarissa.updateCursor(oTargetElement, "wait");
- Sarissa.clearChildNodes(oTargetElement);
- // check for parsing errors
- var ownerDoc = oNode.nodeType == Node.DOCUMENT_NODE?oNode:oNode.ownerDocument;
- if(ownerDoc.parseError && ownerDoc.parseError.errorCode != 0) {
- var pre = document.createElement("pre");
- pre.appendChild(document.createTextNode(Sarissa.getParseErrorText(ownerDoc)));
- oTargetElement.appendChild(pre);
- }
- else {
- // transform if appropriate
- if(xsltproc) {
- oNode = xsltproc.transformToDocument(oNode);
- }
- // be smart, maybe the user wants to display the source instead
- if(oTargetElement.tagName.toLowerCase() == "textarea" || oTargetElement.tagName.toLowerCase() == "input") {
- oTargetElement.value = new XMLSerializer().serializeToString(oNode);
- }
- else {
- // ok that was not smart; it was paranoid. Keep up the good work by trying to use DOM instead of innerHTML
- if(oNode.nodeType == Node.DOCUMENT_NODE || oNode.ownerDocument.documentElement == oNode) {
- oTargetElement.innerHTML = new XMLSerializer().serializeToString(oNode);
- }
- else{
- oTargetElement.appendChild(oTargetElement.ownerDocument.importNode(oNode, true));
- }
- }
- }
- }
- catch(e) {
- throw e;
- }
- finally{
- Sarissa.updateCursor(oTargetElement, "auto");
- }
-};
-
-
-/**
- * Creates an HTTP URL query string from the given HTML form data
- * @memberOf Sarissa
- */
-Sarissa.formToQueryString = function(oForm){
- var qs = "";
- for(var i = 0;i < oForm.elements.length;i++) {
- var oField = oForm.elements[i];
- var sFieldName = oField.getAttribute("name") ? oField.getAttribute("name") : oField.getAttribute("id");
- // ensure we got a proper name/id and that the field is not disabled
- if(sFieldName &&
- ((!oField.disabled) || oField.type == "hidden")) {
- switch(oField.type) {
- case "hidden":
- case "text":
- case "textarea":
- case "password":
- qs += sFieldName + "=" + encodeURIComponent(oField.value) + "&";
- break;
- case "select-one":
- qs += sFieldName + "=" + encodeURIComponent(oField.options[oField.selectedIndex].value) + "&";
- break;
- case "select-multiple":
- for (var j = 0; j < oField.length; j++) {
- var optElem = oField.options[j];
- if (optElem.selected === true) {
- qs += sFieldName + "[]" + "=" + encodeURIComponent(optElem.value) + "&";
- }
- }
- break;
- case "checkbox":
- case "radio":
- if(oField.checked) {
- qs += sFieldName + "=" + encodeURIComponent(oField.value) + "&";
- }
- break;
- }
- }
- }
- // return after removing last '&'
- return qs.substr(0, qs.length - 1);
-};
-
-
-/**
- * Asynchronously update an element with response of an XMLHttpRequest-based emulation of a form submission. The form action and
- * method attributess will be followed. Passing a configured XSLT processor will result in
- * transforming and updating the server response before using it to update the target element.
- * You can also pass a callback function to be executed when the update is finished. The function will be called as
- * functionName(oNode, oTargetElement);
Here is an example of using this in a form element:
- *
- * <div id="targetId"> this content will be updated</div>
- * <form action="/my/form/handler" method="post"
- * onbeforesubmit="return Sarissa.updateContentFromForm(this, document.getElementById('targetId'));">
- * If JavaScript is supported, the form will not be submitted. Instead, Sarissa will
- * scan the form and make an appropriate AJAX request, also adding a parameter
- * to signal to the server that this is an AJAX call. The parameter is
- * constructed as Sarissa.REMOTE_CALL_FLAG = "=true" so you can change the name in your webpage
- * simply by assigning another value to Sarissa.REMOTE_CALL_FLAG. If JavaScript is not supported
- * the form will be submitted normally.
- * @memberOf Sarissa
- * @param oForm the form submition to emulate
- * @param oTargetElement the element to update
- * @param xsltproc (optional) the transformer to use on the returned
- * content before updating the target element with it
- * @param callback (optional) a Function object to execute once the update is finished successfuly, called as callback(oNode, oTargetElement).
- * In case an exception occurs during excecution and a callback function was provided, the exception is cought and the callback is called as
- * callback(oForm, oTargetElement, exception)
- */
-Sarissa.updateContentFromForm = function(oForm, oTargetElement, xsltproc, callback) {
- try{
- Sarissa.updateCursor(oTargetElement, "wait");
- // build parameters from form fields
- var params = Sarissa.formToQueryString(oForm) + "&" + Sarissa.REMOTE_CALL_FLAG + "=true";
- var xmlhttp = new XMLHttpRequest();
- var bUseGet = oForm.getAttribute("method") && oForm.getAttribute("method").toLowerCase() == "get";
- if(bUseGet) {
- xmlhttp.open("GET", oForm.getAttribute("action")+"?"+params, true);
- }
- else{
- xmlhttp.open('POST', oForm.getAttribute("action"), true);
- xmlhttp.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
- xmlhttp.setRequestHeader("Content-length", params.length);
- xmlhttp.setRequestHeader("Connection", "close");
- }
- xmlhttp.onreadystatechange = function() {
- try{
- if (xmlhttp.readyState == 4) {
- var oDomDoc = xmlhttp.responseXML;
- if(oDomDoc && Sarissa.getParseErrorText(oDomDoc) == Sarissa.PARSED_OK){
- Sarissa.updateContentFromNode(xmlhttp.responseXML, oTargetElement, xsltproc);
- callback(oForm, oTargetElement);
- }
- else{
- throw Sarissa.getParseErrorText(oDomDoc);
- }
- }
- }
- catch(e){
- if(callback){
- callback(oForm, oTargetElement, e);
- }
- else{
- throw e;
- }
- }
- };
- xmlhttp.send(bUseGet?"":params);
- }
- catch(e){
- Sarissa.updateCursor(oTargetElement, "auto");
- if(callback){
- callback(oForm, oTargetElement, e);
- }
- else{
- throw e;
- }
- }
- return false;
-};
-
-// EOF