t3lib_install: Use <tab> instead of whitespaces when appending comment to typo3conf...
[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_sqlContent($sqlContent)
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 if (!strstr($updatedLine, $writeToLocalconf_dat['updatedText'])) {
204 array_push($lines,$updatedLine);
205 }
206
207 if (is_array($inlines)) { // Setting a line and write:
208 // Setting configuration
209 $updatedLine = $writeToLocalconf_dat['updatedText'].date('d-m-Y H:i:s');
210 array_push($inlines,$updatedLine);
211 array_push($inlines,$writeToLocalconf_dat['endLine']);
212
213 if ($this->setLocalconf) {
214 $success = FALSE;
215 if (!t3lib_div::writeFile($writeToLocalconf_dat['tmpfile'],implode(chr(10),$inlines))) {
216 $msg = 'typo3conf/localconf.php'.$tmpExt.' could not be written - maybe a write access problem?';
217 }
218 elseif (strcmp(t3lib_div::getUrl($writeToLocalconf_dat['tmpfile']), implode(chr(10),$inlines))) {
219 @unlink($writeToLocalconf_dat['tmpfile']);
220 $msg = 'typo3conf/localconf.php'.$tmpExt.' was NOT written properly (written content didn\'t match file content) - maybe a disk space problem?';
221 }
222 elseif (!@copy($writeToLocalconf_dat['tmpfile'],$writeToLocalconf_dat['file'])) {
223 $msg = 'typo3conf/localconf.php could not be replaced by typo3conf/localconf.php'.$tmpExt.' - maybe a write access problem?';
224 }
225 else {
226 @unlink($writeToLocalconf_dat['tmpfile']);
227 $success = TRUE;
228 $msg = 'Configuration written to typo3conf/localconf.php';
229 }
230 $this->messages[] = $msg;
231
232 if ($success) {
233 return 'continue';
234 } else {
235 t3lib_div::sysLog($msg, 'Core', 3);
236 return 'nochange';
237 }
238 } else {
239 return 'nochange';
240 }
241 } else { // Return lines found in localconf.php
242 return $lines;
243 }
244 }
245
246 /**
247 * Checking for linebreaks in the string
248 *
249 * @param string String to test
250 * @return boolean Returns TRUE if string is OK
251 * @see setValueInLocalconfFile()
252 */
253 function checkForBadString($string) {
254 return preg_match('/['.chr(10).chr(13).']/',$string) ? FALSE : TRUE;
255 }
256
257 /**
258 * Replaces ' with \' and \ with \\
259 *
260 * @param string Input value
261 * @return string Output value
262 * @see setValueInLocalconfFile()
263 */
264 function slashValueForSingleDashes($value) {
265 $value = str_replace("'.chr(10).'", '###INSTALL_TOOL_LINEBREAK###', $value);
266 $value = str_replace("'","\'",str_replace('\\','\\\\',$value));
267 $value = str_replace('###INSTALL_TOOL_LINEBREAK###', "'.chr(10).'", $value);
268
269 return $value;
270 }
271
272
273
274
275
276
277
278
279
280
281 /*************************************
282 *
283 * SQL
284 *
285 *************************************/
286
287 /**
288 * Reads the field definitions for the input sql-file string
289 *
290 * @param string $sqlContent: Should be a string read from an sql-file made with 'mysqldump [database_name] -d'
291 * @return array Array with information about table.
292 */
293 function getFieldDefinitions_sqlContent($sqlContent) {
294 $lines = t3lib_div::trimExplode(chr(10), $sqlContent,1);
295 $isTable = '';
296 $total = Array();
297
298 foreach($lines as $value) {
299 if ($value[0]!='#') {
300 if (!$isTable) {
301 $parts = explode(' ',$value);
302 if ($parts[0]=='CREATE' && $parts[1]=='TABLE') {
303 $isTable = str_replace( '`', '', $parts[2]);
304 if (TYPO3_OS=='WIN') { // tablenames are always lowercase on windows!
305 $isTable = strtolower($isTable);
306 }
307 }
308 } else {
309 if (substr($value,0,1)==')' && substr($value,-1)==';') {
310 $ttype = array();
311 preg_match('/(ENGINE|TYPE)=([a-zA-Z]*)/',$value,$ttype);
312 $total[$isTable]['extra']['ttype'] = $ttype[2];
313 $isTable = '';
314 } else {
315 $lineV = preg_replace('/,$/','',$value);
316 $lineV = str_replace('UNIQUE KEY', 'UNIQUE', $lineV);
317 $parts = explode(' ',$lineV,2);
318
319 // Make sure there is no default value when auto_increment is set
320 if(stristr($parts[1],'auto_increment')) {
321 $parts[1] = preg_replace('/ default \'0\'/i','',$parts[1]);
322 }
323 // "default" is always lower-case
324 if(strstr($parts[1], ' DEFAULT ')) {
325 $parts[1] = str_replace(' DEFAULT ', ' default ', $parts[1]);
326 }
327
328 // Change order of "default" and "null" statements
329 $parts[1] = preg_replace('/(.*) (default .*) (NOT NULL)/', '$1 $3 $2', $parts[1]);
330 $parts[1] = preg_replace('/(.*) (default .*) (NULL)/', '$1 $3 $2', $parts[1]);
331
332 // Remove double blanks
333 $parts[1] = preg_replace('/([^ ]+)[ ]+([^ ]+)/', '$1 $2', $parts[1]);
334
335 if ($parts[0]!='PRIMARY' && $parts[0]!='KEY' && $parts[0]!='UNIQUE') {
336 $key = str_replace('`', '', $parts[0]);
337 $total[$isTable]['fields'][$key] = $parts[1];
338 } else { // Process keys
339 $newParts = explode(' ',$parts[1],2);
340 $key = str_replace('`', '', ($parts[0]=='PRIMARY'?$parts[0]:$newParts[0]));
341 $lineV = str_replace('`', '', $lineV);
342 $total[$isTable]['keys'][$key] = $lineV;
343 }
344 }
345 }
346 }
347 }
348
349 $this->getFieldDefinitions_sqlContent_parseTypes($total);
350 return $total;
351 }
352
353 /**
354 * Multiplies varchars/tinytext fields in size according to $this->multiplySize
355 * 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.
356 *
357 * @param array Total array (from getFieldDefinitions_sqlContent())
358 * @return void
359 * @access private
360 * @see getFieldDefinitions_sqlContent()
361 */
362 function getFieldDefinitions_sqlContent_parseTypes(&$total) {
363
364 $mSize = (double)$this->multiplySize;
365 if ($mSize > 1) {
366
367 // Init SQL parser:
368 $sqlParser = t3lib_div::makeInstance('t3lib_sqlparser');
369 foreach($total as $table => $cfg) {
370 if (is_array($cfg['fields'])) {
371 foreach($cfg['fields'] as $fN => $fType) {
372 $orig_fType = $fType;
373 $fInfo = $sqlParser->parseFieldDef($fType);
374
375 switch($fInfo['fieldType']) {
376 case 'char':
377 case 'varchar':
378 $newSize = round($fInfo['value']*$mSize);
379
380 if ($newSize <= 255) {
381 $fInfo['value'] = $newSize;
382 } else {
383 $fInfo = array(
384 'fieldType' => 'text',
385 'featureIndex' => array(
386 'NOTNULL' => array(
387 'keyword' => 'NOT NULL'
388 )
389 )
390 );
391 // Change key definition if necessary (must use "prefix" on TEXT columns)
392 foreach ($cfg['keys'] as $kN => $kType) {
393 $match = array();
394 preg_match('/^([^(]*)\(([^)]+)\)(.*)/', $kType, $match);
395 $keys = array();
396 foreach (t3lib_div::trimExplode(',',$match[2]) as $kfN) {
397 if ($fN == $kfN) {
398 $kfN .= '('.$newSize.')';
399 }
400 $keys[] = $kfN;
401 }
402 $total[$table]['keys'][$kN] = $match[1].'('.join(',',$keys).')'.$match[3];
403 }
404 }
405 break;
406 case 'tinytext':
407 $fInfo['fieldType'] = 'text';
408 break;
409 }
410
411 $total[$table]['fields'][$fN] = $sqlParser->compileFieldCfg($fInfo);
412 if ($sqlParser->parse_error) die($sqlParser->parse_error);
413 }
414 }
415 }
416 }
417 }
418
419 /**
420 * Reads the field definitions for the current database
421 *
422 * @return array Array with information about table.
423 */
424 function getFieldDefinitions_database() {
425 $total = array();
426 $GLOBALS['TYPO3_DB']->sql_select_db(TYPO3_db);
427 echo $GLOBALS['TYPO3_DB']->sql_error();
428
429 $tables = $GLOBALS['TYPO3_DB']->admin_get_tables(TYPO3_db);
430 foreach($tables as $tableName) {
431
432 // Fields:
433 $fieldInformation = $GLOBALS['TYPO3_DB']->admin_get_fields($tableName);
434 foreach($fieldInformation as $fN => $fieldRow) {
435 $total[$tableName]['fields'][$fN] = $this->assembleFieldDefinition($fieldRow);
436 }
437
438 // Keys:
439 $keyInformation = $GLOBALS['TYPO3_DB']->admin_get_keys($tableName);
440 foreach($keyInformation as $kN => $keyRow) {
441 $tempKeys[$tableName][$keyRow['Key_name']][$keyRow['Seq_in_index']] = $keyRow['Column_name'];
442 if ($keyRow['Sub_part']) {
443 $tempKeys[$tableName][$keyRow['Key_name']][$keyRow['Seq_in_index']].= '('.$keyRow['Sub_part'].')';
444 }
445 if ($keyRow['Key_name']=='PRIMARY') {
446 $tempKeysPrefix[$tableName][$keyRow['Key_name']] = 'PRIMARY KEY';
447 } else {
448 if ($keyRow['Non_unique']) {
449 $tempKeysPrefix[$tableName][$keyRow['Key_name']] = 'KEY';
450 } else {
451 $tempKeysPrefix[$tableName][$keyRow['Key_name']] = 'UNIQUE';
452 }
453 $tempKeysPrefix[$tableName][$keyRow['Key_name']].= ' '.$keyRow['Key_name'];
454 }
455 }
456 }
457
458 // Compile information:
459 if (is_array($tempKeys)) {
460 foreach($tempKeys as $table => $keyInf) {
461 foreach($keyInf as $kName => $index) {
462 ksort($index);
463 $total[$table]['keys'][$kName] = $tempKeysPrefix[$table][$kName].' ('.implode(',',$index).')';
464 }
465 }
466 }
467
468 return $total;
469 }
470
471 /**
472 * Compares two arrays with field information and returns information about fields that are MISSING and fields that have CHANGED.
473 * FDsrc and FDcomp can be switched if you want the list of stuff to remove rather than update.
474 *
475 * @param array Field definitions, source (from getFieldDefinitions_sqlContent())
476 * @param array Field definitions, comparison. (from getFieldDefinitions_database())
477 * @param string Table names (in list) which is the ONLY one observed.
478 * @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.
479 * @return array Returns an array with 1) all elements from $FSsrc that is not in $FDcomp (in key 'extra') and 2) all elements from $FSsrc that is difference from the ones in $FDcomp
480 */
481 function getDatabaseExtra($FDsrc, $FDcomp, $onlyTableList='',$ignoreNotNullWhenComparing=true) {
482 $extraArr = array();
483 $diffArr = array();
484
485 if (is_array($FDsrc)) {
486 foreach($FDsrc as $table => $info) {
487 if (!strlen($onlyTableList) || t3lib_div::inList($onlyTableList, $table)) {
488 if (!isset($FDcomp[$table])) {
489 $extraArr[$table] = $info; // If the table was not in the FDcomp-array, the result array is loaded with that table.
490 $extraArr[$table]['whole_table']=1;
491 } else {
492 $keyTypes = explode(',','fields,keys');
493 foreach($keyTypes as $theKey) {
494 if (is_array($info[$theKey])) {
495 foreach($info[$theKey] as $fieldN => $fieldC) {
496 $fieldN = str_replace('`','',$fieldN);
497 if (!isset($FDcomp[$table][$theKey][$fieldN])) {
498 $extraArr[$table][$theKey][$fieldN] = $fieldC;
499 } elseif (strcmp($FDcomp[$table][$theKey][$fieldN], $ignoreNotNullWhenComparing?str_replace(' NOT NULL', '', $fieldC):$fieldC)) {
500 $diffArr[$table][$theKey][$fieldN] = $fieldC;
501 $diffArr_cur[$table][$theKey][$fieldN] = $FDcomp[$table][$theKey][$fieldN];
502 }
503 }
504 }
505 }
506 }
507 }
508 }
509 }
510
511 $output = array(
512 'extra' => $extraArr,
513 'diff' => $diffArr,
514 'diff_currentValues' => $diffArr_cur
515 );
516
517 return $output;
518 }
519
520 /**
521 * Returns an array with SQL-statements that is needed to update according to the diff-array
522 *
523 * @param array Array with differences of current and needed DB settings. (from getDatabaseExtra())
524 * @param string List of fields in diff array to take notice of.
525 * @return array Array of SQL statements (organized in keys depending on type)
526 */
527 function getUpdateSuggestions($diffArr,$keyList='extra,diff') {
528 $statements = array();
529 $deletedPrefixKey = $this->deletedPrefixKey;
530 $remove = 0;
531 if ($keyList == 'remove') {
532 $remove = 1;
533 $keyList = 'extra';
534 }
535 $keyList = explode(',',$keyList);
536 foreach($keyList as $theKey) {
537 if (is_array($diffArr[$theKey])) {
538 foreach($diffArr[$theKey] as $table => $info) {
539 $whole_table = array();
540 if (is_array($info['fields'])) {
541 foreach($info['fields'] as $fN => $fV) {
542 if ($info['whole_table']) {
543 $whole_table[]=$fN.' '.$fV;
544 } else {
545 if ($theKey=='extra') {
546 if ($remove) {
547 if (substr($fN,0,strlen($deletedPrefixKey))!=$deletedPrefixKey) {
548 $statement = 'ALTER TABLE '.$table.' CHANGE '.$fN.' '.$deletedPrefixKey.$fN.' '.$fV.';';
549 $statements['change'][md5($statement)] = $statement;
550 } else {
551 $statement = 'ALTER TABLE '.$table.' DROP '.$fN.';';
552 $statements['drop'][md5($statement)] = $statement;
553 }
554 } else {
555 $statement = 'ALTER TABLE '.$table.' ADD '.$fN.' '.$fV.';';
556 $statements['add'][md5($statement)] = $statement;
557 }
558 } elseif ($theKey=='diff') {
559 $statement = 'ALTER TABLE '.$table.' CHANGE '.$fN.' '.$fN.' '.$fV.';';
560 $statements['change'][md5($statement)] = $statement;
561 $statements['change_currentValue'][md5($statement)] = $diffArr['diff_currentValues'][$table]['fields'][$fN];
562 }
563 }
564 }
565 }
566 if (is_array($info['keys'])) {
567 foreach($info['keys'] as $fN => $fV) {
568 if ($info['whole_table']) {
569 $whole_table[] = $fV;
570 } else {
571 if ($theKey=='extra') {
572 if ($remove) {
573 $statement = 'ALTER TABLE '.$table.($fN=='PRIMARY' ? ' DROP PRIMARY KEY' : ' DROP KEY '.$fN).';';
574 $statements['drop'][md5($statement)] = $statement;
575 } else {
576 $statement = 'ALTER TABLE '.$table.' ADD '.$fV.';';
577 $statements['add'][md5($statement)] = $statement;
578 }
579 } elseif ($theKey=='diff') {
580 $statement = 'ALTER TABLE '.$table.($fN=='PRIMARY' ? ' DROP PRIMARY KEY' : ' DROP KEY '.$fN).';';
581 $statements['change'][md5($statement)] = $statement;
582 $statement = 'ALTER TABLE '.$table.' ADD '.$fV.';';
583 $statements['change'][md5($statement)] = $statement;
584 }
585 }
586 }
587 }
588 if ($info['whole_table']) {
589 if ($remove) {
590 if (substr($table,0,strlen($deletedPrefixKey))!=$deletedPrefixKey) {
591 $statement = 'ALTER TABLE '.$table.' RENAME '.$deletedPrefixKey.$table.';';
592 $statements['change_table'][md5($statement)]=$statement;
593 } else {
594 $statement = 'DROP TABLE '.$table.';';
595 $statements['drop_table'][md5($statement)]=$statement;
596 }
597 // count:
598 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('count(*)', $table, '');
599 list($count) = $GLOBALS['TYPO3_DB']->sql_fetch_row($res);
600 $statements['tables_count'][md5($statement)] = $count?'Records in table: '.$count:'';
601 } else {
602 $statement = 'CREATE TABLE '.$table." (\n".implode(",\n",$whole_table)."\n)";
603 $statement .= ($info['extra']['ttype']) ? ' TYPE='.$info['extra']['ttype'].';' : ';';
604 $statements['create_table'][md5($statement)]=$statement;
605 }
606 }
607 }
608 }
609 }
610
611 return $statements;
612 }
613
614 /**
615 * Converts a result row with field information into the SQL field definition string
616 *
617 * @param array MySQL result row.
618 * @return string Field definition
619 */
620 function assembleFieldDefinition($row) {
621 $field[] = $row['Type'];
622 // if (!$row['Null']) { $field[] = 'NOT NULL'; }
623 if (!strstr($row['Type'],'blob') && !strstr($row['Type'],'text')) {
624 // Add a default value if the field is not auto-incremented (these fields never have a default definition).
625 if (!stristr($row['Extra'],'auto_increment')) {
626 $field[] = 'default '."'".(addslashes($row['Default']))."'";
627 }
628 }
629 if ($row['Extra']) { $field[] = $row['Extra']; }
630
631 return implode(' ',$field);
632 }
633
634 /**
635 * Returns an array where every entry is a single sql-statement. Input must be formatted like an ordinary MySQL-dump files
636 *
637 * @param string $sqlcode 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.
638 * @param boolean If set, non-sql (like comments and blank lines) are not included in the final product)
639 * @param string Regex to filter SQL lines to include.
640 * @return array Array of SQL statements.
641 */
642 function getStatementArray($sqlcode,$removeNonSQL=0,$query_regex='') {
643 $sqlcodeArr = explode(chr(10),$sqlcode);
644
645 // Based on the assumption that the sql-dump has
646 $statementArray = array();
647 $statementArrayPointer = 0;
648
649 foreach($sqlcodeArr as $line => $linecontent) {
650 $is_set = 0;
651 if(stristr($linecontent,'auto_increment')) {
652 $linecontent = eregi_replace(' default \'0\'','',$linecontent);
653 }
654
655 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
656 $statementArray[$statementArrayPointer].= $linecontent;
657 $is_set = 1;
658 }
659 if (substr(trim($linecontent),-1)==';') {
660 if (isset($statementArray[$statementArrayPointer])) {
661 if (!trim($statementArray[$statementArrayPointer]) || ($query_regex && !eregi($query_regex,trim($statementArray[$statementArrayPointer])))) {
662 unset($statementArray[$statementArrayPointer]);
663 }
664 }
665 $statementArrayPointer++;
666 } elseif ($is_set) {
667 $statementArray[$statementArrayPointer].=chr(10);
668 }
669 }
670 return $statementArray;
671 }
672
673 /**
674 * Returns tables to create and how many records in each
675 *
676 * @param array Array of SQL statements to analyse.
677 * @param boolean If set, will count number of INSERT INTO statements following that table definition
678 * @return array Array with table definitions in index 0 and count in index 1
679 */
680 function getCreateTables($statements, $insertCountFlag=0) {
681 $crTables = array();
682 $insertCount = array();
683 foreach($statements as $line => $linecontent) {
684 $reg = array();
685 if (eregi('^create[[:space:]]*table[[:space:]]*[`]?([[:alnum:]_]*)[`]?',substr($linecontent,0,100),$reg)) {
686 $table = trim($reg[1]);
687 if ($table) {
688 if (TYPO3_OS=='WIN') { $table=strtolower($table); } // table names are always lowercase on Windows!
689 $sqlLines = explode(chr(10), $linecontent);
690 foreach($sqlLines as $k=>$v) {
691 if(stristr($v,'auto_increment')) {
692 $sqlLines[$k] = eregi_replace(' default \'0\'','',$v);
693 }
694 }
695 $linecontent = implode(chr(10), $sqlLines);
696 $crTables[$table] = $linecontent;
697 }
698 } elseif ($insertCountFlag && eregi('^insert[[:space:]]*into[[:space:]]*[`]?([[:alnum:]_]*)[`]?',substr($linecontent,0,100),$reg)) {
699 $nTable = trim($reg[1]);
700 $insertCount[$nTable]++;
701 }
702 }
703
704 return array($crTables,$insertCount);
705 }
706
707 /**
708 * Extracts all insert statements from $statement array where content is inserted into $table
709 *
710 * @param array Array of SQL statements
711 * @param string Table name
712 * @return array Array of INSERT INTO statements where table match $table
713 */
714 function getTableInsertStatements($statements, $table) {
715 $outStatements=array();
716 foreach($statements as $line => $linecontent) {
717 $reg = array();
718 if (preg_match('/^insert[[:space:]]*into[[:space:]]*[`]?([[:alnum:]_]*)[`]?/i',substr($linecontent,0,100),$reg)) {
719 $nTable = trim($reg[1]);
720 if ($nTable && !strcmp($table,$nTable)) {
721 $outStatements[]=$linecontent;
722 }
723 }
724 }
725 return $outStatements;
726 }
727
728 /**
729 * Performs the queries passed from the input array.
730 *
731 * @param array Array of SQL queries to execute.
732 * @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)
733 * @return void
734 */
735 function performUpdateQueries($arr,$keyArr) {
736 if (is_array($arr)) {
737 foreach($arr as $key => $string) {
738 if (isset($keyArr[$key]) && $keyArr[$key]) {
739 $GLOBALS['TYPO3_DB']->admin_query($string);
740 }
741 }
742 }
743 }
744
745 /**
746 * Returns list of tables in the database
747 *
748 * @return array List of tables.
749 * @see t3lib_db::admin_get_tables()
750 */
751 function getListOfTables() {
752 $whichTables = $GLOBALS['TYPO3_DB']->admin_get_tables(TYPO3_db);
753 return $whichTables;
754 }
755
756 /**
757 * Creates a table which checkboxes for updating database.
758 *
759 * @param array Array of statements (key / value pairs where key is used for the checkboxes)
760 * @param string Label for the table.
761 * @param boolean If set, then checkboxes are set by default.
762 * @param boolean If set, then icons are shown.
763 * @param array Array of "current values" for each key/value pair in $arr. Shown if given.
764 * @param boolean If set, will show the prefix "Current value" if $currentValue is given.
765 * @return string HTML table with checkboxes for update. Must be wrapped in a form.
766 */
767 function generateUpdateDatabaseForm_checkboxes($arr,$label,$checked=1,$iconDis=0,$currentValue=array(),$cVfullMsg=0) {
768 $out = array();
769 if (is_array($arr)) {
770 foreach($arr as $key => $string) {
771 $ico = '';
772 if ($iconDis) {
773 if (stristr($string,' user_')) {
774 $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(USER) </strong>';
775 }
776 if (stristr($string,' app_')) {
777 $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(APP) </strong>';
778 }
779 if (stristr($string,' ttx_') || stristr($string,' tx_')) {
780 $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(EXT) </strong>';
781 }
782 }
783 $out[]='
784 <tr>
785 <td valign="top"><input type="checkbox" id="db-'.$key.'" name="'.$this->dbUpdateCheckboxPrefix.'['.$key.']" value="1"'.($checked?' checked="checked"':'').' /></td>
786 <td nowrap="nowrap"><label for="db-'.$key.'">'.nl2br($ico.htmlspecialchars($string)).'</label></td>
787 </tr>';
788 if (isset($currentValue[$key])) {
789 $out[]='
790 <tr>
791 <td valign="top"></td>
792 <td nowrap="nowrap" style="color : #666666;">'.nl2br((!$cVfullMsg?"Current value: ":"").'<em>'.$currentValue[$key].'</em>').'</td>
793 </tr>';
794 }
795 }
796
797 // Compile rows:
798 $content = '
799 <!-- Update database fields / tables -->
800 <h3>'.$label.'</h3>
801 <table border="0" cellpadding="2" cellspacing="2" class="update-db-fields">'.implode('',$out).'
802 </table>';
803 }
804
805 return $content;
806 }
807 }
808
809 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_install.php']) {
810 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_install.php']);
811 }
812 ?>