[civicrm-core.git] / CRM / Upgrade / Incremental / Base.php

<?php
/*
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC. All rights reserved.                        |
 |                                                                    |
 | This work is published under the GNU AGPLv3 license with some      |
 | permitted exceptions and without any warranty. For full license    |
 | and copyright information, see https://civicrm.org/licensing       |
 +--------------------------------------------------------------------+
 */

use Civi\Core\SettingsBag;

/**
 * Base class for incremental upgrades
 */
class CRM_Upgrade_Incremental_Base {
  const BATCH_SIZE = 5000;

  /**
   * @var string|null
   */
  protected $majorMinor;

  /**
   * Get the major and minor version for this class (based on English-style class name).
   *
   * @return string
   *   Ex: '5.34' or '4.7'
   */
  public function getMajorMinor() {
    if (!$this->majorMinor) {
      $className = explode('_', static::CLASS);
      $numbers = preg_split("/([[:upper:]][[:lower:]]+)/", array_pop($className), -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
      $major = CRM_Utils_EnglishNumber::toInt(array_shift($numbers));
      $minor = CRM_Utils_EnglishNumber::toInt(implode('', $numbers));
      $this->majorMinor = $major . '.' . $minor;
    }
    return $this->majorMinor;
  }

  /**
   * Get a list of revisions (PATCH releases) related to this class.
   *
   * @return array
   *   Ex: ['4.5.6', '4.5.7']
   * @throws \ReflectionException
   */
  public function getRevisionSequence() {
    $revList = [];

    $sqlGlob = implode(DIRECTORY_SEPARATOR, [dirname(__FILE__), 'sql', $this->getMajorMinor() . '.*.mysql.tpl']);
    $sqlFiles = glob($sqlGlob);;
    foreach ($sqlFiles as $file) {
      $revList[] = str_replace('.mysql.tpl', '', basename($file));
    }

    $c = new ReflectionClass(static::class);
    foreach ($c->getMethods() as $method) {
      /** @var \ReflectionMethod $method */
      if (preg_match(';^upgrade_([0-9_alphabeta]+)$;', $method->getName(), $m)) {
        $revList[] = str_replace('_', '.', $m[1]);
      }
    }

    $revList = array_unique($revList);
    usort($revList, 'version_compare');
    return $revList;
  }

  /**
   * Verify DB state.
   *
   * @param $errors
   *
   * @return bool
   */
  public function verifyPreDBstate(&$errors) {
    return TRUE;
  }

  /**
   * Compute any messages which should be displayed before upgrade.
   *
   * Note: This function is called iteratively for each upcoming
   * revision to the database.
   *
   * @param $preUpgradeMessage
   * @param string $rev
   *   a version number, e.g. '4.8.alpha1', '4.8.beta3', '4.8.0'.
   * @param null $currentVer
   */
  public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
  }

