Converting number of Excel column names no longer limited
[phpmyadmin/arisferyanto.git] / libraries / import.lib.php
blob6c039bd6e7fbb9994c56f8b2679cec01835fe967
1 <?php
2 /* vim: set expandtab sw=4 ts=4 sts=4: */
3 /**
4 * Library that provides common import functions that are used by import plugins
6 * @version $Id$
7 * @package phpMyAdmin
8 */
9 if (! defined('PHPMYADMIN')) {
10 exit;
13 /**
14 * We need to know something about user
16 require_once './libraries/check_user_privileges.lib.php';
18 /**
19 * We do this check, DROP DATABASE does not need to be confirmed elsewhere
21 define('PMA_CHK_DROP', 1);
23 /**
24 * Check whether timeout is getting close
26 * @return boolean true if timeout is close
27 * @access public
29 function PMA_checkTimeout()
31 global $timestamp, $maximum_time, $timeout_passed;
32 if ($maximum_time == 0) {
33 return FALSE;
34 } elseif ($timeout_passed) {
35 return TRUE;
36 /* 5 in next row might be too much */
37 } elseif ((time() - $timestamp) > ($maximum_time - 5)) {
38 $timeout_passed = TRUE;
39 return TRUE;
40 } else {
41 return FALSE;
45 /**
46 * Detects what compression filse uses
48 * @param string filename to check
49 * @return string MIME type of compression, none for none
50 * @access public
52 function PMA_detectCompression($filepath)
54 $file = @fopen($filepath, 'rb');
55 if (!$file) {
56 return FALSE;
58 $test = fread($file, 4);
59 $len = strlen($test);
60 fclose($file);
61 if ($len >= 2 && $test[0] == chr(31) && $test[1] == chr(139)) {
62 return 'application/gzip';
64 if ($len >= 3 && substr($test, 0, 3) == 'BZh') {
65 return 'application/bzip2';
67 if ($len >= 4 && $test == "PK\003\004") {
68 return 'application/zip';
70 return 'none';
73 /**
74 * Runs query inside import buffer. This is needed to allow displaying
75 * of last SELECT, SHOW or HANDLER results and similar nice stuff.
77 * @uses $GLOBALS['finished'] read and write
78 * @param string query to run
79 * @param string query to display, this might be commented
80 * @param bool whether to use control user for queries
81 * @access public
83 function PMA_importRunQuery($sql = '', $full = '', $controluser = false)
85 global $import_run_buffer, $go_sql, $complete_query, $display_query,
86 $sql_query, $my_die, $error, $reload,
87 $last_query_with_results,
88 $skip_queries, $executed_queries, $max_sql_len, $read_multiply,
89 $cfg, $sql_query_disabled, $db, $run_query, $is_superuser;
90 $read_multiply = 1;
91 if (isset($import_run_buffer)) {
92 // Should we skip something?
93 if ($skip_queries > 0) {
94 $skip_queries--;
95 } else {
96 if (!empty($import_run_buffer['sql']) && trim($import_run_buffer['sql']) != '') {
97 $max_sql_len = max($max_sql_len, strlen($import_run_buffer['sql']));
98 if (!$sql_query_disabled) {
99 $sql_query .= $import_run_buffer['full'];
101 if (!$cfg['AllowUserDropDatabase']
102 && !$is_superuser
103 && preg_match('@^[[:space:]]*DROP[[:space:]]+(IF EXISTS[[:space:]]+)?DATABASE @i', $import_run_buffer['sql'])) {
104 $GLOBALS['message'] = PMA_Message::error('strNoDropDatabases');
105 $error = TRUE;
106 } else {
107 $executed_queries++;
108 if ($run_query && $GLOBALS['finished'] && empty($sql) && !$error && (
109 (!empty($import_run_buffer['sql']) && preg_match('/^[\s]*(SELECT|SHOW|HANDLER)/i', $import_run_buffer['sql'])) ||
110 ($executed_queries == 1)
111 )) {
112 $go_sql = TRUE;
113 if (!$sql_query_disabled) {
114 $complete_query = $sql_query;
115 $display_query = $sql_query;
116 } else {
117 $complete_query = '';
118 $display_query = '';
120 $sql_query = $import_run_buffer['sql'];
121 } elseif ($run_query) {
122 if ($controluser) {
123 $result = PMA_query_as_controluser($import_run_buffer['sql']);
124 } else {
125 $result = PMA_DBI_try_query($import_run_buffer['sql']);
127 $msg = '# ';
128 if ($result === FALSE) { // execution failed
129 if (!isset($my_die)) {
130 $my_die = array();
132 $my_die[] = array('sql' => $import_run_buffer['full'], 'error' => PMA_DBI_getError());
134 if ($cfg['VerboseMultiSubmit']) {
135 $msg .= $GLOBALS['strError'];
138 if (!$cfg['IgnoreMultiSubmitErrors']) {
139 $error = TRUE;
140 return;
142 } elseif ($cfg['VerboseMultiSubmit']) {
143 $a_num_rows = (int)@PMA_DBI_num_rows($result);
144 $a_aff_rows = (int)@PMA_DBI_affected_rows();
145 if ($a_num_rows > 0) {
146 $msg .= $GLOBALS['strRows'] . ': ' . $a_num_rows;
147 $last_query_with_results = $import_run_buffer['sql'];
148 } elseif ($a_aff_rows > 0) {
149 $msg .= sprintf($GLOBALS['strRowsAffected'], $a_aff_rows);
150 } else {
151 $msg .= $GLOBALS['strEmptyResultSet'];
154 if (!$sql_query_disabled) {
155 $sql_query .= $msg . "\n";
158 // If a 'USE <db>' SQL-clause was found and the query succeeded, set our current $db to the new one
159 if ($result != FALSE && preg_match('@^[\s]*USE[[:space:]]*([\S]+)@i', $import_run_buffer['sql'], $match)) {
160 $db = trim($match[1]);
161 $db = trim($db,';'); // for example, USE abc;
162 $reload = TRUE;
165 if ($result != FALSE && preg_match('@^[\s]*(DROP|CREATE)[\s]+(IF EXISTS[[:space:]]+)?(TABLE|DATABASE)[[:space:]]+(.+)@im', $import_run_buffer['sql'])) {
166 $reload = TRUE;
168 } // end run query
169 } // end if not DROP DATABASE
170 } // end non empty query
171 elseif (!empty($import_run_buffer['full'])) {
172 if ($go_sql) {
173 $complete_query .= $import_run_buffer['full'];
174 $display_query .= $import_run_buffer['full'];
175 } else {
176 if (!$sql_query_disabled) {
177 $sql_query .= $import_run_buffer['full'];
181 // check length of query unless we decided to pass it to sql.php
182 // (if $run_query is false, we are just displaying so show
183 // the complete query in the textarea)
184 if (! $go_sql && $run_query) {
185 if ($cfg['VerboseMultiSubmit'] && ! empty($sql_query)) {
186 if (strlen($sql_query) > 50000 || $executed_queries > 50 || $max_sql_len > 1000) {
187 $sql_query = '';
188 $sql_query_disabled = TRUE;
190 } else {
191 if (strlen($sql_query) > 10000 || $executed_queries > 10 || $max_sql_len > 500) {
192 $sql_query = '';
193 $sql_query_disabled = TRUE;
197 } // end do query (no skip)
198 } // end buffer exists
200 // Do we have something to push into buffer?
201 if (!empty($sql) || !empty($full)) {
202 $import_run_buffer = array('sql' => $sql, 'full' => $full);
203 } else {
204 unset($GLOBALS['import_run_buffer']);
210 * Returns next part of imported file/buffer
212 * @uses $GLOBALS['offset'] read and write
213 * @uses $GLOBALS['import_file'] read only
214 * @uses $GLOBALS['import_text'] read and write
215 * @uses $GLOBALS['finished'] read and write
216 * @uses $GLOBALS['read_limit'] read only
217 * @param integer size of buffer to read (this is maximal size
218 * function will return)
219 * @return string part of file/buffer
220 * @access public
222 function PMA_importGetNextChunk($size = 32768)
224 global $compression, $import_handle, $charset_conversion, $charset_of_file,
225 $charset, $read_multiply;
227 // Add some progression while reading large amount of data
228 if ($read_multiply <= 8) {
229 $size *= $read_multiply;
230 } else {
231 $size *= 8;
233 $read_multiply++;
235 // We can not read too much
236 if ($size > $GLOBALS['read_limit']) {
237 $size = $GLOBALS['read_limit'];
240 if (PMA_checkTimeout()) {
241 return FALSE;
243 if ($GLOBALS['finished']) {
244 return TRUE;
247 if ($GLOBALS['import_file'] == 'none') {
248 // Well this is not yet supported and tested, but should return content of textarea
249 if (strlen($GLOBALS['import_text']) < $size) {
250 $GLOBALS['finished'] = TRUE;
251 return $GLOBALS['import_text'];
252 } else {
253 $r = substr($GLOBALS['import_text'], 0, $size);
254 $GLOBALS['offset'] += $size;
255 $GLOBALS['import_text'] = substr($GLOBALS['import_text'], $size);
256 return $r;
260 switch ($compression) {
261 case 'application/bzip2':
262 $result = bzread($import_handle, $size);
263 $GLOBALS['finished'] = feof($import_handle);
264 break;
265 case 'application/gzip':
266 $result = gzread($import_handle, $size);
267 $GLOBALS['finished'] = feof($import_handle);
268 break;
269 case 'application/zip':
270 $result = substr($GLOBALS['import_text'], 0, $size);
271 $GLOBALS['import_text'] = substr($GLOBALS['import_text'], $size);
272 $GLOBALS['finished'] = empty($GLOBALS['import_text']);
273 break;
274 case 'none':
275 $result = fread($import_handle, $size);
276 $GLOBALS['finished'] = feof($import_handle);
277 break;
279 $GLOBALS['offset'] += $size;
281 if ($charset_conversion) {
282 return PMA_convert_string($charset_of_file, $charset, $result);
283 } else {
285 * Skip possible byte order marks (I do not think we need more
286 * charsets, but feel free to add more, you can use wikipedia for
287 * reference: <http://en.wikipedia.org/wiki/Byte_Order_Mark>)
289 * @todo BOM could be used for charset autodetection
291 if ($GLOBALS['offset'] == $size) {
292 // UTF-8
293 if (strncmp($result, "\xEF\xBB\xBF", 3) == 0) {
294 $result = substr($result, 3);
295 // UTF-16 BE, LE
296 } elseif (strncmp($result, "\xFE\xFF", 2) == 0 || strncmp($result, "\xFF\xFE", 2) == 0) {
297 $result = substr($result, 2);
300 return $result;
305 * Returns the "Excel" column name (i.e. 1 = "A", 26 = "Z", 27 = "AA", etc.)
307 * This functions uses recursion to build the Excel column name.
309 * The column number (1-26) is converted to the responding ASCII character (A-Z) and returned.
311 * If the column number is bigger than 26 (= num of letters in alfabet),
312 * an extra character needs to be added. To find this extra character, the number is divided by 26
313 * and this value is passed to another instance of the same function (hence recursion).
314 * In that new instance the number is evaluated again, and if it is still bigger than 26, it is divided again
315 * and passed to another instance of the same function. This continues until the number is smaller than 26.
316 * Then the last called function returns the corresponding ASCII character to the function that called it.
317 * Each time a called function ends an extra character is added to the column name.
318 * When the first function is reached, the last character is addded and the complete column name is returned.
320 * @access public
322 * @uses chr()
323 * @param int $num
324 * @return string The column's "Excel" name
326 function PMA_getColumnAlphaName($num)
328 $A = 65; // ASCII value for capital "A"
329 $col_name = "";
331 if ($num > 26) {
332 $div = (int)($num / 26);
333 $remain = (int)($num % 26);
335 // subtract 1 of divided value in case the modulus is 0,
336 // this is necessary because A-Z has no 'zero'
337 if ($remain == 0) {
338 $div--;
341 // recursive function call
342 $col_name = PMA_getColumnAlphaName($div);
343 // use modulus as new column number
344 $num = $remain;
347 if ($num == 0) {
348 // use 'Z' if column number is 0,
349 // this is necessary because A-Z has no 'zero'
350 $col_name .= chr(($A + 26) - 1);
351 } else {
352 // convert column number to ASCII character
353 $col_name .= chr(($A + $num) - 1);
356 return $col_name;
360 * Returns the column number based on the Excel name.
361 * So "A" = 1, "Z" = 26, "AA" = 27, etc.
363 * Basicly this is a base26 (A-Z) to base10 (0-9) conversion.
364 * It iterates through all characters in the column name and
365 * calculates the corresponding value, based on character value
366 * (A = 1, ..., Z = 26) and position in the string.
368 * @access public
370 * @uses strtoupper()
371 * @uses strlen()
372 * @uses ord()
373 * @param string $name (i.e. "A", or "BC", etc.)
374 * @return int The column number
376 function PMA_getColumnNumberFromName($name) {
377 if (!empty($name)) {
378 $name = strtoupper($name);
379 $num_chars = strlen($name);
380 $column_number = 0;
381 for ($i = 0; $i < $num_chars; ++$i) {
382 // read string from back to front
383 $char_pos = ($num_chars - 1) - $i;
385 // convert capital character to ASCII value
386 // and subtract 64 to get corresponding decimal value
387 // ASCII value of "A" is 65, "B" is 66, etc.
388 // Decimal equivalent of "A" is 1, "B" is 2, etc.
389 $number = (ord($name[$char_pos]) - 64);
391 // base26 to base10 conversion : multiply each number
392 // with corresponding value of the position, in this case
393 // $i=0 : 1; $i=1 : 26; $i=2 : 676; ...
394 $column_number += $number * pow(26,$i);
396 return $column_number;
397 } else {
398 return 0;
403 * Constants definitions
406 /* MySQL type defs */
407 define("NONE", 0);
408 define("VARCHAR", 1);
409 define("INT", 2);
410 define("DECIMAL", 3);
412 /* Decimal size defs */
413 define("M", 0);
414 define("D", 1);
415 define("FULL", 2);
417 /* Table array defs */
418 define("TBL_NAME", 0);
419 define("COL_NAMES", 1);
420 define("ROWS", 2);
422 /* Analysis array defs */
423 define("TYPES", 0);
424 define("SIZES", 1);
427 * Obtains the precision (total # of digits) from a size of type decimal
429 * @author Derek Schaefer (derek.schaefer@gmail.com)
431 * @access public
433 * @uses substr()
434 * @uses strpos()
435 * @param string $last_cumulative_size
436 * @return int Precision of the given decimal size notation
438 function PMA_getM($last_cumulative_size) {
439 return (int)substr($last_cumulative_size, 0, strpos($last_cumulative_size, ","));
443 * Obtains the scale (# of digits to the right of the decimal point) from a size of type decimal
445 * @author Derek Schaefer (derek.schaefer@gmail.com)
447 * @access public
449 * @uses substr()
450 * @uses strpos()
451 * @uses strlen()
452 * @param string $last_cumulative_size
453 * @return int Scale of the given decimal size notation
455 function PMA_getD($last_cumulative_size) {
456 return (int)substr($last_cumulative_size, (strpos($last_cumulative_size, ",") + 1), (strlen($last_cumulative_size) - strpos($last_cumulative_size, ",")));
460 * Obtains the decimal size of a given cell
462 * @author Derek Schaefer (derek.schaefer@gmail.com)
464 * @access public
466 * @uses strlen()
467 * @uses strpos()
468 * @param string &$cell
469 * @return array Contains the precision, scale, and full size representation of the given decimal cell
471 function PMA_getDecimalSize(&$cell) {
472 $curr_size = strlen((string)$cell);
473 $decPos = strpos($cell, ".");
474 $decPrecision = ($curr_size - 1) - $decPos;
476 $m = $curr_size - 1;
477 $d = $decPrecision;
479 return array($m, $d, ($m . "," . $d));
483 * Obtains the size of the given cell
485 * @author Derek Schaefer (derek.schaefer@gmail.com)
487 * @todo Handle the error cases more elegantly
489 * @access public
491 * @uses M
492 * @uses D
493 * @uses FULL
494 * @uses VARCHAR
495 * @uses DECIMAL
496 * @uses INT
497 * @uses NONE
498 * @uses strcmp()
499 * @uses strlen()
500 * @uses PMA_getM()
501 * @uses PMA_getD()
502 * @uses PMA_getDecimalSize()
503 * @param string $last_cumulative_size Last cumulative column size
504 * @param int $last_cumulative_type Last cumulative column type (NONE or VARCHAR or DECIMAL or INT)
505 * @param int $curr_type Type of the current cell (NONE or VARCHAR or DECIMAL or INT)
506 * @param string &$cell The current cell
507 * @return string Size of the given cell in the type-appropriate format
509 function PMA_detectSize($last_cumulative_size, $last_cumulative_type, $curr_type, &$cell) {
510 $curr_size = strlen((string)$cell);
513 * If the cell is NULL, don't treat it as a varchar
515 if (! strcmp('NULL', $cell)) {
516 return $last_cumulative_size;
519 * What to do if the current cell is of type VARCHAR
521 elseif ($curr_type == VARCHAR) {
523 * The last cumlative type was VARCHAR
525 if ($last_cumulative_type == VARCHAR) {
526 if ($curr_size >= $last_cumulative_size) {
527 return $curr_size;
528 } else {
529 return $last_cumulative_size;
533 * The last cumlative type was DECIMAL
535 elseif ($last_cumulative_type == DECIMAL) {
536 $oldM = PMA_getM($last_cumulative_size);
538 if ($curr_size >= $oldM) {
539 return $curr_size;
540 } else {
541 return $oldM;
545 * The last cumlative type was INT
547 elseif ($last_cumulative_type == INT) {
548 if ($curr_size >= $last_cumulative_size) {
549 return $curr_size;
550 } else {
551 return $last_cumulative_size;
555 * This is the first row to be analyzed
557 elseif (! isset($last_cumulative_type) || $last_cumulative_type == NONE) {
558 return $curr_size;
561 * An error has DEFINITELY occurred
563 else {
565 * TODO: Handle this MUCH more elegantly
568 return -1;
572 * What to do if the current cell is of type DECIMAL
574 elseif ($curr_type == DECIMAL) {
576 * The last cumlative type was VARCHAR
578 if ($last_cumulative_type == VARCHAR) {
579 /* Convert $last_cumulative_size from varchar to decimal format */
580 $size = PMA_getDecimalSize($cell);
582 if ($size[M] >= $last_cumulative_size) {
583 return $size[M];
584 } else {
585 return $last_cumulative_size;
589 * The last cumlative type was DECIMAL
591 elseif ($last_cumulative_type == DECIMAL) {
592 $size = PMA_getDecimalSize($cell);
594 $oldM = PMA_getM($last_cumulative_size);
595 $oldD = PMA_getD($last_cumulative_size);
597 /* New val if M or D is greater than current largest */
598 if ($size[M] > $oldM || $size[D] > $oldD) {
599 /* Take the largest of both types */
600 return (string)((($size[M] > $oldM) ? $size[M] : $oldM) . "," . (($size[D] > $oldD) ? $size[D] : $oldD));
601 } else {
602 return $last_cumulative_size;
606 * The last cumlative type was INT
608 elseif ($last_cumulative_type == INT) {
609 /* Convert $last_cumulative_size from int to decimal format */
610 $size = PMA_getDecimalSize($cell);
612 if ($size[M] >= $last_cumulative_size) {
613 return $size[FULL];
614 } else {
615 return ($last_cumulative_size.",".$size[D]);
619 * This is the first row to be analyzed
621 elseif (! isset($last_cumulative_type) || $last_cumulative_type == NONE) {
622 /* First row of the column */
623 $size = PMA_getDecimalSize($cell);
625 return $size[FULL];
628 * An error has DEFINITELY occurred
630 else {
632 * TODO: Handle this MUCH more elegantly
635 return -1;
639 * What to do if the current cell is of type INT
641 elseif ($curr_type == INT) {
643 * The last cumlative type was VARCHAR
645 if ($last_cumulative_type == VARCHAR) {
646 if ($curr_size >= $last_cumulative_size) {
647 return $curr_size;
648 } else {
649 return $last_cumulative_size;
653 * The last cumlative type was DECIMAL
655 elseif ($last_cumulative_type == DECIMAL) {
656 $oldM = PMA_getM($last_cumulative_size);
657 $oldD = PMA_getD($last_cumulative_size);
658 $oldInt = $oldM - $oldD;
659 $newInt = strlen((string)$cell);
661 /* See which has the larger integer length */
662 if ($oldInt >= $newInt) {
663 /* Use old decimal size */
664 return $last_cumulative_size;
665 } else {
666 /* Use $newInt + $oldD as new M */
667 return (($newInt + $oldD) . "," . $oldD);
671 * The last cumlative type was INT
673 elseif ($last_cumulative_type == INT) {
674 if ($curr_size >= $last_cumulative_size) {
675 return $curr_size;
676 } else {
677 return $last_cumulative_size;
681 * This is the first row to be analyzed
683 elseif (!isset($last_cumulative_type) || $last_cumulative_type == NONE) {
684 return $curr_size;
687 * An error has DEFINITELY occurred
689 else {
691 * TODO: Handle this MUCH more elegantly
694 return -1;
698 * An error has DEFINITELY occurred
700 else {
702 * TODO: Handle this MUCH more elegantly
705 return -1;
710 * Determines what MySQL type a cell is
712 * @author Derek Schaefer (derek.schaefer@gmail.com)
714 * @access public
716 * @uses DECIMAL
717 * @uses INT
718 * @uses VARCHAR
719 * @uses NONE
720 * @uses is_numeric()
721 * @uses strcmp()
722 * @uses strpos()
723 * @uses substr_count()
724 * @param int $last_cumulative_type Last cumulative column type (VARCHAR or INT or DECIMAL or NONE)
725 * @param string &$cell String representation of the cell for which a best-fit type is to be determined
726 * @return int The MySQL type representation (VARCHAR or INT or DECIMAL or NONE)
728 function PMA_detectType($last_cumulative_type, &$cell) {
730 * If numeric, determine if decimal or int
731 * Else, we call it varchar for simplicity
734 if (! strcmp('NULL', $cell)) {
735 if ($last_cumulative_type === NULL || $last_cumulative_type == NONE) {
736 return NONE;
737 } else {
738 return $last_cumulative_type;
740 } elseif (is_numeric($cell)) {
741 if ($cell == (string)(float)$cell && strpos($cell, ".") !== false && substr_count($cell, ".") == 1) {
742 return DECIMAL;
743 } else {
744 return INT;
746 } else {
747 return VARCHAR;
752 * Determines if the column types are int, decimal, or string
754 * @author Derek Schaefer (derek.schaefer@gmail.com)
756 * @link http://wiki.phpmyadmin.net/pma/Devel:Import
758 * @todo Handle the error case more elegantly
760 * @access public
762 * @uses TBL_NAME
763 * @uses COL_NAMES
764 * @uses ROWS
765 * @uses VARCHAR
766 * @uses DECIMAL
767 * @uses INT
768 * @uses NONE
769 * @uses count()
770 * @uses is_array()
771 * @uses PMA_detectType()
772 * @uses PMA_detectSize()
773 * @param &$table array(string $table_name, array $col_names, array $rows)
774 * @return array array(array $types, array $sizes)
776 function PMA_analyzeTable(&$table) {
777 /* Get number of rows in table */
778 $numRows = count($table[ROWS]);
779 /* Get number of columns */
780 $numCols = count($table[COL_NAMES]);
781 /* Current type for each column */
782 $types = array();
783 $sizes = array();
785 /* Initialize $sizes to all 0's */
786 for ($i = 0; $i < $numCols; ++$i) {
787 $sizes[$i] = 0;
790 /* Initialize $types to NONE */
791 for ($i = 0; $i < $numCols; ++$i) {
792 $types[$i] = NONE;
795 /* Temp vars */
796 $curr_type = NONE;
797 $curr_size = 0;
799 /* If the passed array is not of the correct form, do not process it */
800 if (is_array($table) && ! is_array($table[TBL_NAME]) && is_array($table[COL_NAMES]) && is_array($table[ROWS])) {
801 /* Analyze each column */
802 for ($i = 0; $i < $numCols; ++$i) {
803 /* Analyze the column in each row */
804 for ($j = 0; $j < $numRows; ++$j) {
805 /* Determine type of the current cell */
806 $curr_type = PMA_detectType($types[$i], $table[ROWS][$j][$i]);
807 /* Determine size of the current cell */
808 $sizes[$i] = PMA_detectSize($sizes[$i], $types[$i], $curr_type, $table[ROWS][$j][$i]);
811 * If a type for this column has alreday been delcared,
812 * only alter it if it was a number and a varchar was found
814 if ($curr_type != NONE) {
815 if ($curr_type == VARCHAR) {
816 $types[$i] = VARCHAR;
817 } else if ($curr_type == DECIMAL) {
818 if ($types[$i] != VARCHAR) {
819 $types[$i] = DECIMAL;
821 } else if ($curr_type == INT) {
822 if ($types[$i] != VARCHAR && $types[$i] != DECIMAL) {
823 $types[$i] = INT;
830 /* Check to ensure that all types are valid */
831 $len = count($types);
832 for ($n = 0; $n < $len; ++$n) {
833 if (! strcmp(NONE, $types[$n])) {
834 $types[$n] = VARCHAR;
835 $sizes[$n] = '10';
839 return array($types, $sizes);
841 else
844 * TODO: Handle this better
847 return false;
851 /* Needed to quell the beast that is PMA_Message */
852 $import_notice = NULL;
855 * Builds and executes SQL statements to create the database and tables
856 * as necessary, as well as insert all the data.
858 * @author Derek Schaefer (derek.schaefer@gmail.com)
860 * @link http://wiki.phpmyadmin.net/pma/Devel:Import
862 * @access public
864 * @uses TBL_NAME
865 * @uses COL_NAMES
866 * @uses ROWS
867 * @uses TYPES
868 * @uses SIZES
869 * @uses strcmp()
870 * @uses count()
871 * @uses preg_match()
872 * @uses preg_replace()
873 * @uses PMA_isView()
874 * @uses PMA_backquote()
875 * @uses PMA_importRunQuery()
876 * @uses PMA_generate_common_url()
877 * @uses PMA_Message::notice()
878 * @param string $db_name Name of the database
879 * @param array &$tables Array of tables for the specified database
880 * @param array &$analyses = NULL Analyses of the tables
881 * @param array &$additional_sql = NULL Additional SQL statements to be executed
882 * @param array $options = NULL Associative array of options
883 * @return void
885 function PMA_buildSQL($db_name, &$tables, &$analyses = NULL, &$additional_sql = NULL, $options = NULL) {
886 /* Take care of the options */
887 if (isset($options['db_collation'])) {
888 $collation = $options['db_collation'];
889 } else {
890 $collation = "utf8_general_ci";
893 if (isset($options['db_charset'])) {
894 $charset = $options['db_charset'];
895 } else {
896 $charset = "utf8";
899 if (isset($options['create_db'])) {
900 $create_db = $options['create_db'];
901 } else {
902 $create_db = true;
905 /* Create SQL code to handle the database */
906 $sql = array();
908 if ($create_db) {
909 $sql[] = "CREATE DATABASE IF NOT EXISTS " . PMA_backquote($db_name) . " DEFAULT CHARACTER SET " . $charset . " COLLATE " . $collation;
913 * The calling plug-in should include this statement, if necessary, in the $additional_sql parameter
915 * $sql[] = "USE " . PMA_backquote($db_name);
918 /* Execute the SQL statements create above */
919 $sql_len = count($sql);
920 for ($i = 0; $i < $sql_len; ++$i) {
921 PMA_importRunQuery($sql[$i], $sql[$i]);
924 /* No longer needed */
925 unset($sql);
927 /* Run the $additional_sql statements supplied by the caller plug-in */
928 if ($additional_sql != NULL) {
929 /* Clean the SQL first */
930 $additional_sql_len = count($additional_sql);
933 * Only match tables for now, because CREATE IF NOT EXISTS
934 * syntax is lacking or nonexisting for views, triggers,
935 * functions, and procedures.
937 * See: http://bugs.mysql.com/bug.php?id=15287
939 * To the best of my knowledge this is still an issue.
941 * $pattern = 'CREATE (TABLE|VIEW|TRIGGER|FUNCTION|PROCEDURE)';
943 $pattern = '/CREATE .*(TABLE)/';
944 $replacement = 'CREATE \\1 IF NOT EXISTS';
946 /* Change CREATE statements to CREATE IF NOT EXISTS to support inserting into existing structures */
947 for ($i = 0; $i < $additional_sql_len; ++$i) {
948 $additional_sql[$i] = preg_replace($pattern, $replacement, $additional_sql[$i]);
949 /* Execute the resulting statements */
950 PMA_importRunQuery($additional_sql[$i], $additional_sql[$i]);
954 if ($analyses != NULL) {
955 $type_array = array(NONE => "NULL", VARCHAR => "varchar", INT => "int", DECIMAL => "decimal");
957 /* TODO: Do more checking here to make sure they really are matched */
958 if (count($tables) != count($analyses)) {
959 exit();
962 /* Create SQL code to create the tables */
963 $tempSQLStr = "";
964 $num_tables = count($tables);
965 for ($i = 0; $i < $num_tables; ++$i) {
966 $num_cols = count($tables[$i][COL_NAMES]);
967 $tempSQLStr = "CREATE TABLE IF NOT EXISTS " . PMA_backquote($db_name) . '.' . PMA_backquote($tables[$i][TBL_NAME]) . " (";
968 for ($j = 0; $j < $num_cols; ++$j) {
969 $size = $analyses[$i][SIZES][$j];
970 if ((int)$size == 0) {
971 $size = 10;
974 $tempSQLStr .= PMA_backquote($tables[$i][COL_NAMES][$j]) . " " . $type_array[$analyses[$i][TYPES][$j]] . "(" . $size . ")";
976 if ($j != (count($tables[$i][COL_NAMES]) - 1)) {
977 $tempSQLStr .= ", ";
980 $tempSQLStr .= ") ENGINE=MyISAM DEFAULT CHARACTER SET " . $charset . " COLLATE " . $collation . ";";
983 * Each SQL statement is executed immediately
984 * after it is formed so that we don't have
985 * to store them in a (possibly large) buffer
987 PMA_importRunQuery($tempSQLStr, $tempSQLStr);
992 * Create the SQL statements to insert all the data
994 * Only one insert query is formed for each table
996 $tempSQLStr = "";
997 $col_count = 0;
998 $num_tables = count($tables);
999 for ($i = 0; $i < $num_tables; ++$i) {
1000 $num_cols = count($tables[$i][COL_NAMES]);
1001 $num_rows = count($tables[$i][ROWS]);
1003 $tempSQLStr = "INSERT INTO " . PMA_backquote($db_name) . '.' . PMA_backquote($tables[$i][TBL_NAME]) . " (";
1005 for ($m = 0; $m < $num_cols; ++$m) {
1006 $tempSQLStr .= PMA_backquote($tables[$i][COL_NAMES][$m]);
1008 if ($m != ($num_cols - 1)) {
1009 $tempSQLStr .= ", ";
1013 $tempSQLStr .= ") VALUES ";
1015 for ($j = 0; $j < $num_rows; ++$j) {
1016 $tempSQLStr .= "(";
1018 for ($k = 0; $k < $num_cols; ++$k) {
1019 if ($analyses != NULL) {
1020 $is_varchar = ($analyses[$i][TYPES][$col_count] === VARCHAR);
1021 } else {
1022 $is_varchar = !is_numeric($tables[$i][ROWS][$j][$k]);
1025 /* Don't put quotes around NULL fields */
1026 if (! strcmp($tables[$i][ROWS][$j][$k], 'NULL')) {
1027 $is_varchar = false;
1030 $tempSQLStr .= (($is_varchar) ? "'" : "");
1031 $tempSQLStr .= PMA_sqlAddslashes((string)$tables[$i][ROWS][$j][$k]);
1032 $tempSQLStr .= (($is_varchar) ? "'" : "");
1034 if ($k != ($num_cols - 1)) {
1035 $tempSQLStr .= ", ";
1038 if ($col_count == ($num_cols - 1)) {
1039 $col_count = 0;
1040 } else {
1041 $col_count++;
1044 /* Delete the cell after we are done with it */
1045 unset($tables[$i][ROWS][$j][$k]);
1048 $tempSQLStr .= ")";
1050 if ($j != ($num_rows - 1)) {
1051 $tempSQLStr .= ",\n ";
1054 $col_count = 0;
1055 /* Delete the row after we are done with it */
1056 unset($tables[$i][ROWS][$j]);
1059 $tempSQLStr .= ";";
1062 * Each SQL statement is executed immediately
1063 * after it is formed so that we don't have
1064 * to store them in a (possibly large) buffer
1066 PMA_importRunQuery($tempSQLStr, $tempSQLStr);
1069 /* No longer needed */
1070 unset($tempSQLStr);
1073 * A work in progress
1076 /* Add the viewable structures from $additional_sql to $tables so they are also displayed */
1078 $view_pattern = '@VIEW `[^`]+`\.`([^`]+)@';
1079 $table_pattern = '@CREATE TABLE IF NOT EXISTS `([^`]+)`@';
1080 /* Check a third pattern to make sure its not a "USE `db_name`;" statement */
1082 $regs = array();
1084 $inTables = false;
1086 $additional_sql_len = count($additional_sql);
1087 for ($i = 0; $i < $additional_sql_len; ++$i) {
1088 preg_match($view_pattern, $additional_sql[$i], $regs);
1090 if (count($regs) == 0) {
1091 preg_match($table_pattern, $additional_sql[$i], $regs);
1094 if (count($regs)) {
1095 for ($n = 0; $n < $num_tables; ++$n) {
1096 if (!strcmp($regs[1], $tables[$n][TBL_NAME])) {
1097 $inTables = true;
1098 break;
1102 if (!$inTables) {
1103 $tables[] = array(TBL_NAME => $regs[1]);
1107 /* Reset the array */
1108 $regs = array();
1109 $inTables = false;
1112 $params = array('db' => (string)$db_name);
1113 $db_url = 'db_structure.php' . PMA_generate_common_url($params);
1114 $db_ops_url = 'db_operations.php' . PMA_generate_common_url($params);
1116 $message = '<br /><br />';
1117 $message .= '<strong>' . $GLOBALS['strImportNoticePt1'] . '</strong><br />';
1118 $message .= '<ul><li>' . $GLOBALS['strImportNoticePt2'] . '</li>';
1119 $message .= '<li>' . $GLOBALS['strImportNoticePt3'] . '</li>';
1120 $message .= '<li>' . $GLOBALS['strImportNoticePt4'] . '</li>';
1121 $message .= sprintf('<br /><li><a href="%s" title="%s">%s</a> (<a href="%s" title="%s">' . $GLOBALS['strOptions'] . '</a>)</li>',
1122 $db_url,
1123 $GLOBALS['strGoToDatabase'] . ': ' . PMA_backquote($db_name),
1124 $db_name,
1125 $db_ops_url,
1126 $GLOBALS['strEdit'] . ' ' . PMA_backquote($db_name) . ' ' . $GLOBALS['strSettings']);
1128 $message .= '<ul>';
1130 unset($params);
1132 $num_tables = count($tables);
1133 for ($i = 0; $i < $num_tables; ++$i)
1135 $params = array('db' => (string)$db_name, 'table' => (string)$tables[$i][TBL_NAME]);
1136 $tbl_url = 'sql.php' . PMA_generate_common_url($params);
1137 $tbl_struct_url = 'tbl_structure.php' . PMA_generate_common_url($params);
1138 $tbl_ops_url = 'tbl_operations.php' . PMA_generate_common_url($params);
1140 unset($params);
1142 if (! PMA_isView($db_name, $tables[$i][TBL_NAME])) {
1143 $message .= sprintf('<li><a href="%s" title="%s">%s</a> (<a href="%s" title="%s">' . $GLOBALS['strStructure'] . '</a>) (<a href="%s" title="%s">' . $GLOBALS['strOptions'] . '</a>)</li>',
1144 $tbl_url,
1145 $GLOBALS['strGoToTable'] . ': ' . PMA_backquote($tables[$i][TBL_NAME]),
1146 $tables[$i][TBL_NAME],
1147 $tbl_struct_url,
1148 PMA_backquote($tables[$i][TBL_NAME]) . ' ' . $GLOBALS['strStructureLC'],
1149 $tbl_ops_url,
1150 $GLOBALS['strEdit'] . ' ' . PMA_backquote($tables[$i][TBL_NAME]) . ' ' . $GLOBALS['strSettings']);
1151 } else {
1152 $message .= sprintf('<li><a href="%s" title="%s">%s</a></li>',
1153 $tbl_url,
1154 $GLOBALS['strGoToView'] . ': ' . PMA_backquote($tables[$i][TBL_NAME]),
1155 $tables[$i][TBL_NAME]);
1159 $message .= '</ul></ul>';
1161 global $import_notice;
1162 $import_notice = $message;
1164 unset($tables);