0)
{
var nextRequest = AjaxTCR.comm.queue._requestQueue.shift();
AjaxTCR.comm.sendRequest(nextRequest.url, nextRequest.options);
}
},
/**
* Private method called after response comes in if request is in the response queue.
* Adds response to response queue and then calls callbacks for any that are able to move forward
*
* @param {object} response The object that contains all the settings for the request
*/
_handleQueue: function(response){
/* add response into queue */
AjaxTCR.comm.queue._responseQueue.queue[response.responseQueueID] = response;
/* loop thru queue handling any received requests up to current point */
while (AjaxTCR.comm.queue._responseQueue.queue[AjaxTCR.comm.queue._responseQueue.currentIndex] != undefined)
{
AjaxTCR.comm._handleCallbacks(AjaxTCR.comm.queue._responseQueue.queue[AjaxTCR.comm.queue._responseQueue.currentIndex]);
AjaxTCR.comm.queue._responseQueue.currentIndex++;
}
}
};
/************************************* AjaxTCR.comm.stats *****************************/
/**
* The statistics class of the library. Collects statistics regarding total requests, timeouts, retries, successes, and failures
* Can serialize and send this data to your server.
*
* @class AjaxTCR.comm.stats
* @static
*/
AjaxTCR.comm.stats = {
/** stats object to hold results
* @private
* @config {integer} totalRequests
* @config {integer} totalTimeouts
* @config {integer} totalRetries
* @config {integer} totalSuccesses
* @config {integer} totalFails
* @config {array} requestFails
*/
_commResults : {
totalRequests : 0,
totalTimeouts : 0,
totalRetries : 0,
totalSuccesses : 0,
totalFails : 0,
requestFails : new Array()},
/**
* Sets up system to send results to the passed in URL on page unload. It passes them as a POST with an application/json body.
*
* @param {Object} url URL to send the results to
*/
collect : function (url) {
var sendConnectionStats = function(){
var results = AjaxTCR.comm.stats.get();
if (results.totalRequests > 0)
{
var payload = AjaxTCR.data.encodeJSON(results);
AjaxTCR.comm.sendRequest(url, {method:"POST",payload:payload,requestContentType:"application/json",oneway:true});
}
};
if(window.attachEvent)
window.attachEvent('onunload', sendConnectionStats);
else
window.addEventListener('unload', sendConnectionStats, false);
},
/**
* Returns the whole statistics object
*
* @return {object} the statistics object
*/
get : function() {
return AjaxTCR.comm.stats._commResults;
},
/**
* Public method acting as simple getter for the count of requests currently out
*
* @param {string} type The type of requests that you want the count on. Options are "queued", "active", and "all"
* @return - the number of outstanding requests
*/
getRequestCount : function(type) {
if (type == "queued")
return AjaxTCR.comm.queue.getSize();
else if (type == "active")
return AjaxTCR.comm._requestsOutstanding;
else
return (AjaxTCR.comm.queue.getSize() + AjaxTCR.comm._requestsOutstanding);
}
};
/************************************* AjaxTCR.comm.cookie *****************************/
/**
* The cookie class of the library. Allows setting and retrieving of cookies
*
* @class AjaxTCR.comm.cookie
* @static
*/
AjaxTCR.comm.cookie = {
/**
* Gets the value of a cookie with the given name.
*
* @param {String} name The name of the cookie to find
* @return {String} The value of the specified cookie
*/
get : function(name){
var fullname = name + "=";
var cookies = document.cookie.split(';');
for(var i=0;i < cookies.length;i++)
{
var cookieNV = cookies[i];
while (cookieNV.charAt(0)==' ')
cookieNV = cookieNV.substring(1);
if (cookieNV.indexOf(fullname) == 0)
return cookieNV.substring(fullname.length);
}
return null;
},
/**
* Create a cookie using document.cookie
*
* @param {string} key The cookie name
* @param {string} value The cookie value
* @param {string} expires The date of expiration. If not set, the cookie expires when the browser is closed.
* @param {string} [path] The path to store the cookie. If not set, it is stored at "/"
*/
set: function(key, value, expires, path){
if (!path)
path = "/";
document.cookie = key+"="+value+"; expires=" + expires +"; path=" + path;
},
/**
* Removes the cookie specified by key.
* @param {Object} key The name of the cookie to remove
* @param {Object} [path] The path where the cookie is stored. If not set, it checks "/"
*/
remove: function(key, path){
if (!path)
path = "/";
var now = new Date();
now.setYear(now.getYear()-1);
var expires = now.toGMTString();
document.cookie = key+"=; expires=" + expires +"; path=" + path;
}
};
/************************************* AjaxTCR.history *****************************/
/**
* The history class of the library. History is called directly from communications, but can also be called by the user.
* If history is going to be used, you must call AjaxTCR.history.init() before usage.
*
* @class AjaxTCR.history
* @static
*/
AjaxTCR.history = {
/** contstants
* @private
*/
BACK_GUARD_DISABLED : 0,
BACK_GUARD_INITIALIZED : 1,
BACK_GUARD_ENABLED : 2,
/** Current State of application
* @private
*/
_currentState : "",
/** function to call on statechange callback. Specifed in init()
* @private
*/
_onStateChangeCallback : function(){},
/** html file that iframe points to. Does not need any contents, but does need to exist
* @private
*/
_iframeSrc : "blank.html",
/** Boolean indicated whether to handle history
* @private
*/
_historyEnabled : false,
/** The history array
* @private
*/
_history : new Array(),
/** The current position in the history array
* @private
*/
_historyPosition : 0,
/** Boolean indicated if library should warn on page unload
* @private
*/
_backGuardEnabled: 0,
/** Message to alert when warning on page unload
* @private
*/
_backGuardMessage: "Are you sure you wish to end your session?",
/**
* Function that must be called before using the history mechanics.
* It sets historyEnabled to true, sets the callback function,
* sets up the timers to check for history change
* and checks to see if the initial state is a bookmark
*
* @param {function} onStateChangeCallback The function to call if there is a state change outside of the XHR call
* @param {Object} initState The data to pass back to the callback function
*/
init : function(onStateChangeCallback, initState){
if (AjaxTCR.history._historyEnabled)
return;
else
AjaxTCR.history._historyEnabled = true;
AjaxTCR.history._onStateChangeCallback = onStateChangeCallback;
if(!(navigator.userAgent.toLowerCase().indexOf("msie")>-1))
AjaxTCR.history._checkHash();
else
AjaxTCR.history._checkHashIE();
if (!window.location.hash)
AjaxTCR.history.addToHistory("AjaxTCRinit", initState, document.title);
else if ((navigator.userAgent.toLowerCase().indexOf("msie")>-1))
AjaxTCR.history._initIE();
},
/**
* Adds an item to the browser history. Saves the title, position in history, and the data for later retrieval.
*
* @param {string} id the key to store the history item under
* @param {object} data the data field to be returned to the callback function.
* @param {title} [title] the title to change the page to
* @param {string} [url] the url to request when page reloads.
* @param {object} [options] the options for the request
*/
addToHistory : function(id, data, title, url, options){
if (id != "AjaxTCRinit")
{
window.location.hash =AjaxTCR.data.encodeValue(id).replace(/%2F/g, '/');;
AjaxTCR.history._currentState = window.location.hash.substring(1);
}
var optionsString = "";
var safeStateName = id.replace(/[%\+]/g, "");
if (title)
document.title = title;
if (options)
{
options.url = url;
if (navigator.userAgent.toLowerCase().indexOf("msie")>-1)
options.responseXML = "iebug";
optionsString = AjaxTCR.data.encode64(AjaxTCR.data.encodeJSON(options));
}
else if (data)
{
options = {value: data};
optionsString = AjaxTCR.data.encode64(AjaxTCR.data.encodeJSON(options));
}
//update position
AjaxTCR.history._historyPosition++;
if(navigator.userAgent.toLowerCase().indexOf("msie")>-1)
{
var iframe = document.getElementById("ieFix");
var html = 'IE History' + AjaxTCR.history._currentState + '
';
var doc = iframe.contentWindow.document;
doc.open();
doc.write(html);
doc.close();
var persistDiv = doc.getElementById("persistDiv");
AjaxTCR.storage.add("request", optionsString, persistDiv, safeStateName);
if (title)
AjaxTCR.storage.add("title", title, persistDiv, safeStateName);
AjaxTCR.storage.add("position", AjaxTCR.history._historyPosition, persistDiv, safeStateName);
}
else if (safeStateName)
{
AjaxTCR.storage.add(safeStateName, optionsString);
if (title)
AjaxTCR.storage.add(safeStateName + "title", title);
AjaxTCR.storage.add(safeStateName + "position", AjaxTCR.history._historyPosition);
}
/* Finally push onto history stack */
var historyItem = {id: AjaxTCR.history._currentState, title: title};
var diff = AjaxTCR.history._history.length - AjaxTCR.history._historyPosition + 1;
if (diff > 0)
AjaxTCR.history._history.splice(AjaxTCR.history._historyPosition-1,diff);
AjaxTCR.history._history.push(historyItem);
},
/**
* Returns the entire history array
* @return {array} The history array
*/
getAll : function(){
return AjaxTCR.history._history;
},
/**
* Returns the current position in the history stack
* @return {integer} The current position in the history stack
*/
getPosition : function(){
return AjaxTCR.history._historyPosition;
},
/**
* Sets up the system that will alert the user when they leave the page that they are leaving the application
*
* @param {string} [message] The message to alert the user
* @param {Boolean} [immediate] If set to true, it immediately sets up the system. Otherwise, it sets it up on first sendRequest call.
*/
enableBackGuard: function(message, immediate){
if (AjaxTCR.history._backGuardEnabled)
return;
if (message != null && typeof(message) != "undefined")
AjaxTCR.history._backGuardMessage = message;
if (immediate)
AjaxTCR.history._activateBackGuard();
else
AjaxTCR.history._backGuardEnabled = AjaxTCR.history.BACK_GUARD_INITIALIZED;
},
/**
* Sets the onbeforeunload handler to alert when the user tries to leave the page
* @private
*/
_activateBackGuard: function(){
var message = AjaxTCR.history._backGuardMessage;
window.onbeforeunload = function () {return message;}
AjaxTCR.history._backGuardEnabled = AjaxTCR.history.BACK_GUARD_ENABLED;
},
/**
* Creates html page to write to the iframe in the case of IE
*
* @private
*/
_initIE: function(){
var iframe = document.getElementById("ieFix");
var html = 'IE History' + window.location.hash.substring(1); + '
';
var doc = iframe.contentWindow.document;
doc.open();
doc.write(html);
doc.close();
},
/**
* Checks to see if the state that is set in the IE Iframe matches the current state as set in the library. If they are not a match,
* update the state of the page
*
* @private
*/
_checkHashIE : function (){
var iframe = document.getElementById("ieFix");
if ( !iframe.contentWindow || !iframe.contentWindow.document )
{
setTimeout( _checkHashIE, 10 );
return;
}
var doc = iframe.contentWindow.document;
var keyObj = doc.getElementById("currentState");
var key = "";
if (keyObj)
key = keyObj.innerText;
if (key != AjaxTCR.history._currentState)
{
AjaxTCR.history._currentState = key;
window.location.hash = key;
var persistDiv = doc.getElementById("persistDiv");
var safeStateName = AjaxTCR.history._currentState.replace(/[%\+]/g, "");
if (!safeStateName)
safeStateName = "AjaxTCRinit";
var title = AjaxTCR.storage.get("title", persistDiv, safeStateName);
if (title)
document.title = title;
AjaxTCR.history._historyPosition = AjaxTCR.storage.get("position", persistDiv, safeStateName);
//check for bookmarked history position
if (AjaxTCR.history._historyPosition > AjaxTCR.history._history.length)
{
AjaxTCR.history._historyPosition = 1;
AjaxTCR.storage.add("position", AjaxTCR.history._historyPosition, persistDiv, safeStateName);
var historyItem = {id: AjaxTCR.history._currentState, title: title};
AjaxTCR.history._history.push(historyItem);
}
var optionsString = AjaxTCR.storage.get("request", persistDiv, safeStateName);
AjaxTCR.history._handleHistoryCallback(optionsString);
}
setTimeout("AjaxTCR.history._checkHashIE();", 500);
},
/**
* Checks to see if the current window.location.hash value matches the value saved in the currentState.
* If they do not match, update the state of the page.
*
* @private
*/
_checkHash : function () {
if ((window.location.hash != "#" + AjaxTCR.history._currentState) && window.location.hash != AjaxTCR.history._currentState)
{
AjaxTCR.history._currentState = window.location.hash.substring(1);
var safeStateName = AjaxTCR.history._currentState.replace(/[%\+]/g, "");
if (!safeStateName)
safeStateName = "AjaxTCRinit";
var title = AjaxTCR.storage.get(safeStateName + "title");
if (title)
document.title = title.value;
AjaxTCR.history._historyPosition = AjaxTCR.storage.get(safeStateName + "position").value;
//check for bookmarked history position
if (AjaxTCR.history._historyPosition > AjaxTCR.history._history.length)
{
AjaxTCR.history._historyPosition = 1;
AjaxTCR.storage.add(safeStateName + "position", AjaxTCR.history._historyPosition);
var historyItem = {id: AjaxTCR.history._currentState, title: title};
AjaxTCR.history._history.push(historyItem);
}
var results = AjaxTCR.storage.get(safeStateName);
if (results)
AjaxTCR.history._handleHistoryCallback(results.value);
else
AjaxTCR.history._onStateChangeCallback(AjaxTCR.data.decodeValue(AjaxTCR.history._currentState));
}
setTimeout("AjaxTCR.history._checkHash();", 500);
},
/**
* If the state on the page changes, this function is called to figure out how to restore the state of the new location.
* Check the stored data and see if we need to call sendRequest/handleCacheResponse or if we need to call the callback function specified by the user in init.
*
* @private
* @param {string} String value containing the JSON data that was saved on addToHistory
*/
_handleHistoryCallback : function(optionsString){
if (optionsString && optionsString != "")
{
var str = AjaxTCR.data.decode64(optionsString);
var options = AjaxTCR.data.decodeJSON(AjaxTCR.data.decode64(optionsString));
if (options.history)
{
if (options.history.saveResponse)
{
options.history = null;
AjaxTCR.comm.cache._handleCacheResponse(options, options.responseText);
}
else
{
options.history = null;
AjaxTCR.comm.sendRequest(options.url, options);
}
}
else
AjaxTCR.history._onStateChangeCallback(AjaxTCR.data.decodeValue(AjaxTCR.history._currentState), options.value);
}
else
AjaxTCR.history._onStateChangeCallback(AjaxTCR.data.decodeValue(AjaxTCR.history._currentState));
}
};
/********************************************* Storage Methods *********************************************/
/**
* The storage class of the library. Storage is called directly from history, but can also be called by the user.
* If storage is going to be used, you must call AjaxTCR.storage.init() before usage.
* The types of storage supported are IE Behaviors, WHATWG globalStorage, and cookies
*
* @class AjaxTCR.storage
* @static
*/
AjaxTCR.storage = {
/** The max size to store in cookies */
DEFAULT_MAX_COOKIE_SIZE: 4000,
/**
* Method must be called before using storage. The returned value must be passed to all future storage requests
*
* @returns {object} The newly created persitent Div object
*/
init : function(){
if (navigator.userAgent.toLowerCase().indexOf("msie")>-1 )
{
var persistDiv = document.createElement("div");
persistDiv.id = "AjaxTCRPersistDiv";
persistDiv.style.behavior = "url(#default#userData)";
document.body.appendChild(persistDiv);
return persistDiv;
}
return null;
},
/**
* Adds an item to storage. Checks the browser support and chooses an appropriate method.
*
* @param {String} key The key to reference the stored string
* @param {String} value The string to store in persistent data
* @param {Object} persistObj The persistent Object returned from init
* @param {string} [store] Optional value to name the store to save the data. Only applicable in IE
*/
add : function(key, value, persistObj, store){
var setFlag = 0;
if(navigator.userAgent.toLowerCase().indexOf("msie")>-1 )
{
if (!store)
store = "AjaxTCRStore";
if (persistObj)
{
var allitemsString = AjaxTCR.storage.get("AjaxTCRAllItems", persistObj, store);
if (!allitemsString)
var allitemsObj = {};
else
var allitemsObj = AjaxTCR.data.decodeJSON(allitemsString);
allitemsObj[key] = value;
allitemsString = AjaxTCR.data.encodeJSON(allitemsObj);
persistObj.setAttribute("AjaxTCRAllItems",allitemsString);
persistObj.setAttribute(key,value);
persistObj.save(store);
setFlag = 1;
}
}
else if (typeof(globalStorage) != "undefined")
{
try{
var storage = globalStorage[document.domain];
storage.setItem(key, value);
setFlag = 1;
}
catch(e){}
}
if (!setFlag)
{
/* Update all records */
var allitemsString = AjaxTCR.storage.get("AjaxTCRAllItems");
if (!allitemsString)
var allitemsObj = new Array();
else
var allitemsObj = AjaxTCR.data.decodeJSON(allitemsString);
allitemsObj.push(key);
allitemsString = AjaxTCR.data.encodeJSON(allitemsObj);
var now = new Date();
now.setMonth(now.getMonth()+1);
var expires = now.toGMTString();
var pieces = Math.floor(allitemsString.length/AjaxTCR.storage.DEFAULT_MAX_COOKIE_SIZE + 1);
for (var i=0;i-1)
{
if (!store)
store = "AjaxTCRStore";
if (persistObj)
{
persistObj.load(store);
return persistObj.getAttribute(key);
}
}
else if (typeof(globalStorage) != "undefined")
{
try{
var storage = globalStorage[document.domain];
return storage.getItem(key);
}
catch(e){}
}
//if it the storage hasn't been found, check cookies
var i=0;
var fullvalue = "";
do
{
var val = AjaxTCR.comm.cookie.get(key+i.toString());
if (val)
fullvalue += val;
i++;
}while(val);
if (fullvalue != "")
return fullvalue;
return null;
},
/**
* Returns all items from the storage in an associative array of name/value pairs
*
* @param {Object} persistObj The persistent Object returned from init
* @param {String} [store] Optional value to name the store to save the data. Only applicable in IE
*/
getAll : function(persistObj, store){
if(navigator.userAgent.toLowerCase().indexOf("msie")>-1)
{
if (!store)
store = "AjaxTCRStore";
if (persistObj)
{
var allitems = AjaxTCR.storage.get("AjaxTCRAllItems", persistObj, store);
return AjaxTCR.data.decodeJSON(allitems);
}
}
else if (typeof(globalStorage) != "undefined")
{
try{
var storage = globalStorage[document.domain];
return storage;
}
catch(e){}
}
//if it the storage hasn't been found, check cookies
var allitems = AjaxTCR.storage.get("AjaxTCRAllItems");
if (allitems)
{
var items = {};
var keys = AjaxTCR.data.decodeJSON(allitems);
for (var i=0;i-1 )
{
if (!store)
store = "AjaxTCRStore";
if (persistObj)
{
var allitems = AjaxTCR.storage.get("AjaxTCRAllItems", persistObj, store);
if (allitems)
{
allitems = AjaxTCR.data.decodeJSON(allitems);
if (allitems[key])
delete allitems[key];
allitems = AjaxTCR.data.encodeJSON(allitems);
persistObj.setAttribute("AjaxTCRAllItems",allitems);
}
persistObj.removeAttribute(key);
persistObj.save(store);
removeFlag = 1;
}
}
else if (typeof(globalStorage) != "undefined")
{
try{
var storage = globalStorage[document.domain];
delete storage[key];
removeFlag = 1;
}
catch(e){}
}
if (!removeFlag)
{
/* First remove from global object */
var allitems = AjaxTCR.storage.get("AjaxTCRAllItems", persistObj, store);
if (allitems)
{
allitems = AjaxTCR.data.decodeJSON(allitems);
for (var i=allitems.length-1;i>=0;i--)
{
if (allitems[i] == key)
delete allitems[i];
}
var allitemsString = AjaxTCR.data.encodeJSON(allitems);
var loops = Math.floor(allitemsString.length/AjaxTCR.storage.DEFAULT_MAX_COOKIE_SIZE + 1);
var now = new Date();
now.setMonth(now.getMonth()+1);
var expires = now.toGMTString();
for (var i=0;i
* <h3>Thanks for voting!</h3>
* <p>Your rating: {$userrating}. <br />
* Average rating: {$avgrating}.<br />
* Total votes: {$totalvotes}. <br />
* </p>
* <!-- Template-End -->
* <!-- Template-Begin URL='thankyou-Ajax.tpl' -->
* <h2>Thank you for registering {$username}</h2>
* <p>Contact technical support at 555-1212</p>
* <!-- Template-End -->
*
* @param url - URL of the template bundle to fetch
*/
cacheBundle : function(url){
var options = {cacheTemplate:true,
onSuccess: AjaxTCR.template._parseTemplateBundle};
AjaxTCR.comm.sendRequest(url, options);
},
/**
* Public method that resets the template's cache
*
*/
clearCache : function(){
AjaxTCR.template._cache = new Array();
},
/**
* public method to fetch a cached template based on the key
* @param {string} key key to add to the template cache
* @return {string} the cached object value if found
*/
getFromCache: function(key){
var cacheObject = null;
/* Search for item */
for (var i=0;i');
AjaxTCR.template._libraryIncluded = true;
},
/**
* Takes a template bundle, parses it, and adds each item to the cache
*
* @private
* @param {response} The response object from the XHR
*
*/
_parseTemplateBundle : function(response){
var bundle = response.responseText;
var re = /\s*\