3 /*********************************************************************************
4 * SugarCRM is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
7 * This program is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU Affero General Public License version 3 as published by the
9 * Free Software Foundation with the addition of the following permission added
10 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
11 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
12 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
19 * You should have received a copy of the GNU Affero General Public License along with
20 * this program; if not, see http://www.gnu.org/licenses or write to the Free
21 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
25 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
27 * The interactive user interfaces in modified source and object code versions
28 * of this program must display Appropriate Legal Notices, as required under
29 * Section 5 of the GNU Affero General Public License version 3.
31 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
32 * these Appropriate Legal Notices must retain the display of the "Powered by
33 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
34 * technical reasons, the Appropriate Legal Notices must display the words
35 * "Powered by SugarCRM".
36 ********************************************************************************/
39 //////////////////////////////////////////////////////////////////////////////////////////
40 //// This is a stand alone file that can be run from the command prompt for upgrading a
41 //// Sugar Instance. Three parameters are required to be defined in order to execute this file.
42 //// php.exe -f silentUpgrade.php [Path to Upgrade Package zip] [Path to Log file] [Path to Instance]
43 //// See below the Usage for more details.
44 /////////////////////////////////////////////////////////////////////////////////////////
45 ini_set('memory_limit',-1);
46 ///////////////////////////////////////////////////////////////////////////////
47 //// UTILITIES THAT MUST BE LOCAL :(
48 //Bug 24890, 24892. default_permissions not written to config.php. Following function checks and if
49 //no found then adds default_permissions to the config file.
50 function checkConfigForPermissions(){
51 if(file_exists(getcwd().'/config.php')){
52 require(getcwd().'/config.php');
55 if(!isset($sugar_config['default_permissions'])){
56 $sugar_config['default_permissions'] = array (
63 if(is_writable('config.php') && write_array_to_file("sugar_config", $sugar_config,'config.php')) {
69 function checkLoggerSettings(){
70 if(file_exists(getcwd().'/config.php')){
71 require(getcwd().'/config.php');
74 if(!isset($sugar_config['logger'])){
75 $sugar_config['logger'] =array (
88 if(is_writable('config.php') && write_array_to_file("sugar_config", $sugar_config,'config.php')) {
94 function checkResourceSettings(){
95 if(file_exists(getcwd().'/config.php')){
96 require(getcwd().'/config.php');
99 if(!isset($sugar_config['resource_management'])){
100 $sugar_config['resource_management'] =
102 'special_query_limit' => 50000,
103 'special_query_modules' =>
108 3 => 'Administration',
111 'default_limit' => 1000,
113 ksort($sugar_config);
114 if(is_writable('config.php') && write_array_to_file("sugar_config", $sugar_config,'config.php')) {
115 //writing to the file
121 function verifyArguments($argv,$usage_regular){
123 $cwd = getcwd(); // default to current, assumed to be in a valid SugarCRM root dir.
124 if(isset($argv[3])) {
125 if(is_dir($argv[3])) {
129 echo "*******************************************************************************\n";
130 echo "*** ERROR: 3rd parameter must be a valid directory. Tried to cd to [ {$argv[3]} ].\n";
135 //check if this is an instance
136 if(is_file("{$cwd}/include/entryPoint.php")) {
137 //this should be a regular sugar install
138 $upgradeType = constant('SUGARCRM_INSTALL');
139 //check if this is a valid zip file
140 if(!is_file($argv[1])) { // valid zip?
141 echo "*******************************************************************************\n";
142 echo "*** ERROR: First argument must be a full path to the patch file. Got [ {$argv[1]} ].\n";
147 if(count($argv) < 5) {
148 echo "*******************************************************************************\n";
149 echo "*** ERROR: Missing required parameters. Received ".count($argv)." argument(s), require 5.\n";
156 //this should be a regular sugar install
157 echo "*******************************************************************************\n";
158 echo "*** ERROR: Tried to execute in a non-SugarCRM root directory.\n";
162 if(isset($argv[7]) && file_exists($argv[7].'SugarTemplateUtilties.php')){
163 require_once($argv[7].'SugarTemplateUtilties.php');
169 //// END UTILITIES THAT MUST BE LOCAL :(
170 ///////////////////////////////////////////////////////////////////////////////
172 function rebuildRelations($pre_path = '')
174 $_REQUEST['silent'] = true;
175 include($pre_path.'modules/Administration/RebuildRelationship.php');
176 $_REQUEST['upgradeWizard'] = true;
177 include($pre_path.'modules/ACL/install_actions.php');
180 // only run from command line
181 if(isset($_SERVER['HTTP_USER_AGENT'])) {
182 fwrite(STDERR,'This utility may only be run from the command line or command prompt.');
185 //Clean_string cleans out any file passed in as a parameter
186 $_SERVER['PHP_SELF'] = 'silentUpgrade.php';
189 ///////////////////////////////////////////////////////////////////////////////
191 $usage_regular =<<<eoq2
192 Usage: php.exe -f silentUpgrade.php [upgradeZipFile] [logFile] [pathToSugarInstance] [admin-user]
194 On Command Prompt Change directory to where silentUpgrade.php resides. Then type path to
195 php.exe followed by -f silentUpgrade.php and the arguments.
198 [path-to-PHP/]php.exe -f silentUpgrade.php [path-to-upgrade-package/]SugarEnt-Upgrade-5.2.0-to-5.5.0.zip [path-to-log-file/]silentupgrade.log [path-to-sugar-instance/] admin
201 upgradeZipFile : Upgrade package file.
202 logFile : Silent Upgarde log file.
203 pathToSugarInstance : Sugar Instance instance being upgraded.
204 admin-user : admin user performing the upgrade
207 ///////////////////////////////////////////////////////////////////////////////
211 ///////////////////////////////////////////////////////////////////////////////
212 //// STANDARD REQUIRED SUGAR INCLUDES AND PRESETS
213 if(!defined('sugarEntry')) define('sugarEntry', true);
216 $_SESSION['schema_change'] = 'sugar'; // we force-run all SQL
217 $_SESSION['silent_upgrade'] = true;
218 $_SESSION['step'] = 'silent'; // flag to NOT try redirect to 4.5.x upgrade wizard
221 $_REQUEST['addTaskReminder'] = 'remind';
224 define('SUGARCRM_INSTALL', 'SugarCRM_Install');
225 define('DCE_INSTANCE', 'DCE_Instance');
228 $cwd = getcwd(); // default to current, assumed to be in a valid SugarCRM root dir.
230 $upgradeType = verifyArguments($argv,$usage_regular);
232 $path = $argv[2]; // custom log file, if blank will use ./upgradeWizard.log
233 $subdirs = array('full', 'langpack', 'module', 'patch', 'theme', 'temp');
235 require_once('include/entryPoint.php');
236 require_once('modules/UpgradeWizard/uw_utils.php');
237 require_once('include/utils/zip_utils.php');
238 require_once('include/utils/sugar_file_utils.php');
239 require_once('include/SugarObjects/SugarConfig.php');
241 global $sugar_config;
242 $isDCEInstance = false;
245 require('config.php');
246 if(isset($argv[3])) {
247 if(is_dir($argv[3])) {
253 require_once("{$cwd}/sugar_version.php"); // provides $sugar_version & $sugar_flavor
255 global $sugar_config;
256 $configOptions = $sugar_config['dbconfig'];
258 $GLOBALS['log'] = LoggerManager::getLogger('SugarCRM');
259 $patchName = basename($argv[1]);
260 $zip_from_dir = substr($patchName, 0, strlen($patchName) - 4); // patch folder name (minus ".zip")
261 $path = $argv[2]; // custom log file, if blank will use ./upgradeWizard.log
263 if($sugar_version < '5.1.0'){
264 $db = &DBManager :: getInstance();
266 $db = &DBManagerFactory::getInstance();
269 $UWstrings = return_module_language('en_us', 'UpgradeWizard');
270 $adminStrings = return_module_language('en_us', 'Administration');
271 $mod_strings = array_merge($adminStrings, $UWstrings);
272 $subdirs = array('full', 'langpack', 'module', 'patch', 'theme', 'temp');
274 $license_accepted = false;
275 if(isset($argv[5]) && (strtolower($argv[5])=='yes' || strtolower($argv[5])=='y')){
276 $license_accepted = true;
278 //////////////////////////////////////////////////////////////////////////////
279 //Adding admin user to the silent upgrade
281 $current_user = new User();
282 if(isset($argv[4])) {
283 //if being used for internal upgrades avoid admin user verification
284 $user_name = $argv[4];
285 $q = "select id from users where user_name = '" . $user_name . "' and is_admin=1";
286 $result = $GLOBALS['db']->query($q, false);
287 $logged_user = $GLOBALS['db']->fetchByAssoc($result);
288 if(isset($logged_user['id']) && $logged_user['id'] != null){
290 $current_user->retrieve($logged_user['id']);
293 echo "Not an admin user in users table. Please provide an admin user\n";
298 echo "*******************************************************************************\n";
299 echo "*** ERROR: 4th parameter must be a valid admin user.\n";
305 /////retrieve admin user
310 $unzip_dir = clean_path("{$cwd}/{$sugar_config['upload_dir']}upgrades/temp");
311 $install_file = clean_path("{$cwd}/{$sugar_config['upload_dir']}upgrades/patch/".basename($argv[1]));
313 $_SESSION['unzip_dir'] = $unzip_dir;
314 $_SESSION['install_file'] = $install_file;
315 $_SESSION['zip_from_dir'] = $zip_from_dir;
317 mkdir_recursive($unzip_dir);
318 if(!is_dir($unzip_dir)) {
319 fwrite(STDERR,"\n{$unzip_dir} is not an available directory\nFAILURE\n");
322 unzip($argv[1], $unzip_dir);
323 // mimic standard UW by copy patch zip to appropriate dir
324 copy($argv[1], $install_file);
325 //// END UPGRADE PREP
326 ///////////////////////////////////////////////////////////////////////////////
328 if(function_exists('repairTableDictionaryExtFile'))
330 repairTableDictionaryExtFile();
333 if(function_exists('set_upgrade_vars')){
338 if($configOptions['db_type'] == 'mysql'){
339 //Change the db wait_timeout for this session
340 $que ="select @@wait_timeout";
341 $result = $db->query($que);
342 $tb = $db->fetchByAssoc($result);
343 logThis('Wait Timeout before change ***** '.$tb['@@wait_timeout'] , $path);
344 $query ="set wait_timeout=28800";
346 $result = $db->query($que);
347 $ta = $db->fetchByAssoc($result);
348 logThis('Wait Timeout after change ***** '.$ta['@@wait_timeout'] , $path);
352 ///////////////////////////////////////////////////////////////////////////////
353 //// RUN SILENT UPGRADE
357 /// RELOAD NEW DEFINITIONS
358 global $ACLActions, $beanList, $beanFiles;
359 include('modules/ACLActions/actiondefs.php');
360 include('include/modules.php');
362 // clear out the theme cache
363 if(is_dir($GLOBALS['sugar_config']['cache_dir'].'themes')){
364 $allModFiles = array();
365 $allModFiles = findAllFiles($GLOBALS['sugar_config']['cache_dir'].'themes',$allModFiles);
366 foreach($allModFiles as $file){
367 //$file_md5_ref = str_replace(clean_path(getcwd()),'',$file);
368 if(file_exists($file)){
374 // re-minify the JS source files
375 $_REQUEST['root_directory'] = getcwd();
376 $_REQUEST['js_rebuild_concat'] = 'rebuild';
377 require_once('jssource/minify.php');
379 //Add the cache cleaning here.
380 if(function_exists('deleteCache'))
382 logThis('Call deleteCache', $path);
386 //First repair the databse to ensure it is up to date with the new vardefs/tabledefs
387 logThis('About to repair the database.', $path);
388 //Use Repair and rebuild to update the database.
390 require_once("modules/Administration/QuickRepairAndRebuild.php");
391 $rac = new RepairAndClear();
392 $rac->clearVardefs();
393 $rac->rebuildExtensions();
395 $repairedTables = array();
396 foreach ($beanFiles as $bean => $file) {
397 if(file_exists($file)){
398 unset($GLOBALS['dictionary'][$bean]);
400 $focus = new $bean ();
401 if(empty($focus->table_name) || isset($repairedTables[$focus->table_name])) {
405 if (($focus instanceOf SugarBean)) {
406 if(!isset($repairedTables[$focus->table_name]))
408 $sql = $GLOBALS['db']->repairTable($focus, true);
409 logThis('Running sql:' . $sql, $path);
410 $repairedTables[$focus->table_name] = true;
413 //Check to see if we need to create the audit table
414 if($focus->is_AuditEnabled() && !$focus->db->tableExists($focus->get_audit_table_name())){
415 logThis('Creating audit table:' . $focus->get_audit_table_name(), $path);
416 $focus->create_audit_table();
423 include ("{$argv[3]}/modules/TableDictionary.php");
424 foreach ($dictionary as $meta) {
425 $tablename = $meta['table'];
427 if(isset($repairedTables[$tablename])) {
431 $fielddefs = $meta['fields'];
432 $indices = $meta['indices'];
433 $sql = $GLOBALS['db']->repairTableParams($tablename, $fielddefs, $indices, true);
435 logThis($sql, $path);
436 $repairedTables[$tablename] = true;
441 logThis('database repaired', $path);
443 logThis('Start rebuild relationships.', $path);
445 logThis('End rebuild relationships.', $path);
447 include("{$cwd}/{$sugar_config['upload_dir']}upgrades/temp/manifest.php");
448 $ce_to_pro_ent = isset($manifest['name']) && ($manifest['name'] == 'SugarCE to SugarPro' || $manifest['name'] == 'SugarCE to SugarEnt');
449 $origVersion = getSilentUpgradeVar('origVersion');
451 global $silent_upgrade_vars_loaded;
452 logThis("Error retrieving silent upgrade var for origVersion: cache dir is {$GLOBALS['sugar_config']['cache_dir']} -- full cache for \$silent_upgrade_vars_loaded is ".var_export($silent_upgrade_vars_loaded, true), $path);
457 //add the global team if it does not exist
458 $globalteam = new Team();
459 $globalteam->retrieve('1');
460 require_once('modules/Administration/language/en_us.lang.php');
461 if(isset($globalteam->name)){
462 echo 'Global '.$mod_strings['LBL_UPGRADE_TEAM_EXISTS'].'<br>';
463 logThis(" Finish Building Global Team", $path);
465 $globalteam->create_team("Global", $mod_strings['LBL_GLOBAL_TEAM_DESC'], $globalteam->global_team);
468 logThis(" Start Building private teams", $path);
470 upgradeModulesForTeam();
471 logThis(" Finish Building private teams", $path);
473 logThis(" Start Building the team_set and team_sets_teams", $path);
474 upgradeModulesForTeamsets();
475 logThis(" Finish Building the team_set and team_sets_teams", $path);
477 logThis(" Start modules/Administration/upgradeTeams.php", $path);
478 include('modules/Administration/upgradeTeams.php');
479 logThis(" Finish modules/Administration/upgradeTeams.php", $path);
481 if($sugar_config['dbconfig']['db_type'] == 'mssql') {
483 $GLOBALS['db']->wakeupFTS();
489 if($origVersion < '620'){
490 //bug: 39757 - upgrade the calls and meetings end_date to a datetime field
491 upgradeDateTimeFields($path);
493 //upgrade the documents and meetings for lotus support
494 upgradeDocumentTypeFields($path);
497 //bug: 37214 - merge config_si.php settings if available
498 logThis('Begin merge_config_si_settings', $path);
499 merge_config_si_settings(true, '', '', $path);
500 logThis('End merge_config_si_settings', $path);
503 if($origVersion < '610' && function_exists('upgrade_connectors'))
505 upgrade_connectors($path);
508 //bug: 36845 - ability to provide global search support for custom modules
509 if($origVersion < '620' && function_exists('add_unified_search_to_custom_modules_vardefs')){
510 logThis('Add global search for custom modules start .', $path);
511 add_unified_search_to_custom_modules_vardefs();
512 logThis('Add global search for custom modules finished .', $path);
515 //Upgrade system displayed tabs and subpanels
516 if(function_exists('upgradeDisplayedTabsAndSubpanels'))
518 upgradeDisplayedTabsAndSubpanels($origVersion);
521 //Unlink files that have been removed
522 if(function_exists('unlinkUpgradeFiles'))
524 unlinkUpgradeFiles($origVersion);
527 ///////////////////////////////////////////////////////////////////////////////
530 set_upgrade_progress('end','in_progress','unlinkingfiles','in_progress');
531 logThis('Taking out the trash, unlinking temp files.', $path);
532 unlinkTempFiles(true);
533 removeSilentUpgradeVarsCache();
534 logThis('Taking out the trash, done.', $path);
537 ///////////////////////////////////////////////////////////////////////////////
540 $phpErrors = ob_get_contents();
542 logThis("**** Potential PHP generated error messages: {$phpErrors}", $path);
544 if(count($errors) > 0) {
545 foreach($errors as $error) {
546 logThis("****** SilentUpgrade ERROR: {$error}", $path);
550 logThis("***** SilentUpgrade completed successfully.", $path);
551 echo "********************************************************************\n";
552 echo "*************************** SUCCESS*********************************\n";
553 echo "********************************************************************\n";
554 echo "******** If your pre-upgrade Leads data is not showing ************\n";
555 echo "******** Or you see errors in detailview subpanels ****************\n";
556 echo "************* In order to resolve them ****************************\n";
557 echo "******** Log into application as Administrator ********************\n";
558 echo "******** Go to Admin panel ****************************************\n";
559 echo "******** Run Repair -> Rebuild Relationships **********************\n";
560 echo "********************************************************************\n";