js/common.js

   1 /* vim: set expandtab sw=4 ts=4 sts=4: */
   2 /**
   3  * common functions used for communicating between main, navigation and querywindow
   4  *
   5  * @version $Id$
   6  */
   7
   8 /**
   9  * holds the browser query window
  10  */
  11 var querywindow = '';
  12
  13 /**
  14  * holds the query to be load from a new query window
  15  */
  16 var query_to_load = '';
  17
  18 /**
  19  * attach a function to object event
  20  *
  21  * <code>
  22  * addEvent(window, 'load', PMA_initPage);
  23  * </code>
  24  * @param object or id
  25  * @param string event type (load, mouseover, focus, ...)
  26  * @param function to be attached
  27  */
  28 function addEvent(obj, type, fn)
  29 {
  30     if (obj.attachEvent) {
  31         obj['e' + type + fn] = fn;
  32         obj[type + fn] = function() {obj['e' + type + fn](window.event);}
  33         obj.attachEvent('on' + type, obj[type + fn]);
  34     } else {
  35         obj.addEventListener(type, fn, false);
  36     }
  37 }
  38
  39 /**
  40  * detach/remove a function from an object event
  41  *
  42  * @param object or id
  43  * @param event type (load, mouseover, focus, ...)
  44  * @param function naem of function to be attached
  45  */
  46 function removeEvent(obj, type, fn)
  47 {
  48     if (obj.detachEvent) {
  49         obj.detachEvent('on' + type, obj[type + fn]);
  50         obj[type + fn] = null;
  51     } else {
  52         obj.removeEventListener(type, fn, false);
  53     }
  54 }
  55
  56 /**
  57  * get DOM elements by html class
  58  *
  59  * @param string class_name - name of class
  60  * @param node node - search only sub nodes of this node (optional)
  61  * @param string tag - search only these tags (optional)
  62  */
  63 function getElementsByClassName(class_name, node, tag)
  64 {
  65     var classElements = new Array();
  66
  67     if (node == null) {
  68         node = document;
  69     }
  70     if (tag == null) {
  71         tag = '*';
  72     }
  73
  74     var j = 0, teststr;
  75     var els = node.getElementsByTagName(tag);
  76     var elsLen = els.length;
  77
  78     for (i = 0; i < elsLen; i++) {
  79         if (els[i].className.indexOf(class_name) != -1) {
  80             teststr = "," + els[i].className.split(" ").join(",") + ",";
  81             if (teststr.indexOf("," + class_name + ",") != -1) {
  82                 classElements[j] = els[i];
  83                 j++;
  84             }
  85         }
  86     }
  87     return classElements;
  88 }
  89
  90 /**
  91  * sets current selected db
  92  *
  93  * @param    string    db name
  94  */
  95 function setDb(new_db) {
  96     //alert('setDb(' + new_db + ')');
  97     if (new_db != db) {
  98         // db has changed
  99         //alert( new_db + '(' + new_db.length + ') : ' + db );
 100
 101         var old_db = db;
 102         db = new_db;
 103
 104         if (window.frame_navigation.document.getElementById(db) == null) {
 105             // db is unknown, reload complete left frame
 106             refreshNavigation();
 107         } else {
 108             unmarkDbTable(old_db);
 109             markDbTable(db);
 110         }
 111
 112         // TODO: add code to expand db in lightview mode
 113
 114         // refresh querywindow
 115         refreshQuerywindow();
 116     }
 117 }
 118
 119 /**
 120  * sets current selected table (called from navigation.php)
 121  *
 122  * @param    string    table name
 123  */
 124 function setTable(new_table) {
 125     //alert('setTable(' + new_table + ')');
 126     if (new_table != table) {
 127         // table has changed
 128         //alert( new_table + '(' + new_table.length + ') : ' + table );
 129
 130         table = new_table;
 131
 132         if (window.frame_navigation.document.getElementById(db + '.' + table) == null
 133          && table != '') {
 134             // table is unknown, reload complete left frame
 135             refreshNavigation();
 136
 137         }
 138         // TODO: add code to expand table in lightview mode
 139
 140         // refresh querywindow
 141         refreshQuerywindow();
 142     }
 143 }
 144
 145 /**
 146  * reloads main frame
 147  *
 148  * @uses     goTo()
 149  * @uses     opendb_url
 150  * @uses     token
 151  * @uses     db
 152  * @uses     server
 153  * @uses     table
 154  * @uses     lang
 155  * @uses    collation_connection
 156  * @uses    encodeURIComponent()
 157  * @param    string    url    name of page to be loaded
 158  */
 159 function refreshMain(url) {
 160     if (! url) {
 161         if (db) {
 162             url = opendb_url;
 163         } else {
 164             url = 'main.php';
 165         }
 166     }
 167     //alert(db);
 168     goTo(url + '?server=' + encodeURIComponent(server) +
 169         '&token=' + encodeURIComponent(token) +
 170         '&db=' + encodeURIComponent(db) +
 171         '&table=' + encodeURIComponent(table) +
 172         '&lang=' + encodeURIComponent(lang) +
 173         '&collation_connection=' + encodeURIComponent(collation_connection),
 174         'main');
 175 }
 176
 177 /**
 178  * reloads navigation frame
 179  *
 180  * @uses     goTo()
 181  * @uses     token
 182  * @uses     db
 183  * @uses     server
 184  * @uses     table
 185  * @uses     lang
 186  * @uses    collation_connection
 187  * @uses    encodeURIComponent()
 188  */
 189 function refreshNavigation() {
 190     goTo('navigation.php?server=' + encodeURIComponent(server) +
 191         '&token=' + encodeURIComponent(token)  +
 192         '&db=' + encodeURIComponent(db)  +
 193         '&table=' + encodeURIComponent(table) +
 194         '&lang=' + encodeURIComponent(lang) +
 195         '&collation_connection=' + encodeURIComponent(collation_connection)
 196         );
 197 }
 198
 199 /**
 200  * adds class to element
 201  */
 202 function addClass(element, classname)
 203 {
 204     if (element != null) {
 205         element.className += ' ' + classname;
 206         //alert('set class: ' + classname + ', now: ' + element.className);
 207     }
 208 }
 209
 210 /**
 211  * removes class from element
 212  */
 213 function removeClass(element, classname)
 214 {
 215     if (element != null) {
 216         element.className = element.className.replace(' ' + classname, '');
 217         // if there is no other class anem there is no leading space
 218         element.className = element.className.replace(classname, '');
 219         //alert('removed class: ' + classname + ', now: ' + element.className);
 220     }
 221 }
 222
 223 function unmarkDbTable(db, table)
 224 {
 225     var element_reference = window.frame_navigation.document.getElementById(db);
 226     if (element_reference != null) {
 227         //alert('remove from: ' + db);
 228         removeClass(element_reference.parentNode, 'marked');
 229     }
 230
 231     element_reference = window.frame_navigation.document.getElementById(db + '.' + table);
 232     if (element_reference != null) {
 233         //alert('remove from: ' + db + '.' + table);
 234         removeClass(element_reference.parentNode, 'marked');
 235     }
 236 }
 237
 238 function markDbTable(db, table)
 239 {
 240     var element_reference = window.frame_navigation.document.getElementById(db);
 241     if (element_reference != null) {
 242         addClass(element_reference.parentNode, 'marked');
 243         // scrolldown
 244         element_reference.focus();
 245         // opera marks the text, we dont want this ...
 246         element_reference.blur();
 247     }
 248
 249     element_reference = window.frame_navigation.document.getElementById(db + '.' + table);
 250     if (element_reference != null) {
 251         addClass(element_reference.parentNode, 'marked');
 252         // scrolldown
 253         element_reference.focus();
 254         // opera marks the text, we dont want this ...
 255         element_reference.blur();
 256     }
 257
 258     // return to main frame ...
 259     window.frame_content.focus();
 260 }
 261
 262 /**
 263  * sets current selected server, table and db (called from libraries/footer.inc.php)
 264  */
 265 function setAll( new_lang, new_collation_connection, new_server, new_db, new_table, new_token ) {
 266     //alert('setAll( ' + new_lang + ', ' + new_collation_connection + ', ' + new_server + ', ' + new_db + ', ' + new_table + ', ' + new_token + ' )');
 267     if (new_server != server || new_lang != lang
 268       || new_collation_connection != collation_connection) {
 269         // something important has changed
 270         server = new_server;
 271         db     = new_db;
 272         table  = new_table;
 273         collation_connection  = new_collation_connection;
 274         lang  = new_lang;
 275         token  = new_token;
 276         refreshNavigation();
 277     } else if (new_db != db || new_table != table) {
 278         // save new db and table
 279         var old_db    = db;
 280         var old_table = table;
 281         db        = new_db;
 282         table     = new_table;
 283
 284         if (window.frame_navigation.document.getElementById(db) == null
 285           && window.frame_navigation.document.getElementById(db + '.' + table) == null ) {
 286             // table or db is unknown, reload complete left frame
 287             refreshNavigation();
 288         } else {
 289             unmarkDbTable(old_db, old_table);
 290             markDbTable(db, table);
 291         }
 292
 293         // TODO: add code to expand db in lightview mode
 294
 295         // refresh querywindow
 296         refreshQuerywindow();
 297     }
 298 }
 299
 300 function reload_querywindow(db, table, sql_query)
 301 {
 302     if ( ! querywindow.closed && querywindow.location ) {
 303         if ( ! querywindow.document.sqlform.LockFromUpdate
 304           || ! querywindow.document.sqlform.LockFromUpdate.checked ) {
 305             querywindow.document.getElementById('hiddenqueryform').db.value = db;
 306             querywindow.document.getElementById('hiddenqueryform').table.value = table;
 307
 308             if (sql_query) {
 309                 querywindow.document.getElementById('hiddenqueryform').sql_query.value = sql_query;
 310             }
 311
 312             querywindow.document.getElementById('hiddenqueryform').submit();
 313         }
 314     }
 315 }
 316
 317 /**
 318  * brings query window to front and inserts query to be edited
 319  */
 320 function focus_querywindow(sql_query)
 321 {
 322     /* if ( querywindow && !querywindow.closed && querywindow.location) { */
 323     if ( !querywindow || querywindow.closed || !querywindow.location) {
 324         // we need first to open the window and cannot pass the query with it
 325         // as we dont know if the query exceeds max url length
 326         /* url = 'querywindow.php?' + common_query + '&db=' + db + '&table=' + table + '&sql_query=SELECT * FROM'; */
 327         query_to_load = sql_query;
 328         open_querywindow();
 329         insertQuery(0);
 330     } else {
 331         //var querywindow = querywindow;
 332         if ( querywindow.document.getElementById('hiddenqueryform').querydisplay_tab != 'sql' ) {
 333             querywindow.document.getElementById('hiddenqueryform').querydisplay_tab.value = "sql";
 334             querywindow.document.getElementById('hiddenqueryform').sql_query.value = sql_query;
 335             querywindow.document.getElementById('hiddenqueryform').submit();
 336             querywindow.focus();
 337         } else {
 338             querywindow.focus();
 339         }
 340     }
 341     return true;
 342 }
 343
 344 /**
 345  * inserts query string into query window textarea
 346  * called from script tag in querywindow
 347  */
 348 function insertQuery() {
 349     if (query_to_load != '' && querywindow.document && querywindow.document.getElementById && querywindow.document.getElementById('sqlquery')) {
 350         querywindow.document.getElementById('sqlquery').value = query_to_load;
 351         query_to_load = '';
 352         return true;
 353     }
 354     return false;
 355 }
 356
 357 function open_querywindow( url ) {
 358     if ( ! url ) {
 359         url = 'querywindow.php?' + common_query + '&db=' + encodeURIComponent(db) + '&table=' + encodeURIComponent(table);
 360     }
 361
 362     if (!querywindow.closed && querywindow.location) {
 363         goTo( url, 'query' );
 364         querywindow.focus();
 365     } else {
 366         querywindow = window.open( url + '&init=1', '',
 367             'toolbar=0,location=0,directories=0,status=1,menubar=0,' +
 368             'scrollbars=yes,resizable=yes,' +
 369             'width=' + querywindow_width + ',' +
 370             'height=' + querywindow_height );
 371     }
 372
 373     if ( ! querywindow.opener ) {
 374        querywindow.opener = window.window;
 375     }
 376
 377     if ( window.focus ) {
 378         querywindow.focus();
 379     }
 380
 381     return true;
 382 }
 383
 384 function refreshQuerywindow( url ) {
 385
 386     if ( ! querywindow.closed && querywindow.location ) {
 387         if ( ! querywindow.document.sqlform.LockFromUpdate
 388           || ! querywindow.document.sqlform.LockFromUpdate.checked ) {
 389             open_querywindow( url )
 390         }
 391     }
 392 }
 393
 394 /**
 395  * opens new url in target frame, with default being left frame
 396  * valid is 'main' and 'querywindow' all others leads to 'left'
 397  *
 398  * @param    string    targeturl    new url to load
 399  * @param    string    target       frame where to load the new url
 400  */
 401 function goTo(targeturl, target) {
 402     //alert(targeturl);
 403     if ( target == 'main' ) {
 404         target = window.frame_content;
 405     } else if ( target == 'query' ) {
 406         target = querywindow;
 407         //return open_querywindow( targeturl );
 408     } else if ( ! target ) {
 409         target = window.frame_navigation;
 410     }
 411
 412     if ( target ) {
 413         if ( target.location.href == targeturl ) {
 414             return true;
 415         } else if ( target.location.href == pma_absolute_uri + targeturl ) {
 416             return true;
 417         }
 418
 419         if ( safari_browser ) {
 420             target.location.href = targeturl;
 421         } else {
 422             target.location.replace(targeturl);
 423         }
 424     }
 425
 426     return true;
 427 }
 428
 429 // opens selected db in main frame
 430 function openDb(new_db) {
 431     //alert('opendb(' +  new_db + ')');
 432     setDb(new_db);
 433     setTable('');
 434     refreshMain(opendb_url);
 435     return true;
 436 }
 437
 438 function updateTableTitle( table_link_id, new_title ) {
 439     //alert('updateTableTitle');
 440     if ( window.parent.frame_navigation.document && window.parent.frame_navigation.document.getElementById(table_link_id) ) {
 441         var left = window.parent.frame_navigation.document;
 442
 443         var link = left.getElementById(table_link_id);
 444         link.title = window.parent.pma_text_default_tab + ': ' + new_title;
 445
 446         var link = left.getElementById('quick_' + table_link_id);
 447         link.title = window.parent.pma_text_left_default_tab + ': ' + new_title;
 448
 449         return true;
 450     }
 451
 452     return false;
 453 }