js/tbl_structure.js

   1 /* vim: set expandtab sw=4 ts=4 sts=4: */
   2 /**
   3  * @fileoverview    functions used on the table structure page
   4  * @name            Table Structure
   5  *
   6  * @requires    jQuery
   7  * @requires    jQueryUI
   8  * @required    js/functions.js
   9  */
  10
  11 /**
  12  * AJAX scripts for tbl_structure.php
  13  *
  14  * Actions ajaxified here:
  15  * Drop Column
  16  * Add Primary Key
  17  * Drop Primary Key/Index
  18  *
  19  */
  20
  21 /**
  22  * This function returns the horizontal space available for the menu in pixels.
  23  * To calculate this value we start we the width of the main panel, then we
  24  * substract the margin of the page content, then we substract any cellspacing
  25  * that the table may have (original theme only) and finally we substract the
  26  * width of all columns of the table except for the last one (which is where
  27  * the menu will go). What we should end up with is the distance between the
  28  * start of the last column on the table and the edge of the page, again this
  29  * is the space available for the menu.
  30  *
  31  * In the case where the table cell where the menu will be displayed is already
  32  * off-screen (the table is wider than the page), a negative value will be returned,
  33  * but this will be treated as a zero by the menuResizer plugin.
  34  *
  35  * @return int
  36  */
  37 function PMA_tbl_structure_menu_resizer_callback() {
  38     var pagewidth = $('body').width();
  39     var $page = $('#page_content');
  40     pagewidth -= $page.outerWidth(true) - $page.outerWidth();
  41     var columnsWidth = 0;
  42     var $columns = $('#tablestructure').find('tr:eq(1)').find('td,th');
  43     $columns.not(':last').each(function () {
  44         columnsWidth += $(this).outerWidth(true);
  45     });
  46     var totalCellSpacing = $('#tablestructure').width();
  47     $columns.each(function () {
  48         totalCellSpacing -= $(this).outerWidth(true);
  49     });
  50     return pagewidth - columnsWidth - totalCellSpacing - 15; // 15px extra margin
  51 }
  52
  53 /**
  54  * Reload fields table
  55  */
  56 function reloadFieldForm() {
  57     $.post($("#fieldsForm").attr('action'), $("#fieldsForm").serialize() + "&ajax_request=true", function (form_data) {
  58         var $temp_div = $("<div id='temp_div'><div>").append(form_data.message);
  59         $("#fieldsForm").replaceWith($temp_div.find("#fieldsForm"));
  60         $("#addColumns").replaceWith($temp_div.find("#addColumns"));
  61         $('#move_columns_dialog').find('ul').replaceWith($temp_div.find("#move_columns_dialog ul"));
  62         $("#moveColumns").removeClass("move-active");
  63         /* reinitialise the more options in table */
  64         if ($('#fieldsForm').hasClass('HideStructureActions')) {
  65             $('#fieldsForm').find('ul.table-structure-actions').menuResizer(PMA_tbl_structure_menu_resizer_callback);
  66         }
  67     });
  68     $('#page_content').show();
  69 }
  70
  71 function checkFirst() {
  72     if ($("select[name=after_field] option:selected").data('pos') === 'first') {
  73         $("input[name=field_where]").val('first');
  74     } else {
  75         $("input[name=field_where]").val('after');
  76     }
  77 }
  78 /**
  79  * Unbind all event handlers before tearing down a page
  80  */
  81 AJAX.registerTeardown('tbl_structure.js', function () {
  82     $(document).off('click', "a.drop_column_anchor.ajax");
  83     $(document).off('click', "a.add_key.ajax");
  84     $(document).off('click', "#move_columns_anchor");
  85     $(document).off('click', "#printView");
  86     $(document).off('submit', ".append_fields_form.ajax");
  87     $('body').off('click', '#fieldsForm.ajax button[name="submit_mult"], #fieldsForm.ajax input[name="submit_mult"]');
  88     $(document).off('click', 'a[name^=partition_action].ajax');
  89     $(document).off('click', '#remove_partitioning.ajax');
  90 });
  91
  92 AJAX.registerOnload('tbl_structure.js', function () {
  93
  94     // Re-initialize variables.
  95     primary_indexes = [];
  96     indexes = [];
  97     fulltext_indexes = [];
  98     spatial_indexes = [];
  99
 100     /**
 101      *Ajax action for submitting the "Column Change" and "Add Column" form
 102      */
 103     $(".append_fields_form.ajax").off();
 104     $(document).on('submit', ".append_fields_form.ajax", function (event) {
 105         event.preventDefault();
 106         /**
 107          * @var    the_form    object referring to the export form
 108          */
 109         var $form = $(this);
 110         var field_cnt = $form.find('input[name=orig_num_fields]').val();
 111
 112
 113         function submitForm(){
 114             $msg = PMA_ajaxShowMessage(PMA_messages.strProcessingRequest);
 115             $.post($form.attr('action'), $form.serialize() + '&do_save_data=1', function (data) {
 116                 if ($(".sqlqueryresults").length !== 0) {
 117                     $(".sqlqueryresults").remove();
 118                 } else if ($(".error:not(.tab)").length !== 0) {
 119                     $(".error:not(.tab)").remove();
 120                 }
 121                 if (typeof data.success != 'undefined' && data.success === true) {
 122                     $("#page_content")
 123                         .empty()
 124                         .append(data.message)
 125                         .show();
 126                     PMA_highlightSQL($('#page_content'));
 127                     $(".result_query .notice").remove();
 128                     reloadFieldForm();
 129                     $form.remove();
 130                     PMA_ajaxRemoveMessage($msg);
 131                     PMA_init_slider();
 132                     PMA_reloadNavigation();
 133                 } else {
 134                     PMA_ajaxShowMessage(data.error, false);
 135                 }
 136             }); // end $.post()
 137         }
 138
 139         function checkIfConfirmRequired($form, $field_cnt) {
 140             var i = 0, id, elm, val, name_orig, elm_orig, val_orig;
 141             var checkRequired = false;
 142             for (i = 0; i < field_cnt; i++) {
 143                 id = "#field_" + i + "_5";
 144                 elm = $(id);
 145                 val = elm.val();
 146
 147                 name_orig = "input[name=field_collation_orig\\[" + i + "\\]]";
 148                 elm_orig = $form.find(name_orig);
 149                 val_orig = elm_orig.val();
 150
 151                 if (val && val_orig && val !== val_orig){
 152                     checkRequired = true;
 153                     break;
 154                 }
 155             }
 156             return checkRequired;
 157         }
 158
 159         /*
 160          * First validate the form; if there is a problem, avoid submitting it
 161          *
 162          * checkTableEditForm() needs a pure element and not a jQuery object,
 163          * this is why we pass $form[0] as a parameter (the jQuery object
 164          * is actually an array of DOM elements)
 165          */
 166         if (checkTableEditForm($form[0], field_cnt)) {
 167             // OK, form passed validation step
 168
 169             PMA_prepareForAjaxRequest($form);
 170             if (PMA_checkReservedWordColumns($form)) {
 171                 //User wants to submit the form
 172
 173                 // If Collation is changed, Warn and Confirm
 174                 if (checkIfConfirmRequired($form, field_cnt)){
 175                     var question = sprintf(
 176                         PMA_messages.strChangeColumnCollation, 'https://wiki.phpmyadmin.net/pma/Garbled_data'
 177                     );
 178                     $form.PMA_confirm(question, $form.attr('action'), function (url) {
 179                         submitForm();
 180                     });
 181                 } else {
 182                     submitForm();
 183                 }
 184             }
 185         }
 186     }); // end change table button "do_save_data"
 187
 188     /**
 189      * Attach Event Handler for 'Drop Column'
 190      */
 191     $(document).on('click', "a.drop_column_anchor.ajax", function (event) {
 192         event.preventDefault();
 193         /**
 194          * @var curr_table_name String containing the name of the current table
 195          */
 196         var curr_table_name = $(this).closest('form').find('input[name=table]').val();
 197         /**
 198          * @var curr_row    Object reference to the currently selected row (i.e. field in the table)
 199          */
 200         var $curr_row = $(this).parents('tr');
 201         /**
 202          * @var curr_column_name    String containing name of the field referred to by {@link curr_row}
 203          */
 204         var curr_column_name = $curr_row.children('th').children('label').text().trim();
 205         curr_column_name = escapeHtml(curr_column_name);
 206         /**
 207          * @var $after_field_item    Corresponding entry in the 'After' field.
 208          */
 209         var $after_field_item = $("select[name='after_field'] option[value='" + curr_column_name + "']");
 210         /**
 211          * @var question    String containing the question to be asked for confirmation
 212          */
 213         var question = PMA_sprintf(PMA_messages.strDoYouReally, 'ALTER TABLE `' + escapeHtml(curr_table_name) + '` DROP `' + escapeHtml(curr_column_name) + '`;');
 214         $(this).PMA_confirm(question, $(this).attr('href'), function (url) {
 215             var $msg = PMA_ajaxShowMessage(PMA_messages.strDroppingColumn, false);
 216             $.post(url, {'is_js_confirmed' : 1, 'ajax_request' : true, 'ajax_page_request' : true}, function (data) {
 217                 if (typeof data !== 'undefined' && data.success === true) {
 218                     PMA_ajaxRemoveMessage($msg);
 219                     if ($('.result_query').length) {
 220                         $('.result_query').remove();
 221                     }
 222                     if (data.sql_query) {
 223                         $('<div class="result_query"></div>')
 224                             .html(data.sql_query)
 225                             .prependTo('#structure_content');
 226                         PMA_highlightSQL($('#page_content'));
 227                     }
 228                     toggleRowColors($curr_row.next());
 229                     // Adjust the row numbers
 230                     for (var $row = $curr_row.next(); $row.length > 0; $row = $row.next()) {
 231                         var new_val = parseInt($row.find('td:nth-child(2)').text(), 10) - 1;
 232                         $row.find('td:nth-child(2)').text(new_val);
 233                     }
 234                     $after_field_item.remove();
 235                     $curr_row.hide("medium").remove();
 236
 237                     // Remove the dropped column from select menu for 'after field'
 238                     $("select[name=after_field]").find(
 239                         '[value="' + curr_column_name + '"]'
 240                     ).remove();
 241
 242                     // by default select the (new) last option to add new column
 243                     // (in case last column is dropped)
 244                     $("select[name=after_field] option:last").attr("selected","selected");
 245
 246                     //refresh table stats
 247                     if (data.tableStat) {
 248                         $('#tablestatistics').html(data.tableStat);
 249                     }
 250                     // refresh the list of indexes (comes from sql.php)
 251                     $('.index_info').replaceWith(data.indexes_list);
 252                     PMA_reloadNavigation();
 253                 } else {
 254                     PMA_ajaxShowMessage(PMA_messages.strErrorProcessingRequest + " : " + data.error, false);
 255                 }
 256             }); // end $.post()
 257         }); // end $.PMA_confirm()
 258     }); //end of Drop Column Anchor action
 259
 260     /**
 261      * Attach Event Handler for 'Print' link
 262      */
 263     $(document).on('click', "#printView", function (event) {
 264         event.preventDefault();
 265
 266         // Take to preview mode
 267         printPreview();
 268     }); //end of Print View action
 269
 270     /**
 271      * Ajax Event handler for adding keys
 272      */
 273     $(document).on('click', "a.add_key.ajax", function (event) {
 274         event.preventDefault();
 275
 276         var $this = $(this);
 277         var curr_table_name = $this.closest('form').find('input[name=table]').val();
 278         var curr_column_name = $this.parents('tr').children('th').children('label').text().trim();
 279
 280         var add_clause = '';
 281         if ($this.is('.add_primary_key_anchor')) {
 282             add_clause = 'ADD PRIMARY KEY';
 283         } else if ($this.is('.add_index_anchor')) {
 284             add_clause = 'ADD INDEX';
 285         } else if ($this.is('.add_unique_anchor')) {
 286             add_clause = 'ADD UNIQUE';
 287         } else if ($this.is('.add_spatial_anchor')) {
 288             add_clause = 'ADD SPATIAL';
 289         } else if ($this.is('.add_fulltext_anchor')) {
 290             add_clause = 'ADD FULLTEXT';
 291         }
 292         var question = PMA_sprintf(PMA_messages.strDoYouReally, 'ALTER TABLE `' +
 293                 escapeHtml(curr_table_name) + '` ' + add_clause + '(`' + escapeHtml(curr_column_name) + '`);');
 294
 295         $(this).PMA_confirm(question, $(this).attr('href'), function (url) {
 296             PMA_ajaxShowMessage();
 297             AJAX.source = $this;
 298             $.post(url, {'ajax_request' : true, 'ajax_page_request' : true}, AJAX.responseHandler);
 299         }); // end $.PMA_confirm()
 300     }); //end Add key
 301
 302     /**
 303      * Inline move columns
 304     **/
 305     $(document).on('click', "#move_columns_anchor", function (e) {
 306         e.preventDefault();
 307
 308         if ($(this).hasClass("move-active")) {
 309             return;
 310         }
 311
 312         /**
 313          * @var    button_options  Object that stores the options passed to jQueryUI
 314          *                          dialog
 315          */
 316         var button_options = {};
 317
 318         button_options[PMA_messages.strGo] = function (event) {
 319             event.preventDefault();
 320             var $msgbox = PMA_ajaxShowMessage();
 321             var $this = $(this);
 322             var $form = $this.find("form");
 323             var serialized = $form.serialize();
 324
 325             // check if any columns were moved at all
 326             if (serialized == $form.data("serialized-unmoved")) {
 327                 PMA_ajaxRemoveMessage($msgbox);
 328                 $this.dialog('close');
 329                 return;
 330             }
 331
 332             $.post($form.prop("action"), serialized + "&ajax_request=true", function (data) {
 333                 if (data.success === false) {
 334                     PMA_ajaxRemoveMessage($msgbox);
 335                     $this
 336                     .clone()
 337                     .html(data.error)
 338                     .dialog({
 339                         title: $(this).prop("title"),
 340                         height: 230,
 341                         width: 900,
 342                         modal: true,
 343                         buttons: button_options_error
 344                     }); // end dialog options
 345                 } else {
 346                     if ($('#fieldsForm').hasClass('HideStructureActions')) {
 347                         $('#fieldsForm').find('ul.table-structure-actions').menuResizer('destroy');
 348                     }
 349                     // sort the fields table
 350                     var $fields_table = $("table#tablestructure tbody");
 351                     // remove all existing rows and remember them
 352                     var $rows = $fields_table.find("tr").remove();
 353                     // loop through the correct order
 354                     for (var i in data.columns) {
 355                         var the_column = data.columns[i];
 356                         var $the_row = $rows
 357                             .find("input:checkbox[value=" + the_column + "]")
 358                             .closest("tr");
 359                         // append the row for this column to the table
 360                         $fields_table.append($the_row);
 361                     }
 362                     var $firstrow = $fields_table.find("tr").eq(0);
 363                     // Adjust the row numbers and colors
 364                     for (var $row = $firstrow; $row.length > 0; $row = $row.next()) {
 365                         $row
 366                         .find('td:nth-child(2)')
 367                         .text($row.index() + 1)
 368                         .end()
 369                         .removeClass("odd even")
 370                         .addClass($row.index() % 2 === 0 ? "odd" : "even");
 371                     }
 372                     PMA_ajaxShowMessage(data.message);
 373                     $this.dialog('close');
 374                     if ($('#fieldsForm').hasClass('HideStructureActions')) {
 375                         $('#fieldsForm').find('ul.table-structure-actions').menuResizer(PMA_tbl_structure_menu_resizer_callback);
 376                     }
 377                 }
 378             });
 379         };
 380         button_options[PMA_messages.strCancel] = function () {
 381             $(this).dialog('close');
 382         };
 383
 384         var button_options_error = {};
 385         button_options_error[PMA_messages.strOK] = function () {
 386             $(this).dialog('close').remove();
 387         };
 388
 389         var columns = [];
 390
 391         $("#tablestructure").find("tbody tr").each(function () {
 392             var col_name = $(this).find("input:checkbox").eq(0).val();
 393             var hidden_input = $("<input/>")
 394                 .prop({
 395                     name: "move_columns[]",
 396                     type: "hidden"
 397                 })
 398                 .val(col_name);
 399             columns[columns.length] = $("<li/>")
 400                 .addClass("placeholderDrag")
 401                 .text(col_name)
 402                 .append(hidden_input);
 403         });
 404
 405         var col_list = $("#move_columns_dialog").find("ul")
 406             .find("li").remove().end();
 407         for (var i in columns) {
 408             col_list.append(columns[i]);
 409         }
 410         col_list.sortable({
 411             axis: 'y',
 412             containment: $("#move_columns_dialog").find("div"),
 413             tolerance: 'pointer'
 414         }).disableSelection();
 415         var $form = $("#move_columns_dialog").find("form");
 416         $form.data("serialized-unmoved", $form.serialize());
 417
 418         $("#move_columns_dialog").dialog({
 419             modal: true,
 420             buttons: button_options,
 421             open: function () {
 422                 if ($('#move_columns_dialog').parents('.ui-dialog').height() > $(window).height()) {
 423                     $('#move_columns_dialog').dialog("option", "height", $(window).height());
 424                 }
 425             },
 426             beforeClose: function () {
 427                 $("#move_columns_anchor").removeClass("move-active");
 428             }
 429         });
 430     });
 431
 432     /**
 433      * Handles multi submits in table structure page such as change, browse, drop, primary etc.
 434      */
 435     $('body').on('click', '#fieldsForm.ajax button[name="submit_mult"], #fieldsForm.ajax input[name="submit_mult"]', function (e) {
 436         e.preventDefault();
 437         var $button = $(this);
 438         var $form = $button.parents('form');
 439         var submitData = $form.serialize() + '&ajax_request=true&ajax_page_request=true&submit_mult=' + $button.val();
 440         PMA_ajaxShowMessage();
 441         AJAX.source = $form;
 442         $.post($form.attr('action'), submitData, AJAX.responseHandler);
 443     });
 444
 445     /**
 446      * Handles clicks on Action links in partition table
 447      */
 448     $(document).on('click', 'a[name^=partition_action].ajax', function (e) {
 449         e.preventDefault();
 450         var $link = $(this);
 451
 452         function submitPartitionAction(url) {
 453             var submitData = '&ajax_request=true&ajax_page_request=true';
 454             PMA_ajaxShowMessage();
 455             AJAX.source = $link;
 456             $.post(url, submitData, AJAX.responseHandler);
 457         }
 458
 459         if ($link.is('#partition_action_DROP')) {
 460             var question = PMA_messages.strDropPartitionWarning;
 461             $link.PMA_confirm(question, $link.attr('href'), function (url) {
 462                 submitPartitionAction(url);
 463             });
 464         } else if ($link.is('#partition_action_TRUNCATE')) {
 465             var question = PMA_messages.strTruncatePartitionWarning;
 466             $link.PMA_confirm(question, $link.attr('href'), function (url) {
 467                 submitPartitionAction(url);
 468             });
 469         } else {
 470             submitPartitionAction($link.attr('href'));
 471         }
 472     });
 473
 474     /**
 475      * Handles remove partitioning
 476      */
 477     $(document).on('click', '#remove_partitioning.ajax', function (e) {
 478         e.preventDefault();
 479         var $link = $(this);
 480         var question = PMA_messages.strRemovePartitioningWarning;
 481         $link.PMA_confirm(question, $link.attr('href'), function (url) {
 482             var submitData = '&ajax_request=true&ajax_page_request=true';
 483             PMA_ajaxShowMessage();
 484             AJAX.source = $link;
 485             $.post(url, submitData, AJAX.responseHandler);
 486         });
 487     });
 488 });
 489
 490 /** Handler for "More" dropdown in structure table rows */
 491 AJAX.registerOnload('tbl_structure.js', function () {
 492     if ($('#fieldsForm').hasClass('HideStructureActions')) {
 493         $('#fieldsForm').find('ul.table-structure-actions').menuResizer(PMA_tbl_structure_menu_resizer_callback);
 494     } else {
 495         $('.table-structure-actions').width(function () {
 496             var width = 5;
 497             $(this).find('li').each(function () {
 498                 width += $(this).outerWidth(true);
 499             });
 500             return width;
 501         });
 502     }
 503 });
 504 AJAX.registerTeardown('tbl_structure.js', function () {
 505     if ($('#fieldsForm').hasClass('HideStructureActions')) {
 506         $('#fieldsForm').find('ul.table-structure-actions').menuResizer('destroy');
 507     }
 508 });
 509 $(function () {
 510     $(window).resize($.throttle(function () {
 511         if ($('#fieldsForm').length && $('#fieldsForm').hasClass('HideStructureActions')) {
 512             $('#fieldsForm').find('ul.table-structure-actions').menuResizer('resize');
 513         }
 514     }));
 515 });