/**
* The YACS AJAX shared library.
*
* This file extends prototype, etc., to enhance interactions with the end-user
*
* @see users/heartbit.php
* @see users/notifications.php
* @see users/view.php
*
* @author Bernard Paques [email]bernard.paques@bigfoot.com[/email]
* @reference
* @license http://www.gnu.org/copyleft/lesser.txt GNU Lesser General Public License
*/
var Yacs = {
/**
* alert the surfer
*
* @param message to display
*/
alert: function(message) {
return alert(message);
},
/**
* reflect last sort in table
*
* @param target table
* @param sorted column
*/
beautifyTable: function(tblEl, col) {
// look for class names in styles
var rowTest = new RegExp("odd", "gi");
var colTest = new RegExp("sorted", "gi");
// alternate row appearance
var i, j;
var rowEl, cellEl;
for (i = 0; i < tblEl.rows.length; i++) {
rowEl = tblEl.rows[i];
Element.removeClassName(rowEl, 'odd');
if (i % 2 != 0)
Element.addClassName(rowEl, 'odd');
// set style classes on each column
for (j = 2; j < tblEl.rows[i].cells.length; j++) {
cellEl = rowEl.cells[j];
Element.removeClassName(cellEl, 'sorted');
// highlight the one that was sorted
if (j == col)
Element.addClassName(cellEl, 'sorted');
}
}
// find the table header and highlight the column that was sorted
var el = tblEl.parentNode.tHead;
rowEl = el.rows[el.rows.length - 1];
// set style classes for each column
for (i = 0; i < rowEl.cells.length; i++) {
cellEl = rowEl.cells[i];
Element.removeClassName(cellEl, 'sorted');
// highlight the header of the sorted column
if (i == col)
Element.addClassName(cellEl, 'sorted');
}
},
/**
* clear one cookie
*
* @param cookie name
*/
clearCookie: function(name) {
if(Yacs.getCookie(name)) {
document.cookie = name + "=; expires=Thu, 01-Jan-70 00:00:01 GMT";
}
},
/**
* ask for confirmation
*
* @param message to display
* @return true if this has been confirmed, false otherwise
*/
confirm: function(message) {
return confirm(message);
},
/**
* compare two values
*
* @param first value
* @param second value
* @return comparison value
*/
compareValues: function(v1, v2) {
// if the values are numeric, convert them to floats
var f1 = parseFloat(v1);
var f2 = parseFloat(v2);
if(!isNaN(f1) && !isNaN(f2)) {
v1 = f1;
v2 = f2;
}
// compare the two values
if(v1 == v2)
return 0;
if(v1 > v2)
return 1;
return -1;
},
/**
* detect Flash on client-side
*
* The script used to detect Flash under Firefox, etc. This is complemented
* by server-side detection for IE.
*
* This function also save findings in a cookie for transmission to server.
*
* @return 'yes' or 'no'
*/
detectFlash: function () {
var detected = 'no';
// cookie has already been set
if(detected = Yacs.getCookie("FlashIsAvailable"))
return detected;
// detect in plugins
if(navigator.plugins != null && navigator.plugins.length > 0) {
if(navigator.plugins["Shockwave Flash 2.0"] || navigator.plugins["Shockwave Flash"]) {
detected = 'yes';
}
} else if(navigator.userAgent.toLowerCase().indexOf("webtv") != -1) {
detected = 'yes';
}
// remember this in a cookie
Yacs.setCookie("FlashIsAvailable", detected);
// return the result, if useful
return detected;
},
/**
* compute and record surfer time zone
*
* This function computes the surfer time zone, and save it in a cookie to
* share this with the back-end
*
* @return the time zone
*/
detectTimeZone: function () {
var timeZone;
// cookie has already been set
if(timeZone = Yacs.getCookie("TimeZone"))
return timeZone;
// compute time shift
var now = new Date();
timeZone = (-now.getTimezoneOffset() /60);
// var gmtDate = new Date(now.getFullYear(), 0, 1, 0, 0, 0, 0);
// var gmtString = gmtDate.toGMTString();
// var localDate = new Date(gmtString.substring(0, gmtString.lastIndexOf(" ")-1));
// var timeZone = (gmtDate - localDate) / (1000 * 60 * 60);
// remember this in a cookie
Yacs.setCookie("TimeZone", timeZone);
// return the result, if useful
return timeZone;
},
/**
* get the value of one cookie
*
* @param cookie name
* @return cookie value
*/
getCookie: function(name) {
var prefix = name + "=";
var begin = document.cookie.indexOf(prefix);
if(begin == -1) { return null; }
var end = document.cookie.indexOf(";", begin);
if(end == -1) { end = document.cookie.length; }
return unescape(document.cookie.substring(begin + prefix.length, end));
// var arg = name + "=";
// var alen = arg.length;
// var clen = document.cookie.length;
// var i = 0;
// var j = 0;
// while(i < clen){
// j = i + alen;
// if (document.cookie.substring(i, j) == arg) {
// var endstr = document.cookie.indexOf(";", j);
// if(endstr == -1){
// endstr = document.cookie.length;
// }
// return unescape(document.cookie.substring(j, endstr));
// }
// i = document.cookie.indexOf(" ", i) + 1;
// if(i == 0)
// break;
// }
// return null;
},
/**
* get a sortable string
*
* This function finds and concatenate the values of all text nodes
*
* @param the target DOM element
* @return a sortable string
*/
getTextValue: function(el) {
// the returned string
var s = "";
// look at every child node
var i;
for(i = 0; i < el.childNodes.length; i++) {
// a text node
if(el.childNodes[i].nodeType == 3)
s += el.childNodes[i].nodeValue;
// an element node which is a break
else if((el.childNodes[i].nodeType == 1) && (el.childNodes[i].tagName == "br"))
s += " ";
// use recursion to get text within sub-elements
else
s += getTextValue(el.childNodes[i]);
}
return s;
},
/**
* we have received an 'alert' notification
*
* @see users/notifications.php
*/
handleAlertNotification: function(response) {
// build a message in English if no localized message has been provided by the server
if(typeof response['dialog_text'] != 'string')
response['dialog_text'] = 'New at ' + response['title'] + "\nby:" + response['nick_name'] + "\n" + 'Would you like to browse this page?';
// switch to the offered address, if accepted by surfer
if(typeof response['address'] == 'string') {
if(Yacs.confirm(response['dialog_text'])) {
window.open(response['address']);
}
}
},
/**
* we have received a 'browse' notification
*
* @see users/notifications.php
*/
handleBrowseNotification: function(response) {
// build a message in English if no localized message has been provided by the server
if(typeof response['dialog_text'] != 'string')
response['dialog_text'] = 'From ' + response['nick_name'] + ':' + "\n" + response['message'] + "\n" + 'Would you like to browse the provided link?';
// switch to the offered address, if already in tracker, or if accepted by surfer
if(typeof response['address'] == 'string') {
if((window.name == 'yacs_tracker') || Yacs.confirm(response['dialog_text'])) {
window.open(response['address'], 'yacs_tracker');
}
}
},
/**
* we have received a 'hello' notification
*
* @see users/notifications.php
*/
handleHelloNotification: function(response) {
// build a message in English if no localized message has been provided by the server
if(typeof response['dialog_text'] != 'string')
response['dialog_text'] = 'From ' + response['nick_name'] + ':' + "\n" + response['message'] + "\n" + 'Would you like to chat with this person?';
// only show the message to the end-user
if(typeof response['address'] != 'string') {
Yacs.alert(response['dialog_text']);
// else switch to the offered address, if accepted by surfer
} else {
if(Yacs.confirm(response['dialog_text'])) {
window.open(response['address']);
}
}
},
/**
* general initialization on window successful load
*/
onWindowLoad: function() {
// resize according to surfer preferences
Yacs.textSize();
// subscribe to notifications
// Yacs.subscribe('fast');
setTimeout(function(){ Yacs.subscribe('fast') }, 10000);
// compute and record surfer time zone
Yacs.detectTimeZone();
// detect Flash on client side
Yacs.detectFlash();
// pre-load the spinning image used during ajax updates
Yacs.spinningImage = new Image();
Yacs.spinningImage.src = url_to_root + 'skins/_reference/ajax_spinner.gif';
// pre-load the image used at the working overlay
Yacs.workingImage = new Image();
Yacs.workingImage.src = url_to_root + 'skins/_reference/ajax_working.gif';
// do not stop page loading
setTimeout(function(){
// change the behavior of buttons used for data submission, except those with style 'no_spin_on_click'
var buttons = document.getElementsByTagName('button');
for(var index = 0; index < buttons.length; index++) {
var button = buttons[index];
var buttonType = String(button.getAttribute('type'));
if(buttonType.toLowerCase().match('submit') && !Element.hasClassName(button, 'no_spin_on_click')) {
button.onclick = function () { Yacs.startWorking(); return true; };
}
}
}, 500);
},
/**
* open a popup window
*/
popup: function(options) {
// default options
this.options = {
url: '#',
width: 600,
height: 500,
name:"_blank",
location:"no",
menubar:"no",
toolbar:"no",
status:"yes",
scrollbars:"yes",
resizable:"yes",
left:"",
top:"",
normal:false
}
// use provided options, if any
Object.extend(this.options, options || {});
// sanity check
if (this.options.normal){
this.options.menubar = "yes";
this.options.status = "yes";
this.options.toolbar = "yes";
this.options.location = "yes";
}
// some computations
this.options.width = this.options.width < screen.availWidth?this.options.width:screen.availWidth;
this.options.height=this.options.height < screen.availHeight?this.options.height:screen.availHeight;
var openoptions = 'width='+this.options.width+',height='+this.options.height+',location='+this.options.location+',menubar='+this.options.menubar+',toolbar='+this.options.toolbar+',scrollbars='+this.options.scrollbars+',resizable='+this.options.resizable+',status='+this.options.status
if (this.options.top!="")openoptions+=",top="+this.options.top;
if (this.options.left!="")openoptions+=",left="+this.options.left;
// open the popup
window.open(this.options.url, this.options.name, openoptions);
return false;
},
/**
* set a new cookie
*
* @param cookie name
* @param cookie value
* @param days before expiration (optional)
*/
setCookie: function(name, value) {
var argv = arguments;
var argc = arguments.length;
var expires = (argc > 2) ? argv[2] : null;
if(expires > 0) {
var today = new Date();
var future = today.getTime() + 3600000*24*expires;
expires = new Date();
expires.setTime(future);
}
var path = (argc > 3) ? argv[3] : '/';
var domain = (argc > 4) ? argv[4] : null;
var secure = (argc > 5) ? argv[5] : false;
document.cookie = name + "=" + escape (value) +
((expires == null) ? "" : ("; expires=" + expires.toGMTString())) +
((path == null) ? "" : ("; path=" + path)) +
((domain == null) ? "" : ("; domain=" + domain)) +
((secure == true) ? "; secure" : "");
},
/**
* load some opaque overlay during back-end processing
*/
startWorking: function() {
if(Yacs.workingOverlay) {
Element.setStyle(Yacs.workingOverlay, { display: 'block' });
return;
}
// insert some html at the bottom of the page that looks similar to this:
//
//
//
//
//
//
' }
}).merge(args)
);
},
/**
* set content only once
*
* This function is similar to Yacs.update(), except it does nothing if the target
* item already contains something.
*
* Use this function for example to populate tabbed panels of a complex page.
* Look at Yacs.tabs() above for a practical example of use
*
* @param string id of the target CSS container
* @param string web address to fetch new snippet
* @param mixed additional parameters to transmit to Ajax
*
*/
updateOnce: function(panel, address, args) {
// do nothing if the panel contains something
if(!$(panel).innerHTML || ($(panel).innerHTML == '') || ($(panel).innerHTML == '')) {
Yacs.update(panel, address, args);
}
}
}
// ready to receive new notifications
Event.observe(window, 'load', function() { Yacs.onWindowLoad() });
// that's a hack for Firefox --yes, I know, Yacs should always be defined here...
// if(typeof Yacs == 'object') {
// // slow down notifications on window blur -- not active on IE7?
// Event.observe(document, 'blur', function() { Yacs.subscribe('slow'); });
// // boost notifications on window focus
// Event.observe(document, 'focus', function() { Yacs.subscribe('fast'); });
// }