db_search.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * searchs the entire database
   5  *
   6  * @todo    make use of UNION when searching multiple tables
   7  * @todo    display executed query, optional?
   8  * @package phpMyAdmin
   9  */
  10
  11 /**
  12  *
  13  */
  14 require_once './libraries/common.inc.php';
  15
  16 $GLOBALS['js_include'][] = 'db_search.js';
  17 $GLOBALS['js_include'][] = 'sql.js';
  18 $GLOBALS['js_include'][] = 'makegrid.js';
  19
  20 /**
  21  * Gets some core libraries and send headers
  22  */
  23 require './libraries/db_common.inc.php';
  24
  25 /**
  26  * init
  27  */
  28 // If config variable $GLOBALS['cfg']['Usedbsearch'] is on false : exit.
  29 if (! $GLOBALS['cfg']['UseDbSearch']) {
  30     PMA_mysqlDie(__('Access denied'), '', false, $err_url);
  31 } // end if
  32 $url_query .= '&amp;goto=db_search.php';
  33 $url_params['goto'] = 'db_search.php';
  34
  35 /**
  36  * @global array list of tables from the current database
  37  * but do not clash with $tables coming from db_info.inc.php
  38  */
  39 $tables_names_only = PMA_DBI_get_tables($GLOBALS['db']);
  40
  41 $search_options = array(
  42     '1' => __('at least one of the words'),
  43     '2' => __('all words'),
  44     '3' => __('the exact phrase'),
  45     '4' => __('as regular expression'),
  46 );
  47
  48 if (empty($_REQUEST['search_option']) || ! is_string($_REQUEST['search_option'])
  49  || ! array_key_exists($_REQUEST['search_option'], $search_options)) {
  50     $search_option = 1;
  51     unset($_REQUEST['submit_search']);
  52 } else {
  53     $search_option = (int) $_REQUEST['search_option'];
  54     $option_str = $search_options[$_REQUEST['search_option']];
  55 }
  56
  57 if (empty($_REQUEST['search_str']) || ! is_string($_REQUEST['search_str'])) {
  58     unset($_REQUEST['submit_search']);
  59     $searched = '';
  60 } else {
  61     $searched = htmlspecialchars($_REQUEST['search_str']);
  62     // For "as regular expression" (search option 4), we should not treat
  63     // this as an expression that contains a LIKE (second parameter of
  64     // PMA_sqlAddSlashes()).
  65     //
  66     // Usage example: If user is seaching for a literal $ in a regexp search,
  67     // he should enter \$ as the value.
  68     $search_str = PMA_sqlAddSlashes($_REQUEST['search_str'], ($search_option == 4 ? false : true));
  69 }
  70
  71 $tables_selected = array();
  72 if (empty($_REQUEST['table_select']) || ! is_array($_REQUEST['table_select'])) {
  73     unset($_REQUEST['submit_search']);
  74 } elseif (! isset($_REQUEST['selectall']) && ! isset($_REQUEST['unselectall'])) {
  75     $tables_selected = array_intersect($_REQUEST['table_select'], $tables_names_only);
  76 }
  77
  78 if (isset($_REQUEST['selectall'])) {
  79     $tables_selected = $tables_names_only;
  80 } elseif (isset($_REQUEST['unselectall'])) {
  81     $tables_selected = array();
  82 }
  83
  84 if (empty($_REQUEST['field_str']) || ! is_string($_REQUEST['field_str'])) {
  85     unset($field_str);
  86 } else {
  87     $field_str = PMA_sqlAddSlashes($_REQUEST['field_str'], true);
  88 }
  89
  90 /**
  91  * Displays top links if we are not in an Ajax request
  92  */
  93 $sub_part = '';
  94
  95 if ( $GLOBALS['is_ajax_request'] != true) {
  96     include './libraries/db_info.inc.php';
  97     echo '<div id="searchresults">';
  98 }
  99
 100 /**
 101  * 1. Main search form has been submitted
 102  */
 103 if (isset($_REQUEST['submit_search'])) {
 104
 105     /**
 106      * Builds the SQL search query
 107      *
 108      * @todo    can we make use of fulltextsearch IN BOOLEAN MODE for this?
 109      * PMA_backquote
 110      * PMA_DBI_free_result
 111      * PMA_DBI_fetch_assoc
 112      * $GLOBALS['db']
 113      * explode
 114      * count
 115      * strlen
 116      * @param string   the table name
 117      * @param string   restrict the search to this field
 118      * @param string   the string to search
 119      * @param integer  type of search (1 -> 1 word at least, 2 -> all words,
 120      *                                   3 -> exact string, 4 -> regexp)
 121      *
 122      * @return  array    3 SQL querys (for count, display and delete results)
 123      */
 124     function PMA_getSearchSqls($table, $field, $search_str, $search_option)
 125     {
 126         // Statement types
 127         $sqlstr_select = 'SELECT';
 128         $sqlstr_delete = 'DELETE';
 129
 130         // Fields to select
 131         $tblfields = PMA_DBI_get_columns($GLOBALS['db'], $table);
 132
 133         // Table to use
 134         $sqlstr_from = ' FROM ' . PMA_backquote($GLOBALS['db']) . '.' . PMA_backquote($table);
 135
 136         $search_words    = (($search_option > 2) ? array($search_str) : explode(' ', $search_str));
 137
 138         $like_or_regex   = (($search_option == 4) ? 'REGEXP' : 'LIKE');
 139         $automatic_wildcard   = (($search_option < 3) ? '%' : '');
 140
 141         $fieldslikevalues = array();
 142         foreach ($search_words as $search_word) {
 143             // Eliminates empty values
 144             if (strlen($search_word) === 0) {
 145                 continue;
 146             }
 147
 148             $thefieldlikevalue = array();
 149             foreach ($tblfields as $tblfield) {
 150                 if (! isset($field) || strlen($field) == 0 || $tblfield['Field'] == $field) {
 151                     // Drizzle has no CONVERT and all text columns are UTF-8
 152                     if (PMA_DRIZZLE) {
 153                         $thefieldlikevalue[] = PMA_backquote($tblfield['Field'])
 154                                             . ' ' . $like_or_regex . ' '
 155                                             . "'" . $automatic_wildcard
 156                                             . $search_word
 157                                             . $automatic_wildcard . "'";
 158                     } else {
 159                         $thefieldlikevalue[] = 'CONVERT(' . PMA_backquote($tblfield['Field']) . ' USING utf8)'
 160                                             . ' ' . $like_or_regex . ' '
 161                                             . "'" . $automatic_wildcard
 162                                             . $search_word
 163                                             . $automatic_wildcard . "'";
 164                     }
 165                 }
 166             } // end for
 167
 168             if (count($thefieldlikevalue) > 0) {
 169                 $fieldslikevalues[]      = implode(' OR ', $thefieldlikevalue);
 170             }
 171         } // end for
 172
 173         $implode_str  = ($search_option == 1 ? ' OR ' : ' AND ');
 174         if ( empty($fieldslikevalues)) {
 175             // this could happen when the "inside field" does not exist
 176             // in any selected tables
 177             $sqlstr_where = ' WHERE FALSE';
 178         } else {
 179             $sqlstr_where = ' WHERE (' . implode(') ' . $implode_str . ' (', $fieldslikevalues) . ')';
 180         }
 181         unset($fieldslikevalues);
 182
 183         // Builds complete queries
 184         $sql['select_fields'] = $sqlstr_select . ' * ' . $sqlstr_from . $sqlstr_where;
 185         // here, I think we need to still use the COUNT clause, even for
 186         // VIEWs, anyway we have a WHERE clause that should limit results
 187         $sql['select_count']  = $sqlstr_select . ' COUNT(*) AS `count`' . $sqlstr_from . $sqlstr_where;
 188         $sql['delete']        = $sqlstr_delete . $sqlstr_from . $sqlstr_where;
 189
 190         return $sql;
 191     } // end of the "PMA_getSearchSqls()" function
 192
 193
 194     /**
 195      * Displays the results
 196      */
 197     $this_url_params = array(
 198         'db'    => $GLOBALS['db'],
 199         'goto'  => 'db_sql.php',
 200         'pos'   => 0,
 201         'is_js_confirmed' => 0,
 202     );
 203
 204     // Displays search string
 205     echo '<br />' . "\n"
 206         .'<table class="data">' . "\n"
 207         .'<caption class="tblHeaders">' . "\n"
 208         .sprintf(__('Search results for "<i>%s</i>" %s:'),
 209             $searched, $option_str) . "\n"
 210         .'</caption>' . "\n";
 211
 212     $num_search_result_total = 0;
 213     $odd_row = true;
 214
 215     foreach ($tables_selected as $each_table) {
 216         // Gets the SQL statements
 217         $newsearchsqls = PMA_getSearchSqls($each_table, (! empty($field_str) ? $field_str : ''), $search_str, $search_option);
 218
 219         // Executes the "COUNT" statement
 220         $res_cnt = PMA_DBI_fetch_value($newsearchsqls['select_count']);
 221         $num_search_result_total += $res_cnt;
 222
 223         $sql_query .= $newsearchsqls['select_count'];
 224
 225         echo '<tr class="noclick ' . ($odd_row ? 'odd' : 'even') . '">'
 226             .'<td>' . sprintf(_ngettext('%s match inside table <i>%s</i>', '%s matches inside table <i>%s</i>', $res_cnt), $res_cnt,
 227                 htmlspecialchars($each_table)) . "</td>\n";
 228
 229         if ($res_cnt > 0) {
 230             $this_url_params['sql_query'] = $newsearchsqls['select_fields'];
 231              $browse_result_path = 'sql.php' . PMA_generate_common_url($this_url_params);
 232              ?>
 233             <td> <a name="browse_search" href="<?php echo $browse_result_path; ?>" onclick="loadResult('<?php echo $browse_result_path ?> ',' <?php echo  $each_table?> ' , '<?php echo PMA_generate_common_url($GLOBALS['db'], $each_table)?>','<?php echo ($GLOBALS['cfg']['AjaxEnable']); ?>');return false;" ><?php echo __('Browse') ?></a>   </td>
 234             <?php
 235             $this_url_params['sql_query'] = $newsearchsqls['delete'];
 236             $delete_result_path = 'sql.php' . PMA_generate_common_url($this_url_params);
 237             ?>
 238             <td> <a name="delete_search" href="<?php echo $delete_result_path; ?>" onclick="deleteResult('<?php echo $delete_result_path ?>' , ' <?php printf(__('Delete the matches for the %s table?'), htmlspecialchars($each_table)); ?>','<?php echo ($GLOBALS['cfg']['AjaxEnable']); ?>');return false;" ><?php echo __('Delete') ?></a>   </td>
 239             <?php
 240          } else {
 241             echo '<td>&nbsp;</td>' . "\n"
 242                 .'<td>&nbsp;</td>' . "\n";
 243         }// end if else
 244         $odd_row = ! $odd_row;
 245         echo '</tr>' . "\n";
 246     } // end for
 247
 248     echo '</table>' . "\n";
 249
 250     if (count($tables_selected) > 1) {
 251         echo '<p>' . sprintf(_ngettext('<b>Total:</b> <i>%s</i> match', '<b>Total:</b> <i>%s</i> matches', $num_search_result_total),
 252             $num_search_result_total) . '</p>' . "\n";
 253     }
 254 } // end 1.
 255
 256 /**
 257  * If we are in an Ajax request, we need to exit after displaying all the HTML
 258  */
 259 if ($GLOBALS['is_ajax_request'] == true) {
 260     exit;
 261 } else {
 262     echo '</div>';//end searchresults div
 263 }
 264
 265 /**
 266  * 2. Displays the main search form
 267  */
 268 ?>
 269 <a name="db_search"></a>
 270 <form id="db_search_form"<?php echo ($GLOBALS['cfg']['AjaxEnable'] ? ' class="ajax"' : ''); ?> method="post" action="db_search.php" name="db_search">
 271 <?php echo PMA_generate_common_hidden_inputs($GLOBALS['db']); ?>
 272 <fieldset>
 273     <legend><?php echo __('Search in database'); ?></legend>
 274
 275     <table class="formlayout">
 276     <tr><td><?php echo __('Words or values to search for (wildcard: "%"):'); ?></td>
 277         <td><input type="text" name="search_str" size="60"
 278                 value="<?php echo $searched; ?>" /></td>
 279     </tr>
 280     <tr><td align="right" valign="top">
 281             <?php echo __('Find:'); ?></td>
 282             <td><?php
 283
 284 $choices = array(
 285     '1' => __('at least one of the words') . PMA_showHint(__('Words are separated by a space character (" ").')),
 286     '2' => __('all words') . PMA_showHint(__('Words are separated by a space character (" ").')),
 287     '3' => __('the exact phrase'),
 288     '4' => __('as regular expression') . ' ' . PMA_showMySQLDocu('Regexp', 'Regexp')
 289 );
 290 // 4th parameter set to true to add line breaks
 291 // 5th parameter set to false to avoid htmlspecialchars() escaping in the label
 292 //  since we have some HTML in some labels
 293 PMA_display_html_radio('search_option', $choices, $search_option, true, false);
 294 unset($choices);
 295             ?>
 296             </td>
 297     </tr>
 298     <tr><td align="right" valign="top">
 299             <?php echo __('Inside tables:'); ?></td>
 300         <td rowspan="2">
 301 <?php
 302 echo '            <select name="table_select[]" size="6" multiple="multiple">' . "\n";
 303 foreach ($tables_names_only as $each_table) {
 304     if (in_array($each_table, $tables_selected)) {
 305         $is_selected = ' selected="selected"';
 306     } else {
 307         $is_selected = '';
 308     }
 309
 310     echo '                <option value="' . htmlspecialchars($each_table) . '"'
 311         . $is_selected . '>'
 312         . str_replace(' ', '&nbsp;', htmlspecialchars($each_table)) . '</option>' . "\n";
 313 } // end while
 314
 315 echo '            </select>' . "\n";
 316 $alter_select =
 317     '<a href="db_search.php' . PMA_generate_common_url(array_merge($url_params, array('selectall' => 1))) . '#db_search"'
 318     . ' onclick="setSelectOptions(\'db_search\', \'table_select[]\', true); return false;">' . __('Select All') . '</a>'
 319     . '&nbsp;/&nbsp;'
 320     . '<a href="db_search.php' . PMA_generate_common_url(array_merge($url_params, array('unselectall' => 1))) . '#db_search"'
 321     . ' onclick="setSelectOptions(\'db_search\', \'table_select[]\', false); return false;">' . __('Unselect All') . '</a>';
 322 ?>
 323         </td>
 324     </tr>
 325     <tr><td align="right" valign="bottom">
 326             <?php echo $alter_select; ?></td>
 327     </tr>
 328     <tr><td align="right">
 329             <?php echo __('Inside column:'); ?></td>
 330         <td><input type="text" name="field_str" size="60"
 331                 value="<?php echo ! empty($field_str) ? htmlspecialchars($field_str) : ''; ?>" /></td>
 332     </tr>
 333     </table>
 334 </fieldset>
 335 <fieldset class="tblFooters">
 336     <input type="submit" name="submit_search" value="<?php echo __('Go'); ?>"
 337         id="buttonGo" />
 338 </fieldset>
 339 </form>
 340
 341 <!-- These two table-image and table-link elements display the table name in browse search results  -->
 342 <div id='table-info'>
 343 <a class="item" id="table-link" ></a>
 344 </div>
 345 <div id="browse-results">
 346 <!-- this browse-results div is used to load the browse and delete results in the db search -->
 347 </div>
 348 <br class="clearfloat" />
 349 <div id="sqlqueryform">
 350 <!-- this sqlqueryform div is used to load the delete form in the db search -->
 351 </div>
 352 <!--  toggle query box link-->
 353 <a id="togglequerybox"></a>
 354
 355 <?php
 356 /**
 357  * Displays the footer
 358  */
 359 require './libraries/footer.inc.php';
 360 ?>