Commit | Line | Data |
---|---|---|
6cc25669 CW |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.7 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2015 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License along with this program; if not, contact CiviCRM LLC | | |
21 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
22 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
23 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
24 | +--------------------------------------------------------------------+ | |
25 | */ | |
26 | ||
27 | /** | |
bf6a5362 | 28 | * Upgrade logic for 4.7 |
6cc25669 | 29 | */ |
bf6a5362 | 30 | class CRM_Upgrade_Incremental_php_FourSeven extends CRM_Upgrade_Incremental_Base { |
6cc25669 | 31 | |
f431d51f J |
32 | /** |
33 | * Compute any messages which should be displayed beforeupgrade. | |
34 | * | |
35 | * Note: This function is called iteratively for each upcoming | |
36 | * revision to the database. | |
37 | * | |
3bdf1f3a | 38 | * @param string $preUpgradeMessage |
f431d51f J |
39 | * @param string $rev |
40 | * a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'. | |
41 | * @param null $currentVer | |
f431d51f J |
42 | */ |
43 | public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) { | |
44 | if ($rev == '4.7.alpha1') { | |
f431d51f J |
45 | // CRM-16478 Remove custom fatal error template path option |
46 | $config = CRM_Core_Config::singleton(); | |
18b3bef6 | 47 | if (!empty($config->fatalErrorTemplate) && $config->fatalErrorTemplate != 'CRM/common/fatal.tpl') { |
f431d51f J |
48 | $preUpgradeMessage .= '<p>' . ts('The custom fatal error template setting will be removed during the upgrade. You are currently using this custom template: %1 . Following the upgrade you will need to use the standard approach to overriding template files, as described in the documentation.', array(1 => $config->fatalErrorTemplate)) . '</p>'; |
49 | } | |
f431d51f | 50 | } |
a40fd1ac CW |
51 | if ($rev == '4.7.alpha4') { |
52 | // CRM-17004 Warn of Moneris removal | |
87a33a95 CW |
53 | $count = 1; |
54 | // Query only works in 4.3+ | |
55 | if (version_compare($currentVer, "4.3.0") > 0) { | |
56 | $count = CRM_Core_DAO::singleValueQuery("SELECT COUNT(id) FROM civicrm_payment_processor WHERE payment_processor_type_id IN (SELECT id FROM civicrm_payment_processor_type WHERE name = 'Moneris')"); | |
57 | } | |
58 | if ($count && !function_exists('moneris_civicrm_managed')) { | |
a40fd1ac CW |
59 | $preUpgradeMessage .= '<p>' . ts('The %1 payment processor is no longer bundled with CiviCRM. After upgrading you will need to install the extension to continue using it.', array(1 => 'Moneris')) . '</p>'; |
60 | } | |
61 | } | |
f431d51f J |
62 | } |
63 | ||
6cc25669 CW |
64 | /** |
65 | * Compute any messages which should be displayed after upgrade. | |
66 | * | |
67 | * @param string $postUpgradeMessage | |
68 | * alterable. | |
69 | * @param string $rev | |
70 | * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs. | |
6cc25669 CW |
71 | */ |
72 | public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) { | |
6dbe2c23 CW |
73 | if ($rev == '4.7.alpha1') { |
74 | $config = CRM_Core_Config::singleton(); | |
bf6a5362 | 75 | // FIXME: Performing an upgrade step during postUpgrade message phase is probably bad |
6dbe2c23 CW |
76 | $editor_id = self::updateWysiwyg(); |
77 | $msg = NULL; | |
78 | $ext_href = 'href="' . CRM_Utils_System::url('civicrm/admin/extensions', 'reset=1') . '"'; | |
79 | $dsp_href = 'href="' . CRM_Utils_System::url('civicrm/admin/setting/preferences/display', 'reset=1') . '"'; | |
80 | $blog_href = 'href="https://civicrm.org/blogs/colemanw/big-changes-wysiwyg-editing-47"'; | |
81 | switch ($editor_id) { | |
82 | // TinyMCE | |
83 | case 1: | |
84 | $msg = ts('Your configured editor "TinyMCE" is no longer part of the main CiviCRM download. To continue using it, visit the <a %1>Manage Extensions</a> page to download and install the TinyMCE extension.', array(1 => $ext_href)); | |
85 | break; | |
86 | ||
87 | // Drupal/Joomla editor | |
88 | case 3: | |
89 | case 4: | |
90 | $msg = ts('CiviCRM no longer integrates with the "%1 Default Editor." Your wysiwyg setting has been reset to the built-in CKEditor. <a %2>Learn more...</a>', array(1 => $config->userFramework, 2 => $blog_href)); | |
91 | break; | |
92 | } | |
93 | if ($msg) { | |
94 | $postUpgradeMessage .= '<p>' . $msg . '</p>'; | |
95 | } | |
96 | $postUpgradeMessage .= '<p>' . ts('CiviCRM now includes the easy-to-use CKEditor Configurator. To customize the features and display of your wysiwyg editor, visit the <a %1>Display Preferences</a> page. <a %2>Learn more...</a>', array(1 => $dsp_href, 2 => $blog_href)) . '</p>'; | |
dd55005c | 97 | |
98 | $postUpgradeMessage .= '<br /><br />' . ts('Default version of the following System Workflow Message Templates have been modified: <ul><li>Personal Campaign Pages - Owner Notification</li></ul> If you have modified these templates, please review the new default versions and implement updates as needed to your copies (Administer > Communications > Message Templates > System Workflow Messages).'); | |
f431d51f J |
99 | |
100 | $postUpgradeMessage .= '<p>' . ts('The custom fatal error template setting has been removed.') . '</p>'; | |
6dbe2c23 | 101 | } |
6cc25669 CW |
102 | } |
103 | ||
6cc25669 CW |
104 | /** |
105 | * Upgrade function. | |
106 | * | |
107 | * @param string $rev | |
108 | */ | |
109 | public function upgrade_4_7_alpha1($rev) { | |
b604d7ec | 110 | $this->addTask('Migrate \'on behalf of\' information to module_data', 'migrateOnBehalfOfInfo'); |
bf6a5362 | 111 | $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev); |
f806379b | 112 | $this->addTask(ts('Migrate Settings to %1', array(1 => $rev)), 'migrateSettings', $rev); |
b604d7ec | 113 | $this->addTask('Add Getting Started dashlet', 'addGettingStartedDashlet', $rev); |
a40fd1ac CW |
114 | } |
115 | ||
116 | /** | |
117 | * Upgrade function. | |
118 | * | |
119 | * @param string $rev | |
120 | */ | |
121 | public function upgrade_4_7_alpha4($rev) { | |
122 | $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev); | |
058b8a5e | 123 | $this->addTask(ts('Remove %1', array(1 => 'Moneris')), 'removePaymentProcessorType', 'Moneris'); |
b2222b9f | 124 | $this->addTask('Update Smart Groups', 'fixContactTypeInSmartGroups'); |
6cc25669 CW |
125 | } |
126 | ||
0094ac08 CW |
127 | /** |
128 | * Upgrade function. | |
129 | * | |
130 | * @param string $rev | |
131 | */ | |
132 | public function upgrade_4_7_beta2($rev) { | |
133 | $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev); | |
134 | $this->addTask('Delete unused file', 'deleteVersionCheckCacheFile'); | |
135 | } | |
136 | ||
fb1f3850 DRJ |
137 | /** |
138 | * Upgrade function. | |
139 | * | |
140 | * @param string $rev | |
141 | */ | |
902e557f | 142 | public function upgrade_4_7_beta6($rev) { |
13599400 | 143 | $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev); |
fb1f3850 | 144 | $this->addTask('Disable flexible jobs extension', 'disableFlexibleJobsExtension'); |
20d5377e | 145 | $this->addTask('Add Index to financial_trxn trxn_id field', 'addIndexFinancialTrxnTrxnID'); |
fb1f3850 DRJ |
146 | } |
147 | ||
8ca47f5c | 148 | /** |
149 | * Upgrade function. | |
150 | * | |
151 | * @param string $rev | |
152 | */ | |
153 | public function upgrade_4_7_1($rev) { | |
154 | $this->addTask('Add Index to civicrm_contribution creditnote_id field', 'addIndexContributionCreditNoteID'); | |
155 | } | |
156 | ||
2179c899 | 157 | /** |
158 | * Upgrade function. | |
159 | * | |
160 | * @param string $rev | |
161 | */ | |
162 | public function upgrade_4_7_2($rev) { | |
163 | $this->addTask('Fix Index on civicrm_financial_item combined entity_id + entity_table', 'addCombinedIndexFinancialItemEntityIDEntityType'); | |
1f395432 | 164 | $this->addTask('enable financial account relationships for chargeback & refund', 'addRefundAndChargeBackAccountsIfNotExist'); |
3fe26f4c | 165 | $this->addTask('Add Index to civicrm_contribution.source', 'addIndexContributionSource'); |
2179c899 | 166 | } |
167 | ||
fd28b6a0 | 168 | /** |
169 | * Upgrade function. | |
170 | * | |
171 | * @param string $rev | |
172 | */ | |
173 | public function upgrade_4_7_3($rev) { | |
174 | $this->addTask('Add Index to civicrm_contribution.total_amount', 'addIndexContributionAmount'); | |
175 | } | |
176 | ||
6eb752fa | 177 | /** |
178 | * Upgrade function. | |
179 | * | |
180 | * @param string $rev | |
181 | */ | |
182 | public function upgrade_4_7_4($rev) { | |
183 | $this->addTask('Add Contact Deleted by Merge Activity Type', 'addDeletedByMergeActivityType'); | |
184 | } | |
185 | ||
6cc25669 CW |
186 | /** |
187 | * CRM-16354 | |
188 | * | |
6dbe2c23 | 189 | * @return int |
6cc25669 | 190 | */ |
6dbe2c23 | 191 | public static function updateWysiwyg() { |
aaffa79f | 192 | $editorID = Civi::settings()->get('editor_id'); |
6dbe2c23 CW |
193 | // Previously a numeric value indicated one of 4 wysiwyg editors shipped in core, and no value indicated 'Textarea' |
194 | // Now the options are "Textarea", "CKEditor", and the rest have been dropped from core. | |
195 | $newEditor = $editorID ? "CKEditor" : "Textarea"; | |
08ef4ddd | 196 | Civi::settings()->set('editor_id', $newEditor); |
6cc25669 | 197 | |
6dbe2c23 | 198 | return $editorID; |
6cc25669 CW |
199 | } |
200 | ||
f806379b TO |
201 | /** |
202 | * Migrate any last remaining options from `civicrm_domain.config_backend` to `civicrm_setting`. | |
203 | * Cleanup setting schema. | |
204 | * | |
205 | * @param CRM_Queue_TaskContext $ctx | |
206 | * @return bool | |
207 | */ | |
208 | public function migrateSettings(CRM_Queue_TaskContext $ctx) { | |
4cc9e637 TO |
209 | // Tip: If there are problems with adding the new uniqueness index, try inspecting: |
210 | // SELECT name, domain_id, contact_id, count(*) AS dupes FROM civicrm_setting cs GROUP BY name, domain_id, contact_id HAVING dupes > 1; | |
211 | ||
212 | // Nav records are expendable. https://forum.civicrm.org/index.php?topic=36933.0 | |
213 | CRM_Core_DAO::executeQuery('DELETE FROM civicrm_setting WHERE contact_id IS NOT NULL AND name = "navigation"'); | |
214 | ||
f806379b TO |
215 | CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting DROP INDEX index_group_name'); |
216 | CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting DROP COLUMN group_name'); | |
217 | CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting ADD UNIQUE INDEX index_domain_contact_name (domain_id, contact_id, name)'); | |
218 | ||
219 | $domainDao = CRM_Core_DAO::executeQuery('SELECT id, config_backend FROM civicrm_domain'); | |
220 | while ($domainDao->fetch()) { | |
221 | $settings = CRM_Upgrade_Incremental_php_FourSeven::convertBackendToSettings($domainDao->id, $domainDao->config_backend); | |
222 | CRM_Core_Error::debug_var('convertBackendToSettings', array( | |
223 | 'domainId' => $domainDao->id, | |
224 | 'backend' => $domainDao->config_backend, | |
225 | 'settings' => $settings, | |
226 | )); | |
227 | ||
228 | foreach ($settings as $name => $value) { | |
229 | $rowParams = array( | |
230 | 1 => array($domainDao->id, 'Positive'), | |
231 | 2 => array($name, 'String'), | |
232 | 3 => array(serialize($value), 'String'), | |
233 | ); | |
234 | $settingId = CRM_Core_DAO::singleValueQuery( | |
235 | 'SELECT id FROM civicrm_setting WHERE domain_id = %1 AND name = %2', | |
236 | $rowParams); | |
237 | if (!$settingId) { | |
238 | CRM_Core_DAO::executeQuery( | |
239 | 'INSERT INTO civicrm_setting (domain_id, name, value, is_domain) VALUES (%1,%2,%3,1)', | |
240 | $rowParams); | |
241 | } | |
242 | } | |
243 | } | |
244 | ||
9e726168 | 245 | CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_domain DROP COLUMN config_backend'); |
f806379b TO |
246 | |
247 | return TRUE; | |
248 | } | |
249 | ||
250 | /** | |
251 | * Take a config_backend blob and produce an equivalent list of settings. | |
252 | * | |
253 | * @param int $domainId | |
254 | * Domain ID. | |
255 | * @param string $config_backend | |
256 | * Serialized blob. | |
257 | * @return array | |
258 | */ | |
259 | public static function convertBackendToSettings($domainId, $config_backend) { | |
260 | if (!$config_backend) { | |
261 | return array(); | |
262 | } | |
263 | ||
264 | $backend = unserialize($config_backend); | |
265 | if (!$backend) { | |
266 | return array(); | |
267 | } | |
268 | ||
269 | $mappings = \CRM_Core_Config_MagicMerge::getPropertyMap(); | |
270 | $settings = array(); | |
271 | foreach ($backend as $propertyName => $propertyValue) { | |
272 | if (isset($mappings[$propertyName][0]) && preg_match('/^setting/', $mappings[$propertyName][0])) { | |
273 | // $mapping format: $propertyName => Array(0 => $type, 1 => $setting|NULL). | |
274 | $settingName = isset($mappings[$propertyName][1]) ? $mappings[$propertyName][1] : $propertyName; | |
275 | $settings[$settingName] = $propertyValue; | |
276 | } | |
277 | } | |
278 | ||
279 | return $settings; | |
280 | } | |
281 | ||
0a95c936 | 282 | /** |
283 | * Add Getting Started dashlet to dashboard | |
284 | * | |
285 | * @param \CRM_Queue_TaskContext $ctx | |
286 | * | |
287 | * @return bool | |
288 | */ | |
289 | public function addGettingStartedDashlet(CRM_Queue_TaskContext $ctx) { | |
9c4a04f2 | 290 | $sql = "SELECT count(*) FROM civicrm_dashboard WHERE name='getting-started'"; |
e1674273 | 291 | $res = CRM_Core_DAO::singleValueQuery($sql); |
292 | $domainId = CRM_Core_Config::domainID(); | |
293 | if ($res <= 0) { | |
294 | $sql = "INSERT INTO `civicrm_dashboard` | |
a8b704c5 | 295 | ( `domain_id`, `name`, `label`, `url`, `permission`, `permission_operator`, `column_no`, `is_minimized`, `is_active`, `weight`, `fullscreen_url`, `is_fullscreen`, `is_reserved`) VALUES ( {$domainId}, 'getting-started', 'Getting Started', 'civicrm/dashlet/getting-started?reset=1&snippet=5', 'access CiviCRM', NULL, 0, 0, 1, 0, 'civicrm/dashlet/getting-started?reset=1&snippet=5&context=dashletFullscreen', 1, 1)"; |
e1674273 | 296 | CRM_Core_DAO::executeQuery($sql); |
297 | // Add default position for Getting Started Dashlet ( left column) | |
298 | $sql = "INSERT INTO `civicrm_dashboard_contact` (dashboard_id, contact_id, column_no, is_active) | |
299 | SELECT (SELECT MAX(id) FROM `civicrm_dashboard`), contact_id, 0, IF (SUM(is_active) > 0, 1, 0) | |
300 | FROM `civicrm_dashboard_contact` WHERE 1 GROUP BY contact_id"; | |
301 | CRM_Core_DAO::executeQuery($sql); | |
302 | } | |
0a95c936 | 303 | return TRUE; |
e1674273 | 304 | } |
4175ee03 | 305 | |
6b1e1a2c | 306 | /** |
307 | * Migrate on-behalf information to uf_join.module_data as on-behalf columns will be dropped | |
308 | * on DB upgrade | |
309 | * | |
310 | * @param CRM_Queue_TaskContext $ctx | |
311 | * | |
312 | * @return bool | |
313 | * TRUE for success | |
314 | */ | |
315 | public static function migrateOnBehalfOfInfo(CRM_Queue_TaskContext $ctx) { | |
d3e92c88 | 316 | $domain = new CRM_Core_DAO_Domain(); |
317 | $domain->find(TRUE); | |
6b1e1a2c | 318 | |
d3e92c88 | 319 | // fetch onBehalf entry in UFJoin table |
6b1e1a2c | 320 | $ufGroupDAO = new CRM_Core_DAO_UFJoin(); |
321 | $ufGroupDAO->module = 'OnBehalf'; | |
322 | $ufGroupDAO->find(TRUE); | |
323 | ||
d3e92c88 | 324 | $forOrgColums = array(); |
325 | if ($domain->locales) { | |
326 | $locales = explode(CRM_Core_DAO::VALUE_SEPARATOR, $domain->locales); | |
327 | foreach ($locales as $locale) { | |
328 | $forOrgColums[] = "for_organization_{$locale}"; | |
329 | } | |
330 | } | |
331 | else { | |
332 | $forOrgColums[] = "for_organization"; | |
333 | } | |
334 | ||
335 | $query = " | |
336 | SELECT " . implode(", ", $forOrgColums) . ", uj.id as join_id, uj.uf_group_id as uf_group_id | |
337 | FROM civicrm_contribution_page cp | |
338 | INNER JOIN civicrm_uf_join uj ON uj.entity_id = cp.id AND uj.module = 'OnBehalf'"; | |
339 | $dao = CRM_Core_DAO::executeQuery($query, array(), TRUE, NULL, FALSE, FALSE); | |
6b1e1a2c | 340 | |
341 | if ($dao->N) { | |
6b1e1a2c | 342 | while ($dao->fetch()) { |
343 | $onBehalfParams['on_behalf'] = array('is_for_organization' => $dao->is_for_organization); | |
344 | if ($domain->locales) { | |
6b1e1a2c | 345 | foreach ($locales as $locale) { |
346 | $for_organization = "for_organization_{$locale}"; | |
347 | $onBehalfParams['on_behalf'] += array( | |
348 | $locale => array( | |
349 | 'for_organization' => $dao->$for_organization, | |
350 | ), | |
351 | ); | |
352 | } | |
353 | } | |
354 | else { | |
355 | $onBehalfParams['on_behalf'] += array( | |
356 | 'default' => array( | |
357 | 'for_organization' => $dao->for_organization, | |
358 | ), | |
359 | ); | |
360 | } | |
361 | $ufJoinParam = array( | |
362 | 'id' => $dao->join_id, | |
363 | 'module' => 'on_behalf', | |
d3e92c88 | 364 | 'uf_group_id' => $dao->uf_group_id, |
6b1e1a2c | 365 | 'module_data' => json_encode($onBehalfParams), |
366 | ); | |
367 | CRM_Core_BAO_UFJoin::create($ufJoinParam); | |
368 | } | |
369 | } | |
370 | ||
371 | return TRUE; | |
372 | } | |
cb804cd9 | 373 | |
b2222b9f CW |
374 | /** |
375 | * CRM-11782 - Get rid of VALUE_SEPARATOR character in saved search form values | |
376 | * | |
377 | * @param \CRM_Queue_TaskContext $ctx | |
378 | * | |
379 | * @return bool | |
380 | */ | |
381 | public function fixContactTypeInSmartGroups(CRM_Queue_TaskContext $ctx) { | |
382 | $sep = CRM_Core_DAO::VALUE_SEPARATOR; | |
383 | $dao = CRM_Core_DAO::executeQuery("SELECT id, form_values FROM civicrm_saved_search WHERE form_values LIKE '%$sep%'"); | |
384 | while ($dao->fetch()) { | |
385 | $formValues = unserialize($dao->form_values); | |
386 | if (isset($formValues['contact_type']) && is_array($formValues['contact_type'])) { | |
387 | $newVals = array(); | |
388 | foreach ($formValues['contact_type'] as $key => $val) { | |
389 | $newVals[str_replace($sep, '__', $key)] = is_string($val) ? str_replace($sep, '__', $val) : $val; | |
390 | } | |
391 | $formValues['contact_type'] = $newVals; | |
392 | } | |
393 | CRM_Core_DAO::executeQuery("UPDATE civicrm_saved_search SET form_values = %1 WHERE id = {$dao->id}", array(1 => array(serialize($formValues), 'String'))); | |
394 | } | |
395 | ||
396 | return TRUE; | |
397 | } | |
398 | ||
0094ac08 CW |
399 | /** |
400 | * CRM-17637 - Ths file location has been moved; delete the old one | |
401 | * | |
402 | * @param \CRM_Queue_TaskContext $ctx | |
403 | * | |
404 | * @return bool | |
405 | */ | |
406 | public function deleteVersionCheckCacheFile(CRM_Queue_TaskContext $ctx) { | |
407 | $config = CRM_Core_Config::singleton(); | |
408 | $cacheFile = $config->uploadDir . 'version-info-cache.json'; | |
409 | if (file_exists($cacheFile)) { | |
410 | unlink($cacheFile); | |
411 | } | |
412 | return TRUE; | |
413 | } | |
414 | ||
fb1f3850 DRJ |
415 | /** |
416 | * CRM-17669 and CRM-17686, make scheduled jobs more flexible, disable the 4.6 extension if installed | |
417 | * | |
418 | * @param \CRM_Queue_TaskContext $ctx | |
419 | * | |
420 | * @return bool | |
421 | */ | |
422 | public function disableFlexibleJobsExtension(CRM_Queue_TaskContext $ctx) { | |
d357221c DRJ |
423 | try { |
424 | civicrm_api3('Extension', 'disable', array('key' => 'com.klangsoft.flexiblejobs')); | |
425 | } | |
426 | catch (CiviCRM_API3_Exception $e) { | |
427 | // just ignore if the extension isn't installed | |
428 | } | |
fb1f3850 DRJ |
429 | |
430 | return TRUE; | |
431 | } | |
432 | ||
20d5377e | 433 | /** |
434 | * CRM-17752 add index to civicrm_financial_trxn.trxn_id (deliberately non-unique). | |
435 | * | |
436 | * @param \CRM_Queue_TaskContext $ctx | |
437 | * | |
438 | * @return bool | |
439 | */ | |
440 | public function addIndexFinancialTrxnTrxnID(CRM_Queue_TaskContext $ctx) { | |
441 | $tables = array('civicrm_financial_trxn' => array('trxn_id')); | |
442 | CRM_Core_BAO_SchemaHandler::createIndexes($tables); | |
443 | return TRUE; | |
444 | } | |
445 | ||
8ca47f5c | 446 | /** |
447 | * CRM-17882 Add index to civicrm_contribution.credit_note_id. | |
448 | * | |
449 | * @param \CRM_Queue_TaskContext $ctx | |
450 | * | |
451 | * @return bool | |
452 | */ | |
453 | public function addIndexContributionCreditNoteID(CRM_Queue_TaskContext $ctx) { | |
454 | $tables = array('civicrm_contribution' => array('creditnote_id')); | |
455 | CRM_Core_BAO_SchemaHandler::createIndexes($tables); | |
456 | return TRUE; | |
457 | } | |
458 | ||
2179c899 | 459 | /** |
460 | * CRM-17775 Add correct index for table civicrm_financial_item. | |
461 | * | |
462 | * Note that the entity ID should always precede the entity_table as | |
463 | * it is more unique. This is better for performance and does not cause fallback | |
464 | * to no index if table it omitted. | |
465 | * | |
466 | * @return bool | |
467 | */ | |
468 | public function addCombinedIndexFinancialItemEntityIDEntityType() { | |
469 | CRM_Core_BAO_SchemaHandler::dropIndexIfExists('civicrm_financial_item', 'UI_id'); | |
470 | CRM_Core_BAO_SchemaHandler::dropIndexIfExists('civicrm_financial_item', 'IX_Entity'); | |
471 | CRM_Core_BAO_SchemaHandler::createIndexes(array( | |
472 | 'civicrm_financial_item' => array(array('entity_id', 'entity_table')), | |
473 | )); | |
474 | return TRUE; | |
475 | } | |
476 | ||
1f395432 | 477 | /** |
478 | * CRM-17951 Add accounts option values for refund and chargeback. | |
479 | * | |
480 | * Add Chargeback contribution status and Chargeback and Contra account relationships, | |
481 | * checking first if one exists. | |
482 | */ | |
483 | public function addRefundAndChargeBackAccountsIfNotExist() { | |
484 | // First we enable and edit the record for Credit contra - this exists but is disabled for most sites. | |
485 | // Using the ensure function (below) will not enabled a disabled option (by design). | |
486 | CRM_Core_DAO::executeQuery("UPDATE civicrm_option_value v | |
487 | INNER JOIN civicrm_option_group g on v.option_group_id=g.id and g.name='account_relationship' | |
488 | SET v.is_active=1, v.label='Credit/Contra Revenue Account is', v.name='Credit/Contra Revenue Account is', v.description='Credit/Contra Revenue Account is' | |
489 | WHERE v.name = 'Credit/Contra Account is';"); | |
490 | ||
491 | CRM_Core_BAO_OptionValue::ensureOptionValueExists(array( | |
492 | 'option_group_id' => 'account_relationship', | |
4a907feb EM |
493 | 'name' => 'Chargeback Account is', |
494 | 'label' => ts('Chargeback Account is'), | |
1f395432 | 495 | 'is_active' => TRUE, |
496 | 'component_id' => 'CiviContribute', | |
497 | )); | |
498 | ||
499 | CRM_Core_BAO_OptionValue::ensureOptionValueExists(array( | |
500 | 'option_group_id' => 'contribution_status', | |
501 | 'name' => 'Chargeback', | |
502 | 'label' => ts('Chargeback'), | |
503 | 'is_active' => TRUE, | |
504 | 'component_id' => 'CiviContribute', | |
505 | )); | |
506 | return TRUE; | |
507 | } | |
508 | ||
3fe26f4c | 509 | /** |
510 | * CRM-17999 Add index to civicrm_contribution.source. | |
511 | * | |
512 | * @param \CRM_Queue_TaskContext $ctx | |
513 | * | |
514 | * @return bool | |
515 | */ | |
516 | public function addIndexContributionSource(CRM_Queue_TaskContext $ctx) { | |
517 | CRM_Core_BAO_SchemaHandler::createIndexes(array('civicrm_contribution' => array('source'))); | |
518 | return TRUE; | |
519 | } | |
520 | ||
fd28b6a0 | 521 | /** |
522 | * CRM-18124 Add index to civicrm_contribution.total_amount. | |
523 | * | |
524 | * Note that I made this a combined index with receive_date because the issue included | |
525 | * both criteria and they seemed likely to be used in conjunction to me in other cases. | |
526 | * | |
527 | * @param \CRM_Queue_TaskContext $ctx | |
528 | * | |
529 | * @return bool | |
530 | */ | |
531 | public function addIndexContributionAmount(CRM_Queue_TaskContext $ctx) { | |
532 | CRM_Core_BAO_SchemaHandler::createIndexes(array( | |
533 | 'civicrm_contribution' => array(array('total_amount', 'receive_date')), | |
534 | )); | |
535 | return TRUE; | |
536 | } | |
537 | ||
6eb752fa | 538 | /** |
539 | * CRM-18124 Add index to civicrm_contribution.total_amount. | |
540 | * | |
541 | * Note that I made this a combined index with receive_date because the issue included | |
542 | * both criteria and they seemed likely to be used in conjunction to me in other cases. | |
543 | * | |
544 | * @param \CRM_Queue_TaskContext $ctx | |
545 | * | |
546 | * @return bool | |
547 | */ | |
548 | public function addDeletedByMergeActivityType(CRM_Queue_TaskContext $ctx) { | |
549 | CRM_Core_BAO_OptionValue::ensureOptionValueExists(array( | |
550 | 'option_group_id' => 'activity_type', | |
551 | 'name' => 'Contact Deleted by Merge', | |
552 | 'label' => ts('Contact Deleted by Merge'), | |
553 | 'description' => ts('Contact was merged into another contact'), | |
554 | 'is_active' => TRUE, | |
555 | )); | |
556 | return TRUE; | |
557 | } | |
558 | ||
6cc25669 | 559 | } |