class.t3lib_install.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2010 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
/**
 * Class to setup values in localconf.php and verify the TYPO3 DB tables/fields
 *
 * $Id: class.t3lib_install.php 8145 2010-07-09 07:34:38Z steffenk $
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 */
/**
 * [CLASS/FUNCTION INDEX of SCRIPT]
 *
 *
 *
 *   83: class t3lib_install
 *  108:     function t3lib_install()
 *
 *              SECTION: Writing to localconf.php
 *  132:     function setValueInLocalconfFile(&$line_array, $variable, $value)
 *  183:     function writeToLocalconf_control($inlines='',$absFullPath='')
 *  253:     function checkForBadString($string)
 *  266:     function slashValueForSingleDashes($value)
 *
 *              SECTION: SQL
 *  291:     function getFieldDefinitions_fileContent($fileContent)
 *  359:     function getFieldDefinitions_sqlContent_parseTypes(&$total)
 *  406:     function getFieldDefinitions_database()
 *  450:     function getDatabaseExtra($FDsrc, $FDcomp, $onlyTableList='')
 *  496:     function getUpdateSuggestions($diffArr,$keyList='extra,diff')
 *  589:     function assembleFieldDefinition($row)
 *  611:     function getStatementArray($sqlcode,$removeNonSQL=0,$query_regex='')
 *  649:     function getCreateTables($statements, $insertCountFlag=0)
 *  683:     function getTableInsertStatements($statements, $table)
 *  704:     function performUpdateQueries($arr,$keyArr)
 *  720:     function getListOfTables()
 *  736:     function generateUpdateDatabaseForm_checkboxes($arr,$label,$checked=1,$iconDis=0,$currentValue=array(),$cVfullMsg=0)
 *
 * TOTAL FUNCTIONS: 17
 * (This index is automatically created/updated by the extension "extdeveval")
 *
 */









/**
 * Class to setup values in localconf.php and verify the TYPO3 DB tables/fields
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage t3lib
 */
class t3lib_install {


        // External, Static
    var $updateIdentity = '';                   // Set to string which identifies the script using this class.
    var $deletedPrefixKey = 'zzz_deleted_';     // Prefix used for tables/fields when deleted/renamed.
    var $dbUpdateCheckboxPrefix = 'TYPO3_INSTALL[database_update]'; // Prefix for checkbox fields when updating database.
    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.
    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
    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.
    var $backPath = '../';              // Backpath (used for icons etc.)

    var $multiplySize = 1;              // Multiplier of SQL field size (for char, varchar and text fields)
    var $character_sets = array();          // Caching output of $GLOBALS['TYPO3_DB']->admin_get_charsets()

        // Internal, dynamic:
    var $setLocalconf = 0;              // Used to indicate that a value is change in the line-array of localconf and that it should be written.
    var $messages = array();            // Used to set (error)messages from the executing functions like mail-sending, writing Localconf and such
    var $touchedLine = 0;               // updated with line in localconf.php file that was changed.


