* @author Romain Quetiez * @author Denis Flaven * @license http://www.opensource.org/licenses/gpl-3.0.html GPL */ class CheckResult { // Severity levels const ERROR = 0; const WARNING = 1; const INFO = 2; public $iSeverity; public $sLabel; public $sDescription; public function __construct($iSeverity, $sLabel, $sDescription = '') { $this->iSeverity = $iSeverity; $this->sLabel = $sLabel; $this->sDescription = $sDescription; } } /** * Namespace for storing all the functions/utilities needed by both * the setup wizard and the installation process * @author Erwan Taloc * @author Romain Quetiez * @author Denis Flaven * @license http://www.opensource.org/licenses/gpl-3.0.html GPL */ class SetupUtils { const PHP_MIN_VERSION = '5.2.0'; const MYSQL_MIN_VERSION = '5.0.0'; const MIN_MEMORY_LIMIT = 33554432; // = 32*1024*1024 Beware: Computations are not allowed in defining constants const SUHOSIN_GET_MAX_VALUE_LENGTH = 2048; /** * Check the version of PHP, the needed PHP extension and a number * of configuration parameters (memory_limit, max_upload_file_size, etc...) * @param SetupPage $oP The page used only for its 'log' method * @return array An array of CheckResults objects */ static function CheckPHPVersion() { $aResult = array(); SetupPage::log('Info - CheckPHPVersion'); if (version_compare(phpversion(), self::PHP_MIN_VERSION, '>=')) { $aResult[] = new CheckResult(CheckResult::INFO, "The current PHP Version (".phpversion().") is greater than the minimum version required to run ".ITOP_APPLICATION.", which is (".self::PHP_MIN_VERSION.")"); } else { $aResult[] = new CheckResult(CheckResult::ERROR, "Error: The current PHP Version (".phpversion().") is lower than the minimum version required to run ".ITOP_APPLICATION.", which is (".self::PHP_MIN_VERSION.")"); } $aMandatoryExtensions = array('mysqli', 'iconv', 'simplexml', 'soap', 'hash', 'json', 'session', 'pcre', 'dom'); $aOptionalExtensions = array('mcrypt' => 'Strong encryption will not be used.', 'ldap' => 'LDAP authentication will be disabled.'); asort($aMandatoryExtensions); // Sort the list to look clean ! ksort($aOptionalExtensions); // Sort the list to look clean ! $aExtensionsOk = array(); $aMissingExtensions = array(); $aMissingExtensionsLinks = array(); // First check the mandatory extensions foreach($aMandatoryExtensions as $sExtension) { if (extension_loaded($sExtension)) { $aExtensionsOk[] = $sExtension; } else { $aMissingExtensions[] = $sExtension; $aMissingExtensionsLinks[] = "$sExtension"; } } if (count($aExtensionsOk) > 0) { $aResult[] = new CheckResult(CheckResult::INFO, "Required PHP extension(s): ".implode(', ', $aExtensionsOk)."."); } if (count($aMissingExtensions) > 0) { $aResult[] = new CheckResult(CheckResult::ERROR, "Missing PHP extension(s): ".implode(', ', $aMissingExtensionsLinks)."."); } // Next check the optional extensions $aExtensionsOk = array(); $aMissingExtensions = array(); foreach($aOptionalExtensions as $sExtension => $sMessage) { if (extension_loaded($sExtension)) { $aExtensionsOk[] = $sExtension; } else { $aMissingExtensions[$sExtension] = $sMessage; } } if (count($aExtensionsOk) > 0) { $aResult[] = new CheckResult(CheckResult::INFO, "Optional PHP extension(s): ".implode(', ', $aExtensionsOk)."."); } if (count($aMissingExtensions) > 0) { foreach($aMissingExtensions as $sExtension => $sMessage) { $aResult[] = new CheckResult(CheckResult::WARNING, "Missing optional PHP extension: $sExtension. ".$sMessage); } } // Check some ini settings here if (function_exists('php_ini_loaded_file')) // PHP >= 5.2.4 { $sPhpIniFile = php_ini_loaded_file(); // Other included/scanned files if ($sFileList = php_ini_scanned_files()) { if (strlen($sFileList) > 0) { $aFiles = explode(',', $sFileList); foreach ($aFiles as $sFile) { $sPhpIniFile .= ', '.trim($sFile); } } } SetupPage::log("Info - php.ini file(s): '$sPhpIniFile'"); } else { $sPhpIniFile = 'php.ini'; } if (!ini_get('file_uploads')) { $aResult[] = new CheckResult(CheckResult::ERROR, "Files upload is not allowed on this server (file_uploads = ".ini_get('file_uploads').")."); } $sUploadTmpDir = self::GetUploadTmpDir(); if (empty($sUploadTmpDir)) { $sUploadTmpDir = '/tmp'; $aResult[] = new CheckResult(CheckResult::WARNING, "Temporary directory for files upload is not defined (upload_tmp_dir), assuming that $sUploadTmpDir is used."); } // check that the upload directory is indeed writable from PHP if (!empty($sUploadTmpDir)) { if (!file_exists($sUploadTmpDir)) { $aResult[] = new CheckResult(CheckResult::ERROR, "Temporary directory for files upload ($sUploadTmpDir) does not exist or cannot be read by PHP."); } else if (!is_writable($sUploadTmpDir)) { $aResult[] = new CheckResult(CheckResult::ERROR, "Temporary directory for files upload ($sUploadTmpDir) is not writable."); } else { SetupPage::log("Info - Temporary directory for files upload ($sUploadTmpDir) is writable."); } } if (!ini_get('upload_max_filesize')) { $aResult[] = new CheckResult(CheckResult::ERROR, "File upload is not allowed on this server (upload_max_filesize = ".ini_get('upload_max_filesize').")."); } $iMaxFileUploads = ini_get('max_file_uploads'); if (!empty($iMaxFileUploads) && ($iMaxFileUploads < 1)) { $aResult[] = new CheckResult(CheckResult::ERROR, "File upload is not allowed on this server (max_file_uploads = ".ini_get('max_file_uploads').")."); } $iMaxUploadSize = utils::ConvertToBytes(ini_get('upload_max_filesize')); $iMaxPostSize = utils::ConvertToBytes(ini_get('post_max_size')); if ($iMaxPostSize <= $iMaxUploadSize) { $aResult[] = new CheckResult(CheckResult::WARNING, "post_max_size (".ini_get('post_max_size').") in php.ini should be bigger than upload_max_filesize (".ini_get('upload_max_filesize').") otherwise you cannot upload files of the maximun size."); } SetupPage::log("Info - upload_max_filesize: ".ini_get('upload_max_filesize')); SetupPage::log("Info - post_max_size: ".ini_get('post_max_size')); SetupPage::log("Info - max_file_uploads: ".ini_get('max_file_uploads')); // Check some more ini settings here, needed for file upload if (function_exists('get_magic_quotes_gpc')) { if (@get_magic_quotes_gpc()) { $aResult[] = new CheckResult(CheckResult::ERROR, "'magic_quotes_gpc' is set to On. Please turn it Off in php.ini before continuing."); } } if (function_exists('magic_quotes_runtime')) { if (@magic_quotes_runtime()) { $aResult[] = new CheckResult(CheckResult::ERROR, "'magic_quotes_runtime' is set to On. Please turn it Off in php.ini before continuing."); } } $sMemoryLimit = trim(ini_get('memory_limit')); if (empty($sMemoryLimit)) { // On some PHP installations, memory_limit does not exist as a PHP setting! // (encountered on a 5.2.0 under Windows) // In that case, ini_set will not work, let's keep track of this and proceed anyway $aResult[] = new CheckResult(CheckResult::WARNING, "No memory limit has been defined in this instance of PHP"); } else { // Check that the limit will allow us to load the data // $iMemoryLimit = utils::ConvertToBytes($sMemoryLimit); if ($iMemoryLimit < self::MIN_MEMORY_LIMIT) { $aResult[] = new CheckResult(CheckResult::ERROR, "memory_limit ($iMemoryLimit) is too small, the minimum value to run the application is ".self::MIN_MEMORY_LIMIT."."); } else { SetupPage::log("Info - memory_limit is $iMemoryLimit, ok."); } } // Special case for APC if (extension_loaded('apc')) { $sAPCVersion = phpversion('apc'); $aResult[] = new CheckResult(CheckResult::INFO, "APC detected (version $sAPCVersion). The APC cache will be used to speed-up ".ITOP_APPLICATION."."); } // Special case Suhosin extension if (extension_loaded('suhosin')) { $sSuhosinVersion = phpversion('suhosin'); $aOk[] = "Suhosin extension detected (version $sSuhosinVersion)."; $iGetMaxValueLength = ini_get('suhosin.get.max_value_length'); if ($iGetMaxValueLength < self::SUHOSIN_GET_MAX_VALUE_LENGTH) { $aResult[] = new CheckResult(CheckResult::WARNING, "suhosin.get.max_value_length ($iGetMaxValueLength) is too small, the minimum value recommended to run the application is ".self::SUHOSIN_GET_MAX_VALUE_LENGTH."."); } else { SetupPage::log("Info - suhosin.get.max_value_length = $iGetMaxValueLength, ok."); } } if (function_exists('php_ini_loaded_file')) // PHP >= 5.2.4 { $sPhpIniFile = php_ini_loaded_file(); // Other included/scanned files if ($sFileList = php_ini_scanned_files()) { if (strlen($sFileList) > 0) { $aFiles = explode(',', $sFileList); foreach ($aFiles as $sFile) { $sPhpIniFile .= ', '.trim($sFile); } } } $aResult[] = new CheckResult(CheckResult::INFO, "Loaded php.ini files: $sPhpIniFile"); } return $aResult; } /** * Check that the backup could be executed * @param Page $oP The page used only for its 'log' method * @return array An array of CheckResults objects */ static function CheckBackupPrerequisites($sDestDir) { $aResult = array(); SetupPage::log('Info - CheckBackupPrerequisites'); // zip extension // if (!extension_loaded('zip')) { $sMissingExtensionLink = "zip"; $aResult[] = new CheckResult(CheckResult::ERROR, "Missing PHP extension: zip", $sMissingExtensionLink); } // availability of exec() // $aDisabled = explode(', ', ini_get('disable_functions')); SetupPage::log('Info - PHP functions disabled: '.implode(', ', $aDisabled)); if (in_array('exec', $aDisabled)) { $aResult[] = new CheckResult(CheckResult::ERROR, "The PHP exec() function has been disabled on this server"); } // availability of mysqldump $sMySQLBinDir = utils::ReadParam('mysql_bindir', '', true); if (empty($sMySQLBinDir)) { $sMySQLDump = 'mysqldump'; } else { SetupPage::log('Info - Found mysql_bindir: '.$sMySQLBinDir); $sMySQLDump = '"'.$sMySQLBinDir.'/mysqldump"'; } $sCommand = "$sMySQLDump -V 2>&1"; $aOutput = array(); $iRetCode = 0; exec($sCommand, $aOutput, $iRetCode); if ($iRetCode == 0) { $aResult[] = new CheckResult(CheckResult::INFO, "mysqldump is present: ".$aOutput[0]); } elseif ($iRetCode == 1) { $aResult[] = new CheckResult(CheckResult::ERROR, "mysqldump could not be found: ".implode(' ', $aOutput)." - Please make sure it is installed and in the path."); } else { $aResult[] = new CheckResult(CheckResult::ERROR, "mysqldump could not be executed (retcode=$iRetCode): Please make sure it is installed and in the path"); } foreach($aOutput as $sLine) { SetupPage::log('Info - mysqldump -V said: '.$sLine); } // check disk space // to do... evaluate how we can correlate the DB size with the size of the dump (and the zip!) // E.g. 2,28 Mb after a full install, giving a zip of 26 Kb (data = 26 Kb) // Example of query (DB without a suffix) //$sDBSize = "SELECT SUM(ROUND(DATA_LENGTH/1024/1024, 2)) AS size_mb FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_SCHEMA = `$sDBName`"; return $aResult; } /** * Helper function to retrieve the system's temporary directory * Emulates sys_get_temp_dir if neeed (PHP < 5.2.1) * @return string Path to the system's temp directory */ static function GetTmpDir() { // try to figure out what is the temporary directory // prior to PHP 5.2.1 the function sys_get_temp_dir // did not exist if ( !function_exists('sys_get_temp_dir')) { if( $temp=getenv('TMP') ) return realpath($temp); if( $temp=getenv('TEMP') ) return realpath($temp); if( $temp=getenv('TMPDIR') ) return realpath($temp); $temp=tempnam(__FILE__,''); if (file_exists($temp)) { unlink($temp); return realpath(dirname($temp)); } return null; } else { return realpath(sys_get_temp_dir()); } } /** * Helper function to retrieve the directory where files are to be uploaded * @return string Path to the temp directory used for uploading files */ static function GetUploadTmpDir() { $sPath = ini_get('upload_tmp_dir'); if (empty($sPath)) { $sPath = self::GetTmpDir(); } return $sPath; } /** * Helper to recursively remove a directory */ public static function rrmdir($dir) { if ((strlen(trim($dir)) == 0) || ($dir == '/') || ($dir == '\\')) { throw new Exception("Attempting to delete directory: '$dir'"); } self::tidydir($dir); rmdir($dir); } /** * Helper to recursively cleanup a directory */ public static function tidydir($dir) { if ((strlen(trim($dir)) == 0) || ($dir == '/') || ($dir == '\\')) { throw new Exception("Attempting to delete directory: '$dir'"); } foreach(glob($dir . '/*') as $file) { if(is_dir($file)) { self::tidydir($file); rmdir($file); } else { unlink($file); } } } /** * Helper to build the full path of a new directory */ public static function builddir($dir) { $parent = dirname($dir); if(!is_dir($parent)) { self::builddir($parent); } if (!is_dir($dir)) { mkdir($dir); } } /** * Helper to copy a directory to a target directory, skipping .SVN files (for developer's comfort!) * Returns true if successfull */ public static function copydir($sSource, $sDest, $bUseSymbolicLinks = false) { if (is_dir($sSource)) { if (!is_dir($sDest)) { mkdir($sDest); } $aFiles = scandir($sSource); if(sizeof($aFiles) > 0 ) { foreach($aFiles as $sFile) { if ($sFile == '.' || $sFile == '..' || $sFile == '.svn') { // Skip continue; } if (is_dir($sSource.'/'.$sFile)) { // Recurse self::copydir($sSource.'/'.$sFile, $sDest.'/'.$sFile, $bUseSymbolicLinks); } else { if ($bUseSymbolicLinks) { if (function_exists('symlink')) { symlink($sSource.'/'.$sFile, $sDest.'/'.$sFile); } else { throw(new Exception("Error, cannot *copy* '$sSource/$sFile' to '$sDest/$sFile' using symbolic links, 'symlink' is not supported on this system.")); } } else { copy($sSource.'/'.$sFile, $sDest.'/'.$sFile); } } } } return true; } elseif (is_file($sSource)) { if ($bUseSymbolicLinks) { if (function_exists('symlink')) { return symlink($sSource, $sDest); } else { throw(new Exception("Error, cannot *copy* '$sSource' to '$sDest' using symbolic links, 'symlink' is not supported on this system.")); } } else { return copy($sSource, $sDest); } } else { return false; } } static function GetPreviousInstance($sDir) { $bFound = false; $sSourceDir = ''; $sSourceEnvironement = ''; $sConfigFile = ''; $aResult = array( 'found' => false, ); if (file_exists($sDir.'/config-itop.php')) { $sSourceDir = $sDir; $sSourceEnvironment = ''; $sConfigFile = $sDir.'/config-itop.php'; $aResult['found'] = true; } else if (file_exists($sDir.'/conf/production/config-itop.php')) { $sSourceDir = $sDir; $sSourceEnvironment = 'production'; $sConfigFile = $sDir.'/conf/production/config-itop.php'; $aResult['found'] = true; } if ($aResult['found']) { $oPrevConf = new Config($sConfigFile); $aResult = array( 'found' => true, 'source_dir' => $sSourceDir, 'source_environment' => $sSourceEnvironment, 'configuration_file' => $sConfigFile, 'db_server' => $oPrevConf->GetDBHost(), 'db_user' => $oPrevConf->GetDBUser(), 'db_pwd' => $oPrevConf->GetDBPwd(), 'db_name' => $oPrevConf->GetDBName(), 'db_prefix' => $oPrevConf->GetDBSubname(), ); } return $aResult; } static function CheckDiskSpace($sDir) { while(($f = @disk_free_space($sDir)) == false) { if ($sDir == dirname($sDir)) break; if ($sDir == '.') break; $sDir = dirname($sDir); } return $f; } static function HumanReadableSize($fBytes) { $aSizes = array('bytes', 'Kb', 'Mb', 'Gb', 'Tb', 'Pb', 'Hb'); $index = 0; while (($fBytes > 1000) && ($index < count($aSizes))) { $index++; $fBytes = $fBytes / 1000; } return sprintf('%.2f %s', $fBytes, $aSizes[$index]); } static function DisplayDBParameters($oPage, $bAllowDBCreation, $sDBServer, $sDBUser, $sDBPwd, $sDBName, $sDBPrefix, $sNewDBName = '') { $oPage->add(''); $oPage->add('
Database Server Connection'); $oPage->add(''); $oPage->add(''); $oPage->add(''); $oPage->add(''); $oPage->add('
Server Name:E.g. "localhost", "dbserver.mycompany.com" or "192.142.10.23"
Login:The account must have the following privileges on the database: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, CREATE VIEW, SUPER, TRIGGER
Password:
'); $oPage->add('
'); $oPage->add(''); $oPage->add(''); $oPage->add(''); $oPage->add('
Database'); $oPage->add(''); if ($bAllowDBCreation) { $oPage->add(''); $oPage->add(''); $oPage->add(''); $oPage->add(''); $oPage->add(''); } else { $oPage->add(''); $oPage->add(''); } $oPage->add('
Use a prefix for the tables:
Database Name:
Use a prefix for the tables:
'); $oPage->add('
'); $oPage->add(' '); $oPage->add(''); $oPage->add_script( <<'); return false; } else { $("#v_"+sFieldId).html(""); return true; } } else { $("#v_"+sFieldId).html(''); return false; } } else if (bMandatory) { $("#v_"+sFieldId).html(''); return false; } else { $("#v_"+sFieldId).html(""); return true; } } } EOF ); $oPage->add_ready_script( << Array of CheckResult, 'databases' => Array of database names (as strings) or null if not allowed) */ static function CheckServerConnection($sDBServer, $sDBUser, $sDBPwd) { $aResult = array('checks' => array(), 'databases' => null); try { $oDBSource = new CMDBSource; $oDBSource->Init($sDBServer, $sDBUser, $sDBPwd); $aResult['checks'][] = new CheckResult(CheckResult::INFO, "Connection to '$sDBServer' as '$sDBUser' successful."); $aResult['checks'][] = new CheckResult(CheckResult::INFO, "Info - User privileges: ".($oDBSource->GetRawPrivileges())); $sDBVersion = $oDBSource->GetDBVersion(); if (version_compare($sDBVersion, self::MYSQL_MIN_VERSION, '>=')) { $aResult['checks'][] = new CheckResult(CheckResult::INFO, "Current MySQL version ($sDBVersion), greater than minimum required version (".self::MYSQL_MIN_VERSION.")"); // Check some server variables $iMaxAllowedPacket = $oDBSource->GetServerVariable('max_allowed_packet'); $iMaxUploadSize = utils::ConvertToBytes(ini_get('upload_max_filesize')); if ($iMaxAllowedPacket >= (500 + $iMaxUploadSize)) // Allow some space for the query + the file to upload { $aResult['checks'][] = new CheckResult(CheckResult::INFO, "MySQL server's max_allowed_packet ($iMaxAllowedPacket) is big enough compared to upload_max_filesize ($iMaxUploadSize)."); } else if($iMaxAllowedPacket < $iMaxUploadSize) { $aResult['checks'][] = new CheckResult(CheckResult::WARNING, "MySQL server's max_allowed_packet ($iMaxAllowedPacket) is not big enough. Please, consider setting it to at least ".(500 + $iMaxUploadSize)."."); } $iMaxConnections = $oDBSource->GetServerVariable('max_connections'); if ($iMaxConnections < 5) { $aResult['checks'][] = new CheckResult(CheckResult::WARNING, "MySQL server's max_connections ($iMaxConnections) is not enough. Please, consider setting it to at least 5."); } else { $aResult['checks'][] = new CheckResult(CheckResult::INFO, "MySQL server's max_connections is set to $iMaxConnections."); } } else { $aResult['checks'][] = new CheckResult(CheckResult::ERROR, "Error: Current MySQL version is ($sDBVersion), minimum required version (".self::MYSQL_MIN_VERSION.")"); } try { $aResult['databases'] = $oDBSource->ListDB(); } catch(Exception $e) { $aResult['databases'] = null; } } catch(Exception $e) { return false; } return $aResult; } static public function AsyncCheckDB($oPage, $aParameters) { $sDBServer = $aParameters['db_server']; $sDBUser = $aParameters['db_user']; $sDBPwd = $aParameters['db_pwd']; $sDBName = $aParameters['db_name']; $oPage->add_ready_script('oXHRCheckDB = null;'); $checks = SetupUtils::CheckServerConnection($sDBServer, $sDBUser, $sDBPwd); if ($checks === false) { // Connection failed, disable the "Next" button $oPage->add_ready_script('$("#wiz_form").data("db_connection", "error");'); $oPage->add_ready_script('$("#db_info").html("No connection to the database...");'); } else { $aErrors = array(); $aWarnings = array(); foreach($checks['checks'] as $oCheck) { if ($oCheck->iSeverity == CheckResult::ERROR) { $aErrors[] = $oCheck->sLabel; } else if ($oCheck->iSeverity == CheckResult::WARNING) { $aWarnings[] = $oCheck->sLabel; } } if (count($aErrors) > 0) { $oPage->add_ready_script('$("#wiz_form").data("db_connection", "error");'); $oPage->add_ready_script('$("#db_info").html(\' Error: '.htmlentities(implode('
', $aErrors), ENT_QUOTES, 'UTF-8').'\');'); } else if (count($aWarnings) > 0) { $oPage->add_ready_script('$("#wiz_form").data("db_connection", "");'); $oPage->add_ready_script('$("#db_info").html(\' Warning: '.htmlentities(implode('
', $aWarnings), ENT_QUOTES, 'UTF-8').'\');'); } else { $oPage->add_ready_script('$("#wiz_form").data("db_connection", "");'); $oPage->add_ready_script('$("#db_info").html(\' Database server connection Ok.\');'); } if ($checks['databases'] == null) { $sDBNameInput = ''; $oPage->add_ready_script('$("#table_info").html(\' Not enough rights to enumerate the databases\');'); } else { $sDBNameInput = ''; } $oPage->add_ready_script('$("#db_name_container").html("'.addslashes($sDBNameInput).'");'); $oPage->add_ready_script('$("#db_name").bind("click keyup change", function() { $("#existing_db").attr("checked", "checked"); WizardUpdateButtons(); });'); } $oPage->add_ready_script('WizardUpdateButtons();'); } /** * Helper function to get the available languages from the given directory * @param $sDir Path to the dictionary * @return an array of language code => description */ static public function GetAvailableLanguages($sDir) { require_once(APPROOT.'/core/coreexception.class.inc.php'); require_once(APPROOT.'/core/dict.class.inc.php'); $aFiles = scandir($sDir); foreach($aFiles as $sFile) { if ($sFile == '.' || $sFile == '..' || $sFile == '.svn') { // Skip continue; } $sFilePath = $sDir.'/'.$sFile; if (is_file($sFilePath) && preg_match('/^.+\.dict.*\.php$/i', $sFilePath, $aMatches)) { require_once($sFilePath); } } return Dict::GetLanguages(); } static public function GetLanguageSelect($sSourceDir, $sInputName, $sDefaultLanguageCode) { $sHtml = ''; return $sHtml; } public static function AnalyzeInstallation($oWizard) { require_once(APPROOT.'/setup/moduleinstaller.class.inc.php'); $oConfig = new Config(); $sSourceDir = $oWizard->GetParameter('source_dir', ''); if (strpos($sSourceDir, APPROOT) !== false) { $sRelativeSourceDir = str_replace(APPROOT, '', $sSourceDir); } else if (strpos($sSourceDir, $oWizard->GetParameter('previous_version_dir')) !== false) { $sRelativeSourceDir = str_replace($oWizard->GetParameter('previous_version_dir'), '', $sSourceDir); } else { throw(new Exception('Internal error: AnalyzeInstallation: source_dir is neither under APPROOT nor under previous_installation_dir ???')); } $aParamValues = array( 'db_server' => $oWizard->GetParameter('db_server', ''), 'db_user' => $oWizard->GetParameter('db_user', ''), 'db_pwd' => $oWizard->GetParameter('db_pwd', ''), 'db_name' => $oWizard->GetParameter('db_name', ''), 'db_prefix' => $oWizard->GetParameter('db_prefix', ''), 'source_dir' => $sRelativeSourceDir, ); $oConfig->UpdateFromParams($aParamValues, 'datamodel'); $aDirsToScan = array($sSourceDir); if (is_dir($sSourceDir.'/extensions')) { $aDirsToScan[] = $sSourceDir.'/extensions'; } if (is_dir($oWizard->GetParameter('copy_extensions_from'))) { $aDirsToScan[] = $oWizard->GetParameter('copy_extensions_from'); } $oProductionEnv = new RunTimeEnvironment(); $aAvailableModules = $oProductionEnv->AnalyzeInstallation($oConfig, $aDirsToScan); return $aAvailableModules; } public static function GetApplicationVersion($oWizard) { require_once(APPROOT.'/setup/moduleinstaller.class.inc.php'); $oConfig = new Config(); $aParamValues = array( 'db_server' => $oWizard->GetParameter('db_server', ''), 'db_user' => $oWizard->GetParameter('db_user', ''), 'db_pwd' => $oWizard->GetParameter('db_pwd', ''), 'db_name' => $oWizard->GetParameter('db_name', ''), 'db_prefix' => $oWizard->GetParameter('db_prefix', ''), 'source_dir' => '', ); $oConfig->UpdateFromParams($aParamValues, 'datamodel'); $oProductionEnv = new RunTimeEnvironment(); return $oProductionEnv->GetApplicationVersion($oConfig); } /** * Checks if the content of a directory matches the given manifest * @param string $sBaseDir Path to the root directory of iTop * @param string $sSourceDir Relative path to the directory to check under $sBaseDir * @param Array $aDOMManifest Array of array('path' => relative_path 'size'=> iSize, 'md5' => sHexMD5) * @param Hash $aResult Used for recursion * @return hash Hash array ('added' => array(), 'removed' => array(), 'modified' => array()) */ public static function CheckDirAgainstManifest($sBaseDir, $sSourceDir, $aManifest, $aExcludeNames = array('.svn'), $aResult = null) { //echo "CheckDirAgainstManifest($sBaseDir, $sSourceDir ...)\n"; if ($aResult === null) { $aResult = array('added' => array(), 'removed' => array(), 'modified' => array()); } if (substr($sSourceDir, 0, 1) == '/') { $sSourceDir = substr($sSourceDir, 1); } // Manifest limited to all the files supposed to be located in this directory $aDirManifest = array(); foreach($aManifest as $aFileInfo) { $sDir = dirname($aFileInfo['path']); if ($sDir == '.') { // Hmm... the file seems located at the root of iTop $sDir = ''; } if ($sDir == $sSourceDir) { $aDirManifest[basename($aFileInfo['path'])] = $aFileInfo; } } //echo "The manifest contains ".count($aDirManifest)." files for the directory '$sSourceDir' (and below)\n"; // Read the content of the directory foreach(glob($sBaseDir.'/'.$sSourceDir .'/*') as $sFilePath) { $sFile = basename($sFilePath); //echo "Checking $sFile ($sFilePath)\n"; if (in_array(basename($sFile), $aExcludeNames)) continue; if(is_dir($sFilePath)) { $aResult = self::CheckDirAgainstManifest($sBaseDir, $sSourceDir.'/'.$sFile, $aManifest, $aExcludeNames, $aResult); } else { if (!array_key_exists($sFile, $aDirManifest)) { //echo "New file ".$sFile." in $sSourceDir\n"; $aResult['added'][$sSourceDir.'/'.$sFile] = true; } else { $aStats = stat($sFilePath); if ($aStats['size'] != $aDirManifest[$sFile]['size']) { // Different sizes $aResult['modified'][$sSourceDir.'/'.$sFile] = 'Different sizes. Original size: '.$aDirManifest[$sFile]['size'].' bytes, actual file size on disk: '.$aStats['size'].' bytes.'; } else { // Same size, compare the md5 signature $sMD5 = md5_file($sFilePath); if ($sMD5 != $aDirManifest[$sFile]['md5']) { $aResult['modified'][$sSourceDir.'/'.$sFile] = 'Content modified (MD5 checksums differ).'; //echo $sSourceDir.'/'.$sFile." modified ($sMD5 == {$aDirManifest[$sFile]['md5']})\n"; } //else //{ // echo $sSourceDir.'/'.$sFile." unmodified ($sMD5 == {$aDirManifest[$sFile]['md5']})\n"; //} } //echo "Removing ".$sFile." from aDirManifest\n"; unset($aDirManifest[$sFile]); } } } // What remains in the array are files that were deleted foreach($aDirManifest as $sDeletedFile => $void) { $aResult['removed'][$sSourceDir.'/'.$sDeletedFile] = true; } return $aResult; } public static function CheckDataModelFiles($sManifestFile, $sBaseDir) { $oXML = simplexml_load_file($sManifestFile); $aManifest = array(); foreach($oXML as $oFileInfo) { $aManifest[] = array('path' => (string)$oFileInfo->path, 'size' => (int)$oFileInfo->size, 'md5' => (string)$oFileInfo->md5); } $sBaseDir = preg_replace('|modules/?$|', '', $sBaseDir); $aResults = self::CheckDirAgainstManifest($sBaseDir, 'modules', $aManifest); // echo "
Comparison of ".dirname($sBaseDir)."/modules against $sManifestFile:\n".print_r($aResults, true)."
"; return $aResults; } public static function CheckPortalFiles($sManifestFile, $sBaseDir) { $oXML = simplexml_load_file($sManifestFile); $aManifest = array(); foreach($oXML as $oFileInfo) { $aManifest[] = array('path' => (string)$oFileInfo->path, 'size' => (int)$oFileInfo->size, 'md5' => (string)$oFileInfo->md5); } $aResults = self::CheckDirAgainstManifest($sBaseDir, 'portal', $aManifest); // echo "
Comparison of ".dirname($sBaseDir)."/portal:\n".print_r($aResults, true)."
"; return $aResults; } public static function CheckApplicationFiles($sManifestFile, $sBaseDir) { $oXML = simplexml_load_file($sManifestFile); $aManifest = array(); foreach($oXML as $oFileInfo) { $aManifest[] = array('path' => (string)$oFileInfo->path, 'size' => (int)$oFileInfo->size, 'md5' => (string)$oFileInfo->md5); } $aResults = array('added' => array(), 'removed' => array(), 'modified' => array()); foreach(array('addons', 'core', 'dictionaries', 'js', 'application', 'css', 'pages', 'synchro', 'webservices') as $sDir) { $aTmp = self::CheckDirAgainstManifest($sBaseDir, $sDir, $aManifest); $aResults['added'] = array_merge($aResults['added'], $aTmp['added']); $aResults['modified'] = array_merge($aResults['modified'], $aTmp['modified']); $aResults['removed'] = array_merge($aResults['removed'], $aTmp['removed']); } // echo "
Comparison of ".dirname($sBaseDir)."/portal:\n".print_r($aResults, true)."
"; return $aResults; } public static function CheckVersion($sInstalledVersion, $sSourceDir) { $sManifestFilePath = self::GetVersionManifest($sInstalledVersion); if ($sSourceDir != '') { if (file_exists($sManifestFilePath)) { $aDMchanges = self::CheckDataModelFiles($sManifestFilePath, $sSourceDir); //$aPortalChanges = self::CheckPortalFiles($sManifestFilePath, $sSourceDir); //$aCodeChanges = self::CheckApplicationFiles($sManifestFilePath, $sSourceDir); //echo("Changes detected compared to $sInstalledVersion:
DataModel:
".print_r($aDMchanges, true)."
"); //echo("Changes detected compared to $sInstalledVersion:
DataModel:
".print_r($aDMchanges, true)."

Portal:
".print_r($aPortalChanges, true)."

Code:
".print_r($aCodeChanges, true)."
"); return $aDMchanges; } else { return false; } } else { throw(new Exception("Cannot check version '$sInstalledVersion', no source directory provided to check the files.")); } } public static function GetVersionManifest($sInstalledVersion) { if (preg_match('/^([0-9]+)\./', $sInstalledVersion, $aMatches)) { return APPROOT.'datamodels/'.$aMatches[1].'.x/manifest-'.$sInstalledVersion.'.xml'; } return false; } public static function CheckWritableDirs($aWritableDirs) { $aNonWritableDirs = array(); foreach($aWritableDirs as $sDir) { $sFullPath = APPROOT.$sDir; if (is_dir($sFullPath) && !is_writable($sFullPath)) { $aNonWritableDirs[APPROOT.$sDir] = new CheckResult(CheckResult::ERROR, "The directory '".APPROOT.$sDir."' exists but is not writable for the application."); } else if (file_exists($sFullPath) && !is_dir($sFullPath)) { $aNonWritableDirs[APPROOT.$sDir] = new CheckResult(CheckResult::ERROR, "A file with the same name as '".APPROOT.$sDir."' exists."); } else if (!is_dir($sFullPath) && !is_writable(APPROOT)) { $aNonWritableDirs[APPROOT] = new CheckResult(CheckResult::ERROR, "The directory '".APPROOT."' is not writable, the application cannot create the directory '$sDir' inside it."); } } return $aNonWritableDirs; } public static function GetLatestDataModelDir() { $sBaseDir = APPROOT.'datamodels'; $aDirs = glob($sBaseDir.'/*', GLOB_MARK | GLOB_ONLYDIR); if ($aDirs !== false) { sort($aDirs); return array_pop($aDirs); } return false; } public static function GetCompatibleDataModelDir($sInstalledVersion) { if (preg_match('/^([0-9]+)\./', $sInstalledVersion, $aMatches)) { $sMajorVersion = $aMatches[1]; $sDir = APPROOT.'datamodels/'.$sMajorVersion.'.x/'; if (is_dir($sDir)) { return $sDir; } } return false; } static public function GetDataModelVersion($sDatamodelDir) { $sVersionFile = $sDatamodelDir.'version.xml'; if (file_exists($sVersionFile)) { $oParams = new XMLParameters($sVersionFile); return $oParams->Get('version'); } return false; } }