* Improvements to Install Tool:
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_install.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2006 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Class to setup values in localconf.php and verify the TYPO3 DB tables/fields
29 *
30 * $Id$
31 *
32 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
33 */
34 /**
35 * [CLASS/FUNCTION INDEX of SCRIPT]
36 *
37 *
38 *
39 * 83: class t3lib_install
40 * 108: function t3lib_install()
41 *
42 * SECTION: Writing to localconf.php
43 * 132: function setValueInLocalconfFile(&$line_array, $variable, $value)
44 * 183: function writeToLocalconf_control($inlines='',$absFullPath='')
45 * 253: function checkForBadString($string)
46 * 266: function slashValueForSingleDashes($value)
47 *
48 * SECTION: SQL
49 * 291: function getFieldDefinitions_fileContent($fileContent)
50 * 359: function getFieldDefinitions_sqlContent_parseTypes(&$total)
51 * 406: function getFieldDefinitions_database()
52 * 450: function getDatabaseExtra($FDsrc, $FDcomp, $onlyTableList='')
53 * 496: function getUpdateSuggestions($diffArr,$keyList='extra,diff')
54 * 589: function assembleFieldDefinition($row)
55 * 611: function getStatementArray($sqlcode,$removeNonSQL=0,$query_regex='')
56 * 649: function getCreateTables($statements, $insertCountFlag=0)
57 * 683: function getTableInsertStatements($statements, $table)
58 * 704: function performUpdateQueries($arr,$keyArr)
59 * 720: function getListOfTables()
60 * 736: function generateUpdateDatabaseForm_checkboxes($arr,$label,$checked=1,$iconDis=0,$currentValue=array(),$cVfullMsg=0)
61 *
62 * TOTAL FUNCTIONS: 17
63 * (This index is automatically created/updated by the extension "extdeveval")
64 *
65 */
66
67
68
69
70
71
72
73
74 require_once(PATH_t3lib.'class.t3lib_sqlparser.php');
75
76 /**
77 * Class to setup values in localconf.php and verify the TYPO3 DB tables/fields
78 *
79 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
80 * @package TYPO3
81 * @subpackage t3lib
82 */
83 class t3lib_install {
84
85
86 // External, Static
87 var $updateIdentity = ''; // Set to string which identifies the script using this class.
88 var $deletedPrefixKey = 'zzz_deleted_'; // Prefix used for tables/fields when deleted/renamed.
89 var $dbUpdateCheckboxPrefix = 'TYPO3_INSTALL[database_update]'; // Prefix for checkbox fields when updating database.
90 var $localconf_addLinesOnly = 0; // If this is set, modifications to localconf.php is done by adding new lines to the array only. If unset, existing values are recognized and changed.
91 var $localconf_editPointToken = 'INSTALL SCRIPT EDIT POINT TOKEN - all lines after this points may be changed by the install script!'; // If set and addLinesOnly is disabled, lines will be change only if they are after this token (on a single line!) in the file
92 var $allowUpdateLocalConf = 0; // If true, this class will allow the user to update the localconf.php file. Is set true in the init.php file.
93 var $backPath = '../'; // Backpath (used for icons etc.)
94
95 var $multiplySize = 1; // Multiplier of SQL field size (for char, varchar and text fields)
96
97 // Internal, dynamic:
98 var $setLocalconf = 0; // Used to indicate that a value is change in the line-array of localconf and that it should be written.
99 var $messages = array(); // Used to set (error)messages from the executing functions like mail-sending, writing Localconf and such
100 var $touchedLine = 0; // updated with line in localconf.php file that was changed.
101
102
103 /**
104 * Constructor function
105 *
106 * @return void
107 */
108 function t3lib_install() {
109 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['multiplyDBfieldSize']>= 1 && $GLOBALS['TYPO3_CONF_VARS']['SYS']['multiplyDBfieldSize']<=5) {
110 $this->multiplySize = (double)$GLOBALS['TYPO3_CONF_VARS']['SYS']['multiplyDBfieldSize'];
111 }
112 }
113
114
115
116 /**************************************
117 *
118 * Writing to localconf.php
119 *
120
121 **************************************/
122
123 /**
124 * This functions takes an array with lines from localconf.php, finds a variable and inserts the new value.
125 *
126 * @param array $line_array the localconf.php file exploded into an array by linebreaks. (see writeToLocalconf_control())
127 * @param string $variable The variable name to find and substitute. This string must match the first part of a trimmed line in the line-array. Matching is done backwards so the last appearing line will be substituted.
128 * @param string $value Is the value to be insert for the variable
129 * @return void
130 * @see writeToLocalconf_control()
131 */
132 function setValueInLocalconfFile(&$line_array, $variable, $value) {
133 if (!$this->checkForBadString($value)) return 0;
134
135 // Initialize:
136 $found = 0;
137 $this->touchedLine = '';
138 $commentKey = '## ';
139 $inArray = in_array($commentKey.$this->localconf_editPointToken,$line_array);
140 $tokenSet = ($this->localconf_editPointToken && !$inArray); // Flag is set if the token should be set but is not yet...
141 $stopAtToken = ($this->localconf_editPointToken && $inArray);
142 $comment = ' Modified or inserted by '.$this->updateIdentity.'.';
143
144 // Search for variable name:
145 if (!$this->localconf_addLinesOnly && !$tokenSet) {
146 $line_array = array_reverse($line_array);
147 foreach($line_array as $k => $v) {
148 $v2 = trim($v);
149 if ($stopAtToken && !strcmp($v2,$commentKey.$this->localconf_editPointToken)) break; // If stopAtToken and token found, break out of the loop..
150 if (!strcmp(substr($v2,0,strlen($variable.' ')),$variable.' ')) {
151 $mainparts = explode($variable,$v,2);
152 if (count($mainparts)==2) { // should ALWAYS be....
153 $subparts = explode('//',$mainparts[1],2);
154 $line_array[$k] = $mainparts[0].$variable." = '".$this->slashValueForSingleDashes($value)."'; ".('//'.$comment.str_replace($comment,'',$subparts[1]));
155 $this->touchedLine = count($line_array)-$k-1;
156 $found = 1;
157 break;
158 }
159 }
160 }
161 $line_array = array_reverse($line_array);
162 }
163 if (!$found) {
164 if ($tokenSet) {
165 $line_array[] = $commentKey.$this->localconf_editPointToken;
166 $line_array[] = '';
167 }
168 $line_array[] = $variable." = '".$this->slashValueForSingleDashes($value)."'; // ".$comment;
169 $this->touchedLine = -1;
170 }
171 $this->messages[] = $variable." = '".htmlspecialchars($value)."'";
172 $this->setLocalconf = 1;
173 }
174
175 /**
176 * Writes or returns lines from localconf.php
177 *
178 * @param array Array of lines to write back to localconf.php. Possibly
179 * @param string Absolute path of alternative file to use (Notice: this path is not validated in terms of being inside 'TYPO3 space')
180 * @return mixed If $inlines is not an array it will return an array with the lines from localconf.php. Otherwise it will return a status string, either "continue" (updated) or "nochange" (not updated)
181 * @see setValueInLocalconfFile()
182 */
183 function writeToLocalconf_control($inlines='',$absFullPath='') {
184 $tmpExt = '.TMP.php';
185 $writeToLocalconf_dat['file'] = $absFullPath ? $absFullPath : PATH_typo3conf.'localconf.php';
186 $writeToLocalconf_dat['tmpfile'] = $writeToLocalconf_dat['file'].$tmpExt;
187
188 // Checking write state of localconf.php:
189 if (!$this->allowUpdateLocalConf) {
190 die('->allowUpdateLocalConf flag in the install object is not set and therefore "localconf.php" cannot be altered.');
191 }
192 if (!@is_writable($writeToLocalconf_dat['file'])) {
193 die($writeToLocalconf_dat['file'].' is not writable!');
194 }
195
196 // Splitting localconf.php file into lines:
197 $lines = explode(chr(10),str_replace(chr(13),'',trim(t3lib_div::getUrl($writeToLocalconf_dat['file']))));
198 $writeToLocalconf_dat['endLine'] = array_pop($lines); // Getting "? >" ending.
199
200 // Checking if "updated" line was set by this tool - if so remove old line.
201 $updatedLine = array_pop($lines);
202 $writeToLocalconf_dat['updatedText'] = '// Updated by '.$this->updateIdentity.' ';
203
204 if (!strstr($updatedLine, $writeToLocalconf_dat['updatedText'])) {
205 array_push($lines,$updatedLine);
206 }
207
208 if (is_array($inlines)) { // Setting a line and write:
209 // Setting configuration
210 $updatedLine = $writeToLocalconf_dat['updatedText'].date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'].' H:i:s');
211 array_push($inlines,$updatedLine);
212 array_push($inlines,$writeToLocalconf_dat['endLine']);
213
214 if ($this->setLocalconf) {
215 $success = FALSE;
216 if (!t3lib_div::writeFile($writeToLocalconf_dat['tmpfile'],implode(chr(10),$inlines))) {
217 $msg = 'typo3conf/localconf.php'.$tmpExt.' could not be written - maybe a write access problem?';
218 }
219 elseif (strcmp(t3lib_div::getUrl($writeToLocalconf_dat['tmpfile']), implode(chr(10),$inlines))) {
220 @unlink($writeToLocalconf_dat['tmpfile']);
221 $msg = 'typo3conf/localconf.php'.$tmpExt.' was NOT written properly (written content didn\'t match file content) - maybe a disk space problem?';
222 }
223 elseif (!@copy($writeToLocalconf_dat['tmpfile'],$writeToLocalconf_dat['file'])) {
224 $msg = 'typo3conf/localconf.php could not be replaced by typo3conf/localconf.php'.$tmpExt.' - maybe a write access problem?';
225 }
226 else {
227 @unlink($writeToLocalconf_dat['tmpfile']);
228 $success = TRUE;
229 $msg = 'Configuration written to typo3conf/localconf.php';
230 }
231 $this->messages[] = $msg;
232
233 if ($success) {
234 return 'continue';
235 } else {
236 t3lib_div::sysLog($msg, 'Core', 3);
237 return 'nochange';
238 }
239 } else {
240 return 'nochange';
241 }
242 } else { // Return lines found in localconf.php
243 return $lines;
244 }
245 }
246
247 /**
248 * Checking for linebreaks in the string
249 *
250 * @param string String to test
251 * @return boolean Returns TRUE if string is OK
252 * @see setValueInLocalconfFile()
253 */
254 function checkForBadString($string) {
255 return preg_match('/['.chr(10).chr(13).']/',$string) ? FALSE : TRUE;
256 }
257
258 /**
259 * Replaces ' with \' and \ with \\
260 *
261 * @param string Input value
262 * @return string Output value
263 * @see setValueInLocalconfFile()
264 */
265 function slashValueForSingleDashes($value) {
266 $value = str_replace("'.chr(10).'", '###INSTALL_TOOL_LINEBREAK###', $value);
267 $value = str_replace("'","\'",str_replace('\\','\\\\',$value));
268 $value = str_replace('###INSTALL_TOOL_LINEBREAK###', "'.chr(10).'", $value);
269
270 return $value;
271 }
272
273
274
275
276
277
278
279
280
281
282 /*************************************
283 *
284 * SQL
285 *
286 *************************************/
287
288 /**
289 * Reads the field definitions for the input SQL-file string
290 *
291 * @param string Should be a string read from an SQL-file made with 'mysqldump [database_name] -d'
292 * @return array Array with information about table.
293 */
294 function getFieldDefinitions_fileContent($fileContent) {
295 $lines = t3lib_div::trimExplode(chr(10), $fileContent, 1);
296 $table = '';
297 $total = array();
298
299 foreach ($lines as $value) {
300 if (substr($value,0,1)=='#') {
301 continue; // Ignore comments
302 }
303
304 if (!strlen($table)) {
305 $parts = explode(' ',$value);
306 if ($parts[0]=='CREATE' && $parts[1]=='TABLE') {
307 $table = str_replace( '`', '', $parts[2]);
308 if (TYPO3_OS=='WIN') { // tablenames are always lowercase on windows!
309 $table = strtolower($table);
310 }
311 }
312 } else {
313 if (substr($value,0,1)==')' && substr($value,-1)==';') {
314 $ttype = array();
315 if (preg_match('/(ENGINE|TYPE)=([a-zA-Z]*)/',$value,$ttype)) {
316 $total[$table]['extra']['ENGINE'] = $ttype[2];
317 }
318 $table = ''; // Remove table marker and start looking for the next "CREATE TABLE" statement
319 } else {
320 $lineV = preg_replace('/,$/','',$value); // Strip trailing commas
321 $lineV = str_replace('`', '', $lineV);
322
323 $lineV = str_replace('UNIQUE KEY', 'UNIQUE', $lineV);
324 $parts = explode(' ', $lineV, 2);
325
326 // Make sure there is no default value when auto_increment is set
327 if(stristr($parts[1],'auto_increment')) {
328 $parts[1] = preg_replace('/ default \'0\'/i','',$parts[1]);
329 }
330 // "default" is always lower-case
331 if (stristr($parts[1], ' DEFAULT ')) {
332 $parts[1] = str_ireplace(' DEFAULT ', ' default ', $parts[1]);
333 }
334
335 // Change order of "default" and "null" statements
336 $parts[1] = preg_replace('/(.*) (default .*) (NOT NULL)/', '$1 $3 $2', $parts[1]);
337 $parts[1] = preg_replace('/(.*) (default .*) (NULL)/', '$1 $3 $2', $parts[1]);
338
339 // Remove double blanks
340 $parts[1] = str_replace(' ', ' ', $parts[1]);
341
342 if ($parts[0]!='PRIMARY' && $parts[0]!='KEY' && $parts[0]!='UNIQUE') {
343 // Field definition
344 $key = $parts[0];
345 $total[$table]['fields'][$key] = $parts[1];
346 } else {
347 // Key definition
348 $newParts = explode(' ',$parts[1],2);
349 $key = $parts[0]=='PRIMARY' ? $parts[0] : $newParts[0];
350 $total[$table]['keys'][$key] = $lineV;
351 }
352 }
353 }
354 }
355
356 $this->getFieldDefinitions_sqlContent_parseTypes($total);
357 return $total;
358 }
359
360 /**
361 * Multiplies varchars/tinytext fields in size according to $this->multiplySize
362 * Useful if you want to use UTF-8 in the database and needs to extend the field sizes in the database so UTF-8 chars are not discarded. For most charsets available as single byte sets, multiplication with 2 should be enough. For chinese, use 3.
363 *
364 * @param array Total array (from getFieldDefinitions_fileContent())
365 * @return void
366 * @access private
367 * @see getFieldDefinitions_fileContent()
368 */
369 function getFieldDefinitions_sqlContent_parseTypes(&$total) {
370
371 $mSize = (double)$this->multiplySize;
372 if ($mSize > 1) {
373
374 // Init SQL parser:
375 $sqlParser = t3lib_div::makeInstance('t3lib_sqlparser');
376 foreach($total as $table => $cfg) {
377 if (is_array($cfg['fields'])) {
378 foreach($cfg['fields'] as $fN => $fType) {
379 $orig_fType = $fType;
380 $fInfo = $sqlParser->parseFieldDef($fType);
381
382 switch($fInfo['fieldType']) {
383 case 'char':
384 case 'varchar':
385 $newSize = round($fInfo['value']*$mSize);
386
387 if ($newSize <= 255) {
388 $fInfo['value'] = $newSize;
389 } else {
390 $fInfo = array(
391 'fieldType' => 'text',
392 'featureIndex' => array(
393 'NOTNULL' => array(
394 'keyword' => 'NOT NULL'
395 )
396 )
397 );
398 // Change key definition if necessary (must use "prefix" on TEXT columns)
399 if (is_array($cfg['keys'])) {
400 foreach ($cfg['keys'] as $kN => $kType) {
401 $match = array();
402 preg_match('/^([^(]*)\(([^)]+)\)(.*)/', $kType, $match);
403 $keys = array();
404 foreach (t3lib_div::trimExplode(',',$match[2]) as $kfN) {
405 if ($fN == $kfN) {
406 $kfN .= '('.$newSize.')';
407 }
408 $keys[] = $kfN;
409 }
410 $total[$table]['keys'][$kN] = $match[1].'('.join(',',$keys).')'.$match[3];
411 }
412 }
413 }
414 break;
415 case 'tinytext':
416 $fInfo['fieldType'] = 'text';
417 break;
418 }
419
420 $total[$table]['fields'][$fN] = $sqlParser->compileFieldCfg($fInfo);
421 if ($sqlParser->parse_error) die($sqlParser->parse_error);
422 }
423 }
424 }
425 }
426 }
427
428 /**
429 * Reads the field definitions for the current database
430 *
431 * @return array Array with information about table.
432 */
433 function getFieldDefinitions_database() {
434 $total = array();
435 $tempKeys = array();
436 $tempKeysPrefix = array();
437
438 $GLOBALS['TYPO3_DB']->sql_select_db(TYPO3_db);
439 echo $GLOBALS['TYPO3_DB']->sql_error();
440
441 $tables = $GLOBALS['TYPO3_DB']->admin_get_tables(TYPO3_db);
442 foreach ($tables as $tableName) {
443
444 // Fields:
445 $fieldInformation = $GLOBALS['TYPO3_DB']->admin_get_fields($tableName);
446 foreach ($fieldInformation as $fN => $fieldRow) {
447 $total[$tableName]['fields'][$fN] = $this->assembleFieldDefinition($fieldRow);
448 }
449
450 // Keys:
451 $keyInformation = $GLOBALS['TYPO3_DB']->admin_get_keys($tableName);
452
453 foreach ($keyInformation as $keyRow) {
454 $keyName = $keyRow['Key_name'];
455 $colName = $keyRow['Column_name'];
456 if ($keyRow['Sub_part']) {
457 $colName.= '('.$keyRow['Sub_part'].')';
458 }
459 $tempKeys[$tableName][$keyName][$keyRow['Seq_in_index']] = $colName;
460 if ($keyName=='PRIMARY') {
461 $prefix = 'PRIMARY KEY';
462 } else {
463 if ($keyRow['Non_unique']) {
464 $prefix = 'KEY';
465 } else {
466 $prefix = 'UNIQUE';
467 }
468 $prefix.= ' '.$keyName;
469 }
470 $tempKeysPrefix[$tableName][$keyName] = $prefix;
471 }
472 }
473
474 // Compile key information:
475 if (count($tempKeys)) {
476 foreach ($tempKeys as $table => $keyInf) {
477 foreach ($keyInf as $kName => $index) {
478 ksort($index);
479 $total[$table]['keys'][$kName] = $tempKeysPrefix[$table][$kName].' ('.implode(',',$index).')';
480 }
481 }
482 }
483
484 return $total;
485 }
486
487 /**
488 * Compares two arrays with field information and returns information about fields that are MISSING and fields that have CHANGED.
489 * FDsrc and FDcomp can be switched if you want the list of stuff to remove rather than update.
490 *
491 * @param array Field definitions, source (from getFieldDefinitions_fileContent())
492 * @param array Field definitions, comparison. (from getFieldDefinitions_database())
493 * @param string Table names (in list) which is the ONLY one observed.
494 * @param boolean If set, this function ignores NOT NULL statements of the SQL file field definition when comparing current field definition from database with field definition from SQL file. This way, NOT NULL statements will be executed when the field is initially created, but the SQL parser will never complain about missing NOT NULL statements afterwards.
495 * @return array Returns an array with 1) all elements from $FDsrc that is not in $FDcomp (in key 'extra') and 2) all elements from $FDsrc that is different from the ones in $FDcomp
496 */
497 function getDatabaseExtra($FDsrc, $FDcomp, $onlyTableList='',$ignoreNotNullWhenComparing=true) {
498 $extraArr = array();
499 $diffArr = array();
500
501 if (is_array($FDsrc)) {
502 foreach ($FDsrc as $table => $info) {
503 if (!strlen($onlyTableList) || t3lib_div::inList($onlyTableList, $table)) {
504 if (!isset($FDcomp[$table])) {
505 $extraArr[$table] = $info; // If the table was not in the FDcomp-array, the result array is loaded with that table.
506 $extraArr[$table]['whole_table']=1;
507 } else {
508 $keyTypes = explode(',','fields,keys');
509 foreach ($keyTypes as $theKey) {
510 if (is_array($info[$theKey])) {
511 foreach ($info[$theKey] as $fieldN => $fieldC) {
512 $fieldN = str_replace('`','',$fieldN);
513 if (!isset($FDcomp[$table][$theKey][$fieldN])) {
514 $extraArr[$table][$theKey][$fieldN] = $fieldC;
515 } else {
516 $fieldC = trim($fieldC);
517 if ($ignoreNotNullWhenComparing) {
518 $fieldC = str_replace(' NOT NULL', '', $fieldC);
519 $FDcomp[$table][$theKey][$fieldN] = str_replace(' NOT NULL', '', $FDcomp[$table][$theKey][$fieldN]);
520 }
521 if ($fieldC !== $FDcomp[$table][$theKey][$fieldN]) {
522 $diffArr[$table][$theKey][$fieldN] = $fieldC;
523 $diffArr_cur[$table][$theKey][$fieldN] = $FDcomp[$table][$theKey][$fieldN];
524 }
525 }
526 }
527 }
528 }
529 }
530 }
531 }
532 }
533
534 $output = array(
535 'extra' => $extraArr,
536 'diff' => $diffArr,
537 'diff_currentValues' => $diffArr_cur
538 );
539
540 return $output;
541 }
542
543 /**
544 * Returns an array with SQL-statements that is needed to update according to the diff-array
545 *
546 * @param array Array with differences of current and needed DB settings. (from getDatabaseExtra())
547 * @param string List of fields in diff array to take notice of.
548 * @return array Array of SQL statements (organized in keys depending on type)
549 */
550 function getUpdateSuggestions($diffArr,$keyList='extra,diff') {
551 $statements = array();
552 $deletedPrefixKey = $this->deletedPrefixKey;
553 $remove = 0;
554 if ($keyList == 'remove') {
555 $remove = 1;
556 $keyList = 'extra';
557 }
558 $keyList = explode(',',$keyList);
559 foreach ($keyList as $theKey) {
560 if (is_array($diffArr[$theKey])) {
561 foreach ($diffArr[$theKey] as $table => $info) {
562 $whole_table = array();
563 if (is_array($info['fields'])) {
564 foreach ($info['fields'] as $fN => $fV) {
565 if ($info['whole_table']) {
566 $whole_table[]=$fN.' '.$fV;
567 } else {
568 if ($theKey=='extra') {
569 if ($remove) {
570 if (substr($fN,0,strlen($deletedPrefixKey))!=$deletedPrefixKey) {
571 $statement = 'ALTER TABLE '.$table.' CHANGE '.$fN.' '.$deletedPrefixKey.$fN.' '.$fV.';';
572 $statements['change'][md5($statement)] = $statement;
573 } else {
574 $statement = 'ALTER TABLE '.$table.' DROP '.$fN.';';
575 $statements['drop'][md5($statement)] = $statement;
576 }
577 } else {
578 $statement = 'ALTER TABLE '.$table.' ADD '.$fN.' '.$fV.';';
579 $statements['add'][md5($statement)] = $statement;
580 }
581 } elseif ($theKey=='diff') {
582 $statement = 'ALTER TABLE '.$table.' CHANGE '.$fN.' '.$fN.' '.$fV.';';
583 $statements['change'][md5($statement)] = $statement;
584 $statements['change_currentValue'][md5($statement)] = $diffArr['diff_currentValues'][$table]['fields'][$fN];
585 }
586 }
587 }
588 }
589 if (is_array($info['keys'])) {
590 foreach ($info['keys'] as $fN => $fV) {
591 if ($info['whole_table']) {
592 $whole_table[] = $fV;
593 } else {
594 if ($theKey=='extra') {
595 if ($remove) {
596 $statement = 'ALTER TABLE '.$table.($fN=='PRIMARY' ? ' DROP PRIMARY KEY' : ' DROP KEY '.$fN).';';
597 $statements['drop'][md5($statement)] = $statement;
598 } else {
599 $statement = 'ALTER TABLE '.$table.' ADD '.$fV.';';
600 $statements['add'][md5($statement)] = $statement;
601 }
602 } elseif ($theKey=='diff') {
603 $statement = 'ALTER TABLE '.$table.($fN=='PRIMARY' ? ' DROP PRIMARY KEY' : ' DROP KEY '.$fN).';';
604 $statements['change'][md5($statement)] = $statement;
605 $statement = 'ALTER TABLE '.$table.' ADD '.$fV.';';
606 $statements['change'][md5($statement)] = $statement;
607 }
608 }
609 }
610 }
611 if ($info['whole_table']) {
612 if ($remove) {
613 if (substr($table,0,strlen($deletedPrefixKey))!=$deletedPrefixKey) {
614 $statement = 'ALTER TABLE '.$table.' RENAME '.$deletedPrefixKey.$table.';';
615 $statements['change_table'][md5($statement)] = $statement;
616 } else {
617 $statement = 'DROP TABLE '.$table.';';
618 $statements['drop_table'][md5($statement)] = $statement;
619 }
620 // count:
621 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('count(*)', $table, '');
622 list($count) = $GLOBALS['TYPO3_DB']->sql_fetch_row($res);
623 $statements['tables_count'][md5($statement)] = $count?'Records in table: '.$count:'';
624 } else {
625 $statement = 'CREATE TABLE '.$table." (\n".implode(",\n",$whole_table)."\n)";
626 if ($info['extra']) {
627 foreach ($info['extra'] as $k=>$v) {
628 $statement.= ' '.$k.'='.$v; // Add extra attributes like ENGINE, CHARSET, etc.
629 }
630 }
631 $statement.= ';';
632 $statements['create_table'][md5($statement)] = $statement;
633 }
634 }
635 }
636 }
637 }
638
639 return $statements;
640 }
641
642 /**
643 * Converts a result row with field information into the SQL field definition string
644 *
645 * @param array MySQL result row
646 * @return string Field definition
647 */
648 function assembleFieldDefinition($row) {
649 $field = array($row['Type']);
650
651 if ($row['Null']=='NO') {
652 $field[] = 'NOT NULL';
653 }
654 if (!strstr($row['Type'],'blob') && !strstr($row['Type'],'text')) {
655 // Add a default value if the field is not auto-incremented (these fields never have a default definition)
656 if (!stristr($row['Extra'],'auto_increment')) {
657 $field[] = 'default \''.addslashes($row['Default']).'\'';
658 }
659 }
660 if ($row['Extra']) {
661 $field[] = $row['Extra'];
662 }
663
664 return implode(' ',$field);
665 }
666
667 /**
668 * Returns an array where every entry is a single SQL-statement. Input must be formatted like an ordinary MySQL-dump files.
669 *
670 * @param string The SQL-file content. Provided that 1) every query in the input is ended with ';' and that a line in the file contains only one query or a part of a query.
671 * @param boolean If set, non-SQL content (like comments and blank lines) is not included in the final output
672 * @param string Regex to filter SQL lines to include
673 * @return array Array of SQL statements
674 */
675 function getStatementArray($sqlcode,$removeNonSQL=0,$query_regex='') {
676 $sqlcodeArr = explode(chr(10), $sqlcode);
677
678 // Based on the assumption that the sql-dump has
679 $statementArray = array();
680 $statementArrayPointer = 0;
681
682 foreach ($sqlcodeArr as $line => $lineContent) {
683 $is_set = 0;
684
685 // auto_increment fields cannot have a default value!
686 if (stristr($lineContent,'auto_increment')) {
687 $lineContent = preg_replace('/ default \'0\'/i', '', $lineContent);
688 }
689
690 if (!$removeNonSQL || (strcmp(trim($lineContent),'') && substr(trim($lineContent),0,1)!='#' && substr(trim($lineContent),0,2)!='--')) { // '--' is seen as mysqldump comments from server version 3.23.49
691 $statementArray[$statementArrayPointer].= $lineContent;
692 $is_set = 1;
693 }
694 if (substr(trim($lineContent),-1)==';') {
695 if (isset($statementArray[$statementArrayPointer])) {
696 if (!trim($statementArray[$statementArrayPointer]) || ($query_regex && !eregi($query_regex,trim($statementArray[$statementArrayPointer])))) {
697 unset($statementArray[$statementArrayPointer]);
698 }
699 }
700 $statementArrayPointer++;
701
702 } elseif ($is_set) {
703 $statementArray[$statementArrayPointer].= chr(10);
704 }
705 }
706
707 return $statementArray;
708 }
709
710 /**
711 * Returns tables to create and how many records in each
712 *
713 * @param array Array of SQL statements to analyse.
714 * @param boolean If set, will count number of INSERT INTO statements following that table definition
715 * @return array Array with table definitions in index 0 and count in index 1
716 */
717 function getCreateTables($statements, $insertCountFlag=0) {
718 $crTables = array();
719 $insertCount = array();
720 foreach ($statements as $line => $lineContent) {
721 $reg = array();
722 if (eregi('^create[[:space:]]*table[[:space:]]*[`]?([[:alnum:]_]*)[`]?',substr($lineContent,0,100),$reg)) {
723 $table = trim($reg[1]);
724 if ($table) {
725 // table names are always lowercase on Windows!
726 if (TYPO3_OS == 'WIN') {
727 $table = strtolower($table);
728 }
729 $sqlLines = explode(chr(10), $lineContent);
730 foreach ($sqlLines as $k=>$v) {
731 if (stristr($v,'auto_increment')) {
732 $sqlLines[$k] = preg_replace('/ default \'0\'/i', '', $v);
733 }
734 }
735 $lineContent = implode(chr(10), $sqlLines);
736 $crTables[$table] = $lineContent;
737 }
738 } elseif ($insertCountFlag && eregi('^insert[[:space:]]*into[[:space:]]*[`]?([[:alnum:]_]*)[`]?',substr($lineContent,0,100),$reg)) {
739 $nTable = trim($reg[1]);
740 $insertCount[$nTable]++;
741 }
742 }
743
744 return array($crTables,$insertCount);
745 }
746
747 /**
748 * Extracts all insert statements from $statement array where content is inserted into $table
749 *
750 * @param array Array of SQL statements
751 * @param string Table name
752 * @return array Array of INSERT INTO statements where table match $table
753 */
754 function getTableInsertStatements($statements, $table) {
755 $outStatements=array();
756 foreach($statements as $line => $lineContent) {
757 $reg = array();
758 if (preg_match('/^insert[[:space:]]*into[[:space:]]*[`]?([[:alnum:]_]*)[`]?/i',substr($lineContent,0,100),$reg)) {
759 $nTable = trim($reg[1]);
760 if ($nTable && !strcmp($table,$nTable)) {
761 $outStatements[] = $lineContent;
762 }
763 }
764 }
765 return $outStatements;
766 }
767
768 /**
769 * Performs the queries passed from the input array.
770 *
771 * @param array Array of SQL queries to execute.
772 * @param array Array with keys that must match keys in $arr. Only where a key in this array is set and true will the query be executed (meant to be passed from a form checkbox)
773 * @return mixed Array with error message from database if any occured. Otherwise true if everything was executed successfully.
774 */
775 function performUpdateQueries($arr,$keyArr) {
776 $result = array();
777 if (is_array($arr)) {
778 foreach($arr as $key => $string) {
779 if (isset($keyArr[$key]) && $keyArr[$key]) {
780 $res = $GLOBALS['TYPO3_DB']->admin_query($string);
781 if ($res === false) {
782 $result[$key] = $GLOBALS['TYPO3_DB']->sql_error();
783 } elseif (is_resource($res)) {
784 $GLOBALS['TYPO3_DB']->sql_free_result($res);
785 }
786 }
787 }
788 }
789 if (count($result) > 0) {
790 return $result;
791 } else {
792 return true;
793 }
794 }
795
796 /**
797 * Returns list of tables in the database
798 *
799 * @return array List of tables.
800 * @see t3lib_db::admin_get_tables()
801 */
802 function getListOfTables() {
803 $whichTables = $GLOBALS['TYPO3_DB']->admin_get_tables(TYPO3_db);
804 return $whichTables;
805 }
806
807 /**
808 * Creates a table which checkboxes for updating database.
809 *
810 * @param array Array of statements (key / value pairs where key is used for the checkboxes)
811 * @param string Label for the table.
812 * @param boolean If set, then checkboxes are set by default.
813 * @param boolean If set, then icons are shown.
814 * @param array Array of "current values" for each key/value pair in $arr. Shown if given.
815 * @param boolean If set, will show the prefix "Current value" if $currentValue is given.
816 * @return string HTML table with checkboxes for update. Must be wrapped in a form.
817 */
818 function generateUpdateDatabaseForm_checkboxes($arr,$label,$checked=1,$iconDis=0,$currentValue=array(),$cVfullMsg=0) {
819 $out = array();
820 if (is_array($arr)) {
821 foreach($arr as $key => $string) {
822 $ico = '';
823 if ($iconDis) {
824 if (stristr($string,' user_')) {
825 $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(USER) </strong>';
826 }
827 if (stristr($string,' app_')) {
828 $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(APP) </strong>';
829 }
830 if (stristr($string,' ttx_') || stristr($string,' tx_')) {
831 $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(EXT) </strong>';
832 }
833 }
834 $out[]='
835 <tr>
836 <td valign="top"><input type="checkbox" id="db-'.$key.'" name="'.$this->dbUpdateCheckboxPrefix.'['.$key.']" value="1"'.($checked?' checked="checked"':'').' /></td>
837 <td nowrap="nowrap"><label for="db-'.$key.'">'.nl2br($ico.htmlspecialchars($string)).'</label></td>
838 </tr>';
839 if (isset($currentValue[$key])) {
840 $out[]='
841 <tr>
842 <td valign="top"></td>
843 <td nowrap="nowrap" style="color : #666666;">'.nl2br((!$cVfullMsg?"Current value: ":"").'<em>'.$currentValue[$key].'</em>').'</td>
844 </tr>';
845 }
846 }
847
848 // Compile rows:
849 $content = '
850 <!-- Update database fields / tables -->
851 <h3>'.$label.'</h3>
852 <table border="0" cellpadding="2" cellspacing="2" class="update-db-fields">'.implode('',$out).'
853 </table>';
854 }
855
856 return $content;
857 }
858
859 /**
860 * Reads the field definitions for the input SQL-file string
861 *
862 * @param string Should be a string read from an SQL-file made with 'mysqldump [database_name] -d'
863 * @return array Array with information about table.
864 * @deprecated since TYPO3 4.2 Use ->getFieldDefinitions_fileContent() instead!
865 */
866 function getFieldDefinitions_sqlContent($fileContent) {
867 return $this->getFieldDefinitions_fileContent($fileContent);
868 }
869 }
870
871 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_install.php']) {
872 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_install.php']);
873 }
874 ?>