Documentation TYPO3 par Ameos

Disponible dans d'autres versions de TYPO3 -> 3.7.0  3.8.1  4.0.0  4.0.1  4.1.0   <- Available in other TYPO3 versions

class.t3lib_install.php

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2004 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!
***************************************************************/
require_once(PATH_t3lib.'class.t3lib_sqlparser.php');

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 $mysqlVersion = '3.22';                                     // 3.22 or 3.23. If set to 3.23, then the expected format of the incoming sql-dump files are changed. 'DEFAULT' and 'NOT NULL' are reversed in order and 'DEFAULT' is lowercase. Also auto_incremented fields are without default definitions.
        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)

                // 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.





        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
         *
         **************************************/

        function setValueInLocalconfFile(&$line_array, $variable, $value)       {
                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.'.';

                        // 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);
                                                $line_array[$k] = $mainparts[0].$variable." = '".$this->slashValueForSingleDashes($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[] = '';
                        }
                        $line_array[] = $variable." = '".$this->slashValueForSingleDashes($value)."';   // ".$comment;
                        $this->touchedLine = -1;
                }
                $this->messages[] = $variable." = '".htmlspecialchars($value)."'";
                $this->setLocalconf = 1;
        }

        function writeToLocalconf_control($inlines='')  {
                $writeToLocalconf_dat['file'] = PATH_typo3conf.'localconf.php';

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

                                // Splitting localconf.php file into lines:
                $lines = explode(chr(10),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('d-m-Y H:i:s');
                        array_push($inlines,$updatedLine);
                        array_push($inlines,$writeToLocalconf_dat['endLine']);

                        if ($this->setLocalconf)        {
                                t3lib_div::writeFile($writeToLocalconf_dat['file'],implode(chr(10),$inlines));

                                if (strcmp(t3lib_div::getUrl($writeToLocalconf_dat['file']), implode(chr(10),$inlines)))        {
                                        die('typo3temp/localconf.php was NOT updated properly (written content didn\'t match file content) - maybe write access problem?');
                                }

                                $this->messages[]= 'Configuration written to typo3conf/localconf.php';
                                return 'continue';
                        } else {
                                return 'nochange';
                        }
                } else {        // Return lines found in localconf.php
                        return $lines;
                }
        }

        function checkForBadString($string)     {
                if (ereg('['.chr(10).chr(13).']',$string)){
                        return FALSE;
                } else return TRUE;
        }

        function slashValueForSingleDashes($value)      {
                return str_replace("'","\'",str_replace('\\','\\\\',$value));
        }










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

        function getFieldDefinitions_sqlContent($sqlContent)    {
                $lines = t3lib_div::trimExplode(chr(10), $sqlContent,1);
                $isTable = '';

                foreach($lines as $value)       {
                        if ($value[0]!='#')     {
                                if (!$isTable)  {
                                        $parts = explode(' ',$value);
                                        if ($parts[0]=='CREATE' && $parts[1]=='TABLE')  {
                                                $isTable = $parts[2];
                                                if (TYPO3_OS=='WIN') {  // tablenames are always lowercase on windows!
                                                        $isTable = strtolower($isTable);
                                                }
                                        }
                                } else {
                                        if (substr($value,0,1)==')' && substr($value,-1)==';')  {
                                                $isTable = '';
                                        } else {
                                                $lineV = ereg_replace(',$','',$value);
                                                $parts = explode(' ',$lineV,2);
                                                if ($parts[0]!='PRIMARY' && $parts[0]!='KEY' && $parts[0]!='UNIQUE')    {
                                                        $total[$isTable]['fields'][$parts[0]] = $parts[1];
                                                } else {
                                                        $newParts = explode(' ',$parts[1],2);
                                                        $total[$isTable]['keys'][($parts[0]=='PRIMARY'?$parts[0]:$newParts[0])] = $lineV;
                                                }
                                        }
                                }
                        }
                }

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

        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)       {
                                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'
                                                                                )
                                                                        )
                                                                );
                                                        }
                                                break;
                                                case 'tinytext':
                                                        $fInfo['fieldType'] = 'text';
                                                break;
                                        }

                                        $total[$table]['fields'][$fN] = $sqlParser->compileFieldCfg($fInfo);
                                        if ($sqlParser->parse_error)    die($sqlParser->parse_error);
                                }
                        }
                }
        }

        function getFieldDefinitions_database() {
                $total = 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)  {

                                // 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 $kN => $keyRow)      {
                                $tempKeys[$tableName][$keyRow['Key_name']][$keyRow['Seq_in_index']] = $keyRow['Column_name'];
                                $tempKeysPrefix[$tableName][$keyRow['Key_name']]= ($keyRow['Key_name']=='PRIMARY'?'PRIMARY KEY':($keyRow['Non_unique']?'KEY':'UNIQUE').' '.$keyRow['Key_name']);
                        }
                }

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

                return $total;
        }

        function getDatabaseExtra($FDsrc, $FDcomp, $onlyTableList='')   {
                $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(',','fields,keys');
                                                foreach($keyTypes as $theKey)   {
                                                        if (is_array($info[$theKey]))   {
                                                                foreach($info[$theKey] as $fieldN => $fieldC) {
                                                                        if (!isset($FDcomp[$table][$theKey][$fieldN]))  {
                                                                                $extraArr[$table][$theKey][$fieldN] = $fieldC;
                                                                        } elseif (strcmp($FDcomp[$table][$theKey][$fieldN], $fieldC)){
                                                                                $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;
        }

        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 {
                                                                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'])       {
                                                                if ($fN=='PRIMARY')     {
                                                                        $whole_table[] = $fV;
                                                                } else {
                                                                        $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 ($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:
                                                        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('count(*)', $table, '');
                                                        list($count) = $GLOBALS['TYPO3_DB']->sql_fetch_row($res);
                                                        $statements['tables_count'][md5($statement)] = $count?'Records in table: '.$count:'';
                                                } else {
                                                        $statement = 'CREATE TABLE '.$table." (\n".implode(",\n",$whole_table)."\n) TYPE=MyISAM;";
                                                        $statements['create_table'][md5($statement)]=$statement;
                                                }
                                        }
                                }
                        }
                }

                return $statements;
        }

        function assembleFieldDefinition($row)  {
                $field[] = $row['Type'];
                if ($this->mysqlVersion=='3.23' && !$row['Null'])       {
                        $field[] = 'NOT NULL';
                }
                if (!strstr($row['Type'],'blob') && !strstr($row['Type'],'text'))       {
                        // This code will return a default value if the sql-file version is not 3.23 and the field is not auto-incremented. In 3.23 files, the auto-incremented fields do not have a default definition.
                        // Furthermore if the file is 3.22 the default value of auto-incremented fields are expected to always be zero which is why the default value is passed through intval(). Thus it should work on 3.23 MySQL servers.
                        if ($this->mysqlVersion!='3.23' || !stristr($row['Extra'],'auto_increment'))    {
                                $field[] = ($this->mysqlVersion=='3.23'?'default':'DEFAULT')." '".(stristr($row['Extra'],'auto_increment')?intval($row['Default']):addslashes($row['Default']))."'";
                        }
                }
                if ($this->mysqlVersion!='3.23' && !$row['Null'])       {
                        $field[] = 'NOT NULL';
                }
                if ($row['Extra'])      {
                        $field[] = $row['Extra'];
                }
                return implode(' ',$field);
        }

        function getStatementArray($sqlcode,$removeNonSQL=0,$query_regex='')    {
                $sqlcodeArr = explode(chr(10),$sqlcode);

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

                foreach($sqlcodeArr as $line => $linecontent)   {

                                // Setting MySQL Version if necessary.
                        if (substr(trim($linecontent),0,16)=='# Server version')        {
                                $this->mysqlVersion = doubleval(substr(trim($linecontent),16));
                        }
                        $is_set = 0;

                        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 && !eregi($query_regex,trim($statementArray[$statementArrayPointer]))))     {
                                                unset($statementArray[$statementArrayPointer]);
                                        }
                                }
                                $statementArrayPointer++;
                        } elseif ($is_set) {
                                $statementArray[$statementArrayPointer].=chr(10);
                        }
                }
                return $statementArray;
        }

        function getCreateTables($statements, $insertCountFlag=0)       {
                $crTables = array();
                foreach($statements as $line => $linecontent)   {
                        if (eregi('^create[[:space:]]*table[[:space:]]*([[:alnum:]_]*)',substr($linecontent,0,100),$reg))       {
                                $table = trim($reg[1]);
                                if ($table)     {
                                        if (TYPO3_OS=='WIN')    {$table=strtolower($table);}    // tablenames are always lowercase on windows!
                                        $crTables[$table] = $linecontent;
                                }
                        } elseif ($insertCountFlag && eregi('^insert[[:space:]]*into[[:space:]]*([[:alnum:]_]*)',substr($linecontent,0,100),$reg))      {
                                $nTable = trim($reg[1]);
                                $insertCount[$nTable]++;
                        }
                }
                return array($crTables,$insertCount);
        }

        function getTableInsertStatements($statements, $table)  {
                $outStatements=array();
                foreach($statements as $line => $linecontent)   {
                        if (eregi('^insert[[:space:]]*into[[:space:]]*([[:alnum:]_]*)',substr($linecontent,0,100),$reg))        {
                                $nTable = trim($reg[1]);
                                if ($nTable && !strcmp($table,$nTable)) {
                                        $outStatements[]=$linecontent;
                                }
                        }
                }
                return $outStatements;
        }

        function performUpdateQueries($arr,$keyArr)     {
                if (is_array($arr))     {
                        foreach($arr as $key => $string)        {
                                if (isset($keyArr[$key]) && $keyArr[$key])      {
                                        $GLOBALS['TYPO3_DB']->admin_query($string);
                                }
                        }
                }
        }

        function getListOfTables()      {
                $whichTables = $GLOBALS['TYPO3_DB']->admin_get_tables(TYPO3_db);
                return $whichTables;
        }

        function generateUpdateDatabaseForm_checkboxes($arr,$label,$checked=1,$iconDis=0,$currentValue=array(),$cVfullMsg=0)    {
                $out = array();
                if (is_array($arr))     {
                        foreach($arr as $key => $string)        {
                                $ico = '';
                                if ($iconDis)   {
                                        if (stristr($string,' user_'))  {
                                                $ico.= '<img src="'.$this->backPath.'t3lib/gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(USER) </strong>';
                                        }
                                        if (stristr($string,' app_'))   {
                                                $ico.= '<img src="'.$this->backPath.'t3lib/gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(APP) </strong>';
                                        }
                                        if (stristr($string,' ttx_') || stristr($string,' tx_'))        {
                                                $ico.= '<img src="'.$this->backPath.'t3lib/gfx/icon_warning.gif" width="18" height="16" align="top" alt="" /><strong>(EXT) </strong>';
                                        }
                                }
                                $out[]='
                                        <tr>
                                                <td valign="top"><input type="checkbox" name="'.$this->dbUpdateCheckboxPrefix.'['.$key.']" value="1"'.($checked?' checked="checked"':'').' /></td>
                                                <td nowrap="nowrap">'.nl2br($ico.htmlspecialchars($string)).'</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>';
                                }
                        }

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

                return $content;
        }
}

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']);
}
?>

---