CRM/Upgrade/Form.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * Class CRM_Upgrade_Form
  14  */
  15 class CRM_Upgrade_Form extends CRM_Core_Form {
  16   const QUEUE_NAME = 'CRM_Upgrade';
  17
  18   /**
  19    * Minimum size of MySQL's thread_stack option
  20    *
  21    * @see install/index.php MINIMUM_THREAD_STACK
  22    */
  23   const MINIMUM_THREAD_STACK = 192;
  24
  25   /**
  26    * Minimum previous CiviCRM version we can directly upgrade from
  27    */
  28   const MINIMUM_UPGRADABLE_VERSION = '4.2.9';
  29
  30   /**
  31    * @var \CRM_Core_Config
  32    */
  33   protected $_config;
  34
  35   /**
  36    * Upgrade for multilingual.
  37    *
  38    * @var bool
  39    */
  40   public $multilingual = FALSE;
  41
  42   /**
  43    * Locales available for multilingual upgrade.
  44    *
  45    * @var array
  46    */
  47   public $locales;
  48
  49   /**
  50    * Constructor for the basic form page.
  51    *
  52    * We should not use QuickForm directly. This class provides a lot
  53    * of default convenient functions, rules and buttons
  54    *
  55    * @param object $state
  56    *   State associated with this form.
  57    * @param const|\enum|int $action The mode the form is operating in (None/Create/View/Update/Delete)
  58    * @param string $method
  59    *   The type of http method used (GET/POST).
  60    * @param string $name
  61    *   The name of the form if different from class name.
  62    */
  63   public function __construct(
  64     $state = NULL,
  65     $action = CRM_Core_Action::NONE,
  66     $method = 'post',
  67     $name = NULL
  68   ) {
  69     $this->_config = CRM_Core_Config::singleton();
  70
  71     $domain = new CRM_Core_DAO_Domain();
  72     $domain->find(TRUE);
  73
  74     $this->multilingual = (bool) $domain->locales;
  75     $this->locales = explode(CRM_Core_DAO::VALUE_SEPARATOR, $domain->locales);
  76
  77     $smarty = CRM_Core_Smarty::singleton();
  78     //$smarty->compile_dir = $this->_config->templateCompileDir;
  79     $smarty->assign('multilingual', $this->multilingual);
  80     $smarty->assign('locales', $this->locales);
  81
  82     // we didn't call CRM_Core_BAO_ConfigSetting::retrieve(), so we need to set $dbLocale by hand
  83     if ($this->multilingual) {
  84       global $dbLocale;
  85       $dbLocale = "_{$this->_config->lcMessages}";
  86     }
  87
  88     parent::__construct($state, $action, $method, $name);
  89   }
  90
  91   /**
  92    * @param $version
  93    *
  94    * @return mixed
  95    */
  96   public static function &incrementalPhpObject($version) {
  97     static $incrementalPhpObject = [];
  98
  99     $versionParts = explode('.', $version);
 100     $versionName = CRM_Utils_EnglishNumber::toCamelCase($versionParts[0]) . CRM_Utils_EnglishNumber::toCamelCase($versionParts[1]);
 101
 102     if (!array_key_exists($versionName, $incrementalPhpObject)) {
 103       $className = "CRM_Upgrade_Incremental_php_{$versionName}";
 104       $incrementalPhpObject[$versionName] = new $className();
 105     }
 106     return $incrementalPhpObject[$versionName];
 107   }
 108
 109   /**
 110    * @param $version
 111    * @param $release
 112    *
 113    * @return bool
 114    */
 115   public function checkVersionRelease($version, $release) {
 116     $versionParts = explode('.', $version);
 117     return ($versionParts[2] == $release);
 118   }
 119
 120   /**
 121    * @param $constraints
 122    *
 123    * @return array
 124    */
 125   public function checkSQLConstraints(&$constraints) {
 126     $pass = $fail = 0;
 127     foreach ($constraints as $constraint) {
 128       if ($this->checkSQLConstraint($constraint)) {
 129         $pass++;
 130       }
 131       else {
 132         $fail++;
 133       }
 134       return [$pass, $fail];
 135     }
 136   }
 137
 138   /**
 139    * @param $constraint
 140    *
 141    * @return bool
 142    */
 143   public function checkSQLConstraint($constraint) {
 144     // check constraint here
 145     return TRUE;
 146   }
 147
 148   /**
 149    * @param string $fileName
 150    * @param bool $isQueryString
 151    */
 152   public function source($fileName, $isQueryString = FALSE) {
 153     if ($isQueryString) {
 154       CRM_Utils_File::runSqlQuery($this->_config->dsn,
 155         $fileName, NULL
 156       );
 157     }
 158     else {
 159       CRM_Utils_File::sourceSQLFile($this->_config->dsn,
 160         $fileName, NULL
 161       );
 162     }
 163   }
 164
 165   public function preProcess() {
 166     CRM_Utils_System::setTitle($this->getTitle());
 167     if (!$this->verifyPreDBState($errorMessage)) {
 168       if (!isset($errorMessage)) {
 169         $errorMessage = 'pre-condition failed for current upgrade step';
 170       }
 171       CRM_Core_Error::fatal($errorMessage);
 172     }
 173     $this->assign('recentlyViewed', FALSE);
 174   }
 175
 176   public function buildQuickForm() {
 177     $this->addDefaultButtons($this->getButtonTitle(),
 178       'next',
 179       NULL,
 180       TRUE
 181     );
 182   }
 183
 184   /**
 185    * Getter function for title. Should be over-ridden by derived class
 186    *
 187    * @return string
 188    */
 189
 190   /**
 191    * @return string
 192    */
 193   public function getTitle() {
 194     return ts('Title not Set');
 195   }
 196
 197   /**
 198    * @return string
 199    */
 200   public function getFieldsetTitle() {
 201     return '';
 202   }
 203
 204   /**
 205    * @return string
 206    */
 207   public function getButtonTitle() {
 208     return ts('Continue');
 209   }
 210
 211   /**
 212    * Use the form name to create the tpl file name.
 213    *
 214    * @return string
 215    */
 216
 217   /**
 218    * @return string
 219    */
 220   public function getTemplateFileName() {
 221     $this->assign('title',
 222       $this->getFieldsetTitle()
 223     );
 224     $this->assign('message',
 225       $this->getTemplateMessage()
 226     );
 227     return 'CRM/Upgrade/Base.tpl';
 228   }
 229
 230   public function postProcess() {
 231     $this->upgrade();
 232
 233     if (!$this->verifyPostDBState($errorMessage)) {
 234       if (!isset($errorMessage)) {
 235         $errorMessage = 'post-condition failed for current upgrade step';
 236       }
 237       CRM_Core_Error::fatal($errorMessage);
 238     }
 239   }
 240
 241   /**
 242    * @param $query
 243    *
 244    * @return Object
 245    */
 246   public function runQuery($query) {
 247     return CRM_Core_DAO::executeQuery($query);
 248   }
 249
 250   /**
 251    * @param $version
 252    *
 253    * @return Object
 254    */
 255   public function setVersion($version) {
 256     $this->logVersion($version);
 257
 258     $query = "
 259 UPDATE civicrm_domain
 260 SET    version = '$version'
 261 ";
 262     return $this->runQuery($query);
 263   }
 264
 265   /**
 266    * @param $newVersion
 267    *
 268    * @return bool
 269    */
 270   public function logVersion($newVersion) {
 271     if ($newVersion) {
 272       $oldVersion = CRM_Core_BAO_Domain::version();
 273
 274       $session = CRM_Core_Session::singleton();
 275       $logParams = [
 276         'entity_table' => 'civicrm_domain',
 277         'entity_id' => 1,
 278         'data' => "upgrade:{$oldVersion}->{$newVersion}",
 279         // lets skip 'modified_id' for now, as it causes FK issues And
 280         // is not very important for now.
 281         'modified_date' => date('YmdHis'),
 282       ];
 283       CRM_Core_BAO_Log::add($logParams);
 284       return TRUE;
 285     }
 286
 287     return FALSE;
 288   }
 289
 290   /**
 291    * @param $version
 292    *
 293    * @return bool
 294    */
 295   public function checkVersion($version) {
 296     $domainID = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Domain',
 297       $version, 'id',
 298       'version'
 299     );
 300     return (bool) $domainID;
 301   }
 302
 303   /**
 304    * @return array
 305    * @throws Exception
 306    */
 307   public function getRevisionSequence() {
 308     $revList = [];
 309     $sqlDir = implode(DIRECTORY_SEPARATOR,
 310       [dirname(__FILE__), 'Incremental', 'sql']
 311     );
 312     $sqlFiles = scandir($sqlDir);
 313
 314     $sqlFilePattern = '/^((\d{1,2}\.\d{1,2})\.(\d{1,2}\.)?(\d{1,2}|\w{4,7}))\.(my)?sql(\.tpl)?$/i';
 315     foreach ($sqlFiles as $file) {
 316       if (preg_match($sqlFilePattern, $file, $matches)) {
 317         if (!in_array($matches[1], $revList)) {
 318           $revList[] = $matches[1];
 319         }
 320       }
 321     }
 322
 323     usort($revList, 'version_compare');
 324     return $revList;
 325   }
 326
 327   /**
 328    * @param $rev
 329    * @param int $index
 330    *
 331    * @return null
 332    */
 333   public static function getRevisionPart($rev, $index = 1) {
 334     $revPattern = '/^((\d{1,2})\.\d{1,2})\.(\d{1,2}|\w{4,7})?$/i';
 335     preg_match($revPattern, $rev, $matches);
 336
 337     return array_key_exists($index, $matches) ? $matches[$index] : NULL;
 338   }
 339
 340   /**
 341    * @param $tplFile
 342    * @param $rev
 343    *
 344    * @return bool
 345    */
 346   public function processLocales($tplFile, $rev) {
 347     $smarty = CRM_Core_Smarty::singleton();
 348     $smarty->assign('domainID', CRM_Core_Config::domainID());
 349
 350     $this->source($smarty->fetch($tplFile), TRUE);
 351
 352     if ($this->multilingual) {
 353       CRM_Core_I18n_Schema::rebuildMultilingualSchema($this->locales, $rev);
 354     }
 355     return $this->multilingual;
 356   }
 357
 358   /**
 359    * @param $rev
 360    */
 361   public function setSchemaStructureTables($rev) {
 362     if ($this->multilingual) {
 363       CRM_Core_I18n_Schema::schemaStructureTables($rev, TRUE);
 364     }
 365   }
 366
 367   /**
 368    * @param $rev
 369    *
 370    * @throws Exception
 371    */
 372   public function processSQL($rev) {
 373     $sqlFile = implode(DIRECTORY_SEPARATOR,
 374       [
 375         dirname(__FILE__),
 376         'Incremental',
 377         'sql',
 378         $rev . '.mysql',
 379       ]
 380     );
 381     $tplFile = "$sqlFile.tpl";
 382
 383     if (file_exists($tplFile)) {
 384       $this->processLocales($tplFile, $rev);
 385     }
 386     else {
 387       if (!file_exists($sqlFile)) {
 388         CRM_Core_Error::fatal("sqlfile - $rev.mysql not found.");
 389       }
 390       $this->source($sqlFile);
 391     }
 392   }
 393
 394   /**
 395    * Determine the start and end version of the upgrade process.
 396    *
 397    * @return array(0=>$currentVer, 1=>$latestVer)
 398    */
 399   public function getUpgradeVersions() {
 400     $latestVer = CRM_Utils_System::version();
 401     $currentVer = CRM_Core_BAO_Domain::version(TRUE);
 402     if (!$currentVer) {
 403       CRM_Core_Error::fatal(ts('Version information missing in civicrm database.'));
 404     }
 405     elseif (stripos($currentVer, 'upgrade')) {
 406       CRM_Core_Error::fatal(ts('Database check failed - the database looks to have been partially upgraded. You may want to reload the database with the backup and try the upgrade process again.'));
 407     }
 408     if (!$latestVer) {
 409       CRM_Core_Error::fatal(ts('Version information missing in civicrm codebase.'));
 410     }
 411
 412     return [$currentVer, $latestVer];
 413   }
 414
 415   /**
 416    * Determine if $currentVer can be upgraded to $latestVer
 417    *
 418    * @param $currentVer
 419    * @param $latestVer
 420    *
 421    * @return mixed, a string error message or boolean 'false' if OK
 422    */
 423   public function checkUpgradeableVersion($currentVer, $latestVer) {
 424     $error = FALSE;
 425     // since version is suppose to be in valid format at this point, especially after conversion ($convertVer),
 426     // lets do a pattern check -
 427     if (!CRM_Utils_System::isVersionFormatValid($currentVer)) {
 428       $error = ts('Database is marked with invalid version format. You may want to investigate this before you proceed further.');
 429     }
 430     elseif (version_compare($currentVer, $latestVer) > 0) {
 431       // DB version number is higher than codebase being upgraded to. This is unexpected condition-fatal error.
 432       $error = ts('Your database is marked with an unexpected version number: %1. The automated upgrade to version %2 can not be run - and the %2 codebase may not be compatible with your database state. You will need to determine the correct version corresponding to your current database state. You may want to revert to the codebase you were using prior to beginning this upgrade until you resolve this problem.',
 433         [1 => $currentVer, 2 => $latestVer]
 434       );
 435     }
 436     elseif (version_compare($currentVer, $latestVer) == 0) {
 437       $error = ts('Your database has already been upgraded to CiviCRM %1',
 438         [1 => $latestVer]
 439       );
 440     }
 441     elseif (version_compare($currentVer, self::MINIMUM_UPGRADABLE_VERSION) < 0) {
 442       $error = ts('CiviCRM versions prior to %1 cannot be upgraded directly to %2. This upgrade will need to be done in stages. First download an intermediate version (the LTS may be a good choice) and upgrade to that before proceeding to this version.',
 443         [1 => self::MINIMUM_UPGRADABLE_VERSION, 2 => $latestVer]
 444       );
 445     }
 446
 447     if (version_compare(phpversion(), CRM_Upgrade_Incremental_General::MIN_INSTALL_PHP_VER) < 0) {
 448       $error = ts('CiviCRM %3 requires PHP version %1 (or newer), but the current system uses %2 ',
 449         [
 450           1 => CRM_Upgrade_Incremental_General::MIN_INSTALL_PHP_VER,
 451           2 => phpversion(),
 452           3 => $latestVer,
 453         ]);
 454     }
 455
 456     // check for mysql trigger privileges
 457     if (!\Civi::settings()->get('logging_no_trigger_permission') && !CRM_Core_DAO::checkTriggerViewPermission(FALSE, TRUE)) {
 458       $error = ts('CiviCRM %1 requires MySQL trigger privileges.',
 459         [1 => $latestVer]);
 460     }
 461
 462     if (CRM_Core_DAO::getGlobalSetting('thread_stack', 0) < (1024 * self::MINIMUM_THREAD_STACK)) {
 463       $error = ts('CiviCRM %1 requires MySQL thread stack >= %2k', [
 464         1 => $latestVer,
 465         2 => self::MINIMUM_THREAD_STACK,
 466       ]);
 467     }
 468
 469     return $error;
 470   }
 471
 472   /**
 473    * Determine if $currentver already matches $latestVer
 474    *
 475    * @param $currentVer
 476    * @param $latestVer
 477    *
 478    * @return mixed, a string error message or boolean 'false' if OK
 479    */
 480   public function checkCurrentVersion($currentVer, $latestVer) {
 481     $error = FALSE;
 482
 483     // since version is suppose to be in valid format at this point, especially after conversion ($convertVer),
 484     // lets do a pattern check -
 485     if (!CRM_Utils_System::isVersionFormatValid($currentVer)) {
 486       $error = ts('Database is marked with invalid version format. You may want to investigate this before you proceed further.');
 487     }
 488     elseif (version_compare($currentVer, $latestVer) != 0) {
 489       $error = ts('Your database is not configured for version %1',
 490         [1 => $latestVer]
 491       );
 492     }
 493     return $error;
 494   }
 495
 496   /**
 497    * Fill the queue with upgrade tasks.
 498    *
 499    * @param string $currentVer
 500    *   the original revision.
 501    * @param string $latestVer
 502    *   the target (final) revision.
 503    * @param string $postUpgradeMessageFile
 504    *   path of a modifiable file which lists the post-upgrade messages.
 505    *
 506    * @return CRM_Queue_Service
 507    */
 508   public static function buildQueue($currentVer, $latestVer, $postUpgradeMessageFile) {
 509     $upgrade = new CRM_Upgrade_Form();
 510
 511     // Ensure that queue can be created
 512     if (!CRM_Queue_BAO_QueueItem::findCreateTable()) {
 513       CRM_Core_Error::fatal(ts('Failed to find or create queueing table'));
 514     }
 515     $queue = CRM_Queue_Service::singleton()->create([
 516       'name' => self::QUEUE_NAME,
 517       'type' => 'Sql',
 518       'reset' => TRUE,
 519     ]);
 520
 521     $task = new CRM_Queue_Task(
 522       ['CRM_Upgrade_Form', 'doFileCleanup'],
 523       [$postUpgradeMessageFile],
 524       "Cleanup old files"
 525     );
 526     $queue->createItem($task);
 527
 528     $task = new CRM_Queue_Task(
 529       ['CRM_Upgrade_Form', 'disableOldExtensions'],
 530       [$postUpgradeMessageFile],
 531       "Checking extensions"
 532     );
 533     $queue->createItem($task);
 534
 535     $revisions = $upgrade->getRevisionSequence();
 536     foreach ($revisions as $rev) {
 537       // proceed only if $currentVer < $rev
 538       if (version_compare($currentVer, $rev) < 0) {
 539         $beginTask = new CRM_Queue_Task(
 540         // callback
 541           ['CRM_Upgrade_Form', 'doIncrementalUpgradeStart'],
 542           // arguments
 543           [$rev],
 544           "Begin Upgrade to $rev"
 545         );
 546         $queue->createItem($beginTask);
 547
 548         $task = new CRM_Queue_Task(
 549         // callback
 550           ['CRM_Upgrade_Form', 'doIncrementalUpgradeStep'],
 551           // arguments
 552           [$rev, $currentVer, $latestVer, $postUpgradeMessageFile],
 553           "Upgrade DB to $rev"
 554         );
 555         $queue->createItem($task);
 556
 557         $task = new CRM_Queue_Task(
 558         // callback
 559           ['CRM_Upgrade_Form', 'doIncrementalUpgradeFinish'],
 560           // arguments
 561           [$rev, $currentVer, $latestVer, $postUpgradeMessageFile],
 562           "Finish Upgrade DB to $rev"
 563         );
 564         $queue->createItem($task);
 565       }
 566     }
 567
 568     return $queue;
 569   }
 570
 571   /**
 572    * Find any old, orphaned files that should have been deleted.
 573    *
 574    * These files can get left behind, eg, if you use the Joomla
 575    * upgrade procedure.
 576    *
 577    * The earlier we can do this, the better - don't want upgrade logic
 578    * to inadvertently rely on old/relocated files.
 579    *
 580    * @param \CRM_Queue_TaskContext $ctx
 581    * @param string $postUpgradeMessageFile
 582    * @return bool
 583    */
 584   public static function doFileCleanup(CRM_Queue_TaskContext $ctx, $postUpgradeMessageFile) {
 585     $source = new CRM_Utils_Check_Component_Source();
 586     $files = $source->findOrphanedFiles();
 587     $errors = [];
 588     foreach ($files as $file) {
 589       if (is_dir($file['path'])) {
 590         @rmdir($file['path']);
 591       }
 592       else {
 593         @unlink($file['path']);
 594       }
 595
 596       if (file_exists($file['path'])) {
 597         $errors[] = sprintf("<li>%s</li>", htmlentities($file['path']));
 598       }
 599     }
 600
 601     if (!empty($errors)) {
 602       file_put_contents($postUpgradeMessageFile,
 603         '<br/><br/>' . ts('Some old files could not be removed. Please remove them.')
 604         . '<ul>' . implode("\n", $errors) . '</ul>',
 605         FILE_APPEND
 606       );
 607     }
 608
 609     return TRUE;
 610   }
 611
 612   /**
 613    * Disable/uninstall any extensions not compatible with this new version.
 614    *
 615    * @param \CRM_Queue_TaskContext $ctx
 616    * @param string $postUpgradeMessageFile
 617    * @return bool
 618    */
 619   public static function disableOldExtensions(CRM_Queue_TaskContext $ctx, $postUpgradeMessageFile) {
 620     $messages = [];
 621     $manager = CRM_Extension_System::singleton()->getManager();
 622     foreach ($manager->getStatuses() as $key => $status) {
 623       $obsolete = $manager->isIncompatible($key);
 624       if ($obsolete) {
 625         if (!empty($obsolete['disable']) && in_array($status, [$manager::STATUS_INSTALLED, $manager::STATUS_INSTALLED_MISSING])) {
 626           try {
 627             $manager->disable($key);
 628             // Update the status for the sake of uninstall below.
 629             $status = $status == $manager::STATUS_INSTALLED ? $manager::STATUS_DISABLED : $manager::STATUS_DISABLED_MISSING;
 630             // This message is intentionally overwritten by uninstall below as it would be redundant
 631             $messages[$key] = ts('The extension %1 is now obsolete and has been disabled.', [1 => $key]);
 632           }
 633           catch (CRM_Extension_Exception $e) {
 634             $messages[] = ts('The obsolete extension %1 could not be removed due to an error. It is recommended to remove this extension manually.', [1 => $key]);
 635           }
 636         }
 637         if (!empty($obsolete['uninstall']) && in_array($status, [$manager::STATUS_DISABLED, $manager::STATUS_DISABLED_MISSING])) {
 638           try {
 639             $manager->uninstall($key);
 640             $messages[$key] = ts('The extension %1 is now obsolete and has been uninstalled.', [1 => $key]);
 641             if ($status == $manager::STATUS_DISABLED) {
 642               $messages[$key] .= ' ' . ts('You can remove it from your extensions directory.');
 643             }
 644           }
 645           catch (CRM_Extension_Exception $e) {
 646             $messages[] = ts('The obsolete extension %1 could not be removed due to an error. It is recommended to remove this extension manually.', [1 => $key]);
 647           }
 648         }
 649         if (!empty($obsolete['force-uninstall'])) {
 650           CRM_Core_DAO::executeQuery('UPDATE civicrm_extension SET is_active = 0 WHERE full_name = %1', [
 651             1 => [$key, 'String'],
 652           ]);
 653         }
 654       }
 655     }
 656     if ($messages) {
 657       file_put_contents($postUpgradeMessageFile,
 658         '<br/><br/><ul><li>' . implode("</li>\n<li>", $messages) . '</li></ul>',
 659         FILE_APPEND
 660       );
 661     }
 662
 663     return TRUE;
 664   }
 665
 666   /**
 667    * Perform an incremental version update.
 668    *
 669    * @param CRM_Queue_TaskContext $ctx
 670    * @param string $rev
 671    *   the target (intermediate) revision e.g '3.2.alpha1'.
 672    *
 673    * @return bool
 674    */
 675   public static function doIncrementalUpgradeStart(CRM_Queue_TaskContext $ctx, $rev) {
 676     $upgrade = new CRM_Upgrade_Form();
 677
 678     // as soon as we start doing anything we append ".upgrade" to version.
 679     // this also helps detect any partial upgrade issues
 680     $upgrade->setVersion($rev . '.upgrade');
 681
 682     return TRUE;
 683   }
 684
 685   /**
 686    * Perform an incremental version update.
 687    *
 688    * @param CRM_Queue_TaskContext $ctx
 689    * @param string $rev
 690    *   the target (intermediate) revision e.g '3.2.alpha1'.
 691    * @param string $originalVer
 692    *   the original revision.
 693    * @param string $latestVer
 694    *   the target (final) revision.
 695    * @param string $postUpgradeMessageFile
 696    *   path of a modifiable file which lists the post-upgrade messages.
 697    *
 698    * @return bool
 699    */
 700   public static function doIncrementalUpgradeStep(CRM_Queue_TaskContext $ctx, $rev, $originalVer, $latestVer, $postUpgradeMessageFile) {
 701     $upgrade = new CRM_Upgrade_Form();
 702
 703     $phpFunctionName = 'upgrade_' . str_replace('.', '_', $rev);
 704
 705     $versionObject = $upgrade->incrementalPhpObject($rev);
 706
 707     // pre-db check for major release.
 708     if ($upgrade->checkVersionRelease($rev, 'alpha1')) {
 709       if (!(is_callable([$versionObject, 'verifyPreDBstate']))) {
 710         CRM_Core_Error::fatal("verifyPreDBstate method was not found for $rev");
 711       }
 712
 713       $error = NULL;
 714       if (!($versionObject->verifyPreDBstate($error))) {
 715         if (!isset($error)) {
 716           $error = "post-condition failed for current upgrade for $rev";
 717         }
 718         CRM_Core_Error::fatal($error);
 719       }
 720
 721     }
 722
 723     $upgrade->setSchemaStructureTables($rev);
 724
 725     if (is_callable([$versionObject, $phpFunctionName])) {
 726       $versionObject->$phpFunctionName($rev, $originalVer, $latestVer);
 727     }
 728     else {
 729       $upgrade->processSQL($rev);
 730     }
 731
 732     // set post-upgrade-message if any
 733     if (is_callable([$versionObject, 'setPostUpgradeMessage'])) {
 734       $postUpgradeMessage = file_get_contents($postUpgradeMessageFile);
 735       $versionObject->setPostUpgradeMessage($postUpgradeMessage, $rev);
 736       file_put_contents($postUpgradeMessageFile, $postUpgradeMessage);
 737     }
 738
 739     return TRUE;
 740   }
 741
 742   /**
 743    * Perform an incremental version update.
 744    *
 745    * @param CRM_Queue_TaskContext $ctx
 746    * @param string $rev
 747    *   the target (intermediate) revision e.g '3.2.alpha1'.
 748    * @param string $currentVer
 749    *   the original revision.
 750    * @param string $latestVer
 751    *   the target (final) revision.
 752    * @param string $postUpgradeMessageFile
 753    *   path of a modifiable file which lists the post-upgrade messages.
 754    *
 755    * @return bool
 756    */
 757   public static function doIncrementalUpgradeFinish(CRM_Queue_TaskContext $ctx, $rev, $currentVer, $latestVer, $postUpgradeMessageFile) {
 758     $upgrade = new CRM_Upgrade_Form();
 759     $upgrade->setVersion($rev);
 760     CRM_Utils_System::flushCache();
 761
 762     $config = CRM_Core_Config::singleton();
 763     $config->userSystem->flush();
 764     return TRUE;
 765   }
 766
 767   public static function doFinish() {
 768     Civi::dispatcher()->setDispatchPolicy(\CRM_Upgrade_DispatchPolicy::get('upgrade.finish'));
 769     $restore = \CRM_Utils_AutoClean::with(function() {
 770       Civi::dispatcher()->setDispatchPolicy(\CRM_Upgrade_DispatchPolicy::get('upgrade.main'));
 771     });
 772
 773     $upgrade = new CRM_Upgrade_Form();
 774     list($ignore, $latestVer) = $upgrade->getUpgradeVersions();
 775     // Seems extraneous in context, but we'll preserve old behavior
 776     $upgrade->setVersion($latestVer);
 777
 778     CRM_Core_Invoke::rebuildMenuAndCaches(FALSE, TRUE);
 779     // NOTE: triggerRebuild is FALSE becaues it will run again in a moment (via fixSchemaDifferences).
 780
 781     $versionCheck = new CRM_Utils_VersionCheck();
 782     $versionCheck->flushCache();
 783
 784     // Rebuild all triggers and re-enable logging if needed
 785     $logging = new CRM_Logging_Schema();
 786     $logging->fixSchemaDifferences();
 787   }
 788
 789   /**
 790    * Compute any messages which should be displayed before upgrade
 791    * by calling the 'setPreUpgradeMessage' on each incremental upgrade
 792    * object.
 793    *
 794    * @param string $preUpgradeMessage
 795    *   alterable.
 796    * @param $currentVer
 797    * @param $latestVer
 798    */
 799   public function setPreUpgradeMessage(&$preUpgradeMessage, $currentVer, $latestVer) {
 800     // check for changed message templates
 801     CRM_Upgrade_Incremental_General::checkMessageTemplate($preUpgradeMessage, $latestVer, $currentVer);
 802     // set global messages
 803     CRM_Upgrade_Incremental_General::setPreUpgradeMessage($preUpgradeMessage, $currentVer, $latestVer);
 804
 805     // Scan through all php files and see if any file is interested in setting pre-upgrade-message
 806     // based on $currentVer, $latestVer.
 807     // Please note, at this point upgrade hasn't started executing queries.
 808     $revisions = $this->getRevisionSequence();
 809     foreach ($revisions as $rev) {
 810       if (version_compare($currentVer, $rev) < 0) {
 811         $versionObject = $this->incrementalPhpObject($rev);
 812         CRM_Upgrade_Incremental_General::updateMessageTemplate($preUpgradeMessage, $rev);
 813         if (is_callable([$versionObject, 'setPreUpgradeMessage'])) {
 814           $versionObject->setPreUpgradeMessage($preUpgradeMessage, $rev, $currentVer);
 815         }
 816       }
 817     }
 818   }
 819
 820 }