Fixed bug #14097: Preview in BE opens Workspace-preview
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_install.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2010 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
75 /**
76 * Class to setup values in localconf.php and verify the TYPO3 DB tables/fields
77 *
78 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
79 * @package TYPO3
80 * @subpackage t3lib
81 */
82 class t3lib_install {
83
84
85 // External, Static
86 var $updateIdentity = ''; // Set to string which identifies the script using this class.
87 var $deletedPrefixKey = 'zzz_deleted_'; // Prefix used for tables/fields when deleted/renamed.
88 var $dbUpdateCheckboxPrefix = 'TYPO3_INSTALL[database_update]'; // Prefix for checkbox fields when updating database.
89 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.
90 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
91 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.
92 var $backPath = '../'; // Backpath (used for icons etc.)
93
94 var $multiplySize = 1; // Multiplier of SQL field size (for char, varchar and text fields)
95 var $character_sets = array(); // Caching output of $GLOBALS['TYPO3_DB']->admin_get_charsets()
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 $replace = array('["', '"]');
144 $search = array('[\'', '\']');
145 $varDoubleQuotes = str_replace($search, $replace, $variable);
146
147 // Search for variable name:
148 if (!$this->localconf_addLinesOnly && !$tokenSet) {
149 $line_array = array_reverse($line_array);
150 foreach($line_array as $k => $v) {
151 $v2 = trim($v);
152 if ($stopAtToken && !strcmp($v2,$commentKey.$this->localconf_editPointToken)) break; // If stopAtToken and token found, break out of the loop..
153 if (!strcmp(substr($v2,0,strlen($variable.' ')),$variable.' ')) {
154 $mainparts = explode($variable,$v,2);
155 if (count($mainparts)==2) { // should ALWAYS be....
156 $subparts = explode('//',$mainparts[1],2);
157 $line_array[$k] = $mainparts[0].$variable." = '".$this->slashValueForSingleDashes($value)."'; ".('//'.$comment.str_replace($comment,'',$subparts[1]));
158 $this->touchedLine = count($line_array)-$k-1;
159 $found = 1;
160 break;
161 }
162 } elseif (!strcmp(substr($v2, 0, strlen($varDoubleQuotes . ' ')), $varDoubleQuotes . ' ')) {
163 // Due to a bug in the update wizard (fixed in TYPO3 4.1.7) it is possible
164 // that $TYPO3_CONF_VARS['SYS']['compat_version'] was enclosed by "" (double
165 // quotes) instead of the expected '' (single quotes) when is was written to
166 // localconf.php. The following code was added to make sure that values with
167 // double quotes are updated, too.
168 $mainparts = explode($varDoubleQuotes, $v, 2);
169 if (count($mainparts) == 2) { // should ALWAYS be....
170 $subparts = explode('//', $mainparts[1], 2);
171 $line_array[$k] = $mainparts[0] . $variable . " = '" . $this->slashValueForSingleDashes($value) . "'; " . ('//' . $comment . str_replace($comment, '', $subparts[1]));
172 $this->touchedLine = count($line_array) - $k - 1;
173 $found = 1;
174 break;
175 }
176 }
177 }
178 $line_array = array_reverse($line_array);
179 }
180 if (!$found) {
181 if ($tokenSet) {
182 $line_array[] = $commentKey.$this->localconf_editPointToken;
183 $line_array[] = '';
184 }
185 $line_array[] = $variable." = '".$this->slashValueForSingleDashes($value)."'; // ".$comment;
186 $this->touchedLine = -1;
187 }
188 if ($variable == '$typo_db_password') {
189 $this->messages[] = 'Updated ' . $variable;
190 } else {
191 $this->messages[] = $variable . " = '" . htmlspecialchars($value) . "'";
192 }
193 $this->setLocalconf = 1;
194 }
195
196 /**
197 * Writes or returns lines from localconf.php
198 *
199 * @param array Array of lines to write back to localconf.php. Possibly
200 * @param string Absolute path of alternative file to use (Notice: this path is not validated in terms of being inside 'TYPO3 space')
201 * @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)
202 * @see setValueInLocalconfFile()
203 */
204 function writeToLocalconf_control($inlines='',$absFullPath='') {
205 $tmpExt = '.TMP.php';
206 $writeToLocalconf_dat = array();
207 $writeToLocalconf_dat['file'] = $absFullPath ? $absFullPath : PATH_typo3conf.'localconf.php';
208 $writeToLocalconf_dat['tmpfile'] = $writeToLocalconf_dat['file'].$tmpExt;
209
210 // Checking write state of localconf.php:
211 if (!$this->allowUpdateLocalConf) {
212 throw new RuntimeException(
213 'TYPO3 Fatal Error: ->allowUpdateLocalConf flag in the install object is not set and therefore "localconf.php" cannot be altered.',
214 1270853915
215 );
216 }
217 if (!@is_writable($writeToLocalconf_dat['file'])) {
218 throw new RuntimeException(
219 'TYPO3 Fatal Error: ' . $writeToLocalconf_dat['file'] . ' is not writable!',
220 1270853916
221 );
222 }
223
224 // Splitting localconf.php file into lines:
225 $lines = explode(LF,str_replace(CR,'',trim(t3lib_div::getUrl($writeToLocalconf_dat['file']))));
226 $writeToLocalconf_dat['endLine'] = array_pop($lines); // Getting "? >" ending.
227
228 // Checking if "updated" line was set by this tool - if so remove old line.
229 $updatedLine = array_pop($lines);
230 $writeToLocalconf_dat['updatedText'] = '// Updated by '.$this->updateIdentity.' ';
231
232 if (!strstr($updatedLine, $writeToLocalconf_dat['updatedText'])) {
233 array_push($lines,$updatedLine);
234 }
235
236 if (is_array($inlines)) { // Setting a line and write:
237 // Setting configuration
238 $updatedLine = $writeToLocalconf_dat['updatedText'].date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'].' H:i:s');
239 array_push($inlines,$updatedLine);
240 array_push($inlines,$writeToLocalconf_dat['endLine']);
241
242 if ($this->setLocalconf) {
243 $success = FALSE;
244 if (!t3lib_div::writeFile($writeToLocalconf_dat['tmpfile'],implode(LF,$inlines))) {
245 $msg = 'typo3conf/localconf.php'.$tmpExt.' could not be written - maybe a write access problem?';
246 }
247 elseif (strcmp(t3lib_div::getUrl($writeToLocalconf_dat['tmpfile']), implode(LF,$inlines))) {
248 @unlink($writeToLocalconf_dat['tmpfile']);
249 $msg = 'typo3conf/localconf.php'.$tmpExt.' was NOT written properly (written content didn\'t match file content) - maybe a disk space problem?';
250 }
251 elseif (!@copy($writeToLocalconf_dat['tmpfile'],$writeToLocalconf_dat['file'])) {
252 $msg = 'typo3conf/localconf.php could not be replaced by typo3conf/localconf.php'.$tmpExt.' - maybe a write access problem?';
253 }
254 else {
255 @unlink($writeToLocalconf_dat['tmpfile']);
256 $success = TRUE;
257 $msg = 'Configuration written to typo3conf/localconf.php';
258 }
259 $this->messages[] = $msg;
260
261 if ($success) {
262 return 'continue';
263 } else {
264 t3lib_div::sysLog($msg, 'Core', 3);
265 return 'nochange';
266 }
267 } else {
268 return 'nochange';
269 }
270 } else { // Return lines found in localconf.php
271 return $lines;
272 }
273 }
274
275 /**
276 * Checking for linebreaks in the string
277 *
278 * @param string String to test
279 * @return boolean Returns TRUE if string is OK
280 * @see setValueInLocalconfFile()
281 */
282 function checkForBadString($string) {
283 return preg_match('/['.LF.CR.']/',$string) ? FALSE : TRUE;
284 }
285
286 /**
287 * Replaces ' with \' and \ with \\
288 *
289 * @param string Input value
290 * @return string Output value
291 * @see setValueInLocalconfFile()
292 */
293 function slashValueForSingleDashes($value) {
294 $value = str_replace("'.LF.'", '###INSTALL_TOOL_LINEBREAK###', $value);
295 $value = str_replace("'","\'",str_replace('\\','\\\\',$value));
296 $value = str_replace('###INSTALL_TOOL_LINEBREAK###', "'.LF.'", $value);
297
298 return $value;
299 }
300
301
302
303
304
305
306
307
308
309
310 /*************************************
311 *
312 * SQL
313 *
314 *************************************/
315
316 /**
317 * Reads the field definitions for the input SQL-file string
318 *
319 * @param string Should be a string read from an SQL-file made with 'mysqldump [database_name] -d'
320 * @return array Array with information about table.
321 */
322 function getFieldDefinitions_fileContent($fileContent) {
323 $lines = t3lib_div::trimExplode(LF, $fileContent, 1);
324 $table = '';
325 $total = array();
326
327 foreach ($lines as $value) {
328 if (substr($value,0,1)=='#') {
329 continue; // Ignore comments
330 }
331
332 if (!strlen($table)) {
333 $parts = t3lib_div::trimExplode(' ', $value, TRUE);
334 if (strtoupper($parts[0]) === 'CREATE' && strtoupper($parts[1]) === 'TABLE') {
335 $table = str_replace( '`', '', $parts[2]);
336 if (TYPO3_OS=='WIN') { // tablenames are always lowercase on windows!
337 $table = strtolower($table);
338 }
339 }
340 } else {
341 if (substr($value,0,1)==')' && substr($value,-1)==';') {
342 $ttype = array();
343 if (preg_match('/(ENGINE|TYPE)[ ]*=[ ]*([a-zA-Z]*)/',$value,$ttype)) {
344 $total[$table]['extra']['ENGINE'] = $ttype[2];
345 } // Otherwise, just do nothing: If table engine is not defined, just accept the system default.
346
347 // Set the collation, if specified
348 if (preg_match('/(COLLATE)[ ]*=[ ]*([a-zA-z0-9_-]+)/', $value, $tcollation)) {
349 $total[$table]['extra']['COLLATE'] = $tcollation[2];
350 } else {
351 // Otherwise, get the CHARACTER SET and try to find the default collation for it as returned by "SHOW CHARACTER SET" query (for details, see http://dev.mysql.com/doc/refman/5.1/en/charset-table.html)
352 if (preg_match('/(CHARSET|CHARACTER SET)[ ]*=[ ]*([a-zA-z0-9_-]+)/', $value, $tcharset)) { // Note: Keywords "DEFAULT CHARSET" and "CHARSET" are the same, so "DEFAULT" can just be ignored
353 $charset = $tcharset[2];
354 } else {
355 $charset = $GLOBALS['TYPO3_DB']->default_charset; // Fallback to default charset
356 }
357 $total[$table]['extra']['COLLATE'] = $this->getCollationForCharset($charset);
358 }
359
360 $table = ''; // Remove table marker and start looking for the next "CREATE TABLE" statement
361 } else {
362 $lineV = preg_replace('/,$/','',$value); // Strip trailing commas
363 $lineV = str_replace('`', '', $lineV);
364 $lineV = str_replace(' ', ' ', $lineV); // Remove double blanks
365
366 $parts = explode(' ', $lineV, 2);
367 if (!preg_match('/(PRIMARY|UNIQUE|FULLTEXT|INDEX|KEY)/',$parts[0])) { // Field definition
368
369 // Make sure there is no default value when auto_increment is set
370 if (stristr($parts[1],'auto_increment')) {
371 $parts[1] = preg_replace('/ default \'0\'/i','',$parts[1]);
372 }
373 // "default" is always lower-case
374 if (stristr($parts[1], ' DEFAULT ')) {
375 $parts[1] = str_ireplace(' DEFAULT ', ' default ', $parts[1]);
376 }
377
378 // Change order of "default" and "null" statements
379 $parts[1] = preg_replace('/(.*) (default .*) (NOT NULL)/', '$1 $3 $2', $parts[1]);
380 $parts[1] = preg_replace('/(.*) (default .*) (NULL)/', '$1 $3 $2', $parts[1]);
381
382 $key = $parts[0];
383 $total[$table]['fields'][$key] = $parts[1];
384
385 } else { // Key definition
386 $search = array('/UNIQUE (INDEX|KEY)/', '/FULLTEXT (INDEX|KEY)/', '/INDEX/');
387 $replace = array('UNIQUE', 'FULLTEXT', 'KEY');
388 $lineV = preg_replace($search, $replace, $lineV);
389
390 if (preg_match('/PRIMARY|UNIQUE|FULLTEXT/', $parts[0])) {
391 $parts[1] = preg_replace('/^(KEY|INDEX) /', '', $parts[1]);
392 }
393
394 $newParts = explode(' ',$parts[1],2);
395 $key = $parts[0]=='PRIMARY' ? $parts[0] : $newParts[0];
396
397 $total[$table]['keys'][$key] = $lineV;
398
399 // This is a protection against doing something stupid: Only allow clearing of cache_* and index_* tables.
400 if (preg_match('/^(cache|index)_/',$table)) {
401 // Suggest to truncate (clear) this table
402 $total[$table]['extra']['CLEAR'] = 1;
403 }
404 }
405 }
406 }
407 }
408
409 $this->getFieldDefinitions_sqlContent_parseTypes($total);
410 return $total;
411 }
412
413 /**
414 * Multiplies varchars/tinytext fields in size according to $this->multiplySize
415 * 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.
416 *
417 * @param array Total array (from getFieldDefinitions_fileContent())
418 * @return void
419 * @access private
420 * @see getFieldDefinitions_fileContent()
421 */
422 function getFieldDefinitions_sqlContent_parseTypes(&$total) {
423
424 $mSize = (double)$this->multiplySize;
425 if ($mSize > 1) {
426
427 // Init SQL parser:
428 $sqlParser = t3lib_div::makeInstance('t3lib_sqlparser');
429 foreach($total as $table => $cfg) {
430 if (is_array($cfg['fields'])) {
431 foreach($cfg['fields'] as $fN => $fType) {
432 $orig_fType = $fType;
433 $fInfo = $sqlParser->parseFieldDef($fType);
434
435 switch($fInfo['fieldType']) {
436 case 'char':
437 case 'varchar':
438 $newSize = round($fInfo['value']*$mSize);
439
440 if ($newSize <= 255) {
441 $fInfo['value'] = $newSize;
442 } else {
443 $fInfo = array(
444 'fieldType' => 'text',
445 'featureIndex' => array(
446 'NOTNULL' => array(
447 'keyword' => 'NOT NULL'
448 )
449 )
450 );
451 // Change key definition if necessary (must use "prefix" on TEXT columns)
452 if (is_array($cfg['keys'])) {
453 foreach ($cfg['keys'] as $kN => $kType) {
454 $match = array();
455 preg_match('/^([^(]*)\(([^)]+)\)(.*)/', $kType, $match);
456 $keys = array();
457 foreach (t3lib_div::trimExplode(',',$match[2]) as $kfN) {
458 if ($fN == $kfN) {
459 $kfN .= '('.$newSize.')';
460 }
461 $keys[] = $kfN;
462 }
463 $total[$table]['keys'][$kN] = $match[1].'('.implode(',',$keys).')'.$match[3];
464 }
465 }
466 }
467 break;
468 case 'tinytext':
469 $fInfo['fieldType'] = 'text';
470 break;
471 }
472
473 $total[$table]['fields'][$fN] = $sqlParser->compileFieldCfg($fInfo);
474 if ($sqlParser->parse_error) {
475 throw new RuntimeException(
476 'TYPO3 Fatal Error: ' . $sqlParser->parse_error,
477 1270853961
478 );
479 }
480 }
481 }
482 }
483 }
484 }
485
486 /**
487 * Look up the default collation for specified character set based on "SHOW CHARACTER SET" output
488 *
489 * @param string Character set
490 * @return string Corresponding default collation
491 */
492 function getCollationForCharset($charset) {
493 // Load character sets, if not cached already
494 if (!count($this->character_sets)) {
495 if (method_exists($GLOBALS['TYPO3_DB'],'admin_get_charsets')) {
496 $this->character_sets = $GLOBALS['TYPO3_DB']->admin_get_charsets();
497 } else {
498 $this->character_sets[$charset] = array(); // Add empty element to avoid that the check will be repeated
499 }
500 }
501
502 $collation = '';
503 if (isset($this->character_sets[$charset]['Default collation'])) {
504 $collation = $this->character_sets[$charset]['Default collation'];
505 }
506
507 return $collation;
508 }
509
510 /**
511 * Reads the field definitions for the current database
512 *
513 * @return array Array with information about table.
514 */
515 function getFieldDefinitions_database() {
516 $total = array();
517 $tempKeys = array();
518 $tempKeysPrefix = array();
519
520 $GLOBALS['TYPO3_DB']->sql_select_db(TYPO3_db);
521 echo $GLOBALS['TYPO3_DB']->sql_error();
522
523 $tables = $GLOBALS['TYPO3_DB']->admin_get_tables(TYPO3_db);
524 foreach ($tables as $tableName => $tableStatus) {
525
526 // Fields:
527 $fieldInformation = $GLOBALS['TYPO3_DB']->admin_get_fields($tableName);
528 foreach ($fieldInformation as $fN => $fieldRow) {
529 $total[$tableName]['fields'][$fN] = $this->assembleFieldDefinition($fieldRow);
530 }
531
532 // Keys:
533 $keyInformation = $GLOBALS['TYPO3_DB']->admin_get_keys($tableName);
534
535 foreach ($keyInformation as $keyRow) {
536 $keyName = $keyRow['Key_name'];
537 $colName = $keyRow['Column_name'];
538 if ($keyRow['Sub_part']) {
539 $colName.= '('.$keyRow['Sub_part'].')';
540 }
541 $tempKeys[$tableName][$keyName][$keyRow['Seq_in_index']] = $colName;
542 if ($keyName=='PRIMARY') {
543 $prefix = 'PRIMARY KEY';
544 } else {
545 if ($keyRow['Index_type']=='FULLTEXT') {
546 $prefix = 'FULLTEXT';
547 } elseif ($keyRow['Non_unique']) {
548 $prefix = 'KEY';
549 } else {
550 $prefix = 'UNIQUE';
551 }
552 $prefix.= ' '.$keyName;
553 }
554 $tempKeysPrefix[$tableName][$keyName] = $prefix;
555 }
556
557 // Table status (storage engine, collaction, etc.)
558 if (is_array($tableStatus)) {
559 $tableExtraFields = array(
560 'Engine' => 'ENGINE',
561 'Collation' => 'COLLATE',
562 );
563
564 foreach ($tableExtraFields as $mysqlKey=>$internalKey) {
565 if (isset($tableStatus[$mysqlKey])) {
566 $total[$tableName]['extra'][$internalKey] = $tableStatus[$mysqlKey];
567 }
568 }
569 }
570 }
571
572 // Compile key information:
573 if (count($tempKeys)) {
574 foreach ($tempKeys as $table => $keyInf) {
575 foreach ($keyInf as $kName => $index) {
576 ksort($index);
577 $total[$table]['keys'][$kName] = $tempKeysPrefix[$table][$kName].' ('.implode(',',$index).')';
578 }
579 }
580 }
581
582 return $total;
583 }
584
585 /**
586 * Compares two arrays with field information and returns information about fields that are MISSING and fields that have CHANGED.
587 * FDsrc and FDcomp can be switched if you want the list of stuff to remove rather than update.
588 *
589 * @param array Field definitions, source (from getFieldDefinitions_fileContent())
590 * @param array Field definitions, comparison. (from getFieldDefinitions_database())
591 * @param string Table names (in list) which is the ONLY one observed.
592 * @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.
593 * @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
594 */
595 function getDatabaseExtra($FDsrc, $FDcomp, $onlyTableList='',$ignoreNotNullWhenComparing=true) {
596 $extraArr = array();
597 $diffArr = array();
598
599 if (is_array($FDsrc)) {
600 foreach ($FDsrc as $table => $info) {
601 if (!strlen($onlyTableList) || t3lib_div::inList($onlyTableList, $table)) {
602 if (!isset($FDcomp[$table])) {
603 $extraArr[$table] = $info; // If the table was not in the FDcomp-array, the result array is loaded with that table.
604 $extraArr[$table]['whole_table']=1;
605 } else {
606 $keyTypes = explode(',','extra,fields,keys');
607 foreach ($keyTypes as $theKey) {
608 if (is_array($info[$theKey])) {
609 foreach ($info[$theKey] as $fieldN => $fieldC) {
610 $fieldN = str_replace('`','',$fieldN);
611 if ($fieldN=='COLLATE') {
612 continue; // TODO: collation support is currently disabled (needs more testing)
613 }
614
615 if (!isset($FDcomp[$table][$theKey][$fieldN])) {
616 $extraArr[$table][$theKey][$fieldN] = $fieldC;
617 } else {
618 $fieldC = trim($fieldC);
619 if ($ignoreNotNullWhenComparing) {
620 $fieldC = str_replace(' NOT NULL', '', $fieldC);
621 $FDcomp[$table][$theKey][$fieldN] = str_replace(' NOT NULL', '', $FDcomp[$table][$theKey][$fieldN]);
622 }
623 if ($fieldC !== $FDcomp[$table][$theKey][$fieldN]) {
624 $diffArr[$table][$theKey][$fieldN] = $fieldC;
625 $diffArr_cur[$table][$theKey][$fieldN] = $FDcomp[$table][$theKey][$fieldN];
626 }
627 }
628 }
629 }
630 }
631 }
632 }
633 }
634 }
635
636 $output = array(
637 'extra' => $extraArr,
638 'diff' => $diffArr,
639 'diff_currentValues' => $diffArr_cur
640 );
641
642 return $output;
643 }
644
645 /**
646 * Returns an array with SQL-statements that is needed to update according to the diff-array
647 *
648 * @param array Array with differences of current and needed DB settings. (from getDatabaseExtra())
649 * @param string List of fields in diff array to take notice of.
650 * @return array Array of SQL statements (organized in keys depending on type)
651 */
652 function getUpdateSuggestions($diffArr,$keyList='extra,diff') {
653 $statements = array();
654 $deletedPrefixKey = $this->deletedPrefixKey;
655 $remove = 0;
656 if ($keyList == 'remove') {
657 $remove = 1;
658 $keyList = 'extra';
659 }
660 $keyList = explode(',',$keyList);
661 foreach ($keyList as $theKey) {
662 if (is_array($diffArr[$theKey])) {
663 foreach ($diffArr[$theKey] as $table => $info) {
664 $whole_table = array();
665 if (is_array($info['fields'])) {
666 foreach ($info['fields'] as $fN => $fV) {
667 if ($info['whole_table']) {
668 $whole_table[]=$fN.' '.$fV;
669 } else {
670 // Special case to work around MySQL problems when adding auto_increment fields:
671 if (stristr($fV, 'auto_increment')) {
672 // The field can only be set "auto_increment" if there exists a PRIMARY key of that field already.
673 // The check does not look up which field is primary but just assumes it must be the field with the auto_increment value...
674 if (isset($diffArr['extra'][$table]['keys']['PRIMARY'])) {
675 // Remove "auto_increment" from the statement - it will be suggested in a 2nd step after the primary key was created
676 $fV = str_replace(' auto_increment', '', $fV);
677 } else {
678 // In the next step, attempt to clear the table once again (2 = force)
679 $info['extra']['CLEAR'] = 2;
680 }
681 }
682 if ($theKey=='extra') {
683 if ($remove) {
684 if (substr($fN,0,strlen($deletedPrefixKey))!=$deletedPrefixKey) {
685 $statement = 'ALTER TABLE '.$table.' CHANGE '.$fN.' '.$deletedPrefixKey.$fN.' '.$fV.';';
686 $statements['change'][md5($statement)] = $statement;
687 } else {
688 $statement = 'ALTER TABLE '.$table.' DROP '.$fN.';';
689 $statements['drop'][md5($statement)] = $statement;
690 }
691 } else {
692 $statement = 'ALTER TABLE '.$table.' ADD '.$fN.' '.$fV.';';
693 $statements['add'][md5($statement)] = $statement;
694 }
695 } elseif ($theKey=='diff') {
696 $statement = 'ALTER TABLE '.$table.' CHANGE '.$fN.' '.$fN.' '.$fV.';';
697 $statements['change'][md5($statement)] = $statement;
698 $statements['change_currentValue'][md5($statement)] = $diffArr['diff_currentValues'][$table]['fields'][$fN];
699 }
700 }
701 }
702 }
703 if (is_array($info['keys'])) {
704 foreach ($info['keys'] as $fN => $fV) {
705 if ($info['whole_table']) {
706 $whole_table[] = $fV;
707 } else {
708 if ($theKey=='extra') {
709 if ($remove) {
710 $statement = 'ALTER TABLE '.$table.($fN=='PRIMARY' ? ' DROP PRIMARY KEY' : ' DROP KEY '.$fN).';';
711 $statements['drop'][md5($statement)] = $statement;
712 } else {
713 $statement = 'ALTER TABLE '.$table.' ADD '.$fV.';';
714 $statements['add'][md5($statement)] = $statement;
715 }
716 } elseif ($theKey=='diff') {
717 $statement = 'ALTER TABLE '.$table.($fN=='PRIMARY' ? ' DROP PRIMARY KEY' : ' DROP KEY '.$fN).';';
718 $statements['change'][md5($statement)] = $statement;
719 $statement = 'ALTER TABLE '.$table.' ADD '.$fV.';';
720 $statements['change'][md5($statement)] = $statement;
721 }
722 }
723 }
724 }
725 if (is_array($info['extra'])) {
726 $extras = array();
727 $extras_currentValue = array();
728 $clear_table = false;
729
730 foreach ($info['extra'] as $fN => $fV) {
731
732 // Only consider statements which are missing in the database but don't remove existing properties
733 if (!$remove) {
734 if (!$info['whole_table']) { // If the whole table is created at once, we take care of this later by imploding all elements of $info['extra']
735 if ($fN=='CLEAR') {
736 // Truncate table must happen later, not now
737 // Valid values for CLEAR: 1=only clear if keys are missing, 2=clear anyway (force)
738 if (count($info['keys']) || $fV==2) {
739 $clear_table = true;
740 }
741 continue;
742 } else {
743 $extras[] = $fN.'='.$fV;
744 $extras_currentValue[] = $fN.'='.$diffArr['diff_currentValues'][$table]['extra'][$fN];
745 }
746 }
747 }
748 }
749 if ($clear_table) {
750 $statement = 'TRUNCATE TABLE '.$table.';';
751 $statements['clear_table'][md5($statement)] = $statement;
752 }
753 if (count($extras)) {
754 $statement = 'ALTER TABLE '.$table.' '.implode(' ',$extras).';';
755 $statements['change'][md5($statement)] = $statement;
756 $statements['change_currentValue'][md5($statement)] = implode(' ',$extras_currentValue);
757 }
758 }
759 if ($info['whole_table']) {
760 if ($remove) {
761 if (substr($table,0,strlen($deletedPrefixKey))!=$deletedPrefixKey) {
762 $statement = 'ALTER TABLE '.$table.' RENAME '.$deletedPrefixKey.$table.';';
763 $statements['change_table'][md5($statement)] = $statement;
764 } else {
765 $statement = 'DROP TABLE '.$table.';';
766 $statements['drop_table'][md5($statement)] = $statement;
767 }
768 // count:
769 $count = $GLOBALS['TYPO3_DB']->exec_SELECTcountRows('*', $table);
770 $statements['tables_count'][md5($statement)] = $count?'Records in table: '.$count:'';
771 } else {
772 $statement = 'CREATE TABLE '.$table." (\n".implode(",\n",$whole_table)."\n)";
773 if ($info['extra']) {
774 foreach ($info['extra'] as $k=>$v) {
775 if ($k=='COLLATE' || $k=='CLEAR') {
776 continue; // Skip these special statements. TODO: collation support is currently disabled (needs more testing)
777 }
778 $statement.= ' '.$k.'='.$v; // Add extra attributes like ENGINE, CHARSET, etc.
779 }
780 }
781 $statement.= ';';
782 $statements['create_table'][md5($statement)] = $statement;
783 }
784 }
785 }
786 }
787 }
788
789 return $statements;
790 }
791
792 /**
793 * Converts a result row with field information into the SQL field definition string
794 *
795 * @param array MySQL result row
796 * @return string Field definition
797 */
798 function assembleFieldDefinition($row) {
799 $field = array($row['Type']);
800
801 if ($row['Null']=='NO') {
802 $field[] = 'NOT NULL';
803 }
804 if (!strstr($row['Type'],'blob') && !strstr($row['Type'],'text')) {
805 // Add a default value if the field is not auto-incremented (these fields never have a default definition)
806 if (!stristr($row['Extra'],'auto_increment')) {
807 $field[] = 'default \''.addslashes($row['Default']).'\'';
808 }
809 }
810 if ($row['Extra']) {
811 $field[] = $row['Extra'];
812 }
813
814 return implode(' ',$field);
815 }
816
817 /**
818 * Returns an array where every entry is a single SQL-statement. Input must be formatted like an ordinary MySQL-dump files.
819 *
820 * @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.
821 * @param boolean If set, non-SQL content (like comments and blank lines) is not included in the final output
822 * @param string Regex to filter SQL lines to include
823 * @return array Array of SQL statements
824 */
825 function getStatementArray($sqlcode,$removeNonSQL=0,$query_regex='') {
826 $sqlcodeArr = explode(LF, $sqlcode);
827
828 // Based on the assumption that the sql-dump has
829 $statementArray = array();
830 $statementArrayPointer = 0;
831
832 foreach ($sqlcodeArr as $line => $lineContent) {
833 $is_set = 0;
834
835 // auto_increment fields cannot have a default value!
836 if (stristr($lineContent,'auto_increment')) {
837 $lineContent = preg_replace('/ default \'0\'/i', '', $lineContent);
838 }
839
840 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
841 $statementArray[$statementArrayPointer].= $lineContent;
842 $is_set = 1;
843 }
844 if (substr(trim($lineContent),-1)==';') {
845 if (isset($statementArray[$statementArrayPointer])) {
846 if (!trim($statementArray[$statementArrayPointer]) || ($query_regex && !preg_match('/'.$query_regex.'/i',trim($statementArray[$statementArrayPointer])))) {
847 unset($statementArray[$statementArrayPointer]);
848 }
849 }
850 $statementArrayPointer++;
851
852 } elseif ($is_set) {
853 $statementArray[$statementArrayPointer].= LF;
854 }
855 }
856
857 return $statementArray;
858 }
859
860 /**
861 * Returns tables to create and how many records in each
862 *
863 * @param array Array of SQL statements to analyse.
864 * @param boolean If set, will count number of INSERT INTO statements following that table definition
865 * @return array Array with table definitions in index 0 and count in index 1
866 */
867 function getCreateTables($statements, $insertCountFlag=0) {
868 $crTables = array();
869 $insertCount = array();
870 foreach ($statements as $line => $lineContent) {
871 $reg = array();
872 if (preg_match('/^create[[:space:]]*table[[:space:]]*[`]?([[:alnum:]_]*)[`]?/i',substr($lineContent,0,100),$reg)) {
873 $table = trim($reg[1]);
874 if ($table) {
875 // table names are always lowercase on Windows!
876 if (TYPO3_OS == 'WIN') {
877 $table = strtolower($table);
878 }
879 $sqlLines = explode(LF, $lineContent);
880 foreach ($sqlLines as $k=>$v) {
881 if (stristr($v,'auto_increment')) {
882 $sqlLines[$k] = preg_replace('/ default \'0\'/i', '', $v);
883 }
884 }
885 $lineContent = implode(LF, $sqlLines);
886 $crTables[$table] = $lineContent;
887 }
888 } elseif ($insertCountFlag && preg_match('/^insert[[:space:]]*into[[:space:]]*[`]?([[:alnum:]_]*)[`]?/i',substr($lineContent,0,100),$reg)) {
889 $nTable = trim($reg[1]);
890 $insertCount[$nTable]++;
891 }
892 }
893
894 return array($crTables,$insertCount);
895 }
896
897 /**
898 * Extracts all insert statements from $statement array where content is inserted into $table
899 *
900 * @param array Array of SQL statements
901 * @param string Table name
902 * @return array Array of INSERT INTO statements where table match $table
903 */
904 function getTableInsertStatements($statements, $table) {
905 $outStatements=array();
906 foreach($statements as $line => $lineContent) {
907 $reg = array();
908 if (preg_match('/^insert[[:space:]]*into[[:space:]]*[`]?([[:alnum:]_]*)[`]?/i',substr($lineContent,0,100),$reg)) {
909 $nTable = trim($reg[1]);
910 if ($nTable && !strcmp($table,$nTable)) {
911 $outStatements[] = $lineContent;
912 }
913 }
914 }
915 return $outStatements;
916 }
917
918 /**
919 * Performs the queries passed from the input array.
920 *
921 * @param array Array of SQL queries to execute.
922 * @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)
923 * @return mixed Array with error message from database if any occured. Otherwise true if everything was executed successfully.
924 */
925 function performUpdateQueries($arr,$keyArr) {
926 $result = array();
927 if (is_array($arr)) {
928 foreach($arr as $key => $string) {
929 if (isset($keyArr[$key]) && $keyArr[$key]) {
930 $res = $GLOBALS['TYPO3_DB']->admin_query($string);
931 if ($res === false) {
932 $result[$key] = $GLOBALS['TYPO3_DB']->sql_error();
933 } elseif (is_resource($res)) {
934 $GLOBALS['TYPO3_DB']->sql_free_result($res);
935 }
936 }
937 }
938 }
939 if (count($result) > 0) {
940 return $result;
941 } else {
942 return true;
943 }
944 }
945
946 /**
947 * Returns list of tables in the database
948 *
949 * @return array List of tables.
950 * @see t3lib_db::admin_get_tables()
951 */
952 function getListOfTables() {
953 $whichTables = $GLOBALS['TYPO3_DB']->admin_get_tables(TYPO3_db);
954 foreach ($whichTables as $key=>&$value) {
955 $value = $key;
956 }
957 return $whichTables;
958 }
959
960 /**
961 * Creates a table which checkboxes for updating database.
962 *
963 * @param array Array of statements (key / value pairs where key is used for the checkboxes)
964 * @param string Label for the table.
965 * @param boolean If set, then checkboxes are set by default.
966 * @param boolean If set, then icons are shown.
967 * @param array Array of "current values" for each key/value pair in $arr. Shown if given.
968 * @param boolean If set, will show the prefix "Current value" if $currentValue is given.
969 * @return string HTML table with checkboxes for update. Must be wrapped in a form.
970 */
971 function generateUpdateDatabaseForm_checkboxes($arr,$label,$checked=1,$iconDis=0,$currentValue=array(),$cVfullMsg=0) {
972 $out = array();
973 if (is_array($arr)) {
974 $tableId = uniqid('table');
975 if (count($arr) > 1) {
976 $out[] = '
977 <tr class="update-db-fields-batch">
978 <td valign="top">
979 <input type="checkbox" id="' . $tableId . '-checkbox"' . ($checked ? ' checked="checked"' : '') . '
980 onclick="$(\'' . $tableId . '\').select(\'input[type=checkbox]\').invoke(\'setValue\', $(this).checked);" />
981 </td>
982 <td nowrap="nowrap"><label for="' . $tableId . '-checkbox" style="cursor:pointer"><strong>select/deselect all</strong></label></td>
983 </tr>';
984 }
985 foreach($arr as $key => $string) {
986 $ico = '';
987 $warnings = array();
988
989 if ($iconDis) {
990 if (preg_match('/^TRUNCATE/i',$string)) {
991 $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong> </strong>';
992 $warnings['clear_table_info'] = 'Clearing the table is sometimes neccessary when adding new keys. In case of cache_* tables this should not hurt at all. However, use it with care.';
993 } elseif (stristr($string,' user_')) {
994 $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(USER) </strong>';
995 } elseif (stristr($string,' app_')) {
996 $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(APP) </strong>';
997 } elseif (stristr($string,' ttx_') || stristr($string,' tx_')) {
998 $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(EXT) </strong>';
999 }
1000 }
1001 $out[]='
1002 <tr>
1003 <td valign="top"><input type="checkbox" id="db-'.$key.'" name="'.$this->dbUpdateCheckboxPrefix.'['.$key.']" value="1"'.($checked?' checked="checked"':'').' /></td>
1004 <td nowrap="nowrap"><label for="db-'.$key.'">'.nl2br($ico.htmlspecialchars($string)).'</label></td>
1005 </tr>';
1006 if (isset($currentValue[$key])) {
1007 $out[]='
1008 <tr>
1009 <td valign="top"></td>
1010 <td nowrap="nowrap" style="color:#666666;">'.nl2br((!$cVfullMsg?"Current value: ":"").'<em>'.$currentValue[$key].'</em>').'</td>
1011 </tr>';
1012 }
1013 }
1014 if (count($warnings)) {
1015 $out[] = '
1016 <tr>
1017 <td valign="top"></td>
1018 <td style="color:#666666;"><em>' . implode('<br />',$warnings) . '</em></td>
1019 </tr>';
1020 }
1021
1022 // Compile rows:
1023 $content = '
1024 <!-- Update database fields / tables -->
1025 <h3>'.$label.'</h3>
1026 <table border="0" cellpadding="2" cellspacing="2" id="' . $tableId . '" class="update-db-fields">' . implode('', $out) . '
1027 </table>';
1028 }
1029
1030 return $content;
1031 }
1032
1033 /**
1034 * Reads the field definitions for the input SQL-file string
1035 *
1036 * @param string Should be a string read from an SQL-file made with 'mysqldump [database_name] -d'
1037 * @return array Array with information about table.
1038 * @deprecated since TYPO3 4.2, this function will be removed in TYPO3 4.5, use ->getFieldDefinitions_fileContent() instead!
1039 */
1040 function getFieldDefinitions_sqlContent($fileContent) {
1041 t3lib_div::logDeprecatedFunction();
1042
1043 return $this->getFieldDefinitions_fileContent($fileContent);
1044 }
1045 }
1046
1047 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_install.php']) {
1048 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_install.php']);
1049 }
1050
1051 ?>