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