3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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. |
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 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 +--------------------------------------------------------------------+
28 * Upgrade logic for 4.7
30 class CRM_Upgrade_Incremental_php_FourSeven
extends CRM_Upgrade_Incremental_Base
{
33 * Compute any messages which should be displayed beforeupgrade.
35 * Note: This function is called iteratively for each upcoming
36 * revision to the database.
38 * @param string $preUpgradeMessage
40 * a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
41 * @param null $currentVer
43 public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
44 if ($rev == '4.7.alpha1') {
45 // CRM-16478 Remove custom fatal error template path option
46 $config = CRM_Core_Config
::singleton();
47 if (!empty($config->fatalErrorTemplate
) && $config->fatalErrorTemplate
!= 'CRM/common/fatal.tpl') {
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>';
51 if ($rev == '4.7.alpha4') {
52 // CRM-17004 Warn of Moneris removal
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')");
58 if ($count && !function_exists('moneris_civicrm_managed')) {
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>';
65 * Compute any messages which should be displayed after upgrade.
67 * @param string $postUpgradeMessage
70 * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
72 public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
73 if ($rev == '4.7.alpha1') {
74 $config = CRM_Core_Config
::singleton();
75 // FIXME: Performing an upgrade step during postUpgrade message phase is probably bad
76 $editor_id = self
::updateWysiwyg();
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"';
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));
87 // Drupal/Joomla editor
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));
94 $postUpgradeMessage .= '<p>' . $msg . '</p>';
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>';
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).');
100 $postUpgradeMessage .= '<p>' . ts('The custom fatal error template setting has been removed.') . '</p>';
109 public function upgrade_4_7_alpha1($rev) {
110 $this->addTask('Migrate \'on behalf of\' information to module_data', 'migrateOnBehalfOfInfo');
111 $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
112 $this->addTask(ts('Migrate Settings to %1', array(1 => $rev)), 'migrateSettings', $rev);
113 $this->addTask('Add Getting Started dashlet', 'addGettingStartedDashlet', $rev);
121 public function upgrade_4_7_alpha4($rev) {
122 $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
123 $this->addTask(ts('Remove %1', array(1 => 'Moneris')), 'removePaymentProcessorType', 'Moneris');
124 $this->addTask('Update Smart Groups', 'fixContactTypeInSmartGroups');
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');
142 public function upgrade_4_7_beta6($rev) {
143 $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
144 $this->addTask('Disable flexible jobs extension', 'disableFlexibleJobsExtension');
145 $this->addTask('Add Index to financial_trxn trxn_id field', 'addIndexFinancialTrxnTrxnID');
153 public function upgrade_4_7_1($rev) {
154 $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
155 $this->addTask('Add Index to civicrm_contribution creditnote_id field', 'addIndexContributionCreditNoteID');
163 public function upgrade_4_7_2($rev) {
164 $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
165 $this->addTask('Fix Index on civicrm_financial_item combined entity_id + entity_table', 'addCombinedIndexFinancialItemEntityIDEntityType');
166 $this->addTask('enable financial account relationships for chargeback & refund', 'addRefundAndChargeBackAccountsIfNotExist');
167 $this->addTask('Add Index to civicrm_contribution.source', 'addIndexContributionSource');
175 public function upgrade_4_7_3($rev) {
176 $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
177 $this->addTask('Add Index to civicrm_contribution.total_amount', 'addIndexContributionAmount');
185 public function upgrade_4_7_4($rev) {
186 $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
187 $this->addTask('Add Contact Deleted by Merge Activity Type', 'addDeletedByMergeActivityType');
195 public function upgrade_4_7_7($rev) {
196 $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
197 // https://issues.civicrm.org/jira/browse/CRM-18006
198 if (CRM_Core_DAO
::checkTableExists('civicrm_install_canary')) {
199 CRM_Core_DAO
::executeQuery('ALTER TABLE civicrm_install_canary ENGINE=InnoDB');
204 * Important! All upgrade functions MUST call the 'runSql' task.
205 * Uncomment and use the following template for a new upgrade version
206 * (change the x in the function name):
210 // * Upgrade function.
212 // * @param string $rev
214 // public function upgrade_4_7_x($rev) {
215 // $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
216 // // Additional tasks here...
224 public static function updateWysiwyg() {
225 $editorID = Civi
::settings()->get('editor_id');
226 // Previously a numeric value indicated one of 4 wysiwyg editors shipped in core, and no value indicated 'Textarea'
227 // Now the options are "Textarea", "CKEditor", and the rest have been dropped from core.
228 $newEditor = $editorID ?
"CKEditor" : "Textarea";
229 Civi
::settings()->set('editor_id', $newEditor);
235 * Migrate any last remaining options from `civicrm_domain.config_backend` to `civicrm_setting`.
236 * Cleanup setting schema.
238 * @param CRM_Queue_TaskContext $ctx
241 public function migrateSettings(CRM_Queue_TaskContext
$ctx) {
242 // Tip: If there are problems with adding the new uniqueness index, try inspecting:
243 // SELECT name, domain_id, contact_id, count(*) AS dupes FROM civicrm_setting cs GROUP BY name, domain_id, contact_id HAVING dupes > 1;
245 // Nav records are expendable. https://forum.civicrm.org/index.php?topic=36933.0
246 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_setting WHERE contact_id IS NOT NULL AND name = "navigation"');
248 CRM_Core_DAO
::executeQuery('ALTER TABLE civicrm_setting DROP INDEX index_group_name');
249 CRM_Core_DAO
::executeQuery('ALTER TABLE civicrm_setting DROP COLUMN group_name');
250 CRM_Core_DAO
::executeQuery('ALTER TABLE civicrm_setting ADD UNIQUE INDEX index_domain_contact_name (domain_id, contact_id, name)');
252 $domainDao = CRM_Core_DAO
::executeQuery('SELECT id, config_backend FROM civicrm_domain');
253 while ($domainDao->fetch()) {
254 $settings = CRM_Upgrade_Incremental_php_FourSeven
::convertBackendToSettings($domainDao->id
, $domainDao->config_backend
);
255 CRM_Core_Error
::debug_var('convertBackendToSettings', array(
256 'domainId' => $domainDao->id
,
257 'backend' => $domainDao->config_backend
,
258 'settings' => $settings,
261 foreach ($settings as $name => $value) {
263 1 => array($domainDao->id
, 'Positive'),
264 2 => array($name, 'String'),
265 3 => array(serialize($value), 'String'),
267 $settingId = CRM_Core_DAO
::singleValueQuery(
268 'SELECT id FROM civicrm_setting WHERE domain_id = %1 AND name = %2',
271 CRM_Core_DAO
::executeQuery(
272 'INSERT INTO civicrm_setting (domain_id, name, value, is_domain) VALUES (%1,%2,%3,1)',
278 CRM_Core_DAO
::executeQuery('ALTER TABLE civicrm_domain DROP COLUMN config_backend');
284 * Take a config_backend blob and produce an equivalent list of settings.
286 * @param int $domainId
288 * @param string $config_backend
292 public static function convertBackendToSettings($domainId, $config_backend) {
293 if (!$config_backend) {
297 $backend = unserialize($config_backend);
302 $mappings = \CRM_Core_Config_MagicMerge
::getPropertyMap();
304 foreach ($backend as $propertyName => $propertyValue) {
305 if (isset($mappings[$propertyName][0]) && preg_match('/^setting/', $mappings[$propertyName][0])) {
306 // $mapping format: $propertyName => Array(0 => $type, 1 => $setting|NULL).
307 $settingName = isset($mappings[$propertyName][1]) ?
$mappings[$propertyName][1] : $propertyName;
308 $settings[$settingName] = $propertyValue;
316 * Add Getting Started dashlet to dashboard
318 * @param \CRM_Queue_TaskContext $ctx
322 public function addGettingStartedDashlet(CRM_Queue_TaskContext
$ctx) {
323 $sql = "SELECT count(*) FROM civicrm_dashboard WHERE name='getting-started'";
324 $res = CRM_Core_DAO
::singleValueQuery($sql);
325 $domainId = CRM_Core_Config
::domainID();
327 $sql = "INSERT INTO `civicrm_dashboard`
328 ( `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)";
329 CRM_Core_DAO
::executeQuery($sql);
330 // Add default position for Getting Started Dashlet ( left column)
331 $sql = "INSERT INTO `civicrm_dashboard_contact` (dashboard_id, contact_id, column_no, is_active)
332 SELECT (SELECT MAX(id) FROM `civicrm_dashboard`), contact_id, 0, IF (SUM(is_active) > 0, 1, 0)
333 FROM `civicrm_dashboard_contact` JOIN `civicrm_contact` WHERE civicrm_dashboard_contact.contact_id = civicrm_contact.id GROUP BY contact_id";
334 CRM_Core_DAO
::executeQuery($sql);
340 * Migrate on-behalf information to uf_join.module_data as on-behalf columns will be dropped
343 * @param CRM_Queue_TaskContext $ctx
348 public static function migrateOnBehalfOfInfo(CRM_Queue_TaskContext
$ctx) {
349 $domain = new CRM_Core_DAO_Domain();
352 // fetch onBehalf entry in UFJoin table
353 $ufGroupDAO = new CRM_Core_DAO_UFJoin();
354 $ufGroupDAO->module
= 'OnBehalf';
355 $ufGroupDAO->find(TRUE);
357 $forOrgColums = array();
358 if ($domain->locales
) {
359 $locales = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $domain->locales
);
360 foreach ($locales as $locale) {
361 $forOrgColums[] = "for_organization_{$locale}";
365 $forOrgColums[] = "for_organization";
369 SELECT " . implode(", ", $forOrgColums) . ", uj.id as join_id, uj.uf_group_id as uf_group_id
370 FROM civicrm_contribution_page cp
371 INNER JOIN civicrm_uf_join uj ON uj.entity_id = cp.id AND uj.module = 'OnBehalf'";
372 $dao = CRM_Core_DAO
::executeQuery($query, array(), TRUE, NULL, FALSE, FALSE);
375 while ($dao->fetch()) {
376 $onBehalfParams['on_behalf'] = array('is_for_organization' => $dao->is_for_organization
);
377 if ($domain->locales
) {
378 foreach ($locales as $locale) {
379 $for_organization = "for_organization_{$locale}";
380 $onBehalfParams['on_behalf'] +
= array(
382 'for_organization' => $dao->$for_organization,
388 $onBehalfParams['on_behalf'] +
= array(
390 'for_organization' => $dao->for_organization
,
394 $ufJoinParam = array(
395 'id' => $dao->join_id
,
396 'module' => 'on_behalf',
397 'uf_group_id' => $dao->uf_group_id
,
398 'module_data' => json_encode($onBehalfParams),
400 CRM_Core_BAO_UFJoin
::create($ufJoinParam);
408 * CRM-11782 - Get rid of VALUE_SEPARATOR character in saved search form values
410 * @param \CRM_Queue_TaskContext $ctx
414 public function fixContactTypeInSmartGroups(CRM_Queue_TaskContext
$ctx) {
415 $sep = CRM_Core_DAO
::VALUE_SEPARATOR
;
416 $dao = CRM_Core_DAO
::executeQuery("SELECT id, form_values FROM civicrm_saved_search WHERE form_values LIKE '%$sep%'");
417 while ($dao->fetch()) {
418 $formValues = unserialize($dao->form_values
);
419 if (isset($formValues['contact_type']) && is_array($formValues['contact_type'])) {
421 foreach ($formValues['contact_type'] as $key => $val) {
422 $newVals[str_replace($sep, '__', $key)] = is_string($val) ?
str_replace($sep, '__', $val) : $val;
424 $formValues['contact_type'] = $newVals;
426 CRM_Core_DAO
::executeQuery("UPDATE civicrm_saved_search SET form_values = %1 WHERE id = {$dao->id}", array(1 => array(serialize($formValues), 'String')));
433 * CRM-17637 - Ths file location has been moved; delete the old one
435 * @param \CRM_Queue_TaskContext $ctx
439 public function deleteVersionCheckCacheFile(CRM_Queue_TaskContext
$ctx) {
440 $config = CRM_Core_Config
::singleton();
441 $cacheFile = $config->uploadDir
. 'version-info-cache.json';
442 if (file_exists($cacheFile)) {
449 * CRM-17669 and CRM-17686, make scheduled jobs more flexible, disable the 4.6 extension if installed
451 * @param \CRM_Queue_TaskContext $ctx
455 public function disableFlexibleJobsExtension(CRM_Queue_TaskContext
$ctx) {
457 civicrm_api3('Extension', 'disable', array('key' => 'com.klangsoft.flexiblejobs'));
459 catch (CiviCRM_API3_Exception
$e) {
460 // just ignore if the extension isn't installed
467 * CRM-17752 add index to civicrm_financial_trxn.trxn_id (deliberately non-unique).
469 * @param \CRM_Queue_TaskContext $ctx
473 public function addIndexFinancialTrxnTrxnID(CRM_Queue_TaskContext
$ctx) {
474 $tables = array('civicrm_financial_trxn' => array('trxn_id'));
475 CRM_Core_BAO_SchemaHandler
::createIndexes($tables);
480 * CRM-17882 Add index to civicrm_contribution.credit_note_id.
482 * @param \CRM_Queue_TaskContext $ctx
486 public function addIndexContributionCreditNoteID(CRM_Queue_TaskContext
$ctx) {
487 $tables = array('civicrm_contribution' => array('creditnote_id'));
488 CRM_Core_BAO_SchemaHandler
::createIndexes($tables);
493 * CRM-17775 Add correct index for table civicrm_financial_item.
495 * Note that the entity ID should always precede the entity_table as
496 * it is more unique. This is better for performance and does not cause fallback
497 * to no index if table it omitted.
501 public function addCombinedIndexFinancialItemEntityIDEntityType() {
502 CRM_Core_BAO_SchemaHandler
::dropIndexIfExists('civicrm_financial_item', 'UI_id');
503 CRM_Core_BAO_SchemaHandler
::dropIndexIfExists('civicrm_financial_item', 'IX_Entity');
504 CRM_Core_BAO_SchemaHandler
::createIndexes(array(
505 'civicrm_financial_item' => array(array('entity_id', 'entity_table')),
511 * CRM-17951 Add accounts option values for refund and chargeback.
513 * Add Chargeback contribution status and Chargeback and Contra account relationships,
514 * checking first if one exists.
516 public function addRefundAndChargeBackAccountsIfNotExist() {
517 // First we enable and edit the record for Credit contra - this exists but is disabled for most sites.
518 // Using the ensure function (below) will not enabled a disabled option (by design).
519 CRM_Core_DAO
::executeQuery("UPDATE civicrm_option_value v
520 INNER JOIN civicrm_option_group g on v.option_group_id=g.id and g.name='account_relationship'
521 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'
522 WHERE v.name = 'Credit/Contra Account is';");
524 CRM_Core_BAO_OptionValue
::ensureOptionValueExists(array(
525 'option_group_id' => 'account_relationship',
526 'name' => 'Chargeback Account is',
527 'label' => ts('Chargeback Account is'),
529 'component_id' => 'CiviContribute',
532 CRM_Core_BAO_OptionValue
::ensureOptionValueExists(array(
533 'option_group_id' => 'contribution_status',
534 'name' => 'Chargeback',
535 'label' => ts('Chargeback'),
537 'component_id' => 'CiviContribute',
543 * CRM-17999 Add index to civicrm_contribution.source.
545 * @param \CRM_Queue_TaskContext $ctx
549 public function addIndexContributionSource(CRM_Queue_TaskContext
$ctx) {
550 CRM_Core_BAO_SchemaHandler
::createIndexes(array('civicrm_contribution' => array('source')));
555 * CRM-18124 Add index to civicrm_contribution.total_amount.
557 * Note that I made this a combined index with receive_date because the issue included
558 * both criteria and they seemed likely to be used in conjunction to me in other cases.
560 * @param \CRM_Queue_TaskContext $ctx
564 public function addIndexContributionAmount(CRM_Queue_TaskContext
$ctx) {
565 CRM_Core_BAO_SchemaHandler
::createIndexes(array(
566 'civicrm_contribution' => array(array('total_amount', 'receive_date')),
572 * CRM-18124 Add index to civicrm_contribution.total_amount.
574 * Note that I made this a combined index with receive_date because the issue included
575 * both criteria and they seemed likely to be used in conjunction to me in other cases.
577 * @param \CRM_Queue_TaskContext $ctx
581 public function addDeletedByMergeActivityType(CRM_Queue_TaskContext
$ctx) {
582 CRM_Core_BAO_OptionValue
::ensureOptionValueExists(array(
583 'option_group_id' => 'activity_type',
584 'name' => 'Contact Deleted by Merge',
585 'label' => ts('Contact Deleted by Merge'),
586 'description' => ts('Contact was merged into another contact'),