  /**
   * Compute any messages which should be displayed after upgrade.
   *
   * @param string $postUpgradeMessage
   *   alterable.
   * @param string $rev
   *   an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
   */
  public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
  }

  /**
   * (Queue Task Callback)
   *
   * @param \CRM_Queue_TaskContext $ctx
   * @param string $rev
   *
   * @return bool
   */
  public static function runSql(CRM_Queue_TaskContext $ctx, $rev) {
    $upgrade = new CRM_Upgrade_Form();
    $upgrade->processSQL($rev);

    return TRUE;
  }

  /**
   * Syntactic sugar for adding a task.
   *
   * Task is (a) in this class and (b) has a high priority.
   *
   * After passing the $funcName, you can also pass parameters that will go to
   * the function. Note that all params must be serializable.
   *
   * @param string $title
   * @param string $funcName
   */
  protected function addTask($title, $funcName) {
    $queue = CRM_Queue_Service::singleton()->load([
      'type' => 'Sql',
      'name' => CRM_Upgrade_Form::QUEUE_NAME,
    ]);

    $args = func_get_args();
    $title = array_shift($args);
    $funcName = array_shift($args);
    $task = new CRM_Queue_Task(
      [get_class($this), $funcName],
      $args,
      $title
    );
    $queue->createItem($task, ['weight' => -1]);
  }

  /**
   * Remove a payment processor if not in use
   *
   * @param CRM_Queue_TaskContext $ctx
   * @param string $name
   * @return bool
   * @throws \CiviCRM_API3_Exception
   */
  public static function removePaymentProcessorType(CRM_Queue_TaskContext $ctx, $name) {
    $processors = civicrm_api3('PaymentProcessor', 'getcount', ['payment_processor_type_id' => $name]);
    if (empty($processors['result'])) {
      $result = civicrm_api3('PaymentProcessorType', 'get', [
        'name' => $name,
        'return' => 'id',
      ]);
      if (!empty($result['id'])) {
        civicrm_api3('PaymentProcessorType', 'delete', ['id' => $result['id']]);
      }
    }
    return TRUE;
  }

  /**
   * @param string $table_name
   * @param string $constraint_name
   * @return bool
   */
  public static function checkFKExists($table_name, $constraint_name) {
    return CRM_Core_BAO_SchemaHandler::checkFKExists($table_name, $constraint_name);
  }

  /**
   * Add a column to a table if it doesn't already exist
   *
   * @param CRM_Queue_TaskContext $ctx
   * @param string $table
   * @param string $column
   * @param string $properties
   * @param bool $localizable is this a field that should be localized
   * @param string|null $version CiviCRM version to use if rebuilding multilingual schema
   * @param bool $triggerRebuild should we trigger the rebuild of the multilingual schema
   *
   * @return bool
   */
  public static function addColumn($ctx, $table, $column, $properties, $localizable = FALSE, $version = NULL, $triggerRebuild = TRUE) {
    $locales = CRM_Core_I18n::getMultilingual();
    $queries = [];
    if (!CRM_Core_BAO_SchemaHandler::checkIfFieldExists($table, $column, FALSE)) {
      if ($locales) {
        if ($localizable) {
          foreach ($locales as $locale) {
            if (!CRM_Core_BAO_SchemaHandler::checkIfFieldExists($table, "{$column}_{$locale}", FALSE)) {
              $queries[] = "ALTER TABLE `$table` ADD COLUMN `{$column}_{$locale}` $properties";
            }
          }
        }
        else {
          $queries[] = "ALTER TABLE `$table` ADD COLUMN `$column` $properties";
        }
      }
      else {
        $queries[] = "ALTER TABLE `$table` ADD COLUMN `$column` $properties";
      }
      foreach ($queries as $query) {
        CRM_Core_DAO::executeQuery($query, [], TRUE, NULL, FALSE, FALSE);
      }
    }
    if ($locales && $triggerRebuild) {
      CRM_Core_I18n_Schema::rebuildMultilingualSchema($locales, $version, TRUE);
    }
    return TRUE;
  }

  /**
   * Do any relevant message template updates.
   *
   * @param CRM_Queue_TaskContext $ctx
   * @param string $version
   */
  public static function updateMessageTemplates($ctx, $version) {
    $messageTemplateObject = new CRM_Upgrade_Incremental_MessageTemplates($version);
    $messageTemplateObject->updateTemplates();
  }

  /**
   * Updated a message token within a template.
   *
   * @param CRM_Queue_TaskContext $ctx
   * @param string $workflowName
   * @param string $old
   * @param string $new
   * @param $version
   *
   * @return bool
   */
  public static function updateMessageToken($ctx, string $workflowName, string $old, string $new, $version):bool {
    $messageObj = new CRM_Upgrade_Incremental_MessageTemplates($version);
    $messageObj->replaceTokenInTemplate($workflowName, $old, $new);
    return TRUE;
  }

  /**
   * Re-save any valid values from contribute settings into the normal setting
   * format.
   *
   * We render the array of contribution_invoice_settings and any that have
   * metadata defined we add to the correct key. This is safe to run even if no
   * settings are to be converted, per the test in
   * testConvertUpgradeContributeSettings.
   *
   * @param $ctx
   *
   * @return bool
   */
  public static function updateContributeSettings($ctx) {
    // Use a direct query as api now does some handling on this.
    $settings = CRM_Core_DAO::executeQuery("SELECT value, domain_id FROM civicrm_setting WHERE name = 'contribution_invoice_settings'");

    while ($settings->fetch()) {
      $contributionSettings = (array) CRM_Utils_String::unserialize($settings->value);
      foreach (array_merge(SettingsBag::getContributionInvoiceSettingKeys(), ['deferred_revenue_enabled' => 'deferred_revenue_enabled']) as $possibleKeyName => $settingName) {
        if (!empty($contributionSettings[$possibleKeyName]) && empty(Civi::settings($settings->domain_id)->getExplicit($settingName))) {
          Civi::settings($settings->domain_id)->set($settingName, $contributionSettings[$possibleKeyName]);
        }
      }
    }
    return TRUE;
  }

  /**
   * Do any relevant smart group updates.
   *
   * @param CRM_Queue_TaskContext $ctx
   * @param array $actions
   *
   * @return bool
   */
  public static function updateSmartGroups($ctx, $actions) {
    $groupUpdateObject = new CRM_Upgrade_Incremental_SmartGroups();
    $groupUpdateObject->updateGroups($actions);
    return TRUE;
  }

  /**
   * Drop a column from a table if it exist.
   *
   * @param CRM_Queue_TaskContext $ctx
   * @param string $table
   * @param string $column
   * @return bool
   */
  public static function dropColumn($ctx, $table, $column) {
    if (CRM_Core_BAO_SchemaHandler::checkIfFieldExists($table, $column)) {
      CRM_Core_DAO::executeQuery("ALTER TABLE `$table` DROP COLUMN `$column`",
        [], TRUE, NULL, FALSE, FALSE);
    }
    return TRUE;
  }

  /**
   * Add a index to a table column.
   *
   * @param CRM_Queue_TaskContext $ctx
   * @param string $table
   * @param string|array $columns
   * @param string $prefix
   * @return bool
   */
  public static function addIndex($ctx, $table, $columns, $prefix = 'index') {
    $tables = [$table => (array) $columns];
    CRM_Core_BAO_SchemaHandler::createIndexes($tables, $prefix);

    return TRUE;
  }

  /**
   * Drop a index from a table if it exist.
   *
   * @param CRM_Queue_TaskContext $ctx
   * @param string $table
   * @param string $indexName
   * @return bool
   */
  public static function dropIndex($ctx, $table, $indexName) {
    CRM_Core_BAO_SchemaHandler::dropIndexIfExists($table, $indexName);

    return TRUE;
  }

  /**
   * Drop a table... but only if it's empty.
   *
   * @param CRM_Queue_TaskContext $ctx
   * @param string $table
   * @return bool
   */
  public static function dropTableIfEmpty($ctx, $table) {
    if (CRM_Core_DAO::checkTableExists($table)) {
      if (!CRM_Core_DAO::checkTableHasData($table)) {
        CRM_Core_BAO_SchemaHandler::dropTable($table);
      }
      else {
        $ctx->log->warning("dropTableIfEmpty($table): Found data. Preserved table.");
      }
    }

    return TRUE;
  }

  /**
   * Rebuild Multilingual Schema.
   * @param CRM_Queue_TaskContext $ctx
   * @param string|null $version CiviCRM version to use if rebuilding multilingual schema
   *
   * @return bool
   */
  public static function rebuildMultilingalSchema($ctx, $version = NULL) {
    $locales = CRM_Core_I18n::getMultilingual();
    if ($locales) {
      CRM_Core_I18n_Schema::rebuildMultilingualSchema($locales, $version);
    }
    return TRUE;
  }

}
Commit	Line	Data
bf6a5362 CW	1	<?php
	2	/*
	3	+--------------------------------------------------------------------+
bc77d7c0	4	\| Copyright CiviCRM LLC. All rights reserved. \|
bf6a5362	5	\| \|
bc77d7c0 TO	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 \|
bf6a5362 CW	9	+--------------------------------------------------------------------+
	10	*/
	11
