CRM/Upgrade/Incremental/php/FourSeven.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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 /**
  28  * Upgrade logic for 4.7
  29  */
  30 class CRM_Upgrade_Incremental_php_FourSeven extends CRM_Upgrade_Incremental_Base {
  31
  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    *
  38    * @param string $preUpgradeMessage
  39    * @param string $rev
  40    *   a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
  41    * @param null $currentVer
  42    */
  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>';
  49       }
  50     }
  51     if ($rev == '4.7.alpha4') {
  52       // CRM-17004 Warn of Moneris removal
  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')) {
  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     }
  62   }
  63
  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.
  71    */
  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();
  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>';
  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).');
  99
 100       $postUpgradeMessage .= '<p>' . ts('The custom fatal error template setting has been removed.') . '</p>';
 101     }
 102   }
 103
 104   /**
 105    * Upgrade function.
 106    *
 107    * @param string $rev
 108    */
 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);
 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);
 123     $this->addTask(ts('Remove %1', array(1 => 'Moneris')), 'removePaymentProcessorType', 'Moneris');
 124     $this->addTask('Update Smart Groups', 'fixContactTypeInSmartGroups');
 125   }
 126
 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
 137   /**
 138    * Upgrade function.
 139    *
 140    * @param string $rev
 141    */
 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');
 146   }
 147
 148   /**
 149    * Upgrade function.
 150    *
 151    * @param string $rev
 152    */
 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');
 156   }
 157
 158   /**
 159    * Upgrade function.
 160    *
 161    * @param string $rev
 162    */
 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');
 168   }
 169
 170   /**
 171    * Upgrade function.
 172    *
 173    * @param string $rev
 174    */
 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');
 178   }
 179
 180   /**
 181    * Upgrade function.
 182    *
 183    * @param string $rev
 184    */
 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');
 188   }
 189
 190   /**
 191    * Upgrade function.
 192    *
 193    * @param string $rev
 194    */
 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');
 200     }
 201   }
 202
 203   /**
 204    * Upgrade function.
 205    *
 206    * @param string $rev
 207    */
 208   public function upgrade_4_7_8($rev) {
 209     $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
 210     $this->addTask('Upgrade mailing foreign key constraints', 'upgradeMailingFKs');
 211   }
 212
 213   /**
 214    * Upgrade function.
 215    *
 216    * @param string $rev
 217    */
 218   public function upgrade_4_7_10($rev) {
 219     $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
 220     $this->addTask(ts('Upgrade Add Help Pre and Post Fields to price value table'), 'addHelpPreAndHelpPostFieldsPriceFieldValue');
 221   }
 222
 223   /*
 224    * Important! All upgrade functions MUST call the 'runSql' task.
 225    * Uncomment and use the following template for a new upgrade version
 226    * (change the x in the function name):
 227    */
 228
 229   //  /**
 230   //   * Upgrade function.
 231   //   *
 232   //   * @param string $rev
 233   //   */
 234   //  public function upgrade_4_7_x($rev) {
 235   //    $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
 236   //    // Additional tasks here...
 237   //  }
 238
 239   /**
 240    * CRM-16354
 241    *
 242    * @return int
 243    */
 244   public static function updateWysiwyg() {
 245     $editorID = Civi::settings()->get('editor_id');
 246     // Previously a numeric value indicated one of 4 wysiwyg editors shipped in core, and no value indicated 'Textarea'
 247     // Now the options are "Textarea", "CKEditor", and the rest have been dropped from core.
 248     $newEditor = $editorID ? "CKEditor" : "Textarea";
 249     Civi::settings()->set('editor_id', $newEditor);
 250
 251     return $editorID;
 252   }
 253
 254   /**
 255    * Migrate any last remaining options from `civicrm_domain.config_backend` to `civicrm_setting`.
 256    * Cleanup setting schema.
 257    *
 258    * @param CRM_Queue_TaskContext $ctx
 259    * @return bool
 260    */
 261   public function migrateSettings(CRM_Queue_TaskContext $ctx) {
 262     // Tip: If there are problems with adding the new uniqueness index, try inspecting:
 263     // SELECT name, domain_id, contact_id, count(*) AS dupes FROM civicrm_setting cs GROUP BY name, domain_id, contact_id HAVING dupes > 1;
 264
 265     // Nav records are expendable. https://forum.civicrm.org/index.php?topic=36933.0
 266     CRM_Core_DAO::executeQuery('DELETE FROM civicrm_setting WHERE contact_id IS NOT NULL AND name = "navigation"');
 267
 268     CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting DROP INDEX index_group_name');
 269     CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting DROP COLUMN group_name');
 270
 271     // Handle Strange activity_tab_filter settings.
 272     CRM_Core_DAO::executeQuery('CREATE TABLE civicrm_activity_setting LIKE civicrm_setting');
 273     CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_activity_setting ADD UNIQUE INDEX index_domain_contact_name (domain_id, contact_id, name)');
 274     CRM_Core_DAO::executeQuery('INSERT INTO civicrm_activity_setting (name, contact_id, domain_id, value)
 275      SELECT DISTINCT name, contact_id, domain_id, value
 276      FROM civicrm_setting
 277      WHERE name = "activity_tab_filter"
 278      AND value is not NULL');
 279     CRM_Core_DAO::executeQuery('DELETE FROM civicrm_setting WHERE name = "activity_tab_filter"');
 280
 281     $date = CRM_Utils_Time::getTime('Y-m-d H:i:s');
 282     CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting ADD UNIQUE INDEX index_domain_contact_name (domain_id, contact_id, name)');
 283     CRM_Core_DAO::executeQuery("INSERT INTO civicrm_setting (name, contact_id, domain_id, value, is_domain, created_id, created_date)
 284      SELECT name, contact_id, domain_id, value, 0, contact_id,'$date'
 285      FROM civicrm_activity_setting
 286      WHERE name = 'activity_tab_filter'
 287      AND value is not NULL"
 288     );
 289     CRM_Core_DAO::executeQuery('DROP TABLE civicrm_activity_setting');
 290
 291     $domainDao = CRM_Core_DAO::executeQuery('SELECT id, config_backend FROM civicrm_domain');
 292     while ($domainDao->fetch()) {
 293       $settings = CRM_Upgrade_Incremental_php_FourSeven::convertBackendToSettings($domainDao->id, $domainDao->config_backend);
 294       CRM_Core_Error::debug_var('convertBackendToSettings', array(
 295         'domainId' => $domainDao->id,
 296         'backend' => $domainDao->config_backend,
 297         'settings' => $settings,
 298       ));
 299
 300       foreach ($settings as $name => $value) {
 301         $rowParams = array(
 302           1 => array($domainDao->id, 'Positive'),
 303           2 => array($name, 'String'),
 304           3 => array(serialize($value), 'String'),
 305         );
 306         $settingId = CRM_Core_DAO::singleValueQuery(
 307           'SELECT id FROM civicrm_setting WHERE domain_id = %1 AND name = %2',
 308           $rowParams);
 309         if (!$settingId) {
 310           CRM_Core_DAO::executeQuery(
 311             'INSERT INTO civicrm_setting (domain_id, name, value, is_domain) VALUES (%1,%2,%3,1)',
 312             $rowParams);
 313         }
 314       }
 315     }
 316
 317     CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_domain DROP COLUMN config_backend');
 318
 319     return TRUE;
 320   }
 321
 322   /**
 323    * Take a config_backend blob and produce an equivalent list of settings.
 324    *
 325    * @param int $domainId
 326    *   Domain ID.
 327    * @param string $config_backend
 328    *   Serialized blob.
 329    * @return array
 330    */
 331   public static function convertBackendToSettings($domainId, $config_backend) {
 332     if (!$config_backend) {
 333       return array();
 334     }
 335
 336     $backend = unserialize($config_backend);
 337     if (!$backend) {
 338       return array();
 339     }
 340
 341     $mappings = \CRM_Core_Config_MagicMerge::getPropertyMap();
 342     $settings = array();
 343     foreach ($backend as $propertyName => $propertyValue) {
 344       if (isset($mappings[$propertyName][0]) && preg_match('/^setting/', $mappings[$propertyName][0])) {
 345         // $mapping format: $propertyName => Array(0 => $type, 1 => $setting|NULL).
 346         $settingName = isset($mappings[$propertyName][1]) ? $mappings[$propertyName][1] : $propertyName;
 347         $settings[$settingName] = $propertyValue;
 348       }
 349     }
 350
 351     return $settings;
 352   }
 353
 354   /**
 355    * Add Getting Started dashlet to dashboard
 356    *
 357    * @param \CRM_Queue_TaskContext $ctx
 358    *
 359    * @return bool
 360    */
 361   public function addGettingStartedDashlet(CRM_Queue_TaskContext $ctx) {
 362     $sql = "SELECT count(*) FROM civicrm_dashboard WHERE name='getting-started'";
 363     $res = CRM_Core_DAO::singleValueQuery($sql);
 364     $domainId = CRM_Core_Config::domainID();
 365     if ($res <= 0) {
 366       $sql = "INSERT INTO `civicrm_dashboard`
 367     ( `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)";
 368       CRM_Core_DAO::executeQuery($sql);
 369       // Add default position for Getting Started Dashlet ( left column)
 370       $sql = "INSERT INTO `civicrm_dashboard_contact` (dashboard_id, contact_id, column_no, is_active)
 371 SELECT (SELECT MAX(id) FROM `civicrm_dashboard`), contact_id, 0, IF (SUM(is_active) > 0, 1, 0)
 372 FROM `civicrm_dashboard_contact` JOIN `civicrm_contact` WHERE civicrm_dashboard_contact.contact_id = civicrm_contact.id GROUP BY contact_id";
 373       CRM_Core_DAO::executeQuery($sql);
 374     }
 375     return TRUE;
 376   }
 377
 378   /**
 379    * Migrate on-behalf information to uf_join.module_data as on-behalf columns will be dropped
 380    * on DB upgrade
 381    *
 382    * @param CRM_Queue_TaskContext $ctx
 383    *
 384    * @return bool
 385    *   TRUE for success
 386    */
 387   public static function migrateOnBehalfOfInfo(CRM_Queue_TaskContext $ctx) {
 388     $domain = new CRM_Core_DAO_Domain();
 389     $domain->find(TRUE);
 390
 391     // fetch onBehalf entry in UFJoin table
 392     $ufGroupDAO = new CRM_Core_DAO_UFJoin();
 393     $ufGroupDAO->module = 'OnBehalf';
 394     $ufGroupDAO->find(TRUE);
 395
 396     $forOrgColums = array();
 397     if ($domain->locales) {
 398       $locales = explode(CRM_Core_DAO::VALUE_SEPARATOR, $domain->locales);
 399       foreach ($locales as $locale) {
 400         $forOrgColums[] = "for_organization_{$locale}";
 401       }
 402     }
 403     else {
 404       $forOrgColums[] = "for_organization";
 405     }
 406
 407     $query = "
 408       SELECT " . implode(", ", $forOrgColums) . ", uj.id as join_id, uj.uf_group_id as uf_group_id
 409       FROM civicrm_contribution_page cp
 410        INNER JOIN civicrm_uf_join uj ON uj.entity_id = cp.id AND uj.module = 'OnBehalf'";
 411     $dao = CRM_Core_DAO::executeQuery($query, array(), TRUE, NULL, FALSE, FALSE);
 412
 413     if ($dao->N) {
 414       while ($dao->fetch()) {
 415         $onBehalfParams['on_behalf'] = array('is_for_organization' => $dao->is_for_organization);
 416         if ($domain->locales) {
 417           foreach ($locales as $locale) {
 418             $for_organization = "for_organization_{$locale}";
 419             $onBehalfParams['on_behalf'] += array(
 420               $locale => array(
 421                 'for_organization' => $dao->$for_organization,
 422               ),
 423             );
 424           }
 425         }
 426         else {
 427           $onBehalfParams['on_behalf'] += array(
 428             'default' => array(
 429               'for_organization' => $dao->for_organization,
 430             ),
 431           );
 432         }
 433         $ufJoinParam = array(
 434           'id' => $dao->join_id,
 435           'module' => 'on_behalf',
 436           'uf_group_id' => $dao->uf_group_id,
 437           'module_data' => json_encode($onBehalfParams),
 438         );
 439         CRM_Core_BAO_UFJoin::create($ufJoinParam);
 440       }
 441     }
 442
 443     return TRUE;
 444   }
 445
 446   /**
 447    * CRM-11782 - Get rid of VALUE_SEPARATOR character in saved search form values
 448    *
 449    * @param \CRM_Queue_TaskContext $ctx
 450    *
 451    * @return bool
 452    */
 453   public function fixContactTypeInSmartGroups(CRM_Queue_TaskContext $ctx) {
 454     $sep = CRM_Core_DAO::VALUE_SEPARATOR;
 455     $dao = CRM_Core_DAO::executeQuery("SELECT id, form_values FROM civicrm_saved_search WHERE form_values LIKE '%$sep%'");
 456     while ($dao->fetch()) {
 457       $formValues = unserialize($dao->form_values);
 458       if (isset($formValues['contact_type']) && is_array($formValues['contact_type'])) {
 459         $newVals = array();
 460         foreach ($formValues['contact_type'] as $key => $val) {
 461           $newVals[str_replace($sep, '__', $key)] = is_string($val) ? str_replace($sep, '__', $val) : $val;
 462         }
 463         $formValues['contact_type'] = $newVals;
 464       }
 465       CRM_Core_DAO::executeQuery("UPDATE civicrm_saved_search SET form_values = %1 WHERE id = {$dao->id}", array(1 => array(serialize($formValues), 'String')));
 466     }
 467
 468     return TRUE;
 469   }
 470
 471   /**
 472    * CRM-17637 - Ths file location has been moved; delete the old one
 473    *
 474    * @param \CRM_Queue_TaskContext $ctx
 475    *
 476    * @return bool
 477    */
 478   public function deleteVersionCheckCacheFile(CRM_Queue_TaskContext $ctx) {
 479     $config = CRM_Core_Config::singleton();
 480     $cacheFile = $config->uploadDir . 'version-info-cache.json';
 481     if (file_exists($cacheFile)) {
 482       unlink($cacheFile);
 483     }
 484     return TRUE;
 485   }
 486
 487   /**
 488    * CRM-17669 and CRM-17686, make scheduled jobs more flexible, disable the 4.6 extension if installed
 489    *
 490    * @param \CRM_Queue_TaskContext $ctx
 491    *
 492    * @return bool
 493    */
 494   public function disableFlexibleJobsExtension(CRM_Queue_TaskContext $ctx) {
 495     try {
 496       civicrm_api3('Extension', 'disable', array('key' => 'com.klangsoft.flexiblejobs'));
 497     }
 498     catch (CiviCRM_API3_Exception $e) {
 499       // just ignore if the extension isn't installed
 500     }
 501
 502     return TRUE;
 503   }
 504
 505   /**
 506    * CRM-17752 add index to civicrm_financial_trxn.trxn_id (deliberately non-unique).
 507    *
 508    * @param \CRM_Queue_TaskContext $ctx
 509    *
 510    * @return bool
 511    */
 512   public function addIndexFinancialTrxnTrxnID(CRM_Queue_TaskContext $ctx) {
 513     $tables = array('civicrm_financial_trxn' => array('trxn_id'));
 514     CRM_Core_BAO_SchemaHandler::createIndexes($tables);
 515     return TRUE;
 516   }
 517
 518   /**
 519    * CRM-17882 Add index to civicrm_contribution.credit_note_id.
 520    *
 521    * @param \CRM_Queue_TaskContext $ctx
 522    *
 523    * @return bool
 524    */
 525   public function addIndexContributionCreditNoteID(CRM_Queue_TaskContext $ctx) {
 526     $tables = array('civicrm_contribution' => array('creditnote_id'));
 527     CRM_Core_BAO_SchemaHandler::createIndexes($tables);
 528     return TRUE;
 529   }
 530
 531   /**
 532    * CRM-17775 Add correct index for table civicrm_financial_item.
 533    *
 534    * Note that the entity ID should always precede the entity_table as
 535    * it is more unique. This is better for performance and does not cause fallback
 536    * to no index if table it omitted.
 537    *
 538    * @return bool
 539    */
 540   public function addCombinedIndexFinancialItemEntityIDEntityType() {
 541     CRM_Core_BAO_SchemaHandler::dropIndexIfExists('civicrm_financial_item', 'UI_id');
 542     CRM_Core_BAO_SchemaHandler::dropIndexIfExists('civicrm_financial_item', 'IX_Entity');
 543     CRM_Core_BAO_SchemaHandler::createIndexes(array(
 544       'civicrm_financial_item' => array(array('entity_id', 'entity_table')),
 545     ));
 546     return TRUE;
 547   }
 548
 549   /**
 550    * CRM-17951 Add accounts option values for refund and chargeback.
 551    *
 552    * Add Chargeback contribution status and Chargeback and Contra account relationships,
 553    * checking first if one exists.
 554    */
 555   public function addRefundAndChargeBackAccountsIfNotExist() {
 556     // First we enable and edit the record for Credit contra - this exists but is disabled for most sites.
 557     // Using the ensure function (below) will not enabled a disabled option (by design).
 558     CRM_Core_DAO::executeQuery("UPDATE civicrm_option_value v
 559      INNER JOIN civicrm_option_group g on v.option_group_id=g.id and g.name='account_relationship'
 560      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'
 561      WHERE v.name = 'Credit/Contra Account is';");
 562
 563     CRM_Core_BAO_OptionValue::ensureOptionValueExists(array(
 564       'option_group_id' => 'account_relationship',
 565       'name' => 'Chargeback Account is',
 566       'label' => ts('Chargeback Account is'),
 567       'is_active' => TRUE,
 568       'component_id' => 'CiviContribute',
 569     ));
 570
 571     CRM_Core_BAO_OptionValue::ensureOptionValueExists(array(
 572       'option_group_id' => 'contribution_status',
 573       'name' => 'Chargeback',
 574       'label' => ts('Chargeback'),
 575       'is_active' => TRUE,
 576       'component_id' => 'CiviContribute',
 577     ));
 578     return TRUE;
 579   }
 580
 581   /**
 582    * CRM-17999 Add index to civicrm_contribution.source.
 583    *
 584    * @param \CRM_Queue_TaskContext $ctx
 585    *
 586    * @return bool
 587    */
 588   public function addIndexContributionSource(CRM_Queue_TaskContext $ctx) {
 589     CRM_Core_BAO_SchemaHandler::createIndexes(array('civicrm_contribution' => array('source')));
 590     return TRUE;
 591   }
 592
 593   /**
 594    * CRM-18124 Add index to civicrm_contribution.total_amount.
 595    *
 596    * Note that I made this a combined index with receive_date because the issue included
 597    * both criteria and they seemed likely to be used in conjunction to me in other cases.
 598    *
 599    * @param \CRM_Queue_TaskContext $ctx
 600    *
 601    * @return bool
 602    */
 603   public function addIndexContributionAmount(CRM_Queue_TaskContext $ctx) {
 604     CRM_Core_BAO_SchemaHandler::createIndexes(array(
 605       'civicrm_contribution' => array(array('total_amount', 'receive_date')),
 606     ));
 607     return TRUE;
 608   }
 609
 610   /**
 611    * CRM-18124 Add index to civicrm_contribution.total_amount.
 612    *
 613    * Note that I made this a combined index with receive_date because the issue included
 614    * both criteria and they seemed likely to be used in conjunction to me in other cases.
 615    *
 616    * @param \CRM_Queue_TaskContext $ctx
 617    *
 618    * @return bool
 619    */
 620   public function addDeletedByMergeActivityType(CRM_Queue_TaskContext $ctx) {
 621     CRM_Core_BAO_OptionValue::ensureOptionValueExists(array(
 622       'option_group_id' => 'activity_type',
 623       'name' => 'Contact Deleted by Merge',
 624       'label' => ts('Contact Deleted by Merge'),
 625       'description' => ts('Contact was merged into another contact'),
 626       'is_active' => TRUE,
 627       'filter' => 1,
 628     ));
 629     return TRUE;
 630   }
 631
 632   /**
 633    * CRM-12252 Add Help Pre and Help Post Fields for Price Field Value Table.
 634    *
 635    * @param \CRM_Queue_TaskContext $ctx
 636    *
 637    * @return bool
 638    */
 639   public function addHelpPreAndHelpPostFieldsPriceFieldValue(CRM_Queue_TaskContext $ctx) {
 640     $domain = new CRM_Core_DAO_Domain();
 641     $domain->find(TRUE);
 642     if ($domain->locales) {
 643       $locales = explode(CRM_Core_DAO::VALUE_SEPARATOR, $domain->locales);
 644       foreach ($locales as $locale) {
 645         if (!CRM_Core_BAO_SchemaHandler::checkIfFieldExists("civicrm_price_field_value", "help_pre_{$locale}")) {
 646           CRM_Core_DAO::executeQuery("ALTER TABLE `civicrm_price_field_value`
 647             ADD COLUMN `help_pre_{$locale}` text COLLATE utf8_unicode_ci COMMENT 'Price field option pre help text.'", array(), TRUE, NULL, FALSE, FALSE);
 648         }
 649         if (!CRM_Core_BAO_SchemaHandler::checkIfFieldExists("civicrm_price_field_value", "help_post_{$locale}")) {
 650           CRM_Core_DAO::executeQuery("ALTER TABLE `civicrm_price_field_value`
 651             ADD COLUMN `help_post_{$locale}` text COLLATE utf8_unicode_ci COMMENT 'Price field option post help text.'", array(), TRUE, NULL, FALSE, FALSE);
 652         }
 653       }
 654       CRM_Core_I18n_Schema::rebuildMultilingualSchema($locales, NULL);
 655     }
 656     else {
 657       if (!CRM_Core_BAO_SchemaHandler::checkIfFieldExists('civicrm_price_field_value', 'help_pre')) {
 658         CRM_Core_DAO::executeQuery("ALTER TABLE `civicrm_price_field_value`
 659           ADD COLUMN `help_pre` text COLLATE utf8_unicode_ci COMMENT 'Price field option pre help text.'");
 660       }
 661       if (!CRM_Core_BAO_SchemaHandler::checkIfFieldExists('civicrm_price_field_value', 'help_post')) {
 662         CRM_Core_DAO::executeQuery("ALTER TABLE `civicrm_price_field_value`
 663           ADD COLUMN `help_post` text COLLATE utf8_unicode_ci COMMENT 'Price field option post help text.'");
 664       }
 665     }
 666     return TRUE;
 667   }
 668
 669   /**
 670    * CRM-18345 Don't delete mailing data on email/phone deletion
 671    * Implemented here in CRM-18526
 672    *
 673    * @param \CRM_Queue_TaskContext $ctx
 674    *
 675    * @return bool
 676    */
 677   public function upgradeMailingFKs(CRM_Queue_TaskContext $ctx) {
 678
 679     // Safely drop the foreign keys
 680     CRM_Core_BAO_SchemaHandler::safeRemoveFK('civicrm_mailing_event_queue', 'FK_civicrm_mailing_event_queue_email_id');
 681     CRM_Core_BAO_SchemaHandler::safeRemoveFK('civicrm_mailing_event_queue', 'FK_civicrm_mailing_event_queue_phone_id');
 682     CRM_Core_BAO_SchemaHandler::safeRemoveFK('civicrm_mailing_recipients', 'FK_civicrm_mailing_recipients_email_id');
 683     CRM_Core_BAO_SchemaHandler::safeRemoveFK('civicrm_mailing_recipients', 'FK_civicrm_mailing_recipients_phone_id');
 684
 685     // Set up the new foreign keys
 686     CRM_Core_DAO::executeQuery("SET FOREIGN_KEY_CHECKS = 0;");
 687
 688     CRM_Core_DAO::executeQuery("
 689       ALTER TABLE `civicrm_mailing_event_queue`
 690         ADD CONSTRAINT `FK_civicrm_mailing_event_queue_email_id`
 691         FOREIGN KEY (`email_id`)
 692         REFERENCES `civicrm_email`(`id`)
 693         ON DELETE SET NULL
 694         ON UPDATE RESTRICT;
 695     ");
 696
 697     CRM_Core_DAO::executeQuery("
 698       ALTER TABLE `civicrm_mailing_event_queue`
 699         ADD CONSTRAINT `FK_civicrm_mailing_event_queue_phone_id`
 700         FOREIGN KEY (`phone_id`)
 701         REFERENCES `civicrm_phone`(`id`)
 702         ON DELETE SET NULL
 703         ON UPDATE RESTRICT;
 704     ");
 705
 706     CRM_Core_DAO::executeQuery("
 707       ALTER TABLE `civicrm_mailing_recipients`
 708         ADD CONSTRAINT `FK_civicrm_mailing_recipients_email_id`
 709         FOREIGN KEY (`email_id`)
 710         REFERENCES `civicrm_email`(`id`)
 711         ON DELETE SET NULL
 712         ON UPDATE RESTRICT;
 713     ");
 714
 715     CRM_Core_DAO::executeQuery("
 716       ALTER TABLE `civicrm_mailing_recipients`
 717         ADD CONSTRAINT `FK_civicrm_mailing_recipients_phone_id`
 718         FOREIGN KEY (`phone_id`)
 719         REFERENCES `civicrm_phone`(`id`)
 720         ON DELETE SET NULL
 721         ON UPDATE RESTRICT;
 722     ");
 723
 724     CRM_Core_DAO::executeQuery("SET FOREIGN_KEY_CHECKS = 1;");
 725
 726     return TRUE;
 727   }
 728
 729 }