3 /*********************************************************************************
4 * SugarCRM Community Edition is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2013 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 (
84 'suffix' => '', // bug51583, change default suffix to blank for backwards comptability
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 //Bug 52872. Dies if the request does not come from CLI.
181 $sapi_type = php_sapi_name();
182 if (substr($sapi_type, 0, 3) != 'cli') {
183 die("This is command-line only script");
187 // only run from command line
188 if(isset($_SERVER['HTTP_USER_AGENT'])) {
189 fwrite(STDERR,'This utility may only be run from the command line or command prompt.');
192 //Clean_string cleans out any file passed in as a parameter
193 $_SERVER['PHP_SELF'] = 'silentUpgrade.php';
196 ///////////////////////////////////////////////////////////////////////////////
198 $usage_regular =<<<eoq2
199 Usage: php.exe -f silentUpgrade.php [upgradeZipFile] [logFile] [pathToSugarInstance] [admin-user]
201 On Command Prompt Change directory to where silentUpgrade.php resides. Then type path to
202 php.exe followed by -f silentUpgrade.php and the arguments.
205 [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
208 upgradeZipFile : Upgrade package file.
209 logFile : Silent Upgarde log file.
210 pathToSugarInstance : Sugar Instance instance being upgraded.
211 admin-user : admin user performing the upgrade
214 ///////////////////////////////////////////////////////////////////////////////
218 ///////////////////////////////////////////////////////////////////////////////
219 //// STANDARD REQUIRED SUGAR INCLUDES AND PRESETS
220 if(!defined('sugarEntry')) define('sugarEntry', true);
223 $_SESSION['schema_change'] = 'sugar'; // we force-run all SQL
224 $_SESSION['silent_upgrade'] = true;
225 $_SESSION['step'] = 'silent'; // flag to NOT try redirect to 4.5.x upgrade wizard
228 $_REQUEST['addTaskReminder'] = 'remind';
231 define('SUGARCRM_INSTALL', 'SugarCRM_Install');
232 define('DCE_INSTANCE', 'DCE_Instance');
235 $cwd = getcwd(); // default to current, assumed to be in a valid SugarCRM root dir.
237 $upgradeType = verifyArguments($argv,$usage_regular);
239 $path = $argv[2]; // custom log file, if blank will use ./upgradeWizard.log
240 $subdirs = array('full', 'langpack', 'module', 'patch', 'theme', 'temp');
242 require_once('include/entryPoint.php');
243 require_once('modules/UpgradeWizard/uw_utils.php');
244 require_once('include/utils/zip_utils.php');
245 require_once('include/utils/sugar_file_utils.php');
246 require_once('include/SugarObjects/SugarConfig.php');
247 global $sugar_config;
248 $isDCEInstance = false;
251 require('config.php');
252 if(isset($argv[3])) {
253 if(is_dir($argv[3])) {
259 require_once("{$cwd}/sugar_version.php"); // provides $sugar_version & $sugar_flavor
261 global $sugar_config;
262 $configOptions = $sugar_config['dbconfig'];
264 $GLOBALS['log'] = LoggerManager::getLogger('SugarCRM');
265 $patchName = basename($argv[1]);
266 $zip_from_dir = substr($patchName, 0, strlen($patchName) - 4); // patch folder name (minus ".zip")
267 $path = $argv[2]; // custom log file, if blank will use ./upgradeWizard.log
268 $db = &DBManagerFactory::getInstance();
269 $UWstrings = return_module_language('en_us', 'UpgradeWizard', true);
270 $adminStrings = return_module_language('en_us', 'Administration', true);
271 $app_list_strings = return_app_list_strings_language('en_us');
272 $mod_strings = array_merge($adminStrings, $UWstrings);
273 $subdirs = array('full', 'langpack', 'module', 'patch', 'theme', 'temp');
275 $license_accepted = false;
276 if(isset($argv[5]) && (strtolower($argv[5])=='yes' || strtolower($argv[5])=='y')){
277 $license_accepted = true;
279 //////////////////////////////////////////////////////////////////////////////
280 //Adding admin user to the silent upgrade
282 $current_user = new User();
283 if(isset($argv[4])) {
284 //if being used for internal upgrades avoid admin user verification
285 $user_name = $argv[4];
286 $q = "select id from users where user_name = '" . $user_name . "' and is_admin=1";
287 $result = $GLOBALS['db']->query($q, false);
288 $logged_user = $GLOBALS['db']->fetchByAssoc($result);
289 if(isset($logged_user['id']) && $logged_user['id'] != null){
291 $current_user->retrieve($logged_user['id']);
294 echo "Not an admin user in users table. Please provide an admin user\n";
299 echo "*******************************************************************************\n";
300 echo "*** ERROR: 4th parameter must be a valid admin user.\n";
306 /////retrieve admin user
308 $unzip_dir = sugar_cached("upgrades/temp");
309 $install_file = $sugar_config['upload_dir']."/upgrades/patch/".basename($argv[1]);
310 sugar_mkdir($sugar_config['upload_dir']."/upgrades/patch", 0775, true);
312 $_SESSION['unzip_dir'] = $unzip_dir;
313 $_SESSION['install_file'] = $install_file;
314 $_SESSION['zip_from_dir'] = $zip_from_dir;
316 mkdir_recursive($unzip_dir);
317 if(!is_dir($unzip_dir)) {
318 fwrite(STDERR,"\n{$unzip_dir} is not an available directory\nFAILURE\n");
321 unzip($argv[1], $unzip_dir);
322 // mimic standard UW by copy patch zip to appropriate dir
323 copy($argv[1], $install_file);
324 //// END UPGRADE PREP
325 ///////////////////////////////////////////////////////////////////////////////
328 if(function_exists('set_upgrade_vars')){
332 ///////////////////////////////////////////////////////////////////////////////
333 //// RUN SILENT UPGRADE
337 /// RELOAD NEW DEFINITIONS
338 global $ACLActions, $beanList, $beanFiles;
340 require_once('modules/Trackers/TrackerManager.php');
341 $trackerManager = TrackerManager::getInstance();
342 $trackerManager->pause();
343 $trackerManager->unsetMonitors();
345 include('modules/ACLActions/actiondefs.php');
346 include('include/modules.php');
348 require_once('modules/Administration/upgrade_custom_relationships.php');
349 upgrade_custom_relationships();
351 logThis('Upgrading user preferences start .', $path);
352 if(function_exists('upgradeUserPreferences')){
353 upgradeUserPreferences();
355 logThis('Upgrading user preferences finish .', $path);
357 // clear out the theme cache
358 if(is_dir($GLOBALS['sugar_config']['cache_dir'].'themes')){
359 $allModFiles = array();
360 $allModFiles = findAllFiles($GLOBALS['sugar_config']['cache_dir'].'themes',$allModFiles);
361 foreach($allModFiles as $file){
362 //$file_md5_ref = str_replace(clean_path(getcwd()),'',$file);
363 if(file_exists($file)){
369 // re-minify the JS source files
370 $_REQUEST['root_directory'] = getcwd();
371 $_REQUEST['js_rebuild_concat'] = 'rebuild';
372 require_once('jssource/minify.php');
374 //Add the cache cleaning here.
375 if(function_exists('deleteCache'))
377 logThis('Call deleteCache', $path);
381 // creating full text search logic hooks
382 // this will be merged into application/Ext/LogicHooks/logichooks.ext.php
383 // when rebuild_extensions is called
384 logThis(' Writing FTS hooks');
385 if (!function_exists('createFTSLogicHook')) {
386 $customFileLoc = create_custom_directory('Extension/application/Ext/LogicHooks/SugarFTSHooks.php');
387 $fp = sugar_fopen($customFileLoc, 'wb');
390 if (!isset(\$hook_array) || !is_array(\$hook_array)) {
391 \$hook_array = array();
393 if (!isset(\$hook_array['after_save']) || !is_array(\$hook_array['after_save'])) {
394 \$hook_array['after_save'] = array();
396 \$hook_array['after_save'][] = array(1, 'fts', 'include/SugarSearchEngine/SugarSearchEngineQueueManager.php', 'SugarSearchEngineQueueManager', 'populateIndexQueue');
399 fwrite($fp,$contents);
402 createFTSLogicHook('Extension/application/Ext/LogicHooks/SugarFTSHooks.php');
405 //First repair the databse to ensure it is up to date with the new vardefs/tabledefs
406 logThis('About to repair the database.', $path);
407 //Use Repair and rebuild to update the database.
409 require_once("modules/Administration/QuickRepairAndRebuild.php");
410 $rac = new RepairAndClear();
411 $rac->clearVardefs();
412 $rac->rebuildExtensions();
413 //bug: 44431 - defensive check to ensure the method exists since upgrades to 6.2.0 may not have this method define yet.
414 if(method_exists($rac, 'clearExternalAPICache'))
416 $rac->clearExternalAPICache();
419 $repairedTables = array();
420 foreach ($beanFiles as $bean => $file) {
421 if(file_exists($file)){
422 unset($GLOBALS['dictionary'][$bean]);
424 $focus = new $bean ();
425 if(empty($focus->table_name) || isset($repairedTables[$focus->table_name])) {
429 if (($focus instanceOf SugarBean)) {
430 if(!isset($repairedTables[$focus->table_name]))
432 $sql = $GLOBALS['db']->repairTable($focus, true);
435 logThis('Running sql:' . $sql, $path);
437 $repairedTables[$focus->table_name] = true;
440 //Check to see if we need to create the audit table
441 if($focus->is_AuditEnabled() && !$focus->db->tableExists($focus->get_audit_table_name())){
442 logThis('Creating audit table:' . $focus->get_audit_table_name(), $path);
443 $focus->create_audit_table();
450 include ("{$argv[3]}/modules/TableDictionary.php");
451 foreach ($dictionary as $meta) {
452 $tablename = $meta['table'];
454 if(isset($repairedTables[$tablename])) {
458 $fielddefs = $meta['fields'];
459 $indices = $meta['indices'];
460 $sql = $GLOBALS['db']->repairTableParams($tablename, $fielddefs, $indices, true);
462 logThis($sql, $path);
463 $repairedTables[$tablename] = true;
468 logThis('database repaired', $path);
470 logThis('Start rebuild relationships.', $path);
472 logThis('End rebuild relationships.', $path);
474 include("$unzip_dir/manifest.php");
475 $ce_to_pro_ent = isset($manifest['name']) && ($manifest['name'] == 'SugarCE to SugarPro' || $manifest['name'] == 'SugarCE to SugarEnt' || $manifest['name'] == 'SugarCE to SugarCorp' || $manifest['name'] == 'SugarCE to SugarUlt');
476 $sugar_version = getSilentUpgradeVar('origVersion');
479 global $silent_upgrade_vars_loaded;
480 logThis("Error retrieving silent upgrade var for sugar_version: cache dir is {$GLOBALS['sugar_config']['cache_dir']} -- full cache for \$silent_upgrade_vars_loaded is ".var_export($silent_upgrade_vars_loaded, true), $path);
485 //add the global team if it does not exist
486 $globalteam = new Team();
487 $globalteam->retrieve('1');
488 require_once($unzip_dir.'/'.$zip_from_dir.'/modules/Administration/language/en_us.lang.php');
489 if(isset($globalteam->name)){
490 echo 'Global '.$mod_strings['LBL_UPGRADE_TEAM_EXISTS'].'<br>';
491 logThis(" Finish Building Global Team", $path);
493 $globalteam->create_team("Global", $mod_strings['LBL_GLOBAL_TEAM_DESC'], $globalteam->global_team);
496 logThis(" Start Building private teams", $path);
498 upgradeModulesForTeam();
499 logThis(" Finish Building private teams", $path);
501 logThis(" Start Building the team_set and team_sets_teams", $path);
502 upgradeModulesForTeamsets();
503 logThis(" Finish Building the team_set and team_sets_teams", $path);
505 logThis(" Start modules/Administration/upgradeTeams.php", $path);
506 include('modules/Administration/upgradeTeams.php');
507 logThis(" Finish modules/Administration/upgradeTeams.php", $path);
510 $GLOBALS['db']->full_text_indexing_setup();
514 //bug: 37214 - merge config_si.php settings if available
515 logThis('Begin merge_config_si_settings', $path);
516 merge_config_si_settings(true, '', '', $path);
517 logThis('End merge_config_si_settings', $path);
520 logThis('Begin upgrade_connectors', $path);
521 upgrade_connectors();
522 logThis('End upgrade_connectors', $path);
525 //Unlink files that have been removed
526 if(function_exists('unlinkUpgradeFiles'))
528 unlinkUpgradeFiles($sugar_version);
531 if(function_exists('rebuildSprites') && function_exists('imagecreatetruecolor'))
533 rebuildSprites(true);
536 //Run repairUpgradeHistoryTable
537 if (version_compare($sugar_version, '6.5.0', '<') && function_exists('repairUpgradeHistoryTable'))
539 repairUpgradeHistoryTable();
542 ///////////////////////////////////////////////////////////////////////////////
545 set_upgrade_progress('end','in_progress','unlinkingfiles','in_progress');
546 logThis('Taking out the trash, unlinking temp files.', $path);
548 removeSilentUpgradeVarsCache();
549 logThis('Taking out the trash, done.', $path);
552 ///////////////////////////////////////////////////////////////////////////////
555 $phpErrors = ob_get_contents();
557 logThis("**** Potential PHP generated error messages: {$phpErrors}", $path);
559 if(count($errors) > 0) {
560 foreach($errors as $error) {
561 logThis("****** SilentUpgrade ERROR: {$error}", $path);
565 logThis("***** SilentUpgrade completed successfully.", $path);
566 echo "********************************************************************\n";
567 echo "*************************** SUCCESS*********************************\n";
568 echo "********************************************************************\n";
569 echo "******** If your pre-upgrade Leads data is not showing ************\n";
570 echo "******** Or you see errors in detailview subpanels ****************\n";
571 echo "************* In order to resolve them ****************************\n";
572 echo "******** Log into application as Administrator ********************\n";
573 echo "******** Go to Admin panel ****************************************\n";
574 echo "******** Run Repair -> Rebuild Relationships **********************\n";
575 echo "********************************************************************\n";