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