[civicrm-core.git] / CRM / Upgrade / Incremental / php / FourSeven.php

<?php
/*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.7                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2015                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007.                                       |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License along with this program; if not, contact CiviCRM LLC       |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
 */

/**
 * Upgrade logic for 4.7
 */
class CRM_Upgrade_Incremental_php_FourSeven extends CRM_Upgrade_Incremental_Base {

  /**
   * Compute any messages which should be displayed beforeupgrade.
   *
   * Note: This function is called iteratively for each upcoming
   * revision to the database.
   *
   * @param string $preUpgradeMessage
   * @param string $rev
   *   a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
   * @param null $currentVer
   */
  public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
    if ($rev == '4.7.alpha1') {
      // CRM-16478 Remove custom fatal error template path option
      $config = CRM_Core_Config::singleton();
      if (!empty($config->fatalErrorTemplate) && $config->fatalErrorTemplate != 'CRM/common/fatal.tpl') {
        $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>';
      }
    }
    if ($rev == '4.7.alpha4') {
      // CRM-17004 Warn of Moneris removal
      $count = 1;
      // Query only works in 4.3+
      if (version_compare($currentVer, "4.3.0") > 0) {
        $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')");
      }
      if ($count && !function_exists('moneris_civicrm_managed')) {
        $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>';
      }
    }
  }

  /**
   * Compute any messages which should be displayed after upgrade.
   *
   * @param string $postUpgradeMessage
   *   alterable.
   * @param string $rev
   *   an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
   */
  public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
    if ($rev == '4.7.alpha1') {
      $config = CRM_Core_Config::singleton();
      // FIXME: Performing an upgrade step during postUpgrade message phase is probably bad
      $editor_id = self::updateWysiwyg();
      $msg = NULL;
      $ext_href = 'href="' . CRM_Utils_System::url('civicrm/admin/extensions', 'reset=1') . '"';
      $dsp_href = 'href="' . CRM_Utils_System::url('civicrm/admin/setting/preferences/display', 'reset=1') . '"';
      $blog_href = 'href="https://civicrm.org/blogs/colemanw/big-changes-wysiwyg-editing-47"';
      switch ($editor_id) {
        // TinyMCE
        case 1:
          $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));
          break;

        // Drupal/Joomla editor
        case 3:
        case 4:
          $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));
          break;
      }
      if ($msg) {
        $postUpgradeMessage .= '<p>' . $msg . '</p>';
      }
      $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>';

      $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).');

      $postUpgradeMessage .= '<p>' . ts('The custom fatal error template setting has been removed.') . '</p>';
    }
  }

  /**
   * Upgrade function.
   *
   * @param string $rev
   */
  public function upgrade_4_7_alpha1($rev) {
    $this->addTask('Migrate \'on behalf of\' information to module_data', 'migrateOnBehalfOfInfo');
    $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
    $this->addTask(ts('Migrate Settings to %1', array(1 => $rev)), 'migrateSettings', $rev);
    $this->addTask('Add Getting Started dashlet', 'addGettingStartedDashlet', $rev);
  }

  /**
   * Upgrade function.
   *
   * @param string $rev
   */
  public function upgrade_4_7_alpha4($rev) {
    $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
    $this->addTask(ts('Remove %1', array(1 => 'Moneris')), 'removePaymentProcessorType', 'Moneris');
    $this->addTask('Update Smart Groups', 'fixContactTypeInSmartGroups');
  }

  /**
   * Upgrade function.
   *
   * @param string $rev
   */
  public function upgrade_4_7_beta2($rev) {
    $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
    $this->addTask('Delete unused file', 'deleteVersionCheckCacheFile');
  }

  /**
   * Upgrade function.
   *
   * @param string $rev
   */
  public function upgrade_4_7_beta6($rev) {
    $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
    $this->addTask('Disable flexible jobs extension', 'disableFlexibleJobsExtension');
    $this->addTask('Add Index to financial_trxn trxn_id field', 'addIndexFinancialTrxnTrxnID');
  }

  /**
   * CRM-16354
   *
   * @return int
   */
  public static function updateWysiwyg() {
    $editorID = Civi::settings()->get('editor_id');
    // Previously a numeric value indicated one of 4 wysiwyg editors shipped in core, and no value indicated 'Textarea'
    // Now the options are "Textarea", "CKEditor", and the rest have been dropped from core.
    $newEditor = $editorID ? "CKEditor" : "Textarea";
    Civi::settings()->set('editor_id', $newEditor);

    return $editorID;
  }

  /**
   * Migrate any last remaining options from `civicrm_domain.config_backend` to `civicrm_setting`.
   * Cleanup setting schema.
   *
   * @param CRM_Queue_TaskContext $ctx
   * @return bool
   */
  public function migrateSettings(CRM_Queue_TaskContext $ctx) {
    // Tip: If there are problems with adding the new uniqueness index, try inspecting:
    // SELECT name, domain_id, contact_id, count(*) AS dupes FROM civicrm_setting cs GROUP BY name, domain_id, contact_id HAVING dupes > 1;

    // Nav records are expendable. https://forum.civicrm.org/index.php?topic=36933.0
    CRM_Core_DAO::executeQuery('DELETE FROM civicrm_setting WHERE contact_id IS NOT NULL AND name = "navigation"');

    CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting DROP INDEX index_group_name');
    CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting DROP COLUMN group_name');
    CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting ADD UNIQUE INDEX index_domain_contact_name (domain_id, contact_id, name)');

    $domainDao = CRM_Core_DAO::executeQuery('SELECT id, config_backend FROM civicrm_domain');
    while ($domainDao->fetch()) {
      $settings = CRM_Upgrade_Incremental_php_FourSeven::convertBackendToSettings($domainDao->id, $domainDao->config_backend);
      CRM_Core_Error::debug_var('convertBackendToSettings', array(
        'domainId' => $domainDao->id,
        'backend' => $domainDao->config_backend,
        'settings' => $settings,
      ));

      foreach ($settings as $name => $value) {
        $rowParams = array(
          1 => array($domainDao->id, 'Positive'),
          2 => array($name, 'String'),
          3 => array(serialize($value), 'String'),
        );
        $settingId = CRM_Core_DAO::singleValueQuery(
          'SELECT id FROM civicrm_setting WHERE domain_id = %1 AND name = %2',
          $rowParams);
        if (!$settingId) {
          CRM_Core_DAO::executeQuery(
            'INSERT INTO civicrm_setting (domain_id, name, value, is_domain) VALUES (%1,%2,%3,1)',
            $rowParams);
        }
      }
    }

    CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_domain DROP COLUMN config_backend');

    return TRUE;
  }

  /**
   * Take a config_backend blob and produce an equivalent list of settings.
   *
   * @param int $domainId
   *   Domain ID.
   * @param string $config_backend
   *   Serialized blob.
   * @return array
   */
  public static function convertBackendToSettings($domainId, $config_backend) {
    if (!$config_backend) {
      return array();
    }

    $backend = unserialize($config_backend);
    if (!$backend) {
      return array();
    }

    $mappings = \CRM_Core_Config_MagicMerge::getPropertyMap();
    $settings = array();
    foreach ($backend as $propertyName => $propertyValue) {
      if (isset($mappings[$propertyName][0]) && preg_match('/^setting/', $mappings[$propertyName][0])) {
        // $mapping format: $propertyName => Array(0 => $type, 1 => $setting|NULL).
        $settingName = isset($mappings[$propertyName][1]) ? $mappings[$propertyName][1] : $propertyName;
        $settings[$settingName] = $propertyValue;
      }
    }

    return $settings;
  }

  /**
   * Add Getting Started dashlet to dashboard
   *
   * @param \CRM_Queue_TaskContext $ctx
   *
   * @return bool
   */
  public function addGettingStartedDashlet(CRM_Queue_TaskContext $ctx) {
    $sql = "SELECT count(*) FROM civicrm_dashboard WHERE name='gettingStarted'";
    $res = CRM_Core_DAO::singleValueQuery($sql);
    $domainId = CRM_Core_Config::domainID();
    if ($res <= 0) {
      $sql = "INSERT INTO `civicrm_dashboard`
    ( `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)";
      CRM_Core_DAO::executeQuery($sql);
      // Add default position for Getting Started Dashlet ( left column)
      $sql = "INSERT INTO `civicrm_dashboard_contact` (dashboard_id, contact_id, column_no, is_active)
SELECT (SELECT MAX(id) FROM `civicrm_dashboard`), contact_id, 0, IF (SUM(is_active) > 0, 1, 0)
FROM `civicrm_dashboard_contact` WHERE 1 GROUP BY contact_id";
      CRM_Core_DAO::executeQuery($sql);
    }
    return TRUE;
  }

  /**
   * Migrate on-behalf information to uf_join.module_data as on-behalf columns will be dropped
   * on DB upgrade
   *
   * @param CRM_Queue_TaskContext $ctx
   *
   * @return bool
   *   TRUE for success
   */
  public static function migrateOnBehalfOfInfo(CRM_Queue_TaskContext $ctx) {
    $domain = new CRM_Core_DAO_Domain();
    $domain->find(TRUE);

    // fetch onBehalf entry in UFJoin table
    $ufGroupDAO = new CRM_Core_DAO_UFJoin();
    $ufGroupDAO->module = 'OnBehalf';
    $ufGroupDAO->find(TRUE);

    $forOrgColums = array();
    if ($domain->locales) {
      $locales = explode(CRM_Core_DAO::VALUE_SEPARATOR, $domain->locales);
      foreach ($locales as $locale) {
        $forOrgColums[] = "for_organization_{$locale}";
      }
    }
    else {
      $forOrgColums[] = "for_organization";
    }

    $query = "
      SELECT " . implode(", ", $forOrgColums) . ", uj.id as join_id, uj.uf_group_id as uf_group_id
      FROM civicrm_contribution_page cp
       INNER JOIN civicrm_uf_join uj ON uj.entity_id = cp.id AND uj.module = 'OnBehalf'";
    $dao = CRM_Core_DAO::executeQuery($query, array(), TRUE, NULL, FALSE, FALSE);

    if ($dao->N) {
      while ($dao->fetch()) {
        $onBehalfParams['on_behalf'] = array('is_for_organization' => $dao->is_for_organization);
        if ($domain->locales) {
          foreach ($locales as $locale) {
            $for_organization = "for_organization_{$locale}";
            $onBehalfParams['on_behalf'] += array(
              $locale => array(
                'for_organization' => $dao->$for_organization,
              ),
            );
          }
        }
        else {
          $onBehalfParams['on_behalf'] += array(
            'default' => array(
              'for_organization' => $dao->for_organization,
            ),
          );
        }
        $ufJoinParam = array(
          'id' => $dao->join_id,
          'module' => 'on_behalf',
          'uf_group_id' => $dao->uf_group_id,
          'module_data' => json_encode($onBehalfParams),
        );
        CRM_Core_BAO_UFJoin::create($ufJoinParam);
      }
    }

    return TRUE;
  }

  /**
   * CRM-11782 - Get rid of VALUE_SEPARATOR character in saved search form values
   *
   * @param \CRM_Queue_TaskContext $ctx
   *
   * @return bool
   */
  public function fixContactTypeInSmartGroups(CRM_Queue_TaskContext $ctx) {
    $sep = CRM_Core_DAO::VALUE_SEPARATOR;
    $dao = CRM_Core_DAO::executeQuery("SELECT id, form_values FROM civicrm_saved_search WHERE form_values LIKE '%$sep%'");
    while ($dao->fetch()) {
      $formValues = unserialize($dao->form_values);
      if (isset($formValues['contact_type']) && is_array($formValues['contact_type'])) {
        $newVals = array();
        foreach ($formValues['contact_type'] as $key => $val) {
          $newVals[str_replace($sep, '__', $key)] = is_string($val) ? str_replace($sep, '__', $val) : $val;
        }
        $formValues['contact_type'] = $newVals;
      }
      CRM_Core_DAO::executeQuery("UPDATE civicrm_saved_search SET form_values = %1 WHERE id = {$dao->id}", array(1 => array(serialize($formValues), 'String')));
    }

    return TRUE;
  }

  /**
   * CRM-17637 - Ths file location has been moved; delete the old one
   *
   * @param \CRM_Queue_TaskContext $ctx
   *
   * @return bool
   */
  public function deleteVersionCheckCacheFile(CRM_Queue_TaskContext $ctx) {
    $config = CRM_Core_Config::singleton();
    $cacheFile = $config->uploadDir . 'version-info-cache.json';
    if (file_exists($cacheFile)) {
      unlink($cacheFile);
    }
    return TRUE;
  }

  /**
   * CRM-17669 and CRM-17686, make scheduled jobs more flexible, disable the 4.6 extension if installed
   *
   * @param \CRM_Queue_TaskContext $ctx
   *
   * @return bool
   */
  public function disableFlexibleJobsExtension(CRM_Queue_TaskContext $ctx) {
    try {
      civicrm_api3('Extension', 'disable', array('key' => 'com.klangsoft.flexiblejobs'));
    }
    catch (CiviCRM_API3_Exception $e) {
      // just ignore if the extension isn't installed
    }

    return TRUE;
  }

  /**
   * CRM-17752 add index to civicrm_financial_trxn.trxn_id (deliberately non-unique).
   *
   * @param \CRM_Queue_TaskContext $ctx
   *
   * @return bool
   */
  public function addIndexFinancialTrxnTrxnID(CRM_Queue_TaskContext $ctx) {
    $tables = array('civicrm_financial_trxn' => array('trxn_id'));
    CRM_Core_BAO_SchemaHandler::createIndexes($tables);
    return TRUE;
  }

}
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
f431d51f J	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>';
f431d51f J	49	}
f431d51f	50	}
a40fd1ac CW	51	if ($rev == '4.7.alpha4') {
a40fd1ac CW	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	}
f431d51f J	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	*/
6cc25669 CW	72	public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
6dbe2c23 CW	73	if ($rev == '4.7.alpha1') {
6dbe2c23 CW	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
dd55005c	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
f431d51f J	100	$postUpgradeMessage .= '<p>' . ts('The custom fatal error template setting has been removed.') . '</p>';
6dbe2c23	101	}
6cc25669 CW	102	}
6cc25669 CW	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	}
6cc25669 CW	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	}
fb1f3850 DRJ	147
6cc25669 CW	148	/**
	149	* CRM-16354
	150	*
6dbe2c23	151	* @return int
6cc25669	152	*/
6dbe2c23	153	public static function updateWysiwyg() {
aaffa79f	154	$editorID = Civi::settings()->get('editor_id');
6dbe2c23 CW	155	// Previously a numeric value indicated one of 4 wysiwyg editors shipped in core, and no value indicated 'Textarea'
	156	// Now the options are "Textarea", "CKEditor", and the rest have been dropped from core.
	157	$newEditor = $editorID ? "CKEditor" : "Textarea";
08ef4ddd	158	Civi::settings()->set('editor_id', $newEditor);
6cc25669	159
6dbe2c23	160	return $editorID;
6cc25669 CW	161	}
6cc25669 CW	162
f806379b TO	163	/**
	164	* Migrate any last remaining options from `civicrm_domain.config_backend` to `civicrm_setting`.
	165	* Cleanup setting schema.
	166	*
	167	* @param CRM_Queue_TaskContext $ctx
	168	* @return bool
	169	*/
	170	public function migrateSettings(CRM_Queue_TaskContext $ctx) {
4cc9e637 TO	171	// Tip: If there are problems with adding the new uniqueness index, try inspecting:
	172	// SELECT name, domain_id, contact_id, count(*) AS dupes FROM civicrm_setting cs GROUP BY name, domain_id, contact_id HAVING dupes > 1;
	173
	174	// Nav records are expendable. https://forum.civicrm.org/index.php?topic=36933.0
	175	CRM_Core_DAO::executeQuery('DELETE FROM civicrm_setting WHERE contact_id IS NOT NULL AND name = "navigation"');
	176
f806379b TO	177	CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting DROP INDEX index_group_name');
	178	CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting DROP COLUMN group_name');
	179	CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting ADD UNIQUE INDEX index_domain_contact_name (domain_id, contact_id, name)');
	180
	181	$domainDao = CRM_Core_DAO::executeQuery('SELECT id, config_backend FROM civicrm_domain');
	182	while ($domainDao->fetch()) {
	183	$settings = CRM_Upgrade_Incremental_php_FourSeven::convertBackendToSettings($domainDao->id, $domainDao->config_backend);
	184	CRM_Core_Error::debug_var('convertBackendToSettings', array(
	185	'domainId' => $domainDao->id,
	186	'backend' => $domainDao->config_backend,
	187	'settings' => $settings,
	188	));
	189
	190	foreach ($settings as $name => $value) {
	191	$rowParams = array(
	192	1 => array($domainDao->id, 'Positive'),
	193	2 => array($name, 'String'),
	194	3 => array(serialize($value), 'String'),
	195	);
	196	$settingId = CRM_Core_DAO::singleValueQuery(
	197	'SELECT id FROM civicrm_setting WHERE domain_id = %1 AND name = %2',
	198	$rowParams);
	199	if (!$settingId) {
	200	CRM_Core_DAO::executeQuery(
	201	'INSERT INTO civicrm_setting (domain_id, name, value, is_domain) VALUES (%1,%2,%3,1)',
	202	$rowParams);
	203	}
	204	}
	205	}
	206
9e726168	207	CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_domain DROP COLUMN config_backend');
f806379b TO	208
	209	return TRUE;
	210	}
	211
	212	/**
	213	* Take a config_backend blob and produce an equivalent list of settings.
	214	*
	215	* @param int $domainId
	216	* Domain ID.
	217	* @param string $config_backend
	218	* Serialized blob.
	219	* @return array
	220	*/
	221	public static function convertBackendToSettings($domainId, $config_backend) {
	222	if (!$config_backend) {
	223	return array();
	224	}
	225
	226	$backend = unserialize($config_backend);
	227	if (!$backend) {
	228	return array();
	229	}
	230
	231	$mappings = \CRM_Core_Config_MagicMerge::getPropertyMap();
	232	$settings = array();
	233	foreach ($backend as $propertyName => $propertyValue) {
	234	if (isset($mappings[$propertyName][0]) && preg_match('/^setting/', $mappings[$propertyName][0])) {
	235	// $mapping format: $propertyName => Array(0 => $type, 1 => $setting\|NULL).
	236	$settingName = isset($mappings[$propertyName][1]) ? $mappings[$propertyName][1] : $propertyName;
	237	$settings[$settingName] = $propertyValue;
	238	}
	239	}
	240
	241	return $settings;
	242	}
	243
0a95c936	244	/**
	245	* Add Getting Started dashlet to dashboard
	246	*
	247	* @param \CRM_Queue_TaskContext $ctx
	248	*
	249	* @return bool
	250	*/
	251	public function addGettingStartedDashlet(CRM_Queue_TaskContext $ctx) {
e1674273	252	$sql = "SELECT count(*) FROM civicrm_dashboard WHERE name='gettingStarted'";
	253	$res = CRM_Core_DAO::singleValueQuery($sql);
	254	$domainId = CRM_Core_Config::domainID();
	255	if ($res <= 0) {
	256	$sql = "INSERT INTO `civicrm_dashboard`
a8b704c5	257	( `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	258	CRM_Core_DAO::executeQuery($sql);
	259	// Add default position for Getting Started Dashlet ( left column)
	260	$sql = "INSERT INTO `civicrm_dashboard_contact` (dashboard_id, contact_id, column_no, is_active)
	261	SELECT (SELECT MAX(id) FROM `civicrm_dashboard`), contact_id, 0, IF (SUM(is_active) > 0, 1, 0)
	262	FROM `civicrm_dashboard_contact` WHERE 1 GROUP BY contact_id";
	263	CRM_Core_DAO::executeQuery($sql);
	264	}
0a95c936	265	return TRUE;
e1674273	266	}
4175ee03	267
6b1e1a2c	268	/**
	269	* Migrate on-behalf information to uf_join.module_data as on-behalf columns will be dropped
	270	* on DB upgrade
	271	*
	272	* @param CRM_Queue_TaskContext $ctx
	273	*
	274	* @return bool
	275	* TRUE for success
	276	*/
	277	public static function migrateOnBehalfOfInfo(CRM_Queue_TaskContext $ctx) {
d3e92c88	278	$domain = new CRM_Core_DAO_Domain();
d3e92c88	279	$domain->find(TRUE);
6b1e1a2c	280
d3e92c88	281	// fetch onBehalf entry in UFJoin table
6b1e1a2c	282	$ufGroupDAO = new CRM_Core_DAO_UFJoin();
	283	$ufGroupDAO->module = 'OnBehalf';
	284	$ufGroupDAO->find(TRUE);
	285
d3e92c88	286	$forOrgColums = array();
	287	if ($domain->locales) {
	288	$locales = explode(CRM_Core_DAO::VALUE_SEPARATOR, $domain->locales);
	289	foreach ($locales as $locale) {
	290	$forOrgColums[] = "for_organization_{$locale}";
	291	}
	292	}
	293	else {
	294	$forOrgColums[] = "for_organization";
	295	}
	296
	297	$query = "
	298	SELECT " . implode(", ", $forOrgColums) . ", uj.id as join_id, uj.uf_group_id as uf_group_id
	299	FROM civicrm_contribution_page cp
	300	INNER JOIN civicrm_uf_join uj ON uj.entity_id = cp.id AND uj.module = 'OnBehalf'";
	301	$dao = CRM_Core_DAO::executeQuery($query, array(), TRUE, NULL, FALSE, FALSE);
6b1e1a2c	302
6b1e1a2c	303	if ($dao->N) {
6b1e1a2c	304	while ($dao->fetch()) {
	305	$onBehalfParams['on_behalf'] = array('is_for_organization' => $dao->is_for_organization);
	306	if ($domain->locales) {
6b1e1a2c	307	foreach ($locales as $locale) {
	308	$for_organization = "for_organization_{$locale}";
	309	$onBehalfParams['on_behalf'] += array(
	310	$locale => array(
	311	'for_organization' => $dao->$for_organization,
	312	),
	313	);
	314	}
	315	}
	316	else {
	317	$onBehalfParams['on_behalf'] += array(
	318	'default' => array(
	319	'for_organization' => $dao->for_organization,
	320	),
	321	);
	322	}
	323	$ufJoinParam = array(
	324	'id' => $dao->join_id,
	325	'module' => 'on_behalf',
d3e92c88	326	'uf_group_id' => $dao->uf_group_id,
6b1e1a2c	327	'module_data' => json_encode($onBehalfParams),
	328	);
	329	CRM_Core_BAO_UFJoin::create($ufJoinParam);
	330	}
	331	}
	332
	333	return TRUE;
	334	}
cb804cd9	335
b2222b9f CW	336	/**
	337	* CRM-11782 - Get rid of VALUE_SEPARATOR character in saved search form values
	338	*
	339	* @param \CRM_Queue_TaskContext $ctx
	340	*
	341	* @return bool
	342	*/
	343	public function fixContactTypeInSmartGroups(CRM_Queue_TaskContext $ctx) {
	344	$sep = CRM_Core_DAO::VALUE_SEPARATOR;
	345	$dao = CRM_Core_DAO::executeQuery("SELECT id, form_values FROM civicrm_saved_search WHERE form_values LIKE '%$sep%'");
	346	while ($dao->fetch()) {
	347	$formValues = unserialize($dao->form_values);
	348	if (isset($formValues['contact_type']) && is_array($formValues['contact_type'])) {
	349	$newVals = array();
	350	foreach ($formValues['contact_type'] as $key => $val) {
	351	$newVals[str_replace($sep, '__', $key)] = is_string($val) ? str_replace($sep, '__', $val) : $val;
	352	}
	353	$formValues['contact_type'] = $newVals;
	354	}
	355	CRM_Core_DAO::executeQuery("UPDATE civicrm_saved_search SET form_values = %1 WHERE id = {$dao->id}", array(1 => array(serialize($formValues), 'String')));
	356	}
	357
	358	return TRUE;
	359	}
	360
0094ac08 CW	361	/**
	362	* CRM-17637 - Ths file location has been moved; delete the old one
	363	*
	364	* @param \CRM_Queue_TaskContext $ctx
	365	*
	366	* @return bool
	367	*/
	368	public function deleteVersionCheckCacheFile(CRM_Queue_TaskContext $ctx) {
	369	$config = CRM_Core_Config::singleton();
	370	$cacheFile = $config->uploadDir . 'version-info-cache.json';
	371	if (file_exists($cacheFile)) {
	372	unlink($cacheFile);
	373	}
	374	return TRUE;
	375	}
	376
fb1f3850 DRJ	377	/**
	378	* CRM-17669 and CRM-17686, make scheduled jobs more flexible, disable the 4.6 extension if installed
	379	*
	380	* @param \CRM_Queue_TaskContext $ctx
	381	*
	382	* @return bool
	383	*/
	384	public function disableFlexibleJobsExtension(CRM_Queue_TaskContext $ctx) {
d357221c DRJ	385	try {
	386	civicrm_api3('Extension', 'disable', array('key' => 'com.klangsoft.flexiblejobs'));
	387	}
	388	catch (CiviCRM_API3_Exception $e) {
	389	// just ignore if the extension isn't installed
	390	}
fb1f3850 DRJ	391
	392	return TRUE;
	393	}
	394
20d5377e	395	/**
	396	* CRM-17752 add index to civicrm_financial_trxn.trxn_id (deliberately non-unique).
	397	*
	398	* @param \CRM_Queue_TaskContext $ctx
	399	*
	400	* @return bool
	401	*/
	402	public function addIndexFinancialTrxnTrxnID(CRM_Queue_TaskContext $ctx) {
	403	$tables = array('civicrm_financial_trxn' => array('trxn_id'));
	404	CRM_Core_BAO_SchemaHandler::createIndexes($tables);
	405	return TRUE;
	406	}
	407
6cc25669	408	}