    /**
     * Constructor function
     *
     * @return  void
     */
    function t3lib_install()    {
        if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['multiplyDBfieldSize']>= 1 && $GLOBALS['TYPO3_CONF_VARS']['SYS']['multiplyDBfieldSize']<=5)  {
            $this->multiplySize = (double)$GLOBALS['TYPO3_CONF_VARS']['SYS']['multiplyDBfieldSize'];
        }
    }



    /**************************************
     *
     * Writing to localconf.php
     *

     **************************************/

    /**
     * This functions takes an array with lines from localconf.php, finds a variable and inserts the new value.
     *
     * @param   array       $line_array the localconf.php file exploded into an array by linebreaks. (see writeToLocalconf_control())
     * @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.
     * @param   string      $value      Is the value to be insert for the variable
     * @param   boolean     $quoteValue Whether the given value should be quoted before being written
     * @return  void
     * @see writeToLocalconf_control()
     */
    public function setValueInLocalconfFile(&$line_array, $variable, $value, $quoteValue = TRUE) {
        if (!$this->checkForBadString($value))  return 0;

            // Initialize:
        $found = 0;
        $this->touchedLine = '';
        $commentKey = '## ';
        $inArray = in_array($commentKey.$this->localconf_editPointToken,$line_array);
        $tokenSet = ($this->localconf_editPointToken && !$inArray);     // Flag is set if the token should be set but is not yet...
        $stopAtToken = ($this->localconf_editPointToken && $inArray);
        $comment = ' Modified or inserted by '.$this->updateIdentity.'.';
        $replace = array('["', '"]');
        $search = array('[\'', '\']');
        $varDoubleQuotes = str_replace($search, $replace, $variable);

            // Search for variable name:
        if (!$this->localconf_addLinesOnly && !$tokenSet)   {
            $line_array = array_reverse($line_array);
            foreach($line_array as $k => $v)    {
                $v2 = trim($v);
                if ($stopAtToken && !strcmp($v2,$commentKey.$this->localconf_editPointToken))   break;      // If stopAtToken and token found, break out of the loop..
                if (!strcmp(substr($v2,0,strlen($variable.' ')),$variable.' ')) {
                    $mainparts = explode($variable,$v,2);
                    if (count($mainparts)==2)   {   // should ALWAYS be....
                        $subparts = explode('//',$mainparts[1],2);
                        if ($quoteValue) {
                            $value = '\'' . $this->slashValueForSingleDashes($value) . '\'';
                        }
                        $line_array[$k] = $mainparts[0] . $variable . " = " . $value . ";   " . ('//' . $comment . str_replace($comment, '', $subparts[1]));
                        $this->touchedLine = count($line_array)-$k-1;
                        $found = 1;
                        break;
                    }
                } elseif (!strcmp(substr($v2, 0, strlen($varDoubleQuotes . ' ')), $varDoubleQuotes . ' ')) {
                        // Due to a bug in the update wizard (fixed in TYPO3 4.1.7) it is possible
                        // that $TYPO3_CONF_VARS['SYS']['compat_version'] was enclosed by "" (double
                        // quotes) instead of the expected '' (single quotes) when is was written to
                        // localconf.php. The following code was added to make sure that values with
                        // double quotes are updated, too.
                    $mainparts = explode($varDoubleQuotes, $v, 2);
                    if (count($mainparts) == 2) { // should ALWAYS be....
                        $subparts = explode('//', $mainparts[1], 2);
                        if ($quoteValue) {
                            $value = '\'' . $this->slashValueForSingleDashes($value) . '\'';
                        }
                        $line_array[$k] = $mainparts[0] . $variable . " = " . $value . ";   " . ('//' . $comment . str_replace($comment, '', $subparts[1]));
                        $this->touchedLine = count($line_array) - $k - 1;
                        $found = 1;
                        break;
                    }
                }
            }
            $line_array = array_reverse($line_array);
        }
        if (!$found)    {
            if ($tokenSet)      {
                $line_array[] = $commentKey.$this->localconf_editPointToken;
                $line_array[] = '';
            }
            if ($quoteValue) {
                $value = '\'' . $this->slashValueForSingleDashes($value) . '\'';
            }
            $line_array[] = $variable . " = " . $value . "; // " . $comment;
            $this->touchedLine = -1;
        }
        if ($variable == '$typo_db_password') {
            $this->messages[] = 'Updated ' . $variable;
        } else {
            $this->messages[] = $variable . " = " . htmlspecialchars($value);
        }
        $this->setLocalconf = 1;
    }

    /**
     * Writes or returns lines from localconf.php
     *
     * @param   array       Array of lines to write back to localconf.php. Possibly
     * @param   string      Absolute path of alternative file to use (Notice: this path is not validated in terms of being inside 'TYPO3 space')
     * @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)
     * @see setValueInLocalconfFile()
     */
    function writeToLocalconf_control($inlines='',$absFullPath='')  {
        $tmpExt = '.TMP.php';
        $writeToLocalconf_dat = array();
        $writeToLocalconf_dat['file'] = $absFullPath ? $absFullPath : PATH_typo3conf.'localconf.php';
        $writeToLocalconf_dat['tmpfile'] = $writeToLocalconf_dat['file'].$tmpExt;

            // Checking write state of localconf.php:
        if (!$this->allowUpdateLocalConf) {
            throw new RuntimeException(
                'TYPO3 Fatal Error: ->allowUpdateLocalConf flag in the install object is not set and therefore "localconf.php" cannot be altered.',
                1270853915
            );
        }
        if (!@is_writable($writeToLocalconf_dat['file']))   {
            throw new RuntimeException(
                'TYPO3 Fatal Error: ' . $writeToLocalconf_dat['file'] . ' is not writable!',
                1270853916
            );
        }

                // Splitting localconf.php file into lines:
        $lines = explode(LF,str_replace(CR,'',trim(t3lib_div::getUrl($writeToLocalconf_dat['file']))));
        $writeToLocalconf_dat['endLine'] = array_pop($lines);   // Getting "? >" ending.

            // Checking if "updated" line was set by this tool - if so remove old line.
        $updatedLine = array_pop($lines);
        $writeToLocalconf_dat['updatedText'] = '// Updated by '.$this->updateIdentity.' ';

        if (!strstr($updatedLine, $writeToLocalconf_dat['updatedText']))    {
            array_push($lines,$updatedLine);
        }

        if (is_array($inlines)) {   // Setting a line and write:
                // Setting configuration
            $updatedLine = $writeToLocalconf_dat['updatedText'].date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'].' H:i:s');
            array_push($inlines,$updatedLine);
            array_push($inlines,$writeToLocalconf_dat['endLine']);

            if ($this->setLocalconf)    {
                $success = FALSE;
                if (!t3lib_div::writeFile($writeToLocalconf_dat['tmpfile'],implode(LF,$inlines)))   {
                    $msg = 'typo3conf/localconf.php'.$tmpExt.' could not be written - maybe a write access problem?';
                }
                elseif (strcmp(t3lib_div::getUrl($writeToLocalconf_dat['tmpfile']), implode(LF,$inlines)))  {
                    @unlink($writeToLocalconf_dat['tmpfile']);
                    $msg = 'typo3conf/localconf.php'.$tmpExt.' was NOT written properly (written content didn\'t match file content) - maybe a disk space problem?';
                }
                elseif (!@copy($writeToLocalconf_dat['tmpfile'],$writeToLocalconf_dat['file'])) {
                    $msg = 'typo3conf/localconf.php could not be replaced by typo3conf/localconf.php'.$tmpExt.' - maybe a write access problem?';
                }
                else {
                    @unlink($writeToLocalconf_dat['tmpfile']);
                    $success = TRUE;
                    $msg = 'Configuration written to typo3conf/localconf.php';
                }
                $this->messages[] = $msg;

                if ($success)   {
                    return 'continue';
                } else {
                    t3lib_div::sysLog($msg, 'Core', 3);
                    return 'nochange';
                }
            } else {
                return 'nochange';
            }
        } else {    // Return lines found in localconf.php
            return $lines;
        }
    }

    /**
     * Checking for linebreaks in the string
     *
     * @param   string      String to test
     * @return  boolean     Returns TRUE if string is OK
     * @see setValueInLocalconfFile()
     */
    function checkForBadString($string) {
        return preg_match('/['.LF.CR.']/',$string) ? FALSE : TRUE;
    }

    /**
     * Replaces ' with \' and \ with \\
     *
     * @param   string      Input value
     * @return  string      Output value
     * @see setValueInLocalconfFile()
     */
    function slashValueForSingleDashes($value)  {
        $value = str_replace("'.LF.'", '###INSTALL_TOOL_LINEBREAK###', $value);
        $value = str_replace("'","\'",str_replace('\\','\\\\',$value));
        $value = str_replace('###INSTALL_TOOL_LINEBREAK###', "'.LF.'", $value);

        return $value;
    }










    /*************************************
     *
     * SQL
     *
     *************************************/

    /**
     * Reads the field definitions for the input SQL-file string
     *
     * @param   string      Should be a string read from an SQL-file made with 'mysqldump [database_name] -d'
     * @return  array       Array with information about table.
     */
    function getFieldDefinitions_fileContent($fileContent)  {
        $lines = t3lib_div::trimExplode(LF, $fileContent, 1);
        $table = '';
        $total = array();

        foreach ($lines as $value) {
            if (substr($value,0,1)=='#') {
                continue;   // Ignore comments
            }

            if (!strlen($table)) {
                $parts = t3lib_div::trimExplode(' ', $value, TRUE);
                if (strtoupper($parts[0]) === 'CREATE' && strtoupper($parts[1]) === 'TABLE') {
                    $table = str_replace( '`', '', $parts[2]);
                    if (TYPO3_OS=='WIN') {  // tablenames are always lowercase on windows!
                        $table = strtolower($table);
                    }
                }
            } else {
                if (substr($value,0,1)==')' && substr($value,-1)==';')  {
                    $ttype = array();
                    if (preg_match('/(ENGINE|TYPE)[ ]*=[ ]*([a-zA-Z]*)/',$value,$ttype)) {
                        $total[$table]['extra']['ENGINE'] = $ttype[2];
                    } // Otherwise, just do nothing: If table engine is not defined, just accept the system default.

                        // Set the collation, if specified
                    if (preg_match('/(COLLATE)[ ]*=[ ]*([a-zA-z0-9_-]+)/', $value, $tcollation)) {
                        $total[$table]['extra']['COLLATE'] = $tcollation[2];
                    } else {
                            // 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)
                        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
                            $charset = $tcharset[2];
                        } else {
                            $charset = $GLOBALS['TYPO3_DB']->default_charset;   // Fallback to default charset
                        }
                        $total[$table]['extra']['COLLATE'] = $this->getCollationForCharset($charset);
                    }

                    $table = '';    // Remove table marker and start looking for the next "CREATE TABLE" statement
                } else {
                    $lineV = preg_replace('/,$/','',$value);    // Strip trailing commas
                    $lineV = str_replace('`', '', $lineV);
                    $lineV = str_replace('  ', ' ', $lineV);    // Remove double blanks

                    $parts = explode(' ', $lineV, 2);
                    if (!preg_match('/(PRIMARY|UNIQUE|FULLTEXT|INDEX|KEY)/',$parts[0])) {   // Field definition

                            // Make sure there is no default value when auto_increment is set
                        if (stristr($parts[1],'auto_increment')) {
                            $parts[1] = preg_replace('/ default \'0\'/i','',$parts[1]);
                        }
                            // "default" is always lower-case
                        if (stristr($parts[1], ' DEFAULT '))    {
                            $parts[1] = str_ireplace(' DEFAULT ', ' default ', $parts[1]);
                        }

                            // Change order of "default" and "null" statements
                        $parts[1] = preg_replace('/(.*) (default .*) (NOT NULL)/', '$1 $3 $2', $parts[1]);
                        $parts[1] = preg_replace('/(.*) (default .*) (NULL)/', '$1 $3 $2', $parts[1]);

                        $key = $parts[0];
                        $total[$table]['fields'][$key] = $parts[1];

                    } else {    // Key definition
                        $search = array('/UNIQUE (INDEX|KEY)/', '/FULLTEXT (INDEX|KEY)/', '/INDEX/');
                        $replace = array('UNIQUE', 'FULLTEXT', 'KEY');
                        $lineV = preg_replace($search, $replace, $lineV);

                        if (preg_match('/PRIMARY|UNIQUE|FULLTEXT/', $parts[0])) {
                            $parts[1] = preg_replace('/^(KEY|INDEX) /', '', $parts[1]);
                        }

                        $newParts = explode(' ',$parts[1],2);
                        $key = $parts[0]=='PRIMARY' ? $parts[0] : $newParts[0];

                        $total[$table]['keys'][$key] = $lineV;

                            // This is a protection against doing something stupid: Only allow clearing of cache_* and index_* tables.
                        if (preg_match('/^(cache|index)_/',$table)) {
                                // Suggest to truncate (clear) this table
                            $total[$table]['extra']['CLEAR'] = 1;
                        }
                    }
                }
            }
        }

        $this->getFieldDefinitions_sqlContent_parseTypes($total);
        return $total;
    }

    /**
     * Multiplies varchars/tinytext fields in size according to $this->multiplySize
     * 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.
     *
     * @param   array       Total array (from getFieldDefinitions_fileContent())
     * @return  void
     * @access private
     * @see getFieldDefinitions_fileContent()
     */
    function getFieldDefinitions_sqlContent_parseTypes(&$total) {

        $mSize = (double)$this->multiplySize;
        if ($mSize > 1) {

                // Init SQL parser:
            $sqlParser = t3lib_div::makeInstance('t3lib_sqlparser');
            foreach($total as $table => $cfg)   {
                if (is_array($cfg['fields'])) {
                    foreach($cfg['fields'] as $fN => $fType)    {
                        $orig_fType = $fType;
                        $fInfo = $sqlParser->parseFieldDef($fType);

                        switch($fInfo['fieldType']) {
                            case 'char':
                            case 'varchar':
                                $newSize = round($fInfo['value']*$mSize);

                                if ($newSize <= 255)    {
                                    $fInfo['value'] = $newSize;
                                } else {
                                    $fInfo = array(
                                        'fieldType' => 'text',
                                        'featureIndex' => array(
                                            'NOTNULL' => array(
                                                'keyword' => 'NOT NULL'
                                            )
                                        )
                                    );
                                        // Change key definition if necessary (must use "prefix" on TEXT columns)
                                    if (is_array($cfg['keys'])) {
                                        foreach ($cfg['keys'] as $kN => $kType) {
                                            $match = array();
                                            preg_match('/^([^(]*)\(([^)]+)\)(.*)/', $kType, $match);
                                            $keys = array();
                                            foreach (t3lib_div::trimExplode(',',$match[2]) as $kfN) {
                                                if ($fN == $kfN)    {
                                                    $kfN .= '('.$newSize.')';
                                                }
                                                $keys[] = $kfN;
                                            }
                                            $total[$table]['keys'][$kN] = $match[1].'('.implode(',',$keys).')'.$match[3];
                                        }
                                    }
                                }
                            break;
                            case 'tinytext':
                                $fInfo['fieldType'] = 'text';
                            break;
                        }

                        $total[$table]['fields'][$fN] = $sqlParser->compileFieldCfg($fInfo);
                        if ($sqlParser->parse_error) {
                            throw new RuntimeException(
                                'TYPO3 Fatal Error: ' . $sqlParser->parse_error,
                                1270853961
                            );
                        }
                    }
                }
            }
        }
    }

    /**
     * Look up the default collation for specified character set based on "SHOW CHARACTER SET" output
     *
     * @param   string      Character set
     * @return  string      Corresponding default collation
     */
    function getCollationForCharset($charset)   {
            // Load character sets, if not cached already
        if (!count($this->character_sets)) {
            if (method_exists($GLOBALS['TYPO3_DB'],'admin_get_charsets')) {
                $this->character_sets = $GLOBALS['TYPO3_DB']->admin_get_charsets();
            } else {
                $this->character_sets[$charset] = array();  // Add empty element to avoid that the check will be repeated
            }
        }

        $collation = '';
        if (isset($this->character_sets[$charset]['Default collation'])) {
            $collation = $this->character_sets[$charset]['Default collation'];
        }

        return $collation;
    }

    /**
     * Reads the field definitions for the current database
     *
     * @return  array       Array with information about table.
     */
    function getFieldDefinitions_database() {
        $total = array();
        $tempKeys = array();
        $tempKeysPrefix = array();

        $GLOBALS['TYPO3_DB']->sql_select_db(TYPO3_db);
        echo $GLOBALS['TYPO3_DB']->sql_error();

        $tables = $GLOBALS['TYPO3_DB']->admin_get_tables(TYPO3_db);
        foreach ($tables as $tableName => $tableStatus) {

                // Fields:
            $fieldInformation = $GLOBALS['TYPO3_DB']->admin_get_fields($tableName);
            foreach ($fieldInformation as $fN => $fieldRow) {
                $total[$tableName]['fields'][$fN] = $this->assembleFieldDefinition($fieldRow);
            }

                // Keys:
            $keyInformation = $GLOBALS['TYPO3_DB']->admin_get_keys($tableName);

            foreach ($keyInformation as $keyRow) {
                $keyName = $keyRow['Key_name'];
                $colName = $keyRow['Column_name'];
                if ($keyRow['Sub_part']) {
                    $colName.= '('.$keyRow['Sub_part'].')';
                }
                $tempKeys[$tableName][$keyName][$keyRow['Seq_in_index']] = $colName;
                if ($keyName=='PRIMARY') {
                    $prefix = 'PRIMARY KEY';
                } else {
                    if ($keyRow['Index_type']=='FULLTEXT') {
                        $prefix = 'FULLTEXT';
                    } elseif ($keyRow['Non_unique']) {
                        $prefix = 'KEY';
                    } else {
                        $prefix = 'UNIQUE';
                    }
                    $prefix.= ' '.$keyName;
                }
                $tempKeysPrefix[$tableName][$keyName] = $prefix;
            }

                // Table status (storage engine, collaction, etc.)
            if (is_array($tableStatus)) {
                $tableExtraFields = array(
                    'Engine' => 'ENGINE',
                    'Collation' => 'COLLATE',
                );

                foreach ($tableExtraFields as $mysqlKey=>$internalKey) {
                    if (isset($tableStatus[$mysqlKey])) {
                        $total[$tableName]['extra'][$internalKey] = $tableStatus[$mysqlKey];
                    }
                }
            }
        }

            // Compile key information:
        if (count($tempKeys)) {
            foreach ($tempKeys as $table => $keyInf) {
                foreach ($keyInf as $kName => $index) {
                    ksort($index);
                    $total[$table]['keys'][$kName] = $tempKeysPrefix[$table][$kName].' ('.implode(',',$index).')';
                }
            }
        }

        return $total;
    }

    /**
     * Compares two arrays with field information and returns information about fields that are MISSING and fields that have CHANGED.
     * FDsrc and FDcomp can be switched if you want the list of stuff to remove rather than update.
     *
     * @param   array       Field definitions, source (from getFieldDefinitions_fileContent())
     * @param   array       Field definitions, comparison. (from getFieldDefinitions_database())
     * @param   string      Table names (in list) which is the ONLY one observed.
     * @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.
     * @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
     */
    function getDatabaseExtra($FDsrc, $FDcomp, $onlyTableList='',$ignoreNotNullWhenComparing=true)  {
        $extraArr = array();
        $diffArr = array();

        if (is_array($FDsrc)) {
            foreach ($FDsrc as $table => $info) {
                if (!strlen($onlyTableList) || t3lib_div::inList($onlyTableList, $table)) {
                    if (!isset($FDcomp[$table])) {
                        $extraArr[$table] = $info;      // If the table was not in the FDcomp-array, the result array is loaded with that table.
                        $extraArr[$table]['whole_table']=1;
                    } else {
                        $keyTypes = explode(',','extra,fields,keys');
                        foreach ($keyTypes as $theKey) {
                            if (is_array($info[$theKey])) {
                                foreach ($info[$theKey] as $fieldN => $fieldC) {
                                    $fieldN = str_replace('`','',$fieldN);
                                    if ($fieldN=='COLLATE') {
                                        continue;   // TODO: collation support is currently disabled (needs more testing)
                                    }

                                    if (!isset($FDcomp[$table][$theKey][$fieldN])) {
                                        $extraArr[$table][$theKey][$fieldN] = $fieldC;
                                    } else {
                                        $fieldC = trim($fieldC);
                                        if ($ignoreNotNullWhenComparing) {
                                            $fieldC = str_replace(' NOT NULL', '', $fieldC);
                                            $FDcomp[$table][$theKey][$fieldN] = str_replace(' NOT NULL', '', $FDcomp[$table][$theKey][$fieldN]);
                                        }
                                        if ($fieldC !== $FDcomp[$table][$theKey][$fieldN]) {
                                            $diffArr[$table][$theKey][$fieldN] = $fieldC;
                                            $diffArr_cur[$table][$theKey][$fieldN] = $FDcomp[$table][$theKey][$fieldN];
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }

        $output = array(
            'extra' => $extraArr,
            'diff' => $diffArr,
            'diff_currentValues' => $diffArr_cur
        );

        return $output;
    }

    /**
     * Returns an array with SQL-statements that is needed to update according to the diff-array
     *
     * @param   array       Array with differences of current and needed DB settings. (from getDatabaseExtra())
     * @param   string      List of fields in diff array to take notice of.
     * @return  array       Array of SQL statements (organized in keys depending on type)
     */
    function getUpdateSuggestions($diffArr,$keyList='extra,diff')   {
        $statements = array();
        $deletedPrefixKey = $this->deletedPrefixKey;
        $remove = 0;
        if ($keyList == 'remove')   {
            $remove = 1;
            $keyList = 'extra';
        }
        $keyList = explode(',',$keyList);
        foreach ($keyList as $theKey) {
            if (is_array($diffArr[$theKey])) {
                foreach ($diffArr[$theKey] as $table => $info) {
                    $whole_table = array();
                    if (is_array($info['fields'])) {
                        foreach ($info['fields'] as $fN => $fV) {
                            if ($info['whole_table']) {
                                $whole_table[]=$fN.' '.$fV;
                            } else {
                                    // Special case to work around MySQL problems when adding auto_increment fields:
                                if (stristr($fV, 'auto_increment')) {
                                        // The field can only be set "auto_increment" if there exists a PRIMARY key of that field already.
                                        // The check does not look up which field is primary but just assumes it must be the field with the auto_increment value...
                                    if (isset($diffArr['extra'][$table]['keys']['PRIMARY'])) {
                                            // Remove "auto_increment" from the statement - it will be suggested in a 2nd step after the primary key was created
                                        $fV = str_replace(' auto_increment', '', $fV);
                                    } else {
                                            // In the next step, attempt to clear the table once again (2 = force)
                                        $info['extra']['CLEAR'] = 2;
                                    }
                                }
                                if ($theKey=='extra') {
                                    if ($remove) {
                                        if (substr($fN,0,strlen($deletedPrefixKey))!=$deletedPrefixKey) {
                                            $statement = 'ALTER TABLE '.$table.' CHANGE '.$fN.' '.$deletedPrefixKey.$fN.' '.$fV.';';
                                            $statements['change'][md5($statement)] = $statement;
                                        } else {
                                            $statement = 'ALTER TABLE '.$table.' DROP '.$fN.';';
                                            $statements['drop'][md5($statement)] = $statement;
                                        }
                                    } else {
                                        $statement = 'ALTER TABLE '.$table.' ADD '.$fN.' '.$fV.';';
                                        $statements['add'][md5($statement)] = $statement;
                                    }
                                } elseif ($theKey=='diff') {
                                    $statement = 'ALTER TABLE '.$table.' CHANGE '.$fN.' '.$fN.' '.$fV.';';
                                    $statements['change'][md5($statement)] = $statement;
                                    $statements['change_currentValue'][md5($statement)] = $diffArr['diff_currentValues'][$table]['fields'][$fN];
                                }
                            }
                        }
                    }
                    if (is_array($info['keys'])) {
                        foreach ($info['keys'] as $fN => $fV) {
                            if ($info['whole_table']) {
                                $whole_table[] = $fV;
                            } else {
                                if ($theKey=='extra') {
                                    if ($remove) {
                                        $statement = 'ALTER TABLE '.$table.($fN=='PRIMARY' ? ' DROP PRIMARY KEY' : ' DROP KEY '.$fN).';';
                                        $statements['drop'][md5($statement)] = $statement;
                                    } else {
                                        $statement = 'ALTER TABLE '.$table.' ADD '.$fV.';';
                                        $statements['add'][md5($statement)] = $statement;
                                    }
                                } elseif ($theKey=='diff') {
                                    $statement = 'ALTER TABLE '.$table.($fN=='PRIMARY' ? ' DROP PRIMARY KEY' : ' DROP KEY '.$fN).';';
                                    $statements['change'][md5($statement)] = $statement;
                                    $statement = 'ALTER TABLE '.$table.' ADD '.$fV.';';
                                    $statements['change'][md5($statement)] = $statement;
                                }
                            }
                        }
                    }
                    if (is_array($info['extra'])) {
                        $extras = array();
                        $extras_currentValue = array();
                        $clear_table = false;

                        foreach ($info['extra'] as $fN => $fV) {

                                // Only consider statements which are missing in the database but don't remove existing properties
                            if (!$remove) {
                                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']
                                    if ($fN=='CLEAR') {
                                            // Truncate table must happen later, not now
                                            // Valid values for CLEAR: 1=only clear if keys are missing, 2=clear anyway (force)
                                        if (count($info['keys']) || $fV==2) {
                                            $clear_table = true;
                                        }
                                        continue;
                                    } else {
                                        $extras[] = $fN.'='.$fV;
                                        $extras_currentValue[] = $fN.'='.$diffArr['diff_currentValues'][$table]['extra'][$fN];
                                    }
                                }
                            }
                        }
                        if ($clear_table) {
                            $statement = 'TRUNCATE TABLE '.$table.';';
                            $statements['clear_table'][md5($statement)] = $statement;
                        }
                        if (count($extras)) {
                            $statement = 'ALTER TABLE '.$table.' '.implode(' ',$extras).';';
                            $statements['change'][md5($statement)] = $statement;
                            $statements['change_currentValue'][md5($statement)] = implode(' ',$extras_currentValue);
                        }
                    }
                    if ($info['whole_table']) {
                        if ($remove) {
                            if (substr($table,0,strlen($deletedPrefixKey))!=$deletedPrefixKey) {
                                $statement = 'ALTER TABLE '.$table.' RENAME '.$deletedPrefixKey.$table.';';
                                $statements['change_table'][md5($statement)] = $statement;
                            } else {
                                $statement = 'DROP TABLE '.$table.';';
                                $statements['drop_table'][md5($statement)] = $statement;
                            }
                                // count:
                            $count = $GLOBALS['TYPO3_DB']->exec_SELECTcountRows('*', $table);
                            $statements['tables_count'][md5($statement)] = $count?'Records in table: '.$count:'';
                        } else {
                            $statement = 'CREATE TABLE '.$table." (\n".implode(",\n",$whole_table)."\n)";
                            if ($info['extra']) {
                                foreach ($info['extra'] as $k=>$v) {
                                    if ($k=='COLLATE' || $k=='CLEAR') {
                                        continue;   // Skip these special statements. TODO: collation support is currently disabled (needs more testing)
                                    }
                                    $statement.= ' '.$k.'='.$v; // Add extra attributes like ENGINE, CHARSET, etc.
                                }
                            }
                            $statement.= ';';
                            $statements['create_table'][md5($statement)] = $statement;
                        }
                    }
                }
            }
        }

        return $statements;
    }

    /**
     * Converts a result row with field information into the SQL field definition string
     *
     * @param   array       MySQL result row
     * @return  string      Field definition
     */
    function assembleFieldDefinition($row)  {
        $field = array($row['Type']);

        if ($row['Null']=='NO') {
            $field[] = 'NOT NULL';
        }
        if (!strstr($row['Type'],'blob') && !strstr($row['Type'],'text')) {
                // Add a default value if the field is not auto-incremented (these fields never have a default definition)
            if (!stristr($row['Extra'],'auto_increment')) {
                $field[] = 'default \''.addslashes($row['Default']).'\'';
            }
        }
        if ($row['Extra']) {
            $field[] = $row['Extra'];
        }

        return implode(' ',$field);
    }

    /**
     * Returns an array where every entry is a single SQL-statement. Input must be formatted like an ordinary MySQL-dump files.
     *
     * @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.
     * @param   boolean     If set, non-SQL content (like comments and blank lines) is not included in the final output
     * @param   string      Regex to filter SQL lines to include
     * @return  array       Array of SQL statements
     */
    function getStatementArray($sqlcode,$removeNonSQL=0,$query_regex='')    {
        $sqlcodeArr = explode(LF, $sqlcode);

            // Based on the assumption that the sql-dump has
        $statementArray = array();
        $statementArrayPointer = 0;

        foreach ($sqlcodeArr as $line => $lineContent) {
            $is_set = 0;

                // auto_increment fields cannot have a default value!
            if (stristr($lineContent,'auto_increment')) {
                $lineContent = preg_replace('/ default \'0\'/i', '', $lineContent);
            }

            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
                $statementArray[$statementArrayPointer].= $lineContent;
                $is_set = 1;
            }
            if (substr(trim($lineContent),-1)==';') {
                if (isset($statementArray[$statementArrayPointer])) {
                    if (!trim($statementArray[$statementArrayPointer]) || ($query_regex && !preg_match('/'.$query_regex.'/i',trim($statementArray[$statementArrayPointer])))) {
                        unset($statementArray[$statementArrayPointer]);
                    }
                }
                $statementArrayPointer++;

            } elseif ($is_set) {
                $statementArray[$statementArrayPointer].= LF;
            }
        }

        return $statementArray;
    }

    /**
     * Returns tables to create and how many records in each
     *
     * @param   array       Array of SQL statements to analyse.
     * @param   boolean     If set, will count number of INSERT INTO statements following that table definition
     * @return  array       Array with table definitions in index 0 and count in index 1
     */
    function getCreateTables($statements, $insertCountFlag=0) {
        $crTables = array();
        $insertCount = array();
        foreach ($statements as $line => $lineContent) {
            $reg = array();
            if (preg_match('/^create[[:space:]]*table[[:space:]]*[`]?([[:alnum:]_]*)[`]?/i',substr($lineContent,0,100),$reg)) {
                $table = trim($reg[1]);
                if ($table) {
                        // table names are always lowercase on Windows!
                    if (TYPO3_OS == 'WIN') {
                        $table = strtolower($table);
                    }
                    $sqlLines = explode(LF, $lineContent);
                    foreach ($sqlLines as $k=>$v) {
                        if (stristr($v,'auto_increment')) {
                            $sqlLines[$k] = preg_replace('/ default \'0\'/i', '', $v);
                        }
                    }
                    $lineContent = implode(LF, $sqlLines);
                    $crTables[$table] = $lineContent;
                }
            } elseif ($insertCountFlag && preg_match('/^insert[[:space:]]*into[[:space:]]*[`]?([[:alnum:]_]*)[`]?/i',substr($lineContent,0,100),$reg)) {
                $nTable = trim($reg[1]);
                $insertCount[$nTable]++;
            }
        }

        return array($crTables,$insertCount);
    }

    /**
     * Extracts all insert statements from $statement array where content is inserted into $table
     *
     * @param   array       Array of SQL statements
     * @param   string      Table name
     * @return  array       Array of INSERT INTO statements where table match $table
     */
    function getTableInsertStatements($statements, $table)  {
        $outStatements=array();
        foreach($statements as $line => $lineContent) {
            $reg = array();
            if (preg_match('/^insert[[:space:]]*into[[:space:]]*[`]?([[:alnum:]_]*)[`]?/i',substr($lineContent,0,100),$reg)) {
                $nTable = trim($reg[1]);
                if ($nTable && !strcmp($table,$nTable)) {
                    $outStatements[] = $lineContent;
                }
            }
        }
        return $outStatements;
    }

    /**
     * Performs the queries passed from the input array.
     *
     * @param   array       Array of SQL queries to execute.
     * @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)
     * @return  mixed       Array with error message from database if any occured. Otherwise true if everything was executed successfully.
     */
    function performUpdateQueries($arr,$keyArr) {
        $result = array();
        if (is_array($arr)) {
            foreach($arr as $key => $string)    {
                if (isset($keyArr[$key]) && $keyArr[$key])  {
                    $res = $GLOBALS['TYPO3_DB']->admin_query($string);
                    if ($res === false) {
                        $result[$key] = $GLOBALS['TYPO3_DB']->sql_error();
                    } elseif (is_resource($res)) {
                        $GLOBALS['TYPO3_DB']->sql_free_result($res);
                    }
                }
            }
        }
        if (count($result) > 0) {
            return $result;
        } else {
            return true;
        }
    }

    /**
     * Returns list of tables in the database
     *
     * @return  array       List of tables.
     * @see t3lib_db::admin_get_tables()
     */
    function getListOfTables()  {
        $whichTables = $GLOBALS['TYPO3_DB']->admin_get_tables(TYPO3_db);
        foreach ($whichTables as $key=>&$value) {
            $value = $key;
        }
        return $whichTables;
    }

    /**
     * Creates a table which checkboxes for updating database.
     *
     * @param   array       Array of statements (key / value pairs where key is used for the checkboxes)
     * @param   string      Label for the table.
     * @param   boolean     If set, then checkboxes are set by default.
     * @param   boolean     If set, then icons are shown.
     * @param   array       Array of "current values" for each key/value pair in $arr. Shown if given.
     * @param   boolean     If set, will show the prefix "Current value" if $currentValue is given.
     * @return  string      HTML table with checkboxes for update. Must be wrapped in a form.
     */
    function generateUpdateDatabaseForm_checkboxes($arr,$label,$checked=1,$iconDis=0,$currentValue=array(),$cVfullMsg=0)    {
        $out = array();
        if (is_array($arr)) {
            $tableId = uniqid('table');
            if (count($arr) > 1) {
                $out[] = '
                    <tr class="update-db-fields-batch">
                        <td valign="top">
                            <input type="checkbox" id="' . $tableId . '-checkbox"' . ($checked ? ' checked="checked"' : '') . '
                             onclick="$(\'' . $tableId . '\').select(\'input[type=checkbox]\').invoke(\'setValue\', $(this).checked);" />
                        </td>
                        <td nowrap="nowrap"><label for="' . $tableId . '-checkbox" style="cursor:pointer"><strong>select/deselect all</strong></label></td>
                    </tr>';
            }
            foreach($arr as $key => $string)    {
                $ico = '';
                $warnings = array();

                if ($iconDis)   {
                    if (preg_match('/^TRUNCATE/i',$string)) {
                        $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong> </strong>';
                        $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.';
                    } elseif (stristr($string,' user_'))    {
                        $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(USER) </strong>';
                    } elseif (stristr($string,' app_')) {
                        $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(APP) </strong>';
                    } elseif (stristr($string,' ttx_') || stristr($string,' tx_'))  {
                        $ico.= '<img src="'.$this->backPath.'gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(EXT) </strong>';
                    }
                }
                $out[]='
                    <tr>
                        <td valign="top"><input type="checkbox" id="db-'.$key.'" name="'.$this->dbUpdateCheckboxPrefix.'['.$key.']" value="1"'.($checked?' checked="checked"':'').' /></td>
                        <td nowrap="nowrap"><label for="db-'.$key.'">'.nl2br($ico.htmlspecialchars($string)).'</label></td>
                    </tr>';
                if (isset($currentValue[$key])) {
                    $out[]='
                    <tr>
                        <td valign="top"></td>
                        <td nowrap="nowrap" style="color:#666666;">'.nl2br((!$cVfullMsg?"Current value: ":"").'<em>'.$currentValue[$key].'</em>').'</td>
                    </tr>';
                }
            }
            if (count($warnings)) {
                $out[] = '
                    <tr>
                        <td valign="top"></td>
                        <td style="color:#666666;"><em>' . implode('<br />',$warnings) . '</em></td>
                    </tr>';
            }

            // Compile rows:
            $content = '
                <!-- Update database fields / tables -->
                <h3>'.$label.'</h3>
                <table border="0" cellpadding="2" cellspacing="2" id="' . $tableId . '" class="update-db-fields">' . implode('', $out) . '
                </table>';
        }

        return $content;
    }

    /**
     * Reads the field definitions for the input SQL-file string
     *
     * @param   string      Should be a string read from an SQL-file made with 'mysqldump [database_name] -d'
     * @return  array       Array with information about table.
     * @deprecated  since TYPO3 4.2, this function will be removed in TYPO3 4.5, use ->getFieldDefinitions_fileContent() instead!
     */
    function getFieldDefinitions_sqlContent($fileContent)   {
        t3lib_div::logDeprecatedFunction();

        return $this->getFieldDefinitions_fileContent($fileContent);
    }
}

if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_install.php'])   {
    include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_install.php']);
}

?>

---