3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
13 * Class CRM_Upgrade_Form
15 class CRM_Upgrade_Form
extends CRM_Core_Form
{
16 const QUEUE_NAME
= 'CRM_Upgrade';
19 * Minimum size of MySQL's thread_stack option
21 * @see install/index.php MINIMUM_THREAD_STACK
23 const MINIMUM_THREAD_STACK
= 192;
26 * Minimum previous CiviCRM version we can directly upgrade from
28 const MINIMUM_UPGRADABLE_VERSION
= '4.5.9';
31 * @var \CRM_Core_Config
36 * Upgrade for multilingual.
40 public $multilingual = FALSE;
43 * Locales available for multilingual upgrade.
50 * Constructor for the basic form page.
52 * We should not use QuickForm directly. This class provides a lot
53 * of default convenient functions, rules and buttons
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).
61 * The name of the form if different from class name.
63 public function __construct(
65 $action = CRM_Core_Action
::NONE
,
69 $this->_config
= CRM_Core_Config
::singleton();
71 $locales = CRM_Core_I18n
::getMultilingual();
73 $this->multilingual
= (bool) $locales;
74 $this->locales
= $locales;
76 $smarty = CRM_Core_Smarty
::singleton();
77 //$smarty->compile_dir = $this->_config->templateCompileDir;
78 $smarty->assign('multilingual', $this->multilingual
);
79 $smarty->assign('locales', $this->locales
);
81 // we didn't call CRM_Core_BAO_ConfigSetting::retrieve(), so we need to set $dbLocale by hand
82 if ($this->multilingual
) {
84 $dbLocale = "_{$this->_config->lcMessages}";
87 parent
::__construct($state, $action, $method, $name);
91 * @param string $version
92 * Ex: '5.22' or '5.22.3'
94 * @return CRM_Upgrade_Incremental_Base
95 * Ex: CRM_Upgrade_Incremental_php_FiveTwentyTwo
97 public static function &incrementalPhpObject($version) {
98 static $incrementalPhpObject = [];
100 $versionParts = explode('.', $version);
101 $versionName = CRM_Utils_EnglishNumber
::toCamelCase($versionParts[0]) . CRM_Utils_EnglishNumber
::toCamelCase($versionParts[1]);
103 if (!array_key_exists($versionName, $incrementalPhpObject)) {
104 $className = "CRM_Upgrade_Incremental_php_{$versionName}";
105 $incrementalPhpObject[$versionName] = new $className();
107 return $incrementalPhpObject[$versionName];
112 * ex: ['5.13', '5.14', '5.15']
114 public static function incrementalPhpObjectVersions() {
117 $phpDir = implode(DIRECTORY_SEPARATOR
, [dirname(__FILE__
), 'Incremental', 'php']);
118 $phpFiles = glob("$phpDir/*.php");
119 foreach ($phpFiles as $phpFile) {
120 $phpWord = substr(basename($phpFile), 0, -4);
121 if (CRM_Utils_EnglishNumber
::isNumeric($phpWord)) {
122 /** @var \CRM_Upgrade_Incremental_Base $instance */
123 $className = 'CRM_Upgrade_Incremental_php_' . $phpWord;
124 $instance = new $className();
125 $versions[] = $instance->getMajorMinor();
129 usort($versions, 'version_compare');
139 public function checkVersionRelease($version, $release) {
140 $versionParts = explode('.', $version);
141 return ($versionParts[2] == $release);
145 * @param $constraints
149 public function checkSQLConstraints(&$constraints) {
151 foreach ($constraints as $constraint) {
152 if ($this->checkSQLConstraint($constraint)) {
158 return [$pass, $fail];
167 public function checkSQLConstraint($constraint) {
168 // check constraint here
173 * @param string $fileName
174 * @param bool $isQueryString
176 public function source($fileName, $isQueryString = FALSE) {
177 if ($isQueryString) {
178 CRM_Utils_File
::runSqlQuery($this->_config
->dsn
,
183 CRM_Utils_File
::sourceSQLFile($this->_config
->dsn
,
189 public function preProcess() {
190 $this->setTitle($this->getTitle());
191 if (!$this->verifyPreDBState($errorMessage)) {
192 if (!isset($errorMessage)) {
193 $errorMessage = 'pre-condition failed for current upgrade step';
195 throw new CRM_Core_Exception($errorMessage);
197 $this->assign('recentlyViewed', FALSE);
200 public function buildQuickForm() {
201 $this->addDefaultButtons($this->getButtonTitle(),
209 * Getter function for title. Should be over-ridden by derived class
217 public function getTitle() {
218 return ts('Title not Set');
224 public function getFieldsetTitle() {
231 public function getButtonTitle() {
232 return ts('Continue');
236 * Use the form name to create the tpl file name.
244 public function getTemplateFileName() {
245 $this->assign('title',
246 $this->getFieldsetTitle()
248 $this->assign('message',
249 $this->getTemplateMessage()
251 return 'CRM/Upgrade/Base.tpl';
254 public function postProcess() {
257 if (!$this->verifyPostDBState($errorMessage)) {
258 if (!isset($errorMessage)) {
259 $errorMessage = 'post-condition failed for current upgrade step';
261 throw new CRM_Core_Exception($errorMessage);
270 public function runQuery($query) {
271 return CRM_Core_DAO
::executeQuery($query);
279 public function setVersion($version) {
280 $this->logVersion($version);
283 UPDATE civicrm_domain
284 SET version = '$version'
286 return $this->runQuery($query);
294 public function logVersion($newVersion) {
296 $oldVersion = CRM_Core_BAO_Domain
::version();
298 $session = CRM_Core_Session
::singleton();
300 'entity_table' => 'civicrm_domain',
302 'data' => "upgrade:{$oldVersion}->{$newVersion}",
303 // lets skip 'modified_id' for now, as it causes FK issues And
304 // is not very important for now.
305 'modified_date' => date('YmdHis'),
307 CRM_Core_BAO_Log
::add($logParams);
315 * Get a list of all patch-versions that appear in upgrade steps, whether
316 * as *.mysql.tpl or as *.php.
321 public function getRevisionSequence() {
324 foreach (self
::incrementalPhpObjectVersions() as $majorMinor) {
325 $phpUpgrader = self
::incrementalPhpObject($majorMinor);
326 $revList = array_merge($revList, array_values($phpUpgrader->getRevisionSequence()));
329 usort($revList, 'version_compare');
339 public function processLocales($tplFile, $rev) {
340 $smarty = CRM_Core_Smarty
::singleton();
341 $smarty->assign('domainID', CRM_Core_Config
::domainID());
343 $this->source($smarty->fetch($tplFile), TRUE);
345 if ($this->multilingual
) {
346 CRM_Core_I18n_Schema
::rebuildMultilingualSchema($this->locales
, $rev);
348 return $this->multilingual
;
354 public function setSchemaStructureTables($rev) {
355 if ($this->multilingual
) {
356 CRM_Core_I18n_Schema
::schemaStructureTables($rev, TRUE);
365 public function processSQL($rev) {
366 $sqlFile = implode(DIRECTORY_SEPARATOR
,
374 $tplFile = "$sqlFile.tpl";
376 if (file_exists($tplFile)) {
377 $this->processLocales($tplFile, $rev);
380 if (!file_exists($sqlFile)) {
381 throw new CRM_Core_Exception("sqlfile - $rev.mysql not found.");
383 $this->source($sqlFile);
388 * Determine the start and end version of the upgrade process.
390 * @return array(0=>$currentVer, 1=>$latestVer)
392 public function getUpgradeVersions() {
393 $latestVer = CRM_Utils_System
::version();
394 $currentVer = CRM_Core_BAO_Domain
::version(TRUE);
396 throw new CRM_Core_Exception(ts('Version information missing in civicrm database.'));
398 elseif (stripos($currentVer, 'upgrade')) {
399 throw new CRM_Core_Exception(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.'));
402 throw new CRM_Core_Exception(ts('Version information missing in civicrm codebase.'));
405 return [$currentVer, $latestVer];
409 * Determine if $currentVer can be upgraded to $latestVer
414 * @return mixed, a string error message or boolean 'false' if OK
416 public function checkUpgradeableVersion($currentVer, $latestVer) {
418 // since version is suppose to be in valid format at this point, especially after conversion ($convertVer),
419 // lets do a pattern check -
420 if (!CRM_Utils_System
::isVersionFormatValid($currentVer)) {
421 $error = ts('Database is marked with invalid version format. You may want to investigate this before you proceed further.');
423 elseif (version_compare($currentVer, $latestVer) > 0) {
424 // DB version number is higher than codebase being upgraded to. This is unexpected condition-fatal error.
425 $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.',
426 [1 => $currentVer, 2 => $latestVer]
429 elseif (version_compare($currentVer, $latestVer) == 0) {
430 $error = ts('Your database has already been upgraded to CiviCRM %1',
434 elseif (version_compare($currentVer, self
::MINIMUM_UPGRADABLE_VERSION
) < 0) {
435 $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.',
436 [1 => self
::MINIMUM_UPGRADABLE_VERSION
, 2 => $latestVer]
440 if (version_compare(phpversion(), CRM_Upgrade_Incremental_General
::MIN_INSTALL_PHP_VER
) < 0) {
441 $error = ts('CiviCRM %3 requires PHP version %1 (or newer), but the current system uses %2 ',
443 1 => CRM_Upgrade_Incremental_General
::MIN_INSTALL_PHP_VER
,
449 if (version_compare(CRM_Utils_SQL
::getDatabaseVersion(), CRM_Upgrade_Incremental_General
::MIN_INSTALL_MYSQL_VER
) < 0) {
450 $error = ts('CiviCRM %4 requires MySQL version v%1 or MariaDB v%3 (or newer), but the current system uses %2 ',
452 1 => CRM_Upgrade_Incremental_General
::MIN_INSTALL_MYSQL_VER
,
453 2 => CRM_Utils_SQL
::getDatabaseVersion(),
459 // check for mysql trigger privileges
460 if (!\Civi
::settings()->get('logging_no_trigger_permission') && !CRM_Core_DAO
::checkTriggerViewPermission(FALSE, TRUE)) {
461 $error = ts('CiviCRM %1 requires MySQL trigger privileges.',
465 if (CRM_Core_DAO
::getGlobalSetting('thread_stack', 0) < (1024 * self
::MINIMUM_THREAD_STACK
)) {
466 $error = ts('CiviCRM %1 requires MySQL thread stack >= %2k', [
468 2 => self
::MINIMUM_THREAD_STACK
,
476 * Determine if $currentver already matches $latestVer
481 * @return mixed, a string error message or boolean 'false' if OK
483 public function checkCurrentVersion($currentVer, $latestVer) {
486 // since version is suppose to be in valid format at this point, especially after conversion ($convertVer),
487 // lets do a pattern check -
488 if (!CRM_Utils_System
::isVersionFormatValid($currentVer)) {
489 $error = ts('Database is marked with invalid version format. You may want to investigate this before you proceed further.');
491 elseif (version_compare($currentVer, $latestVer) != 0) {
492 $error = ts('Your database is not configured for version %1',
500 * Fill the queue with upgrade tasks.
502 * @param string $currentVer
503 * the original revision.
504 * @param string $latestVer
505 * the target (final) revision.
506 * @param string $postUpgradeMessageFile
507 * path of a modifiable file which lists the post-upgrade messages.
509 * @return CRM_Queue_Service
511 public static function buildQueue($currentVer, $latestVer, $postUpgradeMessageFile) {
512 $upgrade = new CRM_Upgrade_Form();
514 // Ensure that queue can be created
515 if (!CRM_Queue_BAO_QueueItem
::findCreateTable()) {
516 throw new CRM_Core_Exception(ts('Failed to find or create queueing table'));
518 $queue = CRM_Queue_Service
::singleton()->create([
519 'name' => self
::QUEUE_NAME
,
524 $task = new CRM_Queue_Task(
525 ['CRM_Upgrade_Form', 'doFileCleanup'],
526 [$postUpgradeMessageFile],
529 $queue->createItem($task);
531 $task = new CRM_Queue_Task(
532 ['CRM_Upgrade_Form', 'disableOldExtensions'],
533 [$postUpgradeMessageFile],
534 "Checking extensions"
536 $queue->createItem($task);
538 $revisions = $upgrade->getRevisionSequence();
539 $maxRevision = empty($revisions) ?
NULL : end($revisions);
541 if (version_compare($latestVer, $maxRevision, '<')) {
542 throw new CRM_Core_Exception("Malformed upgrade sequence. The incremental update $maxRevision exceeds target version $latestVer");
545 foreach ($revisions as $rev) {
546 // proceed only if $currentVer < $rev
547 if (version_compare($currentVer, $rev) < 0) {
548 $beginTask = new CRM_Queue_Task(
550 ['CRM_Upgrade_Form', 'doIncrementalUpgradeStart'],
553 "Begin Upgrade to $rev"
555 $queue->createItem($beginTask);
557 $task = new CRM_Queue_Task(
559 ['CRM_Upgrade_Form', 'doIncrementalUpgradeStep'],
561 [$rev, $currentVer, $latestVer, $postUpgradeMessageFile],
564 $queue->createItem($task);
566 $task = new CRM_Queue_Task(
568 ['CRM_Upgrade_Form', 'doIncrementalUpgradeFinish'],
570 [$rev, $currentVer, $latestVer, $postUpgradeMessageFile],
571 "Finish Upgrade DB to $rev"
573 $queue->createItem($task);
577 // It's possible that xml/version.xml points to a version that doesn't have any concrete revision steps.
578 if (!in_array($latestVer, $revisions)) {
579 $task = new CRM_Queue_Task(
580 ['CRM_Upgrade_Form', 'doIncrementalUpgradeFinish'],
581 [$rev, $latestVer, $latestVer, $postUpgradeMessageFile],
582 "Finish Upgrade DB to $latestVer"
584 $queue->createItem($task);
591 * Find any old, orphaned files that should have been deleted.
593 * These files can get left behind, eg, if you use the Joomla
596 * The earlier we can do this, the better - don't want upgrade logic
597 * to inadvertently rely on old/relocated files.
599 * @param \CRM_Queue_TaskContext $ctx
600 * @param string $postUpgradeMessageFile
603 public static function doFileCleanup(CRM_Queue_TaskContext
$ctx, $postUpgradeMessageFile) {
604 $source = new CRM_Utils_Check_Component_Source();
605 $files = $source->findOrphanedFiles();
607 foreach ($files as $file) {
608 if (is_dir($file['path'])) {
609 @rmdir
($file['path']);
612 @unlink
($file['path']);
615 if (file_exists($file['path'])) {
616 $errors[] = sprintf("<li>%s</li>", htmlentities($file['path']));
620 if (!empty($errors)) {
621 file_put_contents($postUpgradeMessageFile,
622 '<br/><br/>' . ts('Some old files could not be removed. Please remove them.')
623 . '<ul>' . implode("\n", $errors) . '</ul>',
632 * Disable/uninstall any extensions not compatible with this new version.
634 * @param \CRM_Queue_TaskContext $ctx
635 * @param string $postUpgradeMessageFile
638 public static function disableOldExtensions(CRM_Queue_TaskContext
$ctx, $postUpgradeMessageFile) {
640 $manager = CRM_Extension_System
::singleton()->getManager();
641 foreach ($manager->getStatuses() as $key => $status) {
642 $enableReplacement = CRM_Core_DAO
::singleValueQuery('SELECT is_active FROM civicrm_extension WHERE full_name = %1', [1 => [$key, 'String']]);
643 $obsolete = $manager->isIncompatible($key);
645 if (!empty($obsolete['disable']) && in_array($status, [$manager::STATUS_INSTALLED
, $manager::STATUS_INSTALLED_MISSING
])) {
647 $manager->disable($key);
648 // Update the status for the sake of uninstall below.
649 $status = $status == $manager::STATUS_INSTALLED ?
$manager::STATUS_DISABLED
: $manager::STATUS_DISABLED_MISSING
;
650 // This message is intentionally overwritten by uninstall below as it would be redundant
651 $messages[$key] = ts('The extension %1 is now obsolete and has been disabled.', [1 => $key]);
653 catch (CRM_Extension_Exception
$e) {
654 $messages[] = ts('The obsolete extension %1 could not be removed due to an error. It is recommended to remove this extension manually.', [1 => $key]);
657 if (!empty($obsolete['uninstall']) && in_array($status, [$manager::STATUS_DISABLED
, $manager::STATUS_DISABLED_MISSING
])) {
659 $manager->uninstall($key);
660 $messages[$key] = ts('The extension %1 is now obsolete and has been uninstalled.', [1 => $key]);
661 if ($status == $manager::STATUS_DISABLED
) {
662 $messages[$key] .= ' ' . ts('You can remove it from your extensions directory.');
665 catch (CRM_Extension_Exception
$e) {
666 $messages[] = ts('The obsolete extension %1 could not be removed due to an error. It is recommended to remove this extension manually.', [1 => $key]);
669 if (!empty($obsolete['force-uninstall'])) {
670 CRM_Core_DAO
::executeQuery('UPDATE civicrm_extension SET is_active = 0 WHERE full_name = %1', [
671 1 => [$key, 'String'],
674 if (!empty($obsolete['replacement']) && $enableReplacement) {
676 $manager->enable($manager->install($obsolete['replacement']));
677 $messages[] = ts('A replacement extension %1 has been installed as you had the obsolete extension %2 installed', [1 => $obsolete['replacement'], 2 => $key]);
679 catch (CRM_Extension_Exception
$e) {
680 $messages[] = ts('The replacement extension %1 could not be installed due to an error. It is recommended to enable this extension manually.', [1 => $obsolete['replacement']]);
686 file_put_contents($postUpgradeMessageFile,
687 '<br/><br/><ul><li>' . implode("</li>\n<li>", $messages) . '</li></ul>',
696 * Perform an incremental version update.
698 * @param CRM_Queue_TaskContext $ctx
700 * the target (intermediate) revision e.g '3.2.alpha1'.
704 public static function doIncrementalUpgradeStart(CRM_Queue_TaskContext
$ctx, $rev) {
705 $upgrade = new CRM_Upgrade_Form();
707 // as soon as we start doing anything we append ".upgrade" to version.
708 // this also helps detect any partial upgrade issues
709 $upgrade->setVersion($rev . '.upgrade');
715 * Perform an incremental version update.
717 * @param CRM_Queue_TaskContext $ctx
719 * the target (intermediate) revision e.g '3.2.alpha1'.
720 * @param string $originalVer
721 * the original revision.
722 * @param string $latestVer
723 * the target (final) revision.
724 * @param string $postUpgradeMessageFile
725 * path of a modifiable file which lists the post-upgrade messages.
729 public static function doIncrementalUpgradeStep(CRM_Queue_TaskContext
$ctx, $rev, $originalVer, $latestVer, $postUpgradeMessageFile) {
730 $upgrade = new CRM_Upgrade_Form();
732 $phpFunctionName = 'upgrade_' . str_replace('.', '_', $rev);
734 $versionObject = $upgrade->incrementalPhpObject($rev);
736 // pre-db check for major release.
737 if ($upgrade->checkVersionRelease($rev, 'alpha1')) {
738 if (!(is_callable([$versionObject, 'verifyPreDBstate']))) {
739 throw new CRM_Core_Exception("verifyPreDBstate method was not found for $rev");
743 if (!($versionObject->verifyPreDBstate($error))) {
744 if (!isset($error)) {
745 $error = "post-condition failed for current upgrade for $rev";
747 throw new CRM_Core_Exception($error);
752 $upgrade->setSchemaStructureTables($rev);
754 if (is_callable([$versionObject, $phpFunctionName])) {
755 $versionObject->$phpFunctionName($rev, $originalVer, $latestVer);
758 $upgrade->processSQL($rev);
761 // set post-upgrade-message if any
762 if (is_callable([$versionObject, 'setPostUpgradeMessage'])) {
763 $postUpgradeMessage = file_get_contents($postUpgradeMessageFile);
764 $versionObject->setPostUpgradeMessage($postUpgradeMessage, $rev);
765 file_put_contents($postUpgradeMessageFile, $postUpgradeMessage);
772 * Mark an incremental update as finished.
774 * This method may be called in two cases:
776 * - After performing each incremental update (`X.X.X.mysql.tpl` or `upgrade_X_X_X()`)
777 * - If needed, one more time at the end of the upgrade for the final version-number.
779 * @param CRM_Queue_TaskContext $ctx
781 * the target (intermediate) revision e.g '3.2.alpha1'.
782 * @param string $currentVer
783 * the original revision.
784 * @param string $latestVer
785 * the target (final) revision.
786 * @param string $postUpgradeMessageFile
787 * path of a modifiable file which lists the post-upgrade messages.
791 public static function doIncrementalUpgradeFinish(CRM_Queue_TaskContext
$ctx, $rev, $currentVer, $latestVer, $postUpgradeMessageFile) {
792 $upgrade = new CRM_Upgrade_Form();
793 $upgrade->setVersion($rev);
794 CRM_Utils_System
::flushCache();
799 public static function doFinish() {
800 Civi
::dispatcher()->setDispatchPolicy(\CRM_Upgrade_DispatchPolicy
::get('upgrade.finish'));
801 $restore = \CRM_Utils_AutoClean
::with(function() {
802 Civi
::dispatcher()->setDispatchPolicy(\CRM_Upgrade_DispatchPolicy
::get('upgrade.main'));
805 $upgrade = new CRM_Upgrade_Form();
806 list($ignore, $latestVer) = $upgrade->getUpgradeVersions();
807 // Seems extraneous in context, but we'll preserve old behavior
808 $upgrade->setVersion($latestVer);
810 $config = CRM_Core_Config
::singleton();
811 $config->userSystem
->flush();
813 CRM_Core_Invoke
::rebuildMenuAndCaches(FALSE, TRUE);
814 // NOTE: triggerRebuild is FALSE becaues it will run again in a moment (via fixSchemaDifferences).
816 $versionCheck = new CRM_Utils_VersionCheck();
817 $versionCheck->flushCache();
819 // Rebuild all triggers and re-enable logging if needed
820 $logging = new CRM_Logging_Schema();
821 $logging->fixSchemaDifferences();
822 // Force a rebuild of CiviCRM asset cache in case things have changed.
823 \Civi
::service('asset_builder')->clear(FALSE);
827 * Compute any messages which should be displayed before upgrade
828 * by calling the 'setPreUpgradeMessage' on each incremental upgrade
831 * @param string $preUpgradeMessage
836 public function setPreUpgradeMessage(&$preUpgradeMessage, $currentVer, $latestVer) {
837 // check for changed message templates
838 CRM_Upgrade_Incremental_General
::checkMessageTemplate($preUpgradeMessage, $latestVer, $currentVer);
839 // set global messages
840 CRM_Upgrade_Incremental_General
::setPreUpgradeMessage($preUpgradeMessage, $currentVer, $latestVer);
842 // Scan through all php files and see if any file is interested in setting pre-upgrade-message
843 // based on $currentVer, $latestVer.
844 // Please note, at this point upgrade hasn't started executing queries.
845 $revisions = $this->getRevisionSequence();
846 foreach ($revisions as $rev) {
847 if (version_compare($currentVer, $rev) < 0) {
848 $versionObject = $this->incrementalPhpObject($rev);
849 CRM_Upgrade_Incremental_General
::updateMessageTemplate($preUpgradeMessage, $rev);
850 if (is_callable([$versionObject, 'setPreUpgradeMessage'])) {
851 $versionObject->setPreUpgradeMessage($preUpgradeMessage, $rev, $currentVer);