ff6f993e	12	use Civi\Core\SettingsBag;
ff6f993e	13
bf6a5362 CW	14	/**
	15	* Base class for incremental upgrades
	16	*/
	17	class CRM_Upgrade_Incremental_Base {
	18	const BATCH_SIZE = 5000;
	19
d7e4d371 TO	20	/**
	21	* @var string\|null
	22	*/
	23	protected $majorMinor;
	24
	25	/**
	26	* Get the major and minor version for this class (based on English-style class name).
	27	*
	28	* @return string
	29	* Ex: '5.34' or '4.7'
	30	*/
	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;
	38	}
	39	return $this->majorMinor;
	40	}
	41
	42	/**
	43	* Get a list of revisions (PATCH releases) related to this class.
	44	*
	45	* @return array
	46	* Ex: ['4.5.6', '4.5.7']
	47	* @throws \ReflectionException
	48	*/
	49	public function getRevisionSequence() {
	50	$revList = [];
	51
	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));
	56	}
	57
	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]);
	63	}
	64	}
	65
	66	$revList = array_unique($revList);
	67	usort($revList, 'version_compare');
	68	return $revList;
	69	}
	70
bf6a5362 CW	71	/**
	72	* Verify DB state.
	73	*
	74	* @param $errors
	75	*
	76	* @return bool
	77	*/
	78	public function verifyPreDBstate(&$errors) {
	79	return TRUE;
	80	}
	81
	82	/**
	83	* Compute any messages which should be displayed before upgrade.
	84	*
	85	* Note: This function is called iteratively for each upcoming
	86	* revision to the database.
	87	*
	88	* @param $preUpgradeMessage
	89	* @param string $rev
	90	* a version number, e.g. '4.8.alpha1', '4.8.beta3', '4.8.0'.
	91	* @param null $currentVer
	92	*/
	93	public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
	94	}
	95
	96	/**
	97	* Compute any messages which should be displayed after upgrade.
	98	*
	99	* @param string $postUpgradeMessage
	100	* alterable.
	101	* @param string $rev
	102	* an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
bf6a5362 CW	103	*/
	104	public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
	105	}
	106
