* 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 $lineV = str_replace(' ', ' ', $lineV); // Remove double blanks
323
324 $parts = explode(' ', $lineV, 2);
325 if (!preg_match('/(PRIMARY|UNIQUE|FULLTEXT|INDEX|KEY)/',$parts[0])) { // Field definition
326
327 // Make sure there is no default value when auto_increment is set
328 if (stristr($parts[1],'auto_increment')) {
329 $parts[1] = preg_replace('/ default \'0\'/i','',$parts[1]);
330 }
331 // "default" is always lower-case
332 if (stristr($parts[1], ' DEFAULT ')) {
333 $parts[1] = str_ireplace(' DEFAULT ', ' default ', $parts[1]);
334 }
335
336 // Change order of "default" and "null" statements
337 $parts[1] = preg_replace('/(.*) (default .*) (NOT NULL)/', '$1 $3 $2', $parts[1]);
338 $parts[1] = preg_replace('/(.*) (default .*) (NULL)/', '$1 $3 $2', $parts[1]);
339
340 $key = $parts[0];
341 $total[$table]['fields'][$key] = $parts[1];
342
343 } else { // Key definition
344 $search = array('/UNIQUE (INDEX|KEY)/', '/FULLTEXT (INDEX|KEY)/', '/INDEX/');
345 $replace = array('UNIQUE', 'FULLTEXT', 'KEY');
346 $lineV = preg_replace($search, $replace, $lineV);
347
348 if (preg_match('/PRIMARY|UNIQUE|FULLTEXT/', $parts[0])) {
349 $parts[1] = preg_replace('/^(KEY|INDEX) /', '', $parts[1]);
350 }
351
352 $newParts = explode(' ',$parts[1],2);
353 $key = $parts[0]=='PRIMARY' ? $parts[0] : $newParts[0];
354 $total[$table]['keys'][$key] = $lineV;
355 }
356 }
357 }
358 }
359
360 $this->getFieldDefinitions_sqlContent_parseTypes($total);
361 return $total;
362 }
363
364 /**
365 * Multiplies varchars/tinytext fields in size according to $this->multiplySize
366 * 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.
367 *
368 * @param array Total array (from getFieldDefinitions_fileContent())
369 * @return void
370 * @access private
371 * @see getFieldDefinitions_fileContent()
372 */
373 function getFieldDefinitions_sqlContent_parseTypes(&$total) {
374
375 $mSize = (double)$this->multiplySize;
376 if ($mSize > 1) {
377
378 // Init SQL parser:
379 $sqlParser = t3lib_div::makeInstance('t3lib_sqlparser');
380 foreach($total as $table => $cfg) {
381 if (is_array($cfg['fields'])) {
382 foreach($cfg['fields'] as $fN => $fType) {
383 $orig_fType = $fType;
384 $fInfo = $sqlParser->parseFieldDef($fType);
385
386 switch($fInfo['fieldType']) {
387 case 'char':
388 case 'varchar':
389 $newSize = round($fInfo['value']*$mSize);
390
391 if ($newSize <= 255) {
392 $fInfo['value'] = $newSize;
393 } else {
394 $fInfo = array(
395 'fieldType' => 'text',
396 'featureIndex' => array(
397 'NOTNULL' => array(
398 'keyword' => 'NOT NULL'
399 )
400 )
401 );
402 // Change key definition if necessary (must use "prefix" on TEXT columns)
403 if (is_array($cfg['keys'])) {
404 foreach ($cfg['keys'] as $kN => $kType) {
405 $match = array();
406 preg_match('/^([^(]*)\(([^)]+)\)(.*)/', $kType, $match);
407 $keys = array();
408 foreach (t3lib_div::trimExplode(',',$match[2]) as $kfN) {
409 if ($fN == $kfN) {
410 $kfN .= '('.$newSize.')';
411 }
412 $keys[] = $kfN;
413 }
414 $total[$table]['keys'][$kN] = $match[1].'('.join(',',$keys).')'.$match[3];
415 }
416 }
417 }
418 break;
419 case 'tinytext':
420 $fInfo['fieldType'] = 'text';
421 break;
422 }
423
424 $total[$table]['fields'][$fN] = $sqlParser->compileFieldCfg($fInfo);
425 if ($sqlParser->parse_error) die($sqlParser->parse_error);
426 }
427 }
428 }
429 }
430 }
431
432 /**
433 * Reads the field definitions for the current database
434 *
435 * @return array Array with information about table.
436 */
437 function getFieldDefinitions_database() {
438 $total = array();
439 $tempKeys = array();
440 $tempKeysPrefix = array();
441
442 $GLOBALS['TYPO3_DB']->sql_select_db(TYPO3_db);
443 echo $GLOBALS['TYPO3_DB']->sql_error();
444
445 $tables = $GLOBALS['TYPO3_DB']->admin_get_tables(TYPO3_db);
446 foreach ($tables as $tableName) {
447
448 // Fields:
449 $fieldInformation = $GLOBALS['TYPO3_DB']->admin_get_fields($tableName);
450 foreach ($fieldInformation as $fN => $fieldRow) {
451 $total[$tableName]['fields'][$fN] = $this->assembleFieldDefinition($fieldRow);
452 }
453
454 // Keys:
455 $keyInformation = $GLOBALS['TYPO3_DB']->admin_get_keys($tableName);
456
457 foreach ($keyInformation as $keyRow) {
458 $keyName = $keyRow['Key_name'];
459 $colName = $keyRow['Column_name'];
460 if ($keyRow['Sub_part']) {
461 $colName.= '('.$keyRow['Sub_part'].')';
462 }
463 $tempKeys[$tableName][$keyName][$keyRow['Seq_in_index']] = $colName;
464 if ($keyName=='PRIMARY') {
465 $prefix = 'PRIMARY KEY';
466 } else {
467 if ($keyRow['Index_type']=='FULLTEXT') {
468 $prefix = 'FULLTEXT';
469 } elseif ($keyRow['Non_unique']) {
470 $prefix = 'KEY';
471 } else {
472 $prefix = 'UNIQUE';
473 }
474 $prefix.= ' '.$keyName;
475 }
476 $tempKeysPrefix[$tableName][$keyName] = $prefix;
477 }
478 }
479
480 // Compile key information:
481 if (count($tempKeys)) {
482 foreach ($tempKeys as $table => $keyInf) {
483 foreach ($keyInf as $kName => $index) {
484 ksort($index);
485 $total[$table]['keys'][$kName] = $tempKeysPrefix[$table][$kName].' ('.implode(',',$index).')';
486 }
487 }
488 }
489
490 return $total;
491 }
492
493 /**
494 * Compares two arrays with field information and returns information about fields that are MISSING and fields that have CHANGED.
495 * FDsrc and FDcomp can be switched if you want the list of stuff to remove rather than update.
496 *
497 * @param array Field definitions, source (from getFieldDefinitions_fileContent())
498 * @param array Field definitions, comparison. (from getFieldDefinitions_database())
499 * @param string Table names (in list) which is the ONLY one observed.
500 * @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.
501 * @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
502 */
503 function getDatabaseExtra($FDsrc, $FDcomp, $onlyTableList='',$ignoreNotNullWhenComparing=true) {
504 $extraArr = array();
505 $diffArr = array();
506
507 if (is_array($FDsrc)) {
508 foreach ($FDsrc as $table => $info) {
509 if (!strlen($onlyTableList) || t3lib_div::inList($onlyTableList, $table)) {
510 if (!isset($FDcomp[$table])) {
511 $extraArr[$table] = $info; // If the table was not in the FDcomp-array, the result array is loaded with that table.
512 $extraArr[$table]['whole_table']=1;
513 } else {
514 $keyTypes = explode(',','fields,keys');
515 foreach ($keyTypes as $theKey) {
516 if (is_array($info[$theKey])) {
517 foreach ($info[$theKey] as $fieldN => $fieldC) {
518 $fieldN = str_replace('`','',$fieldN);
519 if (!isset($FDcomp[$table][$theKey][$fieldN])) {
520 $extraArr[$table][$theKey][$fieldN] = $fieldC;
521 } else {
522 $fieldC = trim($fieldC);
523 if ($ignoreNotNullWhenComparing) {
524 $fieldC = str_replace(' NOT NULL', '', $fieldC);
525 $FDcomp[$table][$theKey][$fieldN] = str_replace(' NOT NULL', '', $FDcomp[$table][$theKey][$fieldN]);
526 }
527 if ($fieldC !== $FDcomp[$table][$theKey][$fieldN]) {
528 $diffArr[$table][$theKey][$fieldN] = $fieldC;
529 $diffArr_cur[$table][$theKey][$fieldN] = $FDcomp[$table][$theKey][$fieldN];
530 }
531 }
532 }
533 }
534 }
535 }
536 }
537 }
538 }
539
540 $output = array(
541 'extra' => $extraArr,
542 'diff' => $diffArr,
543 'diff_currentValues' => $diffArr_cur
544 );
545
546 return $output;
547 }
548
549 /**
550 * Returns an array with SQL-statements that is needed to update according to the diff-array
551 *
552 * @param array Array with differences of current and needed DB settings. (from getDatabaseExtra())
553 * @param string List of fields in diff array to take notice of.
554 * @return array Array of SQL statements (organized in keys depending on type)
555 */
556 function getUpdateSuggestions($diffArr,$keyList='extra,diff') {
557 $statements = array();
558 $deletedPrefixKey = $this->deletedPrefixKey;
559 $remove = 0;
560 if ($keyList == 'remove') {
561 $remove = 1;
562 $keyList = 'extra';
563 }
564 $keyList = explode(',',$keyList);
565 foreach ($keyList as $theKey) {
566 if (is_array($diffArr[$theKey])) {
567 foreach ($diffArr[$theKey] as $table => $info) {
568 $whole_table = array();
569 if (is_array($info['fields'])) {
570 foreach ($info['fields'] as $fN => $fV) {
571 if ($info['whole_table']) {
572 $whole_table[]=$fN.' '.$fV;
573 } else {
574 if ($theKey=='extra') {
575 if ($remove) {
576 if (substr($fN,0,strlen($deletedPrefixKey))!=$deletedPrefixKey) {
577 $statement = 'ALTER TABLE '.$table.' CHANGE '.$fN.' '.$deletedPrefixKey.$fN.' '.$fV.';';
578 $statements['change'][md5($statement)] = $statement;
579 } else {
580 $statement = 'ALTER TABLE '.$table.' DROP '.$fN.';';
581 $statements['drop'][md5($statement)] = $statement;
582 }
583 } else {
584 $statement = 'ALTER TABLE '.$table.' ADD '.$fN.' '.$fV.';';
585 $statements['add'][md5($statement)] = $statement;
586 }
587 } elseif ($theKey=='diff') {
588 $statement = 'ALTER TABLE '.$table.' CHANGE '.$fN.' '.$fN.' '.$fV.';';
589 $statements['change'][md5($statement)] = $statement;
590 $statements['change_currentValue'][md5($statement)] = $diffArr['diff_currentValues'][$table]['fields'][$fN];
591 }
592 }
593 }
594 }
595 if (is_array($info['keys'])) {
596 foreach ($info['keys'] as $fN => $fV) {
597 if ($info['whole_table']) {
598 $whole_table[] = $fV;
599 } else {
600 if ($theKey=='extra') {
601 if ($remove) {
602 $statement = 'ALTER TABLE '.$table.($fN=='PRIMARY' ? ' DROP PRIMARY KEY' : ' DROP KEY '.$fN).';';
603 $statements['drop'][md5($statement)] = $statement;
604 } else {
605 $statement = 'ALTER TABLE '.$table.' ADD '.$fV.';';
606 $statements['add'][md5($statement)] = $statement;
607 }
608 } elseif ($theKey=='diff') {
609 $statement = 'ALTER TABLE '.$table.($fN=='PRIMARY' ? ' DROP PRIMARY KEY' : ' DROP KEY '.$fN).';';
610 $statements['change'][md5($statement)] = $statement;
611 $statement = 'ALTER TABLE '.$table.' ADD '.$fV.';';
612 $statements['change'][md5($statement)] = $statement;
613 }
614 }
615 }
616 }
617 if ($info['whole_table']) {
618 if ($remove) {
619 if (substr($table,0,strlen($deletedPrefixKey))!=$deletedPrefixKey) {
620 $statement = 'ALTER TABLE '.$table.' RENAME '.$deletedPrefixKey.$table.';';
621 $statements['change_table'][md5($statement)] = $statement;
622 } else {
623 $statement = 'DROP TABLE '.$table.';';
624 $statements['drop_table'][md5($statement)] = $statement;
625 }
626 // count:
627 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('count(*)', $table, '');
628 list($count) = $GLOBALS['TYPO3_DB']->sql_fetch_row($res);
629 $statements['tables_count'][md5($statement)] = $count?'Records in table: '.$count:'';
630 } else {
631 $statement = 'CREATE TABLE '.$table." (\n".implode(",\n",$whole_table)."\n)";
632 if ($info['extra']) {
633 foreach ($info['extra'] as $k=>$v) {
634 $statement.= ' '.$k.'='.$v; // Add extra attributes like ENGINE, CHARSET, etc.
635 }
636 }
637 $statement.= ';';
638 $statements['create_table'][md5($statement)] = $statement;
639 }
640 }
641 }
642 }
643 }
644
645 return $statements;
646 }
647
648 /**
649 * Converts a result row with field information into the SQL field definition string
650 *
651 * @param array MySQL result row
652 * @return string Field definition
653 */
654 function assembleFieldDefinition($row) {
655 $field = array($row['Type']);
656
657 if ($row['Null']=='NO') {
658 $field[] = 'NOT NULL';
659 }
660 if (!strstr($row['Type'],'blob') && !strstr($row['Type'],'text')) {
661 // Add a default value if the field is not auto-incremented (these fields never have a default definition)
662 if (!stristr($row['Extra'],'auto_increment')) {
663 $field[] = 'default \''.addslashes($row['Default']).'\'';
664 }
665 }
666 if ($row['Extra']) {
667 $field[] = $row['Extra'];
668 }
669
670 return implode(' ',$field);
671 }
672
673 /**
674 * Returns an array where every entry is a single SQL-statement. Input must be formatted like an ordinary MySQL-dump files.
675 *
676 * @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.
677 * @param boolean If set, non-SQL content (like comments and blank lines) is not included in the final output
678 * @param string Regex to filter SQL lines to include
679 * @return array Array of SQL statements
680 */
681 function getStatementArray($sqlcode,$removeNonSQL=0,$query_regex='') {
682 $sqlcodeArr = explode(chr(10), $sqlcode);
683
684 // Based on the assumption that the sql-dump has
685 $statementArray = array();
686 $statementArrayPointer = 0;
687
688 foreach ($sqlcodeArr as $line => $lineContent) {
689 $is_set = 0;
690
691 // auto_increment fields cannot have a default value!
692 if (stristr($lineContent,'auto_increment')) {
693 $lineContent = preg_replace('/ default \'0\'/i', '', $lineContent);
694 }
695
696 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
697 $statementArray[$statementArrayPointer].= $lineContent;
698 $is_set = 1;
699 }
700 if (substr(trim($lineContent),-1)==';') {
701 if (isset($statementArray[$statementArrayPointer])) {
702 if (!trim($statementArray[$statementArrayPointer]) || ($query_regex && !eregi($query_regex,trim($statementArray[$statementArrayPointer])))) {
703 unset($statementArray[$statementArrayPointer]);
704 }
705 }
706 $statementArrayPointer++;
707
708 } elseif ($is_set) {
709 $statementArray[$statementArrayPointer].= chr(10);
710 }
711 }
712
713 return $statementArray;
714 }
715
716 /**
717 * Returns tables to create and how many records in each
718 *
719 * @param array Array of SQL statements to analyse.
720 * @param boolean If set, will count number of INSERT INTO statements following that table definition
721 * @return array Array with table definitions in index 0 and count in index 1
722 */
723 function getCreateTables($statements, $insertCountFlag=0) {
724 $crTables = array();
725 $insertCount = array();
726 foreach ($statements as $line => $lineContent) {
727 $reg = array();
728 if (eregi('^create[[:space:]]*table[[:space:]]*[`]?([[:alnum:]_]*)[`]?',substr($lineContent,0,100),$reg)) {
729 $table = trim($reg[1]);
730 if ($table) {
731 // table names are always lowercase on Windows!
732 if (TYPO3_OS == 'WIN') {
733 $table = strtolower($table);
734 }
735 $sqlLines = explode(chr(10), $lineContent);
736 foreach ($sqlLines as $k=>$v) {
737 if (stristr($v,'auto_increment')) {
738 $sqlLines[$k] = preg_replace('/ default \'0\'/i', '', $v);
739 }
740 }
741 $lineContent = implode(chr(10), $sqlLines);
742 $crTables[$table] = $lineContent;
743 }
744 } elseif ($insertCountFlag && eregi('^insert[[:space:]]*into[[:space:]]*[`]?([[:alnum:]_]*)[`]?',substr($lineContent,0,100),$reg)) {
745 $nTable = trim($reg[1]);
746 $insertCount[$nTable]++;
747 }
748 }
749
750 return array($crTables,$insertCount);
751 }
752
753 /**
754 * Extracts all insert statements from $statement array where content is inserted into $table
755 *
756 * @param array Array of SQL statements
757 * @param string Table name
758 * @return array Array of INSERT INTO statements where table match $table
759 */
760 function getTableInsertStatements($statements, $table) {
761 $outStatements=array();
762 foreach($statements as $line => $lineContent) {
763 $reg = array();
764 if (preg_match('/^insert[[:space:]]*into[[:space:]]*[`]?([[:alnum:]_]*)[`]?/i',substr($lineContent,0,100),$reg)) {
765 $nTable = trim($reg[1]);
766 if ($nTable && !strcmp($table,$nTable)) {
767 $outStatements[] = $lineContent;
768 }
769 }
770 }
771 return $outStatements;
772 }
773
774 /**
775 * Performs the queries passed from the input array.
776 *
777 * @param array Array of SQL queries to execute.
778 * @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)
779 * @return mixed Array with error message from database if any occured. Otherwise true if everything was executed successfully.
780 */
781 function performUpdateQueries($arr,$keyArr) {
782 $result = array();
783 if (is_array($arr)) {
784 foreach($arr as $key => $string) {
785 if (isset($keyArr[$key]) && $keyArr[$key]) {
786 $res = $GLOBALS['TYPO3_DB']->admin_query($string);
787 if ($res === false) {
788 $result[$key] = $GLOBALS['TYPO3_DB']->sql_error();
789 } elseif (is_resource($res)) {
790 $GLOBALS['TYPO3_DB']->sql_free_result($res);
791 }
792 }
793 }
794 }
795 if (count($result) > 0) {
796 return $result;
797 } else {
798 return true;
799 }
800 }
801
802 /**
803 * Returns list of tables in the database
804 *
805 * @return array List of tables.
806 * @see t3lib_db::admin_get_tables()
807 */
808 function getListOfTables() {
809 $whichTables = $GLOBALS['TYPO3_DB']->admin_get_tables(TYPO3_db);
810 return $whichTables;
811 }
812
813 /**
814 * Creates a table which checkboxes for updating database.
815 *
816 * @param array Array of statements (key / value pairs where key is used for the checkboxes)
817 * @param string Label for the table.
818 * @param boolean If set, then checkboxes are set by default.
819 * @param boolean If set, then icons are shown.
820 * @param array Array of "current values" for each key/value pair in $arr. Shown if given.
821 * @param boolean If set, will show the prefix "Current value" if $currentValue is given.
822 * @return string HTML table with checkboxes for update. Must be wrapped in a form.
823 */
824 function generateUpdateDatabaseForm_checkboxes($arr,$label,$checked=1,$iconDis=0,$currentValue=array(),$cVfullMsg=0) {
825 $out = array();
826 if (is_array($arr)) {
827 foreach($arr as $key => $string) {
828 $ico = '';
829 if ($iconDis) {
830 if (stristr($string,' user_')) {
831 $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(USER) </strong>';
832 }
833 if (stristr($string,' app_')) {
834 $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(APP) </strong>';
835 }
836 if (stristr($string,' ttx_') || stristr($string,' tx_')) {
837 $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(EXT) </strong>';
838 }
839 }
840 $out[]='
841 <tr>
842 <td valign="top"><input type="checkbox" id="db-'.$key.'" name="'.$this->dbUpdateCheckboxPrefix.'['.$key.']" value="1"'.($checked?' checked="checked"':'').' /></td>
843 <td nowrap="nowrap"><label for="db-'.$key.'">'.nl2br($ico.htmlspecialchars($string)).'</label></td>
844 </tr>';
845 if (isset($currentValue[$key])) {
846 $out[]='
847 <tr>
848 <td valign="top"></td>
849 <td nowrap="nowrap" style="color : #666666;">'.nl2br((!$cVfullMsg?"Current value: ":"").'<em>'.$currentValue[$key].'</em>').'</td>
850 </tr>';
851 }
852 }
853
854 // Compile rows:
855 $content = '
856 <!-- Update database fields / tables -->
857 <h3>'.$label.'</h3>
858 <table border="0" cellpadding="2" cellspacing="2" class="update-db-fields">'.implode('',$out).'
859 </table>';
860 }
861
862 return $content;
863 }
864
865 /**
866 * Reads the field definitions for the input SQL-file string
867 *
868 * @param string Should be a string read from an SQL-file made with 'mysqldump [database_name] -d'
869 * @return array Array with information about table.
870 * @deprecated since TYPO3 4.2 Use ->getFieldDefinitions_fileContent() instead!
871 */
872 function getFieldDefinitions_sqlContent($fileContent) {
873 return $this->getFieldDefinitions_fileContent($fileContent);
874 }
875 }
876
877 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_install.php']) {
878 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_install.php']);
879 }
880 ?>