3 +--------------------------------------------------------------------+
4 | CiviCRM version 5 .alpha1 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * Base class for incremental upgrades
31 class CRM_Upgrade_Incremental_Base
{
32 const BATCH_SIZE
= 5000;
41 public function verifyPreDBstate(&$errors) {
46 * Compute any messages which should be displayed before upgrade.
48 * Note: This function is called iteratively for each upcoming
49 * revision to the database.
51 * @param $preUpgradeMessage
53 * a version number, e.g. '4.8.alpha1', '4.8.beta3', '4.8.0'.
54 * @param null $currentVer
56 public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
60 * Compute any messages which should be displayed after upgrade.
62 * @param string $postUpgradeMessage
65 * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
67 public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
71 * (Queue Task Callback)
73 * @param \CRM_Queue_TaskContext $ctx
78 public static function runSql(CRM_Queue_TaskContext
$ctx, $rev) {
79 $upgrade = new CRM_Upgrade_Form();
80 $upgrade->processSQL($rev);
86 * Syntactic sugar for adding a task.
88 * Task is (a) in this class and (b) has a high priority.
90 * After passing the $funcName, you can also pass parameters that will go to
91 * the function. Note that all params must be serializable.
93 * @param string $title
94 * @param string $funcName
96 protected function addTask($title, $funcName) {
97 $queue = CRM_Queue_Service
::singleton()->load([
99 'name' => CRM_Upgrade_Form
::QUEUE_NAME
,
102 $args = func_get_args();
103 $title = array_shift($args);
104 $funcName = array_shift($args);
105 $task = new CRM_Queue_Task(
106 [get_class($this), $funcName],
110 $queue->createItem($task, ['weight' => -1]);
114 * Remove a payment processor if not in use
116 * @param CRM_Queue_TaskContext $ctx
117 * @param string $name
119 * @throws \CiviCRM_API3_Exception
121 public static function removePaymentProcessorType(CRM_Queue_TaskContext
$ctx, $name) {
122 $processors = civicrm_api3('PaymentProcessor', 'getcount', ['payment_processor_type_id' => $name]);
123 if (empty($processors['result'])) {
124 $result = civicrm_api3('PaymentProcessorType', 'get', [
128 if (!empty($result['id'])) {
129 civicrm_api3('PaymentProcessorType', 'delete', ['id' => $result['id']]);
136 * @param string $table_name
137 * @param string $constraint_name
140 public static function checkFKExists($table_name, $constraint_name) {
141 return CRM_Core_BAO_SchemaHandler
::checkFKExists($table_name, $constraint_name);
145 * Add a column to a table if it doesn't already exist
147 * @param CRM_Queue_TaskContext $ctx
148 * @param string $table
149 * @param string $column
150 * @param string $properties
151 * @param bool $localizable is this a field that should be localized
152 * @param string|NULL $version CiviCRM version to use if rebuilding multilingual schema
155 public static function addColumn($ctx, $table, $column, $properties, $localizable = FALSE, $version = NULL) {
156 $domain = new CRM_Core_DAO_Domain();
159 if (!CRM_Core_BAO_SchemaHandler
::checkIfFieldExists($table, $column, FALSE)) {
160 if ($domain->locales
) {
162 $locales = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $domain->locales
);
163 foreach ($locales as $locale) {
164 if (!CRM_Core_BAO_SchemaHandler
::checkIfFieldExists($table, "{$column}_{$locale}", FALSE)) {
165 $queries[] = "ALTER TABLE `$table` ADD COLUMN `{$column}_{$locale}` $properties";
170 $queries[] = "ALTER TABLE `$table` ADD COLUMN `$column` $properties";
174 $queries[] = "ALTER TABLE `$table` ADD COLUMN `$column` $properties";
176 foreach ($queries as $query) {
177 CRM_Core_DAO
::executeQuery($query, [], TRUE, NULL, FALSE, FALSE);
180 if ($domain->locales
) {
181 $locales = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $domain->locales
);
182 CRM_Core_I18n_Schema
::rebuildMultilingualSchema($locales, $version, TRUE);
188 * Do any relevant message template updates.
190 * @param CRM_Queue_TaskContext $ctx
191 * @param string $version
193 public static function updateMessageTemplates($ctx, $version) {
194 $messageTemplateObject = new CRM_Upgrade_Incremental_MessageTemplates($version);
195 $messageTemplateObject->updateTemplates();
200 * Re-save any valid values from contribute settings into the normal setting
203 * We render the array of contribution_invoice_settings and any that have
204 * metadata defined we add to the correct key. This is safe to run even if no
205 * settings are to be converted, per the test in
206 * testConvertUpgradeContributeSettings.
212 public static function updateContributeSettings($ctx) {
213 $settings = Civi
::settings()->get('contribution_invoice_settings');
214 $metadata = \Civi\Core\SettingsMetadata
::getMetadata();
215 $conversions = array_intersect_key((array) $settings, $metadata);
216 foreach ($conversions as $key => $conversion) {
217 Civi
::settings()->set($key, $conversion);
223 * Do any relevant smart group updates.
225 * @param CRM_Queue_TaskContext $ctx
226 * @param array $actions
230 public function updateSmartGroups($ctx, $actions) {
231 $groupUpdateObject = new CRM_Upgrade_Incremental_SmartGroups();
232 $groupUpdateObject->updateGroups($actions);
237 * Drop a column from a table if it exist.
239 * @param CRM_Queue_TaskContext $ctx
240 * @param string $table
241 * @param string $column
244 public static function dropColumn($ctx, $table, $column) {
245 if (CRM_Core_BAO_SchemaHandler
::checkIfFieldExists($table, $column)) {
246 CRM_Core_DAO
::executeQuery("ALTER TABLE `$table` DROP COLUMN `$column`",
247 [], TRUE, NULL, FALSE, FALSE);
253 * Add a index to a table column.
255 * @param CRM_Queue_TaskContext $ctx
256 * @param string $table
257 * @param string|array $column
260 public static function addIndex($ctx, $table, $column) {
261 $tables = [$table => (array) $column];
262 CRM_Core_BAO_SchemaHandler
::createIndexes($tables);
268 * Drop a index from a table if it exist.
270 * @param CRM_Queue_TaskContext $ctx
271 * @param string $table
272 * @param string $indexName
275 public static function dropIndex($ctx, $table, $indexName) {
276 CRM_Core_BAO_SchemaHandler
::dropIndexIfExists($table, $indexName);
282 * Rebuild Multilingual Schema.
283 * @param CRM_Queue_TaskContext $ctx
284 * @param string|NULL $version CiviCRM version to use if rebuilding multilingual schema
287 public static function rebuildMultilingalSchema($ctx, $version = NULL) {
288 $domain = new CRM_Core_DAO_Domain();
290 if ($domain->locales
) {
291 $locales = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $domain->locales
);
292 CRM_Core_I18n_Schema
::rebuildMultilingualSchema($locales, $version);