bf6a5362 CW	107	/**
bf6a5362 CW	108	* (Queue Task Callback)
54957108	109	*
	110	* @param \CRM_Queue_TaskContext $ctx
	111	* @param string $rev
	112	*
	113	* @return bool
bf6a5362 CW	114	*/
	115	public static function runSql(CRM_Queue_TaskContext $ctx, $rev) {
	116	$upgrade = new CRM_Upgrade_Form();
	117	$upgrade->processSQL($rev);
	118
	119	return TRUE;
	120	}
	121
	122	/**
54957108	123	* Syntactic sugar for adding a task.
	124	*
	125	* Task is (a) in this class and (b) has a high priority.
bf6a5362 CW	126	*
	127	* After passing the $funcName, you can also pass parameters that will go to
	128	* the function. Note that all params must be serializable.
54957108	129	*
	130	* @param string $title
	131	* @param string $funcName
bf6a5362 CW	132	*/
bf6a5362 CW	133	protected function addTask($title, $funcName) {
be2fb01f	134	$queue = CRM_Queue_Service::singleton()->load([
bf6a5362 CW	135	'type' => 'Sql',
bf6a5362 CW	136	'name' => CRM_Upgrade_Form::QUEUE_NAME,
be2fb01f	137	]);
bf6a5362 CW	138
	139	$args = func_get_args();
	140	$title = array_shift($args);
	141	$funcName = array_shift($args);
	142	$task = new CRM_Queue_Task(
be2fb01f	143	[get_class($this), $funcName],
bf6a5362 CW	144	$args,
	145	$title
	146	);
be2fb01f	147	$queue->createItem($task, ['weight' => -1]);
bf6a5362 CW	148	}
bf6a5362 CW	149
058b8a5e CW	150	/**
	151	* Remove a payment processor if not in use
	152	*
87a33a95 CW	153	* @param CRM_Queue_TaskContext $ctx
	154	* @param string $name
	155	* @return bool
058b8a5e CW	156	* @throws \CiviCRM_API3_Exception
058b8a5e CW	157	*/
87a33a95	158	public static function removePaymentProcessorType(CRM_Queue_TaskContext $ctx, $name) {
be2fb01f	159	$processors = civicrm_api3('PaymentProcessor', 'getcount', ['payment_processor_type_id' => $name]);
058b8a5e	160	if (empty($processors['result'])) {
be2fb01f	161	$result = civicrm_api3('PaymentProcessorType', 'get', [
058b8a5e CW	162	'name' => $name,
058b8a5e CW	163	'return' => 'id',
be2fb01f	164	]);
058b8a5e	165	if (!empty($result['id'])) {
be2fb01f	166	civicrm_api3('PaymentProcessorType', 'delete', ['id' => $result['id']]);
058b8a5e CW	167	}
058b8a5e CW	168	}
87a33a95	169	return TRUE;
058b8a5e CW	170	}
058b8a5e CW	171
27e82c24 SL	172	/**
	173	* @param string $table_name
	174	* @param string $constraint_name
	175	* @return bool
	176	*/
	177	public static function checkFKExists($table_name, $constraint_name) {
	178	return CRM_Core_BAO_SchemaHandler::checkFKExists($table_name, $constraint_name);
	179	}
	180
