* Formato dos argumentos:
* {
* busyContainer: [objeto ou string] elemento onde a imagem ser?? exibida,
* busyImage: [string, opcional] nome da imagem
* }
*
*
* @private
* @param {object} objArgs Argumentos do objeto
* @return True se a imagem esta sendo exibida
* @type boolean
*/
RPC.Transport.isBusy = function(objArgs) {
// Obt??m o conteiner onde deve existir a imagem
var objContainer = objArgs.busyContainer;
if (typeof objContainer == 'string') {
objContainer = document.getElementById(objContainer);
}
if (!objContainer) {
return;
}
// Obtém o nome da imagem
var strImage = objArgs.busyImage;
if (typeof strImage != 'string') {
strImage = '';
}
strImage = strImage.split('/').pop();
if (!strImage.length) {
strImage = 'ajbusy.gif';
}
// Verifica se a imagem est?? sendo exibida
var objFC = objContainer.firstChild;
if (objFC) {
objFC = objFC.firstChild;
if (objFC) {
objFC = objFC.firstChild;
if (objFC && objFC.tagName && objFC.tagName.toUpperCase() == 'IMG') {
var strSrc = objFC.getAttribute('src');
if (typeof strSrc == 'string' && strSrc.length) {
// Obtém a ultima parte da string
strSrc = strSrc.split('/').pop();
if (strSrc == strImage) {
return true;
}
}
}
}
}
return false;
};
/**
* Retorna o caminho para o arquivo js especificado. Navega por todos os elemtos
* script carregados, iniciando do final. Acha o arquivo js especificado
* no atributo src do elemento script. Separa o atributo src e retorna o caminho
* sem o nome do arquivo js.
*
* @param {string} strScriptFileName Nome do arquivo Js, ex. 'RPCUtil.js'
* @return Caminho para o script, ex. '../src/' ou '' se o caminho n??o for encontrado
* @type string
*/
RPC.Transport.getPath = function(strScriptFileName) {
// Obt??m todos os elementos script
var arrScripts = document.getElementsByTagName('script');
// Encontra o script na lista obtida
for (var iScript = arrScripts.length - 1; iScript >= 0; iScript--) {
var strSrc = arrScripts[iScript].getAttribute('src') || '';
var arrTokens = strSrc.split('/');
// Remove a ultima parte
var strLastToken = arrTokens.pop();
if (strLastToken == strScriptFileName) {
return arrTokens.join('/') + '/';
}
}
// N??o encontrado
return '';
};
/**
* Exibe a imagem de loading em um div especificado.
*
*
* Formato dos argumentos:
* {
* busyContainer: [objeto or string] elemento onde será colocada a imagem,
* busyImage: [string, opcional] nome da imagem,
* busyImageWidth: [número or string, opcional] largura da imagem,
* busyImageHeight: [número or string, opcional] altura da imagem
* }
*
*
* @private
* @param {object} objArgs Argumentos
*/
RPC.Transport.showBusy = function(objArgs) {
// Tendo certeza que a imagem não esta sendo exibida
if (RPC.Transport.isBusy(objArgs)) {
return;
}
// Obtem o recipiente
var objContainer = objArgs.busyContainer;
if (typeof objContainer == 'string') {
objContainer = document.getElementById(objContainer);
}
if (!objContainer) {
return;
}
// Obtem o nome da imagem e suas dimensões
var strImage = objArgs.busyImage;
var strImageWidth = objArgs.busyImageWidth;
var strImageHeight = objArgs.busyImageHeight;
if (typeof strImage != 'string' || !strImage.length) {
strImage = 'ajbusy.gif';
} else {
if (typeof strImageWidth == 'number' ||
(typeof strImageWidth == 'string' && /\d$/.test(strImageWidth))) {
strImageWidth += 'px';
}
if (typeof strImageHeight == 'number' ||
(typeof strImageHeight == 'string' && /\d$/.test(strImageHeight))) {
strImageHeight += 'px';
}
}
if (!strImageWidth) {
strImageWidth = '65px';
}
if (!strImageHeight) {
strImageHeight = '35px';
}
// Obtem o caminho
var strPath = '';
// Verifica se o caminho foi especificado
if (strImage.indexOf('/') < 0) {
// Utiliza o caminho padrão
strPath = RPC.Transport.getPath('RPC_T.js');
}
// Cria a tag IMG
var arrImgTag = [];
arrImgTag.push('
* Formato dos argumentos:
* {
* busyContainer: [objeto or string] elemento onde a imagem se encontra,
* busyImage: [string, opcional] nome da imagem
* }
*
*
* @private
* @param {object} objArgs Argumentos
*/
RPC.Transport.removeBusy = function(objArgs) {
// Obtem o recipiente
var objContainer = objArgs.busyContainer;
if (typeof objContainer == 'string') {
objContainer = document.getElementById(objContainer);
}
if (!objContainer) {
return;
}
// Tem certeza que a imagem esta sendo exibida
if (RPC.Transport.isBusy(objArgs)) {
// Remove a imagem
objContainer.removeChild(objContainer.firstChild);
}
};
/**
* Busca uma URL espec??fica utilizando um objeto XMLHttpRequeste novo.
*
*
* Modo asincrono ?? recomendado pois ?? mais seguro e n??o apresenta risco de ter
* o script parado por problemas de internet. Modos sincronos significa que o
* c??digo ir?? ficar parado enquanto n??o obtiver resposta.
*
* Quando uma requisi????o ?? completa, uma das fun????es retorno s??o chamadas:
* onLoad quando obteve sucesso ou onError quando obteve erro. Em modo sincrono
* a fun????o onLoad pode ser omitida. Ao inv??s utilize o objeto retornado.
*
* A fun????o de retorno onLoad recebe o objeto XMLHttpRequest como argumento e
* pode utilizar suas v??rias propriedade como por exemplo responseText, responseXML, etc.
*
* A fun????o de retorno onError recebe o seguinte objeto:
* {
* errorCode: numero do status do servidor (404, etc.) [number],
* errorDescription: descri????o do erro [string]
* }
*
* Nota: Alguns browsers implementam cache para requisi????es GET. O cacheamento ??
* previnido adicionando 'r=' + Math.random() como par??metro para a URL.
*
* Se voc?? utiliza o m??todo POST, o argumento de cont??do deve ser algo assim
* 'var1=value1&var2=value2' com os valorer utilizando urlencode. Se voc?? deseja
* enviar outro conte??do, utilize o contentType apropriado. Ex. 'multipart/form-data',
* 'text/xml', * etc.
*
* Se a resposta do servidor contiver caracteres n??o ASCII, o servidor deve enviar
* o cabe??alho content-type correspondente. Ex.
* "Content-type: text/plain; charset=utf-8" ou
* "Content-type: text/plain; charset=windows-1251".
*
* Formato do argumento:
* {
* url: [string] URL relativa ou absoluta que ser?? inquisitada,
* method: [string, optional] m??todo ('GET', 'POST', 'HEAD', 'PUT'),
* async: [boolean, optional] use modo asincrono (default: true),
* contentType: [string, optional] content type when using POST,
* content: [string or object, optional] string postavel ou dados de objeto DOM
* quando usa POST,
* onLoad: [function, optional] fun????o chamada quando se obteve sucesso,
* onError: [function, optional] fun????o chamada quando se obteve erro,
* username: [string, optional] username,
* password: [string, optional] password,
* busyContainer: [object or string, optional] elemento ou id do elemento onde
* ser?? colocada a imagem de Loading,
* busyImage: [string, optional] nome da imagem,
* busyImageWidth: [number or string, optional] largura da imagem,
* busyImageHeight: [number or string, optional] altura da imagem
* }
*
*
* @param {object} objArgs Argumentos
* @return No modo sincrono objeto XMLHttpRequest ou null. No modo assincrono
* sempre null.
* @type object
*/
RPC.Transport.fetch = function(objArgs) {
// Check arguments
if (objArgs == null || typeof objArgs != 'object') {
return null;
}
if (!objArgs.url) {
return null;
}
if (!objArgs.method) {
objArgs.method = 'GET';
}
if (typeof objArgs.async == 'undefined') {
objArgs.async = true;
}
if (!objArgs.contentType && objArgs.method.toUpperCase() == 'POST') {
objArgs.contentType = 'application/x-www-form-urlencoded';
}
if (!objArgs.content) {
objArgs.content = null;
}
if (!objArgs.onLoad) {
objArgs.onLoad = null;
}
if (!objArgs.onError) {
objArgs.onError = null;
}
// Request URL
var objRequest = RPC.Transport.createXmlHttpRequest();
if (objRequest == null) {
return null;
}
// Show "Busy" animated GIF
RPC.Transport.showBusy(objArgs);
// IE 6 calls onreadystatechange and then raises an exception if local file is
// not found. This flag is used to prevent duplicate onError calls.
var boolErrorDisplayed = false;
try {
// Open request
if (typeof objArgs.username != 'undefined' &&
typeof objArgs.password != 'undefined') {
objRequest.open(objArgs.method, objArgs.url, objArgs.async,
objArgs.username, objArgs.password);
} else {
objRequest.open(objArgs.method, objArgs.url, objArgs.async);
}
// Onready handler
var funcOnReady = function () {
// Remove "Busy" animated GIF
RPC.Transport.removeBusy(objArgs);
// Process response
if (objRequest.status == 200 || objRequest.status == 304 ||
(location.protocol == 'file:' && !objRequest.status)) {
// OK or found, but determined unchanged and loaded from cache
if (typeof objArgs.onLoad == 'function') {
objArgs.onLoad(objRequest);
}
} else if (!boolErrorDisplayed) {
boolErrorDisplayed = true;
// 404 Not found, etc.
RPC.Transport.displayError(objRequest.status,
'Error: Cannot fetch ' + objArgs.url + '.\n' +
(objRequest.statusText || ''),
objArgs.onError);
}
};
// Prevent duplicate funcOnReady call in synchronous mode
if (objArgs.async) {
// Set onreadystatechange handler
objRequest.onreadystatechange = function () {
if (objRequest.readyState == 4) {
// Request complete
funcOnReady();
// Prevent memory leak
objRequest.onreadystatechange = {};
}
};
}
// Set content type if needed
if (objArgs.contentType) {
objRequest.setRequestHeader('Content-Type', objArgs.contentType);
}
// Send request
objRequest.send(objArgs.content);
// In synchronous mode the result is ready on the next line
if (!objArgs.async) {
funcOnReady();
return objRequest;
}
} catch (objException) {
// Remove "Busy" animated GIF
RPC.Transport.removeBusy(objArgs);
// Process error
if (!boolErrorDisplayed) {
boolErrorDisplayed = true;
if (objException.name &&
objException.name == 'NS_ERROR_FILE_NOT_FOUND') {
RPC.Transport.displayError(0,
'Error: Cannot fetch ' + objArgs.url + '.\nFile not found.',
objArgs.onError);
} else {
RPC.Transport.displayError(0,
'Error: Cannot fetch ' + objArgs.url + '.\n' +
(objException.message || ''),
objArgs.onError);
}
}
};
return null;
};
/**
* Parses HTML fragment into HTMLElement object.
*
* @param {string} strHtml HTML fragment
* @return Div element which contains parsed HTML fragment
* @type object
*/
RPC.Transport.parseHtml = function(strHtml) {
// Convert to string
strHtml += '';
// Remove leading whitespace characters because Firefox and Opera don't parse
// fragment that starts from whitespace character
strHtml = strHtml.replace(/^\s+/g, '');
// Create temporaty container
var objTempContainer = null;
if (document.createElementNS) {
// use the XHTML namespace
objTempContainer =
document.createElementNS('http://www.w3.org/1999/xhtml', 'div');
} else {
objTempContainer = document.createElement('div');
}
// Parse HTML fragment
objTempContainer.innerHTML = strHtml;
// Return container element
return objTempContainer;
};
/**
* Evaluates javascript in global scope.
*
* * Note: Global variables must be declared without "var" keyword. Otherwise * they will be ignored by Safari. *
* * @param {string} strScript Script to evaluate */ RPC.Transport.evalGlobalScope = function(strScript) { if (typeof strScript != 'string' || !strScript.match(/\S/)) { return; } if (window.execScript) { // IE window.execScript(strScript, 'javascript'); } else if (window.eval) { // Others window.eval(strScript); /* This should never be reached } else { var funcScript = new Function(strScript); funcScript.call(window); */ } }; /** * Assigns passed HTML fragment to the specified element's innerHTML property * and evaluates in global scope javascripts found in the fragment. * *
* Arguments object format:
* {
* html: [string] HTML fragment,
* container: [object or string, optional] element or id of element to put
* HTML fragment into
* }
*
*
* * Note: Scripts are executed after HTML fragment is assigned to innerHTML. * If external scripts are used, they are loaded asynchronously and execution * sequence is not preserved. *
* ** Note: Global variables must be declared without "var" keyword. Otherwise * they will be ignored by Safari. *
* * @param {object} objArgs Arguments object */ RPC.Transport.setInnerHtml = function(objArgs) { // Check arguments if (!objArgs || typeof objArgs.html != 'string') { return; } var strHtml = objArgs.html; // Get container var objContainer = null; if (typeof objArgs.container == 'string') { objContainer = document.getElementById(objArgs.container); } else if (typeof objArgs.container == 'object') { objContainer = objArgs.container; } // Extract javascripts var arrScripts = []; if (strHtml.match(/<\s*\/\s*script\s*>/i)) { // Split whole string by var arrTokens = strHtml.split(/<\s*\/\s*script\s*>/i); var arrHtml = []; for (var iToken = arrTokens.length - 1; iToken >= 0; iToken--) { var strToken = arrTokens[iToken]; if (strToken.match(/\S/)) { // Search ' + strToken; } else { // If this is last token, assume it is HTML fragment arrHtml.unshift(strToken); } } else { // Empty token arrHtml.unshift(strToken); } } // Get HTML part strHtml = arrHtml.join(''); } // Set inner HTML if (objContainer) { // Opera hack objContainer.innerHTML = ''; objContainer.innerHTML = strHtml; } // Evaluate javascripts for (var iScript = 0; iScript < arrScripts.length; iScript++) { if (arrScripts[iScript][1].length) { // Evaluate in global scope RPC.Transport.evalGlobalScope(arrScripts[iScript][1]); } // Load external script var strAttrs = arrScripts[iScript][0]; strAttrs = strAttrs.replace(/\s+/g, ' ').replace(/^\s/, '') .replace(/\s$/, '').replace(/ = /g, '='); if (strAttrs.indexOf('src=') >= 0) { // Get container var objContainer = document.body; if (!objContainer) { objContainer = document.getElementsByTagName('head')[0]; if (!objContainer) { objContainer = document; } } // Get attributes var arrAttrs = strAttrs.split(' '); // Load script var objScript = RPC.Utils.createElement('script'); for (var iAttr = 0; iAttr < arrAttrs.length; iAttr++) { var arrAttr = arrAttrs[iAttr].split('='); if (arrAttr.length > 1) { objScript.setAttribute(arrAttr[0], arrAttr[1].match(/^[\s|"|']*([\s|\S]*[^'|"])[\s|"|']*$/)[1]); } else { objScript.setAttribute(arrAttr[0], arrAttr[0]); } } // It's important for Safari to assign attributes before appending objContainer.appendChild(objScript); } } }; /** * Fetches and parses XML document from the specified URL. * *
* When XML document is fetched and parsed, one of provided callback functions
* is called: onLoad on success or onError on error. In synchronous mode onLoad
* callback can be omitted. Instead use returned object.
*
* onLoad callback function receives XMLDocument object as argument and may use
* its documentElement and other properties.
*
* onError callback function receives following object:
* {
* errorCode: error code [number],
* errorDescription: human readable error description [string]
* }
* Error code will be 0 unless RPC.Transport.fetch was used to fetch URL
* and there was a problem during fetching.
*
* If method argument is not defined, more efficient XMLDOM in IE and
* document.implementation.createDocument in Mozilla will be used to fetch
* and parse document. Otherwise RPC.Transport.fetch will be used to fetch
* document and RPC.Transport.parseXml to parse.
*
* Note: Some browsers implement caching for GET requests. Caching can be
* prevented by adding 'r=' + Math.random() parameter to URL.
*
* If you use POST method, content argument should be something like
* 'var1=value1&var2=value'. If you wish to send other content, set appropriate
* contentType. E.g. to send XML string, you should set contentType: 'text/xml'.
*
* If server response contains non-ASCII characters, encoding must be specified.
* E.g. or
* .
*
* If server response contains non-ASCII characters, server must send
* corresponding content-type header. E.g.
* "Content-type: text/xml; charset=utf-8" or
* "Content-type: text/xml; charset=windows-1251".
*
* Arguments object format:
* {
* url: [string] relative or absolute URL to fetch,
* method: [string, optional] method ('GET', 'POST', 'HEAD', 'PUT'),
* async: [boolean, optional] use asynchronous mode (default: true),
* contentType: [string, optional] content type when using POST,
* content: [string or object, optional] postable string or DOM object data
* when using POST,
* onLoad: [function, optional] function reference to call on success,
* onError: [function, optional] function reference to call on error,
* username: [string, optional] username,
* password: [string, optional] password,
* busyContainer: [object or string, optional] element or id of element where
* to put "Busy" animated GIF,
* busyImage: [string, optional] image name,
* busyImageWidth: [number or string, optional] image width,
* busyImageHeight: [number or string, optional] image height
* }
*
*
* @param {object} objArgs Arguments object
* @return In synchronous mode XMLDocument object or null. In asynchronous mode
* always null.
* @type object
*/
RPC.Transport.fetchXmlDoc = function(objArgs) {
// Check arguments
if (objArgs == null || typeof objArgs != 'object') {
return null;
}
if (!objArgs.url) {
return null;
}
if (typeof objArgs.async == 'undefined') {
objArgs.async = true;
}
if (!objArgs.onLoad) {
objArgs.onLoad = null;
}
if (!objArgs.onError) {
objArgs.onError = null;
}
// Try more efficient methods first
if (!objArgs.method && typeof objArgs.username == 'undefined' &&
typeof objArgs.password == 'undefined') {
if (document.implementation && document.implementation.createDocument) {
// Mozilla
var objDocument = document.implementation.createDocument('', '', null);
// Opera 8.51 also has document.implementation, but hasn't implemented
// XMLDOM load method yet
if (objDocument.load) {
objDocument.async = objArgs.async;
// Prevent duplicate onXmlDocLoad call in synchronous mode
if (objArgs.async) {
objDocument.onload = function() {
// Remove "Busy" animated GIF
RPC.Transport.removeBusy(objArgs);
// Process response
RPC.Transport.onXmlDocLoad(objDocument, objArgs.onLoad,
objArgs.onError);
};
}
// Show "Busy" animated GIF
RPC.Transport.showBusy(objArgs);
// Load document
try {
objDocument.load(objArgs.url);
// In synchronous mode the result is ready on the next line
if (!objArgs.async) {
// Remove "Busy" animated GIF
RPC.Transport.removeBusy(objArgs);
// Process response
RPC.Transport.onXmlDocLoad(objDocument, objArgs.onLoad,
objArgs.onError);
return objDocument;
}
return null;
} catch (objException) {
// Remove "Busy" animated GIF
RPC.Transport.removeBusy(objArgs);
// Process error
if (objException.name &&
objException.name == 'NS_ERROR_FILE_NOT_FOUND') {
RPC.Transport.displayError(0,
'Error: Cannot fetch ' + objArgs.url + '.\nFile not found.',
objArgs.onError);
} else {
RPC.Transport.displayError(0,
'Error: Cannot fetch ' + objArgs.url + '.\n' +
objException.toString(),
objArgs.onError);
}
};
}
}
if (typeof ActiveXObject != 'undefined') {
// IE
// Show "Busy" animated GIF
RPC.Transport.showBusy(objArgs);
// Load document
try {
var objDocument = new ActiveXObject(RPC.Transport.XMLDOM);
objDocument.async = objArgs.async;
// Prevent duplicate onXmlDocLoad call in synchronous mode
if (objArgs.async) {
objDocument.onreadystatechange = function () {
if (objDocument.readyState == 4) {
// Remove "Busy" animated GIF
RPC.Transport.removeBusy(objArgs);
// Process response
RPC.Transport.onXmlDocLoad(objDocument, objArgs.onLoad,
objArgs.onError);
// Prevent memory leak
objDocument.onreadystatechange = {};
}
};
}
objDocument.load(objArgs.url);
// In synchronous mode the result is ready on the next line
if (!objArgs.async) {
// Remove "Busy" animated GIF
RPC.Transport.removeBusy(objArgs);
// Process response
RPC.Transport.onXmlDocLoad(objDocument, objArgs.onLoad,
objArgs.onError);
return objDocument;
}
return null;
} catch (objException) {
// Remove "Busy" animated GIF
RPC.Transport.removeBusy(objArgs);
};
}
}
// Try XMLHttpRequest
// Form argument for fetch
var objFetchArgs = {};
for (var strKey in objArgs) {
objFetchArgs[strKey] = objArgs[strKey];
}
// Prevent duplicate parseXml call in synchronous mode
if (objArgs.async) {
objFetchArgs.onLoad = function(objRequest) {
RPC.Transport.parseXml({
strXml: objRequest.responseText,
onLoad: objArgs.onLoad,
onError: objArgs.onError
});
};
} else {
objFetchArgs.onLoad = null;
}
// Fetch URL
var objRequest = RPC.Transport.fetch(objFetchArgs);
// In synchronous mode the result is ready on the next line
if (!objArgs.async && objRequest) {
return RPC.Transport.parseXml({
strXml: objRequest.responseText,
onLoad: objArgs.onLoad,
onError: objArgs.onError
});
}
return null;
};
/**
* Parses XML string into XMLDocument object.
*
*
* When XML string is parsed, one of provided callback functions is called:
* onLoad on success or onError on error. In synchronous mode onLoad callback
* can be omitted. Instead use returned object.
*
* onLoad callback function receives XMLDocument object as argument and may use
* its documentElement and other properties.
*
* onError callback function receives following object:
* {
* errorCode: error code [number],
* errorDescription: human readable error description [string]
* }
* Error code will be always 0.
*
* Returns XMLDocument object, so onLoad callback function is optional.
* Returned value and its documentElement property should be checked before
* use because they can be null or undefined.
*
* If XML string contains non-ASCII characters, encoding must be specified.
* E.g. or
* .
*
* Arguments object format:
* {
* strXml: XML string to parse [string],
* onLoad: function reference to call on success [function] (optional),
* onError: function reference to call on error [function] (optional)
* }
*
*
* @param {object} objArgs Arguments object
* @return XMLDocument object or null
* @type object
*/
RPC.Transport.parseXml = function(objArgs) {
if (objArgs == null || typeof objArgs != 'object') {
return null;
}
if (!objArgs.strXml) {
return null;
}
if (!objArgs.onLoad) {
objArgs.onLoad = null;
}
if (!objArgs.onError) {
objArgs.onError = null;
}
if (window.DOMParser) {
// Mozilla
try {
var objDocument = (new DOMParser()).parseFromString(objArgs.strXml,
'text/xml');
RPC.Transport.onXmlDocLoad(objDocument, objArgs.onLoad,
objArgs.onError);
return objDocument;
} catch (objException) {
RPC.Transport.displayError(0,
'Error: Cannot parse.\n' +
'String does not appear to be a valid XML fragment.',
objArgs.onError);
};
return null;
}
if (typeof ActiveXObject != 'undefined') {
// IE
try {
var objDocument = new ActiveXObject(RPC.Transport.XMLDOM);
objDocument.loadXML(objArgs.strXml);
RPC.Transport.onXmlDocLoad(objDocument, objArgs.onLoad,
objArgs.onError);
return objDocument;
} catch (objException) {};
}
return null;
};
/**
* Checks if there were errors during XML document fetching and parsing and
* calls onLoad or onError callback function correspondingly.
*
* @private
* @param {object} objDocument XMLDocument object
* @param {function} onLoad Callback function provided by user
* @param {function} onError Callback function provided by user
*/
RPC.Transport.onXmlDocLoad = function(objDocument, onLoad, onError) {
var strError = null;
if (objDocument.parseError) {
// Parsing error in IE
strError = objDocument.parseError.reason;
if (objDocument.parseError.srcText) {
strError += 'Location: ' + objDocument.parseError.url +
'\nLine number ' + objDocument.parseError.line + ', column ' +
objDocument.parseError.linepos + ':\n' +
objDocument.parseError.srcText + '\n';
}
} else if (objDocument.documentElement &&
objDocument.documentElement.tagName == 'parsererror') {
// If an error is caused while parsing, Mozilla doesn't throw an exception.
// Instead, it creates an XML string containing the details of the error:
//
* When JSON object is fetched and parsed, one of provided callback functions
* is called: onLoad on success or onError on error. In synchronous mode onLoad
* callback can be omitted. Instead use returned object.
*
* onLoad callback function receives JSON object as argument.
*
* onError callback function receives following object:
* {
* errorCode: error code [number],
* errorDescription: human readable error description [string]
* }
* Error code will be 0 unless there was a problem during fetching.
*
* Note: Some browsers implement caching for GET requests. Caching can be
* prevented by adding 'r=' + Math.random() parameter to URL.
*
* If you use POST method, content argument should be something like
* 'var1=value1&var2=value'. If you wish to send other content, set appropriate
* contentType. E.g. to send XML string, you should set contentType: 'text/xml'.
*
* If server response contains non-ASCII characters, server must send
* corresponding content-type header. E.g.
* "Content-type: text/plain; charset=utf-8" or
* "Content-type: text/plain; charset=windows-1251".
*
* Arguments object format:
* {
* url: [string] relative or absolute URL to fetch,
* reliable: [boolean, optional] false (string will be parsed) or true
* (evaluated) (default: false),
* method: [string, optional] method ('GET', 'POST', 'HEAD', 'PUT'),
* async: [boolean, optional] use asynchronous mode (default: true),
* contentType: [string, optional] content type when using POST,
* content: [string or object, optional] postable string or DOM object data
* when using POST,
* onLoad: [function, optional] function reference to call on success,
* onError: [function, optional] function reference to call on error,
* username: [string, optional] username,
* password: [string, optional] password,
* busyContainer: [object or string, optional] element or id of element where
* to put "Busy" animated GIF,
* busyImage: [string, optional] image name,
* busyImageWidth: [number or string, optional] image width,
* busyImageHeight: [number or string, optional] image height
* }
*
*
* @param {object} objArgs Arguments object
* @return In synchronous mode JSON object or null. In asynchronous mode always
* null.
* @type object
*/
RPC.Transport.fetchJsonObj = function(objArgs) {
// Check arguments
if (objArgs == null || typeof objArgs != 'object') {
return null;
}
if (!objArgs.url) {
return null;
}
if (typeof objArgs.async == 'undefined') {
objArgs.async = true;
}
if (!objArgs.reliable) {
objArgs.reliable = false;
}
// Form argument for fetch
var objFetchArgs = {};
for (var strKey in objArgs) {
objFetchArgs[strKey] = objArgs[strKey];
}
// Prevent duplicate parseXml call in synchronous mode
if (objArgs.async) {
objFetchArgs.onLoad = function(objRequest) {
RPC.Transport.parseJson({
strJson: objRequest.responseText,
reliable: objArgs.reliable,
onLoad: objArgs.onLoad,
onError: objArgs.onError
});
};
} else {
objFetchArgs.onLoad = null;
}
// Fetch URL
var objRequest = RPC.Transport.fetch(objFetchArgs);
// In synchronous mode the result is ready on the next line
if (!objArgs.async && objRequest) {
return RPC.Transport.parseJson({
strJson: objRequest.responseText,
reliable: objArgs.reliable,
onLoad: objArgs.onLoad,
onError: objArgs.onError
});
}
return null;
};
/**
* Parses JSON string into object.
*
*
* When JSON string is parsed, one of provided callback functions is called:
* onLoad on success or onError on error.
*
* onLoad callback function receives JSON object as argument.
*
* onError callback function receives following object:
* {
* errorCode: error code [number],
* errorDescription: human readable error description [string]
* }
* Error code will be always 0.
*
* Returns JSON object, so onLoad callback function is optional.
* Returned value should be checked before use because it can be null.
*
* Arguments object format:
* {
* strJson: JSON string to parse [string],
* reliable: false (string will be parsed) or true (evaluated) [boolean]
* (optional, false by default),
* onLoad: function reference to call on success [function] (optional),
* onError: function reference to call on error [function] (optional)
* }
*
*
* @param {object} objArgs Arguments object
* @return JSON object or null
* @type object
*/
RPC.Transport.parseJson = function(objArgs) {
if (objArgs == null || typeof objArgs != 'object') {
return null;
}
if (!objArgs.strJson) {
return null;
}
if (!objArgs.reliable) {
objArgs.reliable = false;
}
if (!objArgs.onLoad) {
objArgs.onLoad = null;
}
if (!objArgs.onError) {
objArgs.onError = null;
}
var objJson = null;
try {
if (objArgs.reliable) {
objJson = eval('(' + objArgs.strJson + ')');
} else {
objJson = RPC.Transport.parseJsonStr(objArgs.strJson);
}
} catch (objException) {
RPC.Transport.displayError(0,
'Error: Cannot parse.\n' +
'String does not appear to be a valid JSON fragment: ' +
objException.message + '\n' + objException.text,
objArgs.onError);
};
if (typeof objArgs.onLoad == 'function') {
objArgs.onLoad(objJson);
}
return objJson;
};
/**
* Parses JSON string into object.
*
* * Was taken with changes from http://json.org/json.js. * * Throws exception if parsing error occurs. * * JSON format is described at http://json.org/js.html. ** * @private * @param {string} text JSON string to parse * @return JSON object * @type object */ RPC.Transport.parseJsonStr = function(text) { var p = /^\s*(([,:{}\[\]])|"(\\.|[^\x00-\x1f"\\])*"|-?\d+(\.\d*)?([eE][+-]?\d+)?|true|false|null)\s*/, token, operator; function error(m, t) { throw { name: 'JSONError', message: m, text: t || operator || token }; } function next(b) { if (b && b != operator) { error("Expected '" + b + "'"); } if (text) { var t = p.exec(text); if (t) { if (t[2]) { token = null; operator = t[2]; } else { operator = null; try { token = eval(t[1]); } catch (e) { error("Bad token", t[1]); } } text = text.substring(t[0].length); } else { error("Unrecognized token", text); } } else { // undefined changed to null because it is not supported in IE 5.0 token = operator = null; } } function val() { var k, o; switch (operator) { case '{': next('{'); o = {}; if (operator != '}') { for (;;) { if (operator || typeof token != 'string') { error("Missing key"); } k = token; next(); next(':'); o[k] = val(); if (operator != ',') { break; } next(','); } } next('}'); return o; case '[': next('['); o = []; if (operator != ']') { for (;;) { o.push(val()); if (operator != ',') { break; } next(','); } } next(']'); return o; default: if (operator !== null) { error("Missing value"); } k = token; next(); return k; } } next(); return val(); }; /** * Serializes JSON object into JSON string. * * Was taken with changes from http://json.org/json.js. * * @param {object} v JSON object * @return JSON string * @type string */ RPC.Transport.serializeJsonObj = function(v) { var a = []; /* Emit a string. */ function e(s) { a[a.length] = s; } /* Convert a value. */ function g(x) { var c, i, l, v; switch (typeof x) { case 'object': if (x) { if (x instanceof Array) { e('['); l = a.length; for (i = 0; i < x.length; i += 1) { v = x[i]; if (typeof v != 'undefined' && typeof v != 'function') { if (l < a.length) { e(','); } g(v); } } e(']'); return; } else if (typeof x.toString != 'undefined') { e('{'); l = a.length; for (i in x) { v = x[i]; if (x.hasOwnProperty(i) && typeof v != 'undefined' && typeof v != 'function') { if (l < a.length) { e(','); } g(i); e(':'); g(v); } } return e('}'); } } e('null'); return; case 'number': e(isFinite(x) ? +x : 'null'); return; case 'string': l = x.length; e('"'); for (i = 0; i < l; i += 1) { c = x.charAt(i); if (c >= ' ') { if (c == '\\' || c == '"') { e('\\'); } e(c); } else { switch (c) { case '\b': e('\\b'); break; case '\f': e('\\f'); break; case '\n': e('\\n'); break; case '\r': e('\\r'); break; case '\t': e('\\t'); break; default: c = c.charCodeAt(); e('\\u00' + Math.floor(c / 16).toString(16) + (c % 16).toString(16)); } } } e('"'); return; case 'boolean': e(String(x)); return; default: e('null'); return; } } g(v); return a.join(''); }; /** * Displays error message. * *
* Calls onError callback function provided by user. If there is no onError
* callback function, displays alert with human readable error description.
* onError callback function receives following object:
* {
* errorCode: error code [number],
* errorDescription: human readable error description [string]
* }
*
*
* @private
* @param {number} iErrCode Error code
* @param {string} strError Human readable error description
* @param {function} onError Callback function provided by user
*/
RPC.Transport.displayError = function(iErrCode, strError, onError) {
if (typeof onError == 'function') {
onError({
errorCode: iErrCode,
errorDescription: strError
});
} else {
alert(strError);
}
};
/**
* Translates a URL to the URL relative to the specified or to absolute URL.
*
*
* Arguments object format:
* {
* url: absolute or relative URL to translate [string] (if absolute, will be
* returned as is),
* relativeTo: "url" will be translated to the URL relative to this absolute
* or relative URL [string] (optional, current page URL by default)
* }
*
*
* @param {object} objArgs Arguments object
* @return Translated URL
* @type string
*/
RPC.Transport.translateUrl = function(objArgs) {
if (!objArgs || !objArgs.url) {
return null;
}
// Cut arguments part
var arrFullUrl = objArgs.url.split('?', 2);
var strUrl = arrFullUrl[0];
// Check if it is absolute
if (strUrl.charAt(0) == '/' || strUrl.indexOf(':') >= 0) {
return objArgs.url;
}
// Make relative to current page URL by default
if (!objArgs.relativeTo) {
objArgs.relativeTo = document.location.toString();
}
// Remove arguments
objArgs.relativeTo = objArgs.relativeTo.split("?", 2)[0];
// Split URLs
var arrUrl = strUrl.split('/');
var arrRelativeTo = objArgs.relativeTo.split('/');
// Remove file name
arrRelativeTo.pop();
// Form new URL
for (var iToken = 0; iToken < arrUrl.length; iToken++) {
var strToken = arrUrl[iToken];
if (strToken == '..') {
arrRelativeTo.pop();
} else if (strToken != '.') {
arrRelativeTo.push(strToken);
}
}
arrFullUrl[0] = arrRelativeTo.join('/');
// Restore arguments part
return arrFullUrl.join('?');
};