3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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 $preUpgradeMessage
40 * a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
41 * @param null $currentVer
45 public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) {
46 if ($rev == '4.7.alpha1') {
48 // CRM-16478 Remove custom fatal error template path option
49 $config = CRM_Core_Config
::singleton();
50 if (!empty($config->fatalErrorTemplate
) && $config->fatalErrorTemplate
!= 'CRM/common/fatal.tpl') {
51 $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>';
57 * Compute any messages which should be displayed after upgrade.
59 * @param string $postUpgradeMessage
62 * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
65 public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
66 if ($rev == '4.7.alpha1') {
67 $config = CRM_Core_Config
::singleton();
68 // FIXME: Performing an upgrade step during postUpgrade message phase is probably bad
69 $editor_id = self
::updateWysiwyg();
71 $ext_href = 'href="' . CRM_Utils_System
::url('civicrm/admin/extensions', 'reset=1') . '"';
72 $dsp_href = 'href="' . CRM_Utils_System
::url('civicrm/admin/setting/preferences/display', 'reset=1') . '"';
73 $blog_href = 'href="https://civicrm.org/blogs/colemanw/big-changes-wysiwyg-editing-47"';
77 $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));
80 // Drupal/Joomla editor
83 $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));
87 $postUpgradeMessage .= '<p>' . $msg . '</p>';
89 $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>';
91 $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).');
93 $postUpgradeMessage .= '<p>' . ts('The custom fatal error template setting has been removed.') . '</p>';
102 public function upgrade_4_7_alpha1($rev) {
103 $this->addTask(ts('Migrate \'on behalf of\' information to module_data'), 'migrateOnBehalfOfInfo');
104 $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
105 $this->addTask(ts('Migrate Settings to %1', array(1 => $rev)), 'migrateSettings', $rev);
106 $this->addTask(ts('Add Getting Started dashlet to %1: SQL', array(1 => $rev)), 'addGettingStartedDashlet', $rev);
114 public static function updateWysiwyg() {
115 $editorID = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'editor_id');
116 // Previously a numeric value indicated one of 4 wysiwyg editors shipped in core, and no value indicated 'Textarea'
117 // Now the options are "Textarea", "CKEditor", and the rest have been dropped from core.
118 $newEditor = $editorID ?
"CKEditor" : "Textarea";
119 CRM_Core_BAO_Setting
::setItem($newEditor, CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'editor_id');
125 * Migrate any last remaining options from `civicrm_domain.config_backend` to `civicrm_setting`.
126 * Cleanup setting schema.
128 * @param CRM_Queue_TaskContext $ctx
131 public function migrateSettings(CRM_Queue_TaskContext
$ctx) {
132 CRM_Core_DAO
::executeQuery('ALTER TABLE civicrm_setting DROP INDEX index_group_name');
133 CRM_Core_DAO
::executeQuery('ALTER TABLE civicrm_setting DROP COLUMN group_name');
134 CRM_Core_DAO
::executeQuery('ALTER TABLE civicrm_setting ADD UNIQUE INDEX index_domain_contact_name (domain_id, contact_id, name)');
136 $domainDao = CRM_Core_DAO
::executeQuery('SELECT id, config_backend FROM civicrm_domain');
137 while ($domainDao->fetch()) {
138 $settings = CRM_Upgrade_Incremental_php_FourSeven
::convertBackendToSettings($domainDao->id
, $domainDao->config_backend
);
139 CRM_Core_Error
::debug_var('convertBackendToSettings', array(
140 'domainId' => $domainDao->id
,
141 'backend' => $domainDao->config_backend
,
142 'settings' => $settings,
145 foreach ($settings as $name => $value) {
147 1 => array($domainDao->id
, 'Positive'),
148 2 => array($name, 'String'),
149 3 => array(serialize($value), 'String'),
151 $settingId = CRM_Core_DAO
::singleValueQuery(
152 'SELECT id FROM civicrm_setting WHERE domain_id = %1 AND name = %2',
155 CRM_Core_DAO
::executeQuery(
156 'INSERT INTO civicrm_setting (domain_id, name, value, is_domain) VALUES (%1,%2,%3,1)',
162 // TODO Should drop config_backend, but keeping it during alpha/beta cycle in case we miss something.
163 // CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_domain DROP COLUMN config_backend');
169 * Take a config_backend blob and produce an equivalent list of settings.
171 * @param int $domainId
173 * @param string $config_backend
177 public static function convertBackendToSettings($domainId, $config_backend) {
178 if (!$config_backend) {
182 $backend = unserialize($config_backend);
187 $mappings = \CRM_Core_Config_MagicMerge
::getPropertyMap();
189 foreach ($backend as $propertyName => $propertyValue) {
190 if (isset($mappings[$propertyName][0]) && preg_match('/^setting/', $mappings[$propertyName][0])) {
191 // $mapping format: $propertyName => Array(0 => $type, 1 => $setting|NULL).
192 $settingName = isset($mappings[$propertyName][1]) ?
$mappings[$propertyName][1] : $propertyName;
193 $settings[$settingName] = $propertyValue;
201 * Add Getting Started dashlet to dashboard
203 * @param \CRM_Queue_TaskContext $ctx
207 public function addGettingStartedDashlet(CRM_Queue_TaskContext
$ctx) {
208 $sql = "SELECT count(*) FROM civicrm_dashboard WHERE name='gettingStarted'";
209 $res = CRM_Core_DAO
::singleValueQuery($sql);
210 $domainId = CRM_Core_Config
::domainID();
212 $sql = "INSERT INTO `civicrm_dashboard`
213 ( `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)";
214 CRM_Core_DAO
::executeQuery($sql);
215 // Add default position for Getting Started Dashlet ( left column)
216 $sql = "INSERT INTO `civicrm_dashboard_contact` (dashboard_id, contact_id, column_no, is_active)
217 SELECT (SELECT MAX(id) FROM `civicrm_dashboard`), contact_id, 0, IF (SUM(is_active) > 0, 1, 0)
218 FROM `civicrm_dashboard_contact` WHERE 1 GROUP BY contact_id";
219 CRM_Core_DAO
::executeQuery($sql);
225 * Migrate on-behalf information to uf_join.module_data as on-behalf columns will be dropped
228 * @param CRM_Queue_TaskContext $ctx
233 public static function migrateOnBehalfOfInfo(CRM_Queue_TaskContext
$ctx) {
234 $domain = new CRM_Core_DAO_Domain();
237 // fetch onBehalf entry in UFJoin table
238 $ufGroupDAO = new CRM_Core_DAO_UFJoin();
239 $ufGroupDAO->module
= 'OnBehalf';
240 $ufGroupDAO->find(TRUE);
242 $forOrgColums = array();
243 if ($domain->locales
) {
244 $locales = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $domain->locales
);
245 foreach ($locales as $locale) {
246 $forOrgColums[] = "for_organization_{$locale}";
250 $forOrgColums[] = "for_organization";
254 SELECT " . implode(", ", $forOrgColums) . ", uj.id as join_id, uj.uf_group_id as uf_group_id
255 FROM civicrm_contribution_page cp
256 INNER JOIN civicrm_uf_join uj ON uj.entity_id = cp.id AND uj.module = 'OnBehalf'";
257 $dao = CRM_Core_DAO
::executeQuery($query, array(), TRUE, NULL, FALSE, FALSE);
260 while ($dao->fetch()) {
261 $onBehalfParams['on_behalf'] = array('is_for_organization' => $dao->is_for_organization
);
262 if ($domain->locales
) {
263 foreach ($locales as $locale) {
264 $for_organization = "for_organization_{$locale}";
265 $onBehalfParams['on_behalf'] +
= array(
267 'for_organization' => $dao->$for_organization,
273 $onBehalfParams['on_behalf'] +
= array(
275 'for_organization' => $dao->for_organization
,
279 $ufJoinParam = array(
280 'id' => $dao->join_id
,
281 'module' => 'on_behalf',
282 'uf_group_id' => $dao->uf_group_id
,
283 'module_data' => json_encode($onBehalfParams),
285 CRM_Core_BAO_UFJoin
::create($ufJoinParam);