libraries/import.lib.php

   1 <?php
   2 /* $Id$ */
   3 // vim: expandtab sw=4 ts=4 sts=4:
   4
   5 /* Library that provides common import functions that are used by import plugins */
   6
   7 // We need to know something about user
   8 require_once('./libraries/check_user_privileges.lib.php');
   9 // We do this check
  10 define('PMA_CHK_DROP', 1);
  11
  12 /**
  13  *  Check whether timeout is getting close
  14  *
  15  *  @return boolean true if timeout is close
  16  *  @access public
  17  */
  18 function PMA_checkTimeout()
  19 {
  20     global $timestamp, $maximum_time, $timeout_passed;
  21     if ($maximum_time == 0) {
  22         return FALSE;
  23     } elseif ($timeout_passed) {
  24         return TRUE;
  25     /* 5 in next row might be too much */
  26     } elseif ((time() - $timestamp) > ($maximum_time - 5)) {
  27         $timeout_passed = TRUE;
  28         return TRUE;
  29     } else {
  30         return FALSE;
  31     }
  32 }
  33
  34 /**
  35  *  Detects what compression filse uses
  36  *
  37  *  @param  string filename to check
  38  *  @return string MIME type of compression, none for none
  39  *  @access public
  40  */
  41 function PMA_detectCompression($filepath)
  42 {
  43     $file = @fopen($filepath, 'rb');
  44     if (!$file) {
  45         return FALSE;
  46     }
  47     $test = fread($file, 4);
  48     fclose($file);
  49     if ($test[0] == chr(31) && $test[1] == chr(139)) {
  50         return 'application/gzip';
  51     }
  52     if (substr($test, 0, 3) == 'BZh') {
  53         return 'application/bzip2';
  54     }
  55     if ($test == "PK\003\004") {
  56         return 'application/zip';
  57     }
  58     return 'none';
  59 }
  60
  61 /**
  62  *  Runs query inside import buffer. This is needed to allow displaying
  63  *  of last SELECT, SHOW or HANDLER results and similar nice stuff.
  64  *
  65  *  @param  string query to run
  66  *  @param  string query to display, this might be commented
  67  *  @access public
  68  */
  69 function PMA_importRunQuery($sql = '', $full = '')
  70 {
  71     global $import_run_buffer, $go_sql, $complete_query, $display_query, $sql_query, $cfg, $my_die, $error, $reload, $finished, $timeout_passed, $skip_queries, $executed_queries, $max_sql_len, $read_multiply, $cfg, $sql_query_disabled, $db, $run_query, $is_superuser, $message, $show_error_header;
  72     $read_multiply = 1;
  73     if (isset($import_run_buffer)) {
  74         // Should we skip something?
  75         if ($skip_queries > 0) {
  76             $skip_queries--;
  77         } else {
  78             if (!empty($import_run_buffer['sql']) && trim($import_run_buffer['sql']) != '') {
  79                 $max_sql_len = max($max_sql_len, strlen($import_run_buffer['sql']));
  80                 if (!$sql_query_disabled) {
  81                     $sql_query .= $import_run_buffer['full'];
  82                 }
  83                 if (!$cfg['AllowUserDropDatabase']
  84                     && !$is_superuser
  85                     && preg_match('@^[[:space:]]*DROP[[:space:]]+(IF EXISTS[[:space:]]+)?DATABASE @i', $import_run_buffer['sql'])) {
  86                     $message = $GLOBALS['strNoDropDatabases'];
  87                     $show_error_header = TRUE;
  88                     $error = TRUE;
  89                 } else {
  90                     $executed_queries++;
  91                     if ($run_query && $finished && empty($sql) && !$error && (
  92                             (!empty($import_run_buffer['sql']) && preg_match('/^[\s]*(SELECT|SHOW|HANDLER)/i', $import_run_buffer['sql'])) ||
  93                             ($executed_queries == 1)
  94                             )) {
  95                         $go_sql = TRUE;
  96                         if (!$sql_query_disabled) {
  97                             $complete_query = $sql_query;
  98                             $display_query = $sql_query;
  99                         } else {
 100                             $complete_query = '';
 101                             $display_query = '';
 102                         }
 103                         $sql_query = $import_run_buffer['sql'];
 104                     } elseif ($run_query) {
 105                         $result = PMA_DBI_try_query($import_run_buffer['sql']);
 106                         $msg = '# ';
 107                         if ($result === FALSE) { // execution failed
 108                             if (!isset($my_die)) {
 109                                 $my_die = array();
 110                             }
 111                             $my_die[] = array('sql' => $import_run_buffer['full'], 'error' => PMA_DBI_getError());
 112
 113                             if ($cfg['VerboseMultiSubmit']) {
 114                                 $msg .= $GLOBALS['strError'];
 115                             }
 116
 117                             if (!$cfg['IgnoreMultiSubmitErrors']) {
 118                                 $error = TRUE;
 119                                 return;
 120                             }
 121                         } elseif ($cfg['VerboseMultiSubmit']) {
 122                             $a_num_rows = (int)@PMA_DBI_num_rows($result);
 123                             $a_aff_rows = (int)@PMA_DBI_affected_rows();
 124                             if ($a_num_rows > 0) {
 125                                 $msg .= $GLOBALS['strRows'] . ': ' . $a_num_rows;
 126                             } elseif ($a_aff_rows > 0) {
 127                                 $a_rows =
 128                                 $msg .= $GLOBALS['strAffectedRows'] . ' ' . $a_aff_rows;
 129                             } else {
 130                                 $msg .= $GLOBALS['strEmptyResultSet'];
 131                             }
 132                         }
 133                         if (!$sql_query_disabled) {
 134                             $sql_query .= $msg . "\n";
 135                         }
 136
 137                         // If a 'USE <db>' SQL-clause was found and the query succeeded, set our current $db to the new one
 138                         if ($result != FALSE && preg_match('@^[\s]*USE[[:space:]]*([\S]+)@i', $import_run_buffer['sql'], $match)) {
 139                             $db = trim($match[1]);
 140                             $db = trim($db,';'); // for example, USE abc;
 141                             $reload = TRUE;
 142                         }
 143
 144                         if ($result != FALSE && preg_match('@^[\s]*(DROP|CREATE)[\s]+(IF EXISTS[[:space:]]+)?(TABLE|DATABASE)[[:space:]]+(.+)@im', $import_run_buffer['sql'])) {
 145                             $reload = TRUE;
 146                         }
 147                     } // end run query
 148                 } // end if not DROP DATABASE
 149             } // end non empty query
 150             elseif (!empty($import_run_buffer['full'])) {
 151                 if ($go_sql) {
 152                     $complete_query .= $import_run_buffer['full'];
 153                     $display_query .= $import_run_buffer['full'];
 154                 } else {
 155                     if (!$sql_query_disabled) {
 156                         $sql_query .= $import_run_buffer['full'];
 157                     }
 158                 }
 159             }
 160             // check length of query unless we decided to pass it to sql.php
 161             if (!$go_sql) {
 162                 if ($cfg['VerboseMultiSubmit'] && !empty($sql_query)) {
 163                     if (strlen($sql_query) > 50000 || $executed_queries > 50 || $max_sql_len > 1000) {
 164                         $sql_query = '';
 165                         $sql_query_disabled = TRUE;
 166                     }
 167                 } else {
 168                     if (strlen($sql_query) > 10000 || $executed_queries > 10 || $max_sql_len > 500) {
 169                         $sql_query = '';
 170                         $sql_query_disabled = TRUE;
 171                     }
 172                 }
 173             }
 174         } // end do query (no skip)
 175     } // end buffer exists
 176
 177     // Do we have something to push into buffer?
 178     if (!empty($sql) || !empty($full)) {
 179         $import_run_buffer = array('sql' => $sql, 'full' => $full);
 180     } else {
 181         unset($GLOBALS['import_run_buffer']);
 182     }
 183 }
 184
 185
 186 /**
 187  *  Returns next part of imported file/buffer
 188  *
 189  *  @param  integer size of buffer to read (this is maximal size
 190  *                  function will return)
 191  *  @return string part of file/buffer
 192  *  @access public
 193  */
 194 function PMA_importGetNextChunk($size = 32768)
 195 {
 196     global $import_file, $import_text, $finished, $compression, $import_handle, $offset, $charset_conversion, $charset_of_file, $charset, $read_multiply, $read_limit;
 197
 198     // Add some progression while reading large amount of data
 199     if ($read_multiply <= 8) {
 200         $size *= $read_multiply;
 201     } else {
 202         $size *= 8;
 203     }
 204     $read_multiply++;
 205
 206     // We can not read too much
 207     if ($size > $read_limit) {
 208         $size = $read_limit;
 209     }
 210
 211     if (PMA_checkTimeout()) {
 212         return FALSE;
 213     }
 214     if ($finished) {
 215         return TRUE;
 216     }
 217
 218     if ($import_file == 'none') {
 219         // Well this is not yet supported and tested, but should return content of textarea
 220         if (strlen($import_text) < $size) {
 221             $finished = TRUE;
 222             return $import_text;
 223         } else {
 224             $r = substr($import_text, 0, $size);
 225             $offset += $size;
 226             $import_text = substr($import_text, $size);
 227             return $r;
 228         }
 229     }
 230
 231     switch ($compression) {
 232         case 'application/bzip2':
 233             $result = bzread($import_handle, $size);
 234             $finished = feof($import_handle);
 235             break;
 236         case 'application/gzip':
 237             $result = gzread($import_handle, $size);
 238             $finished = feof($import_handle);
 239             break;
 240         case 'application/zip':
 241             $result = substr($import_text, 0, $size);
 242             $import_text = substr($import_text, $size);
 243             $finished = empty($import_text);
 244             break;
 245         case 'none':
 246             $result = fread($import_handle, $size);
 247             $finished = feof($import_handle);
 248             break;
 249     }
 250     $offset += $size;
 251
 252     if ($charset_conversion) {
 253         return PMA_convert_string($charset_of_file, $charset, $result);
 254     } else {
 255         // Skip possible byte order marks (I do not think we need more
 256         // charsets, but feel free to add more, you can use wikipedia for
 257         // reference: <http://en.wikipedia.org/wiki/Byte_Order_Mark>)
 258         // @TODO: BOM could be used for charset autodetection
 259         if ($offset == $size) {
 260             // UTF-8
 261             if (strncmp($result, "\xEF\xBB\xBF", 3) == 0) {
 262                 $result = substr($result, 3);
 263             // UTF-16 BE, LE
 264             } elseif (strncmp($result, "\xFE\xFF", 2) == 0 || strncmp($result, "\xFF\xFE", 2) == 0) {
 265                 $result = substr($result, 2);
 266             }
 267         }
 268         return $result;
 269     }
 270 }
 271
 272
 273
 274 ?>