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