Commit | Line | Data |
---|---|---|
6cc25669 CW |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.7 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2015 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License along with this program; if not, contact CiviCRM LLC | | |
21 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
22 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
23 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
24 | +--------------------------------------------------------------------+ | |
25 | */ | |
26 | ||
27 | /** | |
bf6a5362 | 28 | * Upgrade logic for 4.7 |
6cc25669 | 29 | */ |
bf6a5362 | 30 | class CRM_Upgrade_Incremental_php_FourSeven extends CRM_Upgrade_Incremental_Base { |
6cc25669 | 31 | |
f431d51f J |
32 | /** |
33 | * Compute any messages which should be displayed beforeupgrade. | |
34 | * | |
35 | * Note: This function is called iteratively for each upcoming | |
36 | * revision to the database. | |
37 | * | |
3bdf1f3a | 38 | * @param string $preUpgradeMessage |
f431d51f J |
39 | * @param string $rev |
40 | * a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'. | |
41 | * @param null $currentVer | |
f431d51f J |
42 | */ |
43 | public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) { | |
44 | if ($rev == '4.7.alpha1') { | |
f431d51f J |
45 | // CRM-16478 Remove custom fatal error template path option |
46 | $config = CRM_Core_Config::singleton(); | |
18b3bef6 | 47 | if (!empty($config->fatalErrorTemplate) && $config->fatalErrorTemplate != 'CRM/common/fatal.tpl') { |
f431d51f J |
48 | $preUpgradeMessage .= '<p>' . ts('The custom fatal error template setting will be removed during the upgrade. You are currently using this custom template: %1 . Following the upgrade you will need to use the standard approach to overriding template files, as described in the documentation.', array(1 => $config->fatalErrorTemplate)) . '</p>'; |
49 | } | |
f431d51f | 50 | } |
a40fd1ac CW |
51 | if ($rev == '4.7.alpha4') { |
52 | // CRM-17004 Warn of Moneris removal | |
87a33a95 CW |
53 | $count = 1; |
54 | // Query only works in 4.3+ | |
55 | if (version_compare($currentVer, "4.3.0") > 0) { | |
56 | $count = CRM_Core_DAO::singleValueQuery("SELECT COUNT(id) FROM civicrm_payment_processor WHERE payment_processor_type_id IN (SELECT id FROM civicrm_payment_processor_type WHERE name = 'Moneris')"); | |
57 | } | |
58 | if ($count && !function_exists('moneris_civicrm_managed')) { | |
a40fd1ac CW |
59 | $preUpgradeMessage .= '<p>' . ts('The %1 payment processor is no longer bundled with CiviCRM. After upgrading you will need to install the extension to continue using it.', array(1 => 'Moneris')) . '</p>'; |
60 | } | |
61 | } | |
f431d51f J |
62 | } |
63 | ||
6cc25669 CW |
64 | /** |
65 | * Compute any messages which should be displayed after upgrade. | |
66 | * | |
67 | * @param string $postUpgradeMessage | |
68 | * alterable. | |
69 | * @param string $rev | |
70 | * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs. | |
6cc25669 CW |
71 | */ |
72 | public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) { | |
6dbe2c23 CW |
73 | if ($rev == '4.7.alpha1') { |
74 | $config = CRM_Core_Config::singleton(); | |
bf6a5362 | 75 | // FIXME: Performing an upgrade step during postUpgrade message phase is probably bad |
6dbe2c23 CW |
76 | $editor_id = self::updateWysiwyg(); |
77 | $msg = NULL; | |
78 | $ext_href = 'href="' . CRM_Utils_System::url('civicrm/admin/extensions', 'reset=1') . '"'; | |
79 | $dsp_href = 'href="' . CRM_Utils_System::url('civicrm/admin/setting/preferences/display', 'reset=1') . '"'; | |
80 | $blog_href = 'href="https://civicrm.org/blogs/colemanw/big-changes-wysiwyg-editing-47"'; | |
81 | switch ($editor_id) { | |
82 | // TinyMCE | |
83 | case 1: | |
84 | $msg = ts('Your configured editor "TinyMCE" is no longer part of the main CiviCRM download. To continue using it, visit the <a %1>Manage Extensions</a> page to download and install the TinyMCE extension.', array(1 => $ext_href)); | |
85 | break; | |
86 | ||
87 | // Drupal/Joomla editor | |
88 | case 3: | |
89 | case 4: | |
90 | $msg = ts('CiviCRM no longer integrates with the "%1 Default Editor." Your wysiwyg setting has been reset to the built-in CKEditor. <a %2>Learn more...</a>', array(1 => $config->userFramework, 2 => $blog_href)); | |
91 | break; | |
92 | } | |
93 | if ($msg) { | |
94 | $postUpgradeMessage .= '<p>' . $msg . '</p>'; | |
95 | } | |
96 | $postUpgradeMessage .= '<p>' . ts('CiviCRM now includes the easy-to-use CKEditor Configurator. To customize the features and display of your wysiwyg editor, visit the <a %1>Display Preferences</a> page. <a %2>Learn more...</a>', array(1 => $dsp_href, 2 => $blog_href)) . '</p>'; | |
dd55005c | 97 | |
98 | $postUpgradeMessage .= '<br /><br />' . ts('Default version of the following System Workflow Message Templates have been modified: <ul><li>Personal Campaign Pages - Owner Notification</li></ul> If you have modified these templates, please review the new default versions and implement updates as needed to your copies (Administer > Communications > Message Templates > System Workflow Messages).'); | |
f431d51f J |
99 | |
100 | $postUpgradeMessage .= '<p>' . ts('The custom fatal error template setting has been removed.') . '</p>'; | |
6dbe2c23 | 101 | } |
6cc25669 CW |
102 | } |
103 | ||
6cc25669 CW |
104 | /** |
105 | * Upgrade function. | |
106 | * | |
107 | * @param string $rev | |
108 | */ | |
109 | public function upgrade_4_7_alpha1($rev) { | |
b604d7ec | 110 | $this->addTask('Migrate \'on behalf of\' information to module_data', 'migrateOnBehalfOfInfo'); |
bf6a5362 | 111 | $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev); |
f806379b | 112 | $this->addTask(ts('Migrate Settings to %1', array(1 => $rev)), 'migrateSettings', $rev); |
b604d7ec | 113 | $this->addTask('Add Getting Started dashlet', 'addGettingStartedDashlet', $rev); |
a40fd1ac CW |
114 | } |
115 | ||
116 | /** | |
117 | * Upgrade function. | |
118 | * | |
119 | * @param string $rev | |
120 | */ | |
121 | public function upgrade_4_7_alpha4($rev) { | |
122 | $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev); | |
058b8a5e | 123 | $this->addTask(ts('Remove %1', array(1 => 'Moneris')), 'removePaymentProcessorType', 'Moneris'); |
b2222b9f | 124 | $this->addTask('Update Smart Groups', 'fixContactTypeInSmartGroups'); |
6cc25669 CW |
125 | } |
126 | ||
0094ac08 CW |
127 | /** |
128 | * Upgrade function. | |
129 | * | |
130 | * @param string $rev | |
131 | */ | |
132 | public function upgrade_4_7_beta2($rev) { | |
133 | $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev); | |
134 | $this->addTask('Delete unused file', 'deleteVersionCheckCacheFile'); | |
135 | } | |
136 | ||
fb1f3850 DRJ |
137 | /** |
138 | * Upgrade function. | |
139 | * | |
140 | * @param string $rev | |
141 | */ | |
142 | public function upgrade_4_7_beta5($rev) { | |
13599400 | 143 | $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev); |
fb1f3850 DRJ |
144 | $this->addTask('Disable flexible jobs extension', 'disableFlexibleJobsExtension'); |
145 | } | |
146 | ||
6cc25669 CW |
147 | /** |
148 | * CRM-16354 | |
149 | * | |
6dbe2c23 | 150 | * @return int |
6cc25669 | 151 | */ |
6dbe2c23 | 152 | public static function updateWysiwyg() { |
aaffa79f | 153 | $editorID = Civi::settings()->get('editor_id'); |
6dbe2c23 CW |
154 | // Previously a numeric value indicated one of 4 wysiwyg editors shipped in core, and no value indicated 'Textarea' |
155 | // Now the options are "Textarea", "CKEditor", and the rest have been dropped from core. | |
156 | $newEditor = $editorID ? "CKEditor" : "Textarea"; | |
08ef4ddd | 157 | Civi::settings()->set('editor_id', $newEditor); |
6cc25669 | 158 | |
6dbe2c23 | 159 | return $editorID; |
6cc25669 CW |
160 | } |
161 | ||
f806379b TO |
162 | /** |
163 | * Migrate any last remaining options from `civicrm_domain.config_backend` to `civicrm_setting`. | |
164 | * Cleanup setting schema. | |
165 | * | |
166 | * @param CRM_Queue_TaskContext $ctx | |
167 | * @return bool | |
168 | */ | |
169 | public function migrateSettings(CRM_Queue_TaskContext $ctx) { | |
4cc9e637 TO |
170 | // Tip: If there are problems with adding the new uniqueness index, try inspecting: |
171 | // SELECT name, domain_id, contact_id, count(*) AS dupes FROM civicrm_setting cs GROUP BY name, domain_id, contact_id HAVING dupes > 1; | |
172 | ||
173 | // Nav records are expendable. https://forum.civicrm.org/index.php?topic=36933.0 | |
174 | CRM_Core_DAO::executeQuery('DELETE FROM civicrm_setting WHERE contact_id IS NOT NULL AND name = "navigation"'); | |
175 | ||
f806379b TO |
176 | CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting DROP INDEX index_group_name'); |
177 | CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting DROP COLUMN group_name'); | |
178 | CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_setting ADD UNIQUE INDEX index_domain_contact_name (domain_id, contact_id, name)'); | |
179 | ||
180 | $domainDao = CRM_Core_DAO::executeQuery('SELECT id, config_backend FROM civicrm_domain'); | |
181 | while ($domainDao->fetch()) { | |
182 | $settings = CRM_Upgrade_Incremental_php_FourSeven::convertBackendToSettings($domainDao->id, $domainDao->config_backend); | |
183 | CRM_Core_Error::debug_var('convertBackendToSettings', array( | |
184 | 'domainId' => $domainDao->id, | |
185 | 'backend' => $domainDao->config_backend, | |
186 | 'settings' => $settings, | |
187 | )); | |
188 | ||
189 | foreach ($settings as $name => $value) { | |
190 | $rowParams = array( | |
191 | 1 => array($domainDao->id, 'Positive'), | |
192 | 2 => array($name, 'String'), | |
193 | 3 => array(serialize($value), 'String'), | |
194 | ); | |
195 | $settingId = CRM_Core_DAO::singleValueQuery( | |
196 | 'SELECT id FROM civicrm_setting WHERE domain_id = %1 AND name = %2', | |
197 | $rowParams); | |
198 | if (!$settingId) { | |
199 | CRM_Core_DAO::executeQuery( | |
200 | 'INSERT INTO civicrm_setting (domain_id, name, value, is_domain) VALUES (%1,%2,%3,1)', | |
201 | $rowParams); | |
202 | } | |
203 | } | |
204 | } | |
205 | ||
9e726168 | 206 | CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_domain DROP COLUMN config_backend'); |
f806379b TO |
207 | |
208 | return TRUE; | |
209 | } | |
210 | ||
211 | /** | |
212 | * Take a config_backend blob and produce an equivalent list of settings. | |
213 | * | |
214 | * @param int $domainId | |
215 | * Domain ID. | |
216 | * @param string $config_backend | |
217 | * Serialized blob. | |
218 | * @return array | |
219 | */ | |
220 | public static function convertBackendToSettings($domainId, $config_backend) { | |
221 | if (!$config_backend) { | |
222 | return array(); | |
223 | } | |
224 | ||
225 | $backend = unserialize($config_backend); | |
226 | if (!$backend) { | |
227 | return array(); | |
228 | } | |
229 | ||
230 | $mappings = \CRM_Core_Config_MagicMerge::getPropertyMap(); | |
231 | $settings = array(); | |
232 | foreach ($backend as $propertyName => $propertyValue) { | |
233 | if (isset($mappings[$propertyName][0]) && preg_match('/^setting/', $mappings[$propertyName][0])) { | |
234 | // $mapping format: $propertyName => Array(0 => $type, 1 => $setting|NULL). | |
235 | $settingName = isset($mappings[$propertyName][1]) ? $mappings[$propertyName][1] : $propertyName; | |
236 | $settings[$settingName] = $propertyValue; | |
237 | } | |
238 | } | |
239 | ||
240 | return $settings; | |
241 | } | |
242 | ||
0a95c936 | 243 | /** |
244 | * Add Getting Started dashlet to dashboard | |
245 | * | |
246 | * @param \CRM_Queue_TaskContext $ctx | |
247 | * | |
248 | * @return bool | |
249 | */ | |
250 | public function addGettingStartedDashlet(CRM_Queue_TaskContext $ctx) { | |
e1674273 | 251 | $sql = "SELECT count(*) FROM civicrm_dashboard WHERE name='gettingStarted'"; |
252 | $res = CRM_Core_DAO::singleValueQuery($sql); | |
253 | $domainId = CRM_Core_Config::domainID(); | |
254 | if ($res <= 0) { | |
255 | $sql = "INSERT INTO `civicrm_dashboard` | |
a8b704c5 | 256 | ( `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 | 257 | CRM_Core_DAO::executeQuery($sql); |
258 | // Add default position for Getting Started Dashlet ( left column) | |
259 | $sql = "INSERT INTO `civicrm_dashboard_contact` (dashboard_id, contact_id, column_no, is_active) | |
260 | SELECT (SELECT MAX(id) FROM `civicrm_dashboard`), contact_id, 0, IF (SUM(is_active) > 0, 1, 0) | |
261 | FROM `civicrm_dashboard_contact` WHERE 1 GROUP BY contact_id"; | |
262 | CRM_Core_DAO::executeQuery($sql); | |
263 | } | |
0a95c936 | 264 | return TRUE; |
e1674273 | 265 | } |
4175ee03 | 266 | |
6b1e1a2c | 267 | /** |
268 | * Migrate on-behalf information to uf_join.module_data as on-behalf columns will be dropped | |
269 | * on DB upgrade | |
270 | * | |
271 | * @param CRM_Queue_TaskContext $ctx | |
272 | * | |
273 | * @return bool | |
274 | * TRUE for success | |
275 | */ | |
276 | public static function migrateOnBehalfOfInfo(CRM_Queue_TaskContext $ctx) { | |
d3e92c88 | 277 | $domain = new CRM_Core_DAO_Domain(); |
278 | $domain->find(TRUE); | |
6b1e1a2c | 279 | |
d3e92c88 | 280 | // fetch onBehalf entry in UFJoin table |
6b1e1a2c | 281 | $ufGroupDAO = new CRM_Core_DAO_UFJoin(); |
282 | $ufGroupDAO->module = 'OnBehalf'; | |
283 | $ufGroupDAO->find(TRUE); | |
284 | ||
d3e92c88 | 285 | $forOrgColums = array(); |
286 | if ($domain->locales) { | |
287 | $locales = explode(CRM_Core_DAO::VALUE_SEPARATOR, $domain->locales); | |
288 | foreach ($locales as $locale) { | |
289 | $forOrgColums[] = "for_organization_{$locale}"; | |
290 | } | |
291 | } | |
292 | else { | |
293 | $forOrgColums[] = "for_organization"; | |
294 | } | |
295 | ||
296 | $query = " | |
297 | SELECT " . implode(", ", $forOrgColums) . ", uj.id as join_id, uj.uf_group_id as uf_group_id | |
298 | FROM civicrm_contribution_page cp | |
299 | INNER JOIN civicrm_uf_join uj ON uj.entity_id = cp.id AND uj.module = 'OnBehalf'"; | |
300 | $dao = CRM_Core_DAO::executeQuery($query, array(), TRUE, NULL, FALSE, FALSE); | |
6b1e1a2c | 301 | |
302 | if ($dao->N) { | |
6b1e1a2c | 303 | while ($dao->fetch()) { |
304 | $onBehalfParams['on_behalf'] = array('is_for_organization' => $dao->is_for_organization); | |
305 | if ($domain->locales) { | |
6b1e1a2c | 306 | foreach ($locales as $locale) { |
307 | $for_organization = "for_organization_{$locale}"; | |
308 | $onBehalfParams['on_behalf'] += array( | |
309 | $locale => array( | |
310 | 'for_organization' => $dao->$for_organization, | |
311 | ), | |
312 | ); | |
313 | } | |
314 | } | |
315 | else { | |
316 | $onBehalfParams['on_behalf'] += array( | |
317 | 'default' => array( | |
318 | 'for_organization' => $dao->for_organization, | |
319 | ), | |
320 | ); | |
321 | } | |
322 | $ufJoinParam = array( | |
323 | 'id' => $dao->join_id, | |
324 | 'module' => 'on_behalf', | |
d3e92c88 | 325 | 'uf_group_id' => $dao->uf_group_id, |
6b1e1a2c | 326 | 'module_data' => json_encode($onBehalfParams), |
327 | ); | |
328 | CRM_Core_BAO_UFJoin::create($ufJoinParam); | |
329 | } | |
330 | } | |
331 | ||
332 | return TRUE; | |
333 | } | |
cb804cd9 | 334 | |
b2222b9f CW |
335 | /** |
336 | * CRM-11782 - Get rid of VALUE_SEPARATOR character in saved search form values | |
337 | * | |
338 | * @param \CRM_Queue_TaskContext $ctx | |
339 | * | |
340 | * @return bool | |
341 | */ | |
342 | public function fixContactTypeInSmartGroups(CRM_Queue_TaskContext $ctx) { | |
343 | $sep = CRM_Core_DAO::VALUE_SEPARATOR; | |
344 | $dao = CRM_Core_DAO::executeQuery("SELECT id, form_values FROM civicrm_saved_search WHERE form_values LIKE '%$sep%'"); | |
345 | while ($dao->fetch()) { | |
346 | $formValues = unserialize($dao->form_values); | |
347 | if (isset($formValues['contact_type']) && is_array($formValues['contact_type'])) { | |
348 | $newVals = array(); | |
349 | foreach ($formValues['contact_type'] as $key => $val) { | |
350 | $newVals[str_replace($sep, '__', $key)] = is_string($val) ? str_replace($sep, '__', $val) : $val; | |
351 | } | |
352 | $formValues['contact_type'] = $newVals; | |
353 | } | |
354 | CRM_Core_DAO::executeQuery("UPDATE civicrm_saved_search SET form_values = %1 WHERE id = {$dao->id}", array(1 => array(serialize($formValues), 'String'))); | |
355 | } | |
356 | ||
357 | return TRUE; | |
358 | } | |
359 | ||
0094ac08 CW |
360 | /** |
361 | * CRM-17637 - Ths file location has been moved; delete the old one | |
362 | * | |
363 | * @param \CRM_Queue_TaskContext $ctx | |
364 | * | |
365 | * @return bool | |
366 | */ | |
367 | public function deleteVersionCheckCacheFile(CRM_Queue_TaskContext $ctx) { | |
368 | $config = CRM_Core_Config::singleton(); | |
369 | $cacheFile = $config->uploadDir . 'version-info-cache.json'; | |
370 | if (file_exists($cacheFile)) { | |
371 | unlink($cacheFile); | |
372 | } | |
373 | return TRUE; | |
374 | } | |
375 | ||
fb1f3850 DRJ |
376 | /** |
377 | * CRM-17669 and CRM-17686, make scheduled jobs more flexible, disable the 4.6 extension if installed | |
378 | * | |
379 | * @param \CRM_Queue_TaskContext $ctx | |
380 | * | |
381 | * @return bool | |
382 | */ | |
383 | public function disableFlexibleJobsExtension(CRM_Queue_TaskContext $ctx) { | |
13599400 | 384 | civicrm_api3('Extension', 'disable', array('key' => 'com.klangsoft.flexiblejobs')); |
fb1f3850 DRJ |
385 | |
386 | return TRUE; | |
387 | } | |
388 | ||
6cc25669 | 389 | } |