b412f764 CW	181	/**
	182	* Add a column to a table if it doesn't already exist
	183	*
	184	* @param CRM_Queue_TaskContext $ctx
	185	* @param string $table
	186	* @param string $column
	187	* @param string $properties
61612722	188	* @param bool $localizable is this a field that should be localized
9f266042	189	* @param string\|null $version CiviCRM version to use if rebuilding multilingual schema
35fd9d21	190	* @param bool $triggerRebuild should we trigger the rebuild of the multilingual schema
9f266042	191	*
b412f764 CW	192	* @return bool
b412f764 CW	193	*/
35fd9d21	194	public static function addColumn($ctx, $table, $column, $properties, $localizable = FALSE, $version = NULL, $triggerRebuild = TRUE) {
394d18d3	195	$locales = CRM_Core_I18n::getMultilingual();
be2fb01f	196	$queries = [];
ce33da5a	197	if (!CRM_Core_BAO_SchemaHandler::checkIfFieldExists($table, $column, FALSE)) {
394d18d3	198	if ($locales) {
61612722	199	if ($localizable) {
61612722	200	foreach ($locales as $locale) {
ce33da5a	201	if (!CRM_Core_BAO_SchemaHandler::checkIfFieldExists($table, "{$column}_{$locale}", FALSE)) {
41ace555 SL	202	$queries[] = "ALTER TABLE `$table` ADD COLUMN `{$column}_{$locale}` $properties";
41ace555 SL	203	}
61612722 SL	204	}
	205	}
	206	else {
	207	$queries[] = "ALTER TABLE `$table` ADD COLUMN `$column` $properties";
	208	}
	209	}
	210	else {
	211	$queries[] = "ALTER TABLE `$table` ADD COLUMN `$column` $properties";
	212	}
	213	foreach ($queries as $query) {
be2fb01f	214	CRM_Core_DAO::executeQuery($query, [], TRUE, NULL, FALSE, FALSE);
61612722 SL	215	}
61612722 SL	216	}
35fd9d21	217	if ($locales && $triggerRebuild) {
76ee148d	218	CRM_Core_I18n_Schema::rebuildMultilingualSchema($locales, $version, TRUE);
150676ad	219	}
b412f764 CW	220	return TRUE;
	221	}
	222
fe83c251	223	/**
	224	* Do any relevant message template updates.
	225	*
	226	* @param CRM_Queue_TaskContext $ctx
	227	* @param string $version
	228	*/
	229	public static function updateMessageTemplates($ctx, $version) {
	230	$messageTemplateObject = new CRM_Upgrade_Incremental_MessageTemplates($version);
	231	$messageTemplateObject->updateTemplates();
8515e10c	232	}
fe83c251	233
8515e10c EM	234	/**
	235	* Updated a message token within a template.
	236	*
	237	* @param CRM_Queue_TaskContext $ctx
	238	* @param string $workflowName
	239	* @param string $old
	240	* @param string $new
	241	* @param $version
	242	*
	243	* @return bool
	244	*/
	245	public static function updateMessageToken($ctx, string $workflowName, string $old, string $new, $version):bool {
	246	$messageObj = new CRM_Upgrade_Incremental_MessageTemplates($version);
	247	$messageObj->replaceTokenInTemplate($workflowName, $old, $new);
	248	return TRUE;
fe83c251	249	}
fe83c251	250
504770b4	251	/**
	252	* Re-save any valid values from contribute settings into the normal setting
	253	* format.
	254	*
	255	* We render the array of contribution_invoice_settings and any that have
	256	* metadata defined we add to the correct key. This is safe to run even if no
	257	* settings are to be converted, per the test in
	258	* testConvertUpgradeContributeSettings.
	259	*
	260	* @param $ctx
	261	*
	262	* @return bool
	263	*/
	264	public static function updateContributeSettings($ctx) {
ff6f993e	265	// Use a direct query as api now does some handling on this.
	266	$settings = CRM_Core_DAO::executeQuery("SELECT value, domain_id FROM civicrm_setting WHERE name = 'contribution_invoice_settings'");
	267
	268	while ($settings->fetch()) {
	269	$contributionSettings = (array) CRM_Utils_String::unserialize($settings->value);
	270	foreach (array_merge(SettingsBag::getContributionInvoiceSettingKeys(), ['deferred_revenue_enabled' => 'deferred_revenue_enabled']) as $possibleKeyName => $settingName) {
	271	if (!empty($contributionSettings[$possibleKeyName]) && empty(Civi::settings($settings->domain_id)->getExplicit($settingName))) {
	272	Civi::settings($settings->domain_id)->set($settingName, $contributionSettings[$possibleKeyName]);
	273	}
	274	}
504770b4	275	}
	276	return TRUE;
	277	}
	278
