libraries/sql_query_form.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * functions for displaying the sql query form
   5  *
   6  * @usedby  server_sql.php
   7  * @usedby  db_sql.php
   8  * @usedby  tbl_sql.php
   9  * @usedby  tbl_structure.php
  10  * @usedby  tbl_tracking.php
  11  * @usedby  querywindow.php
  12  * @package phpMyAdmin
  13  */
  14 if (! defined('PHPMYADMIN')) {
  15     exit;
  16 }
  17
  18 /**
  19  *
  20  */
  21 require_once './libraries/file_listing.php'; // used for file listing
  22 require_once './libraries/bookmark.lib.php'; // used for file listing
  23
  24 /**
  25  * prints the sql query boxes
  26  *
  27  * @usedby  server_sql.php
  28  * @usedby  db_sql.php
  29  * @usedby  tbl_sql.php
  30  * @usedby  tbl_structure.php
  31  * @usedby  tbl_tracking.php
  32  * @usedby  querywindow.php
  33  * @uses    $GLOBALS['table']
  34  * @uses    $GLOBALS['db']
  35  * @uses    $GLOBALS['server']
  36  * @uses    $GLOBALS['goto']
  37  * @uses    $GLOBALS['is_upload']           from common.inc.php
  38  * @uses    $GLOBALS['sql_query']           from grab_globals.lib.php
  39  * @uses    $GLOBALS['cfg']['DefaultQueryTable']
  40  * @uses    $GLOBALS['cfg']['DefaultQueryDatabase']
  41  * @uses    $GLOBALS['cfg']['Servers']
  42  * @uses    $GLOBALS['cfg']['DefaultTabDatabase']
  43  * @uses    $GLOBALS['cfg']['DefaultQueryDatabase']
  44  * @uses    $GLOBALS['cfg']['DefaultQueryTable']
  45  * @uses    $GLOBALS['cfg']['Bookmark']
  46  * @uses    PMA_generate_common_url()
  47  * @uses    PMA_backquote()
  48  * @uses    PMA_DBI_fetch_result()
  49  * @uses    PMA_showMySQLDocu()
  50  * @uses    PMA_generate_common_hidden_inputs()
  51  * @uses    PMA_sqlQueryFormBookmark()
  52  * @uses    PMA_sqlQueryFormInsert()
  53  * @uses    PMA_sqlQueryFormUpload()
  54  * @uses    PMA_DBI_QUERY_STORE
  55  * @uses    PMA_set_enc_form()
  56  * @uses    sprintf()
  57  * @uses    htmlspecialchars()
  58  * @uses    str_replace()
  59  * @uses    md5()
  60  * @uses    function_exists()
  61  * @param   boolean|string  $query          query to display in the textarea
  62  *                                          or true to display last executed
  63  * @param   boolean|string  $display_tab    sql|files|history|full|FALSE
  64  *                                          what part to display
  65  *                                          false if not inside querywindow
  66  * @param   string          $delimiter
  67  */
  68 function PMA_sqlQueryForm($query = true, $display_tab = false, $delimiter = ';')
  69 {
  70     // check tab to display if inside querywindow
  71     if (! $display_tab) {
  72         $display_tab = 'full';
  73         $is_querywindow = false;
  74     } else {
  75         $is_querywindow = true;
  76     }
  77
  78     // query to show
  79     if (true === $query) {
  80         $query = $GLOBALS['sql_query'];
  81     }
  82
  83     // set enctype to multipart for file uploads
  84     if ($GLOBALS['is_upload']) {
  85         $enctype = ' enctype="multipart/form-data"';
  86     } else {
  87         $enctype = '';
  88     }
  89
  90     $table  = '';
  91     $db     = '';
  92     if (! strlen($GLOBALS['db'])) {
  93         // prepare for server related
  94         $goto   = empty($GLOBALS['goto']) ?
  95                     'server_sql.php' : $GLOBALS['goto'];
  96     } elseif (! strlen($GLOBALS['table'])) {
  97         // prepare for db related
  98         $db     = $GLOBALS['db'];
  99         $goto   = empty($GLOBALS['goto']) ?
 100                     'db_sql.php' : $GLOBALS['goto'];
 101     } else {
 102         $table  = $GLOBALS['table'];
 103         $db     = $GLOBALS['db'];
 104         $goto   = empty($GLOBALS['goto']) ?
 105                     'tbl_sql.php' : $GLOBALS['goto'];
 106     }
 107
 108
 109     // start output
 110     if ($is_querywindow) {
 111         ?>
 112         <form method="post" id="sqlqueryform" target="frame_content"
 113               action="import.php"<?php echo $enctype; ?> name="sqlform"
 114               onsubmit="var save_name = window.opener.parent.frame_content.name;
 115               window.opener.parent.frame_content.name = save_name + '<?php echo time(); ?>';
 116               this.target = window.opener.parent.frame_content.name;
 117               return checkSqlQuery(this)">
 118         <?php
 119     } else {
 120         echo '<form method="post" action="import.php" ' . $enctype . ' id="sqlqueryform"'
 121             .' onsubmit="return checkSqlQuery(this)" name="sqlform">' . "\n";
 122     }
 123
 124     if ($is_querywindow) {
 125         echo '<input type="hidden" name="focus_querywindow" value="true" />'
 126             ."\n";
 127         if ($display_tab != 'sql' && $display_tab != 'full') {
 128             echo '<input type="hidden" name="sql_query" value="" />' . "\n";
 129             echo '<input type="hidden" name="show_query" value="1" />' . "\n";
 130         }
 131     }
 132     echo '<input type="hidden" name="is_js_confirmed" value="0" />' . "\n"
 133         .PMA_generate_common_hidden_inputs($db, $table) . "\n"
 134         .'<input type="hidden" name="pos" value="0" />' . "\n"
 135         .'<input type="hidden" name="goto" value="'
 136         .htmlspecialchars($goto) . '" />' . "\n"
 137         .'<input type="hidden" name="zero_rows" value="'
 138         . htmlspecialchars(__('Your SQL query has been executed successfully')) . '" />' . "\n"
 139         .'<input type="hidden" name="prev_sql_query" value="'
 140         . htmlspecialchars($query) . '" />' . "\n";
 141
 142     // display querybox
 143     if ($display_tab === 'full' || $display_tab === 'sql') {
 144         PMA_sqlQueryFormInsert($query, $is_querywindow, $delimiter);
 145     }
 146
 147     // display uploads
 148     if ($display_tab === 'files' && $GLOBALS['is_upload']) {
 149         PMA_sqlQueryFormUpload();
 150     }
 151
 152     // Bookmark Support
 153     if ($display_tab === 'full' || $display_tab === 'history') {
 154         if (! empty($GLOBALS['cfg']['Bookmark'])) {
 155             PMA_sqlQueryFormBookmark();
 156         }
 157     }
 158
 159     // Encoding setting form appended by Y.Kawada
 160     if (function_exists('PMA_set_enc_form')) {
 161         echo PMA_set_enc_form('    ');
 162     }
 163
 164     echo '</form>' . "\n";
 165     if ($is_querywindow) {
 166         ?>
 167         <script type="text/javascript">
 168         //<![CDATA[
 169             if (window.opener) {
 170                 window.opener.parent.insertQuery();
 171             }
 172         //]]>
 173         </script>
 174         <?php
 175     }
 176 }
 177
 178 /**
 179  * prints querybox fieldset
 180  *
 181  * @usedby  PMA_sqlQueryForm()
 182  * @uses    $GLOBALS['text_dir']
 183  * @uses    $GLOBALS['cfg']['TextareaAutoSelect']
 184  * @uses    $GLOBALS['cfg']['TextareaCols']
 185  * @uses    $GLOBALS['cfg']['TextareaRows']
 186  * @uses    PMA_USR_OS
 187  * @uses    PMA_USR_BROWSER_AGENT
 188  * @uses    PMA_USR_BROWSER_VER
 189  * @uses    htmlspecialchars()
 190  * @param   string      $query          query to display in the textarea
 191  * @param   boolean     $is_querywindow if inside querywindow or not
 192  * @param   string      $delimiter      default delimiter to use
 193  */
 194 function PMA_sqlQueryFormInsert($query = '', $is_querywindow = false, $delimiter = ';')
 195 {
 196
 197     // enable auto select text in textarea
 198     if ($GLOBALS['cfg']['TextareaAutoSelect']) {
 199         $auto_sel = ' onfocus="selectContent(this, sql_box_locked, true)"';
 200     } else {
 201         $auto_sel = '';
 202     }
 203
 204     // enable locking if inside query window
 205     if ($is_querywindow) {
 206         $locking = ' onkeypress="document.sqlform.elements[\'LockFromUpdate\'].'
 207             .'checked = true;"';
 208         $height = $GLOBALS['cfg']['TextareaRows'] * 1.25;
 209     } else {
 210         $locking = '';
 211         $height = $GLOBALS['cfg']['TextareaRows'] * 2;
 212     }
 213
 214     $table          = '';
 215     $db             = '';
 216     $fields_list    = array();
 217     if (! strlen($GLOBALS['db'])) {
 218         // prepare for server related
 219         $legend = sprintf(__('Run SQL query/queries on server %s'),
 220             '&quot;' . htmlspecialchars(
 221                 ! empty($GLOBALS['cfg']['Servers'][$GLOBALS['server']]['verbose']) ? $GLOBALS['cfg']['Servers'][$GLOBALS['server']]['verbose'] : $GLOBALS['cfg']['Servers'][$GLOBALS['server']]['host']) . '&quot;');
 222     } elseif (! strlen($GLOBALS['table'])) {
 223         // prepare for db related
 224         $db     = $GLOBALS['db'];
 225         // if you want navigation:
 226         $tmp_db_link = '<a href="' . $GLOBALS['cfg']['DefaultTabDatabase']
 227             . '?' . PMA_generate_common_url($db) . '"';
 228         if ($is_querywindow) {
 229             $tmp_db_link .= ' target="_self"'
 230                 . ' onclick="this.target=window.opener.frame_content.name"';
 231         }
 232         $tmp_db_link .= '>'
 233             . htmlspecialchars($db) . '</a>';
 234         // else use
 235         // $tmp_db_link = htmlspecialchars($db);
 236         $legend = sprintf(__('Run SQL query/queries on database %s'), $tmp_db_link);
 237         if (empty($query)) {
 238             $query = str_replace('%d',
 239                 PMA_backquote($db), $GLOBALS['cfg']['DefaultQueryDatabase']);
 240         }
 241     } else {
 242         $table  = $GLOBALS['table'];
 243         $db     = $GLOBALS['db'];
 244         // Get the list and number of fields
 245         // we do a try_query here, because we could be in the query window,
 246         // trying to synchonize and the table has not yet been created
 247         $fields_list = PMA_DBI_fetch_result(
 248             'SHOW FULL COLUMNS FROM ' . PMA_backquote($db)
 249             . '.' . PMA_backquote($GLOBALS['table']));
 250
 251         $tmp_db_link = '<a href="' . $GLOBALS['cfg']['DefaultTabDatabase']
 252             . '?' . PMA_generate_common_url($db) . '"';
 253         if ($is_querywindow) {
 254             $tmp_db_link .= ' target="_self"'
 255                 . ' onclick="this.target=window.opener.frame_content.name"';
 256         }
 257         $tmp_db_link .= '>'
 258             . htmlspecialchars($db) . '</a>';
 259         // else use
 260         // $tmp_db_link = htmlspecialchars($db);
 261         $legend = sprintf(__('Run SQL query/queries on database %s'), $tmp_db_link);
 262         if (empty($query) && count($fields_list)) {
 263             $field_names = array();
 264             foreach ($fields_list as $field) {
 265                 $field_names[] = PMA_backquote($field['Field']);
 266             }
 267             $query =
 268                 str_replace('%d', PMA_backquote($db),
 269                     str_replace('%t', PMA_backquote($table),
 270                         str_replace('%f',
 271                             implode(', ', $field_names),
 272                             $GLOBALS['cfg']['DefaultQueryTable'])));
 273             unset($field_names);
 274         }
 275     }
 276     $legend .= ': ' . PMA_showMySQLDocu('SQL-Syntax', 'SELECT');
 277
 278     if (count($fields_list)) {
 279         $sqlquerycontainer_id = 'sqlquerycontainer';
 280     } else {
 281         $sqlquerycontainer_id = 'sqlquerycontainerfull';
 282     }
 283
 284     echo '<a name="querybox"></a>' . "\n"
 285         .'<div id="queryboxcontainer">' . "\n"
 286         .'<fieldset id="querybox">' . "\n";
 287     echo '<legend>' . $legend . '</legend>' . "\n";
 288     echo '<div id="queryfieldscontainer">' . "\n";
 289     echo '<div id="' . $sqlquerycontainer_id . '">' . "\n"
 290         .'<textarea tabindex="100" name="sql_query" id="sqlquery"'
 291         .'  cols="' . $GLOBALS['cfg']['TextareaCols'] . '"'
 292         .'  rows="' . $height . '"'
 293         .'  dir="' . $GLOBALS['text_dir'] . '"'
 294         .$auto_sel . $locking . '>' . htmlspecialchars($query) . '</textarea>' . "\n";
 295     // Add buttons to generate query easily for select all,single select,insert,update and delete
 296     if(count($fields_list)) {
 297         echo '<input type="button" value="SELECT *" id="selectall" class="sqlbutton" />';
 298         echo '<input type="button" value="SELECT" id="select" class="sqlbutton" />';
 299         echo '<input type="button" value="INSERT" id="insert" class="sqlbutton" />';
 300         echo '<input type="button" value="UPDATE" id="update" class="sqlbutton" />';
 301         echo '<input type="button" value="DELETE" id="delete" class="sqlbutton" />';
 302     }
 303     echo '</div>' . "\n";
 304
 305     if (count($fields_list)) {
 306         echo '<div id="tablefieldscontainer">' . "\n"
 307             .'<label>' . __('Columns') . '</label>' . "\n"
 308             .'<select id="tablefields" name="dummy" '
 309             .'size="' . ($GLOBALS['cfg']['TextareaRows'] - 2) . '" '
 310             .'multiple="multiple" ondblclick="insertValueQuery()">' . "\n";
 311         foreach ($fields_list as $field) {
 312             echo '<option value="'
 313                 .PMA_backquote(htmlspecialchars($field['Field'])) . '"';
 314             if (isset($field['Field']) && strlen($field['Field']) && isset($field['Comment'])) {
 315                 echo ' title="' . htmlspecialchars($field['Comment']) . '"';
 316             }
 317             echo '>' . htmlspecialchars($field['Field']) . '</option>' . "\n";
 318         }
 319         echo '</select>' . "\n"
 320             .'<div id="tablefieldinsertbuttoncontainer">' . "\n";
 321         if ($GLOBALS['cfg']['PropertiesIconic']) {
 322             echo '<input type="button" name="insert" value="&lt;&lt;"'
 323                 .' onclick="insertValueQuery()"'
 324                 .' title="' . __('Insert') . '" />' . "\n";
 325         } else {
 326             echo '<input type="button" name="insert"'
 327                 .' value="' . __('Insert') . '"'
 328                 .' onclick="insertValueQuery()" />' . "\n";
 329         }
 330         echo '</div>' . "\n"
 331             .'</div>' . "\n";
 332     }
 333
 334     echo '<div class="clearfloat"></div>' . "\n";
 335     echo '</div>' . "\n";
 336
 337     if (! empty($GLOBALS['cfg']['Bookmark'])) {
 338         ?>
 339         <div id="bookmarkoptions">
 340         <div class="formelement">
 341         <label for="bkm_label">
 342             <?php echo __('Bookmark this SQL query'); ?>:</label>
 343         <input type="text" name="bkm_label" id="bkm_label" tabindex="110" value="" />
 344         </div>
 345         <div class="formelement">
 346         <input type="checkbox" name="bkm_all_users" tabindex="111" id="id_bkm_all_users"
 347             value="true" />
 348         <label for="id_bkm_all_users">
 349             <?php echo __('Let every user access this bookmark'); ?></label>
 350         </div>
 351         <div class="formelement">
 352         <input type="checkbox" name="bkm_replace" tabindex="112" id="id_bkm_replace"
 353             value="true" />
 354         <label for="id_bkm_replace">
 355             <?php echo __('Replace existing bookmark of same name'); ?></label>
 356         </div>
 357         </div>
 358         <?php
 359     }
 360
 361     echo '<div class="clearfloat"></div>' . "\n";
 362     echo '</fieldset>' . "\n"
 363         .'</div>' . "\n";
 364
 365     echo '<fieldset id="queryboxfooter" class="tblFooters">' . "\n";
 366     echo '<div class="formelement">' . "\n";
 367     if ($is_querywindow) {
 368         ?>
 369         <script type="text/javascript">
 370         //<![CDATA[
 371             document.writeln(' <input type="checkbox" name="LockFromUpdate" value="1" tabindex="120" id="checkbox_lock" /> <label for="checkbox_lock"><?php echo __('Do not overwrite this query from outside the window'); ?></label> ');
 372         //]]>
 373         </script>
 374         <?php
 375     }
 376     echo '</div>' . "\n";
 377     echo '<div class="formelement">' . "\n";
 378     echo '<label for="id_sql_delimiter">[ ' . __('Delimiter')
 379         .'</label>' . "\n";
 380     echo '<input type="text" name="sql_delimiter" tabindex="131" size="3" '
 381         .'value="' . $delimiter . '" '
 382         .'id="id_sql_delimiter" /> ]' . "\n";
 383
 384     echo '<input type="checkbox" name="show_query" value="1" '
 385         .'id="checkbox_show_query" tabindex="132" checked="checked" />' . "\n"
 386         .'<label for="checkbox_show_query">' . __(' Show this query here again ')
 387         .'</label>' . "\n";
 388
 389     echo '</div>' . "\n";
 390     echo '<input type="submit" name="SQL" tabindex="200" value="' . __('Go') . '" />'
 391         ."\n";
 392     echo '<div class="clearfloat"></div>' . "\n";
 393     echo '</fieldset>' . "\n";
 394 }
 395
 396 /**
 397  * prints bookmark fieldset
 398  *
 399  * @usedby  PMA_sqlQueryForm()
 400  * @uses    PMA_Bookmark_getList()
 401  * @uses    $GLOBALS['db']
 402  * @uses    $GLOBALS['pmaThemeImage']
 403  * @uses    $GLOBALS['cfg']['ReplaceHelpImg']
 404  * @uses    count()
 405  * @uses    htmlspecialchars()
 406  */
 407 function PMA_sqlQueryFormBookmark()
 408 {
 409     $bookmark_list = PMA_Bookmark_getList($GLOBALS['db']);
 410     if (! $bookmark_list || count($bookmark_list) < 1) {
 411         return;
 412     }
 413
 414     echo '<fieldset id="bookmarkoptions">';
 415     echo '<legend>';
 416     echo __('Bookmarked SQL query') . '</legend>' . "\n";
 417     echo '<div class="formelement">';
 418     echo '<select name="id_bookmark">' . "\n";
 419     echo '<option value="">&nbsp;</option>' . "\n";
 420     foreach ($bookmark_list as $key => $value) {
 421         echo '<option value="' . htmlspecialchars($key) . '">'
 422             .htmlspecialchars($value) . '</option>' . "\n";
 423     }
 424     // &nbsp; is required for correct display with styles/line height
 425     echo '</select>&nbsp;' . "\n";
 426     echo '</div>' . "\n";
 427     echo '<div class="formelement">' . "\n";
 428     echo __('Variable');
 429     if ($GLOBALS['cfg']['ReplaceHelpImg']) {
 430         echo ' <a href="./Documentation.html#faqbookmark"'
 431             .' target="documentation">'
 432             .'<img class="icon" src="' . $GLOBALS['pmaThemeImage'] . 'b_help.png"'
 433             .' border="0" width="11" height="11" align="middle"'
 434             .' alt="' . __('Documentation') . '" /></a> ';
 435     } else {
 436         echo ' (<a href="./Documentation.html#faqbookmark"'
 437             .' target="documentation">' . __('Documentation') . '</a>): ';
 438     }
 439     echo '<input type="text" name="bookmark_variable" class="textfield"'
 440         .' size="10" />' . "\n";
 441     echo '</div>' . "\n";
 442     echo '<div class="formelement">' . "\n";
 443     echo '<input type="radio" name="action_bookmark" value="0"'
 444         .' id="radio_bookmark_exe" checked="checked" />'
 445         .'<label for="radio_bookmark_exe">' . __('Submit')
 446         .'</label>' . "\n";
 447     echo '<input type="radio" name="action_bookmark" value="1"'
 448         .' id="radio_bookmark_view" />'
 449         .'<label for="radio_bookmark_view">' . __('View only')
 450         .'</label>' . "\n";
 451     echo '<input type="radio" name="action_bookmark" value="2"'
 452         .' id="radio_bookmark_del" />'
 453         .'<label for="radio_bookmark_del">' . __('Delete')
 454         .'</label>' . "\n";
 455     echo '</div>' . "\n";
 456     echo '<div class="clearfloat"></div>' . "\n";
 457     echo '</fieldset>' . "\n";
 458
 459     echo '<fieldset id="bookmarkoptionsfooter" class="tblFooters">' . "\n";
 460     echo '<input type="submit" name="SQL" value="' . __('Go') . '" />';
 461     echo '<div class="clearfloat"></div>' . "\n";
 462     echo '</fieldset>' . "\n";
 463 }
 464
 465 /**
 466  * prints bookmark fieldset
 467  *
 468  * @usedby  PMA_sqlQueryForm()
 469  * @uses    $GLOBALS['cfg']['GZipDump']
 470  * @uses    $GLOBALS['cfg']['BZipDump']
 471  * @uses    $GLOBALS['cfg']['UploadDir']
 472  * @uses    $GLOBALS['cfg']['AvailableCharsets']
 473  * @uses    $GLOBALS['charset']
 474  * @uses    $GLOBALS['max_upload_size']
 475  * @uses    PMA_supportedDecompressions()
 476  * @uses    PMA_getFileSelectOptions()
 477  * @uses    PMA_displayMaximumUploadSize()
 478  * @uses    PMA_generateCharsetDropdownBox()
 479  * @uses    PMA_generateHiddenMaxFileSize()
 480  * @uses    PMA_CSDROPDOWN_CHARSET
 481  * @uses    empty()
 482  */
 483 function PMA_sqlQueryFormUpload(){
 484     $errors = array ();
 485
 486     $matcher = '@\.sql(\.(' . PMA_supportedDecompressions() . '))?$@'; // we allow only SQL here
 487
 488     if (!empty($GLOBALS['cfg']['UploadDir'])) {
 489         $files = PMA_getFileSelectOptions(PMA_userDir($GLOBALS['cfg']['UploadDir']), $matcher, (isset($timeout_passed) && $timeout_passed && isset($local_import_file)) ? $local_import_file : '');
 490     } else {
 491         $files = '';
 492     }
 493
 494     // start output
 495     echo '<fieldset id="">';
 496     echo '<legend>';
 497     echo __('Location of the text file') . '</legend>';
 498     echo '<div class="formelement">';
 499     echo '<input type="file" name="sql_file" class="textfield" /> ';
 500     echo PMA_displayMaximumUploadSize($GLOBALS['max_upload_size']);
 501     // some browsers should respect this :)
 502     echo PMA_generateHiddenMaxFileSize($GLOBALS['max_upload_size']) . "\n";
 503     echo '</div>';
 504
 505     if ($files === FALSE) {
 506         $errors[] = PMA_Message::error( __('The directory you set for upload work cannot be reached'));
 507     } elseif (!empty($files)) {
 508         echo '<div class="formelement">';
 509         echo '<strong>' . __('web server upload directory') .':</strong>' . "\n";
 510         echo '<select size="1" name="sql_localfile">' . "\n";
 511         echo '<option value="" selected="selected"></option>' . "\n";
 512         echo $files;
 513         echo '</select>' . "\n";
 514         echo '</div>';
 515     }
 516
 517     echo '<div class="clearfloat"></div>' . "\n";
 518     echo '</fieldset>';
 519
 520
 521     echo '<fieldset id="" class="tblFooters">';
 522     echo __('Character set of the file:') . "\n";
 523     echo PMA_generateCharsetDropdownBox(PMA_CSDROPDOWN_CHARSET,
 524             'charset_of_file', null, 'utf8', FALSE);
 525     echo '<input type="submit" name="SQL" value="' . __('Go')
 526         .'" />' . "\n";
 527     echo '<div class="clearfloat"></div>' . "\n";
 528     echo '</fieldset>';
 529
 530     foreach ($errors as $error) {
 531         $error->display();
 532     }
 533 }
 534 ?>