2 +-----------------------------------------------------------------------+
3 | Roundcube common js library |
5 | This file is part of the Roundcube web development suite |
6 | Copyright (C) 2005-2007, Roundcube Dev, - Switzerland |
7 | Licensed under the GNU GPL |
9 +-----------------------------------------------------------------------+
10 | Author: Thomas Bruederli <roundcube@gmail.com> |
11 +-----------------------------------------------------------------------+
13 $Id: common.js 4509 2011-02-09 10:51:50Z thomasb $
19 var CONTROL_SHIFT_KEY = 3;
23 * Default browser check class
26 function roundcube_browser()
30 this.ver = parseFloat(n.appVersion);
31 this.appver = n.appVersion;
32 this.agent = n.userAgent;
33 this.agent_lc = n.userAgent.toLowerCase();
34 this.name = n.appName;
35 this.vendor = n.vendor ? n.vendor : '';
36 this.vendver = n.vendorSub ? parseFloat(n.vendorSub) : 0;
37 this.product = n.product ? n.product : '';
38 this.platform = String(n.platform).toLowerCase();
39 this.lang = (n.language) ? n.language.substring(0,2) :
40 (n.browserLanguage) ? n.browserLanguage.substring(0,2) :
41 (n.systemLanguage) ? n.systemLanguage.substring(0,2) : 'en';
43 this.win = (this.platform.indexOf('win') >= 0);
44 this.mac = (this.platform.indexOf('mac') >= 0);
45 this.linux = (this.platform.indexOf('linux') >= 0);
46 this.unix = (this.platform.indexOf('unix') >= 0);
48 this.dom = document.getElementById ? true : false;
49 this.dom2 = (document.addEventListener && document.removeEventListener);
51 this.ie = (document.all && !window.opera);
52 this.ie4 = (this.ie && !this.dom);
53 this.ie5 = (this.dom && this.appver.indexOf('MSIE 5')>0);
54 this.ie8 = (this.dom && this.appver.indexOf('MSIE 8')>0);
55 this.ie7 = (this.dom && this.appver.indexOf('MSIE 7')>0);
56 this.ie6 = (this.dom && !this.ie8 && !this.ie7 && this.appver.indexOf('MSIE 6')>0);
58 this.mz = (this.dom && this.ver >= 5); // (this.dom && this.product=='Gecko')
59 this.ns = ((this.ver < 5 && this.name == 'Netscape') || (this.ver >= 5 && this.vendor.indexOf('Netscape') >= 0));
60 this.ns6 = (this.ns && parseInt(this.vendver) == 6); // (this.mz && this.ns) ? true : false;
61 this.ns7 = (this.ns && parseInt(this.vendver) == 7); // this.agent.indexOf('Netscape/7')>0);
62 this.chrome = (this.agent_lc.indexOf('chrome') > 0);
63 this.safari = (!this.chrome && (this.agent_lc.indexOf('safari') > 0 || this.agent_lc.indexOf('applewebkit') > 0));
64 this.konq = (this.agent_lc.indexOf('konqueror') > 0);
65 this.iphone = (this.safari && this.agent_lc.indexOf('iphone') > 0);
66 this.ipad = (this.safari && this.agent_lc.indexOf('ipad') > 0);
68 this.opera = window.opera ? true : false;
70 if (this.opera && window.RegExp)
71 this.vendver = (/opera(\s|\/)([0-9\.]+)/.test(this.agent_lc)) ? parseFloat(RegExp.$2) : -1;
72 else if (this.chrome && window.RegExp)
73 this.vendver = (/chrome\/([0-9\.]+)/.test(this.agent_lc)) ? parseFloat(RegExp.$1) : 0;
74 else if (!this.vendver && this.safari)
75 this.vendver = (/(safari|applewebkit)\/([0-9]+)/.test(this.agent_lc)) ? parseInt(RegExp.$2) : 0;
76 else if ((!this.vendver && this.mz) || this.agent.indexOf('Camino')>0)
77 this.vendver = (/rv:([0-9\.]+)/.test(this.agent)) ? parseFloat(RegExp.$1) : 0;
78 else if (this.ie && window.RegExp)
79 this.vendver = (/msie\s+([0-9\.]+)/.test(this.agent_lc)) ? parseFloat(RegExp.$1) : 0;
80 else if (this.konq && window.RegExp)
81 this.vendver = (/khtml\/([0-9\.]+)/.test(this.agent_lc)) ? parseFloat(RegExp.$1) : 0;
83 // get real language out of safari's user agent
84 if(this.safari && (/;\s+([a-z]{2})-[a-z]{2}\)/.test(this.agent_lc)))
85 this.lang = RegExp.$1;
87 this.dhtml = ((this.ie4 && this.win) || this.ie5 || this.ie6 || this.ns4 || this.mz);
88 this.vml = (this.win && this.ie && this.dom && !this.opera);
89 this.pngalpha = (this.mz || (this.opera && this.vendver >= 6) || (this.ie && this.mac && this.vendver >= 5) ||
90 (this.ie && this.win && this.vendver >= 5.5) || this.safari);
91 this.opacity = (this.mz || (this.ie && this.vendver >= 5.5 && !this.opera) || (this.safari && this.vendver >= 100));
92 this.cookies = n.cookieEnabled;
94 // test for XMLHTTP support
95 this.xmlhttp_test = function()
97 var activeX_test = new Function("try{var o=new ActiveXObject('Microsoft.XMLHTTP');return true;}catch(err){return false;}");
98 this.xmlhttp = (window.XMLHttpRequest || (window.ActiveXObject && activeX_test()));
102 // set class names to html tag according to the current user agent detection
103 // this allows browser-specific css selectors like "html.chrome .someclass"
104 this.set_html_class = function()
106 var classname = ' js';
120 classname += ' opera';
122 classname += ' konqueror';
123 else if (this.safari)
124 classname += ' safari';
127 classname += ' chrome';
128 else if (this.iphone)
129 classname += ' iphone';
131 classname += ' ipad';
133 classname += ' netscape6';
135 classname += ' netscape7';
137 if (document.documentElement)
138 document.documentElement.className += classname;
143 // static functions for DOM event handling
147 * returns the event target element
149 get_target: function(e)
151 e = e || window.event;
152 return e && e.target ? e.target : e.srcElement;
156 * returns the event key code
158 get_keycode: function(e)
160 e = e || window.event;
161 return e && e.keyCode ? e.keyCode : (e && e.which ? e.which : 0);
165 * returns the event key code
167 get_button: function(e)
169 e = e || window.event;
170 return e && (typeof e.button != 'undefined') ? e.button : (e && e.which ? e.which : 0);
174 * returns modifier key (constants defined at top of file)
176 get_modifier: function(e)
179 e = e || window.event;
182 opcode += (e.metaKey && CONTROL_KEY) + (e.shiftKey && SHIFT_KEY);
186 opcode += (e.ctrlKey && CONTROL_KEY) + (e.shiftKey && SHIFT_KEY);
192 * Return absolute mouse position of an event
194 get_mouse_pos: function(e)
196 if (!e) e = window.event;
197 var mX = (e.pageX) ? e.pageX : e.clientX,
198 mY = (e.pageY) ? e.pageY : e.clientY;
200 if (document.body && document.all) {
201 mX += document.body.scrollLeft;
202 mY += document.body.scrollTop;
206 mX += e._offset.left;
210 return { x:mX, y:mY };
214 * Add an object method as event listener to a certain element
216 add_listener: function(p)
218 if (!p.object || !p.method) // not enough arguments
221 p.element = document;
223 if (!p.object._rc_events)
224 p.object._rc_events = [];
226 var key = p.event + '*' + p.method;
227 if (!p.object._rc_events[key])
228 p.object._rc_events[key] = function(e){ return p.object[p.method](e); };
230 if (p.element.addEventListener)
231 p.element.addEventListener(p.event, p.object._rc_events[key], false);
232 else if (p.element.attachEvent) {
233 // IE allows multiple events with the same function to be applied to the same object
234 // forcibly detach the event, then attach
235 p.element.detachEvent('on'+p.event, p.object._rc_events[key]);
236 p.element.attachEvent('on'+p.event, p.object._rc_events[key]);
239 p.element['on'+p.event] = p.object._rc_events[key];
243 * Remove event listener
245 remove_listener: function(p)
248 p.element = document;
250 var key = p.event + '*' + p.method;
251 if (p.object && p.object._rc_events && p.object._rc_events[key]) {
252 if (p.element.removeEventListener)
253 p.element.removeEventListener(p.event, p.object._rc_events[key], false);
254 else if (p.element.detachEvent)
255 p.element.detachEvent('on'+p.event, p.object._rc_events[key]);
257 p.element['on'+p.event] = null;
262 * Prevent event propagation and bubbeling
264 cancel: function(evt)
266 var e = evt ? evt : window.event;
267 if (e.preventDefault)
269 if (e.stopPropagation)
272 e.cancelBubble = true;
273 e.returnValue = false;
277 touchevent: function(e)
279 return { pageX:e.pageX, pageY:e.pageY, offsetX:e.pageX - e.target.offsetLeft, offsetY:e.pageY - e.target.offsetTop, target:e.target, istouch:true };
286 * rcmail objects event interface
288 function rcube_event_engine()
293 rcube_event_engine.prototype = {
296 * Setter for object event handlers
298 * @param {String} Event name
299 * @param {Function} Handler function
300 * @return Listener ID (used to remove this handler later on)
302 addEventListener: function(evt, func, obj)
306 if (!this._events[evt])
307 this._events[evt] = [];
309 var e = {func:func, obj:obj ? obj : window};
310 this._events[evt][this._events[evt].length] = e;
314 * Removes a specific event listener
316 * @param {String} Event name
317 * @param {Int} Listener ID to remove
319 removeEventListener: function(evt, func, obj)
321 if (typeof obj == 'undefined')
324 for (var h,i=0; this._events && this._events[evt] && i < this._events[evt].length; i++)
325 if ((h = this._events[evt][i]) && h.func == func && h.obj == obj)
326 this._events[evt][i] = null;
330 * This will execute all registered event handlers
332 * @param {String} Event to trigger
333 * @param {Object} Event object/arguments
335 triggerEvent: function(evt, e)
338 if (typeof e == 'undefined')
340 else if (typeof e == 'object')
343 if (this._events && this._events[evt] && !this._event_exec) {
344 this._event_exec = true;
345 for (var i=0; i < this._events[evt].length; i++) {
346 if ((h = this._events[evt][i])) {
347 if (typeof h.func == 'function')
348 ret = h.func.call ? h.func.call(h.obj, e) : h.func(e);
349 else if (typeof h.obj[h.func] == 'function')
350 ret = h.obj[h.func](e);
352 // cancel event execution
353 if (typeof ret != 'undefined' && !ret)
359 this._event_exec = false;
363 }; // end rcube_event_engine.prototype
368 * Roundcube generic layer (floating box) class
372 function rcube_layer(id, attributes)
376 // create a new layer in the current document
377 this.create = function(arg)
379 var l = (arg.x) ? arg.x : 0,
380 t = (arg.y) ? arg.y : 0,
386 obj = document.createElement('DIV');
391 position = 'absolute';
392 visibility = (vis) ? (vis==2) ? 'inherit' : 'visible' : 'hidden';
396 width = w.toString().match(/\%$/) ? w : w+'px';
398 height = h.toString().match(/\%$/) ? h : h+'px';
405 parent.appendChild(obj);
407 document.body.appendChild(obj);
413 if (attributes != null) {
414 this.create(attributes);
415 this.name = this.elm.id;
417 else // just refer to the object
418 this.elm = document.getElementById(id);
424 // ********* layer object properties *********
426 this.css = this.elm.style;
427 this.event = this.elm;
428 this.width = this.elm.offsetWidth;
429 this.height = this.elm.offsetHeight;
430 this.x = parseInt(this.elm.offsetLeft);
431 this.y = parseInt(this.elm.offsetTop);
432 this.visible = (this.css.visibility=='visible' || this.css.visibility=='show' || this.css.visibility=='inherit') ? true : false;
435 // ********* layer object methods *********
437 // move the layer to a specific position
438 this.move = function(x, y)
442 this.css.left = Math.round(this.x)+'px';
443 this.css.top = Math.round(this.y)+'px';
446 // change the layers width and height
447 this.resize = function(w,h)
449 this.css.width = w+'px';
450 this.css.height = h+'px';
455 // show or hide the layer
456 this.show = function(a)
459 this.css.visibility = 'visible';
463 this.css.visibility = 'inherit';
467 this.css.visibility = 'hidden';
468 this.visible = false;
472 // write new content into a Layer
473 this.write = function(cont)
475 this.elm.innerHTML = cont;
481 // check if input is a valid email address
482 // By Cal Henderson <cal@iamcal.com>
483 // http://code.iamcal.com/php/rfc822/
484 function rcube_check_email(input, inline)
486 if (input && window.RegExp) {
487 var qtext = '[^\\x0d\\x22\\x5c\\x80-\\xff]',
488 dtext = '[^\\x0d\\x5b-\\x5d\\x80-\\xff]',
489 atom = '[^\\x00-\\x20\\x22\\x28\\x29\\x2c\\x2e\\x3a-\\x3c\\x3e\\x40\\x5b-\\x5d\\x7f-\\xff]+',
490 quoted_pair = '\\x5c[\\x00-\\x7f]',
491 quoted_string = '\\x22('+qtext+'|'+quoted_pair+')*\\x22',
492 // Use simplified domain matching, because we need to allow Unicode characters here
493 // So, e-mail address should be validated also on server side after idn_to_ascii() use
494 //domain_literal = '\\x5b('+dtext+'|'+quoted_pair+')*\\x5d',
495 //sub_domain = '('+atom+'|'+domain_literal+')',
496 // allow punycode in last domain part for ICANN test domains
497 domain = '([^@\\x2e]+\\x2e)+([a-z]{2,}|xn--[a-z0-9]{2,})',
498 // ICANN e-mail test (http://idn.icann.org/E-mail_test)
500 '\\u0645\\u062b\\u0627\\u0644\\x2e\\u0625\\u062e\\u062a\\u0628\\u0627\\u0631',
501 '\\u4f8b\\u5b50\\x2e\\u6d4b\\u8bd5',
502 '\\u4f8b\\u5b50\\x2e\\u6e2c\\u8a66',
503 '\\u03c0\\u03b1\\u03c1\\u03ac\\u03b4\\u03b5\\u03b9\\u03b3\\u03bc\\u03b1\\x2e\\u03b4\\u03bf\\u03ba\\u03b9\\u03bc\\u03ae',
504 '\\u0909\\u0926\\u093e\\u0939\\u0930\\u0923\\x2e\\u092a\\u0930\\u0940\\u0915\\u094d\\u0937\\u093e',
505 '\\u4f8b\\u3048\\x2e\\u30c6\\u30b9\\u30c8',
506 '\\uc2e4\\ub840\\x2e\\ud14c\\uc2a4\\ud2b8',
507 '\\u0645\\u062b\\u0627\\u0644\\x2e\\u0622\\u0632\\u0645\\u0627\\u06cc\\u0634\u06cc',
508 '\\u043f\\u0440\\u0438\\u043c\\u0435\\u0440\\x2e\\u0438\\u0441\\u043f\\u044b\\u0442\\u0430\\u043d\\u0438\\u0435',
509 '\\u0b89\\u0ba4\\u0bbe\\u0bb0\\u0ba3\\u0bae\\u0bcd\\x2e\\u0baa\\u0bb0\\u0bbf\\u0b9f\\u0bcd\\u0b9a\\u0bc8',
510 '\\u05d1\\u05f2\\u05b7\\u05e9\\u05e4\\u05bc\\u05d9\\u05dc\\x2e\\u05d8\\u05e2\\u05e1\\u05d8'
512 icann_addr = 'mailtest\\x40('+icann_domains.join('|')+')',
513 word = '('+atom+'|'+quoted_string+')',
515 local_part = word+'(\\x2e'+word+')*',
516 addr_spec = '(('+local_part+'\\x40'+domain+')|('+icann_addr+'))',
517 reg1 = inline ? new RegExp('(^|<|'+delim+')'+addr_spec+'($|>|'+delim+')', 'i') : new RegExp('^'+addr_spec+'$', 'i');
519 return reg1.test(input) ? true : false;
526 // recursively copy an object
527 function rcube_clone_object(obj)
531 for (var key in obj) {
532 if (obj[key] && typeof obj[key] == 'object')
533 out[key] = clone_object(obj[key]);
541 // make a string URL safe
542 function urlencode(str)
544 return window.encodeURIComponent ? encodeURIComponent(str) : escape(str);
548 // get any type of html objects by id/name
549 function rcube_find_object(id, d)
554 if(d.getElementsByName && (e = d.getElementsByName(id)))
556 if(!obj && d.getElementById)
557 obj = d.getElementById(id);
561 if(!obj && d.images.length)
564 if (!obj && d.forms.length) {
565 for (f=0; f<d.forms.length; f++) {
566 if(d.forms[f].name == id)
568 else if(d.forms[f].elements[id])
569 obj = d.forms[f].elements[id];
573 if (!obj && d.layers) {
574 if (d.layers[id]) obj = d.layers[id];
575 for (n=0; !obj && n<d.layers.length; n++)
576 obj = rcube_find_object(id, d.layers[n].document);
582 // determine whether the mouse is over the given object or not
583 function rcube_mouse_is_over(ev, obj)
585 var mouse = rcube_event.get_mouse_pos(ev);
586 var pos = $(obj).offset();
588 return ((mouse.x >= pos.left) && (mouse.x < (pos.left + obj.offsetWidth)) &&
589 (mouse.y >= pos.top) && (mouse.y < (pos.top + obj.offsetHeight)));
593 // cookie functions by GoogieSpell
594 function setCookie(name, value, expires, path, domain, secure)
596 var curCookie = name + "=" + escape(value) +
597 (expires ? "; expires=" + expires.toGMTString() : "") +
598 (path ? "; path=" + path : "") +
599 (domain ? "; domain=" + domain : "") +
600 (secure ? "; secure" : "");
601 document.cookie = curCookie;
604 function getCookie(name)
606 var dc = document.cookie;
607 var prefix = name + "=";
608 var begin = dc.indexOf("; " + prefix);
610 begin = dc.indexOf(prefix);
611 if (begin != 0) return null;
615 var end = document.cookie.indexOf(";", begin);
618 return unescape(dc.substring(begin + prefix.length, end));
621 roundcube_browser.prototype.set_cookie = setCookie;
622 roundcube_browser.prototype.get_cookie = getCookie;
624 // tiny replacement for Firebox functionality
625 function rcube_console()
627 this.log = function(msg)
629 var box = rcube_find_object('dbgconsole');
632 if (msg.charAt(msg.length-1)=='\n')
633 msg += '--------------------------------------\n';
635 msg += '\n--------------------------------------\n';
637 // Konqueror doesn't allows to just change value of hidden element
639 box.innerText += msg;
640 box.value = box.innerText;
646 this.reset = function()
648 var box = rcube_find_object('dbgconsole');
650 box.innerText = box.value = '';
654 var bw = new roundcube_browser();
658 console = new rcube_console();
661 // Add escape() method to RegExp object
662 // http://dev.rubyonrails.org/changeset/7271
663 RegExp.escape = function(str)
665 return String(str).replace(/([.*+?^=!:${}()|[\]\/\\])/g, '\\$1');
669 // Make getElementById() case-sensitive on IE
672 document._getElementById = document.getElementById;
673 document.getElementById = function(id)
675 var i = 0, obj = document._getElementById(id);
677 if (obj && obj.id != id)
678 while ((obj = document.all[i]) && obj.id != id)