7015248a	279	/**
	280	* Do any relevant smart group updates.
	281	*
	282	* @param CRM_Queue_TaskContext $ctx
ac241c34	283	* @param array $actions
7015248a	284	*
	285	* @return bool
	286	*/
adcd5156	287	public static function updateSmartGroups($ctx, $actions) {
ac241c34 CW	288	$groupUpdateObject = new CRM_Upgrade_Incremental_SmartGroups();
ac241c34 CW	289	$groupUpdateObject->updateGroups($actions);
7015248a	290	return TRUE;
	291	}
	292
21ca2cb6	293	/**
	294	* Drop a column from a table if it exist.
	295	*
	296	* @param CRM_Queue_TaskContext $ctx
	297	* @param string $table
	298	* @param string $column
	299	* @return bool
	300	*/
	301	public static function dropColumn($ctx, $table, $column) {
	302	if (CRM_Core_BAO_SchemaHandler::checkIfFieldExists($table, $column)) {
	303	CRM_Core_DAO::executeQuery("ALTER TABLE `$table` DROP COLUMN `$column`",
be2fb01f	304	[], TRUE, NULL, FALSE, FALSE);
21ca2cb6	305	}
	306	return TRUE;
	307	}
	308
19415e64	309	/**
	310	* Add a index to a table column.
	311	*
	312	* @param CRM_Queue_TaskContext $ctx
	313	* @param string $table
8a493ab9 CW	314	* @param string\|array $columns
8a493ab9 CW	315	* @param string $prefix
19415e64	316	* @return bool
19415e64	317	*/
8a493ab9 CW	318	public static function addIndex($ctx, $table, $columns, $prefix = 'index') {
	319	$tables = [$table => (array) $columns];
	320	CRM_Core_BAO_SchemaHandler::createIndexes($tables, $prefix);
19415e64	321
	322	return TRUE;
	323	}
	324
	325	/**
	326	* Drop a index from a table if it exist.
	327	*
	328	* @param CRM_Queue_TaskContext $ctx
	329	* @param string $table
	330	* @param string $indexName
	331	* @return bool
	332	*/
	333	public static function dropIndex($ctx, $table, $indexName) {
	334	CRM_Core_BAO_SchemaHandler::dropIndexIfExists($table, $indexName);
	335
	336	return TRUE;
	337	}
	338
e3ed5029 TO	339	/**
	340	* Drop a table... but only if it's empty.
	341	*
	342	* @param CRM_Queue_TaskContext $ctx
	343	* @param string $table
	344	* @return bool
	345	*/
	346	public static function dropTableIfEmpty($ctx, $table) {
	347	if (CRM_Core_DAO::checkTableExists($table)) {
	348	if (!CRM_Core_DAO::checkTableHasData($table)) {
	349	CRM_Core_BAO_SchemaHandler::dropTable($table);
	350	}
	351	else {
	352	$ctx->log->warning("dropTableIfEmpty($table): Found data. Preserved table.");
	353	}
	354	}
	355
	356	return TRUE;
	357	}
	358
81e30d0a SL	359	/**
	360	* Rebuild Multilingual Schema.
	361	* @param CRM_Queue_TaskContext $ctx
9f266042	362	* @param string\|null $version CiviCRM version to use if rebuilding multilingual schema
9f266042	363	*
81e30d0a SL	364	* @return bool
81e30d0a SL	365	*/
76ee148d	366	public static function rebuildMultilingalSchema($ctx, $version = NULL) {
394d18d3 CW	367	$locales = CRM_Core_I18n::getMultilingual();
394d18d3 CW	368	if ($locales) {
76ee148d	369	CRM_Core_I18n_Schema::rebuildMultilingualSchema($locales, $version);
81e30d0a SL	370	}
	371	return TRUE;
	372	}
	373
bf6a5362	374	}