modules/UpgradeWizard/silentUpgrade_step2.php

   1 <?php
   2
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   6  *
   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.
  13  *
  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
  17  * details.
  18  *
  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
  22  * 02110-1301 USA.
  23  *
  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.
  26  *
  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.
  30  *
  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  ********************************************************************************/
  37
  38
  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');
  53      }
  54      global $sugar_config;
  55      if(!isset($sugar_config['default_permissions'])){
  56              $sugar_config['default_permissions'] = array (
  57                      'dir_mode' => 02770,
  58                      'file_mode' => 0660,
  59                      'user' => '',
  60                      'group' => '',
  61              );
  62          ksort($sugar_config);
  63          if(is_writable('config.php') && write_array_to_file("sugar_config", $sugar_config,'config.php')) {
  64                 //writing to the file
  65                 }
  66      }
  67 }
  68
  69 function checkLoggerSettings(){
  70         if(file_exists(getcwd().'/config.php')){
  71          require(getcwd().'/config.php');
  72      }
  73     global $sugar_config;
  74         if(!isset($sugar_config['logger'])){
  75             $sugar_config['logger'] =array (
  76                         'level'=>'fatal',
  77                     'file' =>
  78                      array (
  79                       'ext' => '.log',
  80                       'name' => 'sugarcrm',
  81                       'dateFormat' => '%c',
  82                       'maxSize' => '10MB',
  83                       'maxLogs' => 10,
  84                       'suffix' => '%m_%Y',
  85                     ),
  86                   );
  87                  ksort($sugar_config);
  88          if(is_writable('config.php') && write_array_to_file("sugar_config", $sugar_config,'config.php')) {
  89                 //writing to the file
  90                 }
  91          }
  92 }
  93
  94 function checkResourceSettings(){
  95         if(file_exists(getcwd().'/config.php')){
  96          require(getcwd().'/config.php');
  97      }
  98     global $sugar_config;
  99         if(!isset($sugar_config['resource_management'])){
 100           $sugar_config['resource_management'] =
 101                   array (
 102                     'special_query_limit' => 50000,
 103                     'special_query_modules' =>
 104                     array (
 105                       0 => 'Reports',
 106                       1 => 'Export',
 107                       2 => 'Import',
 108                       3 => 'Administration',
 109                       4 => 'Sync',
 110                     ),
 111                     'default_limit' => 1000,
 112                   );
 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
 116                 }
 117         }
 118 }
 119
 120
 121 function verifyArguments($argv,$usage_regular){
 122     $upgradeType = '';
 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])) {
 126             $cwd = $argv[3];
 127             chdir($cwd);
 128         } else {
 129             echo "*******************************************************************************\n";
 130             echo "*** ERROR: 3rd parameter must be a valid directory.  Tried to cd to [ {$argv[3]} ].\n";
 131             exit(1);
 132         }
 133     }
 134
 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";
 143             echo $usage_regular;
 144             echo "FAILURE\n";
 145             exit(1);
 146         }
 147         if(count($argv) < 5) {
 148             echo "*******************************************************************************\n";
 149             echo "*** ERROR: Missing required parameters.  Received ".count($argv)." argument(s), require 5.\n";
 150             echo $usage_regular;
 151             echo "FAILURE\n";
 152             exit(1);
 153         }
 154     }
 155     else {
 156         //this should be a regular sugar install
 157         echo "*******************************************************************************\n";
 158         echo "*** ERROR: Tried to execute in a non-SugarCRM root directory.\n";
 159         exit(1);
 160     }
 161
 162     if(isset($argv[7]) && file_exists($argv[7].'SugarTemplateUtilties.php')){
 163         require_once($argv[7].'SugarTemplateUtilties.php');
 164     }
 165
 166     return $upgradeType;
 167 }
 168
 169 ////    END UTILITIES THAT MUST BE LOCAL :(
 170 ///////////////////////////////////////////////////////////////////////////////
 171
 172 function rebuildRelations($pre_path = '')
 173 {
 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');
 178 }
 179
 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.');
 183         exit(1);
 184 }
 185 //Clean_string cleans out any file  passed in as a parameter
 186 $_SERVER['PHP_SELF'] = 'silentUpgrade.php';
 187
 188
 189 ///////////////////////////////////////////////////////////////////////////////
 190 ////    USAGE
 191 $usage_regular =<<<eoq2
 192 Usage: php.exe -f silentUpgrade.php [upgradeZipFile] [logFile] [pathToSugarInstance] [admin-user]
 193
 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.
 196
 197 Example:
 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
 199
 200 Arguments:
 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
 205 eoq2;
 206 ////    END USAGE
 207 ///////////////////////////////////////////////////////////////////////////////
 208
 209
 210
 211 ///////////////////////////////////////////////////////////////////////////////
 212 ////    STANDARD REQUIRED SUGAR INCLUDES AND PRESETS
 213 if(!defined('sugarEntry')) define('sugarEntry', true);
 214
 215 $_SESSION = array();
 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
 219
 220 $_REQUEST = array();
 221 $_REQUEST['addTaskReminder'] = 'remind';
 222
 223
 224 define('SUGARCRM_INSTALL', 'SugarCRM_Install');
 225 define('DCE_INSTANCE', 'DCE_Instance');
 226
 227 global $cwd;
 228 $cwd = getcwd(); // default to current, assumed to be in a valid SugarCRM root dir.
 229
 230 $upgradeType = verifyArguments($argv,$usage_regular);
 231
 232 $path                   = $argv[2]; // custom log file, if blank will use ./upgradeWizard.log
 233 $subdirs                = array('full', 'langpack', 'module', 'patch', 'theme', 'temp');
 234
 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');
 240 global $sugar_config;
 241 $isDCEInstance = false;
 242 $errors = array();
 243
 244         require('config.php');
 245         if(isset($argv[3])) {
 246                 if(is_dir($argv[3])) {
 247                         $cwd = $argv[3];
 248                         chdir($cwd);
 249                 }
 250         }
 251
 252         require_once("{$cwd}/sugar_version.php"); // provides $sugar_version & $sugar_flavor
 253
 254         global $sugar_config;
 255         $configOptions = $sugar_config['dbconfig'];
 256
 257     $GLOBALS['log']     = LoggerManager::getLogger('SugarCRM');
 258         $patchName              = basename($argv[1]);
 259         $zip_from_dir   = substr($patchName, 0, strlen($patchName) - 4); // patch folder name (minus ".zip")
 260         $path                   = $argv[2]; // custom log file, if blank will use ./upgradeWizard.log
 261
 262         if($sugar_version < '5.1.0'){
 263                 $db                             = &DBManager :: getInstance();
 264         } else{
 265                 $db                             = &DBManagerFactory::getInstance();
 266         }
 267
 268         $UWstrings              = return_module_language('en_us', 'UpgradeWizard');
 269         $adminStrings   = return_module_language('en_us', 'Administration');
 270         $mod_strings    = array_merge($adminStrings, $UWstrings);
 271         $subdirs                = array('full', 'langpack', 'module', 'patch', 'theme', 'temp');
 272         global $unzip_dir;
 273     $license_accepted = false;
 274     if(isset($argv[5]) && (strtolower($argv[5])=='yes' || strtolower($argv[5])=='y')){
 275         $license_accepted = true;
 276          }
 277         //////////////////////////////////////////////////////////////////////////////
 278         //Adding admin user to the silent upgrade
 279
 280         $current_user = new User();
 281         if(isset($argv[4])) {
 282            //if being used for internal upgrades avoid admin user verification
 283            $user_name = $argv[4];
 284            $q = "select id from users where user_name = '" . $user_name . "' and is_admin=1";
 285            $result = $GLOBALS['db']->query($q, false);
 286            $logged_user = $GLOBALS['db']->fetchByAssoc($result);
 287            if(isset($logged_user['id']) && $logged_user['id'] != null){
 288                 //do nothing
 289             $current_user->retrieve($logged_user['id']);
 290            }
 291            else{
 292                 echo "Not an admin user in users table. Please provide an admin user\n";
 293                 exit(1);
 294            }
 295         }
 296         else {
 297                 echo "*******************************************************************************\n";
 298                 echo "*** ERROR: 4th parameter must be a valid admin user.\n";
 299                 echo $usage;
 300                 echo "FAILURE\n";
 301                 exit(1);
 302         }
 303
 304 /////retrieve admin user
 305
 306
 307
 308
 309 $unzip_dir = clean_path("{$cwd}/{$sugar_config['upload_dir']}upgrades/temp");
 310 $install_file = clean_path("{$cwd}/{$sugar_config['upload_dir']}upgrades/patch/".basename($argv[1]));
 311
 312 if(!file_exists("{$sugar_config['upload_dir']}upgrades/patch"))
 313 {
 314         logThis("Create directory " . dirname($install_file), $path);
 315         mkdir_recursive("{$sugar_config['upload_dir']}upgrades/patch");
 316 }
 317
 318 $_SESSION['unzip_dir'] = $unzip_dir;
 319 $_SESSION['install_file'] = $install_file;
 320 $_SESSION['zip_from_dir'] = $zip_from_dir;
 321
 322 mkdir_recursive($unzip_dir);
 323 if(!is_dir($unzip_dir)) {
 324         fwrite(STDERR,"\n{$unzip_dir} is not an available directory\nFAILURE\n");
 325     exit(1);
 326 }
 327 unzip($argv[1], $unzip_dir);
 328 // mimic standard UW by copy patch zip to appropriate dir
 329 copy($argv[1], $install_file);
 330 ////    END UPGRADE PREP
 331 ///////////////////////////////////////////////////////////////////////////////
 332
 333
 334 if(function_exists('set_upgrade_vars')){
 335         set_upgrade_vars();
 336 }
 337
 338 /*
 339 if($configOptions['db_type'] == 'mysql'){
 340         //Change the db wait_timeout for this session
 341         $que ="select @@wait_timeout";
 342         $result = $db->query($que);
 343         $tb = $db->fetchByAssoc($result);
 344         logThis('Wait Timeout before change ***** '.$tb['@@wait_timeout'] , $path);
 345         $query ="set wait_timeout=28800";
 346         $db->query($query);
 347         $result = $db->query($que);
 348         $ta = $db->fetchByAssoc($result);
 349         logThis('Wait Timeout after change ***** '.$ta['@@wait_timeout'] , $path);
 350 }
 351 */
 352
 353 ///////////////////////////////////////////////////////////////////////////////
 354 ////    RUN SILENT UPGRADE
 355 ob_start();
 356 set_time_limit(0);
 357
 358 ///    RELOAD NEW DEFINITIONS
 359 global $ACLActions, $beanList, $beanFiles;
 360
 361 require_once('modules/Trackers/TrackerManager.php');
 362 $trackerManager = TrackerManager::getInstance();
 363 $trackerManager->pause();
 364 $trackerManager->unsetMonitors();
 365
 366 include('modules/ACLActions/actiondefs.php');
 367 include('include/modules.php');
 368
 369 // clear out the theme cache
 370 if(is_dir($GLOBALS['sugar_config']['cache_dir'].'themes')){
 371     $allModFiles = array();
 372     $allModFiles = findAllFiles($GLOBALS['sugar_config']['cache_dir'].'themes',$allModFiles);
 373     foreach($allModFiles as $file){
 374         //$file_md5_ref = str_replace(clean_path(getcwd()),'',$file);
 375         if(file_exists($file)){
 376             unlink($file);
 377         }
 378     }
 379 }
 380
 381 // re-minify the JS source files
 382 $_REQUEST['root_directory'] = getcwd();
 383 $_REQUEST['js_rebuild_concat'] = 'rebuild';
 384 require_once('jssource/minify.php');
 385
 386 //Add the cache cleaning here.
 387 if(function_exists('deleteCache'))
 388 {
 389         logThis('Call deleteCache', $path);
 390         @deleteCache();
 391 }
 392
 393 //First repair the databse to ensure it is up to date with the new vardefs/tabledefs
 394 logThis('About to repair the database.', $path);
 395 //Use Repair and rebuild to update the database.
 396 global $dictionary;
 397 require_once("modules/Administration/QuickRepairAndRebuild.php");
 398 $rac = new RepairAndClear();
 399 $rac->clearVardefs();
 400 $rac->rebuildExtensions();
 401 //bug: 44431 - defensive check to ensure the method exists since upgrades to 6.2.0 may not have this method define yet.
 402 if(method_exists($rac, 'clearExternalAPICache'))
 403 {
 404     $rac->clearExternalAPICache();
 405 }
 406
 407 $repairedTables = array();
 408 foreach ($beanFiles as $bean => $file) {
 409         if(file_exists($file)){
 410                 unset($GLOBALS['dictionary'][$bean]);
 411                 require_once($file);
 412                 $focus = new $bean ();
 413                 if(empty($focus->table_name) || isset($repairedTables[$focus->table_name])) {
 414                    continue;
 415                 }
 416
 417                 if (($focus instanceOf SugarBean)) {
 418                         if(!isset($repairedTables[$focus->table_name]))
 419                         {
 420                                 $sql = $GLOBALS['db']->repairTable($focus, true);
 421                                 logThis('Running sql:' . $sql, $path);
 422                                 $repairedTables[$focus->table_name] = true;
 423                         }
 424
 425                         //Check to see if we need to create the audit table
 426                     if($focus->is_AuditEnabled() && !$focus->db->tableExists($focus->get_audit_table_name())){
 427                logThis('Creating audit table:' . $focus->get_audit_table_name(), $path);
 428                        $focus->create_audit_table();
 429             }
 430                 }
 431         }
 432 }
 433
 434 unset ($dictionary);
 435 include ("{$argv[3]}/modules/TableDictionary.php");
 436 foreach ($dictionary as $meta) {
 437         $tablename = $meta['table'];
 438
 439         if(isset($repairedTables[$tablename])) {
 440            continue;
 441         }
 442
 443         $fielddefs = $meta['fields'];
 444         $indices = $meta['indices'];
 445         $sql = $GLOBALS['db']->repairTableParams($tablename, $fielddefs, $indices, true);
 446         if(!empty($sql)) {
 447             logThis($sql, $path);
 448             $repairedTables[$tablename] = true;
 449         }
 450
 451 }
 452
 453 logThis('database repaired', $path);
 454
 455 logThis('Start rebuild relationships.', $path);
 456 @rebuildRelations();
 457 logThis('End rebuild relationships.', $path);
 458
 459 include("{$cwd}/{$sugar_config['upload_dir']}upgrades/temp/manifest.php");
 460 $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');
 461 $origVersion = getSilentUpgradeVar('origVersion');
 462 if(!$origVersion){
 463     global $silent_upgrade_vars_loaded;
 464     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);
 465 }
 466
 467
 468 if($ce_to_pro_ent) {
 469         //add the global team if it does not exist
 470         $globalteam = new Team();
 471         $globalteam->retrieve('1');
 472         require_once('modules/Administration/language/en_us.lang.php');
 473         if(isset($globalteam->name)){
 474                 echo 'Global '.$mod_strings['LBL_UPGRADE_TEAM_EXISTS'].'<br>';
 475                 logThis(" Finish Building Global Team", $path);
 476         }else{
 477                 $globalteam->create_team("Global", $mod_strings['LBL_GLOBAL_TEAM_DESC'], $globalteam->global_team);
 478         }
 479
 480         logThis(" Start Building private teams", $path);
 481
 482     upgradeModulesForTeam();
 483     logThis(" Finish Building private teams", $path);
 484
 485     logThis(" Start Building the team_set and team_sets_teams", $path);
 486     upgradeModulesForTeamsets();
 487     logThis(" Finish Building the team_set and team_sets_teams", $path);
 488
 489         logThis(" Start modules/Administration/upgradeTeams.php", $path);
 490         include('modules/Administration/upgradeTeams.php');
 491         logThis(" Finish modules/Administration/upgradeTeams.php", $path);
 492
 493     if($sugar_config['dbconfig']['db_type'] == 'mssql') {
 494             if(check_FTS()){
 495                 $GLOBALS['db']->wakeupFTS();
 496             }
 497     }
 498 }
 499
 500
 501 if($origVersion < '620'){
 502         //bug: 39757 - upgrade the calls and meetings end_date to a datetime field
 503         upgradeDateTimeFields($path);
 504
 505         //upgrade the documents and meetings for lotus support
 506         upgradeDocumentTypeFields($path);
 507 }
 508
 509 //bug: 37214 - merge config_si.php settings if available
 510 logThis('Begin merge_config_si_settings', $path);
 511 merge_config_si_settings(true, '', '', $path);
 512 logThis('End merge_config_si_settings', $path);
 513
 514 //Upgrade connectors
 515 if($origVersion < '610' && function_exists('upgrade_connectors'))
 516 {
 517    upgrade_connectors($path);
 518 }
 519
 520 // Enable the InsideView connector by default
 521 if($origVersion < '621' && function_exists('upgradeEnableInsideViewConnector')) {
 522     logThis("Looks like we need to enable the InsideView connector\n",$path);
 523     upgradeEnableInsideViewConnector($path);
 524 }
 525
 526
 527
 528 //bug: 36845 - ability to provide global search support for custom modules
 529 if($origVersion < '620' && function_exists('add_unified_search_to_custom_modules_vardefs')){
 530    logThis('Add global search for custom modules start .', $path);
 531    add_unified_search_to_custom_modules_vardefs();
 532    logThis('Add global search for custom modules finished .', $path);
 533 }
 534
 535 //Upgrade system displayed tabs and subpanels
 536 if(function_exists('upgradeDisplayedTabsAndSubpanels'))
 537 {
 538         upgradeDisplayedTabsAndSubpanels($origVersion);
 539 }
 540
 541 //Unlink files that have been removed
 542 if(function_exists('unlinkUpgradeFiles'))
 543 {
 544         unlinkUpgradeFiles($origVersion);
 545 }
 546
 547 ///////////////////////////////////////////////////////////////////////////////
 548 ////    TAKE OUT TRASH
 549 if(empty($errors)) {
 550         set_upgrade_progress('end','in_progress','unlinkingfiles','in_progress');
 551         logThis('Taking out the trash, unlinking temp files.', $path);
 552         unlinkTempFiles(true);
 553         removeSilentUpgradeVarsCache();
 554         logThis('Taking out the trash, done.', $path);
 555 }
 556
 557 ///////////////////////////////////////////////////////////////////////////////
 558 ////    RECORD ERRORS
 559
 560 $phpErrors = ob_get_contents();
 561 ob_end_clean();
 562 logThis("**** Potential PHP generated error messages: {$phpErrors}", $path);
 563
 564 if(count($errors) > 0) {
 565         foreach($errors as $error) {
 566                 logThis("****** SilentUpgrade ERROR: {$error}", $path);
 567         }
 568         echo "FAILED\n";
 569 } else {
 570         logThis("***** SilentUpgrade completed successfully.", $path);
 571         echo "********************************************************************\n";
 572         echo "*************************** SUCCESS*********************************\n";
 573         echo "********************************************************************\n";
 574         echo "******** If your pre-upgrade Leads data is not showing  ************\n";
 575         echo "******** Or you see errors in detailview subpanels  ****************\n";
 576         echo "************* In order to resolve them  ****************************\n";
 577         echo "******** Log into application as Administrator  ********************\n";
 578         echo "******** Go to Admin panel  ****************************************\n";
 579         echo "******** Run Repair -> Rebuild Relationships  **********************\n";
 580         echo "********************************************************************\n";
 581 }
 582
 583
 584 ?>