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