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