Translation update done using Pootle.
[phpmyadmin-themes.git] / js / sql.js
blob43b3af7325c116afa99fa0a57c101560e98e4b56
1 /* vim: set expandtab sw=4 ts=4 sts=4: */
2 /**
3  * @fileoverview    functions used wherever an sql query form is used
4  *
5  * @requires    jQuery
6  * @requires    js/functions.js
7  *
8  */
10 /**
11  * decode a string URL_encoded
12  *
13  * @param string str
14  * @return string the URL-decoded string
15  */
16 function PMA_urldecode(str) {
17     return decodeURIComponent(str.replace(/\+/g, '%20'));
20 /**
21  * Get the field name for the current field.  Required to construct the query
22  * for inline editing
23  *
24  * @param   $this_field  jQuery object that points to the current field's tr
25  * @param   disp_mode    string
26  */
27 function getFieldName($this_field, disp_mode) {
29     if(disp_mode == 'vertical') {
30         var field_name = $this_field.siblings('th').find('a').text();
31         // happens when just one row (headings contain no a)
32         if ("" == field_name) {
33             field_name = $this_field.siblings('th').text();
34         }
35     }
36     else {
37         var this_field_index = $this_field.index();
38         // ltr or rtl direction does not impact how the DOM was generated
39         //
40         // 4 columns to account for the checkbox, edit, delete and appended inline edit anchors but index is zero-based so substract 3
41         var field_name = $('#table_results').find('thead').find('th:nth('+ (this_field_index-3 )+') a').text();
42         // happens when just one row (headings contain no a)
43         if ("" == field_name) {
44             field_name = $('#table_results').find('thead').find('th:nth('+ (this_field_index-3 )+')').text();
45         }
46     }
48     field_name = $.trim(field_name);
50     return field_name;
53 /**
54  * The function that iterates over each row in the table_results and appends a
55  * new inline edit anchor to each table row.
56  *
57  */
58 function appendInlineAnchor() {
59     var disp_mode = $("#top_direction_dropdown").val();
61     if (disp_mode == 'vertical') {
62         // there can be one or two tr containing this class, depending
63         // on the ModifyDeleteAtLeft and ModifyDeleteAtRight cfg parameters 
64         $('#table_results tr')
65             .find('.edit_row_anchor')
66             .removeClass('.edit_row_anchor')
67             .parent().each(function() {
68             var $this_tr = $(this);
69             var $cloned_tr = $this_tr.clone();
71             var $img_object = $cloned_tr.find('img:first').attr('title', PMA_messages['strInlineEdit']);
72             var img_src = $img_object.attr('src').replace(/b_edit/,'b_inline_edit');
73             $img_object.attr('src', img_src);
75             $cloned_tr.find('td')
76              .addClass('inline_edit_anchor')
77              .find('a').attr('href', '#')
78              .find('span')
79              .text(' ' + PMA_messages['strInlineEdit'])
80              .prepend($img_object);
82             $cloned_tr.insertAfter($this_tr);
83         });
85         $("#table_results").find('tr').find(':checkbox').closest('tr').find('th')
86          .attr('rowspan', '4');
87     }
88     else {
89         $('.edit_row_anchor').each(function() {
91             $this_td = $(this)
92             $this_td.removeClass('edit_row_anchor');
94             var $cloned_anchor = $this_td.clone();
96             var $img_object = $cloned_anchor.find('img').attr('title', PMA_messages['strInlineEdit']);
97             var img_src = $img_object.attr('src').replace(/b_edit/,'b_inline_edit');
98             $img_object.attr('src', img_src);
100             $cloned_anchor.addClass('inline_edit_anchor')
101             .find('a').attr('href', '#')
102             .find('span')
103             .text(' ' + PMA_messages['strInlineEdit'])
104             .prepend($img_object);
106             $this_td.after($cloned_anchor);
107         });
109         $('#rowsDeleteForm').find('thead, tbody').find('th').each(function() {
110             var $this_th = $(this);
111             if ($this_th.attr('colspan') == 3) {
112                 $this_th.attr('colspan', '4')
113             }
114         });
115     }
118 /**#@+
119  * @namespace   jQuery
120  */
123  * @description <p>Ajax scripts for sql and browse pages</p>
125  * Actions ajaxified here:
126  * <ul>
127  * <li>Retrieve results of an SQL query</li>
128  * <li>Paginate the results table</li>
129  * <li>Sort the results table</li>
130  * <li>Change table according to display options</li>
131  * <li>Inline editing of data</li>
132  * </ul>
134  * @name        document.ready
135  * @memberOf    jQuery
136  */
137 $(document).ready(function() {
139     /**
140      * Set a parameter for all Ajax queries made on this page.  Don't let the
141      * web server serve cached pages
142      */
143     $.ajaxSetup({
144         cache: 'false'
145     });
147     /**
148      * current value of the direction in which the table is displayed
149      * @type    String
150      * @fieldOf jQuery
151      * @name    disp_mode
152      */
153     var disp_mode = $("#top_direction_dropdown").val();
155     /**
156      * Update value of {@link jQuery.disp_mode} everytime the direction dropdown changes value
157      * @memberOf    jQuery
158      * @name        direction_dropdown_change
159      */
160     $("#top_direction_dropdown, #bottom_direction_dropdown").live('change', function(event) {
161         disp_mode = $(this).val();
162     })
164     /**
165      * Attach the {@link appendInlineAnchor} function to a custom event, which
166      * will be triggered manually everytime the table of results is reloaded
167      * @memberOf    jQuery
168      */
169     $("#sqlqueryresults").live('appendAnchor',function() {
170         appendInlineAnchor();
171     })
173     /**
174      * Trigger the appendAnchor event to prepare the first table for inline edit
175      *
176      * @memberOf    jQuery
177      * @name        sqlqueryresults_trigger
178      */
179     $("#sqlqueryresults").trigger('appendAnchor');
181     /**
182      * Append the "Show/Hide query box" message to the query input form
183      *
184      * @memberOf jQuery
185      * @name    appendToggleSpan
186      */
187     // do not add this link more than once
188     if (! $('#sqlqueryform').find('a').is('#togglequerybox')) {
189         $('<a id="togglequerybox"></a>')
190         .html(PMA_messages['strHideQueryBox'])
191         .appendTo("#sqlqueryform");
193         // Attach the toggling of the query box visibility to a click
194         $("#togglequerybox").bind('click', function() {
195             var $link = $(this)
196             $link.siblings().slideToggle("medium");
197             if ($link.text() == PMA_messages['strHideQueryBox']) {
198                 $link.text(PMA_messages['strShowQueryBox']);
199             } else {
200                 $link.text(PMA_messages['strHideQueryBox']);
201             }
202             // avoid default click action
203             return false;
204         })
205     }
206     
207     /**
208      * Ajax Event handler for 'SQL Query Submit'
209      *
210      * @see         PMA_ajaxShowMessage()
211      * @memberOf    jQuery
212      * @name        sqlqueryform_submit
213      */
214     $("#sqlqueryform").live('submit', function(event) {
215         event.preventDefault();
216         // remove any div containing a previous error message
217         $('.error').remove();
219         $form = $(this);
220         PMA_ajaxShowMessage();
222             if (! $form.find('input:hidden').is('#ajax_request_hidden')) {
223                 $form.append('<input type="hidden" id="ajax_request_hidden" name="ajax_request" value="true" />');
224             }
226         $.post($(this).attr('action'), $(this).serialize() , function(data) {
227             if(data.success == true) {
228                 // fade out previous success message, if any 
229                 $('.success').fadeOut();
230                 // show a message that stays on screen 
231                 $('#sqlqueryform').before(data.message);
232                 $('#sqlqueryresults').show();
233                 // this happens if a USE command was typed
234                 if (typeof data.reload != 'undefined') {
235                     $form.find('input[name=db]').val(data.db);
236                     // need to regenerate the whole upper part
237                     $form.find('input[name=ajax_request]').remove();
238                     $form.append('<input type="hidden" name="reload" value="true" />');
239                     $.post('db_sql.php', $form.serialize(), function(data) {
240                         $('body').html(data);
241                     }); // end inner post
242                 }
243             }
244             else if (data.success == false ) {
245                 // show an error message that stays on screen 
246                 $('#sqlqueryform').before(data.error);
247                 $('#sqlqueryresults').hide();
248             }
249             else {
250                 // real results are returned
251                 $('#sqlqueryresults').show();
252                 $("#sqlqueryresults").html(data);
253                 $("#sqlqueryresults").trigger('appendAnchor');
254                 if($("#togglequerybox").siblings(":visible").length > 0) {
255                     $("#togglequerybox").trigger('click');
256                 }
257             }
258         }) // end $.post()
259     }) // end SQL Query submit
261     /**
262      * Ajax Event handlers for Paginating the results table
263      */
265     /**
266      * Paginate when we click any of the navigation buttons
267      * @memberOf    jQuery
268      * @name        paginate_nav_button_click
269      * @uses        PMA_ajaxShowMessage()
270      */
271     $("input[name=navig]").live('click', function(event) {
272         /** @lends jQuery */
273         event.preventDefault();
275         PMA_ajaxShowMessage();
276         
277         /**
278          * @var $the_form    Object referring to the form element that paginates the results table
279          */
280         var $the_form = $(this).parent("form");
282         $the_form.append('<input type="hidden" name="ajax_request" value="true" />');
284         $.post($the_form.attr('action'), $the_form.serialize(), function(data) {
285             $("#sqlqueryresults").html(data);
286             $("#sqlqueryresults").trigger('appendAnchor');
287         }) // end $.post()
288     })// end Paginate results table
290     /**
291      * Paginate results with Page Selector dropdown
292      * @memberOf    jQuery
293      * @name        paginate_dropdown_change
294      */
295     $("#pageselector").live('change', function(event) {
296         event.preventDefault();
298         PMA_ajaxShowMessage();
299         var $the_form = $(this).parent("form");
301         $.post($the_form.attr('action'), $the_form.serialize() + '&ajax_request=true', function(data) {
302             $("#sqlqueryresults").html(data);
303             $("#sqlqueryresults").trigger('appendAnchor');
304         }) // end $.post()
305     })// end Paginate results with Page Selector
307     /**
308      * Ajax Event handler for sorting the results table
309      * @memberOf    jQuery
310      * @name        table_results_sort_click
311      */
312     $("#table_results").find("a[title=Sort]").live('click', function(event) {
313         event.preventDefault();
315         PMA_ajaxShowMessage();
317         $.get($(this).attr('href'), $(this).serialize() + '&ajax_request=true', function(data) {
318             $("#sqlqueryresults").html(data);
319             $("#sqlqueryresults").trigger('appendAnchor');
320         }) // end $.get()
321     })//end Sort results table
323     /**
324      * Ajax Event handler for the display options
325      * @memberOf    jQuery
326      * @name        displayOptionsForm_submit
327      */
328     $("#displayOptionsForm").live('submit', function(event) {
329         event.preventDefault();
331         $.post($(this).attr('action'), $(this).serialize() + '&ajax_request=true' , function(data) {
332             $("#sqlqueryresults").html(data);
333             $("#sqlqueryresults").trigger('appendAnchor');
334         }) // end $.post()
335     })
336     //end displayOptionsForm handler
338     /**
339      * Ajax Event handlers for Inline Editing
340      */
342     /**
343      * On click, replace the fields of current row with an input/textarea
344      * @memberOf    jQuery
345      * @name        inline_edit_start
346      * @see         PMA_ajaxShowMessage()
347      * @see         getFieldName()
348      */
349     $(".inline_edit_anchor").live('click', function(event) {
350         /** @lends jQuery */
351         event.preventDefault();
353         $(this).removeClass('inline_edit_anchor').addClass('inline_edit_active');
355         // Initialize some variables
356         if(disp_mode == 'vertical') {
357             /**
358              * @var this_row_index  Index of the current <td> in the parent <tr>
359              *                      Current <td> is the inline edit anchor.
360              */
361             var this_row_index = $(this).index();
362             /**
363              * @var $input_siblings  Object referring to all inline editable events from same row
364              */
365             var $input_siblings = $(this).parents('tbody').find('tr').find('.inline_edit:nth('+this_row_index+')');
366             /**
367              * @var where_clause    String containing the WHERE clause to select this row
368              */
369             var where_clause = $(this).parents('tbody').find('tr').find('.where_clause:nth('+this_row_index+')').val();
370         }
371         else {
372             var $input_siblings = $(this).parent('tr').find('.inline_edit');
373             var where_clause = $(this).parent('tr').find('.where_clause').val();
374         }
376         $input_siblings.each(function() {
377             /** @lends jQuery */
378             /**
379              * @var data_value  Current value of this field
380              */
381             var data_value = $(this).html();
383             // We need to retrieve the value from the server for truncated/relation fields
384             // Find the field name
385             
386             /**
387              * @var this_field  Object referring to this field (<td>)
388              */
389             var $this_field = $(this);
390             /**
391              * @var field_name  String containing the name of this field.
392              * @see getFieldName()
393              */
394             var field_name = getFieldName($this_field, disp_mode);
396             // In each input sibling, wrap the current value in a textarea
397             // and store the current value in a hidden span
398             if($this_field.is(':not(.truncated, .transformed, .relation, .enum, .null)')) {
399                 // handle non-truncated, non-transformed, non-relation values
400                 // We don't need to get any more data, just wrap the value
401                 $this_field.html('<textarea>'+data_value+'</textarea>')
402                 .append('<span class="original_data">'+data_value+'</span>');
403                 $(".original_data").hide();
404             }
405             else if($this_field.is('.truncated, .transformed')) {
406                 /** @lends jQuery */
407                 //handle truncated/transformed values values
409                 /**
410                  * @var sql_query   String containing the SQL query used to retrieve value of truncated/transformed data
411                  */
412                 var sql_query = 'SELECT ' + field_name + ' FROM ' + window.parent.table + ' WHERE ' + where_clause;
414                 // Make the Ajax call and get the data, wrap it and insert it
415                 $.post('sql.php', {
416                     'token' : window.parent.token,
417                     'db' : window.parent.db,
418                     'ajax_request' : true,
419                     'sql_query' : sql_query,
420                     'inline_edit' : true
421                 }, function(data) {
422                     if(data.success == true) {
423                         $this_field.html('<textarea>'+data.value+'</textarea>')
424                         .append('<span class="original_data">'+data_value+'</span>');
425                         $(".original_data").hide();
426                     }
427                     else {
428                         PMA_ajaxShowMessage(data.error);
429                     }
430                 }) // end $.post()
431             }
432             else if($this_field.is('.relation')) {
433                 /** @lends jQuery */
434                 //handle relations
436                 /**
437                  * @var curr_value  String containing the current value of this relational field
438                  */
439                 var curr_value = $this_field.find('a').text();
441                 /**
442                  * @var post_params Object containing parameters for the POST request
443                  */
444                 var post_params = {
445                         'ajax_request' : true,
446                         'get_relational_values' : true,
447                         'db' : window.parent.db,
448                         'table' : window.parent.table,
449                         'column' : field_name,
450                         'token' : window.parent.token,
451                         'curr_value' : curr_value
452                 }
454                 $.post('sql.php', post_params, function(data) {
455                     $this_field.html(data.dropdown)
456                     .append('<span class="original_data">'+data_value+'</span>');
457                     $(".original_data").hide();
458                 }) // end $.post()
459             }
460             else if($this_field.is('.enum')) {
461                 /** @lends jQuery */
462                 //handle enum fields
463                 /**
464                  * @var curr_value  String containing the current value of this relational field
465                  */
466                 var curr_value = $this_field.text();
468                 /**
469                  * @var post_params Object containing parameters for the POST request
470                  */
471                 var post_params = {
472                         'ajax_request' : true,
473                         'get_enum_values' : true,
474                         'db' : window.parent.db,
475                         'table' : window.parent.table,
476                         'column' : field_name,
477                         'token' : window.parent.token,
478                         'curr_value' : curr_value
479                 }
481                 $.post('sql.php', post_params, function(data) {
482                     $this_field.html(data.dropdown)
483                     .append('<span class="original_data">'+data_value+'</span>');
484                     $(".original_data").hide();
485                 }) // end $.post()
486             }
487             else if($this_field.is('.null')) {
488                 //handle null fields
489                 $this_field.html('<textarea></textarea>')
490                 .append('<span class="original_data">NULL</span>');
491                 $(".original_data").hide();
492             }
493         })
494     }) // End On click, replace the current field with an input/textarea
496     /**
497      * After editing, clicking again should post data
498      *
499      * @memberOf    jQuery
500      * @name        inline_edit_save
501      * @see         PMA_ajaxShowMessage()
502      * @see         getFieldName()
503      */
504     $(".inline_edit_active").live('click', function(event) {
505         /** @lends jQuery */
506         event.preventDefault();
508         /**
509          * @var $this_td    Object referring to the td containing the 
510          * "Inline Edit" link that was clicked to save the row that is 
511          * being edited
512          *
513          */
514         var $this_td = $(this);
516         var $test_element = ''; // to test the presence of a element
518         // Initialize variables
519         if(disp_mode == 'vertical') {
520             /**
521              * @var this_td_index  Index of the current <td> in the parent <tr>
522              *                      Current <td> is the inline edit anchor.
523              */
524             var this_td_index = $this_td.index();
525             /**
526              * @var $input_siblings  Object referring to all inline editable events from same row
527              */
528             var $input_siblings = $this_td.parents('tbody').find('tr').find('.inline_edit:nth('+this_td_index+')');
529             /**
530              * @var where_clause    String containing the WHERE clause to select this row
531              */
532             var where_clause = $this_td.parents('tbody').find('tr').find('.where_clause:nth('+this_td_index+')').val();
533         }
534         else {
535             var $input_siblings = $this_td.parent('tr').find('.inline_edit');
536             var where_clause = $this_td.parent('tr').find('.where_clause').val();
537         }
539         /**
540          * @var nonunique   Boolean, whether this row is unique or not
541          */
542         if($this_td.is('.nonunique')) {
543             var nonunique = 0;
544         }
545         else {
546             var nonunique = 1;
547         }
549         // Collect values of all fields to submit, we don't know which changed
550         /**
551          * @var params_to_submit    Array containing the name/value pairs of all fields
552          */
553         var params_to_submit = {};
554         /**
555          * @var relation_fields Array containing the name/value pairs of relational fields
556          */
557         var relation_fields = {};
558         /**
559          * @var transform_fields    Array containing the name/value pairs for transformed fields
560          */
561         var transform_fields = {};
562         /**
563          * @var transformation_fields   Boolean, if there are any transformed fields in this row
564          */
565         var transformation_fields = false;
567         $input_siblings.each(function() {
568             /** @lends jQuery */
569             /**
570              * @var this_field  Object referring to this field (<td>)
571              */
572             var $this_field = $(this);
573             /**
574              * @var field_name  String containing the name of this field.
575              * @see getFieldName()
576              */
577             var field_name = getFieldName($this_field, disp_mode);
579             /**
580              * @var this_field_params   Array temporary storage for the name/value of current field
581              */
582             var this_field_params = {};
584             if($this_field.is('.transformed')) {
585                 transformation_fields =  true;
586             }
588             if($this_field.is(":not(.relation, .enum)")) {
589                 this_field_params[field_name] = $this_field.find('textarea').val();
590                 if($this_field.is('.transformed')) {
591                     $.extend(transform_fields, this_field_params);
592                 }
593             }
594             else {
595                 // results from a drop-down
596                 $test_element = $this_field.find('select');
597                 if ($test_element.length != 0) {
598                     this_field_params[field_name] = $test_element.val();
599                 }
601                 // results from Browse foreign value
602                 $test_element = $this_field.find('span.curr_value');
603                 if ($test_element.length != 0) {
604                     this_field_params[field_name] = $test_element.text();
605                 }
607                 if($this_field.is('.relation')) {
608                     $.extend(relation_fields, this_field_params);
609                 }
610             }
612             $.extend(params_to_submit, this_field_params);
613         })
615         /**
616          * @var sql_query   String containing the SQL query to update this row
617          */
618         var sql_query = 'UPDATE ' + window.parent.table + ' SET ';
620         $.each(params_to_submit, function(key, value) {
621             if(value.length == 0) {
622                 value = 'NULL'
623             }
624            sql_query += ' ' + key + "='" + value.replace(/'/g, "''") + "' , ";
625         })
626         //Remove the last ',' appended in the above loop
627         sql_query = sql_query.replace(/,\s$/, '');
628         sql_query += ' WHERE ' + PMA_urldecode(where_clause);
630         /**
631          * @var rel_fields_list  String, url encoded representation of {@link relations_fields}
632          */
633         var rel_fields_list = $.param(relation_fields);
635         /**
636          * @var transform_fields_list  String, url encoded representation of {@link transform_fields}
637          */
638         var transform_fields_list = $.param(transform_fields);
640         // Make the Ajax post after setting all parameters
641         /**
642          * @var post_params Object containing parameters for the POST request
643          */
644         var post_params = {'ajax_request' : true,
645                             'sql_query' : sql_query,
646                             'disp_direction' : disp_mode,
647                             'token' : window.parent.token,
648                             'db' : window.parent.db,
649                             'table' : window.parent.table,
650                             'clause_is_unique' : nonunique,
651                             'where_clause' : where_clause,
652                             'rel_fields_list' : rel_fields_list,
653                             'do_transformations' : transformation_fields,
654                             'transform_fields_list' : transform_fields_list,
655                             'goto' : 'sql.php',
656                             'submit_type' : 'save'
657                           };
659         $.post('tbl_replace.php', post_params, function(data) {
660             if(data.success == true) {
661                 PMA_ajaxShowMessage(data.message);
662                 $this_td.removeClass('inline_edit_active').addClass('inline_edit_anchor');
664                 $input_siblings.each(function() {
665                     // Inline edit post has been successful.
666                     $this_sibling = $(this);
667                     if($this_sibling.is(':not(.relation, .enum)')) {
668                         /**
669                          * @var new_html    String containing value of the data field after edit
670                          */
671                         var new_html = $this_sibling.find('textarea').val();
673                         if($this_sibling.is('.transformed')) {
674                             var field_name = getFieldName($this_sibling, disp_mode);
675                             $.each(data.transformations, function(key, value) {
676                                 if(key == field_name) {
677                                     if($this_sibling.is('.text_plain, .application_octetstream')) {
678                                         new_html = value;
679                                         return false;
680                                     }
681                                     else {
682                                         var new_value = $this_sibling.find('textarea').val();
683                                         new_html = $(value).append(new_value);
684                                         return false;
685                                     }
686                                 }
687                             })
688                         }
689                     }
690                     else {
691                         var new_html = '';
692                         var new_value = '';
693                         $test_element = $this_sibling.find('select');
694                         if ($test_element.length != 0) {
695                             new_value = $test_element.val();
696                         }
698                         $test_element = $this_sibling.find('span.curr_value');
699                         if ($test_element.length != 0) {
700                             new_value = $test_element.text();
701                         }
703                         
704                         if($this_sibling.is('.relation')) {
705                             var field_name = getFieldName($this_sibling, disp_mode);
706                             $.each(data.relations, function(key, value) {
707                                 if(key == field_name) {
708                                     new_html = $(value).append(new_value);
709                                     return false;
710                                 }
711                             })
712                         } 
713                         if($this_sibling.is('.enum')) {
714                             new_html = new_value;
715                         }
716                     }
717                     $this_sibling.html(new_html);
718                 })
719             }
720             else {
721                 PMA_ajaxShowMessage(data.error);
722             };
723         }) // end $.post()
724     }) // End After editing, clicking again should post data
725 }, 'top.frame_content') // end $(document).ready()
728  * Starting from some th, change the class of all td under it
729  */
730 function PMA_changeClassForColumn($this_th, newclass) {
731     // index 0 is the th containing the big T
732     var th_index = $this_th.index();
733     // .eq() is zero-based
734     th_index--;
735     var $tr_with_data = $this_th.closest('table').find('tbody tr ').has('td.data');
736     $tr_with_data.each(function() {
737         $(this).find('td.data:eq('+th_index+')').toggleClass(newclass);
738     });
741 $(document).ready(function() {
743     $('.browse_foreign').live('click', function(e) {
744         e.preventDefault();
745         window.open(this.href, 'foreigners', 'width=640,height=240,scrollbars=yes,resizable=yes');
746         $anchor = $(this);
747         $anchor.addClass('browse_foreign_clicked');
748         return false;
749     });
751     /**
752      * vertical column highlighting in horizontal mode when hovering over the column header
753      */
754     $('.column_heading').live('hover', function() {
755         PMA_changeClassForColumn($(this), 'hover'); 
756         });
758     /**
759      * vertical column marking in horizontal mode when clicking the column header
760      */
761     $('.column_heading').live('click', function() {
762         PMA_changeClassForColumn($(this), 'marked'); 
763         });
766 /**#@- */