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 +--------------------------------------------------------------------+
12 use Civi\Core\SettingsBag
;
15 * Base class for incremental upgrades
17 class CRM_Upgrade_Incremental_Base
{
18 const BATCH_SIZE
= 5000;
23 protected $majorMinor;
26 * Get the major and minor version for this class (based on English-style class name).
31 public function getMajorMinor() {
32 if (!$this->majorMinor
) {
33 $className = explode('_', static::CLASS);
34 $numbers = preg_split("/([[:upper:]][[:lower:]]+)/", array_pop($className), -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY
);
35 $major = CRM_Utils_EnglishNumber
::toInt(array_shift($numbers));
36 $minor = CRM_Utils_EnglishNumber
::toInt(implode('', $numbers));
37 $this->majorMinor
= $major . '.' . $minor;
39 return $this->majorMinor
;
43 * Get a list of revisions (PATCH releases) related to this class.
46 * Ex: ['4.5.6', '4.5.7']
47 * @throws \ReflectionException
49 public function getRevisionSequence() {
52 $sqlGlob = implode(DIRECTORY_SEPARATOR
, [dirname(__FILE__
), 'sql', $this->getMajorMinor() . '.*.mysql.tpl']);
53 $sqlFiles = glob($sqlGlob);;
54 foreach ($sqlFiles as $file) {
55 $revList[] = str_replace('.mysql.tpl', '', basename($file));
58 $c = new ReflectionClass(static::class);
59 foreach ($c->getMethods() as $method) {
60 /** @var \ReflectionMethod $method */
61 if (preg_match(';^upgrade_([0-9_alphabeta]+)$;', $method->getName(), $m)) {
62 $revList[] = str_replace('_', '.', $m[1]);
66 $revList = array_unique($revList);
67 usort($revList, 'version_compare');
78 public function verifyPreDBstate(&$errors) {
83 * Compute any messages which should be displayed before upgrade.
85 * Note: This function is called iteratively for each upcoming
86 * revision to the database.
88 * @param $preUpgradeMessage
90 * a version number, e.g. '4.8.alpha1', '4.8.beta3', '4.8.0'.
91 * @param null $currentVer
93 public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
97 * Compute any messages which should be displayed after upgrade.
99 * @param string $postUpgradeMessage
102 * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
104 public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
108 * (Queue Task Callback)
110 * @param \CRM_Queue_TaskContext $ctx
115 public static function runSql(CRM_Queue_TaskContext
$ctx, $rev) {
116 $upgrade = new CRM_Upgrade_Form();
117 $upgrade->processSQL($rev);
123 * Syntactic sugar for adding a task.
125 * Task is (a) in this class and (b) has a high priority.
127 * After passing the $funcName, you can also pass parameters that will go to
128 * the function. Note that all params must be serializable.
130 * @param string $title
131 * @param string $funcName
133 protected function addTask($title, $funcName) {
134 $queue = CRM_Queue_Service
::singleton()->load([
136 'name' => CRM_Upgrade_Form
::QUEUE_NAME
,
139 $args = func_get_args();
140 $title = array_shift($args);
141 $funcName = array_shift($args);
142 $task = new CRM_Queue_Task(
143 [get_class($this), $funcName],
147 $queue->createItem($task, ['weight' => -1]);
151 * Remove a payment processor if not in use
153 * @param CRM_Queue_TaskContext $ctx
154 * @param string $name
156 * @throws \CiviCRM_API3_Exception
158 public static function removePaymentProcessorType(CRM_Queue_TaskContext
$ctx, $name) {
159 $processors = civicrm_api3('PaymentProcessor', 'getcount', ['payment_processor_type_id' => $name]);
160 if (empty($processors['result'])) {
161 $result = civicrm_api3('PaymentProcessorType', 'get', [
165 if (!empty($result['id'])) {
166 civicrm_api3('PaymentProcessorType', 'delete', ['id' => $result['id']]);
173 * @param string $table_name
174 * @param string $constraint_name
177 public static function checkFKExists($table_name, $constraint_name) {
178 return CRM_Core_BAO_SchemaHandler
::checkFKExists($table_name, $constraint_name);
182 * Add a column to a table if it doesn't already exist
184 * @param CRM_Queue_TaskContext $ctx
185 * @param string $table
186 * @param string $column
187 * @param string $properties
188 * @param bool $localizable is this a field that should be localized
189 * @param string|null $version CiviCRM version to use if rebuilding multilingual schema
190 * @param bool $triggerRebuild should we trigger the rebuild of the multilingual schema
194 public static function addColumn($ctx, $table, $column, $properties, $localizable = FALSE, $version = NULL, $triggerRebuild = TRUE) {
195 $locales = CRM_Core_I18n
::getMultilingual();
197 if (!CRM_Core_BAO_SchemaHandler
::checkIfFieldExists($table, $column, FALSE)) {
200 foreach ($locales as $locale) {
201 if (!CRM_Core_BAO_SchemaHandler
::checkIfFieldExists($table, "{$column}_{$locale}", FALSE)) {
202 $queries[] = "ALTER TABLE `$table` ADD COLUMN `{$column}_{$locale}` $properties";
207 $queries[] = "ALTER TABLE `$table` ADD COLUMN `$column` $properties";
211 $queries[] = "ALTER TABLE `$table` ADD COLUMN `$column` $properties";
213 foreach ($queries as $query) {
214 CRM_Core_DAO
::executeQuery($query, [], TRUE, NULL, FALSE, FALSE);
217 if ($locales && $triggerRebuild) {
218 CRM_Core_I18n_Schema
::rebuildMultilingualSchema($locales, $version, TRUE);
224 * Add the specified option group, gracefully if it already exists.
226 * @param CRM_Queue_TaskContext $ctx
227 * @param array $params
228 * @param array $options
232 public static function addOptionGroup(CRM_Queue_TaskContext
$ctx, $params, $options): bool {
233 $defaults = ['is_active' => 1];
234 $optionDefaults = ['is_active' => 1];
235 $optionDefaults['option_group_id'] = \CRM_Core_BAO_OptionGroup
::ensureOptionGroupExists(array_merge($defaults, $params));
237 foreach ($options as $option) {
238 \CRM_Core_BAO_OptionValue
::ensureOptionValueExists(array_merge($optionDefaults, $option));
244 * Do any relevant message template updates.
246 * @param CRM_Queue_TaskContext $ctx
247 * @param string $version
249 public static function updateMessageTemplates($ctx, $version) {
250 $messageTemplateObject = new CRM_Upgrade_Incremental_MessageTemplates($version);
251 $messageTemplateObject->updateTemplates();
255 * Updated a message token within a template.
257 * @param CRM_Queue_TaskContext $ctx
258 * @param string $workflowName
265 public static function updateMessageToken($ctx, string $workflowName, string $old, string $new, $version):bool {
266 $messageObj = new CRM_Upgrade_Incremental_MessageTemplates($version);
267 if (!empty($workflowName)) {
268 $messageObj->replaceTokenInTemplate($workflowName, $old, $new);
271 $messageObj->replaceTokenInMessageTemplates($old, $new);
277 * Updated a message token within a scheduled reminder.
279 * @param CRM_Queue_TaskContext $ctx
286 public static function updateActionScheduleToken($ctx, string $old, string $new, $version):bool {
287 $messageObj = new CRM_Upgrade_Incremental_MessageTemplates($version);
288 $messageObj->replaceTokenInActionSchedule($old, $new);
293 * Updated a message token within a label.
295 * @param CRM_Queue_TaskContext $ctx
302 public static function updatePrintLabelToken($ctx, string $old, string $new, $version):bool {
303 $messageObj = new CRM_Upgrade_Incremental_MessageTemplates($version);
304 $messageObj->replaceTokenInPrintLabel($old, $new);
309 * Updated a message token within greeting options.
311 * @param CRM_Queue_TaskContext $ctx
318 public static function updateGreetingOptions($ctx, string $old, string $new, $version):bool {
319 $messageObj = new CRM_Upgrade_Incremental_MessageTemplates($version);
320 $messageObj->replaceTokenInGreetingOptions($old, $new);
325 * Updated a currency in civicrm_currency and related configurations
327 * @param CRM_Queue_TaskContext $ctx
328 * @param string $old_name
329 * @param string $new_name
333 public static function updateCurrencyName($ctx, string $old_name, string $new_name): bool {
334 CRM_Core_DAO
::executeQuery('UPDATE civicrm_currency SET name = %1 WHERE name = %2', [
335 1 => [$new_name, 'String'],
336 2 => [$old_name, 'String'],
339 $oid = CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_option_group WHERE name = 'currencies_enabled'");
341 CRM_Core_DAO
::executeQuery('UPDATE civicrm_option_value SET value = %1 WHERE value = %2 AND option_group_id = %3', [
342 1 => [$new_name, 'String'],
343 2 => [$old_name, 'String'],
344 3 => [$oid, 'String'],
348 CRM_Core_DAO
::executeQuery('UPDATE civicrm_participant SET fee_currency = %1 WHERE fee_currency = %2', [
349 1 => [$new_name, 'String'],
350 2 => [$old_name, 'String'],
354 'civicrm_contribution',
355 'civicrm_contribution_page',
356 'civicrm_contribution_recur',
357 'civicrm_contribution_soft',
359 'civicrm_financial_item',
360 'civicrm_financial_trxn',
363 'civicrm_pledge_payment',
368 foreach ($tables as $table) {
369 CRM_Core_DAO
::executeQuery('UPDATE %3 SET currency = %1 WHERE currency = %2', [
370 1 => [$new_name, 'String'],
371 2 => [$old_name, 'String'],
372 3 => [$table, 'MysqlColumnNameOrAlias'],
380 * Re-save any valid values from contribute settings into the normal setting
383 * We render the array of contribution_invoice_settings and any that have
384 * metadata defined we add to the correct key. This is safe to run even if no
385 * settings are to be converted, per the test in
386 * testConvertUpgradeContributeSettings.
392 public static function updateContributeSettings($ctx) {
393 // Use a direct query as api now does some handling on this.
394 $settings = CRM_Core_DAO
::executeQuery("SELECT value, domain_id FROM civicrm_setting WHERE name = 'contribution_invoice_settings'");
396 while ($settings->fetch()) {
397 $contributionSettings = (array) CRM_Utils_String
::unserialize($settings->value
);
398 foreach (array_merge(SettingsBag
::getContributionInvoiceSettingKeys(), ['deferred_revenue_enabled' => 'deferred_revenue_enabled']) as $possibleKeyName => $settingName) {
399 if (!empty($contributionSettings[$possibleKeyName]) && empty(Civi
::settings($settings->domain_id
)->getExplicit($settingName))) {
400 Civi
::settings($settings->domain_id
)->set($settingName, $contributionSettings[$possibleKeyName]);
408 * Do any relevant smart group updates.
410 * @param CRM_Queue_TaskContext $ctx
411 * @param array $actions
415 public static function updateSmartGroups($ctx, $actions) {
416 $groupUpdateObject = new CRM_Upgrade_Incremental_SmartGroups();
417 $groupUpdateObject->updateGroups($actions);
422 * Drop a column from a table if it exist.
424 * @param CRM_Queue_TaskContext $ctx
425 * @param string $table
426 * @param string $column
429 public static function dropColumn($ctx, $table, $column) {
430 if (CRM_Core_BAO_SchemaHandler
::checkIfFieldExists($table, $column)) {
431 CRM_Core_DAO
::executeQuery("ALTER TABLE `$table` DROP COLUMN `$column`",
432 [], TRUE, NULL, FALSE, FALSE);
438 * Add a index to a table column.
440 * @param CRM_Queue_TaskContext $ctx
441 * @param string $table
442 * @param string|array $columns
443 * @param string $prefix
446 public static function addIndex($ctx, $table, $columns, $prefix = 'index') {
447 $tables = [$table => (array) $columns];
448 CRM_Core_BAO_SchemaHandler
::createIndexes($tables, $prefix);
454 * Drop a index from a table if it exist.
456 * @param CRM_Queue_TaskContext $ctx
457 * @param string $table
458 * @param string $indexName
461 public static function dropIndex($ctx, $table, $indexName) {
462 CRM_Core_BAO_SchemaHandler
::dropIndexIfExists($table, $indexName);
468 * Drop a table... but only if it's empty.
470 * @param CRM_Queue_TaskContext $ctx
471 * @param string $table
474 public static function dropTableIfEmpty($ctx, $table) {
475 if (CRM_Core_DAO
::checkTableExists($table)) {
476 if (!CRM_Core_DAO
::checkTableHasData($table)) {
477 CRM_Core_BAO_SchemaHandler
::dropTable($table);
480 $ctx->log
->warning("dropTableIfEmpty($table): Found data. Preserved table.");
488 * Rebuild Multilingual Schema.
489 * @param CRM_Queue_TaskContext $ctx
490 * @param string|null $version CiviCRM version to use if rebuilding multilingual schema
494 public static function rebuildMultilingalSchema($ctx, $version = NULL) {
495 $locales = CRM_Core_I18n
::getMultilingual();
497 CRM_Core_I18n_Schema
::rebuildMultilingualSchema($locales, $version);