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.4.7';
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);
95 public static function &incrementalPhpObject($version) {
96 static $incrementalPhpObject = [];
98 $versionParts = explode('.', $version);
99 $versionName = CRM_Utils_EnglishNumber
::toCamelCase($versionParts[0]) . CRM_Utils_EnglishNumber
::toCamelCase($versionParts[1]);
101 if (!array_key_exists($versionName, $incrementalPhpObject)) {
102 $className = "CRM_Upgrade_Incremental_php_{$versionName}";
103 $incrementalPhpObject[$versionName] = new $className();
105 return $incrementalPhpObject[$versionName];
114 public function checkVersionRelease($version, $release) {
115 $versionParts = explode('.', $version);
116 return ($versionParts[2] == $release);
120 * @param $constraints
124 public function checkSQLConstraints(&$constraints) {
126 foreach ($constraints as $constraint) {
127 if ($this->checkSQLConstraint($constraint)) {
133 return [$pass, $fail];
142 public function checkSQLConstraint($constraint) {
143 // check constraint here
148 * @param string $fileName
149 * @param bool $isQueryString
151 public function source($fileName, $isQueryString = FALSE) {
152 if ($isQueryString) {
153 CRM_Utils_File
::runSqlQuery($this->_config
->dsn
,
158 CRM_Utils_File
::sourceSQLFile($this->_config
->dsn
,
164 public function preProcess() {
165 CRM_Utils_System
::setTitle($this->getTitle());
166 if (!$this->verifyPreDBState($errorMessage)) {
167 if (!isset($errorMessage)) {
168 $errorMessage = 'pre-condition failed for current upgrade step';
170 throw new CRM_Core_Exception($errorMessage);
172 $this->assign('recentlyViewed', FALSE);
175 public function buildQuickForm() {
176 $this->addDefaultButtons($this->getButtonTitle(),
184 * Getter function for title. Should be over-ridden by derived class
192 public function getTitle() {
193 return ts('Title not Set');
199 public function getFieldsetTitle() {
206 public function getButtonTitle() {
207 return ts('Continue');
211 * Use the form name to create the tpl file name.
219 public function getTemplateFileName() {
220 $this->assign('title',
221 $this->getFieldsetTitle()
223 $this->assign('message',
224 $this->getTemplateMessage()
226 return 'CRM/Upgrade/Base.tpl';
229 public function postProcess() {
232 if (!$this->verifyPostDBState($errorMessage)) {
233 if (!isset($errorMessage)) {
234 $errorMessage = 'post-condition failed for current upgrade step';
236 throw new CRM_Core_Exception($errorMessage);
245 public function runQuery($query) {
246 return CRM_Core_DAO
::executeQuery($query);
254 public function setVersion($version) {
255 $this->logVersion($version);
258 UPDATE civicrm_domain
259 SET version = '$version'
261 return $this->runQuery($query);
269 public function logVersion($newVersion) {
271 $oldVersion = CRM_Core_BAO_Domain
::version();
273 $session = CRM_Core_Session
::singleton();
275 'entity_table' => 'civicrm_domain',
277 'data' => "upgrade:{$oldVersion}->{$newVersion}",
278 // lets skip 'modified_id' for now, as it causes FK issues And
279 // is not very important for now.
280 'modified_date' => date('YmdHis'),
282 CRM_Core_BAO_Log
::add($logParams);
294 public function checkVersion($version) {
295 $domainID = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Domain',
299 return (bool) $domainID;
306 public function getRevisionSequence() {
308 $sqlDir = implode(DIRECTORY_SEPARATOR
,
309 [dirname(__FILE__
), 'Incremental', 'sql']
311 $sqlFiles = scandir($sqlDir);
313 $sqlFilePattern = '/^((\d{1,2}\.\d{1,2})\.(\d{1,2}\.)?(\d{1,2}|\w{4,7}))\.(my)?sql(\.tpl)?$/i';
314 foreach ($sqlFiles as $file) {
315 if (preg_match($sqlFilePattern, $file, $matches)) {
316 if (!in_array($matches[1], $revList)) {
317 $revList[] = $matches[1];
322 usort($revList, 'version_compare');
332 public static function getRevisionPart($rev, $index = 1) {
333 $revPattern = '/^((\d{1,2})\.\d{1,2})\.(\d{1,2}|\w{4,7})?$/i';
334 preg_match($revPattern, $rev, $matches);
336 return array_key_exists($index, $matches) ?
$matches[$index] : NULL;
345 public function processLocales($tplFile, $rev) {
346 $smarty = CRM_Core_Smarty
::singleton();
347 $smarty->assign('domainID', CRM_Core_Config
::domainID());
349 $this->source($smarty->fetch($tplFile), TRUE);
351 if ($this->multilingual
) {
352 CRM_Core_I18n_Schema
::rebuildMultilingualSchema($this->locales
, $rev);
354 return $this->multilingual
;
360 public function setSchemaStructureTables($rev) {
361 if ($this->multilingual
) {
362 CRM_Core_I18n_Schema
::schemaStructureTables($rev, TRUE);
371 public function processSQL($rev) {
372 $sqlFile = implode(DIRECTORY_SEPARATOR
,
380 $tplFile = "$sqlFile.tpl";
382 if (file_exists($tplFile)) {
383 $this->processLocales($tplFile, $rev);
386 if (!file_exists($sqlFile)) {
387 throw new CRM_Core_Exception("sqlfile - $rev.mysql not found.");
389 $this->source($sqlFile);
394 * Determine the start and end version of the upgrade process.
396 * @return array(0=>$currentVer, 1=>$latestVer)
398 public function getUpgradeVersions() {
399 $latestVer = CRM_Utils_System
::version();
400 $currentVer = CRM_Core_BAO_Domain
::version(TRUE);
402 throw new CRM_Core_Exception(ts('Version information missing in civicrm database.'));
404 elseif (stripos($currentVer, 'upgrade')) {
405 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.'));
408 throw new CRM_Core_Exception(ts('Version information missing in civicrm codebase.'));
411 return [$currentVer, $latestVer];
415 * Determine if $currentVer can be upgraded to $latestVer
420 * @return mixed, a string error message or boolean 'false' if OK
422 public function checkUpgradeableVersion($currentVer, $latestVer) {
424 // since version is suppose to be in valid format at this point, especially after conversion ($convertVer),
425 // lets do a pattern check -
426 if (!CRM_Utils_System
::isVersionFormatValid($currentVer)) {
427 $error = ts('Database is marked with invalid version format. You may want to investigate this before you proceed further.');
429 elseif (version_compare($currentVer, $latestVer) > 0) {
430 // DB version number is higher than codebase being upgraded to. This is unexpected condition-fatal error.
431 $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.',
432 [1 => $currentVer, 2 => $latestVer]
435 elseif (version_compare($currentVer, $latestVer) == 0) {
436 $error = ts('Your database has already been upgraded to CiviCRM %1',
440 elseif (version_compare($currentVer, self
::MINIMUM_UPGRADABLE_VERSION
) < 0) {
441 $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.',
442 [1 => self
::MINIMUM_UPGRADABLE_VERSION
, 2 => $latestVer]
446 if (version_compare(phpversion(), CRM_Upgrade_Incremental_General
::MIN_INSTALL_PHP_VER
) < 0) {
447 $error = ts('CiviCRM %3 requires PHP version %1 (or newer), but the current system uses %2 ',
449 1 => CRM_Upgrade_Incremental_General
::MIN_INSTALL_PHP_VER
,
455 if (version_compare(CRM_Utils_SQL
::getDatabaseVersion(), CRM_Upgrade_Incremental_General
::MIN_INSTALL_MYSQL_VER
) < 0) {
456 $error = ts('CiviCRM %4 requires MySQL version v%1 or MariaDB v%3 (or newer), but the current system uses %2 ',
458 1 => CRM_Upgrade_Incremental_General
::MIN_INSTALL_MYSQL_VER
,
459 2 => CRM_Utils_SQL
::getDatabaseVersion(),
465 // check for mysql trigger privileges
466 if (!\Civi
::settings()->get('logging_no_trigger_permission') && !CRM_Core_DAO
::checkTriggerViewPermission(FALSE, TRUE)) {
467 $error = ts('CiviCRM %1 requires MySQL trigger privileges.',
471 if (CRM_Core_DAO
::getGlobalSetting('thread_stack', 0) < (1024 * self
::MINIMUM_THREAD_STACK
)) {
472 $error = ts('CiviCRM %1 requires MySQL thread stack >= %2k', [
474 2 => self
::MINIMUM_THREAD_STACK
,
482 * Determine if $currentver already matches $latestVer
487 * @return mixed, a string error message or boolean 'false' if OK
489 public function checkCurrentVersion($currentVer, $latestVer) {
492 // since version is suppose to be in valid format at this point, especially after conversion ($convertVer),
493 // lets do a pattern check -
494 if (!CRM_Utils_System
::isVersionFormatValid($currentVer)) {
495 $error = ts('Database is marked with invalid version format. You may want to investigate this before you proceed further.');
497 elseif (version_compare($currentVer, $latestVer) != 0) {
498 $error = ts('Your database is not configured for version %1',
506 * Fill the queue with upgrade tasks.
508 * @param string $currentVer
509 * the original revision.
510 * @param string $latestVer
511 * the target (final) revision.
512 * @param string $postUpgradeMessageFile
513 * path of a modifiable file which lists the post-upgrade messages.
515 * @return CRM_Queue_Service
517 public static function buildQueue($currentVer, $latestVer, $postUpgradeMessageFile) {
518 $upgrade = new CRM_Upgrade_Form();
520 // Ensure that queue can be created
521 if (!CRM_Queue_BAO_QueueItem
::findCreateTable()) {
522 throw new CRM_Core_Exception(ts('Failed to find or create queueing table'));
524 $queue = CRM_Queue_Service
::singleton()->create([
525 'name' => self
::QUEUE_NAME
,
530 $task = new CRM_Queue_Task(
531 ['CRM_Upgrade_Form', 'doFileCleanup'],
532 [$postUpgradeMessageFile],
535 $queue->createItem($task);
537 $task = new CRM_Queue_Task(
538 ['CRM_Upgrade_Form', 'disableOldExtensions'],
539 [$postUpgradeMessageFile],
540 "Checking extensions"
542 $queue->createItem($task);
544 $revisions = $upgrade->getRevisionSequence();
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);
581 * Find any old, orphaned files that should have been deleted.
583 * These files can get left behind, eg, if you use the Joomla
586 * The earlier we can do this, the better - don't want upgrade logic
587 * to inadvertently rely on old/relocated files.
589 * @param \CRM_Queue_TaskContext $ctx
590 * @param string $postUpgradeMessageFile
593 public static function doFileCleanup(CRM_Queue_TaskContext
$ctx, $postUpgradeMessageFile) {
594 $source = new CRM_Utils_Check_Component_Source();
595 $files = $source->findOrphanedFiles();
597 foreach ($files as $file) {
598 if (is_dir($file['path'])) {
599 @rmdir
($file['path']);
602 @unlink
($file['path']);
605 if (file_exists($file['path'])) {
606 $errors[] = sprintf("<li>%s</li>", htmlentities($file['path']));
610 if (!empty($errors)) {
611 file_put_contents($postUpgradeMessageFile,
612 '<br/><br/>' . ts('Some old files could not be removed. Please remove them.')
613 . '<ul>' . implode("\n", $errors) . '</ul>',
622 * Disable/uninstall any extensions not compatible with this new version.
624 * @param \CRM_Queue_TaskContext $ctx
625 * @param string $postUpgradeMessageFile
628 public static function disableOldExtensions(CRM_Queue_TaskContext
$ctx, $postUpgradeMessageFile) {
630 $manager = CRM_Extension_System
::singleton()->getManager();
631 foreach ($manager->getStatuses() as $key => $status) {
632 $obsolete = $manager->isIncompatible($key);
634 if (!empty($obsolete['disable']) && in_array($status, [$manager::STATUS_INSTALLED
, $manager::STATUS_INSTALLED_MISSING
])) {
636 $manager->disable($key);
637 // Update the status for the sake of uninstall below.
638 $status = $status == $manager::STATUS_INSTALLED ?
$manager::STATUS_DISABLED
: $manager::STATUS_DISABLED_MISSING
;
639 // This message is intentionally overwritten by uninstall below as it would be redundant
640 $messages[$key] = ts('The extension %1 is now obsolete and has been disabled.', [1 => $key]);
642 catch (CRM_Extension_Exception
$e) {
643 $messages[] = ts('The obsolete extension %1 could not be removed due to an error. It is recommended to remove this extension manually.', [1 => $key]);
646 if (!empty($obsolete['uninstall']) && in_array($status, [$manager::STATUS_DISABLED
, $manager::STATUS_DISABLED_MISSING
])) {
648 $manager->uninstall($key);
649 $messages[$key] = ts('The extension %1 is now obsolete and has been uninstalled.', [1 => $key]);
650 if ($status == $manager::STATUS_DISABLED
) {
651 $messages[$key] .= ' ' . ts('You can remove it from your extensions directory.');
654 catch (CRM_Extension_Exception
$e) {
655 $messages[] = ts('The obsolete extension %1 could not be removed due to an error. It is recommended to remove this extension manually.', [1 => $key]);
658 if (!empty($obsolete['force-uninstall'])) {
659 CRM_Core_DAO
::executeQuery('UPDATE civicrm_extension SET is_active = 0 WHERE full_name = %1', [
660 1 => [$key, 'String'],
666 file_put_contents($postUpgradeMessageFile,
667 '<br/><br/><ul><li>' . implode("</li>\n<li>", $messages) . '</li></ul>',
676 * Perform an incremental version update.
678 * @param CRM_Queue_TaskContext $ctx
680 * the target (intermediate) revision e.g '3.2.alpha1'.
684 public static function doIncrementalUpgradeStart(CRM_Queue_TaskContext
$ctx, $rev) {
685 $upgrade = new CRM_Upgrade_Form();
687 // as soon as we start doing anything we append ".upgrade" to version.
688 // this also helps detect any partial upgrade issues
689 $upgrade->setVersion($rev . '.upgrade');
695 * Perform an incremental version update.
697 * @param CRM_Queue_TaskContext $ctx
699 * the target (intermediate) revision e.g '3.2.alpha1'.
700 * @param string $originalVer
701 * the original revision.
702 * @param string $latestVer
703 * the target (final) revision.
704 * @param string $postUpgradeMessageFile
705 * path of a modifiable file which lists the post-upgrade messages.
709 public static function doIncrementalUpgradeStep(CRM_Queue_TaskContext
$ctx, $rev, $originalVer, $latestVer, $postUpgradeMessageFile) {
710 $upgrade = new CRM_Upgrade_Form();
712 $phpFunctionName = 'upgrade_' . str_replace('.', '_', $rev);
714 $versionObject = $upgrade->incrementalPhpObject($rev);
716 // pre-db check for major release.
717 if ($upgrade->checkVersionRelease($rev, 'alpha1')) {
718 if (!(is_callable([$versionObject, 'verifyPreDBstate']))) {
719 throw new CRM_Core_Exception("verifyPreDBstate method was not found for $rev");
723 if (!($versionObject->verifyPreDBstate($error))) {
724 if (!isset($error)) {
725 $error = "post-condition failed for current upgrade for $rev";
727 throw new CRM_Core_Exception($error);
732 $upgrade->setSchemaStructureTables($rev);
734 if (is_callable([$versionObject, $phpFunctionName])) {
735 $versionObject->$phpFunctionName($rev, $originalVer, $latestVer);
738 $upgrade->processSQL($rev);
741 // set post-upgrade-message if any
742 if (is_callable([$versionObject, 'setPostUpgradeMessage'])) {
743 $postUpgradeMessage = file_get_contents($postUpgradeMessageFile);
744 $versionObject->setPostUpgradeMessage($postUpgradeMessage, $rev);
745 file_put_contents($postUpgradeMessageFile, $postUpgradeMessage);
752 * Perform an incremental version update.
754 * @param CRM_Queue_TaskContext $ctx
756 * the target (intermediate) revision e.g '3.2.alpha1'.
757 * @param string $currentVer
758 * the original revision.
759 * @param string $latestVer
760 * the target (final) revision.
761 * @param string $postUpgradeMessageFile
762 * path of a modifiable file which lists the post-upgrade messages.
766 public static function doIncrementalUpgradeFinish(CRM_Queue_TaskContext
$ctx, $rev, $currentVer, $latestVer, $postUpgradeMessageFile) {
767 $upgrade = new CRM_Upgrade_Form();
768 $upgrade->setVersion($rev);
769 CRM_Utils_System
::flushCache();
771 $config = CRM_Core_Config
::singleton();
772 $config->userSystem
->flush();
776 public static function doFinish() {
777 Civi
::dispatcher()->setDispatchPolicy(\CRM_Upgrade_DispatchPolicy
::get('upgrade.finish'));
778 $restore = \CRM_Utils_AutoClean
::with(function() {
779 Civi
::dispatcher()->setDispatchPolicy(\CRM_Upgrade_DispatchPolicy
::get('upgrade.main'));
782 $upgrade = new CRM_Upgrade_Form();
783 list($ignore, $latestVer) = $upgrade->getUpgradeVersions();
784 // Seems extraneous in context, but we'll preserve old behavior
785 $upgrade->setVersion($latestVer);
787 CRM_Core_Invoke
::rebuildMenuAndCaches(FALSE, TRUE);
788 // NOTE: triggerRebuild is FALSE becaues it will run again in a moment (via fixSchemaDifferences).
790 $versionCheck = new CRM_Utils_VersionCheck();
791 $versionCheck->flushCache();
793 // Rebuild all triggers and re-enable logging if needed
794 $logging = new CRM_Logging_Schema();
795 $logging->fixSchemaDifferences();
799 * Compute any messages which should be displayed before upgrade
800 * by calling the 'setPreUpgradeMessage' on each incremental upgrade
803 * @param string $preUpgradeMessage
808 public function setPreUpgradeMessage(&$preUpgradeMessage, $currentVer, $latestVer) {
809 // check for changed message templates
810 CRM_Upgrade_Incremental_General
::checkMessageTemplate($preUpgradeMessage, $latestVer, $currentVer);
811 // set global messages
812 CRM_Upgrade_Incremental_General
::setPreUpgradeMessage($preUpgradeMessage, $currentVer, $latestVer);
814 // Scan through all php files and see if any file is interested in setting pre-upgrade-message
815 // based on $currentVer, $latestVer.
816 // Please note, at this point upgrade hasn't started executing queries.
817 $revisions = $this->getRevisionSequence();
818 foreach ($revisions as $rev) {
819 if (version_compare($currentVer, $rev) < 0) {
820 $versionObject = $this->incrementalPhpObject($rev);
821 CRM_Upgrade_Incremental_General
::updateMessageTemplate($preUpgradeMessage, $rev);
822 if (is_callable([$versionObject, 'setPreUpgradeMessage'])) {
823 $versionObject->setPreUpgradeMessage($preUpgradeMessage, $rev, $currentVer);