program/js/common.js

   1 /*
   2  +-----------------------------------------------------------------------+
   3  | RoundCube common js library                                           |
   4  |                                                                       |
   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                                            |
   8  |                                                                       |
   9  +-----------------------------------------------------------------------+
  10  | Author: Thomas Bruederli <roundcube@gmail.com>                        |
  11  +-----------------------------------------------------------------------+
  12
  13  $Id: common.js 2721 2009-07-07 17:23:55Z alec $
  14 */
  15
  16 // Constants
  17 var CONTROL_KEY = 1;
  18 var SHIFT_KEY = 2;
  19 var CONTROL_SHIFT_KEY = 3;
  20
  21
  22 /**
  23  * Default browser check class
  24  * @construcotr
  25  */
  26 function roundcube_browser()
  27   {
  28   this.ver = parseFloat(navigator.appVersion);
  29   this.appver = navigator.appVersion;
  30   this.agent = navigator.userAgent;
  31   this.name = navigator.appName;
  32   this.vendor = navigator.vendor ? navigator.vendor : '';
  33   this.vendver = navigator.vendorSub ? parseFloat(navigator.vendorSub) : 0;
  34   this.product = navigator.product ? navigator.product : '';
  35   this.platform = String(navigator.platform).toLowerCase();
  36   this.lang = (navigator.language) ? navigator.language.substring(0,2) :
  37               (navigator.browserLanguage) ? navigator.browserLanguage.substring(0,2) :
  38               (navigator.systemLanguage) ? navigator.systemLanguage.substring(0,2) : 'en';
  39
  40   this.win = (this.platform.indexOf('win')>=0) ? true : false;
  41   this.mac = (this.platform.indexOf('mac')>=0) ? true : false;
  42   this.linux = (this.platform.indexOf('linux')>=0) ? true : false;
  43   this.unix = (this.platform.indexOf('unix')>=0) ? true : false;
  44
  45   this.dom = document.getElementById ? true : false;
  46   this.dom2 = (document.addEventListener && document.removeEventListener);
  47
  48   this.ie = (document.all) ? true : false;
  49   this.ie4 = (this.ie && !this.dom);
  50   this.ie5 = (this.dom && this.appver.indexOf('MSIE 5')>0);
  51   this.ie6 = (this.dom && this.appver.indexOf('MSIE 6')>0);
  52   this.ie7 = (this.dom && this.appver.indexOf('MSIE 7')>0);
  53
  54   this.mz = (this.dom && this.ver>=5);  // (this.dom && this.product=='Gecko')
  55   this.ns = ((this.ver<5 && this.name=='Netscape') || (this.ver>=5 && this.vendor.indexOf('Netscape')>=0));
  56   this.ns6 = (this.ns && parseInt(this.vendver)==6);  // (this.mz && this.ns) ? true : false;
  57   this.ns7 = (this.ns && parseInt(this.vendver)==7);  // this.agent.indexOf('Netscape/7')>0);
  58   this.safari = (this.agent.toLowerCase().indexOf('safari')>0 || this.agent.toLowerCase().indexOf('applewebkit')>0);
  59   this.konq   = (this.agent.toLowerCase().indexOf('konqueror')>0);
  60
  61   this.opera = (window.opera) ? true : false;
  62
  63   if(this.opera && window.RegExp)
  64     this.vendver = (/opera(\s|\/)([0-9\.]+)/i.test(navigator.userAgent)) ? parseFloat(RegExp.$2) : -1;
  65   else if(!this.vendver && this.safari)
  66     this.vendver = (/(safari|applewebkit)\/([0-9]+)/i.test(this.agent)) ? parseInt(RegExp.$2) : 0;
  67   else if((!this.vendver && this.mz) || this.agent.indexOf('Camino')>0)
  68     this.vendver = (/rv:([0-9\.]+)/.test(this.agent)) ? parseFloat(RegExp.$1) : 0;
  69   else if(this.ie && window.RegExp)
  70     this.vendver = (/msie\s+([0-9\.]+)/i.test(this.agent)) ? parseFloat(RegExp.$1) : 0;
  71   else if(this.konq && window.RegExp)
  72     this.vendver = (/khtml\/([0-9\.]+)/i.test(this.agent)) ? parseFloat(RegExp.$1) : 0;
  73
  74
  75   // get real language out of safari's user agent
  76   if(this.safari && (/;\s+([a-z]{2})-[a-z]{2}\)/i.test(this.agent)))
  77     this.lang = RegExp.$1;
  78
  79   this.dhtml = ((this.ie4 && this.win) || this.ie5 || this.ie6 || this.ns4 || this.mz);
  80   this.vml = (this.win && this.ie && this.dom && !this.opera);
  81   this.pngalpha = (this.mz || (this.opera && this.vendver>=6) || (this.ie && this.mac && this.vendver>=5) ||
  82                    (this.ie && this.win && this.vendver>=5.5) || this.safari);
  83   this.opacity = (this.mz || (this.ie && this.vendver>=5.5 && !this.opera) || (this.safari && this.vendver>=100));
  84   this.cookies = navigator.cookieEnabled;
  85
  86   // test for XMLHTTP support
  87   this.xmlhttp_test = function()
  88     {
  89     var activeX_test = new Function("try{var o=new ActiveXObject('Microsoft.XMLHTTP');return true;}catch(err){return false;}");
  90     this.xmlhttp = (window.XMLHttpRequest || (window.ActiveXObject && activeX_test())) ? true : false;
  91     return this.xmlhttp;
  92     }
  93   }
  94
  95
  96 // static functions for DOM event handling
  97 var rcube_event = {
  98
  99 /**
 100  * returns the event target element
 101  */
 102 get_target: function(e)
 103 {
 104   e = e || window.event;
 105   return e && e.target ? e.target : e.srcElement;
 106 },
 107
 108 /**
 109  * returns the event key code
 110  */
 111 get_keycode: function(e)
 112 {
 113   e = e || window.event;
 114   return e && e.keyCode ? e.keyCode : (e && e.which ? e.which : 0);
 115 },
 116
 117 /**
 118  * returns the event key code
 119  */
 120 get_button: function(e)
 121 {
 122   e = e || window.event;
 123   return e && (typeof e.button != 'undefined') ? e.button : (e && e.which ? e.which : 0);
 124 },
 125
 126 /**
 127  * returns modifier key (constants defined at top of file)
 128  */
 129 get_modifier: function(e)
 130 {
 131   var opcode = 0;
 132   e = e || window.event;
 133
 134   if (bw.mac && e)
 135     {
 136     opcode += (e.metaKey && CONTROL_KEY) + (e.shiftKey && SHIFT_KEY);
 137     return opcode;
 138     }
 139   if (e)
 140     {
 141     opcode += (e.ctrlKey && CONTROL_KEY) + (e.shiftKey && SHIFT_KEY);
 142     return opcode;
 143     }
 144 },
 145
 146 /**
 147  * Return absolute mouse position of an event
 148  */
 149 get_mouse_pos: function(e)
 150 {
 151   if (!e) e = window.event;
 152   var mX = (e.pageX) ? e.pageX : e.clientX;
 153   var mY = (e.pageY) ? e.pageY : e.clientY;
 154
 155   if (document.body && document.all)
 156   {
 157     mX += document.body.scrollLeft;
 158     mY += document.body.scrollTop;
 159   }
 160
 161   if (e._offset) {
 162     mX += e._offset.left;
 163     mY += e._offset.top;
 164   }
 165
 166   return { x:mX, y:mY };
 167 },
 168
 169 /**
 170  * Add an object method as event listener to a certain element
 171  */
 172 add_listener: function(p)
 173 {
 174   if (!p.object || !p.method)  // not enough arguments
 175     return;
 176   if (!p.element)
 177     p.element = document;
 178
 179   if (!p.object._rc_events)
 180     p.object._rc_events = [];
 181
 182   var key = p.event + '*' + p.method;
 183   if (!p.object._rc_events[key])
 184     p.object._rc_events[key] = function(e){ return p.object[p.method](e); };
 185
 186   if (p.element.addEventListener)
 187     p.element.addEventListener(p.event, p.object._rc_events[key], false);
 188   else if (p.element.attachEvent)
 189     {
 190     // IE allows multiple events with the same function to be applied to the same object
 191     // forcibly detach the event, then attach
 192     p.element.detachEvent('on'+p.event, p.object._rc_events[key]);
 193     p.element.attachEvent('on'+p.event, p.object._rc_events[key]);
 194     }
 195   else
 196     p.element['on'+p.event] = p.object._rc_events[key];
 197 },
 198
 199 /**
 200  * Remove event listener
 201  */
 202 remove_listener: function(p)
 203 {
 204   if (!p.element)
 205     p.element = document;
 206
 207   var key = p.event + '*' + p.method;
 208   if (p.object && p.object._rc_events && p.object._rc_events[key]) {
 209     if (p.element.removeEventListener)
 210       p.element.removeEventListener(p.event, p.object._rc_events[key], false);
 211     else if (p.element.detachEvent)
 212       p.element.detachEvent('on'+p.event, p.object._rc_events[key]);
 213     else
 214       p.element['on'+p.event] = null;
 215   }
 216 },
 217
 218 /**
 219  * Prevent event propagation and bubbeling
 220  */
 221 cancel: function(evt)
 222 {
 223   var e = evt ? evt : window.event;
 224   if (e.preventDefault)
 225     e.preventDefault();
 226   if (e.stopPropagation)
 227     e.stopPropagation();
 228
 229   e.cancelBubble = true;
 230   e.returnValue = false;
 231   return false;
 232 }
 233
 234 };
 235
 236
 237 /**
 238  * rcmail objects event interface
 239  */
 240 function rcube_event_engine()
 241 {
 242   this._events = {};
 243 }
 244
 245 rcube_event_engine.prototype = {
 246
 247 /**
 248  * Setter for object event handlers
 249  *
 250  * @param {String}   Event name
 251  * @param {Function} Handler function
 252  * @return Listener ID (used to remove this handler later on)
 253  */
 254 addEventListener: function(evt, func, obj)
 255 {
 256   if (!this._events)
 257     this._events = {};
 258   if (!this._events[evt])
 259     this._events[evt] = [];
 260
 261   var e = {func:func, obj:obj ? obj : window};
 262   this._events[evt][this._events[evt].length] = e;
 263 },
 264
 265 /**
 266  * Removes a specific event listener
 267  *
 268  * @param {String} Event name
 269  * @param {Int}    Listener ID to remove
 270  */
 271 removeEventListener: function(evt, func, obj)
 272 {
 273   if (typeof obj == 'undefined')
 274     obj = window;
 275
 276   for (var h,i=0; this._events && this._events[evt] && i < this._events[evt].length; i++)
 277     if ((h = this._events[evt][i]) && h.func == func && h.obj == obj)
 278       this._events[evt][i] = null;
 279 },
 280
 281 /**
 282  * This will execute all registered event handlers
 283  *
 284  * @param {String} Event to trigger
 285  * @param {Object} Event object/arguments
 286  */
 287 triggerEvent: function(evt, e)
 288 {
 289   var ret, h;
 290   if (typeof e == 'undefined')
 291     e = this;
 292   else if (typeof e == 'object')
 293     e.event = evt;
 294
 295   if (this._events && this._events[evt] && !this._event_exec) {
 296     this._event_exec = true;
 297     for (var i=0; i < this._events[evt].length; i++) {
 298       if ((h = this._events[evt][i])) {
 299         if (typeof h.func == 'function')
 300           ret = h.func.call ? h.func.call(h.obj, e) : h.func(e);
 301         else if (typeof h.obj[h.func] == 'function')
 302           ret = h.obj[h.func](e);
 303
 304         // cancel event execution
 305         if (typeof ret != 'undefined' && !ret)
 306           break;
 307       }
 308     }
 309   }
 310
 311   this._event_exec = false;
 312   return ret;
 313 }
 314
 315 }  // end rcube_event_engine.prototype
 316
 317
 318
 319 /**
 320  * RoundCube generic layer (floating box) class
 321  *
 322  * @constructor
 323  */
 324 function rcube_layer(id, attributes)
 325 {
 326   this.name = id;
 327
 328   // create a new layer in the current document
 329   this.create = function(arg)
 330     {
 331     var l = (arg.x) ? arg.x : 0;
 332     var t = (arg.y) ? arg.y : 0;
 333     var w = arg.width;
 334     var h = arg.height;
 335     var z = arg.zindex;
 336     var vis = arg.vis;
 337     var parent = arg.parent;
 338     var obj;
 339
 340     obj = document.createElement('DIV');
 341
 342     with(obj)
 343       {
 344       id = this.name;
 345       with(style)
 346         {
 347         position = 'absolute';
 348         visibility = (vis) ? (vis==2) ? 'inherit' : 'visible' : 'hidden';
 349         left = l+'px';
 350         top = t+'px';
 351         if (w)
 352           width = w.toString().match(/\%$/) ? w : w+'px';
 353         if (h)
 354           height = h.toString().match(/\%$/) ? h : h+'px';
 355         if(z) zIndex = z;
 356         }
 357       }
 358
 359     if (parent)
 360       parent.appendChild(obj);
 361     else
 362       document.body.appendChild(obj);
 363
 364     this.elm = obj;
 365     };
 366
 367
 368   // create new layer
 369   if(attributes!=null)
 370     {
 371     this.create(attributes);
 372     this.name = this.elm.id;
 373     }
 374   else  // just refer to the object
 375     this.elm = document.getElementById(id);
 376
 377
 378   if(!this.elm)
 379     return false;
 380
 381
 382   // ********* layer object properties *********
 383
 384   this.css = this.elm.style;
 385   this.event = this.elm;
 386   this.width = this.elm.offsetWidth;
 387   this.height = this.elm.offsetHeight;
 388   this.x = parseInt(this.elm.offsetLeft);
 389   this.y = parseInt(this.elm.offsetTop);
 390   this.visible = (this.css.visibility=='visible' || this.css.visibility=='show' || this.css.visibility=='inherit') ? true : false;
 391
 392
 393   // ********* layer object methods *********
 394
 395
 396   // move the layer to a specific position
 397   this.move = function(x, y)
 398     {
 399     this.x = x;
 400     this.y = y;
 401     this.css.left = Math.round(this.x)+'px';
 402     this.css.top = Math.round(this.y)+'px';
 403     }
 404
 405   // change the layers width and height
 406   this.resize = function(w,h)
 407     {
 408     this.css.width  = w+'px';
 409     this.css.height = h+'px';
 410     this.width = w;
 411     this.height = h;
 412     }
 413
 414
 415   // show or hide the layer
 416   this.show = function(a)
 417     {
 418     if(a==1)
 419       {
 420       this.css.visibility = 'visible';
 421       this.visible = true;
 422       }
 423     else if(a==2)
 424       {
 425       this.css.visibility = 'inherit';
 426       this.visible = true;
 427       }
 428     else
 429       {
 430       this.css.visibility = 'hidden';
 431       this.visible = false;
 432       }
 433     }
 434
 435
 436   // write new content into a Layer
 437   this.write = function(cont)
 438     {
 439     this.elm.innerHTML = cont;
 440     }
 441
 442 }
 443
 444
 445 // check if input is a valid email address
 446 // By Cal Henderson <cal@iamcal.com>
 447 // http://code.iamcal.com/php/rfc822/
 448 function rcube_check_email(input, inline)
 449   {
 450   if (input && window.RegExp)
 451     {
 452     var qtext = '[^\\x0d\\x22\\x5c\\x80-\\xff]';
 453     var dtext = '[^\\x0d\\x5b-\\x5d\\x80-\\xff]';
 454     var atom = '[^\\x00-\\x20\\x22\\x28\\x29\\x2c\\x2e\\x3a-\\x3c\\x3e\\x40\\x5b-\\x5d\\x7f-\\xff]+';
 455     var quoted_pair = '\\x5c[\\x00-\\x7f]';
 456     var domain_literal = '\\x5b('+dtext+'|'+quoted_pair+')*\\x5d';
 457     var quoted_string = '\\x22('+qtext+'|'+quoted_pair+')*\\x22';
 458     var sub_domain = '('+atom+'|'+domain_literal+')';
 459     var word = '('+atom+'|'+quoted_string+')';
 460     var domain = sub_domain+'(\\x2e'+sub_domain+')*';
 461     var local_part = word+'(\\x2e'+word+')*';
 462     var addr_spec = local_part+'\\x40'+domain;
 463     var delim = '[,;\s\n]';
 464     var reg1 = inline ? new RegExp('(^|<|'+delim+')'+addr_spec+'($|>|'+delim+')', 'i') : new RegExp('^'+addr_spec+'$', 'i');
 465     return reg1.test(input) ? true : false;
 466     }
 467   return false;
 468   }
 469
 470
 471 // find a value in a specific array and returns the index
 472 function find_in_array()
 473   {
 474   var args = find_in_array.arguments;
 475   if(!args.length) return -1;
 476
 477   var haystack = typeof(args[0])=='object' ? args[0] : args.length>1 && typeof(args[1])=='object' ? args[1] : new Array();
 478   var needle = typeof(args[0])!='object' ? args[0] : args.length>1 && typeof(args[1])!='object' ? args[1] : '';
 479   var nocase = args.length==3 ? args[2] : false;
 480
 481   if(!haystack.length) return -1;
 482
 483   for(var i=0; i<haystack.length; i++)
 484     if(nocase && haystack[i].toLowerCase()==needle.toLowerCase())
 485       return i;
 486     else if(haystack[i]==needle)
 487       return i;
 488
 489   return -1;
 490   }
 491
 492
 493 // make a string URL safe
 494 function urlencode(str)
 495 {
 496   return window.encodeURIComponent ? encodeURIComponent(str) : escape(str);
 497 }
 498
 499
 500 // get any type of html objects by id/name
 501 function rcube_find_object(id, d)
 502 {
 503   var n, f, obj, e;
 504   if(!d) d = document;
 505
 506   if(d.getElementsByName && (e = d.getElementsByName(id)))
 507     obj = e[0];
 508   if(!obj && d.getElementById)
 509     obj = d.getElementById(id);
 510   if(!obj && d.all)
 511     obj = d.all[id];
 512
 513   if(!obj && d.images.length)
 514     obj = d.images[id];
 515
 516   if (!obj && d.forms.length) {
 517     for (f=0; f<d.forms.length; f++) {
 518       if(d.forms[f].name == id)
 519         obj = d.forms[f];
 520       else if(d.forms[f].elements[id])
 521         obj = d.forms[f].elements[id];
 522     }
 523   }
 524
 525   if (!obj && d.layers) {
 526     if (d.layers[id]) obj = d.layers[id];
 527     for (n=0; !obj && n<d.layers.length; n++)
 528       obj = rcube_find_object(id, d.layers[n].document);
 529   }
 530
 531   return obj;
 532 }
 533
 534 // determine whether the mouse is over the given object or not
 535 function rcube_mouse_is_over(ev, obj)
 536 {
 537   var mouse = rcube_event.get_mouse_pos(ev);
 538   var pos = $(obj).offset();
 539
 540   return ((mouse.x >= pos.left) && (mouse.x < (pos.left + obj.offsetWidth)) &&
 541     (mouse.y >= pos.top) && (mouse.y < (pos.top + obj.offsetHeight)));
 542 }
 543
 544
 545 // cookie functions by GoogieSpell
 546 function setCookie(name, value, expires, path, domain, secure)
 547   {
 548   var curCookie = name + "=" + escape(value) +
 549       (expires ? "; expires=" + expires.toGMTString() : "") +
 550       (path ? "; path=" + path : "") +
 551       (domain ? "; domain=" + domain : "") +
 552       (secure ? "; secure" : "");
 553   document.cookie = curCookie;
 554   }
 555
 556 roundcube_browser.prototype.set_cookie = setCookie;
 557
 558 function getCookie(name)
 559   {
 560   var dc = document.cookie;
 561   var prefix = name + "=";
 562   var begin = dc.indexOf("; " + prefix);
 563   if (begin == -1)
 564     {
 565     begin = dc.indexOf(prefix);
 566     if (begin != 0) return null;
 567     }
 568   else
 569     begin += 2;
 570   var end = document.cookie.indexOf(";", begin);
 571   if (end == -1)
 572     end = dc.length;
 573   return unescape(dc.substring(begin + prefix.length, end));
 574   }
 575
 576 roundcube_browser.prototype.get_cookie = getCookie;
 577
 578 // tiny replacement for Firebox functionality
 579 function rcube_console()
 580 {
 581   this.log = function(msg)
 582   {
 583     var box = rcube_find_object('dbgconsole');
 584
 585     if (box) {
 586       if (msg.charAt(msg.length-1)=='\n')
 587         msg += '--------------------------------------\n';
 588       else
 589         msg += '\n--------------------------------------\n';
 590
 591       // Konqueror doesn't allows to just change value of hidden element
 592       if (bw.konq) {
 593         box.innerText += msg;
 594         box.value = box.innerText;
 595       } else
 596         box.value += msg;
 597     }
 598   };
 599
 600   this.reset = function()
 601   {
 602     var box = rcube_find_object('dbgconsole');
 603     if (box)
 604       box.innerText = box.value = '';
 605   };
 606 }
 607
 608 var bw = new roundcube_browser();
 609 if (!window.console)
 610   console = new rcube_console();
 611
 612
 613 // Add escape() method to RegExp object
 614 // http://dev.rubyonrails.org/changeset/7271
 615 RegExp.escape = function(str)
 616   {
 617   return String(str).replace(/([.*+?^=!:${}()|[\]\/\\])/g, '\\$1');
 618   }
 619
 620
 621 // Make getElementById() case-sensitive on IE
 622 if (bw.ie)
 623   {
 624   document._getElementById = document.getElementById;
 625   document.getElementById = function(id)
 626     {
 627     var i = 0;
 628     var o = document._getElementById(id);
 629
 630     if (!o || o.id != id)
 631       while ((o = document.all[i]) && o.id != id)
 632         i++;
 633
 634     return o;
 635     }
 636   }